blob: 3465a7c5a154899dce70459fd9eee56132e6808a [file] [log] [blame]
Kamil Rytarowskicb77f0d2017-05-07 23:25:26 +02001#!/usr/bin/env perl
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830be2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Kamil Rytarowskicb77f0d2017-05-07 23:25:26 +02009use warnings;
Joe Perchesc707a812013-07-08 16:00:43 -070010use POSIX;
Joe Perches36061e32014-12-10 15:51:43 -080011use File::Basename;
12use Cwd 'abs_path';
Joe Perches57230292015-06-25 15:03:03 -070013use Term::ANSIColor qw(:constants);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070014
15my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080016my $D = dirname(abs_path($P));
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070017
Joe Perches000d1cc12011-07-25 17:13:25 -070018my $V = '0.32';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070019
20use Getopt::Long qw(:config no_auto_abbrev);
21
22my $quiet = 0;
23my $tree = 1;
24my $chk_signoff = 1;
25my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070026my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070027my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080028my $terse = 0;
Joe Perches34d88152015-06-25 15:03:05 -070029my $showfile = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070030my $file = 0;
Du, Changbin4a593c32016-05-20 17:04:16 -070031my $git = 0;
Joe Perches0dea9f1e2016-05-20 17:04:19 -070032my %git_commits = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070033my $check = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -070034my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080035my $summary = 1;
36my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080037my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070038my $show_types = 0;
Joe Perches3beb42e2016-05-20 17:04:14 -070039my $list_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070040my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080041my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070042my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080043my %debug;
Joe Perches34456862013-07-03 15:05:34 -070044my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070045my %use_type = ();
46my @use = ();
47my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070048my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070049my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070050my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080051my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070052my $ignore_perl_version = 0;
53my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070054my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070055my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070056my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070057my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe Perchesbf1fa1d2016-10-11 13:51:56 -070058my $conststructsfile = "$D/const_structs.checkpatch";
Jerome Forissier75ad8c52017-05-08 15:56:00 -070059my $typedefsfile = "";
Joe Perches57230292015-06-25 15:03:03 -070060my $color = 1;
Joe Perchesdadf6802016-08-02 14:04:33 -070061my $allow_c99_comments = 1;
Hannes Eder77f5b102009-09-21 17:04:37 -070062
63sub help {
64 my ($exitcode) = @_;
65
66 print << "EOM";
67Usage: $P [OPTION]... [FILE]...
68Version: $V
69
70Options:
71 -q, --quiet quiet
72 --no-tree run without a kernel tree
73 --no-signoff do not check for 'Signed-off-by' line
74 --patch treat FILE as patchfile (default)
75 --emacs emacs compile window format
76 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070077 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070078 -g, --git treat FILE as a single commit or git revision range
79 single git commit with:
80 <rev>
81 <rev>^
82 <rev>~n
83 multiple git commits with:
84 <rev1>..<rev2>
85 <rev1>...<rev2>
86 <rev>-<count>
87 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -070088 -f, --file treat FILE as regular source file
89 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -070090 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -070091 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070092 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -070093 --show-types show the specific message type in the output
Joe Perches6cd7f382012-12-17 16:01:54 -080094 --max-line-length=n set the maximum line length, if exceeded, warn
Vadim Bendebury56193272014-10-13 15:51:48 -070095 --min-conf-desc-length=n set the min description length, if shorter, warn
Hannes Eder77f5b102009-09-21 17:04:37 -070096 --root=PATH PATH to the kernel tree root
97 --no-summary suppress the per-file summary
98 --mailback only produce a report in case of warnings/errors
99 --summary-file include the filename in summary
100 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
101 'values', 'possible', 'type', and 'attr' (default
102 is all off)
103 --test-only=WORD report only warnings/errors containing WORD
104 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700105 --fix EXPERIMENTAL - may create horrible results
106 If correctable single-line errors exist, create
107 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
108 with potential errors corrected to the preferred
109 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800110 --fix-inplace EXPERIMENTAL - may create horrible results
111 Is the same as --fix, but overwrites the input
112 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700113 --ignore-perl-version override checking of perl version. expect
114 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700115 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700116 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700117 --codespellfile Use this codespell dictionary
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700118 --typedefsfile Read additional types from this file
Joe Perches57230292015-06-25 15:03:03 -0700119 --color Use colors when output is STDOUT (default: on)
Hannes Eder77f5b102009-09-21 17:04:37 -0700120 -h, --help, --version display this help and exit
121
122When FILE is - read standard input.
123EOM
124
125 exit($exitcode);
126}
127
Joe Perches3beb42e2016-05-20 17:04:14 -0700128sub uniq {
129 my %seen;
130 return grep { !$seen{$_}++ } @_;
131}
132
133sub list_types {
134 my ($exitcode) = @_;
135
136 my $count = 0;
137
138 local $/ = undef;
139
140 open(my $script, '<', abs_path($P)) or
141 die "$P: Can't read '$P' $!\n";
142
143 my $text = <$script>;
144 close($script);
145
146 my @types = ();
147 for ($text =~ /\b(?:(?:CHK|WARN|ERROR)\s*\(\s*"([^"]+)")/g) {
148 push (@types, $_);
149 }
150 @types = sort(uniq(@types));
151 print("#\tMessage type\n\n");
152 foreach my $type (@types) {
153 print(++$count . "\t" . $type . "\n");
154 }
155
156 exit($exitcode);
157}
158
Joe Perches000d1cc12011-07-25 17:13:25 -0700159my $conf = which_conf($configuration_file);
160if (-f $conf) {
161 my @conf_args;
162 open(my $conffile, '<', "$conf")
163 or warn "$P: Can't find a readable $configuration_file file $!\n";
164
165 while (<$conffile>) {
166 my $line = $_;
167
168 $line =~ s/\s*\n?$//g;
169 $line =~ s/^\s*//g;
170 $line =~ s/\s+/ /g;
171
172 next if ($line =~ m/^\s*#/);
173 next if ($line =~ m/^\s*$/);
174
175 my @words = split(" ", $line);
176 foreach my $word (@words) {
177 last if ($word =~ m/^#/);
178 push (@conf_args, $word);
179 }
180 }
181 close($conffile);
182 unshift(@ARGV, @conf_args) if @conf_args;
183}
184
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700185GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700186 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700187 'tree!' => \$tree,
188 'signoff!' => \$chk_signoff,
189 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700190 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800191 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700192 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700193 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700194 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700195 'subjective!' => \$check,
196 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700197 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700198 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700199 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700200 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800201 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700202 'min-conf-desc-length=i' => \$min_conf_desc_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700203 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800204 'summary!' => \$summary,
205 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800206 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700207 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800208 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700209 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800210 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700211 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700212 'codespell!' => \$codespell,
213 'codespellfile=s' => \$codespellfile,
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700214 'typedefsfile=s' => \$typedefsfile,
Joe Perches57230292015-06-25 15:03:03 -0700215 'color!' => \$color,
Hannes Eder77f5b102009-09-21 17:04:37 -0700216 'h|help' => \$help,
217 'version' => \$help
218) or help(1);
219
220help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700221
Joe Perches3beb42e2016-05-20 17:04:14 -0700222list_types(0) if ($list_types);
223
Joe Perches9624b8d2014-01-23 15:54:44 -0800224$fix = 1 if ($fix_inplace);
Joe Perches2ac73b42014-06-04 16:12:05 -0700225$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800226
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700227my $exit = 0;
228
Dave Hansend62a2012013-09-11 14:23:56 -0700229if ($^V && $^V lt $minimum_perl_version) {
230 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
231 if (!$ignore_perl_version) {
232 exit(1);
233 }
234}
235
Allen Hubbe45107ff2016-08-02 14:04:47 -0700236#if no filenames are given, push '-' to read patch from stdin
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700237if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700238 push(@ARGV, '-');
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700239}
240
Joe Perches91bfe482013-09-11 14:23:59 -0700241sub hash_save_array_words {
242 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700243
Joe Perches91bfe482013-09-11 14:23:59 -0700244 my @array = split(/,/, join(',', @$arrayRef));
245 foreach my $word (@array) {
246 $word =~ s/\s*\n?$//g;
247 $word =~ s/^\s*//g;
248 $word =~ s/\s+/ /g;
249 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700250
Joe Perches91bfe482013-09-11 14:23:59 -0700251 next if ($word =~ m/^\s*#/);
252 next if ($word =~ m/^\s*$/);
253
254 $hashRef->{$word}++;
255 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700256}
257
Joe Perches91bfe482013-09-11 14:23:59 -0700258sub hash_show_words {
259 my ($hashRef, $prefix) = @_;
260
Joe Perches3c816e42015-06-25 15:03:29 -0700261 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700262 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700263 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700264 print " $word";
265 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700266 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700267 }
268}
269
270hash_save_array_words(\%ignore_type, \@ignore);
271hash_save_array_words(\%use_type, \@use);
272
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800273my $dbg_values = 0;
274my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700275my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700276my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800277for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800278 ## no critic
279 eval "\${dbg_$key} = '$debug{$key}';";
280 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800281}
282
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700283my $rpt_cleaners = 0;
284
Andy Whitcroft8905a672007-11-28 16:21:06 -0800285if ($terse) {
286 $emacs = 1;
287 $quiet++;
288}
289
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700290if ($tree) {
291 if (defined $root) {
292 if (!top_of_kernel_tree($root)) {
293 die "$P: $root: --root does not point at a valid tree\n";
294 }
295 } else {
296 if (top_of_kernel_tree('.')) {
297 $root = '.';
298 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
299 top_of_kernel_tree($1)) {
300 $root = $1;
301 }
302 }
303
304 if (!defined $root) {
305 print "Must be run from the top-level dir. of a kernel tree\n";
306 exit(2);
307 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700308}
309
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700310my $emitted_corrupt = 0;
311
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700312our $Ident = qr{
313 [A-Za-z_][A-Za-z\d_]*
314 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
315 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700316our $Storage = qr{extern|static|asmlinkage};
317our $Sparse = qr{
318 __user|
319 __kernel|
320 __force|
321 __iomem|
322 __must_check|
323 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800324 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700325 __ref|
Boqun Fengad315452015-12-29 12:18:46 +0800326 __rcu|
327 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700328 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800329our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
330our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
331our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
332our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
333our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700334
Wolfram Sang52131292010-03-05 13:43:51 -0800335# Notes to $Attribute:
336# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700337our $Attribute = qr{
338 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700339 __percpu|
340 __nocast|
341 __safe|
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +0200342 __bitwise|
Joe Perches03f1df72010-10-26 14:23:16 -0700343 __packed__|
344 __packed2__|
345 __naked|
346 __maybe_unused|
347 __always_unused|
348 __noreturn|
349 __used|
350 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800351 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700352 __noclone|
353 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700354 __read_mostly|
355 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700356 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700357 ____cacheline_aligned|
358 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800359 ____cacheline_internodealigned_in_smp|
360 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700361 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700362our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700363our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700364our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
365our $Lval = qr{$Ident(?:$Member)*};
366
Joe Perches95e2c602013-07-03 15:05:20 -0700367our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
368our $Binary = qr{(?i)0b[01]+$Int_type?};
369our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
370our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700371our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800372our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800373our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
374our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
375our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800376our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700377our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800378our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700379our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700380our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700381our $Operators = qr{
382 <=|>=|==|!=|
383 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700384 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700385 }x;
386
Joe Perches91cb5192014-04-03 14:49:32 -0700387our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
388
Joe Perchesab7e23f2015-04-16 12:44:22 -0700389our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800390our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700391our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700392our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800393our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700394our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800395our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700396our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800397
Joe Perches15662b32011-10-31 17:13:12 -0700398our $NON_ASCII_UTF8 = qr{
399 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700400 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
401 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
402 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
403 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
404 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
405 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
406}x;
407
Joe Perches15662b32011-10-31 17:13:12 -0700408our $UTF8 = qr{
409 [\x09\x0A\x0D\x20-\x7E] # ASCII
410 | $NON_ASCII_UTF8
411}x;
412
Joe Perchese6176fa2015-06-25 15:02:49 -0700413our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800414our $typeOtherOSTypedefs = qr{(?x:
415 u_(?:char|short|int|long) | # bsd
416 u(?:nchar|short|int|long) # sysv
417)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700418our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700419 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700420 atomic_t
421)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700422our $typeTypedefs = qr{(?x:
423 $typeC99Typedefs\b|
424 $typeOtherOSTypedefs\b|
425 $typeKernelTypedefs\b
426)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700427
Joe Perches6d32f7a2015-11-06 16:31:37 -0800428our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
429
Joe Perches691e6692010-03-05 13:43:51 -0800430our $logFunctions = qr{(?x:
Miles Chen758d7aa2017-02-24 15:01:34 -0800431 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700432 (?:[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 -0700433 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700434 panic|
Joe Perches06668722013-11-12 15:10:07 -0800435 MODULE_[A-Z_]+|
436 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800437)};
438
Joe Perches20112472011-07-25 17:13:23 -0700439our $signature_tags = qr{(?xi:
440 Signed-off-by:|
441 Acked-by:|
442 Tested-by:|
443 Reviewed-by:|
444 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700445 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700446 To:|
447 Cc:
448)};
449
Joe Perches18130872014-08-06 16:11:22 -0700450our @typeListMisordered = (
451 qr{char\s+(?:un)?signed},
452 qr{int\s+(?:(?:un)?signed\s+)?short\s},
453 qr{int\s+short(?:\s+(?:un)?signed)},
454 qr{short\s+int(?:\s+(?:un)?signed)},
455 qr{(?:un)?signed\s+int\s+short},
456 qr{short\s+(?:un)?signed},
457 qr{long\s+int\s+(?:un)?signed},
458 qr{int\s+long\s+(?:un)?signed},
459 qr{long\s+(?:un)?signed\s+int},
460 qr{int\s+(?:un)?signed\s+long},
461 qr{int\s+(?:un)?signed},
462 qr{int\s+long\s+long\s+(?:un)?signed},
463 qr{long\s+long\s+int\s+(?:un)?signed},
464 qr{long\s+long\s+(?:un)?signed\s+int},
465 qr{long\s+long\s+(?:un)?signed},
466 qr{long\s+(?:un)?signed},
467);
468
Andy Whitcroft8905a672007-11-28 16:21:06 -0800469our @typeList = (
470 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700471 qr{(?:(?:un)?signed\s+)?char},
472 qr{(?:(?:un)?signed\s+)?short\s+int},
473 qr{(?:(?:un)?signed\s+)?short},
474 qr{(?:(?:un)?signed\s+)?int},
475 qr{(?:(?:un)?signed\s+)?long\s+int},
476 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
477 qr{(?:(?:un)?signed\s+)?long\s+long},
478 qr{(?:(?:un)?signed\s+)?long},
479 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800480 qr{float},
481 qr{double},
482 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800483 qr{struct\s+$Ident},
484 qr{union\s+$Ident},
485 qr{enum\s+$Ident},
486 qr{${Ident}_t},
487 qr{${Ident}_handler},
488 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700489 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800490);
Joe Perches938224b2016-01-20 14:59:15 -0800491
492our $C90_int_types = qr{(?x:
493 long\s+long\s+int\s+(?:un)?signed|
494 long\s+long\s+(?:un)?signed\s+int|
495 long\s+long\s+(?:un)?signed|
496 (?:(?:un)?signed\s+)?long\s+long\s+int|
497 (?:(?:un)?signed\s+)?long\s+long|
498 int\s+long\s+long\s+(?:un)?signed|
499 int\s+(?:(?:un)?signed\s+)?long\s+long|
500
501 long\s+int\s+(?:un)?signed|
502 long\s+(?:un)?signed\s+int|
503 long\s+(?:un)?signed|
504 (?:(?:un)?signed\s+)?long\s+int|
505 (?:(?:un)?signed\s+)?long|
506 int\s+long\s+(?:un)?signed|
507 int\s+(?:(?:un)?signed\s+)?long|
508
509 int\s+(?:un)?signed|
510 (?:(?:un)?signed\s+)?int
511)};
512
Alex Dowad485ff232015-06-25 15:02:52 -0700513our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700514our @typeListWithAttr = (
515 @typeList,
516 qr{struct\s+$InitAttribute\s+$Ident},
517 qr{union\s+$InitAttribute\s+$Ident},
518);
519
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700520our @modifierList = (
521 qr{fastcall},
522);
Alex Dowad485ff232015-06-25 15:02:52 -0700523our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800524
Joe Perches24358802014-04-03 14:49:13 -0700525our @mode_permission_funcs = (
526 ["module_param", 3],
527 ["module_param_(?:array|named|string)", 4],
528 ["module_param_array_named", 5],
529 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
530 ["proc_create(?:_data|)", 2],
Joe Perches459cf0a2016-10-11 13:52:19 -0700531 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
532 ["IIO_DEV_ATTR_[A-Z_]+", 1],
533 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
534 ["SENSOR_TEMPLATE(?:_2|)", 3],
535 ["__ATTR", 2],
Joe Perches24358802014-04-03 14:49:13 -0700536);
537
Joe Perches515a2352014-04-03 14:49:24 -0700538#Create a search pattern for all these functions to speed up a loop below
539our $mode_perms_search = "";
540foreach my $entry (@mode_permission_funcs) {
541 $mode_perms_search .= '|' if ($mode_perms_search ne "");
542 $mode_perms_search .= $entry->[0];
543}
544
Joe Perchesb392c642015-04-16 12:44:16 -0700545our $mode_perms_world_writable = qr{
546 S_IWUGO |
547 S_IWOTH |
548 S_IRWXUGO |
549 S_IALLUGO |
550 0[0-7][0-7][2367]
551}x;
552
Joe Perchesf90774e2016-10-11 13:51:47 -0700553our %mode_permission_string_types = (
554 "S_IRWXU" => 0700,
555 "S_IRUSR" => 0400,
556 "S_IWUSR" => 0200,
557 "S_IXUSR" => 0100,
558 "S_IRWXG" => 0070,
559 "S_IRGRP" => 0040,
560 "S_IWGRP" => 0020,
561 "S_IXGRP" => 0010,
562 "S_IRWXO" => 0007,
563 "S_IROTH" => 0004,
564 "S_IWOTH" => 0002,
565 "S_IXOTH" => 0001,
566 "S_IRWXUGO" => 0777,
567 "S_IRUGO" => 0444,
568 "S_IWUGO" => 0222,
569 "S_IXUGO" => 0111,
570);
571
572#Create a search pattern for all these strings to speed up a loop below
573our $mode_perms_string_search = "";
574foreach my $entry (keys %mode_permission_string_types) {
575 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
576 $mode_perms_string_search .= $entry;
577}
578
Wolfram Sang7840a942010-08-09 17:20:57 -0700579our $allowed_asm_includes = qr{(?x:
580 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700581 memory|
582 time|
583 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700584)};
585# memory.h: ARM has a custom one
586
Kees Cook66b47b42014-10-13 15:51:57 -0700587# Load common spelling mistakes and build regular expression list.
588my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700589my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700590
Joe Perches36061e32014-12-10 15:51:43 -0800591if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800592 while (<$spelling>) {
593 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700594
Joe Perches36061e32014-12-10 15:51:43 -0800595 $line =~ s/\s*\n?$//g;
596 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700597
Joe Perches36061e32014-12-10 15:51:43 -0800598 next if ($line =~ m/^\s*#/);
599 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700600
Joe Perches36061e32014-12-10 15:51:43 -0800601 my ($suspect, $fix) = split(/\|\|/, $line);
602
Joe Perches36061e32014-12-10 15:51:43 -0800603 $spelling_fix{$suspect} = $fix;
604 }
605 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800606} else {
607 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700608}
Kees Cook66b47b42014-10-13 15:51:57 -0700609
Joe Perchesebfd7d62015-04-16 12:44:14 -0700610if ($codespell) {
611 if (open(my $spelling, '<', $codespellfile)) {
612 while (<$spelling>) {
613 my $line = $_;
614
615 $line =~ s/\s*\n?$//g;
616 $line =~ s/^\s*//g;
617
618 next if ($line =~ m/^\s*#/);
619 next if ($line =~ m/^\s*$/);
620 next if ($line =~ m/, disabled/i);
621
622 $line =~ s/,.*$//;
623
624 my ($suspect, $fix) = split(/->/, $line);
625
626 $spelling_fix{$suspect} = $fix;
627 }
628 close($spelling);
629 } else {
630 warn "No codespell typos will be found - file '$codespellfile': $!\n";
631 }
632}
633
634$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
635
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700636sub read_words {
637 my ($wordsRef, $file) = @_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700638
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700639 if (open(my $words, '<', $file)) {
640 while (<$words>) {
641 my $line = $_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700642
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700643 $line =~ s/\s*\n?$//g;
644 $line =~ s/^\s*//g;
645
646 next if ($line =~ m/^\s*#/);
647 next if ($line =~ m/^\s*$/);
648 if ($line =~ /\s/) {
649 print("$file: '$line' invalid - ignored\n");
650 next;
651 }
652
653 $$wordsRef .= '|' if ($$wordsRef ne "");
654 $$wordsRef .= $line;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700655 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700656 close($file);
657 return 1;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700658 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700659
660 return 0;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700661}
662
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700663my $const_structs = "";
664read_words(\$const_structs, $conststructsfile)
665 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
666
667my $typeOtherTypedefs = "";
668if (length($typedefsfile)) {
669 read_words(\$typeOtherTypedefs, $typedefsfile)
670 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
671}
672$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
673
Andy Whitcroft8905a672007-11-28 16:21:06 -0800674sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700675 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
676 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700677 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700678 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700679 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700680 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700681 (?:$typeTypedefs\b)|
682 (?:${all}\b)
683 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800684 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700685 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800686 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800687 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700688 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700689 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800690 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700691 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800692 }x;
Joe Perches18130872014-08-06 16:11:22 -0700693 $NonptrTypeMisordered = qr{
694 (?:$Modifier\s+|const\s+)*
695 (?:
696 (?:${Misordered}\b)
697 )
698 (?:\s+$Modifier|\s+const)*
699 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700700 $NonptrTypeWithAttr = qr{
701 (?:$Modifier\s+|const\s+)*
702 (?:
703 (?:typeof|__typeof__)\s*\([^\)]*\)|
704 (?:$typeTypedefs\b)|
705 (?:${allWithAttr}\b)
706 )
707 (?:\s+$Modifier|\s+const)*
708 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800709 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700710 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700711 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700712 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800713 }x;
Joe Perches18130872014-08-06 16:11:22 -0700714 $TypeMisordered = qr{
715 $NonptrTypeMisordered
716 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
717 (?:\s+$Inline|\s+$Modifier)*
718 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700719 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700720 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800721}
722build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700723
Joe Perches7d2367a2011-07-25 17:13:22 -0700724our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700725
726# Using $balanced_parens, $LvalOrFunc, or $FuncArg
727# requires at least perl version v5.10.0
728# Any use must be runtime checked with $^V
729
730our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700731our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800732our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700733
Joe Perchesf8422302014-08-06 16:11:31 -0700734our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700735 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Joe Perchesf8422302014-08-06 16:11:31 -0700736 (?:$Storage\s+)?LIST_HEAD\s*\(|
737 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
738)};
739
Joe Perches7d2367a2011-07-25 17:13:22 -0700740sub deparenthesize {
741 my ($string) = @_;
742 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700743
744 while ($string =~ /^\s*\(.*\)\s*$/) {
745 $string =~ s@^\s*\(\s*@@;
746 $string =~ s@\s*\)\s*$@@;
747 }
748
Joe Perches7d2367a2011-07-25 17:13:22 -0700749 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700750
Joe Perches7d2367a2011-07-25 17:13:22 -0700751 return $string;
752}
753
Joe Perches34456862013-07-03 15:05:34 -0700754sub seed_camelcase_file {
755 my ($file) = @_;
756
757 return if (!(-f $file));
758
759 local $/;
760
761 open(my $include_file, '<', "$file")
762 or warn "$P: Can't read '$file' $!\n";
763 my $text = <$include_file>;
764 close($include_file);
765
766 my @lines = split('\n', $text);
767
768 foreach my $line (@lines) {
769 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
770 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
771 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800772 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
773 $camelcase{$1} = 1;
774 } 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 -0700775 $camelcase{$1} = 1;
776 }
777 }
778}
779
Joe Perches85b0ee12016-10-11 13:51:44 -0700780sub is_maintained_obsolete {
781 my ($filename) = @_;
782
Jerome Forissierf2c19c22016-12-12 16:46:23 -0800783 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
Joe Perches85b0ee12016-10-11 13:51:44 -0700784
Joe Perches0616efa2016-10-11 13:52:02 -0700785 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
Joe Perches85b0ee12016-10-11 13:51:44 -0700786
787 return $status =~ /obsolete/i;
788}
789
Joe Perches34456862013-07-03 15:05:34 -0700790my $camelcase_seeded = 0;
791sub seed_camelcase_includes {
792 return if ($camelcase_seeded);
793
794 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700795 my $camelcase_cache = "";
796 my @include_files = ();
797
798 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700799
Richard Genoud3645e322014-02-10 14:25:32 -0800800 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700801 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
802 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700803 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700804 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700805 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700806 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700807 @include_files = split('\n', $files);
808 foreach my $file (@include_files) {
809 my $date = POSIX::strftime("%Y%m%d%H%M",
810 localtime((stat $file)[9]));
811 $last_mod_date = $date if ($last_mod_date < $date);
812 }
813 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700814 }
Joe Perchesc707a812013-07-08 16:00:43 -0700815
816 if ($camelcase_cache ne "" && -f $camelcase_cache) {
817 open(my $camelcase_file, '<', "$camelcase_cache")
818 or warn "$P: Can't read '$camelcase_cache' $!\n";
819 while (<$camelcase_file>) {
820 chomp;
821 $camelcase{$_} = 1;
822 }
823 close($camelcase_file);
824
825 return;
826 }
827
Richard Genoud3645e322014-02-10 14:25:32 -0800828 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700829 $files = `git ls-files "include/*.h"`;
830 @include_files = split('\n', $files);
831 }
832
Joe Perches34456862013-07-03 15:05:34 -0700833 foreach my $file (@include_files) {
834 seed_camelcase_file($file);
835 }
Joe Perches351b2a12013-07-03 15:05:36 -0700836
Joe Perchesc707a812013-07-08 16:00:43 -0700837 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700838 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700839 open(my $camelcase_file, '>', "$camelcase_cache")
840 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700841 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
842 print $camelcase_file ("$_\n");
843 }
844 close($camelcase_file);
845 }
Joe Perches34456862013-07-03 15:05:34 -0700846}
847
Joe Perchesd311cd42014-08-06 16:10:57 -0700848sub git_commit_info {
849 my ($commit, $id, $desc) = @_;
850
851 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
852
853 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
854 $output =~ s/^\s*//gm;
855 my @lines = split("\n", $output);
856
Joe Perches0d7835f2015-02-13 14:38:35 -0800857 return ($id, $desc) if ($#lines < 0);
858
Joe Perchesd311cd42014-08-06 16:10:57 -0700859 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
860# Maybe one day convert this block of bash into something that returns
861# all matching commit ids, but it's very slow...
862#
863# echo "checking commits $1..."
864# git rev-list --remotes | grep -i "^$1" |
865# while read line ; do
866# git log --format='%H %s' -1 $line |
867# echo "commit $(cut -c 1-12,41-)"
868# done
869 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
870 } else {
871 $id = substr($lines[0], 0, 12);
872 $desc = substr($lines[0], 41);
873 }
874
875 return ($id, $desc);
876}
877
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700878$chk_signoff = 0 if ($file);
879
Andy Whitcroft00df3442007-06-08 13:47:06 -0700880my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800881my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700882my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700883my @fixed_inserted = ();
884my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700885my $fixlinenr = -1;
886
Du, Changbin4a593c32016-05-20 17:04:16 -0700887# If input is git commits, extract all commits from the commit expressions.
888# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
889die "$P: No git repository found\n" if ($git && !-e ".git");
890
891if ($git) {
892 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700893 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -0700894 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -0700895 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
896 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -0700897 } elsif ($commit_expr =~ m/\.\./) {
898 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -0700899 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700900 $git_range = "-1 $commit_expr";
901 }
902 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
903 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -0700904 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
905 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700906 my $sha1 = $1;
907 my $subject = $2;
908 unshift(@commits, $sha1);
909 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -0700910 }
911 }
912 die "$P: no git commits after extraction!\n" if (@commits == 0);
913 @ARGV = @commits;
914}
915
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800916my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700917for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800918 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -0700919 if ($git) {
920 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
921 die "$P: $filename: git format-patch failed - $!\n";
922 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800923 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700924 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800925 } elsif ($filename eq '-') {
926 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700927 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800928 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700929 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700930 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800931 if ($filename eq '-') {
932 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -0700933 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700934 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800935 } else {
936 $vname = $filename;
937 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800938 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700939 chomp;
940 push(@rawlines, $_);
941 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800942 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -0700943
944 if ($#ARGV > 0 && $quiet == 0) {
945 print '-' x length($vname) . "\n";
946 print "$vname\n";
947 print '-' x length($vname) . "\n";
948 }
949
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800950 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700951 $exit = 1;
952 }
953 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800954 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700955 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700956 @fixed_inserted = ();
957 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700958 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -0700959 @modifierListFile = ();
960 @typeListFile = ();
961 build_types();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700962}
963
Joe Perchesd8469f12015-06-25 15:03:00 -0700964if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -0700965 hash_show_words(\%use_type, "Used");
966 hash_show_words(\%ignore_type, "Ignored");
967
Joe Perchesd8469f12015-06-25 15:03:00 -0700968 if ($^V lt 5.10.0) {
969 print << "EOM"
970
971NOTE: perl $^V is not modern enough to detect all possible issues.
972 An upgrade to at least perl v5.10.0 is suggested.
973EOM
974 }
975 if ($exit) {
976 print << "EOM"
977
978NOTE: If any of the errors are false positives, please report
979 them to the maintainer, see CHECKPATCH in MAINTAINERS.
980EOM
981 }
982}
983
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700984exit($exit);
985
986sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700987 my ($root) = @_;
988
989 my @tree_check = (
990 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
991 "README", "Documentation", "arch", "include", "drivers",
992 "fs", "init", "ipc", "kernel", "lib", "scripts",
993 );
994
995 foreach my $check (@tree_check) {
996 if (! -e $root . '/' . $check) {
997 return 0;
998 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700999 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001000 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -07001001}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001002
Joe Perches20112472011-07-25 17:13:23 -07001003sub parse_email {
1004 my ($formatted_email) = @_;
1005
1006 my $name = "";
1007 my $address = "";
1008 my $comment = "";
1009
1010 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1011 $name = $1;
1012 $address = $2;
1013 $comment = $3 if defined $3;
1014 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1015 $address = $1;
1016 $comment = $2 if defined $2;
1017 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1018 $address = $1;
1019 $comment = $2 if defined $2;
1020 $formatted_email =~ s/$address.*$//;
1021 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -07001022 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001023 $name =~ s/^\"|\"$//g;
1024 # If there's a name left after stripping spaces and
1025 # leading quotes, and the address doesn't have both
1026 # leading and trailing angle brackets, the address
1027 # is invalid. ie:
1028 # "joe smith joe@smith.com" bad
1029 # "joe smith <joe@smith.com" bad
1030 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1031 $name = "";
1032 $address = "";
1033 $comment = "";
1034 }
1035 }
1036
Joe Perches3705ce52013-07-03 15:05:31 -07001037 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001038 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001039 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001040 $address =~ s/^\<|\>$//g;
1041
1042 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1043 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1044 $name = "\"$name\"";
1045 }
1046
1047 return ($name, $address, $comment);
1048}
1049
1050sub format_email {
1051 my ($name, $address) = @_;
1052
1053 my $formatted_email;
1054
Joe Perches3705ce52013-07-03 15:05:31 -07001055 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001056 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001057 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001058
1059 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1060 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1061 $name = "\"$name\"";
1062 }
1063
1064 if ("$name" eq "") {
1065 $formatted_email = "$address";
1066 } else {
1067 $formatted_email = "$name <$address>";
1068 }
1069
1070 return $formatted_email;
1071}
1072
Joe Perchesd311cd42014-08-06 16:10:57 -07001073sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001074 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001075
Joe Perchesbd474ca2014-08-06 16:11:10 -07001076 foreach my $path (split(/:/, $ENV{PATH})) {
1077 if (-e "$path/$bin") {
1078 return "$path/$bin";
1079 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001080 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001081
Joe Perchesbd474ca2014-08-06 16:11:10 -07001082 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001083}
1084
Joe Perches000d1cc12011-07-25 17:13:25 -07001085sub which_conf {
1086 my ($conf) = @_;
1087
1088 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1089 if (-e "$path/$conf") {
1090 return "$path/$conf";
1091 }
1092 }
1093
1094 return "";
1095}
1096
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001097sub expand_tabs {
1098 my ($str) = @_;
1099
1100 my $res = '';
1101 my $n = 0;
1102 for my $c (split(//, $str)) {
1103 if ($c eq "\t") {
1104 $res .= ' ';
1105 $n++;
1106 for (; ($n % 8) != 0; $n++) {
1107 $res .= ' ';
1108 }
1109 next;
1110 }
1111 $res .= $c;
1112 $n++;
1113 }
1114
1115 return $res;
1116}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001117sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001118 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001119 return $res;
1120}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001121
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001122sub line_stats {
1123 my ($line) = @_;
1124
1125 # Drop the diff line leader and expand tabs
1126 $line =~ s/^.//;
1127 $line = expand_tabs($line);
1128
1129 # Pick the indent from the front of the line.
1130 my ($white) = ($line =~ /^(\s*)/);
1131
1132 return (length($line), length($white));
1133}
1134
Andy Whitcroft773647a2008-03-28 14:15:58 -07001135my $sanitise_quote = '';
1136
1137sub sanitise_line_reset {
1138 my ($in_comment) = @_;
1139
1140 if ($in_comment) {
1141 $sanitise_quote = '*/';
1142 } else {
1143 $sanitise_quote = '';
1144 }
1145}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001146sub sanitise_line {
1147 my ($line) = @_;
1148
1149 my $res = '';
1150 my $l = '';
1151
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001152 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001153 my $off = 0;
1154 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001155
Andy Whitcroft773647a2008-03-28 14:15:58 -07001156 # Always copy over the diff marker.
1157 $res = substr($line, 0, 1);
1158
1159 for ($off = 1; $off < length($line); $off++) {
1160 $c = substr($line, $off, 1);
1161
1162 # Comments we are wacking completly including the begin
1163 # and end, all to $;.
1164 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1165 $sanitise_quote = '*/';
1166
1167 substr($res, $off, 2, "$;$;");
1168 $off++;
1169 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001170 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001171 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001172 $sanitise_quote = '';
1173 substr($res, $off, 2, "$;$;");
1174 $off++;
1175 next;
1176 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001177 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1178 $sanitise_quote = '//';
1179
1180 substr($res, $off, 2, $sanitise_quote);
1181 $off++;
1182 next;
1183 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001184
1185 # A \ in a string means ignore the next character.
1186 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1187 $c eq "\\") {
1188 substr($res, $off, 2, 'XX');
1189 $off++;
1190 next;
1191 }
1192 # Regular quotes.
1193 if ($c eq "'" || $c eq '"') {
1194 if ($sanitise_quote eq '') {
1195 $sanitise_quote = $c;
1196
1197 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001198 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001199 } elsif ($sanitise_quote eq $c) {
1200 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001201 }
1202 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001203
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001204 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001205 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1206 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001207 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1208 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001209 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1210 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001211 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001212 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001213 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001214 }
1215
Daniel Walker113f04a2009-09-21 17:04:35 -07001216 if ($sanitise_quote eq '//') {
1217 $sanitise_quote = '';
1218 }
1219
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001220 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001221 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001222 my $clean = 'X' x length($1);
1223 $res =~ s@\<.*\>@<$clean>@;
1224
1225 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001226 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001227 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001228 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001229 }
1230
Joe Perchesdadf6802016-08-02 14:04:33 -07001231 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1232 my $match = $1;
1233 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1234 }
1235
Andy Whitcroft00df3442007-06-08 13:47:06 -07001236 return $res;
1237}
1238
Joe Perchesa6962d72013-04-29 16:18:13 -07001239sub get_quoted_string {
1240 my ($line, $rawline) = @_;
1241
Joe Perches33acb542015-06-25 15:02:54 -07001242 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001243 return substr($rawline, $-[0], $+[0] - $-[0]);
1244}
1245
Andy Whitcroft8905a672007-11-28 16:21:06 -08001246sub ctx_statement_block {
1247 my ($linenr, $remain, $off) = @_;
1248 my $line = $linenr - 1;
1249 my $blk = '';
1250 my $soff = $off;
1251 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001252 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001253
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001254 my $loff = 0;
1255
Andy Whitcroft8905a672007-11-28 16:21:06 -08001256 my $type = '';
1257 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001258 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001259 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001260 my $c;
1261 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001262
1263 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001264 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001265 @stack = (['', 0]) if ($#stack == -1);
1266
Andy Whitcroft773647a2008-03-28 14:15:58 -07001267 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001268 # If we are about to drop off the end, pull in more
1269 # context.
1270 if ($off >= $len) {
1271 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001272 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001273 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001274 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001275 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001276 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001277 $len = length($blk);
1278 $line++;
1279 last;
1280 }
1281 # Bail if there is no further context.
1282 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001283 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001284 last;
1285 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001286 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1287 $level++;
1288 $type = '#';
1289 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001290 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001291 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001292 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001293 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001294
Andy Whitcroft773647a2008-03-28 14:15:58 -07001295 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001296
1297 # Handle nested #if/#else.
1298 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1299 push(@stack, [ $type, $level ]);
1300 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1301 ($type, $level) = @{$stack[$#stack - 1]};
1302 } elsif ($remainder =~ /^#\s*endif\b/) {
1303 ($type, $level) = @{pop(@stack)};
1304 }
1305
Andy Whitcroft8905a672007-11-28 16:21:06 -08001306 # Statement ends at the ';' or a close '}' at the
1307 # outermost level.
1308 if ($level == 0 && $c eq ';') {
1309 last;
1310 }
1311
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001312 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001313 if ($level == 0 && $coff_set == 0 &&
1314 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1315 $remainder =~ /^(else)(?:\s|{)/ &&
1316 $remainder !~ /^else\s+if\b/) {
1317 $coff = $off + length($1) - 1;
1318 $coff_set = 1;
1319 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1320 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001321 }
1322
Andy Whitcroft8905a672007-11-28 16:21:06 -08001323 if (($type eq '' || $type eq '(') && $c eq '(') {
1324 $level++;
1325 $type = '(';
1326 }
1327 if ($type eq '(' && $c eq ')') {
1328 $level--;
1329 $type = ($level != 0)? '(' : '';
1330
1331 if ($level == 0 && $coff < $soff) {
1332 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001333 $coff_set = 1;
1334 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001335 }
1336 }
1337 if (($type eq '' || $type eq '{') && $c eq '{') {
1338 $level++;
1339 $type = '{';
1340 }
1341 if ($type eq '{' && $c eq '}') {
1342 $level--;
1343 $type = ($level != 0)? '{' : '';
1344
1345 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001346 if (substr($blk, $off + 1, 1) eq ';') {
1347 $off++;
1348 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001349 last;
1350 }
1351 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001352 # Preprocessor commands end at the newline unless escaped.
1353 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1354 $level--;
1355 $type = '';
1356 $off++;
1357 last;
1358 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001359 $off++;
1360 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001361 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001362 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001363 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001364 $line++;
1365 $remain--;
1366 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001367
1368 my $statement = substr($blk, $soff, $off - $soff + 1);
1369 my $condition = substr($blk, $soff, $coff - $soff + 1);
1370
1371 #warn "STATEMENT<$statement>\n";
1372 #warn "CONDITION<$condition>\n";
1373
Andy Whitcroft773647a2008-03-28 14:15:58 -07001374 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001375
1376 return ($statement, $condition,
1377 $line, $remain + 1, $off - $loff + 1, $level);
1378}
1379
Andy Whitcroftcf655042008-03-04 14:28:20 -08001380sub statement_lines {
1381 my ($stmt) = @_;
1382
1383 # Strip the diff line prefixes and rip blank lines at start and end.
1384 $stmt =~ s/(^|\n)./$1/g;
1385 $stmt =~ s/^\s*//;
1386 $stmt =~ s/\s*$//;
1387
1388 my @stmt_lines = ($stmt =~ /\n/g);
1389
1390 return $#stmt_lines + 2;
1391}
1392
1393sub statement_rawlines {
1394 my ($stmt) = @_;
1395
1396 my @stmt_lines = ($stmt =~ /\n/g);
1397
1398 return $#stmt_lines + 2;
1399}
1400
1401sub statement_block_size {
1402 my ($stmt) = @_;
1403
1404 $stmt =~ s/(^|\n)./$1/g;
1405 $stmt =~ s/^\s*{//;
1406 $stmt =~ s/}\s*$//;
1407 $stmt =~ s/^\s*//;
1408 $stmt =~ s/\s*$//;
1409
1410 my @stmt_lines = ($stmt =~ /\n/g);
1411 my @stmt_statements = ($stmt =~ /;/g);
1412
1413 my $stmt_lines = $#stmt_lines + 2;
1414 my $stmt_statements = $#stmt_statements + 1;
1415
1416 if ($stmt_lines > $stmt_statements) {
1417 return $stmt_lines;
1418 } else {
1419 return $stmt_statements;
1420 }
1421}
1422
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001423sub ctx_statement_full {
1424 my ($linenr, $remain, $off) = @_;
1425 my ($statement, $condition, $level);
1426
1427 my (@chunks);
1428
Andy Whitcroftcf655042008-03-04 14:28:20 -08001429 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001430 ($statement, $condition, $linenr, $remain, $off, $level) =
1431 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001432 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001433 push(@chunks, [ $condition, $statement ]);
1434 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1435 return ($level, $linenr, @chunks);
1436 }
1437
1438 # Pull in the following conditional/block pairs and see if they
1439 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001440 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001441 ($statement, $condition, $linenr, $remain, $off, $level) =
1442 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001443 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001444 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001445 #print "C: push\n";
1446 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001447 }
1448
1449 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001450}
1451
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001452sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001453 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001454 my $line;
1455 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001456 my $blk = '';
1457 my @o;
1458 my @c;
1459 my @res = ();
1460
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001461 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001462 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001463 for ($line = $start; $remain > 0; $line++) {
1464 next if ($rawlines[$line] =~ /^-/);
1465 $remain--;
1466
1467 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001468
1469 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001470 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001471 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001472 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001473 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001474 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001475 $level = pop(@stack);
1476 }
1477
Andy Whitcroft01464f32010-10-26 14:23:19 -07001478 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001479 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1480 if ($off > 0) {
1481 $off--;
1482 next;
1483 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001484
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001485 if ($c eq $close && $level > 0) {
1486 $level--;
1487 last if ($level == 0);
1488 } elsif ($c eq $open) {
1489 $level++;
1490 }
1491 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001492
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001493 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001494 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001495 }
1496
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001497 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001498 }
1499
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001500 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001501}
1502sub ctx_block_outer {
1503 my ($linenr, $remain) = @_;
1504
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001505 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1506 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001507}
1508sub ctx_block {
1509 my ($linenr, $remain) = @_;
1510
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001511 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1512 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001513}
1514sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001515 my ($linenr, $remain, $off) = @_;
1516
1517 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1518 return @r;
1519}
1520sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001521 my ($linenr, $remain) = @_;
1522
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001523 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001524}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001525sub ctx_statement_level {
1526 my ($linenr, $remain, $off) = @_;
1527
1528 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1529}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001530
1531sub ctx_locate_comment {
1532 my ($first_line, $end_line) = @_;
1533
1534 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001535 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001536 return $current_comment if (defined $current_comment);
1537
1538 # Look through the context and try and figure out if there is a
1539 # comment.
1540 my $in_comment = 0;
1541 $current_comment = '';
1542 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001543 my $line = $rawlines[$linenr - 1];
1544 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001545 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1546 $in_comment = 1;
1547 }
1548 if ($line =~ m@/\*@) {
1549 $in_comment = 1;
1550 }
1551 if (!$in_comment && $current_comment ne '') {
1552 $current_comment = '';
1553 }
1554 $current_comment .= $line . "\n" if ($in_comment);
1555 if ($line =~ m@\*/@) {
1556 $in_comment = 0;
1557 }
1558 }
1559
1560 chomp($current_comment);
1561 return($current_comment);
1562}
1563sub ctx_has_comment {
1564 my ($first_line, $end_line) = @_;
1565 my $cmt = ctx_locate_comment($first_line, $end_line);
1566
Andy Whitcroft00df3442007-06-08 13:47:06 -07001567 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001568 ##print "CMMT: $cmt\n";
1569
1570 return ($cmt ne '');
1571}
1572
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001573sub raw_line {
1574 my ($linenr, $cnt) = @_;
1575
1576 my $offset = $linenr - 1;
1577 $cnt++;
1578
1579 my $line;
1580 while ($cnt) {
1581 $line = $rawlines[$offset++];
1582 next if (defined($line) && $line =~ /^-/);
1583 $cnt--;
1584 }
1585
1586 return $line;
1587}
1588
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001589sub cat_vet {
1590 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001591 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001592
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001593 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001594 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1595 $res .= $1;
1596 if ($2 ne '') {
1597 $coded = sprintf("^%c", unpack('C', $2) + 64);
1598 $res .= $coded;
1599 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001600 }
1601 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001602
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001603 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001604}
1605
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001606my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001607my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001608my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001609my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001610
1611sub annotate_reset {
1612 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001613 $av_pending = '_';
1614 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001615 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001616}
1617
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001618sub annotate_values {
1619 my ($stream, $type) = @_;
1620
1621 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001622 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001623 my $cur = $stream;
1624
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001625 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001626
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001627 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001628 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001629 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001630 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001631 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001632 print "WS($1)\n" if ($dbg_values > 1);
1633 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001634 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001635 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001636 }
1637
Florian Micklerc023e4732011-01-12 16:59:58 -08001638 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001639 print "CAST($1)\n" if ($dbg_values > 1);
1640 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001641 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001642
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001643 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001644 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001645 $type = 'T';
1646
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001647 } elsif ($cur =~ /^($Modifier)\s*/) {
1648 print "MODIFIER($1)\n" if ($dbg_values > 1);
1649 $type = 'T';
1650
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001651 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001652 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001653 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001654 push(@av_paren_type, $type);
1655 if ($2 ne '') {
1656 $av_pending = 'N';
1657 }
1658 $type = 'E';
1659
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001660 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001661 print "UNDEF($1)\n" if ($dbg_values > 1);
1662 $av_preprocessor = 1;
1663 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001664
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001665 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001666 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001667 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001668
1669 push(@av_paren_type, $type);
1670 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001671 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001672
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001673 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001674 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1675 $av_preprocessor = 1;
1676
1677 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1678
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001679 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001680
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001681 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001682 print "PRE_END($1)\n" if ($dbg_values > 1);
1683
1684 $av_preprocessor = 1;
1685
1686 # Assume all arms of the conditional end as this
1687 # one does, and continue as if the #endif was not here.
1688 pop(@av_paren_type);
1689 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001690 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001691
1692 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001693 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001694
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001695 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1696 print "ATTR($1)\n" if ($dbg_values > 1);
1697 $av_pending = $type;
1698 $type = 'N';
1699
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001700 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001701 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001702 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001703 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001704 }
1705 $type = 'N';
1706
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001707 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001708 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001709 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001710 $type = 'N';
1711
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001712 } elsif ($cur =~/^(case)/o) {
1713 print "CASE($1)\n" if ($dbg_values > 1);
1714 $av_pend_colon = 'C';
1715 $type = 'N';
1716
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001717 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001718 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001719 $type = 'N';
1720
1721 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001722 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001723 push(@av_paren_type, $av_pending);
1724 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001725 $type = 'N';
1726
1727 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001728 my $new_type = pop(@av_paren_type);
1729 if ($new_type ne '_') {
1730 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001731 print "PAREN('$1') -> $type\n"
1732 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001733 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001734 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001735 }
1736
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001737 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001738 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001739 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001740 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001741
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001742 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1743 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001744 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001745 } elsif ($type eq 'E') {
1746 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001747 }
1748 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1749 $type = 'V';
1750
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001751 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001752 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001753 $type = 'V';
1754
1755 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001756 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001757 $type = 'N';
1758
Andy Whitcroftcf655042008-03-04 14:28:20 -08001759 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001760 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001761 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001762 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001763
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001764 } elsif ($cur =~/^(,)/) {
1765 print "COMMA($1)\n" if ($dbg_values > 1);
1766 $type = 'C';
1767
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001768 } elsif ($cur =~ /^(\?)/o) {
1769 print "QUESTION($1)\n" if ($dbg_values > 1);
1770 $type = 'N';
1771
1772 } elsif ($cur =~ /^(:)/o) {
1773 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1774
1775 substr($var, length($res), 1, $av_pend_colon);
1776 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1777 $type = 'E';
1778 } else {
1779 $type = 'N';
1780 }
1781 $av_pend_colon = 'O';
1782
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001783 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001784 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001785 $type = 'N';
1786
Andy Whitcroft0d413862008-10-15 22:02:16 -07001787 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001788 my $variant;
1789
1790 print "OPV($1)\n" if ($dbg_values > 1);
1791 if ($type eq 'V') {
1792 $variant = 'B';
1793 } else {
1794 $variant = 'U';
1795 }
1796
1797 substr($var, length($res), 1, $variant);
1798 $type = 'N';
1799
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001800 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001801 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001802 if ($1 ne '++' && $1 ne '--') {
1803 $type = 'N';
1804 }
1805
1806 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001807 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001808 }
1809 if (defined $1) {
1810 $cur = substr($cur, length($1));
1811 $res .= $type x length($1);
1812 }
1813 }
1814
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001815 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001816}
1817
Andy Whitcroft8905a672007-11-28 16:21:06 -08001818sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001819 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001820 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001821 ^(?:
1822 $Modifier|
1823 $Storage|
1824 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001825 DEFINE_\S+
1826 )$|
1827 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001828 goto|
1829 return|
1830 case|
1831 else|
1832 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001833 do|
1834 \#|
1835 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001836 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001837 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001838 )}x;
1839 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1840 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001841 # Check for modifiers.
1842 $possible =~ s/\s*$Storage\s*//g;
1843 $possible =~ s/\s*$Sparse\s*//g;
1844 if ($possible =~ /^\s*$/) {
1845
1846 } elsif ($possible =~ /\s/) {
1847 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001848 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001849 if ($modifier !~ $notPermitted) {
1850 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001851 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001852 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001853 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001854
1855 } else {
1856 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001857 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001858 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001859 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001860 } else {
1861 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001862 }
1863}
1864
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001865my $prefix = '';
1866
Joe Perches000d1cc12011-07-25 17:13:25 -07001867sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001868 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001869
Alexey Dobriyan522b8372017-02-27 14:30:05 -08001870 $type =~ tr/[a-z]/[A-Z]/;
1871
Joe Perchescbec18a2014-04-03 14:49:19 -07001872 return defined $use_type{$type} if (scalar keys %use_type > 0);
1873
1874 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001875}
1876
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001877sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001878 my ($level, $type, $msg) = @_;
1879
1880 if (!show_type($type) ||
1881 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001882 return 0;
1883 }
Joe Perches57230292015-06-25 15:03:03 -07001884 my $output = '';
1885 if (-t STDOUT && $color) {
1886 if ($level eq 'ERROR') {
1887 $output .= RED;
1888 } elsif ($level eq 'WARNING') {
1889 $output .= YELLOW;
1890 } else {
1891 $output .= GREEN;
1892 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001893 }
Joe Perches57230292015-06-25 15:03:03 -07001894 $output .= $prefix . $level . ':';
1895 if ($show_types) {
1896 $output .= BLUE if (-t STDOUT && $color);
1897 $output .= "$type:";
1898 }
1899 $output .= RESET if (-t STDOUT && $color);
1900 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001901
1902 if ($showfile) {
1903 my @lines = split("\n", $output, -1);
1904 splice(@lines, 1, 1);
1905 $output = join("\n", @lines);
1906 }
Joe Perches57230292015-06-25 15:03:03 -07001907 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001908
Joe Perches57230292015-06-25 15:03:03 -07001909 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001910
1911 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001912}
Joe Perchescbec18a2014-04-03 14:49:19 -07001913
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001914sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001915 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001916}
Joe Perches000d1cc12011-07-25 17:13:25 -07001917
Joe Perchesd752fcc2014-08-06 16:11:05 -07001918sub fixup_current_range {
1919 my ($lineRef, $offset, $length) = @_;
1920
1921 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1922 my $o = $1;
1923 my $l = $2;
1924 my $no = $o + $offset;
1925 my $nl = $l + $length;
1926 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1927 }
1928}
1929
1930sub fix_inserted_deleted_lines {
1931 my ($linesRef, $insertedRef, $deletedRef) = @_;
1932
1933 my $range_last_linenr = 0;
1934 my $delta_offset = 0;
1935
1936 my $old_linenr = 0;
1937 my $new_linenr = 0;
1938
1939 my $next_insert = 0;
1940 my $next_delete = 0;
1941
1942 my @lines = ();
1943
1944 my $inserted = @{$insertedRef}[$next_insert++];
1945 my $deleted = @{$deletedRef}[$next_delete++];
1946
1947 foreach my $old_line (@{$linesRef}) {
1948 my $save_line = 1;
1949 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07001950 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07001951 $delta_offset = 0;
1952 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1953 $range_last_linenr = $new_linenr;
1954 fixup_current_range(\$line, $delta_offset, 0);
1955 }
1956
1957 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1958 $deleted = @{$deletedRef}[$next_delete++];
1959 $save_line = 0;
1960 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1961 }
1962
1963 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1964 push(@lines, ${$inserted}{'LINE'});
1965 $inserted = @{$insertedRef}[$next_insert++];
1966 $new_linenr++;
1967 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1968 }
1969
1970 if ($save_line) {
1971 push(@lines, $line);
1972 $new_linenr++;
1973 }
1974
1975 $old_linenr++;
1976 }
1977
1978 return @lines;
1979}
1980
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001981sub fix_insert_line {
1982 my ($linenr, $line) = @_;
1983
1984 my $inserted = {
1985 LINENR => $linenr,
1986 LINE => $line,
1987 };
1988 push(@fixed_inserted, $inserted);
1989}
1990
1991sub fix_delete_line {
1992 my ($linenr, $line) = @_;
1993
1994 my $deleted = {
1995 LINENR => $linenr,
1996 LINE => $line,
1997 };
1998
1999 push(@fixed_deleted, $deleted);
2000}
2001
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002002sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002003 my ($type, $msg) = @_;
2004
2005 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002006 our $clean = 0;
2007 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002008 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002009 }
Joe Perches3705ce52013-07-03 15:05:31 -07002010 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002011}
2012sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002013 my ($type, $msg) = @_;
2014
2015 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002016 our $clean = 0;
2017 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002018 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002019 }
Joe Perches3705ce52013-07-03 15:05:31 -07002020 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002021}
2022sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002023 my ($type, $msg) = @_;
2024
2025 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002026 our $clean = 0;
2027 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002028 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002029 }
Joe Perches3705ce52013-07-03 15:05:31 -07002030 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002031}
2032
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002033sub check_absolute_file {
2034 my ($absolute, $herecurr) = @_;
2035 my $file = $absolute;
2036
2037 ##print "absolute<$absolute>\n";
2038
2039 # See if any suffix of this path is a path within the tree.
2040 while ($file =~ s@^[^/]*/@@) {
2041 if (-f "$root/$file") {
2042 ##print "file<$file>\n";
2043 last;
2044 }
2045 }
2046 if (! -f _) {
2047 return 0;
2048 }
2049
2050 # It is, so see if the prefix is acceptable.
2051 my $prefix = $absolute;
2052 substr($prefix, -length($file)) = '';
2053
2054 ##print "prefix<$prefix>\n";
2055 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002056 WARN("USE_RELATIVE_PATH",
2057 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002058 }
2059}
2060
Joe Perches3705ce52013-07-03 15:05:31 -07002061sub trim {
2062 my ($string) = @_;
2063
Joe Perchesb34c6482013-09-11 14:24:01 -07002064 $string =~ s/^\s+|\s+$//g;
2065
2066 return $string;
2067}
2068
2069sub ltrim {
2070 my ($string) = @_;
2071
2072 $string =~ s/^\s+//;
2073
2074 return $string;
2075}
2076
2077sub rtrim {
2078 my ($string) = @_;
2079
2080 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002081
2082 return $string;
2083}
2084
Joe Perches52ea8502013-11-12 15:10:09 -08002085sub string_find_replace {
2086 my ($string, $find, $replace) = @_;
2087
2088 $string =~ s/$find/$replace/g;
2089
2090 return $string;
2091}
2092
Joe Perches3705ce52013-07-03 15:05:31 -07002093sub tabify {
2094 my ($leading) = @_;
2095
2096 my $source_indent = 8;
2097 my $max_spaces_before_tab = $source_indent - 1;
2098 my $spaces_to_tab = " " x $source_indent;
2099
2100 #convert leading spaces to tabs
2101 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2102 #Remove spaces before a tab
2103 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2104
2105 return "$leading";
2106}
2107
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002108sub pos_last_openparen {
2109 my ($line) = @_;
2110
2111 my $pos = 0;
2112
2113 my $opens = $line =~ tr/\(/\(/;
2114 my $closes = $line =~ tr/\)/\)/;
2115
2116 my $last_openparen = 0;
2117
2118 if (($opens == 0) || ($closes >= $opens)) {
2119 return -1;
2120 }
2121
2122 my $len = length($line);
2123
2124 for ($pos = 0; $pos < $len; $pos++) {
2125 my $string = substr($line, $pos);
2126 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2127 $pos += length($1) - 1;
2128 } elsif (substr($line, $pos, 1) eq '(') {
2129 $last_openparen = $pos;
2130 } elsif (index($string, '(') == -1) {
2131 last;
2132 }
2133 }
2134
Joe Perches91cb5192014-04-03 14:49:32 -07002135 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002136}
2137
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002138sub process {
2139 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002140
2141 my $linenr=0;
2142 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002143 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002144 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002145 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002146
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002147 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002148 my $indent;
2149 my $previndent=0;
2150 my $stashindent=0;
2151
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002152 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002153 my $signoff = 0;
2154 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002155 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002156 my $in_commit_log = 0; #Scanning lines before patch
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002157 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches77cb8542017-02-24 15:01:28 -08002158 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002159 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002160 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002161 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002162 my $non_utf8_charset = 0;
2163
Joe Perches365dd4e2014-08-06 16:10:42 -07002164 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002165 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002166
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002167 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002168 our $cnt_lines = 0;
2169 our $cnt_error = 0;
2170 our $cnt_warn = 0;
2171 our $cnt_chk = 0;
2172
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002173 # Trace the real file/line as we go.
2174 my $realfile = '';
2175 my $realline = 0;
2176 my $realcnt = 0;
2177 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002178 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002179 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002180 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002181 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002182 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002183
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002184 my $prev_values = 'E';
2185
2186 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002187 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002188 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002189 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002190 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002191
Joe Perches7e51f192013-09-11 14:23:57 -07002192 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002193
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002194 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002195 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002196 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002197 my @setup_docs = ();
2198 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002199
Joe Perchesd8b07712013-11-12 15:10:06 -08002200 my $camelcase_file_seeded = 0;
2201
Andy Whitcroft773647a2008-03-28 14:15:58 -07002202 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002203 my $line;
2204 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002205 $linenr++;
2206 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002207
Joe Perches3705ce52013-07-03 15:05:31 -07002208 push(@fixed, $rawline) if ($fix);
2209
Andy Whitcroft773647a2008-03-28 14:15:58 -07002210 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002211 $setup_docs = 0;
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02002212 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002213 $setup_docs = 1;
2214 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002215 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002216 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002217 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002218 $realline=$1-1;
2219 if (defined $2) {
2220 $realcnt=$3+1;
2221 } else {
2222 $realcnt=1+1;
2223 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002224 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002225
2226 # Guestimate if this is a continuing comment. Run
2227 # the context looking for a comment "edge". If this
2228 # edge is a close comment then we must be in a comment
2229 # at context start.
2230 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002231 my $cnt = $realcnt;
2232 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2233 next if (defined $rawlines[$ln - 1] &&
2234 $rawlines[$ln - 1] =~ /^-/);
2235 $cnt--;
2236 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002237 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002238 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2239 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2240 ($edge) = $1;
2241 last;
2242 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002243 }
2244 if (defined $edge && $edge eq '*/') {
2245 $in_comment = 1;
2246 }
2247
2248 # Guestimate if this is a continuing comment. If this
2249 # is the start of a diff block and this line starts
2250 # ' *' then it is very likely a comment.
2251 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002252 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002253 {
2254 $in_comment = 1;
2255 }
2256
2257 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2258 sanitise_line_reset($in_comment);
2259
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002260 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002261 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002262 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002263 $line = sanitise_line($rawline);
2264 }
2265 push(@lines, $line);
2266
2267 if ($realcnt > 1) {
2268 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2269 } else {
2270 $realcnt = 0;
2271 }
2272
2273 #print "==>$rawline\n";
2274 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002275
2276 if ($setup_docs && $line =~ /^\+/) {
2277 push(@setup_docs, $line);
2278 }
2279 }
2280
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002281 $prefix = '';
2282
Andy Whitcroft773647a2008-03-28 14:15:58 -07002283 $realcnt = 0;
2284 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002285 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002286 foreach my $line (@lines) {
2287 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002288 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002289 my $sline = $line; #copy of $line
2290 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002291
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002292 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002293
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002294#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002295 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002296 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2297 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002298 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002299 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002300 $realline=$1-1;
2301 if (defined $2) {
2302 $realcnt=$3+1;
2303 } else {
2304 $realcnt=1+1;
2305 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002306 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002307 $prev_values = 'E';
2308
Andy Whitcroft773647a2008-03-28 14:15:58 -07002309 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002310 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002311 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002312 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002313 if ($context =~ /\b(\w+)\s*\(/) {
2314 $context_function = $1;
2315 } else {
2316 undef $context_function;
2317 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002318 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002319
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002320# track the line number as we move through the hunk, note that
2321# new versions of GNU diff omit the leading space on completely
2322# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002323 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002324 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002325 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002326
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002327 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002328 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002329
2330 # Track the previous line.
2331 ($prevline, $stashline) = ($stashline, $line);
2332 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002333 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2334
Andy Whitcroft773647a2008-03-28 14:15:58 -07002335 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002336
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002337 } elsif ($realcnt == 1) {
2338 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002339 }
2340
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002341 my $hunk_line = ($realcnt != 0);
2342
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002343 $here = "#$linenr: " if (!$file);
2344 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002345
Joe Perches2ac73b42014-06-04 16:12:05 -07002346 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002347 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002348 if ($line =~ /^diff --git.*?(\S+)$/) {
2349 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002350 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002351 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002352 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002353 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002354 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002355 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002356 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002357
2358 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002359 if (!$file && $tree && $p1_prefix ne '' &&
2360 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002361 WARN("PATCH_PREFIX",
2362 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002363 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002364
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002365 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002366 ERROR("MODIFIED_INCLUDE_ASM",
2367 "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 -07002368 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002369 $found_file = 1;
2370 }
2371
Joe Perches34d88152015-06-25 15:03:05 -07002372#make up the handle for any error we report on this line
2373 if ($showfile) {
2374 $prefix = "$realfile:$realline: "
2375 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002376 if ($file) {
2377 $prefix = "$filename:$realline: ";
2378 } else {
2379 $prefix = "$filename:$linenr: ";
2380 }
Joe Perches34d88152015-06-25 15:03:05 -07002381 }
2382
Joe Perches2ac73b42014-06-04 16:12:05 -07002383 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002384 if (is_maintained_obsolete($realfile)) {
2385 WARN("OBSOLETE",
2386 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2387 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002388 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002389 $check = 1;
2390 } else {
2391 $check = $check_orig;
2392 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002393 next;
2394 }
2395
Randy Dunlap389834b2007-06-08 13:47:03 -07002396 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002397
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002398 my $hereline = "$here\n$rawline\n";
2399 my $herecurr = "$here\n$rawline\n";
2400 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002401
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002402 $cnt_lines++ if ($realcnt != 0);
2403
Joe Perchese518e9a2015-06-25 15:03:27 -07002404# Check if the commit log has what seems like a diff which can confuse patch
2405 if ($in_commit_log && !$commit_log_has_diff &&
2406 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2407 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2408 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2409 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2410 ERROR("DIFF_IN_COMMIT_MSG",
2411 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2412 $commit_log_has_diff = 1;
2413 }
2414
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002415# Check for incorrect file permissions
2416 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2417 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002418 if ($realfile !~ m@scripts/@ &&
2419 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002420 ERROR("EXECUTE_PERMISSIONS",
2421 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002422 }
2423 }
2424
Joe Perches20112472011-07-25 17:13:23 -07002425# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002426 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002427 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002428 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002429 }
2430
Joe Perchese0d975b2014-12-10 15:51:49 -08002431# Check if MAINTAINERS is being updated. If so, there's probably no need to
2432# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2433 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2434 $reported_maintainer_file = 1;
2435 }
2436
Joe Perches20112472011-07-25 17:13:23 -07002437# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002438 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002439 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002440 my $space_before = $1;
2441 my $sign_off = $2;
2442 my $space_after = $3;
2443 my $email = $4;
2444 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2445
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002446 if ($sign_off !~ /$signature_tags/) {
2447 WARN("BAD_SIGN_OFF",
2448 "Non-standard signature: $sign_off\n" . $herecurr);
2449 }
Joe Perches20112472011-07-25 17:13:23 -07002450 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002451 if (WARN("BAD_SIGN_OFF",
2452 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2453 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002454 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002455 "$ucfirst_sign_off $email";
2456 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002457 }
Joe Perches20112472011-07-25 17:13:23 -07002458 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002459 if (WARN("BAD_SIGN_OFF",
2460 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2461 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002462 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002463 "$ucfirst_sign_off $email";
2464 }
2465
Joe Perches20112472011-07-25 17:13:23 -07002466 }
2467 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002468 if (WARN("BAD_SIGN_OFF",
2469 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2470 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002471 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002472 "$ucfirst_sign_off $email";
2473 }
Joe Perches20112472011-07-25 17:13:23 -07002474 }
2475
2476 my ($email_name, $email_address, $comment) = parse_email($email);
2477 my $suggested_email = format_email(($email_name, $email_address));
2478 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002479 ERROR("BAD_SIGN_OFF",
2480 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002481 } else {
2482 my $dequoted = $suggested_email;
2483 $dequoted =~ s/^"//;
2484 $dequoted =~ s/" </ </;
2485 # Don't force email to have quotes
2486 # Allow just an angle bracketed address
2487 if ("$dequoted$comment" ne $email &&
2488 "<$email_address>$comment" ne $email &&
2489 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002490 WARN("BAD_SIGN_OFF",
2491 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002492 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002493 }
Joe Perches7e51f192013-09-11 14:23:57 -07002494
2495# Check for duplicate signatures
2496 my $sig_nospace = $line;
2497 $sig_nospace =~ s/\s//g;
2498 $sig_nospace = lc($sig_nospace);
2499 if (defined $signatures{$sig_nospace}) {
2500 WARN("BAD_SIGN_OFF",
2501 "Duplicate signature\n" . $herecurr);
2502 } else {
2503 $signatures{$sig_nospace} = 1;
2504 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002505 }
2506
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002507# Check email subject for common tools that don't need to be mentioned
2508 if ($in_header_lines &&
2509 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2510 WARN("EMAIL_SUBJECT",
2511 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2512 }
2513
Joe Perches9b3189e2014-06-04 16:12:10 -07002514# Check for old stable address
2515 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2516 ERROR("STABLE_ADDRESS",
2517 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2518 }
2519
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002520# Check for unwanted Gerrit info
2521 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2522 ERROR("GERRIT_CHANGE_ID",
2523 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2524 }
2525
Joe Perches369c8dd2015-11-06 16:31:34 -08002526# Check if the commit log is in a possible stack dump
2527 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2528 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2529 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2530 # timestamp
2531 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2532 # stack dump address
2533 $commit_log_possible_stack_dump = 1;
2534 }
2535
Joe Perches2a076f42015-04-16 12:44:28 -07002536# Check for line lengths > 75 in commit log, warn once
2537 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002538 length($line) > 75 &&
2539 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2540 # file delta changes
2541 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2542 # filename then :
2543 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2544 # A Fixes: or Link: line
2545 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002546 WARN("COMMIT_LOG_LONG_LINE",
2547 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2548 $commit_log_long_line = 1;
2549 }
2550
Joe Perchesbf4daf12015-09-09 15:37:50 -07002551# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002552 if ($in_commit_log && $commit_log_possible_stack_dump &&
2553 $line =~ /^\s*$/) {
2554 $commit_log_possible_stack_dump = 0;
2555 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002556
Joe Perches0d7835f2015-02-13 14:38:35 -08002557# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002558 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002559 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07002560 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002561 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002562 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002563 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2564 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002565 my $init_char = "c";
2566 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002567 my $short = 1;
2568 my $long = 0;
2569 my $case = 1;
2570 my $space = 1;
2571 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002572 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002573 my $id = '0123456789ab';
2574 my $orig_desc = "commit description";
2575 my $description = "";
2576
Joe Perchesfe043ea2015-09-09 15:37:25 -07002577 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2578 $init_char = $1;
2579 $orig_commit = lc($2);
2580 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2581 $orig_commit = lc($1);
2582 }
2583
Joe Perches0d7835f2015-02-13 14:38:35 -08002584 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2585 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2586 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2587 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2588 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2589 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002590 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002591 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2592 defined $rawlines[$linenr] &&
2593 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2594 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002595 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002596 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2597 defined $rawlines[$linenr] &&
2598 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2599 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2600 $orig_desc = $1;
2601 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2602 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002603 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002604 }
2605
2606 ($id, $description) = git_commit_info($orig_commit,
2607 $id, $orig_desc);
2608
Joe Perches19c146a2015-02-13 14:39:00 -08002609 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002610 ERROR("GIT_COMMIT_ID",
2611 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2612 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002613 }
2614
Joe Perches13f19372014-08-06 16:10:59 -07002615# Check for added, moved or deleted files
2616 if (!$reported_maintainer_file && !$in_commit_log &&
2617 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2618 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2619 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2620 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08002621 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07002622 $reported_maintainer_file = 1;
2623 WARN("FILE_PATH_CHANGES",
2624 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2625 }
2626
Andy Whitcroft00df3442007-06-08 13:47:06 -07002627# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002628 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002629 ERROR("CORRUPTED_PATCH",
2630 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002631 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002632 }
2633
2634# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2635 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002636 $rawline !~ m/^$UTF8*$/) {
2637 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2638
2639 my $blank = copy_spacing($rawline);
2640 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2641 my $hereptr = "$hereline$ptr\n";
2642
Joe Perches34d99212011-07-25 17:13:26 -07002643 CHK("INVALID_UTF8",
2644 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002645 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002646
Joe Perches15662b32011-10-31 17:13:12 -07002647# Check if it's the start of a commit log
2648# (not a header line and we haven't seen the patch filename)
2649 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07002650 !($rawline =~ /^\s+(?:\S|$)/ ||
2651 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002652 $in_header_lines = 0;
2653 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002654 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002655 }
2656
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002657# Check if there is UTF-8 in a commit log when a mail header has explicitly
2658# declined it, i.e defined some charset where it is missing.
2659 if ($in_header_lines &&
2660 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2661 $1 !~ /utf-8/i) {
2662 $non_utf8_charset = 1;
2663 }
2664
2665 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002666 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002667 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002668 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2669 }
2670
Joe Perchesd6430f72016-12-12 16:46:28 -08002671# Check for absolute kernel paths in commit message
2672 if ($tree && $in_commit_log) {
2673 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2674 my $file = $1;
2675
2676 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2677 check_absolute_file($1, $herecurr)) {
2678 #
2679 } else {
2680 check_absolute_file($file, $herecurr);
2681 }
2682 }
2683 }
2684
Kees Cook66b47b42014-10-13 15:51:57 -07002685# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002686 if (defined($misspellings) &&
2687 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002688 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002689 my $typo = $1;
2690 my $typo_fix = $spelling_fix{lc($typo)};
2691 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2692 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2693 my $msg_type = \&WARN;
2694 $msg_type = \&CHK if ($file);
2695 if (&{$msg_type}("TYPO_SPELLING",
2696 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2697 $fix) {
2698 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2699 }
2700 }
2701 }
2702
Andy Whitcroft306708542008-10-15 22:02:28 -07002703# ignore non-hunk lines and lines being removed
2704 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002705
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002706#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002707 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002708 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002709 if (ERROR("DOS_LINE_ENDINGS",
2710 "DOS line endings\n" . $herevet) &&
2711 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002712 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002713 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002714 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2715 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002716 if (ERROR("TRAILING_WHITESPACE",
2717 "trailing whitespace\n" . $herevet) &&
2718 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002719 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002720 }
2721
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002722 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002723 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002724
Josh Triplett4783f892013-11-12 15:10:12 -08002725# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002726 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08002727 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002728 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2729 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002730 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2731 my $msg_type = \&ERROR;
2732 $msg_type = \&CHK if ($file);
2733 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002734 "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 -08002735 }
2736
Andi Kleen33549572010-05-24 14:33:29 -07002737# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002738# Only applies when adding the entry originally, after that we do not have
2739# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002740 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002741 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002742 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002743 my $cnt = $realcnt;
2744 my $ln = $linenr + 1;
2745 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002746 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002747 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002748 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002749 $f = $lines[$ln - 1];
2750 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2751 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002752
2753 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002754 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002755
Joe Perches8d73e0e2014-08-06 16:10:46 -07002756 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002757 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002758 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002759 $length = -1;
2760 }
2761
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002762 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002763 $f =~ s/#.*//;
2764 $f =~ s/^\s+//;
2765 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002766 if ($f =~ /^\s*config\s/) {
2767 $is_end = 1;
2768 last;
2769 }
Andi Kleen33549572010-05-24 14:33:29 -07002770 $length++;
2771 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002772 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2773 WARN("CONFIG_DESCRIPTION",
2774 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2775 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002776 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002777 }
2778
Christoph Jaeger327953e2015-02-13 14:38:29 -08002779# discourage the use of boolean for type definition attributes of Kconfig options
2780 if ($realfile =~ /Kconfig/ &&
2781 $line =~ /^\+\s*\bboolean\b/) {
2782 WARN("CONFIG_TYPE_BOOLEAN",
2783 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2784 }
2785
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002786 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2787 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2788 my $flag = $1;
2789 my $replacement = {
2790 'EXTRA_AFLAGS' => 'asflags-y',
2791 'EXTRA_CFLAGS' => 'ccflags-y',
2792 'EXTRA_CPPFLAGS' => 'cppflags-y',
2793 'EXTRA_LDFLAGS' => 'ldflags-y',
2794 };
2795
2796 WARN("DEPRECATED_VARIABLE",
2797 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2798 }
2799
Rob Herringbff5da42014-01-23 15:54:51 -08002800# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002801 if (defined $root &&
2802 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2803 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2804
Rob Herringbff5da42014-01-23 15:54:51 -08002805 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2806
Florian Vaussardcc933192014-04-03 14:49:27 -07002807 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2808 my $vp_file = $dt_path . "vendor-prefixes.txt";
2809
Rob Herringbff5da42014-01-23 15:54:51 -08002810 foreach my $compat (@compats) {
2811 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002812 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2813 my $compat3 = $compat;
2814 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2815 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002816 if ( $? >> 8 ) {
2817 WARN("UNDOCUMENTED_DT_STRING",
2818 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2819 }
2820
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002821 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2822 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002823 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002824 if ( $? >> 8 ) {
2825 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002826 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002827 }
2828 }
2829 }
2830
Andy Whitcroft5368df202008-10-15 22:02:27 -07002831# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08002832 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07002833
Joe Perches47e0c882015-06-25 15:02:57 -07002834# line length limit (with some exclusions)
2835#
2836# There are a few types of lines that may extend beyond $max_line_length:
2837# logging functions like pr_info that end in a string
2838# lines with a single string
2839# #defines that are a single string
2840#
2841# There are 3 different line length message types:
2842# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2843# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2844# LONG_LINE all other lines longer than $max_line_length
2845#
2846# if LONG_LINE is ignored, the other 2 types are also ignored
2847#
2848
Joe Perchesb4749e92015-07-17 16:24:01 -07002849 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002850 my $msg_type = "LONG_LINE";
2851
2852 # Check the allowed long line types first
2853
2854 # logging functions that end in a string that starts
2855 # before $max_line_length
2856 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2857 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2858 $msg_type = "";
2859
2860 # lines with only strings (w/ possible termination)
2861 # #defines with only strings
2862 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2863 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2864 $msg_type = "";
2865
Joe Perchesd560a5f2016-08-02 14:04:31 -07002866 # EFI_GUID is another special case
2867 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/) {
2868 $msg_type = "";
2869
Joe Perches47e0c882015-06-25 15:02:57 -07002870 # Otherwise set the alternate message types
2871
2872 # a comment starts before $max_line_length
2873 } elsif ($line =~ /($;[\s$;]*)$/ &&
2874 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2875 $msg_type = "LONG_LINE_COMMENT"
2876
2877 # a quoted string starts before $max_line_length
2878 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2879 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2880 $msg_type = "LONG_LINE_STRING"
2881 }
2882
2883 if ($msg_type ne "" &&
2884 (show_type("LONG_LINE") || show_type($msg_type))) {
2885 WARN($msg_type,
2886 "line over $max_line_length characters\n" . $herecurr);
2887 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002888 }
2889
Andy Whitcroft8905a672007-11-28 16:21:06 -08002890# check for adding lines without a newline.
2891 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002892 WARN("MISSING_EOF_NEWLINE",
2893 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002894 }
2895
Mike Frysinger42e41c52009-09-21 17:04:40 -07002896# Blackfin: use hi/lo macros
2897 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2898 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2899 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002900 ERROR("LO_MACRO",
2901 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002902 }
2903 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2904 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002905 ERROR("HI_MACRO",
2906 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002907 }
2908 }
2909
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002910# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002911 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002912
2913# at the beginning of a line any tabs must come first and anything
2914# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002915 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2916 $rawline =~ /^\+\s* \s*/) {
2917 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002918 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002919 if (ERROR("CODE_INDENT",
2920 "code indent should use tabs where possible\n" . $herevet) &&
2921 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002922 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002923 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002924 }
2925
Alberto Panizzo08e44362010-03-05 13:43:54 -08002926# check for space before tabs.
2927 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2928 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002929 if (WARN("SPACE_BEFORE_TAB",
2930 "please, no space before tabs\n" . $herevet) &&
2931 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002932 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002933 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002934 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002935 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002936 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002937 }
2938
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002939# check for && or || at the start of a line
2940 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2941 CHK("LOGICAL_CONTINUATIONS",
2942 "Logical continuations should be on the previous line\n" . $hereprev);
2943 }
2944
Joe Perchesa91e8992016-05-20 17:04:05 -07002945# check indentation starts on a tab stop
2946 if ($^V && $^V ge 5.10.0 &&
2947 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2948 my $indent = length($1);
2949 if ($indent % 8) {
2950 if (WARN("TABSTOP",
2951 "Statements should start on a tabstop\n" . $herecurr) &&
2952 $fix) {
2953 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2954 }
2955 }
2956 }
2957
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002958# check multi-line statement indentation matches previous line
2959 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002960 $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 -07002961 $prevline =~ /^\+(\t*)(.*)$/;
2962 my $oldindent = $1;
2963 my $rest = $2;
2964
2965 my $pos = pos_last_openparen($rest);
2966 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002967 $line =~ /^(\+| )([ \t]*)/;
2968 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002969
2970 my $goodtabindent = $oldindent .
2971 "\t" x ($pos / 8) .
2972 " " x ($pos % 8);
2973 my $goodspaceindent = $oldindent . " " x $pos;
2974
2975 if ($newindent ne $goodtabindent &&
2976 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002977
2978 if (CHK("PARENTHESIS_ALIGNMENT",
2979 "Alignment should match open parenthesis\n" . $hereprev) &&
2980 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002981 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002982 s/^\+[ \t]*/\+$goodtabindent/;
2983 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002984 }
2985 }
2986 }
2987
Joe Perches6ab3a972015-04-16 12:44:05 -07002988# check for space after cast like "(int) foo" or "(struct foo) bar"
2989# avoid checking a few false positives:
2990# "sizeof(<type>)" or "__alignof__(<type>)"
2991# function pointer declarations like "(*foo)(int) = bar;"
2992# structure definitions like "(struct foo) { 0 };"
2993# multiline macros that define functions
2994# known attributes or the __attribute__ keyword
2995 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2996 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002997 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002998 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002999 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003000 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003001 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003002 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003003 }
3004
Joe Perches86406b12015-09-09 15:37:41 -07003005# Block comment styles
3006# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003007 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003008 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003009 $rawline =~ /^\+[ \t]*\*/ &&
3010 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07003011 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3012 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3013 }
3014
Joe Perches86406b12015-09-09 15:37:41 -07003015# Block comments use * on subsequent lines
3016 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3017 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003018 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003019 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003020 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003021 WARN("BLOCK_COMMENT_STYLE",
3022 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003023 }
3024
Joe Perches86406b12015-09-09 15:37:41 -07003025# Block comments use */ on trailing lines
3026 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003027 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3028 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3029 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003030 WARN("BLOCK_COMMENT_STYLE",
3031 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003032 }
3033
Joe Perches08eb9b82016-10-11 13:51:50 -07003034# Block comment * alignment
3035 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003036 $line =~ /^\+[ \t]*$;/ && #leading comment
3037 $rawline =~ /^\+[ \t]*\*/ && #leading *
3038 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003039 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003040 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3041 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003042 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003043 if (defined($1)) {
3044 $oldindent = expand_tabs($1);
3045 } else {
3046 $prevrawline =~ m@^\+(.*/?)\*@;
3047 $oldindent = expand_tabs($1);
3048 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003049 $rawline =~ m@^\+([ \t]*)\*@;
3050 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003051 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003052 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003053 WARN("BLOCK_COMMENT_STYLE",
3054 "Block comments should align the * on each line\n" . $hereprev);
3055 }
3056 }
3057
Joe Perches7f619192014-08-06 16:10:39 -07003058# check for missing blank lines after struct/union declarations
3059# with exceptions for various attributes and macros
3060 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3061 $line =~ /^\+/ &&
3062 !($line =~ /^\+\s*$/ ||
3063 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3064 $line =~ /^\+\s*MODULE_/i ||
3065 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3066 $line =~ /^\+[a-z_]*init/ ||
3067 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3068 $line =~ /^\+\s*DECLARE/ ||
3069 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003070 if (CHK("LINE_SPACING",
3071 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3072 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003073 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003074 }
Joe Perches7f619192014-08-06 16:10:39 -07003075 }
3076
Joe Perches365dd4e2014-08-06 16:10:42 -07003077# check for multiple consecutive blank lines
3078 if ($prevline =~ /^[\+ ]\s*$/ &&
3079 $line =~ /^\+\s*$/ &&
3080 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003081 if (CHK("LINE_SPACING",
3082 "Please don't use multiple blank lines\n" . $hereprev) &&
3083 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003084 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003085 }
3086
Joe Perches365dd4e2014-08-06 16:10:42 -07003087 $last_blank_line = $linenr;
3088 }
3089
Joe Perches3b617e32014-04-03 14:49:28 -07003090# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003091 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3092 # actual declarations
3093 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003094 # function pointer declarations
3095 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003096 # foo bar; where foo is some local typedef or #define
3097 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3098 # known declaration macros
3099 $prevline =~ /^\+\s+$declaration_macros/) &&
3100 # for "else if" which can look like "$Ident $Ident"
3101 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3102 # other possible extensions of declaration lines
3103 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3104 # not starting a section or a macro "\" extended line
3105 $prevline =~ /(?:\{\s*|\\)$/) &&
3106 # looks like a declaration
3107 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003108 # function pointer declarations
3109 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003110 # foo bar; where foo is some local typedef or #define
3111 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3112 # known declaration macros
3113 $sline =~ /^\+\s+$declaration_macros/ ||
3114 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07003115 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003116 # start or end of block or continuation of declaration
3117 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3118 # bitfield continuation
3119 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3120 # other possible extensions of declaration lines
3121 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3122 # indentation of previous and current line are the same
3123 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003124 if (WARN("LINE_SPACING",
3125 "Missing a blank line after declarations\n" . $hereprev) &&
3126 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003127 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003128 }
Joe Perches3b617e32014-04-03 14:49:28 -07003129 }
3130
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003131# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003132# Exceptions:
3133# 1) within comments
3134# 2) indented preprocessor commands
3135# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003136 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003137 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003138 if (WARN("LEADING_SPACE",
3139 "please, no spaces at the start of a line\n" . $herevet) &&
3140 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003141 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003142 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003143 }
3144
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003145# check we are in a valid C source file if not then ignore this hunk
3146 next if ($realfile !~ /\.(h|c)$/);
3147
Joe Perches4dbed762017-05-08 15:55:39 -07003148# check if this appears to be the start function declaration, save the name
3149 if ($sline =~ /^\+\{\s*$/ &&
3150 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3151 $context_function = $1;
3152 }
3153
3154# check if this appears to be the end of function declaration
3155 if ($sline =~ /^\+\}\s*$/) {
3156 undef $context_function;
3157 }
3158
Joe Perches032a4c02014-08-06 16:10:29 -07003159# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003160# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003161# if the previous line is a break or return and is indented 1 tab more...
3162 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3163 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003164 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3165 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3166 defined $lines[$linenr] &&
3167 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003168 WARN("UNNECESSARY_ELSE",
3169 "else is not generally useful after a break or return\n" . $hereprev);
3170 }
3171 }
3172
Joe Perchesc00df192014-08-06 16:11:01 -07003173# check indentation of a line with a break;
3174# if the previous line is a goto or return and is indented the same # of tabs
3175 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3176 my $tabs = $1;
3177 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3178 WARN("UNNECESSARY_BREAK",
3179 "break is not useful after a goto or return\n" . $hereprev);
3180 }
3181 }
3182
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003183# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003184 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003185 WARN("CVS_KEYWORD",
3186 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003187 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003188
Mike Frysinger42e41c52009-09-21 17:04:40 -07003189# Blackfin: don't use __builtin_bfin_[cs]sync
3190 if ($line =~ /__builtin_bfin_csync/) {
3191 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003192 ERROR("CSYNC",
3193 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003194 }
3195 if ($line =~ /__builtin_bfin_ssync/) {
3196 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003197 ERROR("SSYNC",
3198 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003199 }
3200
Joe Perches56e77d72013-02-21 16:44:14 -08003201# check for old HOTPLUG __dev<foo> section markings
3202 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3203 WARN("HOTPLUG_SECTION",
3204 "Using $1 is unnecessary\n" . $herecurr);
3205 }
3206
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003207# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003208 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3209 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003210#print "LINE<$line>\n";
3211 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003212 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003213 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003214 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003215 $stat =~ s/\n./\n /g;
3216 $cond =~ s/\n./\n /g;
3217
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003218#print "linenr<$linenr> <$stat>\n";
3219 # If this statement has no statement boundaries within
3220 # it there is no point in retrying a statement scan
3221 # until we hit end of it.
3222 my $frag = $stat; $frag =~ s/;+\s*$//;
3223 if ($frag !~ /(?:{|;)/) {
3224#print "skip<$line_nr_next>\n";
3225 $suppress_statement = $line_nr_next;
3226 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003227
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003228 # Find the real next line.
3229 $realline_next = $line_nr_next;
3230 if (defined $realline_next &&
3231 (!defined $lines[$realline_next - 1] ||
3232 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3233 $realline_next++;
3234 }
3235
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003236 my $s = $stat;
3237 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003238
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003239 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003240 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003241
3242 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003243 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003244
Andy Whitcroft463f2862009-09-21 17:04:34 -07003245 } elsif ($s =~ /^.\s*else\b/s) {
3246
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003247 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003248 } 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 -07003249 my $type = $1;
3250 $type =~ s/\s+/ /g;
3251 possible($type, "A:" . $s);
3252
Andy Whitcroft8905a672007-11-28 16:21:06 -08003253 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003254 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003255 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003256 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003257
3258 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003259 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003260 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003261 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003262
3263 # Check for any sort of function declaration.
3264 # int foo(something bar, other baz);
3265 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003266 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 -08003267 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003268
Andy Whitcroftcf655042008-03-04 14:28:20 -08003269 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003270 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003271 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003272
Andy Whitcroft8905a672007-11-28 16:21:06 -08003273 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003274 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003275
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003276 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003277 }
3278 }
3279 }
3280
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003281 }
3282
Andy Whitcroft653d4872007-06-23 17:16:34 -07003283#
3284# Checks which may be anchored in the context.
3285#
3286
3287# Check for switch () and associated case and default
3288# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003289 if ($line=~/\bswitch\s*\(.*\)/) {
3290 my $err = '';
3291 my $sep = '';
3292 my @ctx = ctx_block_outer($linenr, $realcnt);
3293 shift(@ctx);
3294 for my $ctx (@ctx) {
3295 my ($clen, $cindent) = line_stats($ctx);
3296 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3297 $indent != $cindent) {
3298 $err .= "$sep$ctx\n";
3299 $sep = '';
3300 } else {
3301 $sep = "[...]\n";
3302 }
3303 }
3304 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003305 ERROR("SWITCH_CASE_INDENT_LEVEL",
3306 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003307 }
3308 }
3309
3310# if/while/etc brace do not go on next line, unless defining a do while loop,
3311# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003312 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 -07003313 my $pre_ctx = "$1$2";
3314
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003315 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003316
3317 if ($line =~ /^\+\t{6,}/) {
3318 WARN("DEEP_INDENTATION",
3319 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3320 }
3321
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003322 my $ctx_cnt = $realcnt - $#ctx - 1;
3323 my $ctx = join("\n", @ctx);
3324
Andy Whitcroft548596d2008-07-23 21:29:01 -07003325 my $ctx_ln = $linenr;
3326 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003327
Andy Whitcroft548596d2008-07-23 21:29:01 -07003328 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3329 defined $lines[$ctx_ln - 1] &&
3330 $lines[$ctx_ln - 1] =~ /^-/)) {
3331 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3332 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003333 $ctx_ln++;
3334 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003335
Andy Whitcroft53210162008-07-23 21:29:03 -07003336 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3337 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003338
Joe Perchesd752fcc2014-08-06 16:11:05 -07003339 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003340 ERROR("OPEN_BRACE",
3341 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003342 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003343 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003344 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3345 $ctx =~ /\)\s*\;\s*$/ &&
3346 defined $lines[$ctx_ln - 1])
3347 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003348 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3349 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003350 WARN("TRAILING_SEMICOLON",
3351 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003352 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003353 }
3354 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003355 }
3356
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003357# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07003358 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003359 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3360 ctx_statement_block($linenr, $realcnt, 0)
3361 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003362 my ($s, $c) = ($stat, $cond);
3363
3364 substr($s, 0, length($c), '');
3365
Joe Perches9f5af482015-09-09 15:37:30 -07003366 # remove inline comments
3367 $s =~ s/$;/ /g;
3368 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003369
3370 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003371 my @newlines = ($c =~ /\n/gs);
3372 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003373
Joe Perches9f5af482015-09-09 15:37:30 -07003374 # Make sure we remove the line prefixes as we have
3375 # none on the first line, and are going to readd them
3376 # where necessary.
3377 $s =~ s/\n./\n/gs;
3378 while ($s =~ /\n\s+\\\n/) {
3379 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3380 }
3381
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003382 # We want to check the first line inside the block
3383 # starting at the end of the conditional, so remove:
3384 # 1) any blank line termination
3385 # 2) any opening brace { on end of the line
3386 # 3) any do (...) {
3387 my $continuation = 0;
3388 my $check = 0;
3389 $s =~ s/^.*\bdo\b//;
3390 $s =~ s/^\s*{//;
3391 if ($s =~ s/^\s*\\//) {
3392 $continuation = 1;
3393 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003394 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003395 $check = 1;
3396 $cond_lines++;
3397 }
3398
3399 # Also ignore a loop construct at the end of a
3400 # preprocessor statement.
3401 if (($prevline =~ /^.\s*#\s*define\s/ ||
3402 $prevline =~ /\\\s*$/) && $continuation == 0) {
3403 $check = 0;
3404 }
3405
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003406 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003407 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003408 while ($cond_ptr != $cond_lines) {
3409 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003410
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003411 # If we see an #else/#elif then the code
3412 # is not linear.
3413 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3414 $check = 0;
3415 }
3416
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003417 # Ignore:
3418 # 1) blank lines, they should be at 0,
3419 # 2) preprocessor lines, and
3420 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003421 if ($continuation ||
3422 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003423 $s =~ /^\s*#\s*?/ ||
3424 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003425 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003426 if ($s =~ s/^.*?\n//) {
3427 $cond_lines++;
3428 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003429 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003430 }
3431
3432 my (undef, $sindent) = line_stats("+" . $s);
3433 my $stat_real = raw_line($linenr, $cond_lines);
3434
3435 # Check if either of these lines are modified, else
3436 # this is not this patch's fault.
3437 if (!defined($stat_real) ||
3438 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3439 $check = 0;
3440 }
3441 if (defined($stat_real) && $cond_lines > 1) {
3442 $stat_real = "[...]\n$stat_real";
3443 }
3444
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003445 #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 -07003446
Joe Perches9f5af482015-09-09 15:37:30 -07003447 if ($check && $s ne '' &&
3448 (($sindent % 8) != 0 ||
3449 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07003450 ($sindent == $indent &&
3451 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Joe Perches9f5af482015-09-09 15:37:30 -07003452 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003453 WARN("SUSPECT_CODE_INDENT",
3454 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003455 }
3456 }
3457
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003458 # Track the 'values' across context and added lines.
3459 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003460 my ($curr_values, $curr_vars) =
3461 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003462 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003463 if ($dbg_values) {
3464 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003465 print "$linenr > .$outline\n";
3466 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003467 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003468 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003469 $prev_values = substr($curr_values, -1);
3470
Andy Whitcroft00df3442007-06-08 13:47:06 -07003471#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003472 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003473
Joe Perches11ca40a2016-12-12 16:46:31 -08003474# check for dereferences that span multiple lines
3475 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3476 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3477 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3478 my $ref = $1;
3479 $line =~ /^.\s*($Lval)/;
3480 $ref .= $1;
3481 $ref =~ s/\s//g;
3482 WARN("MULTILINE_DEREFERENCE",
3483 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3484 }
3485
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003486# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003487 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 -07003488 my $type = $1;
3489 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003490 $var = "" if (!defined $var);
3491 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003492 my $sign = $1;
3493 my $pointer = $2;
3494
3495 $pointer = "" if (!defined $pointer);
3496
3497 if (WARN("UNSPECIFIED_INT",
3498 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3499 $fix) {
3500 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003501 my $comp_pointer = $pointer;
3502 $comp_pointer =~ s/\s//g;
3503 $decl .= $comp_pointer;
3504 $decl = rtrim($decl) if ($var eq "");
3505 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003506 }
3507 }
3508 }
3509
Andy Whitcroft653d4872007-06-23 17:16:34 -07003510# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003511 if ($dbg_type) {
3512 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003513 ERROR("TEST_TYPE",
3514 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003515 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003516 ERROR("TEST_NOT_TYPE",
3517 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003518 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003519 next;
3520 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003521# TEST: allow direct testing of the attribute matcher.
3522 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003523 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003524 ERROR("TEST_ATTR",
3525 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003526 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003527 ERROR("TEST_NOT_ATTR",
3528 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003529 }
3530 next;
3531 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003532
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003533# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003534 if ($line =~ /^.\s*{/ &&
3535 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003536 if (ERROR("OPEN_BRACE",
3537 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003538 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3539 fix_delete_line($fixlinenr - 1, $prevrawline);
3540 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003541 my $fixedline = $prevrawline;
3542 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003543 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003544 $fixedline = $line;
3545 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003546 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003547 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003548 }
3549
Andy Whitcroft653d4872007-06-23 17:16:34 -07003550#
3551# Checks which are anchored on the added line.
3552#
3553
3554# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003555 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003556 my $path = $1;
3557 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003558 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003559 "malformed #include filename\n" . $herecurr);
3560 }
3561 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3562 ERROR("UAPI_INCLUDE",
3563 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003564 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003565 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003566
3567# no C99 // comments
3568 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003569 if (ERROR("C99_COMMENTS",
3570 "do not use C99 // comments\n" . $herecurr) &&
3571 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003572 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003573 if ($line =~ /\/\/(.*)$/) {
3574 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003575 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003576 }
3577 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003578 }
3579 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003580 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003581 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003582
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003583# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3584# the whole statement.
3585#print "APW <$lines[$realline_next - 1]>\n";
3586 if (defined $realline_next &&
3587 exists $lines[$realline_next - 1] &&
3588 !defined $suppress_export{$realline_next} &&
3589 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3590 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003591 # Handle definitions which produce identifiers with
3592 # a prefix:
3593 # XXX(foo);
3594 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003595 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003596 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003597 $name =~ /^${Ident}_$2/) {
3598#print "FOO C name<$name>\n";
3599 $suppress_export{$realline_next} = 1;
3600
3601 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003602 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003603 ^.DEFINE_$Ident\(\Q$name\E\)|
3604 ^.DECLARE_$Ident\(\Q$name\E\)|
3605 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003606 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3607 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003608 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003609#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3610 $suppress_export{$realline_next} = 2;
3611 } else {
3612 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003613 }
3614 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003615 if (!defined $suppress_export{$linenr} &&
3616 $prevline =~ /^.\s*$/ &&
3617 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3618 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3619#print "FOO B <$lines[$linenr - 1]>\n";
3620 $suppress_export{$linenr} = 2;
3621 }
3622 if (defined $suppress_export{$linenr} &&
3623 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003624 WARN("EXPORT_SYMBOL",
3625 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003626 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003627
Joe Eloff5150bda2010-08-09 17:21:00 -07003628# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003629 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003630 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003631 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003632 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003633 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003634 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003635 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003636# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003637 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003638 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003639 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003640 $herecurr) &&
3641 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003642 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003643 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003644 }
3645
Joe Perches18130872014-08-06 16:11:22 -07003646# check for misordered declarations of char/short/int/long with signed/unsigned
3647 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3648 my $tmp = trim($1);
3649 WARN("MISORDERED_TYPE",
3650 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3651 }
3652
Joe Perchescb710ec2010-10-26 14:23:20 -07003653# check for static const char * arrays.
3654 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003655 WARN("STATIC_CONST_CHAR_ARRAY",
3656 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003657 $herecurr);
3658 }
3659
3660# check for static char foo[] = "bar" declarations.
3661 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003662 WARN("STATIC_CONST_CHAR_ARRAY",
3663 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003664 $herecurr);
3665 }
3666
Joe Perchesab7e23f2015-04-16 12:44:22 -07003667# check for const <foo> const where <foo> is not a pointer or array type
3668 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3669 my $found = $1;
3670 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3671 WARN("CONST_CONST",
3672 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3673 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3674 WARN("CONST_CONST",
3675 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3676 }
3677 }
3678
Joe Perches9b0fa602014-04-03 14:49:18 -07003679# check for non-global char *foo[] = {"bar", ...} declarations.
3680 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3681 WARN("STATIC_CONST_CHAR_ARRAY",
3682 "char * array declaration might be better as static const\n" .
3683 $herecurr);
3684 }
3685
Joe Perchesb598b672015-04-16 12:44:36 -07003686# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3687 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3688 my $array = $1;
3689 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3690 my $array_div = $1;
3691 if (WARN("ARRAY_SIZE",
3692 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3693 $fix) {
3694 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3695 }
3696 }
3697 }
3698
Joe Perchesb36190c2014-01-27 17:07:18 -08003699# check for function declarations without arguments like "int foo()"
3700 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3701 if (ERROR("FUNCTION_WITHOUT_ARGS",
3702 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3703 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003704 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003705 }
3706 }
3707
Andy Whitcroft653d4872007-06-23 17:16:34 -07003708# check for new typedefs, only function parameters and sparse annotations
3709# make sense.
3710 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003711 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003712 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003713 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02003714 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003715 WARN("NEW_TYPEDEFS",
3716 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003717 }
3718
3719# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003720 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003721 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3722 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003723 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003724
Andy Whitcroft65863862009-01-06 14:41:21 -08003725 # Should start with a space.
3726 $to =~ s/^(\S)/ $1/;
3727 # Should not end with a space.
3728 $to =~ s/\s+$//;
3729 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003730 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003731 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003732
Joe Perches3705ce52013-07-03 15:05:31 -07003733## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003734 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003735 if (ERROR("POINTER_LOCATION",
3736 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3737 $fix) {
3738 my $sub_from = $ident;
3739 my $sub_to = $ident;
3740 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003741 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003742 s@\Q$sub_from\E@$sub_to@;
3743 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003744 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003745 }
3746 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3747 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003748 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003749
Andy Whitcroft65863862009-01-06 14:41:21 -08003750 # Should start with a space.
3751 $to =~ s/^(\S)/ $1/;
3752 # Should not end with a space.
3753 $to =~ s/\s+$//;
3754 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003755 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003756 }
3757 # Modifiers should have spaces.
3758 $to =~ s/(\b$Modifier$)/$1 /;
3759
Joe Perches3705ce52013-07-03 15:05:31 -07003760## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003761 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003762 if (ERROR("POINTER_LOCATION",
3763 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3764 $fix) {
3765
3766 my $sub_from = $match;
3767 my $sub_to = $match;
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 Whitcroft0a920b5b2007-06-01 00:46:48 -07003773 }
3774
Joe Perches9d3e3c72015-09-09 15:37:27 -07003775# avoid BUG() or BUG_ON()
3776 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3777 my $msg_type = \&WARN;
3778 $msg_type = \&CHK if ($file);
3779 &{$msg_type}("AVOID_BUG",
3780 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3781 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003782
Joe Perches9d3e3c72015-09-09 15:37:27 -07003783# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003784 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003785 WARN("LINUX_VERSION_CODE",
3786 "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 -08003787 }
3788
Joe Perches17441222011-06-15 15:08:17 -07003789# check for uses of printk_ratelimit
3790 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003791 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003792 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003793 }
3794
Andy Whitcroft00df3442007-06-08 13:47:06 -07003795# printk should use KERN_* levels. Note that follow on printk's on the
3796# same line do not need a level, so we use the current block context
3797# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003798# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003799# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003800 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003801 my $ok = 0;
3802 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3803 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003804 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003805 # with "\n" ignore it, else it is to blame
3806 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3807 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3808 $ok = 1;
3809 }
3810 last;
3811 }
3812 }
3813 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003814 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3815 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003816 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003817 }
3818
Joe Perches243f3802012-05-31 16:26:09 -07003819 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3820 my $orig = $1;
3821 my $level = lc($orig);
3822 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003823 my $level2 = $level;
3824 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003825 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003826 "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 -07003827 }
3828
3829 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003830 if (WARN("PREFER_PR_LEVEL",
3831 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3832 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003833 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003834 s/\bpr_warning\b/pr_warn/;
3835 }
Joe Perches243f3802012-05-31 16:26:09 -07003836 }
3837
Joe Perchesdc139312013-02-21 16:44:13 -08003838 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3839 my $orig = $1;
3840 my $level = lc($orig);
3841 $level = "warn" if ($level eq "warning");
3842 $level = "dbg" if ($level eq "debug");
3843 WARN("PREFER_DEV_LEVEL",
3844 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3845 }
3846
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003847# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3848# number of false positives, but assembly files are not checked, so at
3849# least the arch entry code will not trigger this warning.
3850 if ($line =~ /\bENOSYS\b/) {
3851 WARN("ENOSYS",
3852 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3853 }
3854
Andy Whitcroft653d4872007-06-23 17:16:34 -07003855# function brace can't be on same line, except for #defines of do while,
3856# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003857 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07003858 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003859 if (ERROR("OPEN_BRACE",
3860 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3861 $fix) {
3862 fix_delete_line($fixlinenr, $rawline);
3863 my $fixed_line = $rawline;
3864 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3865 my $line1 = $1;
3866 my $line2 = $2;
3867 fix_insert_line($fixlinenr, ltrim($line1));
3868 fix_insert_line($fixlinenr, "\+{");
3869 if ($line2 !~ /^\s*$/) {
3870 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3871 }
3872 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003873 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003874
Andy Whitcroft8905a672007-11-28 16:21:06 -08003875# open braces for enum, union and struct go on the same line.
3876 if ($line =~ /^.\s*{/ &&
3877 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003878 if (ERROR("OPEN_BRACE",
3879 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3880 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3881 fix_delete_line($fixlinenr - 1, $prevrawline);
3882 fix_delete_line($fixlinenr, $rawline);
3883 my $fixedline = rtrim($prevrawline) . " {";
3884 fix_insert_line($fixlinenr, $fixedline);
3885 $fixedline = $rawline;
3886 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3887 if ($fixedline !~ /^\+\s*$/) {
3888 fix_insert_line($fixlinenr, $fixedline);
3889 }
3890 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003891 }
3892
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003893# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003894 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3895 if (WARN("SPACING",
3896 "missing space after $1 definition\n" . $herecurr) &&
3897 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003898 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003899 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3900 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003901 }
3902
Joe Perches31070b52014-01-23 15:54:49 -08003903# Function pointer declarations
3904# check spacing between type, funcptr, and args
3905# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003906 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003907 my $declare = $1;
3908 my $pre_pointer_space = $2;
3909 my $post_pointer_space = $3;
3910 my $funcname = $4;
3911 my $post_funcname_space = $5;
3912 my $pre_args_space = $6;
3913
Joe Perches91f72e92014-04-03 14:49:12 -07003914# the $Declare variable will capture all spaces after the type
3915# so check it for a missing trailing missing space but pointer return types
3916# don't need a space so don't warn for those.
3917 my $post_declare_space = "";
3918 if ($declare =~ /(\s+)$/) {
3919 $post_declare_space = $1;
3920 $declare = rtrim($declare);
3921 }
3922 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003923 WARN("SPACING",
3924 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003925 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003926 }
3927
3928# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003929# This test is not currently implemented because these declarations are
3930# equivalent to
3931# int foo(int bar, ...)
3932# and this is form shouldn't/doesn't generate a checkpatch warning.
3933#
3934# elsif ($declare =~ /\s{2,}$/) {
3935# WARN("SPACING",
3936# "Multiple spaces after return type\n" . $herecurr);
3937# }
Joe Perches31070b52014-01-23 15:54:49 -08003938
3939# unnecessary space "type ( *funcptr)(args...)"
3940 if (defined $pre_pointer_space &&
3941 $pre_pointer_space =~ /^\s/) {
3942 WARN("SPACING",
3943 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3944 }
3945
3946# unnecessary space "type (* funcptr)(args...)"
3947 if (defined $post_pointer_space &&
3948 $post_pointer_space =~ /^\s/) {
3949 WARN("SPACING",
3950 "Unnecessary space before function pointer name\n" . $herecurr);
3951 }
3952
3953# unnecessary space "type (*funcptr )(args...)"
3954 if (defined $post_funcname_space &&
3955 $post_funcname_space =~ /^\s/) {
3956 WARN("SPACING",
3957 "Unnecessary space after function pointer name\n" . $herecurr);
3958 }
3959
3960# unnecessary space "type (*funcptr) (args...)"
3961 if (defined $pre_args_space &&
3962 $pre_args_space =~ /^\s/) {
3963 WARN("SPACING",
3964 "Unnecessary space before function pointer arguments\n" . $herecurr);
3965 }
3966
3967 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003968 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003969 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003970 }
3971 }
3972
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003973# check for spacing round square brackets; allowed:
3974# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003975# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3976# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003977 while ($line =~ /(.*?\s)\[/g) {
3978 my ($where, $prefix) = ($-[1], $1);
3979 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003980 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003981 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003982 if (ERROR("BRACKET_SPACE",
3983 "space prohibited before open square bracket '['\n" . $herecurr) &&
3984 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003985 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003986 s/^(\+.*?)\s+\[/$1\[/;
3987 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003988 }
3989 }
3990
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003991# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003992 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003993 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003994 my $ctx_before = substr($line, 0, $-[1]);
3995 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003996
3997 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003998 if ($name =~ /^(?:
3999 if|for|while|switch|return|case|
4000 volatile|__volatile__|
4001 __attribute__|format|__extension__|
4002 asm|__asm__)$/x)
4003 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004004 # cpp #define statements have non-optional spaces, ie
4005 # if there is a space between the name and the open
4006 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004007 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004008
4009 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004010 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004011
4012 # If this whole things ends with a type its most
4013 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004014 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004015
4016 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004017 if (WARN("SPACING",
4018 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4019 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004020 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004021 s/\b$name\s+\(/$name\(/;
4022 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004023 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004024 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004025
Andy Whitcroft653d4872007-06-23 17:16:34 -07004026# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004027 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004028 my $fixed_line = "";
4029 my $line_fixed = 0;
4030
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004031 my $ops = qr{
4032 <<=|>>=|<=|>=|==|!=|
4033 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4034 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004035 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004036 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004037 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004038 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004039
4040## print("element count: <" . $#elements . ">\n");
4041## foreach my $el (@elements) {
4042## print("el: <$el>\n");
4043## }
4044
4045 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004046 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004047
Joe Perches3705ce52013-07-03 15:05:31 -07004048 foreach my $el (@elements) {
4049 push(@fix_elements, substr($rawline, $off, length($el)));
4050 $off += length($el);
4051 }
4052
4053 $off = 0;
4054
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004055 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004056 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004057
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004058 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004059
4060 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4061
4062## print("n: <$n> good: <$good>\n");
4063
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004064 $off += length($elements[$n]);
4065
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004066 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004067 my $ca = substr($opline, 0, $off);
4068 my $cc = '';
4069 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4070 $cc = substr($opline, $off + length($elements[$n + 1]));
4071 }
4072 my $cb = "$ca$;$cc";
4073
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004074 my $a = '';
4075 $a = 'V' if ($elements[$n] ne '');
4076 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004077 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004078 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4079 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004080 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004081
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004082 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004083
4084 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004085 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004086 $c = 'V' if ($elements[$n + 2] ne '');
4087 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004088 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004089 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4090 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004091 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004092 } else {
4093 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004094 }
4095
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004096 my $ctx = "${a}x${c}";
4097
4098 my $at = "(ctx:$ctx)";
4099
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004100 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004101 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004102
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004103 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004104 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004105
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004106 # Get the full operator variant.
4107 my $opv = $op . substr($curr_vars, $off, 1);
4108
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004109 # Ignore operators passed as parameters.
4110 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004111 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004112
Andy Whitcroftcf655042008-03-04 14:28:20 -08004113# # Ignore comments
4114# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004115
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004116 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004117 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004118 if ($ctx !~ /.x[WEBC]/ &&
4119 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004120 if (ERROR("SPACING",
4121 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004122 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004123 $line_fixed = 1;
4124 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004125 }
4126
4127 # // is a comment
4128 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004129
Joe Perchesb00e4812014-04-03 14:49:33 -07004130 # : when part of a bitfield
4131 } elsif ($opv eq ':B') {
4132 # skip the bitfield test for now
4133
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004134 # No spaces for:
4135 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004136 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004137 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004138 if (ERROR("SPACING",
4139 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004140 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004141 if (defined $fix_elements[$n + 2]) {
4142 $fix_elements[$n + 2] =~ s/^\s+//;
4143 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004144 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004145 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004146 }
4147
Joe Perches23810972014-12-10 15:51:32 -08004148 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004149 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004150 my $rtrim_before = 0;
4151 my $space_after = 0;
4152 if ($ctx =~ /Wx./) {
4153 if (ERROR("SPACING",
4154 "space prohibited before that '$op' $at\n" . $hereptr)) {
4155 $line_fixed = 1;
4156 $rtrim_before = 1;
4157 }
4158 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004159 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004160 if (ERROR("SPACING",
4161 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004162 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004163 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004164 $space_after = 1;
4165 }
4166 }
4167 if ($rtrim_before || $space_after) {
4168 if ($rtrim_before) {
4169 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4170 } else {
4171 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4172 }
4173 if ($space_after) {
4174 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004175 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004176 }
4177
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004178 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004179 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004180 #warn "'*' is part of type\n";
4181
4182 # unary operators should have a space before and
4183 # none after. May be left adjacent to another
4184 # unary operator, or a cast
4185 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004186 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004187 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004188 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004189 if (ERROR("SPACING",
4190 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004191 if ($n != $last_after + 2) {
4192 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4193 $line_fixed = 1;
4194 }
Joe Perches3705ce52013-07-03 15:05:31 -07004195 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004196 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004197 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004198 # A unary '*' may be const
4199
4200 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004201 if (ERROR("SPACING",
4202 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004203 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004204 if (defined $fix_elements[$n + 2]) {
4205 $fix_elements[$n + 2] =~ s/^\s+//;
4206 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004207 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004208 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004209 }
4210
4211 # unary ++ and unary -- are allowed no space on one side.
4212 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004213 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004214 if (ERROR("SPACING",
4215 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004216 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004217 $line_fixed = 1;
4218 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004219 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004220 if ($ctx =~ /Wx[BE]/ ||
4221 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004222 if (ERROR("SPACING",
4223 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004224 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004225 $line_fixed = 1;
4226 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004227 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004228 if ($ctx =~ /ExW/) {
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] . trim($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 Whitcroft773647a2008-03-28 14:15:58 -07004237 }
4238
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004239 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004240 } elsif ($op eq '<<' or $op eq '>>' or
4241 $op eq '&' or $op eq '^' or $op eq '|' or
4242 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004243 $op eq '*' or $op eq '/' or
4244 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004245 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004246 if ($check) {
4247 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4248 if (CHK("SPACING",
4249 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4250 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4251 $fix_elements[$n + 2] =~ s/^\s+//;
4252 $line_fixed = 1;
4253 }
4254 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4255 if (CHK("SPACING",
4256 "space preferred before that '$op' $at\n" . $hereptr)) {
4257 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4258 $line_fixed = 1;
4259 }
4260 }
4261 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004262 if (ERROR("SPACING",
4263 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004264 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4265 if (defined $fix_elements[$n + 2]) {
4266 $fix_elements[$n + 2] =~ s/^\s+//;
4267 }
Joe Perches3705ce52013-07-03 15:05:31 -07004268 $line_fixed = 1;
4269 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004270 }
4271
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004272 # A colon needs no spaces before when it is
4273 # terminating a case value or a label.
4274 } elsif ($opv eq ':C' || $opv eq ':L') {
4275 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004276 if (ERROR("SPACING",
4277 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004278 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004279 $line_fixed = 1;
4280 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004281 }
4282
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004283 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004284 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004285 my $ok = 0;
4286
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004287 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004288 if (($op eq '<' &&
4289 $cc =~ /^\S+\@\S+>/) ||
4290 ($op eq '>' &&
4291 $ca =~ /<\S+\@\S+$/))
4292 {
4293 $ok = 1;
4294 }
4295
Joe Perchese0df7e12015-04-16 12:44:53 -07004296 # for asm volatile statements
4297 # ignore a colon with another
4298 # colon immediately before or after
4299 if (($op eq ':') &&
4300 ($ca =~ /:$/ || $cc =~ /^:/)) {
4301 $ok = 1;
4302 }
4303
Joe Perches84731622013-11-12 15:10:05 -08004304 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004305 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08004306 my $msg_type = \&ERROR;
4307 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4308
4309 if (&{$msg_type}("SPACING",
4310 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004311 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4312 if (defined $fix_elements[$n + 2]) {
4313 $fix_elements[$n + 2] =~ s/^\s+//;
4314 }
Joe Perches3705ce52013-07-03 15:05:31 -07004315 $line_fixed = 1;
4316 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004317 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004318 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004319 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004320
4321## print("n: <$n> GOOD: <$good>\n");
4322
4323 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004324 }
Joe Perches3705ce52013-07-03 15:05:31 -07004325
4326 if (($#elements % 2) == 0) {
4327 $fixed_line = $fixed_line . $fix_elements[$#elements];
4328 }
4329
Joe Perches194f66f2014-08-06 16:11:03 -07004330 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4331 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004332 }
4333
4334
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004335 }
4336
Joe Perches786b6322013-07-03 15:05:32 -07004337# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004338 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004339 if (WARN("SPACING",
4340 "space prohibited before semicolon\n" . $herecurr) &&
4341 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004342 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004343 s/^(\+.*\S)\s+;/$1;/;
4344 }
4345 }
4346
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004347# check for multiple assignments
4348 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004349 CHK("MULTIPLE_ASSIGNMENTS",
4350 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004351 }
4352
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004353## # check for multiple declarations, allowing for a function declaration
4354## # continuation.
4355## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4356## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4357##
4358## # Remove any bracketed sections to ensure we do not
4359## # falsly report the parameters of functions.
4360## my $ln = $line;
4361## while ($ln =~ s/\([^\(\)]*\)//g) {
4362## }
4363## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004364## WARN("MULTIPLE_DECLARATION",
4365## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004366## }
4367## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004368
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004369#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004370 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004371 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004372 if (ERROR("SPACING",
4373 "space required before the open brace '{'\n" . $herecurr) &&
4374 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004375 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004376 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004377 }
4378
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004379## # check for blank lines before declarations
4380## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4381## $prevrawline =~ /^.\s*$/) {
4382## WARN("SPACING",
4383## "No blank lines before declarations\n" . $hereprev);
4384## }
4385##
4386
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004387# closing brace should have a space following it when it has anything
4388# on the line
4389 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004390 if (ERROR("SPACING",
4391 "space required after that close brace '}'\n" . $herecurr) &&
4392 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004393 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004394 s/}((?!(?:,|;|\)))\S)/} $1/;
4395 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004396 }
4397
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004398# check spacing on square brackets
4399 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004400 if (ERROR("SPACING",
4401 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4402 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004403 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004404 s/\[\s+/\[/;
4405 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004406 }
4407 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004408 if (ERROR("SPACING",
4409 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4410 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004411 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004412 s/\s+\]/\]/;
4413 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004414 }
4415
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004416# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004417 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4418 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004419 if (ERROR("SPACING",
4420 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4421 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004422 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004423 s/\(\s+/\(/;
4424 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004425 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004426 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004427 $line !~ /for\s*\(.*;\s+\)/ &&
4428 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004429 if (ERROR("SPACING",
4430 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4431 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004432 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004433 s/\s+\)/\)/;
4434 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004435 }
4436
Joe Perchese2826fd2014-08-06 16:10:48 -07004437# check unnecessary parentheses around addressof/dereference single $Lvals
4438# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4439
4440 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004441 my $var = $1;
4442 if (CHK("UNNECESSARY_PARENTHESES",
4443 "Unnecessary parentheses around $var\n" . $herecurr) &&
4444 $fix) {
4445 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4446 }
4447 }
4448
4449# check for unnecessary parentheses around function pointer uses
4450# ie: (foo->bar)(); should be foo->bar();
4451# but not "if (foo->bar) (" to avoid some false positives
4452 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4453 my $var = $2;
4454 if (CHK("UNNECESSARY_PARENTHESES",
4455 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4456 $fix) {
4457 my $var2 = deparenthesize($var);
4458 $var2 =~ s/\s//g;
4459 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4460 }
4461 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004462
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004463#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004464 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004465 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004466 if (WARN("INDENTED_LABEL",
4467 "labels should not be indented\n" . $herecurr) &&
4468 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004469 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004470 s/^(.)\s+/$1/;
4471 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004472 }
4473
Joe Perches5b9553a2014-04-03 14:49:21 -07004474# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004475 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004476 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004477 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004478 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4479 my $value = $1;
4480 $value = deparenthesize($value);
4481 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4482 ERROR("RETURN_PARENTHESES",
4483 "return is not a function, parentheses are not required\n" . $herecurr);
4484 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004485 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004486 ERROR("SPACING",
4487 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004488 }
4489 }
Joe Perches507e5142013-11-12 15:10:13 -08004490
Joe Perchesb43ae212014-06-23 13:22:07 -07004491# unnecessary return in a void function
4492# at end-of-function, with the previous line a single leading tab, then return;
4493# and the line before that not a goto label target like "out:"
4494 if ($sline =~ /^[ \+]}\s*$/ &&
4495 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4496 $linenr >= 3 &&
4497 $lines[$linenr - 3] =~ /^[ +]/ &&
4498 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004499 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004500 "void function return statements are not generally useful\n" . $hereprev);
4501 }
Joe Perches9819cf22014-06-04 16:12:09 -07004502
Joe Perches189248d2014-01-23 15:54:47 -08004503# if statements using unnecessary parentheses - ie: if ((foo == bar))
4504 if ($^V && $^V ge 5.10.0 &&
4505 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4506 my $openparens = $1;
4507 my $count = $openparens =~ tr@\(@\(@;
4508 my $msg = "";
4509 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4510 my $comp = $4; #Not $1 because of $LvalOrFunc
4511 $msg = " - maybe == should be = ?" if ($comp eq "==");
4512 WARN("UNNECESSARY_PARENTHESES",
4513 "Unnecessary parentheses$msg\n" . $herecurr);
4514 }
4515 }
4516
Joe Perchesc5595fa2015-09-09 15:37:58 -07004517# comparisons with a constant or upper case identifier on the left
4518# avoid cases like "foo + BAR < baz"
4519# only fix matches surrounded by parentheses to avoid incorrect
4520# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4521 if ($^V && $^V ge 5.10.0 &&
4522 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4523 my $lead = $1;
4524 my $const = $2;
4525 my $comp = $3;
4526 my $to = $4;
4527 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004528 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004529 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4530 WARN("CONSTANT_COMPARISON",
4531 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4532 $fix) {
4533 if ($comp eq "<") {
4534 $newcomp = ">";
4535 } elsif ($comp eq "<=") {
4536 $newcomp = ">=";
4537 } elsif ($comp eq ">") {
4538 $newcomp = "<";
4539 } elsif ($comp eq ">=") {
4540 $newcomp = "<=";
4541 }
4542 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4543 }
4544 }
4545
Joe Perchesf34e4a42015-04-16 12:44:19 -07004546# Return of what appears to be an errno should normally be negative
4547 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004548 my $name = $1;
4549 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004550 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004551 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004552 }
4553 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004554
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004555# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004556 if ($line =~ /\b(if|while|for|switch)\(/) {
4557 if (ERROR("SPACING",
4558 "space required before the open parenthesis '('\n" . $herecurr) &&
4559 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004560 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004561 s/\b(if|while|for|switch)\(/$1 \(/;
4562 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004563 }
4564
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004565# Check for illegal assignment in if conditional -- and check for trailing
4566# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004567 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004568 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4569 ctx_statement_block($linenr, $realcnt, 0)
4570 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004571 my ($stat_next) = ctx_statement_block($line_nr_next,
4572 $remain_next, $off_next);
4573 $stat_next =~ s/\n./\n /g;
4574 ##print "stat<$stat> stat_next<$stat_next>\n";
4575
4576 if ($stat_next =~ /^\s*while\b/) {
4577 # If the statement carries leading newlines,
4578 # then count those as offsets.
4579 my ($whitespace) =
4580 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4581 my $offset =
4582 statement_rawlines($whitespace) - 1;
4583
4584 $suppress_whiletrailers{$line_nr_next +
4585 $offset} = 1;
4586 }
4587 }
4588 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004589 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004590 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004591 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004592
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004593 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004594 ERROR("ASSIGN_IN_IF",
4595 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004596 }
4597
4598 # Find out what is on the end of the line after the
4599 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004600 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004601 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004602 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004603 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4604 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004605 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004606 # Find out how long the conditional actually is.
4607 my @newlines = ($c =~ /\n/gs);
4608 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004609 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004610
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004611 $stat_real = raw_line($linenr, $cond_lines)
4612 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004613 if (defined($stat_real) && $cond_lines > 1) {
4614 $stat_real = "[...]\n$stat_real";
4615 }
4616
Joe Perches000d1cc12011-07-25 17:13:25 -07004617 ERROR("TRAILING_STATEMENTS",
4618 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004619 }
4620 }
4621
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004622# Check for bitwise tests written as boolean
4623 if ($line =~ /
4624 (?:
4625 (?:\[|\(|\&\&|\|\|)
4626 \s*0[xX][0-9]+\s*
4627 (?:\&\&|\|\|)
4628 |
4629 (?:\&\&|\|\|)
4630 \s*0[xX][0-9]+\s*
4631 (?:\&\&|\|\||\)|\])
4632 )/x)
4633 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004634 WARN("HEXADECIMAL_BOOLEAN_TEST",
4635 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004636 }
4637
Andy Whitcroft8905a672007-11-28 16:21:06 -08004638# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004639 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4640 my $s = $1;
4641 $s =~ s/$;//g; # Remove any comments
4642 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004643 ERROR("TRAILING_STATEMENTS",
4644 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004645 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004646 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004647# if should not continue a brace
4648 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004649 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004650 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004651 $herecurr);
4652 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004653# case and default should not have general statements after them
4654 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4655 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004656 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004657 \s*return\s+
4658 )/xg)
4659 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004660 ERROR("TRAILING_STATEMENTS",
4661 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004662 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004663
4664 # Check for }<nl>else {, these must be at the same
4665 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004666 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4667 $previndent == $indent) {
4668 if (ERROR("ELSE_AFTER_BRACE",
4669 "else should follow close brace '}'\n" . $hereprev) &&
4670 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4671 fix_delete_line($fixlinenr - 1, $prevrawline);
4672 fix_delete_line($fixlinenr, $rawline);
4673 my $fixedline = $prevrawline;
4674 $fixedline =~ s/}\s*$//;
4675 if ($fixedline !~ /^\+\s*$/) {
4676 fix_insert_line($fixlinenr, $fixedline);
4677 }
4678 $fixedline = $rawline;
4679 $fixedline =~ s/^(.\s*)else/$1} else/;
4680 fix_insert_line($fixlinenr, $fixedline);
4681 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004682 }
4683
Joe Perches8b8856f2014-08-06 16:11:14 -07004684 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4685 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004686 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4687
4688 # Find out what is on the end of the line after the
4689 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004690 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004691 $s =~ s/\n.*//g;
4692
4693 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004694 if (ERROR("WHILE_AFTER_BRACE",
4695 "while should follow close brace '}'\n" . $hereprev) &&
4696 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4697 fix_delete_line($fixlinenr - 1, $prevrawline);
4698 fix_delete_line($fixlinenr, $rawline);
4699 my $fixedline = $prevrawline;
4700 my $trailing = $rawline;
4701 $trailing =~ s/^\+//;
4702 $trailing = trim($trailing);
4703 $fixedline =~ s/}\s*$/} $trailing/;
4704 fix_insert_line($fixlinenr, $fixedline);
4705 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004706 }
4707 }
4708
Joe Perches95e2c602013-07-03 15:05:20 -07004709#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004710 while ($line =~ m{($Constant|$Lval)}g) {
4711 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004712
4713#gcc binary extension
4714 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004715 if (WARN("GCC_BINARY_CONSTANT",
4716 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4717 $fix) {
4718 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004719 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004720 s/\b$var\b/$hexval/;
4721 }
Joe Perches95e2c602013-07-03 15:05:20 -07004722 }
4723
4724#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004725 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004726 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004727#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004728 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004729#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004730 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4731#Ignore some three character SI units explicitly, like MiB and KHz
4732 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004733 while ($var =~ m{($Ident)}g) {
4734 my $word = $1;
4735 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004736 if ($check) {
4737 seed_camelcase_includes();
4738 if (!$file && !$camelcase_file_seeded) {
4739 seed_camelcase_file($realfile);
4740 $camelcase_file_seeded = 1;
4741 }
4742 }
Joe Perches7e781f62013-09-11 14:23:55 -07004743 if (!defined $camelcase{$word}) {
4744 $camelcase{$word} = 1;
4745 CHK("CAMELCASE",
4746 "Avoid CamelCase: <$word>\n" . $herecurr);
4747 }
Joe Perches34456862013-07-03 15:05:34 -07004748 }
Joe Perches323c1262012-12-17 16:02:07 -08004749 }
4750 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004751
4752#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004753 if ($line =~ /\#\s*define.*\\\s+$/) {
4754 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4755 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4756 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004757 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004758 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004759 }
4760
Fabian Frederick0e212e02015-04-16 12:44:25 -07004761# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4762# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004763 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004764 my $file = "$1.h";
4765 my $checkfile = "include/linux/$file";
4766 if (-f "$root/$checkfile" &&
4767 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004768 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004769 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004770 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4771 if ($asminclude > 0) {
4772 if ($realfile =~ m{^arch/}) {
4773 CHK("ARCH_INCLUDE_LINUX",
4774 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4775 } else {
4776 WARN("INCLUDE_LINUX",
4777 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4778 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004779 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004780 }
4781 }
4782
Andy Whitcroft653d4872007-06-23 17:16:34 -07004783# multi-statement macros should be enclosed in a do while loop, grab the
4784# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004785# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07004786 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4787 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004788 my $ln = $linenr;
4789 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004790 my ($off, $dstat, $dcond, $rest);
4791 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004792 my $has_flow_statement = 0;
4793 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004794 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004795 ctx_statement_block($linenr, $realcnt, 0);
4796 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004797 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004798 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004799
Joe Perches08a28432014-10-13 15:51:55 -07004800 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004801 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004802
Joe Perchesf59b64b2016-10-11 13:52:08 -07004803 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4804 my $define_args = $1;
4805 my $define_stmt = $dstat;
4806 my @def_args = ();
4807
4808 if (defined $define_args && $define_args ne "") {
4809 $define_args = substr($define_args, 1, length($define_args) - 2);
4810 $define_args =~ s/\s*//g;
4811 @def_args = split(",", $define_args);
4812 }
4813
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004814 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004815 $dstat =~ s/\\\n.//g;
4816 $dstat =~ s/^\s*//s;
4817 $dstat =~ s/\s*$//s;
4818
4819 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004820 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4821 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004822 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004823 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004824 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004825
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004826 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004827 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4828 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004829 {
4830 }
4831
Joe Perches42e15292016-03-15 14:58:01 -07004832 # Make asm volatile uses seem like a generic function
4833 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4834
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004835 my $exceptions = qr{
4836 $Declare|
4837 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004838 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004839 DECLARE_PER_CPU|
4840 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004841 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004842 union|
4843 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004844 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004845 ^\"|\"$|
4846 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004847 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004848 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07004849
4850 $ctx =~ s/\n*$//;
4851 my $herectx = $here . "\n";
4852 my $stmt_cnt = statement_rawlines($ctx);
4853
4854 for (my $n = 0; $n < $stmt_cnt; $n++) {
4855 $herectx .= raw_line($linenr, $n) . "\n";
4856 }
4857
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004858 if ($dstat ne '' &&
4859 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4860 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004861 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004862 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004863 $dstat !~ /$exceptions/ &&
4864 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004865 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004866 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004867 $dstat !~ /^for\s*$Constant$/ && # for (...)
4868 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4869 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004870 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004871 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004872 {
Joe Perchese7955562017-05-08 15:55:48 -07004873 if ($dstat =~ /^\s*if\b/) {
4874 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4875 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
4876 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004877 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4878 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4879 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004880 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004881 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004882 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07004883
4884 }
Joe Perches52076492016-10-11 13:52:14 -07004885
4886 # Make $define_stmt single line, comment-free, etc
4887 my @stmt_array = split('\n', $define_stmt);
4888 my $first = 1;
4889 $define_stmt = "";
4890 foreach my $l (@stmt_array) {
4891 $l =~ s/\\$//;
4892 if ($first) {
4893 $define_stmt = $l;
4894 $first = 0;
4895 } elsif ($l =~ /^[\+ ]/) {
4896 $define_stmt .= substr($l, 1);
4897 }
4898 }
4899 $define_stmt =~ s/$;//g;
4900 $define_stmt =~ s/\s+/ /g;
4901 $define_stmt = trim($define_stmt);
4902
Joe Perchesf59b64b2016-10-11 13:52:08 -07004903# check if any macro arguments are reused (ignore '...' and 'type')
4904 foreach my $arg (@def_args) {
4905 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07004906 next if ($arg =~ /^type$/i);
Joe Perchesf59b64b2016-10-11 13:52:08 -07004907 my $tmp = $define_stmt;
4908 $tmp =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
Joe Perches52076492016-10-11 13:52:14 -07004909 $tmp =~ s/\#+\s*$arg\b//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07004910 $tmp =~ s/\b$arg\s*\#\#//g;
4911 my $use_cnt = $tmp =~ s/\b$arg\b//g;
4912 if ($use_cnt > 1) {
4913 CHK("MACRO_ARG_REUSE",
4914 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07004915 }
4916# check if any macro arguments may have other precedence issues
4917 if ($define_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
4918 ((defined($1) && $1 ne ',') ||
4919 (defined($2) && $2 ne ','))) {
4920 CHK("MACRO_ARG_PRECEDENCE",
4921 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07004922 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004923 }
Joe Perches5023d342012-12-17 16:01:47 -08004924
Joe Perches08a28432014-10-13 15:51:55 -07004925# check for macros with flow control, but without ## concatenation
4926# ## concatenation is commonly a macro that defines a function so ignore those
4927 if ($has_flow_statement && !$has_arg_concat) {
4928 my $herectx = $here . "\n";
4929 my $cnt = statement_rawlines($ctx);
4930
4931 for (my $n = 0; $n < $cnt; $n++) {
4932 $herectx .= raw_line($linenr, $n) . "\n";
4933 }
4934 WARN("MACRO_WITH_FLOW_CONTROL",
4935 "Macros with flow control statements should be avoided\n" . "$herectx");
4936 }
4937
Joe Perches481eb482012-12-17 16:01:56 -08004938# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004939
4940 } else {
4941 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004942 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4943 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004944 $line =~ /^\+.*\\$/) {
4945 WARN("LINE_CONTINUATIONS",
4946 "Avoid unnecessary line continuations\n" . $herecurr);
4947 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004948 }
4949
Joe Perchesb13edf72012-07-30 14:41:24 -07004950# do {} while (0) macro tests:
4951# single-statement macros do not need to be enclosed in do while (0) loop,
4952# macro should not end with a semicolon
4953 if ($^V && $^V ge 5.10.0 &&
4954 $realfile !~ m@/vmlinux.lds.h$@ &&
4955 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4956 my $ln = $linenr;
4957 my $cnt = $realcnt;
4958 my ($off, $dstat, $dcond, $rest);
4959 my $ctx = '';
4960 ($dstat, $dcond, $ln, $cnt, $off) =
4961 ctx_statement_block($linenr, $realcnt, 0);
4962 $ctx = $dstat;
4963
4964 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004965 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004966
4967 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4968 my $stmts = $2;
4969 my $semis = $3;
4970
4971 $ctx =~ s/\n*$//;
4972 my $cnt = statement_rawlines($ctx);
4973 my $herectx = $here . "\n";
4974
4975 for (my $n = 0; $n < $cnt; $n++) {
4976 $herectx .= raw_line($linenr, $n) . "\n";
4977 }
4978
Joe Perchesac8e97f2012-08-21 16:15:53 -07004979 if (($stmts =~ tr/;/;/) == 1 &&
4980 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004981 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4982 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4983 }
4984 if (defined $semis && $semis ne "") {
4985 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4986 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4987 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004988 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4989 $ctx =~ s/\n*$//;
4990 my $cnt = statement_rawlines($ctx);
4991 my $herectx = $here . "\n";
4992
4993 for (my $n = 0; $n < $cnt; $n++) {
4994 $herectx .= raw_line($linenr, $n) . "\n";
4995 }
4996
4997 WARN("TRAILING_SEMICOLON",
4998 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004999 }
5000 }
5001
Mike Frysinger080ba922009-01-06 14:41:25 -08005002# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
5003# all assignments may have only one of the following with an assignment:
5004# .
5005# ALIGN(...)
5006# VMLINUX_SYMBOL(...)
5007 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005008 WARN("MISSING_VMLINUX_SYMBOL",
5009 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08005010 }
5011
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005012# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005013 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5014 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005015 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005016 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005017 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5018 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005019 my @allowed = ();
5020 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005021 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005022 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005023 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005024 for my $chunk (@chunks) {
5025 my ($cond, $block) = @{$chunk};
5026
Andy Whitcroft773647a2008-03-28 14:15:58 -07005027 # If the condition carries leading newlines, then count those as offsets.
5028 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5029 my $offset = statement_rawlines($whitespace) - 1;
5030
Joe Perchesaad4f612012-03-23 15:02:19 -07005031 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005032 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5033
5034 # We have looked at and allowed this specific line.
5035 $suppress_ifbraces{$ln + $offset} = 1;
5036
5037 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005038 $ln += statement_rawlines($block) - 1;
5039
Andy Whitcroft773647a2008-03-28 14:15:58 -07005040 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005041
5042 $seen++ if ($block =~ /^\s*{/);
5043
Joe Perchesaad4f612012-03-23 15:02:19 -07005044 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005045 if (statement_lines($cond) > 1) {
5046 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005047 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005048 }
5049 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005050 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005051 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005052 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005053 if (statement_block_size($block) > 1) {
5054 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005055 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005056 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005057 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005058 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005059 if ($seen) {
5060 my $sum_allowed = 0;
5061 foreach (@allowed) {
5062 $sum_allowed += $_;
5063 }
5064 if ($sum_allowed == 0) {
5065 WARN("BRACES",
5066 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5067 } elsif ($sum_allowed != $allow &&
5068 $seen != $allow) {
5069 CHK("BRACES",
5070 "braces {} should be used on all arms of this statement\n" . $herectx);
5071 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005072 }
5073 }
5074 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005075 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005076 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005077 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005078
Andy Whitcroftcf655042008-03-04 14:28:20 -08005079 # Check the pre-context.
5080 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5081 #print "APW: ALLOWED: pre<$1>\n";
5082 $allowed = 1;
5083 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005084
5085 my ($level, $endln, @chunks) =
5086 ctx_statement_full($linenr, $realcnt, $-[0]);
5087
Andy Whitcroftcf655042008-03-04 14:28:20 -08005088 # Check the condition.
5089 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005090 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005091 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005092 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005093 }
5094 if (statement_lines($cond) > 1) {
5095 #print "APW: ALLOWED: cond<$cond>\n";
5096 $allowed = 1;
5097 }
5098 if ($block =~/\b(?:if|for|while)\b/) {
5099 #print "APW: ALLOWED: block<$block>\n";
5100 $allowed = 1;
5101 }
5102 if (statement_block_size($block) > 1) {
5103 #print "APW: ALLOWED: lines block<$block>\n";
5104 $allowed = 1;
5105 }
5106 # Check the post-context.
5107 if (defined $chunks[1]) {
5108 my ($cond, $block) = @{$chunks[1]};
5109 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005110 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005111 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005112 if ($block =~ /^\s*\{/) {
5113 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5114 $allowed = 1;
5115 }
5116 }
5117 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005118 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07005119 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005120
Andy Whitcroftf0556632008-10-15 22:02:23 -07005121 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005122 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005123 }
5124
Joe Perches000d1cc12011-07-25 17:13:25 -07005125 WARN("BRACES",
5126 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005127 }
5128 }
5129
Joe Perchese4c5bab2017-02-24 15:01:41 -08005130# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005131 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5132 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005133 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5134 }
5135
Joe Perches0979ae62012-12-17 16:01:59 -08005136# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005137 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005138 if (CHK("BRACES",
5139 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5140 $fix && $prevrawline =~ /^\+/) {
5141 fix_delete_line($fixlinenr - 1, $prevrawline);
5142 }
Joe Perches0979ae62012-12-17 16:01:59 -08005143 }
Joe Perches77b9a532013-07-03 15:05:29 -07005144 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005145 if (CHK("BRACES",
5146 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5147 $fix) {
5148 fix_delete_line($fixlinenr, $rawline);
5149 }
Joe Perches0979ae62012-12-17 16:01:59 -08005150 }
5151
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005152# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005153 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5154 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005155 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005156 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005157 }
5158
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005159# Check for user-visible strings broken across lines, which breaks the ability
5160# to grep for the string. Make exceptions when the previous string ends in a
5161# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5162# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005163 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005164 $prevline =~ /"\s*$/ &&
5165 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5166 if (WARN("SPLIT_STRING",
5167 "quoted string split across lines\n" . $hereprev) &&
5168 $fix &&
5169 $prevrawline =~ /^\+.*"\s*$/ &&
5170 $last_coalesced_string_linenr != $linenr - 1) {
5171 my $extracted_string = get_quoted_string($line, $rawline);
5172 my $comma_close = "";
5173 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5174 $comma_close = $1;
5175 }
5176
5177 fix_delete_line($fixlinenr - 1, $prevrawline);
5178 fix_delete_line($fixlinenr, $rawline);
5179 my $fixedline = $prevrawline;
5180 $fixedline =~ s/"\s*$//;
5181 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5182 fix_insert_line($fixlinenr - 1, $fixedline);
5183 $fixedline = $rawline;
5184 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5185 if ($fixedline !~ /\+\s*$/) {
5186 fix_insert_line($fixlinenr, $fixedline);
5187 }
5188 $last_coalesced_string_linenr = $linenr;
5189 }
5190 }
5191
5192# check for missing a space in a string concatenation
5193 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5194 WARN('MISSING_SPACE',
5195 "break quoted strings at a space character\n" . $hereprev);
5196 }
5197
Joe Perchese4b7d302017-05-08 15:55:51 -07005198# check for an embedded function name in a string when the function is known
5199# This does not work very well for -f --file checking as it depends on patch
5200# context providing the function name or a single line form for in-file
5201# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005202 if ($line =~ /^\+.*$String/ &&
5203 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005204 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5205 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005206 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005207 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005208 }
5209
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005210# check for spaces before a quoted newline
5211 if ($rawline =~ /^.*\".*\s\\n/) {
5212 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5213 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5214 $fix) {
5215 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5216 }
5217
5218 }
5219
Joe Perchesf17dba42014-10-13 15:51:51 -07005220# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005221 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005222 CHK("CONCATENATED_STRING",
5223 "Concatenated strings should use spaces between elements\n" . $herecurr);
5224 }
5225
Joe Perches90ad30e2014-12-10 15:51:59 -08005226# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005227 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005228 WARN("STRING_FRAGMENTS",
5229 "Consecutive strings are generally better as a single string\n" . $herecurr);
5230 }
5231
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005232# check for non-standard and hex prefixed decimal printf formats
5233 my $show_L = 1; #don't show the same defect twice
5234 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005235 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005236 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005237 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005238 # check for %L
5239 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005240 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005241 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5242 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005243 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005244 # check for %Z
5245 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5246 WARN("PRINTF_Z",
5247 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5248 $show_Z = 0;
5249 }
5250 # check for 0x<decimal>
5251 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5252 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07005253 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5254 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005255 }
5256
5257# check for line continuations in quoted strings with odd counts of "
5258 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5259 WARN("LINE_CONTINUATIONS",
5260 "Avoid line continuations in quoted strings\n" . $herecurr);
5261 }
5262
Andy Whitcroft00df3442007-06-08 13:47:06 -07005263# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005264 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005265 CHK("REDUNDANT_CODE",
5266 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005267 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005268 }
5269
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005270# check for needless "if (<foo>) fn(<foo>)" uses
5271 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005272 my $tested = quotemeta($1);
5273 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5274 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5275 my $func = $1;
5276 if (WARN('NEEDLESS_IF',
5277 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5278 $fix) {
5279 my $do_fix = 1;
5280 my $leading_tabs = "";
5281 my $new_leading_tabs = "";
5282 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5283 $leading_tabs = $1;
5284 } else {
5285 $do_fix = 0;
5286 }
5287 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5288 $new_leading_tabs = $1;
5289 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5290 $do_fix = 0;
5291 }
5292 } else {
5293 $do_fix = 0;
5294 }
5295 if ($do_fix) {
5296 fix_delete_line($fixlinenr - 1, $prevrawline);
5297 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5298 }
5299 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005300 }
5301 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005302
Joe Perchesebfdc402014-08-06 16:10:27 -07005303# check for unnecessary "Out of Memory" messages
5304 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5305 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5306 (defined $1 || defined $3) &&
5307 $linenr > 3) {
5308 my $testval = $2;
5309 my $testline = $lines[$linenr - 3];
5310
5311 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5312# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5313
5314 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5315 WARN("OOM_MESSAGE",
5316 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5317 }
5318 }
5319
Joe Perchesf78d98f2014-10-13 15:52:01 -07005320# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005321 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005322 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5323 my $level = $1;
5324 if (WARN("UNNECESSARY_KERN_LEVEL",
5325 "Possible unnecessary $level\n" . $herecurr) &&
5326 $fix) {
5327 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5328 }
5329 }
5330
Joe Perches45c55e92017-02-24 15:01:31 -08005331# check for logging continuations
5332 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5333 WARN("LOGGING_CONTINUATION",
5334 "Avoid logging continuation uses where feasible\n" . $herecurr);
5335 }
5336
Joe Perchesabb08a52014-12-10 15:51:46 -08005337# check for mask then right shift without a parentheses
5338 if ($^V && $^V ge 5.10.0 &&
5339 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5340 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5341 WARN("MASK_THEN_SHIFT",
5342 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5343 }
5344
Joe Perchesb75ac612014-12-10 15:52:02 -08005345# check for pointer comparisons to NULL
5346 if ($^V && $^V ge 5.10.0) {
5347 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5348 my $val = $1;
5349 my $equal = "!";
5350 $equal = "" if ($4 eq "!=");
5351 if (CHK("COMPARISON_TO_NULL",
5352 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5353 $fix) {
5354 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5355 }
5356 }
5357 }
5358
Joe Perches8716de32013-09-11 14:24:05 -07005359# check for bad placement of section $InitAttribute (e.g.: __initdata)
5360 if ($line =~ /(\b$InitAttribute\b)/) {
5361 my $attr = $1;
5362 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5363 my $ptr = $1;
5364 my $var = $2;
5365 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5366 ERROR("MISPLACED_INIT",
5367 "$attr should be placed after $var\n" . $herecurr)) ||
5368 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5369 WARN("MISPLACED_INIT",
5370 "$attr should be placed after $var\n" . $herecurr))) &&
5371 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005372 $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 -07005373 }
5374 }
5375 }
5376
Joe Perchese970b8842013-11-12 15:10:10 -08005377# check for $InitAttributeData (ie: __initdata) with const
5378 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5379 my $attr = $1;
5380 $attr =~ /($InitAttributePrefix)(.*)/;
5381 my $attr_prefix = $1;
5382 my $attr_type = $2;
5383 if (ERROR("INIT_ATTRIBUTE",
5384 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5385 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005386 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005387 s/$InitAttributeData/${attr_prefix}initconst/;
5388 }
5389 }
5390
5391# check for $InitAttributeConst (ie: __initconst) without const
5392 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5393 my $attr = $1;
5394 if (ERROR("INIT_ATTRIBUTE",
5395 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5396 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005397 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005398 /(^\+\s*(?:static\s+))/;
5399 $lead = rtrim($1);
5400 $lead = "$lead " if ($lead !~ /^\+$/);
5401 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005402 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005403 }
5404 }
5405
Joe Perchesc17893c2015-04-16 12:44:42 -07005406# check for __read_mostly with const non-pointer (should just be const)
5407 if ($line =~ /\b__read_mostly\b/ &&
5408 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5409 if (ERROR("CONST_READ_MOSTLY",
5410 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5411 $fix) {
5412 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5413 }
5414 }
5415
Joe Perchesfbdb8132014-04-03 14:49:14 -07005416# don't use __constant_<foo> functions outside of include/uapi/
5417 if ($realfile !~ m@^include/uapi/@ &&
5418 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5419 my $constant_func = $1;
5420 my $func = $constant_func;
5421 $func =~ s/^__constant_//;
5422 if (WARN("CONSTANT_CONVERSION",
5423 "$constant_func should be $func\n" . $herecurr) &&
5424 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005425 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005426 }
5427 }
5428
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005429# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005430 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005431 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005432 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005433 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005434 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005435 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5436 }
5437 if ($delay > 2000) {
5438 WARN("LONG_UDELAY",
5439 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005440 }
5441 }
5442
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005443# warn about unexpectedly long msleep's
5444 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5445 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005446 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005447 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005448 }
5449 }
5450
Joe Perches36ec1932013-07-03 15:05:25 -07005451# check for comparisons of jiffies
5452 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5453 WARN("JIFFIES_COMPARISON",
5454 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5455 }
5456
Joe Perches9d7a34a2013-07-03 15:05:26 -07005457# check for comparisons of get_jiffies_64()
5458 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5459 WARN("JIFFIES_COMPARISON",
5460 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5461 }
5462
Andy Whitcroft00df3442007-06-08 13:47:06 -07005463# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005464# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005465# print "#ifdef in C files should be avoided\n";
5466# print "$herecurr";
5467# $clean = 0;
5468# }
5469
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005470# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005471 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005472 if (ERROR("SPACING",
5473 "exactly one space required after that #$1\n" . $herecurr) &&
5474 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005475 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005476 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5477 }
5478
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005479 }
5480
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005481# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005482 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5483 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005484 my $which = $1;
5485 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005486 CHK("UNCOMMENTED_DEFINITION",
5487 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005488 }
5489 }
5490# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005491
5492 my $barriers = qr{
5493 mb|
5494 rmb|
5495 wmb|
5496 read_barrier_depends
5497 }x;
5498 my $barrier_stems = qr{
5499 mb__before_atomic|
5500 mb__after_atomic|
5501 store_release|
5502 load_acquire|
5503 store_mb|
5504 (?:$barriers)
5505 }x;
5506 my $all_barriers = qr{
5507 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005508 smp_(?:$barrier_stems)|
5509 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005510 }x;
5511
5512 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005513 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005514 WARN("MEMORY_BARRIER",
5515 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005516 }
5517 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005518
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005519 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5520
5521 if ($realfile !~ m@^include/asm-generic/@ &&
5522 $realfile !~ m@/barrier\.h$@ &&
5523 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5524 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5525 WARN("MEMORY_BARRIER",
5526 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5527 }
5528
Joe Perchescb426e92015-06-25 15:02:46 -07005529# check for waitqueue_active without a comment.
5530 if ($line =~ /\bwaitqueue_active\s*\(/) {
5531 if (!ctx_has_comment($first_line, $linenr)) {
5532 WARN("WAITQUEUE_ACTIVE",
5533 "waitqueue_active without comment\n" . $herecurr);
5534 }
5535 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005536
5537# Check for expedited grace periods that interrupt non-idle non-nohz
5538# online CPUs. These expedited can therefore degrade real-time response
5539# if used carelessly, and should be avoided where not absolutely
5540# needed. It is always OK to use synchronize_rcu_expedited() and
5541# synchronize_sched_expedited() at boot time (before real-time applications
5542# start) and in error situations where real-time response is compromised in
5543# any case. Note that synchronize_srcu_expedited() does -not- interrupt
5544# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5545# Of course, nothing comes for free, and srcu_read_lock() and
5546# srcu_read_unlock() do contain full memory barriers in payment for
5547# synchronize_srcu_expedited() non-interruption properties.
5548 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5549 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5550 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5551
5552 }
5553
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005554# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005555 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005556 CHK("ARCH_DEFINES",
5557 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005558 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005559
Tobias Klauserd4977c72010-05-24 14:33:30 -07005560# Check that the storage class is at the beginning of a declaration
5561 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005562 WARN("STORAGE_CLASS",
5563 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07005564 }
5565
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005566# check the location of the inline attribute, that it is between
5567# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005568 if ($line =~ /\b$Type\s+$Inline\b/ ||
5569 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005570 ERROR("INLINE_LOCATION",
5571 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005572 }
5573
Andy Whitcroft8905a672007-11-28 16:21:06 -08005574# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005575 if ($realfile !~ m@\binclude/uapi/@ &&
5576 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005577 if (WARN("INLINE",
5578 "plain inline is preferred over $1\n" . $herecurr) &&
5579 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005580 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005581
5582 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005583 }
5584
Joe Perches3d130fd2011-01-12 17:00:00 -08005585# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005586 if ($realfile !~ m@\binclude/uapi/@ &&
5587 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005588 WARN("PREFER_PACKED",
5589 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005590 }
5591
Joe Perches39b7e282011-07-25 17:13:24 -07005592# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005593 if ($realfile !~ m@\binclude/uapi/@ &&
5594 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005595 WARN("PREFER_ALIGNED",
5596 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005597 }
5598
Joe Perches5f14d3b2012-01-10 15:09:52 -08005599# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005600 if ($realfile !~ m@\binclude/uapi/@ &&
5601 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005602 if (WARN("PREFER_PRINTF",
5603 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5604 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005605 $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 -07005606
5607 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005608 }
5609
Joe Perches6061d942012-03-23 15:02:16 -07005610# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005611 if ($realfile !~ m@\binclude/uapi/@ &&
5612 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005613 if (WARN("PREFER_SCANF",
5614 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5615 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005616 $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 -07005617 }
Joe Perches6061d942012-03-23 15:02:16 -07005618 }
5619
Joe Perches619a9082014-12-10 15:51:35 -08005620# Check for __attribute__ weak, or __weak declarations (may have link issues)
5621 if ($^V && $^V ge 5.10.0 &&
5622 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5623 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5624 $line =~ /\b__weak\b/)) {
5625 ERROR("WEAK_DECLARATION",
5626 "Using weak declarations can have unintended link defects\n" . $herecurr);
5627 }
5628
Tomas Winklerfd39f902016-12-12 16:46:34 -08005629# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07005630 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08005631 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07005632 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5633 my $type = $1;
5634 if ($type =~ /\b($typeC99Typedefs)\b/) {
5635 $type = $1;
5636 my $kernel_type = 'u';
5637 $kernel_type = 's' if ($type =~ /^_*[si]/);
5638 $type =~ /(\d+)/;
5639 $kernel_type .= $1;
5640 if (CHK("PREFER_KERNEL_TYPES",
5641 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5642 $fix) {
5643 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5644 }
5645 }
5646 }
5647
Joe Perches938224b2016-01-20 14:59:15 -08005648# check for cast of C90 native int or longer types constants
5649 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5650 my $cast = $1;
5651 my $const = $2;
5652 if (WARN("TYPECAST_INT_CONSTANT",
5653 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5654 $fix) {
5655 my $suffix = "";
5656 my $newconst = $const;
5657 $newconst =~ s/${Int_type}$//;
5658 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5659 if ($cast =~ /\blong\s+long\b/) {
5660 $suffix .= 'LL';
5661 } elsif ($cast =~ /\blong\b/) {
5662 $suffix .= 'L';
5663 }
5664 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5665 }
5666 }
5667
Joe Perches8f53a9b2010-03-05 13:43:48 -08005668# check for sizeof(&)
5669 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005670 WARN("SIZEOF_ADDRESS",
5671 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005672 }
5673
Joe Perches66c80b62012-07-30 14:41:22 -07005674# check for sizeof without parenthesis
5675 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005676 if (WARN("SIZEOF_PARENTHESIS",
5677 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5678 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005679 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005680 }
Joe Perches66c80b62012-07-30 14:41:22 -07005681 }
5682
Joe Perches88982fe2012-12-17 16:02:00 -08005683# check for struct spinlock declarations
5684 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5685 WARN("USE_SPINLOCK_T",
5686 "struct spinlock should be spinlock_t\n" . $herecurr);
5687 }
5688
Joe Perchesa6962d72013-04-29 16:18:13 -07005689# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005690 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005691 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005692 $fmt =~ s/%%//g;
5693 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005694 if (WARN("PREFER_SEQ_PUTS",
5695 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5696 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005697 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005698 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005699 }
5700 }
5701
Joe Perches0b523762017-05-08 15:55:36 -07005702 # check for vsprintf extension %p<foo> misuses
5703 if ($^V && $^V ge 5.10.0 &&
5704 defined $stat &&
5705 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5706 $1 !~ /^_*volatile_*$/) {
5707 my $bad_extension = "";
5708 my $lc = $stat =~ tr@\n@@;
5709 $lc = $lc + $linenr;
5710 for (my $count = $linenr; $count <= $lc; $count++) {
5711 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5712 $fmt =~ s/%%//g;
5713 if ($fmt =~ /(\%[\*\d\.]*p(?![\WFfSsBKRraEhMmIiUDdgVCbGN]).)/) {
5714 $bad_extension = $1;
5715 last;
5716 }
5717 }
5718 if ($bad_extension ne "") {
5719 my $stat_real = raw_line($linenr, 0);
5720 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5721 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5722 }
5723 WARN("VSPRINTF_POINTER_EXTENSION",
5724 "Invalid vsprintf pointer extension '$bad_extension'\n" . "$here\n$stat_real\n");
5725 }
5726 }
5727
Andy Whitcroft554e1652012-01-10 15:09:57 -08005728# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005729 if ($^V && $^V ge 5.10.0 &&
5730 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005731 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005732
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005733 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005734 my $ms_val = $7;
5735 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005736
Andy Whitcroft554e1652012-01-10 15:09:57 -08005737 if ($ms_size =~ /^(0x|)0$/i) {
5738 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005739 "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 -08005740 } elsif ($ms_size =~ /^(0x|)1$/i) {
5741 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005742 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5743 }
5744 }
5745
Joe Perches98a9bba2014-01-23 15:54:52 -08005746# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perchesf333195d2016-10-11 13:51:53 -07005747# if ($^V && $^V ge 5.10.0 &&
5748# defined $stat &&
5749# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5750# if (WARN("PREFER_ETHER_ADDR_COPY",
5751# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5752# $fix) {
5753# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5754# }
5755# }
Joe Perches98a9bba2014-01-23 15:54:52 -08005756
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005757# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perchesf333195d2016-10-11 13:51:53 -07005758# if ($^V && $^V ge 5.10.0 &&
5759# defined $stat &&
5760# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5761# WARN("PREFER_ETHER_ADDR_EQUAL",
5762# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5763# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005764
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005765# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5766# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perchesf333195d2016-10-11 13:51:53 -07005767# if ($^V && $^V ge 5.10.0 &&
5768# defined $stat &&
5769# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5770#
5771# my $ms_val = $7;
5772#
5773# if ($ms_val =~ /^(?:0x|)0+$/i) {
5774# if (WARN("PREFER_ETH_ZERO_ADDR",
5775# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5776# $fix) {
5777# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5778# }
5779# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5780# if (WARN("PREFER_ETH_BROADCAST_ADDR",
5781# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5782# $fix) {
5783# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5784# }
5785# }
5786# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005787
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005788# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005789 if ($^V && $^V ge 5.10.0 &&
5790 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005791 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005792 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005793 my $call = $1;
5794 my $cast1 = deparenthesize($2);
5795 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005796 my $cast2 = deparenthesize($7);
5797 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005798 my $cast;
5799
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005800 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005801 $cast = "$cast1 or $cast2";
5802 } elsif ($cast1 ne "") {
5803 $cast = $cast1;
5804 } else {
5805 $cast = $cast2;
5806 }
5807 WARN("MINMAX",
5808 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005809 }
5810 }
5811
Joe Perches4a273192012-07-30 14:41:20 -07005812# check usleep_range arguments
5813 if ($^V && $^V ge 5.10.0 &&
5814 defined $stat &&
5815 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5816 my $min = $1;
5817 my $max = $7;
5818 if ($min eq $max) {
5819 WARN("USLEEP_RANGE",
5820 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5821 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5822 $min > $max) {
5823 WARN("USLEEP_RANGE",
5824 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5825 }
5826 }
5827
Joe Perches823b7942013-11-12 15:10:15 -08005828# check for naked sscanf
5829 if ($^V && $^V ge 5.10.0 &&
5830 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005831 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005832 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5833 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5834 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5835 my $lc = $stat =~ tr@\n@@;
5836 $lc = $lc + $linenr;
5837 my $stat_real = raw_line($linenr, 0);
5838 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5839 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5840 }
5841 WARN("NAKED_SSCANF",
5842 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5843 }
5844
Joe Perchesafc819a2014-06-04 16:12:08 -07005845# check for simple sscanf that should be kstrto<foo>
5846 if ($^V && $^V ge 5.10.0 &&
5847 defined $stat &&
5848 $line =~ /\bsscanf\b/) {
5849 my $lc = $stat =~ tr@\n@@;
5850 $lc = $lc + $linenr;
5851 my $stat_real = raw_line($linenr, 0);
5852 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5853 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5854 }
5855 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5856 my $format = $6;
5857 my $count = $format =~ tr@%@%@;
5858 if ($count == 1 &&
5859 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5860 WARN("SSCANF_TO_KSTRTO",
5861 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5862 }
5863 }
5864 }
5865
Joe Perches70dc8a42013-09-11 14:23:58 -07005866# check for new externs in .h files.
5867 if ($realfile =~ /\.h$/ &&
5868 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005869 if (CHK("AVOID_EXTERNS",
5870 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005871 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005872 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005873 }
5874 }
5875
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005876# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005877 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005878 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005879 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005880 my $function_name = $1;
5881 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005882
5883 my $s = $stat;
5884 if (defined $cond) {
5885 substr($s, 0, length($cond), '');
5886 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005887 if ($s =~ /^\s*;/ &&
5888 $function_name ne 'uninitialized_var')
5889 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005890 WARN("AVOID_EXTERNS",
5891 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005892 }
5893
5894 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005895 WARN("FUNCTION_ARGUMENTS",
5896 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005897 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005898
5899 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5900 $stat =~ /^.\s*extern\s+/)
5901 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005902 WARN("AVOID_EXTERNS",
5903 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005904 }
5905
Joe Perchesca0d8922016-10-11 13:52:16 -07005906 if ($realfile =~ /\.[ch]$/ && defined $stat &&
5907 $stat =~ /^.\s*(?:extern\s+)?$Type\s*$Ident\s*\(\s*([^{]+)\s*\)\s*;/s &&
5908 $1 ne "void") {
5909 my $args = trim($1);
5910 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
5911 my $arg = trim($1);
5912 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
5913 WARN("FUNCTION_ARGUMENTS",
5914 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
5915 }
5916 }
5917 }
5918
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005919# checks for new __setup's
5920 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5921 my $name = $1;
5922
5923 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005924 CHK("UNDOCUMENTED_SETUP",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005925 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005926 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005927 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005928
5929# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005930 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005931 WARN("UNNECESSARY_CASTS",
5932 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005933 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005934
Joe Perchesa640d252013-07-03 15:05:21 -07005935# alloc style
5936# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5937 if ($^V && $^V ge 5.10.0 &&
5938 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5939 CHK("ALLOC_SIZEOF_STRUCT",
5940 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5941 }
5942
Joe Perches60a55362014-06-04 16:12:07 -07005943# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5944 if ($^V && $^V ge 5.10.0 &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07005945 defined $stat &&
5946 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
Joe Perches60a55362014-06-04 16:12:07 -07005947 my $oldfunc = $3;
5948 my $a1 = $4;
5949 my $a2 = $10;
5950 my $newfunc = "kmalloc_array";
5951 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005952 my $r1 = $a1;
5953 my $r2 = $a2;
5954 if ($a1 =~ /^sizeof\s*\S/) {
5955 $r1 = $a2;
5956 $r2 = $a1;
5957 }
5958 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5959 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07005960 my $ctx = '';
5961 my $herectx = $here . "\n";
5962 my $cnt = statement_rawlines($stat);
5963 for (my $n = 0; $n < $cnt; $n++) {
5964 $herectx .= raw_line($linenr, $n) . "\n";
5965 }
Joe Perches60a55362014-06-04 16:12:07 -07005966 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07005967 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
5968 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07005969 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005970 $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 -07005971 }
5972 }
5973 }
5974
Joe Perches972fdea2013-04-29 16:18:12 -07005975# check for krealloc arg reuse
5976 if ($^V && $^V ge 5.10.0 &&
5977 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5978 WARN("KREALLOC_ARG_REUSE",
5979 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5980 }
5981
Joe Perches5ce59ae2013-02-21 16:44:18 -08005982# check for alloc argument mismatch
5983 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5984 WARN("ALLOC_ARRAY_ARGS",
5985 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5986 }
5987
Joe Perchescaf2a542011-01-12 16:59:56 -08005988# check for multiple semicolons
5989 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005990 if (WARN("ONE_SEMICOLON",
5991 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5992 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005993 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005994 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005995 }
5996
Tomas Winklercec3aaa2016-08-02 14:04:39 -07005997# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
5998 if ($realfile !~ m@^include/uapi/@ &&
5999 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006000 my $ull = "";
6001 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6002 if (CHK("BIT_MACRO",
6003 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6004 $fix) {
6005 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6006 }
6007 }
6008
Joe Perches2d632742016-05-20 17:04:00 -07006009# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6010 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6011 my $config = $1;
6012 if (WARN("PREFER_IS_ENABLED",
6013 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6014 $fix) {
6015 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6016 }
6017 }
6018
Joe Perchese81f2392014-08-06 16:11:25 -07006019# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08006020 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6021 my $has_break = 0;
6022 my $has_statement = 0;
6023 my $count = 0;
6024 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07006025 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08006026 $prevline--;
6027 my $rline = $rawlines[$prevline - 1];
6028 my $fline = $lines[$prevline - 1];
6029 last if ($fline =~ /^\@\@/);
6030 next if ($fline =~ /^\-/);
6031 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6032 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6033 next if ($fline =~ /^.[\s$;]*$/);
6034 $has_statement = 1;
6035 $count++;
6036 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
6037 }
6038 if (!$has_break && $has_statement) {
6039 WARN("MISSING_BREAK",
Andrew Morton224236d2016-12-12 16:46:26 -08006040 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006041 }
6042 }
6043
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006044# check for switch/default statements without a break;
6045 if ($^V && $^V ge 5.10.0 &&
6046 defined $stat &&
6047 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6048 my $ctx = '';
6049 my $herectx = $here . "\n";
6050 my $cnt = statement_rawlines($stat);
6051 for (my $n = 0; $n < $cnt; $n++) {
6052 $herectx .= raw_line($linenr, $n) . "\n";
6053 }
6054 WARN("DEFAULT_NO_BREAK",
6055 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006056 }
6057
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006058# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006059 if ($line =~ /\b__FUNCTION__\b/) {
6060 if (WARN("USE_FUNC",
6061 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6062 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006063 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006064 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006065 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006066
Joe Perches62ec8182015-02-13 14:38:18 -08006067# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6068 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6069 ERROR("DATE_TIME",
6070 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6071 }
6072
Joe Perches2c924882012-03-23 15:02:20 -07006073# check for use of yield()
6074 if ($line =~ /\byield\s*\(\s*\)/) {
6075 WARN("YIELD",
6076 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6077 }
6078
Joe Perches179f8f42013-07-03 15:05:30 -07006079# check for comparisons against true and false
6080 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6081 my $lead = $1;
6082 my $arg = $2;
6083 my $test = $3;
6084 my $otype = $4;
6085 my $trail = $5;
6086 my $op = "!";
6087
6088 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6089
6090 my $type = lc($otype);
6091 if ($type =~ /^(?:true|false)$/) {
6092 if (("$test" eq "==" && "$type" eq "true") ||
6093 ("$test" eq "!=" && "$type" eq "false")) {
6094 $op = "";
6095 }
6096
6097 CHK("BOOL_COMPARISON",
6098 "Using comparison to $otype is error prone\n" . $herecurr);
6099
6100## maybe suggesting a correct construct would better
6101## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6102
6103 }
6104 }
6105
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006106# check for semaphores initialized locked
6107 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006108 WARN("CONSIDER_COMPLETION",
6109 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006110 }
Joe Perches6712d852012-03-23 15:02:20 -07006111
Joe Perches67d0a072011-10-31 17:13:10 -07006112# recommend kstrto* over simple_strto* and strict_strto*
6113 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006114 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006115 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006116 }
Joe Perches6712d852012-03-23 15:02:20 -07006117
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006118# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006119 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006120 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006121 "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 -07006122 }
Joe Perches6712d852012-03-23 15:02:20 -07006123
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006124# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006125# and avoid what seem like struct definitions 'struct foo {'
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006126 if ($line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006127 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006128 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006129 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006130 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006131
6132# use of NR_CPUS is usually wrong
6133# ignore definitions of NR_CPUS and usage to define arrays as likely right
6134 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006135 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6136 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006137 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6138 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6139 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006140 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006141 WARN("NR_CPUS",
6142 "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 -07006143 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006144
Joe Perches52ea8502013-11-12 15:10:09 -08006145# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6146 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6147 ERROR("DEFINE_ARCH_HAS",
6148 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6149 }
6150
Joe Perchesacd93622015-02-13 14:38:38 -08006151# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6152 if ($^V && $^V ge 5.10.0 &&
6153 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6154 WARN("LIKELY_MISUSE",
6155 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6156 }
6157
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006158# whine mightly about in_atomic
6159 if ($line =~ /\bin_atomic\s*\(/) {
6160 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006161 ERROR("IN_ATOMIC",
6162 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006163 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006164 WARN("IN_ATOMIC",
6165 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006166 }
6167 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006168
Joe Perches481aea52016-05-20 17:04:08 -07006169# whine about ACCESS_ONCE
6170 if ($^V && $^V ge 5.10.0 &&
6171 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
6172 my $par = $1;
6173 my $eq = $2;
6174 my $fun = $3;
6175 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
6176 if (defined($eq)) {
6177 if (WARN("PREFER_WRITE_ONCE",
6178 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
6179 $fix) {
6180 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6181 }
6182 } else {
6183 if (WARN("PREFER_READ_ONCE",
6184 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
6185 $fix) {
6186 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
6187 }
6188 }
6189 }
6190
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006191# check for mutex_trylock_recursive usage
6192 if ($line =~ /mutex_trylock_recursive/) {
6193 ERROR("LOCKING",
6194 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6195 }
6196
Peter Zijlstra1704f472010-03-19 01:37:42 +01006197# check for lockdep_set_novalidate_class
6198 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6199 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6200 if ($realfile !~ m@^kernel/lockdep@ &&
6201 $realfile !~ m@^include/linux/lockdep@ &&
6202 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006203 ERROR("LOCKDEP",
6204 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006205 }
6206 }
Dave Jones88f88312011-01-12 16:59:59 -08006207
Joe Perchesb392c642015-04-16 12:44:16 -07006208 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6209 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006210 WARN("EXPORTED_WORLD_WRITABLE",
6211 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006212 }
Joe Perches24358802014-04-03 14:49:13 -07006213
Joe Perches515a2352014-04-03 14:49:24 -07006214# Mode permission misuses where it seems decimal should be octal
6215# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6216 if ($^V && $^V ge 5.10.0 &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006217 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006218 $line =~ /$mode_perms_search/) {
6219 foreach my $entry (@mode_permission_funcs) {
6220 my $func = $entry->[0];
6221 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006222
Joe Perches459cf0a2016-10-11 13:52:19 -07006223 my $lc = $stat =~ tr@\n@@;
6224 $lc = $lc + $linenr;
6225 my $stat_real = raw_line($linenr, 0);
6226 for (my $count = $linenr + 1; $count <= $lc; $count++) {
6227 $stat_real = $stat_real . "\n" . raw_line($count, 0);
6228 }
6229
Joe Perches515a2352014-04-03 14:49:24 -07006230 my $skip_args = "";
6231 if ($arg_pos > 1) {
6232 $arg_pos--;
6233 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6234 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006235 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006236 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006237 my $val = $1;
6238 $val = $6 if ($skip_args ne "");
Joe Perchesf90774e2016-10-11 13:51:47 -07006239 if (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6240 ($val =~ /^$Octal$/ && length($val) ne 4)) {
Joe Perches515a2352014-04-03 14:49:24 -07006241 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006242 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006243 }
6244 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006245 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006246 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006247 }
Joe Perches24358802014-04-03 14:49:13 -07006248 }
6249 }
6250 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006251
Joe Perches459cf0a2016-10-11 13:52:19 -07006252# check for uses of S_<PERMS> that could be octal for readability
6253 if ($line =~ /\b$mode_perms_string_search\b/) {
6254 my $val = "";
6255 my $oval = "";
6256 my $to = 0;
6257 my $curpos = 0;
6258 my $lastpos = 0;
6259 while ($line =~ /\b(($mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
6260 $curpos = pos($line);
6261 my $match = $2;
6262 my $omatch = $1;
6263 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
6264 $lastpos = $curpos;
6265 $to |= $mode_permission_string_types{$match};
6266 $val .= '\s*\|\s*' if ($val ne "");
6267 $val .= $match;
6268 $oval .= $omatch;
6269 }
6270 $oval =~ s/^\s*\|\s*//;
6271 $oval =~ s/\s*\|\s*$//;
6272 my $octal = sprintf("%04o", $to);
6273 if (WARN("SYMBOLIC_PERMS",
6274 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6275 $fix) {
6276 $fixed[$fixlinenr] =~ s/$val/$octal/;
6277 }
6278 }
6279
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006280# validate content of MODULE_LICENSE against list from include/linux/module.h
6281 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6282 my $extracted_string = get_quoted_string($line, $rawline);
6283 my $valid_licenses = qr{
6284 GPL|
6285 GPL\ v2|
6286 GPL\ and\ additional\ rights|
6287 Dual\ BSD/GPL|
6288 Dual\ MIT/GPL|
6289 Dual\ MPL/GPL|
6290 Proprietary
6291 }x;
6292 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6293 WARN("MODULE_LICENSE",
6294 "unknown module license " . $extracted_string . "\n" . $herecurr);
6295 }
6296 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006297 }
6298
6299 # If we have no input at all, then there is nothing to report on
6300 # so just keep quiet.
6301 if ($#rawlines == -1) {
6302 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006303 }
6304
Andy Whitcroft8905a672007-11-28 16:21:06 -08006305 # In mailback mode only produce a report in the negative, for
6306 # things that appear to be patches.
6307 if ($mailback && ($clean == 1 || !$is_patch)) {
6308 exit(0);
6309 }
6310
6311 # This is not a patch, and we are are in 'no-patch' mode so
6312 # just keep quiet.
6313 if (!$chk_patch && !$is_patch) {
6314 exit(0);
6315 }
6316
Joe Perches06330fc2015-06-25 15:03:11 -07006317 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006318 ERROR("NOT_UNIFIED_DIFF",
6319 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006320 }
Allen Hubbeed43c4e2016-08-02 14:04:45 -07006321 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006322 ERROR("MISSING_SIGN_OFF",
6323 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006324 }
6325
Andy Whitcroft8905a672007-11-28 16:21:06 -08006326 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006327 if ($summary && !($clean == 1 && $quiet == 1)) {
6328 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006329 print "total: $cnt_error errors, $cnt_warn warnings, " .
6330 (($check)? "$cnt_chk checks, " : "") .
6331 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006332 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006333
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006334 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006335 # If there were any defects found and not already fixing them
6336 if (!$clean and !$fix) {
6337 print << "EOM"
6338
6339NOTE: For some of the reported defects, checkpatch may be able to
6340 mechanically convert to the typical style using --fix or --fix-inplace.
6341EOM
6342 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006343 # If there were whitespace errors which cleanpatch can fix
6344 # then suggest that.
6345 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006346 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006347 print << "EOM"
6348
6349NOTE: Whitespace errors detected.
6350 You may wish to use scripts/cleanpatch or scripts/cleanfile
6351EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006352 }
6353 }
6354
Joe Perchesd752fcc2014-08-06 16:11:05 -07006355 if ($clean == 0 && $fix &&
6356 ("@rawlines" ne "@fixed" ||
6357 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006358 my $newfile = $filename;
6359 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006360 my $linecount = 0;
6361 my $f;
6362
Joe Perchesd752fcc2014-08-06 16:11:05 -07006363 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6364
Joe Perches3705ce52013-07-03 15:05:31 -07006365 open($f, '>', $newfile)
6366 or die "$P: Can't open $newfile for write\n";
6367 foreach my $fixed_line (@fixed) {
6368 $linecount++;
6369 if ($file) {
6370 if ($linecount > 3) {
6371 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006372 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006373 }
6374 } else {
6375 print $f $fixed_line . "\n";
6376 }
6377 }
6378 close($f);
6379
6380 if (!$quiet) {
6381 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006382
Joe Perches3705ce52013-07-03 15:05:31 -07006383Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6384
6385Do _NOT_ trust the results written to this file.
6386Do _NOT_ submit these changes without inspecting them for correctness.
6387
6388This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6389No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006390EOM
6391 }
6392 }
6393
Joe Perchesd8469f12015-06-25 15:03:00 -07006394 if ($quiet == 0) {
6395 print "\n";
6396 if ($clean == 1) {
6397 print "$vname has no obvious style problems and is ready for submission.\n";
6398 } else {
6399 print "$vname has style problems, please review.\n";
6400 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006401 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006402 return $clean;
6403}