blob: 1fa089d883339ca1040f308980502b47b53225b0 [file] [log] [blame]
pengzhao.liua923dea2023-06-25 09:58:20 +08001#!/usr/bin/env perl
2# SPDX-License-Identifier: GPL-2.0
3#
4# (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>
8# (c) 2010-2018 Joe Perches <joe@perches.com>
9
10use strict;
11use warnings;
12use POSIX;
13use File::Basename;
14use Cwd 'abs_path';
15use Term::ANSIColor qw(:constants);
16use Encode qw(decode encode);
17
18my $P = $0;
19my $D = dirname(abs_path($P));
20
21my $V = '0.32';
22
23use Getopt::Long qw(:config no_auto_abbrev);
24
25my $quiet = 0;
26my $verbose = 0;
27my %verbose_messages = ();
28my %verbose_emitted = ();
29my $tree = 1;
30my $chk_signoff = 1;
31my $chk_patch = 1;
32my $tst_only;
33my $emacs = 0;
34my $terse = 0;
35my $showfile = 0;
36my $file = 0;
37my $git = 0;
38my %git_commits = ();
39my $check = 0;
40my $check_orig = 0;
41my $summary = 1;
42my $mailback = 0;
43my $summary_file = 0;
44my $show_types = 0;
45my $list_types = 0;
46my $fix = 0;
47my $fix_inplace = 0;
48my $root;
49my $gitroot = $ENV{'GIT_DIR'};
50$gitroot = ".git" if !defined($gitroot);
51my %debug;
52my %camelcase = ();
53my %use_type = ();
54my @use = ();
55my %ignore_type = ();
56my @ignore = ();
57my $help = 0;
58my $configuration_file = ".checkpatch.conf";
59my $max_line_length = 100;
60my $ignore_perl_version = 0;
61my $minimum_perl_version = 5.10.0;
62my $min_conf_desc_length = 2;
63my $spelling_file = "$D/spelling.txt";
64my $codespell = 0;
65my $codespellfile = "/usr/share/codespell/dictionary.txt";
66my $conststructsfile = "$D/const_structs.checkpatch";
67my $docsfile = "$D/../Documentation/dev-tools/checkpatch.rst";
68my $typedefsfile;
69my $color = "auto";
70my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE
71# git output parsing needs US English output, so first set backtick child process LANGUAGE
72my $git_command ='export LANGUAGE=en_US.UTF-8; git';
73my $tabsize = 8;
74my ${CONFIG_} = "CONFIG_";
75
76sub help {
77 my ($exitcode) = @_;
78
79 print << "EOM";
80Usage: $P [OPTION]... [FILE]...
81Version: $V
82
83Options:
84 -q, --quiet quiet
85 -v, --verbose verbose mode
86 --no-tree run without a kernel tree
87 --no-signoff do not check for 'Signed-off-by' line
88 --patch treat FILE as patchfile (default)
89 --emacs emacs compile window format
90 --terse one line per report
91 --showfile emit diffed file position, not input file position
92 -g, --git treat FILE as a single commit or git revision range
93 single git commit with:
94 <rev>
95 <rev>^
96 <rev>~n
97 multiple git commits with:
98 <rev1>..<rev2>
99 <rev1>...<rev2>
100 <rev>-<count>
101 git merges are ignored
102 -f, --file treat FILE as regular source file
103 --subjective, --strict enable more subjective tests
104 --list-types list the possible message types
105 --types TYPE(,TYPE2...) show only these comma separated message types
106 --ignore TYPE(,TYPE2...) ignore various comma separated message types
107 --show-types show the specific message type in the output
108 --max-line-length=n set the maximum line length, if exceeded, warn
109 --min-conf-desc-length=n set the min description length, if shorter, warn
110 --tab-size=n set the number of spaces for tab (default $tabsize)
111 --root=PATH PATH to the kernel tree root
112 --no-summary suppress the per-file summary
113 --mailback only produce a report in case of warnings/errors
114 --summary-file include the filename in summary
115 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
116 'values', 'possible', 'type', and 'attr' (default
117 is all off)
118 --test-only=WORD report only warnings/errors containing WORD
119 literally
120 --fix EXPERIMENTAL - may create horrible results
121 If correctable single-line errors exist, create
122 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
123 with potential errors corrected to the preferred
124 checkpatch style
125 --fix-inplace EXPERIMENTAL - may create horrible results
126 Is the same as --fix, but overwrites the input
127 file. It's your fault if there's no backup or git
128 --ignore-perl-version override checking of perl version. expect
129 runtime errors.
130 --codespell Use the codespell dictionary for spelling/typos
131 (default:/usr/share/codespell/dictionary.txt)
132 --codespellfile Use this codespell dictionary
133 --typedefsfile Read additional types from this file
134 --color[=WHEN] Use colors 'always', 'never', or only when output
135 is a terminal ('auto'). Default is 'auto'.
136 --kconfig-prefix=WORD use WORD as a prefix for Kconfig symbols (default
137 ${CONFIG_})
138 -h, --help, --version display this help and exit
139
140When FILE is - read standard input.
141EOM
142
143 exit($exitcode);
144}
145
146sub uniq {
147 my %seen;
148 return grep { !$seen{$_}++ } @_;
149}
150
151sub list_types {
152 my ($exitcode) = @_;
153
154 my $count = 0;
155
156 local $/ = undef;
157
158 open(my $script, '<', abs_path($P)) or
159 die "$P: Can't read '$P' $!\n";
160
161 my $text = <$script>;
162 close($script);
163
164 my %types = ();
165 # Also catch when type or level is passed through a variable
166 while ($text =~ /(?:(\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
167 if (defined($1)) {
168 if (exists($types{$2})) {
169 $types{$2} .= ",$1" if ($types{$2} ne $1);
170 } else {
171 $types{$2} = $1;
172 }
173 } else {
174 $types{$2} = "UNDETERMINED";
175 }
176 }
177
178 print("#\tMessage type\n\n");
179 if ($color) {
180 print(" ( Color coding: ");
181 print(RED . "ERROR" . RESET);
182 print(" | ");
183 print(YELLOW . "WARNING" . RESET);
184 print(" | ");
185 print(GREEN . "CHECK" . RESET);
186 print(" | ");
187 print("Multiple levels / Undetermined");
188 print(" )\n\n");
189 }
190
191 foreach my $type (sort keys %types) {
192 my $orig_type = $type;
193 if ($color) {
194 my $level = $types{$type};
195 if ($level eq "ERROR") {
196 $type = RED . $type . RESET;
197 } elsif ($level eq "WARN") {
198 $type = YELLOW . $type . RESET;
199 } elsif ($level eq "CHK") {
200 $type = GREEN . $type . RESET;
201 }
202 }
203 print(++$count . "\t" . $type . "\n");
204 if ($verbose && exists($verbose_messages{$orig_type})) {
205 my $message = $verbose_messages{$orig_type};
206 $message =~ s/\n/\n\t/g;
207 print("\t" . $message . "\n\n");
208 }
209 }
210
211 exit($exitcode);
212}
213
214my $conf = which_conf($configuration_file);
215if (-f $conf) {
216 my @conf_args;
217 open(my $conffile, '<', "$conf")
218 or warn "$P: Can't find a readable $configuration_file file $!\n";
219
220 while (<$conffile>) {
221 my $line = $_;
222
223 $line =~ s/\s*\n?$//g;
224 $line =~ s/^\s*//g;
225 $line =~ s/\s+/ /g;
226
227 next if ($line =~ m/^\s*#/);
228 next if ($line =~ m/^\s*$/);
229
230 my @words = split(" ", $line);
231 foreach my $word (@words) {
232 last if ($word =~ m/^#/);
233 push (@conf_args, $word);
234 }
235 }
236 close($conffile);
237 unshift(@ARGV, @conf_args) if @conf_args;
238}
239
240sub load_docs {
241 open(my $docs, '<', "$docsfile")
242 or warn "$P: Can't read the documentation file $docsfile $!\n";
243
244 my $type = '';
245 my $desc = '';
246 my $in_desc = 0;
247
248 while (<$docs>) {
249 chomp;
250 my $line = $_;
251 $line =~ s/\s+$//;
252
253 if ($line =~ /^\s*\*\*(.+)\*\*$/) {
254 if ($desc ne '') {
255 $verbose_messages{$type} = trim($desc);
256 }
257 $type = $1;
258 $desc = '';
259 $in_desc = 1;
260 } elsif ($in_desc) {
261 if ($line =~ /^(?:\s{4,}|$)/) {
262 $line =~ s/^\s{4}//;
263 $desc .= $line;
264 $desc .= "\n";
265 } else {
266 $verbose_messages{$type} = trim($desc);
267 $type = '';
268 $desc = '';
269 $in_desc = 0;
270 }
271 }
272 }
273
274 if ($desc ne '') {
275 $verbose_messages{$type} = trim($desc);
276 }
277 close($docs);
278}
279
280# Perl's Getopt::Long allows options to take optional arguments after a space.
281# Prevent --color by itself from consuming other arguments
282foreach (@ARGV) {
283 if ($_ eq "--color" || $_ eq "-color") {
284 $_ = "--color=$color";
285 }
286}
287
288GetOptions(
289 'q|quiet+' => \$quiet,
290 'v|verbose!' => \$verbose,
291 'tree!' => \$tree,
292 'signoff!' => \$chk_signoff,
293 'patch!' => \$chk_patch,
294 'emacs!' => \$emacs,
295 'terse!' => \$terse,
296 'showfile!' => \$showfile,
297 'f|file!' => \$file,
298 'g|git!' => \$git,
299 'subjective!' => \$check,
300 'strict!' => \$check,
301 'ignore=s' => \@ignore,
302 'types=s' => \@use,
303 'show-types!' => \$show_types,
304 'list-types!' => \$list_types,
305 'max-line-length=i' => \$max_line_length,
306 'min-conf-desc-length=i' => \$min_conf_desc_length,
307 'tab-size=i' => \$tabsize,
308 'root=s' => \$root,
309 'summary!' => \$summary,
310 'mailback!' => \$mailback,
311 'summary-file!' => \$summary_file,
312 'fix!' => \$fix,
313 'fix-inplace!' => \$fix_inplace,
314 'ignore-perl-version!' => \$ignore_perl_version,
315 'debug=s' => \%debug,
316 'test-only=s' => \$tst_only,
317 'codespell!' => \$codespell,
318 'codespellfile=s' => \$codespellfile,
319 'typedefsfile=s' => \$typedefsfile,
320 'color=s' => \$color,
321 'no-color' => \$color, #keep old behaviors of -nocolor
322 'nocolor' => \$color, #keep old behaviors of -nocolor
323 'kconfig-prefix=s' => \${CONFIG_},
324 'h|help' => \$help,
325 'version' => \$help
326) or help(1);
327
328help(0) if ($help);
329
330die "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix));
331die "$P: --verbose cannot be used with --terse\n" if ($verbose && $terse);
332
333if ($color =~ /^[01]$/) {
334 $color = !$color;
335} elsif ($color =~ /^always$/i) {
336 $color = 1;
337} elsif ($color =~ /^never$/i) {
338 $color = 0;
339} elsif ($color =~ /^auto$/i) {
340 $color = (-t STDOUT);
341} else {
342 die "$P: Invalid color mode: $color\n";
343}
344
345load_docs() if ($verbose);
346list_types(0) if ($list_types);
347
348$fix = 1 if ($fix_inplace);
349$check_orig = $check;
350
351my $exit = 0;
352
353my $perl_version_ok = 1;
354if ($^V && $^V lt $minimum_perl_version) {
355 $perl_version_ok = 0;
356 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
357 exit(1) if (!$ignore_perl_version);
358}
359
360#if no filenames are given, push '-' to read patch from stdin
361if ($#ARGV < 0) {
362 push(@ARGV, '-');
363}
364
365# skip TAB size 1 to avoid additional checks on $tabsize - 1
366die "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2);
367
368sub hash_save_array_words {
369 my ($hashRef, $arrayRef) = @_;
370
371 my @array = split(/,/, join(',', @$arrayRef));
372 foreach my $word (@array) {
373 $word =~ s/\s*\n?$//g;
374 $word =~ s/^\s*//g;
375 $word =~ s/\s+/ /g;
376 $word =~ tr/[a-z]/[A-Z]/;
377
378 next if ($word =~ m/^\s*#/);
379 next if ($word =~ m/^\s*$/);
380
381 $hashRef->{$word}++;
382 }
383}
384
385sub hash_show_words {
386 my ($hashRef, $prefix) = @_;
387
388 if (keys %$hashRef) {
389 print "\nNOTE: $prefix message types:";
390 foreach my $word (sort keys %$hashRef) {
391 print " $word";
392 }
393 print "\n";
394 }
395}
396
397hash_save_array_words(\%ignore_type, \@ignore);
398hash_save_array_words(\%use_type, \@use);
399
400my $dbg_values = 0;
401my $dbg_possible = 0;
402my $dbg_type = 0;
403my $dbg_attr = 0;
404for my $key (keys %debug) {
405 ## no critic
406 eval "\${dbg_$key} = '$debug{$key}';";
407 die "$@" if ($@);
408}
409
410my $rpt_cleaners = 0;
411
412if ($terse) {
413 $emacs = 1;
414 $quiet++;
415}
416
417if ($tree) {
418 if (defined $root) {
419 if (!top_of_kernel_tree($root)) {
420 die "$P: $root: --root does not point at a valid tree\n";
421 }
422 } else {
423 if (top_of_kernel_tree('.')) {
424 $root = '.';
425 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
426 top_of_kernel_tree($1)) {
427 $root = $1;
428 }
429 }
430
431 if (!defined $root) {
432# print "Must be run from the top-level dir. of a kernel tree\n";
433# exit(2);
434 }
435}
436
437my $emitted_corrupt = 0;
438
439our $Ident = qr{
440 [A-Za-z_][A-Za-z\d_]*
441 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
442 }x;
443our $Storage = qr{extern|static|asmlinkage};
444our $Sparse = qr{
445 __user|
446 __kernel|
447 __force|
448 __iomem|
449 __must_check|
450 __kprobes|
451 __ref|
452 __refconst|
453 __refdata|
454 __rcu|
455 __private
456 }x;
457our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
458our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
459our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
460our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
461our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
462
463# Notes to $Attribute:
464# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
465our $Attribute = qr{
466 const|
467 volatile|
468 __percpu|
469 __nocast|
470 __safe|
471 __bitwise|
472 __packed__|
473 __packed2__|
474 __naked|
475 __maybe_unused|
476 __always_unused|
477 __noreturn|
478 __used|
479 __cold|
480 __pure|
481 __noclone|
482 __deprecated|
483 __read_mostly|
484 __ro_after_init|
485 __kprobes|
486 $InitAttribute|
487 ____cacheline_aligned|
488 ____cacheline_aligned_in_smp|
489 ____cacheline_internodealigned_in_smp|
490 __weak|
491 __alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\)
492 }x;
493our $Modifier;
494our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
495our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
496our $Lval = qr{$Ident(?:$Member)*};
497
498our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
499our $Binary = qr{(?i)0b[01]+$Int_type?};
500our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
501our $Int = qr{[0-9]+$Int_type?};
502our $Octal = qr{0[0-7]+$Int_type?};
503our $String = qr{(?:\b[Lu])?"[X\t]*"};
504our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
505our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
506our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
507our $Float = qr{$Float_hex|$Float_dec|$Float_int};
508our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
509our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
510our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
511our $Arithmetic = qr{\+|-|\*|\/|%};
512our $Operators = qr{
513 <=|>=|==|!=|
514 =>|->|<<|>>|<|>|!|~|
515 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
516 }x;
517
518our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
519
520our $BasicType;
521our $NonptrType;
522our $NonptrTypeMisordered;
523our $NonptrTypeWithAttr;
524our $Type;
525our $TypeMisordered;
526our $Declare;
527our $DeclareMisordered;
528
529our $NON_ASCII_UTF8 = qr{
530 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
531 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
532 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
533 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
534 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
535 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
536 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
537}x;
538
539our $UTF8 = qr{
540 [\x09\x0A\x0D\x20-\x7E] # ASCII
541 | $NON_ASCII_UTF8
542}x;
543
544our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
545our $typeOtherOSTypedefs = qr{(?x:
546 u_(?:char|short|int|long) | # bsd
547 u(?:nchar|short|int|long) # sysv
548)};
549our $typeKernelTypedefs = qr{(?x:
550 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
551 atomic_t
552)};
553our $typeTypedefs = qr{(?x:
554 $typeC99Typedefs\b|
555 $typeOtherOSTypedefs\b|
556 $typeKernelTypedefs\b
557)};
558
559our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
560
561our $logFunctions = qr{(?x:
562 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
563 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
564 TP_printk|
565 WARN(?:_RATELIMIT|_ONCE|)|
566 panic|
567 MODULE_[A-Z_]+|
568 seq_vprintf|seq_printf|seq_puts
569)};
570
571our $allocFunctions = qr{(?x:
572 (?:(?:devm_)?
573 (?:kv|k|v)[czm]alloc(?:_array)?(?:_node)? |
574 kstrdup(?:_const)? |
575 kmemdup(?:_nul)?) |
576 (?:\w+)?alloc_skb(?:_ip_align)? |
577 # dev_alloc_skb/netdev_alloc_skb, et al
578 dma_alloc_coherent
579)};
580
581our $signature_tags = qr{(?xi:
582 Signed-off-by:|
583 Co-developed-by:|
584 Acked-by:|
585 Tested-by:|
586 Reviewed-by:|
587 Reported-by:|
588 Suggested-by:|
589 To:|
590 Cc:
591)};
592
593our $tracing_logging_tags = qr{(?xi:
594 [=-]*> |
595 <[=-]* |
596 \[ |
597 \] |
598 start |
599 called |
600 entered |
601 entry |
602 enter |
603 in |
604 inside |
605 here |
606 begin |
607 exit |
608 end |
609 done |
610 leave |
611 completed |
612 out |
613 return |
614 [\.\!:\s]*
615)};
616
617sub edit_distance_min {
618 my (@arr) = @_;
619 my $len = scalar @arr;
620 if ((scalar @arr) < 1) {
621 # if underflow, return
622 return;
623 }
624 my $min = $arr[0];
625 for my $i (0 .. ($len-1)) {
626 if ($arr[$i] < $min) {
627 $min = $arr[$i];
628 }
629 }
630 return $min;
631}
632
633sub get_edit_distance {
634 my ($str1, $str2) = @_;
635 $str1 = lc($str1);
636 $str2 = lc($str2);
637 $str1 =~ s/-//g;
638 $str2 =~ s/-//g;
639 my $len1 = length($str1);
640 my $len2 = length($str2);
641 # two dimensional array storing minimum edit distance
642 my @distance;
643 for my $i (0 .. $len1) {
644 for my $j (0 .. $len2) {
645 if ($i == 0) {
646 $distance[$i][$j] = $j;
647 } elsif ($j == 0) {
648 $distance[$i][$j] = $i;
649 } elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) {
650 $distance[$i][$j] = $distance[$i - 1][$j - 1];
651 } else {
652 my $dist1 = $distance[$i][$j - 1]; #insert distance
653 my $dist2 = $distance[$i - 1][$j]; # remove
654 my $dist3 = $distance[$i - 1][$j - 1]; #replace
655 $distance[$i][$j] = 1 + edit_distance_min($dist1, $dist2, $dist3);
656 }
657 }
658 }
659 return $distance[$len1][$len2];
660}
661
662sub find_standard_signature {
663 my ($sign_off) = @_;
664 my @standard_signature_tags = (
665 'Signed-off-by:', 'Co-developed-by:', 'Acked-by:', 'Tested-by:',
666 'Reviewed-by:', 'Reported-by:', 'Suggested-by:'
667 );
668 foreach my $signature (@standard_signature_tags) {
669 return $signature if (get_edit_distance($sign_off, $signature) <= 2);
670 }
671
672 return "";
673}
674
675our @typeListMisordered = (
676 qr{char\s+(?:un)?signed},
677 qr{int\s+(?:(?:un)?signed\s+)?short\s},
678 qr{int\s+short(?:\s+(?:un)?signed)},
679 qr{short\s+int(?:\s+(?:un)?signed)},
680 qr{(?:un)?signed\s+int\s+short},
681 qr{short\s+(?:un)?signed},
682 qr{long\s+int\s+(?:un)?signed},
683 qr{int\s+long\s+(?:un)?signed},
684 qr{long\s+(?:un)?signed\s+int},
685 qr{int\s+(?:un)?signed\s+long},
686 qr{int\s+(?:un)?signed},
687 qr{int\s+long\s+long\s+(?:un)?signed},
688 qr{long\s+long\s+int\s+(?:un)?signed},
689 qr{long\s+long\s+(?:un)?signed\s+int},
690 qr{long\s+long\s+(?:un)?signed},
691 qr{long\s+(?:un)?signed},
692);
693
694our @typeList = (
695 qr{void},
696 qr{(?:(?:un)?signed\s+)?char},
697 qr{(?:(?:un)?signed\s+)?short\s+int},
698 qr{(?:(?:un)?signed\s+)?short},
699 qr{(?:(?:un)?signed\s+)?int},
700 qr{(?:(?:un)?signed\s+)?long\s+int},
701 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
702 qr{(?:(?:un)?signed\s+)?long\s+long},
703 qr{(?:(?:un)?signed\s+)?long},
704 qr{(?:un)?signed},
705 qr{float},
706 qr{double},
707 qr{bool},
708 qr{struct\s+$Ident},
709 qr{union\s+$Ident},
710 qr{enum\s+$Ident},
711 qr{${Ident}_t},
712 qr{${Ident}_handler},
713 qr{${Ident}_handler_fn},
714 @typeListMisordered,
715);
716
717our $C90_int_types = qr{(?x:
718 long\s+long\s+int\s+(?:un)?signed|
719 long\s+long\s+(?:un)?signed\s+int|
720 long\s+long\s+(?:un)?signed|
721 (?:(?:un)?signed\s+)?long\s+long\s+int|
722 (?:(?:un)?signed\s+)?long\s+long|
723 int\s+long\s+long\s+(?:un)?signed|
724 int\s+(?:(?:un)?signed\s+)?long\s+long|
725
726 long\s+int\s+(?:un)?signed|
727 long\s+(?:un)?signed\s+int|
728 long\s+(?:un)?signed|
729 (?:(?:un)?signed\s+)?long\s+int|
730 (?:(?:un)?signed\s+)?long|
731 int\s+long\s+(?:un)?signed|
732 int\s+(?:(?:un)?signed\s+)?long|
733
734 int\s+(?:un)?signed|
735 (?:(?:un)?signed\s+)?int
736)};
737
738our @typeListFile = ();
739our @typeListWithAttr = (
740 @typeList,
741 qr{struct\s+$InitAttribute\s+$Ident},
742 qr{union\s+$InitAttribute\s+$Ident},
743);
744
745our @modifierList = (
746 qr{fastcall},
747);
748our @modifierListFile = ();
749
750our @mode_permission_funcs = (
751 ["module_param", 3],
752 ["module_param_(?:array|named|string)", 4],
753 ["module_param_array_named", 5],
754 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
755 ["proc_create(?:_data|)", 2],
756 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
757 ["IIO_DEV_ATTR_[A-Z_]+", 1],
758 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
759 ["SENSOR_TEMPLATE(?:_2|)", 3],
760 ["__ATTR", 2],
761);
762
763my $word_pattern = '\b[A-Z]?[a-z]{2,}\b';
764
765#Create a search pattern for all these functions to speed up a loop below
766our $mode_perms_search = "";
767foreach my $entry (@mode_permission_funcs) {
768 $mode_perms_search .= '|' if ($mode_perms_search ne "");
769 $mode_perms_search .= $entry->[0];
770}
771$mode_perms_search = "(?:${mode_perms_search})";
772
773our %deprecated_apis = (
774 "synchronize_rcu_bh" => "synchronize_rcu",
775 "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited",
776 "call_rcu_bh" => "call_rcu",
777 "rcu_barrier_bh" => "rcu_barrier",
778 "synchronize_sched" => "synchronize_rcu",
779 "synchronize_sched_expedited" => "synchronize_rcu_expedited",
780 "call_rcu_sched" => "call_rcu",
781 "rcu_barrier_sched" => "rcu_barrier",
782 "get_state_synchronize_sched" => "get_state_synchronize_rcu",
783 "cond_synchronize_sched" => "cond_synchronize_rcu",
784);
785
786#Create a search pattern for all these strings to speed up a loop below
787our $deprecated_apis_search = "";
788foreach my $entry (keys %deprecated_apis) {
789 $deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
790 $deprecated_apis_search .= $entry;
791}
792$deprecated_apis_search = "(?:${deprecated_apis_search})";
793
794our $mode_perms_world_writable = qr{
795 S_IWUGO |
796 S_IWOTH |
797 S_IRWXUGO |
798 S_IALLUGO |
799 0[0-7][0-7][2367]
800}x;
801
802our %mode_permission_string_types = (
803 "S_IRWXU" => 0700,
804 "S_IRUSR" => 0400,
805 "S_IWUSR" => 0200,
806 "S_IXUSR" => 0100,
807 "S_IRWXG" => 0070,
808 "S_IRGRP" => 0040,
809 "S_IWGRP" => 0020,
810 "S_IXGRP" => 0010,
811 "S_IRWXO" => 0007,
812 "S_IROTH" => 0004,
813 "S_IWOTH" => 0002,
814 "S_IXOTH" => 0001,
815 "S_IRWXUGO" => 0777,
816 "S_IRUGO" => 0444,
817 "S_IWUGO" => 0222,
818 "S_IXUGO" => 0111,
819);
820
821#Create a search pattern for all these strings to speed up a loop below
822our $mode_perms_string_search = "";
823foreach my $entry (keys %mode_permission_string_types) {
824 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
825 $mode_perms_string_search .= $entry;
826}
827our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
828our $multi_mode_perms_string_search = qr{
829 ${single_mode_perms_string_search}
830 (?:\s*\|\s*${single_mode_perms_string_search})*
831}x;
832
833sub perms_to_octal {
834 my ($string) = @_;
835
836 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
837
838 my $val = "";
839 my $oval = "";
840 my $to = 0;
841 my $curpos = 0;
842 my $lastpos = 0;
843 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
844 $curpos = pos($string);
845 my $match = $2;
846 my $omatch = $1;
847 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
848 $lastpos = $curpos;
849 $to |= $mode_permission_string_types{$match};
850 $val .= '\s*\|\s*' if ($val ne "");
851 $val .= $match;
852 $oval .= $omatch;
853 }
854 $oval =~ s/^\s*\|\s*//;
855 $oval =~ s/\s*\|\s*$//;
856 return sprintf("%04o", $to);
857}
858
859our $allowed_asm_includes = qr{(?x:
860 irq|
861 memory|
862 time|
863 reboot
864)};
865# memory.h: ARM has a custom one
866
867# Load common spelling mistakes and build regular expression list.
868my $misspellings;
869my %spelling_fix;
870
871if (open(my $spelling, '<', $spelling_file)) {
872 while (<$spelling>) {
873 my $line = $_;
874
875 $line =~ s/\s*\n?$//g;
876 $line =~ s/^\s*//g;
877
878 next if ($line =~ m/^\s*#/);
879 next if ($line =~ m/^\s*$/);
880
881 my ($suspect, $fix) = split(/\|\|/, $line);
882
883 $spelling_fix{$suspect} = $fix;
884 }
885 close($spelling);
886} else {
887 warn "No typos will be found - file '$spelling_file': $!\n";
888}
889
890if ($codespell) {
891 if (open(my $spelling, '<', $codespellfile)) {
892 while (<$spelling>) {
893 my $line = $_;
894
895 $line =~ s/\s*\n?$//g;
896 $line =~ s/^\s*//g;
897
898 next if ($line =~ m/^\s*#/);
899 next if ($line =~ m/^\s*$/);
900 next if ($line =~ m/, disabled/i);
901
902 $line =~ s/,.*$//;
903
904 my ($suspect, $fix) = split(/->/, $line);
905
906 $spelling_fix{$suspect} = $fix;
907 }
908 close($spelling);
909 } else {
910 warn "No codespell typos will be found - file '$codespellfile': $!\n";
911 }
912}
913
914$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
915
916sub read_words {
917 my ($wordsRef, $file) = @_;
918
919 if (open(my $words, '<', $file)) {
920 while (<$words>) {
921 my $line = $_;
922
923 $line =~ s/\s*\n?$//g;
924 $line =~ s/^\s*//g;
925
926 next if ($line =~ m/^\s*#/);
927 next if ($line =~ m/^\s*$/);
928 if ($line =~ /\s/) {
929 print("$file: '$line' invalid - ignored\n");
930 next;
931 }
932
933 $$wordsRef .= '|' if (defined $$wordsRef);
934 $$wordsRef .= $line;
935 }
936 close($file);
937 return 1;
938 }
939
940 return 0;
941}
942
943my $const_structs;
944if (show_type("CONST_STRUCT")) {
945 read_words(\$const_structs, $conststructsfile)
946 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
947}
948
949if (defined($typedefsfile)) {
950 my $typeOtherTypedefs;
951 read_words(\$typeOtherTypedefs, $typedefsfile)
952 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
953 $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs);
954}
955
956sub build_types {
957 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
958 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
959 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
960 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
961 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
962 $BasicType = qr{
963 (?:$typeTypedefs\b)|
964 (?:${all}\b)
965 }x;
966 $NonptrType = qr{
967 (?:$Modifier\s+|const\s+)*
968 (?:
969 (?:typeof|__typeof__)\s*\([^\)]*\)|
970 (?:$typeTypedefs\b)|
971 (?:${all}\b)
972 )
973 (?:\s+$Modifier|\s+const)*
974 }x;
975 $NonptrTypeMisordered = qr{
976 (?:$Modifier\s+|const\s+)*
977 (?:
978 (?:${Misordered}\b)
979 )
980 (?:\s+$Modifier|\s+const)*
981 }x;
982 $NonptrTypeWithAttr = qr{
983 (?:$Modifier\s+|const\s+)*
984 (?:
985 (?:typeof|__typeof__)\s*\([^\)]*\)|
986 (?:$typeTypedefs\b)|
987 (?:${allWithAttr}\b)
988 )
989 (?:\s+$Modifier|\s+const)*
990 }x;
991 $Type = qr{
992 $NonptrType
993 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
994 (?:\s+$Inline|\s+$Modifier)*
995 }x;
996 $TypeMisordered = qr{
997 $NonptrTypeMisordered
998 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
999 (?:\s+$Inline|\s+$Modifier)*
1000 }x;
1001 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
1002 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
1003}
1004build_types();
1005
1006our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
1007
1008# Using $balanced_parens, $LvalOrFunc, or $FuncArg
1009# requires at least perl version v5.10.0
1010# Any use must be runtime checked with $^V
1011
1012our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
1013our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
1014our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
1015
1016our $declaration_macros = qr{(?x:
1017 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
1018 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
1019 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
1020)};
1021
1022our %allow_repeated_words = (
1023 add => '',
1024 added => '',
1025 bad => '',
1026 be => '',
1027);
1028
1029sub deparenthesize {
1030 my ($string) = @_;
1031 return "" if (!defined($string));
1032
1033 while ($string =~ /^\s*\(.*\)\s*$/) {
1034 $string =~ s@^\s*\(\s*@@;
1035 $string =~ s@\s*\)\s*$@@;
1036 }
1037
1038 $string =~ s@\s+@ @g;
1039
1040 return $string;
1041}
1042
1043sub seed_camelcase_file {
1044 my ($file) = @_;
1045
1046 return if (!(-f $file));
1047
1048 local $/;
1049
1050 open(my $include_file, '<', "$file")
1051 or warn "$P: Can't read '$file' $!\n";
1052 my $text = <$include_file>;
1053 close($include_file);
1054
1055 my @lines = split('\n', $text);
1056
1057 foreach my $line (@lines) {
1058 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
1059 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
1060 $camelcase{$1} = 1;
1061 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
1062 $camelcase{$1} = 1;
1063 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
1064 $camelcase{$1} = 1;
1065 }
1066 }
1067}
1068
1069our %maintained_status = ();
1070
1071sub is_maintained_obsolete {
1072 my ($filename) = @_;
1073
1074 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
1075
1076 if (!exists($maintained_status{$filename})) {
1077 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
1078 }
1079
1080 return $maintained_status{$filename} =~ /obsolete/i;
1081}
1082
1083sub is_SPDX_License_valid {
1084 my ($license) = @_;
1085
1086 return 1 if (!$tree || which("python3") eq "" || !(-x "scripts/spdxcheck.py") || !(-e "$gitroot"));
1087
1088 my $root_path = abs_path($root);
1089 my $status = `cd "$root_path"; echo "$license" | scripts/spdxcheck.py -`;
1090 return 0 if ($status ne "");
1091 return 1;
1092}
1093
1094my $camelcase_seeded = 0;
1095sub seed_camelcase_includes {
1096 return if ($camelcase_seeded);
1097
1098 my $files;
1099 my $camelcase_cache = "";
1100 my @include_files = ();
1101
1102 $camelcase_seeded = 1;
1103
1104 if (-e "$gitroot") {
1105 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
1106 chomp $git_last_include_commit;
1107 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
1108 } else {
1109 my $last_mod_date = 0;
1110 $files = `find $root/include -name "*.h"`;
1111 @include_files = split('\n', $files);
1112 foreach my $file (@include_files) {
1113 my $date = POSIX::strftime("%Y%m%d%H%M",
1114 localtime((stat $file)[9]));
1115 $last_mod_date = $date if ($last_mod_date < $date);
1116 }
1117 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
1118 }
1119
1120 if ($camelcase_cache ne "" && -f $camelcase_cache) {
1121 open(my $camelcase_file, '<', "$camelcase_cache")
1122 or warn "$P: Can't read '$camelcase_cache' $!\n";
1123 while (<$camelcase_file>) {
1124 chomp;
1125 $camelcase{$_} = 1;
1126 }
1127 close($camelcase_file);
1128
1129 return;
1130 }
1131
1132 if (-e "$gitroot") {
1133 $files = `${git_command} ls-files "include/*.h"`;
1134 @include_files = split('\n', $files);
1135 }
1136
1137 foreach my $file (@include_files) {
1138 seed_camelcase_file($file);
1139 }
1140
1141 if ($camelcase_cache ne "") {
1142 unlink glob ".checkpatch-camelcase.*";
1143 open(my $camelcase_file, '>', "$camelcase_cache")
1144 or warn "$P: Can't write '$camelcase_cache' $!\n";
1145 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
1146 print $camelcase_file ("$_\n");
1147 }
1148 close($camelcase_file);
1149 }
1150}
1151
1152sub git_is_single_file {
1153 my ($filename) = @_;
1154
1155 return 0 if ((which("git") eq "") || !(-e "$gitroot"));
1156
1157 my $output = `${git_command} ls-files -- $filename 2>/dev/null`;
1158 my $count = $output =~ tr/\n//;
1159 return $count eq 1 && $output =~ m{^${filename}$};
1160}
1161
1162sub git_commit_info {
1163 my ($commit, $id, $desc) = @_;
1164
1165 return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot"));
1166
1167 my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
1168 $output =~ s/^\s*//gm;
1169 my @lines = split("\n", $output);
1170
1171 return ($id, $desc) if ($#lines < 0);
1172
1173 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
1174# Maybe one day convert this block of bash into something that returns
1175# all matching commit ids, but it's very slow...
1176#
1177# echo "checking commits $1..."
1178# git rev-list --remotes | grep -i "^$1" |
1179# while read line ; do
1180# git log --format='%H %s' -1 $line |
1181# echo "commit $(cut -c 1-12,41-)"
1182# done
1183 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./ ||
1184 $lines[0] =~ /^fatal: bad object $commit/) {
1185 $id = undef;
1186 } else {
1187 $id = substr($lines[0], 0, 12);
1188 $desc = substr($lines[0], 41);
1189 }
1190
1191 return ($id, $desc);
1192}
1193
1194$chk_signoff = 0 if ($file);
1195
1196my @rawlines = ();
1197my @lines = ();
1198my @fixed = ();
1199my @fixed_inserted = ();
1200my @fixed_deleted = ();
1201my $fixlinenr = -1;
1202
1203# If input is git commits, extract all commits from the commit expressions.
1204# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1205die "$P: No git repository found\n" if ($git && !-e "$gitroot");
1206
1207if ($git) {
1208 my @commits = ();
1209 foreach my $commit_expr (@ARGV) {
1210 my $git_range;
1211 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
1212 $git_range = "-$2 $1";
1213 } elsif ($commit_expr =~ m/\.\./) {
1214 $git_range = "$commit_expr";
1215 } else {
1216 $git_range = "-1 $commit_expr";
1217 }
1218 my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
1219 foreach my $line (split(/\n/, $lines)) {
1220 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
1221 next if (!defined($1) || !defined($2));
1222 my $sha1 = $1;
1223 my $subject = $2;
1224 unshift(@commits, $sha1);
1225 $git_commits{$sha1} = $subject;
1226 }
1227 }
1228 die "$P: no git commits after extraction!\n" if (@commits == 0);
1229 @ARGV = @commits;
1230}
1231
1232my $vname;
1233$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
1234for my $filename (@ARGV) {
1235 my $FILE;
1236 my $is_git_file = git_is_single_file($filename);
1237 my $oldfile = $file;
1238 $file = 1 if ($is_git_file);
1239 if ($git) {
1240 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
1241 die "$P: $filename: git format-patch failed - $!\n";
1242 } elsif ($file) {
1243 open($FILE, '-|', "diff -u /dev/null $filename") ||
1244 die "$P: $filename: diff failed - $!\n";
1245 } elsif ($filename eq '-') {
1246 open($FILE, '<&STDIN');
1247 } else {
1248 open($FILE, '<', "$filename") ||
1249 die "$P: $filename: open failed - $!\n";
1250 }
1251 if ($filename eq '-') {
1252 $vname = 'Your patch';
1253 } elsif ($git) {
1254 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
1255 } else {
1256 $vname = $filename;
1257 }
1258 while (<$FILE>) {
1259 chomp;
1260 push(@rawlines, $_);
1261 $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i);
1262 }
1263 close($FILE);
1264
1265 if ($#ARGV > 0 && $quiet == 0) {
1266 print '-' x length($vname) . "\n";
1267 print "$vname\n";
1268 print '-' x length($vname) . "\n";
1269 }
1270
1271 if (!process($filename)) {
1272 $exit = 1;
1273 }
1274 @rawlines = ();
1275 @lines = ();
1276 @fixed = ();
1277 @fixed_inserted = ();
1278 @fixed_deleted = ();
1279 $fixlinenr = -1;
1280 @modifierListFile = ();
1281 @typeListFile = ();
1282 build_types();
1283 $file = $oldfile if ($is_git_file);
1284}
1285
1286if (!$quiet) {
1287 hash_show_words(\%use_type, "Used");
1288 hash_show_words(\%ignore_type, "Ignored");
1289
1290 if (!$perl_version_ok) {
1291 print << "EOM"
1292
1293NOTE: perl $^V is not modern enough to detect all possible issues.
1294 An upgrade to at least perl $minimum_perl_version is suggested.
1295EOM
1296 }
1297 if ($exit) {
1298 print << "EOM"
1299
1300NOTE: If any of the errors are false positives, please report
1301 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1302EOM
1303 }
1304}
1305
1306exit($exit);
1307
1308sub top_of_kernel_tree {
1309 my ($root) = @_;
1310
1311 my @tree_check = (
1312 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1313 "README", "Documentation", "arch", "include", "drivers",
1314 "fs", "init", "ipc", "kernel", "lib", "scripts",
1315 );
1316
1317 foreach my $check (@tree_check) {
1318 if (! -e $root . '/' . $check) {
1319 return 0;
1320 }
1321 }
1322 return 1;
1323}
1324
1325sub parse_email {
1326 my ($formatted_email) = @_;
1327
1328 my $name = "";
1329 my $quoted = "";
1330 my $name_comment = "";
1331 my $address = "";
1332 my $comment = "";
1333
1334 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1335 $name = $1;
1336 $address = $2;
1337 $comment = $3 if defined $3;
1338 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1339 $address = $1;
1340 $comment = $2 if defined $2;
1341 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1342 $address = $1;
1343 $comment = $2 if defined $2;
1344 $formatted_email =~ s/\Q$address\E.*$//;
1345 $name = $formatted_email;
1346 $name = trim($name);
1347 $name =~ s/^\"|\"$//g;
1348 # If there's a name left after stripping spaces and
1349 # leading quotes, and the address doesn't have both
1350 # leading and trailing angle brackets, the address
1351 # is invalid. ie:
1352 # "joe smith joe@smith.com" bad
1353 # "joe smith <joe@smith.com" bad
1354 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1355 $name = "";
1356 $address = "";
1357 $comment = "";
1358 }
1359 }
1360
1361 # Extract comments from names excluding quoted parts
1362 # "John D. (Doe)" - Do not extract
1363 if ($name =~ s/\"(.+)\"//) {
1364 $quoted = $1;
1365 }
1366 while ($name =~ s/\s*($balanced_parens)\s*/ /) {
1367 $name_comment .= trim($1);
1368 }
1369 $name =~ s/^[ \"]+|[ \"]+$//g;
1370 $name = trim("$quoted $name");
1371
1372 $address = trim($address);
1373 $address =~ s/^\<|\>$//g;
1374 $comment = trim($comment);
1375
1376 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1377 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1378 $name = "\"$name\"";
1379 }
1380
1381 return ($name, $name_comment, $address, $comment);
1382}
1383
1384sub format_email {
1385 my ($name, $name_comment, $address, $comment) = @_;
1386
1387 my $formatted_email;
1388
1389 $name =~ s/^[ \"]+|[ \"]+$//g;
1390 $address = trim($address);
1391 $address =~ s/(?:\.|\,|\")+$//; ##trailing commas, dots or quotes
1392
1393 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1394 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1395 $name = "\"$name\"";
1396 }
1397
1398 $name_comment = trim($name_comment);
1399 $name_comment = " $name_comment" if ($name_comment ne "");
1400 $comment = trim($comment);
1401 $comment = " $comment" if ($comment ne "");
1402
1403 if ("$name" eq "") {
1404 $formatted_email = "$address";
1405 } else {
1406 $formatted_email = "$name$name_comment <$address>";
1407 }
1408 $formatted_email .= "$comment";
1409 return $formatted_email;
1410}
1411
1412sub reformat_email {
1413 my ($email) = @_;
1414
1415 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
1416 return format_email($email_name, $name_comment, $email_address, $comment);
1417}
1418
1419sub same_email_addresses {
1420 my ($email1, $email2) = @_;
1421
1422 my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1);
1423 my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2);
1424
1425 return $email1_name eq $email2_name &&
1426 $email1_address eq $email2_address &&
1427 $name1_comment eq $name2_comment &&
1428 $comment1 eq $comment2;
1429}
1430
1431sub which {
1432 my ($bin) = @_;
1433
1434 foreach my $path (split(/:/, $ENV{PATH})) {
1435 if (-e "$path/$bin") {
1436 return "$path/$bin";
1437 }
1438 }
1439
1440 return "";
1441}
1442
1443sub which_conf {
1444 my ($conf) = @_;
1445
1446 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1447 if (-e "$path/$conf") {
1448 return "$path/$conf";
1449 }
1450 }
1451
1452 return "";
1453}
1454
1455sub expand_tabs {
1456 my ($str) = @_;
1457
1458 my $res = '';
1459 my $n = 0;
1460 for my $c (split(//, $str)) {
1461 if ($c eq "\t") {
1462 $res .= ' ';
1463 $n++;
1464 for (; ($n % $tabsize) != 0; $n++) {
1465 $res .= ' ';
1466 }
1467 next;
1468 }
1469 $res .= $c;
1470 $n++;
1471 }
1472
1473 return $res;
1474}
1475sub copy_spacing {
1476 (my $res = shift) =~ tr/\t/ /c;
1477 return $res;
1478}
1479
1480sub line_stats {
1481 my ($line) = @_;
1482
1483 # Drop the diff line leader and expand tabs
1484 $line =~ s/^.//;
1485 $line = expand_tabs($line);
1486
1487 # Pick the indent from the front of the line.
1488 my ($white) = ($line =~ /^(\s*)/);
1489
1490 return (length($line), length($white));
1491}
1492
1493my $sanitise_quote = '';
1494
1495sub sanitise_line_reset {
1496 my ($in_comment) = @_;
1497
1498 if ($in_comment) {
1499 $sanitise_quote = '*/';
1500 } else {
1501 $sanitise_quote = '';
1502 }
1503}
1504sub sanitise_line {
1505 my ($line) = @_;
1506
1507 my $res = '';
1508 my $l = '';
1509
1510 my $qlen = 0;
1511 my $off = 0;
1512 my $c;
1513
1514 # Always copy over the diff marker.
1515 $res = substr($line, 0, 1);
1516
1517 for ($off = 1; $off < length($line); $off++) {
1518 $c = substr($line, $off, 1);
1519
1520 # Comments we are whacking completely including the begin
1521 # and end, all to $;.
1522 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1523 $sanitise_quote = '*/';
1524
1525 substr($res, $off, 2, "$;$;");
1526 $off++;
1527 next;
1528 }
1529 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1530 $sanitise_quote = '';
1531 substr($res, $off, 2, "$;$;");
1532 $off++;
1533 next;
1534 }
1535 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1536 $sanitise_quote = '//';
1537
1538 substr($res, $off, 2, $sanitise_quote);
1539 $off++;
1540 next;
1541 }
1542
1543 # A \ in a string means ignore the next character.
1544 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1545 $c eq "\\") {
1546 substr($res, $off, 2, 'XX');
1547 $off++;
1548 next;
1549 }
1550 # Regular quotes.
1551 if ($c eq "'" || $c eq '"') {
1552 if ($sanitise_quote eq '') {
1553 $sanitise_quote = $c;
1554
1555 substr($res, $off, 1, $c);
1556 next;
1557 } elsif ($sanitise_quote eq $c) {
1558 $sanitise_quote = '';
1559 }
1560 }
1561
1562 #print "c<$c> SQ<$sanitise_quote>\n";
1563 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1564 substr($res, $off, 1, $;);
1565 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1566 substr($res, $off, 1, $;);
1567 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1568 substr($res, $off, 1, 'X');
1569 } else {
1570 substr($res, $off, 1, $c);
1571 }
1572 }
1573
1574 if ($sanitise_quote eq '//') {
1575 $sanitise_quote = '';
1576 }
1577
1578 # The pathname on a #include may be surrounded by '<' and '>'.
1579 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1580 my $clean = 'X' x length($1);
1581 $res =~ s@\<.*\>@<$clean>@;
1582
1583 # The whole of a #error is a string.
1584 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1585 my $clean = 'X' x length($1);
1586 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1587 }
1588
1589 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1590 my $match = $1;
1591 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1592 }
1593
1594 return $res;
1595}
1596
1597sub get_quoted_string {
1598 my ($line, $rawline) = @_;
1599
1600 return "" if (!defined($line) || !defined($rawline));
1601 return "" if ($line !~ m/($String)/g);
1602 return substr($rawline, $-[0], $+[0] - $-[0]);
1603}
1604
1605sub ctx_statement_block {
1606 my ($linenr, $remain, $off) = @_;
1607 my $line = $linenr - 1;
1608 my $blk = '';
1609 my $soff = $off;
1610 my $coff = $off - 1;
1611 my $coff_set = 0;
1612
1613 my $loff = 0;
1614
1615 my $type = '';
1616 my $level = 0;
1617 my @stack = ();
1618 my $p;
1619 my $c;
1620 my $len = 0;
1621
1622 my $remainder;
1623 while (1) {
1624 @stack = (['', 0]) if ($#stack == -1);
1625
1626 #warn "CSB: blk<$blk> remain<$remain>\n";
1627 # If we are about to drop off the end, pull in more
1628 # context.
1629 if ($off >= $len) {
1630 for (; $remain > 0; $line++) {
1631 last if (!defined $lines[$line]);
1632 next if ($lines[$line] =~ /^-/);
1633 $remain--;
1634 $loff = $len;
1635 $blk .= $lines[$line] . "\n";
1636 $len = length($blk);
1637 $line++;
1638 last;
1639 }
1640 # Bail if there is no further context.
1641 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1642 if ($off >= $len) {
1643 last;
1644 }
1645 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1646 $level++;
1647 $type = '#';
1648 }
1649 }
1650 $p = $c;
1651 $c = substr($blk, $off, 1);
1652 $remainder = substr($blk, $off);
1653
1654 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1655
1656 # Handle nested #if/#else.
1657 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1658 push(@stack, [ $type, $level ]);
1659 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1660 ($type, $level) = @{$stack[$#stack - 1]};
1661 } elsif ($remainder =~ /^#\s*endif\b/) {
1662 ($type, $level) = @{pop(@stack)};
1663 }
1664
1665 # Statement ends at the ';' or a close '}' at the
1666 # outermost level.
1667 if ($level == 0 && $c eq ';') {
1668 last;
1669 }
1670
1671 # An else is really a conditional as long as its not else if
1672 if ($level == 0 && $coff_set == 0 &&
1673 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1674 $remainder =~ /^(else)(?:\s|{)/ &&
1675 $remainder !~ /^else\s+if\b/) {
1676 $coff = $off + length($1) - 1;
1677 $coff_set = 1;
1678 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1679 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1680 }
1681
1682 if (($type eq '' || $type eq '(') && $c eq '(') {
1683 $level++;
1684 $type = '(';
1685 }
1686 if ($type eq '(' && $c eq ')') {
1687 $level--;
1688 $type = ($level != 0)? '(' : '';
1689
1690 if ($level == 0 && $coff < $soff) {
1691 $coff = $off;
1692 $coff_set = 1;
1693 #warn "CSB: mark coff<$coff>\n";
1694 }
1695 }
1696 if (($type eq '' || $type eq '{') && $c eq '{') {
1697 $level++;
1698 $type = '{';
1699 }
1700 if ($type eq '{' && $c eq '}') {
1701 $level--;
1702 $type = ($level != 0)? '{' : '';
1703
1704 if ($level == 0) {
1705 if (substr($blk, $off + 1, 1) eq ';') {
1706 $off++;
1707 }
1708 last;
1709 }
1710 }
1711 # Preprocessor commands end at the newline unless escaped.
1712 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1713 $level--;
1714 $type = '';
1715 $off++;
1716 last;
1717 }
1718 $off++;
1719 }
1720 # We are truly at the end, so shuffle to the next line.
1721 if ($off == $len) {
1722 $loff = $len + 1;
1723 $line++;
1724 $remain--;
1725 }
1726
1727 my $statement = substr($blk, $soff, $off - $soff + 1);
1728 my $condition = substr($blk, $soff, $coff - $soff + 1);
1729
1730 #warn "STATEMENT<$statement>\n";
1731 #warn "CONDITION<$condition>\n";
1732
1733 #print "coff<$coff> soff<$off> loff<$loff>\n";
1734
1735 return ($statement, $condition,
1736 $line, $remain + 1, $off - $loff + 1, $level);
1737}
1738
1739sub statement_lines {
1740 my ($stmt) = @_;
1741
1742 # Strip the diff line prefixes and rip blank lines at start and end.
1743 $stmt =~ s/(^|\n)./$1/g;
1744 $stmt =~ s/^\s*//;
1745 $stmt =~ s/\s*$//;
1746
1747 my @stmt_lines = ($stmt =~ /\n/g);
1748
1749 return $#stmt_lines + 2;
1750}
1751
1752sub statement_rawlines {
1753 my ($stmt) = @_;
1754
1755 my @stmt_lines = ($stmt =~ /\n/g);
1756
1757 return $#stmt_lines + 2;
1758}
1759
1760sub statement_block_size {
1761 my ($stmt) = @_;
1762
1763 $stmt =~ s/(^|\n)./$1/g;
1764 $stmt =~ s/^\s*{//;
1765 $stmt =~ s/}\s*$//;
1766 $stmt =~ s/^\s*//;
1767 $stmt =~ s/\s*$//;
1768
1769 my @stmt_lines = ($stmt =~ /\n/g);
1770 my @stmt_statements = ($stmt =~ /;/g);
1771
1772 my $stmt_lines = $#stmt_lines + 2;
1773 my $stmt_statements = $#stmt_statements + 1;
1774
1775 if ($stmt_lines > $stmt_statements) {
1776 return $stmt_lines;
1777 } else {
1778 return $stmt_statements;
1779 }
1780}
1781
1782sub ctx_statement_full {
1783 my ($linenr, $remain, $off) = @_;
1784 my ($statement, $condition, $level);
1785
1786 my (@chunks);
1787
1788 # Grab the first conditional/block pair.
1789 ($statement, $condition, $linenr, $remain, $off, $level) =
1790 ctx_statement_block($linenr, $remain, $off);
1791 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1792 push(@chunks, [ $condition, $statement ]);
1793 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1794 return ($level, $linenr, @chunks);
1795 }
1796
1797 # Pull in the following conditional/block pairs and see if they
1798 # could continue the statement.
1799 for (;;) {
1800 ($statement, $condition, $linenr, $remain, $off, $level) =
1801 ctx_statement_block($linenr, $remain, $off);
1802 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1803 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1804 #print "C: push\n";
1805 push(@chunks, [ $condition, $statement ]);
1806 }
1807
1808 return ($level, $linenr, @chunks);
1809}
1810
1811sub ctx_block_get {
1812 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1813 my $line;
1814 my $start = $linenr - 1;
1815 my $blk = '';
1816 my @o;
1817 my @c;
1818 my @res = ();
1819
1820 my $level = 0;
1821 my @stack = ($level);
1822 for ($line = $start; $remain > 0; $line++) {
1823 next if ($rawlines[$line] =~ /^-/);
1824 $remain--;
1825
1826 $blk .= $rawlines[$line];
1827
1828 # Handle nested #if/#else.
1829 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1830 push(@stack, $level);
1831 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1832 $level = $stack[$#stack - 1];
1833 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1834 $level = pop(@stack);
1835 }
1836
1837 foreach my $c (split(//, $lines[$line])) {
1838 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1839 if ($off > 0) {
1840 $off--;
1841 next;
1842 }
1843
1844 if ($c eq $close && $level > 0) {
1845 $level--;
1846 last if ($level == 0);
1847 } elsif ($c eq $open) {
1848 $level++;
1849 }
1850 }
1851
1852 if (!$outer || $level <= 1) {
1853 push(@res, $rawlines[$line]);
1854 }
1855
1856 last if ($level == 0);
1857 }
1858
1859 return ($level, @res);
1860}
1861sub ctx_block_outer {
1862 my ($linenr, $remain) = @_;
1863
1864 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1865 return @r;
1866}
1867sub ctx_block {
1868 my ($linenr, $remain) = @_;
1869
1870 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1871 return @r;
1872}
1873sub ctx_statement {
1874 my ($linenr, $remain, $off) = @_;
1875
1876 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1877 return @r;
1878}
1879sub ctx_block_level {
1880 my ($linenr, $remain) = @_;
1881
1882 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1883}
1884sub ctx_statement_level {
1885 my ($linenr, $remain, $off) = @_;
1886
1887 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1888}
1889
1890sub ctx_locate_comment {
1891 my ($first_line, $end_line) = @_;
1892
1893 # If c99 comment on the current line, or the line before or after
1894 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@);
1895 return $current_comment if (defined $current_comment);
1896 ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@);
1897 return $current_comment if (defined $current_comment);
1898 ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@);
1899 return $current_comment if (defined $current_comment);
1900
1901 # Catch a comment on the end of the line itself.
1902 ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1903 return $current_comment if (defined $current_comment);
1904
1905 # Look through the context and try and figure out if there is a
1906 # comment.
1907 my $in_comment = 0;
1908 $current_comment = '';
1909 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1910 my $line = $rawlines[$linenr - 1];
1911 #warn " $line\n";
1912 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1913 $in_comment = 1;
1914 }
1915 if ($line =~ m@/\*@) {
1916 $in_comment = 1;
1917 }
1918 if (!$in_comment && $current_comment ne '') {
1919 $current_comment = '';
1920 }
1921 $current_comment .= $line . "\n" if ($in_comment);
1922 if ($line =~ m@\*/@) {
1923 $in_comment = 0;
1924 }
1925 }
1926
1927 chomp($current_comment);
1928 return($current_comment);
1929}
1930sub ctx_has_comment {
1931 my ($first_line, $end_line) = @_;
1932 my $cmt = ctx_locate_comment($first_line, $end_line);
1933
1934 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1935 ##print "CMMT: $cmt\n";
1936
1937 return ($cmt ne '');
1938}
1939
1940sub raw_line {
1941 my ($linenr, $cnt) = @_;
1942
1943 my $offset = $linenr - 1;
1944 $cnt++;
1945
1946 my $line;
1947 while ($cnt) {
1948 $line = $rawlines[$offset++];
1949 next if (defined($line) && $line =~ /^-/);
1950 $cnt--;
1951 }
1952
1953 return $line;
1954}
1955
1956sub get_stat_real {
1957 my ($linenr, $lc) = @_;
1958
1959 my $stat_real = raw_line($linenr, 0);
1960 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1961 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1962 }
1963
1964 return $stat_real;
1965}
1966
1967sub get_stat_here {
1968 my ($linenr, $cnt, $here) = @_;
1969
1970 my $herectx = $here . "\n";
1971 for (my $n = 0; $n < $cnt; $n++) {
1972 $herectx .= raw_line($linenr, $n) . "\n";
1973 }
1974
1975 return $herectx;
1976}
1977
1978sub cat_vet {
1979 my ($vet) = @_;
1980 my ($res, $coded);
1981
1982 $res = '';
1983 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1984 $res .= $1;
1985 if ($2 ne '') {
1986 $coded = sprintf("^%c", unpack('C', $2) + 64);
1987 $res .= $coded;
1988 }
1989 }
1990 $res =~ s/$/\$/;
1991
1992 return $res;
1993}
1994
1995my $av_preprocessor = 0;
1996my $av_pending;
1997my @av_paren_type;
1998my $av_pend_colon;
1999
2000sub annotate_reset {
2001 $av_preprocessor = 0;
2002 $av_pending = '_';
2003 @av_paren_type = ('E');
2004 $av_pend_colon = 'O';
2005}
2006
2007sub annotate_values {
2008 my ($stream, $type) = @_;
2009
2010 my $res;
2011 my $var = '_' x length($stream);
2012 my $cur = $stream;
2013
2014 print "$stream\n" if ($dbg_values > 1);
2015
2016 while (length($cur)) {
2017 @av_paren_type = ('E') if ($#av_paren_type < 0);
2018 print " <" . join('', @av_paren_type) .
2019 "> <$type> <$av_pending>" if ($dbg_values > 1);
2020 if ($cur =~ /^(\s+)/o) {
2021 print "WS($1)\n" if ($dbg_values > 1);
2022 if ($1 =~ /\n/ && $av_preprocessor) {
2023 $type = pop(@av_paren_type);
2024 $av_preprocessor = 0;
2025 }
2026
2027 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
2028 print "CAST($1)\n" if ($dbg_values > 1);
2029 push(@av_paren_type, $type);
2030 $type = 'c';
2031
2032 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
2033 print "DECLARE($1)\n" if ($dbg_values > 1);
2034 $type = 'T';
2035
2036 } elsif ($cur =~ /^($Modifier)\s*/) {
2037 print "MODIFIER($1)\n" if ($dbg_values > 1);
2038 $type = 'T';
2039
2040 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
2041 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
2042 $av_preprocessor = 1;
2043 push(@av_paren_type, $type);
2044 if ($2 ne '') {
2045 $av_pending = 'N';
2046 }
2047 $type = 'E';
2048
2049 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
2050 print "UNDEF($1)\n" if ($dbg_values > 1);
2051 $av_preprocessor = 1;
2052 push(@av_paren_type, $type);
2053
2054 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
2055 print "PRE_START($1)\n" if ($dbg_values > 1);
2056 $av_preprocessor = 1;
2057
2058 push(@av_paren_type, $type);
2059 push(@av_paren_type, $type);
2060 $type = 'E';
2061
2062 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
2063 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
2064 $av_preprocessor = 1;
2065
2066 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
2067
2068 $type = 'E';
2069
2070 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
2071 print "PRE_END($1)\n" if ($dbg_values > 1);
2072
2073 $av_preprocessor = 1;
2074
2075 # Assume all arms of the conditional end as this
2076 # one does, and continue as if the #endif was not here.
2077 pop(@av_paren_type);
2078 push(@av_paren_type, $type);
2079 $type = 'E';
2080
2081 } elsif ($cur =~ /^(\\\n)/o) {
2082 print "PRECONT($1)\n" if ($dbg_values > 1);
2083
2084 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
2085 print "ATTR($1)\n" if ($dbg_values > 1);
2086 $av_pending = $type;
2087 $type = 'N';
2088
2089 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
2090 print "SIZEOF($1)\n" if ($dbg_values > 1);
2091 if (defined $2) {
2092 $av_pending = 'V';
2093 }
2094 $type = 'N';
2095
2096 } elsif ($cur =~ /^(if|while|for)\b/o) {
2097 print "COND($1)\n" if ($dbg_values > 1);
2098 $av_pending = 'E';
2099 $type = 'N';
2100
2101 } elsif ($cur =~/^(case)/o) {
2102 print "CASE($1)\n" if ($dbg_values > 1);
2103 $av_pend_colon = 'C';
2104 $type = 'N';
2105
2106 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
2107 print "KEYWORD($1)\n" if ($dbg_values > 1);
2108 $type = 'N';
2109
2110 } elsif ($cur =~ /^(\()/o) {
2111 print "PAREN('$1')\n" if ($dbg_values > 1);
2112 push(@av_paren_type, $av_pending);
2113 $av_pending = '_';
2114 $type = 'N';
2115
2116 } elsif ($cur =~ /^(\))/o) {
2117 my $new_type = pop(@av_paren_type);
2118 if ($new_type ne '_') {
2119 $type = $new_type;
2120 print "PAREN('$1') -> $type\n"
2121 if ($dbg_values > 1);
2122 } else {
2123 print "PAREN('$1')\n" if ($dbg_values > 1);
2124 }
2125
2126 } elsif ($cur =~ /^($Ident)\s*\(/o) {
2127 print "FUNC($1)\n" if ($dbg_values > 1);
2128 $type = 'V';
2129 $av_pending = 'V';
2130
2131 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
2132 if (defined $2 && $type eq 'C' || $type eq 'T') {
2133 $av_pend_colon = 'B';
2134 } elsif ($type eq 'E') {
2135 $av_pend_colon = 'L';
2136 }
2137 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
2138 $type = 'V';
2139
2140 } elsif ($cur =~ /^($Ident|$Constant)/o) {
2141 print "IDENT($1)\n" if ($dbg_values > 1);
2142 $type = 'V';
2143
2144 } elsif ($cur =~ /^($Assignment)/o) {
2145 print "ASSIGN($1)\n" if ($dbg_values > 1);
2146 $type = 'N';
2147
2148 } elsif ($cur =~/^(;|{|})/) {
2149 print "END($1)\n" if ($dbg_values > 1);
2150 $type = 'E';
2151 $av_pend_colon = 'O';
2152
2153 } elsif ($cur =~/^(,)/) {
2154 print "COMMA($1)\n" if ($dbg_values > 1);
2155 $type = 'C';
2156
2157 } elsif ($cur =~ /^(\?)/o) {
2158 print "QUESTION($1)\n" if ($dbg_values > 1);
2159 $type = 'N';
2160
2161 } elsif ($cur =~ /^(:)/o) {
2162 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
2163
2164 substr($var, length($res), 1, $av_pend_colon);
2165 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
2166 $type = 'E';
2167 } else {
2168 $type = 'N';
2169 }
2170 $av_pend_colon = 'O';
2171
2172 } elsif ($cur =~ /^(\[)/o) {
2173 print "CLOSE($1)\n" if ($dbg_values > 1);
2174 $type = 'N';
2175
2176 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
2177 my $variant;
2178
2179 print "OPV($1)\n" if ($dbg_values > 1);
2180 if ($type eq 'V') {
2181 $variant = 'B';
2182 } else {
2183 $variant = 'U';
2184 }
2185
2186 substr($var, length($res), 1, $variant);
2187 $type = 'N';
2188
2189 } elsif ($cur =~ /^($Operators)/o) {
2190 print "OP($1)\n" if ($dbg_values > 1);
2191 if ($1 ne '++' && $1 ne '--') {
2192 $type = 'N';
2193 }
2194
2195 } elsif ($cur =~ /(^.)/o) {
2196 print "C($1)\n" if ($dbg_values > 1);
2197 }
2198 if (defined $1) {
2199 $cur = substr($cur, length($1));
2200 $res .= $type x length($1);
2201 }
2202 }
2203
2204 return ($res, $var);
2205}
2206
2207sub possible {
2208 my ($possible, $line) = @_;
2209 my $notPermitted = qr{(?:
2210 ^(?:
2211 $Modifier|
2212 $Storage|
2213 $Type|
2214 DEFINE_\S+
2215 )$|
2216 ^(?:
2217 goto|
2218 return|
2219 case|
2220 else|
2221 asm|__asm__|
2222 do|
2223 \#|
2224 \#\#|
2225 )(?:\s|$)|
2226 ^(?:typedef|struct|enum)\b
2227 )}x;
2228 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
2229 if ($possible !~ $notPermitted) {
2230 # Check for modifiers.
2231 $possible =~ s/\s*$Storage\s*//g;
2232 $possible =~ s/\s*$Sparse\s*//g;
2233 if ($possible =~ /^\s*$/) {
2234
2235 } elsif ($possible =~ /\s/) {
2236 $possible =~ s/\s*$Type\s*//g;
2237 for my $modifier (split(' ', $possible)) {
2238 if ($modifier !~ $notPermitted) {
2239 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
2240 push(@modifierListFile, $modifier);
2241 }
2242 }
2243
2244 } else {
2245 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
2246 push(@typeListFile, $possible);
2247 }
2248 build_types();
2249 } else {
2250 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
2251 }
2252}
2253
2254my $prefix = '';
2255
2256sub show_type {
2257 my ($type) = @_;
2258
2259 $type =~ tr/[a-z]/[A-Z]/;
2260
2261 return defined $use_type{$type} if (scalar keys %use_type > 0);
2262
2263 return !defined $ignore_type{$type};
2264}
2265
2266sub report {
2267 my ($level, $type, $msg) = @_;
2268
2269 if (!show_type($type) ||
2270 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
2271 return 0;
2272 }
2273 my $output = '';
2274 if ($color) {
2275 if ($level eq 'ERROR') {
2276 $output .= RED;
2277 } elsif ($level eq 'WARNING') {
2278 $output .= YELLOW;
2279 } else {
2280 $output .= GREEN;
2281 }
2282 }
2283 $output .= $prefix . $level . ':';
2284 if ($show_types) {
2285 $output .= BLUE if ($color);
2286 $output .= "$type:";
2287 }
2288 $output .= RESET if ($color);
2289 $output .= ' ' . $msg . "\n";
2290
2291 if ($showfile) {
2292 my @lines = split("\n", $output, -1);
2293 splice(@lines, 1, 1);
2294 $output = join("\n", @lines);
2295 }
2296
2297 if ($terse) {
2298 $output = (split('\n', $output))[0] . "\n";
2299 }
2300
2301 if ($verbose && exists($verbose_messages{$type}) &&
2302 !exists($verbose_emitted{$type})) {
2303 $output .= $verbose_messages{$type} . "\n\n";
2304 $verbose_emitted{$type} = 1;
2305 }
2306
2307 push(our @report, $output);
2308
2309 return 1;
2310}
2311
2312sub report_dump {
2313 our @report;
2314}
2315
2316sub fixup_current_range {
2317 my ($lineRef, $offset, $length) = @_;
2318
2319 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2320 my $o = $1;
2321 my $l = $2;
2322 my $no = $o + $offset;
2323 my $nl = $l + $length;
2324 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2325 }
2326}
2327
2328sub fix_inserted_deleted_lines {
2329 my ($linesRef, $insertedRef, $deletedRef) = @_;
2330
2331 my $range_last_linenr = 0;
2332 my $delta_offset = 0;
2333
2334 my $old_linenr = 0;
2335 my $new_linenr = 0;
2336
2337 my $next_insert = 0;
2338 my $next_delete = 0;
2339
2340 my @lines = ();
2341
2342 my $inserted = @{$insertedRef}[$next_insert++];
2343 my $deleted = @{$deletedRef}[$next_delete++];
2344
2345 foreach my $old_line (@{$linesRef}) {
2346 my $save_line = 1;
2347 my $line = $old_line; #don't modify the array
2348 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
2349 $delta_offset = 0;
2350 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2351 $range_last_linenr = $new_linenr;
2352 fixup_current_range(\$line, $delta_offset, 0);
2353 }
2354
2355 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2356 $deleted = @{$deletedRef}[$next_delete++];
2357 $save_line = 0;
2358 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2359 }
2360
2361 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2362 push(@lines, ${$inserted}{'LINE'});
2363 $inserted = @{$insertedRef}[$next_insert++];
2364 $new_linenr++;
2365 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2366 }
2367
2368 if ($save_line) {
2369 push(@lines, $line);
2370 $new_linenr++;
2371 }
2372
2373 $old_linenr++;
2374 }
2375
2376 return @lines;
2377}
2378
2379sub fix_insert_line {
2380 my ($linenr, $line) = @_;
2381
2382 my $inserted = {
2383 LINENR => $linenr,
2384 LINE => $line,
2385 };
2386 push(@fixed_inserted, $inserted);
2387}
2388
2389sub fix_delete_line {
2390 my ($linenr, $line) = @_;
2391
2392 my $deleted = {
2393 LINENR => $linenr,
2394 LINE => $line,
2395 };
2396
2397 push(@fixed_deleted, $deleted);
2398}
2399
2400sub ERROR {
2401 my ($type, $msg) = @_;
2402
2403 if (report("ERROR", $type, $msg)) {
2404 our $clean = 0;
2405 our $cnt_error++;
2406 return 1;
2407 }
2408 return 0;
2409}
2410sub WARN {
2411 my ($type, $msg) = @_;
2412
2413 if (report("WARNING", $type, $msg)) {
2414 our $clean = 0;
2415 our $cnt_warn++;
2416 return 1;
2417 }
2418 return 0;
2419}
2420sub CHK {
2421 my ($type, $msg) = @_;
2422
2423 if ($check && report("CHECK", $type, $msg)) {
2424 our $clean = 0;
2425 our $cnt_chk++;
2426 return 1;
2427 }
2428 return 0;
2429}
2430
2431sub check_absolute_file {
2432 my ($absolute, $herecurr) = @_;
2433 my $file = $absolute;
2434
2435 ##print "absolute<$absolute>\n";
2436
2437 # See if any suffix of this path is a path within the tree.
2438 while ($file =~ s@^[^/]*/@@) {
2439 if (-f "$root/$file") {
2440 ##print "file<$file>\n";
2441 last;
2442 }
2443 }
2444 if (! -f _) {
2445 return 0;
2446 }
2447
2448 # It is, so see if the prefix is acceptable.
2449 my $prefix = $absolute;
2450 substr($prefix, -length($file)) = '';
2451
2452 ##print "prefix<$prefix>\n";
2453 if ($prefix ne ".../") {
2454 WARN("USE_RELATIVE_PATH",
2455 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
2456 }
2457}
2458
2459sub trim {
2460 my ($string) = @_;
2461
2462 $string =~ s/^\s+|\s+$//g;
2463
2464 return $string;
2465}
2466
2467sub ltrim {
2468 my ($string) = @_;
2469
2470 $string =~ s/^\s+//;
2471
2472 return $string;
2473}
2474
2475sub rtrim {
2476 my ($string) = @_;
2477
2478 $string =~ s/\s+$//;
2479
2480 return $string;
2481}
2482
2483sub string_find_replace {
2484 my ($string, $find, $replace) = @_;
2485
2486 $string =~ s/$find/$replace/g;
2487
2488 return $string;
2489}
2490
2491sub tabify {
2492 my ($leading) = @_;
2493
2494 my $source_indent = $tabsize;
2495 my $max_spaces_before_tab = $source_indent - 1;
2496 my $spaces_to_tab = " " x $source_indent;
2497
2498 #convert leading spaces to tabs
2499 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2500 #Remove spaces before a tab
2501 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2502
2503 return "$leading";
2504}
2505
2506sub pos_last_openparen {
2507 my ($line) = @_;
2508
2509 my $pos = 0;
2510
2511 my $opens = $line =~ tr/\(/\(/;
2512 my $closes = $line =~ tr/\)/\)/;
2513
2514 my $last_openparen = 0;
2515
2516 if (($opens == 0) || ($closes >= $opens)) {
2517 return -1;
2518 }
2519
2520 my $len = length($line);
2521
2522 for ($pos = 0; $pos < $len; $pos++) {
2523 my $string = substr($line, $pos);
2524 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2525 $pos += length($1) - 1;
2526 } elsif (substr($line, $pos, 1) eq '(') {
2527 $last_openparen = $pos;
2528 } elsif (index($string, '(') == -1) {
2529 last;
2530 }
2531 }
2532
2533 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2534}
2535
2536sub get_raw_comment {
2537 my ($line, $rawline) = @_;
2538 my $comment = '';
2539
2540 for my $i (0 .. (length($line) - 1)) {
2541 if (substr($line, $i, 1) eq "$;") {
2542 $comment .= substr($rawline, $i, 1);
2543 }
2544 }
2545
2546 return $comment;
2547}
2548
2549sub exclude_global_initialisers {
2550 my ($realfile) = @_;
2551
2552 # Do not check for BPF programs (tools/testing/selftests/bpf/progs/*.c, samples/bpf/*_kern.c, *.bpf.c).
2553 return $realfile =~ m@^tools/testing/selftests/bpf/progs/.*\.c$@ ||
2554 $realfile =~ m@^samples/bpf/.*_kern\.c$@ ||
2555 $realfile =~ m@/bpf/.*\.bpf\.c$@;
2556}
2557
2558sub process {
2559 my $filename = shift;
2560
2561 my $linenr=0;
2562 my $prevline="";
2563 my $prevrawline="";
2564 my $stashline="";
2565 my $stashrawline="";
2566
2567 my $length;
2568 my $indent;
2569 my $previndent=0;
2570 my $stashindent=0;
2571
2572 our $clean = 1;
2573 my $signoff = 0;
2574 my $author = '';
2575 my $authorsignoff = 0;
2576 my $author_sob = '';
2577 my $is_patch = 0;
2578 my $is_binding_patch = -1;
2579 my $in_header_lines = $file ? 0 : 1;
2580 my $in_commit_log = 0; #Scanning lines before patch
2581 my $has_patch_separator = 0; #Found a --- line
2582 my $has_commit_log = 0; #Encountered lines before patch
2583 my $commit_log_lines = 0; #Number of commit log lines
2584 my $commit_log_possible_stack_dump = 0;
2585 my $commit_log_long_line = 0;
2586 my $commit_log_has_diff = 0;
2587 my $reported_maintainer_file = 0;
2588 my $non_utf8_charset = 0;
2589
2590 my $last_git_commit_id_linenr = -1;
2591
2592 my $last_blank_line = 0;
2593 my $last_coalesced_string_linenr = -1;
2594
2595 our @report = ();
2596 our $cnt_lines = 0;
2597 our $cnt_error = 0;
2598 our $cnt_warn = 0;
2599 our $cnt_chk = 0;
2600
2601 # Trace the real file/line as we go.
2602 my $realfile = '';
2603 my $realline = 0;
2604 my $realcnt = 0;
2605 my $here = '';
2606 my $context_function; #undef'd unless there's a known function
2607 my $in_comment = 0;
2608 my $comment_edge = 0;
2609 my $first_line = 0;
2610 my $p1_prefix = '';
2611
2612 my $prev_values = 'E';
2613
2614 # suppression flags
2615 my %suppress_ifbraces;
2616 my %suppress_whiletrailers;
2617 my %suppress_export;
2618 my $suppress_statement = 0;
2619
2620 my %signatures = ();
2621
2622 # Pre-scan the patch sanitizing the lines.
2623 # Pre-scan the patch looking for any __setup documentation.
2624 #
2625 my @setup_docs = ();
2626 my $setup_docs = 0;
2627
2628 my $camelcase_file_seeded = 0;
2629
2630 my $checklicenseline = 1;
2631
2632 sanitise_line_reset();
2633 my $line;
2634 foreach my $rawline (@rawlines) {
2635 $linenr++;
2636 $line = $rawline;
2637
2638 push(@fixed, $rawline) if ($fix);
2639
2640 if ($rawline=~/^\+\+\+\s+(\S+)/) {
2641 $setup_docs = 0;
2642 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) {
2643 $setup_docs = 1;
2644 }
2645 #next;
2646 }
2647 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2648 $realline=$1-1;
2649 if (defined $2) {
2650 $realcnt=$3+1;
2651 } else {
2652 $realcnt=1+1;
2653 }
2654 $in_comment = 0;
2655
2656 # Guestimate if this is a continuing comment. Run
2657 # the context looking for a comment "edge". If this
2658 # edge is a close comment then we must be in a comment
2659 # at context start.
2660 my $edge;
2661 my $cnt = $realcnt;
2662 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2663 next if (defined $rawlines[$ln - 1] &&
2664 $rawlines[$ln - 1] =~ /^-/);
2665 $cnt--;
2666 #print "RAW<$rawlines[$ln - 1]>\n";
2667 last if (!defined $rawlines[$ln - 1]);
2668 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2669 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2670 ($edge) = $1;
2671 last;
2672 }
2673 }
2674 if (defined $edge && $edge eq '*/') {
2675 $in_comment = 1;
2676 }
2677
2678 # Guestimate if this is a continuing comment. If this
2679 # is the start of a diff block and this line starts
2680 # ' *' then it is very likely a comment.
2681 if (!defined $edge &&
2682 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2683 {
2684 $in_comment = 1;
2685 }
2686
2687 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2688 sanitise_line_reset($in_comment);
2689
2690 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2691 # Standardise the strings and chars within the input to
2692 # simplify matching -- only bother with positive lines.
2693 $line = sanitise_line($rawline);
2694 }
2695 push(@lines, $line);
2696
2697 if ($realcnt > 1) {
2698 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2699 } else {
2700 $realcnt = 0;
2701 }
2702
2703 #print "==>$rawline\n";
2704 #print "-->$line\n";
2705
2706 if ($setup_docs && $line =~ /^\+/) {
2707 push(@setup_docs, $line);
2708 }
2709 }
2710
2711 $prefix = '';
2712
2713 $realcnt = 0;
2714 $linenr = 0;
2715 $fixlinenr = -1;
2716 foreach my $line (@lines) {
2717 $linenr++;
2718 $fixlinenr++;
2719 my $sline = $line; #copy of $line
2720 $sline =~ s/$;/ /g; #with comments as spaces
2721
2722 my $rawline = $rawlines[$linenr - 1];
2723 my $raw_comment = get_raw_comment($line, $rawline);
2724
2725# check if it's a mode change, rename or start of a patch
2726 if (!$in_commit_log &&
2727 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2728 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2729 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2730 $is_patch = 1;
2731 }
2732
2733#extract the line range in the file after the patch is applied
2734 if (!$in_commit_log &&
2735 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2736 my $context = $4;
2737 $is_patch = 1;
2738 $first_line = $linenr + 1;
2739 $realline=$1-1;
2740 if (defined $2) {
2741 $realcnt=$3+1;
2742 } else {
2743 $realcnt=1+1;
2744 }
2745 annotate_reset();
2746 $prev_values = 'E';
2747
2748 %suppress_ifbraces = ();
2749 %suppress_whiletrailers = ();
2750 %suppress_export = ();
2751 $suppress_statement = 0;
2752 if ($context =~ /\b(\w+)\s*\(/) {
2753 $context_function = $1;
2754 } else {
2755 undef $context_function;
2756 }
2757 next;
2758
2759# track the line number as we move through the hunk, note that
2760# new versions of GNU diff omit the leading space on completely
2761# blank context lines so we need to count that too.
2762 } elsif ($line =~ /^( |\+|$)/) {
2763 $realline++;
2764 $realcnt-- if ($realcnt != 0);
2765
2766 # Measure the line length and indent.
2767 ($length, $indent) = line_stats($rawline);
2768
2769 # Track the previous line.
2770 ($prevline, $stashline) = ($stashline, $line);
2771 ($previndent, $stashindent) = ($stashindent, $indent);
2772 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2773
2774 #warn "line<$line>\n";
2775
2776 } elsif ($realcnt == 1) {
2777 $realcnt--;
2778 }
2779
2780 my $hunk_line = ($realcnt != 0);
2781
2782 $here = "#$linenr: " if (!$file);
2783 $here = "#$realline: " if ($file);
2784
2785 my $found_file = 0;
2786 # extract the filename as it passes
2787 if ($line =~ /^diff --git.*?(\S+)$/) {
2788 $realfile = $1;
2789 $realfile =~ s@^([^/]*)/@@ if (!$file);
2790 $in_commit_log = 0;
2791 $found_file = 1;
2792 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2793 $realfile = $1;
2794 $realfile =~ s@^([^/]*)/@@ if (!$file);
2795 $in_commit_log = 0;
2796
2797 $p1_prefix = $1;
2798 if (!$file && $tree && $p1_prefix ne '' &&
2799 -e "$p1_prefix") {
2800 WARN("PATCH_PREFIX",
2801 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2802 }
2803
2804 if ($realfile =~ m@^include/asm/@) {
2805 ERROR("MODIFIED_INCLUDE_ASM",
2806 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2807 }
2808 $found_file = 1;
2809 }
2810
2811#make up the handle for any error we report on this line
2812 if ($showfile) {
2813 $prefix = "$realfile:$realline: "
2814 } elsif ($emacs) {
2815 if ($file) {
2816 $prefix = "$filename:$realline: ";
2817 } else {
2818 $prefix = "$filename:$linenr: ";
2819 }
2820 }
2821
2822 if ($found_file) {
2823 #if (is_maintained_obsolete($realfile)) {
2824 # WARN("OBSOLETE",
2825 # "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2826 #}
2827 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2828 $check = 1;
2829 } else {
2830 $check = $check_orig;
2831 }
2832 $checklicenseline = 1;
2833
2834 if ($realfile !~ /^MAINTAINERS/) {
2835 my $last_binding_patch = $is_binding_patch;
2836
2837 $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2838
2839 if (($last_binding_patch != -1) &&
2840 ($last_binding_patch ^ $is_binding_patch)) {
2841 #WARN("DT_SPLIT_BINDING_PATCH",
2842 # "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n");
2843 }
2844 }
2845
2846 next;
2847 }
2848
2849 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2850
2851 my $hereline = "$here\n$rawline\n";
2852 my $herecurr = "$here\n$rawline\n";
2853 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2854
2855 $cnt_lines++ if ($realcnt != 0);
2856
2857# Verify the existence of a commit log if appropriate
2858# 2 is used because a $signature is counted in $commit_log_lines
2859 if ($in_commit_log) {
2860 if ($line !~ /^\s*$/) {
2861 $commit_log_lines++; #could be a $signature
2862 }
2863 } elsif ($has_commit_log && $commit_log_lines < 2) {
2864 #WARN("COMMIT_MESSAGE",
2865 # "Missing commit description - Add an appropriate one\n");
2866 #$commit_log_lines = 2; #warn only once
2867 }
2868
2869# Check if the commit log has what seems like a diff which can confuse patch
2870 if ($in_commit_log && !$commit_log_has_diff &&
2871 (($line =~ m@^\s+diff\b.*a/([\w/]+)@ &&
2872 $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) ||
2873 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2874 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2875 ERROR("DIFF_IN_COMMIT_MSG",
2876 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2877 $commit_log_has_diff = 1;
2878 }
2879
2880# Check for incorrect file permissions
2881 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2882 my $permhere = $here . "FILE: $realfile\n";
2883 if ($realfile !~ m@scripts/@ &&
2884 $realfile !~ /\.(py|pl|awk|sh)$/) {
2885 ERROR("EXECUTE_PERMISSIONS",
2886 "do not set execute permissions for source files\n" . $permhere);
2887 }
2888 }
2889
2890# Check the patch for a From:
2891 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2892 $author = $1;
2893 my $curline = $linenr;
2894 while(defined($rawlines[$curline]) && ($rawlines[$curline++] =~ /^[ \t]\s*(.*)/)) {
2895 $author .= $1;
2896 }
2897 $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2898 $author =~ s/"//g;
2899 $author = reformat_email($author);
2900 }
2901
2902# Check the patch for a signoff:
2903 if ($line =~ /^\s*signed-off-by:\s*(.*)/i) {
2904 $signoff++;
2905 $in_commit_log = 0;
2906 if ($author ne '' && $authorsignoff != 1) {
2907 if (same_email_addresses($1, $author)) {
2908 $authorsignoff = 1;
2909 } else {
2910 my $ctx = $1;
2911 my ($email_name, $email_comment, $email_address, $comment1) = parse_email($ctx);
2912 my ($author_name, $author_comment, $author_address, $comment2) = parse_email($author);
2913
2914 if (lc $email_address eq lc $author_address && $email_name eq $author_name) {
2915 $author_sob = $ctx;
2916 $authorsignoff = 2;
2917 } elsif (lc $email_address eq lc $author_address) {
2918 $author_sob = $ctx;
2919 $authorsignoff = 3;
2920 } elsif ($email_name eq $author_name) {
2921 $author_sob = $ctx;
2922 $authorsignoff = 4;
2923
2924 my $address1 = $email_address;
2925 my $address2 = $author_address;
2926
2927 if ($address1 =~ /(\S+)\+\S+(\@.*)/) {
2928 $address1 = "$1$2";
2929 }
2930 if ($address2 =~ /(\S+)\+\S+(\@.*)/) {
2931 $address2 = "$1$2";
2932 }
2933 if ($address1 eq $address2) {
2934 $authorsignoff = 5;
2935 }
2936 }
2937 }
2938 }
2939 }
2940
2941# Check for patch separator
2942 if ($line =~ /^---$/) {
2943 $has_patch_separator = 1;
2944 $in_commit_log = 0;
2945 }
2946
2947# Check if MAINTAINERS is being updated. If so, there's probably no need to
2948# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2949 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2950 $reported_maintainer_file = 1;
2951 }
2952
2953# Check signature styles
2954 if (!$in_header_lines &&
2955 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2956 my $space_before = $1;
2957 my $sign_off = $2;
2958 my $space_after = $3;
2959 my $email = $4;
2960 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2961
2962 if ($sign_off !~ /$signature_tags/) {
2963 my $suggested_signature = find_standard_signature($sign_off);
2964 if ($suggested_signature eq "") {
2965 WARN("BAD_SIGN_OFF",
2966 "Non-standard signature: $sign_off\n" . $herecurr);
2967 } else {
2968 if (WARN("BAD_SIGN_OFF",
2969 "Non-standard signature: '$sign_off' - perhaps '$suggested_signature'?\n" . $herecurr) &&
2970 $fix) {
2971 $fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/;
2972 }
2973 }
2974 }
2975 if (defined $space_before && $space_before ne "") {
2976 if (WARN("BAD_SIGN_OFF",
2977 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2978 $fix) {
2979 $fixed[$fixlinenr] =
2980 "$ucfirst_sign_off $email";
2981 }
2982 }
2983 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2984 if (WARN("BAD_SIGN_OFF",
2985 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2986 $fix) {
2987 $fixed[$fixlinenr] =
2988 "$ucfirst_sign_off $email";
2989 }
2990
2991 }
2992 if (!defined $space_after || $space_after ne " ") {
2993 if (WARN("BAD_SIGN_OFF",
2994 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2995 $fix) {
2996 $fixed[$fixlinenr] =
2997 "$ucfirst_sign_off $email";
2998 }
2999 }
3000
3001 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
3002 my $suggested_email = format_email(($email_name, $name_comment, $email_address, $comment));
3003 if ($suggested_email eq "") {
3004 #ERROR("BAD_SIGN_OFF",
3005 # "Unrecognized email address: '$email'\n" . $herecurr);
3006 } else {
3007 my $dequoted = $suggested_email;
3008 $dequoted =~ s/^"//;
3009 $dequoted =~ s/" </ </;
3010 # Don't force email to have quotes
3011 # Allow just an angle bracketed address
3012 if (!same_email_addresses($email, $suggested_email)) {
3013 if (WARN("BAD_SIGN_OFF",
3014 "email address '$email' might be better as '$suggested_email'\n" . $herecurr) &&
3015 $fix) {
3016 $fixed[$fixlinenr] =~ s/\Q$email\E/$suggested_email/;
3017 }
3018 }
3019
3020 # Address part shouldn't have comments
3021 my $stripped_address = $email_address;
3022 $stripped_address =~ s/\([^\(\)]*\)//g;
3023 if ($email_address ne $stripped_address) {
3024 if (WARN("BAD_SIGN_OFF",
3025 "address part of email should not have comments: '$email_address'\n" . $herecurr) &&
3026 $fix) {
3027 $fixed[$fixlinenr] =~ s/\Q$email_address\E/$stripped_address/;
3028 }
3029 }
3030
3031 # Only one name comment should be allowed
3032 my $comment_count = () = $name_comment =~ /\([^\)]+\)/g;
3033 if ($comment_count > 1) {
3034 WARN("BAD_SIGN_OFF",
3035 "Use a single name comment in email: '$email'\n" . $herecurr);
3036 }
3037
3038
3039 # stable@vger.kernel.org or stable@kernel.org shouldn't
3040 # have an email name. In addition comments should strictly
3041 # begin with a #
3042 if ($email =~ /^.*stable\@(?:vger\.)?kernel\.org/i) {
3043 if (($comment ne "" && $comment !~ /^#.+/) ||
3044 ($email_name ne "")) {
3045 my $cur_name = $email_name;
3046 my $new_comment = $comment;
3047 $cur_name =~ s/[a-zA-Z\s\-\"]+//g;
3048
3049 # Remove brackets enclosing comment text
3050 # and # from start of comments to get comment text
3051 $new_comment =~ s/^\((.*)\)$/$1/;
3052 $new_comment =~ s/^\[(.*)\]$/$1/;
3053 $new_comment =~ s/^[\s\#]+|\s+$//g;
3054
3055 $new_comment = trim("$new_comment $cur_name") if ($cur_name ne $new_comment);
3056 $new_comment = " # $new_comment" if ($new_comment ne "");
3057 my $new_email = "$email_address$new_comment";
3058
3059 if (WARN("BAD_STABLE_ADDRESS_STYLE",
3060 "Invalid email format for stable: '$email', prefer '$new_email'\n" . $herecurr) &&
3061 $fix) {
3062 $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/;
3063 }
3064 }
3065 } elsif ($comment ne "" && $comment !~ /^(?:#.+|\(.+\))$/) {
3066 my $new_comment = $comment;
3067
3068 # Extract comment text from within brackets or
3069 # c89 style /*...*/ comments
3070 $new_comment =~ s/^\[(.*)\]$/$1/;
3071 $new_comment =~ s/^\/\*(.*)\*\/$/$1/;
3072
3073 $new_comment = trim($new_comment);
3074 $new_comment =~ s/^[^\w]$//; # Single lettered comment with non word character is usually a typo
3075 $new_comment = "($new_comment)" if ($new_comment ne "");
3076 my $new_email = format_email($email_name, $name_comment, $email_address, $new_comment);
3077
3078 if (WARN("BAD_SIGN_OFF",
3079 "Unexpected content after email: '$email', should be: '$new_email'\n" . $herecurr) &&
3080 $fix) {
3081 $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/;
3082 }
3083 }
3084 }
3085
3086# Check for duplicate signatures
3087 my $sig_nospace = $line;
3088 $sig_nospace =~ s/\s//g;
3089 $sig_nospace = lc($sig_nospace);
3090 if (defined $signatures{$sig_nospace}) {
3091 WARN("BAD_SIGN_OFF",
3092 "Duplicate signature\n" . $herecurr);
3093 } else {
3094 $signatures{$sig_nospace} = 1;
3095 }
3096
3097# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
3098 if ($sign_off =~ /^co-developed-by:$/i) {
3099 if ($email eq $author) {
3100 WARN("BAD_SIGN_OFF",
3101 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
3102 }
3103 if (!defined $lines[$linenr]) {
3104 WARN("BAD_SIGN_OFF",
3105 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
3106 } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
3107 WARN("BAD_SIGN_OFF",
3108 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
3109 } elsif ($1 ne $email) {
3110 WARN("BAD_SIGN_OFF",
3111 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
3112 }
3113 }
3114 }
3115
3116# Check email subject for common tools that don't need to be mentioned
3117 if ($in_header_lines &&
3118 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
3119 WARN("EMAIL_SUBJECT",
3120 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
3121 }
3122
3123# Check for Gerrit Change-Ids not in any patch context
3124 if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
3125 #if (ERROR("GERRIT_CHANGE_ID",
3126 # "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr) &&
3127 # $fix) {
3128 # fix_delete_line($fixlinenr, $rawline);
3129 #}
3130 }
3131
3132# Check if the commit log is in a possible stack dump
3133 if ($in_commit_log && !$commit_log_possible_stack_dump &&
3134 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
3135 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
3136 # timestamp
3137 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
3138 $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
3139 $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
3140 # stack dump address styles
3141 $commit_log_possible_stack_dump = 1;
3142 }
3143
3144# Check for line lengths > 75 in commit log, warn once
3145 if ($in_commit_log && !$commit_log_long_line &&
3146 length($line) > 75 &&
3147 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
3148 # file delta changes
3149 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
3150 # filename then :
3151 $line =~ /^\s*(?:Fixes:|Link:|$signature_tags)/i ||
3152 # A Fixes: or Link: line or signature tag line
3153 $commit_log_possible_stack_dump)) {
3154 WARN("COMMIT_LOG_LONG_LINE",
3155 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
3156 $commit_log_long_line = 1;
3157 }
3158
3159# Reset possible stack dump if a blank line is found
3160 if ($in_commit_log && $commit_log_possible_stack_dump &&
3161 $line =~ /^\s*$/) {
3162 $commit_log_possible_stack_dump = 0;
3163 }
3164
3165# Check for lines starting with a #
3166 if ($in_commit_log && $line =~ /^#/) {
3167 if (WARN("COMMIT_COMMENT_SYMBOL",
3168 "Commit log lines starting with '#' are dropped by git as comments\n" . $herecurr) &&
3169 $fix) {
3170 $fixed[$fixlinenr] =~ s/^/ /;
3171 }
3172 }
3173
3174# Check for git id commit length and improperly formed commit descriptions
3175# A correctly formed commit description is:
3176# commit <SHA-1 hash length 12+ chars> ("Complete commit subject")
3177# with the commit subject '("' prefix and '")' suffix
3178# This is a fairly compilicated block as it tests for what appears to be
3179# bare SHA-1 hash with minimum length of 5. It also avoids several types of
3180# possible SHA-1 matches.
3181# A commit match can span multiple lines so this block attempts to find a
3182# complete typical commit on a maximum of 3 lines
3183 if ($perl_version_ok &&
3184 $in_commit_log && !$commit_log_possible_stack_dump &&
3185 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
3186 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
3187 (($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
3188 ($line =~ /\bcommit\s*$/i && defined($rawlines[$linenr]) && $rawlines[$linenr] =~ /^\s*[0-9a-f]{5,}\b/i)) ||
3189 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
3190 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
3191 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
3192 my $init_char = "c";
3193 my $orig_commit = "";
3194 my $short = 1;
3195 my $long = 0;
3196 my $case = 1;
3197 my $space = 1;
3198 my $id = '0123456789ab';
3199 my $orig_desc = "commit description";
3200 my $description = "";
3201 my $herectx = $herecurr;
3202 my $has_parens = 0;
3203 my $has_quotes = 0;
3204
3205 my $input = $line;
3206 if ($line =~ /(?:\bcommit\s+[0-9a-f]{5,}|\bcommit\s*$)/i) {
3207 for (my $n = 0; $n < 2; $n++) {
3208 if ($input =~ /\bcommit\s+[0-9a-f]{5,}\s*($balanced_parens)/i) {
3209 $orig_desc = $1;
3210 $has_parens = 1;
3211 # Always strip leading/trailing parens then double quotes if existing
3212 $orig_desc = substr($orig_desc, 1, -1);
3213 if ($orig_desc =~ /^".*"$/) {
3214 $orig_desc = substr($orig_desc, 1, -1);
3215 $has_quotes = 1;
3216 }
3217 last;
3218 }
3219 last if ($#lines < $linenr + $n);
3220 $input .= " " . trim($rawlines[$linenr + $n]);
3221 $herectx .= "$rawlines[$linenr + $n]\n";
3222 }
3223 $herectx = $herecurr if (!$has_parens);
3224 }
3225
3226 if ($input =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
3227 $init_char = $1;
3228 $orig_commit = lc($2);
3229 $short = 0 if ($input =~ /\bcommit\s+[0-9a-f]{12,40}/i);
3230 $long = 1 if ($input =~ /\bcommit\s+[0-9a-f]{41,}/i);
3231 $space = 0 if ($input =~ /\bcommit [0-9a-f]/i);
3232 $case = 0 if ($input =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
3233 } elsif ($input =~ /\b([0-9a-f]{12,40})\b/i) {
3234 $orig_commit = lc($1);
3235 }
3236
3237 ($id, $description) = git_commit_info($orig_commit,
3238 $id, $orig_desc);
3239
3240 if (defined($id) &&
3241 ($short || $long || $space || $case || ($orig_desc ne $description) || !$has_quotes) &&
3242 $last_git_commit_id_linenr != $linenr - 1) {
3243 ERROR("GIT_COMMIT_ID",
3244 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herectx);
3245 }
3246 #don't report the next line if this line ends in commit and the sha1 hash is the next line
3247 $last_git_commit_id_linenr = $linenr if ($line =~ /\bcommit\s*$/i);
3248 }
3249
3250# Check for added, moved or deleted files
3251# if (!$reported_maintainer_file && !$in_commit_log &&
3252# ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
3253# $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
3254# ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
3255# (defined($1) || defined($2))))) {
3256# $is_patch = 1;
3257# $reported_maintainer_file = 1;
3258# WARN("FILE_PATH_CHANGES",
3259# "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
3260# }
3261
3262# Check for adding new DT bindings not in schema format
3263 if (!$in_commit_log &&
3264 ($line =~ /^new file mode\s*\d+\s*$/) &&
3265 ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {
3266 WARN("DT_SCHEMA_BINDING_PATCH",
3267 "DT bindings should be in DT schema format. See: Documentation/devicetree/bindings/writing-schema.rst\n");
3268 }
3269
3270# Check for wrappage within a valid hunk of the file
3271 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
3272 ERROR("CORRUPTED_PATCH",
3273 "patch seems to be corrupt (line wrapped?)\n" .
3274 $herecurr) if (!$emitted_corrupt++);
3275 }
3276
3277# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
3278 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
3279 $rawline !~ m/^$UTF8*$/) {
3280 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
3281
3282 my $blank = copy_spacing($rawline);
3283 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
3284 my $hereptr = "$hereline$ptr\n";
3285
3286 CHK("INVALID_UTF8",
3287 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
3288 }
3289
3290# Check if it's the start of a commit log
3291# (not a header line and we haven't seen the patch filename)
3292 if ($in_header_lines && $realfile =~ /^$/ &&
3293 !($rawline =~ /^\s+(?:\S|$)/ ||
3294 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
3295 $in_header_lines = 0;
3296 $in_commit_log = 1;
3297 $has_commit_log = 1;
3298 }
3299
3300# Check if there is UTF-8 in a commit log when a mail header has explicitly
3301# declined it, i.e defined some charset where it is missing.
3302 if ($in_header_lines &&
3303 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
3304 $1 !~ /utf-8/i) {
3305 $non_utf8_charset = 1;
3306 }
3307
3308 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
3309 $rawline =~ /$NON_ASCII_UTF8/) {
3310 WARN("UTF8_BEFORE_PATCH",
3311 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
3312 }
3313
3314# Check for absolute kernel paths in commit message
3315 if ($tree && $in_commit_log) {
3316 while ($line =~ m{(?:^|\s)(/\S*)}g) {
3317 my $file = $1;
3318
3319 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
3320 check_absolute_file($1, $herecurr)) {
3321 #
3322 } else {
3323 check_absolute_file($file, $herecurr);
3324 }
3325 }
3326 }
3327
3328# Check for various typo / spelling mistakes
3329 if (defined($misspellings) &&
3330 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
3331 while ($rawline =~ /(?:^|[^\w\-'`])($misspellings)(?:[^\w\-'`]|$)/gi) {
3332 my $typo = $1;
3333 my $blank = copy_spacing($rawline);
3334 my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo);
3335 my $hereptr = "$hereline$ptr\n";
3336 my $typo_fix = $spelling_fix{lc($typo)};
3337 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
3338 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
3339 my $msg_level = \&WARN;
3340 $msg_level = \&CHK if ($file);
3341 if (&{$msg_level}("TYPO_SPELLING",
3342 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $hereptr) &&
3343 $fix) {
3344 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
3345 }
3346 }
3347 }
3348
3349# check for invalid commit id
3350 if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
3351 my $id;
3352 my $description;
3353 ($id, $description) = git_commit_info($2, undef, undef);
3354 if (!defined($id)) {
3355 WARN("UNKNOWN_COMMIT_ID",
3356 "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
3357 }
3358 }
3359
3360# check for repeated words separated by a single space
3361# avoid false positive from list command eg, '-rw-r--r-- 1 root root'
3362 if (($rawline =~ /^\+/ || $in_commit_log) &&
3363 $rawline !~ /[bcCdDlMnpPs\?-][rwxsStT-]{9}/) {
3364 pos($rawline) = 1 if (!$in_commit_log);
3365 while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) {
3366
3367 my $first = $1;
3368 my $second = $2;
3369 my $start_pos = $-[1];
3370 my $end_pos = $+[2];
3371 if ($first =~ /(?:struct|union|enum)/) {
3372 pos($rawline) += length($first) + length($second) + 1;
3373 next;
3374 }
3375
3376 next if (lc($first) ne lc($second));
3377 next if ($first eq 'long');
3378
3379 # check for character before and after the word matches
3380 my $start_char = '';
3381 my $end_char = '';
3382 $start_char = substr($rawline, $start_pos - 1, 1) if ($start_pos > ($in_commit_log ? 0 : 1));
3383 $end_char = substr($rawline, $end_pos, 1) if ($end_pos < length($rawline));
3384
3385 next if ($start_char =~ /^\S$/);
3386 next if (index(" \t.,;?!", $end_char) == -1);
3387
3388 # avoid repeating hex occurrences like 'ff ff fe 09 ...'
3389 if ($first =~ /\b[0-9a-f]{2,}\b/i) {
3390 next if (!exists($allow_repeated_words{lc($first)}));
3391 }
3392
3393 if (WARN("REPEATED_WORD",
3394 "Possible repeated word: '$first'\n" . $herecurr) &&
3395 $fix) {
3396 $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/;
3397 }
3398 }
3399
3400 # if it's a repeated word on consecutive lines in a comment block
3401 if ($prevline =~ /$;+\s*$/ &&
3402 $prevrawline =~ /($word_pattern)\s*$/) {
3403 my $last_word = $1;
3404 if ($rawline =~ /^\+\s*\*\s*$last_word /) {
3405 if (WARN("REPEATED_WORD",
3406 "Possible repeated word: '$last_word'\n" . $hereprev) &&
3407 $fix) {
3408 $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/;
3409 }
3410 }
3411 }
3412 }
3413
3414# ignore non-hunk lines and lines being removed
3415 next if (!$hunk_line || $line =~ /^-/);
3416
3417#trailing whitespace
3418 if ($line =~ /^\+.*\015/) {
3419 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3420 if (ERROR("DOS_LINE_ENDINGS",
3421 "DOS line endings\n" . $herevet) &&
3422 $fix) {
3423 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
3424 }
3425 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
3426 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3427 if (ERROR("TRAILING_WHITESPACE",
3428 "trailing whitespace\n" . $herevet) &&
3429 $fix) {
3430 $fixed[$fixlinenr] =~ s/\s+$//;
3431 }
3432
3433 $rpt_cleaners = 1;
3434 }
3435
3436# Check for FSF mailing addresses.
3437 if ($rawline =~ /\bwrite to the Free/i ||
3438 $rawline =~ /\b675\s+Mass\s+Ave/i ||
3439 $rawline =~ /\b59\s+Temple\s+Pl/i ||
3440 $rawline =~ /\b51\s+Franklin\s+St/i) {
3441 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3442 my $msg_level = \&ERROR;
3443 $msg_level = \&CHK if ($file);
3444 &{$msg_level}("FSF_MAILING_ADDRESS",
3445 "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)
3446 }
3447
3448# check for Kconfig help text having a real description
3449# Only applies when adding the entry originally, after that we do not have
3450# sufficient context to determine whether it is indeed long enough.
3451 if ($realfile =~ /Kconfig/ &&
3452 # 'choice' is usually the last thing on the line (though
3453 # Kconfig supports named choices), so use a word boundary
3454 # (\b) rather than a whitespace character (\s)
3455 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
3456 my $length = 0;
3457 my $cnt = $realcnt;
3458 my $ln = $linenr + 1;
3459 my $f;
3460 my $is_start = 0;
3461 my $is_end = 0;
3462 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
3463 $f = $lines[$ln - 1];
3464 $cnt-- if ($lines[$ln - 1] !~ /^-/);
3465 $is_end = $lines[$ln - 1] =~ /^\+/;
3466
3467 next if ($f =~ /^-/);
3468 last if (!$file && $f =~ /^\@\@/);
3469
3470 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
3471 $is_start = 1;
3472 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
3473 $length = -1;
3474 }
3475
3476 $f =~ s/^.//;
3477 $f =~ s/#.*//;
3478 $f =~ s/^\s+//;
3479 next if ($f =~ /^$/);
3480
3481 # This only checks context lines in the patch
3482 # and so hopefully shouldn't trigger false
3483 # positives, even though some of these are
3484 # common words in help texts
3485 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
3486 if|endif|menu|endmenu|source)\b/x) {
3487 $is_end = 1;
3488 last;
3489 }
3490 $length++;
3491 }
3492 if ($is_start && $is_end && $length < $min_conf_desc_length) {
3493 #WARN("CONFIG_DESCRIPTION",
3494 # "please write a paragraph that describes the config symbol fully\n" . $herecurr);
3495 }
3496 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3497 }
3498
3499# check MAINTAINERS entries
3500 if ($realfile =~ /^MAINTAINERS$/) {
3501# check MAINTAINERS entries for the right form
3502 if ($rawline =~ /^\+[A-Z]:/ &&
3503 $rawline !~ /^\+[A-Z]:\t\S/) {
3504 if (WARN("MAINTAINERS_STYLE",
3505 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3506 $fix) {
3507 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3508 }
3509 }
3510# check MAINTAINERS entries for the right ordering too
3511 my $preferred_order = 'MRLSWQBCPTFXNK';
3512 if ($rawline =~ /^\+[A-Z]:/ &&
3513 $prevrawline =~ /^[\+ ][A-Z]:/) {
3514 $rawline =~ /^\+([A-Z]):\s*(.*)/;
3515 my $cur = $1;
3516 my $curval = $2;
3517 $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/;
3518 my $prev = $1;
3519 my $prevval = $2;
3520 my $curindex = index($preferred_order, $cur);
3521 my $previndex = index($preferred_order, $prev);
3522 if ($curindex < 0) {
3523 WARN("MAINTAINERS_STYLE",
3524 "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr);
3525 } else {
3526 if ($previndex >= 0 && $curindex < $previndex) {
3527 WARN("MAINTAINERS_STYLE",
3528 "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev);
3529 } elsif ((($prev eq 'F' && $cur eq 'F') ||
3530 ($prev eq 'X' && $cur eq 'X')) &&
3531 ($prevval cmp $curval) > 0) {
3532 WARN("MAINTAINERS_STYLE",
3533 "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev);
3534 }
3535 }
3536 }
3537 }
3538
3539 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3540 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3541 my $flag = $1;
3542 my $replacement = {
3543 'EXTRA_AFLAGS' => 'asflags-y',
3544 'EXTRA_CFLAGS' => 'ccflags-y',
3545 'EXTRA_CPPFLAGS' => 'cppflags-y',
3546 'EXTRA_LDFLAGS' => 'ldflags-y',
3547 };
3548
3549 WARN("DEPRECATED_VARIABLE",
3550 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3551 }
3552
3553# check for DT compatible documentation
3554 if (defined $root &&
3555 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3556 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3557
3558 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3559
3560 my $dt_path = $root . "/Documentation/devicetree/bindings/";
3561 my $vp_file = $dt_path . "vendor-prefixes.yaml";
3562
3563 foreach my $compat (@compats) {
3564 my $compat2 = $compat;
3565 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3566 my $compat3 = $compat;
3567 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3568 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
3569 if ( $? >> 8 ) {
3570 #WARN("UNDOCUMENTED_DT_STRING",
3571 # "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3572 }
3573
3574 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3575 my $vendor = $1;
3576 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
3577 if ( $? >> 8 ) {
3578 WARN("UNDOCUMENTED_DT_STRING",
3579 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3580 }
3581 }
3582 }
3583
3584# check for using SPDX license tag at beginning of files
3585 if ($realline == $checklicenseline) {
3586 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3587 $checklicenseline = 2;
3588 } elsif ($rawline =~ /^\+/) {
3589 my $comment = "";
3590 if ($realfile =~ /\.(h|s|S)$/) {
3591 $comment = '/*';
3592 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
3593 $comment = '//';
3594 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) {
3595 $comment = '#';
3596 } elsif ($realfile =~ /\.rst$/) {
3597 $comment = '..';
3598 }
3599
3600# check SPDX comment style for .[chsS] files
3601 if ($realfile =~ /\.[chsS]$/ &&
3602 $rawline =~ /SPDX-License-Identifier:/ &&
3603 $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
3604 WARN("SPDX_LICENSE_TAG",
3605 "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3606 }
3607
3608 if ($comment !~ /^$/ &&
3609 $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
3610 WARN("SPDX_LICENSE_TAG",
3611 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
3612 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
3613 my $spdx_license = $1;
3614 #if (!is_SPDX_License_valid($spdx_license)) {
3615 # WARN("SPDX_LICENSE_TAG",
3616 # "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3617 #}
3618 if ($realfile =~ m@^Documentation/devicetree/bindings/@ &&
3619 not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) {
3620 my $msg_level = \&WARN;
3621 $msg_level = \&CHK if ($file);
3622 if (&{$msg_level}("SPDX_LICENSE_TAG",
3623
3624 "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) &&
3625 $fix) {
3626 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3627 }
3628 }
3629 }
3630 }
3631 }
3632
3633# check for embedded filenames
3634 if ($rawline =~ /^\+.*\Q$realfile\E/) {
3635 WARN("EMBEDDED_FILENAME",
3636 "It's generally not useful to have the filename in the file\n" . $herecurr);
3637 }
3638
3639# check we are in a valid source file if not then ignore this hunk
3640 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
3641
3642# check for using SPDX-License-Identifier on the wrong line number
3643 if ($realline != $checklicenseline &&
3644 $rawline =~ /\bSPDX-License-Identifier:/ &&
3645 substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3646 WARN("SPDX_LICENSE_TAG",
3647 "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3648 }
3649
3650# line length limit (with some exclusions)
3651#
3652# There are a few types of lines that may extend beyond $max_line_length:
3653# logging functions like pr_info that end in a string
3654# lines with a single string
3655# #defines that are a single string
3656# lines with an RFC3986 like URL
3657#
3658# There are 3 different line length message types:
3659# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3660# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3661# LONG_LINE all other lines longer than $max_line_length
3662#
3663# if LONG_LINE is ignored, the other 2 types are also ignored
3664#
3665
3666 if ($line =~ /^\+/ && $length > $max_line_length) {
3667 my $msg_type = "LONG_LINE";
3668
3669 # Check the allowed long line types first
3670
3671 # logging functions that end in a string that starts
3672 # before $max_line_length
3673 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3674 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3675 $msg_type = "";
3676
3677 # lines with only strings (w/ possible termination)
3678 # #defines with only strings
3679 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3680 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3681 $msg_type = "";
3682
3683 # More special cases
3684 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3685 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
3686 $msg_type = "";
3687
3688 # URL ($rawline is used in case the URL is in a comment)
3689 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3690 $msg_type = "";
3691
3692 # Otherwise set the alternate message types
3693
3694 # a comment starts before $max_line_length
3695 } elsif ($line =~ /($;[\s$;]*)$/ &&
3696 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3697 $msg_type = "LONG_LINE_COMMENT"
3698
3699 # a quoted string starts before $max_line_length
3700 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3701 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3702 $msg_type = "LONG_LINE_STRING"
3703 }
3704
3705 if ($msg_type ne "" &&
3706 (show_type("LONG_LINE") || show_type($msg_type))) {
3707 my $msg_level = \&WARN;
3708 $msg_level = \&CHK if ($file);
3709 &{$msg_level}($msg_type,
3710 "line length of $length exceeds $max_line_length columns\n" . $herecurr);
3711 }
3712 }
3713
3714# check for adding lines without a newline.
3715 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3716 if (WARN("MISSING_EOF_NEWLINE",
3717 "adding a line without newline at end of file\n" . $herecurr) &&
3718 $fix) {
3719 fix_delete_line($fixlinenr+1, "No newline at end of file");
3720 }
3721 }
3722
3723# check for .L prefix local symbols in .S files
3724 if ($realfile =~ /\.S$/ &&
3725 $line =~ /^\+\s*(?:[A-Z]+_)?SYM_[A-Z]+_(?:START|END)(?:_[A-Z_]+)?\s*\(\s*\.L/) {
3726 WARN("AVOID_L_PREFIX",
3727 "Avoid using '.L' prefixed local symbol names for denoting a range of code via 'SYM_*_START/END' annotations; see Documentation/asm-annotations.rst\n" . $herecurr);
3728 }
3729
3730# check we are in a valid source file C or perl if not then ignore this hunk
3731 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
3732
3733# at the beginning of a line any tabs must come first and anything
3734# more than $tabsize must use tabs.
3735 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3736 $rawline =~ /^\+\s* \s*/) {
3737 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3738 $rpt_cleaners = 1;
3739 if (ERROR("CODE_INDENT",
3740 "code indent should use tabs where possible\n" . $herevet) &&
3741 $fix) {
3742 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3743 }
3744 }
3745
3746# check for space before tabs.
3747 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3748 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3749 if (WARN("SPACE_BEFORE_TAB",
3750 "please, no space before tabs\n" . $herevet) &&
3751 $fix) {
3752 while ($fixed[$fixlinenr] =~
3753 s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {}
3754 while ($fixed[$fixlinenr] =~
3755 s/(^\+.*) +\t/$1\t/) {}
3756 }
3757 }
3758
3759# check for assignments on the start of a line
3760 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3761 my $operator = $1;
3762 if (CHK("ASSIGNMENT_CONTINUATIONS",
3763 "Assignment operator '$1' should be on the previous line\n" . $hereprev) &&
3764 $fix && $prevrawline =~ /^\+/) {
3765 # add assignment operator to the previous line, remove from current line
3766 $fixed[$fixlinenr - 1] .= " $operator";
3767 $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
3768 }
3769 }
3770
3771# check for && or || at the start of a line
3772 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3773 my $operator = $1;
3774 if (CHK("LOGICAL_CONTINUATIONS",
3775 "Logical continuations should be on the previous line\n" . $hereprev) &&
3776 $fix && $prevrawline =~ /^\+/) {
3777 # insert logical operator at last non-comment, non-whitepsace char on previous line
3778 $prevline =~ /[\s$;]*$/;
3779 my $line_end = substr($prevrawline, $-[0]);
3780 $fixed[$fixlinenr - 1] =~ s/\Q$line_end\E$/ $operator$line_end/;
3781 $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
3782 }
3783 }
3784
3785# check indentation starts on a tab stop
3786 if ($perl_version_ok &&
3787 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3788 my $indent = length($1);
3789 if ($indent % $tabsize) {
3790 if (WARN("TABSTOP",
3791 "Statements should start on a tabstop\n" . $herecurr) &&
3792 $fix) {
3793 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e;
3794 }
3795 }
3796 }
3797
3798# check multi-line statement indentation matches previous line
3799# if ($perl_version_ok &&
3800# $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3801# $prevline =~ /^\+(\t*)(.*)$/;
3802# my $oldindent = $1;
3803# my $rest = $2;
3804#
3805# my $pos = pos_last_openparen($rest);
3806# if ($pos >= 0) {
3807# $line =~ /^(\+| )([ \t]*)/;
3808# my $newindent = $2;
3809#
3810# my $goodtabindent = $oldindent .
3811# "\t" x ($pos / $tabsize) .
3812# " " x ($pos % $tabsize);
3813# my $goodspaceindent = $oldindent . " " x $pos;
3814#
3815# if ($newindent ne $goodtabindent &&
3816# $newindent ne $goodspaceindent) {
3817#
3818# if (CHK("PARENTHESIS_ALIGNMENT",
3819# "Alignment should match open parenthesis\n" . $hereprev) &&
3820# $fix && $line =~ /^\+/) {
3821# $fixed[$fixlinenr] =~
3822# s/^\+[ \t]*/\+$goodtabindent/;
3823# }
3824# }
3825# }
3826# }
3827#
3828# check for space after cast like "(int) foo" or "(struct foo) bar"
3829# avoid checking a few false positives:
3830# "sizeof(<type>)" or "__alignof__(<type>)"
3831# function pointer declarations like "(*foo)(int) = bar;"
3832# structure definitions like "(struct foo) { 0 };"
3833# multiline macros that define functions
3834# known attributes or the __attribute__ keyword
3835 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3836 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
3837 if (CHK("SPACING",
3838 "No space is necessary after a cast\n" . $herecurr) &&
3839 $fix) {
3840 $fixed[$fixlinenr] =~
3841 s/(\(\s*$Type\s*\))[ \t]+/$1/;
3842 }
3843 }
3844
3845# Block comment styles
3846# Networking with an initial /*
3847 if ($realfile =~ m@^(drivers/net/|net/)@ &&
3848 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
3849 $rawline =~ /^\+[ \t]*\*/ &&
3850 $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier
3851 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3852 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3853 }
3854
3855# Block comments use * on subsequent lines
3856 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3857 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
3858 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
3859 $rawline =~ /^\+/ && #line is new
3860 $rawline !~ /^\+[ \t]*\*/) { #no leading *
3861 WARN("BLOCK_COMMENT_STYLE",
3862 "Block comments use * on subsequent lines\n" . $hereprev);
3863 }
3864
3865# Block comments use */ on trailing lines
3866 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
3867 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3868 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3869 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
3870 WARN("BLOCK_COMMENT_STYLE",
3871 "Block comments use a trailing */ on a separate line\n" . $herecurr);
3872 }
3873
3874# Block comment * alignment
3875 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3876 $line =~ /^\+[ \t]*$;/ && #leading comment
3877 $rawline =~ /^\+[ \t]*\*/ && #leading *
3878 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
3879 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
3880 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3881 my $oldindent;
3882 $prevrawline =~ m@^\+([ \t]*/?)\*@;
3883 if (defined($1)) {
3884 $oldindent = expand_tabs($1);
3885 } else {
3886 $prevrawline =~ m@^\+(.*/?)\*@;
3887 $oldindent = expand_tabs($1);
3888 }
3889 $rawline =~ m@^\+([ \t]*)\*@;
3890 my $newindent = $1;
3891 $newindent = expand_tabs($newindent);
3892 if (length($oldindent) ne length($newindent)) {
3893 WARN("BLOCK_COMMENT_STYLE",
3894 "Block comments should align the * on each line\n" . $hereprev);
3895 }
3896 }
3897
3898# check for missing blank lines after struct/union declarations
3899# with exceptions for various attributes and macros
3900 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3901 $line =~ /^\+/ &&
3902 !($line =~ /^\+\s*$/ ||
3903 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3904 $line =~ /^\+\s*MODULE_/i ||
3905 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3906 $line =~ /^\+[a-z_]*init/ ||
3907 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3908 $line =~ /^\+\s*DECLARE/ ||
3909 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
3910 $line =~ /^\+\s*__setup/)) {
3911 if (CHK("LINE_SPACING",
3912 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3913 $fix) {
3914 fix_insert_line($fixlinenr, "\+");
3915 }
3916 }
3917
3918# check for multiple consecutive blank lines
3919 if ($prevline =~ /^[\+ ]\s*$/ &&
3920 $line =~ /^\+\s*$/ &&
3921 $last_blank_line != ($linenr - 1)) {
3922 if (CHK("LINE_SPACING",
3923 "Please don't use multiple blank lines\n" . $hereprev) &&
3924 $fix) {
3925 fix_delete_line($fixlinenr, $rawline);
3926 }
3927
3928 $last_blank_line = $linenr;
3929 }
3930
3931# check for missing blank lines after declarations
3932# (declarations must have the same indentation and not be at the start of line)
3933 if (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/) {
3934 # use temporaries
3935 my $sl = $sline;
3936 my $pl = $prevline;
3937 # remove $Attribute/$Sparse uses to simplify comparisons
3938 $sl =~ s/\b(?:$Attribute|$Sparse)\b//g;
3939 $pl =~ s/\b(?:$Attribute|$Sparse)\b//g;
3940 if (($pl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3941 # function pointer declarations
3942 $pl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3943 # foo bar; where foo is some local typedef or #define
3944 $pl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3945 # known declaration macros
3946 $pl =~ /^\+\s+$declaration_macros/) &&
3947 # for "else if" which can look like "$Ident $Ident"
3948 !($pl =~ /^\+\s+$c90_Keywords\b/ ||
3949 # other possible extensions of declaration lines
3950 $pl =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3951 # not starting a section or a macro "\" extended line
3952 $pl =~ /(?:\{\s*|\\)$/) &&
3953 # looks like a declaration
3954 !($sl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3955 # function pointer declarations
3956 $sl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3957 # foo bar; where foo is some local typedef or #define
3958 $sl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3959 # known declaration macros
3960 $sl =~ /^\+\s+$declaration_macros/ ||
3961 # start of struct or union or enum
3962 $sl =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
3963 # start or end of block or continuation of declaration
3964 $sl =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3965 # bitfield continuation
3966 $sl =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3967 # other possible extensions of declaration lines
3968 $sl =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/)) {
3969 if (WARN("LINE_SPACING",
3970 "Missing a blank line after declarations\n" . $hereprev) &&
3971 $fix) {
3972 fix_insert_line($fixlinenr, "\+");
3973 }
3974 }
3975 }
3976
3977# check for spaces at the beginning of a line.
3978# Exceptions:
3979# 1) within comments
3980# 2) indented preprocessor commands
3981# 3) hanging labels
3982 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
3983 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3984 if (WARN("LEADING_SPACE",
3985 "please, no spaces at the start of a line\n" . $herevet) &&
3986 $fix) {
3987 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3988 }
3989 }
3990
3991# check we are in a valid C source file if not then ignore this hunk
3992 next if ($realfile !~ /\.(h|c)$/);
3993
3994# check for unusual line ending [ or (
3995 if ($line =~ /^\+.*([\[\(])\s*$/) {
3996 CHK("OPEN_ENDED_LINE",
3997 "Lines should not end with a '$1'\n" . $herecurr);
3998 }
3999
4000# check if this appears to be the start function declaration, save the name
4001 if ($sline =~ /^\+\{\s*$/ &&
4002 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
4003 $context_function = $1;
4004 }
4005
4006# check if this appears to be the end of function declaration
4007 if ($sline =~ /^\+\}\s*$/) {
4008 undef $context_function;
4009 }
4010
4011# check indentation of any line with a bare else
4012# (but not if it is a multiple line "if (foo) return bar; else return baz;")
4013# if the previous line is a break or return and is indented 1 tab more...
4014 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
4015 my $tabs = length($1) + 1;
4016 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
4017 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
4018 defined $lines[$linenr] &&
4019 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
4020 WARN("UNNECESSARY_ELSE",
4021 "else is not generally useful after a break or return\n" . $hereprev);
4022 }
4023 }
4024
4025# check indentation of a line with a break;
4026# if the previous line is a goto, return or break
4027# and is indented the same # of tabs
4028 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
4029 my $tabs = $1;
4030 if ($prevline =~ /^\+$tabs(goto|return|break)\b/) {
4031 if (WARN("UNNECESSARY_BREAK",
4032 "break is not useful after a $1\n" . $hereprev) &&
4033 $fix) {
4034 fix_delete_line($fixlinenr, $rawline);
4035 }
4036 }
4037 }
4038
4039# check for RCS/CVS revision markers
4040 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
4041 WARN("CVS_KEYWORD",
4042 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
4043 }
4044
4045# check for old HOTPLUG __dev<foo> section markings
4046 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
4047 WARN("HOTPLUG_SECTION",
4048 "Using $1 is unnecessary\n" . $herecurr);
4049 }
4050
4051# Check for potential 'bare' types
4052 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
4053 $realline_next);
4054#print "LINE<$line>\n";
4055 if ($linenr > $suppress_statement &&
4056 $realcnt && $sline =~ /.\s*\S/) {
4057 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4058 ctx_statement_block($linenr, $realcnt, 0);
4059 $stat =~ s/\n./\n /g;
4060 $cond =~ s/\n./\n /g;
4061
4062#print "linenr<$linenr> <$stat>\n";
4063 # If this statement has no statement boundaries within
4064 # it there is no point in retrying a statement scan
4065 # until we hit end of it.
4066 my $frag = $stat; $frag =~ s/;+\s*$//;
4067 if ($frag !~ /(?:{|;)/) {
4068#print "skip<$line_nr_next>\n";
4069 $suppress_statement = $line_nr_next;
4070 }
4071
4072 # Find the real next line.
4073 $realline_next = $line_nr_next;
4074 if (defined $realline_next &&
4075 (!defined $lines[$realline_next - 1] ||
4076 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
4077 $realline_next++;
4078 }
4079
4080 my $s = $stat;
4081 $s =~ s/{.*$//s;
4082
4083 # Ignore goto labels.
4084 if ($s =~ /$Ident:\*$/s) {
4085
4086 # Ignore functions being called
4087 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
4088
4089 } elsif ($s =~ /^.\s*else\b/s) {
4090
4091 # declarations always start with types
4092 } 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) {
4093 my $type = $1;
4094 $type =~ s/\s+/ /g;
4095 possible($type, "A:" . $s);
4096
4097 # definitions in global scope can only start with types
4098 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
4099 possible($1, "B:" . $s);
4100 }
4101
4102 # any (foo ... *) is a pointer cast, and foo is a type
4103 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
4104 possible($1, "C:" . $s);
4105 }
4106
4107 # Check for any sort of function declaration.
4108 # int foo(something bar, other baz);
4109 # void (*store_gdt)(x86_descr_ptr *);
4110 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
4111 my ($name_len) = length($1);
4112
4113 my $ctx = $s;
4114 substr($ctx, 0, $name_len + 1, '');
4115 $ctx =~ s/\)[^\)]*$//;
4116
4117 for my $arg (split(/\s*,\s*/, $ctx)) {
4118 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
4119
4120 possible($1, "D:" . $s);
4121 }
4122 }
4123 }
4124
4125 }
4126
4127#
4128# Checks which may be anchored in the context.
4129#
4130
4131# Check for switch () and associated case and default
4132# statements should be at the same indent.
4133 if ($line=~/\bswitch\s*\(.*\)/) {
4134 my $err = '';
4135 my $sep = '';
4136 my @ctx = ctx_block_outer($linenr, $realcnt);
4137 shift(@ctx);
4138 for my $ctx (@ctx) {
4139 my ($clen, $cindent) = line_stats($ctx);
4140 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
4141 $indent != $cindent) {
4142 $err .= "$sep$ctx\n";
4143 $sep = '';
4144 } else {
4145 $sep = "[...]\n";
4146 }
4147 }
4148 if ($err ne '') {
4149 ERROR("SWITCH_CASE_INDENT_LEVEL",
4150 "switch and case should be at the same indent\n$hereline$err");
4151 }
4152 }
4153
4154# if/while/etc brace do not go on next line, unless defining a do while loop,
4155# or if that brace on the next line is for something else
4156 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
4157 my $pre_ctx = "$1$2";
4158
4159 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
4160
4161 if ($line =~ /^\+\t{6,}/) {
4162 WARN("DEEP_INDENTATION",
4163 "Too many leading tabs - consider code refactoring\n" . $herecurr);
4164 }
4165
4166 my $ctx_cnt = $realcnt - $#ctx - 1;
4167 my $ctx = join("\n", @ctx);
4168
4169 my $ctx_ln = $linenr;
4170 my $ctx_skip = $realcnt;
4171
4172 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
4173 defined $lines[$ctx_ln - 1] &&
4174 $lines[$ctx_ln - 1] =~ /^-/)) {
4175 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
4176 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
4177 $ctx_ln++;
4178 }
4179
4180 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
4181 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
4182
4183 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
4184 ERROR("OPEN_BRACE",
4185 "that open brace { should be on the previous line\n" .
4186 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
4187 }
4188 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
4189 $ctx =~ /\)\s*\;\s*$/ &&
4190 defined $lines[$ctx_ln - 1])
4191 {
4192 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
4193 if ($nindent > $indent) {
4194 WARN("TRAILING_SEMICOLON",
4195 "trailing semicolon indicates no statements, indent implies otherwise\n" .
4196 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
4197 }
4198 }
4199 }
4200
4201# Check relative indent for conditionals and blocks.
4202 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
4203 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4204 ctx_statement_block($linenr, $realcnt, 0)
4205 if (!defined $stat);
4206 my ($s, $c) = ($stat, $cond);
4207
4208 substr($s, 0, length($c), '');
4209
4210 # remove inline comments
4211 $s =~ s/$;/ /g;
4212 $c =~ s/$;/ /g;
4213
4214 # Find out how long the conditional actually is.
4215 my @newlines = ($c =~ /\n/gs);
4216 my $cond_lines = 1 + $#newlines;
4217
4218 # Make sure we remove the line prefixes as we have
4219 # none on the first line, and are going to readd them
4220 # where necessary.
4221 $s =~ s/\n./\n/gs;
4222 while ($s =~ /\n\s+\\\n/) {
4223 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
4224 }
4225
4226 # We want to check the first line inside the block
4227 # starting at the end of the conditional, so remove:
4228 # 1) any blank line termination
4229 # 2) any opening brace { on end of the line
4230 # 3) any do (...) {
4231 my $continuation = 0;
4232 my $check = 0;
4233 $s =~ s/^.*\bdo\b//;
4234 $s =~ s/^\s*{//;
4235 if ($s =~ s/^\s*\\//) {
4236 $continuation = 1;
4237 }
4238 if ($s =~ s/^\s*?\n//) {
4239 $check = 1;
4240 $cond_lines++;
4241 }
4242
4243 # Also ignore a loop construct at the end of a
4244 # preprocessor statement.
4245 if (($prevline =~ /^.\s*#\s*define\s/ ||
4246 $prevline =~ /\\\s*$/) && $continuation == 0) {
4247 $check = 0;
4248 }
4249
4250 my $cond_ptr = -1;
4251 $continuation = 0;
4252 while ($cond_ptr != $cond_lines) {
4253 $cond_ptr = $cond_lines;
4254
4255 # If we see an #else/#elif then the code
4256 # is not linear.
4257 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
4258 $check = 0;
4259 }
4260
4261 # Ignore:
4262 # 1) blank lines, they should be at 0,
4263 # 2) preprocessor lines, and
4264 # 3) labels.
4265 if ($continuation ||
4266 $s =~ /^\s*?\n/ ||
4267 $s =~ /^\s*#\s*?/ ||
4268 $s =~ /^\s*$Ident\s*:/) {
4269 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
4270 if ($s =~ s/^.*?\n//) {
4271 $cond_lines++;
4272 }
4273 }
4274 }
4275
4276 my (undef, $sindent) = line_stats("+" . $s);
4277 my $stat_real = raw_line($linenr, $cond_lines);
4278
4279 # Check if either of these lines are modified, else
4280 # this is not this patch's fault.
4281 if (!defined($stat_real) ||
4282 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
4283 $check = 0;
4284 }
4285 if (defined($stat_real) && $cond_lines > 1) {
4286 $stat_real = "[...]\n$stat_real";
4287 }
4288
4289 #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";
4290
4291 if ($check && $s ne '' &&
4292 (($sindent % $tabsize) != 0 ||
4293 ($sindent < $indent) ||
4294 ($sindent == $indent &&
4295 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
4296 ($sindent > $indent + $tabsize))) {
4297 WARN("SUSPECT_CODE_INDENT",
4298 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
4299 }
4300 }
4301
4302 # Track the 'values' across context and added lines.
4303 my $opline = $line; $opline =~ s/^./ /;
4304 my ($curr_values, $curr_vars) =
4305 annotate_values($opline . "\n", $prev_values);
4306 $curr_values = $prev_values . $curr_values;
4307 if ($dbg_values) {
4308 my $outline = $opline; $outline =~ s/\t/ /g;
4309 print "$linenr > .$outline\n";
4310 print "$linenr > $curr_values\n";
4311 print "$linenr > $curr_vars\n";
4312 }
4313 $prev_values = substr($curr_values, -1);
4314
4315#ignore lines not being added
4316 next if ($line =~ /^[^\+]/);
4317
4318# check for self assignments used to avoid compiler warnings
4319# e.g.: int foo = foo, *bar = NULL;
4320# struct foo bar = *(&(bar));
4321 if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) {
4322 my $var = $1;
4323 if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) {
4324 WARN("SELF_ASSIGNMENT",
4325 "Do not use self-assignments to avoid compiler warnings\n" . $herecurr);
4326 }
4327 }
4328
4329# check for dereferences that span multiple lines
4330 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
4331 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
4332 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
4333 my $ref = $1;
4334 $line =~ /^.\s*($Lval)/;
4335 $ref .= $1;
4336 $ref =~ s/\s//g;
4337 WARN("MULTILINE_DEREFERENCE",
4338 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
4339 }
4340
4341# check for declarations of signed or unsigned without int
4342 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
4343 my $type = $1;
4344 my $var = $2;
4345 $var = "" if (!defined $var);
4346 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
4347 my $sign = $1;
4348 my $pointer = $2;
4349
4350 $pointer = "" if (!defined $pointer);
4351
4352 if (WARN("UNSPECIFIED_INT",
4353 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
4354 $fix) {
4355 my $decl = trim($sign) . " int ";
4356 my $comp_pointer = $pointer;
4357 $comp_pointer =~ s/\s//g;
4358 $decl .= $comp_pointer;
4359 $decl = rtrim($decl) if ($var eq "");
4360 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
4361 }
4362 }
4363 }
4364
4365# TEST: allow direct testing of the type matcher.
4366 if ($dbg_type) {
4367 if ($line =~ /^.\s*$Declare\s*$/) {
4368 ERROR("TEST_TYPE",
4369 "TEST: is type\n" . $herecurr);
4370 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
4371 ERROR("TEST_NOT_TYPE",
4372 "TEST: is not type ($1 is)\n". $herecurr);
4373 }
4374 next;
4375 }
4376# TEST: allow direct testing of the attribute matcher.
4377 if ($dbg_attr) {
4378 if ($line =~ /^.\s*$Modifier\s*$/) {
4379 ERROR("TEST_ATTR",
4380 "TEST: is attr\n" . $herecurr);
4381 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
4382 ERROR("TEST_NOT_ATTR",
4383 "TEST: is not attr ($1 is)\n". $herecurr);
4384 }
4385 next;
4386 }
4387
4388# check for initialisation to aggregates open brace on the next line
4389 if ($line =~ /^.\s*{/ &&
4390 $prevline =~ /(?:^|[^=])=\s*$/) {
4391 if (ERROR("OPEN_BRACE",
4392 "that open brace { should be on the previous line\n" . $hereprev) &&
4393 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4394 fix_delete_line($fixlinenr - 1, $prevrawline);
4395 fix_delete_line($fixlinenr, $rawline);
4396 my $fixedline = $prevrawline;
4397 $fixedline =~ s/\s*=\s*$/ = {/;
4398 fix_insert_line($fixlinenr, $fixedline);
4399 $fixedline = $line;
4400 $fixedline =~ s/^(.\s*)\{\s*/$1/;
4401 fix_insert_line($fixlinenr, $fixedline);
4402 }
4403 }
4404
4405#
4406# Checks which are anchored on the added line.
4407#
4408
4409# check for malformed paths in #include statements (uses RAW line)
4410 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
4411 my $path = $1;
4412 if ($path =~ m{//}) {
4413 ERROR("MALFORMED_INCLUDE",
4414 "malformed #include filename\n" . $herecurr);
4415 }
4416 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
4417 ERROR("UAPI_INCLUDE",
4418 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
4419 }
4420 }
4421
4422# no C99 // comments
4423 if ($line =~ m{//}) {
4424 if (ERROR("C99_COMMENTS",
4425 "do not use C99 // comments\n" . $herecurr) &&
4426 $fix) {
4427 my $line = $fixed[$fixlinenr];
4428 if ($line =~ /\/\/(.*)$/) {
4429 my $comment = trim($1);
4430 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
4431 }
4432 }
4433 }
4434 # Remove C99 comments.
4435 $line =~ s@//.*@@;
4436 $opline =~ s@//.*@@;
4437
4438# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
4439# the whole statement.
4440#print "APW <$lines[$realline_next - 1]>\n";
4441 if (defined $realline_next &&
4442 exists $lines[$realline_next - 1] &&
4443 !defined $suppress_export{$realline_next} &&
4444 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/)) {
4445 # Handle definitions which produce identifiers with
4446 # a prefix:
4447 # XXX(foo);
4448 # EXPORT_SYMBOL(something_foo);
4449 my $name = $1;
4450 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
4451 $name =~ /^${Ident}_$2/) {
4452#print "FOO C name<$name>\n";
4453 $suppress_export{$realline_next} = 1;
4454
4455 } elsif ($stat !~ /(?:
4456 \n.}\s*$|
4457 ^.DEFINE_$Ident\(\Q$name\E\)|
4458 ^.DECLARE_$Ident\(\Q$name\E\)|
4459 ^.LIST_HEAD\(\Q$name\E\)|
4460 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
4461 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
4462 )/x) {
4463#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
4464 $suppress_export{$realline_next} = 2;
4465 } else {
4466 $suppress_export{$realline_next} = 1;
4467 }
4468 }
4469 if (!defined $suppress_export{$linenr} &&
4470 $prevline =~ /^.\s*$/ &&
4471 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/)) {
4472#print "FOO B <$lines[$linenr - 1]>\n";
4473 $suppress_export{$linenr} = 2;
4474 }
4475 if (defined $suppress_export{$linenr} &&
4476 $suppress_export{$linenr} == 2) {
4477 WARN("EXPORT_SYMBOL",
4478 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
4479 }
4480
4481# check for global initialisers.
4482 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/ &&
4483 !exclude_global_initialisers($realfile)) {
4484 if (ERROR("GLOBAL_INITIALISERS",
4485 "do not initialise globals to $1\n" . $herecurr) &&
4486 $fix) {
4487 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
4488 }
4489 }
4490# check for static initialisers.
4491 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
4492 if (ERROR("INITIALISED_STATIC",
4493 "do not initialise statics to $1\n" .
4494 $herecurr) &&
4495 $fix) {
4496 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
4497 }
4498 }
4499
4500# check for misordered declarations of char/short/int/long with signed/unsigned
4501 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
4502 my $tmp = trim($1);
4503 WARN("MISORDERED_TYPE",
4504 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4505 }
4506
4507# check for unnecessary <signed> int declarations of short/long/long long
4508 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
4509 my $type = trim($1);
4510 next if ($type !~ /\bint\b/);
4511 next if ($type !~ /\b(?:short|long\s+long|long)\b/);
4512 my $new_type = $type;
4513 $new_type =~ s/\b\s*int\s*\b/ /;
4514 $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
4515 $new_type =~ s/^const\s+//;
4516 $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
4517 $new_type = "const $new_type" if ($type =~ /^const\b/);
4518 $new_type =~ s/\s+/ /g;
4519 $new_type = trim($new_type);
4520 if (WARN("UNNECESSARY_INT",
4521 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
4522 $fix) {
4523 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
4524 }
4525 }
4526
4527# check for static const char * arrays.
4528 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
4529 WARN("STATIC_CONST_CHAR_ARRAY",
4530 "static const char * array should probably be static const char * const\n" .
4531 $herecurr);
4532 }
4533
4534# check for initialized const char arrays that should be static const
4535 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4536 if (WARN("STATIC_CONST_CHAR_ARRAY",
4537 "const array should probably be static const\n" . $herecurr) &&
4538 $fix) {
4539 $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
4540 }
4541 }
4542
4543# check for static char foo[] = "bar" declarations.
4544 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
4545 WARN("STATIC_CONST_CHAR_ARRAY",
4546 "static char array declaration should probably be static const char\n" .
4547 $herecurr);
4548 }
4549
4550# check for const <foo> const where <foo> is not a pointer or array type
4551 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
4552 my $found = $1;
4553 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
4554 WARN("CONST_CONST",
4555 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
4556 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
4557 WARN("CONST_CONST",
4558 "'const $found const' should probably be 'const $found'\n" . $herecurr);
4559 }
4560 }
4561
4562# check for const static or static <non ptr type> const declarations
4563# prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const'
4564 if ($sline =~ /^\+\s*const\s+static\s+($Type)\b/ ||
4565 $sline =~ /^\+\s*static\s+($BasicType)\s+const\b/) {
4566 if (WARN("STATIC_CONST",
4567 "Move const after static - use 'static const $1'\n" . $herecurr) &&
4568 $fix) {
4569 $fixed[$fixlinenr] =~ s/\bconst\s+static\b/static const/;
4570 $fixed[$fixlinenr] =~ s/\bstatic\s+($BasicType)\s+const\b/static const $1/;
4571 }
4572 }
4573
4574# check for non-global char *foo[] = {"bar", ...} declarations.
4575 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
4576 WARN("STATIC_CONST_CHAR_ARRAY",
4577 "char * array declaration might be better as static const\n" .
4578 $herecurr);
4579 }
4580
4581# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4582 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
4583 my $array = $1;
4584 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4585 my $array_div = $1;
4586 if (WARN("ARRAY_SIZE",
4587 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
4588 $fix) {
4589 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4590 }
4591 }
4592 }
4593
4594# check for function declarations without arguments like "int foo()"
4595 if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) {
4596 if (ERROR("FUNCTION_WITHOUT_ARGS",
4597 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4598 $fix) {
4599 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
4600 }
4601 }
4602
4603# check for new typedefs, only function parameters and sparse annotations
4604# make sense.
4605 if ($line =~ /\btypedef\s/ &&
4606 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
4607 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
4608 $line !~ /\b$typeTypedefs\b/ &&
4609 $line !~ /\b__bitwise\b/) {
4610 WARN("NEW_TYPEDEFS",
4611 "do not add new typedefs\n" . $herecurr);
4612 }
4613
4614# * goes on variable not on type
4615 # (char*[ const])
4616 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4617 #print "AA<$1>\n";
4618 my ($ident, $from, $to) = ($1, $2, $2);
4619
4620 # Should start with a space.
4621 $to =~ s/^(\S)/ $1/;
4622 # Should not end with a space.
4623 $to =~ s/\s+$//;
4624 # '*'s should not have spaces between.
4625 while ($to =~ s/\*\s+\*/\*\*/) {
4626 }
4627
4628## print "1: from<$from> to<$to> ident<$ident>\n";
4629 if ($from ne $to) {
4630 if (ERROR("POINTER_LOCATION",
4631 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
4632 $fix) {
4633 my $sub_from = $ident;
4634 my $sub_to = $ident;
4635 $sub_to =~ s/\Q$from\E/$to/;
4636 $fixed[$fixlinenr] =~
4637 s@\Q$sub_from\E@$sub_to@;
4638 }
4639 }
4640 }
4641 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4642 #print "BB<$1>\n";
4643 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
4644
4645 # Should start with a space.
4646 $to =~ s/^(\S)/ $1/;
4647 # Should not end with a space.
4648 $to =~ s/\s+$//;
4649 # '*'s should not have spaces between.
4650 while ($to =~ s/\*\s+\*/\*\*/) {
4651 }
4652 # Modifiers should have spaces.
4653 $to =~ s/(\b$Modifier$)/$1 /;
4654
4655## print "2: from<$from> to<$to> ident<$ident>\n";
4656 if ($from ne $to && $ident !~ /^$Modifier$/) {
4657 if (ERROR("POINTER_LOCATION",
4658 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
4659 $fix) {
4660
4661 my $sub_from = $match;
4662 my $sub_to = $match;
4663 $sub_to =~ s/\Q$from\E/$to/;
4664 $fixed[$fixlinenr] =~
4665 s@\Q$sub_from\E@$sub_to@;
4666 }
4667 }
4668 }
4669
4670# avoid BUG() or BUG_ON()
4671 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
4672 my $msg_level = \&WARN;
4673 $msg_level = \&CHK if ($file);
4674 &{$msg_level}("AVOID_BUG",
4675 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
4676 }
4677
4678# avoid LINUX_VERSION_CODE
4679 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
4680 WARN("LINUX_VERSION_CODE",
4681 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4682 }
4683
4684# check for uses of printk_ratelimit
4685 if ($line =~ /\bprintk_ratelimit\s*\(/) {
4686 WARN("PRINTK_RATELIMITED",
4687 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
4688 }
4689
4690# printk should use KERN_* levels
4691 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4692 WARN("PRINTK_WITHOUT_KERN_LEVEL",
4693 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
4694 }
4695
4696# prefer variants of (subsystem|netdev|dev|pr)_<level> to printk(KERN_<LEVEL>
4697 if ($line =~ /\b(printk(_once|_ratelimited)?)\s*\(\s*KERN_([A-Z]+)/) {
4698 my $printk = $1;
4699 my $modifier = $2;
4700 my $orig = $3;
4701 $modifier = "" if (!defined($modifier));
4702 my $level = lc($orig);
4703 $level = "warn" if ($level eq "warning");
4704 my $level2 = $level;
4705 $level2 = "dbg" if ($level eq "debug");
4706 $level .= $modifier;
4707 $level2 .= $modifier;
4708 WARN("PREFER_PR_LEVEL",
4709 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to $printk(KERN_$orig ...\n" . $herecurr);
4710 }
4711
4712# prefer dev_<level> to dev_printk(KERN_<LEVEL>
4713 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4714 my $orig = $1;
4715 my $level = lc($orig);
4716 $level = "warn" if ($level eq "warning");
4717 $level = "dbg" if ($level eq "debug");
4718 WARN("PREFER_DEV_LEVEL",
4719 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4720 }
4721
4722# trace_printk should not be used in production code.
4723 if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) {
4724 WARN("TRACE_PRINTK",
4725 "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr);
4726 }
4727
4728# ENOSYS means "bad syscall nr" and nothing else. This will have a small
4729# number of false positives, but assembly files are not checked, so at
4730# least the arch entry code will not trigger this warning.
4731 if ($line =~ /\bENOSYS\b/) {
4732 WARN("ENOSYS",
4733 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4734 }
4735
4736# ENOTSUPP is not a standard error code and should be avoided in new patches.
4737# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP.
4738# Similarly to ENOSYS warning a small number of false positives is expected.
4739 if (!$file && $line =~ /\bENOTSUPP\b/) {
4740 if (WARN("ENOTSUPP",
4741 "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) &&
4742 $fix) {
4743 $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/;
4744 }
4745 }
4746
4747# function brace can't be on same line, except for #defines of do while,
4748# or if closed on same line
4749 if ($perl_version_ok &&
4750 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4751 $sline !~ /\#\s*define\b.*do\s*\{/ &&
4752 $sline !~ /}/) {
4753 if (ERROR("OPEN_BRACE",
4754 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
4755 $fix) {
4756 fix_delete_line($fixlinenr, $rawline);
4757 my $fixed_line = $rawline;
4758 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*)\{(.*)$/;
4759 my $line1 = $1;
4760 my $line2 = $2;
4761 fix_insert_line($fixlinenr, ltrim($line1));
4762 fix_insert_line($fixlinenr, "\+{");
4763 if ($line2 !~ /^\s*$/) {
4764 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4765 }
4766 }
4767 }
4768
4769# open braces for enum, union and struct go on the same line.
4770 if ($line =~ /^.\s*{/ &&
4771 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
4772 if (ERROR("OPEN_BRACE",
4773 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4774 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4775 fix_delete_line($fixlinenr - 1, $prevrawline);
4776 fix_delete_line($fixlinenr, $rawline);
4777 my $fixedline = rtrim($prevrawline) . " {";
4778 fix_insert_line($fixlinenr, $fixedline);
4779 $fixedline = $rawline;
4780 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
4781 if ($fixedline !~ /^\+\s*$/) {
4782 fix_insert_line($fixlinenr, $fixedline);
4783 }
4784 }
4785 }
4786
4787# missing space after union, struct or enum definition
4788 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4789 if (WARN("SPACING",
4790 "missing space after $1 definition\n" . $herecurr) &&
4791 $fix) {
4792 $fixed[$fixlinenr] =~
4793 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4794 }
4795 }
4796
4797# Function pointer declarations
4798# check spacing between type, funcptr, and args
4799# canonical declaration is "type (*funcptr)(args...)"
4800 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
4801 my $declare = $1;
4802 my $pre_pointer_space = $2;
4803 my $post_pointer_space = $3;
4804 my $funcname = $4;
4805 my $post_funcname_space = $5;
4806 my $pre_args_space = $6;
4807
4808# the $Declare variable will capture all spaces after the type
4809# so check it for a missing trailing missing space but pointer return types
4810# don't need a space so don't warn for those.
4811 my $post_declare_space = "";
4812 if ($declare =~ /(\s+)$/) {
4813 $post_declare_space = $1;
4814 $declare = rtrim($declare);
4815 }
4816 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
4817 WARN("SPACING",
4818 "missing space after return type\n" . $herecurr);
4819 $post_declare_space = " ";
4820 }
4821
4822# unnecessary space "type (*funcptr)(args...)"
4823# This test is not currently implemented because these declarations are
4824# equivalent to
4825# int foo(int bar, ...)
4826# and this is form shouldn't/doesn't generate a checkpatch warning.
4827#
4828# elsif ($declare =~ /\s{2,}$/) {
4829# WARN("SPACING",
4830# "Multiple spaces after return type\n" . $herecurr);
4831# }
4832
4833# unnecessary space "type ( *funcptr)(args...)"
4834 if (defined $pre_pointer_space &&
4835 $pre_pointer_space =~ /^\s/) {
4836 WARN("SPACING",
4837 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4838 }
4839
4840# unnecessary space "type (* funcptr)(args...)"
4841 if (defined $post_pointer_space &&
4842 $post_pointer_space =~ /^\s/) {
4843 WARN("SPACING",
4844 "Unnecessary space before function pointer name\n" . $herecurr);
4845 }
4846
4847# unnecessary space "type (*funcptr )(args...)"
4848 if (defined $post_funcname_space &&
4849 $post_funcname_space =~ /^\s/) {
4850 WARN("SPACING",
4851 "Unnecessary space after function pointer name\n" . $herecurr);
4852 }
4853
4854# unnecessary space "type (*funcptr) (args...)"
4855 if (defined $pre_args_space &&
4856 $pre_args_space =~ /^\s/) {
4857 WARN("SPACING",
4858 "Unnecessary space before function pointer arguments\n" . $herecurr);
4859 }
4860
4861 if (show_type("SPACING") && $fix) {
4862 $fixed[$fixlinenr] =~
4863 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4864 }
4865 }
4866
4867# check for spacing round square brackets; allowed:
4868# 1. with a type on the left -- int [] a;
4869# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4870# 3. inside a curly brace -- = { [0...10] = 5 }
4871 while ($line =~ /(.*?\s)\[/g) {
4872 my ($where, $prefix) = ($-[1], $1);
4873 if ($prefix !~ /$Type\s+$/ &&
4874 ($where != 0 || $prefix !~ /^.\s+$/) &&
4875 $prefix !~ /[{,:]\s+$/) {
4876 if (ERROR("BRACKET_SPACE",
4877 "space prohibited before open square bracket '['\n" . $herecurr) &&
4878 $fix) {
4879 $fixed[$fixlinenr] =~
4880 s/^(\+.*?)\s+\[/$1\[/;
4881 }
4882 }
4883 }
4884
4885# check for spaces between functions and their parentheses.
4886 while ($line =~ /($Ident)\s+\(/g) {
4887 my $name = $1;
4888 my $ctx_before = substr($line, 0, $-[1]);
4889 my $ctx = "$ctx_before$name";
4890
4891 # Ignore those directives where spaces _are_ permitted.
4892 if ($name =~ /^(?:
4893 if|for|while|switch|return|case|
4894 volatile|__volatile__|
4895 __attribute__|format|__extension__|
4896 asm|__asm__)$/x)
4897 {
4898 # cpp #define statements have non-optional spaces, ie
4899 # if there is a space between the name and the open
4900 # parenthesis it is simply not a parameter group.
4901 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
4902
4903 # cpp #elif statement condition may start with a (
4904 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
4905
4906 # If this whole things ends with a type its most
4907 # likely a typedef for a function.
4908 } elsif ($ctx =~ /$Type$/) {
4909
4910 } else {
4911 if (WARN("SPACING",
4912 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4913 $fix) {
4914 $fixed[$fixlinenr] =~
4915 s/\b$name\s+\(/$name\(/;
4916 }
4917 }
4918 }
4919
4920# Check operator spacing.
4921 if (!($line=~/\#\s*include/)) {
4922 my $fixed_line = "";
4923 my $line_fixed = 0;
4924
4925 my $ops = qr{
4926 <<=|>>=|<=|>=|==|!=|
4927 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4928 =>|->|<<|>>|<|>|=|!|~|
4929 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
4930 \?:|\?|:
4931 }x;
4932 my @elements = split(/($ops|;)/, $opline);
4933
4934## print("element count: <" . $#elements . ">\n");
4935## foreach my $el (@elements) {
4936## print("el: <$el>\n");
4937## }
4938
4939 my @fix_elements = ();
4940 my $off = 0;
4941
4942 foreach my $el (@elements) {
4943 push(@fix_elements, substr($rawline, $off, length($el)));
4944 $off += length($el);
4945 }
4946
4947 $off = 0;
4948
4949 my $blank = copy_spacing($opline);
4950 my $last_after = -1;
4951
4952 for (my $n = 0; $n < $#elements; $n += 2) {
4953
4954 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4955
4956## print("n: <$n> good: <$good>\n");
4957
4958 $off += length($elements[$n]);
4959
4960 # Pick up the preceding and succeeding characters.
4961 my $ca = substr($opline, 0, $off);
4962 my $cc = '';
4963 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4964 $cc = substr($opline, $off + length($elements[$n + 1]));
4965 }
4966 my $cb = "$ca$;$cc";
4967
4968 my $a = '';
4969 $a = 'V' if ($elements[$n] ne '');
4970 $a = 'W' if ($elements[$n] =~ /\s$/);
4971 $a = 'C' if ($elements[$n] =~ /$;$/);
4972 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4973 $a = 'O' if ($elements[$n] eq '');
4974 $a = 'E' if ($ca =~ /^\s*$/);
4975
4976 my $op = $elements[$n + 1];
4977
4978 my $c = '';
4979 if (defined $elements[$n + 2]) {
4980 $c = 'V' if ($elements[$n + 2] ne '');
4981 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
4982 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4983 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4984 $c = 'O' if ($elements[$n + 2] eq '');
4985 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4986 } else {
4987 $c = 'E';
4988 }
4989
4990 my $ctx = "${a}x${c}";
4991
4992 my $at = "(ctx:$ctx)";
4993
4994 my $ptr = substr($blank, 0, $off) . "^";
4995 my $hereptr = "$hereline$ptr\n";
4996
4997 # Pull out the value of this operator.
4998 my $op_type = substr($curr_values, $off + 1, 1);
4999
5000 # Get the full operator variant.
5001 my $opv = $op . substr($curr_vars, $off, 1);
5002
5003 # Ignore operators passed as parameters.
5004 if ($op_type ne 'V' &&
5005 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
5006
5007# # Ignore comments
5008# } elsif ($op =~ /^$;+$/) {
5009
5010 # ; should have either the end of line or a space or \ after it
5011 } elsif ($op eq ';') {
5012 if ($ctx !~ /.x[WEBC]/ &&
5013 $cc !~ /^\\/ && $cc !~ /^;/) {
5014 if (ERROR("SPACING",
5015 "space required after that '$op' $at\n" . $hereptr)) {
5016 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
5017 $line_fixed = 1;
5018 }
5019 }
5020
5021 # // is a comment
5022 } elsif ($op eq '//') {
5023
5024 # : when part of a bitfield
5025 } elsif ($opv eq ':B') {
5026 # skip the bitfield test for now
5027
5028 # No spaces for:
5029 # ->
5030 } elsif ($op eq '->') {
5031 if ($ctx =~ /Wx.|.xW/) {
5032 if (ERROR("SPACING",
5033 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
5034 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
5035 if (defined $fix_elements[$n + 2]) {
5036 $fix_elements[$n + 2] =~ s/^\s+//;
5037 }
5038 $line_fixed = 1;
5039 }
5040 }
5041
5042 # , must not have a space before and must have a space on the right.
5043 } elsif ($op eq ',') {
5044 my $rtrim_before = 0;
5045 my $space_after = 0;
5046 if ($ctx =~ /Wx./) {
5047 if (ERROR("SPACING",
5048 "space prohibited before that '$op' $at\n" . $hereptr)) {
5049 $line_fixed = 1;
5050 $rtrim_before = 1;
5051 }
5052 }
5053 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
5054 if (ERROR("SPACING",
5055 "space required after that '$op' $at\n" . $hereptr)) {
5056 $line_fixed = 1;
5057 $last_after = $n;
5058 $space_after = 1;
5059 }
5060 }
5061 if ($rtrim_before || $space_after) {
5062 if ($rtrim_before) {
5063 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
5064 } else {
5065 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
5066 }
5067 if ($space_after) {
5068 $good .= " ";
5069 }
5070 }
5071
5072 # '*' as part of a type definition -- reported already.
5073 } elsif ($opv eq '*_') {
5074 #warn "'*' is part of type\n";
5075
5076 # unary operators should have a space before and
5077 # none after. May be left adjacent to another
5078 # unary operator, or a cast
5079 } elsif ($op eq '!' || $op eq '~' ||
5080 $opv eq '*U' || $opv eq '-U' ||
5081 $opv eq '&U' || $opv eq '&&U') {
5082 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
5083 if (ERROR("SPACING",
5084 "space required before that '$op' $at\n" . $hereptr)) {
5085 if ($n != $last_after + 2) {
5086 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
5087 $line_fixed = 1;
5088 }
5089 }
5090 }
5091 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
5092 # A unary '*' may be const
5093
5094 } elsif ($ctx =~ /.xW/) {
5095 if (ERROR("SPACING",
5096 "space prohibited after that '$op' $at\n" . $hereptr)) {
5097 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
5098 if (defined $fix_elements[$n + 2]) {
5099 $fix_elements[$n + 2] =~ s/^\s+//;
5100 }
5101 $line_fixed = 1;
5102 }
5103 }
5104
5105 # unary ++ and unary -- are allowed no space on one side.
5106 } elsif ($op eq '++' or $op eq '--') {
5107 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
5108 if (ERROR("SPACING",
5109 "space required one side of that '$op' $at\n" . $hereptr)) {
5110 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
5111 $line_fixed = 1;
5112 }
5113 }
5114 if ($ctx =~ /Wx[BE]/ ||
5115 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
5116 if (ERROR("SPACING",
5117 "space prohibited before that '$op' $at\n" . $hereptr)) {
5118 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
5119 $line_fixed = 1;
5120 }
5121 }
5122 if ($ctx =~ /ExW/) {
5123 if (ERROR("SPACING",
5124 "space prohibited after that '$op' $at\n" . $hereptr)) {
5125 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
5126 if (defined $fix_elements[$n + 2]) {
5127 $fix_elements[$n + 2] =~ s/^\s+//;
5128 }
5129 $line_fixed = 1;
5130 }
5131 }
5132
5133 # << and >> may either have or not have spaces both sides
5134 } elsif ($op eq '<<' or $op eq '>>' or
5135 $op eq '&' or $op eq '^' or $op eq '|' or
5136 $op eq '+' or $op eq '-' or
5137 $op eq '*' or $op eq '/' or
5138 $op eq '%')
5139 {
5140 if ($check) {
5141 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
5142 if (CHK("SPACING",
5143 "spaces preferred around that '$op' $at\n" . $hereptr)) {
5144 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
5145 $fix_elements[$n + 2] =~ s/^\s+//;
5146 $line_fixed = 1;
5147 }
5148 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
5149 if (CHK("SPACING",
5150 "space preferred before that '$op' $at\n" . $hereptr)) {
5151 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
5152 $line_fixed = 1;
5153 }
5154 }
5155 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
5156 if (ERROR("SPACING",
5157 "need consistent spacing around '$op' $at\n" . $hereptr)) {
5158 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
5159 if (defined $fix_elements[$n + 2]) {
5160 $fix_elements[$n + 2] =~ s/^\s+//;
5161 }
5162 $line_fixed = 1;
5163 }
5164 }
5165
5166 # A colon needs no spaces before when it is
5167 # terminating a case value or a label.
5168 } elsif ($opv eq ':C' || $opv eq ':L') {
5169 if ($ctx =~ /Wx./ and $realfile !~ m@.*\.lds\.h$@) {
5170 if (ERROR("SPACING",
5171 "space prohibited before that '$op' $at\n" . $hereptr)) {
5172 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
5173 $line_fixed = 1;
5174 }
5175 }
5176
5177 # All the others need spaces both sides.
5178 } elsif ($ctx !~ /[EWC]x[CWE]/) {
5179 my $ok = 0;
5180
5181 # Ignore email addresses <foo@bar>
5182 if (($op eq '<' &&
5183 $cc =~ /^\S+\@\S+>/) ||
5184 ($op eq '>' &&
5185 $ca =~ /<\S+\@\S+$/))
5186 {
5187 $ok = 1;
5188 }
5189
5190 # for asm volatile statements
5191 # ignore a colon with another
5192 # colon immediately before or after
5193 if (($op eq ':') &&
5194 ($ca =~ /:$/ || $cc =~ /^:/)) {
5195 $ok = 1;
5196 }
5197
5198 # messages are ERROR, but ?: are CHK
5199 if ($ok == 0) {
5200 my $msg_level = \&ERROR;
5201 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
5202
5203 if (&{$msg_level}("SPACING",
5204 "spaces required around that '$op' $at\n" . $hereptr)) {
5205 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
5206 if (defined $fix_elements[$n + 2]) {
5207 $fix_elements[$n + 2] =~ s/^\s+//;
5208 }
5209 $line_fixed = 1;
5210 }
5211 }
5212 }
5213 $off += length($elements[$n + 1]);
5214
5215## print("n: <$n> GOOD: <$good>\n");
5216
5217 $fixed_line = $fixed_line . $good;
5218 }
5219
5220 if (($#elements % 2) == 0) {
5221 $fixed_line = $fixed_line . $fix_elements[$#elements];
5222 }
5223
5224 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
5225 $fixed[$fixlinenr] = $fixed_line;
5226 }
5227
5228
5229 }
5230
5231# check for whitespace before a non-naked semicolon
5232 if ($line =~ /^\+.*\S\s+;\s*$/) {
5233 if (WARN("SPACING",
5234 "space prohibited before semicolon\n" . $herecurr) &&
5235 $fix) {
5236 1 while $fixed[$fixlinenr] =~
5237 s/^(\+.*\S)\s+;/$1;/;
5238 }
5239 }
5240
5241# check for multiple assignments
5242 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
5243 CHK("MULTIPLE_ASSIGNMENTS",
5244 "multiple assignments should be avoided\n" . $herecurr);
5245 }
5246
5247## # check for multiple declarations, allowing for a function declaration
5248## # continuation.
5249## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
5250## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
5251##
5252## # Remove any bracketed sections to ensure we do not
5253## # falsely report the parameters of functions.
5254## my $ln = $line;
5255## while ($ln =~ s/\([^\(\)]*\)//g) {
5256## }
5257## if ($ln =~ /,/) {
5258## WARN("MULTIPLE_DECLARATION",
5259## "declaring multiple variables together should be avoided\n" . $herecurr);
5260## }
5261## }
5262
5263#need space before brace following if, while, etc
5264 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
5265 $line =~ /\b(?:else|do)\{/) {
5266 if (ERROR("SPACING",
5267 "space required before the open brace '{'\n" . $herecurr) &&
5268 $fix) {
5269 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
5270 }
5271 }
5272
5273## # check for blank lines before declarations
5274## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
5275## $prevrawline =~ /^.\s*$/) {
5276## WARN("SPACING",
5277## "No blank lines before declarations\n" . $hereprev);
5278## }
5279##
5280
5281# closing brace should have a space following it when it has anything
5282# on the line
5283 if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
5284 if (ERROR("SPACING",
5285 "space required after that close brace '}'\n" . $herecurr) &&
5286 $fix) {
5287 $fixed[$fixlinenr] =~
5288 s/}((?!(?:,|;|\)))\S)/} $1/;
5289 }
5290 }
5291
5292# check spacing on square brackets
5293 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
5294 if (ERROR("SPACING",
5295 "space prohibited after that open square bracket '['\n" . $herecurr) &&
5296 $fix) {
5297 $fixed[$fixlinenr] =~
5298 s/\[\s+/\[/;
5299 }
5300 }
5301 if ($line =~ /\s\]/) {
5302 if (ERROR("SPACING",
5303 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
5304 $fix) {
5305 $fixed[$fixlinenr] =~
5306 s/\s+\]/\]/;
5307 }
5308 }
5309
5310# check spacing on parentheses
5311 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
5312 $line !~ /for\s*\(\s+;/) {
5313 if (ERROR("SPACING",
5314 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
5315 $fix) {
5316 $fixed[$fixlinenr] =~
5317 s/\(\s+/\(/;
5318 }
5319 }
5320 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
5321 $line !~ /for\s*\(.*;\s+\)/ &&
5322 $line !~ /:\s+\)/) {
5323 if (ERROR("SPACING",
5324 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
5325 $fix) {
5326 $fixed[$fixlinenr] =~
5327 s/\s+\)/\)/;
5328 }
5329 }
5330
5331# check unnecessary parentheses around addressof/dereference single $Lvals
5332# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
5333
5334 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
5335 my $var = $1;
5336 if (CHK("UNNECESSARY_PARENTHESES",
5337 "Unnecessary parentheses around $var\n" . $herecurr) &&
5338 $fix) {
5339 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
5340 }
5341 }
5342
5343# check for unnecessary parentheses around function pointer uses
5344# ie: (foo->bar)(); should be foo->bar();
5345# but not "if (foo->bar) (" to avoid some false positives
5346 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
5347 my $var = $2;
5348 if (CHK("UNNECESSARY_PARENTHESES",
5349 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
5350 $fix) {
5351 my $var2 = deparenthesize($var);
5352 $var2 =~ s/\s//g;
5353 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
5354 }
5355 }
5356
5357# check for unnecessary parentheses around comparisons in if uses
5358# when !drivers/staging or command-line uses --strict
5359 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
5360 $perl_version_ok && defined($stat) &&
5361 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
5362 my $if_stat = $1;
5363 my $test = substr($2, 1, -1);
5364 my $herectx;
5365 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
5366 my $match = $1;
5367 # avoid parentheses around potential macro args
5368 next if ($match =~ /^\s*\w+\s*$/);
5369 if (!defined($herectx)) {
5370 $herectx = $here . "\n";
5371 my $cnt = statement_rawlines($if_stat);
5372 for (my $n = 0; $n < $cnt; $n++) {
5373 my $rl = raw_line($linenr, $n);
5374 $herectx .= $rl . "\n";
5375 last if $rl =~ /^[ \+].*\{/;
5376 }
5377 }
5378 CHK("UNNECESSARY_PARENTHESES",
5379 "Unnecessary parentheses around '$match'\n" . $herectx);
5380 }
5381 }
5382
5383# check that goto labels aren't indented (allow a single space indentation)
5384# and ignore bitfield definitions like foo:1
5385# Strictly, labels can have whitespace after the identifier and before the :
5386# but this is not allowed here as many ?: uses would appear to be labels
5387 if ($sline =~ /^.\s+[A-Za-z_][A-Za-z\d_]*:(?!\s*\d+)/ &&
5388 $sline !~ /^. [A-Za-z\d_][A-Za-z\d_]*:/ &&
5389 $sline !~ /^.\s+default:/) {
5390 if (WARN("INDENTED_LABEL",
5391 "labels should not be indented\n" . $herecurr) &&
5392 $fix) {
5393 $fixed[$fixlinenr] =~
5394 s/^(.)\s+/$1/;
5395 }
5396 }
5397
5398# check if a statement with a comma should be two statements like:
5399# foo = bar(), /* comma should be semicolon */
5400# bar = baz();
5401 if (defined($stat) &&
5402 $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) {
5403 my $cnt = statement_rawlines($stat);
5404 my $herectx = get_stat_here($linenr, $cnt, $here);
5405 WARN("SUSPECT_COMMA_SEMICOLON",
5406 "Possible comma where semicolon could be used\n" . $herectx);
5407 }
5408
5409# return is not a function
5410 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
5411 my $spacing = $1;
5412 if ($perl_version_ok &&
5413 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
5414 my $value = $1;
5415 $value = deparenthesize($value);
5416 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
5417 ERROR("RETURN_PARENTHESES",
5418 "return is not a function, parentheses are not required\n" . $herecurr);
5419 }
5420 } elsif ($spacing !~ /\s+/) {
5421 ERROR("SPACING",
5422 "space required before the open parenthesis '('\n" . $herecurr);
5423 }
5424 }
5425
5426# unnecessary return in a void function
5427# at end-of-function, with the previous line a single leading tab, then return;
5428# and the line before that not a goto label target like "out:"
5429 if ($sline =~ /^[ \+]}\s*$/ &&
5430 $prevline =~ /^\+\treturn\s*;\s*$/ &&
5431 $linenr >= 3 &&
5432 $lines[$linenr - 3] =~ /^[ +]/ &&
5433 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
5434 WARN("RETURN_VOID",
5435 "void function return statements are not generally useful\n" . $hereprev);
5436 }
5437
5438# if statements using unnecessary parentheses - ie: if ((foo == bar))
5439 if ($perl_version_ok &&
5440 $line =~ /\bif\s*((?:\(\s*){2,})/) {
5441 my $openparens = $1;
5442 my $count = $openparens =~ tr@\(@\(@;
5443 my $msg = "";
5444 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
5445 my $comp = $4; #Not $1 because of $LvalOrFunc
5446 $msg = " - maybe == should be = ?" if ($comp eq "==");
5447 WARN("UNNECESSARY_PARENTHESES",
5448 "Unnecessary parentheses$msg\n" . $herecurr);
5449 }
5450 }
5451
5452# comparisons with a constant or upper case identifier on the left
5453# avoid cases like "foo + BAR < baz"
5454# only fix matches surrounded by parentheses to avoid incorrect
5455# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
5456 if ($perl_version_ok &&
5457 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
5458 my $lead = $1;
5459 my $const = $2;
5460 my $comp = $3;
5461 my $to = $4;
5462 my $newcomp = $comp;
5463 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
5464 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
5465 WARN("CONSTANT_COMPARISON",
5466 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
5467 $fix) {
5468 if ($comp eq "<") {
5469 $newcomp = ">";
5470 } elsif ($comp eq "<=") {
5471 $newcomp = ">=";
5472 } elsif ($comp eq ">") {
5473 $newcomp = "<";
5474 } elsif ($comp eq ">=") {
5475 $newcomp = "<=";
5476 }
5477 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
5478 }
5479 }
5480
5481# Return of what appears to be an errno should normally be negative
5482 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
5483 my $name = $1;
5484 if ($name ne 'EOF' && $name ne 'ERROR' && $name !~ /^EPOLL/) {
5485 WARN("USE_NEGATIVE_ERRNO",
5486 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
5487 }
5488 }
5489
5490# Need a space before open parenthesis after if, while etc
5491 if ($line =~ /\b(if|while|for|switch)\(/) {
5492 if (ERROR("SPACING",
5493 "space required before the open parenthesis '('\n" . $herecurr) &&
5494 $fix) {
5495 $fixed[$fixlinenr] =~
5496 s/\b(if|while|for|switch)\(/$1 \(/;
5497 }
5498 }
5499
5500# Check for illegal assignment in if conditional -- and check for trailing
5501# statements after the conditional.
5502 if ($line =~ /do\s*(?!{)/) {
5503 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
5504 ctx_statement_block($linenr, $realcnt, 0)
5505 if (!defined $stat);
5506 my ($stat_next) = ctx_statement_block($line_nr_next,
5507 $remain_next, $off_next);
5508 $stat_next =~ s/\n./\n /g;
5509 ##print "stat<$stat> stat_next<$stat_next>\n";
5510
5511 if ($stat_next =~ /^\s*while\b/) {
5512 # If the statement carries leading newlines,
5513 # then count those as offsets.
5514 my ($whitespace) =
5515 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
5516 my $offset =
5517 statement_rawlines($whitespace) - 1;
5518
5519 $suppress_whiletrailers{$line_nr_next +
5520 $offset} = 1;
5521 }
5522 }
5523 if (!defined $suppress_whiletrailers{$linenr} &&
5524 defined($stat) && defined($cond) &&
5525 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
5526 my ($s, $c) = ($stat, $cond);
5527
5528 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
5529 if (ERROR("ASSIGN_IN_IF",
5530 "do not use assignment in if condition\n" . $herecurr) &&
5531 $fix && $perl_version_ok) {
5532 if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
5533 my $space = $1;
5534 my $not = $2;
5535 my $statement = $3;
5536 my $assigned = $4;
5537 my $test = $8;
5538 my $against = $9;
5539 my $brace = $15;
5540 fix_delete_line($fixlinenr, $rawline);
5541 fix_insert_line($fixlinenr, "$space$statement;");
5542 my $newline = "${space}if (";
5543 $newline .= '!' if defined($not);
5544 $newline .= '(' if (defined $not && defined($test) && defined($against));
5545 $newline .= "$assigned";
5546 $newline .= " $test $against" if (defined($test) && defined($against));
5547 $newline .= ')' if (defined $not && defined($test) && defined($against));
5548 $newline .= ')';
5549 $newline .= " {" if (defined($brace));
5550 fix_insert_line($fixlinenr + 1, $newline);
5551 }
5552 }
5553 }
5554
5555 # Find out what is on the end of the line after the
5556 # conditional.
5557 substr($s, 0, length($c), '');
5558 $s =~ s/\n.*//g;
5559 $s =~ s/$;//g; # Remove any comments
5560 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
5561 $c !~ /}\s*while\s*/)
5562 {
5563 # Find out how long the conditional actually is.
5564 my @newlines = ($c =~ /\n/gs);
5565 my $cond_lines = 1 + $#newlines;
5566 my $stat_real = '';
5567
5568 $stat_real = raw_line($linenr, $cond_lines)
5569 . "\n" if ($cond_lines);
5570 if (defined($stat_real) && $cond_lines > 1) {
5571 $stat_real = "[...]\n$stat_real";
5572 }
5573
5574 ERROR("TRAILING_STATEMENTS",
5575 "trailing statements should be on next line\n" . $herecurr . $stat_real);
5576 }
5577 }
5578
5579# Check for bitwise tests written as boolean
5580 if ($line =~ /
5581 (?:
5582 (?:\[|\(|\&\&|\|\|)
5583 \s*0[xX][0-9]+\s*
5584 (?:\&\&|\|\|)
5585 |
5586 (?:\&\&|\|\|)
5587 \s*0[xX][0-9]+\s*
5588 (?:\&\&|\|\||\)|\])
5589 )/x)
5590 {
5591 WARN("HEXADECIMAL_BOOLEAN_TEST",
5592 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
5593 }
5594
5595# if and else should not have general statements after it
5596 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
5597 my $s = $1;
5598 $s =~ s/$;//g; # Remove any comments
5599 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
5600 ERROR("TRAILING_STATEMENTS",
5601 "trailing statements should be on next line\n" . $herecurr);
5602 }
5603 }
5604# if should not continue a brace
5605 if ($line =~ /}\s*if\b/) {
5606 ERROR("TRAILING_STATEMENTS",
5607 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
5608 $herecurr);
5609 }
5610# case and default should not have general statements after them
5611 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
5612 $line !~ /\G(?:
5613 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
5614 \s*return\s+
5615 )/xg)
5616 {
5617 ERROR("TRAILING_STATEMENTS",
5618 "trailing statements should be on next line\n" . $herecurr);
5619 }
5620
5621 # Check for }<nl>else {, these must be at the same
5622 # indent level to be relevant to each other.
5623 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
5624 $previndent == $indent) {
5625 if (ERROR("ELSE_AFTER_BRACE",
5626 "else should follow close brace '}'\n" . $hereprev) &&
5627 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5628 fix_delete_line($fixlinenr - 1, $prevrawline);
5629 fix_delete_line($fixlinenr, $rawline);
5630 my $fixedline = $prevrawline;
5631 $fixedline =~ s/}\s*$//;
5632 if ($fixedline !~ /^\+\s*$/) {
5633 fix_insert_line($fixlinenr, $fixedline);
5634 }
5635 $fixedline = $rawline;
5636 $fixedline =~ s/^(.\s*)else/$1} else/;
5637 fix_insert_line($fixlinenr, $fixedline);
5638 }
5639 }
5640
5641 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5642 $previndent == $indent) {
5643 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5644
5645 # Find out what is on the end of the line after the
5646 # conditional.
5647 substr($s, 0, length($c), '');
5648 $s =~ s/\n.*//g;
5649
5650 if ($s =~ /^\s*;/) {
5651 if (ERROR("WHILE_AFTER_BRACE",
5652 "while should follow close brace '}'\n" . $hereprev) &&
5653 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5654 fix_delete_line($fixlinenr - 1, $prevrawline);
5655 fix_delete_line($fixlinenr, $rawline);
5656 my $fixedline = $prevrawline;
5657 my $trailing = $rawline;
5658 $trailing =~ s/^\+//;
5659 $trailing = trim($trailing);
5660 $fixedline =~ s/}\s*$/} $trailing/;
5661 fix_insert_line($fixlinenr, $fixedline);
5662 }
5663 }
5664 }
5665
5666#Specific variable tests
5667 while ($line =~ m{($Constant|$Lval)}g) {
5668 my $var = $1;
5669
5670#CamelCase
5671 if ($var !~ /^$Constant$/ &&
5672 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
5673#Ignore some autogenerated defines and enum values
5674 $var !~ /^(?:[A-Z]+_){1,5}[A-Z]{1,3}[a-z]/ &&
5675#Ignore Page<foo> variants
5676 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
5677#Ignore SI style variants like nS, mV and dB
5678#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5679 $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
5680#Ignore some three character SI units explicitly, like MiB and KHz
5681 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
5682 while ($var =~ m{($Ident)}g) {
5683 my $word = $1;
5684 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
5685 if ($check) {
5686 seed_camelcase_includes();
5687 if (!$file && !$camelcase_file_seeded) {
5688 seed_camelcase_file($realfile);
5689 $camelcase_file_seeded = 1;
5690 }
5691 }
5692 if (!defined $camelcase{$word}) {
5693 $camelcase{$word} = 1;
5694 CHK("CAMELCASE",
5695 "Avoid CamelCase: <$word>\n" . $herecurr);
5696 }
5697 }
5698 }
5699 }
5700
5701#no spaces allowed after \ in define
5702 if ($line =~ /\#\s*define.*\\\s+$/) {
5703 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5704 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5705 $fix) {
5706 $fixed[$fixlinenr] =~ s/\s+$//;
5707 }
5708 }
5709
5710# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5711# itself <asm/foo.h> (uses RAW line)
5712 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
5713 my $file = "$1.h";
5714 my $checkfile = "include/linux/$file";
5715 if (-f "$root/$checkfile" &&
5716 $realfile ne $checkfile &&
5717 $1 !~ /$allowed_asm_includes/)
5718 {
5719 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5720 if ($asminclude > 0) {
5721 if ($realfile =~ m{^arch/}) {
5722 CHK("ARCH_INCLUDE_LINUX",
5723 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5724 } else {
5725 WARN("INCLUDE_LINUX",
5726 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5727 }
5728 }
5729 }
5730 }
5731
5732# multi-statement macros should be enclosed in a do while loop, grab the
5733# first statement and ensure its the whole macro if its not enclosed
5734# in a known good container
5735 if ($realfile !~ m@/vmlinux.lds.h$@ &&
5736 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
5737 my $ln = $linenr;
5738 my $cnt = $realcnt;
5739 my ($off, $dstat, $dcond, $rest);
5740 my $ctx = '';
5741 my $has_flow_statement = 0;
5742 my $has_arg_concat = 0;
5743 ($dstat, $dcond, $ln, $cnt, $off) =
5744 ctx_statement_block($linenr, $realcnt, 0);
5745 $ctx = $dstat;
5746 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5747 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5748
5749 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
5750 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
5751
5752 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5753 my $define_args = $1;
5754 my $define_stmt = $dstat;
5755 my @def_args = ();
5756
5757 if (defined $define_args && $define_args ne "") {
5758 $define_args = substr($define_args, 1, length($define_args) - 2);
5759 $define_args =~ s/\s*//g;
5760 $define_args =~ s/\\\+?//g;
5761 @def_args = split(",", $define_args);
5762 }
5763
5764 $dstat =~ s/$;//g;
5765 $dstat =~ s/\\\n.//g;
5766 $dstat =~ s/^\s*//s;
5767 $dstat =~ s/\s*$//s;
5768
5769 # Flatten any parentheses and braces
5770 while ($dstat =~ s/\([^\(\)]*\)/1u/ ||
5771 $dstat =~ s/\{[^\{\}]*\}/1u/ ||
5772 $dstat =~ s/.\[[^\[\]]*\]/1u/)
5773 {
5774 }
5775
5776 # Flatten any obvious string concatenation.
5777 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5778 $dstat =~ s/$Ident\s*($String)/$1/)
5779 {
5780 }
5781
5782 # Make asm volatile uses seem like a generic function
5783 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5784
5785 my $exceptions = qr{
5786 $Declare|
5787 module_param_named|
5788 MODULE_PARM_DESC|
5789 DECLARE_PER_CPU|
5790 DEFINE_PER_CPU|
5791 __typeof__\(|
5792 union|
5793 struct|
5794 \.$Ident\s*=\s*|
5795 ^\"|\"$|
5796 ^\[
5797 }x;
5798 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5799
5800 $ctx =~ s/\n*$//;
5801 my $stmt_cnt = statement_rawlines($ctx);
5802 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
5803
5804 if ($dstat ne '' &&
5805 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5806 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
5807 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5808 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
5809 $dstat !~ /$exceptions/ &&
5810 $dstat !~ /^\.$Ident\s*=/ && # .foo =
5811 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
5812 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5813 $dstat !~ /^while\s*$Constant\s*$Constant\s*$/ && # while (...) {...}
5814 $dstat !~ /^for\s*$Constant$/ && # for (...)
5815 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5816 $dstat !~ /^do\s*{/ && # do {...
5817 $dstat !~ /^\(\{/ && # ({...
5818 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
5819 {
5820 if ($dstat =~ /^\s*if\b/) {
5821 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5822 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5823 } elsif ($dstat =~ /;/) {
5824 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5825 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5826 } else {
5827 ERROR("COMPLEX_MACRO",
5828 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
5829 }
5830
5831 }
5832
5833 # Make $define_stmt single line, comment-free, etc
5834 my @stmt_array = split('\n', $define_stmt);
5835 my $first = 1;
5836 $define_stmt = "";
5837 foreach my $l (@stmt_array) {
5838 $l =~ s/\\$//;
5839 if ($first) {
5840 $define_stmt = $l;
5841 $first = 0;
5842 } elsif ($l =~ /^[\+ ]/) {
5843 $define_stmt .= substr($l, 1);
5844 }
5845 }
5846 $define_stmt =~ s/$;//g;
5847 $define_stmt =~ s/\s+/ /g;
5848 $define_stmt = trim($define_stmt);
5849
5850# check if any macro arguments are reused (ignore '...' and 'type')
5851 foreach my $arg (@def_args) {
5852 next if ($arg =~ /\.\.\./);
5853 next if ($arg =~ /^type$/i);
5854 my $tmp_stmt = $define_stmt;
5855 $tmp_stmt =~ s/\b(__must_be_array|offsetof|sizeof|sizeof_field|__stringify|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5856 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5857 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
5858 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
5859 if ($use_cnt > 1) {
5860 CHK("MACRO_ARG_REUSE",
5861 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
5862 }
5863# check if any macro arguments may have other precedence issues
5864 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
5865 ((defined($1) && $1 ne ',') ||
5866 (defined($2) && $2 ne ','))) {
5867 CHK("MACRO_ARG_PRECEDENCE",
5868 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
5869 }
5870 }
5871
5872# check for macros with flow control, but without ## concatenation
5873# ## concatenation is commonly a macro that defines a function so ignore those
5874 if ($has_flow_statement && !$has_arg_concat) {
5875 my $cnt = statement_rawlines($ctx);
5876 my $herectx = get_stat_here($linenr, $cnt, $here);
5877
5878 WARN("MACRO_WITH_FLOW_CONTROL",
5879 "Macros with flow control statements should be avoided\n" . "$herectx");
5880 }
5881
5882# check for line continuations outside of #defines, preprocessor #, and asm
5883
5884 } else {
5885 if ($prevline !~ /^..*\\$/ &&
5886 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5887 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
5888 $line =~ /^\+.*\\$/) {
5889 WARN("LINE_CONTINUATIONS",
5890 "Avoid unnecessary line continuations\n" . $herecurr);
5891 }
5892 }
5893
5894# do {} while (0) macro tests:
5895# single-statement macros do not need to be enclosed in do while (0) loop,
5896# macro should not end with a semicolon
5897 if ($perl_version_ok &&
5898 $realfile !~ m@/vmlinux.lds.h$@ &&
5899 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5900 my $ln = $linenr;
5901 my $cnt = $realcnt;
5902 my ($off, $dstat, $dcond, $rest);
5903 my $ctx = '';
5904 ($dstat, $dcond, $ln, $cnt, $off) =
5905 ctx_statement_block($linenr, $realcnt, 0);
5906 $ctx = $dstat;
5907
5908 $dstat =~ s/\\\n.//g;
5909 $dstat =~ s/$;/ /g;
5910
5911 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5912 my $stmts = $2;
5913 my $semis = $3;
5914
5915 $ctx =~ s/\n*$//;
5916 my $cnt = statement_rawlines($ctx);
5917 my $herectx = get_stat_here($linenr, $cnt, $here);
5918
5919 if (($stmts =~ tr/;/;/) == 1 &&
5920 $stmts !~ /^\s*(if|while|for|switch)\b/) {
5921 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5922 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5923 }
5924 if (defined $semis && $semis ne "") {
5925 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5926 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5927 }
5928 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5929 $ctx =~ s/\n*$//;
5930 my $cnt = statement_rawlines($ctx);
5931 my $herectx = get_stat_here($linenr, $cnt, $here);
5932
5933 WARN("TRAILING_SEMICOLON",
5934 "macros should not use a trailing semicolon\n" . "$herectx");
5935 }
5936 }
5937
5938# check for redundant bracing round if etc
5939 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5940 my ($level, $endln, @chunks) =
5941 ctx_statement_full($linenr, $realcnt, 1);
5942 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5943 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5944 if ($#chunks > 0 && $level == 0) {
5945 my @allowed = ();
5946 my $allow = 0;
5947 my $seen = 0;
5948 my $herectx = $here . "\n";
5949 my $ln = $linenr - 1;
5950 for my $chunk (@chunks) {
5951 my ($cond, $block) = @{$chunk};
5952
5953 # If the condition carries leading newlines, then count those as offsets.
5954 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5955 my $offset = statement_rawlines($whitespace) - 1;
5956
5957 $allowed[$allow] = 0;
5958 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5959
5960 # We have looked at and allowed this specific line.
5961 $suppress_ifbraces{$ln + $offset} = 1;
5962
5963 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
5964 $ln += statement_rawlines($block) - 1;
5965
5966 substr($block, 0, length($cond), '');
5967
5968 $seen++ if ($block =~ /^\s*{/);
5969
5970 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5971 if (statement_lines($cond) > 1) {
5972 #print "APW: ALLOWED: cond<$cond>\n";
5973 $allowed[$allow] = 1;
5974 }
5975 if ($block =~/\b(?:if|for|while)\b/) {
5976 #print "APW: ALLOWED: block<$block>\n";
5977 $allowed[$allow] = 1;
5978 }
5979 if (statement_block_size($block) > 1) {
5980 #print "APW: ALLOWED: lines block<$block>\n";
5981 $allowed[$allow] = 1;
5982 }
5983 $allow++;
5984 }
5985 if ($seen) {
5986 my $sum_allowed = 0;
5987 foreach (@allowed) {
5988 $sum_allowed += $_;
5989 }
5990 if ($sum_allowed == 0) {
5991 WARN("BRACES",
5992 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5993 } elsif ($sum_allowed != $allow &&
5994 $seen != $allow) {
5995 CHK("BRACES",
5996 "braces {} should be used on all arms of this statement\n" . $herectx);
5997 }
5998 }
5999 }
6000 }
6001 if (!defined $suppress_ifbraces{$linenr - 1} &&
6002 $line =~ /\b(if|while|for|else)\b/) {
6003 my $allowed = 0;
6004
6005 # Check the pre-context.
6006 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
6007 #print "APW: ALLOWED: pre<$1>\n";
6008 $allowed = 1;
6009 }
6010
6011 my ($level, $endln, @chunks) =
6012 ctx_statement_full($linenr, $realcnt, $-[0]);
6013
6014 # Check the condition.
6015 my ($cond, $block) = @{$chunks[0]};
6016 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
6017 if (defined $cond) {
6018 substr($block, 0, length($cond), '');
6019 }
6020 if (statement_lines($cond) > 1) {
6021 #print "APW: ALLOWED: cond<$cond>\n";
6022 $allowed = 1;
6023 }
6024 if ($block =~/\b(?:if|for|while)\b/) {
6025 #print "APW: ALLOWED: block<$block>\n";
6026 $allowed = 1;
6027 }
6028 if (statement_block_size($block) > 1) {
6029 #print "APW: ALLOWED: lines block<$block>\n";
6030 $allowed = 1;
6031 }
6032 # Check the post-context.
6033 if (defined $chunks[1]) {
6034 my ($cond, $block) = @{$chunks[1]};
6035 if (defined $cond) {
6036 substr($block, 0, length($cond), '');
6037 }
6038 if ($block =~ /^\s*\{/) {
6039 #print "APW: ALLOWED: chunk-1 block<$block>\n";
6040 $allowed = 1;
6041 }
6042 }
6043 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
6044 my $cnt = statement_rawlines($block);
6045 my $herectx = get_stat_here($linenr, $cnt, $here);
6046
6047 WARN("BRACES",
6048 "braces {} are not necessary for single statement blocks\n" . $herectx);
6049 }
6050 }
6051
6052# check for single line unbalanced braces
6053 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
6054 $sline =~ /^.\s*else\s*\{\s*$/) {
6055 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
6056 }
6057
6058# check for unnecessary blank lines around braces
6059 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
6060 if (CHK("BRACES",
6061 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
6062 $fix && $prevrawline =~ /^\+/) {
6063 fix_delete_line($fixlinenr - 1, $prevrawline);
6064 }
6065 }
6066 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
6067 if (CHK("BRACES",
6068 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
6069 $fix) {
6070 fix_delete_line($fixlinenr, $rawline);
6071 }
6072 }
6073
6074# no volatiles please
6075 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
6076 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
6077 WARN("VOLATILE",
6078 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
6079 }
6080
6081# Check for user-visible strings broken across lines, which breaks the ability
6082# to grep for the string. Make exceptions when the previous string ends in a
6083# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
6084# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
6085 if ($line =~ /^\+\s*$String/ &&
6086 $prevline =~ /"\s*$/ &&
6087 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
6088 if (WARN("SPLIT_STRING",
6089 "quoted string split across lines\n" . $hereprev) &&
6090 $fix &&
6091 $prevrawline =~ /^\+.*"\s*$/ &&
6092 $last_coalesced_string_linenr != $linenr - 1) {
6093 my $extracted_string = get_quoted_string($line, $rawline);
6094 my $comma_close = "";
6095 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
6096 $comma_close = $1;
6097 }
6098
6099 fix_delete_line($fixlinenr - 1, $prevrawline);
6100 fix_delete_line($fixlinenr, $rawline);
6101 my $fixedline = $prevrawline;
6102 $fixedline =~ s/"\s*$//;
6103 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
6104 fix_insert_line($fixlinenr - 1, $fixedline);
6105 $fixedline = $rawline;
6106 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
6107 if ($fixedline !~ /\+\s*$/) {
6108 fix_insert_line($fixlinenr, $fixedline);
6109 }
6110 $last_coalesced_string_linenr = $linenr;
6111 }
6112 }
6113
6114# check for missing a space in a string concatenation
6115 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
6116 WARN('MISSING_SPACE',
6117 "break quoted strings at a space character\n" . $hereprev);
6118 }
6119
6120# check for an embedded function name in a string when the function is known
6121# This does not work very well for -f --file checking as it depends on patch
6122# context providing the function name or a single line form for in-file
6123# function declarations
6124 if ($line =~ /^\+.*$String/ &&
6125 defined($context_function) &&
6126 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
6127 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
6128 WARN("EMBEDDED_FUNCTION_NAME",
6129 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
6130 }
6131
6132# check for unnecessary function tracing like uses
6133# This does not use $logFunctions because there are many instances like
6134# 'dprintk(FOO, "%s()\n", __func__);' which do not match $logFunctions
6135 if ($rawline =~ /^\+.*\([^"]*"$tracing_logging_tags{0,3}%s(?:\s*\(\s*\)\s*)?$tracing_logging_tags{0,3}(?:\\n)?"\s*,\s*__func__\s*\)\s*;/) {
6136 if (WARN("TRACING_LOGGING",
6137 "Unnecessary ftrace-like logging - prefer using ftrace\n" . $herecurr) &&
6138 $fix) {
6139 fix_delete_line($fixlinenr, $rawline);
6140 }
6141 }
6142
6143# check for spaces before a quoted newline
6144 if ($rawline =~ /^.*\".*\s\\n/) {
6145 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
6146 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
6147 $fix) {
6148 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
6149 }
6150
6151 }
6152
6153# concatenated string without spaces between elements
6154 if ($line =~ /$String[A-Z_]/ ||
6155 ($line =~ /([A-Za-z0-9_]+)$String/ && $1 !~ /^[Lu]$/)) {
6156 if (CHK("CONCATENATED_STRING",
6157 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
6158 $fix) {
6159 while ($line =~ /($String)/g) {
6160 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
6161 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
6162 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
6163 }
6164 }
6165 }
6166
6167# uncoalesced string fragments
6168 if ($line =~ /$String\s*[Lu]?"/) {
6169 if (WARN("STRING_FRAGMENTS",
6170 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
6171 $fix) {
6172 while ($line =~ /($String)(?=\s*")/g) {
6173 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
6174 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
6175 }
6176 }
6177 }
6178
6179# check for non-standard and hex prefixed decimal printf formats
6180 my $show_L = 1; #don't show the same defect twice
6181 my $show_Z = 1;
6182 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
6183 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
6184 $string =~ s/%%/__/g;
6185 # check for %L
6186 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
6187 WARN("PRINTF_L",
6188 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
6189 $show_L = 0;
6190 }
6191 # check for %Z
6192 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
6193 WARN("PRINTF_Z",
6194 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
6195 $show_Z = 0;
6196 }
6197 # check for 0x<decimal>
6198 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
6199 ERROR("PRINTF_0XDECIMAL",
6200 "Prefixing 0x with decimal output is defective\n" . $herecurr);
6201 }
6202 }
6203
6204# check for line continuations in quoted strings with odd counts of "
6205 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
6206 WARN("LINE_CONTINUATIONS",
6207 "Avoid line continuations in quoted strings\n" . $herecurr);
6208 }
6209
6210# warn about #if 0
6211 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
6212 WARN("IF_0",
6213 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
6214 }
6215
6216# warn about #if 1
6217 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
6218 WARN("IF_1",
6219 "Consider removing the #if 1 and its #endif\n" . $herecurr);
6220 }
6221
6222# check for needless "if (<foo>) fn(<foo>)" uses
6223 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
6224 my $tested = quotemeta($1);
6225 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
6226 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
6227 my $func = $1;
6228 if (WARN('NEEDLESS_IF',
6229 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
6230 $fix) {
6231 my $do_fix = 1;
6232 my $leading_tabs = "";
6233 my $new_leading_tabs = "";
6234 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
6235 $leading_tabs = $1;
6236 } else {
6237 $do_fix = 0;
6238 }
6239 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
6240 $new_leading_tabs = $1;
6241 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
6242 $do_fix = 0;
6243 }
6244 } else {
6245 $do_fix = 0;
6246 }
6247 if ($do_fix) {
6248 fix_delete_line($fixlinenr - 1, $prevrawline);
6249 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
6250 }
6251 }
6252 }
6253 }
6254
6255# check for unnecessary "Out of Memory" messages
6256 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
6257 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
6258 (defined $1 || defined $3) &&
6259 $linenr > 3) {
6260 my $testval = $2;
6261 my $testline = $lines[$linenr - 3];
6262
6263 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
6264# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
6265
6266 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
6267 $s !~ /\b__GFP_NOWARN\b/ ) {
6268 WARN("OOM_MESSAGE",
6269 "Possible unnecessary 'out of memory' message\n" . $hereprev);
6270 }
6271 }
6272
6273# check for logging functions with KERN_<LEVEL>
6274 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
6275 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
6276 my $level = $1;
6277 if (WARN("UNNECESSARY_KERN_LEVEL",
6278 "Possible unnecessary $level\n" . $herecurr) &&
6279 $fix) {
6280 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
6281 }
6282 }
6283
6284# check for logging continuations
6285 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
6286 WARN("LOGGING_CONTINUATION",
6287 "Avoid logging continuation uses where feasible\n" . $herecurr);
6288 }
6289
6290# check for unnecessary use of %h[xudi] and %hh[xudi] in logging functions
6291 if (defined $stat &&
6292 $line =~ /\b$logFunctions\s*\(/ &&
6293 index($stat, '"') >= 0) {
6294 my $lc = $stat =~ tr@\n@@;
6295 $lc = $lc + $linenr;
6296 my $stat_real = get_stat_real($linenr, $lc);
6297 pos($stat_real) = index($stat_real, '"');
6298 while ($stat_real =~ /[^\"%]*(%[\#\d\.\*\-]*(h+)[idux])/g) {
6299 my $pspec = $1;
6300 my $h = $2;
6301 my $lineoff = substr($stat_real, 0, $-[1]) =~ tr@\n@@;
6302 if (WARN("UNNECESSARY_MODIFIER",
6303 "Integer promotion: Using '$h' in '$pspec' is unnecessary\n" . "$here\n$stat_real\n") &&
6304 $fix && $fixed[$fixlinenr + $lineoff] =~ /^\+/) {
6305 my $nspec = $pspec;
6306 $nspec =~ s/h//g;
6307 $fixed[$fixlinenr + $lineoff] =~ s/\Q$pspec\E/$nspec/;
6308 }
6309 }
6310 }
6311
6312# check for mask then right shift without a parentheses
6313 if ($perl_version_ok &&
6314 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
6315 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
6316 WARN("MASK_THEN_SHIFT",
6317 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
6318 }
6319
6320# check for pointer comparisons to NULL
6321 if ($perl_version_ok) {
6322 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
6323 my $val = $1;
6324 my $equal = "!";
6325 $equal = "" if ($4 eq "!=");
6326 if (CHK("COMPARISON_TO_NULL",
6327 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
6328 $fix) {
6329 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
6330 }
6331 }
6332 }
6333
6334# check for bad placement of section $InitAttribute (e.g.: __initdata)
6335 if ($line =~ /(\b$InitAttribute\b)/) {
6336 my $attr = $1;
6337 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
6338 my $ptr = $1;
6339 my $var = $2;
6340 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
6341 ERROR("MISPLACED_INIT",
6342 "$attr should be placed after $var\n" . $herecurr)) ||
6343 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
6344 WARN("MISPLACED_INIT",
6345 "$attr should be placed after $var\n" . $herecurr))) &&
6346 $fix) {
6347 $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;
6348 }
6349 }
6350 }
6351
6352# check for $InitAttributeData (ie: __initdata) with const
6353 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
6354 my $attr = $1;
6355 $attr =~ /($InitAttributePrefix)(.*)/;
6356 my $attr_prefix = $1;
6357 my $attr_type = $2;
6358 if (ERROR("INIT_ATTRIBUTE",
6359 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
6360 $fix) {
6361 $fixed[$fixlinenr] =~
6362 s/$InitAttributeData/${attr_prefix}initconst/;
6363 }
6364 }
6365
6366# check for $InitAttributeConst (ie: __initconst) without const
6367 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
6368 my $attr = $1;
6369 if (ERROR("INIT_ATTRIBUTE",
6370 "Use of $attr requires a separate use of const\n" . $herecurr) &&
6371 $fix) {
6372 my $lead = $fixed[$fixlinenr] =~
6373 /(^\+\s*(?:static\s+))/;
6374 $lead = rtrim($1);
6375 $lead = "$lead " if ($lead !~ /^\+$/);
6376 $lead = "${lead}const ";
6377 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
6378 }
6379 }
6380
6381# check for __read_mostly with const non-pointer (should just be const)
6382 if ($line =~ /\b__read_mostly\b/ &&
6383 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
6384 if (ERROR("CONST_READ_MOSTLY",
6385 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
6386 $fix) {
6387 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
6388 }
6389 }
6390
6391# don't use __constant_<foo> functions outside of include/uapi/
6392 if ($realfile !~ m@^include/uapi/@ &&
6393 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
6394 my $constant_func = $1;
6395 my $func = $constant_func;
6396 $func =~ s/^__constant_//;
6397 if (WARN("CONSTANT_CONVERSION",
6398 "$constant_func should be $func\n" . $herecurr) &&
6399 $fix) {
6400 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
6401 }
6402 }
6403
6404# prefer usleep_range over udelay
6405 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
6406 my $delay = $1;
6407 # ignore udelay's < 10, however
6408 if (! ($delay < 10) ) {
6409 CHK("USLEEP_RANGE",
6410 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
6411 }
6412 if ($delay > 2000) {
6413 WARN("LONG_UDELAY",
6414 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
6415 }
6416 }
6417
6418# warn about unexpectedly long msleep's
6419 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
6420 if ($1 < 20) {
6421 WARN("MSLEEP",
6422 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
6423 }
6424 }
6425
6426# check for comparisons of jiffies
6427 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
6428 WARN("JIFFIES_COMPARISON",
6429 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
6430 }
6431
6432# check for comparisons of get_jiffies_64()
6433 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
6434 WARN("JIFFIES_COMPARISON",
6435 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
6436 }
6437
6438# warn about #ifdefs in C files
6439# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
6440# print "#ifdef in C files should be avoided\n";
6441# print "$herecurr";
6442# $clean = 0;
6443# }
6444
6445# warn about spacing in #ifdefs
6446 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
6447 if (ERROR("SPACING",
6448 "exactly one space required after that #$1\n" . $herecurr) &&
6449 $fix) {
6450 $fixed[$fixlinenr] =~
6451 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
6452 }
6453
6454 }
6455
6456# check for spinlock_t definitions without a comment.
6457 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
6458 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
6459 my $which = $1;
6460 if (!ctx_has_comment($first_line, $linenr)) {
6461 CHK("UNCOMMENTED_DEFINITION",
6462 "$1 definition without comment\n" . $herecurr);
6463 }
6464 }
6465# check for memory barriers without a comment.
6466
6467 my $barriers = qr{
6468 mb|
6469 rmb|
6470 wmb
6471 }x;
6472 my $barrier_stems = qr{
6473 mb__before_atomic|
6474 mb__after_atomic|
6475 store_release|
6476 load_acquire|
6477 store_mb|
6478 (?:$barriers)
6479 }x;
6480 my $all_barriers = qr{
6481 (?:$barriers)|
6482 smp_(?:$barrier_stems)|
6483 virt_(?:$barrier_stems)
6484 }x;
6485
6486 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
6487 if (!ctx_has_comment($first_line, $linenr)) {
6488 WARN("MEMORY_BARRIER",
6489 "memory barrier without comment\n" . $herecurr);
6490 }
6491 }
6492
6493 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
6494
6495 if ($realfile !~ m@^include/asm-generic/@ &&
6496 $realfile !~ m@/barrier\.h$@ &&
6497 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
6498 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
6499 WARN("MEMORY_BARRIER",
6500 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
6501 }
6502
6503# check for waitqueue_active without a comment.
6504 if ($line =~ /\bwaitqueue_active\s*\(/) {
6505 if (!ctx_has_comment($first_line, $linenr)) {
6506 WARN("WAITQUEUE_ACTIVE",
6507 "waitqueue_active without comment\n" . $herecurr);
6508 }
6509 }
6510
6511# check for data_race without a comment.
6512 if ($line =~ /\bdata_race\s*\(/) {
6513 if (!ctx_has_comment($first_line, $linenr)) {
6514 WARN("DATA_RACE",
6515 "data_race without comment\n" . $herecurr);
6516 }
6517 }
6518
6519# check of hardware specific defines
6520 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
6521 CHK("ARCH_DEFINES",
6522 "architecture specific defines should be avoided\n" . $herecurr);
6523 }
6524
6525# check that the storage class is not after a type
6526 if ($line =~ /\b($Type)\s+($Storage)\b/) {
6527 WARN("STORAGE_CLASS",
6528 "storage class '$2' should be located before type '$1'\n" . $herecurr);
6529 }
6530# Check that the storage class is at the beginning of a declaration
6531 if ($line =~ /\b$Storage\b/ &&
6532 $line !~ /^.\s*$Storage/ &&
6533 $line =~ /^.\s*(.+?)\$Storage\s/ &&
6534 $1 !~ /[\,\)]\s*$/) {
6535 WARN("STORAGE_CLASS",
6536 "storage class should be at the beginning of the declaration\n" . $herecurr);
6537 }
6538
6539# check the location of the inline attribute, that it is between
6540# storage class and type.
6541 if ($line =~ /\b$Type\s+$Inline\b/ ||
6542 $line =~ /\b$Inline\s+$Storage\b/) {
6543 ERROR("INLINE_LOCATION",
6544 "inline keyword should sit between storage class and type\n" . $herecurr);
6545 }
6546
6547# Check for __inline__ and __inline, prefer inline
6548 if ($realfile !~ m@\binclude/uapi/@ &&
6549 $line =~ /\b(__inline__|__inline)\b/) {
6550 if (WARN("INLINE",
6551 "plain inline is preferred over $1\n" . $herecurr) &&
6552 $fix) {
6553 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
6554
6555 }
6556 }
6557
6558# Check for compiler attributes
6559 if ($realfile !~ m@\binclude/uapi/@ &&
6560 $rawline =~ /\b__attribute__\s*\(\s*($balanced_parens)\s*\)/) {
6561 my $attr = $1;
6562 $attr =~ s/\s*\(\s*(.*)\)\s*/$1/;
6563
6564 my %attr_list = (
6565 "alias" => "__alias",
6566 "aligned" => "__aligned",
6567 "always_inline" => "__always_inline",
6568 "assume_aligned" => "__assume_aligned",
6569 "cold" => "__cold",
6570 "const" => "__attribute_const__",
6571 "copy" => "__copy",
6572 "designated_init" => "__designated_init",
6573 "externally_visible" => "__visible",
6574 "format" => "printf|scanf",
6575 "gnu_inline" => "__gnu_inline",
6576 "malloc" => "__malloc",
6577 "mode" => "__mode",
6578 "no_caller_saved_registers" => "__no_caller_saved_registers",
6579 "noclone" => "__noclone",
6580 "noinline" => "noinline",
6581 "nonstring" => "__nonstring",
6582 "noreturn" => "__noreturn",
6583 "packed" => "__packed",
6584 "pure" => "__pure",
6585 "section" => "__section",
6586 "used" => "__used",
6587 "weak" => "__weak"
6588 );
6589
6590 while ($attr =~ /\s*(\w+)\s*(${balanced_parens})?/g) {
6591 my $orig_attr = $1;
6592 my $params = '';
6593 $params = $2 if defined($2);
6594 my $curr_attr = $orig_attr;
6595 $curr_attr =~ s/^[\s_]+|[\s_]+$//g;
6596 if (exists($attr_list{$curr_attr})) {
6597 my $new = $attr_list{$curr_attr};
6598 if ($curr_attr eq "format" && $params) {
6599 $params =~ /^\s*\(\s*(\w+)\s*,\s*(.*)/;
6600 $new = "__$1\($2";
6601 } else {
6602 $new = "$new$params";
6603 }
6604 if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO",
6605 "Prefer $new over __attribute__(($orig_attr$params))\n" . $herecurr) &&
6606 $fix) {
6607 my $remove = "\Q$orig_attr\E" . '\s*' . "\Q$params\E" . '(?:\s*,\s*)?';
6608 $fixed[$fixlinenr] =~ s/$remove//;
6609 $fixed[$fixlinenr] =~ s/\b__attribute__/$new __attribute__/;
6610 $fixed[$fixlinenr] =~ s/\}\Q$new\E/} $new/;
6611 $fixed[$fixlinenr] =~ s/ __attribute__\s*\(\s*\(\s*\)\s*\)//;
6612 }
6613 }
6614 }
6615
6616 # Check for __attribute__ unused, prefer __always_unused or __maybe_unused
6617 if ($attr =~ /^_*unused/) {
6618 WARN("PREFER_DEFINED_ATTRIBUTE_MACRO",
6619 "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr);
6620 }
6621 }
6622
6623# Check for __attribute__ weak, or __weak declarations (may have link issues)
6624 if ($perl_version_ok &&
6625 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6626 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
6627 $line =~ /\b__weak\b/)) {
6628 ERROR("WEAK_DECLARATION",
6629 "Using weak declarations can have unintended link defects\n" . $herecurr);
6630 }
6631
6632# check for c99 types like uint8_t used outside of uapi/ and tools/
6633 if ($realfile !~ m@\binclude/uapi/@ &&
6634 $realfile !~ m@\btools/@ &&
6635 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
6636 my $type = $1;
6637 if ($type =~ /\b($typeC99Typedefs)\b/) {
6638 $type = $1;
6639 my $kernel_type = 'u';
6640 $kernel_type = 's' if ($type =~ /^_*[si]/);
6641 $type =~ /(\d+)/;
6642 $kernel_type .= $1;
6643 if (CHK("PREFER_KERNEL_TYPES",
6644 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
6645 $fix) {
6646 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
6647 }
6648 }
6649 }
6650
6651# check for cast of C90 native int or longer types constants
6652 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
6653 my $cast = $1;
6654 my $const = $2;
6655 my $suffix = "";
6656 my $newconst = $const;
6657 $newconst =~ s/${Int_type}$//;
6658 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
6659 if ($cast =~ /\blong\s+long\b/) {
6660 $suffix .= 'LL';
6661 } elsif ($cast =~ /\blong\b/) {
6662 $suffix .= 'L';
6663 }
6664 if (WARN("TYPECAST_INT_CONSTANT",
6665 "Unnecessary typecast of c90 int constant - '$cast$const' could be '$const$suffix'\n" . $herecurr) &&
6666 $fix) {
6667 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
6668 }
6669 }
6670
6671# check for sizeof(&)
6672 if ($line =~ /\bsizeof\s*\(\s*\&/) {
6673 WARN("SIZEOF_ADDRESS",
6674 "sizeof(& should be avoided\n" . $herecurr);
6675 }
6676
6677# check for sizeof without parenthesis
6678 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
6679 if (WARN("SIZEOF_PARENTHESIS",
6680 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
6681 $fix) {
6682 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
6683 }
6684 }
6685
6686# check for struct spinlock declarations
6687 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
6688 WARN("USE_SPINLOCK_T",
6689 "struct spinlock should be spinlock_t\n" . $herecurr);
6690 }
6691
6692# check for seq_printf uses that could be seq_puts
6693 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
6694 my $fmt = get_quoted_string($line, $rawline);
6695 $fmt =~ s/%%//g;
6696 if ($fmt !~ /%/) {
6697 if (WARN("PREFER_SEQ_PUTS",
6698 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6699 $fix) {
6700 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
6701 }
6702 }
6703 }
6704
6705# check for vsprintf extension %p<foo> misuses
6706 if ($perl_version_ok &&
6707 defined $stat &&
6708 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
6709 $1 !~ /^_*volatile_*$/) {
6710 my $stat_real;
6711
6712 my $lc = $stat =~ tr@\n@@;
6713 $lc = $lc + $linenr;
6714 for (my $count = $linenr; $count <= $lc; $count++) {
6715 my $specifier;
6716 my $extension;
6717 my $qualifier;
6718 my $bad_specifier = "";
6719 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
6720 $fmt =~ s/%%//g;
6721
6722 while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
6723 $specifier = $1;
6724 $extension = $2;
6725 $qualifier = $3;
6726 if ($extension !~ /[4SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
6727 ($extension eq "f" &&
6728 defined $qualifier && $qualifier !~ /^w/) ||
6729 ($extension eq "4" &&
6730 defined $qualifier && $qualifier !~ /^cc/)) {
6731 $bad_specifier = $specifier;
6732 last;
6733 }
6734 if ($extension eq "x" && !defined($stat_real)) {
6735 if (!defined($stat_real)) {
6736 $stat_real = get_stat_real($linenr, $lc);
6737 }
6738 #WARN("VSPRINTF_SPECIFIER_PX",
6739 # "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");
6740 }
6741 }
6742 if ($bad_specifier ne "") {
6743 my $stat_real = get_stat_real($linenr, $lc);
6744 my $ext_type = "Invalid";
6745 my $use = "";
6746 if ($bad_specifier =~ /p[Ff]/) {
6747 $use = " - use %pS instead";
6748 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6749 }
6750
6751 WARN("VSPRINTF_POINTER_EXTENSION",
6752 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6753 }
6754 }
6755 }
6756
6757# Check for misused memsets
6758 if ($perl_version_ok &&
6759 defined $stat &&
6760 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
6761
6762 my $ms_addr = $2;
6763 my $ms_val = $7;
6764 my $ms_size = $12;
6765
6766 if ($ms_size =~ /^(0x|)0$/i) {
6767 ERROR("MEMSET",
6768 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
6769 } elsif ($ms_size =~ /^(0x|)1$/i) {
6770 WARN("MEMSET",
6771 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6772 }
6773 }
6774
6775# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6776# if ($perl_version_ok &&
6777# defined $stat &&
6778# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6779# if (WARN("PREFER_ETHER_ADDR_COPY",
6780# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6781# $fix) {
6782# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6783# }
6784# }
6785
6786# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6787# if ($perl_version_ok &&
6788# defined $stat &&
6789# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6790# WARN("PREFER_ETHER_ADDR_EQUAL",
6791# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6792# }
6793
6794# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6795# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6796# if ($perl_version_ok &&
6797# defined $stat &&
6798# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6799#
6800# my $ms_val = $7;
6801#
6802# if ($ms_val =~ /^(?:0x|)0+$/i) {
6803# if (WARN("PREFER_ETH_ZERO_ADDR",
6804# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6805# $fix) {
6806# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6807# }
6808# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6809# if (WARN("PREFER_ETH_BROADCAST_ADDR",
6810# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6811# $fix) {
6812# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6813# }
6814# }
6815# }
6816
6817# strlcpy uses that should likely be strscpy
6818 if ($line =~ /\bstrlcpy\s*\(/) {
6819 WARN("STRLCPY",
6820 "Prefer strscpy over strlcpy - see: https://lore.kernel.org/r/CAHk-=wgfRnXz0W3D37d01q3JFkr_i_uTL=V6A6G1oUZcprmknw\@mail.gmail.com/\n" . $herecurr);
6821 }
6822
6823# typecasts on min/max could be min_t/max_t
6824 if ($perl_version_ok &&
6825 defined $stat &&
6826 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
6827 if (defined $2 || defined $7) {
6828 my $call = $1;
6829 my $cast1 = deparenthesize($2);
6830 my $arg1 = $3;
6831 my $cast2 = deparenthesize($7);
6832 my $arg2 = $8;
6833 my $cast;
6834
6835 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
6836 $cast = "$cast1 or $cast2";
6837 } elsif ($cast1 ne "") {
6838 $cast = $cast1;
6839 } else {
6840 $cast = $cast2;
6841 }
6842 WARN("MINMAX",
6843 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
6844 }
6845 }
6846
6847# check usleep_range arguments
6848 if ($perl_version_ok &&
6849 defined $stat &&
6850 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6851 my $min = $1;
6852 my $max = $7;
6853 if ($min eq $max) {
6854 WARN("USLEEP_RANGE",
6855 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6856 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6857 $min > $max) {
6858 WARN("USLEEP_RANGE",
6859 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6860 }
6861 }
6862
6863# check for naked sscanf
6864 if ($perl_version_ok &&
6865 defined $stat &&
6866 $line =~ /\bsscanf\b/ &&
6867 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6868 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6869 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6870 my $lc = $stat =~ tr@\n@@;
6871 $lc = $lc + $linenr;
6872 my $stat_real = get_stat_real($linenr, $lc);
6873 WARN("NAKED_SSCANF",
6874 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6875 }
6876
6877# check for simple sscanf that should be kstrto<foo>
6878 if ($perl_version_ok &&
6879 defined $stat &&
6880 $line =~ /\bsscanf\b/) {
6881 my $lc = $stat =~ tr@\n@@;
6882 $lc = $lc + $linenr;
6883 my $stat_real = get_stat_real($linenr, $lc);
6884 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6885 my $format = $6;
6886 my $count = $format =~ tr@%@%@;
6887 if ($count == 1 &&
6888 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6889 WARN("SSCANF_TO_KSTRTO",
6890 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6891 }
6892 }
6893 }
6894
6895# check for new externs in .h files.
6896 if ($realfile =~ /\.h$/ &&
6897 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
6898 if (CHK("AVOID_EXTERNS",
6899 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
6900 $fix) {
6901 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
6902 }
6903 }
6904
6905# check for new externs in .c files.
6906 if ($realfile =~ /\.c$/ && defined $stat &&
6907 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
6908 {
6909 my $function_name = $1;
6910 my $paren_space = $2;
6911
6912 my $s = $stat;
6913 if (defined $cond) {
6914 substr($s, 0, length($cond), '');
6915 }
6916 if ($s =~ /^\s*;/)
6917 {
6918 WARN("AVOID_EXTERNS",
6919 "externs should be avoided in .c files\n" . $herecurr);
6920 }
6921
6922 if ($paren_space =~ /\n/) {
6923 WARN("FUNCTION_ARGUMENTS",
6924 "arguments for function declarations should follow identifier\n" . $herecurr);
6925 }
6926
6927 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6928 $stat =~ /^.\s*extern\s+/)
6929 {
6930 WARN("AVOID_EXTERNS",
6931 "externs should be avoided in .c files\n" . $herecurr);
6932 }
6933
6934# check for function declarations that have arguments without identifier names
6935 if (defined $stat &&
6936 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6937 $1 ne "void") {
6938 my $args = trim($1);
6939 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6940 my $arg = trim($1);
6941 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6942 WARN("FUNCTION_ARGUMENTS",
6943 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6944 }
6945 }
6946 }
6947
6948# check for function definitions
6949 if ($perl_version_ok &&
6950 defined $stat &&
6951 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6952 $context_function = $1;
6953
6954# check for multiline function definition with misplaced open brace
6955 my $ok = 0;
6956 my $cnt = statement_rawlines($stat);
6957 my $herectx = $here . "\n";
6958 for (my $n = 0; $n < $cnt; $n++) {
6959 my $rl = raw_line($linenr, $n);
6960 $herectx .= $rl . "\n";
6961 $ok = 1 if ($rl =~ /^[ \+]\{/);
6962 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6963 last if $rl =~ /^[ \+].*\{/;
6964 }
6965 if (!$ok) {
6966 ERROR("OPEN_BRACE",
6967 "open brace '{' following function definitions go on the next line\n" . $herectx);
6968 }
6969 }
6970
6971# checks for new __setup's
6972# if ($rawline =~ /\b__setup\("([^"]*)"/) {
6973# my $name = $1;
6974#
6975# if (!grep(/$name/, @setup_docs)) {
6976# CHK("UNDOCUMENTED_SETUP",
6977# "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
6978# }
6979# }
6980
6981# check for pointless casting of alloc functions
6982 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
6983 WARN("UNNECESSARY_CASTS",
6984 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6985 }
6986
6987# alloc style
6988# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6989 if ($perl_version_ok &&
6990 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6991 CHK("ALLOC_SIZEOF_STRUCT",
6992 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6993 }
6994
6995# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6996 if ($perl_version_ok &&
6997 defined $stat &&
6998 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6999 my $oldfunc = $3;
7000 my $a1 = $4;
7001 my $a2 = $10;
7002 my $newfunc = "kmalloc_array";
7003 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
7004 my $r1 = $a1;
7005 my $r2 = $a2;
7006 if ($a1 =~ /^sizeof\s*\S/) {
7007 $r1 = $a2;
7008 $r2 = $a1;
7009 }
7010 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
7011 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
7012 my $cnt = statement_rawlines($stat);
7013 my $herectx = get_stat_here($linenr, $cnt, $here);
7014
7015 if (WARN("ALLOC_WITH_MULTIPLY",
7016 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
7017 $cnt == 1 &&
7018 $fix) {
7019 $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;
7020 }
7021 }
7022 }
7023
7024# check for krealloc arg reuse
7025 if ($perl_version_ok &&
7026 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
7027 $1 eq $3) {
7028 WARN("KREALLOC_ARG_REUSE",
7029 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
7030 }
7031
7032# check for alloc argument mismatch
7033 if ($line =~ /\b((?:devm_)?(?:kcalloc|kmalloc_array))\s*\(\s*sizeof\b/) {
7034 WARN("ALLOC_ARRAY_ARGS",
7035 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
7036 }
7037
7038# check for multiple semicolons
7039 if ($line =~ /;\s*;\s*$/) {
7040 if (WARN("ONE_SEMICOLON",
7041 "Statements terminations use 1 semicolon\n" . $herecurr) &&
7042 $fix) {
7043 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
7044 }
7045 }
7046
7047# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
7048 if ($realfile !~ m@^include/uapi/@ &&
7049 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
7050 my $ull = "";
7051 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
7052 if (CHK("BIT_MACRO",
7053 "Prefer using the BIT$ull macro\n" . $herecurr) &&
7054 $fix) {
7055 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
7056 }
7057 }
7058
7059# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
7060 if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) {
7061 WARN("IS_ENABLED_CONFIG",
7062 "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr);
7063 }
7064
7065# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
7066 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(${CONFIG_}[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
7067 my $config = $1;
7068 if (WARN("PREFER_IS_ENABLED",
7069 "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) &&
7070 $fix) {
7071 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
7072 }
7073 }
7074
7075# check for /* fallthrough */ like comment, prefer fallthrough;
7076 my @fallthroughs = (
7077 'fallthrough',
7078 '@fallthrough@',
7079 'lint -fallthrough[ \t]*',
7080 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)',
7081 '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?',
7082 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
7083 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
7084 );
7085 if ($raw_comment ne '') {
7086 foreach my $ft (@fallthroughs) {
7087 if ($raw_comment =~ /$ft/) {
7088 my $msg_level = \&WARN;
7089 $msg_level = \&CHK if ($file);
7090 &{$msg_level}("PREFER_FALLTHROUGH",
7091 "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr);
7092 last;
7093 }
7094 }
7095 }
7096
7097# check for switch/default statements without a break;
7098 if ($perl_version_ok &&
7099 defined $stat &&
7100 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
7101 my $cnt = statement_rawlines($stat);
7102 my $herectx = get_stat_here($linenr, $cnt, $here);
7103
7104 WARN("DEFAULT_NO_BREAK",
7105 "switch default: should use break\n" . $herectx);
7106 }
7107
7108# check for gcc specific __FUNCTION__
7109 if ($line =~ /\b__FUNCTION__\b/) {
7110 if (WARN("USE_FUNC",
7111 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
7112 $fix) {
7113 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
7114 }
7115 }
7116
7117# check for uses of __DATE__, __TIME__, __TIMESTAMP__
7118 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
7119 ERROR("DATE_TIME",
7120 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
7121 }
7122
7123# check for use of yield()
7124 if ($line =~ /\byield\s*\(\s*\)/) {
7125 WARN("YIELD",
7126 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
7127 }
7128
7129# check for comparisons against true and false
7130 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
7131 my $lead = $1;
7132 my $arg = $2;
7133 my $test = $3;
7134 my $otype = $4;
7135 my $trail = $5;
7136 my $op = "!";
7137
7138 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
7139
7140 my $type = lc($otype);
7141 if ($type =~ /^(?:true|false)$/) {
7142 if (("$test" eq "==" && "$type" eq "true") ||
7143 ("$test" eq "!=" && "$type" eq "false")) {
7144 $op = "";
7145 }
7146
7147 CHK("BOOL_COMPARISON",
7148 "Using comparison to $otype is error prone\n" . $herecurr);
7149
7150## maybe suggesting a correct construct would better
7151## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
7152
7153 }
7154 }
7155
7156# check for semaphores initialized locked
7157 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
7158 WARN("CONSIDER_COMPLETION",
7159 "consider using a completion\n" . $herecurr);
7160 }
7161
7162# recommend kstrto* over simple_strto* and strict_strto*
7163 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
7164 WARN("CONSIDER_KSTRTO",
7165 "$1 is obsolete, use k$3 instead\n" . $herecurr);
7166 }
7167
7168# check for __initcall(), use device_initcall() explicitly or more appropriate function please
7169 if ($line =~ /^.\s*__initcall\s*\(/) {
7170 WARN("USE_DEVICE_INITCALL",
7171 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
7172 }
7173
7174# check for spin_is_locked(), suggest lockdep instead
7175 if ($line =~ /\bspin_is_locked\(/) {
7176 WARN("USE_LOCKDEP",
7177 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
7178 }
7179
7180# check for deprecated apis
7181 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
7182 my $deprecated_api = $1;
7183 my $new_api = $deprecated_apis{$deprecated_api};
7184 WARN("DEPRECATED_API",
7185 "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
7186 }
7187
7188# check for various structs that are normally const (ops, kgdb, device_tree)
7189# and avoid what seem like struct definitions 'struct foo {'
7190 if (defined($const_structs) &&
7191 $line !~ /\bconst\b/ &&
7192 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
7193 WARN("CONST_STRUCT",
7194 "struct $1 should normally be const\n" . $herecurr);
7195 }
7196
7197# use of NR_CPUS is usually wrong
7198# ignore definitions of NR_CPUS and usage to define arrays as likely right
7199# ignore designated initializers using NR_CPUS
7200 if ($line =~ /\bNR_CPUS\b/ &&
7201 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
7202 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
7203 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
7204 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
7205 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/ &&
7206 $line !~ /^.\s*\.\w+\s*=\s*.*\bNR_CPUS\b/)
7207 {
7208 WARN("NR_CPUS",
7209 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
7210 }
7211
7212# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
7213 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
7214 ERROR("DEFINE_ARCH_HAS",
7215 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
7216 }
7217
7218# likely/unlikely comparisons similar to "(likely(foo) > 0)"
7219 if ($perl_version_ok &&
7220 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
7221 WARN("LIKELY_MISUSE",
7222 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
7223 }
7224
7225# return sysfs_emit(foo, fmt, ...) fmt without newline
7226 if ($line =~ /\breturn\s+sysfs_emit\s*\(\s*$FuncArg\s*,\s*($String)/ &&
7227 substr($rawline, $-[6], $+[6] - $-[6]) !~ /\\n"$/) {
7228 my $offset = $+[6] - 1;
7229 if (WARN("SYSFS_EMIT",
7230 "return sysfs_emit(...) formats should include a terminating newline\n" . $herecurr) &&
7231 $fix) {
7232 substr($fixed[$fixlinenr], $offset, 0) = '\\n';
7233 }
7234 }
7235
7236# nested likely/unlikely calls
7237 if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
7238 WARN("LIKELY_MISUSE",
7239 "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
7240 }
7241
7242# whine mightly about in_atomic
7243 if ($line =~ /\bin_atomic\s*\(/) {
7244 if ($realfile =~ m@^drivers/@) {
7245 ERROR("IN_ATOMIC",
7246 "do not use in_atomic in drivers\n" . $herecurr);
7247 } elsif ($realfile !~ m@^kernel/@) {
7248 WARN("IN_ATOMIC",
7249 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
7250 }
7251 }
7252
7253# check for lockdep_set_novalidate_class
7254 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
7255 $line =~ /__lockdep_no_validate__\s*\)/ ) {
7256 if ($realfile !~ m@^kernel/lockdep@ &&
7257 $realfile !~ m@^include/linux/lockdep@ &&
7258 $realfile !~ m@^drivers/base/core@) {
7259 ERROR("LOCKDEP",
7260 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
7261 }
7262 }
7263
7264 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
7265 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
7266 WARN("EXPORTED_WORLD_WRITABLE",
7267 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
7268 }
7269
7270# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
7271# and whether or not function naming is typical and if
7272# DEVICE_ATTR permissions uses are unusual too
7273 if ($perl_version_ok &&
7274 defined $stat &&
7275 $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*\)/) {
7276 my $var = $1;
7277 my $perms = $2;
7278 my $show = $3;
7279 my $store = $4;
7280 my $octal_perms = perms_to_octal($perms);
7281 if ($show =~ /^${var}_show$/ &&
7282 $store =~ /^${var}_store$/ &&
7283 $octal_perms eq "0644") {
7284 if (WARN("DEVICE_ATTR_RW",
7285 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
7286 $fix) {
7287 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
7288 }
7289 } elsif ($show =~ /^${var}_show$/ &&
7290 $store =~ /^NULL$/ &&
7291 $octal_perms eq "0444") {
7292 if (WARN("DEVICE_ATTR_RO",
7293 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
7294 $fix) {
7295 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
7296 }
7297 } elsif ($show =~ /^NULL$/ &&
7298 $store =~ /^${var}_store$/ &&
7299 $octal_perms eq "0200") {
7300 if (WARN("DEVICE_ATTR_WO",
7301 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
7302 $fix) {
7303 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
7304 }
7305 } elsif ($octal_perms eq "0644" ||
7306 $octal_perms eq "0444" ||
7307 $octal_perms eq "0200") {
7308 my $newshow = "$show";
7309 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
7310 my $newstore = $store;
7311 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
7312 my $rename = "";
7313 if ($show ne $newshow) {
7314 $rename .= " '$show' to '$newshow'";
7315 }
7316 if ($store ne $newstore) {
7317 $rename .= " '$store' to '$newstore'";
7318 }
7319 WARN("DEVICE_ATTR_FUNCTIONS",
7320 "Consider renaming function(s)$rename\n" . $herecurr);
7321 } else {
7322 WARN("DEVICE_ATTR_PERMS",
7323 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
7324 }
7325 }
7326
7327# Mode permission misuses where it seems decimal should be octal
7328# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
7329# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
7330# specific definition of not visible in sysfs.
7331# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
7332# use the default permissions
7333 if ($perl_version_ok &&
7334 defined $stat &&
7335 $line =~ /$mode_perms_search/) {
7336 foreach my $entry (@mode_permission_funcs) {
7337 my $func = $entry->[0];
7338 my $arg_pos = $entry->[1];
7339
7340 my $lc = $stat =~ tr@\n@@;
7341 $lc = $lc + $linenr;
7342 my $stat_real = get_stat_real($linenr, $lc);
7343
7344 my $skip_args = "";
7345 if ($arg_pos > 1) {
7346 $arg_pos--;
7347 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
7348 }
7349 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
7350 if ($stat =~ /$test/) {
7351 my $val = $1;
7352 $val = $6 if ($skip_args ne "");
7353 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
7354 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
7355 ($val =~ /^$Octal$/ && length($val) ne 4))) {
7356 ERROR("NON_OCTAL_PERMISSIONS",
7357 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
7358 }
7359 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
7360 ERROR("EXPORTED_WORLD_WRITABLE",
7361 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
7362 }
7363 }
7364 }
7365 }
7366
7367# check for uses of S_<PERMS> that could be octal for readability
7368 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
7369 my $oval = $1;
7370 my $octal = perms_to_octal($oval);
7371 if (WARN("SYMBOLIC_PERMS",
7372 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
7373 $fix) {
7374 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
7375 }
7376 }
7377
7378# validate content of MODULE_LICENSE against list from include/linux/module.h
7379 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
7380 my $extracted_string = get_quoted_string($line, $rawline);
7381 my $valid_licenses = qr{
7382 GPL|
7383 GPL\ v2|
7384 GPL\ and\ additional\ rights|
7385 Dual\ BSD/GPL|
7386 Dual\ MIT/GPL|
7387 Dual\ MPL/GPL|
7388 Proprietary
7389 }x;
7390 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
7391 WARN("MODULE_LICENSE",
7392 "unknown module license " . $extracted_string . "\n" . $herecurr);
7393 }
7394 }
7395
7396# check for sysctl duplicate constants
7397 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
7398 WARN("DUPLICATED_SYSCTL_CONST",
7399 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
7400 }
7401 }
7402
7403 # If we have no input at all, then there is nothing to report on
7404 # so just keep quiet.
7405 if ($#rawlines == -1) {
7406 exit(0);
7407 }
7408
7409 # In mailback mode only produce a report in the negative, for
7410 # things that appear to be patches.
7411 if ($mailback && ($clean == 1 || !$is_patch)) {
7412 exit(0);
7413 }
7414
7415 # This is not a patch, and we are in 'no-patch' mode so
7416 # just keep quiet.
7417 if (!$chk_patch && !$is_patch) {
7418 exit(0);
7419 }
7420
7421 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
7422 ERROR("NOT_UNIFIED_DIFF",
7423 "Does not appear to be a unified-diff format patch\n");
7424 }
7425 if ($is_patch && $has_commit_log && $chk_signoff) {
7426 if ($signoff == 0) {
7427 ERROR("MISSING_SIGN_OFF",
7428 "Missing Signed-off-by: line(s)\n");
7429 } elsif ($authorsignoff != 1) {
7430 # authorsignoff values:
7431 # 0 -> missing sign off
7432 # 1 -> sign off identical
7433 # 2 -> names and addresses match, comments mismatch
7434 # 3 -> addresses match, names different
7435 # 4 -> names match, addresses different
7436 # 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match
7437
7438 my $sob_msg = "'From: $author' != 'Signed-off-by: $author_sob'";
7439
7440 if ($authorsignoff == 0) {
7441 ERROR("NO_AUTHOR_SIGN_OFF",
7442 "Missing Signed-off-by: line by nominal patch author '$author'\n");
7443 } elsif ($authorsignoff == 2) {
7444 CHK("FROM_SIGN_OFF_MISMATCH",
7445 "From:/Signed-off-by: email comments mismatch: $sob_msg\n");
7446 } elsif ($authorsignoff == 3) {
7447 WARN("FROM_SIGN_OFF_MISMATCH",
7448 "From:/Signed-off-by: email name mismatch: $sob_msg\n");
7449 } elsif ($authorsignoff == 4) {
7450 WARN("FROM_SIGN_OFF_MISMATCH",
7451 "From:/Signed-off-by: email address mismatch: $sob_msg\n");
7452 } elsif ($authorsignoff == 5) {
7453 WARN("FROM_SIGN_OFF_MISMATCH",
7454 "From:/Signed-off-by: email subaddress mismatch: $sob_msg\n");
7455 }
7456 }
7457 }
7458
7459 print report_dump();
7460 if ($summary && !($clean == 1 && $quiet == 1)) {
7461 print "$filename " if ($summary_file);
7462 print "total: $cnt_error errors, $cnt_warn warnings, " .
7463 (($check)? "$cnt_chk checks, " : "") .
7464 "$cnt_lines lines checked\n";
7465 }
7466
7467 if ($quiet == 0) {
7468 # If there were any defects found and not already fixing them
7469 if (!$clean and !$fix) {
7470 print << "EOM"
7471
7472NOTE: For some of the reported defects, checkpatch may be able to
7473 mechanically convert to the typical style using --fix or --fix-inplace.
7474EOM
7475 }
7476 # If there were whitespace errors which cleanpatch can fix
7477 # then suggest that.
7478 if ($rpt_cleaners) {
7479 $rpt_cleaners = 0;
7480 print << "EOM"
7481
7482NOTE: Whitespace errors detected.
7483 You may wish to use scripts/cleanpatch or scripts/cleanfile
7484EOM
7485 }
7486 }
7487
7488 if ($clean == 0 && $fix &&
7489 ("@rawlines" ne "@fixed" ||
7490 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
7491 my $newfile = $filename;
7492 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
7493 my $linecount = 0;
7494 my $f;
7495
7496 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
7497
7498 open($f, '>', $newfile)
7499 or die "$P: Can't open $newfile for write\n";
7500 foreach my $fixed_line (@fixed) {
7501 $linecount++;
7502 if ($file) {
7503 if ($linecount > 3) {
7504 $fixed_line =~ s/^\+//;
7505 print $f $fixed_line . "\n";
7506 }
7507 } else {
7508 print $f $fixed_line . "\n";
7509 }
7510 }
7511 close($f);
7512
7513 if (!$quiet) {
7514 print << "EOM";
7515
7516Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
7517
7518Do _NOT_ trust the results written to this file.
7519Do _NOT_ submit these changes without inspecting them for correctness.
7520
7521This EXPERIMENTAL file is simply a convenience to help rewrite patches.
7522No warranties, expressed or implied...
7523EOM
7524 }
7525 }
7526
7527 if ($quiet == 0) {
7528 print "\n";
7529 if ($clean == 1) {
7530 print "$vname has no obvious style problems and is ready for submission.\n";
7531 } else {
7532 print "$vname has style problems, please review.\n";
7533 }
7534 }
7535 return $clean;
7536}