| #!/usr/bin/env perl |
| # SPDX-License-Identifier: GPL-2.0 |
| # |
| # (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) |
| # (c) 2008-2010 Andy Whitcroft <apw@canonical.com> |
| # (c) 2010-2018 Joe Perches <joe@perches.com> |
| |
| use strict; |
| use warnings; |
| use POSIX; |
| use File::Basename; |
| use Cwd 'abs_path'; |
| use Term::ANSIColor qw(:constants); |
| use Encode qw(decode encode); |
| |
| my $P = $0; |
| my $D = dirname(abs_path($P)); |
| |
| my $V = '0.32'; |
| |
| use Getopt::Long qw(:config no_auto_abbrev); |
| |
| my $quiet = 0; |
| my $verbose = 0; |
| my %verbose_messages = (); |
| my %verbose_emitted = (); |
| my $tree = 1; |
| my $chk_signoff = 1; |
| my $chk_patch = 1; |
| my $tst_only; |
| my $emacs = 0; |
| my $terse = 0; |
| my $showfile = 0; |
| my $file = 0; |
| my $git = 0; |
| my %git_commits = (); |
| my $check = 0; |
| my $check_orig = 0; |
| my $summary = 1; |
| my $mailback = 0; |
| my $summary_file = 0; |
| my $show_types = 0; |
| my $list_types = 0; |
| my $fix = 0; |
| my $fix_inplace = 0; |
| my $root; |
| my $gitroot = $ENV{'GIT_DIR'}; |
| $gitroot = ".git" if !defined($gitroot); |
| my %debug; |
| my %camelcase = (); |
| my %use_type = (); |
| my @use = (); |
| my %ignore_type = (); |
| my @ignore = (); |
| my $help = 0; |
| my $configuration_file = ".checkpatch.conf"; |
| my $max_line_length = 100; |
| my $ignore_perl_version = 0; |
| my $minimum_perl_version = 5.10.0; |
| my $min_conf_desc_length = 4; |
| my $spelling_file = "$D/spelling.txt"; |
| my $codespell = 0; |
| my $codespellfile = "/usr/share/codespell/dictionary.txt"; |
| my $conststructsfile = "$D/const_structs.checkpatch"; |
| my $docsfile = "$D/../Documentation/dev-tools/checkpatch.rst"; |
| my $typedefsfile; |
| my $color = "auto"; |
| my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE |
| # git output parsing needs US English output, so first set backtick child process LANGUAGE |
| my $git_command ='export LANGUAGE=en_US.UTF-8; git'; |
| my $tabsize = 8; |
| my ${CONFIG_} = "CONFIG_"; |
| |
| sub help { |
| my ($exitcode) = @_; |
| |
| print << "EOM"; |
| Usage: $P [OPTION]... [FILE]... |
| Version: $V |
| |
| Options: |
| -q, --quiet quiet |
| -v, --verbose verbose mode |
| --no-tree run without a kernel tree |
| --no-signoff do not check for 'Signed-off-by' line |
| --patch treat FILE as patchfile (default) |
| --emacs emacs compile window format |
| --terse one line per report |
| --showfile emit diffed file position, not input file position |
| -g, --git treat FILE as a single commit or git revision range |
| single git commit with: |
| <rev> |
| <rev>^ |
| <rev>~n |
| multiple git commits with: |
| <rev1>..<rev2> |
| <rev1>...<rev2> |
| <rev>-<count> |
| git merges are ignored |
| -f, --file treat FILE as regular source file |
| --subjective, --strict enable more subjective tests |
| --list-types list the possible message types |
| --types TYPE(,TYPE2...) show only these comma separated message types |
| --ignore TYPE(,TYPE2...) ignore various comma separated message types |
| --show-types show the specific message type in the output |
| --max-line-length=n set the maximum line length, (default $max_line_length) |
| if exceeded, warn on patches |
| requires --strict for use with --file |
| --min-conf-desc-length=n set the min description length, if shorter, warn |
| --tab-size=n set the number of spaces for tab (default $tabsize) |
| --root=PATH PATH to the kernel tree root |
| --no-summary suppress the per-file summary |
| --mailback only produce a report in case of warnings/errors |
| --summary-file include the filename in summary |
| --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of |
| 'values', 'possible', 'type', and 'attr' (default |
| is all off) |
| --test-only=WORD report only warnings/errors containing WORD |
| literally |
| --fix EXPERIMENTAL - may create horrible results |
| If correctable single-line errors exist, create |
| "<inputfile>.EXPERIMENTAL-checkpatch-fixes" |
| with potential errors corrected to the preferred |
| checkpatch style |
| --fix-inplace EXPERIMENTAL - may create horrible results |
| Is the same as --fix, but overwrites the input |
| file. It's your fault if there's no backup or git |
| --ignore-perl-version override checking of perl version. expect |
| runtime errors. |
| --codespell Use the codespell dictionary for spelling/typos |
| (default:/usr/share/codespell/dictionary.txt) |
| --codespellfile Use this codespell dictionary |
| --typedefsfile Read additional types from this file |
| --color[=WHEN] Use colors 'always', 'never', or only when output |
| is a terminal ('auto'). Default is 'auto'. |
| --kconfig-prefix=WORD use WORD as a prefix for Kconfig symbols (default |
| ${CONFIG_}) |
| -h, --help, --version display this help and exit |
| |
| When FILE is - read standard input. |
| EOM |
| |
| exit($exitcode); |
| } |
| |
| sub uniq { |
| my %seen; |
| return grep { !$seen{$_}++ } @_; |
| } |
| |
| sub list_types { |
| my ($exitcode) = @_; |
| |
| my $count = 0; |
| |
| local $/ = undef; |
| |
| open(my $script, '<', abs_path($P)) or |
| die "$P: Can't read '$P' $!\n"; |
| |
| my $text = <$script>; |
| close($script); |
| |
| my %types = (); |
| # Also catch when type or level is passed through a variable |
| while ($text =~ /(?:(\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) { |
| if (defined($1)) { |
| if (exists($types{$2})) { |
| $types{$2} .= ",$1" if ($types{$2} ne $1); |
| } else { |
| $types{$2} = $1; |
| } |
| } else { |
| $types{$2} = "UNDETERMINED"; |
| } |
| } |
| |
| print("#\tMessage type\n\n"); |
| if ($color) { |
| print(" ( Color coding: "); |
| print(RED . "ERROR" . RESET); |
| print(" | "); |
| print(YELLOW . "WARNING" . RESET); |
| print(" | "); |
| print(GREEN . "CHECK" . RESET); |
| print(" | "); |
| print("Multiple levels / Undetermined"); |
| print(" )\n\n"); |
| } |
| |
| foreach my $type (sort keys %types) { |
| my $orig_type = $type; |
| if ($color) { |
| my $level = $types{$type}; |
| if ($level eq "ERROR") { |
| $type = RED . $type . RESET; |
| } elsif ($level eq "WARN") { |
| $type = YELLOW . $type . RESET; |
| } elsif ($level eq "CHK") { |
| $type = GREEN . $type . RESET; |
| } |
| } |
| print(++$count . "\t" . $type . "\n"); |
| if ($verbose && exists($verbose_messages{$orig_type})) { |
| my $message = $verbose_messages{$orig_type}; |
| $message =~ s/\n/\n\t/g; |
| print("\t" . $message . "\n\n"); |
| } |
| } |
| |
| exit($exitcode); |
| } |
| |
| my $conf = which_conf($configuration_file); |
| if (-f $conf) { |
| my @conf_args; |
| open(my $conffile, '<', "$conf") |
| or warn "$P: Can't find a readable $configuration_file file $!\n"; |
| |
| while (<$conffile>) { |
| my $line = $_; |
| |
| $line =~ s/\s*\n?$//g; |
| $line =~ s/^\s*//g; |
| $line =~ s/\s+/ /g; |
| |
| next if ($line =~ m/^\s*#/); |
| next if ($line =~ m/^\s*$/); |
| |
| my @words = split(" ", $line); |
| foreach my $word (@words) { |
| last if ($word =~ m/^#/); |
| push (@conf_args, $word); |
| } |
| } |
| close($conffile); |
| unshift(@ARGV, @conf_args) if @conf_args; |
| } |
| |
| sub load_docs { |
| open(my $docs, '<', "$docsfile") |
| or warn "$P: Can't read the documentation file $docsfile $!\n"; |
| |
| my $type = ''; |
| my $desc = ''; |
| my $in_desc = 0; |
| |
| while (<$docs>) { |
| chomp; |
| my $line = $_; |
| $line =~ s/\s+$//; |
| |
| if ($line =~ /^\s*\*\*(.+)\*\*$/) { |
| if ($desc ne '') { |
| $verbose_messages{$type} = trim($desc); |
| } |
| $type = $1; |
| $desc = ''; |
| $in_desc = 1; |
| } elsif ($in_desc) { |
| if ($line =~ /^(?:\s{4,}|$)/) { |
| $line =~ s/^\s{4}//; |
| $desc .= $line; |
| $desc .= "\n"; |
| } else { |
| $verbose_messages{$type} = trim($desc); |
| $type = ''; |
| $desc = ''; |
| $in_desc = 0; |
| } |
| } |
| } |
| |
| if ($desc ne '') { |
| $verbose_messages{$type} = trim($desc); |
| } |
| close($docs); |
| } |
| |
| # 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, |
| 'v|verbose!' => \$verbose, |
| 'tree!' => \$tree, |
| 'signoff!' => \$chk_signoff, |
| 'patch!' => \$chk_patch, |
| 'emacs!' => \$emacs, |
| 'terse!' => \$terse, |
| 'showfile!' => \$showfile, |
| 'f|file!' => \$file, |
| 'g|git!' => \$git, |
| 'subjective!' => \$check, |
| 'strict!' => \$check, |
| 'ignore=s' => \@ignore, |
| 'types=s' => \@use, |
| 'show-types!' => \$show_types, |
| 'list-types!' => \$list_types, |
| 'max-line-length=i' => \$max_line_length, |
| 'min-conf-desc-length=i' => \$min_conf_desc_length, |
| 'tab-size=i' => \$tabsize, |
| 'root=s' => \$root, |
| 'summary!' => \$summary, |
| 'mailback!' => \$mailback, |
| 'summary-file!' => \$summary_file, |
| 'fix!' => \$fix, |
| 'fix-inplace!' => \$fix_inplace, |
| 'ignore-perl-version!' => \$ignore_perl_version, |
| 'debug=s' => \%debug, |
| 'test-only=s' => \$tst_only, |
| 'codespell!' => \$codespell, |
| 'codespellfile=s' => \$codespellfile, |
| 'typedefsfile=s' => \$typedefsfile, |
| 'color=s' => \$color, |
| 'no-color' => \$color, #keep old behaviors of -nocolor |
| 'nocolor' => \$color, #keep old behaviors of -nocolor |
| 'kconfig-prefix=s' => \${CONFIG_}, |
| 'h|help' => \$help, |
| 'version' => \$help |
| ) or help(1); |
| |
| help(0) if ($help); |
| |
| die "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix)); |
| die "$P: --verbose cannot be used with --terse\n" if ($verbose && $terse); |
| |
| 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 "$P: Invalid color mode: $color\n"; |
| } |
| |
| load_docs() if ($verbose); |
| list_types(0) if ($list_types); |
| |
| $fix = 1 if ($fix_inplace); |
| $check_orig = $check; |
| |
| my $exit = 0; |
| |
| my $perl_version_ok = 1; |
| if ($^V && $^V lt $minimum_perl_version) { |
| $perl_version_ok = 0; |
| printf "$P: requires at least perl version %vd\n", $minimum_perl_version; |
| exit(1) if (!$ignore_perl_version); |
| } |
| |
| #if no filenames are given, push '-' to read patch from stdin |
| if ($#ARGV < 0) { |
| push(@ARGV, '-'); |
| } |
| |
| # skip TAB size 1 to avoid additional checks on $tabsize - 1 |
| die "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2); |
| |
| sub hash_save_array_words { |
| my ($hashRef, $arrayRef) = @_; |
| |
| my @array = split(/,/, join(',', @$arrayRef)); |
| foreach my $word (@array) { |
| $word =~ s/\s*\n?$//g; |
| $word =~ s/^\s*//g; |
| $word =~ s/\s+/ /g; |
| $word =~ tr/[a-z]/[A-Z]/; |
| |
| next if ($word =~ m/^\s*#/); |
| next if ($word =~ m/^\s*$/); |
| |
| $hashRef->{$word}++; |
| } |
| } |
| |
| sub hash_show_words { |
| my ($hashRef, $prefix) = @_; |
| |
| if (keys %$hashRef) { |
| print "\nNOTE: $prefix message types:"; |
| foreach my $word (sort keys %$hashRef) { |
| print " $word"; |
| } |
| print "\n"; |
| } |
| } |
| |
| hash_save_array_words(\%ignore_type, \@ignore); |
| hash_save_array_words(\%use_type, \@use); |
| |
| my $dbg_values = 0; |
| my $dbg_possible = 0; |
| my $dbg_type = 0; |
| my $dbg_attr = 0; |
| for my $key (keys %debug) { |
| ## no critic |
| eval "\${dbg_$key} = '$debug{$key}';"; |
| die "$@" if ($@); |
| } |
| |
| my $rpt_cleaners = 0; |
| |
| if ($terse) { |
| $emacs = 1; |
| $quiet++; |
| } |
| |
| if ($tree) { |
| if (defined $root) { |
| if (!top_of_kernel_tree($root)) { |
| die "$P: $root: --root does not point at a valid tree\n"; |
| } |
| } else { |
| if (top_of_kernel_tree('.')) { |
| $root = '.'; |
| } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && |
| top_of_kernel_tree($1)) { |
| $root = $1; |
| } |
| } |
| |
| if (!defined $root) { |
| print "Must be run from the top-level dir. of a kernel tree\n"; |
| exit(2); |
| } |
| } |
| |
| my $emitted_corrupt = 0; |
| |
| our $Ident = qr{ |
| [A-Za-z_][A-Za-z\d_]* |
| (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* |
| }x; |
| our $Storage = qr{extern|static|asmlinkage}; |
| our $Sparse = qr{ |
| __user| |
| __kernel| |
| __force| |
| __iomem| |
| __must_check| |
| __kprobes| |
| __ref| |
| __refconst| |
| __refdata| |
| __rcu| |
| __private |
| }x; |
| our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; |
| our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; |
| our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; |
| our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; |
| our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; |
| |
| # Notes to $Attribute: |
| # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check |
| our $Attribute = qr{ |
| const| |
| volatile| |
| __percpu| |
| __nocast| |
| __safe| |
| __bitwise| |
| __packed__| |
| __packed2__| |
| __naked| |
| __maybe_unused| |
| __always_unused| |
| __noreturn| |
| __used| |
| __cold| |
| __pure| |
| __noclone| |
| __deprecated| |
| __read_mostly| |
| __ro_after_init| |
| __kprobes| |
| $InitAttribute| |
| ____cacheline_aligned| |
| ____cacheline_aligned_in_smp| |
| ____cacheline_internodealigned_in_smp| |
| __weak |
| }x; |
| our $Modifier; |
| our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; |
| our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; |
| our $Lval = qr{$Ident(?:$Member)*}; |
| |
| our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; |
| our $Binary = qr{(?i)0b[01]+$Int_type?}; |
| our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; |
| our $Int = qr{[0-9]+$Int_type?}; |
| our $Octal = qr{0[0-7]+$Int_type?}; |
| our $String = qr{(?:\b[Lu])?"[X\t]*"}; |
| our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; |
| our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; |
| our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; |
| our $Float = qr{$Float_hex|$Float_dec|$Float_int}; |
| our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; |
| our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; |
| our $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; |
| our $Arithmetic = qr{\+|-|\*|\/|%}; |
| our $Operators = qr{ |
| <=|>=|==|!=| |
| =>|->|<<|>>|<|>|!|~| |
| &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic |
| }x; |
| |
| our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; |
| |
| our $BasicType; |
| our $NonptrType; |
| our $NonptrTypeMisordered; |
| our $NonptrTypeWithAttr; |
| our $Type; |
| our $TypeMisordered; |
| our $Declare; |
| our $DeclareMisordered; |
| |
| our $NON_ASCII_UTF8 = qr{ |
| [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte |
| | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs |
| | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte |
| | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates |
| | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 |
| | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 |
| | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 |
| }x; |
| |
| our $UTF8 = qr{ |
| [\x09\x0A\x0D\x20-\x7E] # ASCII |
| | $NON_ASCII_UTF8 |
| }x; |
| |
| our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; |
| our $typeOtherOSTypedefs = qr{(?x: |
| u_(?:char|short|int|long) | # bsd |
| u(?:nchar|short|int|long) # sysv |
| )}; |
| our $typeKernelTypedefs = qr{(?x: |
| (?:__)?(?:u|s|be|le)(?:8|16|32|64)| |
| atomic_t |
| )}; |
| our $typeTypedefs = qr{(?x: |
| $typeC99Typedefs\b| |
| $typeOtherOSTypedefs\b| |
| $typeKernelTypedefs\b |
| )}; |
| |
| our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; |
| |
| our $logFunctions = qr{(?x: |
| printk(?:_ratelimited|_once|_deferred_once|_deferred|)| |
| (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| |
| TP_printk| |
| WARN(?:_RATELIMIT|_ONCE|)| |
| panic| |
| MODULE_[A-Z_]+| |
| seq_vprintf|seq_printf|seq_puts |
| )}; |
| |
| our $allocFunctions = qr{(?x: |
| (?:(?:devm_)? |
| (?:kv|k|v)[czm]alloc(?:_array)?(?:_node)? | |
| kstrdup(?:_const)? | |
| kmemdup(?:_nul)?) | |
| (?:\w+)?alloc_skb(?:_ip_align)? | |
| # dev_alloc_skb/netdev_alloc_skb, et al |
| dma_alloc_coherent |
| )}; |
| |
| our $signature_tags = qr{(?xi: |
| Signed-off-by:| |
| Co-developed-by:| |
| Acked-by:| |
| Tested-by:| |
| Reviewed-by:| |
| Reported-by:| |
| Suggested-by:| |
| To:| |
| Cc: |
| )}; |
| |
| our $tracing_logging_tags = qr{(?xi: |
| [=-]*> | |
| <[=-]* | |
| \[ | |
| \] | |
| start | |
| called | |
| entered | |
| entry | |
| enter | |
| in | |
| inside | |
| here | |
| begin | |
| exit | |
| end | |
| done | |
| leave | |
| completed | |
| out | |
| return | |
| [\.\!:\s]* |
| )}; |
| |
| sub edit_distance_min { |
| my (@arr) = @_; |
| my $len = scalar @arr; |
| if ((scalar @arr) < 1) { |
| # if underflow, return |
| return; |
| } |
| my $min = $arr[0]; |
| for my $i (0 .. ($len-1)) { |
| if ($arr[$i] < $min) { |
| $min = $arr[$i]; |
| } |
| } |
| return $min; |
| } |
| |
| sub get_edit_distance { |
| my ($str1, $str2) = @_; |
| $str1 = lc($str1); |
| $str2 = lc($str2); |
| $str1 =~ s/-//g; |
| $str2 =~ s/-//g; |
| my $len1 = length($str1); |
| my $len2 = length($str2); |
| # two dimensional array storing minimum edit distance |
| my @distance; |
| for my $i (0 .. $len1) { |
| for my $j (0 .. $len2) { |
| if ($i == 0) { |
| $distance[$i][$j] = $j; |
| } elsif ($j == 0) { |
| $distance[$i][$j] = $i; |
| } elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) { |
| $distance[$i][$j] = $distance[$i - 1][$j - 1]; |
| } else { |
| my $dist1 = $distance[$i][$j - 1]; #insert distance |
| my $dist2 = $distance[$i - 1][$j]; # remove |
| my $dist3 = $distance[$i - 1][$j - 1]; #replace |
| $distance[$i][$j] = 1 + edit_distance_min($dist1, $dist2, $dist3); |
| } |
| } |
| } |
| return $distance[$len1][$len2]; |
| } |
| |
| sub find_standard_signature { |
| my ($sign_off) = @_; |
| my @standard_signature_tags = ( |
| 'Signed-off-by:', 'Co-developed-by:', 'Acked-by:', 'Tested-by:', |
| 'Reviewed-by:', 'Reported-by:', 'Suggested-by:' |
| ); |
| foreach my $signature (@standard_signature_tags) { |
| return $signature if (get_edit_distance($sign_off, $signature) <= 2); |
| } |
| |
| return ""; |
| } |
| |
| our @typeListMisordered = ( |
| qr{char\s+(?:un)?signed}, |
| qr{int\s+(?:(?:un)?signed\s+)?short\s}, |
| qr{int\s+short(?:\s+(?:un)?signed)}, |
| qr{short\s+int(?:\s+(?:un)?signed)}, |
| qr{(?:un)?signed\s+int\s+short}, |
| qr{short\s+(?:un)?signed}, |
| qr{long\s+int\s+(?:un)?signed}, |
| qr{int\s+long\s+(?:un)?signed}, |
| qr{long\s+(?:un)?signed\s+int}, |
| qr{int\s+(?:un)?signed\s+long}, |
| qr{int\s+(?:un)?signed}, |
| qr{int\s+long\s+long\s+(?:un)?signed}, |
| qr{long\s+long\s+int\s+(?:un)?signed}, |
| qr{long\s+long\s+(?:un)?signed\s+int}, |
| qr{long\s+long\s+(?:un)?signed}, |
| qr{long\s+(?:un)?signed}, |
| ); |
| |
| our @typeList = ( |
| qr{void}, |
| qr{(?:(?:un)?signed\s+)?char}, |
| qr{(?:(?:un)?signed\s+)?short\s+int}, |
| qr{(?:(?:un)?signed\s+)?short}, |
| qr{(?:(?:un)?signed\s+)?int}, |
| qr{(?:(?:un)?signed\s+)?long\s+int}, |
| qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, |
| qr{(?:(?:un)?signed\s+)?long\s+long}, |
| qr{(?:(?:un)?signed\s+)?long}, |
| qr{(?:un)?signed}, |
| qr{float}, |
| qr{double}, |
| qr{bool}, |
| qr{struct\s+$Ident}, |
| qr{union\s+$Ident}, |
| qr{enum\s+$Ident}, |
| qr{${Ident}_t}, |
| qr{${Ident}_handler}, |
| qr{${Ident}_handler_fn}, |
| @typeListMisordered, |
| ); |
| |
| our $C90_int_types = qr{(?x: |
| long\s+long\s+int\s+(?:un)?signed| |
| long\s+long\s+(?:un)?signed\s+int| |
| long\s+long\s+(?:un)?signed| |
| (?:(?:un)?signed\s+)?long\s+long\s+int| |
| (?:(?:un)?signed\s+)?long\s+long| |
| int\s+long\s+long\s+(?:un)?signed| |
| int\s+(?:(?:un)?signed\s+)?long\s+long| |
| |
| long\s+int\s+(?:un)?signed| |
| long\s+(?:un)?signed\s+int| |
| long\s+(?:un)?signed| |
| (?:(?:un)?signed\s+)?long\s+int| |
| (?:(?:un)?signed\s+)?long| |
| int\s+long\s+(?:un)?signed| |
| int\s+(?:(?:un)?signed\s+)?long| |
| |
| int\s+(?:un)?signed| |
| (?:(?:un)?signed\s+)?int |
| )}; |
| |
| our @typeListFile = (); |
| our @typeListWithAttr = ( |
| @typeList, |
| qr{struct\s+$InitAttribute\s+$Ident}, |
| qr{union\s+$InitAttribute\s+$Ident}, |
| ); |
| |
| our @modifierList = ( |
| qr{fastcall}, |
| ); |
| our @modifierListFile = (); |
| |
| our @mode_permission_funcs = ( |
| ["module_param", 3], |
| ["module_param_(?:array|named|string)", 4], |
| ["module_param_array_named", 5], |
| ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], |
| ["proc_create(?:_data|)", 2], |
| ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2], |
| ["IIO_DEV_ATTR_[A-Z_]+", 1], |
| ["SENSOR_(?:DEVICE_|)ATTR_2", 2], |
| ["SENSOR_TEMPLATE(?:_2|)", 3], |
| ["__ATTR", 2], |
| ); |
| |
| my $word_pattern = '\b[A-Z]?[a-z]{2,}\b'; |
| |
| #Create a search pattern for all these functions to speed up a loop below |
| our $mode_perms_search = ""; |
| foreach my $entry (@mode_permission_funcs) { |
| $mode_perms_search .= '|' if ($mode_perms_search ne ""); |
| $mode_perms_search .= $entry->[0]; |
| } |
| $mode_perms_search = "(?:${mode_perms_search})"; |
| |
| our %deprecated_apis = ( |
| "synchronize_rcu_bh" => "synchronize_rcu", |
| "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited", |
| "call_rcu_bh" => "call_rcu", |
| "rcu_barrier_bh" => "rcu_barrier", |
| "synchronize_sched" => "synchronize_rcu", |
| "synchronize_sched_expedited" => "synchronize_rcu_expedited", |
| "call_rcu_sched" => "call_rcu", |
| "rcu_barrier_sched" => "rcu_barrier", |
| "get_state_synchronize_sched" => "get_state_synchronize_rcu", |
| "cond_synchronize_sched" => "cond_synchronize_rcu", |
| ); |
| |
| #Create a search pattern for all these strings to speed up a loop below |
| our $deprecated_apis_search = ""; |
| foreach my $entry (keys %deprecated_apis) { |
| $deprecated_apis_search .= '|' if ($deprecated_apis_search ne ""); |
| $deprecated_apis_search .= $entry; |
| } |
| $deprecated_apis_search = "(?:${deprecated_apis_search})"; |
| |
| our $mode_perms_world_writable = qr{ |
| S_IWUGO | |
| S_IWOTH | |
| S_IRWXUGO | |
| S_IALLUGO | |
| 0[0-7][0-7][2367] |
| }x; |
| |
| our %mode_permission_string_types = ( |
| "S_IRWXU" => 0700, |
| "S_IRUSR" => 0400, |
| "S_IWUSR" => 0200, |
| "S_IXUSR" => 0100, |
| "S_IRWXG" => 0070, |
| "S_IRGRP" => 0040, |
| "S_IWGRP" => 0020, |
| "S_IXGRP" => 0010, |
| "S_IRWXO" => 0007, |
| "S_IROTH" => 0004, |
| "S_IWOTH" => 0002, |
| "S_IXOTH" => 0001, |
| "S_IRWXUGO" => 0777, |
| "S_IRUGO" => 0444, |
| "S_IWUGO" => 0222, |
| "S_IXUGO" => 0111, |
| ); |
| |
| #Create a search pattern for all these strings to speed up a loop below |
| our $mode_perms_string_search = ""; |
| foreach my $entry (keys %mode_permission_string_types) { |
| $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); |
| $mode_perms_string_search .= $entry; |
| } |
| our $single_mode_perms_string_search = "(?:${mode_perms_string_search})"; |
| our $multi_mode_perms_string_search = qr{ |
| ${single_mode_perms_string_search} |
| (?:\s*\|\s*${single_mode_perms_string_search})* |
| }x; |
| |
| sub perms_to_octal { |
| my ($string) = @_; |
| |
| return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/); |
| |
| my $val = ""; |
| my $oval = ""; |
| my $to = 0; |
| my $curpos = 0; |
| my $lastpos = 0; |
| while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) { |
| $curpos = pos($string); |
| my $match = $2; |
| my $omatch = $1; |
| last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos)); |
| $lastpos = $curpos; |
| $to |= $mode_permission_string_types{$match}; |
| $val .= '\s*\|\s*' if ($val ne ""); |
| $val .= $match; |
| $oval .= $omatch; |
| } |
| $oval =~ s/^\s*\|\s*//; |
| $oval =~ s/\s*\|\s*$//; |
| return sprintf("%04o", $to); |
| } |
| |
| our $allowed_asm_includes = qr{(?x: |
| irq| |
| memory| |
| time| |
| reboot |
| )}; |
| # memory.h: ARM has a custom one |
| |
| # Load common spelling mistakes and build regular expression list. |
| my $misspellings; |
| my %spelling_fix; |
| |
| if (open(my $spelling, '<', $spelling_file)) { |
| while (<$spelling>) { |
| my $line = $_; |
| |
| $line =~ s/\s*\n?$//g; |
| $line =~ s/^\s*//g; |
| |
| next if ($line =~ m/^\s*#/); |
| next if ($line =~ m/^\s*$/); |
| |
| my ($suspect, $fix) = split(/\|\|/, $line); |
| |
| $spelling_fix{$suspect} = $fix; |
| } |
| close($spelling); |
| } else { |
| warn "No typos will be found - file '$spelling_file': $!\n"; |
| } |
| |
| if ($codespell) { |
| if (open(my $spelling, '<', $codespellfile)) { |
| while (<$spelling>) { |
| my $line = $_; |
| |
| $line =~ s/\s*\n?$//g; |
| $line =~ s/^\s*//g; |
| |
| next if ($line =~ m/^\s*#/); |
| next if ($line =~ m/^\s*$/); |
| next if ($line =~ m/, disabled/i); |
| |
| $line =~ s/,.*$//; |
| |
| my ($suspect, $fix) = split(/->/, $line); |
| |
| $spelling_fix{$suspect} = $fix; |
| } |
| close($spelling); |
| } else { |
| warn "No codespell typos will be found - file '$codespellfile': $!\n"; |
| } |
| } |
| |
| $misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; |
| |
| sub read_words { |
| my ($wordsRef, $file) = @_; |
| |
| if (open(my $words, '<', $file)) { |
| while (<$words>) { |
| my $line = $_; |
| |
| $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 (defined $$wordsRef); |
| $$wordsRef .= $line; |
| } |
| close($file); |
| return 1; |
| } |
| |
| return 0; |
| } |
| |
| my $const_structs; |
| if (show_type("CONST_STRUCT")) { |
| read_words(\$const_structs, $conststructsfile) |
| or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; |
| } |
| |
| if (defined($typedefsfile)) { |
| my $typeOtherTypedefs; |
| read_words(\$typeOtherTypedefs, $typedefsfile) |
| or warn "No additional types will be considered - file '$typedefsfile': $!\n"; |
| $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs); |
| } |
| |
| sub build_types { |
| my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; |
| my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; |
| my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; |
| my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; |
| $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; |
| $BasicType = qr{ |
| (?:$typeTypedefs\b)| |
| (?:${all}\b) |
| }x; |
| $NonptrType = qr{ |
| (?:$Modifier\s+|const\s+)* |
| (?: |
| (?:typeof|__typeof__)\s*\([^\)]*\)| |
| (?:$typeTypedefs\b)| |
| (?:${all}\b) |
| ) |
| (?:\s+$Modifier|\s+const)* |
| }x; |
| $NonptrTypeMisordered = qr{ |
| (?:$Modifier\s+|const\s+)* |
| (?: |
| (?:${Misordered}\b) |
| ) |
| (?:\s+$Modifier|\s+const)* |
| }x; |
| $NonptrTypeWithAttr = qr{ |
| (?:$Modifier\s+|const\s+)* |
| (?: |
| (?:typeof|__typeof__)\s*\([^\)]*\)| |
| (?:$typeTypedefs\b)| |
| (?:${allWithAttr}\b) |
| ) |
| (?:\s+$Modifier|\s+const)* |
| }x; |
| $Type = qr{ |
| $NonptrType |
| (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} |
| (?:\s+$Inline|\s+$Modifier)* |
| }x; |
| $TypeMisordered = qr{ |
| $NonptrTypeMisordered |
| (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} |
| (?:\s+$Inline|\s+$Modifier)* |
| }x; |
| $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; |
| $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; |
| } |
| build_types(); |
| |
| our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; |
| |
| # Using $balanced_parens, $LvalOrFunc, or $FuncArg |
| # requires at least perl version v5.10.0 |
| # Any use must be runtime checked with $^V |
| |
| our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; |
| our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; |
| 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+)?[HLP]?LIST_HEAD\s*\(| |
| (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\( |
| )}; |
| |
| our %allow_repeated_words = ( |
| add => '', |
| added => '', |
| bad => '', |
| be => '', |
| ); |
| |
| sub deparenthesize { |
| my ($string) = @_; |
| return "" if (!defined($string)); |
| |
| while ($string =~ /^\s*\(.*\)\s*$/) { |
| $string =~ s@^\s*\(\s*@@; |
| $string =~ s@\s*\)\s*$@@; |
| } |
| |
| $string =~ s@\s+@ @g; |
| |
| return $string; |
| } |
| |
| sub seed_camelcase_file { |
| my ($file) = @_; |
| |
| return if (!(-f $file)); |
| |
| local $/; |
| |
| open(my $include_file, '<', "$file") |
| or warn "$P: Can't read '$file' $!\n"; |
| my $text = <$include_file>; |
| close($include_file); |
| |
| my @lines = split('\n', $text); |
| |
| foreach my $line (@lines) { |
| next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); |
| if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { |
| $camelcase{$1} = 1; |
| } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { |
| $camelcase{$1} = 1; |
| } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { |
| $camelcase{$1} = 1; |
| } |
| } |
| } |
| |
| our %maintained_status = (); |
| |
| sub is_maintained_obsolete { |
| my ($filename) = @_; |
| |
| return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); |
| |
| if (!exists($maintained_status{$filename})) { |
| $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; |
| } |
| |
| return $maintained_status{$filename} =~ /obsolete/i; |
| } |
| |
| sub is_SPDX_License_valid { |
| my ($license) = @_; |
| |
| return 1 if (!$tree || which("python3") eq "" || !(-x "$root/scripts/spdxcheck.py") || !(-e "$gitroot")); |
| |
| my $root_path = abs_path($root); |
| my $status = `cd "$root_path"; echo "$license" | scripts/spdxcheck.py -`; |
| return 0 if ($status ne ""); |
| return 1; |
| } |
| |
| my $camelcase_seeded = 0; |
| sub seed_camelcase_includes { |
| return if ($camelcase_seeded); |
| |
| my $files; |
| my $camelcase_cache = ""; |
| my @include_files = (); |
| |
| $camelcase_seeded = 1; |
| |
| if (-e "$gitroot") { |
| my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`; |
| chomp $git_last_include_commit; |
| $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; |
| } else { |
| my $last_mod_date = 0; |
| $files = `find $root/include -name "*.h"`; |
| @include_files = split('\n', $files); |
| foreach my $file (@include_files) { |
| my $date = POSIX::strftime("%Y%m%d%H%M", |
| localtime((stat $file)[9])); |
| $last_mod_date = $date if ($last_mod_date < $date); |
| } |
| $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; |
| } |
| |
| if ($camelcase_cache ne "" && -f $camelcase_cache) { |
| open(my $camelcase_file, '<', "$camelcase_cache") |
| or warn "$P: Can't read '$camelcase_cache' $!\n"; |
| while (<$camelcase_file>) { |
| chomp; |
| $camelcase{$_} = 1; |
| } |
| close($camelcase_file); |
| |
| return; |
| } |
| |
| if (-e "$gitroot") { |
| $files = `${git_command} ls-files "include/*.h"`; |
| @include_files = split('\n', $files); |
| } |
| |
| foreach my $file (@include_files) { |
| seed_camelcase_file($file); |
| } |
| |
| if ($camelcase_cache ne "") { |
| unlink glob ".checkpatch-camelcase.*"; |
| open(my $camelcase_file, '>', "$camelcase_cache") |
| or warn "$P: Can't write '$camelcase_cache' $!\n"; |
| foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { |
| print $camelcase_file ("$_\n"); |
| } |
| close($camelcase_file); |
| } |
| } |
| |
| sub git_is_single_file { |
| my ($filename) = @_; |
| |
| return 0 if ((which("git") eq "") || !(-e "$gitroot")); |
| |
| my $output = `${git_command} ls-files -- $filename 2>/dev/null`; |
| my $count = $output =~ tr/\n//; |
| return $count eq 1 && $output =~ m{^${filename}$}; |
| } |
| |
| sub git_commit_info { |
| my ($commit, $id, $desc) = @_; |
| |
| return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot")); |
| |
| my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`; |
| $output =~ s/^\s*//gm; |
| my @lines = split("\n", $output); |
| |
| return ($id, $desc) if ($#lines < 0); |
| |
| if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) { |
| # Maybe one day convert this block of bash into something that returns |
| # all matching commit ids, but it's very slow... |
| # |
| # echo "checking commits $1..." |
| # git rev-list --remotes | grep -i "^$1" | |
| # while read line ; do |
| # git log --format='%H %s' -1 $line | |
| # echo "commit $(cut -c 1-12,41-)" |
| # done |
| } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./ || |
| $lines[0] =~ /^fatal: bad object $commit/) { |
| $id = undef; |
| } else { |
| $id = substr($lines[0], 0, 12); |
| $desc = substr($lines[0], 41); |
| } |
| |
| return ($id, $desc); |
| } |
| |
| $chk_signoff = 0 if ($file); |
| |
| my @rawlines = (); |
| my @lines = (); |
| my @fixed = (); |
| my @fixed_inserted = (); |
| my @fixed_deleted = (); |
| my $fixlinenr = -1; |
| |
| # If input is git commits, extract all commits from the commit expressions. |
| # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. |
| die "$P: No git repository found\n" if ($git && !-e "$gitroot"); |
| |
| if ($git) { |
| my @commits = (); |
| foreach my $commit_expr (@ARGV) { |
| my $git_range; |
| if ($commit_expr =~ m/^(.*)-(\d+)$/) { |
| $git_range = "-$2 $1"; |
| } elsif ($commit_expr =~ m/\.\./) { |
| $git_range = "$commit_expr"; |
| } else { |
| $git_range = "-1 $commit_expr"; |
| } |
| my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`; |
| foreach my $line (split(/\n/, $lines)) { |
| $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; |
| next if (!defined($1) || !defined($2)); |
| my $sha1 = $1; |
| my $subject = $2; |
| unshift(@commits, $sha1); |
| $git_commits{$sha1} = $subject; |
| } |
| } |
| die "$P: no git commits after extraction!\n" if (@commits == 0); |
| @ARGV = @commits; |
| } |
| |
| my $vname; |
| $allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"}; |
| for my $filename (@ARGV) { |
| my $FILE; |
| my $is_git_file = git_is_single_file($filename); |
| my $oldfile = $file; |
| $file = 1 if ($is_git_file); |
| if ($git) { |
| open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || |
| die "$P: $filename: git format-patch failed - $!\n"; |
| } elsif ($file) { |
| open($FILE, '-|', "diff -u /dev/null $filename") || |
| die "$P: $filename: diff failed - $!\n"; |
| } elsif ($filename eq '-') { |
| open($FILE, '<&STDIN'); |
| } else { |
| open($FILE, '<', "$filename") || |
| die "$P: $filename: open failed - $!\n"; |
| } |
| if ($filename eq '-') { |
| $vname = 'Your patch'; |
| } elsif ($git) { |
| $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; |
| } else { |
| $vname = $filename; |
| } |
| while (<$FILE>) { |
| chomp; |
| push(@rawlines, $_); |
| $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i); |
| } |
| close($FILE); |
| |
| if ($#ARGV > 0 && $quiet == 0) { |
| print '-' x length($vname) . "\n"; |
| print "$vname\n"; |
| print '-' x length($vname) . "\n"; |
| } |
| |
| if (!process($filename)) { |
| $exit = 1; |
| } |
| @rawlines = (); |
| @lines = (); |
| @fixed = (); |
| @fixed_inserted = (); |
| @fixed_deleted = (); |
| $fixlinenr = -1; |
| @modifierListFile = (); |
| @typeListFile = (); |
| build_types(); |
| $file = $oldfile if ($is_git_file); |
| } |
| |
| if (!$quiet) { |
| hash_show_words(\%use_type, "Used"); |
| hash_show_words(\%ignore_type, "Ignored"); |
| |
| if (!$perl_version_ok) { |
| print << "EOM" |
| |
| NOTE: perl $^V is not modern enough to detect all possible issues. |
| An upgrade to at least perl $minimum_perl_version is suggested. |
| EOM |
| } |
| if ($exit) { |
| print << "EOM" |
| |
| NOTE: If any of the errors are false positives, please report |
| them to the maintainer, see CHECKPATCH in MAINTAINERS. |
| EOM |
| } |
| } |
| |
| exit($exit); |
| |
| sub top_of_kernel_tree { |
| my ($root) = @_; |
| |
| my @tree_check = ( |
| "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", |
| "README", "Documentation", "arch", "include", "drivers", |
| "fs", "init", "ipc", "kernel", "lib", "scripts", |
| ); |
| |
| foreach my $check (@tree_check) { |
| if (! -e $root . '/' . $check) { |
| return 0; |
| } |
| } |
| return 1; |
| } |
| |
| sub parse_email { |
| my ($formatted_email) = @_; |
| |
| my $name = ""; |
| my $quoted = ""; |
| my $name_comment = ""; |
| my $address = ""; |
| my $comment = ""; |
| |
| if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { |
| $name = $1; |
| $address = $2; |
| $comment = $3 if defined $3; |
| } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { |
| $address = $1; |
| $comment = $2 if defined $2; |
| } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { |
| $address = $1; |
| $comment = $2 if defined $2; |
| $formatted_email =~ s/\Q$address\E.*$//; |
| $name = $formatted_email; |
| $name = trim($name); |
| $name =~ s/^\"|\"$//g; |
| # If there's a name left after stripping spaces and |
| # leading quotes, and the address doesn't have both |
| # leading and trailing angle brackets, the address |
| # is invalid. ie: |
| # "joe smith joe@smith.com" bad |
| # "joe smith <joe@smith.com" bad |
| if ($name ne "" && $address !~ /^<[^>]+>$/) { |
| $name = ""; |
| $address = ""; |
| $comment = ""; |
| } |
| } |
| |
| # Extract comments from names excluding quoted parts |
| # "John D. (Doe)" - Do not extract |
| if ($name =~ s/\"(.+)\"//) { |
| $quoted = $1; |
| } |
| while ($name =~ s/\s*($balanced_parens)\s*/ /) { |
| $name_comment .= trim($1); |
| } |
| $name =~ s/^[ \"]+|[ \"]+$//g; |
| $name = trim("$quoted $name"); |
| |
| $address = trim($address); |
| $address =~ s/^\<|\>$//g; |
| $comment = trim($comment); |
| |
| if ($name =~ /[^\w \-]/i) { ##has "must quote" chars |
| $name =~ s/(?<!\\)"/\\"/g; ##escape quotes |
| $name = "\"$name\""; |
| } |
| |
| return ($name, $name_comment, $address, $comment); |
| } |
| |
| sub format_email { |
| my ($name, $name_comment, $address, $comment) = @_; |
| |
| my $formatted_email; |
| |
| $name =~ s/^[ \"]+|[ \"]+$//g; |
| $address = trim($address); |
| $address =~ s/(?:\.|\,|\")+$//; ##trailing commas, dots or quotes |
| |
| if ($name =~ /[^\w \-]/i) { ##has "must quote" chars |
| $name =~ s/(?<!\\)"/\\"/g; ##escape quotes |
| $name = "\"$name\""; |
| } |
| |
| $name_comment = trim($name_comment); |
| $name_comment = " $name_comment" if ($name_comment ne ""); |
| $comment = trim($comment); |
| $comment = " $comment" if ($comment ne ""); |
| |
| if ("$name" eq "") { |
| $formatted_email = "$address"; |
| } else { |
| $formatted_email = "$name$name_comment <$address>"; |
| } |
| $formatted_email .= "$comment"; |
| return $formatted_email; |
| } |
| |
| sub reformat_email { |
| my ($email) = @_; |
| |
| my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); |
| return format_email($email_name, $name_comment, $email_address, $comment); |
| } |
| |
| sub same_email_addresses { |
| my ($email1, $email2) = @_; |
| |
| my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1); |
| my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2); |
| |
| return $email1_name eq $email2_name && |
| $email1_address eq $email2_address && |
| $name1_comment eq $name2_comment && |
| $comment1 eq $comment2; |
| } |
| |
| sub which { |
| my ($bin) = @_; |
| |
| foreach my $path (split(/:/, $ENV{PATH})) { |
| if (-e "$path/$bin") { |
| return "$path/$bin"; |
| } |
| } |
| |
| return ""; |
| } |
| |
| sub which_conf { |
| my ($conf) = @_; |
| |
| foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { |
| if (-e "$path/$conf") { |
| return "$path/$conf"; |
| } |
| } |
| |
| return ""; |
| } |
| |
| sub expand_tabs { |
| my ($str) = @_; |
| |
| my $res = ''; |
| my $n = 0; |
| for my $c (split(//, $str)) { |
| if ($c eq "\t") { |
| $res .= ' '; |
| $n++; |
| for (; ($n % $tabsize) != 0; $n++) { |
| $res .= ' '; |
| } |
| next; |
| } |
| $res .= $c; |
| $n++; |
| } |
| |
| return $res; |
| } |
| sub copy_spacing { |
| (my $res = shift) =~ tr/\t/ /c; |
| return $res; |
| } |
| |
| sub line_stats { |
| my ($line) = @_; |
| |
| # Drop the diff line leader and expand tabs |
| $line =~ s/^.//; |
| $line = expand_tabs($line); |
| |
| # Pick the indent from the front of the line. |
| my ($white) = ($line =~ /^(\s*)/); |
| |
| return (length($line), length($white)); |
| } |
| |
| my $sanitise_quote = ''; |
| |
| sub sanitise_line_reset { |
| my ($in_comment) = @_; |
| |
| if ($in_comment) { |
| $sanitise_quote = '*/'; |
| } else { |
| $sanitise_quote = ''; |
| } |
| } |
| sub sanitise_line { |
| my ($line) = @_; |
| |
| my $res = ''; |
| my $l = ''; |
| |
| my $qlen = 0; |
| my $off = 0; |
| my $c; |
| |
| # Always copy over the diff marker. |
| $res = substr($line, 0, 1); |
| |
| for ($off = 1; $off < length($line); $off++) { |
| $c = substr($line, $off, 1); |
| |
| # Comments we are whacking completely including the begin |
| # and end, all to $;. |
| if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { |
| $sanitise_quote = '*/'; |
| |
| substr($res, $off, 2, "$;$;"); |
| $off++; |
| next; |
| } |
| if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { |
| $sanitise_quote = ''; |
| substr($res, $off, 2, "$;$;"); |
| $off++; |
| next; |
| } |
| if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { |
| $sanitise_quote = '//'; |
| |
| substr($res, $off, 2, $sanitise_quote); |
| $off++; |
| next; |
| } |
| |
| # A \ in a string means ignore the next character. |
| if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && |
| $c eq "\\") { |
| substr($res, $off, 2, 'XX'); |
| $off++; |
| next; |
| } |
| # Regular quotes. |
| if ($c eq "'" || $c eq '"') { |
| if ($sanitise_quote eq '') { |
| $sanitise_quote = $c; |
| |
| substr($res, $off, 1, $c); |
| next; |
| } elsif ($sanitise_quote eq $c) { |
| $sanitise_quote = ''; |
| } |
| } |
| |
| #print "c<$c> SQ<$sanitise_quote>\n"; |
| if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { |
| substr($res, $off, 1, $;); |
| } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { |
| substr($res, $off, 1, $;); |
| } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { |
| substr($res, $off, 1, 'X'); |
| } else { |
| substr($res, $off, 1, $c); |
| } |
| } |
| |
| if ($sanitise_quote eq '//') { |
| $sanitise_quote = ''; |
| } |
| |
| # The pathname on a #include may be surrounded by '<' and '>'. |
| if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { |
| my $clean = 'X' x length($1); |
| $res =~ s@\<.*\>@<$clean>@; |
| |
| # The whole of a #error is a string. |
| } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { |
| my $clean = 'X' x length($1); |
| $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; |
| } |
| |
| if ($allow_c99_comments && $res =~ m@(//.*$)@) { |
| my $match = $1; |
| $res =~ s/\Q$match\E/"$;" x length($match)/e; |
| } |
| |
| return $res; |
| } |
| |
| sub get_quoted_string { |
| my ($line, $rawline) = @_; |
| |
| return "" if (!defined($line) || !defined($rawline)); |
| return "" if ($line !~ m/($String)/g); |
| return substr($rawline, $-[0], $+[0] - $-[0]); |
| } |
| |
| sub ctx_statement_block { |
| my ($linenr, $remain, $off) = @_; |
| my $line = $linenr - 1; |
| my $blk = ''; |
| my $soff = $off; |
| my $coff = $off - 1; |
| my $coff_set = 0; |
| |
| my $loff = 0; |
| |
| my $type = ''; |
| my $level = 0; |
| my @stack = (); |
| my $p; |
| my $c; |
| my $len = 0; |
| |
| my $remainder; |
| while (1) { |
| @stack = (['', 0]) if ($#stack == -1); |
| |
| #warn "CSB: blk<$blk> remain<$remain>\n"; |
| # If we are about to drop off the end, pull in more |
| # context. |
| if ($off >= $len) { |
| for (; $remain > 0; $line++) { |
| last if (!defined $lines[$line]); |
| next if ($lines[$line] =~ /^-/); |
| $remain--; |
| $loff = $len; |
| $blk .= $lines[$line] . "\n"; |
| $len = length($blk); |
| $line++; |
| last; |
| } |
| # Bail if there is no further context. |
| #warn "CSB: blk<$blk> off<$off> len<$len>\n"; |
| if ($off >= $len) { |
| last; |
| } |
| if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { |
| $level++; |
| $type = '#'; |
| } |
| } |
| $p = $c; |
| $c = substr($blk, $off, 1); |
| $remainder = substr($blk, $off); |
| |
| #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; |
| |
| # Handle nested #if/#else. |
| if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { |
| push(@stack, [ $type, $level ]); |
| } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { |
| ($type, $level) = @{$stack[$#stack - 1]}; |
| } elsif ($remainder =~ /^#\s*endif\b/) { |
| ($type, $level) = @{pop(@stack)}; |
| } |
| |
| # Statement ends at the ';' or a close '}' at the |
| # outermost level. |
| if ($level == 0 && $c eq ';') { |
| last; |
| } |
| |
| # An else is really a conditional as long as its not else if |
| if ($level == 0 && $coff_set == 0 && |
| (!defined($p) || $p =~ /(?:\s|\}|\+)/) && |
| $remainder =~ /^(else)(?:\s|{)/ && |
| $remainder !~ /^else\s+if\b/) { |
| $coff = $off + length($1) - 1; |
| $coff_set = 1; |
| #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; |
| #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; |
| } |
| |
| if (($type eq '' || $type eq '(') && $c eq '(') { |
| $level++; |
| $type = '('; |
| } |
| if ($type eq '(' && $c eq ')') { |
| $level--; |
| $type = ($level != 0)? '(' : ''; |
| |
| if ($level == 0 && $coff < $soff) { |
| $coff = $off; |
| $coff_set = 1; |
| #warn "CSB: mark coff<$coff>\n"; |
| } |
| } |
| if (($type eq '' || $type eq '{') && $c eq '{') { |
| $level++; |
| $type = '{'; |
| } |
| if ($type eq '{' && $c eq '}') { |
| $level--; |
| $type = ($level != 0)? '{' : ''; |
| |
| if ($level == 0) { |
| if (substr($blk, $off + 1, 1) eq ';') { |
| $off++; |
| } |
| last; |
| } |
| } |
| # Preprocessor commands end at the newline unless escaped. |
| if ($type eq '#' && $c eq "\n" && $p ne "\\") { |
| $level--; |
| $type = ''; |
| $off++; |
| last; |
| } |
| $off++; |
| } |
| # We are truly at the end, so shuffle to the next line. |
| if ($off == $len) { |
| $loff = $len + 1; |
| $line++; |
| $remain--; |
| } |
| |
| my $statement = substr($blk, $soff, $off - $soff + 1); |
| my $condition = substr($blk, $soff, $coff - $soff + 1); |
| |
| #warn "STATEMENT<$statement>\n"; |
| #warn "CONDITION<$condition>\n"; |
| |
| #print "coff<$coff> soff<$off> loff<$loff>\n"; |
| |
| return ($statement, $condition, |
| $line, $remain + 1, $off - $loff + 1, $level); |
| } |
| |
| sub statement_lines { |
| my ($stmt) = @_; |
| |
| # Strip the diff line prefixes and rip blank lines at start and end. |
| $stmt =~ s/(^|\n)./$1/g; |
| $stmt =~ s/^\s*//; |
| $stmt =~ s/\s*$//; |
| |
| my @stmt_lines = ($stmt =~ /\n/g); |
| |
| return $#stmt_lines + 2; |
| } |
| |
| sub statement_rawlines { |
| my ($stmt) = @_; |
| |
| my @stmt_lines = ($stmt =~ /\n/g); |
| |
| return $#stmt_lines + 2; |
| } |
| |
| sub statement_block_size { |
| my ($stmt) = @_; |
| |
| $stmt =~ s/(^|\n)./$1/g; |
| $stmt =~ s/^\s*{//; |
| $stmt =~ s/}\s*$//; |
| $stmt =~ s/^\s*//; |
| $stmt =~ s/\s*$//; |
| |
| my @stmt_lines = ($stmt =~ /\n/g); |
| my @stmt_statements = ($stmt =~ /;/g); |
| |
| my $stmt_lines = $#stmt_lines + 2; |
| my $stmt_statements = $#stmt_statements + 1; |
| |
| if ($stmt_lines > $stmt_statements) { |
| return $stmt_lines; |
| } else { |
| return $stmt_statements; |
| } |
| } |
| |
| sub ctx_statement_full { |
| my ($linenr, $remain, $off) = @_; |
| my ($statement, $condition, $level); |
| |
| my (@chunks); |
| |
| # Grab the first conditional/block pair. |
| ($statement, $condition, $linenr, $remain, $off, $level) = |
| ctx_statement_block($linenr, $remain, $off); |
| #print "F: c<$condition> s<$statement> remain<$remain>\n"; |
| push(@chunks, [ $condition, $statement ]); |
| if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { |
| return ($level, $linenr, @chunks); |
| } |
| |
| # Pull in the following conditional/block pairs and see if they |
| # could continue the statement. |
| for (;;) { |
| ($statement, $condition, $linenr, $remain, $off, $level) = |
| ctx_statement_block($linenr, $remain, $off); |
| #print "C: c<$condition> s<$statement> remain<$remain>\n"; |
| last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); |
| #print "C: push\n"; |
| push(@chunks, [ $condition, $statement ]); |
| } |
| |
| return ($level, $linenr, @chunks); |
| } |
| |
| sub ctx_block_get { |
| my ($linenr, $remain, $outer, $open, $close, $off) = @_; |
| my $line; |
| my $start = $linenr - 1; |
| my $blk = ''; |
| my @o; |
| my @c; |
| my @res = (); |
| |
| my $level = 0; |
| my @stack = ($level); |
| for ($line = $start; $remain > 0; $line++) { |
| next if ($rawlines[$line] =~ /^-/); |
| $remain--; |
| |
| $blk .= $rawlines[$line]; |
| |
| # Handle nested #if/#else. |
| if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { |
| push(@stack, $level); |
| } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { |
| $level = $stack[$#stack - 1]; |
| } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { |
| $level = pop(@stack); |
| } |
| |
| foreach my $c (split(//, $lines[$line])) { |
| ##print "C<$c>L<$level><$open$close>O<$off>\n"; |
| if ($off > 0) { |
| $off--; |
| next; |
| } |
| |
| if ($c eq $close && $level > 0) { |
| $level--; |
| last if ($level == 0); |
| } elsif ($c eq $open) { |
| $level++; |
| } |
| } |
| |
| if (!$outer || $level <= 1) { |
| push(@res, $rawlines[$line]); |
| } |
| |
| last if ($level == 0); |
| } |
| |
| return ($level, @res); |
| } |
| sub ctx_block_outer { |
| my ($linenr, $remain) = @_; |
| |
| my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); |
| return @r; |
| } |
| sub ctx_block { |
| my ($linenr, $remain) = @_; |
| |
| my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); |
| return @r; |
| } |
| sub ctx_statement { |
| my ($linenr, $remain, $off) = @_; |
| |
| my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); |
| return @r; |
| } |
| sub ctx_block_level { |
| my ($linenr, $remain) = @_; |
| |
| return ctx_block_get($linenr, $remain, 0, '{', '}', 0); |
| } |
| sub ctx_statement_level { |
| my ($linenr, $remain, $off) = @_; |
| |
| return ctx_block_get($linenr, $remain, 0, '(', ')', $off); |
| } |
| |
| sub ctx_locate_comment { |
| my ($first_line, $end_line) = @_; |
| |
| # If c99 comment on the current line, or the line before or after |
| my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@); |
| return $current_comment if (defined $current_comment); |
| ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@); |
| return $current_comment if (defined $current_comment); |
| ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@); |
| return $current_comment if (defined $current_comment); |
| |
| # Catch a comment on the end of the line itself. |
| ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); |
| return $current_comment if (defined $current_comment); |
| |
| # Look through the context and try and figure out if there is a |
| # comment. |
| my $in_comment = 0; |
| $current_comment = ''; |
| for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { |
| my $line = $rawlines[$linenr - 1]; |
| #warn " $line\n"; |
| if ($linenr == $first_line and $line =~ m@^.\s*\*@) { |
| $in_comment = 1; |
| } |
| if ($line =~ m@/\*@) { |
| $in_comment = 1; |
| } |
| if (!$in_comment && $current_comment ne '') { |
| $current_comment = ''; |
| } |
| $current_comment .= $line . "\n" if ($in_comment); |
| if ($line =~ m@\*/@) { |
| $in_comment = 0; |
| } |
| } |
| |
| chomp($current_comment); |
| return($current_comment); |
| } |
| sub ctx_has_comment { |
| my ($first_line, $end_line) = @_; |
| my $cmt = ctx_locate_comment($first_line, $end_line); |
| |
| ##print "LINE: $rawlines[$end_line - 1 ]\n"; |
| ##print "CMMT: $cmt\n"; |
| |
| return ($cmt ne ''); |
| } |
| |
| sub raw_line { |
| my ($linenr, $cnt) = @_; |
| |
| my $offset = $linenr - 1; |
| $cnt++; |
| |
| my $line; |
| while ($cnt) { |
| $line = $rawlines[$offset++]; |
| next if (defined($line) && $line =~ /^-/); |
| $cnt--; |
| } |
| |
| return $line; |
| } |
| |
| sub get_stat_real { |
| my ($linenr, $lc) = @_; |
| |
| my $stat_real = raw_line($linenr, 0); |
| for (my $count = $linenr + 1; $count <= $lc; $count++) { |
| $stat_real = $stat_real . "\n" . raw_line($count, 0); |
| } |
| |
| return $stat_real; |
| } |
| |
| sub get_stat_here { |
| my ($linenr, $cnt, $here) = @_; |
| |
| my $herectx = $here . "\n"; |
| for (my $n = 0; $n < $cnt; $n++) { |
| $herectx .= raw_line($linenr, $n) . "\n"; |
| } |
| |
| return $herectx; |
| } |
| |
| sub cat_vet { |
| my ($vet) = @_; |
| my ($res, $coded); |
| |
| $res = ''; |
| while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { |
| $res .= $1; |
| if ($2 ne '') { |
| $coded = sprintf("^%c", unpack('C', $2) + 64); |
| $res .= $coded; |
| } |
| } |
| $res =~ s/$/\$/; |
| |
| return $res; |
| } |
| |
| my $av_preprocessor = 0; |
| my $av_pending; |
| my @av_paren_type; |
| my $av_pend_colon; |
| |
| sub annotate_reset { |
| $av_preprocessor = 0; |
| $av_pending = '_'; |
| @av_paren_type = ('E'); |
| $av_pend_colon = 'O'; |
| } |
| |
| sub annotate_values { |
| my ($stream, $type) = @_; |
| |
| my $res; |
| my $var = '_' x length($stream); |
| my $cur = $stream; |
| |
| print "$stream\n" if ($dbg_values > 1); |
| |
| while (length($cur)) { |
| @av_paren_type = ('E') if ($#av_paren_type < 0); |
| print " <" . join('', @av_paren_type) . |
| "> <$type> <$av_pending>" if ($dbg_values > 1); |
| if ($cur =~ /^(\s+)/o) { |
| print "WS($1)\n" if ($dbg_values > 1); |
| if ($1 =~ /\n/ && $av_preprocessor) { |
| $type = pop(@av_paren_type); |
| $av_preprocessor = 0; |
| } |
| |
| } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { |
| print "CAST($1)\n" if ($dbg_values > 1); |
| push(@av_paren_type, $type); |
| $type = 'c'; |
| |
| } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { |
| print "DECLARE($1)\n" if ($dbg_values > 1); |
| $type = 'T'; |
| |
| } elsif ($cur =~ /^($Modifier)\s*/) { |
| print "MODIFIER($1)\n" if ($dbg_values > 1); |
| $type = 'T'; |
| |
| } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { |
| print "DEFINE($1,$2)\n" if ($dbg_values > 1); |
| $av_preprocessor = 1; |
| push(@av_paren_type, $type); |
| if ($2 ne '') { |
| $av_pending = 'N'; |
| } |
| $type = 'E'; |
| |
| } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { |
| print "UNDEF($1)\n" if ($dbg_values > 1); |
| $av_preprocessor = 1; |
| push(@av_paren_type, $type); |
| |
| } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { |
| print "PRE_START($1)\n" if ($dbg_values > 1); |
| $av_preprocessor = 1; |
| |
| push(@av_paren_type, $type); |
| push(@av_paren_type, $type); |
| $type = 'E'; |
| |
| } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { |
| print "PRE_RESTART($1)\n" if ($dbg_values > 1); |
| $av_preprocessor = 1; |
| |
| push(@av_paren_type, $av_paren_type[$#av_paren_type]); |
| |
| $type = 'E'; |
| |
| } elsif ($cur =~ /^(\#\s*(?:endif))/o) { |
| print "PRE_END($1)\n" if ($dbg_values > 1); |
| |
| $av_preprocessor = 1; |
| |
| # Assume all arms of the conditional end as this |
| # one does, and continue as if the #endif was not here. |
| pop(@av_paren_type); |
| push(@av_paren_type, $type); |
| $type = 'E'; |
| |
| } elsif ($cur =~ /^(\\\n)/o) { |
| print "PRECONT($1)\n" if ($dbg_values > 1); |
| |
| } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { |
| print "ATTR($1)\n" if ($dbg_values > 1); |
| $av_pending = $type; |
| $type = 'N'; |
| |
| } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { |
| print "SIZEOF($1)\n" if ($dbg_values > 1); |
| if (defined $2) { |
| $av_pending = 'V'; |
| } |
| $type = 'N'; |
| |
| } elsif ($cur =~ /^(if|while|for)\b/o) { |
| print "COND($1)\n" if ($dbg_values > 1); |
| $av_pending = 'E'; |
| $type = 'N'; |
| |
| } elsif ($cur =~/^(case)/o) { |
| print "CASE($1)\n" if ($dbg_values > 1); |
| $av_pend_colon = 'C'; |
| $type = 'N'; |
| |
| } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { |
| print "KEYWORD($1)\n" if ($dbg_values > 1); |
| $type = 'N'; |
| |
| } elsif ($cur =~ /^(\()/o) { |
| print "PAREN('$1')\n" if ($dbg_values > 1); |
| push(@av_paren_type, $av_pending); |
| $av_pending = '_'; |
| $type = 'N'; |
| |
| } elsif ($cur =~ /^(\))/o) { |
| my $new_type = pop(@av_paren_type); |
| if ($new_type ne '_') { |
| $type = $new_type; |
| print "PAREN('$1') -> $type\n" |
| if ($dbg_values > 1); |
| } else { |
| print "PAREN('$1')\n" if ($dbg_values > 1); |
| } |
| |
| } elsif ($cur =~ /^($Ident)\s*\(/o) { |
| print "FUNC($1)\n" if ($dbg_values > 1); |
| $type = 'V'; |
| $av_pending = 'V'; |
| |
| } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { |
| if (defined $2 && $type eq 'C' || $type eq 'T') { |
| $av_pend_colon = 'B'; |
| } elsif ($type eq 'E') { |
| $av_pend_colon = 'L'; |
| } |
| print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); |
| $type = 'V'; |
| |
| } elsif ($cur =~ /^($Ident|$Constant)/o) { |
| print "IDENT($1)\n" if ($dbg_values > 1); |
| $type = 'V'; |
| |
| } elsif ($cur =~ /^($Assignment)/o) { |
| print "ASSIGN($1)\n" if ($dbg_values > 1); |
| $type = 'N'; |
| |
| } elsif ($cur =~/^(;|{|})/) { |
| print "END($1)\n" if ($dbg_values > 1); |
| $type = 'E'; |
| $av_pend_colon = 'O'; |
| |
| } elsif ($cur =~/^(,)/) { |
| print "COMMA($1)\n" if ($dbg_values > 1); |
| $type = 'C'; |
| |
| } elsif ($cur =~ /^(\?)/o) { |
| print "QUESTION($1)\n" if ($dbg_values > 1); |
| $type = 'N'; |
| |
| } elsif ($cur =~ /^(:)/o) { |
| print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); |
| |
| substr($var, length($res), 1, $av_pend_colon); |
| if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { |
| $type = 'E'; |
| } else { |
| $type = 'N'; |
| } |
| $av_pend_colon = 'O'; |
| |
| } elsif ($cur =~ /^(\[)/o) { |
| print "CLOSE($1)\n" if ($dbg_values > 1); |
| $type = 'N'; |
| |
| } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { |
| my $variant; |
| |
| print "OPV($1)\n" if ($dbg_values > 1); |
| if ($type eq 'V') { |
| $variant = 'B'; |
| } else { |
| $variant = 'U'; |
| } |
| |
| substr($var, length($res), 1, $variant); |
| $type = 'N'; |
| |
| } elsif ($cur =~ /^($Operators)/o) { |
| print "OP($1)\n" if ($dbg_values > 1); |
| if ($1 ne '++' && $1 ne '--') { |
| $type = 'N'; |
| } |
| |
| } elsif ($cur =~ /(^.)/o) { |
| print "C($1)\n" if ($dbg_values > 1); |
| } |
| if (defined $1) { |
| $cur = substr($cur, length($1)); |
| $res .= $type x length($1); |
| } |
| } |
| |
| return ($res, $var); |
| } |
| |
| sub possible { |
| my ($possible, $line) = @_; |
| my $notPermitted = qr{(?: |
| ^(?: |
| $Modifier| |
| $Storage| |
| $Type| |
| DEFINE_\S+ |
| )$| |
| ^(?: |
| goto| |
| return| |
| case| |
| else| |
| asm|__asm__| |
| do| |
| \#| |
| \#\#| |
| )(?:\s|$)| |
| ^(?:typedef|struct|enum)\b |
| )}x; |
| warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); |
| if ($possible !~ $notPermitted) { |
| # Check for modifiers. |
| $possible =~ s/\s*$Storage\s*//g; |
| $possible =~ s/\s*$Sparse\s*//g; |
| if ($possible =~ /^\s*$/) { |
| |
| } elsif ($possible =~ /\s/) { |
| $possible =~ s/\s*$Type\s*//g; |
| for my $modifier (split(' ', $possible)) { |
| if ($modifier !~ $notPermitted) { |
| warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); |
| push(@modifierListFile, $modifier); |
| } |
| } |
| |
| } else { |
| warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); |
| push(@typeListFile, $possible); |
| } |
| build_types(); |
| } else { |
| warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); |
| } |
| } |
| |
| my $prefix = ''; |
| |
| sub show_type { |
| my ($type) = @_; |
| |
| $type =~ tr/[a-z]/[A-Z]/; |
| |
| return defined $use_type{$type} if (scalar keys %use_type > 0); |
| |
| return !defined $ignore_type{$type}; |
| } |
| |
| sub report { |
| my ($level, $type, $msg) = @_; |
| |
| if (!show_type($type) || |
| (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { |
| return 0; |
| } |
| my $output = ''; |
| if ($color) { |
| if ($level eq 'ERROR') { |
| $output .= RED; |
| } elsif ($level eq 'WARNING') { |
| $output .= YELLOW; |
| } else { |
| $output .= GREEN; |
| } |
| } |
| $output .= $prefix . $level . ':'; |
| if ($show_types) { |
| $output .= BLUE if ($color); |
| $output .= "$type:"; |
| } |
| $output .= RESET if ($color); |
| $output .= ' ' . $msg . "\n"; |
| |
| if ($showfile) { |
| my @lines = split("\n", $output, -1); |
| splice(@lines, 1, 1); |
| $output = join("\n", @lines); |
| } |
| |
| if ($terse) { |
| $output = (split('\n', $output))[0] . "\n"; |
| } |
| |
| if ($verbose && exists($verbose_messages{$type}) && |
| !exists($verbose_emitted{$type})) { |
| $output .= $verbose_messages{$type} . "\n\n"; |
| $verbose_emitted{$type} = 1; |
| } |
| |
| push(our @report, $output); |
| |
| return 1; |
| } |
| |
| sub report_dump { |
| our @report; |
| } |
| |
| sub fixup_current_range { |
| my ($lineRef, $offset, $length) = @_; |
| |
| if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { |
| my $o = $1; |
| my $l = $2; |
| my $no = $o + $offset; |
| my $nl = $l + $length; |
| $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; |
| } |
| } |
| |
| sub fix_inserted_deleted_lines { |
| my ($linesRef, $insertedRef, $deletedRef) = @_; |
| |
| my $range_last_linenr = 0; |
| my $delta_offset = 0; |
| |
| my $old_linenr = 0; |
| my $new_linenr = 0; |
| |
| my $next_insert = 0; |
| my $next_delete = 0; |
| |
| my @lines = (); |
| |
| my $inserted = @{$insertedRef}[$next_insert++]; |
| my $deleted = @{$deletedRef}[$next_delete++]; |
| |
| foreach my $old_line (@{$linesRef}) { |
| my $save_line = 1; |
| my $line = $old_line; #don't modify the array |
| if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename |
| $delta_offset = 0; |
| } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk |
| $range_last_linenr = $new_linenr; |
| fixup_current_range(\$line, $delta_offset, 0); |
| } |
| |
| while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { |
| $deleted = @{$deletedRef}[$next_delete++]; |
| $save_line = 0; |
| fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); |
| } |
| |
| while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { |
| push(@lines, ${$inserted}{'LINE'}); |
| $inserted = @{$insertedRef}[$next_insert++]; |
| $new_linenr++; |
| fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); |
| } |
| |
| if ($save_line) { |
| push(@lines, $line); |
| $new_linenr++; |
| } |
| |
| $old_linenr++; |
| } |
| |
| return @lines; |
| } |
| |
| sub fix_insert_line { |
| my ($linenr, $line) = @_; |
| |
| my $inserted = { |
| LINENR => $linenr, |
| LINE => $line, |
| }; |
| push(@fixed_inserted, $inserted); |
| } |
| |
| sub fix_delete_line { |
| my ($linenr, $line) = @_; |
| |
| my $deleted = { |
| LINENR => $linenr, |
| LINE => $line, |
| }; |
| |
| push(@fixed_deleted, $deleted); |
| } |
| |
| sub ERROR { |
| my ($type, $msg) = @_; |
| |
| if (report("ERROR", $type, $msg)) { |
| our $clean = 0; |
| our $cnt_error++; |
| return 1; |
| } |
| return 0; |
| } |
| sub WARN { |
| my ($type, $msg) = @_; |
| |
| if (report("WARNING", $type, $msg)) { |
| our $clean = 0; |
| our $cnt_warn++; |
| return 1; |
| } |
| return 0; |
| } |
| sub CHK { |
| my ($type, $msg) = @_; |
| |
| if ($check && report("CHECK", $type, $msg)) { |
| our $clean = 0; |
| our $cnt_chk++; |
| return 1; |
| } |
| return 0; |
| } |
| |
| sub check_absolute_file { |
| my ($absolute, $herecurr) = @_; |
| my $file = $absolute; |
| |
| ##print "absolute<$absolute>\n"; |
| |
| # See if any suffix of this path is a path within the tree. |
| while ($file =~ s@^[^/]*/@@) { |
| if (-f "$root/$file") { |
| ##print "file<$file>\n"; |
| last; |
| } |
| } |
| if (! -f _) { |
| return 0; |
| } |
| |
| # It is, so see if the prefix is acceptable. |
| my $prefix = $absolute; |
| substr($prefix, -length($file)) = ''; |
| |
| ##print "prefix<$prefix>\n"; |
| if ($prefix ne ".../") { |
| WARN("USE_RELATIVE_PATH", |
| "use relative pathname instead of absolute in changelog text\n" . $herecurr); |
| } |
| } |
| |
| sub trim { |
| my ($string) = @_; |
| |
| $string =~ s/^\s+|\s+$//g; |
| |
| return $string; |
| } |
| |
| sub ltrim { |
| my ($string) = @_; |
| |
| $string =~ s/^\s+//; |
| |
| return $string; |
| } |
| |
| sub rtrim { |
| my ($string) = @_; |
| |
| $string =~ s/\s+$//; |
| |
| return $string; |
| } |
| |
| sub string_find_replace { |
| my ($string, $find, $replace) = @_; |
| |
| $string =~ s/$find/$replace/g; |
| |
| return $string; |
| } |
| |
| sub tabify { |
| my ($leading) = @_; |
| |
| my $source_indent = $tabsize; |
| my $max_spaces_before_tab = $source_indent - 1; |
| my $spaces_to_tab = " " x $source_indent; |
| |
| #convert leading spaces to tabs |
| 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; |
| #Remove spaces before a tab |
| 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; |
| |
| return "$leading"; |
| } |
| |
| sub pos_last_openparen { |
| my ($line) = @_; |
| |
| my $pos = 0; |
| |
| my $opens = $line =~ tr/\(/\(/; |
| my $closes = $line =~ tr/\)/\)/; |
| |
| my $last_openparen = 0; |
| |
| if (($opens == 0) || ($closes >= $opens)) { |
| return -1; |
| } |
| |
| my $len = length($line); |
| |
| for ($pos = 0; $pos < $len; $pos++) { |
| my $string = substr($line, $pos); |
| if ($string =~ /^($FuncArg|$balanced_parens)/) { |
| $pos += length($1) - 1; |
| } elsif (substr($line, $pos, 1) eq '(') { |
| $last_openparen = $pos; |
| } elsif (index($string, '(') == -1) { |
| last; |
| } |
| } |
| |
| return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; |
| } |
| |
| sub get_raw_comment { |
| my ($line, $rawline) = @_; |
| my $comment = ''; |
| |
| for my $i (0 .. (length($line) - 1)) { |
| if (substr($line, $i, 1) eq "$;") { |
| $comment .= substr($rawline, $i, 1); |
| } |
| } |
| |
| return $comment; |
| } |
| |
| sub exclude_global_initialisers { |
| my ($realfile) = @_; |
| |
| # Do not check for BPF programs (tools/testing/selftests/bpf/progs/*.c, samples/bpf/*_kern.c, *.bpf.c). |
| return $realfile =~ m@^tools/testing/selftests/bpf/progs/.*\.c$@ || |
| $realfile =~ m@^samples/bpf/.*_kern\.c$@ || |
| $realfile =~ m@/bpf/.*\.bpf\.c$@; |
| } |
| |
| sub process { |
| my $filename = shift; |
| |
| my $linenr=0; |
| my $prevline=""; |
| my $prevrawline=""; |
| my $stashline=""; |
| my $stashrawline=""; |
| |
| my $length; |
| my $indent; |
| my $previndent=0; |
| my $stashindent=0; |
| |
| our $clean = 1; |
| my $signoff = 0; |
| my $author = ''; |
| my $authorsignoff = 0; |
| my $author_sob = ''; |
| my $is_patch = 0; |
| my $is_binding_patch = -1; |
| my $in_header_lines = $file ? 0 : 1; |
| my $in_commit_log = 0; #Scanning lines before patch |
| my $has_patch_separator = 0; #Found a --- line |
| my $has_commit_log = 0; #Encountered lines before patch |
| my $commit_log_lines = 0; #Number of commit log lines |
| my $commit_log_possible_stack_dump = 0; |
| my $commit_log_long_line = 0; |
| my $commit_log_has_diff = 0; |
| my $reported_maintainer_file = 0; |
| my $non_utf8_charset = 0; |
| |
| my $last_git_commit_id_linenr = -1; |
| |
| my $last_blank_line = 0; |
| my $last_coalesced_string_linenr = -1; |
| |
| our @report = (); |
| our $cnt_lines = 0; |
| our $cnt_error = 0; |
| our $cnt_warn = 0; |
| our $cnt_chk = 0; |
| |
| # Trace the real file/line as we go. |
| my $realfile = ''; |
| my $realline = 0; |
| my $realcnt = 0; |
| my $here = ''; |
| my $context_function; #undef'd unless there's a known function |
| my $in_comment = 0; |
| my $comment_edge = 0; |
| my $first_line = 0; |
| my $p1_prefix = ''; |
| |
| my $prev_values = 'E'; |
| |
| # suppression flags |
| my %suppress_ifbraces; |
| my %suppress_whiletrailers; |
| my %suppress_export; |
| my $suppress_statement = 0; |
| |
| my %signatures = (); |
| |
| # Pre-scan the patch sanitizing the lines. |
| # Pre-scan the patch looking for any __setup documentation. |
| # |
| my @setup_docs = (); |
| my $setup_docs = 0; |
| |
| my $camelcase_file_seeded = 0; |
| |
| my $checklicenseline = 1; |
| |
| sanitise_line_reset(); |
| my $line; |
| foreach my $rawline (@rawlines) { |
| $linenr++; |
| $line = $rawline; |
| |
| push(@fixed, $rawline) if ($fix); |
| |
| if ($rawline=~/^\+\+\+\s+(\S+)/) { |
| $setup_docs = 0; |
| if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) { |
| $setup_docs = 1; |
| } |
| #next; |
| } |
| if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { |
| $realline=$1-1; |
| if (defined $2) { |
| $realcnt=$3+1; |
| } else { |
| $realcnt=1+1; |
| } |
| $in_comment = 0; |
| |
| # 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 |
| # at context start. |
| my $edge; |
| my $cnt = $realcnt; |
| for (my $ln = $linenr + 1; $cnt > 0; $ln++) { |
| next if (defined $rawlines[$ln - 1] && |
| $rawlines[$ln - 1] =~ /^-/); |
| $cnt--; |
| #print "RAW<$rawlines[$ln - 1]>\n"; |
| last if (!defined $rawlines[$ln - 1]); |
| if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && |
| $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { |
| ($edge) = $1; |
| last; |
| } |
| } |
| if (defined $edge && $edge eq '*/') { |
| $in_comment = 1; |
| } |
| |
| # Guestimate if this is a continuing comment. If this |
| # is the start of a diff block and this line starts |
| # ' *' then it is very likely a comment. |
| if (!defined $edge && |
| $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) |
| { |
| $in_comment = 1; |
| } |
| |
| ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; |
| sanitise_line_reset($in_comment); |
| |
| } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { |
| # Standardise the strings and chars within the input to |
| # simplify matching -- only bother with positive lines. |
| $line = sanitise_line($rawline); |
| } |
| push(@lines, $line); |
| |
| if ($realcnt > 1) { |
| $realcnt-- if ($line =~ /^(?:\+| |$)/); |
| } else { |
| $realcnt = 0; |
| } |
| |
| #print "==>$rawline\n"; |
| #print "-->$line\n"; |
| |
| if ($setup_docs && $line =~ /^\+/) { |
| push(@setup_docs, $line); |
| } |
| } |
| |
| $prefix = ''; |
| |
| $realcnt = 0; |
| $linenr = 0; |
| $fixlinenr = -1; |
| foreach my $line (@lines) { |
| $linenr++; |
| $fixlinenr++; |
| my $sline = $line; #copy of $line |
| $sline =~ s/$;/ /g; #with comments as spaces |
| |
| my $rawline = $rawlines[$linenr - 1]; |
| my $raw_comment = get_raw_comment($line, $rawline); |
| |
| # check if it's a mode change, rename or start of a patch |
| if (!$in_commit_log && |
| ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || |
| ($line =~ /^rename (?:from|to) \S+\s*$/ || |
| $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { |
| $is_patch = 1; |
| } |
| |
| #extract the line range in the file after the patch is applied |
| if (!$in_commit_log && |
| $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { |
| my $context = $4; |
| $is_patch = 1; |
| $first_line = $linenr + 1; |
| $realline=$1-1; |
| if (defined $2) { |
| $realcnt=$3+1; |
| } else { |
| $realcnt=1+1; |
| } |
| annotate_reset(); |
| $prev_values = 'E'; |
| |
| %suppress_ifbraces = (); |
| %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 |
| # new versions of GNU diff omit the leading space on completely |
| # blank context lines so we need to count that too. |
| } elsif ($line =~ /^( |\+|$)/) { |
| $realline++; |
| $realcnt-- if ($realcnt != 0); |
| |
| # Measure the line length and indent. |
| ($length, $indent) = line_stats($rawline); |
| |
| # Track the previous line. |
| ($prevline, $stashline) = ($stashline, $line); |
| ($previndent, $stashindent) = ($stashindent, $indent); |
| ($prevrawline, $stashrawline) = ($stashrawline, $rawline); |
| |
| #warn "line<$line>\n"; |
| |
| } elsif ($realcnt == 1) { |
| $realcnt--; |
| } |
| |
| my $hunk_line = ($realcnt != 0); |
| |
| $here = "#$linenr: " if (!$file); |
| $here = "#$realline: " if ($file); |
| |
| my $found_file = 0; |
| # extract the filename as it passes |
| if ($line =~ /^diff --git.*?(\S+)$/) { |
| $realfile = $1; |
| $realfile =~ s@^([^/]*)/@@ if (!$file); |
| $in_commit_log = 0; |
| $found_file = 1; |
| } elsif ($line =~ /^\+\+\+\s+(\S+)/) { |
| $realfile = $1; |
| $realfile =~ s@^([^/]*)/@@ if (!$file); |
| $in_commit_log = 0; |
| |
| $p1_prefix = $1; |
| if (!$file && $tree && $p1_prefix ne '' && |
| -e "$root/$p1_prefix") { |
| WARN("PATCH_PREFIX", |
| "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); |
| } |
| |
| if ($realfile =~ m@^include/asm/@) { |
| ERROR("MODIFIED_INCLUDE_ASM", |
| "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); |
| } |
| $found_file = 1; |
| } |
| |
| #make up the handle for any error we report on this line |
| if ($showfile) { |
| $prefix = "$realfile:$realline: " |
| } elsif ($emacs) { |
| if ($file) { |
| $prefix = "$filename:$realline: "; |
| } else { |
| $prefix = "$filename:$linenr: "; |
| } |
| } |
| |
| if ($found_file) { |
| if (is_maintained_obsolete($realfile)) { |
| WARN("OBSOLETE", |
| "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); |
| } |
| if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { |
| $check = 1; |
| } else { |
| $check = $check_orig; |
| } |
| $checklicenseline = 1; |
| |
| if ($realfile !~ /^MAINTAINERS/) { |
| my $last_binding_patch = $is_binding_patch; |
| |
| $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@; |
| |
| if (($last_binding_patch != -1) && |
| ($last_binding_patch ^ $is_binding_patch)) { |
| WARN("DT_SPLIT_BINDING_PATCH", |
| "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n"); |
| } |
| } |
| |
| next; |
| } |
| |
| $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); |
| |
| my $hereline = "$here\n$rawline\n"; |
| my $herecurr = "$here\n$rawline\n"; |
| my $hereprev = "$here\n$prevrawline\n$rawline\n"; |
| |
| $cnt_lines++ if ($realcnt != 0); |
| |
| # Verify the existence of a commit log if appropriate |
| # 2 is used because a $signature is counted in $commit_log_lines |
| if ($in_commit_log) { |
| if ($line !~ /^\s*$/) { |
| $commit_log_lines++; #could be a $signature |
| } |
| } elsif ($has_commit_log && $commit_log_lines < 2) { |
| WARN("COMMIT_MESSAGE", |
| "Missing commit description - Add an appropriate one\n"); |
| $commit_log_lines = 2; #warn only once |
| } |
| |
| # Check if the commit log has what seems like a diff which can confuse patch |
| if ($in_commit_log && !$commit_log_has_diff && |
| (($line =~ m@^\s+diff\b.*a/([\w/]+)@ && |
| $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) || |
| $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || |
| $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { |
| ERROR("DIFF_IN_COMMIT_MSG", |
| "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); |
| $commit_log_has_diff = 1; |
| } |
| |
| # Check for incorrect file permissions |
| if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { |
| my $permhere = $here . "FILE: $realfile\n"; |
| if ($realfile !~ m@scripts/@ && |
| $realfile !~ /\.(py|pl|awk|sh)$/) { |
| ERROR("EXECUTE_PERMISSIONS", |
| "do not set execute permissions for source files\n" . $permhere); |
| } |
| } |
| |
| # Check the patch for a From: |
| if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { |
| $author = $1; |
| my $curline = $linenr; |
| while(defined($rawlines[$curline]) && ($rawlines[$curline++] =~ /^[ \t]\s*(.*)/)) { |
| $author .= $1; |
| } |
| $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); |
| $author =~ s/"//g; |
| $author = reformat_email($author); |
| } |
| |
| # Check the patch for a signoff: |
| if ($line =~ /^\s*signed-off-by:\s*(.*)/i) { |
| $signoff++; |
| $in_commit_log = 0; |
| if ($author ne '' && $authorsignoff != 1) { |
| if (same_email_addresses($1, $author)) { |
| $authorsignoff = 1; |
| } else { |
| my $ctx = $1; |
| my ($email_name, $email_comment, $email_address, $comment1) = parse_email($ctx); |
| my ($author_name, $author_comment, $author_address, $comment2) = parse_email($author); |
| |
| if (lc $email_address eq lc $author_address && $email_name eq $author_name) { |
| $author_sob = $ctx; |
| $authorsignoff = 2; |
| } elsif (lc $email_address eq lc $author_address) { |
| $author_sob = $ctx; |
| $authorsignoff = 3; |
| } elsif ($email_name eq $author_name) { |
| $author_sob = $ctx; |
| $authorsignoff = 4; |
| |
| my $address1 = $email_address; |
| my $address2 = $author_address; |
| |
| if ($address1 =~ /(\S+)\+\S+(\@.*)/) { |
| $address1 = "$1$2"; |
| } |
| if ($address2 =~ /(\S+)\+\S+(\@.*)/) { |
| $address2 = "$1$2"; |
| } |
| if ($address1 eq $address2) { |
| $authorsignoff = 5; |
| } |
| } |
| } |
| } |
| } |
| |
| # Check for patch separator |
| if ($line =~ /^---$/) { |
| $has_patch_separator = 1; |
| $in_commit_log = 0; |
| } |
| |
| # Check if MAINTAINERS is being updated. If so, there's probably no need to |
| # emit the "does MAINTAINERS need updating?" message on file add/move/delete |
| if ($line =~ /^\s*MAINTAINERS\s*\|/) { |
| $reported_maintainer_file = 1; |
| } |
| |
| # Check signature styles |
| if (!$in_header_lines && |
| $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { |
| my $space_before = $1; |
| my $sign_off = $2; |
| my $space_after = $3; |
| my $email = $4; |
| my $ucfirst_sign_off = ucfirst(lc($sign_off)); |
| |
| if ($sign_off !~ /$signature_tags/) { |
| my $suggested_signature = find_standard_signature($sign_off); |
| if ($suggested_signature eq "") { |
| WARN("BAD_SIGN_OFF", |
| "Non-standard signature: $sign_off\n" . $herecurr); |
| } else { |
| if (WARN("BAD_SIGN_OFF", |
| "Non-standard signature: '$sign_off' - perhaps '$suggested_signature'?\n" . $herecurr) && |
| $fix) { |
| $fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/; |
| } |
| } |
| } |
| if (defined $space_before && $space_before ne "") { |
| if (WARN("BAD_SIGN_OFF", |
| "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && |
| $fix) { |
| $fixed[$fixlinenr] = |
| "$ucfirst_sign_off $email"; |
| } |
| } |
| if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { |
| if (WARN("BAD_SIGN_OFF", |
| "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && |
| $fix) { |
| $fixed[$fixlinenr] = |
| "$ucfirst_sign_off $email"; |
| } |
| |
| } |
| if (!defined $space_after || $space_after ne " ") { |
| if (WARN("BAD_SIGN_OFF", |
| "Use a single space after $ucfirst_sign_off\n" . $herecurr) && |
| $fix) { |
| $fixed[$fixlinenr] = |
| "$ucfirst_sign_off $email"; |
| } |
| } |
| |
| my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); |
| my $suggested_email = format_email(($email_name, $name_comment, $email_address, $comment)); |
| if ($suggested_email eq "") { |
| ERROR("BAD_SIGN_OFF", |
| "Unrecognized email address: '$email'\n" . $herecurr); |
| } else { |
| my $dequoted = $suggested_email; |
| $dequoted =~ s/^"//; |
| $dequoted =~ s/" </ </; |
| # Don't force email to have quotes |
| # Allow just an angle bracketed address |
| if (!same_email_addresses($email, $suggested_email)) { |
| if (WARN("BAD_SIGN_OFF", |
| "email address '$email' might be better as '$suggested_email'\n" . $herecurr) && |
| $fix) { |
| $fixed[$fixlinenr] =~ s/\Q$email\E/$suggested_email/; |
| } |
| } |
| |
| # Address part shouldn't have comments |
| my $stripped_address = $email_address; |
| $stripped_address =~ s/\([^\(\)]*\)//g; |
| if ($email_address ne $stripped_address) { |
| if (WARN("BAD_SIGN_OFF", |
| "address part of email should not have comments: '$email_address'\n" . $herecurr) && |
| $fix) { |
| $fixed[$fixlinenr] =~ s/\Q$email_address\E/$stripped_address/; |
| } |
| } |
| |
| # Only one name comment should be allowed |
| my $comment_count = () = $name_comment =~ /\([^\)]+\)/g; |
| if ($comment_count > 1) { |
| WARN("BAD_SIGN_OFF", |
| "Use a single name comment in email: '$email'\n" . $herecurr); |
| } |
| |
| |
| # stable@vger.kernel.org or stable@kernel.org shouldn't |
| # have an email name. In addition comments should strictly |
| # begin with a # |
| if ($email =~ /^.*stable\@(?:vger\.)?kernel\.org/i) { |
| if (($comment ne "" && $comment !~ /^#.+/) || |
| ($email_name ne "")) { |
| my $cur_name = $email_name; |
| my $new_comment = $comment; |
| $cur_name =~ s/[a-zA-Z\s\-\"]+//g; |
| |
| # Remove brackets enclosing comment text |
| # and # from start of comments to get comment text |
| $new_comment =~ s/^\((.*)\)$/$1/; |
| $new_comment =~ s/^\[(.*)\]$/$1/; |
| $new_comment =~ s/^[\s\#]+|\s+$//g; |
| |
| $new_comment = trim("$new_comment $cur_name") if ($cur_name ne $new_comment); |
| $new_comment = " # $new_comment" if ($new_comment ne ""); |
| my $new_email = "$email_address$new_comment"; |
| |
| if (WARN("BAD_STABLE_ADDRESS_STYLE", |
| "Invalid email format for stable: '$email', prefer '$new_email'\n" . $herecurr) && |
| $fix) { |
| $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/; |
| } |
| } |
| } elsif ($comment ne "" && $comment !~ /^(?:#.+|\(.+\))$/) { |
| my $new_comment = $comment; |
| |
| # Extract comment text from within brackets or |
| # c89 style /*...*/ comments |
| $new_comment =~ s/^\[(.*)\]$/$1/; |
| $new_comment =~ s/^\/\*(.*)\*\/$/$1/; |
| |
| $new_comment = trim($new_comment); |
| $new_comment =~ s/^[^\w]$//; # Single lettered comment with non word character is usually a typo |
| $new_comment = "($new_comment)" if ($new_comment ne ""); |
| my $new_email = format_email($email_name, $name_comment, $email_address, $new_comment); |
| |
| if (WARN("BAD_SIGN_OFF", |
| "Unexpected content after email: '$email', should be: '$new_email'\n" . $herecurr) && |
| $fix) { |
| $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/; |
| } |
| } |
| } |
| |
| # Check for duplicate signatures |
| my $sig_nospace = $line; |
| $sig_nospace =~ s/\s//g; |
| $sig_nospace = lc($sig_nospace); |
| if (defined $signatures{$sig_nospace}) { |
| WARN("BAD_SIGN_OFF", |
| "Duplicate signature\n" . $herecurr); |
| } else { |
| $signatures{$sig_nospace} = 1; |
| } |
| |
| # Check Co-developed-by: immediately followed by Signed-off-by: with same name and email |
| if ($sign_off =~ /^co-developed-by:$/i) { |
| if ($email eq $author) { |
| WARN("BAD_SIGN_OFF", |
| "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline); |
| } |
| if (!defined $lines[$linenr]) { |
| WARN("BAD_SIGN_OFF", |
| "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline); |
| } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) { |
| WARN("BAD_SIGN_OFF", |
| "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); |
| } elsif ($1 ne $email) { |
| WARN("BAD_SIGN_OFF", |
| "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); |
| } |
| } |
| } |
| |
| # Check email subject for common tools that don't need to be mentioned |
| if ($in_header_lines && |
| $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { |
| WARN("EMAIL_SUBJECT", |
| "A patch subject line should describe the change not the tool that found it\n" . $herecurr); |
| } |
| |
| # Check for Gerrit Change-Ids not in any patch context |
| if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) { |
| if (ERROR("GERRIT_CHANGE_ID", |
| "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr) && |
| $fix) { |
| fix_delete_line($fixlinenr, $rawline); |
| } |
| } |
| |
| # Check if the commit log is in a possible stack dump |
| if ($in_commit_log && !$commit_log_possible_stack_dump && |
| ($line =~ /^\s*(?:WARNING:|BUG:)/ || |
| $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || |
| # timestamp |
| $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) || |
| $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ || |
| $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) { |
| # stack dump address styles |
| $commit_log_possible_stack_dump = 1; |
| } |
| |
| # Check for line lengths > 75 in commit log, warn once |
| if ($in_commit_log && !$commit_log_long_line && |
| length($line) > 75 && |
| !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || |
| # file delta changes |
| $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || |
| # filename then : |
| $line =~ /^\s*(?:Fixes:|Link:|$signature_tags)/i || |
| # A Fixes: or Link: line or signature tag line |
| $commit_log_possible_stack_dump)) { |
| WARN("COMMIT_LOG_LONG_LINE", |
| "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); |
| $commit_log_long_line = 1; |
| } |
| |
| # Reset possible stack dump if a blank line is found |
| if ($in_commit_log && $commit_log_possible_stack_dump && |
| $line =~ /^\s*$/) { |
| $commit_log_possible_stack_dump = 0; |
| } |
| |
| # Check for lines starting with a # |
| if ($in_commit_log && $line =~ /^#/) { |
| if (WARN("COMMIT_COMMENT_SYMBOL", |
| "Commit log lines starting with '#' are dropped by git as comments\n" . $herecurr) && |
| $fix) { |
| $fixed[$fixlinenr] =~ s/^/ /; |
| } |
| } |
| |
| # Check for git id commit length and improperly formed commit descriptions |
| # A correctly formed commit description is: |
| # commit <SHA-1 hash length 12+ chars> ("Complete commit subject") |
| # with the commit subject '("' prefix and '")' suffix |
| # This is a fairly compilicated block as it tests for what appears to be |
| # bare SHA-1 hash with minimum length of 5. It also avoids several types of |
| # possible SHA-1 matches. |
| # A commit match can span multiple lines so this block attempts to find a |
| # complete typical commit on a maximum of 3 lines |
| if ($perl_version_ok && |
| $in_commit_log && !$commit_log_possible_stack_dump && |
| $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i && |
| $line !~ /^This reverts commit [0-9a-f]{7,40}/ && |
| (($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || |
| ($line =~ /\bcommit\s*$/i && defined($rawlines[$linenr]) && $rawlines[$linenr] =~ /^\s*[0-9a-f]{5,}\b/i)) || |
| ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && |
| $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && |
| $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { |
| my $init_char = "c"; |
| my $orig_commit = ""; |
| my $short = 1; |
| my $long = 0; |
| my $case = 1; |
| my $space = 1; |
| my $id = '0123456789ab'; |
| my $orig_desc = "commit description"; |
| my $description = ""; |
| my $herectx = $herecurr; |
| my $has_parens = 0; |
| my $has_quotes = 0; |
| |
| my $input = $line; |
| if ($line =~ /(?:\bcommit\s+[0-9a-f]{5,}|\bcommit\s*$)/i) { |
| for (my $n = 0; $n < 2; $n++) { |
| if ($input =~ /\bcommit\s+[0-9a-f]{5,}\s*($balanced_parens)/i) { |
| $orig_desc = $1; |
| $has_parens = 1; |
| # Always strip leading/trailing parens then double quotes if existing |
| $orig_desc = substr($orig_desc, 1, -1); |
| if ($orig_desc =~ /^".*"$/) { |
| $orig_desc = substr($orig_desc, 1, -1); |
| $has_quotes = 1; |
| } |
| last; |
| } |
| last if ($#lines < $linenr + $n); |
| $input .= " " . trim($rawlines[$linenr + $n]); |
| $herectx .= "$rawlines[$linenr + $n]\n"; |
| } |
| $herectx = $herecurr if (!$has_parens); |
| } |
| |
| if ($input =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { |
| $init_char = $1; |
| $orig_commit = lc($2); |
| $short = 0 if ($input =~ /\bcommit\s+[0-9a-f]{12,40}/i); |
| $long = 1 if ($input =~ /\bcommit\s+[0-9a-f]{41,}/i); |
| $space = 0 if ($input =~ /\bcommit [0-9a-f]/i); |
| $case = 0 if ($input =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); |
| } elsif ($input =~ /\b([0-9a-f]{12,40})\b/i) { |
| $orig_commit = lc($1); |
| } |
| |
| ($id, $description) = git_commit_info($orig_commit, |
| $id, $orig_desc); |
| |
| if (defined($id) && |
| ($short || $long || $space || $case || ($orig_desc ne $description) || !$has_quotes) && |
| $last_git_commit_id_linenr != $linenr - 1) { |
| ERROR("GIT_COMMIT_ID", |
| "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herectx); |
| } |
| #don't report the next line if this line ends in commit and the sha1 hash is the next line |
| $last_git_commit_id_linenr = $linenr if ($line =~ /\bcommit\s*$/i); |
| } |
| |
| # Check for added, moved or deleted files |
| if (!$reported_maintainer_file && !$in_commit_log && |
| ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || |
| $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || |
| ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && |
| (defined($1) || defined($2))))) { |
| $is_patch = 1; |
| $reported_maintainer_file = 1; |
| WARN("FILE_PATH_CHANGES", |
| "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); |
| } |
| |
| # Check for adding new DT bindings not in schema format |
| if (!$in_commit_log && |
| ($line =~ /^new file mode\s*\d+\s*$/) && |
| ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) { |
| WARN("DT_SCHEMA_BINDING_PATCH", |
| "DT bindings should be in DT schema format. See: Documentation/devicetree/bindings/writing-schema.rst\n"); |
| } |
| |
| # Check for wrappage within a valid hunk of the file |
| if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { |
| ERROR("CORRUPTED_PATCH", |
| "patch seems to be corrupt (line wrapped?)\n" . |
| $herecurr) if (!$emitted_corrupt++); |
| } |
| |
| # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php |
| if (($realfile =~ /^$/ || $line =~ /^\+/) && |
| $rawline !~ m/^$UTF8*$/) { |
| my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); |
| |
| my $blank = copy_spacing($rawline); |
| my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; |
| my $hereptr = "$hereline$ptr\n"; |
| |
| CHK("INVALID_UTF8", |
| "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); |
| } |
| |
| # 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)) { |
| $in_header_lines = 0; |
| $in_commit_log = 1; |
| $has_commit_log = 1; |
| } |
| |
| # Check if there is UTF-8 in a commit log when a mail header has explicitly |
| # declined it, i.e defined some charset where it is missing. |
| if ($in_header_lines && |
| $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && |
| $1 !~ /utf-8/i) { |
| $non_utf8_charset = 1; |
| } |
| |
| if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && |
| $rawline =~ /$NON_ASCII_UTF8/) { |
| WARN("UTF8_BEFORE_PATCH", |
| "8-bit UTF-8 used in possible commit log\n" . $herecurr); |
| } |
| |
| # Check for absolute kernel paths in commit message |
| if ($tree && $in_commit_log) { |
| while ($line =~ m{(?:^|\s)(/\S*)}g) { |
| my $file = $1; |
| |
| if ($file =~ m{^(.*?)(?::\d+)+:?$} && |
| check_absolute_file($1, $herecurr)) { |
| # |
| } else { |
| check_absolute_file($file, $herecurr); |
| } |
| } |
| } |
| |
| # Check for various typo / spelling mistakes |
| if (defined($misspellings) && |
| ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { |
| while ($rawline =~ /(?:^|[^\w\-'`])($misspellings)(?:[^\w\-'`]|$)/gi) { |
| my $typo = $1; |
| my $blank = copy_spacing($rawline); |
| my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo); |
| my $hereptr = "$hereline$ptr\n"; |
| 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_level = \&WARN; |
| $msg_level = \&CHK if ($file); |
| if (&{$msg_level}("TYPO_SPELLING", |
| "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $hereptr) && |
| $fix) { |
| $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; |
| } |
| } |
| } |
| |
| # check for invalid commit id |
| if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) { |
| my $id; |
| my $description; |
| ($id, $description) = git_commit_info($2, undef, undef); |
| if (!defined($id)) { |
| WARN("UNKNOWN_COMMIT_ID", |
| "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr); |
| } |
| } |
| |
| # check for repeated words separated by a single space |
| # avoid false positive from list command eg, '-rw-r--r-- 1 root root' |
| if (($rawline =~ /^\+/ || $in_commit_log) && |
| $rawline !~ /[bcCdDlMnpPs\?-][rwxsStT-]{9}/) { |
| pos($rawline) = 1 if (!$in_commit_log); |
| while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) { |
| |
| my $first = $1; |
| my $second = $2; |
| my $start_pos = $-[1]; |
| my $end_pos = $+[2]; |
| if ($first =~ /(?:struct|union|enum)/) { |
| pos($rawline) += length($first) + length($second) + 1; |
| next; |
| } |
| |
| next if (lc($first) ne lc($second)); |
| next if ($first eq 'long'); |
| |
| # check for character before and after the word matches |
| my $start_char = ''; |
| my $end_char = ''; |
| $start_char = substr($rawline, $start_pos - 1, 1) if ($start_pos > ($in_commit_log ? 0 : 1)); |
| $end_char = substr($rawline, $end_pos, 1) if ($end_pos < length($rawline)); |
| |
| next if ($start_char =~ /^\S$/); |
| next if (index(" \t.,;?!", $end_char) == -1); |
| |
| # avoid repeating hex occurrences like 'ff ff fe 09 ...' |
| if ($first =~ /\b[0-9a-f]{2,}\b/i) { |
| next if (!exists($allow_repeated_words{lc($first)})); |
| } |
| |
| if (WARN("REPEATED_WORD", |
| "Possible repeated word: '$first'\n" . $herecurr) && |
| $fix) { |
| $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/; |
| } |
| } |
| |
| # if it's a repeated word on consecutive lines in a comment block |
| if ($prevline =~ /$;+\s*$/ && |
| $prevrawline =~ /($word_pattern)\s*$/) { |
| my $last_word = $1; |
| if ($rawline =~ /^\+\s*\*\s*$last_word /) { |
| if (WARN("REPEATED_WORD", |
| "Possible repeated word: '$last_word'\n" . $hereprev) && |
| $fix) { |
| $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/; |
| } |
| } |
| } |
| } |
| |
| # ignore non-hunk lines and lines being removed |
| next if (!$hunk_line || $line =~ /^-/); |
| |
| #trailing whitespace |
| if ($line =~ /^\+.*\015/) { |
| my $herevet = "$here\n" . cat_vet($rawline) . "\n"; |
| if (ERROR("DOS_LINE_ENDINGS", |
| "DOS line endings\n" . $herevet) && |
| $fix) { |
| $fixed[$fixlinenr] =~ s/[\s\015]+$//; |
| } |
| } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { |
| my $herevet = "$here\n" . cat_vet($rawline) . "\n"; |
| if (ERROR("TRAILING_WHITESPACE", |
| "trailing whitespace\n" . $herevet) && |
| $fix) { |
| $fixed[$fixlinenr] =~ s/\s+$//; |
| } |
| |
| $rpt_cleaners = 1; |
| } |
| |
| # Check for FSF mailing addresses. |
| if ($rawline =~ /\bwrite to the Free/i || |
| $rawline =~ /\b675\s+Mass\s+Ave/i || |
| $rawline =~ /\b59\s+Temple\s+Pl/i || |
| $rawline =~ /\b51\s+Franklin\s+St/i) { |
| my $herevet = "$here\n" . cat_vet($rawline) . "\n"; |
| 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 |
| # Only applies when adding the entry originally, after that we do not have |
| # sufficient context to determine whether it is indeed long enough. |
| if ($realfile =~ /Kconfig/ && |
| # 'choice' is usually the last thing on the line (though |
| # Kconfig supports named choices), so use a word boundary |
| # (\b) rather than a whitespace character (\s) |
| $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { |
| my $length = 0; |
| my $cnt = $realcnt; |
| my $ln = $linenr + 1; |
| my $f; |
| my $is_start = 0; |
| my $is_end = 0; |
| for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { |
| $f = $lines[$ln - 1]; |
| $cnt-- if ($lines[$ln - 1] !~ /^-/); |
| $is_end = $lines[$ln - 1] =~ /^\+/; |
| |
| next if ($f =~ /^-/); |
| last if (!$file && $f =~ /^\@\@/); |
| |
| if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { |
| $is_start = 1; |
| } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { |
| $length = -1; |
| } |
| |
| $f =~ s/^.//; |
| $f =~ s/#.*//; |
| $f =~ s/^\s+//; |
| next if ($f =~ /^$/); |
| |
| # This only checks context lines in the patch |
| # and so hopefully shouldn't trigger false |
| # positives, even though some of these are |
| # common words in help texts |
| if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| |
| if|endif|menu|endmenu|source)\b/x) { |
| $is_end = 1; |
| last; |
| } |
| $length++; |
| } |
| if ($is_start && $is_end && $length < $min_conf_desc_length) { |
| WARN("CONFIG_DESCRIPTION", |
| "please write a paragraph that describes the config symbol fully\n" . $herecurr); |
| } |
| #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; |
| } |
| |
| # check MAINTAINERS entries |
| if ($realfile =~ /^MAINTAINERS$/) { |
| # check MAINTAINERS entries for the right form |
| if ($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/; |
| } |
| } |
| # check MAINTAINERS entries for the right ordering too |
| my $preferred_order = 'MRLSWQBCPTFXNK'; |
| if ($rawline =~ /^\+[A-Z]:/ && |
| $prevrawline =~ /^[\+ ][A-Z]:/) { |
| $rawline =~ /^\+([A-Z]):\s*(.*)/; |
| my $cur = $1; |
| my $curval = $2; |
| $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/; |
| my $prev = $1; |
| my $prevval = $2; |
| my $curindex = index($preferred_order, $cur); |
| my $previndex = index($preferred_order, $prev); |
| if ($curindex < 0) { |
| WARN("MAINTAINERS_STYLE", |
| "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr); |
| } else { |
| if ($previndex >= 0 && $curindex < $previndex) { |
| WARN("MAINTAINERS_STYLE", |
| "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev); |
| } elsif ((($prev eq 'F' && $cur eq 'F') || |
| ($prev eq 'X' && $cur eq 'X')) && |
| ($prevval cmp $curval) > 0) { |
| WARN("MAINTAINERS_STYLE", |
| "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev); |
| } |
| } |
| } |
| } |
| |
| if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && |
| ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { |
| my $flag = $1; |
| my $replacement = { |
| 'EXTRA_AFLAGS' => 'asflags-y', |
| 'EXTRA_CFLAGS' => 'ccflags-y', |
| 'EXTRA_CPPFLAGS' => 'cppflags-y', |
| 'EXTRA_LDFLAGS' => 'ldflags-y', |
| }; |
| |
| WARN("DEPRECATED_VARIABLE", |
| "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); |
| } |
| |
| # check for DT compatible documentation |
| if (defined $root && |
| (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || |
| ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { |
| |
| my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; |
| |
| my $dt_path = $root . "/Documentation/devicetree/bindings/"; |
| my $vp_file = $dt_path . "vendor-prefixes.yaml"; |
| |
| foreach my $compat (@compats) { |
| my $compat2 = $compat; |
| $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; |
| my $compat3 = $compat; |
| $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; |
| `grep -Erq "$compat|$compat2|$compat3" $dt_path`; |
| if ( $? >> 8 ) { |
| WARN("UNDOCUMENTED_DT_STRING", |
| "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); |
| } |
| |
| next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; |
| my $vendor = $1; |
| `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`; |
| if ( $? >> 8 ) { |
| WARN("UNDOCUMENTED_DT_STRING", |
| "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); |
| } |
| } |
| } |
| |
| # check for using SPDX license tag at beginning of files |
| if ($realline == $checklicenseline) { |
| if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { |
| $checklicenseline = 2; |
| } elsif ($rawline =~ /^\+/) { |
| my $comment = ""; |
| if ($realfile =~ /\.(h|s|S)$/) { |
| $comment = '/*'; |
| } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { |
| $comment = '//'; |
| } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) { |
| $comment = '#'; |
| } elsif ($realfile =~ /\.rst$/) { |
| $comment = '..'; |
| } |
| |
| # check SPDX comment style for .[chsS] files |
| if ($realfile =~ /\.[chsS]$/ && |
| $rawline =~ /SPDX-License-Identifier:/ && |
| $rawline !~ m@^\+\s*\Q$comment\E\s*@) { |
| WARN("SPDX_LICENSE_TAG", |
| "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr); |
| } |
| |
| if ($comment !~ /^$/ && |
| $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) { |
| WARN("SPDX_LICENSE_TAG", |
| "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); |
| } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) { |
| my $spdx_license = $1; |
| if (!is_SPDX_License_valid($spdx_license)) { |
| WARN("SPDX_LICENSE_TAG", |
| "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr); |
| } |
| if ($realfile =~ m@^Documentation/devicetree/bindings/@ && |
| not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) { |
| my $msg_level = \&WARN; |
| $msg_level = \&CHK if ($file); |
| if (&{$msg_level}("SPDX_LICENSE_TAG", |
| |
| "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) && |
| $fix) { |
| $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/; |
| } |
| } |
| } |
| } |
| } |
| |
| # check for embedded filenames |
| if ($rawline =~ /^\+.*\Q$realfile\E/) { |
| WARN("EMBEDDED_FILENAME", |
| "It's generally not useful to have the filename in the file\n" . $herecurr); |
| } |
| |
| # check we are in a valid source file if not then ignore this hunk |
| next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); |
| |
| # check for using SPDX-License-Identifier on the wrong line number |
| if ($realline != $checklicenseline && |
| $rawline =~ /\bSPDX-License-Identifier:/ && |
| substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) { |
| WARN("SPDX_LICENSE_TAG", |
| "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr); |
| } |
| |
| # line length limit (with some exclusions) |
| # |
| # There are a few types of lines that may extend beyond $max_line_length: |
| # logging functions like pr_info that end in a string |
| # lines with a single string |
| # #defines that are a single string |
| # lines with an RFC3986 like URL |
| # |
| # There are 3 different line length message types: |
| # 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 |
| # |
| # if LONG_LINE is ignored, the other 2 types are also ignored |
| # |
| |
| if ($line =~ /^\+/ && $length > $max_line_length) { |
| my $msg_type = "LONG_LINE"; |
| |
| # Check the allowed long line types first |
| |
| # logging functions that end in a string that starts |
| # before $max_line_length |
| if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && |
| length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { |
| $msg_type = ""; |
| |
| # lines with only strings (w/ possible termination) |
| # #defines with only strings |
| } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || |
| $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { |
| $msg_type = ""; |
| |
| # More special cases |
| } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || |
| $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { |
| $msg_type = ""; |
| |
| # URL ($rawline is used in case the URL is in a comment) |
| } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { |
| $msg_type = ""; |
| |
| # Otherwise set the alternate message types |
| |
| # a comment starts before $max_line_length |
| } elsif ($line =~ /($;[\s$;]*)$/ && |
| length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { |
| $msg_type = "LONG_LINE_COMMENT" |
| |
| # a quoted string starts before $max_line_length |
| } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && |
| length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { |
| $msg_type = "LONG_LINE_STRING" |
| } |
| |
| if ($msg_type ne "" && |
| (show_type("LONG_LINE") || show_type($msg_type))) { |
| my $msg_level = \&WARN; |
| $msg_level = \&CHK if ($file); |
| &{$msg_level}($msg_type, |
| "line length of $length exceeds $max_line_length columns\n" . $herecurr); |
| } |
| } |
| |
| # check for adding lines without a newline. |
| if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { |
| if (WARN("MISSING_EOF_NEWLINE", |
| "adding a line without newline at end of file\n" . $herecurr) && |
| $fix) { |
| fix_delete_line($fixlinenr+1, "No newline at end of file"); |
| } |
| } |
| |
| # check for .L prefix local symbols in .S files |
| if ($realfile =~ /\.S$/ && |
| $line =~ /^\+\s*(?:[A-Z]+_)?SYM_[A-Z]+_(?:START|END)(?:_[A-Z_]+)?\s*\(\s*\.L/) { |
| WARN("AVOID_L_PREFIX", |
| "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); |
| } |
| |
| # check we are in a valid source file C or perl if not then ignore this hunk |
| next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); |
| |
| # at the beginning of a line any tabs must come first and anything |
| # more than $tabsize must use tabs. |
| if ($rawline =~ /^\+\s* \t\s*\S/ || |
| $rawline =~ /^\+\s* \s*/) { |
| my $herevet = "$here\n" . cat_vet($rawline) . "\n"; |
| $rpt_cleaners = 1; |
| if (ERROR("CODE_INDENT", |
| "code indent should use tabs where possible\n" . $herevet) && |
| $fix) { |
| $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; |
| } |
| } |
| |
| # check for space before tabs. |
| if ($rawline =~ /^\+/ && $rawline =~ / \t/) { |
| my $herevet = "$here\n" . cat_vet($rawline) . "\n"; |
| if (WARN("SPACE_BEFORE_TAB", |
| "please, no space before tabs\n" . $herevet) && |
| $fix) { |
| while ($fixed[$fixlinenr] =~ |
| s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} |
| while ($fixed[$fixlinenr] =~ |
| s/(^\+.*) +\t/$1\t/) {} |
| } |
| } |
| |
| # check for assignments on the start of a line |
| if ($sline =~ /^\+\s+($Assignment)[^=]/) { |
| my $operator = $1; |
| if (CHK("ASSIGNMENT_CONTINUATIONS", |
| "Assignment operator '$1' should be on the previous line\n" . $hereprev) && |
| $fix && $prevrawline =~ /^\+/) { |
| # add assignment operator to the previous line, remove from current line |
| $fixed[$fixlinenr - 1] .= " $operator"; |
| $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//; |
| } |
| } |
| |
| # check for && or || at the start of a line |
| if ($rawline =~ /^\+\s*(&&|\|\|)/) { |
| my $operator = $1; |
| if (CHK("LOGICAL_CONTINUATIONS", |
| "Logical continuations should be on the previous line\n" . $hereprev) && |
| $fix && $prevrawline =~ /^\+/) { |
| # insert logical operator at last non-comment, non-whitepsace char on previous line |
| $prevline =~ /[\s$;]*$/; |
| my $line_end = substr($prevrawline, $-[0]); |
| $fixed[$fixlinenr - 1] =~ s/\Q$line_end\E$/ $operator$line_end/; |
| $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//; |
| } |
| } |
| |
| # check indentation starts on a tab stop |
| if ($perl_version_ok && |
| $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { |
| my $indent = length($1); |
| if ($indent % $tabsize) { |
| if (WARN("TABSTOP", |
| "Statements should start on a tabstop\n" . $herecurr) && |
| $fix) { |
| $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; |
| } |
| } |
| } |
| |
| # check multi-line statement indentation matches previous line |
| if ($perl_version_ok && |
| $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; |
| |
| my $pos = pos_last_openparen($rest); |
| if ($pos >= 0) { |
| $line =~ /^(\+| )([ \t]*)/; |
| my $newindent = $2; |
| |
| my $goodtabindent = $oldindent . |
| "\t" x ($pos / $tabsize) . |
| " " x ($pos % $tabsize); |
| my $goodspaceindent = $oldindent . " " x $pos; |
| |
| if ($newindent ne $goodtabindent && |
| $newindent ne $goodspaceindent) { |
| |
| if (CHK("PARENTHESIS_ALIGNMENT", |
| "Alignment should match open parenthesis\n" . $hereprev) && |
| $fix && $line =~ /^\+/) { |
| $fixed[$fixlinenr] =~ |
| s/^\+[ \t]*/\+$goodtabindent/; |
| } |
| } |
| } |
| } |
| |
| # check for space after cast like "(int) foo" or "(struct foo) bar" |
| # avoid checking a few false positives: |
| # "sizeof(<type>)" or "__alignof__(<type>)" |
| # function pointer declarations like "(*foo)(int) = bar;" |
| # structure definitions like "(struct foo) { 0 };" |
| # multiline macros that define functions |
| # known attributes or the __attribute__ keyword |
| if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && |
| (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { |
| if (CHK("SPACING", |
| "No space is necessary after a cast\n" . $herecurr) && |
| $fix) { |
| $fixed[$fixlinenr] =~ |
| s/(\(\s*$Type\s*\))[ \t]+/$1/; |
| } |
| } |
| |
| # Block comment styles |
| # Networking with an initial /* |
| if ($realfile =~ m@^(drivers/net/|net/)@ && |
| $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && |
| $rawline =~ /^\+[ \t]*\*/ && |
| $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier |
| WARN("NETWORKING_BLOCK_COMMENT_STYLE", |
| "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); |
| } |
| |
| # Block comments use * on subsequent lines |
| if ($prevline =~ /$;[ \t]*$/ && #ends in comment |
| $prevrawline =~ /^\+.*?\/\*/ && #starting /* |
| $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ |
| $rawline =~ /^\+/ && #line is new |
| $rawline !~ /^\+[ \t]*\*/) { #no leading * |
| WARN("BLOCK_COMMENT_STYLE", |
| "Block comments use * on subsequent lines\n" . $hereprev); |
| } |
| |
| # Block comments use */ on trailing lines |
| if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ |
| $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ |
| $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ |
| $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ |
| WARN("BLOCK_COMMENT_STYLE", |
| "Block comments use a trailing */ on a separate line\n" . $herecurr); |
| } |
| |
| # Block comment * alignment |
| if ($prevline =~ /$;[ \t]*$/ && #ends in comment |
| $line =~ /^\+[ \t]*$;/ && #leading comment |
| $rawline =~ /^\+[ \t]*\*/ && #leading * |
| (($prevrawline =~ /^\+.*?\/\*/ && #leading /* |
| $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ |
| $prevrawline =~ /^\+[ \t]*\*/)) { #leading * |
| my $oldindent; |
| $prevrawline =~ m@^\+([ \t]*/?)\*@; |
| if (defined($1)) { |
| $oldindent = expand_tabs($1); |
| } else { |
| $prevrawline =~ m@^\+(.*/?)\*@; |
| $oldindent = expand_tabs($1); |
| } |
| $rawline =~ m@^\+([ \t]*)\*@; |
| my $newindent = $1; |
| $newindent = expand_tabs($newindent); |
| if (length($oldindent) ne length($newindent)) { |
| WARN("BLOCK_COMMENT_STYLE", |
| "Block comments should align the * on each line\n" . $hereprev); |
| } |
| } |
| |
| # check for missing blank lines after struct/union declarations |
| # with exceptions for various attributes and macros |
| if ($prevline =~ /^[\+ ]};?\s*$/ && |
| $line =~ /^\+/ && |
| !($line =~ /^\+\s*$/ || |
| $line =~ /^\+\s*EXPORT_SYMBOL/ || |
| $line =~ /^\+\s*MODULE_/i || |
| $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || |
| $line =~ /^\+[a-z_]*init/ || |
| $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || |
| $line =~ /^\+\s*DECLARE/ || |
| $line =~ /^\+\s*builtin_[\w_]*driver/ || |
| $line =~ /^\+\s*__setup/)) { |
| if (CHK("LINE_SPACING", |
| "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && |
| $fix) { |
| fix_insert_line($fixlinenr, "\+"); |
| } |
| } |
| |
| # check for multiple consecutive blank lines |
| if ($prevline =~ /^[\+ ]\s*$/ && |
| $line =~ /^\+\s*$/ && |
| $last_blank_line != ($linenr - 1)) { |
| if (CHK("LINE_SPACING", |
| "Please don't use multiple blank lines\n" . $hereprev) && |
| $fix) { |
| fix_delete_line($fixlinenr, $rawline); |
| } |
| |
| $last_blank_line = $linenr; |
| } |
| |
| # check for missing blank lines after declarations |
| # (declarations must have the same indentation and not be at the start of line) |
| if (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/) { |
| # use temporaries |
| my $sl = $sline; |
| my $pl = $prevline; |
| # remove $Attribute/$Sparse uses to simplify comparisons |
| $sl =~ s/\b(?:$Attribute|$Sparse)\b//g; |
| $pl =~ s/\b(?:$Attribute|$Sparse)\b//g; |
| if (($pl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || |
| # function pointer declarations |
| $pl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || |
| # foo bar; where foo is some local typedef or #define |
| $pl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || |
| # known declaration macros |
| $pl =~ /^\+\s+$declaration_macros/) && |
| # for "else if" which can look like "$Ident $Ident" |
| !($pl =~ /^\+\s+$c90_Keywords\b/ || |
| # other possible extensions of declaration lines |
| $pl =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || |
| # not starting a section or a macro "\" extended line |
| $pl =~ /(?:\{\s*|\\)$/) && |
| # looks like a declaration |
| !($sl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || |
| # function pointer declarations |
| $sl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || |
| # foo bar; where foo is some local typedef or #define |
| $sl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || |
| # known declaration macros |
| $sl =~ /^\+\s+$declaration_macros/ || |
| # start of struct or union or enum |
| $sl =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ || |
| # start or end of block or continuation of declaration |
| $sl =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || |
| # bitfield continuation |
| $sl =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || |
| # other possible extensions of declaration lines |
| $sl =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/)) { |
| if (WARN("LINE_SPACING", |
| "Missing a blank line after declarations\n" . $hereprev) && |
| $fix) { |
| fix_insert_line($fixlinenr, "\+"); |
| } |
| } |
| } |
| |
| # check for spaces at the beginning of a line. |
| # Exceptions: |
| # 1) within comments |
| # 2) indented preprocessor commands |
| # 3) hanging labels |
| if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { |
| my $herevet = "$here\n" . cat_vet($rawline) . "\n"; |
| if (WARN("LEADING_SPACE", |
| "please, no spaces at the start of a line\n" . $herevet) && |
| $fix) { |
| $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; |
| } |
| } |
| |
| # check we are in a valid C source file if not then ignore this hunk |
| next if ($realfile !~ /\.(h|c)$/); |
| |
| # check for unusual line ending [ or ( |
| if ($line =~ /^\+.*([\[\(])\s*$/) { |
| CHK("OPEN_ENDED_LINE", |
| "Lines should not end with a '$1'\n" . $herecurr); |
| } |
| |
| # 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... |
| if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { |
| my $tabs = length($1) + 1; |
| if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || |
| ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && |
| defined $lines[$linenr] && |
| $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { |
| WARN("UNNECESSARY_ELSE", |
| "else is not generally useful after a break or return\n" . $hereprev); |
| } |
| } |
| |
| # check indentation of a line with a break; |
| # if the previous line is a goto, return or break |
| # and is indented the same # of tabs |
| if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { |
| my $tabs = $1; |
| if ($prevline =~ /^\+$tabs(goto|return|break)\b/) { |
| if (WARN("UNNECESSARY_BREAK", |
| "break is not useful after a $1\n" . $hereprev) && |
| $fix) { |
| fix_delete_line($fixlinenr, $rawline); |
| } |
| } |
| } |
| |
| # check for RCS/CVS revision markers |
| if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { |
| WARN("CVS_KEYWORD", |
| "CVS style keyword markers, these will _not_ be updated\n". $herecurr); |
| } |
| |
| # check for old HOTPLUG __dev<foo> section markings |
| if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { |
| WARN("HOTPLUG_SECTION", |
| "Using $1 is unnecessary\n" . $herecurr); |
| } |
| |
| # Check for potential 'bare' types |
| my ($stat, $cond, $line_nr_next, $remain_next, $off_next, |
| $realline_next); |
| #print "LINE<$line>\n"; |
| if ($linenr > $suppress_statement && |
| $realcnt && $sline =~ /.\s*\S/) { |
| ($stat, $cond, $line_nr_next, $remain_next, $off_next) = |
| ctx_statement_block($linenr, $realcnt, 0); |
| $stat =~ s/\n./\n /g; |
| $cond =~ s/\n./\n /g; |
| |
| #print "linenr<$linenr> <$stat>\n"; |
| # If this statement has no statement boundaries within |
| # it there is no point in retrying a statement scan |
| # until we hit end of it. |
| my $frag = $stat; $frag =~ s/;+\s*$//; |
| if ($frag !~ /(?:{|;)/) { |
| #print "skip<$line_nr_next>\n"; |
| $suppress_statement = $line_nr_next; |
| } |
| |
| # Find the real next line. |
| $realline_next = $line_nr_next; |
| if (defined $realline_next && |
| (!defined $lines[$realline_next - 1] || |
| substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { |
| $realline_next++; |
| } |
| |
| my $s = $stat; |
| $s =~ s/{.*$//s; |
| |
| # Ignore goto labels. |
| if ($s =~ /$Ident:\*$/s) { |
| |
| # Ignore functions being called |
| } elsif ($s =~ /^.\s*$Ident\s*\(/s) { |
| |
| } elsif ($s =~ /^.\s*else\b/s) { |
| |
| # declarations always start with types |
| } 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) { |
| my $type = $1; |
| $type =~ s/\s+/ /g; |
| possible($type, "A:" . $s); |
| |
| # definitions in global scope can only start with types |
| } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { |
| possible($1, "B:" . $s); |
| } |
| |
| # any (foo ... *) is a pointer cast, and foo is a type |
| while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { |
| possible($1, "C:" . $s); |
| } |
| |
| # Check for any sort of function declaration. |
| # int foo(something bar, other baz); |
| # void (*store_gdt)(x86_descr_ptr *); |
| if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { |
| my ($name_len) = length($1); |
| |
| my $ctx = $s; |
| substr($ctx, 0, $name_len + 1, ''); |
| $ctx =~ s/\)[^\)]*$//; |
| |
| for my $arg (split(/\s*,\s*/, $ctx)) { |
| if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { |
| |
| possible($1, "D:" . $s); |
| } |
| } |
| } |
| |
| } |
| |
| # |
| # Checks which may be anchored in the context. |
| # |
| |
| # Check for switch () and associated case and default |
| # statements should be at the same indent. |
| if ($line=~/\bswitch\s*\(.*\)/) { |
| my $err = ''; |
| my $sep = ''; |
| my @ctx = ctx_block_outer($linenr, $realcnt); |
| shift(@ctx); |
| for my $ctx (@ctx) { |
| my ($clen, $cindent) = line_stats($ctx); |
| if ($ctx =~ /^\+\s*(case\s+|default:)/ && |
| $indent != $cindent) { |
| $err .= "$sep$ctx\n"; |
| $sep = ''; |
| } else { |
| $sep = "[...]\n"; |
| } |
| } |
| if ($err ne '') { |
| ERROR("SWITCH_CASE_INDENT_LEVEL", |
| "switch and case should be at the same indent\n$hereline$err"); |
| } |
| } |
| |
| # if/while/etc brace do not go on next line, unless defining a do while loop, |
| # or if that brace on the next line is for something else |
| if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { |
| my $pre_ctx = "$1$2"; |
| |
| my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); |
| |
| if ($line =~ /^\+\t{6,}/) { |
| WARN("DEEP_INDENTATION", |
| "Too many leading tabs - consider code refactoring\n" . $herecurr); |
| } |
| |
| my $ctx_cnt = $realcnt - $#ctx - 1; |
| my $ctx = join("\n", @ctx); |
| |
| my $ctx_ln = $linenr; |
| my $ctx_skip = $realcnt; |
| |
| while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && |
| defined $lines[$ctx_ln - 1] && |
| $lines[$ctx_ln - 1] =~ /^-/)) { |
| ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; |
| $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); |
| $ctx_ln++; |
| } |
| |
| #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; |
| #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; |
| |
| if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { |
| ERROR("OPEN_BRACE", |
| "that open brace { should be on the previous line\n" . |
| "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); |
| } |
| if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && |
| $ctx =~ /\)\s*\;\s*$/ && |
| defined $lines[$ctx_ln - 1]) |
| { |
| my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); |
| if ($nindent > $indent) { |
| WARN("TRAILING_SEMICOLON", |
| "trailing semicolon indicates no statements, indent implies otherwise\n" . |
| "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); |
| } |
| } |
| } |
| |
| # Check relative indent for conditionals and blocks. |
| 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); |
| my ($s, $c) = ($stat, $cond); |
| |
| substr($s, 0, length($c), ''); |
| |
| # remove inline comments |
| $s =~ s/$;/ /g; |
| $c =~ s/$;/ /g; |
| |
| # Find out how long the conditional actually is. |
| my @newlines = ($c =~ /\n/gs); |
| my $cond_lines = 1 + $#newlines; |
| |
| # Make sure we remove the line prefixes as we have |
| # none on the first line, and are going to readd them |
| # where necessary. |
| $s =~ s/\n./\n/gs; |
| while ($s =~ /\n\s+\\\n/) { |
| $cond_lines += $s =~ s/\n\s+\\\n/\n/g; |
| } |
| |
| # We want to check the first line inside the block |
| # starting at the end of the conditional, so remove: |
| # 1) any blank line termination |
| # 2) any opening brace { on end of the line |
| # 3) any do (...) { |
| my $continuation = 0; |
| my $check = 0; |
| $s =~ s/^.*\bdo\b//; |
| $s =~ s/^\s*{//; |
| if ($s =~ s/^\s*\\//) { |
| $continuation = 1; |
| } |
| if ($s =~ s/^\s*?\n//) { |
| $check = 1; |
| $cond_lines++; |
| } |
| |
| # Also ignore a loop construct at the end of a |
| # preprocessor statement. |
| if (($prevline =~ /^.\s*#\s*define\s/ || |
| $prevline =~ /\\\s*$/) && $continuation == 0) { |
| $check = 0; |
| } |
| |
| my $cond_ptr = -1; |
| $continuation = 0; |
| while ($cond_ptr != $cond_lines) { |
| $cond_ptr = $cond_lines; |
| |
| # If we see an #else/#elif then the code |
| # is not linear. |
| if ($s =~ /^\s*\#\s*(?:else|elif)/) { |
| $check = 0; |
| } |
| |
| # Ignore: |
| # 1) blank lines, they should be at 0, |
| # 2) preprocessor lines, and |
| # 3) labels. |
| if ($continuation || |
| $s =~ /^\s*?\n/ || |
| $s =~ /^\s*#\s*?/ || |
| $s =~ /^\s*$Ident\s*:/) { |
| $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; |
| if ($s =~ s/^.*?\n//) { |
| $cond_lines++; |
| } |
| } |
| } |
| |
| my (undef, $sindent) = line_stats("+" . $s); |
| my $stat_real = raw_line($linenr, $cond_lines); |
| |
| # Check if either of these lines are modified, else |
| # this is not this patch's fault. |
| if (!defined($stat_real) || |
| $stat !~ /^\+/ && $stat_real !~ /^\+/) { |
| $check = 0; |
| } |
| if (defined($stat_real) && $cond_lines > 1) { |
| $stat_real = "[...]\n$stat_real"; |
| } |
| |
| #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"; |
| |
| if ($check && $s ne '' && |
| (($sindent % $tabsize) != 0 || |
| ($sindent < $indent) || |
| ($sindent == $indent && |
| ($s !~ /^\s*(?:\}|\{|else\b)/)) || |
| ($sindent > $indent + $tabsize))) { |
| WARN("SUSPECT_CODE_INDENT", |
| "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); |
| } |
| } |
| |
| # Track the 'values' across context and added lines. |
| my $opline = $line; $opline =~ s/^./ /; |
| my ($curr_values, $curr_vars) = |
| annotate_values($opline . "\n", $prev_values); |
| $curr_values = $prev_values . $curr_values; |
| if ($dbg_values) { |
| my $outline = $opline; $outline =~ s/\t/ /g; |
| print "$linenr > .$outline\n"; |
| print "$linenr > $curr_values\n"; |
| print "$linenr > $curr_vars\n"; |
| } |
| $prev_values = substr($curr_values, -1); |
| |
| #ignore lines not being added |
| next if ($line =~ /^[^\+]/); |
| |
| # check for self assignments used to avoid compiler warnings |
| # e.g.: int foo = foo, *bar = NULL; |
| # struct foo bar = *(&(bar)); |
| if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) { |
| my $var = $1; |
| if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) { |
| WARN("SELF_ASSIGNMENT", |
| "Do not use self-assignments to avoid compiler warnings\n" . $herecurr); |
| } |
| } |
| |
| # check for dereferences that span multiple lines |
| if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && |
| $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { |
| $prevline =~ /($Lval\s*(?:\.|->))\s*$/; |
| my $ref = $1; |
| $line =~ /^.\s*($Lval)/; |
| $ref .= $1; |
| $ref =~ s/\s//g; |
| WARN("MULTILINE_DEREFERENCE", |
| "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); |
| } |
| |
| # check for declarations of signed or unsigned without int |
| while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { |
| my $type = $1; |
| my $var = $2; |
| $var = "" if (!defined $var); |
| if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { |
| my $sign = $1; |
| my $pointer = $2; |
| |
| $pointer = "" if (!defined $pointer); |
| |
| if (WARN("UNSPECIFIED_INT", |
| "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && |
| $fix) { |
| my $decl = trim($sign) . " int "; |
| my $comp_pointer = $pointer; |
| $comp_pointer =~ s/\s//g; |
| $decl .= $comp_pointer; |
| $decl = rtrim($decl) if ($var eq ""); |
| $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; |
| } |
|