util/lint: update checkpatch & spelling.txt to upstream versions
- Update checkpatch.pl to version 0547fa58 (checkpatch: add 6 missing types to --list-types) - Update spelling.txt to version d9f91f8 (scripts/spelling.txt: add a bunch more spelling mistakes) - Fix an additional unescaped left brace in a regex - causes warnings in new versions of perl. Change-Id: Ic443099e90a46280f18d58799afc72d00dc83793 Signed-off-by: Martin Roth <gaumless@gmail.com> Reviewed-on: https://review.coreboot.org/21581 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Chris Ching <chingcodes@chromium.org> Reviewed-by: Patrick Georgi <pgeorgi@google.com>
This commit is contained in:
Martin Roth
Martin Roth
@@ -1,4 +1,4 @@
|
||||
#!/usr/bin/perl -w
|
||||
#!/usr/bin/env perl
|
||||
# (c) 2001, Dave Jones. (the file handling bit)
|
||||
# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
|
||||
# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
|
||||
@@ -6,6 +6,7 @@
|
||||
# Licensed under the terms of the GNU GPL License version 2
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
use POSIX;
|
||||
use File::Basename;
|
||||
use Cwd 'abs_path';
|
||||
@@ -56,7 +57,8 @@ my $spelling_file = "$D/spelling.txt";
|
||||
my $codespell = 0;
|
||||
my $codespellfile = "/usr/share/codespell/dictionary.txt";
|
||||
my $conststructsfile = "$D/const_structs.checkpatch";
|
||||
my $color = 1;
|
||||
my $typedefsfile = "";
|
||||
my $color = "auto";
|
||||
my $allow_c99_comments = 1;
|
||||
|
||||
# For coreboot jenkins
|
||||
@@ -122,7 +124,9 @@ Options:
|
||||
--codespell Use the codespell dictionary for spelling/typos
|
||||
(default:/usr/share/codespell/dictionary.txt)
|
||||
--codespellfile Use this codespell dictionary
|
||||
--color Use colors when output is STDOUT (default: on)
|
||||
--typedefsfile Read additional types from this file
|
||||
--color[=WHEN] Use colors 'always', 'never', or only when output
|
||||
is a terminal ('auto'). Default is 'auto'.
|
||||
-h, --help, --version display this help and exit
|
||||
|
||||
When FILE is - read standard input.
|
||||
@@ -150,7 +154,8 @@ sub list_types {
|
||||
close($script);
|
||||
|
||||
my @types = ();
|
||||
for ($text =~ /\b(?:(?:CHK|WARN|ERROR)\s*\(\s*"([^"]+)")/g) {
|
||||
# Also catch when type or level is passed through a variable
|
||||
for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
|
||||
push (@types, $_);
|
||||
}
|
||||
@types = sort(uniq(@types));
|
||||
@@ -188,6 +193,14 @@ if (-f $conf) {
|
||||
unshift(@ARGV, @conf_args) if @conf_args;
|
||||
}
|
||||
|
||||
# Perl's Getopt::Long allows options to take optional arguments after a space.
|
||||
# Prevent --color by itself from consuming other arguments
|
||||
foreach (@ARGV) {
|
||||
if ($_ eq "--color" || $_ eq "-color") {
|
||||
$_ = "--color=$color";
|
||||
}
|
||||
}
|
||||
|
||||
GetOptions(
|
||||
'q|quiet+' => \$quiet,
|
||||
'tree!' => \$tree,
|
||||
@@ -218,7 +231,10 @@ GetOptions(
|
||||
'test-only=s' => \$tst_only,
|
||||
'codespell!' => \$codespell,
|
||||
'codespellfile=s' => \$codespellfile,
|
||||
'color!' => \$color,
|
||||
'typedefsfile=s' => \$typedefsfile,
|
||||
'color=s' => \$color,
|
||||
'no-color' => \$color, #keep old behaviors of -nocolor
|
||||
'nocolor' => \$color, #keep old behaviors of -nocolor
|
||||
'h|help' => \$help,
|
||||
'version' => \$help
|
||||
) or help(1);
|
||||
@@ -244,6 +260,18 @@ if ($#ARGV < 0) {
|
||||
push(@ARGV, '-');
|
||||
}
|
||||
|
||||
if ($color =~ /^[01]$/) {
|
||||
$color = !$color;
|
||||
} elsif ($color =~ /^always$/i) {
|
||||
$color = 1;
|
||||
} elsif ($color =~ /^never$/i) {
|
||||
$color = 0;
|
||||
} elsif ($color =~ /^auto$/i) {
|
||||
$color = (-t STDOUT);
|
||||
} else {
|
||||
die "Invalid color mode: $color\n";
|
||||
}
|
||||
|
||||
sub hash_save_array_words {
|
||||
my ($hashRef, $arrayRef) = @_;
|
||||
|
||||
@@ -639,29 +667,44 @@ if ($codespell) {
|
||||
|
||||
$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
|
||||
|
||||
my $const_structs = "";
|
||||
if (open(my $conststructs, '<', $conststructsfile)) {
|
||||
while (<$conststructs>) {
|
||||
my $line = $_;
|
||||
sub read_words {
|
||||
my ($wordsRef, $file) = @_;
|
||||
|
||||
$line =~ s/\s*\n?$//g;
|
||||
$line =~ s/^\s*//g;
|
||||
if (open(my $words, '<', $file)) {
|
||||
while (<$words>) {
|
||||
my $line = $_;
|
||||
|
||||
next if ($line =~ m/^\s*#/);
|
||||
next if ($line =~ m/^\s*$/);
|
||||
if ($line =~ /\s/) {
|
||||
print("$conststructsfile: '$line' invalid - ignored\n");
|
||||
next;
|
||||
$line =~ s/\s*\n?$//g;
|
||||
$line =~ s/^\s*//g;
|
||||
|
||||
next if ($line =~ m/^\s*#/);
|
||||
next if ($line =~ m/^\s*$/);
|
||||
if ($line =~ /\s/) {
|
||||
print("$file: '$line' invalid - ignored\n");
|
||||
next;
|
||||
}
|
||||
|
||||
$$wordsRef .= '|' if ($$wordsRef ne "");
|
||||
$$wordsRef .= $line;
|
||||
}
|
||||
|
||||
$const_structs .= '|' if ($const_structs ne "");
|
||||
$const_structs .= $line;
|
||||
close($file);
|
||||
return 1;
|
||||
}
|
||||
close($conststructsfile);
|
||||
} else {
|
||||
warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
my $const_structs = "";
|
||||
read_words(\$const_structs, $conststructsfile)
|
||||
or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
|
||||
|
||||
my $typeOtherTypedefs = "";
|
||||
if (length($typedefsfile)) {
|
||||
read_words(\$typeOtherTypedefs, $typedefsfile)
|
||||
or warn "No additional types will be considered - file '$typedefsfile': $!\n";
|
||||
}
|
||||
$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
|
||||
|
||||
sub build_types {
|
||||
my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
|
||||
my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
|
||||
@@ -724,7 +767,7 @@ our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
|
||||
|
||||
our $declaration_macros = qr{(?x:
|
||||
(?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
|
||||
(?:$Storage\s+)?LIST_HEAD\s*\(|
|
||||
(?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
|
||||
(?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
|
||||
)};
|
||||
|
||||
@@ -858,6 +901,7 @@ sub git_commit_info {
|
||||
# echo "commit $(cut -c 1-12,41-)"
|
||||
# done
|
||||
} elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
|
||||
$id = undef;
|
||||
} else {
|
||||
$id = substr($lines[0], 0, 12);
|
||||
$desc = substr($lines[0], 41);
|
||||
@@ -905,9 +949,8 @@ if ($git) {
|
||||
}
|
||||
|
||||
my $vname;
|
||||
for my $f (@ARGV) {
|
||||
for my $filename (@ARGV) {
|
||||
my $FILE;
|
||||
my ($filename) = ($f =~ /^(.*)$/);
|
||||
if ($git) {
|
||||
open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
|
||||
die "$P: $filename: git format-patch failed - $!\n";
|
||||
@@ -1880,7 +1923,7 @@ sub report {
|
||||
return 0;
|
||||
}
|
||||
my $output = '';
|
||||
if (-t STDOUT && $color) {
|
||||
if ($color) {
|
||||
if ($level eq 'ERROR') {
|
||||
$output .= RED;
|
||||
} elsif ($level eq 'WARNING') {
|
||||
@@ -1891,10 +1934,10 @@ sub report {
|
||||
}
|
||||
$output .= $prefix . $level . ':';
|
||||
if ($show_types) {
|
||||
$output .= BLUE if (-t STDOUT && $color);
|
||||
$output .= BLUE if ($color);
|
||||
$output .= "$type:";
|
||||
}
|
||||
$output .= RESET if (-t STDOUT && $color);
|
||||
$output .= RESET if ($color);
|
||||
$output .= ' ' . $msg . "\n";
|
||||
|
||||
if ($showfile) {
|
||||
@@ -2212,8 +2255,7 @@ sub process {
|
||||
}
|
||||
#next;
|
||||
}
|
||||
if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
|
||||
my $context = $4;
|
||||
if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
|
||||
$realline=$1-1;
|
||||
if (defined $2) {
|
||||
$realcnt=$3+1;
|
||||
@@ -2222,12 +2264,6 @@ sub process {
|
||||
}
|
||||
$in_comment = 0;
|
||||
|
||||
if ($context =~ /\b(\w+)\s*\(/) {
|
||||
$context_function = $1;
|
||||
} else {
|
||||
undef $context_function;
|
||||
}
|
||||
|
||||
# Guestimate if this is a continuing comment. Run
|
||||
# the context looking for a comment "edge". If this
|
||||
# edge is a close comment then we must be in a comment
|
||||
@@ -2298,7 +2334,8 @@ sub process {
|
||||
|
||||
#extract the line range in the file after the patch is applied
|
||||
if (!$in_commit_log &&
|
||||
$line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
|
||||
$line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
|
||||
my $context = $4;
|
||||
$is_patch = 1;
|
||||
$first_line = $linenr + 1;
|
||||
$realline=$1-1;
|
||||
@@ -2314,6 +2351,11 @@ sub process {
|
||||
%suppress_whiletrailers = ();
|
||||
%suppress_export = ();
|
||||
$suppress_statement = 0;
|
||||
if ($context =~ /\b(\w+)\s*\(/) {
|
||||
$context_function = $1;
|
||||
} else {
|
||||
undef $context_function;
|
||||
}
|
||||
next;
|
||||
|
||||
# track the line number as we move through the hunk, note that
|
||||
@@ -2567,6 +2609,7 @@ sub process {
|
||||
# Check for git id commit length and improperly formed commit descriptions
|
||||
if ($in_commit_log && !$commit_log_possible_stack_dump &&
|
||||
$line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
|
||||
$line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
|
||||
($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
|
||||
($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
|
||||
$line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
|
||||
@@ -2615,7 +2658,8 @@ sub process {
|
||||
($id, $description) = git_commit_info($orig_commit,
|
||||
$id, $orig_desc);
|
||||
|
||||
if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
|
||||
if (defined($id) &&
|
||||
($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
|
||||
ERROR("GIT_COMMIT_ID",
|
||||
"Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
|
||||
}
|
||||
@@ -2656,8 +2700,8 @@ sub process {
|
||||
# Check if it's the start of a commit log
|
||||
# (not a header line and we haven't seen the patch filename)
|
||||
if ($in_header_lines && $realfile =~ /^$/ &&
|
||||
!($rawline =~ /^\s+\S/ ||
|
||||
$rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
|
||||
!($rawline =~ /^\s+(?:\S|$)/ ||
|
||||
$rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
|
||||
$in_header_lines = 0;
|
||||
$in_commit_log = 1;
|
||||
$has_commit_log = 1;
|
||||
@@ -2699,10 +2743,10 @@ sub process {
|
||||
my $typo_fix = $spelling_fix{lc($typo)};
|
||||
$typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
|
||||
$typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
|
||||
my $msg_type = \&WARN;
|
||||
$msg_type = \&CHK if ($file);
|
||||
if (&{$msg_type}("TYPO_SPELLING",
|
||||
"'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
|
||||
my $msg_level = \&WARN;
|
||||
$msg_level = \&CHK if ($file);
|
||||
if (&{$msg_level}("TYPO_SPELLING",
|
||||
"'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
|
||||
$fix) {
|
||||
$fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
|
||||
}
|
||||
@@ -2737,10 +2781,10 @@ sub process {
|
||||
$rawline =~ /\b59\s+Temple\s+Pl/i ||
|
||||
$rawline =~ /\b51\s+Franklin\s+St/i) {
|
||||
my $herevet = "$here\n" . cat_vet($rawline) . "\n";
|
||||
my $msg_type = \&ERROR;
|
||||
$msg_type = \&CHK if ($file);
|
||||
&{$msg_type}("FSF_MAILING_ADDRESS",
|
||||
"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)
|
||||
my $msg_level = \&ERROR;
|
||||
$msg_level = \&CHK if ($file);
|
||||
&{$msg_level}("FSF_MAILING_ADDRESS",
|
||||
"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)
|
||||
}
|
||||
|
||||
# check for Kconfig help text having a real description
|
||||
@@ -2785,11 +2829,15 @@ sub process {
|
||||
#print "is_start<$is_start> is_end<$is_end> length<$length>\n";
|
||||
}
|
||||
|
||||
# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
|
||||
if ($realfile =~ /Kconfig/ &&
|
||||
$line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
|
||||
WARN("CONFIG_EXPERIMENTAL",
|
||||
"Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
|
||||
# check for MAINTAINERS entries that don't have the right form
|
||||
if ($realfile =~ /^MAINTAINERS$/ &&
|
||||
$rawline =~ /^\+[A-Z]:/ &&
|
||||
$rawline !~ /^\+[A-Z]:\t\S/) {
|
||||
if (WARN("MAINTAINERS_STYLE",
|
||||
"MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
|
||||
$fix) {
|
||||
$fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
|
||||
}
|
||||
}
|
||||
|
||||
# discourage the use of boolean for type definition attributes of Kconfig options
|
||||
@@ -2855,7 +2903,7 @@ sub process {
|
||||
# #defines that are a single string
|
||||
#
|
||||
# There are 3 different line length message types:
|
||||
# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
|
||||
# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
|
||||
# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
|
||||
# LONG_LINE all other lines longer than $max_line_length
|
||||
#
|
||||
@@ -2973,7 +3021,7 @@ sub process {
|
||||
|
||||
# check multi-line statement indentation matches previous line
|
||||
if ($^V && $^V ge 5.10.0 &&
|
||||
$prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
|
||||
$prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
|
||||
$prevline =~ /^\+(\t*)(.*)$/;
|
||||
my $oldindent = $1;
|
||||
my $rest = $2;
|
||||
@@ -3161,6 +3209,17 @@ sub process {
|
||||
# check we are in a valid C source file if not then ignore this hunk
|
||||
next if ($realfile !~ /\.(h|c)$/);
|
||||
|
||||
# check if this appears to be the start function declaration, save the name
|
||||
if ($sline =~ /^\+\{\s*$/ &&
|
||||
$prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
|
||||
$context_function = $1;
|
||||
}
|
||||
|
||||
# check if this appears to be the end of function declaration
|
||||
if ($sline =~ /^\+\}\s*$/) {
|
||||
undef $context_function;
|
||||
}
|
||||
|
||||
# check indentation of any line with a bare else
|
||||
# (but not if it is a multiple line "if (foo) return bar; else return baz;")
|
||||
# if the previous line is a break or return and is indented 1 tab more...
|
||||
@@ -3185,12 +3244,6 @@ sub process {
|
||||
}
|
||||
}
|
||||
|
||||
# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
|
||||
if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
|
||||
WARN("CONFIG_EXPERIMENTAL",
|
||||
"Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
|
||||
}
|
||||
|
||||
# check for RCS/CVS revision markers
|
||||
if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
|
||||
WARN("CVS_KEYWORD",
|
||||
@@ -3219,7 +3272,7 @@ sub process {
|
||||
my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
|
||||
$realline_next);
|
||||
#print "LINE<$line>\n";
|
||||
if ($linenr >= $suppress_statement &&
|
||||
if ($linenr > $suppress_statement &&
|
||||
$realcnt && $sline =~ /.\s*\S/) {
|
||||
($stat, $cond, $line_nr_next, $remain_next, $off_next) =
|
||||
ctx_statement_block($linenr, $realcnt, 0);
|
||||
@@ -3366,7 +3419,7 @@ sub process {
|
||||
}
|
||||
|
||||
# Check relative indent for conditionals and blocks.
|
||||
if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
|
||||
if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
|
||||
($stat, $cond, $line_nr_next, $remain_next, $off_next) =
|
||||
ctx_statement_block($linenr, $realcnt, 0)
|
||||
if (!defined $stat);
|
||||
@@ -3458,6 +3511,8 @@ sub process {
|
||||
if ($check && $s ne '' &&
|
||||
(($sindent % 8) != 0 ||
|
||||
($sindent < $indent) ||
|
||||
($sindent == $indent &&
|
||||
($s !~ /^\s*(?:\}|\{|else\b)/)) ||
|
||||
($sindent > $indent + 8))) {
|
||||
WARN("SUSPECT_CODE_INDENT",
|
||||
"suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
|
||||
@@ -3551,7 +3606,7 @@ sub process {
|
||||
$fixedline =~ s/\s*=\s*$/ = {/;
|
||||
fix_insert_line($fixlinenr, $fixedline);
|
||||
$fixedline = $line;
|
||||
$fixedline =~ s/^(.\s*){\s*/$1/;
|
||||
$fixedline =~ s/^(.\s*)\{\s*/$1/;
|
||||
fix_insert_line($fixlinenr, $fixedline);
|
||||
}
|
||||
}
|
||||
@@ -3783,10 +3838,10 @@ sub process {
|
||||
|
||||
# avoid BUG() or BUG_ON()
|
||||
if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
|
||||
my $msg_type = \&WARN;
|
||||
$msg_type = \&CHK if ($file);
|
||||
&{$msg_type}("AVOID_BUG",
|
||||
"Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
|
||||
my $msg_level = \&WARN;
|
||||
$msg_level = \&CHK if ($file);
|
||||
&{$msg_level}("AVOID_BUG",
|
||||
"Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
|
||||
}
|
||||
|
||||
# avoid LINUX_VERSION_CODE
|
||||
@@ -3894,7 +3949,7 @@ sub process {
|
||||
my $fixedline = rtrim($prevrawline) . " {";
|
||||
fix_insert_line($fixlinenr, $fixedline);
|
||||
$fixedline = $rawline;
|
||||
$fixedline =~ s/^(.\s*){\s*/$1\t/;
|
||||
$fixedline =~ s/^(.\s*)\{\s*/$1\t/;
|
||||
if ($fixedline !~ /^\+\s*$/) {
|
||||
fix_insert_line($fixlinenr, $fixedline);
|
||||
}
|
||||
@@ -4315,11 +4370,11 @@ sub process {
|
||||
|
||||
# messages are ERROR, but ?: are CHK
|
||||
if ($ok == 0) {
|
||||
my $msg_type = \&ERROR;
|
||||
$msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
|
||||
my $msg_level = \&ERROR;
|
||||
$msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
|
||||
|
||||
if (&{$msg_type}("SPACING",
|
||||
"spaces required around that '$op' $at\n" . $hereptr)) {
|
||||
if (&{$msg_level}("SPACING",
|
||||
"spaces required around that '$op' $at\n" . $hereptr)) {
|
||||
$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
|
||||
if (defined $fix_elements[$n + 2]) {
|
||||
$fix_elements[$n + 2] =~ s/^\s+//;
|
||||
@@ -4384,7 +4439,8 @@ sub process {
|
||||
if (ERROR("SPACING",
|
||||
"space required before the open brace '{'\n" . $herecurr) &&
|
||||
$fix) {
|
||||
$fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
|
||||
#coreboot - Open braces must be escaped in regex
|
||||
$fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 \{/;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4472,6 +4528,30 @@ sub process {
|
||||
}
|
||||
}
|
||||
|
||||
# check for unnecessary parentheses around comparisons in if uses
|
||||
if ($^V && $^V ge 5.10.0 && defined($stat) &&
|
||||
$stat =~ /(^.\s*if\s*($balanced_parens))/) {
|
||||
my $if_stat = $1;
|
||||
my $test = substr($2, 1, -1);
|
||||
my $herectx;
|
||||
while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
|
||||
my $match = $1;
|
||||
# avoid parentheses around potential macro args
|
||||
next if ($match =~ /^\s*\w+\s*$/);
|
||||
if (!defined($herectx)) {
|
||||
$herectx = $here . "\n";
|
||||
my $cnt = statement_rawlines($if_stat);
|
||||
for (my $n = 0; $n < $cnt; $n++) {
|
||||
my $rl = raw_line($linenr, $n);
|
||||
$herectx .= $rl . "\n";
|
||||
last if $rl =~ /^[ \+].*\{/;
|
||||
}
|
||||
}
|
||||
CHK("UNNECESSARY_PARENTHESES",
|
||||
"Unnecessary parentheses around '$match'\n" . $herectx);
|
||||
}
|
||||
}
|
||||
|
||||
#goto labels aren't indented, allow a single space however
|
||||
if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
|
||||
!($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
|
||||
@@ -4882,8 +4962,10 @@ sub process {
|
||||
$dstat !~ /^\(\{/ && # ({...
|
||||
$ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
|
||||
{
|
||||
|
||||
if ($dstat =~ /;/) {
|
||||
if ($dstat =~ /^\s*if\b/) {
|
||||
ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
|
||||
"Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
|
||||
} elsif ($dstat =~ /;/) {
|
||||
ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
|
||||
"Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
|
||||
} else {
|
||||
@@ -4914,17 +4996,17 @@ sub process {
|
||||
foreach my $arg (@def_args) {
|
||||
next if ($arg =~ /\.\.\./);
|
||||
next if ($arg =~ /^type$/i);
|
||||
my $tmp = $define_stmt;
|
||||
$tmp =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
|
||||
$tmp =~ s/\#+\s*$arg\b//g;
|
||||
$tmp =~ s/\b$arg\s*\#\#//g;
|
||||
my $use_cnt = $tmp =~ s/\b$arg\b//g;
|
||||
my $tmp_stmt = $define_stmt;
|
||||
$tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
|
||||
$tmp_stmt =~ s/\#+\s*$arg\b//g;
|
||||
$tmp_stmt =~ s/\b$arg\s*\#\#//g;
|
||||
my $use_cnt = $tmp_stmt =~ s/\b$arg\b//g;
|
||||
if ($use_cnt > 1) {
|
||||
CHK("MACRO_ARG_REUSE",
|
||||
"Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
|
||||
}
|
||||
# check if any macro arguments may have other precedence issues
|
||||
if ($define_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
|
||||
if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
|
||||
((defined($1) && $1 ne ',') ||
|
||||
(defined($2) && $2 ne ','))) {
|
||||
CHK("MACRO_ARG_PRECEDENCE",
|
||||
@@ -5205,14 +5287,16 @@ sub process {
|
||||
"break quoted strings at a space character\n" . $hereprev);
|
||||
}
|
||||
|
||||
#check for an embedded function name in a string when the function is known
|
||||
# as part of a diff. This does not work for -f --file checking as it
|
||||
#depends on patch context providing the function name
|
||||
# check for an embedded function name in a string when the function is known
|
||||
# This does not work very well for -f --file checking as it depends on patch
|
||||
# context providing the function name or a single line form for in-file
|
||||
# function declarations
|
||||
if ($line =~ /^\+.*$String/ &&
|
||||
defined($context_function) &&
|
||||
get_quoted_string($line, $rawline) =~ /\b$context_function\b/) {
|
||||
get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
|
||||
length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
|
||||
WARN("EMBEDDED_FUNCTION_NAME",
|
||||
"Prefer using \"%s\", __func__ to embedded function names\n" . $herecurr);
|
||||
"Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
|
||||
}
|
||||
|
||||
# check for spaces before a quoted newline
|
||||
@@ -5319,7 +5403,7 @@ sub process {
|
||||
my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
|
||||
# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
|
||||
|
||||
if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
|
||||
if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|kmemdup|(?:dev_)?alloc_skb)/) {
|
||||
WARN("OOM_MESSAGE",
|
||||
"Possible unnecessary 'out of memory' message\n" . $hereprev);
|
||||
}
|
||||
@@ -5542,34 +5626,24 @@ sub process {
|
||||
}
|
||||
}
|
||||
|
||||
# Check for expedited grace periods that interrupt non-idle non-nohz
|
||||
# online CPUs. These expedited can therefore degrade real-time response
|
||||
# if used carelessly, and should be avoided where not absolutely
|
||||
# needed. It is always OK to use synchronize_rcu_expedited() and
|
||||
# synchronize_sched_expedited() at boot time (before real-time applications
|
||||
# start) and in error situations where real-time response is compromised in
|
||||
# any case. Note that synchronize_srcu_expedited() does -not- interrupt
|
||||
# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
|
||||
# Of course, nothing comes for free, and srcu_read_lock() and
|
||||
# srcu_read_unlock() do contain full memory barriers in payment for
|
||||
# synchronize_srcu_expedited() non-interruption properties.
|
||||
if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
|
||||
WARN("EXPEDITED_RCU_GRACE_PERIOD",
|
||||
"expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
|
||||
|
||||
}
|
||||
|
||||
# check of hardware specific defines
|
||||
if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
|
||||
CHK("ARCH_DEFINES",
|
||||
"architecture specific defines should be avoided\n" . $herecurr);
|
||||
}
|
||||
|
||||
# Check that the storage class is at the beginning of a declaration
|
||||
# coreboot: skip complaint about our '#define asmlinkage' lines
|
||||
if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/ && $line !~ /^.\s*#\s*define\s+$Storage\b/) {
|
||||
# check that the storage class is not after a type
|
||||
if ($line =~ /\b($Type)\s+($Storage)\b/) {
|
||||
WARN("STORAGE_CLASS",
|
||||
"storage class should be at the beginning of the declaration\n" . $herecurr)
|
||||
"storage class '$2' should be located before type '$1'\n" . $herecurr);
|
||||
}
|
||||
# Check that the storage class is at the beginning of a declaration
|
||||
if ($line =~ /\b$Storage\b/ &&
|
||||
$line !~ /^.\s*$Storage/ &&
|
||||
$line =~ /^.\s*(.+?)\$Storage\s/ &&
|
||||
$1 !~ /[\,\)]\s*$/) {
|
||||
WARN("STORAGE_CLASS",
|
||||
"storage class should be at the beginning of the declaration\n" . $herecurr);
|
||||
}
|
||||
|
||||
# check the location of the inline attribute, that it is between
|
||||
@@ -5708,6 +5782,32 @@ sub process {
|
||||
}
|
||||
}
|
||||
|
||||
# check for vsprintf extension %p<foo> misuses
|
||||
if ($^V && $^V ge 5.10.0 &&
|
||||
defined $stat &&
|
||||
$stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
|
||||
$1 !~ /^_*volatile_*$/) {
|
||||
my $bad_extension = "";
|
||||
my $lc = $stat =~ tr@\n@@;
|
||||
$lc = $lc + $linenr;
|
||||
for (my $count = $linenr; $count <= $lc; $count++) {
|
||||
my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
|
||||
$fmt =~ s/%%//g;
|
||||
if ($fmt =~ /(\%[\*\d\.]*p(?![\WFfSsBKRraEhMmIiUDdgVCbGNO]).)/) {
|
||||
$bad_extension = $1;
|
||||
last;
|
||||
}
|
||||
}
|
||||
if ($bad_extension ne "") {
|
||||
my $stat_real = raw_line($linenr, 0);
|
||||
for (my $count = $linenr + 1; $count <= $lc; $count++) {
|
||||
$stat_real = $stat_real . "\n" . raw_line($count, 0);
|
||||
}
|
||||
WARN("VSPRINTF_POINTER_EXTENSION",
|
||||
"Invalid vsprintf pointer extension '$bad_extension'\n" . "$here\n$stat_real\n");
|
||||
}
|
||||
}
|
||||
|
||||
# Check for misused memsets
|
||||
if ($^V && $^V ge 5.10.0 &&
|
||||
defined $stat &&
|
||||
@@ -5886,7 +5986,8 @@ sub process {
|
||||
"externs should be avoided in .c files\n" . $herecurr);
|
||||
}
|
||||
|
||||
if ($realfile =~ /\.[ch]$/ && defined $stat &&
|
||||
# check for function declarations that have arguments without identifier names
|
||||
if (defined $stat &&
|
||||
$stat =~ /^.\s*(?:extern\s+)?$Type\s*$Ident\s*\(\s*([^{]+)\s*\)\s*;/s &&
|
||||
$1 ne "void") {
|
||||
my $args = trim($1);
|
||||
@@ -5899,6 +6000,29 @@ sub process {
|
||||
}
|
||||
}
|
||||
|
||||
# check for function definitions
|
||||
if ($^V && $^V ge 5.10.0 &&
|
||||
defined $stat &&
|
||||
$stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
|
||||
$context_function = $1;
|
||||
|
||||
# check for multiline function definition with misplaced open brace
|
||||
my $ok = 0;
|
||||
my $cnt = statement_rawlines($stat);
|
||||
my $herectx = $here . "\n";
|
||||
for (my $n = 0; $n < $cnt; $n++) {
|
||||
my $rl = raw_line($linenr, $n);
|
||||
$herectx .= $rl . "\n";
|
||||
$ok = 1 if ($rl =~ /^[ \+]\{/);
|
||||
$ok = 1 if ($rl =~ /\{/ && $n == 0);
|
||||
last if $rl =~ /^[ \+].*\{/;
|
||||
}
|
||||
if (!$ok) {
|
||||
ERROR("OPEN_BRACE",
|
||||
"open brace '{' following function definitions go on the next line\n" . $herectx);
|
||||
}
|
||||
}
|
||||
|
||||
# checks for new __setup's
|
||||
if ($rawline =~ /\b__setup\("([^"]*)"/) {
|
||||
my $name = $1;
|
||||
@@ -5925,7 +6049,8 @@ sub process {
|
||||
|
||||
# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
|
||||
if ($^V && $^V ge 5.10.0 &&
|
||||
$line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
|
||||
defined $stat &&
|
||||
$stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
|
||||
my $oldfunc = $3;
|
||||
my $a1 = $4;
|
||||
my $a2 = $10;
|
||||
@@ -5939,11 +6064,17 @@ sub process {
|
||||
}
|
||||
if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
|
||||
!($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
|
||||
my $ctx = '';
|
||||
my $herectx = $here . "\n";
|
||||
my $cnt = statement_rawlines($stat);
|
||||
for (my $n = 0; $n < $cnt; $n++) {
|
||||
$herectx .= raw_line($linenr, $n) . "\n";
|
||||
}
|
||||
if (WARN("ALLOC_WITH_MULTIPLY",
|
||||
"Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
|
||||
"Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
|
||||
$cnt == 1 &&
|
||||
$fix) {
|
||||
$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;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -6098,11 +6229,11 @@ sub process {
|
||||
}
|
||||
|
||||
# check for various structs that are normally const (ops, kgdb, device_tree)
|
||||
# and avoid what seem like struct definitions 'struct foo {'
|
||||
if ($line !~ /\bconst\b/ &&
|
||||
$line =~ /\bstruct\s+($const_structs)\b/) {
|
||||
$line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
|
||||
WARN("CONST_STRUCT",
|
||||
"struct $1 should normally be const\n" .
|
||||
$herecurr);
|
||||
"struct $1 should normally be const\n" . $herecurr);
|
||||
}
|
||||
|
||||
# use of NR_CPUS is usually wrong
|
||||
|
||||
Reference in New Issue
Block a user