1cb77f0d6SKamil Rytarowski#!/usr/bin/env perl 2882ea1d6SJoe Perches# SPDX-License-Identifier: GPL-2.0 3882ea1d6SJoe Perches# 4dbf004d7SDave Jones# (c) 2001, Dave Jones. (the file handling bit) 500df344fSAndy Whitcroft# (c) 2005, Joel Schopp <[email protected]> (the ugly bit) 62a5a2c25SAndy Whitcroft# (c) 2007,2008, Andy Whitcroft <[email protected]> (new conditions, test suite) 7015830beSAndy Whitcroft# (c) 2008-2010 Andy Whitcroft <[email protected]> 8882ea1d6SJoe Perches# (c) 2010-2018 Joe Perches <[email protected]> 90a920b5bSAndy Whitcroft 100a920b5bSAndy Whitcroftuse strict; 11cb77f0d6SKamil Rytarowskiuse warnings; 12c707a81dSJoe Perchesuse POSIX; 1336061e38SJoe Perchesuse File::Basename; 1436061e38SJoe Perchesuse Cwd 'abs_path'; 1557230297SJoe Perchesuse Term::ANSIColor qw(:constants); 16cd261496SGeert Uytterhoevenuse Encode qw(decode encode); 170a920b5bSAndy Whitcroft 180a920b5bSAndy Whitcroftmy $P = $0; 1936061e38SJoe Perchesmy $D = dirname(abs_path($P)); 200a920b5bSAndy Whitcroft 21000d1cc1SJoe Perchesmy $V = '0.32'; 220a920b5bSAndy Whitcroft 230a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 240a920b5bSAndy Whitcroft 250a920b5bSAndy Whitcroftmy $quiet = 0; 2652178ce0SDwaipayan Raymy $verbose = 0; 2752178ce0SDwaipayan Raymy %verbose_messages = (); 2852178ce0SDwaipayan Raymy %verbose_emitted = (); 290a920b5bSAndy Whitcroftmy $tree = 1; 300a920b5bSAndy Whitcroftmy $chk_signoff = 1; 310a920b5bSAndy Whitcroftmy $chk_patch = 1; 32773647a0SAndy Whitcroftmy $tst_only; 336c72ffaaSAndy Whitcroftmy $emacs = 0; 348905a67cSAndy Whitcroftmy $terse = 0; 3534d8815fSJoe Perchesmy $showfile = 0; 366c72ffaaSAndy Whitcroftmy $file = 0; 374a593c34SDu, Changbinmy $git = 0; 380dea9f1eSJoe Perchesmy %git_commits = (); 396c72ffaaSAndy Whitcroftmy $check = 0; 402ac73b4fSJoe Perchesmy $check_orig = 0; 418905a67cSAndy Whitcroftmy $summary = 1; 428905a67cSAndy Whitcroftmy $mailback = 0; 4313214adfSAndy Whitcroftmy $summary_file = 0; 44000d1cc1SJoe Perchesmy $show_types = 0; 453beb42ecSJoe Perchesmy $list_types = 0; 463705ce5bSJoe Perchesmy $fix = 0; 479624b8d6SJoe Perchesmy $fix_inplace = 0; 486c72ffaaSAndy Whitcroftmy $root; 490f7f635bSJoe Perchesmy $gitroot = $ENV{'GIT_DIR'}; 500f7f635bSJoe Perches$gitroot = ".git" if !defined($gitroot); 51c2fdda0dSAndy Whitcroftmy %debug; 523445686aSJoe Perchesmy %camelcase = (); 5391bfe484SJoe Perchesmy %use_type = (); 5491bfe484SJoe Perchesmy @use = (); 5591bfe484SJoe Perchesmy %ignore_type = (); 56000d1cc1SJoe Perchesmy @ignore = (); 5777f5b10aSHannes Edermy $help = 0; 58000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 59bdc48fa1SJoe Perchesmy $max_line_length = 100; 60d62a201fSDave Hansenmy $ignore_perl_version = 0; 61d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 6256193274SVadim Bendeburymy $min_conf_desc_length = 4; 6366b47b4aSKees Cookmy $spelling_file = "$D/spelling.txt"; 64ebfd7d62SJoe Perchesmy $codespell = 0; 65f1a63678SMaxim Uvarovmy $codespellfile = "/usr/share/codespell/dictionary.txt"; 660ee3e7b8SPeter Ujfalusimy $user_codespellfile = ""; 67bf1fa1daSJoe Perchesmy $conststructsfile = "$D/const_structs.checkpatch"; 6852178ce0SDwaipayan Raymy $docsfile = "$D/../Documentation/dev-tools/checkpatch.rst"; 69ced69da1SQuentin Monnetmy $typedefsfile; 70737c0767SJohn Brooksmy $color = "auto"; 7198005e8cSVadim Bendeburymy $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE 72dbbf869dSJoe Perches# git output parsing needs US English output, so first set backtick child process LANGUAGE 73dbbf869dSJoe Perchesmy $git_command ='export LANGUAGE=en_US.UTF-8; git'; 74713a09deSAntonio Borneomy $tabsize = 8; 753e89ad85SJerome Forissiermy ${CONFIG_} = "CONFIG_"; 7677f5b10aSHannes Eder 7777f5b10aSHannes Edersub help { 7877f5b10aSHannes Eder my ($exitcode) = @_; 7977f5b10aSHannes Eder 8077f5b10aSHannes Eder print << "EOM"; 8177f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 8277f5b10aSHannes EderVersion: $V 8377f5b10aSHannes Eder 8477f5b10aSHannes EderOptions: 8577f5b10aSHannes Eder -q, --quiet quiet 8652178ce0SDwaipayan Ray -v, --verbose verbose mode 8777f5b10aSHannes Eder --no-tree run without a kernel tree 8877f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 8977f5b10aSHannes Eder --patch treat FILE as patchfile (default) 9077f5b10aSHannes Eder --emacs emacs compile window format 9177f5b10aSHannes Eder --terse one line per report 9234d8815fSJoe Perches --showfile emit diffed file position, not input file position 934a593c34SDu, Changbin -g, --git treat FILE as a single commit or git revision range 944a593c34SDu, Changbin single git commit with: 954a593c34SDu, Changbin <rev> 964a593c34SDu, Changbin <rev>^ 974a593c34SDu, Changbin <rev>~n 984a593c34SDu, Changbin multiple git commits with: 994a593c34SDu, Changbin <rev1>..<rev2> 1004a593c34SDu, Changbin <rev1>...<rev2> 1014a593c34SDu, Changbin <rev>-<count> 1024a593c34SDu, Changbin git merges are ignored 10377f5b10aSHannes Eder -f, --file treat FILE as regular source file 10477f5b10aSHannes Eder --subjective, --strict enable more subjective tests 1053beb42ecSJoe Perches --list-types list the possible message types 10691bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 107000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 1083beb42ecSJoe Perches --show-types show the specific message type in the output 109bdc48fa1SJoe Perches --max-line-length=n set the maximum line length, (default $max_line_length) 110bdc48fa1SJoe Perches if exceeded, warn on patches 111bdc48fa1SJoe Perches requires --strict for use with --file 11256193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 113bdc48fa1SJoe Perches --tab-size=n set the number of spaces for tab (default $tabsize) 11477f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 11577f5b10aSHannes Eder --no-summary suppress the per-file summary 11677f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 11777f5b10aSHannes Eder --summary-file include the filename in summary 11877f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 11977f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 12077f5b10aSHannes Eder is all off) 12177f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 12277f5b10aSHannes Eder literally 1233705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 1243705ce5bSJoe Perches If correctable single-line errors exist, create 1253705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 1263705ce5bSJoe Perches with potential errors corrected to the preferred 1273705ce5bSJoe Perches checkpatch style 1289624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 1299624b8d6SJoe Perches Is the same as --fix, but overwrites the input 1309624b8d6SJoe Perches file. It's your fault if there's no backup or git 131d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 132d62a201fSDave Hansen runtime errors. 133ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 1340ee3e7b8SPeter Ujfalusi (default:$codespellfile) 135ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 13675ad8c57SJerome Forissier --typedefsfile Read additional types from this file 137737c0767SJohn Brooks --color[=WHEN] Use colors 'always', 'never', or only when output 138737c0767SJohn Brooks is a terminal ('auto'). Default is 'auto'. 1393e89ad85SJerome Forissier --kconfig-prefix=WORD use WORD as a prefix for Kconfig symbols (default 1403e89ad85SJerome Forissier ${CONFIG_}) 14177f5b10aSHannes Eder -h, --help, --version display this help and exit 14277f5b10aSHannes Eder 14377f5b10aSHannes EderWhen FILE is - read standard input. 14477f5b10aSHannes EderEOM 14577f5b10aSHannes Eder 14677f5b10aSHannes Eder exit($exitcode); 14777f5b10aSHannes Eder} 14877f5b10aSHannes Eder 1493beb42ecSJoe Perchessub uniq { 1503beb42ecSJoe Perches my %seen; 1513beb42ecSJoe Perches return grep { !$seen{$_}++ } @_; 1523beb42ecSJoe Perches} 1533beb42ecSJoe Perches 1543beb42ecSJoe Perchessub list_types { 1553beb42ecSJoe Perches my ($exitcode) = @_; 1563beb42ecSJoe Perches 1573beb42ecSJoe Perches my $count = 0; 1583beb42ecSJoe Perches 1593beb42ecSJoe Perches local $/ = undef; 1603beb42ecSJoe Perches 1613beb42ecSJoe Perches open(my $script, '<', abs_path($P)) or 1623beb42ecSJoe Perches die "$P: Can't read '$P' $!\n"; 1633beb42ecSJoe Perches 1643beb42ecSJoe Perches my $text = <$script>; 1653beb42ecSJoe Perches close($script); 1663beb42ecSJoe Perches 16752178ce0SDwaipayan Ray my %types = (); 1680547fa58SJean Delvare # Also catch when type or level is passed through a variable 16952178ce0SDwaipayan Ray while ($text =~ /(?:(\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) { 17052178ce0SDwaipayan Ray if (defined($1)) { 17152178ce0SDwaipayan Ray if (exists($types{$2})) { 17252178ce0SDwaipayan Ray $types{$2} .= ",$1" if ($types{$2} ne $1); 17352178ce0SDwaipayan Ray } else { 17452178ce0SDwaipayan Ray $types{$2} = $1; 1753beb42ecSJoe Perches } 17652178ce0SDwaipayan Ray } else { 17752178ce0SDwaipayan Ray $types{$2} = "UNDETERMINED"; 17852178ce0SDwaipayan Ray } 17952178ce0SDwaipayan Ray } 18052178ce0SDwaipayan Ray 1813beb42ecSJoe Perches print("#\tMessage type\n\n"); 18252178ce0SDwaipayan Ray if ($color) { 18352178ce0SDwaipayan Ray print(" ( Color coding: "); 18452178ce0SDwaipayan Ray print(RED . "ERROR" . RESET); 18552178ce0SDwaipayan Ray print(" | "); 18652178ce0SDwaipayan Ray print(YELLOW . "WARNING" . RESET); 18752178ce0SDwaipayan Ray print(" | "); 18852178ce0SDwaipayan Ray print(GREEN . "CHECK" . RESET); 18952178ce0SDwaipayan Ray print(" | "); 19052178ce0SDwaipayan Ray print("Multiple levels / Undetermined"); 19152178ce0SDwaipayan Ray print(" )\n\n"); 19252178ce0SDwaipayan Ray } 19352178ce0SDwaipayan Ray 19452178ce0SDwaipayan Ray foreach my $type (sort keys %types) { 19552178ce0SDwaipayan Ray my $orig_type = $type; 19652178ce0SDwaipayan Ray if ($color) { 19752178ce0SDwaipayan Ray my $level = $types{$type}; 19852178ce0SDwaipayan Ray if ($level eq "ERROR") { 19952178ce0SDwaipayan Ray $type = RED . $type . RESET; 20052178ce0SDwaipayan Ray } elsif ($level eq "WARN") { 20152178ce0SDwaipayan Ray $type = YELLOW . $type . RESET; 20252178ce0SDwaipayan Ray } elsif ($level eq "CHK") { 20352178ce0SDwaipayan Ray $type = GREEN . $type . RESET; 20452178ce0SDwaipayan Ray } 20552178ce0SDwaipayan Ray } 2063beb42ecSJoe Perches print(++$count . "\t" . $type . "\n"); 20752178ce0SDwaipayan Ray if ($verbose && exists($verbose_messages{$orig_type})) { 20852178ce0SDwaipayan Ray my $message = $verbose_messages{$orig_type}; 20952178ce0SDwaipayan Ray $message =~ s/\n/\n\t/g; 21052178ce0SDwaipayan Ray print("\t" . $message . "\n\n"); 21152178ce0SDwaipayan Ray } 2123beb42ecSJoe Perches } 2133beb42ecSJoe Perches 2143beb42ecSJoe Perches exit($exitcode); 2153beb42ecSJoe Perches} 2163beb42ecSJoe Perches 217000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 218000d1cc1SJoe Perchesif (-f $conf) { 219000d1cc1SJoe Perches my @conf_args; 220000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 221000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 222000d1cc1SJoe Perches 223000d1cc1SJoe Perches while (<$conffile>) { 224000d1cc1SJoe Perches my $line = $_; 225000d1cc1SJoe Perches 226000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 227000d1cc1SJoe Perches $line =~ s/^\s*//g; 228000d1cc1SJoe Perches $line =~ s/\s+/ /g; 229000d1cc1SJoe Perches 230000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 231000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 232000d1cc1SJoe Perches 233000d1cc1SJoe Perches my @words = split(" ", $line); 234000d1cc1SJoe Perches foreach my $word (@words) { 235000d1cc1SJoe Perches last if ($word =~ m/^#/); 236000d1cc1SJoe Perches push (@conf_args, $word); 237000d1cc1SJoe Perches } 238000d1cc1SJoe Perches } 239000d1cc1SJoe Perches close($conffile); 240000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 241000d1cc1SJoe Perches} 242000d1cc1SJoe Perches 24352178ce0SDwaipayan Raysub load_docs { 24452178ce0SDwaipayan Ray open(my $docs, '<', "$docsfile") 24552178ce0SDwaipayan Ray or warn "$P: Can't read the documentation file $docsfile $!\n"; 24652178ce0SDwaipayan Ray 24752178ce0SDwaipayan Ray my $type = ''; 24852178ce0SDwaipayan Ray my $desc = ''; 24952178ce0SDwaipayan Ray my $in_desc = 0; 25052178ce0SDwaipayan Ray 25152178ce0SDwaipayan Ray while (<$docs>) { 25252178ce0SDwaipayan Ray chomp; 25352178ce0SDwaipayan Ray my $line = $_; 25452178ce0SDwaipayan Ray $line =~ s/\s+$//; 25552178ce0SDwaipayan Ray 25652178ce0SDwaipayan Ray if ($line =~ /^\s*\*\*(.+)\*\*$/) { 25752178ce0SDwaipayan Ray if ($desc ne '') { 25852178ce0SDwaipayan Ray $verbose_messages{$type} = trim($desc); 25952178ce0SDwaipayan Ray } 26052178ce0SDwaipayan Ray $type = $1; 26152178ce0SDwaipayan Ray $desc = ''; 26252178ce0SDwaipayan Ray $in_desc = 1; 26352178ce0SDwaipayan Ray } elsif ($in_desc) { 26452178ce0SDwaipayan Ray if ($line =~ /^(?:\s{4,}|$)/) { 26552178ce0SDwaipayan Ray $line =~ s/^\s{4}//; 26652178ce0SDwaipayan Ray $desc .= $line; 26752178ce0SDwaipayan Ray $desc .= "\n"; 26852178ce0SDwaipayan Ray } else { 26952178ce0SDwaipayan Ray $verbose_messages{$type} = trim($desc); 27052178ce0SDwaipayan Ray $type = ''; 27152178ce0SDwaipayan Ray $desc = ''; 27252178ce0SDwaipayan Ray $in_desc = 0; 27352178ce0SDwaipayan Ray } 27452178ce0SDwaipayan Ray } 27552178ce0SDwaipayan Ray } 27652178ce0SDwaipayan Ray 27752178ce0SDwaipayan Ray if ($desc ne '') { 27852178ce0SDwaipayan Ray $verbose_messages{$type} = trim($desc); 27952178ce0SDwaipayan Ray } 28052178ce0SDwaipayan Ray close($docs); 28152178ce0SDwaipayan Ray} 28252178ce0SDwaipayan Ray 283737c0767SJohn Brooks# Perl's Getopt::Long allows options to take optional arguments after a space. 284737c0767SJohn Brooks# Prevent --color by itself from consuming other arguments 285737c0767SJohn Brooksforeach (@ARGV) { 286737c0767SJohn Brooks if ($_ eq "--color" || $_ eq "-color") { 287737c0767SJohn Brooks $_ = "--color=$color"; 288737c0767SJohn Brooks } 289737c0767SJohn Brooks} 290737c0767SJohn Brooks 2910a920b5bSAndy WhitcroftGetOptions( 2926c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 29352178ce0SDwaipayan Ray 'v|verbose!' => \$verbose, 2940a920b5bSAndy Whitcroft 'tree!' => \$tree, 2950a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 2960a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 2976c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 2988905a67cSAndy Whitcroft 'terse!' => \$terse, 29934d8815fSJoe Perches 'showfile!' => \$showfile, 30077f5b10aSHannes Eder 'f|file!' => \$file, 3014a593c34SDu, Changbin 'g|git!' => \$git, 3026c72ffaaSAndy Whitcroft 'subjective!' => \$check, 3036c72ffaaSAndy Whitcroft 'strict!' => \$check, 304000d1cc1SJoe Perches 'ignore=s' => \@ignore, 30591bfe484SJoe Perches 'types=s' => \@use, 306000d1cc1SJoe Perches 'show-types!' => \$show_types, 3073beb42ecSJoe Perches 'list-types!' => \$list_types, 3086cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 30956193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 310713a09deSAntonio Borneo 'tab-size=i' => \$tabsize, 3116c72ffaaSAndy Whitcroft 'root=s' => \$root, 3128905a67cSAndy Whitcroft 'summary!' => \$summary, 3138905a67cSAndy Whitcroft 'mailback!' => \$mailback, 31413214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 3153705ce5bSJoe Perches 'fix!' => \$fix, 3169624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 317d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 318c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 319773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 320ebfd7d62SJoe Perches 'codespell!' => \$codespell, 3210ee3e7b8SPeter Ujfalusi 'codespellfile=s' => \$user_codespellfile, 32275ad8c57SJerome Forissier 'typedefsfile=s' => \$typedefsfile, 323737c0767SJohn Brooks 'color=s' => \$color, 324737c0767SJohn Brooks 'no-color' => \$color, #keep old behaviors of -nocolor 325737c0767SJohn Brooks 'nocolor' => \$color, #keep old behaviors of -nocolor 3263e89ad85SJerome Forissier 'kconfig-prefix=s' => \${CONFIG_}, 32777f5b10aSHannes Eder 'h|help' => \$help, 32877f5b10aSHannes Eder 'version' => \$help 3290ee3e7b8SPeter Ujfalusi) or $help = 2; 33077f5b10aSHannes Eder 3310ee3e7b8SPeter Ujfalusiif ($user_codespellfile) { 3320ee3e7b8SPeter Ujfalusi # Use the user provided codespell file unconditionally 3330ee3e7b8SPeter Ujfalusi $codespellfile = $user_codespellfile; 3340ee3e7b8SPeter Ujfalusi} elsif (!(-f $codespellfile)) { 3350ee3e7b8SPeter Ujfalusi # If /usr/share/codespell/dictionary.txt is not present, try to find it 3360ee3e7b8SPeter Ujfalusi # under codespell's install directory: <codespell_root>/data/dictionary.txt 337c882c6b1SSagar Patel if (($codespell || $help) && which("python3") ne "") { 3380ee3e7b8SPeter Ujfalusi my $python_codespell_dict = << "EOF"; 3390ee3e7b8SPeter Ujfalusi 3400ee3e7b8SPeter Ujfalusiimport os.path as op 3410ee3e7b8SPeter Ujfalusiimport codespell_lib 3420ee3e7b8SPeter Ujfalusicodespell_dir = op.dirname(codespell_lib.__file__) 3430ee3e7b8SPeter Ujfalusicodespell_file = op.join(codespell_dir, 'data', 'dictionary.txt') 3440ee3e7b8SPeter Ujfalusiprint(codespell_file, end='') 3450ee3e7b8SPeter UjfalusiEOF 3460ee3e7b8SPeter Ujfalusi 347c882c6b1SSagar Patel my $codespell_dict = `python3 -c "$python_codespell_dict" 2> /dev/null`; 3480ee3e7b8SPeter Ujfalusi $codespellfile = $codespell_dict if (-f $codespell_dict); 3490ee3e7b8SPeter Ujfalusi } 3500ee3e7b8SPeter Ujfalusi} 3510ee3e7b8SPeter Ujfalusi 3520ee3e7b8SPeter Ujfalusi# $help is 1 if either -h, --help or --version is passed as option - exitcode: 0 3530ee3e7b8SPeter Ujfalusi# $help is 2 if invalid option is passed - exitcode: 1 3540ee3e7b8SPeter Ujfalusihelp($help - 1) if ($help); 3550a920b5bSAndy Whitcroft 35652178ce0SDwaipayan Raydie "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix)); 35752178ce0SDwaipayan Raydie "$P: --verbose cannot be used with --terse\n" if ($verbose && $terse); 35852178ce0SDwaipayan Ray 35952178ce0SDwaipayan Rayif ($color =~ /^[01]$/) { 36052178ce0SDwaipayan Ray $color = !$color; 36152178ce0SDwaipayan Ray} elsif ($color =~ /^always$/i) { 36252178ce0SDwaipayan Ray $color = 1; 36352178ce0SDwaipayan Ray} elsif ($color =~ /^never$/i) { 36452178ce0SDwaipayan Ray $color = 0; 36552178ce0SDwaipayan Ray} elsif ($color =~ /^auto$/i) { 36652178ce0SDwaipayan Ray $color = (-t STDOUT); 36752178ce0SDwaipayan Ray} else { 36852178ce0SDwaipayan Ray die "$P: Invalid color mode: $color\n"; 36952178ce0SDwaipayan Ray} 37052178ce0SDwaipayan Ray 37152178ce0SDwaipayan Rayload_docs() if ($verbose); 3723beb42ecSJoe Percheslist_types(0) if ($list_types); 3733beb42ecSJoe Perches 3749624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 3752ac73b4fSJoe Perches$check_orig = $check; 3769624b8d6SJoe Perches 3770a920b5bSAndy Whitcroftmy $exit = 0; 3780a920b5bSAndy Whitcroft 3795b57980dSJoe Perchesmy $perl_version_ok = 1; 380d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 3815b57980dSJoe Perches $perl_version_ok = 0; 382d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 3835b57980dSJoe Perches exit(1) if (!$ignore_perl_version); 384d62a201fSDave Hansen} 385d62a201fSDave Hansen 38645107ff6SAllen Hubbe#if no filenames are given, push '-' to read patch from stdin 3870a920b5bSAndy Whitcroftif ($#ARGV < 0) { 38845107ff6SAllen Hubbe push(@ARGV, '-'); 3890a920b5bSAndy Whitcroft} 3900a920b5bSAndy Whitcroft 391713a09deSAntonio Borneo# skip TAB size 1 to avoid additional checks on $tabsize - 1 39232f30ca9SJoe Perchesdie "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2); 393713a09deSAntonio Borneo 39491bfe484SJoe Perchessub hash_save_array_words { 39591bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 39691bfe484SJoe Perches 39791bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 39891bfe484SJoe Perches foreach my $word (@array) { 399000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 400000d1cc1SJoe Perches $word =~ s/^\s*//g; 401000d1cc1SJoe Perches $word =~ s/\s+/ /g; 402000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 403000d1cc1SJoe Perches 404000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 405000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 406000d1cc1SJoe Perches 40791bfe484SJoe Perches $hashRef->{$word}++; 408000d1cc1SJoe Perches } 40991bfe484SJoe Perches} 41091bfe484SJoe Perches 41191bfe484SJoe Perchessub hash_show_words { 41291bfe484SJoe Perches my ($hashRef, $prefix) = @_; 41391bfe484SJoe Perches 4143c816e49SJoe Perches if (keys %$hashRef) { 415d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 41658cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 41791bfe484SJoe Perches print " $word"; 41891bfe484SJoe Perches } 419d8469f16SJoe Perches print "\n"; 42091bfe484SJoe Perches } 42191bfe484SJoe Perches} 42291bfe484SJoe Perches 42391bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 42491bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 425000d1cc1SJoe Perches 426c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 427c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 4287429c690SAndy Whitcroftmy $dbg_type = 0; 429a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 430c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 43121caa13cSAndy Whitcroft ## no critic 43221caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 43321caa13cSAndy Whitcroft die "$@" if ($@); 434c2fdda0dSAndy Whitcroft} 435c2fdda0dSAndy Whitcroft 436d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 437d2c0a235SAndy Whitcroft 4388905a67cSAndy Whitcroftif ($terse) { 4398905a67cSAndy Whitcroft $emacs = 1; 4408905a67cSAndy Whitcroft $quiet++; 4418905a67cSAndy Whitcroft} 4428905a67cSAndy Whitcroft 4436c72ffaaSAndy Whitcroftif ($tree) { 4446c72ffaaSAndy Whitcroft if (defined $root) { 4456c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 4466c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 4476c72ffaaSAndy Whitcroft } 4486c72ffaaSAndy Whitcroft } else { 4496c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 4506c72ffaaSAndy Whitcroft $root = '.'; 4516c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 4526c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 4536c72ffaaSAndy Whitcroft $root = $1; 4546c72ffaaSAndy Whitcroft } 4556c72ffaaSAndy Whitcroft } 4566c72ffaaSAndy Whitcroft 4576c72ffaaSAndy Whitcroft if (!defined $root) { 4580a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 4590a920b5bSAndy Whitcroft exit(2); 4600a920b5bSAndy Whitcroft } 4616c72ffaaSAndy Whitcroft} 4626c72ffaaSAndy Whitcroft 4636c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 4646c72ffaaSAndy Whitcroft 4652ceb532bSAndy Whitcroftour $Ident = qr{ 4662ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 4672ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 4682ceb532bSAndy Whitcroft }x; 4696c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 4706c72ffaaSAndy Whitcroftour $Sparse = qr{ 4716c72ffaaSAndy Whitcroft __user| 4726c72ffaaSAndy Whitcroft __kernel| 4736c72ffaaSAndy Whitcroft __force| 4746c72ffaaSAndy Whitcroft __iomem| 4756c72ffaaSAndy Whitcroft __must_check| 476417495edSAndy Whitcroft __kprobes| 477165e72a6SSven Eckelmann __ref| 47833aa4597SGeert Uytterhoeven __refconst| 47933aa4597SGeert Uytterhoeven __refdata| 480ad315455SBoqun Feng __rcu| 481ad315455SBoqun Feng __private 4826c72ffaaSAndy Whitcroft }x; 483e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 484e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 485e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 486e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 487e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 4888716de38SJoe Perches 48952131292SWolfram Sang# Notes to $Attribute: 49052131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 4916c72ffaaSAndy Whitcroftour $Attribute = qr{ 4926c72ffaaSAndy Whitcroft const| 493b5e8736aSJoe Perches volatile| 49403f1df7dSJoe Perches __percpu| 49503f1df7dSJoe Perches __nocast| 49603f1df7dSJoe Perches __safe| 49746d832f5SMichael S. Tsirkin __bitwise| 49803f1df7dSJoe Perches __packed__| 49903f1df7dSJoe Perches __packed2__| 50003f1df7dSJoe Perches __naked| 50103f1df7dSJoe Perches __maybe_unused| 50203f1df7dSJoe Perches __always_unused| 50303f1df7dSJoe Perches __noreturn| 50403f1df7dSJoe Perches __used| 50503f1df7dSJoe Perches __cold| 506e23ef1f3SJoe Perches __pure| 50703f1df7dSJoe Perches __noclone| 50803f1df7dSJoe Perches __deprecated| 5096c72ffaaSAndy Whitcroft __read_mostly| 510c5967e98SJoe Perches __ro_after_init| 5116c72ffaaSAndy Whitcroft __kprobes| 5128716de38SJoe Perches $InitAttribute| 51324e1d81aSAndy Whitcroft ____cacheline_aligned| 51424e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 5155fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 51686cffecdSKees Cook __weak| 51786cffecdSKees Cook __alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\) 5186c72ffaaSAndy Whitcroft }x; 519c45dcabdSAndy Whitcroftour $Modifier; 52091cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 5216c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 5226c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 5236c72ffaaSAndy Whitcroft 52495e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 52595e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 52695e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 52795e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 5282435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 529d2af5aa6SJoe Perchesour $String = qr{(?:\b[Lu])?"[X\t]*"}; 530326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 531326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 532326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 53374349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 5342435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 535326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 536447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 53723f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 5386c72ffaaSAndy Whitcroftour $Operators = qr{ 5396c72ffaaSAndy Whitcroft <=|>=|==|!=| 5406c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 54123f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 5426c72ffaaSAndy Whitcroft }x; 5436c72ffaaSAndy Whitcroft 54491cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 54591cb5195SJoe Perches 546ab7e23f3SJoe Perchesour $BasicType; 5478905a67cSAndy Whitcroftour $NonptrType; 5481813087dSJoe Perchesour $NonptrTypeMisordered; 5498716de38SJoe Perchesour $NonptrTypeWithAttr; 5508905a67cSAndy Whitcroftour $Type; 5511813087dSJoe Perchesour $TypeMisordered; 5528905a67cSAndy Whitcroftour $Declare; 5531813087dSJoe Perchesour $DeclareMisordered; 5548905a67cSAndy Whitcroft 55515662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 55615662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 557171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 558171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 559171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 560171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 561171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 562171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 563171ae1a4SAndy Whitcroft}x; 564171ae1a4SAndy Whitcroft 56515662b3eSJoe Perchesour $UTF8 = qr{ 56615662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 56715662b3eSJoe Perches | $NON_ASCII_UTF8 56815662b3eSJoe Perches}x; 56915662b3eSJoe Perches 570e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 571021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 572021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 573021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 574021158b4SJoe Perches)}; 575e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 576fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 5778ed22cadSAndy Whitcroft atomic_t 5788ed22cadSAndy Whitcroft)}; 5798ea0114eSMickaël Salaünour $typeStdioTypedefs = qr{(?x: 5808ea0114eSMickaël Salaün FILE 5818ea0114eSMickaël Salaün)}; 582e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 583e6176fa4SJoe Perches $typeC99Typedefs\b| 584e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 5858ea0114eSMickaël Salaün $typeKernelTypedefs\b| 5868ea0114eSMickaël Salaün $typeStdioTypedefs\b 587e6176fa4SJoe Perches)}; 5888ed22cadSAndy Whitcroft 5896d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 5906d32f7a3SJoe Perches 591691e669bSJoe Perchesour $logFunctions = qr{(?x: 592758d7aadSMiles Chen printk(?:_ratelimited|_once|_deferred_once|_deferred|)| 5937d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 59487bd499aSJoe Perches TP_printk| 5956e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 596b0531722SJoe Perches panic| 59706668727SJoe Perches MODULE_[A-Z_]+| 59806668727SJoe Perches seq_vprintf|seq_printf|seq_puts 599691e669bSJoe Perches)}; 600691e669bSJoe Perches 601e29a70f1SJoe Perchesour $allocFunctions = qr{(?x: 602e29a70f1SJoe Perches (?:(?:devm_)? 60358f02267SJoe Perches (?:kv|k|v)[czm]alloc(?:_array)?(?:_node)? | 604e29a70f1SJoe Perches kstrdup(?:_const)? | 605e29a70f1SJoe Perches kmemdup(?:_nul)?) | 606461e1565SChristophe JAILLET (?:\w+)?alloc_skb(?:_ip_align)? | 607e29a70f1SJoe Perches # dev_alloc_skb/netdev_alloc_skb, et al 608e29a70f1SJoe Perches dma_alloc_coherent 609e29a70f1SJoe Perches)}; 610e29a70f1SJoe Perches 61120112475SJoe Perchesour $signature_tags = qr{(?xi: 61220112475SJoe Perches Signed-off-by:| 613d499480cSJorge Ramirez-Ortiz Co-developed-by:| 61420112475SJoe Perches Acked-by:| 61520112475SJoe Perches Tested-by:| 61620112475SJoe Perches Reviewed-by:| 61720112475SJoe Perches Reported-by:| 6188543ae12SMugunthan V N Suggested-by:| 61920112475SJoe Perches To:| 62020112475SJoe Perches Cc: 62120112475SJoe Perches)}; 62220112475SJoe Perches 623adb2da82SJoe Perchesour $tracing_logging_tags = qr{(?xi: 624adb2da82SJoe Perches [=-]*> | 625adb2da82SJoe Perches <[=-]* | 626adb2da82SJoe Perches \[ | 627adb2da82SJoe Perches \] | 628adb2da82SJoe Perches start | 629adb2da82SJoe Perches called | 630adb2da82SJoe Perches entered | 631adb2da82SJoe Perches entry | 632adb2da82SJoe Perches enter | 633adb2da82SJoe Perches in | 634adb2da82SJoe Perches inside | 635adb2da82SJoe Perches here | 636adb2da82SJoe Perches begin | 637adb2da82SJoe Perches exit | 638adb2da82SJoe Perches end | 639adb2da82SJoe Perches done | 640adb2da82SJoe Perches leave | 641adb2da82SJoe Perches completed | 642adb2da82SJoe Perches out | 643adb2da82SJoe Perches return | 644adb2da82SJoe Perches [\.\!:\s]* 645adb2da82SJoe Perches)}; 646adb2da82SJoe Perches 647831242abSAditya Srivastavasub edit_distance_min { 648831242abSAditya Srivastava my (@arr) = @_; 649831242abSAditya Srivastava my $len = scalar @arr; 650831242abSAditya Srivastava if ((scalar @arr) < 1) { 651831242abSAditya Srivastava # if underflow, return 652831242abSAditya Srivastava return; 653831242abSAditya Srivastava } 654831242abSAditya Srivastava my $min = $arr[0]; 655831242abSAditya Srivastava for my $i (0 .. ($len-1)) { 656831242abSAditya Srivastava if ($arr[$i] < $min) { 657831242abSAditya Srivastava $min = $arr[$i]; 658831242abSAditya Srivastava } 659831242abSAditya Srivastava } 660831242abSAditya Srivastava return $min; 661831242abSAditya Srivastava} 662831242abSAditya Srivastava 663831242abSAditya Srivastavasub get_edit_distance { 664831242abSAditya Srivastava my ($str1, $str2) = @_; 665831242abSAditya Srivastava $str1 = lc($str1); 666831242abSAditya Srivastava $str2 = lc($str2); 667831242abSAditya Srivastava $str1 =~ s/-//g; 668831242abSAditya Srivastava $str2 =~ s/-//g; 669831242abSAditya Srivastava my $len1 = length($str1); 670831242abSAditya Srivastava my $len2 = length($str2); 671831242abSAditya Srivastava # two dimensional array storing minimum edit distance 672831242abSAditya Srivastava my @distance; 673831242abSAditya Srivastava for my $i (0 .. $len1) { 674831242abSAditya Srivastava for my $j (0 .. $len2) { 675831242abSAditya Srivastava if ($i == 0) { 676831242abSAditya Srivastava $distance[$i][$j] = $j; 677831242abSAditya Srivastava } elsif ($j == 0) { 678831242abSAditya Srivastava $distance[$i][$j] = $i; 679831242abSAditya Srivastava } elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) { 680831242abSAditya Srivastava $distance[$i][$j] = $distance[$i - 1][$j - 1]; 681831242abSAditya Srivastava } else { 682831242abSAditya Srivastava my $dist1 = $distance[$i][$j - 1]; #insert distance 683831242abSAditya Srivastava my $dist2 = $distance[$i - 1][$j]; # remove 684831242abSAditya Srivastava my $dist3 = $distance[$i - 1][$j - 1]; #replace 685831242abSAditya Srivastava $distance[$i][$j] = 1 + edit_distance_min($dist1, $dist2, $dist3); 686831242abSAditya Srivastava } 687831242abSAditya Srivastava } 688831242abSAditya Srivastava } 689831242abSAditya Srivastava return $distance[$len1][$len2]; 690831242abSAditya Srivastava} 691831242abSAditya Srivastava 692831242abSAditya Srivastavasub find_standard_signature { 693831242abSAditya Srivastava my ($sign_off) = @_; 694831242abSAditya Srivastava my @standard_signature_tags = ( 695831242abSAditya Srivastava 'Signed-off-by:', 'Co-developed-by:', 'Acked-by:', 'Tested-by:', 696831242abSAditya Srivastava 'Reviewed-by:', 'Reported-by:', 'Suggested-by:' 697831242abSAditya Srivastava ); 698831242abSAditya Srivastava foreach my $signature (@standard_signature_tags) { 699831242abSAditya Srivastava return $signature if (get_edit_distance($sign_off, $signature) <= 2); 700831242abSAditya Srivastava } 701831242abSAditya Srivastava 702831242abSAditya Srivastava return ""; 703831242abSAditya Srivastava} 704831242abSAditya Srivastava 7059b71f79fSBjorn Helgaasour $obsolete_archives = qr{(?xi: 7069b71f79fSBjorn Helgaas \Qfreedesktop.org/archives/dri-devel\E | 7079b71f79fSBjorn Helgaas \Qlists.infradead.org\E | 7089b71f79fSBjorn Helgaas \Qlkml.org\E | 7099b71f79fSBjorn Helgaas \Qmail-archive.com\E | 7109b71f79fSBjorn Helgaas \Qmailman.alsa-project.org/pipermail\E | 7119b71f79fSBjorn Helgaas \Qmarc.info\E | 7129b71f79fSBjorn Helgaas \Qozlabs.org/pipermail\E | 7139b71f79fSBjorn Helgaas \Qspinics.net\E 7149b71f79fSBjorn Helgaas)}; 7159b71f79fSBjorn Helgaas 7161813087dSJoe Perchesour @typeListMisordered = ( 7171813087dSJoe Perches qr{char\s+(?:un)?signed}, 7181813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 7191813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 7201813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 7211813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 7221813087dSJoe Perches qr{short\s+(?:un)?signed}, 7231813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 7241813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 7251813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 7261813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 7271813087dSJoe Perches qr{int\s+(?:un)?signed}, 7281813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 7291813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 7301813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 7311813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 7321813087dSJoe Perches qr{long\s+(?:un)?signed}, 7331813087dSJoe Perches); 7341813087dSJoe Perches 7358905a67cSAndy Whitcroftour @typeList = ( 7368905a67cSAndy Whitcroft qr{void}, 7370c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 7380c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 7390c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 7400c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 7410c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 7420c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 7430c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 7440c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 7450c773d9dSJoe Perches qr{(?:un)?signed}, 7468905a67cSAndy Whitcroft qr{float}, 7478905a67cSAndy Whitcroft qr{double}, 7488905a67cSAndy Whitcroft qr{bool}, 7498905a67cSAndy Whitcroft qr{struct\s+$Ident}, 7508905a67cSAndy Whitcroft qr{union\s+$Ident}, 7518905a67cSAndy Whitcroft qr{enum\s+$Ident}, 7528905a67cSAndy Whitcroft qr{${Ident}_t}, 7538905a67cSAndy Whitcroft qr{${Ident}_handler}, 7548905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 7551813087dSJoe Perches @typeListMisordered, 7568905a67cSAndy Whitcroft); 757938224b5SJoe Perches 758938224b5SJoe Perchesour $C90_int_types = qr{(?x: 759938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 760938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 761938224b5SJoe Perches long\s+long\s+(?:un)?signed| 762938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 763938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 764938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 765938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 766938224b5SJoe Perches 767938224b5SJoe Perches long\s+int\s+(?:un)?signed| 768938224b5SJoe Perches long\s+(?:un)?signed\s+int| 769938224b5SJoe Perches long\s+(?:un)?signed| 770938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 771938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 772938224b5SJoe Perches int\s+long\s+(?:un)?signed| 773938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 774938224b5SJoe Perches 775938224b5SJoe Perches int\s+(?:un)?signed| 776938224b5SJoe Perches (?:(?:un)?signed\s+)?int 777938224b5SJoe Perches)}; 778938224b5SJoe Perches 779485ff23eSAlex Dowadour @typeListFile = (); 7808716de38SJoe Perchesour @typeListWithAttr = ( 7818716de38SJoe Perches @typeList, 7828716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 7838716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 7848716de38SJoe Perches); 7858716de38SJoe Perches 786c45dcabdSAndy Whitcroftour @modifierList = ( 787c45dcabdSAndy Whitcroft qr{fastcall}, 788c45dcabdSAndy Whitcroft); 789485ff23eSAlex Dowadour @modifierListFile = (); 7908905a67cSAndy Whitcroft 7912435880fSJoe Perchesour @mode_permission_funcs = ( 7922435880fSJoe Perches ["module_param", 3], 7932435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 7942435880fSJoe Perches ["module_param_array_named", 5], 7952435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 7962435880fSJoe Perches ["proc_create(?:_data|)", 2], 797459cf0aeSJoe Perches ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2], 798459cf0aeSJoe Perches ["IIO_DEV_ATTR_[A-Z_]+", 1], 799459cf0aeSJoe Perches ["SENSOR_(?:DEVICE_|)ATTR_2", 2], 800459cf0aeSJoe Perches ["SENSOR_TEMPLATE(?:_2|)", 3], 801459cf0aeSJoe Perches ["__ATTR", 2], 8022435880fSJoe Perches); 8032435880fSJoe Perches 8041a3dcf2eSJoe Perchesmy $word_pattern = '\b[A-Z]?[a-z]{2,}\b'; 8051a3dcf2eSJoe Perches 806515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 807515a235eSJoe Perchesour $mode_perms_search = ""; 808515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 809515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 810515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 811515a235eSJoe Perches} 81200180468SJoe Perches$mode_perms_search = "(?:${mode_perms_search})"; 813515a235eSJoe Perches 8149189c7e7SJoe Perchesour %deprecated_apis = ( 8159189c7e7SJoe Perches "synchronize_rcu_bh" => "synchronize_rcu", 8169189c7e7SJoe Perches "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited", 8179189c7e7SJoe Perches "call_rcu_bh" => "call_rcu", 8189189c7e7SJoe Perches "rcu_barrier_bh" => "rcu_barrier", 8199189c7e7SJoe Perches "synchronize_sched" => "synchronize_rcu", 8209189c7e7SJoe Perches "synchronize_sched_expedited" => "synchronize_rcu_expedited", 8219189c7e7SJoe Perches "call_rcu_sched" => "call_rcu", 8229189c7e7SJoe Perches "rcu_barrier_sched" => "rcu_barrier", 8239189c7e7SJoe Perches "get_state_synchronize_sched" => "get_state_synchronize_rcu", 8249189c7e7SJoe Perches "cond_synchronize_sched" => "cond_synchronize_rcu", 825defdaff1SIra Weiny "kmap" => "kmap_local_page", 826a3ea42ffSIra Weiny "kunmap" => "kunmap_local", 827defdaff1SIra Weiny "kmap_atomic" => "kmap_local_page", 828a3ea42ffSIra Weiny "kunmap_atomic" => "kunmap_local", 8299189c7e7SJoe Perches); 8309189c7e7SJoe Perches 8319189c7e7SJoe Perches#Create a search pattern for all these strings to speed up a loop below 8329189c7e7SJoe Perchesour $deprecated_apis_search = ""; 8339189c7e7SJoe Perchesforeach my $entry (keys %deprecated_apis) { 8349189c7e7SJoe Perches $deprecated_apis_search .= '|' if ($deprecated_apis_search ne ""); 8359189c7e7SJoe Perches $deprecated_apis_search .= $entry; 8369189c7e7SJoe Perches} 8379189c7e7SJoe Perches$deprecated_apis_search = "(?:${deprecated_apis_search})"; 8389189c7e7SJoe Perches 839b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 840b392c64fSJoe Perches S_IWUGO | 841b392c64fSJoe Perches S_IWOTH | 842b392c64fSJoe Perches S_IRWXUGO | 843b392c64fSJoe Perches S_IALLUGO | 844b392c64fSJoe Perches 0[0-7][0-7][2367] 845b392c64fSJoe Perches}x; 846b392c64fSJoe Perches 847f90774e1SJoe Perchesour %mode_permission_string_types = ( 848f90774e1SJoe Perches "S_IRWXU" => 0700, 849f90774e1SJoe Perches "S_IRUSR" => 0400, 850f90774e1SJoe Perches "S_IWUSR" => 0200, 851f90774e1SJoe Perches "S_IXUSR" => 0100, 852f90774e1SJoe Perches "S_IRWXG" => 0070, 853f90774e1SJoe Perches "S_IRGRP" => 0040, 854f90774e1SJoe Perches "S_IWGRP" => 0020, 855f90774e1SJoe Perches "S_IXGRP" => 0010, 856f90774e1SJoe Perches "S_IRWXO" => 0007, 857f90774e1SJoe Perches "S_IROTH" => 0004, 858f90774e1SJoe Perches "S_IWOTH" => 0002, 859f90774e1SJoe Perches "S_IXOTH" => 0001, 860f90774e1SJoe Perches "S_IRWXUGO" => 0777, 861f90774e1SJoe Perches "S_IRUGO" => 0444, 862f90774e1SJoe Perches "S_IWUGO" => 0222, 863f90774e1SJoe Perches "S_IXUGO" => 0111, 864f90774e1SJoe Perches); 865f90774e1SJoe Perches 866f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below 867f90774e1SJoe Perchesour $mode_perms_string_search = ""; 868f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) { 869f90774e1SJoe Perches $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); 870f90774e1SJoe Perches $mode_perms_string_search .= $entry; 871f90774e1SJoe Perches} 87200180468SJoe Perchesour $single_mode_perms_string_search = "(?:${mode_perms_string_search})"; 87300180468SJoe Perchesour $multi_mode_perms_string_search = qr{ 87400180468SJoe Perches ${single_mode_perms_string_search} 87500180468SJoe Perches (?:\s*\|\s*${single_mode_perms_string_search})* 87600180468SJoe Perches}x; 87700180468SJoe Perches 87800180468SJoe Perchessub perms_to_octal { 87900180468SJoe Perches my ($string) = @_; 88000180468SJoe Perches 88100180468SJoe Perches return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/); 88200180468SJoe Perches 88300180468SJoe Perches my $val = ""; 88400180468SJoe Perches my $oval = ""; 88500180468SJoe Perches my $to = 0; 88600180468SJoe Perches my $curpos = 0; 88700180468SJoe Perches my $lastpos = 0; 88800180468SJoe Perches while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) { 88900180468SJoe Perches $curpos = pos($string); 89000180468SJoe Perches my $match = $2; 89100180468SJoe Perches my $omatch = $1; 89200180468SJoe Perches last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos)); 89300180468SJoe Perches $lastpos = $curpos; 89400180468SJoe Perches $to |= $mode_permission_string_types{$match}; 89500180468SJoe Perches $val .= '\s*\|\s*' if ($val ne ""); 89600180468SJoe Perches $val .= $match; 89700180468SJoe Perches $oval .= $omatch; 89800180468SJoe Perches } 89900180468SJoe Perches $oval =~ s/^\s*\|\s*//; 90000180468SJoe Perches $oval =~ s/\s*\|\s*$//; 90100180468SJoe Perches return sprintf("%04o", $to); 90200180468SJoe Perches} 903f90774e1SJoe Perches 9047840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 9057840a94cSWolfram Sang irq| 906cdcee686SSergey Ryazanov memory| 907cdcee686SSergey Ryazanov time| 908cdcee686SSergey Ryazanov reboot 9097840a94cSWolfram Sang)}; 9107840a94cSWolfram Sang# memory.h: ARM has a custom one 9117840a94cSWolfram Sang 91266b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 91366b47b4aSKees Cookmy $misspellings; 91466b47b4aSKees Cookmy %spelling_fix; 91536061e38SJoe Perches 91636061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 91766b47b4aSKees Cook while (<$spelling>) { 91866b47b4aSKees Cook my $line = $_; 91966b47b4aSKees Cook 92066b47b4aSKees Cook $line =~ s/\s*\n?$//g; 92166b47b4aSKees Cook $line =~ s/^\s*//g; 92266b47b4aSKees Cook 92366b47b4aSKees Cook next if ($line =~ m/^\s*#/); 92466b47b4aSKees Cook next if ($line =~ m/^\s*$/); 92566b47b4aSKees Cook 92666b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 92766b47b4aSKees Cook 92866b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 92966b47b4aSKees Cook } 93066b47b4aSKees Cook close($spelling); 93136061e38SJoe Perches} else { 93236061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 93336061e38SJoe Perches} 93466b47b4aSKees Cook 935ebfd7d62SJoe Perchesif ($codespell) { 936ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 937ebfd7d62SJoe Perches while (<$spelling>) { 938ebfd7d62SJoe Perches my $line = $_; 939ebfd7d62SJoe Perches 940ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 941ebfd7d62SJoe Perches $line =~ s/^\s*//g; 942ebfd7d62SJoe Perches 943ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 944ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 945ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 946ebfd7d62SJoe Perches 947ebfd7d62SJoe Perches $line =~ s/,.*$//; 948ebfd7d62SJoe Perches 949ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 950ebfd7d62SJoe Perches 951ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 952ebfd7d62SJoe Perches } 953ebfd7d62SJoe Perches close($spelling); 954ebfd7d62SJoe Perches } else { 955ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 956ebfd7d62SJoe Perches } 957ebfd7d62SJoe Perches} 958ebfd7d62SJoe Perches 959ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 960ebfd7d62SJoe Perches 96175ad8c57SJerome Forissiersub read_words { 96275ad8c57SJerome Forissier my ($wordsRef, $file) = @_; 96375ad8c57SJerome Forissier 96475ad8c57SJerome Forissier if (open(my $words, '<', $file)) { 96575ad8c57SJerome Forissier while (<$words>) { 966bf1fa1daSJoe Perches my $line = $_; 967bf1fa1daSJoe Perches 968bf1fa1daSJoe Perches $line =~ s/\s*\n?$//g; 969bf1fa1daSJoe Perches $line =~ s/^\s*//g; 970bf1fa1daSJoe Perches 971bf1fa1daSJoe Perches next if ($line =~ m/^\s*#/); 972bf1fa1daSJoe Perches next if ($line =~ m/^\s*$/); 973bf1fa1daSJoe Perches if ($line =~ /\s/) { 97475ad8c57SJerome Forissier print("$file: '$line' invalid - ignored\n"); 975bf1fa1daSJoe Perches next; 976bf1fa1daSJoe Perches } 977bf1fa1daSJoe Perches 978ced69da1SQuentin Monnet $$wordsRef .= '|' if (defined $$wordsRef); 97975ad8c57SJerome Forissier $$wordsRef .= $line; 980bf1fa1daSJoe Perches } 98175ad8c57SJerome Forissier close($file); 98275ad8c57SJerome Forissier return 1; 983bf1fa1daSJoe Perches } 984bf1fa1daSJoe Perches 98575ad8c57SJerome Forissier return 0; 98675ad8c57SJerome Forissier} 98775ad8c57SJerome Forissier 988ced69da1SQuentin Monnetmy $const_structs; 989ced69da1SQuentin Monnetif (show_type("CONST_STRUCT")) { 99075ad8c57SJerome Forissier read_words(\$const_structs, $conststructsfile) 99175ad8c57SJerome Forissier or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 992ced69da1SQuentin Monnet} 99375ad8c57SJerome Forissier 994ced69da1SQuentin Monnetif (defined($typedefsfile)) { 995ced69da1SQuentin Monnet my $typeOtherTypedefs; 99675ad8c57SJerome Forissier read_words(\$typeOtherTypedefs, $typedefsfile) 99775ad8c57SJerome Forissier or warn "No additional types will be considered - file '$typedefsfile': $!\n"; 998ced69da1SQuentin Monnet $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs); 99975ad8c57SJerome Forissier} 100075ad8c57SJerome Forissier 10018905a67cSAndy Whitcroftsub build_types { 1002485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 1003485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 10041813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 10058716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 1006c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 1007ab7e23f3SJoe Perches $BasicType = qr{ 1008ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 1009ab7e23f3SJoe Perches (?:${all}\b) 1010ab7e23f3SJoe Perches }x; 10118905a67cSAndy Whitcroft $NonptrType = qr{ 1012d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 1013cf655043SAndy Whitcroft (?: 10146b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 10158ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 1016c45dcabdSAndy Whitcroft (?:${all}\b) 1017cf655043SAndy Whitcroft ) 1018c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 10198905a67cSAndy Whitcroft }x; 10201813087dSJoe Perches $NonptrTypeMisordered = qr{ 10211813087dSJoe Perches (?:$Modifier\s+|const\s+)* 10221813087dSJoe Perches (?: 10231813087dSJoe Perches (?:${Misordered}\b) 10241813087dSJoe Perches ) 10251813087dSJoe Perches (?:\s+$Modifier|\s+const)* 10261813087dSJoe Perches }x; 10278716de38SJoe Perches $NonptrTypeWithAttr = qr{ 10288716de38SJoe Perches (?:$Modifier\s+|const\s+)* 10298716de38SJoe Perches (?: 10308716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 10318716de38SJoe Perches (?:$typeTypedefs\b)| 10328716de38SJoe Perches (?:${allWithAttr}\b) 10338716de38SJoe Perches ) 10348716de38SJoe Perches (?:\s+$Modifier|\s+const)* 10358716de38SJoe Perches }x; 10368905a67cSAndy Whitcroft $Type = qr{ 1037c45dcabdSAndy Whitcroft $NonptrType 10387b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 1039c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 10408905a67cSAndy Whitcroft }x; 10411813087dSJoe Perches $TypeMisordered = qr{ 10421813087dSJoe Perches $NonptrTypeMisordered 10437b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 10441813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 10451813087dSJoe Perches }x; 104691cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 10471813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 10488905a67cSAndy Whitcroft} 10498905a67cSAndy Whitcroftbuild_types(); 10506c72ffaaSAndy Whitcroft 10517d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 1052d1fe9c09SJoe Perches 1053d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 1054d1fe9c09SJoe Perches# requires at least perl version v5.10.0 1055d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 1056d1fe9c09SJoe Perches 1057d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 10582435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 1059c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 10607d2367afSJoe Perches 1061f8422308SJoe Perchesour $declaration_macros = qr{(?x: 10623e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 1063fe658f94SSteffen Maier (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(| 1064dcea7964SJoe Perches (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(| 1065dcea7964SJoe Perches (?:$Storage\s+)?(?:XA_STATE|XA_STATE_ORDER)\s*\( 1066f8422308SJoe Perches)}; 1067f8422308SJoe Perches 10688d0325ccSAditya Srivastavaour %allow_repeated_words = ( 10698d0325ccSAditya Srivastava add => '', 10708d0325ccSAditya Srivastava added => '', 10718d0325ccSAditya Srivastava bad => '', 10728d0325ccSAditya Srivastava be => '', 10738d0325ccSAditya Srivastava); 10748d0325ccSAditya Srivastava 10757d2367afSJoe Perchessub deparenthesize { 10767d2367afSJoe Perches my ($string) = @_; 10777d2367afSJoe Perches return "" if (!defined($string)); 10785b9553abSJoe Perches 10795b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 10805b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 10815b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 10825b9553abSJoe Perches } 10835b9553abSJoe Perches 10847d2367afSJoe Perches $string =~ s@\s+@ @g; 10855b9553abSJoe Perches 10867d2367afSJoe Perches return $string; 10877d2367afSJoe Perches} 10887d2367afSJoe Perches 10893445686aSJoe Perchessub seed_camelcase_file { 10903445686aSJoe Perches my ($file) = @_; 10913445686aSJoe Perches 10923445686aSJoe Perches return if (!(-f $file)); 10933445686aSJoe Perches 10943445686aSJoe Perches local $/; 10953445686aSJoe Perches 10963445686aSJoe Perches open(my $include_file, '<', "$file") 10973445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 10983445686aSJoe Perches my $text = <$include_file>; 10993445686aSJoe Perches close($include_file); 11003445686aSJoe Perches 11013445686aSJoe Perches my @lines = split('\n', $text); 11023445686aSJoe Perches 11033445686aSJoe Perches foreach my $line (@lines) { 11043445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 11053445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 11063445686aSJoe Perches $camelcase{$1} = 1; 110711ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 110811ea516aSJoe Perches $camelcase{$1} = 1; 110911ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 11103445686aSJoe Perches $camelcase{$1} = 1; 11113445686aSJoe Perches } 11123445686aSJoe Perches } 11133445686aSJoe Perches} 11143445686aSJoe Perches 1115cd28b119SJoe Perchesour %maintained_status = (); 1116cd28b119SJoe Perches 111785b0ee18SJoe Perchessub is_maintained_obsolete { 111885b0ee18SJoe Perches my ($filename) = @_; 111985b0ee18SJoe Perches 1120f2c19c2fSJerome Forissier return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 112185b0ee18SJoe Perches 1122cd28b119SJoe Perches if (!exists($maintained_status{$filename})) { 1123cd28b119SJoe Perches $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 1124cd28b119SJoe Perches } 112585b0ee18SJoe Perches 1126cd28b119SJoe Perches return $maintained_status{$filename} =~ /obsolete/i; 112785b0ee18SJoe Perches} 112885b0ee18SJoe Perches 11293b6e8ac9SJoe Perchessub is_SPDX_License_valid { 11303b6e8ac9SJoe Perches my ($license) = @_; 11313b6e8ac9SJoe Perches 1132f9363b31SGuenter Roeck return 1 if (!$tree || which("python3") eq "" || !(-x "$root/scripts/spdxcheck.py") || !(-e "$gitroot")); 11333b6e8ac9SJoe Perches 113456294112SJoe Perches my $root_path = abs_path($root); 1135f9363b31SGuenter Roeck my $status = `cd "$root_path"; echo "$license" | scripts/spdxcheck.py -`; 11363b6e8ac9SJoe Perches return 0 if ($status ne ""); 11373b6e8ac9SJoe Perches return 1; 11383b6e8ac9SJoe Perches} 11393b6e8ac9SJoe Perches 11403445686aSJoe Perchesmy $camelcase_seeded = 0; 11413445686aSJoe Perchessub seed_camelcase_includes { 11423445686aSJoe Perches return if ($camelcase_seeded); 11433445686aSJoe Perches 11443445686aSJoe Perches my $files; 1145c707a81dSJoe Perches my $camelcase_cache = ""; 1146c707a81dSJoe Perches my @include_files = (); 1147c707a81dSJoe Perches 1148c707a81dSJoe Perches $camelcase_seeded = 1; 1149351b2a1fSJoe Perches 11500f7f635bSJoe Perches if (-e "$gitroot") { 1151dbbf869dSJoe Perches my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`; 1152351b2a1fSJoe Perches chomp $git_last_include_commit; 1153c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 1154c707a81dSJoe Perches } else { 1155c707a81dSJoe Perches my $last_mod_date = 0; 1156c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 1157c707a81dSJoe Perches @include_files = split('\n', $files); 1158c707a81dSJoe Perches foreach my $file (@include_files) { 1159c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 1160c707a81dSJoe Perches localtime((stat $file)[9])); 1161c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 1162c707a81dSJoe Perches } 1163c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 1164c707a81dSJoe Perches } 1165c707a81dSJoe Perches 1166c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 1167c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 1168c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 1169351b2a1fSJoe Perches while (<$camelcase_file>) { 1170351b2a1fSJoe Perches chomp; 1171351b2a1fSJoe Perches $camelcase{$_} = 1; 1172351b2a1fSJoe Perches } 1173351b2a1fSJoe Perches close($camelcase_file); 1174351b2a1fSJoe Perches 1175351b2a1fSJoe Perches return; 1176351b2a1fSJoe Perches } 1177c707a81dSJoe Perches 11780f7f635bSJoe Perches if (-e "$gitroot") { 1179dbbf869dSJoe Perches $files = `${git_command} ls-files "include/*.h"`; 1180c707a81dSJoe Perches @include_files = split('\n', $files); 11813445686aSJoe Perches } 1182c707a81dSJoe Perches 11833445686aSJoe Perches foreach my $file (@include_files) { 11843445686aSJoe Perches seed_camelcase_file($file); 11853445686aSJoe Perches } 1186351b2a1fSJoe Perches 1187c707a81dSJoe Perches if ($camelcase_cache ne "") { 1188351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 1189c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 1190c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 1191351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 1192351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 1193351b2a1fSJoe Perches } 1194351b2a1fSJoe Perches close($camelcase_file); 1195351b2a1fSJoe Perches } 11963445686aSJoe Perches} 11973445686aSJoe Perches 1198f5f61325SJoe Perchessub git_is_single_file { 1199f5f61325SJoe Perches my ($filename) = @_; 1200f5f61325SJoe Perches 1201f5f61325SJoe Perches return 0 if ((which("git") eq "") || !(-e "$gitroot")); 1202f5f61325SJoe Perches 1203f5f61325SJoe Perches my $output = `${git_command} ls-files -- $filename 2>/dev/null`; 1204f5f61325SJoe Perches my $count = $output =~ tr/\n//; 1205f5f61325SJoe Perches return $count eq 1 && $output =~ m{^${filename}$}; 1206f5f61325SJoe Perches} 1207f5f61325SJoe Perches 1208d311cd44SJoe Perchessub git_commit_info { 1209d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 1210d311cd44SJoe Perches 12110f7f635bSJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot")); 1212d311cd44SJoe Perches 1213dbbf869dSJoe Perches my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`; 1214d311cd44SJoe Perches $output =~ s/^\s*//gm; 1215d311cd44SJoe Perches my @lines = split("\n", $output); 1216d311cd44SJoe Perches 12170d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 12180d7835fcSJoe Perches 12195a7f4455SSean Christopherson if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) { 1220d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 1221d311cd44SJoe Perches# all matching commit ids, but it's very slow... 1222d311cd44SJoe Perches# 1223d311cd44SJoe Perches# echo "checking commits $1..." 1224d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 1225d311cd44SJoe Perches# while read line ; do 1226d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 1227d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 1228d311cd44SJoe Perches# done 12294ce9f970SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./ || 12304ce9f970SJoe Perches $lines[0] =~ /^fatal: bad object $commit/) { 1231948b133aSHeinrich Schuchardt $id = undef; 1232d311cd44SJoe Perches } else { 1233d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 1234d311cd44SJoe Perches $desc = substr($lines[0], 41); 1235d311cd44SJoe Perches } 1236d311cd44SJoe Perches 1237d311cd44SJoe Perches return ($id, $desc); 1238d311cd44SJoe Perches} 1239d311cd44SJoe Perches 12406c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 12410a920b5bSAndy Whitcroft 124200df344fSAndy Whitcroftmy @rawlines = (); 1243c2fdda0dSAndy Whitcroftmy @lines = (); 12443705ce5bSJoe Perchesmy @fixed = (); 1245d752fcc8SJoe Perchesmy @fixed_inserted = (); 1246d752fcc8SJoe Perchesmy @fixed_deleted = (); 1247194f66fcSJoe Perchesmy $fixlinenr = -1; 1248194f66fcSJoe Perches 12494a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 12504a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 12510f7f635bSJoe Perchesdie "$P: No git repository found\n" if ($git && !-e "$gitroot"); 12524a593c34SDu, Changbin 12534a593c34SDu, Changbinif ($git) { 12544a593c34SDu, Changbin my @commits = (); 12550dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 12564a593c34SDu, Changbin my $git_range; 125728898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 125828898fd1SJoe Perches $git_range = "-$2 $1"; 12594a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 12604a593c34SDu, Changbin $git_range = "$commit_expr"; 12614a593c34SDu, Changbin } else { 12620dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 12630dea9f1eSJoe Perches } 1264dbbf869dSJoe Perches my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 12650dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 126628898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 126728898fd1SJoe Perches next if (!defined($1) || !defined($2)); 12680dea9f1eSJoe Perches my $sha1 = $1; 12690dea9f1eSJoe Perches my $subject = $2; 12700dea9f1eSJoe Perches unshift(@commits, $sha1); 12710dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 12724a593c34SDu, Changbin } 12734a593c34SDu, Changbin } 12744a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 12754a593c34SDu, Changbin @ARGV = @commits; 12764a593c34SDu, Changbin} 12774a593c34SDu, Changbin 1278c2fdda0dSAndy Whitcroftmy $vname; 127998005e8cSVadim Bendebury$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"}; 12806c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 128121caa13cSAndy Whitcroft my $FILE; 1282f5f61325SJoe Perches my $is_git_file = git_is_single_file($filename); 1283f5f61325SJoe Perches my $oldfile = $file; 1284f5f61325SJoe Perches $file = 1 if ($is_git_file); 12854a593c34SDu, Changbin if ($git) { 12864a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 12874a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 12884a593c34SDu, Changbin } elsif ($file) { 128921caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 12906c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 129121caa13cSAndy Whitcroft } elsif ($filename eq '-') { 129221caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 12936c72ffaaSAndy Whitcroft } else { 129421caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 12956c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 12966c72ffaaSAndy Whitcroft } 1297c2fdda0dSAndy Whitcroft if ($filename eq '-') { 1298c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 12994a593c34SDu, Changbin } elsif ($git) { 13000dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 1301c2fdda0dSAndy Whitcroft } else { 1302c2fdda0dSAndy Whitcroft $vname = $filename; 1303c2fdda0dSAndy Whitcroft } 130421caa13cSAndy Whitcroft while (<$FILE>) { 13050a920b5bSAndy Whitcroft chomp; 130600df344fSAndy Whitcroft push(@rawlines, $_); 1307c7f574d0SGeert Uytterhoeven $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i); 13086c72ffaaSAndy Whitcroft } 130921caa13cSAndy Whitcroft close($FILE); 1310d8469f16SJoe Perches 1311d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 1312d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1313d8469f16SJoe Perches print "$vname\n"; 1314d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1315d8469f16SJoe Perches } 1316d8469f16SJoe Perches 1317c2fdda0dSAndy Whitcroft if (!process($filename)) { 13180a920b5bSAndy Whitcroft $exit = 1; 13190a920b5bSAndy Whitcroft } 132000df344fSAndy Whitcroft @rawlines = (); 132113214adfSAndy Whitcroft @lines = (); 13223705ce5bSJoe Perches @fixed = (); 1323d752fcc8SJoe Perches @fixed_inserted = (); 1324d752fcc8SJoe Perches @fixed_deleted = (); 1325194f66fcSJoe Perches $fixlinenr = -1; 1326485ff23eSAlex Dowad @modifierListFile = (); 1327485ff23eSAlex Dowad @typeListFile = (); 1328485ff23eSAlex Dowad build_types(); 1329f5f61325SJoe Perches $file = $oldfile if ($is_git_file); 13300a920b5bSAndy Whitcroft} 13310a920b5bSAndy Whitcroft 1332d8469f16SJoe Perchesif (!$quiet) { 13333c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 13343c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 13353c816e49SJoe Perches 13365b57980dSJoe Perches if (!$perl_version_ok) { 1337d8469f16SJoe Perches print << "EOM" 1338d8469f16SJoe Perches 1339d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 13405b57980dSJoe Perches An upgrade to at least perl $minimum_perl_version is suggested. 1341d8469f16SJoe PerchesEOM 1342d8469f16SJoe Perches } 1343d8469f16SJoe Perches if ($exit) { 1344d8469f16SJoe Perches print << "EOM" 1345d8469f16SJoe Perches 1346d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 1347d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 1348d8469f16SJoe PerchesEOM 1349d8469f16SJoe Perches } 1350d8469f16SJoe Perches} 1351d8469f16SJoe Perches 13520a920b5bSAndy Whitcroftexit($exit); 13530a920b5bSAndy Whitcroft 13540a920b5bSAndy Whitcroftsub top_of_kernel_tree { 13556c72ffaaSAndy Whitcroft my ($root) = @_; 13566c72ffaaSAndy Whitcroft 13576c72ffaaSAndy Whitcroft my @tree_check = ( 13586c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 13596c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 13606c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 13616c72ffaaSAndy Whitcroft ); 13626c72ffaaSAndy Whitcroft 13636c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 13646c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 13650a920b5bSAndy Whitcroft return 0; 13660a920b5bSAndy Whitcroft } 13676c72ffaaSAndy Whitcroft } 13686c72ffaaSAndy Whitcroft return 1; 13696c72ffaaSAndy Whitcroft} 13700a920b5bSAndy Whitcroft 137120112475SJoe Perchessub parse_email { 137220112475SJoe Perches my ($formatted_email) = @_; 137320112475SJoe Perches 137420112475SJoe Perches my $name = ""; 1375fccaebf0SDwaipayan Ray my $quoted = ""; 1376dfa05c28SJoe Perches my $name_comment = ""; 137720112475SJoe Perches my $address = ""; 137820112475SJoe Perches my $comment = ""; 137920112475SJoe Perches 138020112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 138120112475SJoe Perches $name = $1; 138220112475SJoe Perches $address = $2; 138320112475SJoe Perches $comment = $3 if defined $3; 138420112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 138520112475SJoe Perches $address = $1; 138620112475SJoe Perches $comment = $2 if defined $2; 138720112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 138820112475SJoe Perches $address = $1; 138920112475SJoe Perches $comment = $2 if defined $2; 139085e12066SJoe Perches $formatted_email =~ s/\Q$address\E.*$//; 139120112475SJoe Perches $name = $formatted_email; 13923705ce5bSJoe Perches $name = trim($name); 139320112475SJoe Perches $name =~ s/^\"|\"$//g; 139420112475SJoe Perches # If there's a name left after stripping spaces and 139520112475SJoe Perches # leading quotes, and the address doesn't have both 139620112475SJoe Perches # leading and trailing angle brackets, the address 139720112475SJoe Perches # is invalid. ie: 139820112475SJoe Perches # "joe smith [email protected]" bad 139920112475SJoe Perches # "joe smith <[email protected]" bad 140020112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 140120112475SJoe Perches $name = ""; 140220112475SJoe Perches $address = ""; 140320112475SJoe Perches $comment = ""; 140420112475SJoe Perches } 140520112475SJoe Perches } 140620112475SJoe Perches 1407fccaebf0SDwaipayan Ray # Extract comments from names excluding quoted parts 1408fccaebf0SDwaipayan Ray # "John D. (Doe)" - Do not extract 1409fccaebf0SDwaipayan Ray if ($name =~ s/\"(.+)\"//) { 1410fccaebf0SDwaipayan Ray $quoted = $1; 1411dfa05c28SJoe Perches } 1412fccaebf0SDwaipayan Ray while ($name =~ s/\s*($balanced_parens)\s*/ /) { 1413fccaebf0SDwaipayan Ray $name_comment .= trim($1); 1414fccaebf0SDwaipayan Ray } 1415fccaebf0SDwaipayan Ray $name =~ s/^[ \"]+|[ \"]+$//g; 1416fccaebf0SDwaipayan Ray $name = trim("$quoted $name"); 1417fccaebf0SDwaipayan Ray 14183705ce5bSJoe Perches $address = trim($address); 141920112475SJoe Perches $address =~ s/^\<|\>$//g; 1420fccaebf0SDwaipayan Ray $comment = trim($comment); 142120112475SJoe Perches 142220112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 142320112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 142420112475SJoe Perches $name = "\"$name\""; 142520112475SJoe Perches } 142620112475SJoe Perches 1427dfa05c28SJoe Perches return ($name, $name_comment, $address, $comment); 142820112475SJoe Perches} 142920112475SJoe Perches 143020112475SJoe Perchessub format_email { 143148ca2d8aSDwaipayan Ray my ($name, $name_comment, $address, $comment) = @_; 143220112475SJoe Perches 143320112475SJoe Perches my $formatted_email; 143420112475SJoe Perches 1435fccaebf0SDwaipayan Ray $name =~ s/^[ \"]+|[ \"]+$//g; 14363705ce5bSJoe Perches $address = trim($address); 1437fccaebf0SDwaipayan Ray $address =~ s/(?:\.|\,|\")+$//; ##trailing commas, dots or quotes 143820112475SJoe Perches 143920112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 144020112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 144120112475SJoe Perches $name = "\"$name\""; 144220112475SJoe Perches } 144320112475SJoe Perches 1444fccaebf0SDwaipayan Ray $name_comment = trim($name_comment); 1445fccaebf0SDwaipayan Ray $name_comment = " $name_comment" if ($name_comment ne ""); 1446fccaebf0SDwaipayan Ray $comment = trim($comment); 1447fccaebf0SDwaipayan Ray $comment = " $comment" if ($comment ne ""); 1448fccaebf0SDwaipayan Ray 144920112475SJoe Perches if ("$name" eq "") { 145020112475SJoe Perches $formatted_email = "$address"; 145120112475SJoe Perches } else { 145248ca2d8aSDwaipayan Ray $formatted_email = "$name$name_comment <$address>"; 145320112475SJoe Perches } 145448ca2d8aSDwaipayan Ray $formatted_email .= "$comment"; 145520112475SJoe Perches return $formatted_email; 145620112475SJoe Perches} 145720112475SJoe Perches 1458dfa05c28SJoe Perchessub reformat_email { 1459dfa05c28SJoe Perches my ($email) = @_; 1460dfa05c28SJoe Perches 1461dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 146248ca2d8aSDwaipayan Ray return format_email($email_name, $name_comment, $email_address, $comment); 1463dfa05c28SJoe Perches} 1464dfa05c28SJoe Perches 1465dfa05c28SJoe Perchessub same_email_addresses { 1466fccaebf0SDwaipayan Ray my ($email1, $email2) = @_; 1467dfa05c28SJoe Perches 1468dfa05c28SJoe Perches my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1); 1469dfa05c28SJoe Perches my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2); 1470dfa05c28SJoe Perches 147148ca2d8aSDwaipayan Ray return $email1_name eq $email2_name && 147248ca2d8aSDwaipayan Ray $email1_address eq $email2_address && 147348ca2d8aSDwaipayan Ray $name1_comment eq $name2_comment && 147448ca2d8aSDwaipayan Ray $comment1 eq $comment2; 147548ca2d8aSDwaipayan Ray} 1476dfa05c28SJoe Perches 1477d311cd44SJoe Perchessub which { 1478d311cd44SJoe Perches my ($bin) = @_; 1479d311cd44SJoe Perches 1480d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1481d311cd44SJoe Perches if (-e "$path/$bin") { 1482d311cd44SJoe Perches return "$path/$bin"; 1483d311cd44SJoe Perches } 1484d311cd44SJoe Perches } 1485d311cd44SJoe Perches 1486d311cd44SJoe Perches return ""; 1487d311cd44SJoe Perches} 1488d311cd44SJoe Perches 1489000d1cc1SJoe Perchessub which_conf { 1490000d1cc1SJoe Perches my ($conf) = @_; 1491000d1cc1SJoe Perches 1492000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1493000d1cc1SJoe Perches if (-e "$path/$conf") { 1494000d1cc1SJoe Perches return "$path/$conf"; 1495000d1cc1SJoe Perches } 1496000d1cc1SJoe Perches } 1497000d1cc1SJoe Perches 1498000d1cc1SJoe Perches return ""; 1499000d1cc1SJoe Perches} 1500000d1cc1SJoe Perches 15010a920b5bSAndy Whitcroftsub expand_tabs { 15020a920b5bSAndy Whitcroft my ($str) = @_; 15030a920b5bSAndy Whitcroft 15040a920b5bSAndy Whitcroft my $res = ''; 15050a920b5bSAndy Whitcroft my $n = 0; 15060a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 15070a920b5bSAndy Whitcroft if ($c eq "\t") { 15080a920b5bSAndy Whitcroft $res .= ' '; 15090a920b5bSAndy Whitcroft $n++; 1510713a09deSAntonio Borneo for (; ($n % $tabsize) != 0; $n++) { 15110a920b5bSAndy Whitcroft $res .= ' '; 15120a920b5bSAndy Whitcroft } 15130a920b5bSAndy Whitcroft next; 15140a920b5bSAndy Whitcroft } 15150a920b5bSAndy Whitcroft $res .= $c; 15160a920b5bSAndy Whitcroft $n++; 15170a920b5bSAndy Whitcroft } 15180a920b5bSAndy Whitcroft 15190a920b5bSAndy Whitcroft return $res; 15200a920b5bSAndy Whitcroft} 15216c72ffaaSAndy Whitcroftsub copy_spacing { 1522773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 15236c72ffaaSAndy Whitcroft return $res; 15246c72ffaaSAndy Whitcroft} 15250a920b5bSAndy Whitcroft 15264a0df2efSAndy Whitcroftsub line_stats { 15274a0df2efSAndy Whitcroft my ($line) = @_; 15284a0df2efSAndy Whitcroft 15294a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 15304a0df2efSAndy Whitcroft $line =~ s/^.//; 15314a0df2efSAndy Whitcroft $line = expand_tabs($line); 15324a0df2efSAndy Whitcroft 15334a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 15344a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 15354a0df2efSAndy Whitcroft 15364a0df2efSAndy Whitcroft return (length($line), length($white)); 15374a0df2efSAndy Whitcroft} 15384a0df2efSAndy Whitcroft 1539773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1540773647a0SAndy Whitcroft 1541773647a0SAndy Whitcroftsub sanitise_line_reset { 1542773647a0SAndy Whitcroft my ($in_comment) = @_; 1543773647a0SAndy Whitcroft 1544773647a0SAndy Whitcroft if ($in_comment) { 1545773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1546773647a0SAndy Whitcroft } else { 1547773647a0SAndy Whitcroft $sanitise_quote = ''; 1548773647a0SAndy Whitcroft } 1549773647a0SAndy Whitcroft} 155000df344fSAndy Whitcroftsub sanitise_line { 155100df344fSAndy Whitcroft my ($line) = @_; 155200df344fSAndy Whitcroft 155300df344fSAndy Whitcroft my $res = ''; 155400df344fSAndy Whitcroft my $l = ''; 155500df344fSAndy Whitcroft 1556c2fdda0dSAndy Whitcroft my $qlen = 0; 1557773647a0SAndy Whitcroft my $off = 0; 1558773647a0SAndy Whitcroft my $c; 155900df344fSAndy Whitcroft 1560773647a0SAndy Whitcroft # Always copy over the diff marker. 1561773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1562773647a0SAndy Whitcroft 1563773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1564773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1565773647a0SAndy Whitcroft 15668d2e11b2SClaudio Fontana # Comments we are whacking completely including the begin 1567773647a0SAndy Whitcroft # and end, all to $;. 1568773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1569773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1570773647a0SAndy Whitcroft 1571773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1572773647a0SAndy Whitcroft $off++; 157300df344fSAndy Whitcroft next; 1574773647a0SAndy Whitcroft } 157581bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1576773647a0SAndy Whitcroft $sanitise_quote = ''; 1577773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1578773647a0SAndy Whitcroft $off++; 1579773647a0SAndy Whitcroft next; 1580773647a0SAndy Whitcroft } 1581113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1582113f04a8SDaniel Walker $sanitise_quote = '//'; 1583113f04a8SDaniel Walker 1584113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1585113f04a8SDaniel Walker $off++; 1586113f04a8SDaniel Walker next; 1587113f04a8SDaniel Walker } 1588773647a0SAndy Whitcroft 1589773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1590773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1591773647a0SAndy Whitcroft $c eq "\\") { 1592773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1593773647a0SAndy Whitcroft $off++; 1594773647a0SAndy Whitcroft next; 1595773647a0SAndy Whitcroft } 1596773647a0SAndy Whitcroft # Regular quotes. 1597773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1598773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1599773647a0SAndy Whitcroft $sanitise_quote = $c; 1600773647a0SAndy Whitcroft 1601773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1602773647a0SAndy Whitcroft next; 1603773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1604773647a0SAndy Whitcroft $sanitise_quote = ''; 160500df344fSAndy Whitcroft } 160600df344fSAndy Whitcroft } 1607773647a0SAndy Whitcroft 1608fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1609773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1610773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1611113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1612113f04a8SDaniel Walker substr($res, $off, 1, $;); 1613773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1614773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 161500df344fSAndy Whitcroft } else { 1616773647a0SAndy Whitcroft substr($res, $off, 1, $c); 161700df344fSAndy Whitcroft } 1618c2fdda0dSAndy Whitcroft } 1619c2fdda0dSAndy Whitcroft 1620113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1621113f04a8SDaniel Walker $sanitise_quote = ''; 1622113f04a8SDaniel Walker } 1623113f04a8SDaniel Walker 1624c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1625c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1626c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1627c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1628c2fdda0dSAndy Whitcroft 1629c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1630c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1631c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1632c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1633c2fdda0dSAndy Whitcroft } 1634c2fdda0dSAndy Whitcroft 1635dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1636dadf680dSJoe Perches my $match = $1; 1637dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1638dadf680dSJoe Perches } 1639dadf680dSJoe Perches 164000df344fSAndy Whitcroft return $res; 164100df344fSAndy Whitcroft} 164200df344fSAndy Whitcroft 1643a6962d72SJoe Perchessub get_quoted_string { 1644a6962d72SJoe Perches my ($line, $rawline) = @_; 1645a6962d72SJoe Perches 1646478b1799SJoe Perches return "" if (!defined($line) || !defined($rawline)); 164733acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1648a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1649a6962d72SJoe Perches} 1650a6962d72SJoe Perches 16518905a67cSAndy Whitcroftsub ctx_statement_block { 16528905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 16538905a67cSAndy Whitcroft my $line = $linenr - 1; 16548905a67cSAndy Whitcroft my $blk = ''; 16558905a67cSAndy Whitcroft my $soff = $off; 16568905a67cSAndy Whitcroft my $coff = $off - 1; 1657773647a0SAndy Whitcroft my $coff_set = 0; 16588905a67cSAndy Whitcroft 165913214adfSAndy Whitcroft my $loff = 0; 166013214adfSAndy Whitcroft 16618905a67cSAndy Whitcroft my $type = ''; 16628905a67cSAndy Whitcroft my $level = 0; 1663a2750645SAndy Whitcroft my @stack = (); 1664cf655043SAndy Whitcroft my $p; 16658905a67cSAndy Whitcroft my $c; 16668905a67cSAndy Whitcroft my $len = 0; 166713214adfSAndy Whitcroft 166813214adfSAndy Whitcroft my $remainder; 16698905a67cSAndy Whitcroft while (1) { 1670a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1671a2750645SAndy Whitcroft 1672773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 16738905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 16748905a67cSAndy Whitcroft # context. 16758905a67cSAndy Whitcroft if ($off >= $len) { 16768905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1677dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1678c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 16798905a67cSAndy Whitcroft $remain--; 168013214adfSAndy Whitcroft $loff = $len; 1681c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 16828905a67cSAndy Whitcroft $len = length($blk); 16838905a67cSAndy Whitcroft $line++; 16848905a67cSAndy Whitcroft last; 16858905a67cSAndy Whitcroft } 16868905a67cSAndy Whitcroft # Bail if there is no further context. 16878905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 168813214adfSAndy Whitcroft if ($off >= $len) { 16898905a67cSAndy Whitcroft last; 16908905a67cSAndy Whitcroft } 1691f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1692f74bd194SAndy Whitcroft $level++; 1693f74bd194SAndy Whitcroft $type = '#'; 1694f74bd194SAndy Whitcroft } 16958905a67cSAndy Whitcroft } 1696cf655043SAndy Whitcroft $p = $c; 16978905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 169813214adfSAndy Whitcroft $remainder = substr($blk, $off); 16998905a67cSAndy Whitcroft 1700773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 17014635f4fbSAndy Whitcroft 17024635f4fbSAndy Whitcroft # Handle nested #if/#else. 17034635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 17044635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 17054635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 17064635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 17074635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 17084635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 17094635f4fbSAndy Whitcroft } 17104635f4fbSAndy Whitcroft 17118905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 17128905a67cSAndy Whitcroft # outermost level. 17138905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 17148905a67cSAndy Whitcroft last; 17158905a67cSAndy Whitcroft } 17168905a67cSAndy Whitcroft 171713214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1718773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1719773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1720773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1721773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1722773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1723773647a0SAndy Whitcroft $coff_set = 1; 1724773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1725773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 172613214adfSAndy Whitcroft } 172713214adfSAndy Whitcroft 17288905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 17298905a67cSAndy Whitcroft $level++; 17308905a67cSAndy Whitcroft $type = '('; 17318905a67cSAndy Whitcroft } 17328905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 17338905a67cSAndy Whitcroft $level--; 17348905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 17358905a67cSAndy Whitcroft 17368905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 17378905a67cSAndy Whitcroft $coff = $off; 1738773647a0SAndy Whitcroft $coff_set = 1; 1739773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 17408905a67cSAndy Whitcroft } 17418905a67cSAndy Whitcroft } 17428905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 17438905a67cSAndy Whitcroft $level++; 17448905a67cSAndy Whitcroft $type = '{'; 17458905a67cSAndy Whitcroft } 17468905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 17478905a67cSAndy Whitcroft $level--; 17488905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 17498905a67cSAndy Whitcroft 17508905a67cSAndy Whitcroft if ($level == 0) { 1751b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1752b998e001SPatrick Pannuto $off++; 1753b998e001SPatrick Pannuto } 17548905a67cSAndy Whitcroft last; 17558905a67cSAndy Whitcroft } 17568905a67cSAndy Whitcroft } 1757f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1758f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1759f74bd194SAndy Whitcroft $level--; 1760f74bd194SAndy Whitcroft $type = ''; 1761f74bd194SAndy Whitcroft $off++; 1762f74bd194SAndy Whitcroft last; 1763f74bd194SAndy Whitcroft } 17648905a67cSAndy Whitcroft $off++; 17658905a67cSAndy Whitcroft } 1766a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 176713214adfSAndy Whitcroft if ($off == $len) { 1768a3bb97a7SAndy Whitcroft $loff = $len + 1; 176913214adfSAndy Whitcroft $line++; 177013214adfSAndy Whitcroft $remain--; 177113214adfSAndy Whitcroft } 17728905a67cSAndy Whitcroft 17738905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 17748905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 17758905a67cSAndy Whitcroft 17768905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 17778905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 17788905a67cSAndy Whitcroft 1779773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 178013214adfSAndy Whitcroft 178113214adfSAndy Whitcroft return ($statement, $condition, 178213214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 178313214adfSAndy Whitcroft} 178413214adfSAndy Whitcroft 1785cf655043SAndy Whitcroftsub statement_lines { 1786cf655043SAndy Whitcroft my ($stmt) = @_; 1787cf655043SAndy Whitcroft 1788cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1789cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1790cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1791cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1792cf655043SAndy Whitcroft 1793cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1794cf655043SAndy Whitcroft 1795cf655043SAndy Whitcroft return $#stmt_lines + 2; 1796cf655043SAndy Whitcroft} 1797cf655043SAndy Whitcroft 1798cf655043SAndy Whitcroftsub statement_rawlines { 1799cf655043SAndy Whitcroft my ($stmt) = @_; 1800cf655043SAndy Whitcroft 1801cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1802cf655043SAndy Whitcroft 1803cf655043SAndy Whitcroft return $#stmt_lines + 2; 1804cf655043SAndy Whitcroft} 1805cf655043SAndy Whitcroft 1806cf655043SAndy Whitcroftsub statement_block_size { 1807cf655043SAndy Whitcroft my ($stmt) = @_; 1808cf655043SAndy Whitcroft 1809cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1810cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1811cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1812cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1813cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1814cf655043SAndy Whitcroft 1815cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1816cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1817cf655043SAndy Whitcroft 1818cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1819cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1820cf655043SAndy Whitcroft 1821cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1822cf655043SAndy Whitcroft return $stmt_lines; 1823cf655043SAndy Whitcroft } else { 1824cf655043SAndy Whitcroft return $stmt_statements; 1825cf655043SAndy Whitcroft } 1826cf655043SAndy Whitcroft} 1827cf655043SAndy Whitcroft 182813214adfSAndy Whitcroftsub ctx_statement_full { 182913214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 183013214adfSAndy Whitcroft my ($statement, $condition, $level); 183113214adfSAndy Whitcroft 183213214adfSAndy Whitcroft my (@chunks); 183313214adfSAndy Whitcroft 1834cf655043SAndy Whitcroft # Grab the first conditional/block pair. 183513214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 183613214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1837773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 183813214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1839cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1840cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1841cf655043SAndy Whitcroft } 1842cf655043SAndy Whitcroft 1843cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1844cf655043SAndy Whitcroft # could continue the statement. 1845cf655043SAndy Whitcroft for (;;) { 184613214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 184713214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1848cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1849773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1850cf655043SAndy Whitcroft #print "C: push\n"; 1851cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 185213214adfSAndy Whitcroft } 185313214adfSAndy Whitcroft 185413214adfSAndy Whitcroft return ($level, $linenr, @chunks); 18558905a67cSAndy Whitcroft} 18568905a67cSAndy Whitcroft 18574a0df2efSAndy Whitcroftsub ctx_block_get { 1858f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 18594a0df2efSAndy Whitcroft my $line; 18604a0df2efSAndy Whitcroft my $start = $linenr - 1; 18614a0df2efSAndy Whitcroft my $blk = ''; 18624a0df2efSAndy Whitcroft my @o; 18634a0df2efSAndy Whitcroft my @c; 18644a0df2efSAndy Whitcroft my @res = (); 18654a0df2efSAndy Whitcroft 1866f0a594c1SAndy Whitcroft my $level = 0; 18674635f4fbSAndy Whitcroft my @stack = ($level); 186800df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 186900df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 187000df344fSAndy Whitcroft $remain--; 187100df344fSAndy Whitcroft 187200df344fSAndy Whitcroft $blk .= $rawlines[$line]; 18734635f4fbSAndy Whitcroft 18744635f4fbSAndy Whitcroft # Handle nested #if/#else. 187501464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 18764635f4fbSAndy Whitcroft push(@stack, $level); 187701464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 18784635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 187901464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 18804635f4fbSAndy Whitcroft $level = pop(@stack); 18814635f4fbSAndy Whitcroft } 18824635f4fbSAndy Whitcroft 188301464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1884f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1885f0a594c1SAndy Whitcroft if ($off > 0) { 1886f0a594c1SAndy Whitcroft $off--; 1887f0a594c1SAndy Whitcroft next; 1888f0a594c1SAndy Whitcroft } 18894a0df2efSAndy Whitcroft 1890f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1891f0a594c1SAndy Whitcroft $level--; 1892f0a594c1SAndy Whitcroft last if ($level == 0); 1893f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1894f0a594c1SAndy Whitcroft $level++; 1895f0a594c1SAndy Whitcroft } 1896f0a594c1SAndy Whitcroft } 18974a0df2efSAndy Whitcroft 1898f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 189900df344fSAndy Whitcroft push(@res, $rawlines[$line]); 19004a0df2efSAndy Whitcroft } 19014a0df2efSAndy Whitcroft 1902f0a594c1SAndy Whitcroft last if ($level == 0); 19034a0df2efSAndy Whitcroft } 19044a0df2efSAndy Whitcroft 1905f0a594c1SAndy Whitcroft return ($level, @res); 19064a0df2efSAndy Whitcroft} 19074a0df2efSAndy Whitcroftsub ctx_block_outer { 19084a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 19094a0df2efSAndy Whitcroft 1910f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1911f0a594c1SAndy Whitcroft return @r; 19124a0df2efSAndy Whitcroft} 19134a0df2efSAndy Whitcroftsub ctx_block { 19144a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 19154a0df2efSAndy Whitcroft 1916f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1917f0a594c1SAndy Whitcroft return @r; 1918653d4876SAndy Whitcroft} 1919653d4876SAndy Whitcroftsub ctx_statement { 1920f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1921f0a594c1SAndy Whitcroft 1922f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1923f0a594c1SAndy Whitcroft return @r; 1924f0a594c1SAndy Whitcroft} 1925f0a594c1SAndy Whitcroftsub ctx_block_level { 1926653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1927653d4876SAndy Whitcroft 1928f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 19294a0df2efSAndy Whitcroft} 19309c0ca6f9SAndy Whitcroftsub ctx_statement_level { 19319c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 19329c0ca6f9SAndy Whitcroft 19339c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 19349c0ca6f9SAndy Whitcroft} 19354a0df2efSAndy Whitcroft 19364a0df2efSAndy Whitcroftsub ctx_locate_comment { 19374a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 19384a0df2efSAndy Whitcroft 1939a55ee0ccSJoe Perches # If c99 comment on the current line, or the line before or after 1940a55ee0ccSJoe Perches my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@); 1941a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1942a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@); 1943a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1944a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@); 1945a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1946a55ee0ccSJoe Perches 19474a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1948a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 19494a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 19504a0df2efSAndy Whitcroft 19514a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 19524a0df2efSAndy Whitcroft # comment. 19534a0df2efSAndy Whitcroft my $in_comment = 0; 19544a0df2efSAndy Whitcroft $current_comment = ''; 19554a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 195600df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 195700df344fSAndy Whitcroft #warn " $line\n"; 19584a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 19594a0df2efSAndy Whitcroft $in_comment = 1; 19604a0df2efSAndy Whitcroft } 19614a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 19624a0df2efSAndy Whitcroft $in_comment = 1; 19634a0df2efSAndy Whitcroft } 19644a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 19654a0df2efSAndy Whitcroft $current_comment = ''; 19664a0df2efSAndy Whitcroft } 19674a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 19684a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 19694a0df2efSAndy Whitcroft $in_comment = 0; 19704a0df2efSAndy Whitcroft } 19714a0df2efSAndy Whitcroft } 19724a0df2efSAndy Whitcroft 19734a0df2efSAndy Whitcroft chomp($current_comment); 19744a0df2efSAndy Whitcroft return($current_comment); 19754a0df2efSAndy Whitcroft} 19764a0df2efSAndy Whitcroftsub ctx_has_comment { 19774a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 19784a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 19794a0df2efSAndy Whitcroft 198000df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 19814a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 19824a0df2efSAndy Whitcroft 19834a0df2efSAndy Whitcroft return ($cmt ne ''); 19844a0df2efSAndy Whitcroft} 19854a0df2efSAndy Whitcroft 19864d001e4dSAndy Whitcroftsub raw_line { 19874d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 19884d001e4dSAndy Whitcroft 19894d001e4dSAndy Whitcroft my $offset = $linenr - 1; 19904d001e4dSAndy Whitcroft $cnt++; 19914d001e4dSAndy Whitcroft 19924d001e4dSAndy Whitcroft my $line; 19934d001e4dSAndy Whitcroft while ($cnt) { 19944d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 19954d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 19964d001e4dSAndy Whitcroft $cnt--; 19974d001e4dSAndy Whitcroft } 19984d001e4dSAndy Whitcroft 19994d001e4dSAndy Whitcroft return $line; 20004d001e4dSAndy Whitcroft} 20014d001e4dSAndy Whitcroft 20022a9f9d85STobin C. Hardingsub get_stat_real { 20032a9f9d85STobin C. Harding my ($linenr, $lc) = @_; 20042a9f9d85STobin C. Harding 20052a9f9d85STobin C. Harding my $stat_real = raw_line($linenr, 0); 20062a9f9d85STobin C. Harding for (my $count = $linenr + 1; $count <= $lc; $count++) { 20072a9f9d85STobin C. Harding $stat_real = $stat_real . "\n" . raw_line($count, 0); 20082a9f9d85STobin C. Harding } 20092a9f9d85STobin C. Harding 20102a9f9d85STobin C. Harding return $stat_real; 20112a9f9d85STobin C. Harding} 20122a9f9d85STobin C. Harding 2013e3d95a2aSTobin C. Hardingsub get_stat_here { 2014e3d95a2aSTobin C. Harding my ($linenr, $cnt, $here) = @_; 2015e3d95a2aSTobin C. Harding 2016e3d95a2aSTobin C. Harding my $herectx = $here . "\n"; 2017e3d95a2aSTobin C. Harding for (my $n = 0; $n < $cnt; $n++) { 2018e3d95a2aSTobin C. Harding $herectx .= raw_line($linenr, $n) . "\n"; 2019e3d95a2aSTobin C. Harding } 2020e3d95a2aSTobin C. Harding 2021e3d95a2aSTobin C. Harding return $herectx; 2022e3d95a2aSTobin C. Harding} 2023e3d95a2aSTobin C. Harding 20240a920b5bSAndy Whitcroftsub cat_vet { 20250a920b5bSAndy Whitcroft my ($vet) = @_; 20269c0ca6f9SAndy Whitcroft my ($res, $coded); 20270a920b5bSAndy Whitcroft 20289c0ca6f9SAndy Whitcroft $res = ''; 20296c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 20306c72ffaaSAndy Whitcroft $res .= $1; 20316c72ffaaSAndy Whitcroft if ($2 ne '') { 20329c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 20336c72ffaaSAndy Whitcroft $res .= $coded; 20346c72ffaaSAndy Whitcroft } 20359c0ca6f9SAndy Whitcroft } 20369c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 20370a920b5bSAndy Whitcroft 20389c0ca6f9SAndy Whitcroft return $res; 20390a920b5bSAndy Whitcroft} 20400a920b5bSAndy Whitcroft 2041c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 2042cf655043SAndy Whitcroftmy $av_pending; 2043c2fdda0dSAndy Whitcroftmy @av_paren_type; 20441f65f947SAndy Whitcroftmy $av_pend_colon; 2045c2fdda0dSAndy Whitcroft 2046c2fdda0dSAndy Whitcroftsub annotate_reset { 2047c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 2048cf655043SAndy Whitcroft $av_pending = '_'; 2049cf655043SAndy Whitcroft @av_paren_type = ('E'); 20501f65f947SAndy Whitcroft $av_pend_colon = 'O'; 2051c2fdda0dSAndy Whitcroft} 2052c2fdda0dSAndy Whitcroft 20536c72ffaaSAndy Whitcroftsub annotate_values { 20546c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 20556c72ffaaSAndy Whitcroft 20566c72ffaaSAndy Whitcroft my $res; 20571f65f947SAndy Whitcroft my $var = '_' x length($stream); 20586c72ffaaSAndy Whitcroft my $cur = $stream; 20596c72ffaaSAndy Whitcroft 2060c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 20616c72ffaaSAndy Whitcroft 20626c72ffaaSAndy Whitcroft while (length($cur)) { 2063773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 2064cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 2065171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 20666c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 2067c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 2068c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 2069cf655043SAndy Whitcroft $type = pop(@av_paren_type); 2070c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 20716c72ffaaSAndy Whitcroft } 20726c72ffaaSAndy Whitcroft 2073c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 20749446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 20759446ef56SAndy Whitcroft push(@av_paren_type, $type); 2076addcdceaSAndy Whitcroft $type = 'c'; 20779446ef56SAndy Whitcroft 2078e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 2079c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 20806c72ffaaSAndy Whitcroft $type = 'T'; 20816c72ffaaSAndy Whitcroft 2082389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 2083389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 2084389a2fe5SAndy Whitcroft $type = 'T'; 2085389a2fe5SAndy Whitcroft 2086c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 2087171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 2088c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 2089171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 2090171ae1a4SAndy Whitcroft if ($2 ne '') { 2091cf655043SAndy Whitcroft $av_pending = 'N'; 2092171ae1a4SAndy Whitcroft } 2093171ae1a4SAndy Whitcroft $type = 'E'; 2094171ae1a4SAndy Whitcroft 2095c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 2096171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 2097171ae1a4SAndy Whitcroft $av_preprocessor = 1; 2098171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 20996c72ffaaSAndy Whitcroft 2100c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 2101cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 2102c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 2103cf655043SAndy Whitcroft 2104cf655043SAndy Whitcroft push(@av_paren_type, $type); 2105cf655043SAndy Whitcroft push(@av_paren_type, $type); 2106171ae1a4SAndy Whitcroft $type = 'E'; 2107cf655043SAndy Whitcroft 2108c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 2109cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 2110cf655043SAndy Whitcroft $av_preprocessor = 1; 2111cf655043SAndy Whitcroft 2112cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 2113cf655043SAndy Whitcroft 2114171ae1a4SAndy Whitcroft $type = 'E'; 2115cf655043SAndy Whitcroft 2116c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 2117cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 2118cf655043SAndy Whitcroft 2119cf655043SAndy Whitcroft $av_preprocessor = 1; 2120cf655043SAndy Whitcroft 2121cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 2122cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 2123cf655043SAndy Whitcroft pop(@av_paren_type); 2124cf655043SAndy Whitcroft push(@av_paren_type, $type); 2125171ae1a4SAndy Whitcroft $type = 'E'; 21266c72ffaaSAndy Whitcroft 21276c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 2128c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 21296c72ffaaSAndy Whitcroft 2130171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 2131171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 2132171ae1a4SAndy Whitcroft $av_pending = $type; 2133171ae1a4SAndy Whitcroft $type = 'N'; 2134171ae1a4SAndy Whitcroft 21356c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 2136c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 21376c72ffaaSAndy Whitcroft if (defined $2) { 2138cf655043SAndy Whitcroft $av_pending = 'V'; 21396c72ffaaSAndy Whitcroft } 21406c72ffaaSAndy Whitcroft $type = 'N'; 21416c72ffaaSAndy Whitcroft 214214b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 2143c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 214414b111c1SAndy Whitcroft $av_pending = 'E'; 21456c72ffaaSAndy Whitcroft $type = 'N'; 21466c72ffaaSAndy Whitcroft 21471f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 21481f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 21491f65f947SAndy Whitcroft $av_pend_colon = 'C'; 21501f65f947SAndy Whitcroft $type = 'N'; 21511f65f947SAndy Whitcroft 215214b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 2153c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 21546c72ffaaSAndy Whitcroft $type = 'N'; 21556c72ffaaSAndy Whitcroft 21566c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 2157c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 2158cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 2159cf655043SAndy Whitcroft $av_pending = '_'; 21606c72ffaaSAndy Whitcroft $type = 'N'; 21616c72ffaaSAndy Whitcroft 21626c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 2163cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 2164cf655043SAndy Whitcroft if ($new_type ne '_') { 2165cf655043SAndy Whitcroft $type = $new_type; 2166c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 2167c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 21686c72ffaaSAndy Whitcroft } else { 2169c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 21706c72ffaaSAndy Whitcroft } 21716c72ffaaSAndy Whitcroft 2172c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 2173c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 2174c8cb2ca3SAndy Whitcroft $type = 'V'; 2175cf655043SAndy Whitcroft $av_pending = 'V'; 21766c72ffaaSAndy Whitcroft 21778e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 21788e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 21791f65f947SAndy Whitcroft $av_pend_colon = 'B'; 21808e761b04SAndy Whitcroft } elsif ($type eq 'E') { 21818e761b04SAndy Whitcroft $av_pend_colon = 'L'; 21821f65f947SAndy Whitcroft } 21831f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 21841f65f947SAndy Whitcroft $type = 'V'; 21851f65f947SAndy Whitcroft 21866c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 2187c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 21886c72ffaaSAndy Whitcroft $type = 'V'; 21896c72ffaaSAndy Whitcroft 21906c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 2191c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 21926c72ffaaSAndy Whitcroft $type = 'N'; 21936c72ffaaSAndy Whitcroft 2194cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 2195c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 219613214adfSAndy Whitcroft $type = 'E'; 21971f65f947SAndy Whitcroft $av_pend_colon = 'O'; 219813214adfSAndy Whitcroft 21998e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 22008e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 22018e761b04SAndy Whitcroft $type = 'C'; 22028e761b04SAndy Whitcroft 22031f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 22041f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 22051f65f947SAndy Whitcroft $type = 'N'; 22061f65f947SAndy Whitcroft 22071f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 22081f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 22091f65f947SAndy Whitcroft 22101f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 22111f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 22121f65f947SAndy Whitcroft $type = 'E'; 22131f65f947SAndy Whitcroft } else { 22141f65f947SAndy Whitcroft $type = 'N'; 22151f65f947SAndy Whitcroft } 22161f65f947SAndy Whitcroft $av_pend_colon = 'O'; 22171f65f947SAndy Whitcroft 22188e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 221913214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 22206c72ffaaSAndy Whitcroft $type = 'N'; 22216c72ffaaSAndy Whitcroft 22220d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 222374048ed8SAndy Whitcroft my $variant; 222474048ed8SAndy Whitcroft 222574048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 222674048ed8SAndy Whitcroft if ($type eq 'V') { 222774048ed8SAndy Whitcroft $variant = 'B'; 222874048ed8SAndy Whitcroft } else { 222974048ed8SAndy Whitcroft $variant = 'U'; 223074048ed8SAndy Whitcroft } 223174048ed8SAndy Whitcroft 223274048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 223374048ed8SAndy Whitcroft $type = 'N'; 223474048ed8SAndy Whitcroft 22356c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 2236c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 22376c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 22386c72ffaaSAndy Whitcroft $type = 'N'; 22396c72ffaaSAndy Whitcroft } 22406c72ffaaSAndy Whitcroft 22416c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 2242c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 22436c72ffaaSAndy Whitcroft } 22446c72ffaaSAndy Whitcroft if (defined $1) { 22456c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 22466c72ffaaSAndy Whitcroft $res .= $type x length($1); 22476c72ffaaSAndy Whitcroft } 22486c72ffaaSAndy Whitcroft } 22496c72ffaaSAndy Whitcroft 22501f65f947SAndy Whitcroft return ($res, $var); 22516c72ffaaSAndy Whitcroft} 22526c72ffaaSAndy Whitcroft 22538905a67cSAndy Whitcroftsub possible { 225413214adfSAndy Whitcroft my ($possible, $line) = @_; 22559a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 22560776e594SAndy Whitcroft ^(?: 22570776e594SAndy Whitcroft $Modifier| 22580776e594SAndy Whitcroft $Storage| 22590776e594SAndy Whitcroft $Type| 22609a974fdbSAndy Whitcroft DEFINE_\S+ 22619a974fdbSAndy Whitcroft )$| 22629a974fdbSAndy Whitcroft ^(?: 22630776e594SAndy Whitcroft goto| 22640776e594SAndy Whitcroft return| 22650776e594SAndy Whitcroft case| 22660776e594SAndy Whitcroft else| 22670776e594SAndy Whitcroft asm|__asm__| 226889a88353SAndy Whitcroft do| 226989a88353SAndy Whitcroft \#| 227089a88353SAndy Whitcroft \#\#| 22719a974fdbSAndy Whitcroft )(?:\s|$)| 22720776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 22739a974fdbSAndy Whitcroft )}x; 22749a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 22759a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 2276c45dcabdSAndy Whitcroft # Check for modifiers. 2277c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 2278c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 2279c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 2280c45dcabdSAndy Whitcroft 2281c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 2282c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 2283d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 22849a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 2285d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 2286485ff23eSAlex Dowad push(@modifierListFile, $modifier); 2287d2506586SAndy Whitcroft } 22889a974fdbSAndy Whitcroft } 2289c45dcabdSAndy Whitcroft 2290c45dcabdSAndy Whitcroft } else { 229113214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 2292485ff23eSAlex Dowad push(@typeListFile, $possible); 2293c45dcabdSAndy Whitcroft } 22948905a67cSAndy Whitcroft build_types(); 22950776e594SAndy Whitcroft } else { 22960776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 22978905a67cSAndy Whitcroft } 22988905a67cSAndy Whitcroft} 22998905a67cSAndy Whitcroft 23006c72ffaaSAndy Whitcroftmy $prefix = ''; 23016c72ffaaSAndy Whitcroft 2302000d1cc1SJoe Perchessub show_type { 2303cbec18afSJoe Perches my ($type) = @_; 230491bfe484SJoe Perches 2305522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 2306522b837cSAlexey Dobriyan 2307cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 2308cbec18afSJoe Perches 2309cbec18afSJoe Perches return !defined $ignore_type{$type}; 2310000d1cc1SJoe Perches} 2311000d1cc1SJoe Perches 2312f0a594c1SAndy Whitcroftsub report { 2313cbec18afSJoe Perches my ($level, $type, $msg) = @_; 2314cbec18afSJoe Perches 2315cbec18afSJoe Perches if (!show_type($type) || 2316cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 2317773647a0SAndy Whitcroft return 0; 2318773647a0SAndy Whitcroft } 231957230297SJoe Perches my $output = ''; 2320737c0767SJohn Brooks if ($color) { 232157230297SJoe Perches if ($level eq 'ERROR') { 232257230297SJoe Perches $output .= RED; 232357230297SJoe Perches } elsif ($level eq 'WARNING') { 232457230297SJoe Perches $output .= YELLOW; 2325000d1cc1SJoe Perches } else { 232657230297SJoe Perches $output .= GREEN; 2327000d1cc1SJoe Perches } 232857230297SJoe Perches } 232957230297SJoe Perches $output .= $prefix . $level . ':'; 233057230297SJoe Perches if ($show_types) { 2331737c0767SJohn Brooks $output .= BLUE if ($color); 233257230297SJoe Perches $output .= "$type:"; 233357230297SJoe Perches } 2334737c0767SJohn Brooks $output .= RESET if ($color); 233557230297SJoe Perches $output .= ' ' . $msg . "\n"; 233634d8815fSJoe Perches 233734d8815fSJoe Perches if ($showfile) { 233834d8815fSJoe Perches my @lines = split("\n", $output, -1); 233934d8815fSJoe Perches splice(@lines, 1, 1); 234034d8815fSJoe Perches $output = join("\n", @lines); 234134d8815fSJoe Perches } 234252178ce0SDwaipayan Ray 234352178ce0SDwaipayan Ray if ($terse) { 234452178ce0SDwaipayan Ray $output = (split('\n', $output))[0] . "\n"; 234552178ce0SDwaipayan Ray } 234652178ce0SDwaipayan Ray 234752178ce0SDwaipayan Ray if ($verbose && exists($verbose_messages{$type}) && 234852178ce0SDwaipayan Ray !exists($verbose_emitted{$type})) { 234952178ce0SDwaipayan Ray $output .= $verbose_messages{$type} . "\n\n"; 235052178ce0SDwaipayan Ray $verbose_emitted{$type} = 1; 235152178ce0SDwaipayan Ray } 23528905a67cSAndy Whitcroft 235357230297SJoe Perches push(our @report, $output); 2354773647a0SAndy Whitcroft 2355773647a0SAndy Whitcroft return 1; 2356f0a594c1SAndy Whitcroft} 2357cbec18afSJoe Perches 2358f0a594c1SAndy Whitcroftsub report_dump { 235913214adfSAndy Whitcroft our @report; 2360f0a594c1SAndy Whitcroft} 2361000d1cc1SJoe Perches 2362d752fcc8SJoe Perchessub fixup_current_range { 2363d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 2364d752fcc8SJoe Perches 2365d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 2366d752fcc8SJoe Perches my $o = $1; 2367d752fcc8SJoe Perches my $l = $2; 2368d752fcc8SJoe Perches my $no = $o + $offset; 2369d752fcc8SJoe Perches my $nl = $l + $length; 2370d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 2371d752fcc8SJoe Perches } 2372d752fcc8SJoe Perches} 2373d752fcc8SJoe Perches 2374d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 2375d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 2376d752fcc8SJoe Perches 2377d752fcc8SJoe Perches my $range_last_linenr = 0; 2378d752fcc8SJoe Perches my $delta_offset = 0; 2379d752fcc8SJoe Perches 2380d752fcc8SJoe Perches my $old_linenr = 0; 2381d752fcc8SJoe Perches my $new_linenr = 0; 2382d752fcc8SJoe Perches 2383d752fcc8SJoe Perches my $next_insert = 0; 2384d752fcc8SJoe Perches my $next_delete = 0; 2385d752fcc8SJoe Perches 2386d752fcc8SJoe Perches my @lines = (); 2387d752fcc8SJoe Perches 2388d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 2389d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 2390d752fcc8SJoe Perches 2391d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 2392d752fcc8SJoe Perches my $save_line = 1; 2393d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 2394323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2395d752fcc8SJoe Perches $delta_offset = 0; 2396d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2397d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 2398d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 2399d752fcc8SJoe Perches } 2400d752fcc8SJoe Perches 2401d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2402d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 2403d752fcc8SJoe Perches $save_line = 0; 2404d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2405d752fcc8SJoe Perches } 2406d752fcc8SJoe Perches 2407d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2408d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 2409d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 2410d752fcc8SJoe Perches $new_linenr++; 2411d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2412d752fcc8SJoe Perches } 2413d752fcc8SJoe Perches 2414d752fcc8SJoe Perches if ($save_line) { 2415d752fcc8SJoe Perches push(@lines, $line); 2416d752fcc8SJoe Perches $new_linenr++; 2417d752fcc8SJoe Perches } 2418d752fcc8SJoe Perches 2419d752fcc8SJoe Perches $old_linenr++; 2420d752fcc8SJoe Perches } 2421d752fcc8SJoe Perches 2422d752fcc8SJoe Perches return @lines; 2423d752fcc8SJoe Perches} 2424d752fcc8SJoe Perches 2425f2d7e4d4SJoe Perchessub fix_insert_line { 2426f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2427f2d7e4d4SJoe Perches 2428f2d7e4d4SJoe Perches my $inserted = { 2429f2d7e4d4SJoe Perches LINENR => $linenr, 2430f2d7e4d4SJoe Perches LINE => $line, 2431f2d7e4d4SJoe Perches }; 2432f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2433f2d7e4d4SJoe Perches} 2434f2d7e4d4SJoe Perches 2435f2d7e4d4SJoe Perchessub fix_delete_line { 2436f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2437f2d7e4d4SJoe Perches 2438f2d7e4d4SJoe Perches my $deleted = { 2439f2d7e4d4SJoe Perches LINENR => $linenr, 2440f2d7e4d4SJoe Perches LINE => $line, 2441f2d7e4d4SJoe Perches }; 2442f2d7e4d4SJoe Perches 2443f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2444f2d7e4d4SJoe Perches} 2445f2d7e4d4SJoe Perches 2446de7d4f0eSAndy Whitcroftsub ERROR { 2447cbec18afSJoe Perches my ($type, $msg) = @_; 2448cbec18afSJoe Perches 2449cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2450de7d4f0eSAndy Whitcroft our $clean = 0; 24516c72ffaaSAndy Whitcroft our $cnt_error++; 24523705ce5bSJoe Perches return 1; 2453de7d4f0eSAndy Whitcroft } 24543705ce5bSJoe Perches return 0; 2455773647a0SAndy Whitcroft} 2456de7d4f0eSAndy Whitcroftsub WARN { 2457cbec18afSJoe Perches my ($type, $msg) = @_; 2458cbec18afSJoe Perches 2459cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2460de7d4f0eSAndy Whitcroft our $clean = 0; 24616c72ffaaSAndy Whitcroft our $cnt_warn++; 24623705ce5bSJoe Perches return 1; 2463de7d4f0eSAndy Whitcroft } 24643705ce5bSJoe Perches return 0; 2465773647a0SAndy Whitcroft} 2466de7d4f0eSAndy Whitcroftsub CHK { 2467cbec18afSJoe Perches my ($type, $msg) = @_; 2468cbec18afSJoe Perches 2469cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2470de7d4f0eSAndy Whitcroft our $clean = 0; 24716c72ffaaSAndy Whitcroft our $cnt_chk++; 24723705ce5bSJoe Perches return 1; 24736c72ffaaSAndy Whitcroft } 24743705ce5bSJoe Perches return 0; 2475de7d4f0eSAndy Whitcroft} 2476de7d4f0eSAndy Whitcroft 24776ecd9674SAndy Whitcroftsub check_absolute_file { 24786ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 24796ecd9674SAndy Whitcroft my $file = $absolute; 24806ecd9674SAndy Whitcroft 24816ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 24826ecd9674SAndy Whitcroft 24836ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 24846ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 24856ecd9674SAndy Whitcroft if (-f "$root/$file") { 24866ecd9674SAndy Whitcroft ##print "file<$file>\n"; 24876ecd9674SAndy Whitcroft last; 24886ecd9674SAndy Whitcroft } 24896ecd9674SAndy Whitcroft } 24906ecd9674SAndy Whitcroft if (! -f _) { 24916ecd9674SAndy Whitcroft return 0; 24926ecd9674SAndy Whitcroft } 24936ecd9674SAndy Whitcroft 24946ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 24956ecd9674SAndy Whitcroft my $prefix = $absolute; 24966ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 24976ecd9674SAndy Whitcroft 24986ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 24996ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2500000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2501000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 25026ecd9674SAndy Whitcroft } 25036ecd9674SAndy Whitcroft} 25046ecd9674SAndy Whitcroft 25053705ce5bSJoe Perchessub trim { 25063705ce5bSJoe Perches my ($string) = @_; 25073705ce5bSJoe Perches 2508b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2509b34c648bSJoe Perches 2510b34c648bSJoe Perches return $string; 2511b34c648bSJoe Perches} 2512b34c648bSJoe Perches 2513b34c648bSJoe Perchessub ltrim { 2514b34c648bSJoe Perches my ($string) = @_; 2515b34c648bSJoe Perches 2516b34c648bSJoe Perches $string =~ s/^\s+//; 2517b34c648bSJoe Perches 2518b34c648bSJoe Perches return $string; 2519b34c648bSJoe Perches} 2520b34c648bSJoe Perches 2521b34c648bSJoe Perchessub rtrim { 2522b34c648bSJoe Perches my ($string) = @_; 2523b34c648bSJoe Perches 2524b34c648bSJoe Perches $string =~ s/\s+$//; 25253705ce5bSJoe Perches 25263705ce5bSJoe Perches return $string; 25273705ce5bSJoe Perches} 25283705ce5bSJoe Perches 252952ea8506SJoe Perchessub string_find_replace { 253052ea8506SJoe Perches my ($string, $find, $replace) = @_; 253152ea8506SJoe Perches 253252ea8506SJoe Perches $string =~ s/$find/$replace/g; 253352ea8506SJoe Perches 253452ea8506SJoe Perches return $string; 253552ea8506SJoe Perches} 253652ea8506SJoe Perches 25373705ce5bSJoe Perchessub tabify { 25383705ce5bSJoe Perches my ($leading) = @_; 25393705ce5bSJoe Perches 2540713a09deSAntonio Borneo my $source_indent = $tabsize; 25413705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 25423705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 25433705ce5bSJoe Perches 25443705ce5bSJoe Perches #convert leading spaces to tabs 25453705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 25463705ce5bSJoe Perches #Remove spaces before a tab 25473705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 25483705ce5bSJoe Perches 25493705ce5bSJoe Perches return "$leading"; 25503705ce5bSJoe Perches} 25513705ce5bSJoe Perches 2552d1fe9c09SJoe Perchessub pos_last_openparen { 2553d1fe9c09SJoe Perches my ($line) = @_; 2554d1fe9c09SJoe Perches 2555d1fe9c09SJoe Perches my $pos = 0; 2556d1fe9c09SJoe Perches 2557d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2558d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2559d1fe9c09SJoe Perches 2560d1fe9c09SJoe Perches my $last_openparen = 0; 2561d1fe9c09SJoe Perches 2562d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2563d1fe9c09SJoe Perches return -1; 2564d1fe9c09SJoe Perches } 2565d1fe9c09SJoe Perches 2566d1fe9c09SJoe Perches my $len = length($line); 2567d1fe9c09SJoe Perches 2568d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2569d1fe9c09SJoe Perches my $string = substr($line, $pos); 2570d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2571d1fe9c09SJoe Perches $pos += length($1) - 1; 2572d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2573d1fe9c09SJoe Perches $last_openparen = $pos; 2574d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2575d1fe9c09SJoe Perches last; 2576d1fe9c09SJoe Perches } 2577d1fe9c09SJoe Perches } 2578d1fe9c09SJoe Perches 257991cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2580d1fe9c09SJoe Perches} 2581d1fe9c09SJoe Perches 2582f36d3eb8SJoe Perchessub get_raw_comment { 2583f36d3eb8SJoe Perches my ($line, $rawline) = @_; 2584f36d3eb8SJoe Perches my $comment = ''; 2585f36d3eb8SJoe Perches 2586f36d3eb8SJoe Perches for my $i (0 .. (length($line) - 1)) { 2587f36d3eb8SJoe Perches if (substr($line, $i, 1) eq "$;") { 2588f36d3eb8SJoe Perches $comment .= substr($rawline, $i, 1); 2589f36d3eb8SJoe Perches } 2590f36d3eb8SJoe Perches } 2591f36d3eb8SJoe Perches 2592f36d3eb8SJoe Perches return $comment; 2593f36d3eb8SJoe Perches} 2594f36d3eb8SJoe Perches 25955b8f82e1SSong Liusub exclude_global_initialisers { 25965b8f82e1SSong Liu my ($realfile) = @_; 25975b8f82e1SSong Liu 25985b8f82e1SSong Liu # Do not check for BPF programs (tools/testing/selftests/bpf/progs/*.c, samples/bpf/*_kern.c, *.bpf.c). 25995b8f82e1SSong Liu return $realfile =~ m@^tools/testing/selftests/bpf/progs/.*\.c$@ || 26005b8f82e1SSong Liu $realfile =~ m@^samples/bpf/.*_kern\.c$@ || 26015b8f82e1SSong Liu $realfile =~ m@/bpf/.*\.bpf\.c$@; 26025b8f82e1SSong Liu} 26035b8f82e1SSong Liu 26040a920b5bSAndy Whitcroftsub process { 26050a920b5bSAndy Whitcroft my $filename = shift; 26060a920b5bSAndy Whitcroft 26070a920b5bSAndy Whitcroft my $linenr=0; 26080a920b5bSAndy Whitcroft my $prevline=""; 2609c2fdda0dSAndy Whitcroft my $prevrawline=""; 26100a920b5bSAndy Whitcroft my $stashline=""; 2611c2fdda0dSAndy Whitcroft my $stashrawline=""; 26120a920b5bSAndy Whitcroft 26134a0df2efSAndy Whitcroft my $length; 26140a920b5bSAndy Whitcroft my $indent; 26150a920b5bSAndy Whitcroft my $previndent=0; 26160a920b5bSAndy Whitcroft my $stashindent=0; 26170a920b5bSAndy Whitcroft 2618de7d4f0eSAndy Whitcroft our $clean = 1; 26190a920b5bSAndy Whitcroft my $signoff = 0; 2620cd261496SGeert Uytterhoeven my $author = ''; 2621cd261496SGeert Uytterhoeven my $authorsignoff = 0; 262248ca2d8aSDwaipayan Ray my $author_sob = ''; 26230a920b5bSAndy Whitcroft my $is_patch = 0; 2624133712a2SRob Herring my $is_binding_patch = -1; 262529ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 262615662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 262744d303ebSJoe Perches my $has_patch_separator = 0; #Found a --- line 2628ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2629490b292cSJoe Perches my $commit_log_lines = 0; #Number of commit log lines 2630bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 26312a076f40SJoe Perches my $commit_log_long_line = 0; 2632e518e9a5SJoe Perches my $commit_log_has_diff = 0; 263313f1937eSJoe Perches my $reported_maintainer_file = 0; 2634fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2635fa64205dSPasi Savanainen 26364ce9f970SJoe Perches my $last_git_commit_id_linenr = -1; 26374ce9f970SJoe Perches 2638365dd4eaSJoe Perches my $last_blank_line = 0; 26395e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2640365dd4eaSJoe Perches 264113214adfSAndy Whitcroft our @report = (); 26426c72ffaaSAndy Whitcroft our $cnt_lines = 0; 26436c72ffaaSAndy Whitcroft our $cnt_error = 0; 26446c72ffaaSAndy Whitcroft our $cnt_warn = 0; 26456c72ffaaSAndy Whitcroft our $cnt_chk = 0; 26466c72ffaaSAndy Whitcroft 26470a920b5bSAndy Whitcroft # Trace the real file/line as we go. 26480a920b5bSAndy Whitcroft my $realfile = ''; 26490a920b5bSAndy Whitcroft my $realline = 0; 26500a920b5bSAndy Whitcroft my $realcnt = 0; 26510a920b5bSAndy Whitcroft my $here = ''; 265277cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 26530a920b5bSAndy Whitcroft my $in_comment = 0; 2654c2fdda0dSAndy Whitcroft my $comment_edge = 0; 26550a920b5bSAndy Whitcroft my $first_line = 0; 26561e855726SWolfram Sang my $p1_prefix = ''; 26570a920b5bSAndy Whitcroft 265813214adfSAndy Whitcroft my $prev_values = 'E'; 265913214adfSAndy Whitcroft 266013214adfSAndy Whitcroft # suppression flags 2661773647a0SAndy Whitcroft my %suppress_ifbraces; 2662170d3a22SAndy Whitcroft my %suppress_whiletrailers; 26632b474a1aSAndy Whitcroft my %suppress_export; 26643e469cdcSAndy Whitcroft my $suppress_statement = 0; 2665653d4876SAndy Whitcroft 26667e51f197SJoe Perches my %signatures = (); 2667323c1260SJoe Perches 2668c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2669de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2670c2fdda0dSAndy Whitcroft # 2671de7d4f0eSAndy Whitcroft my @setup_docs = (); 2672de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2673773647a0SAndy Whitcroft 2674d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2675d8b07710SJoe Perches 26769f3a8992SRob Herring my $checklicenseline = 1; 26779f3a8992SRob Herring 2678773647a0SAndy Whitcroft sanitise_line_reset(); 2679c2fdda0dSAndy Whitcroft my $line; 2680c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2681773647a0SAndy Whitcroft $linenr++; 2682773647a0SAndy Whitcroft $line = $rawline; 2683c2fdda0dSAndy Whitcroft 26843705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 26853705ce5bSJoe Perches 2686773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2687de7d4f0eSAndy Whitcroft $setup_docs = 0; 26882581ac7cSTim Froidcoeur if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) { 2689de7d4f0eSAndy Whitcroft $setup_docs = 1; 2690de7d4f0eSAndy Whitcroft } 2691773647a0SAndy Whitcroft #next; 2692de7d4f0eSAndy Whitcroft } 269374fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2694773647a0SAndy Whitcroft $realline=$1-1; 2695773647a0SAndy Whitcroft if (defined $2) { 2696773647a0SAndy Whitcroft $realcnt=$3+1; 2697773647a0SAndy Whitcroft } else { 2698773647a0SAndy Whitcroft $realcnt=1+1; 2699773647a0SAndy Whitcroft } 2700c45dcabdSAndy Whitcroft $in_comment = 0; 2701773647a0SAndy Whitcroft 2702773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2703773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2704773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2705773647a0SAndy Whitcroft # at context start. 2706773647a0SAndy Whitcroft my $edge; 270701fa9147SAndy Whitcroft my $cnt = $realcnt; 270801fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 270901fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 271001fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 271101fa9147SAndy Whitcroft $cnt--; 271201fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2713721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2714fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2715fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2716fae17daeSAndy Whitcroft ($edge) = $1; 2717fae17daeSAndy Whitcroft last; 2718fae17daeSAndy Whitcroft } 2719773647a0SAndy Whitcroft } 2720773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2721773647a0SAndy Whitcroft $in_comment = 1; 2722773647a0SAndy Whitcroft } 2723773647a0SAndy Whitcroft 2724773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2725773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2726773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2727773647a0SAndy Whitcroft if (!defined $edge && 272883242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2729773647a0SAndy Whitcroft { 2730773647a0SAndy Whitcroft $in_comment = 1; 2731773647a0SAndy Whitcroft } 2732773647a0SAndy Whitcroft 2733773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2734773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2735773647a0SAndy Whitcroft 2736171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2737773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2738171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2739773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2740773647a0SAndy Whitcroft } 2741773647a0SAndy Whitcroft push(@lines, $line); 2742773647a0SAndy Whitcroft 2743773647a0SAndy Whitcroft if ($realcnt > 1) { 2744773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2745773647a0SAndy Whitcroft } else { 2746773647a0SAndy Whitcroft $realcnt = 0; 2747773647a0SAndy Whitcroft } 2748773647a0SAndy Whitcroft 2749773647a0SAndy Whitcroft #print "==>$rawline\n"; 2750773647a0SAndy Whitcroft #print "-->$line\n"; 2751de7d4f0eSAndy Whitcroft 2752de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2753de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2754de7d4f0eSAndy Whitcroft } 2755de7d4f0eSAndy Whitcroft } 2756de7d4f0eSAndy Whitcroft 27576c72ffaaSAndy Whitcroft $prefix = ''; 27586c72ffaaSAndy Whitcroft 2759773647a0SAndy Whitcroft $realcnt = 0; 2760773647a0SAndy Whitcroft $linenr = 0; 2761194f66fcSJoe Perches $fixlinenr = -1; 27620a920b5bSAndy Whitcroft foreach my $line (@lines) { 27630a920b5bSAndy Whitcroft $linenr++; 2764194f66fcSJoe Perches $fixlinenr++; 27651b5539b1SJoe Perches my $sline = $line; #copy of $line 27661b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 27670a920b5bSAndy Whitcroft 2768c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 2769f36d3eb8SJoe Perches my $raw_comment = get_raw_comment($line, $rawline); 27706c72ffaaSAndy Whitcroft 277112c253abSJoe Perches# check if it's a mode change, rename or start of a patch 277212c253abSJoe Perches if (!$in_commit_log && 277312c253abSJoe Perches ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 277412c253abSJoe Perches ($line =~ /^rename (?:from|to) \S+\s*$/ || 277512c253abSJoe Perches $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 277612c253abSJoe Perches $is_patch = 1; 277712c253abSJoe Perches } 277812c253abSJoe Perches 27790a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2780e518e9a5SJoe Perches if (!$in_commit_log && 278174fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 278274fd4f34SJoe Perches my $context = $4; 27830a920b5bSAndy Whitcroft $is_patch = 1; 27844a0df2efSAndy Whitcroft $first_line = $linenr + 1; 27850a920b5bSAndy Whitcroft $realline=$1-1; 27860a920b5bSAndy Whitcroft if (defined $2) { 27870a920b5bSAndy Whitcroft $realcnt=$3+1; 27880a920b5bSAndy Whitcroft } else { 27890a920b5bSAndy Whitcroft $realcnt=1+1; 27900a920b5bSAndy Whitcroft } 2791c2fdda0dSAndy Whitcroft annotate_reset(); 279213214adfSAndy Whitcroft $prev_values = 'E'; 279313214adfSAndy Whitcroft 2794773647a0SAndy Whitcroft %suppress_ifbraces = (); 2795170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 27962b474a1aSAndy Whitcroft %suppress_export = (); 27973e469cdcSAndy Whitcroft $suppress_statement = 0; 279874fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 279974fd4f34SJoe Perches $context_function = $1; 280074fd4f34SJoe Perches } else { 280174fd4f34SJoe Perches undef $context_function; 280274fd4f34SJoe Perches } 28030a920b5bSAndy Whitcroft next; 28040a920b5bSAndy Whitcroft 28054a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 28064a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 28074a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2808773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 28090a920b5bSAndy Whitcroft $realline++; 2810d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 28110a920b5bSAndy Whitcroft 28124a0df2efSAndy Whitcroft # Measure the line length and indent. 2813c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 28140a920b5bSAndy Whitcroft 28150a920b5bSAndy Whitcroft # Track the previous line. 28160a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 28170a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2818c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2819c2fdda0dSAndy Whitcroft 2820773647a0SAndy Whitcroft #warn "line<$line>\n"; 28216c72ffaaSAndy Whitcroft 2822d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2823d8aaf121SAndy Whitcroft $realcnt--; 28240a920b5bSAndy Whitcroft } 28250a920b5bSAndy Whitcroft 2826cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2827cc77cdcaSAndy Whitcroft 28286c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 28296c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2830773647a0SAndy Whitcroft 28312ac73b4fSJoe Perches my $found_file = 0; 2832773647a0SAndy Whitcroft # extract the filename as it passes 28333bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 28343bf9a009SRabin Vincent $realfile = $1; 28352b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2836270c49a0SJoe Perches $in_commit_log = 0; 28372ac73b4fSJoe Perches $found_file = 1; 28383bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2839773647a0SAndy Whitcroft $realfile = $1; 28402b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2841270c49a0SJoe Perches $in_commit_log = 0; 28421e855726SWolfram Sang 28431e855726SWolfram Sang $p1_prefix = $1; 2844e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2845e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2846000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2847000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 28481e855726SWolfram Sang } 2849773647a0SAndy Whitcroft 2850c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2851000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2852000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2853773647a0SAndy Whitcroft } 28542ac73b4fSJoe Perches $found_file = 1; 28552ac73b4fSJoe Perches } 28562ac73b4fSJoe Perches 285734d8815fSJoe Perches#make up the handle for any error we report on this line 285834d8815fSJoe Perches if ($showfile) { 285934d8815fSJoe Perches $prefix = "$realfile:$realline: " 286034d8815fSJoe Perches } elsif ($emacs) { 28617d3a9f67SJoe Perches if ($file) { 28627d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 28637d3a9f67SJoe Perches } else { 286434d8815fSJoe Perches $prefix = "$filename:$linenr: "; 286534d8815fSJoe Perches } 28667d3a9f67SJoe Perches } 286734d8815fSJoe Perches 28682ac73b4fSJoe Perches if ($found_file) { 286985b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 287085b0ee18SJoe Perches WARN("OBSOLETE", 287185b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 287285b0ee18SJoe Perches } 28737bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 28742ac73b4fSJoe Perches $check = 1; 28752ac73b4fSJoe Perches } else { 28762ac73b4fSJoe Perches $check = $check_orig; 28772ac73b4fSJoe Perches } 28789f3a8992SRob Herring $checklicenseline = 1; 2879133712a2SRob Herring 2880133712a2SRob Herring if ($realfile !~ /^MAINTAINERS/) { 2881133712a2SRob Herring my $last_binding_patch = $is_binding_patch; 2882133712a2SRob Herring 2883133712a2SRob Herring $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@; 2884133712a2SRob Herring 2885133712a2SRob Herring if (($last_binding_patch != -1) && 2886133712a2SRob Herring ($last_binding_patch ^ $is_binding_patch)) { 2887133712a2SRob Herring WARN("DT_SPLIT_BINDING_PATCH", 2888858e6845SMauro Carvalho Chehab "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n"); 2889133712a2SRob Herring } 2890133712a2SRob Herring } 2891133712a2SRob Herring 2892773647a0SAndy Whitcroft next; 2893773647a0SAndy Whitcroft } 2894773647a0SAndy Whitcroft 2895389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 28960a920b5bSAndy Whitcroft 2897c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2898c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2899c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 29000a920b5bSAndy Whitcroft 29016c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 29026c72ffaaSAndy Whitcroft 2903490b292cSJoe Perches# Verify the existence of a commit log if appropriate 2904490b292cSJoe Perches# 2 is used because a $signature is counted in $commit_log_lines 2905490b292cSJoe Perches if ($in_commit_log) { 2906490b292cSJoe Perches if ($line !~ /^\s*$/) { 2907490b292cSJoe Perches $commit_log_lines++; #could be a $signature 2908490b292cSJoe Perches } 2909490b292cSJoe Perches } elsif ($has_commit_log && $commit_log_lines < 2) { 2910490b292cSJoe Perches WARN("COMMIT_MESSAGE", 2911490b292cSJoe Perches "Missing commit description - Add an appropriate one\n"); 2912490b292cSJoe Perches $commit_log_lines = 2; #warn only once 2913490b292cSJoe Perches } 2914490b292cSJoe Perches 2915e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2916e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 291713e45417SMrinal Pandey (($line =~ m@^\s+diff\b.*a/([\w/]+)@ && 291813e45417SMrinal Pandey $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) || 2919e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2920e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2921e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2922e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2923e518e9a5SJoe Perches $commit_log_has_diff = 1; 2924e518e9a5SJoe Perches } 2925e518e9a5SJoe Perches 29263bf9a009SRabin Vincent# Check for incorrect file permissions 29273bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 29283bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 292904db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 293004db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2931000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2932000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 29333bf9a009SRabin Vincent } 29343bf9a009SRabin Vincent } 29353bf9a009SRabin Vincent 2936cd261496SGeert Uytterhoeven# Check the patch for a From: 2937cd261496SGeert Uytterhoeven if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { 2938cd261496SGeert Uytterhoeven $author = $1; 2939e7f929f3SDwaipayan Ray my $curline = $linenr; 2940e7f929f3SDwaipayan Ray while(defined($rawlines[$curline]) && ($rawlines[$curline++] =~ /^[ \t]\s*(.*)/)) { 2941e7f929f3SDwaipayan Ray $author .= $1; 2942e7f929f3SDwaipayan Ray } 2943cd261496SGeert Uytterhoeven $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); 2944cd261496SGeert Uytterhoeven $author =~ s/"//g; 2945dfa05c28SJoe Perches $author = reformat_email($author); 2946cd261496SGeert Uytterhoeven } 2947cd261496SGeert Uytterhoeven 294820112475SJoe Perches# Check the patch for a signoff: 2949dfa05c28SJoe Perches if ($line =~ /^\s*signed-off-by:\s*(.*)/i) { 29504a0df2efSAndy Whitcroft $signoff++; 295115662b3eSJoe Perches $in_commit_log = 0; 295248ca2d8aSDwaipayan Ray if ($author ne '' && $authorsignoff != 1) { 2953fccaebf0SDwaipayan Ray if (same_email_addresses($1, $author)) { 2954cd261496SGeert Uytterhoeven $authorsignoff = 1; 295548ca2d8aSDwaipayan Ray } else { 295648ca2d8aSDwaipayan Ray my $ctx = $1; 295748ca2d8aSDwaipayan Ray my ($email_name, $email_comment, $email_address, $comment1) = parse_email($ctx); 295848ca2d8aSDwaipayan Ray my ($author_name, $author_comment, $author_address, $comment2) = parse_email($author); 295948ca2d8aSDwaipayan Ray 2960046fc741SMimi Zohar if (lc $email_address eq lc $author_address && $email_name eq $author_name) { 296148ca2d8aSDwaipayan Ray $author_sob = $ctx; 296248ca2d8aSDwaipayan Ray $authorsignoff = 2; 2963046fc741SMimi Zohar } elsif (lc $email_address eq lc $author_address) { 296448ca2d8aSDwaipayan Ray $author_sob = $ctx; 296548ca2d8aSDwaipayan Ray $authorsignoff = 3; 296648ca2d8aSDwaipayan Ray } elsif ($email_name eq $author_name) { 296748ca2d8aSDwaipayan Ray $author_sob = $ctx; 296848ca2d8aSDwaipayan Ray $authorsignoff = 4; 296948ca2d8aSDwaipayan Ray 297048ca2d8aSDwaipayan Ray my $address1 = $email_address; 297148ca2d8aSDwaipayan Ray my $address2 = $author_address; 297248ca2d8aSDwaipayan Ray 297348ca2d8aSDwaipayan Ray if ($address1 =~ /(\S+)\+\S+(\@.*)/) { 297448ca2d8aSDwaipayan Ray $address1 = "$1$2"; 297548ca2d8aSDwaipayan Ray } 297648ca2d8aSDwaipayan Ray if ($address2 =~ /(\S+)\+\S+(\@.*)/) { 297748ca2d8aSDwaipayan Ray $address2 = "$1$2"; 297848ca2d8aSDwaipayan Ray } 297948ca2d8aSDwaipayan Ray if ($address1 eq $address2) { 298048ca2d8aSDwaipayan Ray $authorsignoff = 5; 298148ca2d8aSDwaipayan Ray } 298248ca2d8aSDwaipayan Ray } 2983cd261496SGeert Uytterhoeven } 2984cd261496SGeert Uytterhoeven } 29850a920b5bSAndy Whitcroft } 298620112475SJoe Perches 298744d303ebSJoe Perches# Check for patch separator 298844d303ebSJoe Perches if ($line =~ /^---$/) { 298944d303ebSJoe Perches $has_patch_separator = 1; 299044d303ebSJoe Perches $in_commit_log = 0; 299144d303ebSJoe Perches } 299244d303ebSJoe Perches 2993e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2994e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2995e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2996e0d975b1SJoe Perches $reported_maintainer_file = 1; 2997e0d975b1SJoe Perches } 2998e0d975b1SJoe Perches 299920112475SJoe Perches# Check signature styles 3000270c49a0SJoe Perches if (!$in_header_lines && 3001ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 300220112475SJoe Perches my $space_before = $1; 300320112475SJoe Perches my $sign_off = $2; 300420112475SJoe Perches my $space_after = $3; 300520112475SJoe Perches my $email = $4; 300620112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 300720112475SJoe Perches 3008ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 3009831242abSAditya Srivastava my $suggested_signature = find_standard_signature($sign_off); 3010831242abSAditya Srivastava if ($suggested_signature eq "") { 3011ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 3012ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 3013831242abSAditya Srivastava } else { 3014831242abSAditya Srivastava if (WARN("BAD_SIGN_OFF", 3015831242abSAditya Srivastava "Non-standard signature: '$sign_off' - perhaps '$suggested_signature'?\n" . $herecurr) && 3016831242abSAditya Srivastava $fix) { 3017831242abSAditya Srivastava $fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/; 3018831242abSAditya Srivastava } 3019831242abSAditya Srivastava } 3020ce0338dfSJoe Perches } 302120112475SJoe Perches if (defined $space_before && $space_before ne "") { 30223705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 30233705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 30243705ce5bSJoe Perches $fix) { 3025194f66fcSJoe Perches $fixed[$fixlinenr] = 30263705ce5bSJoe Perches "$ucfirst_sign_off $email"; 30273705ce5bSJoe Perches } 302820112475SJoe Perches } 302920112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 30303705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 30313705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 30323705ce5bSJoe Perches $fix) { 3033194f66fcSJoe Perches $fixed[$fixlinenr] = 30343705ce5bSJoe Perches "$ucfirst_sign_off $email"; 30353705ce5bSJoe Perches } 30363705ce5bSJoe Perches 303720112475SJoe Perches } 303820112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 30393705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 30403705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 30413705ce5bSJoe Perches $fix) { 3042194f66fcSJoe Perches $fixed[$fixlinenr] = 30433705ce5bSJoe Perches "$ucfirst_sign_off $email"; 30443705ce5bSJoe Perches } 304520112475SJoe Perches } 304620112475SJoe Perches 3047dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 304848ca2d8aSDwaipayan Ray my $suggested_email = format_email(($email_name, $name_comment, $email_address, $comment)); 304920112475SJoe Perches if ($suggested_email eq "") { 3050000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 3051000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 305220112475SJoe Perches } else { 305320112475SJoe Perches my $dequoted = $suggested_email; 305420112475SJoe Perches $dequoted =~ s/^"//; 305520112475SJoe Perches $dequoted =~ s/" </ </; 305620112475SJoe Perches # Don't force email to have quotes 305720112475SJoe Perches # Allow just an angle bracketed address 3058fccaebf0SDwaipayan Ray if (!same_email_addresses($email, $suggested_email)) { 3059fccaebf0SDwaipayan Ray if (WARN("BAD_SIGN_OFF", 3060fccaebf0SDwaipayan Ray "email address '$email' might be better as '$suggested_email'\n" . $herecurr) && 3061fccaebf0SDwaipayan Ray $fix) { 3062fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email\E/$suggested_email/; 3063fccaebf0SDwaipayan Ray } 3064fccaebf0SDwaipayan Ray } 3065fccaebf0SDwaipayan Ray 3066fccaebf0SDwaipayan Ray # Address part shouldn't have comments 3067fccaebf0SDwaipayan Ray my $stripped_address = $email_address; 3068fccaebf0SDwaipayan Ray $stripped_address =~ s/\([^\(\)]*\)//g; 3069fccaebf0SDwaipayan Ray if ($email_address ne $stripped_address) { 3070fccaebf0SDwaipayan Ray if (WARN("BAD_SIGN_OFF", 3071fccaebf0SDwaipayan Ray "address part of email should not have comments: '$email_address'\n" . $herecurr) && 3072fccaebf0SDwaipayan Ray $fix) { 3073fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email_address\E/$stripped_address/; 3074fccaebf0SDwaipayan Ray } 3075fccaebf0SDwaipayan Ray } 3076fccaebf0SDwaipayan Ray 3077fccaebf0SDwaipayan Ray # Only one name comment should be allowed 3078fccaebf0SDwaipayan Ray my $comment_count = () = $name_comment =~ /\([^\)]+\)/g; 3079fccaebf0SDwaipayan Ray if ($comment_count > 1) { 3080000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 3081fccaebf0SDwaipayan Ray "Use a single name comment in email: '$email'\n" . $herecurr); 3082fccaebf0SDwaipayan Ray } 3083fccaebf0SDwaipayan Ray 3084fccaebf0SDwaipayan Ray 3085fccaebf0SDwaipayan Ray # [email protected] or [email protected] shouldn't 3086e73d2715SDwaipayan Ray # have an email name. In addition comments should strictly 3087fccaebf0SDwaipayan Ray # begin with a # 3088fccaebf0SDwaipayan Ray if ($email =~ /^.*stable\@(?:vger\.)?kernel\.org/i) { 3089fccaebf0SDwaipayan Ray if (($comment ne "" && $comment !~ /^#.+/) || 3090fccaebf0SDwaipayan Ray ($email_name ne "")) { 3091fccaebf0SDwaipayan Ray my $cur_name = $email_name; 3092fccaebf0SDwaipayan Ray my $new_comment = $comment; 3093fccaebf0SDwaipayan Ray $cur_name =~ s/[a-zA-Z\s\-\"]+//g; 3094fccaebf0SDwaipayan Ray 3095fccaebf0SDwaipayan Ray # Remove brackets enclosing comment text 3096fccaebf0SDwaipayan Ray # and # from start of comments to get comment text 3097fccaebf0SDwaipayan Ray $new_comment =~ s/^\((.*)\)$/$1/; 3098fccaebf0SDwaipayan Ray $new_comment =~ s/^\[(.*)\]$/$1/; 3099fccaebf0SDwaipayan Ray $new_comment =~ s/^[\s\#]+|\s+$//g; 3100fccaebf0SDwaipayan Ray 3101fccaebf0SDwaipayan Ray $new_comment = trim("$new_comment $cur_name") if ($cur_name ne $new_comment); 3102fccaebf0SDwaipayan Ray $new_comment = " # $new_comment" if ($new_comment ne ""); 3103fccaebf0SDwaipayan Ray my $new_email = "$email_address$new_comment"; 3104fccaebf0SDwaipayan Ray 3105fccaebf0SDwaipayan Ray if (WARN("BAD_STABLE_ADDRESS_STYLE", 3106fccaebf0SDwaipayan Ray "Invalid email format for stable: '$email', prefer '$new_email'\n" . $herecurr) && 3107fccaebf0SDwaipayan Ray $fix) { 3108fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/; 3109fccaebf0SDwaipayan Ray } 3110fccaebf0SDwaipayan Ray } 3111fccaebf0SDwaipayan Ray } elsif ($comment ne "" && $comment !~ /^(?:#.+|\(.+\))$/) { 3112fccaebf0SDwaipayan Ray my $new_comment = $comment; 3113fccaebf0SDwaipayan Ray 3114fccaebf0SDwaipayan Ray # Extract comment text from within brackets or 3115fccaebf0SDwaipayan Ray # c89 style /*...*/ comments 3116fccaebf0SDwaipayan Ray $new_comment =~ s/^\[(.*)\]$/$1/; 3117fccaebf0SDwaipayan Ray $new_comment =~ s/^\/\*(.*)\*\/$/$1/; 3118fccaebf0SDwaipayan Ray 3119fccaebf0SDwaipayan Ray $new_comment = trim($new_comment); 3120fccaebf0SDwaipayan Ray $new_comment =~ s/^[^\w]$//; # Single lettered comment with non word character is usually a typo 3121fccaebf0SDwaipayan Ray $new_comment = "($new_comment)" if ($new_comment ne ""); 3122fccaebf0SDwaipayan Ray my $new_email = format_email($email_name, $name_comment, $email_address, $new_comment); 3123fccaebf0SDwaipayan Ray 3124fccaebf0SDwaipayan Ray if (WARN("BAD_SIGN_OFF", 3125fccaebf0SDwaipayan Ray "Unexpected content after email: '$email', should be: '$new_email'\n" . $herecurr) && 3126fccaebf0SDwaipayan Ray $fix) { 3127fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/; 3128fccaebf0SDwaipayan Ray } 312920112475SJoe Perches } 31300a920b5bSAndy Whitcroft } 31317e51f197SJoe Perches 31327e51f197SJoe Perches# Check for duplicate signatures 31337e51f197SJoe Perches my $sig_nospace = $line; 31347e51f197SJoe Perches $sig_nospace =~ s/\s//g; 31357e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 31367e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 31377e51f197SJoe Perches WARN("BAD_SIGN_OFF", 31387e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 31397e51f197SJoe Perches } else { 31407e51f197SJoe Perches $signatures{$sig_nospace} = 1; 31417e51f197SJoe Perches } 31426c5d24eeSSean Christopherson 31436c5d24eeSSean Christopherson# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email 31446c5d24eeSSean Christopherson if ($sign_off =~ /^co-developed-by:$/i) { 31456c5d24eeSSean Christopherson if ($email eq $author) { 31466c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31476c5d24eeSSean Christopherson "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline); 31486c5d24eeSSean Christopherson } 31496c5d24eeSSean Christopherson if (!defined $lines[$linenr]) { 31506c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31516c5d24eeSSean Christopherson "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline); 31526c5d24eeSSean Christopherson } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) { 31536c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31546c5d24eeSSean Christopherson "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 31556c5d24eeSSean Christopherson } elsif ($1 ne $email) { 31566c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31576c5d24eeSSean Christopherson "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 31586c5d24eeSSean Christopherson } 31596c5d24eeSSean Christopherson } 3160*d7f1d71eSKai Wasserbäch 3161*d7f1d71eSKai Wasserbäch# check if Reported-by: is followed by a Link: 3162*d7f1d71eSKai Wasserbäch if ($sign_off =~ /^reported(?:|-and-tested)-by:$/i) { 3163*d7f1d71eSKai Wasserbäch if (!defined $lines[$linenr]) { 3164*d7f1d71eSKai Wasserbäch WARN("BAD_REPORTED_BY_LINK", 3165*d7f1d71eSKai Wasserbäch "Reported-by: should be immediately followed by Link: to the report\n" . $herecurr . $rawlines[$linenr] . "\n"); 3166*d7f1d71eSKai Wasserbäch } elsif ($rawlines[$linenr] !~ m{^link:\s*https?://}i) { 3167*d7f1d71eSKai Wasserbäch WARN("BAD_REPORTED_BY_LINK", 3168*d7f1d71eSKai Wasserbäch "Reported-by: should be immediately followed by Link: with a URL to the report\n" . $herecurr . $rawlines[$linenr] . "\n"); 31690a920b5bSAndy Whitcroft } 3170*d7f1d71eSKai Wasserbäch } 3171*d7f1d71eSKai Wasserbäch } 3172*d7f1d71eSKai Wasserbäch 31730a920b5bSAndy Whitcroft 3174bd17e036SNiklas Söderlund# Check Fixes: styles is correct 3175bd17e036SNiklas Söderlund if (!$in_header_lines && 3176bd17e036SNiklas Söderlund $line =~ /^\s*fixes:?\s*(?:commit\s*)?[0-9a-f]{5,}\b/i) { 3177bd17e036SNiklas Söderlund my $orig_commit = ""; 3178bd17e036SNiklas Söderlund my $id = "0123456789ab"; 3179bd17e036SNiklas Söderlund my $title = "commit title"; 3180bd17e036SNiklas Söderlund my $tag_case = 1; 3181bd17e036SNiklas Söderlund my $tag_space = 1; 3182bd17e036SNiklas Söderlund my $id_length = 1; 3183bd17e036SNiklas Söderlund my $id_case = 1; 3184bd17e036SNiklas Söderlund my $title_has_quotes = 0; 3185bd17e036SNiklas Söderlund 3186bd17e036SNiklas Söderlund if ($line =~ /(\s*fixes:?)\s+([0-9a-f]{5,})\s+($balanced_parens)/i) { 3187bd17e036SNiklas Söderlund my $tag = $1; 3188bd17e036SNiklas Söderlund $orig_commit = $2; 3189bd17e036SNiklas Söderlund $title = $3; 3190bd17e036SNiklas Söderlund 3191bd17e036SNiklas Söderlund $tag_case = 0 if $tag eq "Fixes:"; 3192bd17e036SNiklas Söderlund $tag_space = 0 if ($line =~ /^fixes:? [0-9a-f]{5,} ($balanced_parens)/i); 3193bd17e036SNiklas Söderlund 3194bd17e036SNiklas Söderlund $id_length = 0 if ($orig_commit =~ /^[0-9a-f]{12}$/i); 3195bd17e036SNiklas Söderlund $id_case = 0 if ($orig_commit !~ /[A-F]/); 3196bd17e036SNiklas Söderlund 3197bd17e036SNiklas Söderlund # Always strip leading/trailing parens then double quotes if existing 3198bd17e036SNiklas Söderlund $title = substr($title, 1, -1); 3199bd17e036SNiklas Söderlund if ($title =~ /^".*"$/) { 3200bd17e036SNiklas Söderlund $title = substr($title, 1, -1); 3201bd17e036SNiklas Söderlund $title_has_quotes = 1; 3202bd17e036SNiklas Söderlund } 3203bd17e036SNiklas Söderlund } 3204bd17e036SNiklas Söderlund 3205bd17e036SNiklas Söderlund my ($cid, $ctitle) = git_commit_info($orig_commit, $id, 3206bd17e036SNiklas Söderlund $title); 3207bd17e036SNiklas Söderlund 3208bd17e036SNiklas Söderlund if ($ctitle ne $title || $tag_case || $tag_space || 3209bd17e036SNiklas Söderlund $id_length || $id_case || !$title_has_quotes) { 3210bd17e036SNiklas Söderlund if (WARN("BAD_FIXES_TAG", 3211bd17e036SNiklas Söderlund "Please use correct Fixes: style 'Fixes: <12 chars of sha1> (\"<title line>\")' - ie: 'Fixes: $cid (\"$ctitle\")'\n" . $herecurr) && 3212bd17e036SNiklas Söderlund $fix) { 3213bd17e036SNiklas Söderlund $fixed[$fixlinenr] = "Fixes: $cid (\"$ctitle\")"; 3214bd17e036SNiklas Söderlund } 3215bd17e036SNiklas Söderlund } 3216bd17e036SNiklas Söderlund } 3217bd17e036SNiklas Söderlund 3218a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 3219a2fe16b9SJoe Perches if ($in_header_lines && 3220a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 3221a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 3222a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 3223a2fe16b9SJoe Perches } 3224a2fe16b9SJoe Perches 322544d303ebSJoe Perches# Check for Gerrit Change-Ids not in any patch context 322644d303ebSJoe Perches if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) { 32277580c5b9SAditya Srivastava if (ERROR("GERRIT_CHANGE_ID", 32287580c5b9SAditya Srivastava "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr) && 32297580c5b9SAditya Srivastava $fix) { 32307580c5b9SAditya Srivastava fix_delete_line($fixlinenr, $rawline); 32317580c5b9SAditya Srivastava } 32327ebd05efSChristopher Covington } 32337ebd05efSChristopher Covington 3234369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 3235369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 3236369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 3237369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 3238369c8dd3SJoe Perches # timestamp 3239634cffccSJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) || 3240634cffccSJoe Perches $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ || 3241634cffccSJoe Perches $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) { 3242634cffccSJoe Perches # stack dump address styles 3243369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 3244369c8dd3SJoe Perches } 3245369c8dd3SJoe Perches 32462a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 32472a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 3248bf4daf12SJoe Perches length($line) > 75 && 3249bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 3250bf4daf12SJoe Perches # file delta changes 325136f8b348SJerome Forissier $line =~ /^\s*(?:[\w\.\-\+]*\/)++[\w\.\-\+]+:/ || 3252bf4daf12SJoe Perches # filename then : 325327b379afSAditya Srivastava $line =~ /^\s*(?:Fixes:|Link:|$signature_tags)/i || 325427b379afSAditya Srivastava # A Fixes: or Link: line or signature tag line 3255bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 32562a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 32572a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 32582a076f40SJoe Perches $commit_log_long_line = 1; 32592a076f40SJoe Perches } 32602a076f40SJoe Perches 3261bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 3262bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 3263bf4daf12SJoe Perches $line =~ /^\s*$/) { 3264bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 3265bf4daf12SJoe Perches } 3266bf4daf12SJoe Perches 326776f381bbSKai Wasserbäch# Check for odd tags before a URI/URL 326876f381bbSKai Wasserbäch if ($in_commit_log && 326976f381bbSKai Wasserbäch $line =~ /^\s*(\w+):\s*http/ && $1 ne 'Link') { 327076f381bbSKai Wasserbäch if ($1 =~ /^v(?:ersion)?\d+/i) { 327176f381bbSKai Wasserbäch WARN("COMMIT_LOG_VERSIONING", 327276f381bbSKai Wasserbäch "Patch version information should be after the --- line\n" . $herecurr); 327376f381bbSKai Wasserbäch } else { 327476f381bbSKai Wasserbäch WARN("COMMIT_LOG_USE_LINK", 327576f381bbSKai Wasserbäch "Unknown link reference '$1:', use 'Link:' instead\n" . $herecurr); 327676f381bbSKai Wasserbäch } 327776f381bbSKai Wasserbäch } 327876f381bbSKai Wasserbäch 3279084a617aSDwaipayan Ray# Check for lines starting with a # 3280084a617aSDwaipayan Ray if ($in_commit_log && $line =~ /^#/) { 3281084a617aSDwaipayan Ray if (WARN("COMMIT_COMMENT_SYMBOL", 3282084a617aSDwaipayan Ray "Commit log lines starting with '#' are dropped by git as comments\n" . $herecurr) && 3283084a617aSDwaipayan Ray $fix) { 3284084a617aSDwaipayan Ray $fixed[$fixlinenr] =~ s/^/ /; 3285084a617aSDwaipayan Ray } 3286084a617aSDwaipayan Ray } 3287084a617aSDwaipayan Ray 32880d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 32894ce9f970SJoe Perches# A correctly formed commit description is: 32904ce9f970SJoe Perches# commit <SHA-1 hash length 12+ chars> ("Complete commit subject") 32914ce9f970SJoe Perches# with the commit subject '("' prefix and '")' suffix 32924ce9f970SJoe Perches# This is a fairly compilicated block as it tests for what appears to be 32934ce9f970SJoe Perches# bare SHA-1 hash with minimum length of 5. It also avoids several types of 32944ce9f970SJoe Perches# possible SHA-1 matches. 32954ce9f970SJoe Perches# A commit match can span multiple lines so this block attempts to find a 32964ce9f970SJoe Perches# complete typical commit on a maximum of 3 lines 32974ce9f970SJoe Perches if ($perl_version_ok && 32984ce9f970SJoe Perches $in_commit_log && !$commit_log_possible_stack_dump && 3299a8972573SJohn Hubbard $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i && 3300e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 33014ce9f970SJoe Perches (($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 33024ce9f970SJoe Perches ($line =~ /\bcommit\s*$/i && defined($rawlines[$linenr]) && $rawlines[$linenr] =~ /^\s*[0-9a-f]{5,}\b/i)) || 3303aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 3304369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 3305bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 3306fe043ea1SJoe Perches my $init_char = "c"; 3307fe043ea1SJoe Perches my $orig_commit = ""; 33080d7835fcSJoe Perches my $short = 1; 33090d7835fcSJoe Perches my $long = 0; 33100d7835fcSJoe Perches my $case = 1; 33110d7835fcSJoe Perches my $space = 1; 33120d7835fcSJoe Perches my $id = '0123456789ab'; 33130d7835fcSJoe Perches my $orig_desc = "commit description"; 33140d7835fcSJoe Perches my $description = ""; 33154ce9f970SJoe Perches my $herectx = $herecurr; 33164ce9f970SJoe Perches my $has_parens = 0; 33174ce9f970SJoe Perches my $has_quotes = 0; 33180d7835fcSJoe Perches 33194ce9f970SJoe Perches my $input = $line; 33204ce9f970SJoe Perches if ($line =~ /(?:\bcommit\s+[0-9a-f]{5,}|\bcommit\s*$)/i) { 33214ce9f970SJoe Perches for (my $n = 0; $n < 2; $n++) { 33224ce9f970SJoe Perches if ($input =~ /\bcommit\s+[0-9a-f]{5,}\s*($balanced_parens)/i) { 33234ce9f970SJoe Perches $orig_desc = $1; 33244ce9f970SJoe Perches $has_parens = 1; 33254ce9f970SJoe Perches # Always strip leading/trailing parens then double quotes if existing 33264ce9f970SJoe Perches $orig_desc = substr($orig_desc, 1, -1); 33274ce9f970SJoe Perches if ($orig_desc =~ /^".*"$/) { 33284ce9f970SJoe Perches $orig_desc = substr($orig_desc, 1, -1); 33294ce9f970SJoe Perches $has_quotes = 1; 33304ce9f970SJoe Perches } 33314ce9f970SJoe Perches last; 33324ce9f970SJoe Perches } 33334ce9f970SJoe Perches last if ($#lines < $linenr + $n); 33344ce9f970SJoe Perches $input .= " " . trim($rawlines[$linenr + $n]); 33354ce9f970SJoe Perches $herectx .= "$rawlines[$linenr + $n]\n"; 33364ce9f970SJoe Perches } 33374ce9f970SJoe Perches $herectx = $herecurr if (!$has_parens); 3338fe043ea1SJoe Perches } 3339fe043ea1SJoe Perches 33404ce9f970SJoe Perches if ($input =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 33414ce9f970SJoe Perches $init_char = $1; 33424ce9f970SJoe Perches $orig_commit = lc($2); 33434ce9f970SJoe Perches $short = 0 if ($input =~ /\bcommit\s+[0-9a-f]{12,40}/i); 33444ce9f970SJoe Perches $long = 1 if ($input =~ /\bcommit\s+[0-9a-f]{41,}/i); 33454ce9f970SJoe Perches $space = 0 if ($input =~ /\bcommit [0-9a-f]/i); 33464ce9f970SJoe Perches $case = 0 if ($input =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 33474ce9f970SJoe Perches } elsif ($input =~ /\b([0-9a-f]{12,40})\b/i) { 33484ce9f970SJoe Perches $orig_commit = lc($1); 33490d7835fcSJoe Perches } 33500d7835fcSJoe Perches 33510d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 33520d7835fcSJoe Perches $id, $orig_desc); 33530d7835fcSJoe Perches 3354948b133aSHeinrich Schuchardt if (defined($id) && 33554ce9f970SJoe Perches ($short || $long || $space || $case || ($orig_desc ne $description) || !$has_quotes) && 33564ce9f970SJoe Perches $last_git_commit_id_linenr != $linenr - 1) { 3357d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 33584ce9f970SJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herectx); 33590d7835fcSJoe Perches } 33604ce9f970SJoe Perches #don't report the next line if this line ends in commit and the sha1 hash is the next line 33614ce9f970SJoe Perches $last_git_commit_id_linenr = $linenr if ($line =~ /\bcommit\s*$/i); 3362d311cd44SJoe Perches } 3363d311cd44SJoe Perches 33649b71f79fSBjorn Helgaas# Check for mailing list archives other than lore.kernel.org 33659b71f79fSBjorn Helgaas if ($rawline =~ m{http.*\b$obsolete_archives}) { 33669b71f79fSBjorn Helgaas WARN("PREFER_LORE_ARCHIVE", 33679b71f79fSBjorn Helgaas "Use lore.kernel.org archive links when possible - see https://lore.kernel.org/lists.html\n" . $herecurr); 33689b71f79fSBjorn Helgaas } 33699b71f79fSBjorn Helgaas 337013f1937eSJoe Perches# Check for added, moved or deleted files 337113f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 337213f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 337313f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 337413f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 337513f1937eSJoe Perches (defined($1) || defined($2))))) { 3376a82603a8SAndrew Jeffery $is_patch = 1; 337713f1937eSJoe Perches $reported_maintainer_file = 1; 337813f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 337913f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 338013f1937eSJoe Perches } 338113f1937eSJoe Perches 3382e400edb1SRob Herring# Check for adding new DT bindings not in schema format 3383e400edb1SRob Herring if (!$in_commit_log && 3384e400edb1SRob Herring ($line =~ /^new file mode\s*\d+\s*$/) && 3385e400edb1SRob Herring ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) { 3386e400edb1SRob Herring WARN("DT_SCHEMA_BINDING_PATCH", 338756ddc4cdSMauro Carvalho Chehab "DT bindings should be in DT schema format. See: Documentation/devicetree/bindings/writing-schema.rst\n"); 3388e400edb1SRob Herring } 3389e400edb1SRob Herring 339000df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 33918905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 3392000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 3393000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 33946c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 3395de7d4f0eSAndy Whitcroft } 3396de7d4f0eSAndy Whitcroft 3397de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 3398de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 3399171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 3400171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 3401171ae1a4SAndy Whitcroft 3402171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 3403171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 3404171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 3405171ae1a4SAndy Whitcroft 340634d99219SJoe Perches CHK("INVALID_UTF8", 3407000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 340800df344fSAndy Whitcroft } 34090a920b5bSAndy Whitcroft 341015662b3eSJoe Perches# Check if it's the start of a commit log 341115662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 341215662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 3413eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 3414eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 341515662b3eSJoe Perches $in_header_lines = 0; 341615662b3eSJoe Perches $in_commit_log = 1; 3417ed43c4e5SAllen Hubbe $has_commit_log = 1; 341815662b3eSJoe Perches } 341915662b3eSJoe Perches 3420fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 3421fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 3422fa64205dSPasi Savanainen if ($in_header_lines && 3423fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 3424fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 3425fa64205dSPasi Savanainen $non_utf8_charset = 1; 3426fa64205dSPasi Savanainen } 3427fa64205dSPasi Savanainen 3428fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 342915662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 3430fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 343115662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 343215662b3eSJoe Perches } 343315662b3eSJoe Perches 3434d6430f71SJoe Perches# Check for absolute kernel paths in commit message 3435d6430f71SJoe Perches if ($tree && $in_commit_log) { 3436d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 3437d6430f71SJoe Perches my $file = $1; 3438d6430f71SJoe Perches 3439d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 3440d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 3441d6430f71SJoe Perches # 3442d6430f71SJoe Perches } else { 3443d6430f71SJoe Perches check_absolute_file($file, $herecurr); 3444d6430f71SJoe Perches } 3445d6430f71SJoe Perches } 3446d6430f71SJoe Perches } 3447d6430f71SJoe Perches 344866b47b4aSKees Cook# Check for various typo / spelling mistakes 344966d7a382SJoe Perches if (defined($misspellings) && 345066d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 34517da07c31SDwaipayan Ray while ($rawline =~ /(?:^|[^\w\-'`])($misspellings)(?:[^\w\-'`]|$)/gi) { 345266b47b4aSKees Cook my $typo = $1; 34537da07c31SDwaipayan Ray my $blank = copy_spacing($rawline); 34547da07c31SDwaipayan Ray my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo); 34557da07c31SDwaipayan Ray my $hereptr = "$hereline$ptr\n"; 345666b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 345766b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 345866b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 34590675a8fbSJean Delvare my $msg_level = \&WARN; 34600675a8fbSJean Delvare $msg_level = \&CHK if ($file); 34610675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 34627da07c31SDwaipayan Ray "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $hereptr) && 346366b47b4aSKees Cook $fix) { 346466b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 346566b47b4aSKees Cook } 346666b47b4aSKees Cook } 346766b47b4aSKees Cook } 346866b47b4aSKees Cook 3469a8dd86bfSMatteo Croce# check for invalid commit id 3470a8dd86bfSMatteo Croce if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) { 3471a8dd86bfSMatteo Croce my $id; 3472a8dd86bfSMatteo Croce my $description; 3473a8dd86bfSMatteo Croce ($id, $description) = git_commit_info($2, undef, undef); 3474a8dd86bfSMatteo Croce if (!defined($id)) { 3475a8dd86bfSMatteo Croce WARN("UNKNOWN_COMMIT_ID", 3476a8dd86bfSMatteo Croce "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr); 3477a8dd86bfSMatteo Croce } 3478a8dd86bfSMatteo Croce } 3479a8dd86bfSMatteo Croce 3480310cd06bSJoe Perches# check for repeated words separated by a single space 34818d0325ccSAditya Srivastava# avoid false positive from list command eg, '-rw-r--r-- 1 root root' 34828d0325ccSAditya Srivastava if (($rawline =~ /^\+/ || $in_commit_log) && 34838d0325ccSAditya Srivastava $rawline !~ /[bcCdDlMnpPs\?-][rwxsStT-]{9}/) { 34841db81a68SDwaipayan Ray pos($rawline) = 1 if (!$in_commit_log); 3485310cd06bSJoe Perches while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) { 3486310cd06bSJoe Perches 3487310cd06bSJoe Perches my $first = $1; 3488310cd06bSJoe Perches my $second = $2; 34891db81a68SDwaipayan Ray my $start_pos = $-[1]; 34901db81a68SDwaipayan Ray my $end_pos = $+[2]; 3491310cd06bSJoe Perches if ($first =~ /(?:struct|union|enum)/) { 3492310cd06bSJoe Perches pos($rawline) += length($first) + length($second) + 1; 3493310cd06bSJoe Perches next; 3494310cd06bSJoe Perches } 3495310cd06bSJoe Perches 34961db81a68SDwaipayan Ray next if (lc($first) ne lc($second)); 3497310cd06bSJoe Perches next if ($first eq 'long'); 3498310cd06bSJoe Perches 34991db81a68SDwaipayan Ray # check for character before and after the word matches 35001db81a68SDwaipayan Ray my $start_char = ''; 35011db81a68SDwaipayan Ray my $end_char = ''; 35021db81a68SDwaipayan Ray $start_char = substr($rawline, $start_pos - 1, 1) if ($start_pos > ($in_commit_log ? 0 : 1)); 35031db81a68SDwaipayan Ray $end_char = substr($rawline, $end_pos, 1) if ($end_pos < length($rawline)); 35041db81a68SDwaipayan Ray 35051db81a68SDwaipayan Ray next if ($start_char =~ /^\S$/); 35061db81a68SDwaipayan Ray next if (index(" \t.,;?!", $end_char) == -1); 35071db81a68SDwaipayan Ray 35088d0325ccSAditya Srivastava # avoid repeating hex occurrences like 'ff ff fe 09 ...' 35098d0325ccSAditya Srivastava if ($first =~ /\b[0-9a-f]{2,}\b/i) { 35108d0325ccSAditya Srivastava next if (!exists($allow_repeated_words{lc($first)})); 35118d0325ccSAditya Srivastava } 35128d0325ccSAditya Srivastava 3513310cd06bSJoe Perches if (WARN("REPEATED_WORD", 3514310cd06bSJoe Perches "Possible repeated word: '$first'\n" . $herecurr) && 3515310cd06bSJoe Perches $fix) { 3516310cd06bSJoe Perches $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/; 3517310cd06bSJoe Perches } 3518310cd06bSJoe Perches } 3519310cd06bSJoe Perches 3520310cd06bSJoe Perches # if it's a repeated word on consecutive lines in a comment block 3521310cd06bSJoe Perches if ($prevline =~ /$;+\s*$/ && 3522310cd06bSJoe Perches $prevrawline =~ /($word_pattern)\s*$/) { 3523310cd06bSJoe Perches my $last_word = $1; 3524310cd06bSJoe Perches if ($rawline =~ /^\+\s*\*\s*$last_word /) { 3525310cd06bSJoe Perches if (WARN("REPEATED_WORD", 3526310cd06bSJoe Perches "Possible repeated word: '$last_word'\n" . $hereprev) && 3527310cd06bSJoe Perches $fix) { 3528310cd06bSJoe Perches $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/; 3529310cd06bSJoe Perches } 3530310cd06bSJoe Perches } 3531310cd06bSJoe Perches } 3532310cd06bSJoe Perches } 3533310cd06bSJoe Perches 353430670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 353530670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 353600df344fSAndy Whitcroft 35370a920b5bSAndy Whitcroft#trailing whitespace 35389c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 3539c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3540d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 3541d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 3542d5e616fcSJoe Perches $fix) { 3543194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 3544d5e616fcSJoe Perches } 3545c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 3546c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 35473705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 35483705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 35493705ce5bSJoe Perches $fix) { 3550194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 35513705ce5bSJoe Perches } 35523705ce5bSJoe Perches 3553d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 35540a920b5bSAndy Whitcroft } 35555368df20SAndy Whitcroft 35564783f894SJosh Triplett# Check for FSF mailing addresses. 3557109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 35581bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 35593e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 35603e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 35614783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 35620675a8fbSJean Delvare my $msg_level = \&ERROR; 35630675a8fbSJean Delvare $msg_level = \&CHK if ($file); 35640675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 35654783f894SJosh Triplett "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) 35664783f894SJosh Triplett } 35674783f894SJosh Triplett 35683354957aSAndi Kleen# check for Kconfig help text having a real description 35699fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 35709fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 35713354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 3572678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 3573678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 3574678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 3575678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 3576b8709bceSJoe Perches my $ln = $linenr; 3577b8709bceSJoe Perches my $needs_help = 0; 3578b8709bceSJoe Perches my $has_help = 0; 3579b8709bceSJoe Perches my $help_length = 0; 3580b8709bceSJoe Perches while (defined $lines[$ln]) { 3581b8709bceSJoe Perches my $f = $lines[$ln++]; 35829fe287d7SAndy Whitcroft 35839fe287d7SAndy Whitcroft next if ($f =~ /^-/); 3584b8709bceSJoe Perches last if ($f !~ /^[\+ ]/); # !patch context 3585a1385803SAndy Whitcroft 3586b8709bceSJoe Perches if ($f =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 3587b8709bceSJoe Perches $needs_help = 1; 3588b8709bceSJoe Perches next; 3589b8709bceSJoe Perches } 3590b8709bceSJoe Perches if ($f =~ /^\+\s*help\s*$/) { 3591b8709bceSJoe Perches $has_help = 1; 3592b8709bceSJoe Perches next; 3593a1385803SAndy Whitcroft } 3594a1385803SAndy Whitcroft 3595b8709bceSJoe Perches $f =~ s/^.//; # strip patch context [+ ] 3596b8709bceSJoe Perches $f =~ s/#.*//; # strip # directives 3597b8709bceSJoe Perches $f =~ s/^\s+//; # strip leading blanks 3598b8709bceSJoe Perches next if ($f =~ /^$/); # skip blank lines 3599678ae162SUlf Magnusson 3600b8709bceSJoe Perches # At the end of this Kconfig block: 3601678ae162SUlf Magnusson # This only checks context lines in the patch 3602678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 3603678ae162SUlf Magnusson # positives, even though some of these are 3604678ae162SUlf Magnusson # common words in help texts 3605b8709bceSJoe Perches if ($f =~ /^(?:config|menuconfig|choice|endchoice| 3606678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 36079fe287d7SAndy Whitcroft last; 36089fe287d7SAndy Whitcroft } 3609b8709bceSJoe Perches $help_length++ if ($has_help); 36103354957aSAndi Kleen } 3611b8709bceSJoe Perches if ($needs_help && 3612b8709bceSJoe Perches $help_length < $min_conf_desc_length) { 3613b8709bceSJoe Perches my $stat_real = get_stat_real($linenr, $ln - 1); 3614000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 3615b8709bceSJoe Perches "please write a help paragraph that fully describes the config symbol\n" . "$here\n$stat_real\n"); 361656193274SVadim Bendebury } 36173354957aSAndi Kleen } 36183354957aSAndi Kleen 36197ccf41a8SJoe Perches# check MAINTAINERS entries 36207ccf41a8SJoe Perches if ($realfile =~ /^MAINTAINERS$/) { 36217ccf41a8SJoe Perches# check MAINTAINERS entries for the right form 36227ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 3623628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 3624628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 3625628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 3626628f91a2SJoe Perches $fix) { 3627628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 3628628f91a2SJoe Perches } 3629628f91a2SJoe Perches } 36307ccf41a8SJoe Perches# check MAINTAINERS entries for the right ordering too 36317ccf41a8SJoe Perches my $preferred_order = 'MRLSWQBCPTFXNK'; 36327ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 36337ccf41a8SJoe Perches $prevrawline =~ /^[\+ ][A-Z]:/) { 36347ccf41a8SJoe Perches $rawline =~ /^\+([A-Z]):\s*(.*)/; 36357ccf41a8SJoe Perches my $cur = $1; 36367ccf41a8SJoe Perches my $curval = $2; 36377ccf41a8SJoe Perches $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/; 36387ccf41a8SJoe Perches my $prev = $1; 36397ccf41a8SJoe Perches my $prevval = $2; 36407ccf41a8SJoe Perches my $curindex = index($preferred_order, $cur); 36417ccf41a8SJoe Perches my $previndex = index($preferred_order, $prev); 36427ccf41a8SJoe Perches if ($curindex < 0) { 36437ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 36447ccf41a8SJoe Perches "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr); 36457ccf41a8SJoe Perches } else { 36467ccf41a8SJoe Perches if ($previndex >= 0 && $curindex < $previndex) { 36477ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 36487ccf41a8SJoe Perches "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev); 36497ccf41a8SJoe Perches } elsif ((($prev eq 'F' && $cur eq 'F') || 36507ccf41a8SJoe Perches ($prev eq 'X' && $cur eq 'X')) && 36517ccf41a8SJoe Perches ($prevval cmp $curval) > 0) { 36527ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 36537ccf41a8SJoe Perches "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev); 36547ccf41a8SJoe Perches } 36557ccf41a8SJoe Perches } 36567ccf41a8SJoe Perches } 36577ccf41a8SJoe Perches } 3658628f91a2SJoe Perches 3659c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 3660c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 3661c68e5878SArnaud Lacombe my $flag = $1; 3662c68e5878SArnaud Lacombe my $replacement = { 3663c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 3664c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 3665c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 3666c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 3667c68e5878SArnaud Lacombe }; 3668c68e5878SArnaud Lacombe 3669c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 3670c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 3671c68e5878SArnaud Lacombe } 3672c68e5878SArnaud Lacombe 3673bff5da43SRob Herring# check for DT compatible documentation 36747dd05b38SFlorian Vaussard if (defined $root && 36757dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 36767dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 36777dd05b38SFlorian Vaussard 3678bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 3679bff5da43SRob Herring 3680cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 3681852d095dSRob Herring my $vp_file = $dt_path . "vendor-prefixes.yaml"; 3682cc93319bSFlorian Vaussard 3683bff5da43SRob Herring foreach my $compat (@compats) { 3684bff5da43SRob Herring my $compat2 = $compat; 3685185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 3686185d566bSRob Herring my $compat3 = $compat; 3687185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 3688185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 3689bff5da43SRob Herring if ( $? >> 8 ) { 3690bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3691bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 3692bff5da43SRob Herring } 3693bff5da43SRob Herring 36944fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 36954fbf32a6SFlorian Vaussard my $vendor = $1; 3696852d095dSRob Herring `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`; 3697bff5da43SRob Herring if ( $? >> 8 ) { 3698bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3699cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 3700bff5da43SRob Herring } 3701bff5da43SRob Herring } 3702bff5da43SRob Herring } 3703bff5da43SRob Herring 37049f3a8992SRob Herring# check for using SPDX license tag at beginning of files 37059f3a8992SRob Herring if ($realline == $checklicenseline) { 37069f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 37079f3a8992SRob Herring $checklicenseline = 2; 37089f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 37099f3a8992SRob Herring my $comment = ""; 37109f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 37119f3a8992SRob Herring $comment = '/*'; 3712d1d84b5fSMiguel Ojeda } elsif ($realfile =~ /\.(c|rs|dts|dtsi)$/) { 37139f3a8992SRob Herring $comment = '//'; 3714c8df0ab6SLubomir Rintel } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) { 37159f3a8992SRob Herring $comment = '#'; 37169f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 37179f3a8992SRob Herring $comment = '..'; 37189f3a8992SRob Herring } 37199f3a8992SRob Herring 3720fdf13693SJoe Perches# check SPDX comment style for .[chsS] files 3721fdf13693SJoe Perches if ($realfile =~ /\.[chsS]$/ && 3722fdf13693SJoe Perches $rawline =~ /SPDX-License-Identifier:/ && 3723ffbce897SJoe Perches $rawline !~ m@^\+\s*\Q$comment\E\s*@) { 3724fdf13693SJoe Perches WARN("SPDX_LICENSE_TAG", 3725fdf13693SJoe Perches "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr); 3726fdf13693SJoe Perches } 3727fdf13693SJoe Perches 37289f3a8992SRob Herring if ($comment !~ /^$/ && 3729ffbce897SJoe Perches $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) { 37309f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 37319f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 37323b6e8ac9SJoe Perches } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) { 37333b6e8ac9SJoe Perches my $spdx_license = $1; 37343b6e8ac9SJoe Perches if (!is_SPDX_License_valid($spdx_license)) { 37353b6e8ac9SJoe Perches WARN("SPDX_LICENSE_TAG", 37363b6e8ac9SJoe Perches "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr); 37373b6e8ac9SJoe Perches } 373850c92900SLubomir Rintel if ($realfile =~ m@^Documentation/devicetree/bindings/@ && 373950c92900SLubomir Rintel not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) { 374050c92900SLubomir Rintel my $msg_level = \&WARN; 374150c92900SLubomir Rintel $msg_level = \&CHK if ($file); 374250c92900SLubomir Rintel if (&{$msg_level}("SPDX_LICENSE_TAG", 374350c92900SLubomir Rintel 374450c92900SLubomir Rintel "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) && 374550c92900SLubomir Rintel $fix) { 374650c92900SLubomir Rintel $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/; 374750c92900SLubomir Rintel } 374850c92900SLubomir Rintel } 37499f3a8992SRob Herring } 37509f3a8992SRob Herring } 37519f3a8992SRob Herring } 37529f3a8992SRob Herring 3753a0154cdbSJoe Perches# check for embedded filenames 3754a0154cdbSJoe Perches if ($rawline =~ /^\+.*\Q$realfile\E/) { 3755a0154cdbSJoe Perches WARN("EMBEDDED_FILENAME", 3756a0154cdbSJoe Perches "It's generally not useful to have the filename in the file\n" . $herecurr); 3757a0154cdbSJoe Perches } 3758a0154cdbSJoe Perches 37595368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 3760d1d84b5fSMiguel Ojeda next if ($realfile !~ /\.(h|c|rs|s|S|sh|dtsi|dts)$/); 37615368df20SAndy Whitcroft 3762a8da38a9SJoe Perches# check for using SPDX-License-Identifier on the wrong line number 3763a8da38a9SJoe Perches if ($realline != $checklicenseline && 3764a8da38a9SJoe Perches $rawline =~ /\bSPDX-License-Identifier:/ && 3765a8da38a9SJoe Perches substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) { 3766a8da38a9SJoe Perches WARN("SPDX_LICENSE_TAG", 3767a8da38a9SJoe Perches "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr); 3768a8da38a9SJoe Perches } 3769a8da38a9SJoe Perches 377047e0c88bSJoe Perches# line length limit (with some exclusions) 377147e0c88bSJoe Perches# 377247e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 377347e0c88bSJoe Perches# logging functions like pr_info that end in a string 377447e0c88bSJoe Perches# lines with a single string 377547e0c88bSJoe Perches# #defines that are a single string 37762e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 377747e0c88bSJoe Perches# 377847e0c88bSJoe Perches# There are 3 different line length message types: 3779ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 378047e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 378147e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 378247e0c88bSJoe Perches# 378347e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 378447e0c88bSJoe Perches# 378547e0c88bSJoe Perches 3786b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 378747e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 378847e0c88bSJoe Perches 378947e0c88bSJoe Perches # Check the allowed long line types first 379047e0c88bSJoe Perches 379147e0c88bSJoe Perches # logging functions that end in a string that starts 379247e0c88bSJoe Perches # before $max_line_length 379347e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 379447e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 379547e0c88bSJoe Perches $msg_type = ""; 379647e0c88bSJoe Perches 379747e0c88bSJoe Perches # lines with only strings (w/ possible termination) 379847e0c88bSJoe Perches # #defines with only strings 379947e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 380047e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 380147e0c88bSJoe Perches $msg_type = ""; 380247e0c88bSJoe Perches 3803cc147506SJoe Perches # More special cases 3804cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3805cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3806d560a5f8SJoe Perches $msg_type = ""; 3807d560a5f8SJoe Perches 38082e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 38092e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 38102e4bbbc5SAndreas Brauchli $msg_type = ""; 38112e4bbbc5SAndreas Brauchli 381247e0c88bSJoe Perches # Otherwise set the alternate message types 381347e0c88bSJoe Perches 381447e0c88bSJoe Perches # a comment starts before $max_line_length 381547e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 381647e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 381747e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 381847e0c88bSJoe Perches 381947e0c88bSJoe Perches # a quoted string starts before $max_line_length 382047e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 382147e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 382247e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 382347e0c88bSJoe Perches } 382447e0c88bSJoe Perches 382547e0c88bSJoe Perches if ($msg_type ne "" && 382647e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 3827bdc48fa1SJoe Perches my $msg_level = \&WARN; 3828bdc48fa1SJoe Perches $msg_level = \&CHK if ($file); 3829bdc48fa1SJoe Perches &{$msg_level}($msg_type, 3830bdc48fa1SJoe Perches "line length of $length exceeds $max_line_length columns\n" . $herecurr); 38310a920b5bSAndy Whitcroft } 383247e0c88bSJoe Perches } 38330a920b5bSAndy Whitcroft 38348905a67cSAndy Whitcroft# check for adding lines without a newline. 38358905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 383647ca69b8STom Rix if (WARN("MISSING_EOF_NEWLINE", 383747ca69b8STom Rix "adding a line without newline at end of file\n" . $herecurr) && 383847ca69b8STom Rix $fix) { 383947ca69b8STom Rix fix_delete_line($fixlinenr+1, "No newline at end of file"); 384047ca69b8STom Rix } 38418905a67cSAndy Whitcroft } 38428905a67cSAndy Whitcroft 3843de93245cSAditya Srivastava# check for .L prefix local symbols in .S files 3844de93245cSAditya Srivastava if ($realfile =~ /\.S$/ && 3845de93245cSAditya Srivastava $line =~ /^\+\s*(?:[A-Z]+_)?SYM_[A-Z]+_(?:START|END)(?:_[A-Z_]+)?\s*\(\s*\.L/) { 3846de93245cSAditya Srivastava WARN("AVOID_L_PREFIX", 3847f4bf1cd4SJonathan Corbet "Avoid using '.L' prefixed local symbol names for denoting a range of code via 'SYM_*_START/END' annotations; see Documentation/core-api/asm-annotations.rst\n" . $herecurr); 3848de93245cSAditya Srivastava } 3849de93245cSAditya Srivastava 3850b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3851de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 38520a920b5bSAndy Whitcroft 38530a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 3854713a09deSAntonio Borneo# more than $tabsize must use tabs. 3855c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3856c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3857c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3858d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 38593705ce5bSJoe Perches if (ERROR("CODE_INDENT", 38603705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 38613705ce5bSJoe Perches $fix) { 3862194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 38633705ce5bSJoe Perches } 38640a920b5bSAndy Whitcroft } 38650a920b5bSAndy Whitcroft 386608e44365SAlberto Panizzo# check for space before tabs. 386708e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 386808e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 38693705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 38703705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 38713705ce5bSJoe Perches $fix) { 3872194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3873713a09deSAntonio Borneo s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} 3874194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3875c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 38763705ce5bSJoe Perches } 387708e44365SAlberto Panizzo } 387808e44365SAlberto Panizzo 38796a487211SJoe Perches# check for assignments on the start of a line 38806a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 3881da7355abSAditya Srivastava my $operator = $1; 3882da7355abSAditya Srivastava if (CHK("ASSIGNMENT_CONTINUATIONS", 3883da7355abSAditya Srivastava "Assignment operator '$1' should be on the previous line\n" . $hereprev) && 3884da7355abSAditya Srivastava $fix && $prevrawline =~ /^\+/) { 3885da7355abSAditya Srivastava # add assignment operator to the previous line, remove from current line 3886da7355abSAditya Srivastava $fixed[$fixlinenr - 1] .= " $operator"; 3887da7355abSAditya Srivastava $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//; 3888da7355abSAditya Srivastava } 38896a487211SJoe Perches } 38906a487211SJoe Perches 3891d1fe9c09SJoe Perches# check for && or || at the start of a line 3892d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 38938e08f076SAditya Srivastava my $operator = $1; 38948e08f076SAditya Srivastava if (CHK("LOGICAL_CONTINUATIONS", 38958e08f076SAditya Srivastava "Logical continuations should be on the previous line\n" . $hereprev) && 38968e08f076SAditya Srivastava $fix && $prevrawline =~ /^\+/) { 38978e08f076SAditya Srivastava # insert logical operator at last non-comment, non-whitepsace char on previous line 38988e08f076SAditya Srivastava $prevline =~ /[\s$;]*$/; 38998e08f076SAditya Srivastava my $line_end = substr($prevrawline, $-[0]); 39008e08f076SAditya Srivastava $fixed[$fixlinenr - 1] =~ s/\Q$line_end\E$/ $operator$line_end/; 39018e08f076SAditya Srivastava $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//; 39028e08f076SAditya Srivastava } 3903d1fe9c09SJoe Perches } 3904d1fe9c09SJoe Perches 3905a91e8994SJoe Perches# check indentation starts on a tab stop 39065b57980dSJoe Perches if ($perl_version_ok && 3907bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3908a91e8994SJoe Perches my $indent = length($1); 3909713a09deSAntonio Borneo if ($indent % $tabsize) { 3910a91e8994SJoe Perches if (WARN("TABSTOP", 3911a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3912a91e8994SJoe Perches $fix) { 3913713a09deSAntonio Borneo $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; 3914a91e8994SJoe Perches } 3915a91e8994SJoe Perches } 3916a91e8994SJoe Perches } 3917a91e8994SJoe Perches 3918d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 39195b57980dSJoe Perches if ($perl_version_ok && 3920fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3921d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3922d1fe9c09SJoe Perches my $oldindent = $1; 3923d1fe9c09SJoe Perches my $rest = $2; 3924d1fe9c09SJoe Perches 3925d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3926d1fe9c09SJoe Perches if ($pos >= 0) { 3927b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3928b34a26f3SJoe Perches my $newindent = $2; 3929d1fe9c09SJoe Perches 3930d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3931713a09deSAntonio Borneo "\t" x ($pos / $tabsize) . 3932713a09deSAntonio Borneo " " x ($pos % $tabsize); 3933d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3934d1fe9c09SJoe Perches 3935d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3936d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 39373705ce5bSJoe Perches 39383705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 39393705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 39403705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3941194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39423705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 39433705ce5bSJoe Perches } 3944d1fe9c09SJoe Perches } 3945d1fe9c09SJoe Perches } 3946d1fe9c09SJoe Perches } 3947d1fe9c09SJoe Perches 39486ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 39496ab3a970SJoe Perches# avoid checking a few false positives: 39506ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 39516ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 39526ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 39536ab3a970SJoe Perches# multiline macros that define functions 39546ab3a970SJoe Perches# known attributes or the __attribute__ keyword 39556ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 39566ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 39573705ce5bSJoe Perches if (CHK("SPACING", 3958f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 39593705ce5bSJoe Perches $fix) { 3960194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3961f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 39623705ce5bSJoe Perches } 3963aad4f614SJoe Perches } 3964aad4f614SJoe Perches 396586406b1cSJoe Perches# Block comment styles 396686406b1cSJoe Perches# Networking with an initial /* 396705880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3968fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 396985ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 3970c70735c2SŁukasz Stelmach $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier 397105880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 397205880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 397305880600SJoe Perches } 397405880600SJoe Perches 397586406b1cSJoe Perches# Block comments use * on subsequent lines 397686406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 397786406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3978a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 397961135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3980a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 398186406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 398286406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3983a605e32eSJoe Perches } 3984a605e32eSJoe Perches 398586406b1cSJoe Perches# Block comments use */ on trailing lines 398686406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3987c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3988c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3989c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 399086406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 399186406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 399205880600SJoe Perches } 399305880600SJoe Perches 399408eb9b80SJoe Perches# Block comment * alignment 399508eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3996af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3997af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3998af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 399908eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 4000af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 4001af207524SJoe Perches my $oldindent; 400208eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 4003af207524SJoe Perches if (defined($1)) { 4004af207524SJoe Perches $oldindent = expand_tabs($1); 4005af207524SJoe Perches } else { 4006af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 4007af207524SJoe Perches $oldindent = expand_tabs($1); 4008af207524SJoe Perches } 400908eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 401008eb9b80SJoe Perches my $newindent = $1; 401108eb9b80SJoe Perches $newindent = expand_tabs($newindent); 4012af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 401308eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 401408eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 401508eb9b80SJoe Perches } 401608eb9b80SJoe Perches } 401708eb9b80SJoe Perches 40187f619191SJoe Perches# check for missing blank lines after struct/union declarations 40197f619191SJoe Perches# with exceptions for various attributes and macros 40207f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 40217f619191SJoe Perches $line =~ /^\+/ && 40227f619191SJoe Perches !($line =~ /^\+\s*$/ || 402305dc40e6SJoe Perches $line =~ /^\+\s*(?:EXPORT_SYMBOL|early_param)/ || 40247f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 40257f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 40267f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 40277f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 40287f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 40290bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 40307f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 4031d752fcc8SJoe Perches if (CHK("LINE_SPACING", 4032d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 4033d752fcc8SJoe Perches $fix) { 4034f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 4035d752fcc8SJoe Perches } 40367f619191SJoe Perches } 40377f619191SJoe Perches 4038365dd4eaSJoe Perches# check for multiple consecutive blank lines 4039365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 4040365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 4041365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 4042d752fcc8SJoe Perches if (CHK("LINE_SPACING", 4043d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 4044d752fcc8SJoe Perches $fix) { 4045f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 4046d752fcc8SJoe Perches } 4047d752fcc8SJoe Perches 4048365dd4eaSJoe Perches $last_blank_line = $linenr; 4049365dd4eaSJoe Perches } 4050365dd4eaSJoe Perches 40513b617e3bSJoe Perches# check for missing blank lines after declarations 4052b5e8736aSJoe Perches# (declarations must have the same indentation and not be at the start of line) 4053b5e8736aSJoe Perches if (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/) { 4054b5e8736aSJoe Perches # use temporaries 4055b5e8736aSJoe Perches my $sl = $sline; 4056b5e8736aSJoe Perches my $pl = $prevline; 4057b5e8736aSJoe Perches # remove $Attribute/$Sparse uses to simplify comparisons 4058b5e8736aSJoe Perches $sl =~ s/\b(?:$Attribute|$Sparse)\b//g; 4059b5e8736aSJoe Perches $pl =~ s/\b(?:$Attribute|$Sparse)\b//g; 4060b5e8736aSJoe Perches if (($pl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 40615a4e1fd3SJoe Perches # function pointer declarations 4062b5e8736aSJoe Perches $pl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 40633f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 4064b5e8736aSJoe Perches $pl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 40653f7bac03SJoe Perches # known declaration macros 4066b5e8736aSJoe Perches $pl =~ /^\+\s+$declaration_macros/) && 40673f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 4068b5e8736aSJoe Perches !($pl =~ /^\+\s+$c90_Keywords\b/ || 40693f7bac03SJoe Perches # other possible extensions of declaration lines 4070b5e8736aSJoe Perches $pl =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 40713f7bac03SJoe Perches # not starting a section or a macro "\" extended line 4072b5e8736aSJoe Perches $pl =~ /(?:\{\s*|\\)$/) && 40733f7bac03SJoe Perches # looks like a declaration 4074b5e8736aSJoe Perches !($sl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 40755a4e1fd3SJoe Perches # function pointer declarations 4076b5e8736aSJoe Perches $sl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 40773f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 4078b5e8736aSJoe Perches $sl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 40793f7bac03SJoe Perches # known declaration macros 4080b5e8736aSJoe Perches $sl =~ /^\+\s+$declaration_macros/ || 40813f7bac03SJoe Perches # start of struct or union or enum 4082b5e8736aSJoe Perches $sl =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ || 40833f7bac03SJoe Perches # start or end of block or continuation of declaration 4084b5e8736aSJoe Perches $sl =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 40853f7bac03SJoe Perches # bitfield continuation 4086b5e8736aSJoe Perches $sl =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 40873f7bac03SJoe Perches # other possible extensions of declaration lines 4088b5e8736aSJoe Perches $sl =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/)) { 4089d752fcc8SJoe Perches if (WARN("LINE_SPACING", 4090d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 4091d752fcc8SJoe Perches $fix) { 4092f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 4093d752fcc8SJoe Perches } 40943b617e3bSJoe Perches } 4095b5e8736aSJoe Perches } 40963b617e3bSJoe Perches 40975f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 40986b4c5bebSAndy Whitcroft# Exceptions: 40996b4c5bebSAndy Whitcroft# 1) within comments 41006b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 41016b4c5bebSAndy Whitcroft# 3) hanging labels 41023705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 41035f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 41043705ce5bSJoe Perches if (WARN("LEADING_SPACE", 41053705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 41063705ce5bSJoe Perches $fix) { 4107194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 41083705ce5bSJoe Perches } 41095f7ddae6SRaffaele Recalcati } 41105f7ddae6SRaffaele Recalcati 4111b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 4112b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 4113b9ea10d6SAndy Whitcroft 41145751a24eSJoe Perches# check for unusual line ending [ or ( 41155751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 41165751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 41175751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 41185751a24eSJoe Perches } 41195751a24eSJoe Perches 41204dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 41214dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 41224dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 41234dbed76fSJoe Perches $context_function = $1; 41244dbed76fSJoe Perches } 41254dbed76fSJoe Perches 41264dbed76fSJoe Perches# check if this appears to be the end of function declaration 41274dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 41284dbed76fSJoe Perches undef $context_function; 41294dbed76fSJoe Perches } 41304dbed76fSJoe Perches 4131032a4c0fSJoe Perches# check indentation of any line with a bare else 4132840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 4133032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 4134032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 4135032a4c0fSJoe Perches my $tabs = length($1) + 1; 4136840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 4137840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 4138840080a0SJoe Perches defined $lines[$linenr] && 4139840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 4140032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 4141032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 4142032a4c0fSJoe Perches } 4143032a4c0fSJoe Perches } 4144032a4c0fSJoe Perches 4145c00df19aSJoe Perches# check indentation of a line with a break; 4146dc58bc55SJoe Perches# if the previous line is a goto, return or break 4147dc58bc55SJoe Perches# and is indented the same # of tabs 4148c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 4149c00df19aSJoe Perches my $tabs = $1; 4150dc58bc55SJoe Perches if ($prevline =~ /^\+$tabs(goto|return|break)\b/) { 4151dc58bc55SJoe Perches if (WARN("UNNECESSARY_BREAK", 4152dc58bc55SJoe Perches "break is not useful after a $1\n" . $hereprev) && 4153dc58bc55SJoe Perches $fix) { 4154dc58bc55SJoe Perches fix_delete_line($fixlinenr, $rawline); 4155dc58bc55SJoe Perches } 4156c00df19aSJoe Perches } 4157c00df19aSJoe Perches } 4158c00df19aSJoe Perches 4159c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 4160cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 4161000d1cc1SJoe Perches WARN("CVS_KEYWORD", 4162000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 4163c2fdda0dSAndy Whitcroft } 416422f2a2efSAndy Whitcroft 416556e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 416656e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 416756e77d70SJoe Perches WARN("HOTPLUG_SECTION", 416856e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 416956e77d70SJoe Perches } 417056e77d70SJoe Perches 41719c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 41722b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 41732b474a1aSAndy Whitcroft $realline_next); 41743e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 4175ca819864SJoe Perches if ($linenr > $suppress_statement && 41761b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 4177170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 4178f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4179171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 4180171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 4181171ae1a4SAndy Whitcroft 41823e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 41833e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 41843e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 41853e469cdcSAndy Whitcroft # until we hit end of it. 41863e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 41873e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 41883e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 41893e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 41903e469cdcSAndy Whitcroft } 4191f74bd194SAndy Whitcroft 41922b474a1aSAndy Whitcroft # Find the real next line. 41932b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 41942b474a1aSAndy Whitcroft if (defined $realline_next && 41952b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 41962b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 41972b474a1aSAndy Whitcroft $realline_next++; 41982b474a1aSAndy Whitcroft } 41992b474a1aSAndy Whitcroft 4200171ae1a4SAndy Whitcroft my $s = $stat; 4201171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 4202cf655043SAndy Whitcroft 4203c2fdda0dSAndy Whitcroft # Ignore goto labels. 4204171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 4205c2fdda0dSAndy Whitcroft 4206c2fdda0dSAndy Whitcroft # Ignore functions being called 4207171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 4208c2fdda0dSAndy Whitcroft 4209463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 4210463f2864SAndy Whitcroft 4211c45dcabdSAndy Whitcroft # declarations always start with types 4212d2506586SAndy Whitcroft } 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) { 4213c45dcabdSAndy Whitcroft my $type = $1; 4214c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 4215c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 4216c45dcabdSAndy Whitcroft 42176c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 4218a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 4219c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 4220c2fdda0dSAndy Whitcroft } 42218905a67cSAndy Whitcroft 42226c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 422365863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 4224c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 42259c0ca6f9SAndy Whitcroft } 42268905a67cSAndy Whitcroft 42278905a67cSAndy Whitcroft # Check for any sort of function declaration. 42288905a67cSAndy Whitcroft # int foo(something bar, other baz); 42298905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 4230171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 42318905a67cSAndy Whitcroft my ($name_len) = length($1); 42328905a67cSAndy Whitcroft 4233cf655043SAndy Whitcroft my $ctx = $s; 4234773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 42358905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 4236cf655043SAndy Whitcroft 42378905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 4238c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 42398905a67cSAndy Whitcroft 4240c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 42418905a67cSAndy Whitcroft } 42428905a67cSAndy Whitcroft } 42438905a67cSAndy Whitcroft } 42448905a67cSAndy Whitcroft 42459c0ca6f9SAndy Whitcroft } 42469c0ca6f9SAndy Whitcroft 424700df344fSAndy Whitcroft# 424800df344fSAndy Whitcroft# Checks which may be anchored in the context. 424900df344fSAndy Whitcroft# 425000df344fSAndy Whitcroft 425100df344fSAndy Whitcroft# Check for switch () and associated case and default 425200df344fSAndy Whitcroft# statements should be at the same indent. 425300df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 425400df344fSAndy Whitcroft my $err = ''; 425500df344fSAndy Whitcroft my $sep = ''; 425600df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 425700df344fSAndy Whitcroft shift(@ctx); 425800df344fSAndy Whitcroft for my $ctx (@ctx) { 425900df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 426000df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 426100df344fSAndy Whitcroft $indent != $cindent) { 426200df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 426300df344fSAndy Whitcroft $sep = ''; 426400df344fSAndy Whitcroft } else { 426500df344fSAndy Whitcroft $sep = "[...]\n"; 426600df344fSAndy Whitcroft } 426700df344fSAndy Whitcroft } 426800df344fSAndy Whitcroft if ($err ne '') { 4269000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 4270000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 4271de7d4f0eSAndy Whitcroft } 4272de7d4f0eSAndy Whitcroft } 4273de7d4f0eSAndy Whitcroft 4274de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 4275de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 42760fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 4277773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 4278773647a0SAndy Whitcroft 42799c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 42808eef05ddSJoe Perches 42818eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 42828eef05ddSJoe Perches WARN("DEEP_INDENTATION", 42838eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 42848eef05ddSJoe Perches } 42858eef05ddSJoe Perches 4286de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 4287de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 4288de7d4f0eSAndy Whitcroft 4289548596d5SAndy Whitcroft my $ctx_ln = $linenr; 4290548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 4291de7d4f0eSAndy Whitcroft 4292548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 4293548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 4294548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 4295548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 4296548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 4297773647a0SAndy Whitcroft $ctx_ln++; 4298773647a0SAndy Whitcroft } 4299548596d5SAndy Whitcroft 430053210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 430153210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 4302773647a0SAndy Whitcroft 4303773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 4304000d1cc1SJoe Perches ERROR("OPEN_BRACE", 4305000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 430601464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 430700df344fSAndy Whitcroft } 4308773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 4309773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 4310773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 4311773647a0SAndy Whitcroft { 43129c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 43139c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 4314000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 4315000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 431601464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 43179c0ca6f9SAndy Whitcroft } 43189c0ca6f9SAndy Whitcroft } 431900df344fSAndy Whitcroft } 432000df344fSAndy Whitcroft 43214d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 4322f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 43233e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 43243e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 43253e469cdcSAndy Whitcroft if (!defined $stat); 43264d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 43274d001e4dSAndy Whitcroft 43284d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 43294d001e4dSAndy Whitcroft 43309f5af480SJoe Perches # remove inline comments 43319f5af480SJoe Perches $s =~ s/$;/ /g; 43329f5af480SJoe Perches $c =~ s/$;/ /g; 43334d001e4dSAndy Whitcroft 43344d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 43356f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 43366f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 43374d001e4dSAndy Whitcroft 43389f5af480SJoe Perches # Make sure we remove the line prefixes as we have 43399f5af480SJoe Perches # none on the first line, and are going to readd them 43409f5af480SJoe Perches # where necessary. 43419f5af480SJoe Perches $s =~ s/\n./\n/gs; 43429f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 43439f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 43449f5af480SJoe Perches } 43459f5af480SJoe Perches 43464d001e4dSAndy Whitcroft # We want to check the first line inside the block 43474d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 43484d001e4dSAndy Whitcroft # 1) any blank line termination 43494d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 43504d001e4dSAndy Whitcroft # 3) any do (...) { 43514d001e4dSAndy Whitcroft my $continuation = 0; 43524d001e4dSAndy Whitcroft my $check = 0; 43534d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 43544d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 43554d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 43564d001e4dSAndy Whitcroft $continuation = 1; 43574d001e4dSAndy Whitcroft } 43589bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 43594d001e4dSAndy Whitcroft $check = 1; 43604d001e4dSAndy Whitcroft $cond_lines++; 43614d001e4dSAndy Whitcroft } 43624d001e4dSAndy Whitcroft 43634d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 43644d001e4dSAndy Whitcroft # preprocessor statement. 43654d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 43664d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 43674d001e4dSAndy Whitcroft $check = 0; 43684d001e4dSAndy Whitcroft } 43694d001e4dSAndy Whitcroft 43709bd49efeSAndy Whitcroft my $cond_ptr = -1; 4371740504c6SAndy Whitcroft $continuation = 0; 43729bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 43739bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 43744d001e4dSAndy Whitcroft 4375f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 4376f16fa28fSAndy Whitcroft # is not linear. 4377f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 4378f16fa28fSAndy Whitcroft $check = 0; 4379f16fa28fSAndy Whitcroft } 4380f16fa28fSAndy Whitcroft 43819bd49efeSAndy Whitcroft # Ignore: 43829bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 43839bd49efeSAndy Whitcroft # 2) preprocessor lines, and 43849bd49efeSAndy Whitcroft # 3) labels. 4385740504c6SAndy Whitcroft if ($continuation || 4386740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 43879bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 43889bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 4389740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 439030dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 43919bd49efeSAndy Whitcroft $cond_lines++; 43929bd49efeSAndy Whitcroft } 43934d001e4dSAndy Whitcroft } 439430dad6ebSAndy Whitcroft } 43954d001e4dSAndy Whitcroft 43964d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 43974d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 43984d001e4dSAndy Whitcroft 43994d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 44004d001e4dSAndy Whitcroft # this is not this patch's fault. 44014d001e4dSAndy Whitcroft if (!defined($stat_real) || 44024d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 44034d001e4dSAndy Whitcroft $check = 0; 44044d001e4dSAndy Whitcroft } 44054d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 44064d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 44074d001e4dSAndy Whitcroft } 44084d001e4dSAndy Whitcroft 44099bd49efeSAndy Whitcroft #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"; 44104d001e4dSAndy Whitcroft 44119f5af480SJoe Perches if ($check && $s ne '' && 4412713a09deSAntonio Borneo (($sindent % $tabsize) != 0 || 44139f5af480SJoe Perches ($sindent < $indent) || 4414f6950a73SJoe Perches ($sindent == $indent && 4415f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 4416713a09deSAntonio Borneo ($sindent > $indent + $tabsize))) { 4417000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 4418000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 44194d001e4dSAndy Whitcroft } 44204d001e4dSAndy Whitcroft } 44214d001e4dSAndy Whitcroft 44226c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 44236c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 44241f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 44251f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 44266c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 4427c2fdda0dSAndy Whitcroft if ($dbg_values) { 4428c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 4429cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 4430cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 44311f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 4432c2fdda0dSAndy Whitcroft } 44336c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 44346c72ffaaSAndy Whitcroft 443500df344fSAndy Whitcroft#ignore lines not being added 44363705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 443700df344fSAndy Whitcroft 443899ca38c2SJoe Perches# check for self assignments used to avoid compiler warnings 443999ca38c2SJoe Perches# e.g.: int foo = foo, *bar = NULL; 444099ca38c2SJoe Perches# struct foo bar = *(&(bar)); 444199ca38c2SJoe Perches if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) { 444299ca38c2SJoe Perches my $var = $1; 444399ca38c2SJoe Perches if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) { 444499ca38c2SJoe Perches WARN("SELF_ASSIGNMENT", 444599ca38c2SJoe Perches "Do not use self-assignments to avoid compiler warnings\n" . $herecurr); 444699ca38c2SJoe Perches } 444799ca38c2SJoe Perches } 444899ca38c2SJoe Perches 444911ca40a0SJoe Perches# check for dereferences that span multiple lines 445011ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 445111ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 445211ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 445311ca40a0SJoe Perches my $ref = $1; 445411ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 445511ca40a0SJoe Perches $ref .= $1; 445611ca40a0SJoe Perches $ref =~ s/\s//g; 445711ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 445811ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 445911ca40a0SJoe Perches } 446011ca40a0SJoe Perches 4461a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 4462c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 4463a1ce18e4SJoe Perches my $type = $1; 4464a1ce18e4SJoe Perches my $var = $2; 4465207a8e84SJoe Perches $var = "" if (!defined $var); 4466207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 4467a1ce18e4SJoe Perches my $sign = $1; 4468a1ce18e4SJoe Perches my $pointer = $2; 4469a1ce18e4SJoe Perches 4470a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 4471a1ce18e4SJoe Perches 4472a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 4473a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 4474a1ce18e4SJoe Perches $fix) { 4475a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 4476207a8e84SJoe Perches my $comp_pointer = $pointer; 4477207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 4478207a8e84SJoe Perches $decl .= $comp_pointer; 4479207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 4480207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 4481a1ce18e4SJoe Perches } 4482a1ce18e4SJoe Perches } 4483a1ce18e4SJoe Perches } 4484a1ce18e4SJoe Perches 4485653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 44867429c690SAndy Whitcroft if ($dbg_type) { 44877429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 4488000d1cc1SJoe Perches ERROR("TEST_TYPE", 4489000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 44907429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 4491000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 4492000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 44937429c690SAndy Whitcroft } 4494653d4876SAndy Whitcroft next; 4495653d4876SAndy Whitcroft } 4496a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 4497a1ef277eSAndy Whitcroft if ($dbg_attr) { 44989360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 4499000d1cc1SJoe Perches ERROR("TEST_ATTR", 4500000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 45019360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 4502000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 4503000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 4504a1ef277eSAndy Whitcroft } 4505a1ef277eSAndy Whitcroft next; 4506a1ef277eSAndy Whitcroft } 4507653d4876SAndy Whitcroft 4508f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 450999423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 451099423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 4511d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 4512d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 4513f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 4514f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4515f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 4516d752fcc8SJoe Perches my $fixedline = $prevrawline; 4517d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 4518f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 4519d752fcc8SJoe Perches $fixedline = $line; 45208d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 4521f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 4522d752fcc8SJoe Perches } 4523f0a594c1SAndy Whitcroft } 4524f0a594c1SAndy Whitcroft 452500df344fSAndy Whitcroft# 452600df344fSAndy Whitcroft# Checks which are anchored on the added line. 452700df344fSAndy Whitcroft# 452800df344fSAndy Whitcroft 4529653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 4530c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 4531653d4876SAndy Whitcroft my $path = $1; 4532653d4876SAndy Whitcroft if ($path =~ m{//}) { 4533000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 4534495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 4535495e9d84SJoe Perches } 4536495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 4537495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 4538495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 4539653d4876SAndy Whitcroft } 4540653d4876SAndy Whitcroft } 4541653d4876SAndy Whitcroft 454200df344fSAndy Whitcroft# no C99 // comments 454300df344fSAndy Whitcroft if ($line =~ m{//}) { 45443705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 45453705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 45463705ce5bSJoe Perches $fix) { 4547194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 45483705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 45493705ce5bSJoe Perches my $comment = trim($1); 4550194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 45513705ce5bSJoe Perches } 45523705ce5bSJoe Perches } 455300df344fSAndy Whitcroft } 455400df344fSAndy Whitcroft # Remove C99 comments. 45550a920b5bSAndy Whitcroft $line =~ s@//.*@@; 45566c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 45570a920b5bSAndy Whitcroft 45582b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 45592b474a1aSAndy Whitcroft# the whole statement. 45602b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 45612b474a1aSAndy Whitcroft if (defined $realline_next && 45622b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 45632b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 456436794822SChristoph Hellwig ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/)) { 45653cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 45663cbf62dfSAndy Whitcroft # a prefix: 45673cbf62dfSAndy Whitcroft # XXX(foo); 45683cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 4569653d4876SAndy Whitcroft my $name = $1; 457070a11659SJoe Perches $name =~ s/^\s*($Ident).*/$1/; 457187a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 45723cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 45733cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 45743cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 45753cbf62dfSAndy Whitcroft 45763cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 45772b474a1aSAndy Whitcroft \n.}\s*$| 457848012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 457948012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 458048012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 45812b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 45822b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 458348012058SAndy Whitcroft )/x) { 45842b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 45852b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 45862b474a1aSAndy Whitcroft } else { 45872b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 45880a920b5bSAndy Whitcroft } 45890a920b5bSAndy Whitcroft } 45902b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 45912b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 459236794822SChristoph Hellwig ($line =~ /EXPORT_SYMBOL.*\((.*)\)/)) { 45932b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 45942b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 45952b474a1aSAndy Whitcroft } 45962b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 45972b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 4598000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 4599000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 46002b474a1aSAndy Whitcroft } 46010a920b5bSAndy Whitcroft 46025150bda4SJoe Eloff# check for global initialisers. 46035b8f82e1SSong Liu if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/ && 46045b8f82e1SSong Liu !exclude_global_initialisers($realfile)) { 4605d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 46066d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 4607d5e616fcSJoe Perches $fix) { 46086d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 4609d5e616fcSJoe Perches } 4610f0a594c1SAndy Whitcroft } 46110a920b5bSAndy Whitcroft# check for static initialisers. 46126d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 4613d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 46146d32f7a3SJoe Perches "do not initialise statics to $1\n" . 4615d5e616fcSJoe Perches $herecurr) && 4616d5e616fcSJoe Perches $fix) { 46176d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 4618d5e616fcSJoe Perches } 46190a920b5bSAndy Whitcroft } 46200a920b5bSAndy Whitcroft 46211813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 46221813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 46231813087dSJoe Perches my $tmp = trim($1); 46241813087dSJoe Perches WARN("MISORDERED_TYPE", 46251813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 46261813087dSJoe Perches } 46271813087dSJoe Perches 4628809e082eSJoe Perches# check for unnecessary <signed> int declarations of short/long/long long 4629809e082eSJoe Perches while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) { 4630809e082eSJoe Perches my $type = trim($1); 4631809e082eSJoe Perches next if ($type !~ /\bint\b/); 4632809e082eSJoe Perches next if ($type !~ /\b(?:short|long\s+long|long)\b/); 4633809e082eSJoe Perches my $new_type = $type; 4634809e082eSJoe Perches $new_type =~ s/\b\s*int\s*\b/ /; 4635809e082eSJoe Perches $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /; 4636809e082eSJoe Perches $new_type =~ s/^const\s+//; 4637809e082eSJoe Perches $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/); 4638809e082eSJoe Perches $new_type = "const $new_type" if ($type =~ /^const\b/); 4639809e082eSJoe Perches $new_type =~ s/\s+/ /g; 4640809e082eSJoe Perches $new_type = trim($new_type); 4641809e082eSJoe Perches if (WARN("UNNECESSARY_INT", 4642809e082eSJoe Perches "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) && 4643809e082eSJoe Perches $fix) { 4644809e082eSJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/; 4645809e082eSJoe Perches } 4646809e082eSJoe Perches } 4647809e082eSJoe Perches 4648cb710ecaSJoe Perches# check for static const char * arrays. 4649cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 4650000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4651000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 4652cb710ecaSJoe Perches $herecurr); 4653cb710ecaSJoe Perches } 4654cb710ecaSJoe Perches 465577b8c0a8SJoe Perches# check for initialized const char arrays that should be static const 465677b8c0a8SJoe Perches if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) { 465777b8c0a8SJoe Perches if (WARN("STATIC_CONST_CHAR_ARRAY", 465877b8c0a8SJoe Perches "const array should probably be static const\n" . $herecurr) && 465977b8c0a8SJoe Perches $fix) { 466077b8c0a8SJoe Perches $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/; 466177b8c0a8SJoe Perches } 466277b8c0a8SJoe Perches } 466377b8c0a8SJoe Perches 4664cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 4665cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 4666000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4667000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 4668cb710ecaSJoe Perches $herecurr); 4669cb710ecaSJoe Perches } 4670cb710ecaSJoe Perches 4671ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 4672ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 4673ab7e23f3SJoe Perches my $found = $1; 4674ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 4675ab7e23f3SJoe Perches WARN("CONST_CONST", 4676ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 4677ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 4678ab7e23f3SJoe Perches WARN("CONST_CONST", 4679ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 4680ab7e23f3SJoe Perches } 4681ab7e23f3SJoe Perches } 4682ab7e23f3SJoe Perches 468373169765SJoe Perches# check for const static or static <non ptr type> const declarations 468473169765SJoe Perches# prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const' 468573169765SJoe Perches if ($sline =~ /^\+\s*const\s+static\s+($Type)\b/ || 468673169765SJoe Perches $sline =~ /^\+\s*static\s+($BasicType)\s+const\b/) { 468773169765SJoe Perches if (WARN("STATIC_CONST", 468873169765SJoe Perches "Move const after static - use 'static const $1'\n" . $herecurr) && 468973169765SJoe Perches $fix) { 469073169765SJoe Perches $fixed[$fixlinenr] =~ s/\bconst\s+static\b/static const/; 469173169765SJoe Perches $fixed[$fixlinenr] =~ s/\bstatic\s+($BasicType)\s+const\b/static const $1/; 469273169765SJoe Perches } 469373169765SJoe Perches } 469473169765SJoe Perches 46959b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 46969b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 46979b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 46989b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 46999b0fa60dSJoe Perches $herecurr); 47009b0fa60dSJoe Perches } 47019b0fa60dSJoe Perches 4702b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 4703b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 4704b598b670SJoe Perches my $array = $1; 4705b598b670SJoe Perches if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) { 4706b598b670SJoe Perches my $array_div = $1; 4707b598b670SJoe Perches if (WARN("ARRAY_SIZE", 4708b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 4709b598b670SJoe Perches $fix) { 4710b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 4711b598b670SJoe Perches } 4712b598b670SJoe Perches } 4713b598b670SJoe Perches } 4714b598b670SJoe Perches 4715b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 471616b7f3c8SJoe Perches if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) { 4717b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 4718b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 4719b36190c5SJoe Perches $fix) { 4720194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 4721b36190c5SJoe Perches } 4722b36190c5SJoe Perches } 4723b36190c5SJoe Perches 4724653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 4725653d4876SAndy Whitcroft# make sense. 4726653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 47278054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 4728c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 47298ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 473046d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 4731000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 4732000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 47330a920b5bSAndy Whitcroft } 47340a920b5bSAndy Whitcroft 47350a920b5bSAndy Whitcroft# * goes on variable not on type 473665863862SAndy Whitcroft # (char*[ const]) 4737bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 4738bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 47393705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 4740d8aaf121SAndy Whitcroft 474165863862SAndy Whitcroft # Should start with a space. 474265863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 474365863862SAndy Whitcroft # Should not end with a space. 474465863862SAndy Whitcroft $to =~ s/\s+$//; 474565863862SAndy Whitcroft # '*'s should not have spaces between. 4746f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 474765863862SAndy Whitcroft } 4748d8aaf121SAndy Whitcroft 47493705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 475065863862SAndy Whitcroft if ($from ne $to) { 47513705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 47523705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 47533705ce5bSJoe Perches $fix) { 47543705ce5bSJoe Perches my $sub_from = $ident; 47553705ce5bSJoe Perches my $sub_to = $ident; 47563705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4757194f66fcSJoe Perches $fixed[$fixlinenr] =~ 47583705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 47593705ce5bSJoe Perches } 476065863862SAndy Whitcroft } 4761bfcb2cc7SAndy Whitcroft } 4762bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 4763bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 47643705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 4765d8aaf121SAndy Whitcroft 476665863862SAndy Whitcroft # Should start with a space. 476765863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 476865863862SAndy Whitcroft # Should not end with a space. 476965863862SAndy Whitcroft $to =~ s/\s+$//; 477065863862SAndy Whitcroft # '*'s should not have spaces between. 4771f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 477265863862SAndy Whitcroft } 477365863862SAndy Whitcroft # Modifiers should have spaces. 477465863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 477565863862SAndy Whitcroft 47763705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 4777667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 47783705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 47793705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 47803705ce5bSJoe Perches $fix) { 47813705ce5bSJoe Perches 47823705ce5bSJoe Perches my $sub_from = $match; 47833705ce5bSJoe Perches my $sub_to = $match; 47843705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4785194f66fcSJoe Perches $fixed[$fixlinenr] =~ 47863705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 47873705ce5bSJoe Perches } 478865863862SAndy Whitcroft } 47890a920b5bSAndy Whitcroft } 47900a920b5bSAndy Whitcroft 479169d517e6SDavid Hildenbrand# do not use BUG() or variants 479269d517e6SDavid Hildenbrand if ($line =~ /\b(?!AA_|BUILD_|DCCP_|IDA_|KVM_|RWLOCK_|snd_|SPIN_)(?:[a-zA-Z_]*_)?BUG(?:_ON)?(?:_[A-Z_]+)?\s*\(/) { 47930675a8fbSJean Delvare my $msg_level = \&WARN; 47940675a8fbSJean Delvare $msg_level = \&CHK if ($file); 47950675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 479669d517e6SDavid Hildenbrand "Do not crash the kernel unless it is absolutely unavoidable--use WARN_ON_ONCE() plus recovery code (if feasible) instead of BUG() or variants\n" . $herecurr); 47979d3e3c70SJoe Perches } 47980a920b5bSAndy Whitcroft 47999d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 48008905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 4801000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 4802000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 48038905a67cSAndy Whitcroft } 48048905a67cSAndy Whitcroft 480517441227SJoe Perches# check for uses of printk_ratelimit 480617441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 4807000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 4808000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 480917441227SJoe Perches } 481017441227SJoe Perches 4811eeef5733SJoe Perches# printk should use KERN_* levels 4812eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 4813000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 4814eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 481500df344fSAndy Whitcroft } 48160a920b5bSAndy Whitcroft 4817f5eea3b0SJoe Perches# prefer variants of (subsystem|netdev|dev|pr)_<level> to printk(KERN_<LEVEL> 4818f5eea3b0SJoe Perches if ($line =~ /\b(printk(_once|_ratelimited)?)\s*\(\s*KERN_([A-Z]+)/) { 4819f5eea3b0SJoe Perches my $printk = $1; 4820f5eea3b0SJoe Perches my $modifier = $2; 4821f5eea3b0SJoe Perches my $orig = $3; 4822f5eea3b0SJoe Perches $modifier = "" if (!defined($modifier)); 4823243f3803SJoe Perches my $level = lc($orig); 4824243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 48258f26b837SJoe Perches my $level2 = $level; 48268f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 4827f5eea3b0SJoe Perches $level .= $modifier; 4828f5eea3b0SJoe Perches $level2 .= $modifier; 4829243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 4830f5eea3b0SJoe Perches "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to $printk(KERN_$orig ...\n" . $herecurr); 4831243f3803SJoe Perches } 4832243f3803SJoe Perches 4833f5eea3b0SJoe Perches# prefer dev_<level> to dev_printk(KERN_<LEVEL> 4834dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 4835dc139313SJoe Perches my $orig = $1; 4836dc139313SJoe Perches my $level = lc($orig); 4837dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 4838dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 4839dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 4840dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 4841dc139313SJoe Perches } 4842dc139313SJoe Perches 48438020b253SNicolas Boichat# trace_printk should not be used in production code. 48448020b253SNicolas Boichat if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) { 48458020b253SNicolas Boichat WARN("TRACE_PRINTK", 48468020b253SNicolas Boichat "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr); 48478020b253SNicolas Boichat } 48488020b253SNicolas Boichat 484991c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 485091c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 485191c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 485291c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 485391c9afafSAndy Lutomirski WARN("ENOSYS", 485491c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 485591c9afafSAndy Lutomirski } 485691c9afafSAndy Lutomirski 48576b9ea5ffSJakub Kicinski# ENOTSUPP is not a standard error code and should be avoided in new patches. 48586b9ea5ffSJakub Kicinski# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP. 48596b9ea5ffSJakub Kicinski# Similarly to ENOSYS warning a small number of false positives is expected. 48606b9ea5ffSJakub Kicinski if (!$file && $line =~ /\bENOTSUPP\b/) { 48616b9ea5ffSJakub Kicinski if (WARN("ENOTSUPP", 48626b9ea5ffSJakub Kicinski "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) && 48636b9ea5ffSJakub Kicinski $fix) { 48646b9ea5ffSJakub Kicinski $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/; 48656b9ea5ffSJakub Kicinski } 48666b9ea5ffSJakub Kicinski } 48676b9ea5ffSJakub Kicinski 4868653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 4869653d4876SAndy Whitcroft# or if closed on same line 48705b57980dSJoe Perches if ($perl_version_ok && 48712d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 48722d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 48732d453e3bSJoe Perches $sline !~ /}/) { 48748d182478SJoe Perches if (ERROR("OPEN_BRACE", 48752d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 48768d182478SJoe Perches $fix) { 48778d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 48788d182478SJoe Perches my $fixed_line = $rawline; 487903f49351SDwaipayan Ray $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*)\{(.*)$/; 48808d182478SJoe Perches my $line1 = $1; 48818d182478SJoe Perches my $line2 = $2; 48828d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 48838d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 48848d182478SJoe Perches if ($line2 !~ /^\s*$/) { 48858d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 48868d182478SJoe Perches } 48878d182478SJoe Perches } 48880a920b5bSAndy Whitcroft } 4889653d4876SAndy Whitcroft 48908905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 48918905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 48928905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 48938d182478SJoe Perches if (ERROR("OPEN_BRACE", 48948d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 48958d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 48968d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48978d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 48988d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 48998d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 49008d182478SJoe Perches $fixedline = $rawline; 49018d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 49028d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 49038d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 49048d182478SJoe Perches } 49058d182478SJoe Perches } 49068905a67cSAndy Whitcroft } 49078905a67cSAndy Whitcroft 49080c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 49093705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 49103705ce5bSJoe Perches if (WARN("SPACING", 49113705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 49123705ce5bSJoe Perches $fix) { 4913194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49143705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 49153705ce5bSJoe Perches } 49160c73b4ebSAndy Whitcroft } 49170c73b4ebSAndy Whitcroft 491831070b5dSJoe Perches# Function pointer declarations 491931070b5dSJoe Perches# check spacing between type, funcptr, and args 492031070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 492191f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 492231070b5dSJoe Perches my $declare = $1; 492331070b5dSJoe Perches my $pre_pointer_space = $2; 492431070b5dSJoe Perches my $post_pointer_space = $3; 492531070b5dSJoe Perches my $funcname = $4; 492631070b5dSJoe Perches my $post_funcname_space = $5; 492731070b5dSJoe Perches my $pre_args_space = $6; 492831070b5dSJoe Perches 492991f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 493091f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 493191f72e9cSJoe Perches# don't need a space so don't warn for those. 493291f72e9cSJoe Perches my $post_declare_space = ""; 493391f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 493491f72e9cSJoe Perches $post_declare_space = $1; 493591f72e9cSJoe Perches $declare = rtrim($declare); 493691f72e9cSJoe Perches } 493791f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 493831070b5dSJoe Perches WARN("SPACING", 493931070b5dSJoe Perches "missing space after return type\n" . $herecurr); 494091f72e9cSJoe Perches $post_declare_space = " "; 494131070b5dSJoe Perches } 494231070b5dSJoe Perches 494331070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 494491f72e9cSJoe Perches# This test is not currently implemented because these declarations are 494591f72e9cSJoe Perches# equivalent to 494691f72e9cSJoe Perches# int foo(int bar, ...) 494791f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 494891f72e9cSJoe Perches# 494991f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 495091f72e9cSJoe Perches# WARN("SPACING", 495191f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 495291f72e9cSJoe Perches# } 495331070b5dSJoe Perches 495431070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 495531070b5dSJoe Perches if (defined $pre_pointer_space && 495631070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 495731070b5dSJoe Perches WARN("SPACING", 495831070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 495931070b5dSJoe Perches } 496031070b5dSJoe Perches 496131070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 496231070b5dSJoe Perches if (defined $post_pointer_space && 496331070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 496431070b5dSJoe Perches WARN("SPACING", 496531070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 496631070b5dSJoe Perches } 496731070b5dSJoe Perches 496831070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 496931070b5dSJoe Perches if (defined $post_funcname_space && 497031070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 497131070b5dSJoe Perches WARN("SPACING", 497231070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 497331070b5dSJoe Perches } 497431070b5dSJoe Perches 497531070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 497631070b5dSJoe Perches if (defined $pre_args_space && 497731070b5dSJoe Perches $pre_args_space =~ /^\s/) { 497831070b5dSJoe Perches WARN("SPACING", 497931070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 498031070b5dSJoe Perches } 498131070b5dSJoe Perches 498231070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4983194f66fcSJoe Perches $fixed[$fixlinenr] =~ 498491f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 498531070b5dSJoe Perches } 498631070b5dSJoe Perches } 498731070b5dSJoe Perches 49888d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 49898d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4990fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4991fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 49928d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 49938d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 49948d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4995fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 499638dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 49973705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 49983705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 49993705ce5bSJoe Perches $fix) { 5000194f66fcSJoe Perches $fixed[$fixlinenr] =~ 50013705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 50023705ce5bSJoe Perches } 50038d31cfceSAndy Whitcroft } 50048d31cfceSAndy Whitcroft } 50058d31cfceSAndy Whitcroft 5006f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 50076c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 5008c2fdda0dSAndy Whitcroft my $name = $1; 5009773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 5010773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 5011c2fdda0dSAndy Whitcroft 5012c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 5013773647a0SAndy Whitcroft if ($name =~ /^(?: 5014773647a0SAndy Whitcroft if|for|while|switch|return|case| 5015773647a0SAndy Whitcroft volatile|__volatile__| 5016773647a0SAndy Whitcroft __attribute__|format|__extension__| 5017773647a0SAndy Whitcroft asm|__asm__)$/x) 5018773647a0SAndy Whitcroft { 5019c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 5020c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 5021c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 5022c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 5023773647a0SAndy Whitcroft 5024773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 5025c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 5026c2fdda0dSAndy Whitcroft 5027c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 5028c2fdda0dSAndy Whitcroft # likely a typedef for a function. 5029773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 5030c2fdda0dSAndy Whitcroft 5031c2fdda0dSAndy Whitcroft } else { 50323705ce5bSJoe Perches if (WARN("SPACING", 50333705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 50343705ce5bSJoe Perches $fix) { 5035194f66fcSJoe Perches $fixed[$fixlinenr] =~ 50363705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 50373705ce5bSJoe Perches } 5038f0a594c1SAndy Whitcroft } 50396c72ffaaSAndy Whitcroft } 50409a4cad4eSEric Nelson 5041653d4876SAndy Whitcroft# Check operator spacing. 50420a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 50433705ce5bSJoe Perches my $fixed_line = ""; 50443705ce5bSJoe Perches my $line_fixed = 0; 50453705ce5bSJoe Perches 50469c0ca6f9SAndy Whitcroft my $ops = qr{ 50479c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 50489c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 50499c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 50501f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 505184731623SJoe Perches \?:|\?|: 50529c0ca6f9SAndy Whitcroft }x; 5053cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 50543705ce5bSJoe Perches 50553705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 50563705ce5bSJoe Perches## foreach my $el (@elements) { 50573705ce5bSJoe Perches## print("el: <$el>\n"); 50583705ce5bSJoe Perches## } 50593705ce5bSJoe Perches 50603705ce5bSJoe Perches my @fix_elements = (); 506100df344fSAndy Whitcroft my $off = 0; 50626c72ffaaSAndy Whitcroft 50633705ce5bSJoe Perches foreach my $el (@elements) { 50643705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 50653705ce5bSJoe Perches $off += length($el); 50663705ce5bSJoe Perches } 50673705ce5bSJoe Perches 50683705ce5bSJoe Perches $off = 0; 50693705ce5bSJoe Perches 50706c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 5071b34c648bSJoe Perches my $last_after = -1; 50726c72ffaaSAndy Whitcroft 50730a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 50743705ce5bSJoe Perches 50753705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 50763705ce5bSJoe Perches 50773705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 50783705ce5bSJoe Perches 50794a0df2efSAndy Whitcroft $off += length($elements[$n]); 50804a0df2efSAndy Whitcroft 508125985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 5082773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 5083773647a0SAndy Whitcroft my $cc = ''; 5084773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 5085773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 5086773647a0SAndy Whitcroft } 5087773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 5088773647a0SAndy Whitcroft 50894a0df2efSAndy Whitcroft my $a = ''; 50904a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 50914a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 5092cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 50934a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 50944a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 5095773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 50964a0df2efSAndy Whitcroft 50970a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 50984a0df2efSAndy Whitcroft 50994a0df2efSAndy Whitcroft my $c = ''; 51000a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 51014a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 51024a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 5103cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 51044a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 51054a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 51068b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 51074a0df2efSAndy Whitcroft } else { 51084a0df2efSAndy Whitcroft $c = 'E'; 51090a920b5bSAndy Whitcroft } 51100a920b5bSAndy Whitcroft 51114a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 51124a0df2efSAndy Whitcroft 51134a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 51144a0df2efSAndy Whitcroft 51156c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 5116de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 51170a920b5bSAndy Whitcroft 511874048ed8SAndy Whitcroft # Pull out the value of this operator. 51196c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 51200a920b5bSAndy Whitcroft 51211f65f947SAndy Whitcroft # Get the full operator variant. 51221f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 51231f65f947SAndy Whitcroft 512413214adfSAndy Whitcroft # Ignore operators passed as parameters. 512513214adfSAndy Whitcroft if ($op_type ne 'V' && 5126d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 512713214adfSAndy Whitcroft 5128cf655043SAndy Whitcroft# # Ignore comments 5129cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 513013214adfSAndy Whitcroft 5131d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 513213214adfSAndy Whitcroft } elsif ($op eq ';') { 5133cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 5134cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 51353705ce5bSJoe Perches if (ERROR("SPACING", 51363705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 5137b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 51383705ce5bSJoe Perches $line_fixed = 1; 51393705ce5bSJoe Perches } 5140d8aaf121SAndy Whitcroft } 5141d8aaf121SAndy Whitcroft 5142d8aaf121SAndy Whitcroft # // is a comment 5143d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 51440a920b5bSAndy Whitcroft 5145b00e4814SJoe Perches # : when part of a bitfield 5146b00e4814SJoe Perches } elsif ($opv eq ':B') { 5147b00e4814SJoe Perches # skip the bitfield test for now 5148b00e4814SJoe Perches 51491f65f947SAndy Whitcroft # No spaces for: 51501f65f947SAndy Whitcroft # -> 5151b00e4814SJoe Perches } elsif ($op eq '->') { 51524a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 51533705ce5bSJoe Perches if (ERROR("SPACING", 51543705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 5155b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 51563705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 51573705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 51583705ce5bSJoe Perches } 5159b34c648bSJoe Perches $line_fixed = 1; 51603705ce5bSJoe Perches } 51610a920b5bSAndy Whitcroft } 51620a920b5bSAndy Whitcroft 51632381097bSJoe Perches # , must not have a space before and must have a space on the right. 51640a920b5bSAndy Whitcroft } elsif ($op eq ',') { 51652381097bSJoe Perches my $rtrim_before = 0; 51662381097bSJoe Perches my $space_after = 0; 51672381097bSJoe Perches if ($ctx =~ /Wx./) { 51682381097bSJoe Perches if (ERROR("SPACING", 51692381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 51702381097bSJoe Perches $line_fixed = 1; 51712381097bSJoe Perches $rtrim_before = 1; 51722381097bSJoe Perches } 51732381097bSJoe Perches } 5174cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 51753705ce5bSJoe Perches if (ERROR("SPACING", 51763705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 51773705ce5bSJoe Perches $line_fixed = 1; 5178b34c648bSJoe Perches $last_after = $n; 51792381097bSJoe Perches $space_after = 1; 51802381097bSJoe Perches } 51812381097bSJoe Perches } 51822381097bSJoe Perches if ($rtrim_before || $space_after) { 51832381097bSJoe Perches if ($rtrim_before) { 51842381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 51852381097bSJoe Perches } else { 51862381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 51872381097bSJoe Perches } 51882381097bSJoe Perches if ($space_after) { 51892381097bSJoe Perches $good .= " "; 51903705ce5bSJoe Perches } 51910a920b5bSAndy Whitcroft } 51920a920b5bSAndy Whitcroft 51939c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 519474048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 51959c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 51969c0ca6f9SAndy Whitcroft 51979c0ca6f9SAndy Whitcroft # unary operators should have a space before and 51989c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 51999c0ca6f9SAndy Whitcroft # unary operator, or a cast 52009c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 520174048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 52020d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 5203cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 52043705ce5bSJoe Perches if (ERROR("SPACING", 52053705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 5206b34c648bSJoe Perches if ($n != $last_after + 2) { 5207b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 52083705ce5bSJoe Perches $line_fixed = 1; 52093705ce5bSJoe Perches } 52100a920b5bSAndy Whitcroft } 5211b34c648bSJoe Perches } 5212a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 5213171ae1a4SAndy Whitcroft # A unary '*' may be const 5214171ae1a4SAndy Whitcroft 5215171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 52163705ce5bSJoe Perches if (ERROR("SPACING", 52173705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 5218b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 52193705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 52203705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 52213705ce5bSJoe Perches } 5222b34c648bSJoe Perches $line_fixed = 1; 52233705ce5bSJoe Perches } 52240a920b5bSAndy Whitcroft } 52250a920b5bSAndy Whitcroft 52260a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 52270a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 5228773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 52293705ce5bSJoe Perches if (ERROR("SPACING", 52303705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 5231b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 52323705ce5bSJoe Perches $line_fixed = 1; 52333705ce5bSJoe Perches } 52340a920b5bSAndy Whitcroft } 5235773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 5236773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 52373705ce5bSJoe Perches if (ERROR("SPACING", 52383705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 5239b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 52403705ce5bSJoe Perches $line_fixed = 1; 52413705ce5bSJoe Perches } 5242653d4876SAndy Whitcroft } 5243773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 52443705ce5bSJoe Perches if (ERROR("SPACING", 52453705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 5246b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 52473705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 52483705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5249773647a0SAndy Whitcroft } 5250b34c648bSJoe Perches $line_fixed = 1; 52513705ce5bSJoe Perches } 52523705ce5bSJoe Perches } 52530a920b5bSAndy Whitcroft 52540a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 52559c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 52569c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 52579c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 5258c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 5259c2fdda0dSAndy Whitcroft $op eq '%') 52600a920b5bSAndy Whitcroft { 5261d2e025f3SJoe Perches if ($check) { 5262d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 5263d2e025f3SJoe Perches if (CHK("SPACING", 5264d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 5265d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 5266d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5267d2e025f3SJoe Perches $line_fixed = 1; 5268d2e025f3SJoe Perches } 5269d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 5270d2e025f3SJoe Perches if (CHK("SPACING", 5271d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 5272d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 5273d2e025f3SJoe Perches $line_fixed = 1; 5274d2e025f3SJoe Perches } 5275d2e025f3SJoe Perches } 5276d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 52773705ce5bSJoe Perches if (ERROR("SPACING", 52783705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 5279b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 5280b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 5281b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5282b34c648bSJoe Perches } 52833705ce5bSJoe Perches $line_fixed = 1; 52843705ce5bSJoe Perches } 52850a920b5bSAndy Whitcroft } 52860a920b5bSAndy Whitcroft 52871f65f947SAndy Whitcroft # A colon needs no spaces before when it is 52881f65f947SAndy Whitcroft # terminating a case value or a label. 52891f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 5290263afd39SChris Down if ($ctx =~ /Wx./ and $realfile !~ m@.*\.lds\.h$@) { 52913705ce5bSJoe Perches if (ERROR("SPACING", 52923705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 5293b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 52943705ce5bSJoe Perches $line_fixed = 1; 52953705ce5bSJoe Perches } 52961f65f947SAndy Whitcroft } 52971f65f947SAndy Whitcroft 52980a920b5bSAndy Whitcroft # All the others need spaces both sides. 5299cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 53001f65f947SAndy Whitcroft my $ok = 0; 53011f65f947SAndy Whitcroft 530222f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 53031f65f947SAndy Whitcroft if (($op eq '<' && 53041f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 53051f65f947SAndy Whitcroft ($op eq '>' && 53061f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 53071f65f947SAndy Whitcroft { 53081f65f947SAndy Whitcroft $ok = 1; 53091f65f947SAndy Whitcroft } 53101f65f947SAndy Whitcroft 5311e0df7e1fSJoe Perches # for asm volatile statements 5312e0df7e1fSJoe Perches # ignore a colon with another 5313e0df7e1fSJoe Perches # colon immediately before or after 5314e0df7e1fSJoe Perches if (($op eq ':') && 5315e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 5316e0df7e1fSJoe Perches $ok = 1; 5317e0df7e1fSJoe Perches } 5318e0df7e1fSJoe Perches 531984731623SJoe Perches # messages are ERROR, but ?: are CHK 53201f65f947SAndy Whitcroft if ($ok == 0) { 53210675a8fbSJean Delvare my $msg_level = \&ERROR; 53220675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 532384731623SJoe Perches 53240675a8fbSJean Delvare if (&{$msg_level}("SPACING", 53253705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 5326b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 5327b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 5328b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5329b34c648bSJoe Perches } 53303705ce5bSJoe Perches $line_fixed = 1; 53313705ce5bSJoe Perches } 53320a920b5bSAndy Whitcroft } 533322f2a2efSAndy Whitcroft } 53344a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 53353705ce5bSJoe Perches 53363705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 53373705ce5bSJoe Perches 53383705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 53390a920b5bSAndy Whitcroft } 53403705ce5bSJoe Perches 53413705ce5bSJoe Perches if (($#elements % 2) == 0) { 53423705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 53433705ce5bSJoe Perches } 53443705ce5bSJoe Perches 5345194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 5346194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 53473705ce5bSJoe Perches } 53483705ce5bSJoe Perches 53493705ce5bSJoe Perches 53500a920b5bSAndy Whitcroft } 53510a920b5bSAndy Whitcroft 5352786b6326SJoe Perches# check for whitespace before a non-naked semicolon 5353d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 5354786b6326SJoe Perches if (WARN("SPACING", 5355786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 5356786b6326SJoe Perches $fix) { 5357194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 5358786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 5359786b6326SJoe Perches } 5360786b6326SJoe Perches } 5361786b6326SJoe Perches 5362f0a594c1SAndy Whitcroft# check for multiple assignments 5363f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 5364000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 5365000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 5366f0a594c1SAndy Whitcroft } 5367f0a594c1SAndy Whitcroft 536822f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 536922f2a2efSAndy Whitcroft## # continuation. 537022f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 537122f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 537222f2a2efSAndy Whitcroft## 537322f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 5374e73d2715SDwaipayan Ray## # falsely report the parameters of functions. 537522f2a2efSAndy Whitcroft## my $ln = $line; 537622f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 537722f2a2efSAndy Whitcroft## } 537822f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 5379000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 5380000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 538122f2a2efSAndy Whitcroft## } 538222f2a2efSAndy Whitcroft## } 5383f0a594c1SAndy Whitcroft 53840a920b5bSAndy Whitcroft#need space before brace following if, while, etc 53856b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 53866ad724e2SMichal Zylowski $line =~ /\b(?:else|do)\{/) { 53873705ce5bSJoe Perches if (ERROR("SPACING", 53883705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 53893705ce5bSJoe Perches $fix) { 53906ad724e2SMichal Zylowski $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/; 53913705ce5bSJoe Perches } 5392de7d4f0eSAndy Whitcroft } 5393de7d4f0eSAndy Whitcroft 5394c4a62ef9SJoe Perches## # check for blank lines before declarations 5395c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 5396c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 5397c4a62ef9SJoe Perches## WARN("SPACING", 5398c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 5399c4a62ef9SJoe Perches## } 5400c4a62ef9SJoe Perches## 5401c4a62ef9SJoe Perches 5402de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 5403de7d4f0eSAndy Whitcroft# on the line 540494fb9845SJoe Perches if ($line =~ /}(?!(?:,|;|\)|\}))\S/) { 5405d5e616fcSJoe Perches if (ERROR("SPACING", 5406d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 5407d5e616fcSJoe Perches $fix) { 5408194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5409d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 5410d5e616fcSJoe Perches } 54110a920b5bSAndy Whitcroft } 54120a920b5bSAndy Whitcroft 541322f2a2efSAndy Whitcroft# check spacing on square brackets 541422f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 54153705ce5bSJoe Perches if (ERROR("SPACING", 54163705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 54173705ce5bSJoe Perches $fix) { 5418194f66fcSJoe Perches $fixed[$fixlinenr] =~ 54193705ce5bSJoe Perches s/\[\s+/\[/; 54203705ce5bSJoe Perches } 542122f2a2efSAndy Whitcroft } 542222f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 54233705ce5bSJoe Perches if (ERROR("SPACING", 54243705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 54253705ce5bSJoe Perches $fix) { 5426194f66fcSJoe Perches $fixed[$fixlinenr] =~ 54273705ce5bSJoe Perches s/\s+\]/\]/; 54283705ce5bSJoe Perches } 542922f2a2efSAndy Whitcroft } 543022f2a2efSAndy Whitcroft 5431c45dcabdSAndy Whitcroft# check spacing on parentheses 54329c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 54339c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 54343705ce5bSJoe Perches if (ERROR("SPACING", 54353705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 54363705ce5bSJoe Perches $fix) { 5437194f66fcSJoe Perches $fixed[$fixlinenr] =~ 54383705ce5bSJoe Perches s/\(\s+/\(/; 54393705ce5bSJoe Perches } 544022f2a2efSAndy Whitcroft } 544113214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 5442c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 5443c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 54443705ce5bSJoe Perches if (ERROR("SPACING", 54453705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 54463705ce5bSJoe Perches $fix) { 5447194f66fcSJoe Perches $fixed[$fixlinenr] =~ 54483705ce5bSJoe Perches s/\s+\)/\)/; 54493705ce5bSJoe Perches } 545022f2a2efSAndy Whitcroft } 545122f2a2efSAndy Whitcroft 5452e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 5453e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 5454e2826fd0SJoe Perches 5455e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 5456ea4acbb1SJoe Perches my $var = $1; 5457ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 5458ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 5459ea4acbb1SJoe Perches $fix) { 5460ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 5461ea4acbb1SJoe Perches } 5462ea4acbb1SJoe Perches } 5463ea4acbb1SJoe Perches 5464ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 5465ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 5466ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 5467ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 5468ea4acbb1SJoe Perches my $var = $2; 5469ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 5470ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 5471ea4acbb1SJoe Perches $fix) { 5472ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 5473ea4acbb1SJoe Perches $var2 =~ s/\s//g; 5474ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 5475ea4acbb1SJoe Perches } 5476e2826fd0SJoe Perches } 5477e2826fd0SJoe Perches 547863b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 5479a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 5480a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 54815b57980dSJoe Perches $perl_version_ok && defined($stat) && 548263b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 548363b7c73eSJoe Perches my $if_stat = $1; 548463b7c73eSJoe Perches my $test = substr($2, 1, -1); 548563b7c73eSJoe Perches my $herectx; 548663b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 548763b7c73eSJoe Perches my $match = $1; 548863b7c73eSJoe Perches # avoid parentheses around potential macro args 548963b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 549063b7c73eSJoe Perches if (!defined($herectx)) { 549163b7c73eSJoe Perches $herectx = $here . "\n"; 549263b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 549363b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 549463b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 549563b7c73eSJoe Perches $herectx .= $rl . "\n"; 549663b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 549763b7c73eSJoe Perches } 549863b7c73eSJoe Perches } 549963b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 550063b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 550163b7c73eSJoe Perches } 550263b7c73eSJoe Perches } 550363b7c73eSJoe Perches 550469078651SJoe Perches# check that goto labels aren't indented (allow a single space indentation) 550569078651SJoe Perches# and ignore bitfield definitions like foo:1 550669078651SJoe Perches# Strictly, labels can have whitespace after the identifier and before the : 550769078651SJoe Perches# but this is not allowed here as many ?: uses would appear to be labels 550869078651SJoe Perches if ($sline =~ /^.\s+[A-Za-z_][A-Za-z\d_]*:(?!\s*\d+)/ && 550969078651SJoe Perches $sline !~ /^. [A-Za-z\d_][A-Za-z\d_]*:/ && 551069078651SJoe Perches $sline !~ /^.\s+default:/) { 55113705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 55123705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 55133705ce5bSJoe Perches $fix) { 5514194f66fcSJoe Perches $fixed[$fixlinenr] =~ 55153705ce5bSJoe Perches s/^(.)\s+/$1/; 55163705ce5bSJoe Perches } 55170a920b5bSAndy Whitcroft } 55180a920b5bSAndy Whitcroft 551940873abaSJoe Perches# check if a statement with a comma should be two statements like: 552040873abaSJoe Perches# foo = bar(), /* comma should be semicolon */ 552140873abaSJoe Perches# bar = baz(); 552240873abaSJoe Perches if (defined($stat) && 552340873abaSJoe Perches $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) { 552440873abaSJoe Perches my $cnt = statement_rawlines($stat); 552540873abaSJoe Perches my $herectx = get_stat_here($linenr, $cnt, $here); 552640873abaSJoe Perches WARN("SUSPECT_COMMA_SEMICOLON", 552740873abaSJoe Perches "Possible comma where semicolon could be used\n" . $herectx); 552840873abaSJoe Perches } 552940873abaSJoe Perches 55305b9553abSJoe Perches# return is not a function 5531507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 5532c45dcabdSAndy Whitcroft my $spacing = $1; 55335b57980dSJoe Perches if ($perl_version_ok && 55345b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 55355b9553abSJoe Perches my $value = $1; 55365b9553abSJoe Perches $value = deparenthesize($value); 55375b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 5538000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 5539000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 55405b9553abSJoe Perches } 5541c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 5542000d1cc1SJoe Perches ERROR("SPACING", 5543000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 5544c45dcabdSAndy Whitcroft } 5545c45dcabdSAndy Whitcroft } 5546507e5141SJoe Perches 5547b43ae21bSJoe Perches# unnecessary return in a void function 5548b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 5549b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 5550b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 5551b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 5552b43ae21bSJoe Perches $linenr >= 3 && 5553b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 5554b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 55559819cf25SJoe Perches WARN("RETURN_VOID", 5556b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 55579819cf25SJoe Perches } 55589819cf25SJoe Perches 5559189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 55605b57980dSJoe Perches if ($perl_version_ok && 5561189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 5562189248d8SJoe Perches my $openparens = $1; 5563189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 5564189248d8SJoe Perches my $msg = ""; 5565189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 5566189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 5567189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 5568189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 5569189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 5570189248d8SJoe Perches } 5571189248d8SJoe Perches } 5572189248d8SJoe Perches 5573c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 5574c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 5575c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 5576c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 55775b57980dSJoe Perches if ($perl_version_ok && 5578c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 5579c5595fa2SJoe Perches my $lead = $1; 5580c5595fa2SJoe Perches my $const = $2; 5581c5595fa2SJoe Perches my $comp = $3; 5582c5595fa2SJoe Perches my $to = $4; 5583c5595fa2SJoe Perches my $newcomp = $comp; 5584f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 5585c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 5586c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 5587c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 5588c5595fa2SJoe Perches $fix) { 5589c5595fa2SJoe Perches if ($comp eq "<") { 5590c5595fa2SJoe Perches $newcomp = ">"; 5591c5595fa2SJoe Perches } elsif ($comp eq "<=") { 5592c5595fa2SJoe Perches $newcomp = ">="; 5593c5595fa2SJoe Perches } elsif ($comp eq ">") { 5594c5595fa2SJoe Perches $newcomp = "<"; 5595c5595fa2SJoe Perches } elsif ($comp eq ">=") { 5596c5595fa2SJoe Perches $newcomp = "<="; 5597c5595fa2SJoe Perches } 5598c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 5599c5595fa2SJoe Perches } 5600c5595fa2SJoe Perches } 5601c5595fa2SJoe Perches 5602f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 5603f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 560453a3c448SAndy Whitcroft my $name = $1; 560546b85bf9SGuenter Roeck if ($name ne 'EOF' && $name ne 'ERROR' && $name !~ /^EPOLL/) { 5606000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 5607f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 560853a3c448SAndy Whitcroft } 560953a3c448SAndy Whitcroft } 5610c45dcabdSAndy Whitcroft 56110a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 56124a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 56133705ce5bSJoe Perches if (ERROR("SPACING", 56143705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 56153705ce5bSJoe Perches $fix) { 5616194f66fcSJoe Perches $fixed[$fixlinenr] =~ 56173705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 56183705ce5bSJoe Perches } 56190a920b5bSAndy Whitcroft } 56200a920b5bSAndy Whitcroft 5621f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 5622f5fe35ddSAndy Whitcroft# statements after the conditional. 5623170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 56243e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 56253e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 56263e469cdcSAndy Whitcroft if (!defined $stat); 5627170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 5628170d3a22SAndy Whitcroft $remain_next, $off_next); 5629170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 5630170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 5631170d3a22SAndy Whitcroft 5632170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 5633170d3a22SAndy Whitcroft # If the statement carries leading newlines, 5634170d3a22SAndy Whitcroft # then count those as offsets. 5635170d3a22SAndy Whitcroft my ($whitespace) = 5636170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 5637170d3a22SAndy Whitcroft my $offset = 5638170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 5639170d3a22SAndy Whitcroft 5640170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 5641170d3a22SAndy Whitcroft $offset} = 1; 5642170d3a22SAndy Whitcroft } 5643170d3a22SAndy Whitcroft } 5644170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 5645c11230f4SJoe Perches defined($stat) && defined($cond) && 5646170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 5647171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 5648481efd7bSJoe Perches my $fixed_assign_in_if = 0; 56498905a67cSAndy Whitcroft 5650b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 565165b64b3bSJoe Perches if (ERROR("ASSIGN_IN_IF", 565265b64b3bSJoe Perches "do not use assignment in if condition\n" . $herecurr) && 565365b64b3bSJoe Perches $fix && $perl_version_ok) { 565465b64b3bSJoe Perches if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) { 565565b64b3bSJoe Perches my $space = $1; 565665b64b3bSJoe Perches my $not = $2; 565765b64b3bSJoe Perches my $statement = $3; 565865b64b3bSJoe Perches my $assigned = $4; 565965b64b3bSJoe Perches my $test = $8; 566065b64b3bSJoe Perches my $against = $9; 566165b64b3bSJoe Perches my $brace = $15; 566265b64b3bSJoe Perches fix_delete_line($fixlinenr, $rawline); 566365b64b3bSJoe Perches fix_insert_line($fixlinenr, "$space$statement;"); 566465b64b3bSJoe Perches my $newline = "${space}if ("; 566565b64b3bSJoe Perches $newline .= '!' if defined($not); 566665b64b3bSJoe Perches $newline .= '(' if (defined $not && defined($test) && defined($against)); 566765b64b3bSJoe Perches $newline .= "$assigned"; 566865b64b3bSJoe Perches $newline .= " $test $against" if (defined($test) && defined($against)); 566965b64b3bSJoe Perches $newline .= ')' if (defined $not && defined($test) && defined($against)); 567065b64b3bSJoe Perches $newline .= ')'; 567165b64b3bSJoe Perches $newline .= " {" if (defined($brace)); 567265b64b3bSJoe Perches fix_insert_line($fixlinenr + 1, $newline); 5673481efd7bSJoe Perches $fixed_assign_in_if = 1; 567465b64b3bSJoe Perches } 567565b64b3bSJoe Perches } 56768905a67cSAndy Whitcroft } 56778905a67cSAndy Whitcroft 56788905a67cSAndy Whitcroft # Find out what is on the end of the line after the 56798905a67cSAndy Whitcroft # conditional. 5680773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 56818905a67cSAndy Whitcroft $s =~ s/\n.*//g; 568213214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 568353210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 568453210168SAndy Whitcroft $c !~ /}\s*while\s*/) 5685773647a0SAndy Whitcroft { 5686bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 5687bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 5688bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 568942bdf74cSHidetoshi Seto my $stat_real = ''; 5690bb44ad39SAndy Whitcroft 569142bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 569242bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 5693bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 5694bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 5695bb44ad39SAndy Whitcroft } 5696bb44ad39SAndy Whitcroft 5697481efd7bSJoe Perches if (ERROR("TRAILING_STATEMENTS", 5698481efd7bSJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real) && 5699481efd7bSJoe Perches !$fixed_assign_in_if && 5700481efd7bSJoe Perches $cond_lines == 0 && 5701481efd7bSJoe Perches $fix && $perl_version_ok && 5702481efd7bSJoe Perches $fixed[$fixlinenr] =~ /^\+(\s*)((?:if|while|for)\s*$balanced_parens)\s*(.*)$/) { 5703481efd7bSJoe Perches my $indent = $1; 5704481efd7bSJoe Perches my $test = $2; 5705481efd7bSJoe Perches my $rest = rtrim($4); 5706481efd7bSJoe Perches if ($rest =~ /;$/) { 5707481efd7bSJoe Perches $fixed[$fixlinenr] = "\+$indent$test"; 5708481efd7bSJoe Perches fix_insert_line($fixlinenr + 1, "$indent\t$rest"); 5709481efd7bSJoe Perches } 5710481efd7bSJoe Perches } 57118905a67cSAndy Whitcroft } 57128905a67cSAndy Whitcroft } 57138905a67cSAndy Whitcroft 571413214adfSAndy Whitcroft# Check for bitwise tests written as boolean 571513214adfSAndy Whitcroft if ($line =~ / 571613214adfSAndy Whitcroft (?: 571713214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 571813214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 571913214adfSAndy Whitcroft (?:\&\&|\|\|) 572013214adfSAndy Whitcroft | 572113214adfSAndy Whitcroft (?:\&\&|\|\|) 572213214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 572313214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 572413214adfSAndy Whitcroft )/x) 572513214adfSAndy Whitcroft { 5726000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 5727000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 572813214adfSAndy Whitcroft } 572913214adfSAndy Whitcroft 57308905a67cSAndy Whitcroft# if and else should not have general statements after it 573113214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 573213214adfSAndy Whitcroft my $s = $1; 573313214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 573413214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 5735000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5736000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 57370a920b5bSAndy Whitcroft } 573813214adfSAndy Whitcroft } 573939667782SAndy Whitcroft# if should not continue a brace 574039667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 5741000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5742048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 574339667782SAndy Whitcroft $herecurr); 574439667782SAndy Whitcroft } 5745a1080bf8SAndy Whitcroft# case and default should not have general statements after them 5746a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 5747a1080bf8SAndy Whitcroft $line !~ /\G(?: 57483fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 5749a1080bf8SAndy Whitcroft \s*return\s+ 5750a1080bf8SAndy Whitcroft )/xg) 5751a1080bf8SAndy Whitcroft { 5752000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5753000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 5754a1080bf8SAndy Whitcroft } 57550a920b5bSAndy Whitcroft 57560a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 57570a920b5bSAndy Whitcroft # indent level to be relevant to each other. 57588b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 57590a920b5bSAndy Whitcroft $previndent == $indent) { 57608b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 57618b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 57628b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 57638b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 57648b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 57658b8856f4SJoe Perches my $fixedline = $prevrawline; 57668b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 57678b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 57688b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 57698b8856f4SJoe Perches } 57708b8856f4SJoe Perches $fixedline = $rawline; 57718b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 57728b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 57738b8856f4SJoe Perches } 57740a920b5bSAndy Whitcroft } 57750a920b5bSAndy Whitcroft 57768b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 5777c2fdda0dSAndy Whitcroft $previndent == $indent) { 5778c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 5779c2fdda0dSAndy Whitcroft 5780c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 5781c2fdda0dSAndy Whitcroft # conditional. 5782773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 5783c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 5784c2fdda0dSAndy Whitcroft 5785c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 57868b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 57878b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 57888b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 57898b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 57908b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 57918b8856f4SJoe Perches my $fixedline = $prevrawline; 57928b8856f4SJoe Perches my $trailing = $rawline; 57938b8856f4SJoe Perches $trailing =~ s/^\+//; 57948b8856f4SJoe Perches $trailing = trim($trailing); 57958b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 57968b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 57978b8856f4SJoe Perches } 5798c2fdda0dSAndy Whitcroft } 5799c2fdda0dSAndy Whitcroft } 5800c2fdda0dSAndy Whitcroft 580195e2c602SJoe Perches#Specific variable tests 5802323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 5803323c1260SJoe Perches my $var = $1; 580495e2c602SJoe Perches 580595e2c602SJoe Perches#CamelCase 5806807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 5807be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 58084104a206SŁukasz Stelmach#Ignore some autogenerated defines and enum values 58094104a206SŁukasz Stelmach $var !~ /^(?:[A-Z]+_){1,5}[A-Z]{1,3}[a-z]/ && 581022735ce8SJoe Perches#Ignore Page<foo> variants 5811807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 5812d439e6a5SJoe Perches#Ignore SI style variants like nS, mV and dB 5813d439e6a5SJoe Perches#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE) 5814d439e6a5SJoe Perches $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ && 5815f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 5816f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 5817f858e23aSAntonio Borneo while ($var =~ m{\b($Ident)}g) { 58187e781f67SJoe Perches my $word = $1; 58197e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 5820d8b07710SJoe Perches if ($check) { 5821d8b07710SJoe Perches seed_camelcase_includes(); 5822d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 5823d8b07710SJoe Perches seed_camelcase_file($realfile); 5824d8b07710SJoe Perches $camelcase_file_seeded = 1; 5825d8b07710SJoe Perches } 5826d8b07710SJoe Perches } 58277e781f67SJoe Perches if (!defined $camelcase{$word}) { 58287e781f67SJoe Perches $camelcase{$word} = 1; 5829be79794bSJoe Perches CHK("CAMELCASE", 58307e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 58317e781f67SJoe Perches } 5832323c1260SJoe Perches } 5833323c1260SJoe Perches } 58343445686aSJoe Perches } 58350a920b5bSAndy Whitcroft 58360a920b5bSAndy Whitcroft#no spaces allowed after \ in define 5837d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 5838d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 5839d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 5840d5e616fcSJoe Perches $fix) { 5841194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 5842d5e616fcSJoe Perches } 58430a920b5bSAndy Whitcroft } 58440a920b5bSAndy Whitcroft 58450e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 58460e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 5847c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 5848e09dec48SAndy Whitcroft my $file = "$1.h"; 5849e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 5850e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 5851e09dec48SAndy Whitcroft $realfile ne $checkfile && 58527840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 5853c45dcabdSAndy Whitcroft { 58540e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 58550e212e0aSFabian Frederick if ($asminclude > 0) { 5856e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 5857000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 5858000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5859e09dec48SAndy Whitcroft } else { 5860000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 5861000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5862e09dec48SAndy Whitcroft } 58630a920b5bSAndy Whitcroft } 58640a920b5bSAndy Whitcroft } 58650e212e0aSFabian Frederick } 58660a920b5bSAndy Whitcroft 5867653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 5868653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 5869cf655043SAndy Whitcroft# in a known good container 5870b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 5871b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 5872d8aaf121SAndy Whitcroft my $ln = $linenr; 5873d8aaf121SAndy Whitcroft my $cnt = $realcnt; 5874c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 5875c45dcabdSAndy Whitcroft my $ctx = ''; 587608a2843eSJoe Perches my $has_flow_statement = 0; 587708a2843eSJoe Perches my $has_arg_concat = 0; 5878c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 5879f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 5880f74bd194SAndy Whitcroft $ctx = $dstat; 5881c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 5882a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 5883c45dcabdSAndy Whitcroft 588408a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 588562e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 588608a2843eSJoe Perches 5887f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 5888f59b64bfSJoe Perches my $define_args = $1; 5889f59b64bfSJoe Perches my $define_stmt = $dstat; 5890f59b64bfSJoe Perches my @def_args = (); 5891f59b64bfSJoe Perches 5892f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 5893f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 5894f59b64bfSJoe Perches $define_args =~ s/\s*//g; 58958c8c45cfSJoe Perches $define_args =~ s/\\\+?//g; 5896f59b64bfSJoe Perches @def_args = split(",", $define_args); 5897f59b64bfSJoe Perches } 5898f59b64bfSJoe Perches 5899292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 5900c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 5901c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 5902c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 5903c45dcabdSAndy Whitcroft 5904c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 59052e44e803SDwaipayan Ray while ($dstat =~ s/\([^\(\)]*\)/1u/ || 59062e44e803SDwaipayan Ray $dstat =~ s/\{[^\{\}]*\}/1u/ || 59072e44e803SDwaipayan Ray $dstat =~ s/.\[[^\[\]]*\]/1u/) 5908bf30d6edSAndy Whitcroft { 5909c45dcabdSAndy Whitcroft } 5910c45dcabdSAndy Whitcroft 5911342d3d2fSAntonio Borneo # Flatten any obvious string concatenation. 591233acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 591333acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 5914e45bab8eSAndy Whitcroft { 5915e45bab8eSAndy Whitcroft } 5916e45bab8eSAndy Whitcroft 591742e15293SJoe Perches # Make asm volatile uses seem like a generic function 591842e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 591942e15293SJoe Perches 5920c45dcabdSAndy Whitcroft my $exceptions = qr{ 5921c45dcabdSAndy Whitcroft $Declare| 5922c45dcabdSAndy Whitcroft module_param_named| 5923a0a0a7a9SKees Cook MODULE_PARM_DESC| 5924c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 5925c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 5926383099fdSAndy Whitcroft __typeof__\(| 592722fd2d3eSStefani Seibold union| 592822fd2d3eSStefani Seibold struct| 5929ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 59306b10df42SVladimir Zapolskiy ^\"|\"$| 59316b10df42SVladimir Zapolskiy ^\[ 5932c45dcabdSAndy Whitcroft }x; 59335eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 5934f59b64bfSJoe Perches 5935f59b64bfSJoe Perches $ctx =~ s/\n*$//; 5936f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 5937e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 5938f59b64bfSJoe Perches 5939f74bd194SAndy Whitcroft if ($dstat ne '' && 5940f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 5941f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 59423cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 5943356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5944f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 5945f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5946e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 5947dc3f4deeSStanislaw Gruszka $dstat !~ /^case\b/ && # case ... 594872f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 59492e44e803SDwaipayan Ray $dstat !~ /^while\s*$Constant\s*$Constant\s*$/ && # while (...) {...} 5950f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5951f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5952f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 59534e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5954f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5955c45dcabdSAndy Whitcroft { 5956e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5957e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5958e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5959e795556aSJoe Perches } elsif ($dstat =~ /;/) { 5960f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5961f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5962f74bd194SAndy Whitcroft } else { 5963000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 5964388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5965d8aaf121SAndy Whitcroft } 5966f59b64bfSJoe Perches 5967f59b64bfSJoe Perches } 59685207649bSJoe Perches 59695207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 59705207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 59715207649bSJoe Perches my $first = 1; 59725207649bSJoe Perches $define_stmt = ""; 59735207649bSJoe Perches foreach my $l (@stmt_array) { 59745207649bSJoe Perches $l =~ s/\\$//; 59755207649bSJoe Perches if ($first) { 59765207649bSJoe Perches $define_stmt = $l; 59775207649bSJoe Perches $first = 0; 59785207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 59795207649bSJoe Perches $define_stmt .= substr($l, 1); 59805207649bSJoe Perches } 59815207649bSJoe Perches } 59825207649bSJoe Perches $define_stmt =~ s/$;//g; 59835207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 59845207649bSJoe Perches $define_stmt = trim($define_stmt); 59855207649bSJoe Perches 5986f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5987f59b64bfSJoe Perches foreach my $arg (@def_args) { 5988f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 59899192d41aSJoe Perches next if ($arg =~ /^type$/i); 59907fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 59917b844345SVincent Mailhol $tmp_stmt =~ s/\b(__must_be_array|offsetof|sizeof|sizeof_field|__stringify|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 59927fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 59937fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 5994d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 5995f59b64bfSJoe Perches if ($use_cnt > 1) { 5996f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5997f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5998f59b64bfSJoe Perches } 59999192d41aSJoe Perches# check if any macro arguments may have other precedence issues 60007fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 60019192d41aSJoe Perches ((defined($1) && $1 ne ',') || 60029192d41aSJoe Perches (defined($2) && $2 ne ','))) { 60039192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 60049192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 60059192d41aSJoe Perches } 60060a920b5bSAndy Whitcroft } 60075023d347SJoe Perches 600808a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 600908a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 601008a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 601108a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 6012e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 601308a2843eSJoe Perches 601408a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 601508a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 601608a2843eSJoe Perches } 601708a2843eSJoe Perches 6018481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 60195023d347SJoe Perches 60205023d347SJoe Perches } else { 60215023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 6022481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 6023481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 60245023d347SJoe Perches $line =~ /^\+.*\\$/) { 60255023d347SJoe Perches WARN("LINE_CONTINUATIONS", 60265023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 60275023d347SJoe Perches } 6028653d4876SAndy Whitcroft } 60290a920b5bSAndy Whitcroft 6030b13edf7fSJoe Perches# do {} while (0) macro tests: 6031b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 6032b13edf7fSJoe Perches# macro should not end with a semicolon 60335b57980dSJoe Perches if ($perl_version_ok && 6034b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 6035b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 6036b13edf7fSJoe Perches my $ln = $linenr; 6037b13edf7fSJoe Perches my $cnt = $realcnt; 6038b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 6039b13edf7fSJoe Perches my $ctx = ''; 6040b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 6041b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 6042b13edf7fSJoe Perches $ctx = $dstat; 6043b13edf7fSJoe Perches 6044b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 60451b36b201SJoe Perches $dstat =~ s/$;/ /g; 6046b13edf7fSJoe Perches 6047b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 6048b13edf7fSJoe Perches my $stmts = $2; 6049b13edf7fSJoe Perches my $semis = $3; 6050b13edf7fSJoe Perches 6051b13edf7fSJoe Perches $ctx =~ s/\n*$//; 6052b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 6053e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6054b13edf7fSJoe Perches 6055ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 6056ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 6057b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 6058b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 6059b13edf7fSJoe Perches } 6060b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 6061b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 6062b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 6063b13edf7fSJoe Perches } 6064f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 6065f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 6066f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 6067e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6068f5ef95b1SJoe Perches 6069f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 6070f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 6071b13edf7fSJoe Perches } 6072b13edf7fSJoe Perches } 6073b13edf7fSJoe Perches 6074f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 607513214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 607613214adfSAndy Whitcroft my ($level, $endln, @chunks) = 6077cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 607813214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 6079cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 6080cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 6081aad4f614SJoe Perches my @allowed = (); 6082aad4f614SJoe Perches my $allow = 0; 608313214adfSAndy Whitcroft my $seen = 0; 6084773647a0SAndy Whitcroft my $herectx = $here . "\n"; 6085cf655043SAndy Whitcroft my $ln = $linenr - 1; 608613214adfSAndy Whitcroft for my $chunk (@chunks) { 608713214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 608813214adfSAndy Whitcroft 6089773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 6090773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 6091773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 6092773647a0SAndy Whitcroft 6093aad4f614SJoe Perches $allowed[$allow] = 0; 6094773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 6095773647a0SAndy Whitcroft 6096773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 6097773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 6098773647a0SAndy Whitcroft 6099773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 6100cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 6101cf655043SAndy Whitcroft 6102773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 610313214adfSAndy Whitcroft 610413214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 610513214adfSAndy Whitcroft 6106aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 6107cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 6108cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 6109aad4f614SJoe Perches $allowed[$allow] = 1; 611013214adfSAndy Whitcroft } 611113214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 6112cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 6113aad4f614SJoe Perches $allowed[$allow] = 1; 611413214adfSAndy Whitcroft } 6115cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 6116cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 6117aad4f614SJoe Perches $allowed[$allow] = 1; 611813214adfSAndy Whitcroft } 6119aad4f614SJoe Perches $allow++; 612013214adfSAndy Whitcroft } 6121aad4f614SJoe Perches if ($seen) { 6122aad4f614SJoe Perches my $sum_allowed = 0; 6123aad4f614SJoe Perches foreach (@allowed) { 6124aad4f614SJoe Perches $sum_allowed += $_; 6125aad4f614SJoe Perches } 6126aad4f614SJoe Perches if ($sum_allowed == 0) { 6127000d1cc1SJoe Perches WARN("BRACES", 6128000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 6129aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 6130aad4f614SJoe Perches $seen != $allow) { 6131aad4f614SJoe Perches CHK("BRACES", 6132aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 6133aad4f614SJoe Perches } 613413214adfSAndy Whitcroft } 613513214adfSAndy Whitcroft } 613613214adfSAndy Whitcroft } 6137773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 613813214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 6139cf655043SAndy Whitcroft my $allowed = 0; 6140f0a594c1SAndy Whitcroft 6141cf655043SAndy Whitcroft # Check the pre-context. 6142cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 6143cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 6144cf655043SAndy Whitcroft $allowed = 1; 6145f0a594c1SAndy Whitcroft } 6146773647a0SAndy Whitcroft 6147773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 6148773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 6149773647a0SAndy Whitcroft 6150cf655043SAndy Whitcroft # Check the condition. 6151cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 6152773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 6153cf655043SAndy Whitcroft if (defined $cond) { 6154773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 6155cf655043SAndy Whitcroft } 6156cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 6157cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 6158cf655043SAndy Whitcroft $allowed = 1; 6159cf655043SAndy Whitcroft } 6160cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 6161cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 6162cf655043SAndy Whitcroft $allowed = 1; 6163cf655043SAndy Whitcroft } 6164cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 6165cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 6166cf655043SAndy Whitcroft $allowed = 1; 6167cf655043SAndy Whitcroft } 6168cf655043SAndy Whitcroft # Check the post-context. 6169cf655043SAndy Whitcroft if (defined $chunks[1]) { 6170cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 6171cf655043SAndy Whitcroft if (defined $cond) { 6172773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 6173cf655043SAndy Whitcroft } 6174cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 6175cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 6176cf655043SAndy Whitcroft $allowed = 1; 6177cf655043SAndy Whitcroft } 6178cf655043SAndy Whitcroft } 6179cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 6180f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 6181e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6182cf655043SAndy Whitcroft 6183000d1cc1SJoe Perches WARN("BRACES", 6184000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 6185f0a594c1SAndy Whitcroft } 6186f0a594c1SAndy Whitcroft } 6187f0a594c1SAndy Whitcroft 6188e4c5babdSJoe Perches# check for single line unbalanced braces 618995330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 619095330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 6191e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 6192e4c5babdSJoe Perches } 6193e4c5babdSJoe Perches 61940979ae66SJoe Perches# check for unnecessary blank lines around braces 619577b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 6196f8e58219SJoe Perches if (CHK("BRACES", 6197f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 6198f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 6199f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 6200f8e58219SJoe Perches } 62010979ae66SJoe Perches } 620277b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 6203f8e58219SJoe Perches if (CHK("BRACES", 6204f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 6205f8e58219SJoe Perches $fix) { 6206f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 6207f8e58219SJoe Perches } 62080979ae66SJoe Perches } 62090979ae66SJoe Perches 62104a0df2efSAndy Whitcroft# no volatiles please 62116c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 62126c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 6213000d1cc1SJoe Perches WARN("VOLATILE", 62148c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 62154a0df2efSAndy Whitcroft } 62164a0df2efSAndy Whitcroft 62175e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 62185e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 62195e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 62205e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 622133acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 62225e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 62235e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 62245e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 62255e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 62265e4f6ba5SJoe Perches $fix && 62275e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 62285e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 62295e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 62305e4f6ba5SJoe Perches my $comma_close = ""; 62315e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 62325e4f6ba5SJoe Perches $comma_close = $1; 62335e4f6ba5SJoe Perches } 62345e4f6ba5SJoe Perches 62355e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 62365e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 62375e4f6ba5SJoe Perches my $fixedline = $prevrawline; 62385e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 62395e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 62405e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 62415e4f6ba5SJoe Perches $fixedline = $rawline; 62425e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 62435e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 62445e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 62455e4f6ba5SJoe Perches } 62465e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 62475e4f6ba5SJoe Perches } 62485e4f6ba5SJoe Perches } 62495e4f6ba5SJoe Perches 62505e4f6ba5SJoe Perches# check for missing a space in a string concatenation 62515e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 62525e4f6ba5SJoe Perches WARN('MISSING_SPACE', 62535e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 62545e4f6ba5SJoe Perches } 62555e4f6ba5SJoe Perches 625677cb8546SJoe Perches# check for an embedded function name in a string when the function is known 6257e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 6258e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 6259e4b7d309SJoe Perches# function declarations 626077cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 626177cb8546SJoe Perches defined($context_function) && 6262e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 6263e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 626477cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 6265e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 626677cb8546SJoe Perches } 626777cb8546SJoe Perches 6268adb2da82SJoe Perches# check for unnecessary function tracing like uses 6269adb2da82SJoe Perches# This does not use $logFunctions because there are many instances like 6270adb2da82SJoe Perches# 'dprintk(FOO, "%s()\n", __func__);' which do not match $logFunctions 6271adb2da82SJoe Perches if ($rawline =~ /^\+.*\([^"]*"$tracing_logging_tags{0,3}%s(?:\s*\(\s*\)\s*)?$tracing_logging_tags{0,3}(?:\\n)?"\s*,\s*__func__\s*\)\s*;/) { 6272adb2da82SJoe Perches if (WARN("TRACING_LOGGING", 6273adb2da82SJoe Perches "Unnecessary ftrace-like logging - prefer using ftrace\n" . $herecurr) && 6274adb2da82SJoe Perches $fix) { 6275adb2da82SJoe Perches fix_delete_line($fixlinenr, $rawline); 6276adb2da82SJoe Perches } 6277adb2da82SJoe Perches } 6278adb2da82SJoe Perches 62795e4f6ba5SJoe Perches# check for spaces before a quoted newline 62805e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 62815e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 62825e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 62835e4f6ba5SJoe Perches $fix) { 62845e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 62855e4f6ba5SJoe Perches } 62865e4f6ba5SJoe Perches 62875e4f6ba5SJoe Perches } 62885e4f6ba5SJoe Perches 6289f17dba4fSJoe Perches# concatenated string without spaces between elements 6290d2af5aa6SJoe Perches if ($line =~ /$String[A-Z_]/ || 6291d2af5aa6SJoe Perches ($line =~ /([A-Za-z0-9_]+)$String/ && $1 !~ /^[Lu]$/)) { 629279682c0cSJoe Perches if (CHK("CONCATENATED_STRING", 629379682c0cSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr) && 629479682c0cSJoe Perches $fix) { 629579682c0cSJoe Perches while ($line =~ /($String)/g) { 629679682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 629779682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/; 629879682c0cSJoe Perches $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/; 629979682c0cSJoe Perches } 630079682c0cSJoe Perches } 6301f17dba4fSJoe Perches } 6302f17dba4fSJoe Perches 630390ad30e5SJoe Perches# uncoalesced string fragments 6304d2af5aa6SJoe Perches if ($line =~ /$String\s*[Lu]?"/) { 630579682c0cSJoe Perches if (WARN("STRING_FRAGMENTS", 630679682c0cSJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr) && 630779682c0cSJoe Perches $fix) { 630879682c0cSJoe Perches while ($line =~ /($String)(?=\s*")/g) { 630979682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 631079682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e; 631179682c0cSJoe Perches } 631279682c0cSJoe Perches } 631390ad30e5SJoe Perches } 631490ad30e5SJoe Perches 6315522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 6316522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 6317522b837cSAlexey Dobriyan my $show_Z = 1; 63185e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 6319522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 63205e4f6ba5SJoe Perches $string =~ s/%%/__/g; 6321522b837cSAlexey Dobriyan # check for %L 6322522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 63235e4f6ba5SJoe Perches WARN("PRINTF_L", 6324522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 6325522b837cSAlexey Dobriyan $show_L = 0; 63265e4f6ba5SJoe Perches } 6327522b837cSAlexey Dobriyan # check for %Z 6328522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 6329522b837cSAlexey Dobriyan WARN("PRINTF_Z", 6330522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 6331522b837cSAlexey Dobriyan $show_Z = 0; 6332522b837cSAlexey Dobriyan } 6333522b837cSAlexey Dobriyan # check for 0x<decimal> 6334522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 6335522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 63366e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 63376e300757SJoe Perches } 63385e4f6ba5SJoe Perches } 63395e4f6ba5SJoe Perches 63405e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 63413f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 63425e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 63435e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 63445e4f6ba5SJoe Perches } 63455e4f6ba5SJoe Perches 634600df344fSAndy Whitcroft# warn about #if 0 6347c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 634860f89010SPrakruthi Deepak Heragu WARN("IF_0", 634960f89010SPrakruthi Deepak Heragu "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr); 635060f89010SPrakruthi Deepak Heragu } 635160f89010SPrakruthi Deepak Heragu 635260f89010SPrakruthi Deepak Heragu# warn about #if 1 635360f89010SPrakruthi Deepak Heragu if ($line =~ /^.\s*\#\s*if\s+1\b/) { 635460f89010SPrakruthi Deepak Heragu WARN("IF_1", 635560f89010SPrakruthi Deepak Heragu "Consider removing the #if 1 and its #endif\n" . $herecurr); 63564a0df2efSAndy Whitcroft } 63574a0df2efSAndy Whitcroft 635803df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 635903df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 6360100425deSJoe Perches my $tested = quotemeta($1); 6361100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 6362100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 6363100425deSJoe Perches my $func = $1; 6364100425deSJoe Perches if (WARN('NEEDLESS_IF', 6365100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 6366100425deSJoe Perches $fix) { 6367100425deSJoe Perches my $do_fix = 1; 6368100425deSJoe Perches my $leading_tabs = ""; 6369100425deSJoe Perches my $new_leading_tabs = ""; 6370100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 6371100425deSJoe Perches $leading_tabs = $1; 6372100425deSJoe Perches } else { 6373100425deSJoe Perches $do_fix = 0; 6374100425deSJoe Perches } 6375100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 6376100425deSJoe Perches $new_leading_tabs = $1; 6377100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 6378100425deSJoe Perches $do_fix = 0; 6379100425deSJoe Perches } 6380100425deSJoe Perches } else { 6381100425deSJoe Perches $do_fix = 0; 6382100425deSJoe Perches } 6383100425deSJoe Perches if ($do_fix) { 6384100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 6385100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 6386100425deSJoe Perches } 6387100425deSJoe Perches } 63884c432a8fSGreg Kroah-Hartman } 63894c432a8fSGreg Kroah-Hartman } 6390f0a594c1SAndy Whitcroft 6391ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 6392ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 6393ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 6394ebfdc409SJoe Perches (defined $1 || defined $3) && 6395ebfdc409SJoe Perches $linenr > 3) { 6396ebfdc409SJoe Perches my $testval = $2; 6397ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 6398ebfdc409SJoe Perches 6399ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 6400ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 6401ebfdc409SJoe Perches 6402e29a70f1SJoe Perches if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ && 6403e29a70f1SJoe Perches $s !~ /\b__GFP_NOWARN\b/ ) { 6404ebfdc409SJoe Perches WARN("OOM_MESSAGE", 6405ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 6406ebfdc409SJoe Perches } 6407ebfdc409SJoe Perches } 6408ebfdc409SJoe Perches 6409f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 6410dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 6411f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 6412f78d98f6SJoe Perches my $level = $1; 6413f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 6414f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 6415f78d98f6SJoe Perches $fix) { 6416f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 6417f78d98f6SJoe Perches } 6418f78d98f6SJoe Perches } 6419f78d98f6SJoe Perches 642045c55e92SJoe Perches# check for logging continuations 642145c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 642245c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 642345c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 642445c55e92SJoe Perches } 642545c55e92SJoe Perches 642670eb2275SDwaipayan Ray# check for unnecessary use of %h[xudi] and %hh[xudi] in logging functions 642770eb2275SDwaipayan Ray if (defined $stat && 642870eb2275SDwaipayan Ray $line =~ /\b$logFunctions\s*\(/ && 642970eb2275SDwaipayan Ray index($stat, '"') >= 0) { 643070eb2275SDwaipayan Ray my $lc = $stat =~ tr@\n@@; 643170eb2275SDwaipayan Ray $lc = $lc + $linenr; 643270eb2275SDwaipayan Ray my $stat_real = get_stat_real($linenr, $lc); 643370eb2275SDwaipayan Ray pos($stat_real) = index($stat_real, '"'); 643470eb2275SDwaipayan Ray while ($stat_real =~ /[^\"%]*(%[\#\d\.\*\-]*(h+)[idux])/g) { 643570eb2275SDwaipayan Ray my $pspec = $1; 643670eb2275SDwaipayan Ray my $h = $2; 643770eb2275SDwaipayan Ray my $lineoff = substr($stat_real, 0, $-[1]) =~ tr@\n@@; 643870eb2275SDwaipayan Ray if (WARN("UNNECESSARY_MODIFIER", 643970eb2275SDwaipayan Ray "Integer promotion: Using '$h' in '$pspec' is unnecessary\n" . "$here\n$stat_real\n") && 644070eb2275SDwaipayan Ray $fix && $fixed[$fixlinenr + $lineoff] =~ /^\+/) { 644170eb2275SDwaipayan Ray my $nspec = $pspec; 644270eb2275SDwaipayan Ray $nspec =~ s/h//g; 644370eb2275SDwaipayan Ray $fixed[$fixlinenr + $lineoff] =~ s/\Q$pspec\E/$nspec/; 644470eb2275SDwaipayan Ray } 644570eb2275SDwaipayan Ray } 644670eb2275SDwaipayan Ray } 644770eb2275SDwaipayan Ray 6448abb08a53SJoe Perches# check for mask then right shift without a parentheses 64495b57980dSJoe Perches if ($perl_version_ok && 6450abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 6451abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 6452abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 6453abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 6454abb08a53SJoe Perches } 6455abb08a53SJoe Perches 6456b75ac618SJoe Perches# check for pointer comparisons to NULL 64575b57980dSJoe Perches if ($perl_version_ok) { 6458b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 6459b75ac618SJoe Perches my $val = $1; 6460b75ac618SJoe Perches my $equal = "!"; 6461b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 6462b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 6463b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 6464b75ac618SJoe Perches $fix) { 6465b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 6466b75ac618SJoe Perches } 6467b75ac618SJoe Perches } 6468b75ac618SJoe Perches } 6469b75ac618SJoe Perches 64708716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 64718716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 64728716de38SJoe Perches my $attr = $1; 64738716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 64748716de38SJoe Perches my $ptr = $1; 64758716de38SJoe Perches my $var = $2; 64768716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 64778716de38SJoe Perches ERROR("MISPLACED_INIT", 64788716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 64798716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 64808716de38SJoe Perches WARN("MISPLACED_INIT", 64818716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 64828716de38SJoe Perches $fix) { 6483194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s+(?:const\s+)?)(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*([=;])\s*/"$1" . trim(string_find_replace($2, "\\s*$attr\\s*", " ")) . " " . trim(string_find_replace($3, "\\s*$attr\\s*", "")) . " $attr" . ("$4" eq ";" ? ";" : " = ")/e; 64848716de38SJoe Perches } 64858716de38SJoe Perches } 64868716de38SJoe Perches } 64878716de38SJoe Perches 6488e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 6489e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 6490e970b884SJoe Perches my $attr = $1; 6491e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 6492e970b884SJoe Perches my $attr_prefix = $1; 6493e970b884SJoe Perches my $attr_type = $2; 6494e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 6495e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 6496e970b884SJoe Perches $fix) { 6497194f66fcSJoe Perches $fixed[$fixlinenr] =~ 6498e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 6499e970b884SJoe Perches } 6500e970b884SJoe Perches } 6501e970b884SJoe Perches 6502e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 6503e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 6504e970b884SJoe Perches my $attr = $1; 6505e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 6506e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 6507e970b884SJoe Perches $fix) { 6508194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 6509e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 6510e970b884SJoe Perches $lead = rtrim($1); 6511e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 6512e970b884SJoe Perches $lead = "${lead}const "; 6513194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 6514e970b884SJoe Perches } 6515e970b884SJoe Perches } 6516e970b884SJoe Perches 6517c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 6518c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 6519c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 6520c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 6521c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 6522c17893c7SJoe Perches $fix) { 6523c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 6524c17893c7SJoe Perches } 6525c17893c7SJoe Perches } 6526c17893c7SJoe Perches 6527fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 6528fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 6529fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 6530fbdb8138SJoe Perches my $constant_func = $1; 6531fbdb8138SJoe Perches my $func = $constant_func; 6532fbdb8138SJoe Perches $func =~ s/^__constant_//; 6533fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 6534fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 6535fbdb8138SJoe Perches $fix) { 6536194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 6537fbdb8138SJoe Perches } 6538fbdb8138SJoe Perches } 6539fbdb8138SJoe Perches 65401a15a250SPatrick Pannuto# prefer usleep_range over udelay 654137581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 654243c1d77cSJoe Perches my $delay = $1; 65431a15a250SPatrick Pannuto # ignore udelay's < 10, however 654443c1d77cSJoe Perches if (! ($delay < 10) ) { 6545000d1cc1SJoe Perches CHK("USLEEP_RANGE", 6546458f69efSMauro Carvalho Chehab "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr); 654743c1d77cSJoe Perches } 654843c1d77cSJoe Perches if ($delay > 2000) { 654943c1d77cSJoe Perches WARN("LONG_UDELAY", 655043c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 65511a15a250SPatrick Pannuto } 65521a15a250SPatrick Pannuto } 65531a15a250SPatrick Pannuto 655409ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 655509ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 655609ef8725SPatrick Pannuto if ($1 < 20) { 6557000d1cc1SJoe Perches WARN("MSLEEP", 6558458f69efSMauro Carvalho Chehab "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr); 655909ef8725SPatrick Pannuto } 656009ef8725SPatrick Pannuto } 656109ef8725SPatrick Pannuto 656236ec1939SJoe Perches# check for comparisons of jiffies 656336ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 656436ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 656536ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 656636ec1939SJoe Perches } 656736ec1939SJoe Perches 65689d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 65699d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 65709d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 65719d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 65729d7a34a5SJoe Perches } 65739d7a34a5SJoe Perches 657400df344fSAndy Whitcroft# warn about #ifdefs in C files 6575c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 657600df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 657700df344fSAndy Whitcroft# print "$herecurr"; 657800df344fSAndy Whitcroft# $clean = 0; 657900df344fSAndy Whitcroft# } 658000df344fSAndy Whitcroft 658122f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 6582c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 65833705ce5bSJoe Perches if (ERROR("SPACING", 65843705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 65853705ce5bSJoe Perches $fix) { 6586194f66fcSJoe Perches $fixed[$fixlinenr] =~ 65873705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 65883705ce5bSJoe Perches } 65893705ce5bSJoe Perches 659022f2a2efSAndy Whitcroft } 659122f2a2efSAndy Whitcroft 65924a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 6593171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 6594171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 65954a0df2efSAndy Whitcroft my $which = $1; 65964a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 6597000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 6598000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 65994a0df2efSAndy Whitcroft } 66004a0df2efSAndy Whitcroft } 66014a0df2efSAndy Whitcroft# check for memory barriers without a comment. 6602402c2553SMichael S. Tsirkin 6603402c2553SMichael S. Tsirkin my $barriers = qr{ 6604402c2553SMichael S. Tsirkin mb| 6605402c2553SMichael S. Tsirkin rmb| 6606ad83ec6cSWill Deacon wmb 6607402c2553SMichael S. Tsirkin }x; 6608402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 6609402c2553SMichael S. Tsirkin mb__before_atomic| 6610402c2553SMichael S. Tsirkin mb__after_atomic| 6611402c2553SMichael S. Tsirkin store_release| 6612402c2553SMichael S. Tsirkin load_acquire| 6613402c2553SMichael S. Tsirkin store_mb| 6614402c2553SMichael S. Tsirkin (?:$barriers) 6615402c2553SMichael S. Tsirkin }x; 6616402c2553SMichael S. Tsirkin my $all_barriers = qr{ 6617402c2553SMichael S. Tsirkin (?:$barriers)| 661843e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 661943e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 6620402c2553SMichael S. Tsirkin }x; 6621402c2553SMichael S. Tsirkin 6622402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 66234a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 6624c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 6625000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 66264a0df2efSAndy Whitcroft } 66274a0df2efSAndy Whitcroft } 66283ad81779SPaul E. McKenney 6629f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 6630f4073b0fSMichael S. Tsirkin 6631f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 6632f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 6633f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 6634f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 6635f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 6636f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 6637f4073b0fSMichael S. Tsirkin } 6638f4073b0fSMichael S. Tsirkin 6639cb426e99SJoe Perches# check for waitqueue_active without a comment. 6640cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 6641cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 6642cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 6643cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 6644cb426e99SJoe Perches } 6645cb426e99SJoe Perches } 66463ad81779SPaul E. McKenney 66475099a722SMarco Elver# check for data_race without a comment. 66485099a722SMarco Elver if ($line =~ /\bdata_race\s*\(/) { 66495099a722SMarco Elver if (!ctx_has_comment($first_line, $linenr)) { 66505099a722SMarco Elver WARN("DATA_RACE", 66515099a722SMarco Elver "data_race without comment\n" . $herecurr); 66525099a722SMarco Elver } 66535099a722SMarco Elver } 66545099a722SMarco Elver 66554a0df2efSAndy Whitcroft# check of hardware specific defines 6656c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 6657000d1cc1SJoe Perches CHK("ARCH_DEFINES", 6658000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 66590a920b5bSAndy Whitcroft } 6660653d4876SAndy Whitcroft 6661596ed45bSJoe Perches# check that the storage class is not after a type 6662596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 6663000d1cc1SJoe Perches WARN("STORAGE_CLASS", 6664596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 6665596ed45bSJoe Perches } 6666596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 6667596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 6668596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 6669596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 6670596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 6671596ed45bSJoe Perches WARN("STORAGE_CLASS", 6672596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 6673d4977c78STobias Klauser } 6674d4977c78STobias Klauser 6675de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 6676de7d4f0eSAndy Whitcroft# storage class and type. 66779c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 66789c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 6679000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 6680000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 6681de7d4f0eSAndy Whitcroft } 6682de7d4f0eSAndy Whitcroft 66838905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 66842b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 66852b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 6686d5e616fcSJoe Perches if (WARN("INLINE", 6687d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 6688d5e616fcSJoe Perches $fix) { 6689194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 6690d5e616fcSJoe Perches 6691d5e616fcSJoe Perches } 66928905a67cSAndy Whitcroft } 66938905a67cSAndy Whitcroft 66947ebe1d17SDwaipayan Ray# Check for compiler attributes 66952b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 66967ebe1d17SDwaipayan Ray $rawline =~ /\b__attribute__\s*\(\s*($balanced_parens)\s*\)/) { 66977ebe1d17SDwaipayan Ray my $attr = $1; 66987ebe1d17SDwaipayan Ray $attr =~ s/\s*\(\s*(.*)\)\s*/$1/; 66997ebe1d17SDwaipayan Ray 67007ebe1d17SDwaipayan Ray my %attr_list = ( 67010830aab0SJoe Perches "alias" => "__alias", 67027ebe1d17SDwaipayan Ray "aligned" => "__aligned", 67037ebe1d17SDwaipayan Ray "always_inline" => "__always_inline", 67047ebe1d17SDwaipayan Ray "assume_aligned" => "__assume_aligned", 67057ebe1d17SDwaipayan Ray "cold" => "__cold", 67067ebe1d17SDwaipayan Ray "const" => "__attribute_const__", 67077ebe1d17SDwaipayan Ray "copy" => "__copy", 67087ebe1d17SDwaipayan Ray "designated_init" => "__designated_init", 67097ebe1d17SDwaipayan Ray "externally_visible" => "__visible", 67107ebe1d17SDwaipayan Ray "format" => "printf|scanf", 67117ebe1d17SDwaipayan Ray "gnu_inline" => "__gnu_inline", 67127ebe1d17SDwaipayan Ray "malloc" => "__malloc", 67137ebe1d17SDwaipayan Ray "mode" => "__mode", 67147ebe1d17SDwaipayan Ray "no_caller_saved_registers" => "__no_caller_saved_registers", 67157ebe1d17SDwaipayan Ray "noclone" => "__noclone", 67167ebe1d17SDwaipayan Ray "noinline" => "noinline", 67177ebe1d17SDwaipayan Ray "nonstring" => "__nonstring", 67187ebe1d17SDwaipayan Ray "noreturn" => "__noreturn", 67197ebe1d17SDwaipayan Ray "packed" => "__packed", 67207ebe1d17SDwaipayan Ray "pure" => "__pure", 6721339f29d9SJoe Perches "section" => "__section", 67220830aab0SJoe Perches "used" => "__used", 67230830aab0SJoe Perches "weak" => "__weak" 67247ebe1d17SDwaipayan Ray ); 67257ebe1d17SDwaipayan Ray 67267ebe1d17SDwaipayan Ray while ($attr =~ /\s*(\w+)\s*(${balanced_parens})?/g) { 6727339f29d9SJoe Perches my $orig_attr = $1; 67287ebe1d17SDwaipayan Ray my $params = ''; 67297ebe1d17SDwaipayan Ray $params = $2 if defined($2); 6730339f29d9SJoe Perches my $curr_attr = $orig_attr; 67317ebe1d17SDwaipayan Ray $curr_attr =~ s/^[\s_]+|[\s_]+$//g; 67327ebe1d17SDwaipayan Ray if (exists($attr_list{$curr_attr})) { 6733339f29d9SJoe Perches my $new = $attr_list{$curr_attr}; 67347ebe1d17SDwaipayan Ray if ($curr_attr eq "format" && $params) { 67357ebe1d17SDwaipayan Ray $params =~ /^\s*\(\s*(\w+)\s*,\s*(.*)/; 6736339f29d9SJoe Perches $new = "__$1\($2"; 67377ebe1d17SDwaipayan Ray } else { 6738339f29d9SJoe Perches $new = "$new$params"; 67397ebe1d17SDwaipayan Ray } 67407ebe1d17SDwaipayan Ray if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", 6741339f29d9SJoe Perches "Prefer $new over __attribute__(($orig_attr$params))\n" . $herecurr) && 67427ebe1d17SDwaipayan Ray $fix) { 6743339f29d9SJoe Perches my $remove = "\Q$orig_attr\E" . '\s*' . "\Q$params\E" . '(?:\s*,\s*)?'; 6744339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/$remove//; 6745339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__/$new __attribute__/; 6746339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/\}\Q$new\E/} $new/; 6747339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/ __attribute__\s*\(\s*\(\s*\)\s*\)//; 67487ebe1d17SDwaipayan Ray } 674939b7e287SJoe Perches } 6750462811d9SJoe Perches } 6751462811d9SJoe Perches 67527ebe1d17SDwaipayan Ray # Check for __attribute__ unused, prefer __always_unused or __maybe_unused 67537ebe1d17SDwaipayan Ray if ($attr =~ /^_*unused/) { 67547ebe1d17SDwaipayan Ray WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", 67557ebe1d17SDwaipayan Ray "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr); 6756d5e616fcSJoe Perches } 67576061d949SJoe Perches } 67586061d949SJoe Perches 6759619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 67605b57980dSJoe Perches if ($perl_version_ok && 6761619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 6762619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 6763619a908aSJoe Perches $line =~ /\b__weak\b/)) { 6764619a908aSJoe Perches ERROR("WEAK_DECLARATION", 6765619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 6766619a908aSJoe Perches } 6767619a908aSJoe Perches 6768fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 6769e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 6770fd39f904STomas Winkler $realfile !~ m@\btools/@ && 6771e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 6772e6176fa4SJoe Perches my $type = $1; 6773e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 6774e6176fa4SJoe Perches $type = $1; 6775e6176fa4SJoe Perches my $kernel_type = 'u'; 6776e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 6777e6176fa4SJoe Perches $type =~ /(\d+)/; 6778e6176fa4SJoe Perches $kernel_type .= $1; 6779e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 6780e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 6781e6176fa4SJoe Perches $fix) { 6782e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 6783e6176fa4SJoe Perches } 6784e6176fa4SJoe Perches } 6785e6176fa4SJoe Perches } 6786e6176fa4SJoe Perches 6787938224b5SJoe Perches# check for cast of C90 native int or longer types constants 6788938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 6789938224b5SJoe Perches my $cast = $1; 6790938224b5SJoe Perches my $const = $2; 6791938224b5SJoe Perches my $suffix = ""; 6792938224b5SJoe Perches my $newconst = $const; 6793938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 6794938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 6795938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 6796938224b5SJoe Perches $suffix .= 'LL'; 6797938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 6798938224b5SJoe Perches $suffix .= 'L'; 6799938224b5SJoe Perches } 68000972b8bfSJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 68010972b8bfSJoe Perches "Unnecessary typecast of c90 int constant - '$cast$const' could be '$const$suffix'\n" . $herecurr) && 68020972b8bfSJoe Perches $fix) { 6803938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 6804938224b5SJoe Perches } 6805938224b5SJoe Perches } 6806938224b5SJoe Perches 68078f53a9b8SJoe Perches# check for sizeof(&) 68088f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 6809000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 6810000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 68118f53a9b8SJoe Perches } 68128f53a9b8SJoe Perches 681366c80b60SJoe Perches# check for sizeof without parenthesis 681466c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 6815d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 6816d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 6817d5e616fcSJoe Perches $fix) { 6818194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 6819d5e616fcSJoe Perches } 682066c80b60SJoe Perches } 682166c80b60SJoe Perches 682288982feaSJoe Perches# check for struct spinlock declarations 682388982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 682488982feaSJoe Perches WARN("USE_SPINLOCK_T", 682588982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 682688982feaSJoe Perches } 682788982feaSJoe Perches 6828a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 682906668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 6830a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 6831caac1d5fSHeba Aamer $fmt =~ s/%%//g; 6832caac1d5fSHeba Aamer if ($fmt !~ /%/) { 6833d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 6834d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 6835d5e616fcSJoe Perches $fix) { 6836194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 6837d5e616fcSJoe Perches } 6838a6962d72SJoe Perches } 6839a6962d72SJoe Perches } 6840a6962d72SJoe Perches 68410b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 68425b57980dSJoe Perches if ($perl_version_ok && 68430b523769SJoe Perches defined $stat && 68440b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 68450b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 6846e3c6bc95STobin C. Harding my $stat_real; 6847e3c6bc95STobin C. Harding 68480b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 68490b523769SJoe Perches $lc = $lc + $linenr; 68500b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 6851ffe07513SJoe Perches my $specifier; 6852ffe07513SJoe Perches my $extension; 68533bd32d6aSSakari Ailus my $qualifier; 6854ffe07513SJoe Perches my $bad_specifier = ""; 68550b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 68560b523769SJoe Perches $fmt =~ s/%%//g; 6857e3c6bc95STobin C. Harding 68583bd32d6aSSakari Ailus while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) { 6859e3c6bc95STobin C. Harding $specifier = $1; 6860e3c6bc95STobin C. Harding $extension = $2; 68613bd32d6aSSakari Ailus $qualifier = $3; 6862af612e43SSakari Ailus if ($extension !~ /[4SsBKRraEehMmIiUDdgVCbGNOxtf]/ || 68633bd32d6aSSakari Ailus ($extension eq "f" && 6864af612e43SSakari Ailus defined $qualifier && $qualifier !~ /^w/) || 6865af612e43SSakari Ailus ($extension eq "4" && 6866af612e43SSakari Ailus defined $qualifier && $qualifier !~ /^cc/)) { 6867e3c6bc95STobin C. Harding $bad_specifier = $specifier; 68680b523769SJoe Perches last; 68690b523769SJoe Perches } 6870e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 6871e3c6bc95STobin C. Harding if (!defined($stat_real)) { 6872e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 68730b523769SJoe Perches } 6874e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 6875e3c6bc95STobin C. Harding "Using vsprintf specifier '\%px' potentially exposes the kernel memory layout, if you don't really need the address please consider using '\%p'.\n" . "$here\n$stat_real\n"); 6876e3c6bc95STobin C. Harding } 6877e3c6bc95STobin C. Harding } 6878e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 68792a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6880de48fa1aSMiguel Ojeda my $msg_level = \&WARN; 68811df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 68821df7338aSSergey Senozhatsky my $use = ""; 6883e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 68841df7338aSSergey Senozhatsky $use = " - use %pS instead"; 6885e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 6886de48fa1aSMiguel Ojeda } elsif ($bad_specifier =~ /pA/) { 6887de48fa1aSMiguel Ojeda $use = " - '%pA' is only intended to be used from Rust code"; 6888de48fa1aSMiguel Ojeda $msg_level = \&ERROR; 68891df7338aSSergey Senozhatsky } 68902a9f9d85STobin C. Harding 6891de48fa1aSMiguel Ojeda &{$msg_level}("VSPRINTF_POINTER_EXTENSION", 6892e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 6893e3c6bc95STobin C. Harding } 68940b523769SJoe Perches } 68950b523769SJoe Perches } 68960b523769SJoe Perches 6897554e165cSAndy Whitcroft# Check for misused memsets 68985b57980dSJoe Perches if ($perl_version_ok && 6899d1fe9c09SJoe Perches defined $stat && 69009e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 6901554e165cSAndy Whitcroft 6902d7c76ba7SJoe Perches my $ms_addr = $2; 6903d1fe9c09SJoe Perches my $ms_val = $7; 6904d1fe9c09SJoe Perches my $ms_size = $12; 6905d7c76ba7SJoe Perches 6906554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 6907554e165cSAndy Whitcroft ERROR("MEMSET", 6908d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 6909554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 6910554e165cSAndy Whitcroft WARN("MEMSET", 6911d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 6912d7c76ba7SJoe Perches } 6913d7c76ba7SJoe Perches } 6914d7c76ba7SJoe Perches 691598a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 69165b57980dSJoe Perches# if ($perl_version_ok && 6917f333195dSJoe Perches# defined $stat && 6918f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6919f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 6920f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 6921f333195dSJoe Perches# $fix) { 6922f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 6923f333195dSJoe Perches# } 6924f333195dSJoe Perches# } 692598a9bba5SJoe Perches 6926b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 69275b57980dSJoe Perches# if ($perl_version_ok && 6928f333195dSJoe Perches# defined $stat && 6929f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6930f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 6931f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 6932f333195dSJoe Perches# } 6933b6117d17SMateusz Kulikowski 69348617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 69358617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 69365b57980dSJoe Perches# if ($perl_version_ok && 6937f333195dSJoe Perches# defined $stat && 6938f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6939f333195dSJoe Perches# 6940f333195dSJoe Perches# my $ms_val = $7; 6941f333195dSJoe Perches# 6942f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 6943f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 6944f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 6945f333195dSJoe Perches# $fix) { 6946f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 6947f333195dSJoe Perches# } 6948f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 6949f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 6950f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 6951f333195dSJoe Perches# $fix) { 6952f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 6953f333195dSJoe Perches# } 6954f333195dSJoe Perches# } 6955f333195dSJoe Perches# } 69568617cd09SMateusz Kulikowski 69575dbdb2d8SJoe Perches# strlcpy uses that should likely be strscpy 69585dbdb2d8SJoe Perches if ($line =~ /\bstrlcpy\s*\(/) { 69595dbdb2d8SJoe Perches WARN("STRLCPY", 69605dbdb2d8SJoe Perches "Prefer strscpy over strlcpy - see: https://lore.kernel.org/r/CAHk-=wgfRnXz0W3D37d01q3JFkr_i_uTL=V6A6G1oUZcprmknw\@mail.gmail.com/\n" . $herecurr); 69615dbdb2d8SJoe Perches } 69625dbdb2d8SJoe Perches 6963d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 69645b57980dSJoe Perches if ($perl_version_ok && 6965d1fe9c09SJoe Perches defined $stat && 6966d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 6967d1fe9c09SJoe Perches if (defined $2 || defined $7) { 6968d7c76ba7SJoe Perches my $call = $1; 6969d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 6970d7c76ba7SJoe Perches my $arg1 = $3; 6971d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 6972d1fe9c09SJoe Perches my $arg2 = $8; 6973d7c76ba7SJoe Perches my $cast; 6974d7c76ba7SJoe Perches 6975d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 6976d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 6977d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 6978d7c76ba7SJoe Perches $cast = $cast1; 6979d7c76ba7SJoe Perches } else { 6980d7c76ba7SJoe Perches $cast = $cast2; 6981d7c76ba7SJoe Perches } 6982d7c76ba7SJoe Perches WARN("MINMAX", 6983d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 6984554e165cSAndy Whitcroft } 6985554e165cSAndy Whitcroft } 6986554e165cSAndy Whitcroft 69874a273195SJoe Perches# check usleep_range arguments 69885b57980dSJoe Perches if ($perl_version_ok && 69894a273195SJoe Perches defined $stat && 69904a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 69914a273195SJoe Perches my $min = $1; 69924a273195SJoe Perches my $max = $7; 69934a273195SJoe Perches if ($min eq $max) { 69944a273195SJoe Perches WARN("USLEEP_RANGE", 6995458f69efSMauro Carvalho Chehab "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 69964a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 69974a273195SJoe Perches $min > $max) { 69984a273195SJoe Perches WARN("USLEEP_RANGE", 6999458f69efSMauro Carvalho Chehab "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 70004a273195SJoe Perches } 70014a273195SJoe Perches } 70024a273195SJoe Perches 7003823b794cSJoe Perches# check for naked sscanf 70045b57980dSJoe Perches if ($perl_version_ok && 7005823b794cSJoe Perches defined $stat && 70066c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 7007823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 7008823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 7009823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 7010823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 7011823b794cSJoe Perches $lc = $lc + $linenr; 70122a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 7013823b794cSJoe Perches WARN("NAKED_SSCANF", 7014823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 7015823b794cSJoe Perches } 7016823b794cSJoe Perches 7017afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 70185b57980dSJoe Perches if ($perl_version_ok && 7019afc819abSJoe Perches defined $stat && 7020afc819abSJoe Perches $line =~ /\bsscanf\b/) { 7021afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 7022afc819abSJoe Perches $lc = $lc + $linenr; 70232a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 7024afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 7025afc819abSJoe Perches my $format = $6; 7026afc819abSJoe Perches my $count = $format =~ tr@%@%@; 7027afc819abSJoe Perches if ($count == 1 && 7028afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 7029afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 7030afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 7031afc819abSJoe Perches } 7032afc819abSJoe Perches } 7033afc819abSJoe Perches } 7034afc819abSJoe Perches 703570dc8a48SJoe Perches# check for new externs in .h files. 703670dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 703770dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 7038d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 703970dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 704070dc8a48SJoe Perches $fix) { 7041194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 704270dc8a48SJoe Perches } 704370dc8a48SJoe Perches } 704470dc8a48SJoe Perches 7045de7d4f0eSAndy Whitcroft# check for new externs in .c files. 7046171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 7047c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 7048171ae1a4SAndy Whitcroft { 7049c45dcabdSAndy Whitcroft my $function_name = $1; 7050c45dcabdSAndy Whitcroft my $paren_space = $2; 7051171ae1a4SAndy Whitcroft 7052171ae1a4SAndy Whitcroft my $s = $stat; 7053171ae1a4SAndy Whitcroft if (defined $cond) { 7054171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 7055171ae1a4SAndy Whitcroft } 7056d8b44b58SKees Cook if ($s =~ /^\s*;/) 7057c45dcabdSAndy Whitcroft { 7058000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 7059000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 7060de7d4f0eSAndy Whitcroft } 7061de7d4f0eSAndy Whitcroft 7062171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 7063000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 7064000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 7065171ae1a4SAndy Whitcroft } 70669c9ba34eSAndy Whitcroft 70679c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 70689c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 70699c9ba34eSAndy Whitcroft { 7070000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 7071000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 7072171ae1a4SAndy Whitcroft } 7073171ae1a4SAndy Whitcroft 7074a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 7075a0ad7596SJoe Perches if (defined $stat && 7076d8b44b58SKees Cook $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 7077d8b44b58SKees Cook $1 ne "void") { 7078d8b44b58SKees Cook my $args = trim($1); 7079ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 7080ca0d8929SJoe Perches my $arg = trim($1); 7081d8b44b58SKees Cook if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 7082ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 7083ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 7084ca0d8929SJoe Perches } 7085ca0d8929SJoe Perches } 7086ca0d8929SJoe Perches } 7087ca0d8929SJoe Perches 7088a0ad7596SJoe Perches# check for function definitions 70895b57980dSJoe Perches if ($perl_version_ok && 7090a0ad7596SJoe Perches defined $stat && 7091a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 7092a0ad7596SJoe Perches $context_function = $1; 7093a0ad7596SJoe Perches 7094a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 7095a0ad7596SJoe Perches my $ok = 0; 7096a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 7097a0ad7596SJoe Perches my $herectx = $here . "\n"; 7098a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 7099a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 7100a0ad7596SJoe Perches $herectx .= $rl . "\n"; 7101a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 7102a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 7103a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 7104a0ad7596SJoe Perches } 7105a0ad7596SJoe Perches if (!$ok) { 7106a0ad7596SJoe Perches ERROR("OPEN_BRACE", 7107a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 7108a0ad7596SJoe Perches } 7109a0ad7596SJoe Perches } 7110a0ad7596SJoe Perches 7111de7d4f0eSAndy Whitcroft# checks for new __setup's 7112de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 7113de7d4f0eSAndy Whitcroft my $name = $1; 7114de7d4f0eSAndy Whitcroft 7115de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 7116000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 71172581ac7cSTim Froidcoeur "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr); 7118de7d4f0eSAndy Whitcroft } 7119653d4876SAndy Whitcroft } 71209c0ca6f9SAndy Whitcroft 7121e29a70f1SJoe Perches# check for pointless casting of alloc functions 7122e29a70f1SJoe Perches if ($line =~ /\*\s*\)\s*$allocFunctions\b/) { 7123000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 7124000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 71259c0ca6f9SAndy Whitcroft } 712613214adfSAndy Whitcroft 7127a640d25cSJoe Perches# alloc style 7128a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 71295b57980dSJoe Perches if ($perl_version_ok && 7130e29a70f1SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 7131a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 7132a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 7133a640d25cSJoe Perches } 7134a640d25cSJoe Perches 713573f1d07eSGustavo A. R. Silva# check for (kv|k)[mz]alloc with multiplies that could be kmalloc_array/kvmalloc_array/kvcalloc/kcalloc 71365b57980dSJoe Perches if ($perl_version_ok && 71371b4a2ed4SJoe Perches defined $stat && 713873f1d07eSGustavo A. R. Silva $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k)[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 713960a55369SJoe Perches my $oldfunc = $3; 714060a55369SJoe Perches my $a1 = $4; 714160a55369SJoe Perches my $a2 = $10; 714260a55369SJoe Perches my $newfunc = "kmalloc_array"; 714373f1d07eSGustavo A. R. Silva $newfunc = "kvmalloc_array" if ($oldfunc eq "kvmalloc"); 714473f1d07eSGustavo A. R. Silva $newfunc = "kvcalloc" if ($oldfunc eq "kvzalloc"); 714560a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 714660a55369SJoe Perches my $r1 = $a1; 714760a55369SJoe Perches my $r2 = $a2; 714860a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 714960a55369SJoe Perches $r1 = $a2; 715060a55369SJoe Perches $r2 = $a1; 715160a55369SJoe Perches } 7152e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 7153e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 71541b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 7155e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 7156e3d95a2aSTobin C. Harding 7157e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 71581b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 71591b4a2ed4SJoe Perches $cnt == 1 && 7160e367455aSJoe Perches $fix) { 716173f1d07eSGustavo A. R. Silva $fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k)[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e; 716260a55369SJoe Perches } 716360a55369SJoe Perches } 716460a55369SJoe Perches } 716560a55369SJoe Perches 7166972fdea2SJoe Perches# check for krealloc arg reuse 71675b57980dSJoe Perches if ($perl_version_ok && 71684cab63ceSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ && 71694cab63ceSJoe Perches $1 eq $3) { 7170972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 7171972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 7172972fdea2SJoe Perches } 7173972fdea2SJoe Perches 71745ce59ae0SJoe Perches# check for alloc argument mismatch 71753965292aSLiao Chang if ($line =~ /\b((?:devm_)?((?:k|kv)?(calloc|malloc_array)(?:_node)?))\s*\(\s*sizeof\b/) { 71765ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 71775ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 71785ce59ae0SJoe Perches } 71795ce59ae0SJoe Perches 7180caf2a54fSJoe Perches# check for multiple semicolons 7181caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 7182d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 7183d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 7184d5e616fcSJoe Perches $fix) { 7185194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 7186d5e616fcSJoe Perches } 7187d1e2ad07SJoe Perches } 7188d1e2ad07SJoe Perches 7189cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 7190cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 7191cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 71920ab90191SJoe Perches my $ull = ""; 71930ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 71940ab90191SJoe Perches if (CHK("BIT_MACRO", 71950ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 71960ab90191SJoe Perches $fix) { 71970ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 71980ab90191SJoe Perches } 71990ab90191SJoe Perches } 72000ab90191SJoe Perches 720150161266SJoe Perches# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too) 72023e89ad85SJerome Forissier if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) { 720350161266SJoe Perches WARN("IS_ENABLED_CONFIG", 72043e89ad85SJerome Forissier "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr); 720550161266SJoe Perches } 720650161266SJoe Perches 72072d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 72083e89ad85SJerome Forissier if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(${CONFIG_}[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) { 72092d632745SJoe Perches my $config = $1; 72102d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 72113e89ad85SJerome Forissier "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) && 72122d632745SJoe Perches $fix) { 72132d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 72142d632745SJoe Perches } 72152d632745SJoe Perches } 72162d632745SJoe Perches 7217f36d3eb8SJoe Perches# check for /* fallthrough */ like comment, prefer fallthrough; 7218f36d3eb8SJoe Perches my @fallthroughs = ( 7219f36d3eb8SJoe Perches 'fallthrough', 7220f36d3eb8SJoe Perches '@fallthrough@', 7221f36d3eb8SJoe Perches 'lint -fallthrough[ \t]*', 7222f36d3eb8SJoe Perches 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)', 7223f36d3eb8SJoe Perches '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?', 7224f36d3eb8SJoe Perches 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 7225f36d3eb8SJoe Perches 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 7226f36d3eb8SJoe Perches ); 7227f36d3eb8SJoe Perches if ($raw_comment ne '') { 7228f36d3eb8SJoe Perches foreach my $ft (@fallthroughs) { 7229f36d3eb8SJoe Perches if ($raw_comment =~ /$ft/) { 7230f36d3eb8SJoe Perches my $msg_level = \&WARN; 7231f36d3eb8SJoe Perches $msg_level = \&CHK if ($file); 7232f36d3eb8SJoe Perches &{$msg_level}("PREFER_FALLTHROUGH", 7233f36d3eb8SJoe Perches "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr); 7234f36d3eb8SJoe Perches last; 7235f36d3eb8SJoe Perches } 7236f36d3eb8SJoe Perches } 7237f36d3eb8SJoe Perches } 7238f36d3eb8SJoe Perches 7239d1e2ad07SJoe Perches# check for switch/default statements without a break; 72405b57980dSJoe Perches if ($perl_version_ok && 7241d1e2ad07SJoe Perches defined $stat && 7242d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 7243d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 7244e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 7245e3d95a2aSTobin C. Harding 7246d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 7247d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 7248caf2a54fSJoe Perches } 7249caf2a54fSJoe Perches 725013214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 7251d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 7252d5e616fcSJoe Perches if (WARN("USE_FUNC", 7253d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 7254d5e616fcSJoe Perches $fix) { 7255194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 7256d5e616fcSJoe Perches } 725713214adfSAndy Whitcroft } 7258773647a0SAndy Whitcroft 725962ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 726062ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 726162ec818fSJoe Perches ERROR("DATE_TIME", 726262ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 726362ec818fSJoe Perches } 726462ec818fSJoe Perches 72652c92488aSJoe Perches# check for use of yield() 72662c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 72672c92488aSJoe Perches WARN("YIELD", 72682c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 72692c92488aSJoe Perches } 72702c92488aSJoe Perches 7271179f8f40SJoe Perches# check for comparisons against true and false 7272179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 7273179f8f40SJoe Perches my $lead = $1; 7274179f8f40SJoe Perches my $arg = $2; 7275179f8f40SJoe Perches my $test = $3; 7276179f8f40SJoe Perches my $otype = $4; 7277179f8f40SJoe Perches my $trail = $5; 7278179f8f40SJoe Perches my $op = "!"; 7279179f8f40SJoe Perches 7280179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 7281179f8f40SJoe Perches 7282179f8f40SJoe Perches my $type = lc($otype); 7283179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 7284179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 7285179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 7286179f8f40SJoe Perches $op = ""; 7287179f8f40SJoe Perches } 7288179f8f40SJoe Perches 7289179f8f40SJoe Perches CHK("BOOL_COMPARISON", 7290179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 7291179f8f40SJoe Perches 7292179f8f40SJoe Perches## maybe suggesting a correct construct would better 7293179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 7294179f8f40SJoe Perches 7295179f8f40SJoe Perches } 7296179f8f40SJoe Perches } 7297179f8f40SJoe Perches 72984882720bSThomas Gleixner# check for semaphores initialized locked 72994882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 7300000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 7301000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 7302773647a0SAndy Whitcroft } 73036712d858SJoe Perches 730467d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 730567d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 7306000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 730767d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 7308773647a0SAndy Whitcroft } 73096712d858SJoe Perches 7310ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 7311f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 7312000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 7313ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 7314f3db6639SMichael Ellerman } 73156712d858SJoe Perches 73163d709ab5SPaul E. McKenney# check for spin_is_locked(), suggest lockdep instead 73173d709ab5SPaul E. McKenney if ($line =~ /\bspin_is_locked\(/) { 73183d709ab5SPaul E. McKenney WARN("USE_LOCKDEP", 73193d709ab5SPaul E. McKenney "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr); 73203d709ab5SPaul E. McKenney } 73213d709ab5SPaul E. McKenney 73229189c7e7SJoe Perches# check for deprecated apis 73239189c7e7SJoe Perches if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) { 73249189c7e7SJoe Perches my $deprecated_api = $1; 73259189c7e7SJoe Perches my $new_api = $deprecated_apis{$deprecated_api}; 73269189c7e7SJoe Perches WARN("DEPRECATED_API", 73279189c7e7SJoe Perches "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr); 73289189c7e7SJoe Perches } 73299189c7e7SJoe Perches 73300f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 7331d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 7332ced69da1SQuentin Monnet if (defined($const_structs) && 7333ced69da1SQuentin Monnet $line !~ /\bconst\b/ && 7334d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 7335000d1cc1SJoe Perches WARN("CONST_STRUCT", 7336d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 73372b6db5cbSAndy Whitcroft } 7338773647a0SAndy Whitcroft 7339773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 7340773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 734135cdcbfcSPeng Wang# ignore designated initializers using NR_CPUS 7342773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 7343c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 7344c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 7345171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 7346171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 734735cdcbfcSPeng Wang $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/ && 734835cdcbfcSPeng Wang $line !~ /^.\s*\.\w+\s*=\s*.*\bNR_CPUS\b/) 7349773647a0SAndy Whitcroft { 7350000d1cc1SJoe Perches WARN("NR_CPUS", 7351000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 7352773647a0SAndy Whitcroft } 73539c9ba34eSAndy Whitcroft 735452ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 735552ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 735652ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 735752ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 735852ea8506SJoe Perches } 735952ea8506SJoe Perches 7360acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 73615b57980dSJoe Perches if ($perl_version_ok && 7362acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 7363acd9362cSJoe Perches WARN("LIKELY_MISUSE", 7364acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 7365acd9362cSJoe Perches } 7366acd9362cSJoe Perches 7367fbe74541SJoe Perches# return sysfs_emit(foo, fmt, ...) fmt without newline 7368fbe74541SJoe Perches if ($line =~ /\breturn\s+sysfs_emit\s*\(\s*$FuncArg\s*,\s*($String)/ && 7369fbe74541SJoe Perches substr($rawline, $-[6], $+[6] - $-[6]) !~ /\\n"$/) { 7370fbe74541SJoe Perches my $offset = $+[6] - 1; 7371fbe74541SJoe Perches if (WARN("SYSFS_EMIT", 7372fbe74541SJoe Perches "return sysfs_emit(...) formats should include a terminating newline\n" . $herecurr) && 7373fbe74541SJoe Perches $fix) { 7374fbe74541SJoe Perches substr($fixed[$fixlinenr], $offset, 0) = '\\n'; 7375fbe74541SJoe Perches } 7376fbe74541SJoe Perches } 7377fbe74541SJoe Perches 7378de3f186fSDenis Efremov# nested likely/unlikely calls 7379de3f186fSDenis Efremov if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) { 7380de3f186fSDenis Efremov WARN("LIKELY_MISUSE", 7381de3f186fSDenis Efremov "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr); 7382de3f186fSDenis Efremov } 7383de3f186fSDenis Efremov 7384691d77b6SAndy Whitcroft# whine mightly about in_atomic 7385691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 7386691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 7387000d1cc1SJoe Perches ERROR("IN_ATOMIC", 7388000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 7389f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 7390000d1cc1SJoe Perches WARN("IN_ATOMIC", 7391000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 7392691d77b6SAndy Whitcroft } 7393691d77b6SAndy Whitcroft } 73941704f47bSPeter Zijlstra 73951704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 73961704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 73971704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 73981704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 73991704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 74001704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 7401000d1cc1SJoe Perches ERROR("LOCKDEP", 7402000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 74031704f47bSPeter Zijlstra } 74041704f47bSPeter Zijlstra } 740588f8831cSDave Jones 7406b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 7407b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 7408000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 7409000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 741088f8831cSDave Jones } 74112435880fSJoe Perches 741200180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 741300180468SJoe Perches# and whether or not function naming is typical and if 741400180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 74155b57980dSJoe Perches if ($perl_version_ok && 741600180468SJoe Perches defined $stat && 741700180468SJoe Perches $stat =~ /\bDEVICE_ATTR\s*\(\s*(\w+)\s*,\s*\(?\s*(\s*(?:${multi_mode_perms_string_search}|0[0-7]{3,3})\s*)\s*\)?\s*,\s*(\w+)\s*,\s*(\w+)\s*\)/) { 741800180468SJoe Perches my $var = $1; 741900180468SJoe Perches my $perms = $2; 742000180468SJoe Perches my $show = $3; 742100180468SJoe Perches my $store = $4; 742200180468SJoe Perches my $octal_perms = perms_to_octal($perms); 742300180468SJoe Perches if ($show =~ /^${var}_show$/ && 742400180468SJoe Perches $store =~ /^${var}_store$/ && 742500180468SJoe Perches $octal_perms eq "0644") { 742600180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 742700180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 742800180468SJoe Perches $fix) { 742900180468SJoe Perches $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/; 743000180468SJoe Perches } 743100180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 743200180468SJoe Perches $store =~ /^NULL$/ && 743300180468SJoe Perches $octal_perms eq "0444") { 743400180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 743500180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 743600180468SJoe Perches $fix) { 743700180468SJoe Perches $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/; 743800180468SJoe Perches } 743900180468SJoe Perches } elsif ($show =~ /^NULL$/ && 744000180468SJoe Perches $store =~ /^${var}_store$/ && 744100180468SJoe Perches $octal_perms eq "0200") { 744200180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 744300180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 744400180468SJoe Perches $fix) { 744500180468SJoe Perches $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/; 744600180468SJoe Perches } 744700180468SJoe Perches } elsif ($octal_perms eq "0644" || 744800180468SJoe Perches $octal_perms eq "0444" || 744900180468SJoe Perches $octal_perms eq "0200") { 745000180468SJoe Perches my $newshow = "$show"; 745100180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 745200180468SJoe Perches my $newstore = $store; 745300180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 745400180468SJoe Perches my $rename = ""; 745500180468SJoe Perches if ($show ne $newshow) { 745600180468SJoe Perches $rename .= " '$show' to '$newshow'"; 745700180468SJoe Perches } 745800180468SJoe Perches if ($store ne $newstore) { 745900180468SJoe Perches $rename .= " '$store' to '$newstore'"; 746000180468SJoe Perches } 746100180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 746200180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 746300180468SJoe Perches } else { 746400180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 746500180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 746600180468SJoe Perches } 746700180468SJoe Perches } 746800180468SJoe Perches 7469515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 7470515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 747173121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 747273121534SJoe Perches# specific definition of not visible in sysfs. 747373121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 747473121534SJoe Perches# use the default permissions 74755b57980dSJoe Perches if ($perl_version_ok && 7476459cf0aeSJoe Perches defined $stat && 7477515a235eSJoe Perches $line =~ /$mode_perms_search/) { 74782435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 74792435880fSJoe Perches my $func = $entry->[0]; 74802435880fSJoe Perches my $arg_pos = $entry->[1]; 74812435880fSJoe Perches 7482459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 7483459cf0aeSJoe Perches $lc = $lc + $linenr; 74842a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 7485459cf0aeSJoe Perches 74862435880fSJoe Perches my $skip_args = ""; 74872435880fSJoe Perches if ($arg_pos > 1) { 74882435880fSJoe Perches $arg_pos--; 74892435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 74902435880fSJoe Perches } 7491f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 7492459cf0aeSJoe Perches if ($stat =~ /$test/) { 74932435880fSJoe Perches my $val = $1; 74942435880fSJoe Perches $val = $6 if ($skip_args ne ""); 749573121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 749673121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 749773121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 74982435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 7499459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 7500f90774e1SJoe Perches } 7501f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 7502c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 7503459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 75042435880fSJoe Perches } 7505459cf0aeSJoe Perches } 7506459cf0aeSJoe Perches } 7507459cf0aeSJoe Perches } 7508459cf0aeSJoe Perches 7509459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 7510bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 751100180468SJoe Perches my $oval = $1; 751200180468SJoe Perches my $octal = perms_to_octal($oval); 7513f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 7514459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 7515f90774e1SJoe Perches $fix) { 751600180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 75172435880fSJoe Perches } 751813214adfSAndy Whitcroft } 75195a6d20ceSBjorn Andersson 75205a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 75215a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 75225a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 75235a6d20ceSBjorn Andersson my $valid_licenses = qr{ 75245a6d20ceSBjorn Andersson GPL| 75255a6d20ceSBjorn Andersson GPL\ v2| 75265a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 75275a6d20ceSBjorn Andersson Dual\ BSD/GPL| 75285a6d20ceSBjorn Andersson Dual\ MIT/GPL| 75295a6d20ceSBjorn Andersson Dual\ MPL/GPL| 75305a6d20ceSBjorn Andersson Proprietary 75315a6d20ceSBjorn Andersson }x; 75325a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 75335a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 75345a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 75355a6d20ceSBjorn Andersson } 75366e8f42dcSJoe Perches if (!$file && $extracted_string eq '"GPL v2"') { 75376e8f42dcSJoe Perches if (WARN("MODULE_LICENSE", 75386e8f42dcSJoe Perches "Prefer \"GPL\" over \"GPL v2\" - see commit bf7fbeeae6db (\"module: Cure the MODULE_LICENSE \"GPL\" vs. \"GPL v2\" bogosity\")\n" . $herecurr) && 75396e8f42dcSJoe Perches $fix) { 75406e8f42dcSJoe Perches $fixed[$fixlinenr] =~ s/\bMODULE_LICENSE\s*\(\s*"GPL v2"\s*\)/MODULE_LICENSE("GPL")/; 75416e8f42dcSJoe Perches } 75426e8f42dcSJoe Perches } 75435a6d20ceSBjorn Andersson } 75446a8d76cbSMatteo Croce 75456a8d76cbSMatteo Croce# check for sysctl duplicate constants 75466a8d76cbSMatteo Croce if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) { 75476a8d76cbSMatteo Croce WARN("DUPLICATED_SYSCTL_CONST", 75486a8d76cbSMatteo Croce "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr); 75496a8d76cbSMatteo Croce } 7550515a235eSJoe Perches } 755113214adfSAndy Whitcroft 755213214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 755313214adfSAndy Whitcroft # so just keep quiet. 755413214adfSAndy Whitcroft if ($#rawlines == -1) { 755513214adfSAndy Whitcroft exit(0); 75560a920b5bSAndy Whitcroft } 75570a920b5bSAndy Whitcroft 75588905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 75598905a67cSAndy Whitcroft # things that appear to be patches. 75608905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 75618905a67cSAndy Whitcroft exit(0); 75628905a67cSAndy Whitcroft } 75638905a67cSAndy Whitcroft 7564e73d2715SDwaipayan Ray # This is not a patch, and we are in 'no-patch' mode so 75658905a67cSAndy Whitcroft # just keep quiet. 75668905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 75678905a67cSAndy Whitcroft exit(0); 75688905a67cSAndy Whitcroft } 75698905a67cSAndy Whitcroft 7570a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 7571000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 7572000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 75730a920b5bSAndy Whitcroft } 7574cd261496SGeert Uytterhoeven if ($is_patch && $has_commit_log && $chk_signoff) { 7575cd261496SGeert Uytterhoeven if ($signoff == 0) { 7576000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 7577000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 757848ca2d8aSDwaipayan Ray } elsif ($authorsignoff != 1) { 757948ca2d8aSDwaipayan Ray # authorsignoff values: 758048ca2d8aSDwaipayan Ray # 0 -> missing sign off 758148ca2d8aSDwaipayan Ray # 1 -> sign off identical 758248ca2d8aSDwaipayan Ray # 2 -> names and addresses match, comments mismatch 758348ca2d8aSDwaipayan Ray # 3 -> addresses match, names different 758448ca2d8aSDwaipayan Ray # 4 -> names match, addresses different 758548ca2d8aSDwaipayan Ray # 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match 758648ca2d8aSDwaipayan Ray 758748ca2d8aSDwaipayan Ray my $sob_msg = "'From: $author' != 'Signed-off-by: $author_sob'"; 758848ca2d8aSDwaipayan Ray 758948ca2d8aSDwaipayan Ray if ($authorsignoff == 0) { 759048ca2d8aSDwaipayan Ray ERROR("NO_AUTHOR_SIGN_OFF", 7591cd261496SGeert Uytterhoeven "Missing Signed-off-by: line by nominal patch author '$author'\n"); 759248ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 2) { 759348ca2d8aSDwaipayan Ray CHK("FROM_SIGN_OFF_MISMATCH", 759448ca2d8aSDwaipayan Ray "From:/Signed-off-by: email comments mismatch: $sob_msg\n"); 759548ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 3) { 759648ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 759748ca2d8aSDwaipayan Ray "From:/Signed-off-by: email name mismatch: $sob_msg\n"); 759848ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 4) { 759948ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 760048ca2d8aSDwaipayan Ray "From:/Signed-off-by: email address mismatch: $sob_msg\n"); 760148ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 5) { 760248ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 760348ca2d8aSDwaipayan Ray "From:/Signed-off-by: email subaddress mismatch: $sob_msg\n"); 760448ca2d8aSDwaipayan Ray } 7605cd261496SGeert Uytterhoeven } 76060a920b5bSAndy Whitcroft } 76070a920b5bSAndy Whitcroft 7608f0a594c1SAndy Whitcroft print report_dump(); 760913214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 761013214adfSAndy Whitcroft print "$filename " if ($summary_file); 76116c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 76126c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 76136c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 76146c72ffaaSAndy Whitcroft } 76158905a67cSAndy Whitcroft 7616d2c0a235SAndy Whitcroft if ($quiet == 0) { 7617ef212196SJoe Perches # If there were any defects found and not already fixing them 7618ef212196SJoe Perches if (!$clean and !$fix) { 7619ef212196SJoe Perches print << "EOM" 7620ef212196SJoe Perches 7621ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 7622ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 7623ef212196SJoe PerchesEOM 7624ef212196SJoe Perches } 7625d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 7626d2c0a235SAndy Whitcroft # then suggest that. 7627d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 7628b0781216SMike Frysinger $rpt_cleaners = 0; 7629d8469f16SJoe Perches print << "EOM" 7630d8469f16SJoe Perches 7631d8469f16SJoe PerchesNOTE: Whitespace errors detected. 7632d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 7633d8469f16SJoe PerchesEOM 7634d2c0a235SAndy Whitcroft } 7635d2c0a235SAndy Whitcroft } 7636d2c0a235SAndy Whitcroft 7637d752fcc8SJoe Perches if ($clean == 0 && $fix && 7638d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 7639d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 76409624b8d6SJoe Perches my $newfile = $filename; 76419624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 76423705ce5bSJoe Perches my $linecount = 0; 76433705ce5bSJoe Perches my $f; 76443705ce5bSJoe Perches 7645d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 7646d752fcc8SJoe Perches 76473705ce5bSJoe Perches open($f, '>', $newfile) 76483705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 76493705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 76503705ce5bSJoe Perches $linecount++; 76513705ce5bSJoe Perches if ($file) { 76523705ce5bSJoe Perches if ($linecount > 3) { 76533705ce5bSJoe Perches $fixed_line =~ s/^\+//; 76543705ce5bSJoe Perches print $f $fixed_line . "\n"; 76553705ce5bSJoe Perches } 76563705ce5bSJoe Perches } else { 76573705ce5bSJoe Perches print $f $fixed_line . "\n"; 76583705ce5bSJoe Perches } 76593705ce5bSJoe Perches } 76603705ce5bSJoe Perches close($f); 76613705ce5bSJoe Perches 76623705ce5bSJoe Perches if (!$quiet) { 76633705ce5bSJoe Perches print << "EOM"; 7664d8469f16SJoe Perches 76653705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 76663705ce5bSJoe Perches 76673705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 76683705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 76693705ce5bSJoe Perches 76703705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 76713705ce5bSJoe PerchesNo warranties, expressed or implied... 76723705ce5bSJoe PerchesEOM 76733705ce5bSJoe Perches } 76743705ce5bSJoe Perches } 76753705ce5bSJoe Perches 7676d8469f16SJoe Perches if ($quiet == 0) { 7677d8469f16SJoe Perches print "\n"; 7678d8469f16SJoe Perches if ($clean == 1) { 7679d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 7680d8469f16SJoe Perches } else { 7681d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 76820a920b5bSAndy Whitcroft } 76830a920b5bSAndy Whitcroft } 76840a920b5bSAndy Whitcroft return $clean; 76850a920b5bSAndy Whitcroft} 7686