blob: 755f4802a463942da04890a3fa8a575faaac1720 [file] [log] [blame]
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02001#!/usr/bin/env perl
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02002# SPDX-License-Identifier: GPL-2.0
3#
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004# (c) 2001, Dave Jones. (the file handling bit)
5# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
6# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
7# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02008# (c) 2010-2018 Joe Perches <joe@perches.com>
Joe Hershbergerba2beb52011-10-18 10:06:59 +00009
10use strict;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +020011use warnings;
Tom Rinia50f8de2014-02-27 08:27:28 -050012use POSIX;
Dan Murphy463f6882017-01-31 14:15:53 -060013use File::Basename;
14use Cwd 'abs_path';
Heinrich Schuchardt8716f582017-09-12 09:57:45 +020015use Term::ANSIColor qw(:constants);
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +020016use Encode qw(decode encode);
Joe Hershbergerba2beb52011-10-18 10:06:59 +000017
18my $P = $0;
Dan Murphy463f6882017-01-31 14:15:53 -060019my $D = dirname(abs_path($P));
Joe Hershbergerba2beb52011-10-18 10:06:59 +000020
21my $V = '0.32';
22
23use Getopt::Long qw(:config no_auto_abbrev);
24
25my $quiet = 0;
26my $tree = 1;
27my $chk_signoff = 1;
28my $chk_patch = 1;
29my $tst_only;
30my $emacs = 0;
31my $terse = 0;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +020032my $showfile = 0;
Joe Hershbergerba2beb52011-10-18 10:06:59 +000033my $file = 0;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +020034my $git = 0;
35my %git_commits = ();
Joe Hershbergerba2beb52011-10-18 10:06:59 +000036my $check = 0;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +020037my $check_orig = 0;
Joe Hershbergerba2beb52011-10-18 10:06:59 +000038my $summary = 1;
39my $mailback = 0;
40my $summary_file = 0;
41my $show_types = 0;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +020042my $list_types = 0;
Tom Rinia50f8de2014-02-27 08:27:28 -050043my $fix = 0;
44my $fix_inplace = 0;
Joe Hershbergerba2beb52011-10-18 10:06:59 +000045my $root;
46my %debug;
Tom Rinia50f8de2014-02-27 08:27:28 -050047my %camelcase = ();
48my %use_type = ();
49my @use = ();
Joe Hershbergerba2beb52011-10-18 10:06:59 +000050my %ignore_type = ();
51my @ignore = ();
52my $help = 0;
53my $configuration_file = ".checkpatch.conf";
Simon Glassa33d9822020-05-22 16:32:35 -060054my $max_line_length = 100;
Tom Rinia50f8de2014-02-27 08:27:28 -050055my $ignore_perl_version = 0;
56my $minimum_perl_version = 5.10.0;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +020057my $min_conf_desc_length = 4;
Dan Murphy463f6882017-01-31 14:15:53 -060058my $spelling_file = "$D/spelling.txt";
59my $codespell = 0;
60my $codespellfile = "/usr/share/codespell/dictionary.txt";
Heinrich Schuchardt8716f582017-09-12 09:57:45 +020061my $conststructsfile = "$D/const_structs.checkpatch";
62my $typedefsfile = "";
Simon Glassc8f4d092020-05-22 16:32:36 -060063my $u_boot = 0;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +020064my $color = "auto";
Tom Rinid2e30332020-06-16 10:29:46 -040065my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE
66# git output parsing needs US English output, so first set backtick child process LANGUAGE
67my $git_command ='export LANGUAGE=en_US.UTF-8; git';
68my $tabsize = 8;
Joe Hershbergerba2beb52011-10-18 10:06:59 +000069
70sub help {
71 my ($exitcode) = @_;
72
73 print << "EOM";
74Usage: $P [OPTION]... [FILE]...
75Version: $V
76
77Options:
78 -q, --quiet quiet
79 --no-tree run without a kernel tree
80 --no-signoff do not check for 'Signed-off-by' line
81 --patch treat FILE as patchfile (default)
82 --emacs emacs compile window format
83 --terse one line per report
Heinrich Schuchardt8716f582017-09-12 09:57:45 +020084 --showfile emit diffed file position, not input file position
85 -g, --git treat FILE as a single commit or git revision range
86 single git commit with:
87 <rev>
88 <rev>^
89 <rev>~n
90 multiple git commits with:
91 <rev1>..<rev2>
92 <rev1>...<rev2>
93 <rev>-<count>
94 git merges are ignored
Joe Hershbergerba2beb52011-10-18 10:06:59 +000095 -f, --file treat FILE as regular source file
96 --subjective, --strict enable more subjective tests
Heinrich Schuchardt8716f582017-09-12 09:57:45 +020097 --list-types list the possible message types
Tom Rinia50f8de2014-02-27 08:27:28 -050098 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Hershbergerba2beb52011-10-18 10:06:59 +000099 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200100 --show-types show the specific message type in the output
Simon Glassa33d9822020-05-22 16:32:35 -0600101 --max-line-length=n set the maximum line length, (default $max_line_length)
102 if exceeded, warn on patches
103 requires --strict for use with --file
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200104 --min-conf-desc-length=n set the min description length, if shorter, warn
Tom Rinid2e30332020-06-16 10:29:46 -0400105 --tab-size=n set the number of spaces for tab (default $tabsize)
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000106 --root=PATH PATH to the kernel tree root
107 --no-summary suppress the per-file summary
108 --mailback only produce a report in case of warnings/errors
109 --summary-file include the filename in summary
110 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
111 'values', 'possible', 'type', and 'attr' (default
112 is all off)
113 --test-only=WORD report only warnings/errors containing WORD
114 literally
Tom Rinia50f8de2014-02-27 08:27:28 -0500115 --fix EXPERIMENTAL - may create horrible results
116 If correctable single-line errors exist, create
117 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
118 with potential errors corrected to the preferred
119 checkpatch style
120 --fix-inplace EXPERIMENTAL - may create horrible results
121 Is the same as --fix, but overwrites the input
122 file. It's your fault if there's no backup or git
123 --ignore-perl-version override checking of perl version. expect
124 runtime errors.
Dan Murphy463f6882017-01-31 14:15:53 -0600125 --codespell Use the codespell dictionary for spelling/typos
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200126 (default:/usr/share/codespell/dictionary.txt)
Dan Murphy463f6882017-01-31 14:15:53 -0600127 --codespellfile Use this codespell dictionary
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200128 --typedefsfile Read additional types from this file
129 --color[=WHEN] Use colors 'always', 'never', or only when output
130 is a terminal ('auto'). Default is 'auto'.
Simon Glassc8f4d092020-05-22 16:32:36 -0600131 --u-boot Run additional checks for U-Boot
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000132 -h, --help, --version display this help and exit
133
134When FILE is - read standard input.
135EOM
136
137 exit($exitcode);
138}
139
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200140sub uniq {
141 my %seen;
142 return grep { !$seen{$_}++ } @_;
143}
144
145sub list_types {
146 my ($exitcode) = @_;
147
148 my $count = 0;
149
150 local $/ = undef;
151
152 open(my $script, '<', abs_path($P)) or
153 die "$P: Can't read '$P' $!\n";
154
155 my $text = <$script>;
156 close($script);
157
158 my @types = ();
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +0200159 # Also catch when type or level is passed through a variable
160 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200161 push (@types, $_);
162 }
163 @types = sort(uniq(@types));
164 print("#\tMessage type\n\n");
165 foreach my $type (@types) {
166 print(++$count . "\t" . $type . "\n");
167 }
168
169 exit($exitcode);
170}
171
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000172my $conf = which_conf($configuration_file);
173if (-f $conf) {
174 my @conf_args;
175 open(my $conffile, '<', "$conf")
176 or warn "$P: Can't find a readable $configuration_file file $!\n";
177
178 while (<$conffile>) {
179 my $line = $_;
180
181 $line =~ s/\s*\n?$//g;
182 $line =~ s/^\s*//g;
183 $line =~ s/\s+/ /g;
184
185 next if ($line =~ m/^\s*#/);
186 next if ($line =~ m/^\s*$/);
187
188 my @words = split(" ", $line);
189 foreach my $word (@words) {
190 last if ($word =~ m/^#/);
191 push (@conf_args, $word);
192 }
193 }
194 close($conffile);
195 unshift(@ARGV, @conf_args) if @conf_args;
196}
197
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200198# Perl's Getopt::Long allows options to take optional arguments after a space.
199# Prevent --color by itself from consuming other arguments
200foreach (@ARGV) {
201 if ($_ eq "--color" || $_ eq "-color") {
202 $_ = "--color=$color";
203 }
204}
205
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000206GetOptions(
207 'q|quiet+' => \$quiet,
208 'tree!' => \$tree,
209 'signoff!' => \$chk_signoff,
210 'patch!' => \$chk_patch,
211 'emacs!' => \$emacs,
212 'terse!' => \$terse,
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200213 'showfile!' => \$showfile,
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000214 'f|file!' => \$file,
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200215 'g|git!' => \$git,
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000216 'subjective!' => \$check,
217 'strict!' => \$check,
218 'ignore=s' => \@ignore,
Tom Rinia50f8de2014-02-27 08:27:28 -0500219 'types=s' => \@use,
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000220 'show-types!' => \$show_types,
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200221 'list-types!' => \$list_types,
Kim Phillips9b7b8372013-02-28 12:53:52 +0000222 'max-line-length=i' => \$max_line_length,
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200223 'min-conf-desc-length=i' => \$min_conf_desc_length,
Tom Rinid2e30332020-06-16 10:29:46 -0400224 'tab-size=i' => \$tabsize,
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000225 'root=s' => \$root,
226 'summary!' => \$summary,
227 'mailback!' => \$mailback,
228 'summary-file!' => \$summary_file,
Tom Rinia50f8de2014-02-27 08:27:28 -0500229 'fix!' => \$fix,
230 'fix-inplace!' => \$fix_inplace,
231 'ignore-perl-version!' => \$ignore_perl_version,
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000232 'debug=s' => \%debug,
233 'test-only=s' => \$tst_only,
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200234 'codespell!' => \$codespell,
235 'codespellfile=s' => \$codespellfile,
236 'typedefsfile=s' => \$typedefsfile,
Simon Glassc8f4d092020-05-22 16:32:36 -0600237 'u-boot' => \$u_boot,
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200238 'color=s' => \$color,
239 'no-color' => \$color, #keep old behaviors of -nocolor
240 'nocolor' => \$color, #keep old behaviors of -nocolor
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000241 'h|help' => \$help,
242 'version' => \$help
243) or help(1);
244
245help(0) if ($help);
246
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200247list_types(0) if ($list_types);
248
Tom Rinia50f8de2014-02-27 08:27:28 -0500249$fix = 1 if ($fix_inplace);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200250$check_orig = $check;
Tom Rinia50f8de2014-02-27 08:27:28 -0500251
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000252my $exit = 0;
253
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +0200254my $perl_version_ok = 1;
Tom Rinia50f8de2014-02-27 08:27:28 -0500255if ($^V && $^V lt $minimum_perl_version) {
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +0200256 $perl_version_ok = 0;
Tom Rinia50f8de2014-02-27 08:27:28 -0500257 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +0200258 exit(1) if (!$ignore_perl_version);
Tom Rinia50f8de2014-02-27 08:27:28 -0500259}
260
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200261#if no filenames are given, push '-' to read patch from stdin
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000262if ($#ARGV < 0) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200263 push(@ARGV, '-');
264}
265
266if ($color =~ /^[01]$/) {
267 $color = !$color;
268} elsif ($color =~ /^always$/i) {
269 $color = 1;
270} elsif ($color =~ /^never$/i) {
271 $color = 0;
272} elsif ($color =~ /^auto$/i) {
273 $color = (-t STDOUT);
274} else {
275 die "Invalid color mode: $color\n";
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000276}
277
Tom Rinid2e30332020-06-16 10:29:46 -0400278# skip TAB size 1 to avoid additional checks on $tabsize - 1
279die "Invalid TAB size: $tabsize\n" if ($tabsize < 2);
280
Tom Rinia50f8de2014-02-27 08:27:28 -0500281sub hash_save_array_words {
282 my ($hashRef, $arrayRef) = @_;
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000283
Tom Rinia50f8de2014-02-27 08:27:28 -0500284 my @array = split(/,/, join(',', @$arrayRef));
285 foreach my $word (@array) {
286 $word =~ s/\s*\n?$//g;
287 $word =~ s/^\s*//g;
288 $word =~ s/\s+/ /g;
289 $word =~ tr/[a-z]/[A-Z]/;
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000290
Tom Rinia50f8de2014-02-27 08:27:28 -0500291 next if ($word =~ m/^\s*#/);
292 next if ($word =~ m/^\s*$/);
293
294 $hashRef->{$word}++;
295 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000296}
297
Tom Rinia50f8de2014-02-27 08:27:28 -0500298sub hash_show_words {
299 my ($hashRef, $prefix) = @_;
300
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200301 if (keys %$hashRef) {
302 print "\nNOTE: $prefix message types:";
Tom Rinia50f8de2014-02-27 08:27:28 -0500303 foreach my $word (sort keys %$hashRef) {
304 print " $word";
305 }
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200306 print "\n";
Tom Rinia50f8de2014-02-27 08:27:28 -0500307 }
308}
309
310hash_save_array_words(\%ignore_type, \@ignore);
311hash_save_array_words(\%use_type, \@use);
312
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000313my $dbg_values = 0;
314my $dbg_possible = 0;
315my $dbg_type = 0;
316my $dbg_attr = 0;
317for my $key (keys %debug) {
318 ## no critic
319 eval "\${dbg_$key} = '$debug{$key}';";
320 die "$@" if ($@);
321}
322
323my $rpt_cleaners = 0;
324
325if ($terse) {
326 $emacs = 1;
327 $quiet++;
328}
329
330if ($tree) {
331 if (defined $root) {
332 if (!top_of_kernel_tree($root)) {
333 die "$P: $root: --root does not point at a valid tree\n";
334 }
335 } else {
336 if (top_of_kernel_tree('.')) {
337 $root = '.';
338 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
339 top_of_kernel_tree($1)) {
340 $root = $1;
341 }
342 }
343
344 if (!defined $root) {
345 print "Must be run from the top-level dir. of a kernel tree\n";
346 exit(2);
347 }
348}
349
350my $emitted_corrupt = 0;
351
352our $Ident = qr{
353 [A-Za-z_][A-Za-z\d_]*
354 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
355 }x;
356our $Storage = qr{extern|static|asmlinkage};
357our $Sparse = qr{
358 __user|
359 __kernel|
360 __force|
361 __iomem|
362 __must_check|
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000363 __kprobes|
364 __ref|
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +0200365 __refconst|
366 __refdata|
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200367 __rcu|
368 __private
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000369 }x;
Tom Rinia50f8de2014-02-27 08:27:28 -0500370our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
371our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
372our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
373our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
374our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000375
376# Notes to $Attribute:
377# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
378our $Attribute = qr{
379 const|
380 __percpu|
381 __nocast|
382 __safe|
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200383 __bitwise|
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000384 __packed__|
385 __packed2__|
386 __naked|
387 __maybe_unused|
388 __always_unused|
389 __noreturn|
390 __used|
391 __cold|
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200392 __pure|
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000393 __noclone|
394 __deprecated|
395 __read_mostly|
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +0200396 __ro_after_init|
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000397 __kprobes|
Tom Rinia50f8de2014-02-27 08:27:28 -0500398 $InitAttribute|
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000399 ____cacheline_aligned|
400 ____cacheline_aligned_in_smp|
401 ____cacheline_internodealigned_in_smp|
402 __weak
403 }x;
404our $Modifier;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200405our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000406our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
407our $Lval = qr{$Ident(?:$Member)*};
408
Tom Rinia50f8de2014-02-27 08:27:28 -0500409our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
410our $Binary = qr{(?i)0b[01]+$Int_type?};
411our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
412our $Int = qr{[0-9]+$Int_type?};
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200413our $Octal = qr{0[0-7]+$Int_type?};
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +0200414our $String = qr{"[X\t]*"};
Kim Phillips9b7b8372013-02-28 12:53:52 +0000415our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
416our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
417our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
418our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200419our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Kim Phillips9b7b8372013-02-28 12:53:52 +0000420our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200421our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Tom Rinia50f8de2014-02-27 08:27:28 -0500422our $Arithmetic = qr{\+|-|\*|\/|%};
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000423our $Operators = qr{
424 <=|>=|==|!=|
425 =>|->|<<|>>|<|>|!|~|
Tom Rinia50f8de2014-02-27 08:27:28 -0500426 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000427 }x;
428
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200429our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
430
431our $BasicType;
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000432our $NonptrType;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200433our $NonptrTypeMisordered;
Tom Rinia50f8de2014-02-27 08:27:28 -0500434our $NonptrTypeWithAttr;
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000435our $Type;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200436our $TypeMisordered;
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000437our $Declare;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200438our $DeclareMisordered;
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000439
Kim Phillips9b7b8372013-02-28 12:53:52 +0000440our $NON_ASCII_UTF8 = qr{
441 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000442 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
443 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
444 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
445 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
446 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
447 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
448}x;
449
Kim Phillips9b7b8372013-02-28 12:53:52 +0000450our $UTF8 = qr{
451 [\x09\x0A\x0D\x20-\x7E] # ASCII
452 | $NON_ASCII_UTF8
453}x;
454
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200455our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
456our $typeOtherOSTypedefs = qr{(?x:
457 u_(?:char|short|int|long) | # bsd
458 u(?:nchar|short|int|long) # sysv
459)};
460our $typeKernelTypedefs = qr{(?x:
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000461 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
462 atomic_t
463)};
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200464our $typeTypedefs = qr{(?x:
465 $typeC99Typedefs\b|
466 $typeOtherOSTypedefs\b|
467 $typeKernelTypedefs\b
468)};
469
470our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000471
472our $logFunctions = qr{(?x:
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200473 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
Tom Rinia50f8de2014-02-27 08:27:28 -0500474 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +0200475 TP_printk|
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000476 WARN(?:_RATELIMIT|_ONCE|)|
477 panic|
James Byrnea6859792019-11-21 14:32:46 +0000478 debug|
479 printf|
Tom Rinia50f8de2014-02-27 08:27:28 -0500480 MODULE_[A-Z_]+|
481 seq_vprintf|seq_printf|seq_puts
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000482)};
483
Tom Rinid2e30332020-06-16 10:29:46 -0400484our $allocFunctions = qr{(?x:
485 (?:(?:devm_)?
486 (?:kv|k|v)[czm]alloc(?:_node|_array)? |
487 kstrdup(?:_const)? |
488 kmemdup(?:_nul)?) |
489 (?:\w+)?alloc_skb(?:_ip_align)? |
490 # dev_alloc_skb/netdev_alloc_skb, et al
491 dma_alloc_coherent
492)};
493
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000494our $signature_tags = qr{(?xi:
495 Signed-off-by:|
Tom Rinid2e30332020-06-16 10:29:46 -0400496 Co-developed-by:|
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000497 Acked-by:|
498 Tested-by:|
499 Reviewed-by:|
500 Reported-by:|
Tom Rinia50f8de2014-02-27 08:27:28 -0500501 Suggested-by:|
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000502 To:|
503 Cc:
504)};
505
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200506our @typeListMisordered = (
507 qr{char\s+(?:un)?signed},
508 qr{int\s+(?:(?:un)?signed\s+)?short\s},
509 qr{int\s+short(?:\s+(?:un)?signed)},
510 qr{short\s+int(?:\s+(?:un)?signed)},
511 qr{(?:un)?signed\s+int\s+short},
512 qr{short\s+(?:un)?signed},
513 qr{long\s+int\s+(?:un)?signed},
514 qr{int\s+long\s+(?:un)?signed},
515 qr{long\s+(?:un)?signed\s+int},
516 qr{int\s+(?:un)?signed\s+long},
517 qr{int\s+(?:un)?signed},
518 qr{int\s+long\s+long\s+(?:un)?signed},
519 qr{long\s+long\s+int\s+(?:un)?signed},
520 qr{long\s+long\s+(?:un)?signed\s+int},
521 qr{long\s+long\s+(?:un)?signed},
522 qr{long\s+(?:un)?signed},
523);
524
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000525our @typeList = (
526 qr{void},
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200527 qr{(?:(?:un)?signed\s+)?char},
528 qr{(?:(?:un)?signed\s+)?short\s+int},
529 qr{(?:(?:un)?signed\s+)?short},
530 qr{(?:(?:un)?signed\s+)?int},
531 qr{(?:(?:un)?signed\s+)?long\s+int},
532 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
533 qr{(?:(?:un)?signed\s+)?long\s+long},
534 qr{(?:(?:un)?signed\s+)?long},
535 qr{(?:un)?signed},
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000536 qr{float},
537 qr{double},
538 qr{bool},
539 qr{struct\s+$Ident},
540 qr{union\s+$Ident},
541 qr{enum\s+$Ident},
542 qr{${Ident}_t},
543 qr{${Ident}_handler},
544 qr{${Ident}_handler_fn},
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200545 @typeListMisordered,
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000546);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200547
548our $C90_int_types = qr{(?x:
549 long\s+long\s+int\s+(?:un)?signed|
550 long\s+long\s+(?:un)?signed\s+int|
551 long\s+long\s+(?:un)?signed|
552 (?:(?:un)?signed\s+)?long\s+long\s+int|
553 (?:(?:un)?signed\s+)?long\s+long|
554 int\s+long\s+long\s+(?:un)?signed|
555 int\s+(?:(?:un)?signed\s+)?long\s+long|
556
557 long\s+int\s+(?:un)?signed|
558 long\s+(?:un)?signed\s+int|
559 long\s+(?:un)?signed|
560 (?:(?:un)?signed\s+)?long\s+int|
561 (?:(?:un)?signed\s+)?long|
562 int\s+long\s+(?:un)?signed|
563 int\s+(?:(?:un)?signed\s+)?long|
564
565 int\s+(?:un)?signed|
566 (?:(?:un)?signed\s+)?int
567)};
568
569our @typeListFile = ();
Tom Rinia50f8de2014-02-27 08:27:28 -0500570our @typeListWithAttr = (
571 @typeList,
572 qr{struct\s+$InitAttribute\s+$Ident},
573 qr{union\s+$InitAttribute\s+$Ident},
574);
575
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000576our @modifierList = (
577 qr{fastcall},
578);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200579our @modifierListFile = ();
580
581our @mode_permission_funcs = (
582 ["module_param", 3],
583 ["module_param_(?:array|named|string)", 4],
584 ["module_param_array_named", 5],
585 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
586 ["proc_create(?:_data|)", 2],
587 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
588 ["IIO_DEV_ATTR_[A-Z_]+", 1],
589 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
590 ["SENSOR_TEMPLATE(?:_2|)", 3],
591 ["__ATTR", 2],
592);
593
594#Create a search pattern for all these functions to speed up a loop below
595our $mode_perms_search = "";
596foreach my $entry (@mode_permission_funcs) {
597 $mode_perms_search .= '|' if ($mode_perms_search ne "");
598 $mode_perms_search .= $entry->[0];
599}
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +0200600$mode_perms_search = "(?:${mode_perms_search})";
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200601
Tom Rinid2e30332020-06-16 10:29:46 -0400602our %deprecated_apis = (
603 "synchronize_rcu_bh" => "synchronize_rcu",
604 "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited",
605 "call_rcu_bh" => "call_rcu",
606 "rcu_barrier_bh" => "rcu_barrier",
607 "synchronize_sched" => "synchronize_rcu",
608 "synchronize_sched_expedited" => "synchronize_rcu_expedited",
609 "call_rcu_sched" => "call_rcu",
610 "rcu_barrier_sched" => "rcu_barrier",
611 "get_state_synchronize_sched" => "get_state_synchronize_rcu",
612 "cond_synchronize_sched" => "cond_synchronize_rcu",
613);
614
615#Create a search pattern for all these strings to speed up a loop below
616our $deprecated_apis_search = "";
617foreach my $entry (keys %deprecated_apis) {
618 $deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
619 $deprecated_apis_search .= $entry;
620}
621$deprecated_apis_search = "(?:${deprecated_apis_search})";
622
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200623our $mode_perms_world_writable = qr{
624 S_IWUGO |
625 S_IWOTH |
626 S_IRWXUGO |
627 S_IALLUGO |
628 0[0-7][0-7][2367]
629}x;
630
631our %mode_permission_string_types = (
632 "S_IRWXU" => 0700,
633 "S_IRUSR" => 0400,
634 "S_IWUSR" => 0200,
635 "S_IXUSR" => 0100,
636 "S_IRWXG" => 0070,
637 "S_IRGRP" => 0040,
638 "S_IWGRP" => 0020,
639 "S_IXGRP" => 0010,
640 "S_IRWXO" => 0007,
641 "S_IROTH" => 0004,
642 "S_IWOTH" => 0002,
643 "S_IXOTH" => 0001,
644 "S_IRWXUGO" => 0777,
645 "S_IRUGO" => 0444,
646 "S_IWUGO" => 0222,
647 "S_IXUGO" => 0111,
648);
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000649
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200650#Create a search pattern for all these strings to speed up a loop below
651our $mode_perms_string_search = "";
652foreach my $entry (keys %mode_permission_string_types) {
653 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
654 $mode_perms_string_search .= $entry;
655}
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +0200656our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
657our $multi_mode_perms_string_search = qr{
658 ${single_mode_perms_string_search}
659 (?:\s*\|\s*${single_mode_perms_string_search})*
660}x;
661
662sub perms_to_octal {
663 my ($string) = @_;
664
665 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
666
667 my $val = "";
668 my $oval = "";
669 my $to = 0;
670 my $curpos = 0;
671 my $lastpos = 0;
672 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
673 $curpos = pos($string);
674 my $match = $2;
675 my $omatch = $1;
676 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
677 $lastpos = $curpos;
678 $to |= $mode_permission_string_types{$match};
679 $val .= '\s*\|\s*' if ($val ne "");
680 $val .= $match;
681 $oval .= $omatch;
682 }
683 $oval =~ s/^\s*\|\s*//;
684 $oval =~ s/\s*\|\s*$//;
685 return sprintf("%04o", $to);
686}
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200687
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000688our $allowed_asm_includes = qr{(?x:
689 irq|
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200690 memory|
691 time|
692 reboot
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000693)};
694# memory.h: ARM has a custom one
695
Dan Murphy463f6882017-01-31 14:15:53 -0600696# Load common spelling mistakes and build regular expression list.
697my $misspellings;
698my %spelling_fix;
699
700if (open(my $spelling, '<', $spelling_file)) {
701 while (<$spelling>) {
702 my $line = $_;
703
704 $line =~ s/\s*\n?$//g;
705 $line =~ s/^\s*//g;
706
707 next if ($line =~ m/^\s*#/);
708 next if ($line =~ m/^\s*$/);
709
710 my ($suspect, $fix) = split(/\|\|/, $line);
711
712 $spelling_fix{$suspect} = $fix;
713 }
714 close($spelling);
715} else {
716 warn "No typos will be found - file '$spelling_file': $!\n";
717}
718
719if ($codespell) {
720 if (open(my $spelling, '<', $codespellfile)) {
721 while (<$spelling>) {
722 my $line = $_;
723
724 $line =~ s/\s*\n?$//g;
725 $line =~ s/^\s*//g;
726
727 next if ($line =~ m/^\s*#/);
728 next if ($line =~ m/^\s*$/);
729 next if ($line =~ m/, disabled/i);
730
731 $line =~ s/,.*$//;
732
733 my ($suspect, $fix) = split(/->/, $line);
734
735 $spelling_fix{$suspect} = $fix;
736 }
737 close($spelling);
738 } else {
739 warn "No codespell typos will be found - file '$codespellfile': $!\n";
740 }
741}
742
743$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
744
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200745sub read_words {
746 my ($wordsRef, $file) = @_;
747
748 if (open(my $words, '<', $file)) {
749 while (<$words>) {
750 my $line = $_;
751
752 $line =~ s/\s*\n?$//g;
753 $line =~ s/^\s*//g;
754
755 next if ($line =~ m/^\s*#/);
756 next if ($line =~ m/^\s*$/);
757 if ($line =~ /\s/) {
758 print("$file: '$line' invalid - ignored\n");
759 next;
760 }
761
762 $$wordsRef .= '|' if ($$wordsRef ne "");
763 $$wordsRef .= $line;
764 }
765 close($file);
766 return 1;
767 }
768
769 return 0;
770}
771
772my $const_structs = "";
773read_words(\$const_structs, $conststructsfile)
774 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
775
776my $typeOtherTypedefs = "";
777if (length($typedefsfile)) {
778 read_words(\$typeOtherTypedefs, $typedefsfile)
779 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
780}
781$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
Dan Murphy463f6882017-01-31 14:15:53 -0600782
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000783sub build_types {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200784 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
785 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
786 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Tom Rinia50f8de2014-02-27 08:27:28 -0500787 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000788 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200789 $BasicType = qr{
790 (?:$typeTypedefs\b)|
791 (?:${all}\b)
792 }x;
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000793 $NonptrType = qr{
794 (?:$Modifier\s+|const\s+)*
795 (?:
Kim Phillips9b7b8372013-02-28 12:53:52 +0000796 (?:typeof|__typeof__)\s*\([^\)]*\)|
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000797 (?:$typeTypedefs\b)|
798 (?:${all}\b)
799 )
800 (?:\s+$Modifier|\s+const)*
801 }x;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200802 $NonptrTypeMisordered = qr{
803 (?:$Modifier\s+|const\s+)*
804 (?:
805 (?:${Misordered}\b)
806 )
807 (?:\s+$Modifier|\s+const)*
808 }x;
Tom Rinia50f8de2014-02-27 08:27:28 -0500809 $NonptrTypeWithAttr = qr{
810 (?:$Modifier\s+|const\s+)*
811 (?:
812 (?:typeof|__typeof__)\s*\([^\)]*\)|
813 (?:$typeTypedefs\b)|
814 (?:${allWithAttr}\b)
815 )
816 (?:\s+$Modifier|\s+const)*
817 }x;
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000818 $Type = qr{
819 $NonptrType
Tom Rinid2e30332020-06-16 10:29:46 -0400820 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000821 (?:\s+$Inline|\s+$Modifier)*
822 }x;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200823 $TypeMisordered = qr{
824 $NonptrTypeMisordered
Tom Rinid2e30332020-06-16 10:29:46 -0400825 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200826 (?:\s+$Inline|\s+$Modifier)*
827 }x;
828 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
829 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000830}
831build_types();
832
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000833our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Kim Phillips9b7b8372013-02-28 12:53:52 +0000834
835# Using $balanced_parens, $LvalOrFunc, or $FuncArg
836# requires at least perl version v5.10.0
837# Any use must be runtime checked with $^V
838
839our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200840our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
841our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
842
843our $declaration_macros = qr{(?x:
844 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
845 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +0200846 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(|
847 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200848)};
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000849
850sub deparenthesize {
851 my ($string) = @_;
852 return "" if (!defined($string));
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200853
854 while ($string =~ /^\s*\(.*\)\s*$/) {
855 $string =~ s@^\s*\(\s*@@;
856 $string =~ s@\s*\)\s*$@@;
857 }
858
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000859 $string =~ s@\s+@ @g;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200860
Joe Hershbergerba2beb52011-10-18 10:06:59 +0000861 return $string;
862}
863
Tom Rinia50f8de2014-02-27 08:27:28 -0500864sub seed_camelcase_file {
865 my ($file) = @_;
866
867 return if (!(-f $file));
868
869 local $/;
870
871 open(my $include_file, '<', "$file")
872 or warn "$P: Can't read '$file' $!\n";
873 my $text = <$include_file>;
874 close($include_file);
875
876 my @lines = split('\n', $text);
877
878 foreach my $line (@lines) {
879 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
880 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
881 $camelcase{$1} = 1;
882 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
883 $camelcase{$1} = 1;
884 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
885 $camelcase{$1} = 1;
886 }
887 }
888}
889
Tom Rinid2e30332020-06-16 10:29:46 -0400890our %maintained_status = ();
891
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200892sub is_maintained_obsolete {
893 my ($filename) = @_;
894
895 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
896
Tom Rinid2e30332020-06-16 10:29:46 -0400897 if (!exists($maintained_status{$filename})) {
898 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
899 }
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200900
Tom Rinid2e30332020-06-16 10:29:46 -0400901 return $maintained_status{$filename} =~ /obsolete/i;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200902}
903
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +0200904sub is_SPDX_License_valid {
905 my ($license) = @_;
906
907 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
908
909 my $root_path = abs_path($root);
910 my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
911 return 0 if ($status ne "");
912 return 1;
913}
914
Tom Rinia50f8de2014-02-27 08:27:28 -0500915my $camelcase_seeded = 0;
916sub seed_camelcase_includes {
917 return if ($camelcase_seeded);
918
919 my $files;
920 my $camelcase_cache = "";
921 my @include_files = ();
922
923 $camelcase_seeded = 1;
924
925 if (-e ".git") {
Tom Rinid2e30332020-06-16 10:29:46 -0400926 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
Tom Rinia50f8de2014-02-27 08:27:28 -0500927 chomp $git_last_include_commit;
928 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
929 } else {
930 my $last_mod_date = 0;
931 $files = `find $root/include -name "*.h"`;
932 @include_files = split('\n', $files);
933 foreach my $file (@include_files) {
934 my $date = POSIX::strftime("%Y%m%d%H%M",
935 localtime((stat $file)[9]));
936 $last_mod_date = $date if ($last_mod_date < $date);
937 }
938 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
939 }
940
941 if ($camelcase_cache ne "" && -f $camelcase_cache) {
942 open(my $camelcase_file, '<', "$camelcase_cache")
943 or warn "$P: Can't read '$camelcase_cache' $!\n";
944 while (<$camelcase_file>) {
945 chomp;
946 $camelcase{$_} = 1;
947 }
948 close($camelcase_file);
949
950 return;
951 }
952
953 if (-e ".git") {
Tom Rinid2e30332020-06-16 10:29:46 -0400954 $files = `${git_command} ls-files "include/*.h"`;
Tom Rinia50f8de2014-02-27 08:27:28 -0500955 @include_files = split('\n', $files);
956 }
957
958 foreach my $file (@include_files) {
959 seed_camelcase_file($file);
960 }
961
962 if ($camelcase_cache ne "") {
963 unlink glob ".checkpatch-camelcase.*";
964 open(my $camelcase_file, '>', "$camelcase_cache")
965 or warn "$P: Can't write '$camelcase_cache' $!\n";
966 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
967 print $camelcase_file ("$_\n");
968 }
969 close($camelcase_file);
970 }
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200971}
972
973sub git_commit_info {
974 my ($commit, $id, $desc) = @_;
975
976 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
977
Tom Rinid2e30332020-06-16 10:29:46 -0400978 my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200979 $output =~ s/^\s*//gm;
980 my @lines = split("\n", $output);
981
982 return ($id, $desc) if ($#lines < 0);
983
Tom Rinid2e30332020-06-16 10:29:46 -0400984 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +0200985# Maybe one day convert this block of bash into something that returns
986# all matching commit ids, but it's very slow...
987#
988# echo "checking commits $1..."
989# git rev-list --remotes | grep -i "^$1" |
990# while read line ; do
991# git log --format='%H %s' -1 $line |
992# echo "commit $(cut -c 1-12,41-)"
993# done
994 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
995 $id = undef;
996 } else {
997 $id = substr($lines[0], 0, 12);
998 $desc = substr($lines[0], 41);
999 }
1000
1001 return ($id, $desc);
Tom Rinia50f8de2014-02-27 08:27:28 -05001002}
1003
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001004$chk_signoff = 0 if ($file);
1005
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001006my @rawlines = ();
1007my @lines = ();
Tom Rinia50f8de2014-02-27 08:27:28 -05001008my @fixed = ();
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02001009my @fixed_inserted = ();
1010my @fixed_deleted = ();
Dan Murphy463f6882017-01-31 14:15:53 -06001011my $fixlinenr = -1;
1012
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02001013# If input is git commits, extract all commits from the commit expressions.
1014# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1015die "$P: No git repository found\n" if ($git && !-e ".git");
1016
1017if ($git) {
1018 my @commits = ();
1019 foreach my $commit_expr (@ARGV) {
1020 my $git_range;
1021 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
1022 $git_range = "-$2 $1";
1023 } elsif ($commit_expr =~ m/\.\./) {
1024 $git_range = "$commit_expr";
1025 } else {
1026 $git_range = "-1 $commit_expr";
1027 }
Tom Rinid2e30332020-06-16 10:29:46 -04001028 my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02001029 foreach my $line (split(/\n/, $lines)) {
1030 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
1031 next if (!defined($1) || !defined($2));
1032 my $sha1 = $1;
1033 my $subject = $2;
1034 unshift(@commits, $sha1);
1035 $git_commits{$sha1} = $subject;
1036 }
1037 }
1038 die "$P: no git commits after extraction!\n" if (@commits == 0);
1039 @ARGV = @commits;
1040}
1041
1042my $vname;
Tom Rinid2e30332020-06-16 10:29:46 -04001043$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001044for my $filename (@ARGV) {
1045 my $FILE;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02001046 if ($git) {
1047 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
1048 die "$P: $filename: git format-patch failed - $!\n";
1049 } elsif ($file) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001050 open($FILE, '-|', "diff -u /dev/null $filename") ||
1051 die "$P: $filename: diff failed - $!\n";
1052 } elsif ($filename eq '-') {
1053 open($FILE, '<&STDIN');
1054 } else {
1055 open($FILE, '<', "$filename") ||
1056 die "$P: $filename: open failed - $!\n";
1057 }
1058 if ($filename eq '-') {
1059 $vname = 'Your patch';
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02001060 } elsif ($git) {
1061 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001062 } else {
1063 $vname = $filename;
1064 }
1065 while (<$FILE>) {
1066 chomp;
1067 push(@rawlines, $_);
1068 }
1069 close($FILE);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02001070
1071 if ($#ARGV > 0 && $quiet == 0) {
1072 print '-' x length($vname) . "\n";
1073 print "$vname\n";
1074 print '-' x length($vname) . "\n";
1075 }
1076
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001077 if (!process($filename)) {
1078 $exit = 1;
1079 }
1080 @rawlines = ();
1081 @lines = ();
Tom Rinia50f8de2014-02-27 08:27:28 -05001082 @fixed = ();
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02001083 @fixed_inserted = ();
1084 @fixed_deleted = ();
1085 $fixlinenr = -1;
1086 @modifierListFile = ();
1087 @typeListFile = ();
1088 build_types();
1089}
1090
1091if (!$quiet) {
1092 hash_show_words(\%use_type, "Used");
1093 hash_show_words(\%ignore_type, "Ignored");
1094
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02001095 if (!$perl_version_ok) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02001096 print << "EOM"
1097
1098NOTE: perl $^V is not modern enough to detect all possible issues.
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02001099 An upgrade to at least perl $minimum_perl_version is suggested.
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02001100EOM
1101 }
1102 if ($exit) {
1103 print << "EOM"
1104
1105NOTE: If any of the errors are false positives, please report
1106 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1107EOM
1108 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001109}
1110
1111exit($exit);
1112
1113sub top_of_kernel_tree {
1114 my ($root) = @_;
1115
1116 my @tree_check = (
Tom Rinia50f8de2014-02-27 08:27:28 -05001117 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001118 "README", "Documentation", "arch", "include", "drivers",
1119 "fs", "init", "ipc", "kernel", "lib", "scripts",
1120 );
1121
1122 foreach my $check (@tree_check) {
1123 if (! -e $root . '/' . $check) {
1124 return 0;
1125 }
1126 }
1127 return 1;
Kim Phillips9b7b8372013-02-28 12:53:52 +00001128}
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001129
1130sub parse_email {
1131 my ($formatted_email) = @_;
1132
1133 my $name = "";
Tom Rinid2e30332020-06-16 10:29:46 -04001134 my $name_comment = "";
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001135 my $address = "";
1136 my $comment = "";
1137
1138 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1139 $name = $1;
1140 $address = $2;
1141 $comment = $3 if defined $3;
1142 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1143 $address = $1;
1144 $comment = $2 if defined $2;
1145 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1146 $address = $1;
1147 $comment = $2 if defined $2;
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02001148 $formatted_email =~ s/\Q$address\E.*$//;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001149 $name = $formatted_email;
Tom Rinia50f8de2014-02-27 08:27:28 -05001150 $name = trim($name);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001151 $name =~ s/^\"|\"$//g;
1152 # If there's a name left after stripping spaces and
1153 # leading quotes, and the address doesn't have both
1154 # leading and trailing angle brackets, the address
1155 # is invalid. ie:
1156 # "joe smith joe@smith.com" bad
1157 # "joe smith <joe@smith.com" bad
1158 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1159 $name = "";
1160 $address = "";
1161 $comment = "";
1162 }
1163 }
1164
Tom Rinia50f8de2014-02-27 08:27:28 -05001165 $name = trim($name);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001166 $name =~ s/^\"|\"$//g;
Tom Rinid2e30332020-06-16 10:29:46 -04001167 $name =~ s/(\s*\([^\)]+\))\s*//;
1168 if (defined($1)) {
1169 $name_comment = trim($1);
1170 }
Tom Rinia50f8de2014-02-27 08:27:28 -05001171 $address = trim($address);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001172 $address =~ s/^\<|\>$//g;
1173
1174 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1175 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1176 $name = "\"$name\"";
1177 }
1178
Tom Rinid2e30332020-06-16 10:29:46 -04001179 return ($name, $name_comment, $address, $comment);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001180}
1181
1182sub format_email {
1183 my ($name, $address) = @_;
1184
1185 my $formatted_email;
1186
Tom Rinia50f8de2014-02-27 08:27:28 -05001187 $name = trim($name);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001188 $name =~ s/^\"|\"$//g;
Tom Rinia50f8de2014-02-27 08:27:28 -05001189 $address = trim($address);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001190
1191 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1192 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1193 $name = "\"$name\"";
1194 }
1195
1196 if ("$name" eq "") {
1197 $formatted_email = "$address";
1198 } else {
1199 $formatted_email = "$name <$address>";
1200 }
1201
1202 return $formatted_email;
1203}
1204
Tom Rinid2e30332020-06-16 10:29:46 -04001205sub reformat_email {
1206 my ($email) = @_;
1207
1208 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
1209 return format_email($email_name, $email_address);
1210}
1211
1212sub same_email_addresses {
1213 my ($email1, $email2) = @_;
1214
1215 my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1);
1216 my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2);
1217
1218 return $email1_name eq $email2_name &&
1219 $email1_address eq $email2_address;
1220}
1221
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02001222sub which {
1223 my ($bin) = @_;
1224
1225 foreach my $path (split(/:/, $ENV{PATH})) {
1226 if (-e "$path/$bin") {
1227 return "$path/$bin";
1228 }
1229 }
1230
1231 return "";
1232}
1233
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001234sub which_conf {
1235 my ($conf) = @_;
1236
1237 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1238 if (-e "$path/$conf") {
1239 return "$path/$conf";
1240 }
1241 }
1242
1243 return "";
1244}
1245
1246sub expand_tabs {
1247 my ($str) = @_;
1248
1249 my $res = '';
1250 my $n = 0;
1251 for my $c (split(//, $str)) {
1252 if ($c eq "\t") {
1253 $res .= ' ';
1254 $n++;
Tom Rinid2e30332020-06-16 10:29:46 -04001255 for (; ($n % $tabsize) != 0; $n++) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001256 $res .= ' ';
1257 }
1258 next;
1259 }
1260 $res .= $c;
1261 $n++;
1262 }
1263
1264 return $res;
1265}
1266sub copy_spacing {
1267 (my $res = shift) =~ tr/\t/ /c;
1268 return $res;
1269}
1270
1271sub line_stats {
1272 my ($line) = @_;
1273
1274 # Drop the diff line leader and expand tabs
1275 $line =~ s/^.//;
1276 $line = expand_tabs($line);
1277
1278 # Pick the indent from the front of the line.
1279 my ($white) = ($line =~ /^(\s*)/);
1280
1281 return (length($line), length($white));
1282}
1283
1284my $sanitise_quote = '';
1285
1286sub sanitise_line_reset {
1287 my ($in_comment) = @_;
1288
1289 if ($in_comment) {
1290 $sanitise_quote = '*/';
1291 } else {
1292 $sanitise_quote = '';
1293 }
1294}
1295sub sanitise_line {
1296 my ($line) = @_;
1297
1298 my $res = '';
1299 my $l = '';
1300
1301 my $qlen = 0;
1302 my $off = 0;
1303 my $c;
1304
1305 # Always copy over the diff marker.
1306 $res = substr($line, 0, 1);
1307
1308 for ($off = 1; $off < length($line); $off++) {
1309 $c = substr($line, $off, 1);
1310
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02001311 # Comments we are whacking completely including the begin
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001312 # and end, all to $;.
1313 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1314 $sanitise_quote = '*/';
1315
1316 substr($res, $off, 2, "$;$;");
1317 $off++;
1318 next;
1319 }
1320 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1321 $sanitise_quote = '';
1322 substr($res, $off, 2, "$;$;");
1323 $off++;
1324 next;
1325 }
1326 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1327 $sanitise_quote = '//';
1328
1329 substr($res, $off, 2, $sanitise_quote);
1330 $off++;
1331 next;
1332 }
1333
1334 # A \ in a string means ignore the next character.
1335 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1336 $c eq "\\") {
1337 substr($res, $off, 2, 'XX');
1338 $off++;
1339 next;
1340 }
1341 # Regular quotes.
1342 if ($c eq "'" || $c eq '"') {
1343 if ($sanitise_quote eq '') {
1344 $sanitise_quote = $c;
1345
1346 substr($res, $off, 1, $c);
1347 next;
1348 } elsif ($sanitise_quote eq $c) {
1349 $sanitise_quote = '';
1350 }
1351 }
1352
1353 #print "c<$c> SQ<$sanitise_quote>\n";
1354 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1355 substr($res, $off, 1, $;);
1356 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1357 substr($res, $off, 1, $;);
1358 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1359 substr($res, $off, 1, 'X');
1360 } else {
1361 substr($res, $off, 1, $c);
1362 }
1363 }
1364
1365 if ($sanitise_quote eq '//') {
1366 $sanitise_quote = '';
1367 }
1368
1369 # The pathname on a #include may be surrounded by '<' and '>'.
1370 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1371 my $clean = 'X' x length($1);
1372 $res =~ s@\<.*\>@<$clean>@;
1373
1374 # The whole of a #error is a string.
1375 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1376 my $clean = 'X' x length($1);
1377 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1378 }
1379
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02001380 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1381 my $match = $1;
1382 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1383 }
1384
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001385 return $res;
1386}
1387
Tom Rinia50f8de2014-02-27 08:27:28 -05001388sub get_quoted_string {
1389 my ($line, $rawline) = @_;
1390
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02001391 return "" if (!defined($line) || !defined($rawline));
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02001392 return "" if ($line !~ m/($String)/g);
Tom Rinia50f8de2014-02-27 08:27:28 -05001393 return substr($rawline, $-[0], $+[0] - $-[0]);
1394}
1395
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001396sub ctx_statement_block {
1397 my ($linenr, $remain, $off) = @_;
1398 my $line = $linenr - 1;
1399 my $blk = '';
1400 my $soff = $off;
1401 my $coff = $off - 1;
1402 my $coff_set = 0;
1403
1404 my $loff = 0;
1405
1406 my $type = '';
1407 my $level = 0;
1408 my @stack = ();
1409 my $p;
1410 my $c;
1411 my $len = 0;
1412
1413 my $remainder;
1414 while (1) {
1415 @stack = (['', 0]) if ($#stack == -1);
1416
1417 #warn "CSB: blk<$blk> remain<$remain>\n";
1418 # If we are about to drop off the end, pull in more
1419 # context.
1420 if ($off >= $len) {
1421 for (; $remain > 0; $line++) {
1422 last if (!defined $lines[$line]);
1423 next if ($lines[$line] =~ /^-/);
1424 $remain--;
1425 $loff = $len;
1426 $blk .= $lines[$line] . "\n";
1427 $len = length($blk);
1428 $line++;
1429 last;
1430 }
1431 # Bail if there is no further context.
1432 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1433 if ($off >= $len) {
1434 last;
1435 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00001436 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1437 $level++;
1438 $type = '#';
1439 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001440 }
1441 $p = $c;
1442 $c = substr($blk, $off, 1);
1443 $remainder = substr($blk, $off);
1444
1445 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1446
1447 # Handle nested #if/#else.
1448 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1449 push(@stack, [ $type, $level ]);
1450 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1451 ($type, $level) = @{$stack[$#stack - 1]};
1452 } elsif ($remainder =~ /^#\s*endif\b/) {
1453 ($type, $level) = @{pop(@stack)};
1454 }
1455
1456 # Statement ends at the ';' or a close '}' at the
1457 # outermost level.
1458 if ($level == 0 && $c eq ';') {
1459 last;
1460 }
1461
1462 # An else is really a conditional as long as its not else if
1463 if ($level == 0 && $coff_set == 0 &&
1464 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1465 $remainder =~ /^(else)(?:\s|{)/ &&
1466 $remainder !~ /^else\s+if\b/) {
1467 $coff = $off + length($1) - 1;
1468 $coff_set = 1;
1469 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1470 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1471 }
1472
1473 if (($type eq '' || $type eq '(') && $c eq '(') {
1474 $level++;
1475 $type = '(';
1476 }
1477 if ($type eq '(' && $c eq ')') {
1478 $level--;
1479 $type = ($level != 0)? '(' : '';
1480
1481 if ($level == 0 && $coff < $soff) {
1482 $coff = $off;
1483 $coff_set = 1;
1484 #warn "CSB: mark coff<$coff>\n";
1485 }
1486 }
1487 if (($type eq '' || $type eq '{') && $c eq '{') {
1488 $level++;
1489 $type = '{';
1490 }
1491 if ($type eq '{' && $c eq '}') {
1492 $level--;
1493 $type = ($level != 0)? '{' : '';
1494
1495 if ($level == 0) {
1496 if (substr($blk, $off + 1, 1) eq ';') {
1497 $off++;
1498 }
1499 last;
1500 }
1501 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00001502 # Preprocessor commands end at the newline unless escaped.
1503 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1504 $level--;
1505 $type = '';
1506 $off++;
1507 last;
1508 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001509 $off++;
1510 }
1511 # We are truly at the end, so shuffle to the next line.
1512 if ($off == $len) {
1513 $loff = $len + 1;
1514 $line++;
1515 $remain--;
1516 }
1517
1518 my $statement = substr($blk, $soff, $off - $soff + 1);
1519 my $condition = substr($blk, $soff, $coff - $soff + 1);
1520
1521 #warn "STATEMENT<$statement>\n";
1522 #warn "CONDITION<$condition>\n";
1523
1524 #print "coff<$coff> soff<$off> loff<$loff>\n";
1525
1526 return ($statement, $condition,
1527 $line, $remain + 1, $off - $loff + 1, $level);
1528}
1529
1530sub statement_lines {
1531 my ($stmt) = @_;
1532
1533 # Strip the diff line prefixes and rip blank lines at start and end.
1534 $stmt =~ s/(^|\n)./$1/g;
1535 $stmt =~ s/^\s*//;
1536 $stmt =~ s/\s*$//;
1537
1538 my @stmt_lines = ($stmt =~ /\n/g);
1539
1540 return $#stmt_lines + 2;
1541}
1542
1543sub statement_rawlines {
1544 my ($stmt) = @_;
1545
1546 my @stmt_lines = ($stmt =~ /\n/g);
1547
1548 return $#stmt_lines + 2;
1549}
1550
1551sub statement_block_size {
1552 my ($stmt) = @_;
1553
1554 $stmt =~ s/(^|\n)./$1/g;
1555 $stmt =~ s/^\s*{//;
1556 $stmt =~ s/}\s*$//;
1557 $stmt =~ s/^\s*//;
1558 $stmt =~ s/\s*$//;
1559
1560 my @stmt_lines = ($stmt =~ /\n/g);
1561 my @stmt_statements = ($stmt =~ /;/g);
1562
1563 my $stmt_lines = $#stmt_lines + 2;
1564 my $stmt_statements = $#stmt_statements + 1;
1565
1566 if ($stmt_lines > $stmt_statements) {
1567 return $stmt_lines;
1568 } else {
1569 return $stmt_statements;
1570 }
1571}
1572
1573sub ctx_statement_full {
1574 my ($linenr, $remain, $off) = @_;
1575 my ($statement, $condition, $level);
1576
1577 my (@chunks);
1578
1579 # Grab the first conditional/block pair.
1580 ($statement, $condition, $linenr, $remain, $off, $level) =
1581 ctx_statement_block($linenr, $remain, $off);
1582 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1583 push(@chunks, [ $condition, $statement ]);
1584 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1585 return ($level, $linenr, @chunks);
1586 }
1587
1588 # Pull in the following conditional/block pairs and see if they
1589 # could continue the statement.
1590 for (;;) {
1591 ($statement, $condition, $linenr, $remain, $off, $level) =
1592 ctx_statement_block($linenr, $remain, $off);
1593 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1594 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1595 #print "C: push\n";
1596 push(@chunks, [ $condition, $statement ]);
1597 }
1598
1599 return ($level, $linenr, @chunks);
1600}
1601
1602sub ctx_block_get {
1603 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1604 my $line;
1605 my $start = $linenr - 1;
1606 my $blk = '';
1607 my @o;
1608 my @c;
1609 my @res = ();
1610
1611 my $level = 0;
1612 my @stack = ($level);
1613 for ($line = $start; $remain > 0; $line++) {
1614 next if ($rawlines[$line] =~ /^-/);
1615 $remain--;
1616
1617 $blk .= $rawlines[$line];
1618
1619 # Handle nested #if/#else.
1620 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1621 push(@stack, $level);
1622 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1623 $level = $stack[$#stack - 1];
1624 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1625 $level = pop(@stack);
1626 }
1627
1628 foreach my $c (split(//, $lines[$line])) {
1629 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1630 if ($off > 0) {
1631 $off--;
1632 next;
1633 }
1634
1635 if ($c eq $close && $level > 0) {
1636 $level--;
1637 last if ($level == 0);
1638 } elsif ($c eq $open) {
1639 $level++;
1640 }
1641 }
1642
1643 if (!$outer || $level <= 1) {
1644 push(@res, $rawlines[$line]);
1645 }
1646
1647 last if ($level == 0);
1648 }
1649
1650 return ($level, @res);
1651}
1652sub ctx_block_outer {
1653 my ($linenr, $remain) = @_;
1654
1655 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1656 return @r;
1657}
1658sub ctx_block {
1659 my ($linenr, $remain) = @_;
1660
1661 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1662 return @r;
1663}
1664sub ctx_statement {
1665 my ($linenr, $remain, $off) = @_;
1666
1667 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1668 return @r;
1669}
1670sub ctx_block_level {
1671 my ($linenr, $remain) = @_;
1672
1673 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1674}
1675sub ctx_statement_level {
1676 my ($linenr, $remain, $off) = @_;
1677
1678 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1679}
1680
1681sub ctx_locate_comment {
1682 my ($first_line, $end_line) = @_;
1683
1684 # Catch a comment on the end of the line itself.
1685 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1686 return $current_comment if (defined $current_comment);
1687
1688 # Look through the context and try and figure out if there is a
1689 # comment.
1690 my $in_comment = 0;
1691 $current_comment = '';
1692 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1693 my $line = $rawlines[$linenr - 1];
1694 #warn " $line\n";
1695 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1696 $in_comment = 1;
1697 }
1698 if ($line =~ m@/\*@) {
1699 $in_comment = 1;
1700 }
1701 if (!$in_comment && $current_comment ne '') {
1702 $current_comment = '';
1703 }
1704 $current_comment .= $line . "\n" if ($in_comment);
1705 if ($line =~ m@\*/@) {
1706 $in_comment = 0;
1707 }
1708 }
1709
1710 chomp($current_comment);
1711 return($current_comment);
1712}
1713sub ctx_has_comment {
1714 my ($first_line, $end_line) = @_;
1715 my $cmt = ctx_locate_comment($first_line, $end_line);
1716
1717 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1718 ##print "CMMT: $cmt\n";
1719
1720 return ($cmt ne '');
1721}
1722
1723sub raw_line {
1724 my ($linenr, $cnt) = @_;
1725
1726 my $offset = $linenr - 1;
1727 $cnt++;
1728
1729 my $line;
1730 while ($cnt) {
1731 $line = $rawlines[$offset++];
1732 next if (defined($line) && $line =~ /^-/);
1733 $cnt--;
1734 }
1735
1736 return $line;
1737}
1738
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02001739sub get_stat_real {
1740 my ($linenr, $lc) = @_;
1741
1742 my $stat_real = raw_line($linenr, 0);
1743 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1744 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1745 }
1746
1747 return $stat_real;
1748}
1749
1750sub get_stat_here {
1751 my ($linenr, $cnt, $here) = @_;
1752
1753 my $herectx = $here . "\n";
1754 for (my $n = 0; $n < $cnt; $n++) {
1755 $herectx .= raw_line($linenr, $n) . "\n";
1756 }
1757
1758 return $herectx;
1759}
1760
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001761sub cat_vet {
1762 my ($vet) = @_;
1763 my ($res, $coded);
1764
1765 $res = '';
1766 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1767 $res .= $1;
1768 if ($2 ne '') {
1769 $coded = sprintf("^%c", unpack('C', $2) + 64);
1770 $res .= $coded;
1771 }
1772 }
1773 $res =~ s/$/\$/;
1774
1775 return $res;
1776}
1777
1778my $av_preprocessor = 0;
1779my $av_pending;
1780my @av_paren_type;
1781my $av_pend_colon;
1782
1783sub annotate_reset {
1784 $av_preprocessor = 0;
1785 $av_pending = '_';
1786 @av_paren_type = ('E');
1787 $av_pend_colon = 'O';
1788}
1789
1790sub annotate_values {
1791 my ($stream, $type) = @_;
1792
1793 my $res;
1794 my $var = '_' x length($stream);
1795 my $cur = $stream;
1796
1797 print "$stream\n" if ($dbg_values > 1);
1798
1799 while (length($cur)) {
1800 @av_paren_type = ('E') if ($#av_paren_type < 0);
1801 print " <" . join('', @av_paren_type) .
1802 "> <$type> <$av_pending>" if ($dbg_values > 1);
1803 if ($cur =~ /^(\s+)/o) {
1804 print "WS($1)\n" if ($dbg_values > 1);
1805 if ($1 =~ /\n/ && $av_preprocessor) {
1806 $type = pop(@av_paren_type);
1807 $av_preprocessor = 0;
1808 }
1809
1810 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1811 print "CAST($1)\n" if ($dbg_values > 1);
1812 push(@av_paren_type, $type);
Kim Phillips9b7b8372013-02-28 12:53:52 +00001813 $type = 'c';
Joe Hershbergerba2beb52011-10-18 10:06:59 +00001814
1815 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1816 print "DECLARE($1)\n" if ($dbg_values > 1);
1817 $type = 'T';
1818
1819 } elsif ($cur =~ /^($Modifier)\s*/) {
1820 print "MODIFIER($1)\n" if ($dbg_values > 1);
1821 $type = 'T';
1822
1823 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1824 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1825 $av_preprocessor = 1;
1826 push(@av_paren_type, $type);
1827 if ($2 ne '') {
1828 $av_pending = 'N';
1829 }
1830 $type = 'E';
1831
1832 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1833 print "UNDEF($1)\n" if ($dbg_values > 1);
1834 $av_preprocessor = 1;
1835 push(@av_paren_type, $type);
1836
1837 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1838 print "PRE_START($1)\n" if ($dbg_values > 1);
1839 $av_preprocessor = 1;
1840
1841 push(@av_paren_type, $type);
1842 push(@av_paren_type, $type);
1843 $type = 'E';
1844
1845 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1846 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1847 $av_preprocessor = 1;
1848
1849 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1850
1851 $type = 'E';
1852
1853 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1854 print "PRE_END($1)\n" if ($dbg_values > 1);
1855
1856 $av_preprocessor = 1;
1857
1858 # Assume all arms of the conditional end as this
1859 # one does, and continue as if the #endif was not here.
1860 pop(@av_paren_type);
1861 push(@av_paren_type, $type);
1862 $type = 'E';
1863
1864 } elsif ($cur =~ /^(\\\n)/o) {
1865 print "PRECONT($1)\n" if ($dbg_values > 1);
1866
1867 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1868 print "ATTR($1)\n" if ($dbg_values > 1);
1869 $av_pending = $type;
1870 $type = 'N';
1871
1872 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1873 print "SIZEOF($1)\n" if ($dbg_values > 1);
1874 if (defined $2) {
1875 $av_pending = 'V';
1876 }
1877 $type = 'N';
1878
1879 } elsif ($cur =~ /^(if|while|for)\b/o) {
1880 print "COND($1)\n" if ($dbg_values > 1);
1881 $av_pending = 'E';
1882 $type = 'N';
1883
1884 } elsif ($cur =~/^(case)/o) {
1885 print "CASE($1)\n" if ($dbg_values > 1);
1886 $av_pend_colon = 'C';
1887 $type = 'N';
1888
1889 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1890 print "KEYWORD($1)\n" if ($dbg_values > 1);
1891 $type = 'N';
1892
1893 } elsif ($cur =~ /^(\()/o) {
1894 print "PAREN('$1')\n" if ($dbg_values > 1);
1895 push(@av_paren_type, $av_pending);
1896 $av_pending = '_';
1897 $type = 'N';
1898
1899 } elsif ($cur =~ /^(\))/o) {
1900 my $new_type = pop(@av_paren_type);
1901 if ($new_type ne '_') {
1902 $type = $new_type;
1903 print "PAREN('$1') -> $type\n"
1904 if ($dbg_values > 1);
1905 } else {
1906 print "PAREN('$1')\n" if ($dbg_values > 1);
1907 }
1908
1909 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1910 print "FUNC($1)\n" if ($dbg_values > 1);
1911 $type = 'V';
1912 $av_pending = 'V';
1913
1914 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1915 if (defined $2 && $type eq 'C' || $type eq 'T') {
1916 $av_pend_colon = 'B';
1917 } elsif ($type eq 'E') {
1918 $av_pend_colon = 'L';
1919 }
1920 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1921 $type = 'V';
1922
1923 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1924 print "IDENT($1)\n" if ($dbg_values > 1);
1925 $type = 'V';
1926
1927 } elsif ($cur =~ /^($Assignment)/o) {
1928 print "ASSIGN($1)\n" if ($dbg_values > 1);
1929 $type = 'N';
1930
1931 } elsif ($cur =~/^(;|{|})/) {
1932 print "END($1)\n" if ($dbg_values > 1);
1933 $type = 'E';
1934 $av_pend_colon = 'O';
1935
1936 } elsif ($cur =~/^(,)/) {
1937 print "COMMA($1)\n" if ($dbg_values > 1);
1938 $type = 'C';
1939
1940 } elsif ($cur =~ /^(\?)/o) {
1941 print "QUESTION($1)\n" if ($dbg_values > 1);
1942 $type = 'N';
1943
1944 } elsif ($cur =~ /^(:)/o) {
1945 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1946
1947 substr($var, length($res), 1, $av_pend_colon);
1948 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1949 $type = 'E';
1950 } else {
1951 $type = 'N';
1952 }
1953 $av_pend_colon = 'O';
1954
1955 } elsif ($cur =~ /^(\[)/o) {
1956 print "CLOSE($1)\n" if ($dbg_values > 1);
1957 $type = 'N';
1958
1959 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1960 my $variant;
1961
1962 print "OPV($1)\n" if ($dbg_values > 1);
1963 if ($type eq 'V') {
1964 $variant = 'B';
1965 } else {
1966 $variant = 'U';
1967 }
1968
1969 substr($var, length($res), 1, $variant);
1970 $type = 'N';
1971
1972 } elsif ($cur =~ /^($Operators)/o) {
1973 print "OP($1)\n" if ($dbg_values > 1);
1974 if ($1 ne '++' && $1 ne '--') {
1975 $type = 'N';
1976 }
1977
1978 } elsif ($cur =~ /(^.)/o) {
1979 print "C($1)\n" if ($dbg_values > 1);
1980 }
1981 if (defined $1) {
1982 $cur = substr($cur, length($1));
1983 $res .= $type x length($1);
1984 }
1985 }
1986
1987 return ($res, $var);
1988}
1989
1990sub possible {
1991 my ($possible, $line) = @_;
1992 my $notPermitted = qr{(?:
1993 ^(?:
1994 $Modifier|
1995 $Storage|
1996 $Type|
1997 DEFINE_\S+
1998 )$|
1999 ^(?:
2000 goto|
2001 return|
2002 case|
2003 else|
2004 asm|__asm__|
Kim Phillips9b7b8372013-02-28 12:53:52 +00002005 do|
2006 \#|
2007 \#\#|
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002008 )(?:\s|$)|
2009 ^(?:typedef|struct|enum)\b
2010 )}x;
2011 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
2012 if ($possible !~ $notPermitted) {
2013 # Check for modifiers.
2014 $possible =~ s/\s*$Storage\s*//g;
2015 $possible =~ s/\s*$Sparse\s*//g;
2016 if ($possible =~ /^\s*$/) {
2017
2018 } elsif ($possible =~ /\s/) {
2019 $possible =~ s/\s*$Type\s*//g;
2020 for my $modifier (split(' ', $possible)) {
2021 if ($modifier !~ $notPermitted) {
2022 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002023 push(@modifierListFile, $modifier);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002024 }
2025 }
2026
2027 } else {
2028 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002029 push(@typeListFile, $possible);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002030 }
2031 build_types();
2032 } else {
2033 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
2034 }
2035}
2036
2037my $prefix = '';
2038
2039sub show_type {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002040 my ($type) = @_;
2041
2042 $type =~ tr/[a-z]/[A-Z]/;
Tom Rinia50f8de2014-02-27 08:27:28 -05002043
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002044 return defined $use_type{$type} if (scalar keys %use_type > 0);
2045
2046 return !defined $ignore_type{$type};
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002047}
2048
2049sub report {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002050 my ($level, $type, $msg) = @_;
2051
2052 if (!show_type($type) ||
2053 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002054 return 0;
2055 }
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002056 my $output = '';
2057 if ($color) {
2058 if ($level eq 'ERROR') {
2059 $output .= RED;
2060 } elsif ($level eq 'WARNING') {
2061 $output .= YELLOW;
2062 } else {
2063 $output .= GREEN;
2064 }
2065 }
2066 $output .= $prefix . $level . ':';
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002067 if ($show_types) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002068 $output .= BLUE if ($color);
2069 $output .= "$type:";
2070 }
2071 $output .= RESET if ($color);
2072 $output .= ' ' . $msg . "\n";
2073
2074 if ($showfile) {
2075 my @lines = split("\n", $output, -1);
2076 splice(@lines, 1, 1);
2077 $output = join("\n", @lines);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002078 }
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002079 $output = (split('\n', $output))[0] . "\n" if ($terse);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002080
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002081 push(our @report, $output);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002082
2083 return 1;
2084}
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002085
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002086sub report_dump {
2087 our @report;
2088}
2089
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002090sub fixup_current_range {
2091 my ($lineRef, $offset, $length) = @_;
2092
2093 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2094 my $o = $1;
2095 my $l = $2;
2096 my $no = $o + $offset;
2097 my $nl = $l + $length;
2098 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2099 }
2100}
2101
2102sub fix_inserted_deleted_lines {
2103 my ($linesRef, $insertedRef, $deletedRef) = @_;
2104
2105 my $range_last_linenr = 0;
2106 my $delta_offset = 0;
2107
2108 my $old_linenr = 0;
2109 my $new_linenr = 0;
2110
2111 my $next_insert = 0;
2112 my $next_delete = 0;
2113
2114 my @lines = ();
2115
2116 my $inserted = @{$insertedRef}[$next_insert++];
2117 my $deleted = @{$deletedRef}[$next_delete++];
2118
2119 foreach my $old_line (@{$linesRef}) {
2120 my $save_line = 1;
2121 my $line = $old_line; #don't modify the array
2122 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
2123 $delta_offset = 0;
2124 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2125 $range_last_linenr = $new_linenr;
2126 fixup_current_range(\$line, $delta_offset, 0);
2127 }
2128
2129 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2130 $deleted = @{$deletedRef}[$next_delete++];
2131 $save_line = 0;
2132 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2133 }
2134
2135 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2136 push(@lines, ${$inserted}{'LINE'});
2137 $inserted = @{$insertedRef}[$next_insert++];
2138 $new_linenr++;
2139 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2140 }
2141
2142 if ($save_line) {
2143 push(@lines, $line);
2144 $new_linenr++;
2145 }
2146
2147 $old_linenr++;
2148 }
2149
2150 return @lines;
2151}
2152
2153sub fix_insert_line {
2154 my ($linenr, $line) = @_;
2155
2156 my $inserted = {
2157 LINENR => $linenr,
2158 LINE => $line,
2159 };
2160 push(@fixed_inserted, $inserted);
2161}
2162
2163sub fix_delete_line {
2164 my ($linenr, $line) = @_;
2165
2166 my $deleted = {
2167 LINENR => $linenr,
2168 LINE => $line,
2169 };
2170
2171 push(@fixed_deleted, $deleted);
2172}
2173
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002174sub ERROR {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002175 my ($type, $msg) = @_;
2176
2177 if (report("ERROR", $type, $msg)) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002178 our $clean = 0;
2179 our $cnt_error++;
Tom Rinia50f8de2014-02-27 08:27:28 -05002180 return 1;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002181 }
Tom Rinia50f8de2014-02-27 08:27:28 -05002182 return 0;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002183}
2184sub WARN {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002185 my ($type, $msg) = @_;
2186
2187 if (report("WARNING", $type, $msg)) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002188 our $clean = 0;
2189 our $cnt_warn++;
Tom Rinia50f8de2014-02-27 08:27:28 -05002190 return 1;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002191 }
Tom Rinia50f8de2014-02-27 08:27:28 -05002192 return 0;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002193}
2194sub CHK {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002195 my ($type, $msg) = @_;
2196
2197 if ($check && report("CHECK", $type, $msg)) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002198 our $clean = 0;
2199 our $cnt_chk++;
Tom Rinia50f8de2014-02-27 08:27:28 -05002200 return 1;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002201 }
Tom Rinia50f8de2014-02-27 08:27:28 -05002202 return 0;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002203}
2204
2205sub check_absolute_file {
2206 my ($absolute, $herecurr) = @_;
2207 my $file = $absolute;
2208
2209 ##print "absolute<$absolute>\n";
2210
2211 # See if any suffix of this path is a path within the tree.
2212 while ($file =~ s@^[^/]*/@@) {
2213 if (-f "$root/$file") {
2214 ##print "file<$file>\n";
2215 last;
2216 }
2217 }
2218 if (! -f _) {
2219 return 0;
2220 }
2221
2222 # It is, so see if the prefix is acceptable.
2223 my $prefix = $absolute;
2224 substr($prefix, -length($file)) = '';
2225
2226 ##print "prefix<$prefix>\n";
2227 if ($prefix ne ".../") {
2228 WARN("USE_RELATIVE_PATH",
2229 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
2230 }
2231}
2232
Tom Rinia50f8de2014-02-27 08:27:28 -05002233sub trim {
2234 my ($string) = @_;
2235
2236 $string =~ s/^\s+|\s+$//g;
2237
2238 return $string;
2239}
2240
2241sub ltrim {
2242 my ($string) = @_;
2243
2244 $string =~ s/^\s+//;
2245
2246 return $string;
2247}
2248
2249sub rtrim {
2250 my ($string) = @_;
2251
2252 $string =~ s/\s+$//;
2253
2254 return $string;
2255}
2256
2257sub string_find_replace {
2258 my ($string, $find, $replace) = @_;
2259
2260 $string =~ s/$find/$replace/g;
2261
2262 return $string;
2263}
2264
2265sub tabify {
2266 my ($leading) = @_;
2267
Tom Rinid2e30332020-06-16 10:29:46 -04002268 my $source_indent = $tabsize;
Tom Rinia50f8de2014-02-27 08:27:28 -05002269 my $max_spaces_before_tab = $source_indent - 1;
2270 my $spaces_to_tab = " " x $source_indent;
2271
2272 #convert leading spaces to tabs
2273 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2274 #Remove spaces before a tab
2275 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2276
2277 return "$leading";
2278}
2279
Kim Phillips9b7b8372013-02-28 12:53:52 +00002280sub pos_last_openparen {
2281 my ($line) = @_;
2282
2283 my $pos = 0;
2284
2285 my $opens = $line =~ tr/\(/\(/;
2286 my $closes = $line =~ tr/\)/\)/;
2287
2288 my $last_openparen = 0;
2289
2290 if (($opens == 0) || ($closes >= $opens)) {
2291 return -1;
2292 }
2293
2294 my $len = length($line);
2295
2296 for ($pos = 0; $pos < $len; $pos++) {
2297 my $string = substr($line, $pos);
2298 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2299 $pos += length($1) - 1;
2300 } elsif (substr($line, $pos, 1) eq '(') {
2301 $last_openparen = $pos;
2302 } elsif (index($string, '(') == -1) {
2303 last;
2304 }
2305 }
2306
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002307 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Kim Phillips9b7b8372013-02-28 12:53:52 +00002308}
2309
Tom Rinid2e30332020-06-16 10:29:46 -04002310sub get_raw_comment {
2311 my ($line, $rawline) = @_;
2312 my $comment = '';
2313
2314 for my $i (0 .. (length($line) - 1)) {
2315 if (substr($line, $i, 1) eq "$;") {
2316 $comment .= substr($rawline, $i, 1);
2317 }
2318 }
2319
2320 return $comment;
2321}
2322
Simon Glass2d848112020-12-03 16:55:24 -07002323# Args:
2324# line: Patch line to check
2325# auto: Auto variable name, e.g. "per_child_auto"
2326# suffix: Suffix to expect on member, e.g. "_priv"
2327# warning: Warning name, e.g. "PRIV_AUTO"
2328sub u_boot_struct_name {
2329 my ($line, $auto, $suffix, $warning) = @_;
2330
2331 # Use _priv as a suffix for the device-private data struct
2332 if ($line =~ /^\+\s*\.${auto}\s*=\s*sizeof\(struct\((\w+)\).*/) {
2333 my $struct_name = $1;
2334 if ($struct_name !~ /^\w+${suffix}/) {
2335 WARN($warning, "struct \'$struct_name\' should have a ${suffix} suffix");
2336 }
2337 }
2338}
2339
Simon Glassc8f4d092020-05-22 16:32:36 -06002340# Checks specific to U-Boot
2341sub u_boot_line {
Simon Glassf38051e2020-07-19 10:16:01 -06002342 my ($realfile, $line, $rawline, $herecurr) = @_;
Simon Glass7d919f52020-05-22 16:32:37 -06002343
2344 # ask for a test if a new uclass ID is added
2345 if ($realfile =~ /uclass-id.h/ && $line =~ /^\+/) {
2346 WARN("NEW_UCLASS",
2347 "Possible new uclass - make sure to add a sandbox driver, plus a test in test/dm/<name>.c\n" . $herecurr);
2348 }
Simon Glass3ee01322020-05-22 16:32:38 -06002349
2350 # try to get people to use the livetree API
2351 if ($line =~ /^\+.*fdtdec_/) {
2352 WARN("LIVETREE",
2353 "Use the livetree API (dev_read_...)\n" . $herecurr);
2354 }
Simon Glass35bf3b02020-05-22 16:32:39 -06002355
2356 # add tests for new commands
2357 if ($line =~ /^\+.*do_($Ident)\(struct cmd_tbl.*/) {
2358 WARN("CMD_TEST",
2359 "Possible new command - make sure you add a test\n" . $herecurr);
2360 }
Simon Glass567240d2020-05-22 16:32:40 -06002361
2362 # use if instead of #if
Simon Glass2ec1ed22020-06-14 10:54:08 -06002363 if ($realfile =~ /\.c$/ && $line =~ /^\+#if.*CONFIG.*/) {
Simon Glass567240d2020-05-22 16:32:40 -06002364 WARN("PREFER_IF",
2365 "Use 'if (IS_ENABLED(CONFIG...))' instead of '#if or #ifdef' where possible\n" . $herecurr);
2366 }
Tom Rinid7b4ab52020-05-26 14:29:02 -04002367
2368 # use defconfig to manage CONFIG_CMD options
2369 if ($line =~ /\+\s*#\s*(define|undef)\s+(CONFIG_CMD\w*)\b/) {
2370 ERROR("DEFINE_CONFIG_CMD",
2371 "All commands are managed by Kconfig\n" . $herecurr);
2372 }
Simon Glassf38051e2020-07-19 10:16:01 -06002373
2374 # Don't put common.h and dm.h in header files
2375 if ($realfile =~ /\.h$/ && $rawline =~ /^\+#include\s*<(common|dm)\.h>*/) {
2376 ERROR("BARRED_INCLUDE_IN_HDR",
2377 "Avoid including common.h and dm.h in header files\n" . $herecurr);
2378 }
Tom Rini46b3e0b2020-08-20 08:37:49 -04002379
2380 # Do not disable fdt / initrd relocation
2381 if ($rawline =~ /.*(fdt|initrd)_high=0xffffffff/) {
2382 ERROR("DISABLE_FDT_OR_INITRD_RELOC",
2383 "fdt or initrd relocation disabled at boot time\n" . $herecurr);
2384 }
Alper Nebi Yasak7c1a3022020-10-05 09:57:30 +03002385
Wasim Khan6e5aad82021-02-04 15:44:04 +01002386 # make sure 'skip_board_fixup' is not
2387 if ($rawline =~ /.*skip_board_fixup.*/) {
2388 ERROR("SKIP_BOARD_FIXUP",
2389 "Avoid setting skip_board_fixup env variable\n" . $herecurr);
2390 }
2391
Alper Nebi Yasak7c1a3022020-10-05 09:57:30 +03002392 # Do not use CONFIG_ prefix in CONFIG_IS_ENABLED() calls
2393 if ($line =~ /^\+.*CONFIG_IS_ENABLED\(CONFIG_\w*\).*/) {
2394 ERROR("CONFIG_IS_ENABLED_CONFIG",
2395 "CONFIG_IS_ENABLED() takes values without the CONFIG_ prefix\n" . $herecurr);
2396 }
Simon Glass2d848112020-12-03 16:55:24 -07002397
2398 # Use _priv as a suffix for the device-private data struct
2399 if ($line =~ /^\+\s*\.priv_auto\s*=\s*sizeof\(struct\((\w+)\).*/) {
2400 my $struct_name = $1;
2401 if ($struct_name !~ /^\w+_priv/) {
2402 WARN("PRIV_AUTO", "struct \'$struct_name\' should have a _priv suffix");
2403 }
2404 }
2405
2406 # Check struct names for the 'auto' members of struct driver
2407 u_boot_struct_name($line, "priv_auto", "_priv", "PRIV_AUTO");
2408 u_boot_struct_name($line, "plat_auto", "_plat", "PLAT_AUTO");
2409 u_boot_struct_name($line, "per_child_auto", "_priv", "CHILD_PRIV_AUTO");
2410 u_boot_struct_name($line, "per_child_plat_auto", "_plat",
2411 "CHILD_PLAT_AUTO");
2412
2413 # Now the ones for struct uclass, skipping those in common with above
2414 u_boot_struct_name($line, "per_device_auto", "_priv",
2415 "DEVICE_PRIV_AUTO");
2416 u_boot_struct_name($line, "per_device_plat_auto", "_plat",
2417 "DEVICE_PLAT_AUTO");
Simon Glassc8f4d092020-05-22 16:32:36 -06002418}
2419
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002420sub process {
2421 my $filename = shift;
2422
2423 my $linenr=0;
2424 my $prevline="";
2425 my $prevrawline="";
2426 my $stashline="";
2427 my $stashrawline="";
2428
2429 my $length;
2430 my $indent;
2431 my $previndent=0;
2432 my $stashindent=0;
2433
2434 our $clean = 1;
2435 my $signoff = 0;
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02002436 my $author = '';
2437 my $authorsignoff = 0;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002438 my $is_patch = 0;
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02002439 my $is_binding_patch = -1;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002440 my $in_header_lines = $file ? 0 : 1;
Kim Phillips9b7b8372013-02-28 12:53:52 +00002441 my $in_commit_log = 0; #Scanning lines before patch
Tom Rinid2e30332020-06-16 10:29:46 -04002442 my $has_patch_separator = 0; #Found a --- line
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002443 my $has_commit_log = 0; #Encountered lines before patch
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02002444 my $commit_log_lines = 0; #Number of commit log lines
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002445 my $commit_log_possible_stack_dump = 0;
2446 my $commit_log_long_line = 0;
2447 my $commit_log_has_diff = 0;
2448 my $reported_maintainer_file = 0;
Kim Phillips9b7b8372013-02-28 12:53:52 +00002449 my $non_utf8_charset = 0;
2450
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002451 my $last_blank_line = 0;
2452 my $last_coalesced_string_linenr = -1;
2453
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002454 our @report = ();
2455 our $cnt_lines = 0;
2456 our $cnt_error = 0;
2457 our $cnt_warn = 0;
2458 our $cnt_chk = 0;
2459
2460 # Trace the real file/line as we go.
2461 my $realfile = '';
2462 my $realline = 0;
2463 my $realcnt = 0;
2464 my $here = '';
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002465 my $context_function; #undef'd unless there's a known function
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002466 my $in_comment = 0;
2467 my $comment_edge = 0;
2468 my $first_line = 0;
2469 my $p1_prefix = '';
2470
2471 my $prev_values = 'E';
2472
2473 # suppression flags
2474 my %suppress_ifbraces;
2475 my %suppress_whiletrailers;
2476 my %suppress_export;
Kim Phillips9b7b8372013-02-28 12:53:52 +00002477 my $suppress_statement = 0;
2478
Tom Rinia50f8de2014-02-27 08:27:28 -05002479 my %signatures = ();
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002480
2481 # Pre-scan the patch sanitizing the lines.
2482 # Pre-scan the patch looking for any __setup documentation.
2483 #
2484 my @setup_docs = ();
2485 my $setup_docs = 0;
2486
Tom Rinia50f8de2014-02-27 08:27:28 -05002487 my $camelcase_file_seeded = 0;
2488
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02002489 my $checklicenseline = 1;
2490
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002491 sanitise_line_reset();
2492 my $line;
2493 foreach my $rawline (@rawlines) {
2494 $linenr++;
2495 $line = $rawline;
2496
Tom Rinia50f8de2014-02-27 08:27:28 -05002497 push(@fixed, $rawline) if ($fix);
2498
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002499 if ($rawline=~/^\+\+\+\s+(\S+)/) {
2500 $setup_docs = 0;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002501 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002502 $setup_docs = 1;
2503 }
2504 #next;
2505 }
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002506 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002507 $realline=$1-1;
2508 if (defined $2) {
2509 $realcnt=$3+1;
2510 } else {
2511 $realcnt=1+1;
2512 }
2513 $in_comment = 0;
2514
2515 # Guestimate if this is a continuing comment. Run
2516 # the context looking for a comment "edge". If this
2517 # edge is a close comment then we must be in a comment
2518 # at context start.
2519 my $edge;
2520 my $cnt = $realcnt;
2521 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2522 next if (defined $rawlines[$ln - 1] &&
2523 $rawlines[$ln - 1] =~ /^-/);
2524 $cnt--;
2525 #print "RAW<$rawlines[$ln - 1]>\n";
2526 last if (!defined $rawlines[$ln - 1]);
2527 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2528 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2529 ($edge) = $1;
2530 last;
2531 }
2532 }
2533 if (defined $edge && $edge eq '*/') {
2534 $in_comment = 1;
2535 }
2536
2537 # Guestimate if this is a continuing comment. If this
2538 # is the start of a diff block and this line starts
2539 # ' *' then it is very likely a comment.
2540 if (!defined $edge &&
2541 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2542 {
2543 $in_comment = 1;
2544 }
2545
2546 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2547 sanitise_line_reset($in_comment);
2548
2549 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2550 # Standardise the strings and chars within the input to
2551 # simplify matching -- only bother with positive lines.
2552 $line = sanitise_line($rawline);
2553 }
2554 push(@lines, $line);
2555
2556 if ($realcnt > 1) {
2557 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2558 } else {
2559 $realcnt = 0;
2560 }
2561
2562 #print "==>$rawline\n";
2563 #print "-->$line\n";
2564
2565 if ($setup_docs && $line =~ /^\+/) {
2566 push(@setup_docs, $line);
2567 }
2568 }
2569
2570 $prefix = '';
2571
2572 $realcnt = 0;
2573 $linenr = 0;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002574 $fixlinenr = -1;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002575 foreach my $line (@lines) {
2576 $linenr++;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002577 $fixlinenr++;
Tom Rinia50f8de2014-02-27 08:27:28 -05002578 my $sline = $line; #copy of $line
2579 $sline =~ s/$;/ /g; #with comments as spaces
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002580
2581 my $rawline = $rawlines[$linenr - 1];
Tom Rinid2e30332020-06-16 10:29:46 -04002582 my $raw_comment = get_raw_comment($line, $rawline);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002583
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02002584# check if it's a mode change, rename or start of a patch
2585 if (!$in_commit_log &&
2586 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2587 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2588 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2589 $is_patch = 1;
2590 }
2591
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002592#extract the line range in the file after the patch is applied
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002593 if (!$in_commit_log &&
2594 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2595 my $context = $4;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002596 $is_patch = 1;
2597 $first_line = $linenr + 1;
2598 $realline=$1-1;
2599 if (defined $2) {
2600 $realcnt=$3+1;
2601 } else {
2602 $realcnt=1+1;
2603 }
2604 annotate_reset();
2605 $prev_values = 'E';
2606
2607 %suppress_ifbraces = ();
2608 %suppress_whiletrailers = ();
2609 %suppress_export = ();
Kim Phillips9b7b8372013-02-28 12:53:52 +00002610 $suppress_statement = 0;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002611 if ($context =~ /\b(\w+)\s*\(/) {
2612 $context_function = $1;
2613 } else {
2614 undef $context_function;
2615 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002616 next;
2617
2618# track the line number as we move through the hunk, note that
2619# new versions of GNU diff omit the leading space on completely
2620# blank context lines so we need to count that too.
2621 } elsif ($line =~ /^( |\+|$)/) {
2622 $realline++;
2623 $realcnt-- if ($realcnt != 0);
2624
2625 # Measure the line length and indent.
2626 ($length, $indent) = line_stats($rawline);
2627
2628 # Track the previous line.
2629 ($prevline, $stashline) = ($stashline, $line);
2630 ($previndent, $stashindent) = ($stashindent, $indent);
2631 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2632
2633 #warn "line<$line>\n";
2634
2635 } elsif ($realcnt == 1) {
2636 $realcnt--;
2637 }
2638
2639 my $hunk_line = ($realcnt != 0);
2640
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002641 $here = "#$linenr: " if (!$file);
2642 $here = "#$realline: " if ($file);
2643
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002644 my $found_file = 0;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002645 # extract the filename as it passes
2646 if ($line =~ /^diff --git.*?(\S+)$/) {
2647 $realfile = $1;
Tom Rinia50f8de2014-02-27 08:27:28 -05002648 $realfile =~ s@^([^/]*)/@@ if (!$file);
Kim Phillips9b7b8372013-02-28 12:53:52 +00002649 $in_commit_log = 0;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002650 $found_file = 1;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002651 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2652 $realfile = $1;
Tom Rinia50f8de2014-02-27 08:27:28 -05002653 $realfile =~ s@^([^/]*)/@@ if (!$file);
Kim Phillips9b7b8372013-02-28 12:53:52 +00002654 $in_commit_log = 0;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002655
2656 $p1_prefix = $1;
2657 if (!$file && $tree && $p1_prefix ne '' &&
2658 -e "$root/$p1_prefix") {
2659 WARN("PATCH_PREFIX",
2660 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2661 }
2662
2663 if ($realfile =~ m@^include/asm/@) {
2664 ERROR("MODIFIED_INCLUDE_ASM",
2665 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2666 }
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002667 $found_file = 1;
2668 }
2669
2670#make up the handle for any error we report on this line
2671 if ($showfile) {
2672 $prefix = "$realfile:$realline: "
2673 } elsif ($emacs) {
2674 if ($file) {
2675 $prefix = "$filename:$realline: ";
2676 } else {
2677 $prefix = "$filename:$linenr: ";
2678 }
2679 }
2680
2681 if ($found_file) {
2682 if (is_maintained_obsolete($realfile)) {
2683 WARN("OBSOLETE",
2684 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2685 }
2686 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2687 $check = 1;
2688 } else {
2689 $check = $check_orig;
2690 }
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02002691 $checklicenseline = 1;
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02002692
2693 if ($realfile !~ /^MAINTAINERS/) {
2694 my $last_binding_patch = $is_binding_patch;
2695
2696 $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2697
2698 if (($last_binding_patch != -1) &&
2699 ($last_binding_patch ^ $is_binding_patch)) {
2700 WARN("DT_SPLIT_BINDING_PATCH",
2701 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n");
2702 }
2703 }
2704
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002705 next;
2706 }
2707
2708 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2709
2710 my $hereline = "$here\n$rawline\n";
2711 my $herecurr = "$here\n$rawline\n";
2712 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2713
2714 $cnt_lines++ if ($realcnt != 0);
2715
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02002716# Verify the existence of a commit log if appropriate
2717# 2 is used because a $signature is counted in $commit_log_lines
2718 if ($in_commit_log) {
2719 if ($line !~ /^\s*$/) {
2720 $commit_log_lines++; #could be a $signature
2721 }
2722 } elsif ($has_commit_log && $commit_log_lines < 2) {
2723 WARN("COMMIT_MESSAGE",
2724 "Missing commit description - Add an appropriate one\n");
2725 $commit_log_lines = 2; #warn only once
2726 }
2727
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002728# Check if the commit log has what seems like a diff which can confuse patch
2729 if ($in_commit_log && !$commit_log_has_diff &&
2730 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2731 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2732 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2733 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2734 ERROR("DIFF_IN_COMMIT_MSG",
2735 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2736 $commit_log_has_diff = 1;
2737 }
2738
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002739# Check for incorrect file permissions
2740 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2741 my $permhere = $here . "FILE: $realfile\n";
Tom Rinia50f8de2014-02-27 08:27:28 -05002742 if ($realfile !~ m@scripts/@ &&
2743 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002744 ERROR("EXECUTE_PERMISSIONS",
2745 "do not set execute permissions for source files\n" . $permhere);
2746 }
2747 }
2748
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02002749# Check the patch for a From:
2750 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2751 $author = $1;
2752 $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2753 $author =~ s/"//g;
Tom Rinid2e30332020-06-16 10:29:46 -04002754 $author = reformat_email($author);
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02002755 }
2756
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002757# Check the patch for a signoff:
Tom Rinid2e30332020-06-16 10:29:46 -04002758 if ($line =~ /^\s*signed-off-by:\s*(.*)/i) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002759 $signoff++;
Kim Phillips9b7b8372013-02-28 12:53:52 +00002760 $in_commit_log = 0;
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02002761 if ($author ne '') {
Tom Rinid2e30332020-06-16 10:29:46 -04002762 if (same_email_addresses($1, $author)) {
2763 $authorsignoff = 1;
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02002764 }
2765 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002766 }
2767
Tom Rinid2e30332020-06-16 10:29:46 -04002768# Check for patch separator
2769 if ($line =~ /^---$/) {
2770 $has_patch_separator = 1;
2771 $in_commit_log = 0;
2772 }
2773
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002774# Check if MAINTAINERS is being updated. If so, there's probably no need to
2775# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2776 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2777 $reported_maintainer_file = 1;
2778 }
2779
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002780# Check signature styles
Kim Phillips9b7b8372013-02-28 12:53:52 +00002781 if (!$in_header_lines &&
2782 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002783 my $space_before = $1;
2784 my $sign_off = $2;
2785 my $space_after = $3;
2786 my $email = $4;
2787 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2788
Kim Phillips9b7b8372013-02-28 12:53:52 +00002789 if ($sign_off !~ /$signature_tags/) {
2790 WARN("BAD_SIGN_OFF",
2791 "Non-standard signature: $sign_off\n" . $herecurr);
2792 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002793 if (defined $space_before && $space_before ne "") {
Tom Rinia50f8de2014-02-27 08:27:28 -05002794 if (WARN("BAD_SIGN_OFF",
2795 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2796 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002797 $fixed[$fixlinenr] =
Tom Rinia50f8de2014-02-27 08:27:28 -05002798 "$ucfirst_sign_off $email";
2799 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002800 }
2801 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Tom Rinia50f8de2014-02-27 08:27:28 -05002802 if (WARN("BAD_SIGN_OFF",
2803 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2804 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002805 $fixed[$fixlinenr] =
Tom Rinia50f8de2014-02-27 08:27:28 -05002806 "$ucfirst_sign_off $email";
2807 }
2808
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002809 }
2810 if (!defined $space_after || $space_after ne " ") {
Tom Rinia50f8de2014-02-27 08:27:28 -05002811 if (WARN("BAD_SIGN_OFF",
2812 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2813 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002814 $fixed[$fixlinenr] =
Tom Rinia50f8de2014-02-27 08:27:28 -05002815 "$ucfirst_sign_off $email";
2816 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002817 }
2818
Tom Rinid2e30332020-06-16 10:29:46 -04002819 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002820 my $suggested_email = format_email(($email_name, $email_address));
2821 if ($suggested_email eq "") {
2822 ERROR("BAD_SIGN_OFF",
2823 "Unrecognized email address: '$email'\n" . $herecurr);
2824 } else {
2825 my $dequoted = $suggested_email;
2826 $dequoted =~ s/^"//;
2827 $dequoted =~ s/" </ </;
2828 # Don't force email to have quotes
2829 # Allow just an angle bracketed address
Tom Rinid2e30332020-06-16 10:29:46 -04002830 if (!same_email_addresses($email, $suggested_email)) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002831 WARN("BAD_SIGN_OFF",
2832 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2833 }
2834 }
Tom Rinia50f8de2014-02-27 08:27:28 -05002835
2836# Check for duplicate signatures
2837 my $sig_nospace = $line;
2838 $sig_nospace =~ s/\s//g;
2839 $sig_nospace = lc($sig_nospace);
2840 if (defined $signatures{$sig_nospace}) {
2841 WARN("BAD_SIGN_OFF",
2842 "Duplicate signature\n" . $herecurr);
2843 } else {
2844 $signatures{$sig_nospace} = 1;
2845 }
Tom Rinid2e30332020-06-16 10:29:46 -04002846
2847# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2848 if ($sign_off =~ /^co-developed-by:$/i) {
2849 if ($email eq $author) {
2850 WARN("BAD_SIGN_OFF",
2851 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2852 }
2853 if (!defined $lines[$linenr]) {
2854 WARN("BAD_SIGN_OFF",
2855 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
2856 } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
2857 WARN("BAD_SIGN_OFF",
2858 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2859 } elsif ($1 ne $email) {
2860 WARN("BAD_SIGN_OFF",
2861 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2862 }
2863 }
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002864 }
2865
2866# Check email subject for common tools that don't need to be mentioned
2867 if ($in_header_lines &&
2868 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2869 WARN("EMAIL_SUBJECT",
2870 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2871 }
2872
Tom Rinid2e30332020-06-16 10:29:46 -04002873# Check for Gerrit Change-Ids not in any patch context
2874 if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002875 ERROR("GERRIT_CHANGE_ID",
Tom Rinid2e30332020-06-16 10:29:46 -04002876 "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002877 }
2878
2879# Check if the commit log is in a possible stack dump
2880 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2881 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2882 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2883 # timestamp
Tom Rinid2e30332020-06-16 10:29:46 -04002884 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
2885 $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
2886 $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
2887 # stack dump address styles
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002888 $commit_log_possible_stack_dump = 1;
2889 }
2890
2891# Check for line lengths > 75 in commit log, warn once
2892 if ($in_commit_log && !$commit_log_long_line &&
2893 length($line) > 75 &&
2894 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2895 # file delta changes
2896 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2897 # filename then :
2898 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2899 # A Fixes: or Link: line
2900 $commit_log_possible_stack_dump)) {
2901 WARN("COMMIT_LOG_LONG_LINE",
2902 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2903 $commit_log_long_line = 1;
2904 }
2905
2906# Reset possible stack dump if a blank line is found
2907 if ($in_commit_log && $commit_log_possible_stack_dump &&
2908 $line =~ /^\s*$/) {
2909 $commit_log_possible_stack_dump = 0;
2910 }
2911
2912# Check for git id commit length and improperly formed commit descriptions
2913 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Tom Rinid2e30332020-06-16 10:29:46 -04002914 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02002915 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
2916 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2917 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
2918 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2919 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2920 my $init_char = "c";
2921 my $orig_commit = "";
2922 my $short = 1;
2923 my $long = 0;
2924 my $case = 1;
2925 my $space = 1;
2926 my $hasdesc = 0;
2927 my $hasparens = 0;
2928 my $id = '0123456789ab';
2929 my $orig_desc = "commit description";
2930 my $description = "";
2931
2932 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2933 $init_char = $1;
2934 $orig_commit = lc($2);
2935 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2936 $orig_commit = lc($1);
2937 }
2938
2939 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2940 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2941 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2942 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2943 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2944 $orig_desc = $1;
2945 $hasparens = 1;
2946 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2947 defined $rawlines[$linenr] &&
2948 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2949 $orig_desc = $1;
2950 $hasparens = 1;
2951 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2952 defined $rawlines[$linenr] &&
2953 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2954 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2955 $orig_desc = $1;
2956 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2957 $orig_desc .= " " . $1;
2958 $hasparens = 1;
2959 }
2960
2961 ($id, $description) = git_commit_info($orig_commit,
2962 $id, $orig_desc);
2963
2964 if (defined($id) &&
2965 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
2966 ERROR("GIT_COMMIT_ID",
2967 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2968 }
2969 }
2970
2971# Check for added, moved or deleted files
2972 if (!$reported_maintainer_file && !$in_commit_log &&
2973 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2974 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2975 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2976 (defined($1) || defined($2))))) {
2977 $is_patch = 1;
2978 $reported_maintainer_file = 1;
2979 WARN("FILE_PATH_CHANGES",
2980 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002981 }
2982
Tom Rinid2e30332020-06-16 10:29:46 -04002983# Check for adding new DT bindings not in schema format
2984 if (!$in_commit_log &&
2985 ($line =~ /^new file mode\s*\d+\s*$/) &&
2986 ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {
2987 WARN("DT_SCHEMA_BINDING_PATCH",
2988 "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
2989 }
2990
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002991# Check for wrappage within a valid hunk of the file
2992 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2993 ERROR("CORRUPTED_PATCH",
2994 "patch seems to be corrupt (line wrapped?)\n" .
2995 $herecurr) if (!$emitted_corrupt++);
2996 }
2997
Joe Hershbergerba2beb52011-10-18 10:06:59 +00002998# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2999 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
3000 $rawline !~ m/^$UTF8*$/) {
3001 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
3002
3003 my $blank = copy_spacing($rawline);
3004 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
3005 my $hereptr = "$hereline$ptr\n";
3006
3007 CHK("INVALID_UTF8",
3008 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
3009 }
3010
Kim Phillips9b7b8372013-02-28 12:53:52 +00003011# Check if it's the start of a commit log
3012# (not a header line and we haven't seen the patch filename)
3013 if ($in_header_lines && $realfile =~ /^$/ &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003014 !($rawline =~ /^\s+(?:\S|$)/ ||
3015 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Kim Phillips9b7b8372013-02-28 12:53:52 +00003016 $in_header_lines = 0;
3017 $in_commit_log = 1;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003018 $has_commit_log = 1;
Kim Phillips9b7b8372013-02-28 12:53:52 +00003019 }
3020
3021# Check if there is UTF-8 in a commit log when a mail header has explicitly
3022# declined it, i.e defined some charset where it is missing.
3023 if ($in_header_lines &&
3024 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
3025 $1 !~ /utf-8/i) {
3026 $non_utf8_charset = 1;
3027 }
3028
3029 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
3030 $rawline =~ /$NON_ASCII_UTF8/) {
3031 WARN("UTF8_BEFORE_PATCH",
3032 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
3033 }
3034
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003035# Check for absolute kernel paths in commit message
3036 if ($tree && $in_commit_log) {
3037 while ($line =~ m{(?:^|\s)(/\S*)}g) {
3038 my $file = $1;
3039
3040 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
3041 check_absolute_file($1, $herecurr)) {
3042 #
3043 } else {
3044 check_absolute_file($file, $herecurr);
3045 }
3046 }
3047 }
3048
Dan Murphy463f6882017-01-31 14:15:53 -06003049# Check for various typo / spelling mistakes
3050 if (defined($misspellings) &&
3051 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
3052 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
3053 my $typo = $1;
3054 my $typo_fix = $spelling_fix{lc($typo)};
3055 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
3056 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02003057 my $msg_level = \&WARN;
3058 $msg_level = \&CHK if ($file);
3059 if (&{$msg_level}("TYPO_SPELLING",
3060 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Dan Murphy463f6882017-01-31 14:15:53 -06003061 $fix) {
3062 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
3063 }
3064 }
3065 }
3066
Tom Rinid2e30332020-06-16 10:29:46 -04003067# check for invalid commit id
3068 if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
3069 my $id;
3070 my $description;
3071 ($id, $description) = git_commit_info($2, undef, undef);
3072 if (!defined($id)) {
3073 WARN("UNKNOWN_COMMIT_ID",
3074 "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
3075 }
3076 }
3077
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003078# ignore non-hunk lines and lines being removed
3079 next if (!$hunk_line || $line =~ /^-/);
3080
3081#trailing whitespace
3082 if ($line =~ /^\+.*\015/) {
3083 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Tom Rinia50f8de2014-02-27 08:27:28 -05003084 if (ERROR("DOS_LINE_ENDINGS",
3085 "DOS line endings\n" . $herevet) &&
3086 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003087 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Tom Rinia50f8de2014-02-27 08:27:28 -05003088 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003089 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
3090 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Tom Rinia50f8de2014-02-27 08:27:28 -05003091 if (ERROR("TRAILING_WHITESPACE",
3092 "trailing whitespace\n" . $herevet) &&
3093 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003094 $fixed[$fixlinenr] =~ s/\s+$//;
Tom Rinia50f8de2014-02-27 08:27:28 -05003095 }
3096
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003097 $rpt_cleaners = 1;
3098 }
3099
Tom Rinia50f8de2014-02-27 08:27:28 -05003100# Check for FSF mailing addresses.
3101 if ($rawline =~ /\bwrite to the Free/i ||
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003102 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Tom Rinia50f8de2014-02-27 08:27:28 -05003103 $rawline =~ /\b59\s+Temple\s+Pl/i ||
3104 $rawline =~ /\b51\s+Franklin\s+St/i) {
3105 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02003106 my $msg_level = \&ERROR;
3107 $msg_level = \&CHK if ($file);
3108 &{$msg_level}("FSF_MAILING_ADDRESS",
3109 "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)
Tom Rinia50f8de2014-02-27 08:27:28 -05003110 }
3111
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003112# check for Kconfig help text having a real description
3113# Only applies when adding the entry originally, after that we do not have
3114# sufficient context to determine whether it is indeed long enough.
3115 if ($realfile =~ /Kconfig/ &&
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02003116 # 'choice' is usually the last thing on the line (though
3117 # Kconfig supports named choices), so use a word boundary
3118 # (\b) rather than a whitespace character (\s)
3119 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003120 my $length = 0;
3121 my $cnt = $realcnt;
3122 my $ln = $linenr + 1;
3123 my $f;
Kim Phillips9b7b8372013-02-28 12:53:52 +00003124 my $is_start = 0;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003125 my $is_end = 0;
Kim Phillips9b7b8372013-02-28 12:53:52 +00003126 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003127 $f = $lines[$ln - 1];
3128 $cnt-- if ($lines[$ln - 1] !~ /^-/);
3129 $is_end = $lines[$ln - 1] =~ /^\+/;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003130
3131 next if ($f =~ /^-/);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003132 last if (!$file && $f =~ /^\@\@/);
Kim Phillips9b7b8372013-02-28 12:53:52 +00003133
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02003134 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
Kim Phillips9b7b8372013-02-28 12:53:52 +00003135 $is_start = 1;
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02003136 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
3137 if ($lines[$ln - 1] =~ "---help---") {
3138 WARN("CONFIG_DESCRIPTION",
3139 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
3140 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00003141 $length = -1;
3142 }
3143
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003144 $f =~ s/^.//;
3145 $f =~ s/#.*//;
3146 $f =~ s/^\s+//;
3147 next if ($f =~ /^$/);
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02003148
3149 # This only checks context lines in the patch
3150 # and so hopefully shouldn't trigger false
3151 # positives, even though some of these are
3152 # common words in help texts
3153 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
3154 if|endif|menu|endmenu|source)\b/x) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003155 $is_end = 1;
3156 last;
3157 }
3158 $length++;
3159 }
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003160 if ($is_start && $is_end && $length < $min_conf_desc_length) {
3161 WARN("CONFIG_DESCRIPTION",
3162 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
3163 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00003164 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3165 }
3166
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003167# check for MAINTAINERS entries that don't have the right form
3168 if ($realfile =~ /^MAINTAINERS$/ &&
3169 $rawline =~ /^\+[A-Z]:/ &&
3170 $rawline !~ /^\+[A-Z]:\t\S/) {
3171 if (WARN("MAINTAINERS_STYLE",
3172 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3173 $fix) {
3174 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3175 }
3176 }
3177
3178# discourage the use of boolean for type definition attributes of Kconfig options
Kim Phillips9b7b8372013-02-28 12:53:52 +00003179 if ($realfile =~ /Kconfig/ &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003180 $line =~ /^\+\s*\bboolean\b/) {
3181 WARN("CONFIG_TYPE_BOOLEAN",
3182 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003183 }
3184
Kim Phillips9b7b8372013-02-28 12:53:52 +00003185 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3186 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3187 my $flag = $1;
3188 my $replacement = {
3189 'EXTRA_AFLAGS' => 'asflags-y',
3190 'EXTRA_CFLAGS' => 'ccflags-y',
3191 'EXTRA_CPPFLAGS' => 'cppflags-y',
3192 'EXTRA_LDFLAGS' => 'ldflags-y',
3193 };
3194
3195 WARN("DEPRECATED_VARIABLE",
3196 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3197 }
3198
Tom Rinia50f8de2014-02-27 08:27:28 -05003199# check for DT compatible documentation
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003200 if (defined $root &&
3201 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3202 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3203
Tom Rinia50f8de2014-02-27 08:27:28 -05003204 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3205
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003206 my $dt_path = $root . "/Documentation/devicetree/bindings/";
Tom Rinid2e30332020-06-16 10:29:46 -04003207 my $vp_file = $dt_path . "vendor-prefixes.yaml";
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003208
Tom Rinia50f8de2014-02-27 08:27:28 -05003209 foreach my $compat (@compats) {
3210 my $compat2 = $compat;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003211 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3212 my $compat3 = $compat;
3213 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3214 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Tom Rinia50f8de2014-02-27 08:27:28 -05003215 if ( $? >> 8 ) {
3216 WARN("UNDOCUMENTED_DT_STRING",
3217 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3218 }
3219
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003220 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3221 my $vendor = $1;
Tom Rinid2e30332020-06-16 10:29:46 -04003222 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
Tom Rinia50f8de2014-02-27 08:27:28 -05003223 if ( $? >> 8 ) {
3224 WARN("UNDOCUMENTED_DT_STRING",
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003225 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Tom Rinia50f8de2014-02-27 08:27:28 -05003226 }
3227 }
3228 }
3229
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02003230# check for using SPDX license tag at beginning of files
3231 if ($realline == $checklicenseline) {
3232 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3233 $checklicenseline = 2;
3234 } elsif ($rawline =~ /^\+/) {
3235 my $comment = "";
3236 if ($realfile =~ /\.(h|s|S)$/) {
3237 $comment = '/*';
3238 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
3239 $comment = '//';
Tom Rinid2e30332020-06-16 10:29:46 -04003240 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) {
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02003241 $comment = '#';
3242 } elsif ($realfile =~ /\.rst$/) {
3243 $comment = '..';
3244 }
3245
Tom Rinid2e30332020-06-16 10:29:46 -04003246# check SPDX comment style for .[chsS] files
3247 if ($realfile =~ /\.[chsS]$/ &&
3248 $rawline =~ /SPDX-License-Identifier:/ &&
3249 $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
3250 WARN("SPDX_LICENSE_TAG",
3251 "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3252 }
3253
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02003254 if ($comment !~ /^$/ &&
Tom Rinid2e30332020-06-16 10:29:46 -04003255 $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
3256 WARN("SPDX_LICENSE_TAG",
3257 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02003258 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
Tom Rinid2e30332020-06-16 10:29:46 -04003259 my $spdx_license = $1;
3260 if (!is_SPDX_License_valid($spdx_license)) {
3261 WARN("SPDX_LICENSE_TAG",
3262 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3263 }
3264 if ($realfile =~ m@^Documentation/devicetree/bindings/@ &&
3265 not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) {
3266 my $msg_level = \&WARN;
3267 $msg_level = \&CHK if ($file);
3268 if (&{$msg_level}("SPDX_LICENSE_TAG",
3269
3270 "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) &&
3271 $fix) {
3272 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3273 }
3274 }
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02003275 }
3276 }
3277 }
3278
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003279# check we are in a valid source file if not then ignore this hunk
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003280 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003281
Tom Rinid2e30332020-06-16 10:29:46 -04003282# check for using SPDX-License-Identifier on the wrong line number
3283 if ($realline != $checklicenseline &&
3284 $rawline =~ /\bSPDX-License-Identifier:/ &&
3285 substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3286 WARN("SPDX_LICENSE_TAG",
3287 "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3288 }
3289
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003290# line length limit (with some exclusions)
3291#
3292# There are a few types of lines that may extend beyond $max_line_length:
3293# logging functions like pr_info that end in a string
3294# lines with a single string
3295# #defines that are a single string
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02003296# lines with an RFC3986 like URL
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003297#
3298# There are 3 different line length message types:
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02003299# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003300# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3301# LONG_LINE all other lines longer than $max_line_length
3302#
3303# if LONG_LINE is ignored, the other 2 types are also ignored
3304#
Kim Phillips9b7b8372013-02-28 12:53:52 +00003305
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003306 if ($line =~ /^\+/ && $length > $max_line_length) {
3307 my $msg_type = "LONG_LINE";
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003308
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003309 # Check the allowed long line types first
3310
3311 # logging functions that end in a string that starts
3312 # before $max_line_length
3313 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3314 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3315 $msg_type = "";
3316
3317 # lines with only strings (w/ possible termination)
3318 # #defines with only strings
3319 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3320 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3321 $msg_type = "";
3322
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02003323 # More special cases
3324 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3325 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
3326 $msg_type = "";
3327
3328 # URL ($rawline is used in case the URL is in a comment)
3329 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003330 $msg_type = "";
3331
3332 # Otherwise set the alternate message types
3333
3334 # a comment starts before $max_line_length
3335 } elsif ($line =~ /($;[\s$;]*)$/ &&
3336 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3337 $msg_type = "LONG_LINE_COMMENT"
3338
3339 # a quoted string starts before $max_line_length
3340 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3341 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3342 $msg_type = "LONG_LINE_STRING"
Tom Rinia50f8de2014-02-27 08:27:28 -05003343 }
3344
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003345 if ($msg_type ne "" &&
3346 (show_type("LONG_LINE") || show_type($msg_type))) {
Simon Glassa33d9822020-05-22 16:32:35 -06003347 my $msg_level = \&WARN;
3348 $msg_level = \&CHK if ($file);
3349 &{$msg_level}($msg_type,
3350 "line length of $length exceeds $max_line_length columns\n" . $herecurr);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003351 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003352 }
3353
3354# check for adding lines without a newline.
3355 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3356 WARN("MISSING_EOF_NEWLINE",
3357 "adding a line without newline at end of file\n" . $herecurr);
3358 }
3359
Simon Glassc8f4d092020-05-22 16:32:36 -06003360 if ($u_boot) {
Simon Glassf38051e2020-07-19 10:16:01 -06003361 u_boot_line($realfile, $line, $rawline, $herecurr);
Simon Glassc8f4d092020-05-22 16:32:36 -06003362 }
3363
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003364# check we are in a valid source file C or perl if not then ignore this hunk
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003365 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003366
3367# at the beginning of a line any tabs must come first and anything
Tom Rinid2e30332020-06-16 10:29:46 -04003368# more than $tabsize must use tabs.
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003369 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3370 $rawline =~ /^\+\s* \s*/) {
3371 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003372 $rpt_cleaners = 1;
Tom Rinia50f8de2014-02-27 08:27:28 -05003373 if (ERROR("CODE_INDENT",
3374 "code indent should use tabs where possible\n" . $herevet) &&
3375 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003376 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Tom Rinia50f8de2014-02-27 08:27:28 -05003377 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003378 }
3379
3380# check for space before tabs.
3381 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3382 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Tom Rinia50f8de2014-02-27 08:27:28 -05003383 if (WARN("SPACE_BEFORE_TAB",
3384 "please, no space before tabs\n" . $herevet) &&
3385 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003386 while ($fixed[$fixlinenr] =~
Tom Rinid2e30332020-06-16 10:29:46 -04003387 s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {}
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003388 while ($fixed[$fixlinenr] =~
Tom Rinia50f8de2014-02-27 08:27:28 -05003389 s/(^\+.*) +\t/$1\t/) {}
3390 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003391 }
3392
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02003393# check for assignments on the start of a line
3394 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3395 CHK("ASSIGNMENT_CONTINUATIONS",
3396 "Assignment operator '$1' should be on the previous line\n" . $hereprev);
3397 }
3398
Kim Phillips9b7b8372013-02-28 12:53:52 +00003399# check for && or || at the start of a line
3400 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3401 CHK("LOGICAL_CONTINUATIONS",
3402 "Logical continuations should be on the previous line\n" . $hereprev);
3403 }
3404
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003405# check indentation starts on a tab stop
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02003406 if ($perl_version_ok &&
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02003407 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003408 my $indent = length($1);
Tom Rinid2e30332020-06-16 10:29:46 -04003409 if ($indent % $tabsize) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003410 if (WARN("TABSTOP",
3411 "Statements should start on a tabstop\n" . $herecurr) &&
3412 $fix) {
Tom Rinid2e30332020-06-16 10:29:46 -04003413 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003414 }
3415 }
3416 }
3417
Kim Phillips9b7b8372013-02-28 12:53:52 +00003418# check multi-line statement indentation matches previous line
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02003419 if ($perl_version_ok &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003420 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
Kim Phillips9b7b8372013-02-28 12:53:52 +00003421 $prevline =~ /^\+(\t*)(.*)$/;
3422 my $oldindent = $1;
3423 my $rest = $2;
3424
3425 my $pos = pos_last_openparen($rest);
3426 if ($pos >= 0) {
3427 $line =~ /^(\+| )([ \t]*)/;
3428 my $newindent = $2;
3429
3430 my $goodtabindent = $oldindent .
Tom Rinid2e30332020-06-16 10:29:46 -04003431 "\t" x ($pos / $tabsize) .
3432 " " x ($pos % $tabsize);
Kim Phillips9b7b8372013-02-28 12:53:52 +00003433 my $goodspaceindent = $oldindent . " " x $pos;
3434
3435 if ($newindent ne $goodtabindent &&
3436 $newindent ne $goodspaceindent) {
Tom Rinia50f8de2014-02-27 08:27:28 -05003437
3438 if (CHK("PARENTHESIS_ALIGNMENT",
3439 "Alignment should match open parenthesis\n" . $hereprev) &&
3440 $fix && $line =~ /^\+/) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003441 $fixed[$fixlinenr] =~
Tom Rinia50f8de2014-02-27 08:27:28 -05003442 s/^\+[ \t]*/\+$goodtabindent/;
3443 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00003444 }
3445 }
3446 }
3447
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003448# check for space after cast like "(int) foo" or "(struct foo) bar"
3449# avoid checking a few false positives:
3450# "sizeof(<type>)" or "__alignof__(<type>)"
3451# function pointer declarations like "(*foo)(int) = bar;"
3452# structure definitions like "(struct foo) { 0 };"
3453# multiline macros that define functions
3454# known attributes or the __attribute__ keyword
3455 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3456 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Tom Rinia50f8de2014-02-27 08:27:28 -05003457 if (CHK("SPACING",
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003458 "No space is necessary after a cast\n" . $herecurr) &&
Tom Rinia50f8de2014-02-27 08:27:28 -05003459 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003460 $fixed[$fixlinenr] =~
3461 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Tom Rinia50f8de2014-02-27 08:27:28 -05003462 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00003463 }
3464
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003465# Block comment styles
3466# Networking with an initial /*
Kim Phillips9b7b8372013-02-28 12:53:52 +00003467 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Tom Rinia50f8de2014-02-27 08:27:28 -05003468 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003469 $rawline =~ /^\+[ \t]*\*/ &&
3470 $realline > 2) {
Kim Phillips9b7b8372013-02-28 12:53:52 +00003471 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3472 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3473 }
3474
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003475# Block comments use * on subsequent lines
3476 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3477 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Tom Rinia50f8de2014-02-27 08:27:28 -05003478 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
3479 $rawline =~ /^\+/ && #line is new
3480 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003481 WARN("BLOCK_COMMENT_STYLE",
3482 "Block comments use * on subsequent lines\n" . $hereprev);
Tom Rinia50f8de2014-02-27 08:27:28 -05003483 }
3484
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003485# Block comments use */ on trailing lines
3486 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Kim Phillips9b7b8372013-02-28 12:53:52 +00003487 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3488 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3489 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003490 WARN("BLOCK_COMMENT_STYLE",
3491 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Kim Phillips9b7b8372013-02-28 12:53:52 +00003492 }
3493
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003494# Block comment * alignment
3495 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3496 $line =~ /^\+[ \t]*$;/ && #leading comment
3497 $rawline =~ /^\+[ \t]*\*/ && #leading *
3498 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
3499 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
3500 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3501 my $oldindent;
3502 $prevrawline =~ m@^\+([ \t]*/?)\*@;
3503 if (defined($1)) {
3504 $oldindent = expand_tabs($1);
3505 } else {
3506 $prevrawline =~ m@^\+(.*/?)\*@;
3507 $oldindent = expand_tabs($1);
3508 }
3509 $rawline =~ m@^\+([ \t]*)\*@;
3510 my $newindent = $1;
3511 $newindent = expand_tabs($newindent);
3512 if (length($oldindent) ne length($newindent)) {
3513 WARN("BLOCK_COMMENT_STYLE",
3514 "Block comments should align the * on each line\n" . $hereprev);
3515 }
3516 }
3517
3518# check for missing blank lines after struct/union declarations
3519# with exceptions for various attributes and macros
3520 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3521 $line =~ /^\+/ &&
3522 !($line =~ /^\+\s*$/ ||
3523 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3524 $line =~ /^\+\s*MODULE_/i ||
3525 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3526 $line =~ /^\+[a-z_]*init/ ||
3527 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3528 $line =~ /^\+\s*DECLARE/ ||
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02003529 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003530 $line =~ /^\+\s*__setup/)) {
3531 if (CHK("LINE_SPACING",
3532 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3533 $fix) {
3534 fix_insert_line($fixlinenr, "\+");
3535 }
3536 }
3537
3538# check for multiple consecutive blank lines
3539 if ($prevline =~ /^[\+ ]\s*$/ &&
3540 $line =~ /^\+\s*$/ &&
3541 $last_blank_line != ($linenr - 1)) {
3542 if (CHK("LINE_SPACING",
3543 "Please don't use multiple blank lines\n" . $hereprev) &&
3544 $fix) {
3545 fix_delete_line($fixlinenr, $rawline);
3546 }
3547
3548 $last_blank_line = $linenr;
3549 }
3550
3551# check for missing blank lines after declarations
3552 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3553 # actual declarations
3554 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3555 # function pointer declarations
3556 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3557 # foo bar; where foo is some local typedef or #define
3558 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3559 # known declaration macros
3560 $prevline =~ /^\+\s+$declaration_macros/) &&
3561 # for "else if" which can look like "$Ident $Ident"
3562 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3563 # other possible extensions of declaration lines
3564 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3565 # not starting a section or a macro "\" extended line
3566 $prevline =~ /(?:\{\s*|\\)$/) &&
3567 # looks like a declaration
3568 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3569 # function pointer declarations
3570 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3571 # foo bar; where foo is some local typedef or #define
3572 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3573 # known declaration macros
3574 $sline =~ /^\+\s+$declaration_macros/ ||
3575 # start of struct or union or enum
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02003576 $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003577 # start or end of block or continuation of declaration
3578 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3579 # bitfield continuation
3580 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3581 # other possible extensions of declaration lines
3582 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3583 # indentation of previous and current line are the same
3584 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
3585 if (WARN("LINE_SPACING",
3586 "Missing a blank line after declarations\n" . $hereprev) &&
3587 $fix) {
3588 fix_insert_line($fixlinenr, "\+");
3589 }
3590 }
3591
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003592# check for spaces at the beginning of a line.
3593# Exceptions:
3594# 1) within comments
3595# 2) indented preprocessor commands
3596# 3) hanging labels
Tom Rinia50f8de2014-02-27 08:27:28 -05003597 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003598 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Tom Rinia50f8de2014-02-27 08:27:28 -05003599 if (WARN("LEADING_SPACE",
3600 "please, no spaces at the start of a line\n" . $herevet) &&
3601 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003602 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Tom Rinia50f8de2014-02-27 08:27:28 -05003603 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003604 }
3605
3606# check we are in a valid C source file if not then ignore this hunk
3607 next if ($realfile !~ /\.(h|c)$/);
3608
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02003609# check for unusual line ending [ or (
3610 if ($line =~ /^\+.*([\[\(])\s*$/) {
3611 CHK("OPEN_ENDED_LINE",
3612 "Lines should not end with a '$1'\n" . $herecurr);
3613 }
3614
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003615# check if this appears to be the start function declaration, save the name
3616 if ($sline =~ /^\+\{\s*$/ &&
3617 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3618 $context_function = $1;
3619 }
3620
3621# check if this appears to be the end of function declaration
3622 if ($sline =~ /^\+\}\s*$/) {
3623 undef $context_function;
3624 }
3625
3626# check indentation of any line with a bare else
3627# (but not if it is a multiple line "if (foo) return bar; else return baz;")
3628# if the previous line is a break or return and is indented 1 tab more...
3629 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3630 my $tabs = length($1) + 1;
3631 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3632 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3633 defined $lines[$linenr] &&
3634 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
3635 WARN("UNNECESSARY_ELSE",
3636 "else is not generally useful after a break or return\n" . $hereprev);
3637 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00003638 }
3639
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003640# check indentation of a line with a break;
3641# if the previous line is a goto or return and is indented the same # of tabs
3642 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3643 my $tabs = $1;
3644 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3645 WARN("UNNECESSARY_BREAK",
3646 "break is not useful after a goto or return\n" . $hereprev);
3647 }
3648 }
3649
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003650# check for RCS/CVS revision markers
3651 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3652 WARN("CVS_KEYWORD",
3653 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3654 }
3655
Kim Phillips9b7b8372013-02-28 12:53:52 +00003656# check for old HOTPLUG __dev<foo> section markings
3657 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3658 WARN("HOTPLUG_SECTION",
3659 "Using $1 is unnecessary\n" . $herecurr);
3660 }
3661
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003662# Check for potential 'bare' types
3663 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3664 $realline_next);
Kim Phillips9b7b8372013-02-28 12:53:52 +00003665#print "LINE<$line>\n";
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003666 if ($linenr > $suppress_statement &&
Tom Rinia50f8de2014-02-27 08:27:28 -05003667 $realcnt && $sline =~ /.\s*\S/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003668 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3669 ctx_statement_block($linenr, $realcnt, 0);
3670 $stat =~ s/\n./\n /g;
3671 $cond =~ s/\n./\n /g;
3672
Kim Phillips9b7b8372013-02-28 12:53:52 +00003673#print "linenr<$linenr> <$stat>\n";
3674 # If this statement has no statement boundaries within
3675 # it there is no point in retrying a statement scan
3676 # until we hit end of it.
3677 my $frag = $stat; $frag =~ s/;+\s*$//;
3678 if ($frag !~ /(?:{|;)/) {
3679#print "skip<$line_nr_next>\n";
3680 $suppress_statement = $line_nr_next;
3681 }
3682
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003683 # Find the real next line.
3684 $realline_next = $line_nr_next;
3685 if (defined $realline_next &&
3686 (!defined $lines[$realline_next - 1] ||
3687 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3688 $realline_next++;
3689 }
3690
3691 my $s = $stat;
3692 $s =~ s/{.*$//s;
3693
3694 # Ignore goto labels.
3695 if ($s =~ /$Ident:\*$/s) {
3696
3697 # Ignore functions being called
3698 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
3699
3700 } elsif ($s =~ /^.\s*else\b/s) {
3701
3702 # declarations always start with types
3703 } 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) {
3704 my $type = $1;
3705 $type =~ s/\s+/ /g;
3706 possible($type, "A:" . $s);
3707
3708 # definitions in global scope can only start with types
3709 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3710 possible($1, "B:" . $s);
3711 }
3712
3713 # any (foo ... *) is a pointer cast, and foo is a type
3714 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3715 possible($1, "C:" . $s);
3716 }
3717
3718 # Check for any sort of function declaration.
3719 # int foo(something bar, other baz);
3720 # void (*store_gdt)(x86_descr_ptr *);
3721 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3722 my ($name_len) = length($1);
3723
3724 my $ctx = $s;
3725 substr($ctx, 0, $name_len + 1, '');
3726 $ctx =~ s/\)[^\)]*$//;
3727
3728 for my $arg (split(/\s*,\s*/, $ctx)) {
3729 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3730
3731 possible($1, "D:" . $s);
3732 }
3733 }
3734 }
3735
3736 }
3737
3738#
3739# Checks which may be anchored in the context.
3740#
3741
3742# Check for switch () and associated case and default
3743# statements should be at the same indent.
3744 if ($line=~/\bswitch\s*\(.*\)/) {
3745 my $err = '';
3746 my $sep = '';
3747 my @ctx = ctx_block_outer($linenr, $realcnt);
3748 shift(@ctx);
3749 for my $ctx (@ctx) {
3750 my ($clen, $cindent) = line_stats($ctx);
3751 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3752 $indent != $cindent) {
3753 $err .= "$sep$ctx\n";
3754 $sep = '';
3755 } else {
3756 $sep = "[...]\n";
3757 }
3758 }
3759 if ($err ne '') {
3760 ERROR("SWITCH_CASE_INDENT_LEVEL",
3761 "switch and case should be at the same indent\n$hereline$err");
3762 }
3763 }
3764
3765# if/while/etc brace do not go on next line, unless defining a do while loop,
3766# or if that brace on the next line is for something else
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003767 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003768 my $pre_ctx = "$1$2";
3769
3770 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Kim Phillips9b7b8372013-02-28 12:53:52 +00003771
3772 if ($line =~ /^\+\t{6,}/) {
3773 WARN("DEEP_INDENTATION",
3774 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3775 }
3776
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003777 my $ctx_cnt = $realcnt - $#ctx - 1;
3778 my $ctx = join("\n", @ctx);
3779
3780 my $ctx_ln = $linenr;
3781 my $ctx_skip = $realcnt;
3782
3783 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3784 defined $lines[$ctx_ln - 1] &&
3785 $lines[$ctx_ln - 1] =~ /^-/)) {
3786 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3787 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3788 $ctx_ln++;
3789 }
3790
3791 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3792 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3793
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003794 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003795 ERROR("OPEN_BRACE",
3796 "that open brace { should be on the previous line\n" .
3797 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3798 }
3799 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3800 $ctx =~ /\)\s*\;\s*$/ &&
3801 defined $lines[$ctx_ln - 1])
3802 {
3803 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3804 if ($nindent > $indent) {
3805 WARN("TRAILING_SEMICOLON",
3806 "trailing semicolon indicates no statements, indent implies otherwise\n" .
3807 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3808 }
3809 }
3810 }
3811
3812# Check relative indent for conditionals and blocks.
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003813 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Kim Phillips9b7b8372013-02-28 12:53:52 +00003814 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3815 ctx_statement_block($linenr, $realcnt, 0)
3816 if (!defined $stat);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003817 my ($s, $c) = ($stat, $cond);
3818
3819 substr($s, 0, length($c), '');
3820
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003821 # remove inline comments
3822 $s =~ s/$;/ /g;
3823 $c =~ s/$;/ /g;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003824
3825 # Find out how long the conditional actually is.
3826 my @newlines = ($c =~ /\n/gs);
3827 my $cond_lines = 1 + $#newlines;
3828
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003829 # Make sure we remove the line prefixes as we have
3830 # none on the first line, and are going to readd them
3831 # where necessary.
3832 $s =~ s/\n./\n/gs;
3833 while ($s =~ /\n\s+\\\n/) {
3834 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3835 }
3836
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003837 # We want to check the first line inside the block
3838 # starting at the end of the conditional, so remove:
3839 # 1) any blank line termination
3840 # 2) any opening brace { on end of the line
3841 # 3) any do (...) {
3842 my $continuation = 0;
3843 my $check = 0;
3844 $s =~ s/^.*\bdo\b//;
3845 $s =~ s/^\s*{//;
3846 if ($s =~ s/^\s*\\//) {
3847 $continuation = 1;
3848 }
3849 if ($s =~ s/^\s*?\n//) {
3850 $check = 1;
3851 $cond_lines++;
3852 }
3853
3854 # Also ignore a loop construct at the end of a
3855 # preprocessor statement.
3856 if (($prevline =~ /^.\s*#\s*define\s/ ||
3857 $prevline =~ /\\\s*$/) && $continuation == 0) {
3858 $check = 0;
3859 }
3860
3861 my $cond_ptr = -1;
3862 $continuation = 0;
3863 while ($cond_ptr != $cond_lines) {
3864 $cond_ptr = $cond_lines;
3865
3866 # If we see an #else/#elif then the code
3867 # is not linear.
3868 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3869 $check = 0;
3870 }
3871
3872 # Ignore:
3873 # 1) blank lines, they should be at 0,
3874 # 2) preprocessor lines, and
3875 # 3) labels.
3876 if ($continuation ||
3877 $s =~ /^\s*?\n/ ||
3878 $s =~ /^\s*#\s*?/ ||
3879 $s =~ /^\s*$Ident\s*:/) {
3880 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3881 if ($s =~ s/^.*?\n//) {
3882 $cond_lines++;
3883 }
3884 }
3885 }
3886
3887 my (undef, $sindent) = line_stats("+" . $s);
3888 my $stat_real = raw_line($linenr, $cond_lines);
3889
3890 # Check if either of these lines are modified, else
3891 # this is not this patch's fault.
3892 if (!defined($stat_real) ||
3893 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3894 $check = 0;
3895 }
3896 if (defined($stat_real) && $cond_lines > 1) {
3897 $stat_real = "[...]\n$stat_real";
3898 }
3899
3900 #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";
3901
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003902 if ($check && $s ne '' &&
Tom Rinid2e30332020-06-16 10:29:46 -04003903 (($sindent % $tabsize) != 0 ||
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003904 ($sindent < $indent) ||
3905 ($sindent == $indent &&
3906 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Tom Rinid2e30332020-06-16 10:29:46 -04003907 ($sindent > $indent + $tabsize))) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003908 WARN("SUSPECT_CODE_INDENT",
3909 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3910 }
3911 }
3912
3913 # Track the 'values' across context and added lines.
3914 my $opline = $line; $opline =~ s/^./ /;
3915 my ($curr_values, $curr_vars) =
3916 annotate_values($opline . "\n", $prev_values);
3917 $curr_values = $prev_values . $curr_values;
3918 if ($dbg_values) {
3919 my $outline = $opline; $outline =~ s/\t/ /g;
3920 print "$linenr > .$outline\n";
3921 print "$linenr > $curr_values\n";
3922 print "$linenr > $curr_vars\n";
3923 }
3924 $prev_values = substr($curr_values, -1);
3925
3926#ignore lines not being added
Tom Rinia50f8de2014-02-27 08:27:28 -05003927 next if ($line =~ /^[^\+]/);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003928
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003929# check for dereferences that span multiple lines
3930 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3931 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3932 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3933 my $ref = $1;
3934 $line =~ /^.\s*($Lval)/;
3935 $ref .= $1;
3936 $ref =~ s/\s//g;
3937 WARN("MULTILINE_DEREFERENCE",
3938 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3939 }
3940
3941# check for declarations of signed or unsigned without int
3942 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3943 my $type = $1;
3944 my $var = $2;
3945 $var = "" if (!defined $var);
3946 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3947 my $sign = $1;
3948 my $pointer = $2;
3949
3950 $pointer = "" if (!defined $pointer);
3951
3952 if (WARN("UNSPECIFIED_INT",
3953 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3954 $fix) {
3955 my $decl = trim($sign) . " int ";
3956 my $comp_pointer = $pointer;
3957 $comp_pointer =~ s/\s//g;
3958 $decl .= $comp_pointer;
3959 $decl = rtrim($decl) if ($var eq "");
3960 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
3961 }
3962 }
3963 }
3964
Joe Hershbergerba2beb52011-10-18 10:06:59 +00003965# TEST: allow direct testing of the type matcher.
3966 if ($dbg_type) {
3967 if ($line =~ /^.\s*$Declare\s*$/) {
3968 ERROR("TEST_TYPE",
3969 "TEST: is type\n" . $herecurr);
3970 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3971 ERROR("TEST_NOT_TYPE",
3972 "TEST: is not type ($1 is)\n". $herecurr);
3973 }
3974 next;
3975 }
3976# TEST: allow direct testing of the attribute matcher.
3977 if ($dbg_attr) {
3978 if ($line =~ /^.\s*$Modifier\s*$/) {
3979 ERROR("TEST_ATTR",
3980 "TEST: is attr\n" . $herecurr);
3981 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3982 ERROR("TEST_NOT_ATTR",
3983 "TEST: is not attr ($1 is)\n". $herecurr);
3984 }
3985 next;
3986 }
3987
3988# check for initialisation to aggregates open brace on the next line
3989 if ($line =~ /^.\s*{/ &&
3990 $prevline =~ /(?:^|[^=])=\s*$/) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02003991 if (ERROR("OPEN_BRACE",
3992 "that open brace { should be on the previous line\n" . $hereprev) &&
3993 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3994 fix_delete_line($fixlinenr - 1, $prevrawline);
3995 fix_delete_line($fixlinenr, $rawline);
3996 my $fixedline = $prevrawline;
3997 $fixedline =~ s/\s*=\s*$/ = {/;
3998 fix_insert_line($fixlinenr, $fixedline);
3999 $fixedline = $line;
4000 $fixedline =~ s/^(.\s*)\{\s*/$1/;
4001 fix_insert_line($fixlinenr, $fixedline);
4002 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004003 }
4004
4005#
4006# Checks which are anchored on the added line.
4007#
4008
4009# check for malformed paths in #include statements (uses RAW line)
4010 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
4011 my $path = $1;
4012 if ($path =~ m{//}) {
4013 ERROR("MALFORMED_INCLUDE",
Kim Phillips9b7b8372013-02-28 12:53:52 +00004014 "malformed #include filename\n" . $herecurr);
4015 }
4016 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
4017 ERROR("UAPI_INCLUDE",
4018 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004019 }
4020 }
4021
4022# no C99 // comments
4023 if ($line =~ m{//}) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004024 if (ERROR("C99_COMMENTS",
4025 "do not use C99 // comments\n" . $herecurr) &&
4026 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004027 my $line = $fixed[$fixlinenr];
Tom Rinia50f8de2014-02-27 08:27:28 -05004028 if ($line =~ /\/\/(.*)$/) {
4029 my $comment = trim($1);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004030 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Tom Rinia50f8de2014-02-27 08:27:28 -05004031 }
4032 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004033 }
4034 # Remove C99 comments.
4035 $line =~ s@//.*@@;
4036 $opline =~ s@//.*@@;
4037
4038# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
4039# the whole statement.
4040#print "APW <$lines[$realline_next - 1]>\n";
4041 if (defined $realline_next &&
4042 exists $lines[$realline_next - 1] &&
4043 !defined $suppress_export{$realline_next} &&
4044 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
4045 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
4046 # Handle definitions which produce identifiers with
4047 # a prefix:
4048 # XXX(foo);
4049 # EXPORT_SYMBOL(something_foo);
4050 my $name = $1;
Kim Phillips9b7b8372013-02-28 12:53:52 +00004051 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004052 $name =~ /^${Ident}_$2/) {
4053#print "FOO C name<$name>\n";
4054 $suppress_export{$realline_next} = 1;
4055
4056 } elsif ($stat !~ /(?:
4057 \n.}\s*$|
4058 ^.DEFINE_$Ident\(\Q$name\E\)|
4059 ^.DECLARE_$Ident\(\Q$name\E\)|
4060 ^.LIST_HEAD\(\Q$name\E\)|
4061 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
4062 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
4063 )/x) {
4064#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
4065 $suppress_export{$realline_next} = 2;
4066 } else {
4067 $suppress_export{$realline_next} = 1;
4068 }
4069 }
4070 if (!defined $suppress_export{$linenr} &&
4071 $prevline =~ /^.\s*$/ &&
4072 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
4073 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
4074#print "FOO B <$lines[$linenr - 1]>\n";
4075 $suppress_export{$linenr} = 2;
4076 }
4077 if (defined $suppress_export{$linenr} &&
4078 $suppress_export{$linenr} == 2) {
4079 WARN("EXPORT_SYMBOL",
4080 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
4081 }
4082
4083# check for global initialisers.
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004084 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004085 if (ERROR("GLOBAL_INITIALISERS",
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004086 "do not initialise globals to $1\n" . $herecurr) &&
Tom Rinia50f8de2014-02-27 08:27:28 -05004087 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004088 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Tom Rinia50f8de2014-02-27 08:27:28 -05004089 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004090 }
4091# check for static initialisers.
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004092 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004093 if (ERROR("INITIALISED_STATIC",
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004094 "do not initialise statics to $1\n" .
Tom Rinia50f8de2014-02-27 08:27:28 -05004095 $herecurr) &&
4096 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004097 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Tom Rinia50f8de2014-02-27 08:27:28 -05004098 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004099 }
4100
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004101# check for misordered declarations of char/short/int/long with signed/unsigned
4102 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
4103 my $tmp = trim($1);
4104 WARN("MISORDERED_TYPE",
4105 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4106 }
4107
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02004108# check for unnecessary <signed> int declarations of short/long/long long
4109 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
4110 my $type = trim($1);
4111 next if ($type !~ /\bint\b/);
4112 next if ($type !~ /\b(?:short|long\s+long|long)\b/);
4113 my $new_type = $type;
4114 $new_type =~ s/\b\s*int\s*\b/ /;
4115 $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
4116 $new_type =~ s/^const\s+//;
4117 $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
4118 $new_type = "const $new_type" if ($type =~ /^const\b/);
4119 $new_type =~ s/\s+/ /g;
4120 $new_type = trim($new_type);
4121 if (WARN("UNNECESSARY_INT",
4122 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
4123 $fix) {
4124 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
4125 }
4126 }
4127
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004128# check for static const char * arrays.
4129 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
4130 WARN("STATIC_CONST_CHAR_ARRAY",
4131 "static const char * array should probably be static const char * const\n" .
4132 $herecurr);
Tom Rinid2e30332020-06-16 10:29:46 -04004133 }
4134
4135# check for initialized const char arrays that should be static const
4136 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4137 if (WARN("STATIC_CONST_CHAR_ARRAY",
4138 "const array should probably be static const\n" . $herecurr) &&
4139 $fix) {
4140 $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
4141 }
4142 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004143
4144# check for static char foo[] = "bar" declarations.
4145 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
4146 WARN("STATIC_CONST_CHAR_ARRAY",
4147 "static char array declaration should probably be static const char\n" .
4148 $herecurr);
Tom Rinid2e30332020-06-16 10:29:46 -04004149 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004150
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004151# check for const <foo> const where <foo> is not a pointer or array type
4152 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
4153 my $found = $1;
4154 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
4155 WARN("CONST_CONST",
4156 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
4157 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
4158 WARN("CONST_CONST",
4159 "'const $found const' should probably be 'const $found'\n" . $herecurr);
4160 }
4161 }
4162
4163# check for non-global char *foo[] = {"bar", ...} declarations.
4164 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
4165 WARN("STATIC_CONST_CHAR_ARRAY",
4166 "char * array declaration might be better as static const\n" .
4167 $herecurr);
4168 }
4169
4170# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4171 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
4172 my $array = $1;
4173 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4174 my $array_div = $1;
4175 if (WARN("ARRAY_SIZE",
4176 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
4177 $fix) {
4178 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4179 }
4180 }
4181 }
4182
Tom Rinia50f8de2014-02-27 08:27:28 -05004183# check for function declarations without arguments like "int foo()"
Tom Rinid2e30332020-06-16 10:29:46 -04004184 if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004185 if (ERROR("FUNCTION_WITHOUT_ARGS",
4186 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4187 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004188 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Tom Rinia50f8de2014-02-27 08:27:28 -05004189 }
4190 }
4191
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004192# check for new typedefs, only function parameters and sparse annotations
4193# make sense.
4194 if ($line =~ /\btypedef\s/ &&
4195 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
4196 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
4197 $line !~ /\b$typeTypedefs\b/ &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004198 $line !~ /\b__bitwise\b/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004199 WARN("NEW_TYPEDEFS",
4200 "do not add new typedefs\n" . $herecurr);
4201 }
4202
4203# * goes on variable not on type
4204 # (char*[ const])
Kim Phillips9b7b8372013-02-28 12:53:52 +00004205 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4206 #print "AA<$1>\n";
Tom Rinia50f8de2014-02-27 08:27:28 -05004207 my ($ident, $from, $to) = ($1, $2, $2);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004208
4209 # Should start with a space.
4210 $to =~ s/^(\S)/ $1/;
4211 # Should not end with a space.
4212 $to =~ s/\s+$//;
4213 # '*'s should not have spaces between.
4214 while ($to =~ s/\*\s+\*/\*\*/) {
4215 }
4216
Tom Rinia50f8de2014-02-27 08:27:28 -05004217## print "1: from<$from> to<$to> ident<$ident>\n";
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004218 if ($from ne $to) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004219 if (ERROR("POINTER_LOCATION",
4220 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
4221 $fix) {
4222 my $sub_from = $ident;
4223 my $sub_to = $ident;
4224 $sub_to =~ s/\Q$from\E/$to/;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004225 $fixed[$fixlinenr] =~
Tom Rinia50f8de2014-02-27 08:27:28 -05004226 s@\Q$sub_from\E@$sub_to@;
4227 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004228 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00004229 }
4230 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4231 #print "BB<$1>\n";
Tom Rinia50f8de2014-02-27 08:27:28 -05004232 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004233
4234 # Should start with a space.
4235 $to =~ s/^(\S)/ $1/;
4236 # Should not end with a space.
4237 $to =~ s/\s+$//;
4238 # '*'s should not have spaces between.
4239 while ($to =~ s/\*\s+\*/\*\*/) {
4240 }
4241 # Modifiers should have spaces.
4242 $to =~ s/(\b$Modifier$)/$1 /;
4243
Tom Rinia50f8de2014-02-27 08:27:28 -05004244## print "2: from<$from> to<$to> ident<$ident>\n";
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004245 if ($from ne $to && $ident !~ /^$Modifier$/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004246 if (ERROR("POINTER_LOCATION",
4247 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
4248 $fix) {
4249
4250 my $sub_from = $match;
4251 my $sub_to = $match;
4252 $sub_to =~ s/\Q$from\E/$to/;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004253 $fixed[$fixlinenr] =~
Tom Rinia50f8de2014-02-27 08:27:28 -05004254 s@\Q$sub_from\E@$sub_to@;
4255 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004256 }
4257 }
4258
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004259# avoid BUG() or BUG_ON()
4260 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02004261 my $msg_level = \&WARN;
4262 $msg_level = \&CHK if ($file);
4263 &{$msg_level}("AVOID_BUG",
4264 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004265 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004266
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004267# avoid LINUX_VERSION_CODE
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004268 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
4269 WARN("LINUX_VERSION_CODE",
4270 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4271 }
4272
4273# check for uses of printk_ratelimit
4274 if ($line =~ /\bprintk_ratelimit\s*\(/) {
4275 WARN("PRINTK_RATELIMITED",
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004276 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004277 }
4278
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02004279# printk should use KERN_* levels
4280 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4281 WARN("PRINTK_WITHOUT_KERN_LEVEL",
4282 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004283 }
4284
Kim Phillips9b7b8372013-02-28 12:53:52 +00004285 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
4286 my $orig = $1;
4287 my $level = lc($orig);
4288 $level = "warn" if ($level eq "warning");
4289 my $level2 = $level;
4290 $level2 = "dbg" if ($level eq "debug");
4291 WARN("PREFER_PR_LEVEL",
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004292 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
Kim Phillips9b7b8372013-02-28 12:53:52 +00004293 }
4294
Kim Phillips9b7b8372013-02-28 12:53:52 +00004295 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4296 my $orig = $1;
4297 my $level = lc($orig);
4298 $level = "warn" if ($level eq "warning");
4299 $level = "dbg" if ($level eq "debug");
4300 WARN("PREFER_DEV_LEVEL",
4301 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4302 }
4303
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004304# ENOSYS means "bad syscall nr" and nothing else. This will have a small
4305# number of false positives, but assembly files are not checked, so at
4306# least the arch entry code will not trigger this warning.
4307 if ($line =~ /\bENOSYS\b/) {
4308 WARN("ENOSYS",
4309 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4310 }
4311
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004312# function brace can't be on same line, except for #defines of do while,
4313# or if closed on same line
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02004314 if ($perl_version_ok &&
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02004315 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4316 $sline !~ /\#\s*define\b.*do\s*\{/ &&
4317 $sline !~ /}/) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004318 if (ERROR("OPEN_BRACE",
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02004319 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004320 $fix) {
4321 fix_delete_line($fixlinenr, $rawline);
4322 my $fixed_line = $rawline;
4323 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
4324 my $line1 = $1;
4325 my $line2 = $2;
4326 fix_insert_line($fixlinenr, ltrim($line1));
4327 fix_insert_line($fixlinenr, "\+{");
4328 if ($line2 !~ /^\s*$/) {
4329 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4330 }
4331 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004332 }
4333
4334# open braces for enum, union and struct go on the same line.
4335 if ($line =~ /^.\s*{/ &&
4336 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004337 if (ERROR("OPEN_BRACE",
4338 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4339 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4340 fix_delete_line($fixlinenr - 1, $prevrawline);
4341 fix_delete_line($fixlinenr, $rawline);
4342 my $fixedline = rtrim($prevrawline) . " {";
4343 fix_insert_line($fixlinenr, $fixedline);
4344 $fixedline = $rawline;
4345 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
4346 if ($fixedline !~ /^\+\s*$/) {
4347 fix_insert_line($fixlinenr, $fixedline);
4348 }
4349 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004350 }
4351
4352# missing space after union, struct or enum definition
Tom Rinia50f8de2014-02-27 08:27:28 -05004353 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4354 if (WARN("SPACING",
4355 "missing space after $1 definition\n" . $herecurr) &&
4356 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004357 $fixed[$fixlinenr] =~
Tom Rinia50f8de2014-02-27 08:27:28 -05004358 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4359 }
4360 }
4361
4362# Function pointer declarations
4363# check spacing between type, funcptr, and args
4364# canonical declaration is "type (*funcptr)(args...)"
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004365 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004366 my $declare = $1;
4367 my $pre_pointer_space = $2;
4368 my $post_pointer_space = $3;
4369 my $funcname = $4;
4370 my $post_funcname_space = $5;
4371 my $pre_args_space = $6;
4372
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004373# the $Declare variable will capture all spaces after the type
4374# so check it for a missing trailing missing space but pointer return types
4375# don't need a space so don't warn for those.
4376 my $post_declare_space = "";
4377 if ($declare =~ /(\s+)$/) {
4378 $post_declare_space = $1;
4379 $declare = rtrim($declare);
4380 }
4381 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004382 WARN("SPACING",
4383 "missing space after return type\n" . $herecurr);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004384 $post_declare_space = " ";
Tom Rinia50f8de2014-02-27 08:27:28 -05004385 }
4386
4387# unnecessary space "type (*funcptr)(args...)"
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004388# This test is not currently implemented because these declarations are
4389# equivalent to
4390# int foo(int bar, ...)
4391# and this is form shouldn't/doesn't generate a checkpatch warning.
4392#
4393# elsif ($declare =~ /\s{2,}$/) {
4394# WARN("SPACING",
4395# "Multiple spaces after return type\n" . $herecurr);
4396# }
Tom Rinia50f8de2014-02-27 08:27:28 -05004397
4398# unnecessary space "type ( *funcptr)(args...)"
4399 if (defined $pre_pointer_space &&
4400 $pre_pointer_space =~ /^\s/) {
4401 WARN("SPACING",
4402 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4403 }
4404
4405# unnecessary space "type (* funcptr)(args...)"
4406 if (defined $post_pointer_space &&
4407 $post_pointer_space =~ /^\s/) {
4408 WARN("SPACING",
4409 "Unnecessary space before function pointer name\n" . $herecurr);
4410 }
4411
4412# unnecessary space "type (*funcptr )(args...)"
4413 if (defined $post_funcname_space &&
4414 $post_funcname_space =~ /^\s/) {
4415 WARN("SPACING",
4416 "Unnecessary space after function pointer name\n" . $herecurr);
4417 }
4418
4419# unnecessary space "type (*funcptr) (args...)"
4420 if (defined $pre_args_space &&
4421 $pre_args_space =~ /^\s/) {
4422 WARN("SPACING",
4423 "Unnecessary space before function pointer arguments\n" . $herecurr);
4424 }
4425
4426 if (show_type("SPACING") && $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004427 $fixed[$fixlinenr] =~
4428 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Tom Rinia50f8de2014-02-27 08:27:28 -05004429 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004430 }
4431
4432# check for spacing round square brackets; allowed:
4433# 1. with a type on the left -- int [] a;
4434# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4435# 3. inside a curly brace -- = { [0...10] = 5 }
4436 while ($line =~ /(.*?\s)\[/g) {
4437 my ($where, $prefix) = ($-[1], $1);
4438 if ($prefix !~ /$Type\s+$/ &&
4439 ($where != 0 || $prefix !~ /^.\s+$/) &&
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02004440 $prefix !~ /[{,:]\s+$/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004441 if (ERROR("BRACKET_SPACE",
4442 "space prohibited before open square bracket '['\n" . $herecurr) &&
4443 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004444 $fixed[$fixlinenr] =~
Tom Rinia50f8de2014-02-27 08:27:28 -05004445 s/^(\+.*?)\s+\[/$1\[/;
4446 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004447 }
4448 }
4449
4450# check for spaces between functions and their parentheses.
4451 while ($line =~ /($Ident)\s+\(/g) {
4452 my $name = $1;
4453 my $ctx_before = substr($line, 0, $-[1]);
4454 my $ctx = "$ctx_before$name";
4455
4456 # Ignore those directives where spaces _are_ permitted.
4457 if ($name =~ /^(?:
4458 if|for|while|switch|return|case|
4459 volatile|__volatile__|
4460 __attribute__|format|__extension__|
4461 asm|__asm__)$/x)
4462 {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004463 # cpp #define statements have non-optional spaces, ie
4464 # if there is a space between the name and the open
4465 # parenthesis it is simply not a parameter group.
4466 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
4467
4468 # cpp #elif statement condition may start with a (
4469 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
4470
4471 # If this whole things ends with a type its most
4472 # likely a typedef for a function.
4473 } elsif ($ctx =~ /$Type$/) {
4474
4475 } else {
Tom Rinia50f8de2014-02-27 08:27:28 -05004476 if (WARN("SPACING",
4477 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4478 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004479 $fixed[$fixlinenr] =~
Tom Rinia50f8de2014-02-27 08:27:28 -05004480 s/\b$name\s+\(/$name\(/;
4481 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004482 }
4483 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00004484
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004485# Check operator spacing.
4486 if (!($line=~/\#\s*include/)) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004487 my $fixed_line = "";
4488 my $line_fixed = 0;
4489
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004490 my $ops = qr{
4491 <<=|>>=|<=|>=|==|!=|
4492 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4493 =>|->|<<|>>|<|>|=|!|~|
4494 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Tom Rinia50f8de2014-02-27 08:27:28 -05004495 \?:|\?|:
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004496 }x;
4497 my @elements = split(/($ops|;)/, $opline);
Tom Rinia50f8de2014-02-27 08:27:28 -05004498
4499## print("element count: <" . $#elements . ">\n");
4500## foreach my $el (@elements) {
4501## print("el: <$el>\n");
4502## }
4503
4504 my @fix_elements = ();
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004505 my $off = 0;
4506
Tom Rinia50f8de2014-02-27 08:27:28 -05004507 foreach my $el (@elements) {
4508 push(@fix_elements, substr($rawline, $off, length($el)));
4509 $off += length($el);
4510 }
4511
4512 $off = 0;
4513
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004514 my $blank = copy_spacing($opline);
Tom Rinia50f8de2014-02-27 08:27:28 -05004515 my $last_after = -1;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004516
4517 for (my $n = 0; $n < $#elements; $n += 2) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004518
4519 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4520
4521## print("n: <$n> good: <$good>\n");
4522
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004523 $off += length($elements[$n]);
4524
4525 # Pick up the preceding and succeeding characters.
4526 my $ca = substr($opline, 0, $off);
4527 my $cc = '';
4528 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4529 $cc = substr($opline, $off + length($elements[$n + 1]));
4530 }
4531 my $cb = "$ca$;$cc";
4532
4533 my $a = '';
4534 $a = 'V' if ($elements[$n] ne '');
4535 $a = 'W' if ($elements[$n] =~ /\s$/);
4536 $a = 'C' if ($elements[$n] =~ /$;$/);
4537 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4538 $a = 'O' if ($elements[$n] eq '');
4539 $a = 'E' if ($ca =~ /^\s*$/);
4540
4541 my $op = $elements[$n + 1];
4542
4543 my $c = '';
4544 if (defined $elements[$n + 2]) {
4545 $c = 'V' if ($elements[$n + 2] ne '');
4546 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
4547 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4548 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4549 $c = 'O' if ($elements[$n + 2] eq '');
4550 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4551 } else {
4552 $c = 'E';
4553 }
4554
4555 my $ctx = "${a}x${c}";
4556
4557 my $at = "(ctx:$ctx)";
4558
4559 my $ptr = substr($blank, 0, $off) . "^";
4560 my $hereptr = "$hereline$ptr\n";
4561
4562 # Pull out the value of this operator.
4563 my $op_type = substr($curr_values, $off + 1, 1);
4564
4565 # Get the full operator variant.
4566 my $opv = $op . substr($curr_vars, $off, 1);
4567
4568 # Ignore operators passed as parameters.
4569 if ($op_type ne 'V' &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004570 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004571
4572# # Ignore comments
4573# } elsif ($op =~ /^$;+$/) {
4574
4575 # ; should have either the end of line or a space or \ after it
4576 } elsif ($op eq ';') {
4577 if ($ctx !~ /.x[WEBC]/ &&
4578 $cc !~ /^\\/ && $cc !~ /^;/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004579 if (ERROR("SPACING",
4580 "space required after that '$op' $at\n" . $hereptr)) {
4581 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4582 $line_fixed = 1;
4583 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004584 }
4585
4586 # // is a comment
4587 } elsif ($op eq '//') {
4588
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004589 # : when part of a bitfield
4590 } elsif ($opv eq ':B') {
4591 # skip the bitfield test for now
4592
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004593 # No spaces for:
4594 # ->
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004595 } elsif ($op eq '->') {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004596 if ($ctx =~ /Wx.|.xW/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004597 if (ERROR("SPACING",
4598 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
4599 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4600 if (defined $fix_elements[$n + 2]) {
4601 $fix_elements[$n + 2] =~ s/^\s+//;
4602 }
4603 $line_fixed = 1;
4604 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004605 }
4606
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004607 # , must not have a space before and must have a space on the right.
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004608 } elsif ($op eq ',') {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004609 my $rtrim_before = 0;
4610 my $space_after = 0;
4611 if ($ctx =~ /Wx./) {
4612 if (ERROR("SPACING",
4613 "space prohibited before that '$op' $at\n" . $hereptr)) {
4614 $line_fixed = 1;
4615 $rtrim_before = 1;
4616 }
4617 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004618 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004619 if (ERROR("SPACING",
4620 "space required after that '$op' $at\n" . $hereptr)) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004621 $line_fixed = 1;
4622 $last_after = $n;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004623 $space_after = 1;
Tom Rinia50f8de2014-02-27 08:27:28 -05004624 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004625 }
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004626 if ($rtrim_before || $space_after) {
4627 if ($rtrim_before) {
4628 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4629 } else {
4630 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4631 }
4632 if ($space_after) {
4633 $good .= " ";
4634 }
4635 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004636
4637 # '*' as part of a type definition -- reported already.
4638 } elsif ($opv eq '*_') {
4639 #warn "'*' is part of type\n";
4640
4641 # unary operators should have a space before and
4642 # none after. May be left adjacent to another
4643 # unary operator, or a cast
4644 } elsif ($op eq '!' || $op eq '~' ||
4645 $opv eq '*U' || $opv eq '-U' ||
4646 $opv eq '&U' || $opv eq '&&U') {
4647 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004648 if (ERROR("SPACING",
4649 "space required before that '$op' $at\n" . $hereptr)) {
4650 if ($n != $last_after + 2) {
4651 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4652 $line_fixed = 1;
4653 }
4654 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004655 }
4656 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4657 # A unary '*' may be const
4658
4659 } elsif ($ctx =~ /.xW/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004660 if (ERROR("SPACING",
4661 "space prohibited after that '$op' $at\n" . $hereptr)) {
4662 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
4663 if (defined $fix_elements[$n + 2]) {
4664 $fix_elements[$n + 2] =~ s/^\s+//;
4665 }
4666 $line_fixed = 1;
4667 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004668 }
4669
4670 # unary ++ and unary -- are allowed no space on one side.
4671 } elsif ($op eq '++' or $op eq '--') {
4672 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004673 if (ERROR("SPACING",
4674 "space required one side of that '$op' $at\n" . $hereptr)) {
4675 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4676 $line_fixed = 1;
4677 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004678 }
4679 if ($ctx =~ /Wx[BE]/ ||
4680 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004681 if (ERROR("SPACING",
4682 "space prohibited before that '$op' $at\n" . $hereptr)) {
4683 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4684 $line_fixed = 1;
4685 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004686 }
4687 if ($ctx =~ /ExW/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004688 if (ERROR("SPACING",
4689 "space prohibited after that '$op' $at\n" . $hereptr)) {
4690 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4691 if (defined $fix_elements[$n + 2]) {
4692 $fix_elements[$n + 2] =~ s/^\s+//;
4693 }
4694 $line_fixed = 1;
4695 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004696 }
4697
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004698 # << and >> may either have or not have spaces both sides
4699 } elsif ($op eq '<<' or $op eq '>>' or
4700 $op eq '&' or $op eq '^' or $op eq '|' or
4701 $op eq '+' or $op eq '-' or
4702 $op eq '*' or $op eq '/' or
4703 $op eq '%')
4704 {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004705 if ($check) {
4706 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4707 if (CHK("SPACING",
4708 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4709 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4710 $fix_elements[$n + 2] =~ s/^\s+//;
4711 $line_fixed = 1;
4712 }
4713 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4714 if (CHK("SPACING",
4715 "space preferred before that '$op' $at\n" . $hereptr)) {
4716 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4717 $line_fixed = 1;
4718 }
4719 }
4720 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004721 if (ERROR("SPACING",
4722 "need consistent spacing around '$op' $at\n" . $hereptr)) {
4723 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4724 if (defined $fix_elements[$n + 2]) {
4725 $fix_elements[$n + 2] =~ s/^\s+//;
4726 }
4727 $line_fixed = 1;
4728 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004729 }
4730
4731 # A colon needs no spaces before when it is
4732 # terminating a case value or a label.
4733 } elsif ($opv eq ':C' || $opv eq ':L') {
4734 if ($ctx =~ /Wx./) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004735 if (ERROR("SPACING",
4736 "space prohibited before that '$op' $at\n" . $hereptr)) {
4737 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4738 $line_fixed = 1;
4739 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004740 }
4741
4742 # All the others need spaces both sides.
4743 } elsif ($ctx !~ /[EWC]x[CWE]/) {
4744 my $ok = 0;
4745
4746 # Ignore email addresses <foo@bar>
4747 if (($op eq '<' &&
4748 $cc =~ /^\S+\@\S+>/) ||
4749 ($op eq '>' &&
4750 $ca =~ /<\S+\@\S+$/))
4751 {
Tom Rinid2e30332020-06-16 10:29:46 -04004752 $ok = 1;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004753 }
4754
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004755 # for asm volatile statements
4756 # ignore a colon with another
4757 # colon immediately before or after
4758 if (($op eq ':') &&
4759 ($ca =~ /:$/ || $cc =~ /^:/)) {
4760 $ok = 1;
4761 }
4762
Tom Rinia50f8de2014-02-27 08:27:28 -05004763 # messages are ERROR, but ?: are CHK
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004764 if ($ok == 0) {
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02004765 my $msg_level = \&ERROR;
4766 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Tom Rinia50f8de2014-02-27 08:27:28 -05004767
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02004768 if (&{$msg_level}("SPACING",
4769 "spaces required around that '$op' $at\n" . $hereptr)) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004770 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4771 if (defined $fix_elements[$n + 2]) {
4772 $fix_elements[$n + 2] =~ s/^\s+//;
4773 }
4774 $line_fixed = 1;
4775 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004776 }
4777 }
4778 $off += length($elements[$n + 1]);
Tom Rinia50f8de2014-02-27 08:27:28 -05004779
4780## print("n: <$n> GOOD: <$good>\n");
4781
4782 $fixed_line = $fixed_line . $good;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004783 }
Tom Rinia50f8de2014-02-27 08:27:28 -05004784
4785 if (($#elements % 2) == 0) {
4786 $fixed_line = $fixed_line . $fix_elements[$#elements];
4787 }
4788
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004789 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4790 $fixed[$fixlinenr] = $fixed_line;
Tom Rinia50f8de2014-02-27 08:27:28 -05004791 }
4792
4793
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004794 }
4795
Tom Rinia50f8de2014-02-27 08:27:28 -05004796# check for whitespace before a non-naked semicolon
4797 if ($line =~ /^\+.*\S\s+;\s*$/) {
4798 if (WARN("SPACING",
4799 "space prohibited before semicolon\n" . $herecurr) &&
4800 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004801 1 while $fixed[$fixlinenr] =~
Tom Rinia50f8de2014-02-27 08:27:28 -05004802 s/^(\+.*\S)\s+;/$1;/;
4803 }
4804 }
4805
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004806# check for multiple assignments
4807 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4808 CHK("MULTIPLE_ASSIGNMENTS",
4809 "multiple assignments should be avoided\n" . $herecurr);
4810 }
4811
4812## # check for multiple declarations, allowing for a function declaration
4813## # continuation.
4814## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4815## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4816##
4817## # Remove any bracketed sections to ensure we do not
4818## # falsly report the parameters of functions.
4819## my $ln = $line;
4820## while ($ln =~ s/\([^\(\)]*\)//g) {
4821## }
4822## if ($ln =~ /,/) {
4823## WARN("MULTIPLE_DECLARATION",
4824## "declaring multiple variables together should be avoided\n" . $herecurr);
4825## }
4826## }
4827
4828#need space before brace following if, while, etc
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004829 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02004830 $line =~ /\b(?:else|do)\{/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004831 if (ERROR("SPACING",
4832 "space required before the open brace '{'\n" . $herecurr) &&
4833 $fix) {
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02004834 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
Tom Rinia50f8de2014-02-27 08:27:28 -05004835 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004836 }
4837
Tom Rinia50f8de2014-02-27 08:27:28 -05004838## # check for blank lines before declarations
4839## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4840## $prevrawline =~ /^.\s*$/) {
4841## WARN("SPACING",
4842## "No blank lines before declarations\n" . $hereprev);
4843## }
4844##
4845
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004846# closing brace should have a space following it when it has anything
4847# on the line
Tom Rinid2e30332020-06-16 10:29:46 -04004848 if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004849 if (ERROR("SPACING",
4850 "space required after that close brace '}'\n" . $herecurr) &&
4851 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004852 $fixed[$fixlinenr] =~
Tom Rinia50f8de2014-02-27 08:27:28 -05004853 s/}((?!(?:,|;|\)))\S)/} $1/;
4854 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004855 }
4856
4857# check spacing on square brackets
4858 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004859 if (ERROR("SPACING",
4860 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4861 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004862 $fixed[$fixlinenr] =~
Tom Rinia50f8de2014-02-27 08:27:28 -05004863 s/\[\s+/\[/;
4864 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004865 }
4866 if ($line =~ /\s\]/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004867 if (ERROR("SPACING",
4868 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4869 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004870 $fixed[$fixlinenr] =~
Tom Rinia50f8de2014-02-27 08:27:28 -05004871 s/\s+\]/\]/;
4872 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004873 }
4874
4875# check spacing on parentheses
4876 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4877 $line !~ /for\s*\(\s+;/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004878 if (ERROR("SPACING",
4879 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4880 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004881 $fixed[$fixlinenr] =~
Tom Rinia50f8de2014-02-27 08:27:28 -05004882 s/\(\s+/\(/;
4883 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004884 }
4885 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4886 $line !~ /for\s*\(.*;\s+\)/ &&
4887 $line !~ /:\s+\)/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004888 if (ERROR("SPACING",
4889 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4890 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004891 $fixed[$fixlinenr] =~
Tom Rinia50f8de2014-02-27 08:27:28 -05004892 s/\s+\)/\)/;
4893 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004894 }
4895
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004896# check unnecessary parentheses around addressof/dereference single $Lvals
4897# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4898
4899 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4900 my $var = $1;
4901 if (CHK("UNNECESSARY_PARENTHESES",
4902 "Unnecessary parentheses around $var\n" . $herecurr) &&
4903 $fix) {
4904 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4905 }
4906 }
4907
4908# check for unnecessary parentheses around function pointer uses
4909# ie: (foo->bar)(); should be foo->bar();
4910# but not "if (foo->bar) (" to avoid some false positives
4911 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4912 my $var = $2;
4913 if (CHK("UNNECESSARY_PARENTHESES",
4914 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4915 $fix) {
4916 my $var2 = deparenthesize($var);
4917 $var2 =~ s/\s//g;
4918 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4919 }
4920 }
4921
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02004922# check for unnecessary parentheses around comparisons in if uses
4923# when !drivers/staging or command-line uses --strict
4924 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02004925 $perl_version_ok && defined($stat) &&
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02004926 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4927 my $if_stat = $1;
4928 my $test = substr($2, 1, -1);
4929 my $herectx;
4930 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4931 my $match = $1;
4932 # avoid parentheses around potential macro args
4933 next if ($match =~ /^\s*\w+\s*$/);
4934 if (!defined($herectx)) {
4935 $herectx = $here . "\n";
4936 my $cnt = statement_rawlines($if_stat);
4937 for (my $n = 0; $n < $cnt; $n++) {
4938 my $rl = raw_line($linenr, $n);
4939 $herectx .= $rl . "\n";
4940 last if $rl =~ /^[ \+].*\{/;
4941 }
4942 }
4943 CHK("UNNECESSARY_PARENTHESES",
4944 "Unnecessary parentheses around '$match'\n" . $herectx);
4945 }
4946 }
4947
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004948#goto labels aren't indented, allow a single space however
4949 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4950 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Tom Rinia50f8de2014-02-27 08:27:28 -05004951 if (WARN("INDENTED_LABEL",
4952 "labels should not be indented\n" . $herecurr) &&
4953 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004954 $fixed[$fixlinenr] =~
Tom Rinia50f8de2014-02-27 08:27:28 -05004955 s/^(.)\s+/$1/;
4956 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004957 }
4958
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004959# return is not a function
Tom Rinia50f8de2014-02-27 08:27:28 -05004960 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004961 my $spacing = $1;
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02004962 if ($perl_version_ok &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004963 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4964 my $value = $1;
4965 $value = deparenthesize($value);
4966 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4967 ERROR("RETURN_PARENTHESES",
4968 "return is not a function, parentheses are not required\n" . $herecurr);
4969 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00004970 } elsif ($spacing !~ /\s+/) {
4971 ERROR("SPACING",
4972 "space required before the open parenthesis '('\n" . $herecurr);
4973 }
4974 }
Tom Rinia50f8de2014-02-27 08:27:28 -05004975
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02004976# unnecessary return in a void function
4977# at end-of-function, with the previous line a single leading tab, then return;
4978# and the line before that not a goto label target like "out:"
4979 if ($sline =~ /^[ \+]}\s*$/ &&
4980 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4981 $linenr >= 3 &&
4982 $lines[$linenr - 3] =~ /^[ +]/ &&
4983 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4984 WARN("RETURN_VOID",
4985 "void function return statements are not generally useful\n" . $hereprev);
4986 }
4987
Tom Rinia50f8de2014-02-27 08:27:28 -05004988# if statements using unnecessary parentheses - ie: if ((foo == bar))
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02004989 if ($perl_version_ok &&
Tom Rinia50f8de2014-02-27 08:27:28 -05004990 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4991 my $openparens = $1;
4992 my $count = $openparens =~ tr@\(@\(@;
4993 my $msg = "";
4994 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4995 my $comp = $4; #Not $1 because of $LvalOrFunc
4996 $msg = " - maybe == should be = ?" if ($comp eq "==");
4997 WARN("UNNECESSARY_PARENTHESES",
4998 "Unnecessary parentheses$msg\n" . $herecurr);
4999 }
5000 }
5001
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005002# comparisons with a constant or upper case identifier on the left
5003# avoid cases like "foo + BAR < baz"
5004# only fix matches surrounded by parentheses to avoid incorrect
5005# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02005006 if ($perl_version_ok &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005007 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
5008 my $lead = $1;
5009 my $const = $2;
5010 my $comp = $3;
5011 my $to = $4;
5012 my $newcomp = $comp;
5013 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
5014 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
5015 WARN("CONSTANT_COMPARISON",
5016 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
5017 $fix) {
5018 if ($comp eq "<") {
5019 $newcomp = ">";
5020 } elsif ($comp eq "<=") {
5021 $newcomp = ">=";
5022 } elsif ($comp eq ">") {
5023 $newcomp = "<";
5024 } elsif ($comp eq ">=") {
5025 $newcomp = "<=";
5026 }
5027 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
5028 }
5029 }
5030
5031# Return of what appears to be an errno should normally be negative
5032 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005033 my $name = $1;
5034 if ($name ne 'EOF' && $name ne 'ERROR') {
5035 WARN("USE_NEGATIVE_ERRNO",
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005036 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005037 }
5038 }
5039
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005040# Need a space before open parenthesis after if, while etc
Tom Rinia50f8de2014-02-27 08:27:28 -05005041 if ($line =~ /\b(if|while|for|switch)\(/) {
5042 if (ERROR("SPACING",
5043 "space required before the open parenthesis '('\n" . $herecurr) &&
5044 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005045 $fixed[$fixlinenr] =~
Tom Rinia50f8de2014-02-27 08:27:28 -05005046 s/\b(if|while|for|switch)\(/$1 \(/;
5047 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005048 }
5049
5050# Check for illegal assignment in if conditional -- and check for trailing
5051# statements after the conditional.
5052 if ($line =~ /do\s*(?!{)/) {
Kim Phillips9b7b8372013-02-28 12:53:52 +00005053 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
5054 ctx_statement_block($linenr, $realcnt, 0)
5055 if (!defined $stat);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005056 my ($stat_next) = ctx_statement_block($line_nr_next,
5057 $remain_next, $off_next);
5058 $stat_next =~ s/\n./\n /g;
5059 ##print "stat<$stat> stat_next<$stat_next>\n";
5060
5061 if ($stat_next =~ /^\s*while\b/) {
5062 # If the statement carries leading newlines,
5063 # then count those as offsets.
5064 my ($whitespace) =
5065 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
5066 my $offset =
5067 statement_rawlines($whitespace) - 1;
5068
5069 $suppress_whiletrailers{$line_nr_next +
5070 $offset} = 1;
5071 }
5072 }
5073 if (!defined $suppress_whiletrailers{$linenr} &&
Tom Rinia50f8de2014-02-27 08:27:28 -05005074 defined($stat) && defined($cond) &&
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005075 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
5076 my ($s, $c) = ($stat, $cond);
5077
5078 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
5079 ERROR("ASSIGN_IN_IF",
5080 "do not use assignment in if condition\n" . $herecurr);
5081 }
5082
5083 # Find out what is on the end of the line after the
5084 # conditional.
5085 substr($s, 0, length($c), '');
5086 $s =~ s/\n.*//g;
Tom Rinid2e30332020-06-16 10:29:46 -04005087 $s =~ s/$;//g; # Remove any comments
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005088 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
5089 $c !~ /}\s*while\s*/)
5090 {
5091 # Find out how long the conditional actually is.
5092 my @newlines = ($c =~ /\n/gs);
5093 my $cond_lines = 1 + $#newlines;
5094 my $stat_real = '';
5095
5096 $stat_real = raw_line($linenr, $cond_lines)
5097 . "\n" if ($cond_lines);
5098 if (defined($stat_real) && $cond_lines > 1) {
5099 $stat_real = "[...]\n$stat_real";
5100 }
5101
5102 ERROR("TRAILING_STATEMENTS",
5103 "trailing statements should be on next line\n" . $herecurr . $stat_real);
5104 }
5105 }
5106
5107# Check for bitwise tests written as boolean
5108 if ($line =~ /
5109 (?:
5110 (?:\[|\(|\&\&|\|\|)
5111 \s*0[xX][0-9]+\s*
5112 (?:\&\&|\|\|)
5113 |
5114 (?:\&\&|\|\|)
5115 \s*0[xX][0-9]+\s*
5116 (?:\&\&|\|\||\)|\])
5117 )/x)
5118 {
5119 WARN("HEXADECIMAL_BOOLEAN_TEST",
5120 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
5121 }
5122
5123# if and else should not have general statements after it
5124 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
5125 my $s = $1;
Tom Rinid2e30332020-06-16 10:29:46 -04005126 $s =~ s/$;//g; # Remove any comments
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005127 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
5128 ERROR("TRAILING_STATEMENTS",
5129 "trailing statements should be on next line\n" . $herecurr);
5130 }
5131 }
5132# if should not continue a brace
5133 if ($line =~ /}\s*if\b/) {
5134 ERROR("TRAILING_STATEMENTS",
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005135 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005136 $herecurr);
5137 }
5138# case and default should not have general statements after them
5139 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
5140 $line !~ /\G(?:
5141 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
5142 \s*return\s+
5143 )/xg)
5144 {
5145 ERROR("TRAILING_STATEMENTS",
5146 "trailing statements should be on next line\n" . $herecurr);
5147 }
5148
5149 # Check for }<nl>else {, these must be at the same
5150 # indent level to be relevant to each other.
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005151 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
5152 $previndent == $indent) {
5153 if (ERROR("ELSE_AFTER_BRACE",
5154 "else should follow close brace '}'\n" . $hereprev) &&
5155 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5156 fix_delete_line($fixlinenr - 1, $prevrawline);
5157 fix_delete_line($fixlinenr, $rawline);
5158 my $fixedline = $prevrawline;
5159 $fixedline =~ s/}\s*$//;
5160 if ($fixedline !~ /^\+\s*$/) {
5161 fix_insert_line($fixlinenr, $fixedline);
5162 }
5163 $fixedline = $rawline;
5164 $fixedline =~ s/^(.\s*)else/$1} else/;
5165 fix_insert_line($fixlinenr, $fixedline);
5166 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005167 }
5168
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005169 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5170 $previndent == $indent) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005171 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5172
5173 # Find out what is on the end of the line after the
5174 # conditional.
5175 substr($s, 0, length($c), '');
5176 $s =~ s/\n.*//g;
5177
5178 if ($s =~ /^\s*;/) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005179 if (ERROR("WHILE_AFTER_BRACE",
5180 "while should follow close brace '}'\n" . $hereprev) &&
5181 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5182 fix_delete_line($fixlinenr - 1, $prevrawline);
5183 fix_delete_line($fixlinenr, $rawline);
5184 my $fixedline = $prevrawline;
5185 my $trailing = $rawline;
5186 $trailing =~ s/^\+//;
5187 $trailing = trim($trailing);
5188 $fixedline =~ s/}\s*$/} $trailing/;
5189 fix_insert_line($fixlinenr, $fixedline);
5190 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005191 }
5192 }
5193
Tom Rinia50f8de2014-02-27 08:27:28 -05005194#Specific variable tests
Kim Phillips9b7b8372013-02-28 12:53:52 +00005195 while ($line =~ m{($Constant|$Lval)}g) {
5196 my $var = $1;
Tom Rinia50f8de2014-02-27 08:27:28 -05005197
Tom Rinia50f8de2014-02-27 08:27:28 -05005198#CamelCase
5199 if ($var !~ /^$Constant$/ &&
5200 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
5201#Ignore Page<foo> variants
5202 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Tom Rinid2e30332020-06-16 10:29:46 -04005203#Ignore SI style variants like nS, mV and dB
5204#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5205 $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005206#Ignore some three character SI units explicitly, like MiB and KHz
5207 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05005208 while ($var =~ m{($Ident)}g) {
5209 my $word = $1;
5210 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
5211 if ($check) {
5212 seed_camelcase_includes();
5213 if (!$file && !$camelcase_file_seeded) {
5214 seed_camelcase_file($realfile);
5215 $camelcase_file_seeded = 1;
5216 }
5217 }
5218 if (!defined $camelcase{$word}) {
5219 $camelcase{$word} = 1;
5220 CHK("CAMELCASE",
5221 "Avoid CamelCase: <$word>\n" . $herecurr);
5222 }
5223 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00005224 }
5225 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005226
5227#no spaces allowed after \ in define
Tom Rinia50f8de2014-02-27 08:27:28 -05005228 if ($line =~ /\#\s*define.*\\\s+$/) {
5229 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5230 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5231 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005232 $fixed[$fixlinenr] =~ s/\s+$//;
Tom Rinia50f8de2014-02-27 08:27:28 -05005233 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005234 }
5235
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005236# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5237# itself <asm/foo.h> (uses RAW line)
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005238 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
5239 my $file = "$1.h";
5240 my $checkfile = "include/linux/$file";
5241 if (-f "$root/$checkfile" &&
5242 $realfile ne $checkfile &&
5243 $1 !~ /$allowed_asm_includes/)
5244 {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005245 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5246 if ($asminclude > 0) {
5247 if ($realfile =~ m{^arch/}) {
5248 CHK("ARCH_INCLUDE_LINUX",
5249 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5250 } else {
5251 WARN("INCLUDE_LINUX",
5252 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5253 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005254 }
5255 }
5256 }
5257
5258# multi-statement macros should be enclosed in a do while loop, grab the
5259# first statement and ensure its the whole macro if its not enclosed
5260# in a known good container
5261 if ($realfile !~ m@/vmlinux.lds.h$@ &&
5262 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
5263 my $ln = $linenr;
5264 my $cnt = $realcnt;
5265 my ($off, $dstat, $dcond, $rest);
5266 my $ctx = '';
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005267 my $has_flow_statement = 0;
5268 my $has_arg_concat = 0;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005269 ($dstat, $dcond, $ln, $cnt, $off) =
Kim Phillips9b7b8372013-02-28 12:53:52 +00005270 ctx_statement_block($linenr, $realcnt, 0);
5271 $ctx = $dstat;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005272 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5273 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5274
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005275 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
5276 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
5277
5278 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5279 my $define_args = $1;
5280 my $define_stmt = $dstat;
5281 my @def_args = ();
5282
5283 if (defined $define_args && $define_args ne "") {
5284 $define_args = substr($define_args, 1, length($define_args) - 2);
5285 $define_args =~ s/\s*//g;
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02005286 $define_args =~ s/\\\+?//g;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005287 @def_args = split(",", $define_args);
5288 }
5289
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005290 $dstat =~ s/$;//g;
5291 $dstat =~ s/\\\n.//g;
5292 $dstat =~ s/^\s*//s;
5293 $dstat =~ s/\s*$//s;
5294
5295 # Flatten any parentheses and braces
5296 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
5297 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005298 $dstat =~ s/.\[[^\[\]]*\]/1/)
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005299 {
5300 }
5301
Tom Rinid2e30332020-06-16 10:29:46 -04005302 # Flatten any obvious string concatenation.
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005303 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5304 $dstat =~ s/$Ident\s*($String)/$1/)
Kim Phillips9b7b8372013-02-28 12:53:52 +00005305 {
5306 }
5307
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005308 # Make asm volatile uses seem like a generic function
5309 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5310
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005311 my $exceptions = qr{
5312 $Declare|
5313 module_param_named|
Kim Phillips9b7b8372013-02-28 12:53:52 +00005314 MODULE_PARM_DESC|
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005315 DECLARE_PER_CPU|
5316 DEFINE_PER_CPU|
5317 __typeof__\(|
5318 union|
5319 struct|
5320 \.$Ident\s*=\s*|
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005321 ^\"|\"$|
5322 ^\[
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005323 }x;
5324 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005325
5326 $ctx =~ s/\n*$//;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005327 my $stmt_cnt = statement_rawlines($ctx);
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02005328 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005329
Kim Phillips9b7b8372013-02-28 12:53:52 +00005330 if ($dstat ne '' &&
5331 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5332 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Tom Rinia50f8de2014-02-27 08:27:28 -05005333 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005334 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Kim Phillips9b7b8372013-02-28 12:53:52 +00005335 $dstat !~ /$exceptions/ &&
5336 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Tom Rinia50f8de2014-02-27 08:27:28 -05005337 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Kim Phillips9b7b8372013-02-28 12:53:52 +00005338 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5339 $dstat !~ /^for\s*$Constant$/ && # for (...)
5340 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5341 $dstat !~ /^do\s*{/ && # do {...
Heiko Schochere65be982016-01-04 09:17:19 +01005342 $dstat !~ /^\(\{/ && # ({...
Tom Rinia50f8de2014-02-27 08:27:28 -05005343 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Kim Phillips9b7b8372013-02-28 12:53:52 +00005344 {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005345 if ($dstat =~ /^\s*if\b/) {
5346 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5347 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5348 } elsif ($dstat =~ /;/) {
5349 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5350 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5351 } else {
5352 ERROR("COMPLEX_MACRO",
5353 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
5354 }
5355
5356 }
5357
5358 # Make $define_stmt single line, comment-free, etc
5359 my @stmt_array = split('\n', $define_stmt);
5360 my $first = 1;
5361 $define_stmt = "";
5362 foreach my $l (@stmt_array) {
5363 $l =~ s/\\$//;
5364 if ($first) {
5365 $define_stmt = $l;
5366 $first = 0;
5367 } elsif ($l =~ /^[\+ ]/) {
5368 $define_stmt .= substr($l, 1);
5369 }
5370 }
5371 $define_stmt =~ s/$;//g;
5372 $define_stmt =~ s/\s+/ /g;
5373 $define_stmt = trim($define_stmt);
5374
5375# check if any macro arguments are reused (ignore '...' and 'type')
5376 foreach my $arg (@def_args) {
5377 next if ($arg =~ /\.\.\./);
5378 next if ($arg =~ /^type$/i);
5379 my $tmp_stmt = $define_stmt;
Tom Rinid2e30332020-06-16 10:29:46 -04005380 $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005381 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5382 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02005383 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005384 if ($use_cnt > 1) {
5385 CHK("MACRO_ARG_REUSE",
5386 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
5387 }
5388# check if any macro arguments may have other precedence issues
5389 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
5390 ((defined($1) && $1 ne ',') ||
5391 (defined($2) && $2 ne ','))) {
5392 CHK("MACRO_ARG_PRECEDENCE",
5393 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
5394 }
5395 }
5396
5397# check for macros with flow control, but without ## concatenation
5398# ## concatenation is commonly a macro that defines a function so ignore those
5399 if ($has_flow_statement && !$has_arg_concat) {
Kim Phillips9b7b8372013-02-28 12:53:52 +00005400 my $cnt = statement_rawlines($ctx);
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02005401 my $herectx = get_stat_here($linenr, $cnt, $here);
Kim Phillips9b7b8372013-02-28 12:53:52 +00005402
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005403 WARN("MACRO_WITH_FLOW_CONTROL",
5404 "Macros with flow control statements should be avoided\n" . "$herectx");
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005405 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00005406
5407# check for line continuations outside of #defines, preprocessor #, and asm
5408
5409 } else {
5410 if ($prevline !~ /^..*\\$/ &&
5411 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5412 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
5413 $line =~ /^\+.*\\$/) {
5414 WARN("LINE_CONTINUATIONS",
5415 "Avoid unnecessary line continuations\n" . $herecurr);
5416 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005417 }
5418
Kim Phillips9b7b8372013-02-28 12:53:52 +00005419# do {} while (0) macro tests:
5420# single-statement macros do not need to be enclosed in do while (0) loop,
5421# macro should not end with a semicolon
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02005422 if ($perl_version_ok &&
Kim Phillips9b7b8372013-02-28 12:53:52 +00005423 $realfile !~ m@/vmlinux.lds.h$@ &&
5424 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5425 my $ln = $linenr;
5426 my $cnt = $realcnt;
5427 my ($off, $dstat, $dcond, $rest);
5428 my $ctx = '';
5429 ($dstat, $dcond, $ln, $cnt, $off) =
5430 ctx_statement_block($linenr, $realcnt, 0);
5431 $ctx = $dstat;
5432
5433 $dstat =~ s/\\\n.//g;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005434 $dstat =~ s/$;/ /g;
Kim Phillips9b7b8372013-02-28 12:53:52 +00005435
5436 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5437 my $stmts = $2;
5438 my $semis = $3;
5439
5440 $ctx =~ s/\n*$//;
5441 my $cnt = statement_rawlines($ctx);
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02005442 my $herectx = get_stat_here($linenr, $cnt, $here);
Kim Phillips9b7b8372013-02-28 12:53:52 +00005443
5444 if (($stmts =~ tr/;/;/) == 1 &&
5445 $stmts !~ /^\s*(if|while|for|switch)\b/) {
5446 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5447 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5448 }
5449 if (defined $semis && $semis ne "") {
5450 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5451 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5452 }
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005453 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5454 $ctx =~ s/\n*$//;
5455 my $cnt = statement_rawlines($ctx);
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02005456 my $herectx = get_stat_here($linenr, $cnt, $here);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005457
5458 WARN("TRAILING_SEMICOLON",
5459 "macros should not use a trailing semicolon\n" . "$herectx");
Kim Phillips9b7b8372013-02-28 12:53:52 +00005460 }
5461 }
5462
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005463# check for redundant bracing round if etc
5464 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5465 my ($level, $endln, @chunks) =
5466 ctx_statement_full($linenr, $realcnt, 1);
5467 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5468 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5469 if ($#chunks > 0 && $level == 0) {
Kim Phillips9b7b8372013-02-28 12:53:52 +00005470 my @allowed = ();
5471 my $allow = 0;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005472 my $seen = 0;
5473 my $herectx = $here . "\n";
5474 my $ln = $linenr - 1;
5475 for my $chunk (@chunks) {
5476 my ($cond, $block) = @{$chunk};
5477
5478 # If the condition carries leading newlines, then count those as offsets.
5479 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5480 my $offset = statement_rawlines($whitespace) - 1;
5481
Kim Phillips9b7b8372013-02-28 12:53:52 +00005482 $allowed[$allow] = 0;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005483 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5484
5485 # We have looked at and allowed this specific line.
5486 $suppress_ifbraces{$ln + $offset} = 1;
5487
5488 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
5489 $ln += statement_rawlines($block) - 1;
5490
5491 substr($block, 0, length($cond), '');
5492
5493 $seen++ if ($block =~ /^\s*{/);
5494
Kim Phillips9b7b8372013-02-28 12:53:52 +00005495 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005496 if (statement_lines($cond) > 1) {
5497 #print "APW: ALLOWED: cond<$cond>\n";
Kim Phillips9b7b8372013-02-28 12:53:52 +00005498 $allowed[$allow] = 1;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005499 }
5500 if ($block =~/\b(?:if|for|while)\b/) {
5501 #print "APW: ALLOWED: block<$block>\n";
Kim Phillips9b7b8372013-02-28 12:53:52 +00005502 $allowed[$allow] = 1;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005503 }
5504 if (statement_block_size($block) > 1) {
5505 #print "APW: ALLOWED: lines block<$block>\n";
Kim Phillips9b7b8372013-02-28 12:53:52 +00005506 $allowed[$allow] = 1;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005507 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00005508 $allow++;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005509 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00005510 if ($seen) {
5511 my $sum_allowed = 0;
5512 foreach (@allowed) {
5513 $sum_allowed += $_;
5514 }
5515 if ($sum_allowed == 0) {
5516 WARN("BRACES",
5517 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5518 } elsif ($sum_allowed != $allow &&
5519 $seen != $allow) {
5520 CHK("BRACES",
5521 "braces {} should be used on all arms of this statement\n" . $herectx);
5522 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005523 }
5524 }
5525 }
5526 if (!defined $suppress_ifbraces{$linenr - 1} &&
5527 $line =~ /\b(if|while|for|else)\b/) {
5528 my $allowed = 0;
5529
5530 # Check the pre-context.
5531 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5532 #print "APW: ALLOWED: pre<$1>\n";
5533 $allowed = 1;
5534 }
5535
5536 my ($level, $endln, @chunks) =
5537 ctx_statement_full($linenr, $realcnt, $-[0]);
5538
5539 # Check the condition.
5540 my ($cond, $block) = @{$chunks[0]};
5541 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5542 if (defined $cond) {
5543 substr($block, 0, length($cond), '');
5544 }
5545 if (statement_lines($cond) > 1) {
5546 #print "APW: ALLOWED: cond<$cond>\n";
5547 $allowed = 1;
5548 }
5549 if ($block =~/\b(?:if|for|while)\b/) {
5550 #print "APW: ALLOWED: block<$block>\n";
5551 $allowed = 1;
5552 }
5553 if (statement_block_size($block) > 1) {
5554 #print "APW: ALLOWED: lines block<$block>\n";
5555 $allowed = 1;
5556 }
5557 # Check the post-context.
5558 if (defined $chunks[1]) {
5559 my ($cond, $block) = @{$chunks[1]};
5560 if (defined $cond) {
5561 substr($block, 0, length($cond), '');
5562 }
5563 if ($block =~ /^\s*\{/) {
5564 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5565 $allowed = 1;
5566 }
5567 }
5568 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005569 my $cnt = statement_rawlines($block);
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02005570 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005571
5572 WARN("BRACES",
5573 "braces {} are not necessary for single statement blocks\n" . $herectx);
5574 }
5575 }
5576
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005577# check for single line unbalanced braces
5578 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5579 $sline =~ /^.\s*else\s*\{\s*$/) {
5580 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5581 }
5582
Kim Phillips9b7b8372013-02-28 12:53:52 +00005583# check for unnecessary blank lines around braces
Tom Rinia50f8de2014-02-27 08:27:28 -05005584 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005585 if (CHK("BRACES",
5586 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5587 $fix && $prevrawline =~ /^\+/) {
5588 fix_delete_line($fixlinenr - 1, $prevrawline);
5589 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005590 }
Tom Rinia50f8de2014-02-27 08:27:28 -05005591 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005592 if (CHK("BRACES",
5593 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5594 $fix) {
5595 fix_delete_line($fixlinenr, $rawline);
5596 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005597 }
5598
5599# no volatiles please
5600 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5601 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
5602 WARN("VOLATILE",
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005603 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5604 }
5605
5606# Check for user-visible strings broken across lines, which breaks the ability
5607# to grep for the string. Make exceptions when the previous string ends in a
5608# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5609# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5610 if ($line =~ /^\+\s*$String/ &&
5611 $prevline =~ /"\s*$/ &&
5612 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5613 if (WARN("SPLIT_STRING",
5614 "quoted string split across lines\n" . $hereprev) &&
5615 $fix &&
5616 $prevrawline =~ /^\+.*"\s*$/ &&
5617 $last_coalesced_string_linenr != $linenr - 1) {
5618 my $extracted_string = get_quoted_string($line, $rawline);
5619 my $comma_close = "";
5620 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5621 $comma_close = $1;
5622 }
5623
5624 fix_delete_line($fixlinenr - 1, $prevrawline);
5625 fix_delete_line($fixlinenr, $rawline);
5626 my $fixedline = $prevrawline;
5627 $fixedline =~ s/"\s*$//;
5628 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5629 fix_insert_line($fixlinenr - 1, $fixedline);
5630 $fixedline = $rawline;
5631 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5632 if ($fixedline !~ /\+\s*$/) {
5633 fix_insert_line($fixlinenr, $fixedline);
5634 }
5635 $last_coalesced_string_linenr = $linenr;
5636 }
5637 }
5638
5639# check for missing a space in a string concatenation
5640 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5641 WARN('MISSING_SPACE',
5642 "break quoted strings at a space character\n" . $hereprev);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005643 }
5644
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005645# check for an embedded function name in a string when the function is known
5646# This does not work very well for -f --file checking as it depends on patch
5647# context providing the function name or a single line form for in-file
5648# function declarations
5649 if ($line =~ /^\+.*$String/ &&
5650 defined($context_function) &&
5651 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5652 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
5653 WARN("EMBEDDED_FUNCTION_NAME",
5654 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5655 }
5656
5657# check for spaces before a quoted newline
5658 if ($rawline =~ /^.*\".*\s\\n/) {
5659 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5660 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5661 $fix) {
5662 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5663 }
5664
5665 }
5666
5667# concatenated string without spaces between elements
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02005668 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5669 if (CHK("CONCATENATED_STRING",
5670 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
5671 $fix) {
5672 while ($line =~ /($String)/g) {
5673 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5674 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
5675 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
5676 }
5677 }
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005678 }
5679
5680# uncoalesced string fragments
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02005681 if ($line =~ /$String\s*"/) {
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02005682 if (WARN("STRING_FRAGMENTS",
5683 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
5684 $fix) {
5685 while ($line =~ /($String)(?=\s*")/g) {
5686 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5687 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
5688 }
5689 }
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005690 }
5691
5692# check for non-standard and hex prefixed decimal printf formats
5693 my $show_L = 1; #don't show the same defect twice
5694 my $show_Z = 1;
5695 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5696 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
5697 $string =~ s/%%/__/g;
5698 # check for %L
5699 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
5700 WARN("PRINTF_L",
5701 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5702 $show_L = 0;
5703 }
5704 # check for %Z
5705 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5706 WARN("PRINTF_Z",
5707 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5708 $show_Z = 0;
5709 }
5710 # check for 0x<decimal>
5711 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5712 ERROR("PRINTF_0XDECIMAL",
5713 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5714 }
5715 }
5716
5717# check for line continuations in quoted strings with odd counts of "
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02005718 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005719 WARN("LINE_CONTINUATIONS",
5720 "Avoid line continuations in quoted strings\n" . $herecurr);
5721 }
5722
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005723# warn about #if 0
5724 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02005725 WARN("IF_0",
5726 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
5727 }
5728
5729# warn about #if 1
5730 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
5731 WARN("IF_1",
5732 "Consider removing the #if 1 and its #endif\n" . $herecurr);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005733 }
5734
Kim Phillips9b7b8372013-02-28 12:53:52 +00005735# check for needless "if (<foo>) fn(<foo>)" uses
5736 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005737 my $tested = quotemeta($1);
5738 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5739 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5740 my $func = $1;
5741 if (WARN('NEEDLESS_IF',
5742 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5743 $fix) {
5744 my $do_fix = 1;
5745 my $leading_tabs = "";
5746 my $new_leading_tabs = "";
5747 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5748 $leading_tabs = $1;
5749 } else {
5750 $do_fix = 0;
5751 }
5752 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5753 $new_leading_tabs = $1;
5754 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5755 $do_fix = 0;
5756 }
5757 } else {
5758 $do_fix = 0;
5759 }
5760 if ($do_fix) {
5761 fix_delete_line($fixlinenr - 1, $prevrawline);
5762 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5763 }
5764 }
5765 }
5766 }
5767
5768# check for unnecessary "Out of Memory" messages
5769 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5770 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5771 (defined $1 || defined $3) &&
5772 $linenr > 3) {
5773 my $testval = $2;
5774 my $testline = $lines[$linenr - 3];
5775
5776 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5777# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5778
Tom Rinid2e30332020-06-16 10:29:46 -04005779 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5780 $s !~ /\b__GFP_NOWARN\b/ ) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005781 WARN("OOM_MESSAGE",
5782 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5783 }
5784 }
5785
5786# check for logging functions with KERN_<LEVEL>
5787 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5788 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5789 my $level = $1;
5790 if (WARN("UNNECESSARY_KERN_LEVEL",
5791 "Possible unnecessary $level\n" . $herecurr) &&
5792 $fix) {
5793 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5794 }
5795 }
5796
5797# check for logging continuations
5798 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5799 WARN("LOGGING_CONTINUATION",
5800 "Avoid logging continuation uses where feasible\n" . $herecurr);
5801 }
5802
5803# check for mask then right shift without a parentheses
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02005804 if ($perl_version_ok &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005805 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5806 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5807 WARN("MASK_THEN_SHIFT",
5808 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5809 }
5810
5811# check for pointer comparisons to NULL
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02005812 if ($perl_version_ok) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005813 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5814 my $val = $1;
5815 my $equal = "!";
5816 $equal = "" if ($4 eq "!=");
5817 if (CHK("COMPARISON_TO_NULL",
5818 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5819 $fix) {
5820 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5821 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005822 }
5823 }
5824
Tom Rinia50f8de2014-02-27 08:27:28 -05005825# check for bad placement of section $InitAttribute (e.g.: __initdata)
5826 if ($line =~ /(\b$InitAttribute\b)/) {
5827 my $attr = $1;
5828 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5829 my $ptr = $1;
5830 my $var = $2;
5831 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5832 ERROR("MISPLACED_INIT",
5833 "$attr should be placed after $var\n" . $herecurr)) ||
5834 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5835 WARN("MISPLACED_INIT",
5836 "$attr should be placed after $var\n" . $herecurr))) &&
5837 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005838 $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;
Tom Rinia50f8de2014-02-27 08:27:28 -05005839 }
5840 }
5841 }
5842
5843# check for $InitAttributeData (ie: __initdata) with const
5844 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5845 my $attr = $1;
5846 $attr =~ /($InitAttributePrefix)(.*)/;
5847 my $attr_prefix = $1;
5848 my $attr_type = $2;
5849 if (ERROR("INIT_ATTRIBUTE",
5850 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5851 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005852 $fixed[$fixlinenr] =~
Tom Rinia50f8de2014-02-27 08:27:28 -05005853 s/$InitAttributeData/${attr_prefix}initconst/;
5854 }
5855 }
5856
5857# check for $InitAttributeConst (ie: __initconst) without const
5858 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5859 my $attr = $1;
5860 if (ERROR("INIT_ATTRIBUTE",
5861 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5862 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005863 my $lead = $fixed[$fixlinenr] =~
Tom Rinia50f8de2014-02-27 08:27:28 -05005864 /(^\+\s*(?:static\s+))/;
5865 $lead = rtrim($1);
5866 $lead = "$lead " if ($lead !~ /^\+$/);
5867 $lead = "${lead}const ";
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005868 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5869 }
5870 }
5871
5872# check for __read_mostly with const non-pointer (should just be const)
5873 if ($line =~ /\b__read_mostly\b/ &&
5874 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5875 if (ERROR("CONST_READ_MOSTLY",
5876 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5877 $fix) {
5878 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5879 }
5880 }
5881
5882# don't use __constant_<foo> functions outside of include/uapi/
5883 if ($realfile !~ m@^include/uapi/@ &&
5884 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5885 my $constant_func = $1;
5886 my $func = $constant_func;
5887 $func =~ s/^__constant_//;
5888 if (WARN("CONSTANT_CONVERSION",
5889 "$constant_func should be $func\n" . $herecurr) &&
5890 $fix) {
5891 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Tom Rinia50f8de2014-02-27 08:27:28 -05005892 }
5893 }
5894
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005895# prefer usleep_range over udelay
Kim Phillips9b7b8372013-02-28 12:53:52 +00005896 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005897 my $delay = $1;
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005898 # ignore udelay's < 10, however
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005899 if (! ($delay < 10) ) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005900 CHK("USLEEP_RANGE",
Tom Rinid2e30332020-06-16 10:29:46 -04005901 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005902 }
5903 if ($delay > 2000) {
5904 WARN("LONG_UDELAY",
5905 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005906 }
5907 }
5908
5909# warn about unexpectedly long msleep's
5910 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5911 if ($1 < 20) {
5912 WARN("MSLEEP",
Tom Rinid2e30332020-06-16 10:29:46 -04005913 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005914 }
5915 }
5916
Tom Rinia50f8de2014-02-27 08:27:28 -05005917# check for comparisons of jiffies
5918 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5919 WARN("JIFFIES_COMPARISON",
5920 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5921 }
5922
5923# check for comparisons of get_jiffies_64()
5924 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5925 WARN("JIFFIES_COMPARISON",
5926 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5927 }
5928
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005929# warn about #ifdefs in C files
5930# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5931# print "#ifdef in C files should be avoided\n";
5932# print "$herecurr";
5933# $clean = 0;
5934# }
5935
5936# warn about spacing in #ifdefs
5937 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05005938 if (ERROR("SPACING",
5939 "exactly one space required after that #$1\n" . $herecurr) &&
5940 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005941 $fixed[$fixlinenr] =~
Tom Rinia50f8de2014-02-27 08:27:28 -05005942 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5943 }
5944
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005945 }
5946
5947# check for spinlock_t definitions without a comment.
5948 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5949 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5950 my $which = $1;
5951 if (!ctx_has_comment($first_line, $linenr)) {
5952 CHK("UNCOMMENTED_DEFINITION",
5953 "$1 definition without comment\n" . $herecurr);
5954 }
5955 }
5956# check for memory barriers without a comment.
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005957
5958 my $barriers = qr{
5959 mb|
5960 rmb|
5961 wmb|
5962 read_barrier_depends
5963 }x;
5964 my $barrier_stems = qr{
5965 mb__before_atomic|
5966 mb__after_atomic|
5967 store_release|
5968 load_acquire|
5969 store_mb|
5970 (?:$barriers)
5971 }x;
5972 my $all_barriers = qr{
5973 (?:$barriers)|
5974 smp_(?:$barrier_stems)|
5975 virt_(?:$barrier_stems)
5976 }x;
5977
5978 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005979 if (!ctx_has_comment($first_line, $linenr)) {
Tom Rinia50f8de2014-02-27 08:27:28 -05005980 WARN("MEMORY_BARRIER",
5981 "memory barrier without comment\n" . $herecurr);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00005982 }
5983 }
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02005984
5985 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5986
5987 if ($realfile !~ m@^include/asm-generic/@ &&
5988 $realfile !~ m@/barrier\.h$@ &&
5989 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5990 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5991 WARN("MEMORY_BARRIER",
5992 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5993 }
5994
5995# check for waitqueue_active without a comment.
5996 if ($line =~ /\bwaitqueue_active\s*\(/) {
5997 if (!ctx_has_comment($first_line, $linenr)) {
5998 WARN("WAITQUEUE_ACTIVE",
5999 "waitqueue_active without comment\n" . $herecurr);
6000 }
6001 }
6002
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006003# check for smp_read_barrier_depends and read_barrier_depends
6004 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
6005 WARN("READ_BARRIER_DEPENDS",
6006 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
6007 }
6008
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006009# check of hardware specific defines
6010 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
6011 CHK("ARCH_DEFINES",
6012 "architecture specific defines should be avoided\n" . $herecurr);
6013 }
6014
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006015# check that the storage class is not after a type
6016 if ($line =~ /\b($Type)\s+($Storage)\b/) {
6017 WARN("STORAGE_CLASS",
6018 "storage class '$2' should be located before type '$1'\n" . $herecurr);
6019 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006020# Check that the storage class is at the beginning of a declaration
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006021 if ($line =~ /\b$Storage\b/ &&
6022 $line !~ /^.\s*$Storage/ &&
6023 $line =~ /^.\s*(.+?)\$Storage\s/ &&
6024 $1 !~ /[\,\)]\s*$/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006025 WARN("STORAGE_CLASS",
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006026 "storage class should be at the beginning of the declaration\n" . $herecurr);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006027 }
6028
6029# check the location of the inline attribute, that it is between
6030# storage class and type.
6031 if ($line =~ /\b$Type\s+$Inline\b/ ||
6032 $line =~ /\b$Inline\s+$Storage\b/) {
6033 ERROR("INLINE_LOCATION",
6034 "inline keyword should sit between storage class and type\n" . $herecurr);
6035 }
6036
6037# Check for __inline__ and __inline, prefer inline
Tom Rinia50f8de2014-02-27 08:27:28 -05006038 if ($realfile !~ m@\binclude/uapi/@ &&
6039 $line =~ /\b(__inline__|__inline)\b/) {
6040 if (WARN("INLINE",
6041 "plain inline is preferred over $1\n" . $herecurr) &&
6042 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006043 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Tom Rinia50f8de2014-02-27 08:27:28 -05006044
6045 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006046 }
6047
6048# Check for __attribute__ packed, prefer __packed
Tom Rinia50f8de2014-02-27 08:27:28 -05006049 if ($realfile !~ m@\binclude/uapi/@ &&
6050 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006051 WARN("PREFER_PACKED",
6052 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
6053 }
6054
6055# Check for __attribute__ aligned, prefer __aligned
Tom Rinia50f8de2014-02-27 08:27:28 -05006056 if ($realfile !~ m@\binclude/uapi/@ &&
6057 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006058 WARN("PREFER_ALIGNED",
6059 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
6060 }
6061
Tom Rinid2e30332020-06-16 10:29:46 -04006062# Check for __attribute__ section, prefer __section
6063 if ($realfile !~ m@\binclude/uapi/@ &&
6064 $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) {
6065 my $old = substr($rawline, $-[1], $+[1] - $-[1]);
6066 my $new = substr($old, 1, -1);
6067 if (WARN("PREFER_SECTION",
6068 "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) &&
6069 $fix) {
6070 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
6071 }
6072 }
6073
Kim Phillips9b7b8372013-02-28 12:53:52 +00006074# Check for __attribute__ format(printf, prefer __printf
Tom Rinia50f8de2014-02-27 08:27:28 -05006075 if ($realfile !~ m@\binclude/uapi/@ &&
6076 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
6077 if (WARN("PREFER_PRINTF",
6078 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
6079 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006080 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
Tom Rinia50f8de2014-02-27 08:27:28 -05006081
6082 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00006083 }
6084
6085# Check for __attribute__ format(scanf, prefer __scanf
Tom Rinia50f8de2014-02-27 08:27:28 -05006086 if ($realfile !~ m@\binclude/uapi/@ &&
6087 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
6088 if (WARN("PREFER_SCANF",
6089 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
6090 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006091 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
6092 }
6093 }
6094
6095# Check for __attribute__ weak, or __weak declarations (may have link issues)
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006096 if ($perl_version_ok &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006097 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6098 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
6099 $line =~ /\b__weak\b/)) {
6100 ERROR("WEAK_DECLARATION",
6101 "Using weak declarations can have unintended link defects\n" . $herecurr);
6102 }
6103
6104# check for c99 types like uint8_t used outside of uapi/ and tools/
6105 if ($realfile !~ m@\binclude/uapi/@ &&
6106 $realfile !~ m@\btools/@ &&
6107 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
6108 my $type = $1;
6109 if ($type =~ /\b($typeC99Typedefs)\b/) {
6110 $type = $1;
6111 my $kernel_type = 'u';
6112 $kernel_type = 's' if ($type =~ /^_*[si]/);
6113 $type =~ /(\d+)/;
6114 $kernel_type .= $1;
6115 if (CHK("PREFER_KERNEL_TYPES",
6116 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
6117 $fix) {
6118 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
6119 }
6120 }
6121 }
6122
6123# check for cast of C90 native int or longer types constants
6124 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
6125 my $cast = $1;
6126 my $const = $2;
6127 if (WARN("TYPECAST_INT_CONSTANT",
6128 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
6129 $fix) {
6130 my $suffix = "";
6131 my $newconst = $const;
6132 $newconst =~ s/${Int_type}$//;
6133 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
6134 if ($cast =~ /\blong\s+long\b/) {
6135 $suffix .= 'LL';
6136 } elsif ($cast =~ /\blong\b/) {
6137 $suffix .= 'L';
6138 }
6139 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
Tom Rinia50f8de2014-02-27 08:27:28 -05006140 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00006141 }
6142
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006143# check for sizeof(&)
6144 if ($line =~ /\bsizeof\s*\(\s*\&/) {
6145 WARN("SIZEOF_ADDRESS",
6146 "sizeof(& should be avoided\n" . $herecurr);
6147 }
6148
Kim Phillips9b7b8372013-02-28 12:53:52 +00006149# check for sizeof without parenthesis
6150 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05006151 if (WARN("SIZEOF_PARENTHESIS",
6152 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
6153 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006154 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Tom Rinia50f8de2014-02-27 08:27:28 -05006155 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00006156 }
6157
Kim Phillips9b7b8372013-02-28 12:53:52 +00006158# check for struct spinlock declarations
6159 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
6160 WARN("USE_SPINLOCK_T",
6161 "struct spinlock should be spinlock_t\n" . $herecurr);
6162 }
6163
Tom Rinia50f8de2014-02-27 08:27:28 -05006164# check for seq_printf uses that could be seq_puts
6165 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
6166 my $fmt = get_quoted_string($line, $rawline);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006167 $fmt =~ s/%%//g;
6168 if ($fmt !~ /%/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05006169 if (WARN("PREFER_SEQ_PUTS",
6170 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6171 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006172 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
6173 }
6174 }
6175 }
6176
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006177# check for vsprintf extension %p<foo> misuses
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006178 if ($perl_version_ok &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006179 defined $stat &&
6180 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
6181 $1 !~ /^_*volatile_*$/) {
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006182 my $stat_real;
6183
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006184 my $lc = $stat =~ tr@\n@@;
6185 $lc = $lc + $linenr;
6186 for (my $count = $linenr; $count <= $lc; $count++) {
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006187 my $specifier;
6188 my $extension;
Tom Rinid2e30332020-06-16 10:29:46 -04006189 my $qualifier;
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006190 my $bad_specifier = "";
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006191 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
6192 $fmt =~ s/%%//g;
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006193
Tom Rinid2e30332020-06-16 10:29:46 -04006194 while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006195 $specifier = $1;
6196 $extension = $2;
Tom Rinid2e30332020-06-16 10:29:46 -04006197 $qualifier = $3;
6198 if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
6199 ($extension eq "f" &&
6200 defined $qualifier && $qualifier !~ /^w/)) {
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006201 $bad_specifier = $specifier;
6202 last;
6203 }
6204 if ($extension eq "x" && !defined($stat_real)) {
6205 if (!defined($stat_real)) {
6206 $stat_real = get_stat_real($linenr, $lc);
6207 }
6208 WARN("VSPRINTF_SPECIFIER_PX",
6209 "Using vsprintf specifier '\%px' potentially exposes the kernel memory layout, if you don't really need the address please consider using '\%p'.\n" . "$here\n$stat_real\n");
6210 }
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006211 }
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006212 if ($bad_specifier ne "") {
6213 my $stat_real = get_stat_real($linenr, $lc);
6214 my $ext_type = "Invalid";
6215 my $use = "";
6216 if ($bad_specifier =~ /p[Ff]/) {
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006217 $use = " - use %pS instead";
6218 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6219 }
6220
6221 WARN("VSPRINTF_POINTER_EXTENSION",
6222 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
Tom Rinia50f8de2014-02-27 08:27:28 -05006223 }
6224 }
6225 }
6226
Kim Phillips9b7b8372013-02-28 12:53:52 +00006227# Check for misused memsets
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006228 if ($perl_version_ok &&
Kim Phillips9b7b8372013-02-28 12:53:52 +00006229 defined $stat &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006230 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Kim Phillips9b7b8372013-02-28 12:53:52 +00006231
6232 my $ms_addr = $2;
6233 my $ms_val = $7;
6234 my $ms_size = $12;
6235
6236 if ($ms_size =~ /^(0x|)0$/i) {
6237 ERROR("MEMSET",
6238 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
6239 } elsif ($ms_size =~ /^(0x|)1$/i) {
6240 WARN("MEMSET",
6241 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6242 }
6243 }
6244
Tom Rinia50f8de2014-02-27 08:27:28 -05006245# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006246# if ($perl_version_ok &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006247# defined $stat &&
6248# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6249# if (WARN("PREFER_ETHER_ADDR_COPY",
6250# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6251# $fix) {
6252# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6253# }
6254# }
6255
6256# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006257# if ($perl_version_ok &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006258# defined $stat &&
6259# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6260# WARN("PREFER_ETHER_ADDR_EQUAL",
6261# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6262# }
6263
6264# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6265# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006266# if ($perl_version_ok &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006267# defined $stat &&
6268# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6269#
6270# my $ms_val = $7;
6271#
6272# if ($ms_val =~ /^(?:0x|)0+$/i) {
6273# if (WARN("PREFER_ETH_ZERO_ADDR",
6274# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6275# $fix) {
6276# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6277# }
6278# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6279# if (WARN("PREFER_ETH_BROADCAST_ADDR",
6280# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6281# $fix) {
6282# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6283# }
6284# }
6285# }
Tom Rinia50f8de2014-02-27 08:27:28 -05006286
Kim Phillips9b7b8372013-02-28 12:53:52 +00006287# typecasts on min/max could be min_t/max_t
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006288 if ($perl_version_ok &&
Kim Phillips9b7b8372013-02-28 12:53:52 +00006289 defined $stat &&
6290 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
6291 if (defined $2 || defined $7) {
6292 my $call = $1;
6293 my $cast1 = deparenthesize($2);
6294 my $arg1 = $3;
6295 my $cast2 = deparenthesize($7);
6296 my $arg2 = $8;
6297 my $cast;
6298
6299 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
6300 $cast = "$cast1 or $cast2";
6301 } elsif ($cast1 ne "") {
6302 $cast = $cast1;
6303 } else {
6304 $cast = $cast2;
6305 }
6306 WARN("MINMAX",
6307 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
6308 }
6309 }
6310
6311# check usleep_range arguments
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006312 if ($perl_version_ok &&
Kim Phillips9b7b8372013-02-28 12:53:52 +00006313 defined $stat &&
6314 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6315 my $min = $1;
6316 my $max = $7;
6317 if ($min eq $max) {
6318 WARN("USLEEP_RANGE",
Tom Rinid2e30332020-06-16 10:29:46 -04006319 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
Kim Phillips9b7b8372013-02-28 12:53:52 +00006320 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6321 $min > $max) {
6322 WARN("USLEEP_RANGE",
Tom Rinid2e30332020-06-16 10:29:46 -04006323 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
Kim Phillips9b7b8372013-02-28 12:53:52 +00006324 }
6325 }
6326
Tom Rinia50f8de2014-02-27 08:27:28 -05006327# check for naked sscanf
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006328 if ($perl_version_ok &&
Tom Rinia50f8de2014-02-27 08:27:28 -05006329 defined $stat &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006330 $line =~ /\bsscanf\b/ &&
Tom Rinia50f8de2014-02-27 08:27:28 -05006331 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6332 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6333 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6334 my $lc = $stat =~ tr@\n@@;
6335 $lc = $lc + $linenr;
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006336 my $stat_real = get_stat_real($linenr, $lc);
Tom Rinia50f8de2014-02-27 08:27:28 -05006337 WARN("NAKED_SSCANF",
6338 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6339 }
6340
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006341# check for simple sscanf that should be kstrto<foo>
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006342 if ($perl_version_ok &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006343 defined $stat &&
6344 $line =~ /\bsscanf\b/) {
6345 my $lc = $stat =~ tr@\n@@;
6346 $lc = $lc + $linenr;
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006347 my $stat_real = get_stat_real($linenr, $lc);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006348 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6349 my $format = $6;
6350 my $count = $format =~ tr@%@%@;
6351 if ($count == 1 &&
6352 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6353 WARN("SSCANF_TO_KSTRTO",
6354 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6355 }
6356 }
6357 }
6358
Tom Rinia50f8de2014-02-27 08:27:28 -05006359# check for new externs in .h files.
6360 if ($realfile =~ /\.h$/ &&
6361 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
6362 if (CHK("AVOID_EXTERNS",
6363 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
6364 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006365 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Tom Rinia50f8de2014-02-27 08:27:28 -05006366 }
6367 }
6368
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006369# check for new externs in .c files.
6370 if ($realfile =~ /\.c$/ && defined $stat &&
6371 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
6372 {
6373 my $function_name = $1;
6374 my $paren_space = $2;
6375
6376 my $s = $stat;
6377 if (defined $cond) {
6378 substr($s, 0, length($cond), '');
6379 }
6380 if ($s =~ /^\s*;/ &&
6381 $function_name ne 'uninitialized_var')
6382 {
6383 WARN("AVOID_EXTERNS",
6384 "externs should be avoided in .c files\n" . $herecurr);
6385 }
6386
6387 if ($paren_space =~ /\n/) {
6388 WARN("FUNCTION_ARGUMENTS",
6389 "arguments for function declarations should follow identifier\n" . $herecurr);
6390 }
6391
6392 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6393 $stat =~ /^.\s*extern\s+/)
6394 {
6395 WARN("AVOID_EXTERNS",
6396 "externs should be avoided in .c files\n" . $herecurr);
6397 }
6398
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006399# check for function declarations that have arguments without identifier names
Tom Rinid2e30332020-06-16 10:29:46 -04006400# while avoiding uninitialized_var(x)
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006401 if (defined $stat &&
Tom Rinid2e30332020-06-16 10:29:46 -04006402 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:($Ident)|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6403 (!defined($1) ||
6404 (defined($1) && $1 ne "uninitialized_var")) &&
6405 $2 ne "void") {
6406 my $args = trim($2);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006407 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6408 my $arg = trim($1);
Tom Rinid2e30332020-06-16 10:29:46 -04006409 if ($arg =~ /^$Type$/ &&
6410 $arg !~ /enum\s+$Ident$/) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006411 WARN("FUNCTION_ARGUMENTS",
6412 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6413 }
6414 }
6415 }
6416
6417# check for function definitions
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006418 if ($perl_version_ok &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006419 defined $stat &&
6420 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6421 $context_function = $1;
6422
6423# check for multiline function definition with misplaced open brace
6424 my $ok = 0;
6425 my $cnt = statement_rawlines($stat);
6426 my $herectx = $here . "\n";
6427 for (my $n = 0; $n < $cnt; $n++) {
6428 my $rl = raw_line($linenr, $n);
6429 $herectx .= $rl . "\n";
6430 $ok = 1 if ($rl =~ /^[ \+]\{/);
6431 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6432 last if $rl =~ /^[ \+].*\{/;
6433 }
6434 if (!$ok) {
6435 ERROR("OPEN_BRACE",
6436 "open brace '{' following function definitions go on the next line\n" . $herectx);
6437 }
6438 }
6439
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006440# checks for new __setup's
6441 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6442 my $name = $1;
6443
6444 if (!grep(/$name/, @setup_docs)) {
6445 CHK("UNDOCUMENTED_SETUP",
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006446 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006447 }
6448 }
6449
Tom Rinid2e30332020-06-16 10:29:46 -04006450# check for pointless casting of alloc functions
6451 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006452 WARN("UNNECESSARY_CASTS",
6453 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6454 }
6455
Tom Rinia50f8de2014-02-27 08:27:28 -05006456# alloc style
6457# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006458 if ($perl_version_ok &&
Tom Rinid2e30332020-06-16 10:29:46 -04006459 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05006460 CHK("ALLOC_SIZEOF_STRUCT",
6461 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6462 }
6463
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006464# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006465 if ($perl_version_ok &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006466 defined $stat &&
6467 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6468 my $oldfunc = $3;
6469 my $a1 = $4;
6470 my $a2 = $10;
6471 my $newfunc = "kmalloc_array";
6472 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
6473 my $r1 = $a1;
6474 my $r2 = $a2;
6475 if ($a1 =~ /^sizeof\s*\S/) {
6476 $r1 = $a2;
6477 $r2 = $a1;
6478 }
6479 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6480 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006481 my $cnt = statement_rawlines($stat);
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006482 my $herectx = get_stat_here($linenr, $cnt, $here);
6483
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006484 if (WARN("ALLOC_WITH_MULTIPLY",
6485 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6486 $cnt == 1 &&
6487 $fix) {
6488 $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;
6489 }
6490 }
6491 }
6492
Tom Rinia50f8de2014-02-27 08:27:28 -05006493# check for krealloc arg reuse
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006494 if ($perl_version_ok &&
6495 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
6496 $1 eq $3) {
Tom Rinia50f8de2014-02-27 08:27:28 -05006497 WARN("KREALLOC_ARG_REUSE",
6498 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6499 }
6500
Kim Phillips9b7b8372013-02-28 12:53:52 +00006501# check for alloc argument mismatch
6502 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6503 WARN("ALLOC_ARRAY_ARGS",
6504 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6505 }
6506
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006507# check for multiple semicolons
6508 if ($line =~ /;\s*;\s*$/) {
Tom Rinia50f8de2014-02-27 08:27:28 -05006509 if (WARN("ONE_SEMICOLON",
6510 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6511 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006512 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
6513 }
6514 }
6515
6516# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6517 if ($realfile !~ m@^include/uapi/@ &&
6518 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
6519 my $ull = "";
6520 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6521 if (CHK("BIT_MACRO",
6522 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6523 $fix) {
6524 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
Tom Rinia50f8de2014-02-27 08:27:28 -05006525 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006526 }
6527
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006528# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6529 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6530 my $config = $1;
6531 if (WARN("PREFER_IS_ENABLED",
6532 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6533 $fix) {
6534 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6535 }
6536 }
6537
Robert P. J. Dayc5b1e5d2016-09-07 14:27:59 -04006538# check for case / default statements not preceded by break/fallthrough/switch
Tom Rinia50f8de2014-02-27 08:27:28 -05006539 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6540 my $has_break = 0;
6541 my $has_statement = 0;
6542 my $count = 0;
6543 my $prevline = $linenr;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006544 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Tom Rinia50f8de2014-02-27 08:27:28 -05006545 $prevline--;
6546 my $rline = $rawlines[$prevline - 1];
6547 my $fline = $lines[$prevline - 1];
6548 last if ($fline =~ /^\@\@/);
6549 next if ($fline =~ /^\-/);
6550 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6551 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6552 next if ($fline =~ /^.[\s$;]*$/);
6553 $has_statement = 1;
6554 $count++;
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006555 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
Tom Rinia50f8de2014-02-27 08:27:28 -05006556 }
6557 if (!$has_break && $has_statement) {
6558 WARN("MISSING_BREAK",
Robert P. J. Dayc5b1e5d2016-09-07 14:27:59 -04006559 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
Tom Rinia50f8de2014-02-27 08:27:28 -05006560 }
6561 }
6562
Tom Rinid2e30332020-06-16 10:29:46 -04006563# check for /* fallthrough */ like comment, prefer fallthrough;
6564 my @fallthroughs = (
6565 'fallthrough',
6566 '@fallthrough@',
6567 'lint -fallthrough[ \t]*',
6568 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)',
6569 '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?',
6570 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6571 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6572 );
6573 if ($raw_comment ne '') {
6574 foreach my $ft (@fallthroughs) {
6575 if ($raw_comment =~ /$ft/) {
6576 my $msg_level = \&WARN;
6577 $msg_level = \&CHK if ($file);
6578 &{$msg_level}("PREFER_FALLTHROUGH",
6579 "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr);
6580 last;
6581 }
6582 }
6583 }
6584
Kim Phillips9b7b8372013-02-28 12:53:52 +00006585# check for switch/default statements without a break;
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006586 if ($perl_version_ok &&
Kim Phillips9b7b8372013-02-28 12:53:52 +00006587 defined $stat &&
6588 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
Kim Phillips9b7b8372013-02-28 12:53:52 +00006589 my $cnt = statement_rawlines($stat);
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006590 my $herectx = get_stat_here($linenr, $cnt, $here);
6591
Kim Phillips9b7b8372013-02-28 12:53:52 +00006592 WARN("DEFAULT_NO_BREAK",
6593 "switch default: should use break\n" . $herectx);
Eric Nelson9c7c24f2012-05-02 20:32:18 -07006594 }
6595
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006596# check for gcc specific __FUNCTION__
Tom Rinia50f8de2014-02-27 08:27:28 -05006597 if ($line =~ /\b__FUNCTION__\b/) {
6598 if (WARN("USE_FUNC",
6599 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6600 $fix) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006601 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Tom Rinia50f8de2014-02-27 08:27:28 -05006602 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006603 }
6604
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006605# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6606 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6607 ERROR("DATE_TIME",
6608 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6609 }
6610
Kim Phillips9b7b8372013-02-28 12:53:52 +00006611# check for use of yield()
6612 if ($line =~ /\byield\s*\(\s*\)/) {
6613 WARN("YIELD",
6614 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6615 }
6616
Tom Rinia50f8de2014-02-27 08:27:28 -05006617# check for comparisons against true and false
6618 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6619 my $lead = $1;
6620 my $arg = $2;
6621 my $test = $3;
6622 my $otype = $4;
6623 my $trail = $5;
6624 my $op = "!";
6625
6626 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6627
6628 my $type = lc($otype);
6629 if ($type =~ /^(?:true|false)$/) {
6630 if (("$test" eq "==" && "$type" eq "true") ||
6631 ("$test" eq "!=" && "$type" eq "false")) {
6632 $op = "";
6633 }
6634
6635 CHK("BOOL_COMPARISON",
6636 "Using comparison to $otype is error prone\n" . $herecurr);
6637
6638## maybe suggesting a correct construct would better
6639## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6640
6641 }
6642 }
6643
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006644# check for semaphores initialized locked
6645 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
6646 WARN("CONSIDER_COMPLETION",
6647 "consider using a completion\n" . $herecurr);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006648 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00006649
6650# recommend kstrto* over simple_strto* and strict_strto*
6651 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006652 WARN("CONSIDER_KSTRTO",
Kim Phillips9b7b8372013-02-28 12:53:52 +00006653 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006654 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00006655
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006656# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006657 if ($line =~ /^.\s*__initcall\s*\(/) {
6658 WARN("USE_DEVICE_INITCALL",
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006659 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006660 }
Kim Phillips9b7b8372013-02-28 12:53:52 +00006661
Tom Rinid2e30332020-06-16 10:29:46 -04006662# check for spin_is_locked(), suggest lockdep instead
6663 if ($line =~ /\bspin_is_locked\(/) {
6664 WARN("USE_LOCKDEP",
6665 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6666 }
6667
6668# check for deprecated apis
6669 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
6670 my $deprecated_api = $1;
6671 my $new_api = $deprecated_apis{$deprecated_api};
6672 WARN("DEPRECATED_API",
6673 "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
6674 }
6675
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006676# check for various structs that are normally const (ops, kgdb, device_tree)
6677# and avoid what seem like struct definitions 'struct foo {'
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006678 if ($line !~ /\bconst\b/ &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006679 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006680 WARN("CONST_STRUCT",
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006681 "struct $1 should normally be const\n" . $herecurr);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006682 }
6683
6684# use of NR_CPUS is usually wrong
6685# ignore definitions of NR_CPUS and usage to define arrays as likely right
6686 if ($line =~ /\bNR_CPUS\b/ &&
6687 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6688 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
6689 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6690 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6691 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
6692 {
6693 WARN("NR_CPUS",
6694 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6695 }
6696
Tom Rinia50f8de2014-02-27 08:27:28 -05006697# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6698 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6699 ERROR("DEFINE_ARCH_HAS",
6700 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6701 }
6702
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006703# likely/unlikely comparisons similar to "(likely(foo) > 0)"
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006704 if ($perl_version_ok &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006705 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6706 WARN("LIKELY_MISUSE",
6707 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006708 }
6709
Tom Rinid2e30332020-06-16 10:29:46 -04006710# nested likely/unlikely calls
6711 if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
6712 WARN("LIKELY_MISUSE",
6713 "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
6714 }
6715
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006716# whine mightly about in_atomic
6717 if ($line =~ /\bin_atomic\s*\(/) {
6718 if ($realfile =~ m@^drivers/@) {
6719 ERROR("IN_ATOMIC",
6720 "do not use in_atomic in drivers\n" . $herecurr);
6721 } elsif ($realfile !~ m@^kernel/@) {
6722 WARN("IN_ATOMIC",
6723 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
6724 }
6725 }
6726
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006727# check for mutex_trylock_recursive usage
6728 if ($line =~ /mutex_trylock_recursive/) {
6729 ERROR("LOCKING",
6730 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6731 }
6732
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006733# check for lockdep_set_novalidate_class
6734 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6735 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6736 if ($realfile !~ m@^kernel/lockdep@ &&
6737 $realfile !~ m@^include/linux/lockdep@ &&
6738 $realfile !~ m@^drivers/base/core@) {
6739 ERROR("LOCKDEP",
6740 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
6741 }
6742 }
6743
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006744 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6745 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006746 WARN("EXPORTED_WORLD_WRITABLE",
6747 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6748 }
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006749
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006750# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6751# and whether or not function naming is typical and if
6752# DEVICE_ATTR permissions uses are unusual too
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006753 if ($perl_version_ok &&
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006754 defined $stat &&
6755 $stat =~ /\bDEVICE_ATTR\s*\(\s*(\w+)\s*,\s*\(?\s*(\s*(?:${multi_mode_perms_string_search}|0[0-7]{3,3})\s*)\s*\)?\s*,\s*(\w+)\s*,\s*(\w+)\s*\)/) {
6756 my $var = $1;
6757 my $perms = $2;
6758 my $show = $3;
6759 my $store = $4;
6760 my $octal_perms = perms_to_octal($perms);
6761 if ($show =~ /^${var}_show$/ &&
6762 $store =~ /^${var}_store$/ &&
6763 $octal_perms eq "0644") {
6764 if (WARN("DEVICE_ATTR_RW",
6765 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6766 $fix) {
6767 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6768 }
6769 } elsif ($show =~ /^${var}_show$/ &&
6770 $store =~ /^NULL$/ &&
6771 $octal_perms eq "0444") {
6772 if (WARN("DEVICE_ATTR_RO",
6773 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6774 $fix) {
6775 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6776 }
6777 } elsif ($show =~ /^NULL$/ &&
6778 $store =~ /^${var}_store$/ &&
6779 $octal_perms eq "0200") {
6780 if (WARN("DEVICE_ATTR_WO",
6781 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6782 $fix) {
6783 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6784 }
6785 } elsif ($octal_perms eq "0644" ||
6786 $octal_perms eq "0444" ||
6787 $octal_perms eq "0200") {
6788 my $newshow = "$show";
6789 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6790 my $newstore = $store;
6791 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6792 my $rename = "";
6793 if ($show ne $newshow) {
6794 $rename .= " '$show' to '$newshow'";
6795 }
6796 if ($store ne $newstore) {
6797 $rename .= " '$store' to '$newstore'";
6798 }
6799 WARN("DEVICE_ATTR_FUNCTIONS",
6800 "Consider renaming function(s)$rename\n" . $herecurr);
6801 } else {
6802 WARN("DEVICE_ATTR_PERMS",
6803 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6804 }
6805 }
6806
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006807# Mode permission misuses where it seems decimal should be octal
6808# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006809# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6810# specific definition of not visible in sysfs.
6811# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6812# use the default permissions
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006813 if ($perl_version_ok &&
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006814 defined $stat &&
6815 $line =~ /$mode_perms_search/) {
6816 foreach my $entry (@mode_permission_funcs) {
6817 my $func = $entry->[0];
6818 my $arg_pos = $entry->[1];
6819
6820 my $lc = $stat =~ tr@\n@@;
6821 $lc = $lc + $linenr;
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006822 my $stat_real = get_stat_real($linenr, $lc);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006823
6824 my $skip_args = "";
6825 if ($arg_pos > 1) {
6826 $arg_pos--;
6827 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6828 }
6829 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
6830 if ($stat =~ /$test/) {
6831 my $val = $1;
6832 $val = $6 if ($skip_args ne "");
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006833 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6834 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6835 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006836 ERROR("NON_OCTAL_PERMISSIONS",
6837 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
6838 }
6839 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6840 ERROR("EXPORTED_WORLD_WRITABLE",
6841 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6842 }
6843 }
6844 }
6845 }
6846
6847# check for uses of S_<PERMS> that could be octal for readability
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006848 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
6849 my $oval = $1;
6850 my $octal = perms_to_octal($oval);
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006851 if (WARN("SYMBOLIC_PERMS",
6852 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6853 $fix) {
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006854 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006855 }
6856 }
6857
6858# validate content of MODULE_LICENSE against list from include/linux/module.h
6859 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6860 my $extracted_string = get_quoted_string($line, $rawline);
6861 my $valid_licenses = qr{
6862 GPL|
6863 GPL\ v2|
6864 GPL\ and\ additional\ rights|
6865 Dual\ BSD/GPL|
6866 Dual\ MIT/GPL|
6867 Dual\ MPL/GPL|
6868 Proprietary
6869 }x;
6870 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6871 WARN("MODULE_LICENSE",
6872 "unknown module license " . $extracted_string . "\n" . $herecurr);
6873 }
6874 }
Tom Rinid2e30332020-06-16 10:29:46 -04006875
6876# check for sysctl duplicate constants
6877 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
6878 WARN("DUPLICATED_SYSCTL_CONST",
6879 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6880 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006881 }
6882
6883 # If we have no input at all, then there is nothing to report on
6884 # so just keep quiet.
6885 if ($#rawlines == -1) {
6886 exit(0);
6887 }
6888
6889 # In mailback mode only produce a report in the negative, for
6890 # things that appear to be patches.
6891 if ($mailback && ($clean == 1 || !$is_patch)) {
6892 exit(0);
6893 }
6894
6895 # This is not a patch, and we are are in 'no-patch' mode so
6896 # just keep quiet.
6897 if (!$chk_patch && !$is_patch) {
6898 exit(0);
6899 }
6900
Heinrich Schuchardtc664f0a2018-04-04 15:39:20 +02006901 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006902 ERROR("NOT_UNIFIED_DIFF",
6903 "Does not appear to be a unified-diff format patch\n");
6904 }
Heinrich Schuchardtd46efeb2019-10-19 09:06:38 +02006905 if ($is_patch && $has_commit_log && $chk_signoff) {
6906 if ($signoff == 0) {
6907 ERROR("MISSING_SIGN_OFF",
6908 "Missing Signed-off-by: line(s)\n");
6909 } elsif (!$authorsignoff) {
6910 WARN("NO_AUTHOR_SIGN_OFF",
6911 "Missing Signed-off-by: line by nominal patch author '$author'\n");
6912 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006913 }
6914
6915 print report_dump();
6916 if ($summary && !($clean == 1 && $quiet == 1)) {
6917 print "$filename " if ($summary_file);
6918 print "total: $cnt_error errors, $cnt_warn warnings, " .
6919 (($check)? "$cnt_chk checks, " : "") .
6920 "$cnt_lines lines checked\n";
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006921 }
6922
6923 if ($quiet == 0) {
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006924 # If there were any defects found and not already fixing them
6925 if (!$clean and !$fix) {
6926 print << "EOM"
Kim Phillips9b7b8372013-02-28 12:53:52 +00006927
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006928NOTE: For some of the reported defects, checkpatch may be able to
6929 mechanically convert to the typical style using --fix or --fix-inplace.
6930EOM
Kim Phillips9b7b8372013-02-28 12:53:52 +00006931 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006932 # If there were whitespace errors which cleanpatch can fix
6933 # then suggest that.
6934 if ($rpt_cleaners) {
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006935 $rpt_cleaners = 0;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006936 print << "EOM"
6937
6938NOTE: Whitespace errors detected.
6939 You may wish to use scripts/cleanpatch or scripts/cleanfile
6940EOM
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006941 }
6942 }
6943
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006944 if ($clean == 0 && $fix &&
6945 ("@rawlines" ne "@fixed" ||
6946 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Tom Rinia50f8de2014-02-27 08:27:28 -05006947 my $newfile = $filename;
6948 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6949 my $linecount = 0;
6950 my $f;
6951
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006952 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6953
Tom Rinia50f8de2014-02-27 08:27:28 -05006954 open($f, '>', $newfile)
6955 or die "$P: Can't open $newfile for write\n";
6956 foreach my $fixed_line (@fixed) {
6957 $linecount++;
6958 if ($file) {
6959 if ($linecount > 3) {
6960 $fixed_line =~ s/^\+//;
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006961 print $f $fixed_line . "\n";
Tom Rinia50f8de2014-02-27 08:27:28 -05006962 }
6963 } else {
6964 print $f $fixed_line . "\n";
6965 }
6966 }
6967 close($f);
6968
6969 if (!$quiet) {
6970 print << "EOM";
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006971
Tom Rinia50f8de2014-02-27 08:27:28 -05006972Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6973
6974Do _NOT_ trust the results written to this file.
6975Do _NOT_ submit these changes without inspecting them for correctness.
6976
6977This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6978No warranties, expressed or implied...
Tom Rinia50f8de2014-02-27 08:27:28 -05006979EOM
6980 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006981 }
6982
Heinrich Schuchardt8716f582017-09-12 09:57:45 +02006983 if ($quiet == 0) {
6984 print "\n";
6985 if ($clean == 1) {
6986 print "$vname has no obvious style problems and is ready for submission.\n";
6987 } else {
6988 print "$vname has style problems, please review.\n";
6989 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006990 }
Joe Hershbergerba2beb52011-10-18 10:06:59 +00006991 return $clean;
6992}