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 775b2c7334SJim Cromiemy %maybe_linker_symbol; # for externs in c exceptions, when seen in *vmlinux.lds.h 785b2c7334SJim Cromie 7977f5b10aSHannes Edersub help { 8077f5b10aSHannes Eder my ($exitcode) = @_; 8177f5b10aSHannes Eder 8277f5b10aSHannes Eder print << "EOM"; 8377f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 8477f5b10aSHannes EderVersion: $V 8577f5b10aSHannes Eder 8677f5b10aSHannes EderOptions: 8777f5b10aSHannes Eder -q, --quiet quiet 8852178ce0SDwaipayan Ray -v, --verbose verbose mode 8977f5b10aSHannes Eder --no-tree run without a kernel tree 9077f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 9177f5b10aSHannes Eder --patch treat FILE as patchfile (default) 9277f5b10aSHannes Eder --emacs emacs compile window format 9377f5b10aSHannes Eder --terse one line per report 9434d8815fSJoe Perches --showfile emit diffed file position, not input file position 954a593c34SDu, Changbin -g, --git treat FILE as a single commit or git revision range 964a593c34SDu, Changbin single git commit with: 974a593c34SDu, Changbin <rev> 984a593c34SDu, Changbin <rev>^ 994a593c34SDu, Changbin <rev>~n 1004a593c34SDu, Changbin multiple git commits with: 1014a593c34SDu, Changbin <rev1>..<rev2> 1024a593c34SDu, Changbin <rev1>...<rev2> 1034a593c34SDu, Changbin <rev>-<count> 1044a593c34SDu, Changbin git merges are ignored 10577f5b10aSHannes Eder -f, --file treat FILE as regular source file 10677f5b10aSHannes Eder --subjective, --strict enable more subjective tests 1073beb42ecSJoe Perches --list-types list the possible message types 10891bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 109000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 1103beb42ecSJoe Perches --show-types show the specific message type in the output 111bdc48fa1SJoe Perches --max-line-length=n set the maximum line length, (default $max_line_length) 112bdc48fa1SJoe Perches if exceeded, warn on patches 113bdc48fa1SJoe Perches requires --strict for use with --file 11456193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 115bdc48fa1SJoe Perches --tab-size=n set the number of spaces for tab (default $tabsize) 11677f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 11777f5b10aSHannes Eder --no-summary suppress the per-file summary 11877f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 11977f5b10aSHannes Eder --summary-file include the filename in summary 12077f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 12177f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 12277f5b10aSHannes Eder is all off) 12377f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 12477f5b10aSHannes Eder literally 1253705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 1263705ce5bSJoe Perches If correctable single-line errors exist, create 1273705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 1283705ce5bSJoe Perches with potential errors corrected to the preferred 1293705ce5bSJoe Perches checkpatch style 1309624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 1319624b8d6SJoe Perches Is the same as --fix, but overwrites the input 1329624b8d6SJoe Perches file. It's your fault if there's no backup or git 133d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 134d62a201fSDave Hansen runtime errors. 135ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 1360ee3e7b8SPeter Ujfalusi (default:$codespellfile) 137ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 13875ad8c57SJerome Forissier --typedefsfile Read additional types from this file 139737c0767SJohn Brooks --color[=WHEN] Use colors 'always', 'never', or only when output 140737c0767SJohn Brooks is a terminal ('auto'). Default is 'auto'. 1413e89ad85SJerome Forissier --kconfig-prefix=WORD use WORD as a prefix for Kconfig symbols (default 1423e89ad85SJerome Forissier ${CONFIG_}) 14377f5b10aSHannes Eder -h, --help, --version display this help and exit 14477f5b10aSHannes Eder 14577f5b10aSHannes EderWhen FILE is - read standard input. 14677f5b10aSHannes EderEOM 14777f5b10aSHannes Eder 14877f5b10aSHannes Eder exit($exitcode); 14977f5b10aSHannes Eder} 15077f5b10aSHannes Eder 1513beb42ecSJoe Perchessub uniq { 1523beb42ecSJoe Perches my %seen; 1533beb42ecSJoe Perches return grep { !$seen{$_}++ } @_; 1543beb42ecSJoe Perches} 1553beb42ecSJoe Perches 1563beb42ecSJoe Perchessub list_types { 1573beb42ecSJoe Perches my ($exitcode) = @_; 1583beb42ecSJoe Perches 1593beb42ecSJoe Perches my $count = 0; 1603beb42ecSJoe Perches 1613beb42ecSJoe Perches local $/ = undef; 1623beb42ecSJoe Perches 1633beb42ecSJoe Perches open(my $script, '<', abs_path($P)) or 1643beb42ecSJoe Perches die "$P: Can't read '$P' $!\n"; 1653beb42ecSJoe Perches 1663beb42ecSJoe Perches my $text = <$script>; 1673beb42ecSJoe Perches close($script); 1683beb42ecSJoe Perches 16952178ce0SDwaipayan Ray my %types = (); 1700547fa58SJean Delvare # Also catch when type or level is passed through a variable 17152178ce0SDwaipayan Ray while ($text =~ /(?:(\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) { 17252178ce0SDwaipayan Ray if (defined($1)) { 17352178ce0SDwaipayan Ray if (exists($types{$2})) { 17452178ce0SDwaipayan Ray $types{$2} .= ",$1" if ($types{$2} ne $1); 17552178ce0SDwaipayan Ray } else { 17652178ce0SDwaipayan Ray $types{$2} = $1; 1773beb42ecSJoe Perches } 17852178ce0SDwaipayan Ray } else { 17952178ce0SDwaipayan Ray $types{$2} = "UNDETERMINED"; 18052178ce0SDwaipayan Ray } 18152178ce0SDwaipayan Ray } 18252178ce0SDwaipayan Ray 1833beb42ecSJoe Perches print("#\tMessage type\n\n"); 18452178ce0SDwaipayan Ray if ($color) { 18552178ce0SDwaipayan Ray print(" ( Color coding: "); 18652178ce0SDwaipayan Ray print(RED . "ERROR" . RESET); 18752178ce0SDwaipayan Ray print(" | "); 18852178ce0SDwaipayan Ray print(YELLOW . "WARNING" . RESET); 18952178ce0SDwaipayan Ray print(" | "); 19052178ce0SDwaipayan Ray print(GREEN . "CHECK" . RESET); 19152178ce0SDwaipayan Ray print(" | "); 19252178ce0SDwaipayan Ray print("Multiple levels / Undetermined"); 19352178ce0SDwaipayan Ray print(" )\n\n"); 19452178ce0SDwaipayan Ray } 19552178ce0SDwaipayan Ray 19652178ce0SDwaipayan Ray foreach my $type (sort keys %types) { 19752178ce0SDwaipayan Ray my $orig_type = $type; 19852178ce0SDwaipayan Ray if ($color) { 19952178ce0SDwaipayan Ray my $level = $types{$type}; 20052178ce0SDwaipayan Ray if ($level eq "ERROR") { 20152178ce0SDwaipayan Ray $type = RED . $type . RESET; 20252178ce0SDwaipayan Ray } elsif ($level eq "WARN") { 20352178ce0SDwaipayan Ray $type = YELLOW . $type . RESET; 20452178ce0SDwaipayan Ray } elsif ($level eq "CHK") { 20552178ce0SDwaipayan Ray $type = GREEN . $type . RESET; 20652178ce0SDwaipayan Ray } 20752178ce0SDwaipayan Ray } 2083beb42ecSJoe Perches print(++$count . "\t" . $type . "\n"); 20952178ce0SDwaipayan Ray if ($verbose && exists($verbose_messages{$orig_type})) { 21052178ce0SDwaipayan Ray my $message = $verbose_messages{$orig_type}; 21152178ce0SDwaipayan Ray $message =~ s/\n/\n\t/g; 21252178ce0SDwaipayan Ray print("\t" . $message . "\n\n"); 21352178ce0SDwaipayan Ray } 2143beb42ecSJoe Perches } 2153beb42ecSJoe Perches 2163beb42ecSJoe Perches exit($exitcode); 2173beb42ecSJoe Perches} 2183beb42ecSJoe Perches 219000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 220000d1cc1SJoe Perchesif (-f $conf) { 221000d1cc1SJoe Perches my @conf_args; 222000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 223000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 224000d1cc1SJoe Perches 225000d1cc1SJoe Perches while (<$conffile>) { 226000d1cc1SJoe Perches my $line = $_; 227000d1cc1SJoe Perches 228000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 229000d1cc1SJoe Perches $line =~ s/^\s*//g; 230000d1cc1SJoe Perches $line =~ s/\s+/ /g; 231000d1cc1SJoe Perches 232000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 233000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 234000d1cc1SJoe Perches 235000d1cc1SJoe Perches my @words = split(" ", $line); 236000d1cc1SJoe Perches foreach my $word (@words) { 237000d1cc1SJoe Perches last if ($word =~ m/^#/); 238000d1cc1SJoe Perches push (@conf_args, $word); 239000d1cc1SJoe Perches } 240000d1cc1SJoe Perches } 241000d1cc1SJoe Perches close($conffile); 242000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 243000d1cc1SJoe Perches} 244000d1cc1SJoe Perches 24552178ce0SDwaipayan Raysub load_docs { 24652178ce0SDwaipayan Ray open(my $docs, '<', "$docsfile") 24752178ce0SDwaipayan Ray or warn "$P: Can't read the documentation file $docsfile $!\n"; 24852178ce0SDwaipayan Ray 24952178ce0SDwaipayan Ray my $type = ''; 25052178ce0SDwaipayan Ray my $desc = ''; 25152178ce0SDwaipayan Ray my $in_desc = 0; 25252178ce0SDwaipayan Ray 25352178ce0SDwaipayan Ray while (<$docs>) { 25452178ce0SDwaipayan Ray chomp; 25552178ce0SDwaipayan Ray my $line = $_; 25652178ce0SDwaipayan Ray $line =~ s/\s+$//; 25752178ce0SDwaipayan Ray 25852178ce0SDwaipayan Ray if ($line =~ /^\s*\*\*(.+)\*\*$/) { 25952178ce0SDwaipayan Ray if ($desc ne '') { 26052178ce0SDwaipayan Ray $verbose_messages{$type} = trim($desc); 26152178ce0SDwaipayan Ray } 26252178ce0SDwaipayan Ray $type = $1; 26352178ce0SDwaipayan Ray $desc = ''; 26452178ce0SDwaipayan Ray $in_desc = 1; 26552178ce0SDwaipayan Ray } elsif ($in_desc) { 26652178ce0SDwaipayan Ray if ($line =~ /^(?:\s{4,}|$)/) { 26752178ce0SDwaipayan Ray $line =~ s/^\s{4}//; 26852178ce0SDwaipayan Ray $desc .= $line; 26952178ce0SDwaipayan Ray $desc .= "\n"; 27052178ce0SDwaipayan Ray } else { 27152178ce0SDwaipayan Ray $verbose_messages{$type} = trim($desc); 27252178ce0SDwaipayan Ray $type = ''; 27352178ce0SDwaipayan Ray $desc = ''; 27452178ce0SDwaipayan Ray $in_desc = 0; 27552178ce0SDwaipayan Ray } 27652178ce0SDwaipayan Ray } 27752178ce0SDwaipayan Ray } 27852178ce0SDwaipayan Ray 27952178ce0SDwaipayan Ray if ($desc ne '') { 28052178ce0SDwaipayan Ray $verbose_messages{$type} = trim($desc); 28152178ce0SDwaipayan Ray } 28252178ce0SDwaipayan Ray close($docs); 28352178ce0SDwaipayan Ray} 28452178ce0SDwaipayan Ray 285737c0767SJohn Brooks# Perl's Getopt::Long allows options to take optional arguments after a space. 286737c0767SJohn Brooks# Prevent --color by itself from consuming other arguments 287737c0767SJohn Brooksforeach (@ARGV) { 288737c0767SJohn Brooks if ($_ eq "--color" || $_ eq "-color") { 289737c0767SJohn Brooks $_ = "--color=$color"; 290737c0767SJohn Brooks } 291737c0767SJohn Brooks} 292737c0767SJohn Brooks 2930a920b5bSAndy WhitcroftGetOptions( 2946c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 29552178ce0SDwaipayan Ray 'v|verbose!' => \$verbose, 2960a920b5bSAndy Whitcroft 'tree!' => \$tree, 2970a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 2980a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 2996c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 3008905a67cSAndy Whitcroft 'terse!' => \$terse, 30134d8815fSJoe Perches 'showfile!' => \$showfile, 30277f5b10aSHannes Eder 'f|file!' => \$file, 3034a593c34SDu, Changbin 'g|git!' => \$git, 3046c72ffaaSAndy Whitcroft 'subjective!' => \$check, 3056c72ffaaSAndy Whitcroft 'strict!' => \$check, 306000d1cc1SJoe Perches 'ignore=s' => \@ignore, 30791bfe484SJoe Perches 'types=s' => \@use, 308000d1cc1SJoe Perches 'show-types!' => \$show_types, 3093beb42ecSJoe Perches 'list-types!' => \$list_types, 3106cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 31156193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 312713a09deSAntonio Borneo 'tab-size=i' => \$tabsize, 3136c72ffaaSAndy Whitcroft 'root=s' => \$root, 3148905a67cSAndy Whitcroft 'summary!' => \$summary, 3158905a67cSAndy Whitcroft 'mailback!' => \$mailback, 31613214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 3173705ce5bSJoe Perches 'fix!' => \$fix, 3189624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 319d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 320c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 321773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 322ebfd7d62SJoe Perches 'codespell!' => \$codespell, 3230ee3e7b8SPeter Ujfalusi 'codespellfile=s' => \$user_codespellfile, 32475ad8c57SJerome Forissier 'typedefsfile=s' => \$typedefsfile, 325737c0767SJohn Brooks 'color=s' => \$color, 326737c0767SJohn Brooks 'no-color' => \$color, #keep old behaviors of -nocolor 327737c0767SJohn Brooks 'nocolor' => \$color, #keep old behaviors of -nocolor 3283e89ad85SJerome Forissier 'kconfig-prefix=s' => \${CONFIG_}, 32977f5b10aSHannes Eder 'h|help' => \$help, 33077f5b10aSHannes Eder 'version' => \$help 3310ee3e7b8SPeter Ujfalusi) or $help = 2; 33277f5b10aSHannes Eder 3330ee3e7b8SPeter Ujfalusiif ($user_codespellfile) { 3340ee3e7b8SPeter Ujfalusi # Use the user provided codespell file unconditionally 3350ee3e7b8SPeter Ujfalusi $codespellfile = $user_codespellfile; 3360ee3e7b8SPeter Ujfalusi} elsif (!(-f $codespellfile)) { 3370ee3e7b8SPeter Ujfalusi # If /usr/share/codespell/dictionary.txt is not present, try to find it 3380ee3e7b8SPeter Ujfalusi # under codespell's install directory: <codespell_root>/data/dictionary.txt 339c882c6b1SSagar Patel if (($codespell || $help) && which("python3") ne "") { 3400ee3e7b8SPeter Ujfalusi my $python_codespell_dict = << "EOF"; 3410ee3e7b8SPeter Ujfalusi 3420ee3e7b8SPeter Ujfalusiimport os.path as op 3430ee3e7b8SPeter Ujfalusiimport codespell_lib 3440ee3e7b8SPeter Ujfalusicodespell_dir = op.dirname(codespell_lib.__file__) 3450ee3e7b8SPeter Ujfalusicodespell_file = op.join(codespell_dir, 'data', 'dictionary.txt') 3460ee3e7b8SPeter Ujfalusiprint(codespell_file, end='') 3470ee3e7b8SPeter UjfalusiEOF 3480ee3e7b8SPeter Ujfalusi 349c882c6b1SSagar Patel my $codespell_dict = `python3 -c "$python_codespell_dict" 2> /dev/null`; 3500ee3e7b8SPeter Ujfalusi $codespellfile = $codespell_dict if (-f $codespell_dict); 3510ee3e7b8SPeter Ujfalusi } 3520ee3e7b8SPeter Ujfalusi} 3530ee3e7b8SPeter Ujfalusi 3540ee3e7b8SPeter Ujfalusi# $help is 1 if either -h, --help or --version is passed as option - exitcode: 0 3550ee3e7b8SPeter Ujfalusi# $help is 2 if invalid option is passed - exitcode: 1 3560ee3e7b8SPeter Ujfalusihelp($help - 1) if ($help); 3570a920b5bSAndy Whitcroft 35852178ce0SDwaipayan Raydie "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix)); 35952178ce0SDwaipayan Raydie "$P: --verbose cannot be used with --terse\n" if ($verbose && $terse); 36052178ce0SDwaipayan Ray 36152178ce0SDwaipayan Rayif ($color =~ /^[01]$/) { 36252178ce0SDwaipayan Ray $color = !$color; 36352178ce0SDwaipayan Ray} elsif ($color =~ /^always$/i) { 36452178ce0SDwaipayan Ray $color = 1; 36552178ce0SDwaipayan Ray} elsif ($color =~ /^never$/i) { 36652178ce0SDwaipayan Ray $color = 0; 36752178ce0SDwaipayan Ray} elsif ($color =~ /^auto$/i) { 36852178ce0SDwaipayan Ray $color = (-t STDOUT); 36952178ce0SDwaipayan Ray} else { 37052178ce0SDwaipayan Ray die "$P: Invalid color mode: $color\n"; 37152178ce0SDwaipayan Ray} 37252178ce0SDwaipayan Ray 37352178ce0SDwaipayan Rayload_docs() if ($verbose); 3743beb42ecSJoe Percheslist_types(0) if ($list_types); 3753beb42ecSJoe Perches 3769624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 3772ac73b4fSJoe Perches$check_orig = $check; 3789624b8d6SJoe Perches 3790a920b5bSAndy Whitcroftmy $exit = 0; 3800a920b5bSAndy Whitcroft 3815b57980dSJoe Perchesmy $perl_version_ok = 1; 382d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 3835b57980dSJoe Perches $perl_version_ok = 0; 384d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 3855b57980dSJoe Perches exit(1) if (!$ignore_perl_version); 386d62a201fSDave Hansen} 387d62a201fSDave Hansen 38845107ff6SAllen Hubbe#if no filenames are given, push '-' to read patch from stdin 3890a920b5bSAndy Whitcroftif ($#ARGV < 0) { 39045107ff6SAllen Hubbe push(@ARGV, '-'); 3910a920b5bSAndy Whitcroft} 3920a920b5bSAndy Whitcroft 393713a09deSAntonio Borneo# skip TAB size 1 to avoid additional checks on $tabsize - 1 39432f30ca9SJoe Perchesdie "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2); 395713a09deSAntonio Borneo 39691bfe484SJoe Perchessub hash_save_array_words { 39791bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 39891bfe484SJoe Perches 39991bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 40091bfe484SJoe Perches foreach my $word (@array) { 401000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 402000d1cc1SJoe Perches $word =~ s/^\s*//g; 403000d1cc1SJoe Perches $word =~ s/\s+/ /g; 404000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 405000d1cc1SJoe Perches 406000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 407000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 408000d1cc1SJoe Perches 40991bfe484SJoe Perches $hashRef->{$word}++; 410000d1cc1SJoe Perches } 41191bfe484SJoe Perches} 41291bfe484SJoe Perches 41391bfe484SJoe Perchessub hash_show_words { 41491bfe484SJoe Perches my ($hashRef, $prefix) = @_; 41591bfe484SJoe Perches 4163c816e49SJoe Perches if (keys %$hashRef) { 417d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 41858cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 41991bfe484SJoe Perches print " $word"; 42091bfe484SJoe Perches } 421d8469f16SJoe Perches print "\n"; 42291bfe484SJoe Perches } 42391bfe484SJoe Perches} 42491bfe484SJoe Perches 42591bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 42691bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 427000d1cc1SJoe Perches 428c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 429c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 4307429c690SAndy Whitcroftmy $dbg_type = 0; 431a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 432c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 43321caa13cSAndy Whitcroft ## no critic 43421caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 43521caa13cSAndy Whitcroft die "$@" if ($@); 436c2fdda0dSAndy Whitcroft} 437c2fdda0dSAndy Whitcroft 438d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 439d2c0a235SAndy Whitcroft 4408905a67cSAndy Whitcroftif ($terse) { 4418905a67cSAndy Whitcroft $emacs = 1; 4428905a67cSAndy Whitcroft $quiet++; 4438905a67cSAndy Whitcroft} 4448905a67cSAndy Whitcroft 4456c72ffaaSAndy Whitcroftif ($tree) { 4466c72ffaaSAndy Whitcroft if (defined $root) { 4476c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 4486c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 4496c72ffaaSAndy Whitcroft } 4506c72ffaaSAndy Whitcroft } else { 4516c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 4526c72ffaaSAndy Whitcroft $root = '.'; 4536c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 4546c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 4556c72ffaaSAndy Whitcroft $root = $1; 4566c72ffaaSAndy Whitcroft } 4576c72ffaaSAndy Whitcroft } 4586c72ffaaSAndy Whitcroft 4596c72ffaaSAndy Whitcroft if (!defined $root) { 4600a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 4610a920b5bSAndy Whitcroft exit(2); 4620a920b5bSAndy Whitcroft } 4636c72ffaaSAndy Whitcroft} 4646c72ffaaSAndy Whitcroft 4656c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 4666c72ffaaSAndy Whitcroft 4672ceb532bSAndy Whitcroftour $Ident = qr{ 4682ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 4692ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 4702ceb532bSAndy Whitcroft }x; 4716c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 4726c72ffaaSAndy Whitcroftour $Sparse = qr{ 4736c72ffaaSAndy Whitcroft __user| 4746c72ffaaSAndy Whitcroft __kernel| 4756c72ffaaSAndy Whitcroft __force| 4766c72ffaaSAndy Whitcroft __iomem| 4776c72ffaaSAndy Whitcroft __must_check| 478417495edSAndy Whitcroft __kprobes| 479165e72a6SSven Eckelmann __ref| 48033aa4597SGeert Uytterhoeven __refconst| 48133aa4597SGeert Uytterhoeven __refdata| 482ad315455SBoqun Feng __rcu| 483ad315455SBoqun Feng __private 4846c72ffaaSAndy Whitcroft }x; 485e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 486e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 487e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 488e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 489e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 4908716de38SJoe Perches 49152131292SWolfram Sang# Notes to $Attribute: 49252131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 4936c72ffaaSAndy Whitcroftour $Attribute = qr{ 4946c72ffaaSAndy Whitcroft const| 495b5e8736aSJoe Perches volatile| 49603f1df7dSJoe Perches __percpu| 49703f1df7dSJoe Perches __nocast| 49803f1df7dSJoe Perches __safe| 49946d832f5SMichael S. Tsirkin __bitwise| 50003f1df7dSJoe Perches __packed__| 50103f1df7dSJoe Perches __packed2__| 50203f1df7dSJoe Perches __naked| 50303f1df7dSJoe Perches __maybe_unused| 50403f1df7dSJoe Perches __always_unused| 50503f1df7dSJoe Perches __noreturn| 50603f1df7dSJoe Perches __used| 50703f1df7dSJoe Perches __cold| 508e23ef1f3SJoe Perches __pure| 50903f1df7dSJoe Perches __noclone| 51003f1df7dSJoe Perches __deprecated| 5116c72ffaaSAndy Whitcroft __read_mostly| 512c5967e98SJoe Perches __ro_after_init| 5136c72ffaaSAndy Whitcroft __kprobes| 5148716de38SJoe Perches $InitAttribute| 51524e1d81aSAndy Whitcroft ____cacheline_aligned| 51624e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 5175fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 51886cffecdSKees Cook __weak| 51986cffecdSKees Cook __alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\) 5206c72ffaaSAndy Whitcroft }x; 521c45dcabdSAndy Whitcroftour $Modifier; 52291cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 5236c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 5246c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 5256c72ffaaSAndy Whitcroft 52695e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 52795e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 52895e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 52995e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 5302435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 531d2af5aa6SJoe Perchesour $String = qr{(?:\b[Lu])?"[X\t]*"}; 532326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 533326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 534326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 53574349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 5362435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 537326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 538447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 53923f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 5406c72ffaaSAndy Whitcroftour $Operators = qr{ 5416c72ffaaSAndy Whitcroft <=|>=|==|!=| 5426c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 54323f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 5446c72ffaaSAndy Whitcroft }x; 5456c72ffaaSAndy Whitcroft 54691cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 54791cb5195SJoe Perches 548ab7e23f3SJoe Perchesour $BasicType; 5498905a67cSAndy Whitcroftour $NonptrType; 5501813087dSJoe Perchesour $NonptrTypeMisordered; 5518716de38SJoe Perchesour $NonptrTypeWithAttr; 5528905a67cSAndy Whitcroftour $Type; 5531813087dSJoe Perchesour $TypeMisordered; 5548905a67cSAndy Whitcroftour $Declare; 5551813087dSJoe Perchesour $DeclareMisordered; 5568905a67cSAndy Whitcroft 55715662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 55815662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 559171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 560171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 561171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 562171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 563171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 564171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 565171ae1a4SAndy Whitcroft}x; 566171ae1a4SAndy Whitcroft 56715662b3eSJoe Perchesour $UTF8 = qr{ 56815662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 56915662b3eSJoe Perches | $NON_ASCII_UTF8 57015662b3eSJoe Perches}x; 57115662b3eSJoe Perches 572e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 573021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 574021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 575021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 576021158b4SJoe Perches)}; 577e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 578fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 5798ed22cadSAndy Whitcroft atomic_t 5808ed22cadSAndy Whitcroft)}; 5818ea0114eSMickaël Salaünour $typeStdioTypedefs = qr{(?x: 5828ea0114eSMickaël Salaün FILE 5838ea0114eSMickaël Salaün)}; 584e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 585e6176fa4SJoe Perches $typeC99Typedefs\b| 586e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 5878ea0114eSMickaël Salaün $typeKernelTypedefs\b| 5888ea0114eSMickaël Salaün $typeStdioTypedefs\b 589e6176fa4SJoe Perches)}; 5908ed22cadSAndy Whitcroft 5916d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 5926d32f7a3SJoe Perches 593691e669bSJoe Perchesour $logFunctions = qr{(?x: 594758d7aadSMiles Chen printk(?:_ratelimited|_once|_deferred_once|_deferred|)| 5957d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 59687bd499aSJoe Perches TP_printk| 5976e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 598b0531722SJoe Perches panic| 59906668727SJoe Perches MODULE_[A-Z_]+| 60006668727SJoe Perches seq_vprintf|seq_printf|seq_puts 601691e669bSJoe Perches)}; 602691e669bSJoe Perches 603e29a70f1SJoe Perchesour $allocFunctions = qr{(?x: 604e29a70f1SJoe Perches (?:(?:devm_)? 60558f02267SJoe Perches (?:kv|k|v)[czm]alloc(?:_array)?(?:_node)? | 606e29a70f1SJoe Perches kstrdup(?:_const)? | 607e29a70f1SJoe Perches kmemdup(?:_nul)?) | 608461e1565SChristophe JAILLET (?:\w+)?alloc_skb(?:_ip_align)? | 609e29a70f1SJoe Perches # dev_alloc_skb/netdev_alloc_skb, et al 610e29a70f1SJoe Perches dma_alloc_coherent 611e29a70f1SJoe Perches)}; 612e29a70f1SJoe Perches 61320112475SJoe Perchesour $signature_tags = qr{(?xi: 61420112475SJoe Perches Signed-off-by:| 615d499480cSJorge Ramirez-Ortiz Co-developed-by:| 61620112475SJoe Perches Acked-by:| 61720112475SJoe Perches Tested-by:| 61820112475SJoe Perches Reviewed-by:| 61920112475SJoe Perches Reported-by:| 6208543ae12SMugunthan V N Suggested-by:| 62120112475SJoe Perches To:| 62220112475SJoe Perches Cc: 62320112475SJoe Perches)}; 62420112475SJoe Perches 62544c31888SMatthieu Baertsour @link_tags = qw(Link Closes); 626f94e40eaSMatthieu Baerts 627f94e40eaSMatthieu Baerts#Create a search and print patterns for all these strings to be used directly below 628f94e40eaSMatthieu Baertsour $link_tags_search = ""; 629f94e40eaSMatthieu Baertsour $link_tags_print = ""; 630f94e40eaSMatthieu Baertsforeach my $entry (@link_tags) { 631f94e40eaSMatthieu Baerts if ($link_tags_search ne "") { 632f94e40eaSMatthieu Baerts $link_tags_search .= '|'; 633f94e40eaSMatthieu Baerts $link_tags_print .= ' or '; 634f94e40eaSMatthieu Baerts } 635f94e40eaSMatthieu Baerts $entry .= ':'; 636f94e40eaSMatthieu Baerts $link_tags_search .= $entry; 637f94e40eaSMatthieu Baerts $link_tags_print .= "'$entry'"; 638f94e40eaSMatthieu Baerts} 639f94e40eaSMatthieu Baerts$link_tags_search = "(?:${link_tags_search})"; 640f94e40eaSMatthieu Baerts 641adb2da82SJoe Perchesour $tracing_logging_tags = qr{(?xi: 642adb2da82SJoe Perches [=-]*> | 643adb2da82SJoe Perches <[=-]* | 644adb2da82SJoe Perches \[ | 645adb2da82SJoe Perches \] | 646adb2da82SJoe Perches start | 647adb2da82SJoe Perches called | 648adb2da82SJoe Perches entered | 649adb2da82SJoe Perches entry | 650adb2da82SJoe Perches enter | 651adb2da82SJoe Perches in | 652adb2da82SJoe Perches inside | 653adb2da82SJoe Perches here | 654adb2da82SJoe Perches begin | 655adb2da82SJoe Perches exit | 656adb2da82SJoe Perches end | 657adb2da82SJoe Perches done | 658adb2da82SJoe Perches leave | 659adb2da82SJoe Perches completed | 660adb2da82SJoe Perches out | 661adb2da82SJoe Perches return | 662adb2da82SJoe Perches [\.\!:\s]* 663adb2da82SJoe Perches)}; 664adb2da82SJoe Perches 665831242abSAditya Srivastavasub edit_distance_min { 666831242abSAditya Srivastava my (@arr) = @_; 667831242abSAditya Srivastava my $len = scalar @arr; 668831242abSAditya Srivastava if ((scalar @arr) < 1) { 669831242abSAditya Srivastava # if underflow, return 670831242abSAditya Srivastava return; 671831242abSAditya Srivastava } 672831242abSAditya Srivastava my $min = $arr[0]; 673831242abSAditya Srivastava for my $i (0 .. ($len-1)) { 674831242abSAditya Srivastava if ($arr[$i] < $min) { 675831242abSAditya Srivastava $min = $arr[$i]; 676831242abSAditya Srivastava } 677831242abSAditya Srivastava } 678831242abSAditya Srivastava return $min; 679831242abSAditya Srivastava} 680831242abSAditya Srivastava 681831242abSAditya Srivastavasub get_edit_distance { 682831242abSAditya Srivastava my ($str1, $str2) = @_; 683831242abSAditya Srivastava $str1 = lc($str1); 684831242abSAditya Srivastava $str2 = lc($str2); 685831242abSAditya Srivastava $str1 =~ s/-//g; 686831242abSAditya Srivastava $str2 =~ s/-//g; 687831242abSAditya Srivastava my $len1 = length($str1); 688831242abSAditya Srivastava my $len2 = length($str2); 689831242abSAditya Srivastava # two dimensional array storing minimum edit distance 690831242abSAditya Srivastava my @distance; 691831242abSAditya Srivastava for my $i (0 .. $len1) { 692831242abSAditya Srivastava for my $j (0 .. $len2) { 693831242abSAditya Srivastava if ($i == 0) { 694831242abSAditya Srivastava $distance[$i][$j] = $j; 695831242abSAditya Srivastava } elsif ($j == 0) { 696831242abSAditya Srivastava $distance[$i][$j] = $i; 697831242abSAditya Srivastava } elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) { 698831242abSAditya Srivastava $distance[$i][$j] = $distance[$i - 1][$j - 1]; 699831242abSAditya Srivastava } else { 700831242abSAditya Srivastava my $dist1 = $distance[$i][$j - 1]; #insert distance 701831242abSAditya Srivastava my $dist2 = $distance[$i - 1][$j]; # remove 702831242abSAditya Srivastava my $dist3 = $distance[$i - 1][$j - 1]; #replace 703831242abSAditya Srivastava $distance[$i][$j] = 1 + edit_distance_min($dist1, $dist2, $dist3); 704831242abSAditya Srivastava } 705831242abSAditya Srivastava } 706831242abSAditya Srivastava } 707831242abSAditya Srivastava return $distance[$len1][$len2]; 708831242abSAditya Srivastava} 709831242abSAditya Srivastava 710831242abSAditya Srivastavasub find_standard_signature { 711831242abSAditya Srivastava my ($sign_off) = @_; 712831242abSAditya Srivastava my @standard_signature_tags = ( 713831242abSAditya Srivastava 'Signed-off-by:', 'Co-developed-by:', 'Acked-by:', 'Tested-by:', 714831242abSAditya Srivastava 'Reviewed-by:', 'Reported-by:', 'Suggested-by:' 715831242abSAditya Srivastava ); 716831242abSAditya Srivastava foreach my $signature (@standard_signature_tags) { 717831242abSAditya Srivastava return $signature if (get_edit_distance($sign_off, $signature) <= 2); 718831242abSAditya Srivastava } 719831242abSAditya Srivastava 720831242abSAditya Srivastava return ""; 721831242abSAditya Srivastava} 722831242abSAditya Srivastava 7239b71f79fSBjorn Helgaasour $obsolete_archives = qr{(?xi: 7249b71f79fSBjorn Helgaas \Qfreedesktop.org/archives/dri-devel\E | 7259b71f79fSBjorn Helgaas \Qlists.infradead.org\E | 7269b71f79fSBjorn Helgaas \Qlkml.org\E | 7279b71f79fSBjorn Helgaas \Qmail-archive.com\E | 7289b71f79fSBjorn Helgaas \Qmailman.alsa-project.org/pipermail\E | 7299b71f79fSBjorn Helgaas \Qmarc.info\E | 7309b71f79fSBjorn Helgaas \Qozlabs.org/pipermail\E | 7319b71f79fSBjorn Helgaas \Qspinics.net\E 7329b71f79fSBjorn Helgaas)}; 7339b71f79fSBjorn Helgaas 7341813087dSJoe Perchesour @typeListMisordered = ( 7351813087dSJoe Perches qr{char\s+(?:un)?signed}, 7361813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 7371813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 7381813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 7391813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 7401813087dSJoe Perches qr{short\s+(?:un)?signed}, 7411813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 7421813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 7431813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 7441813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 7451813087dSJoe Perches qr{int\s+(?:un)?signed}, 7461813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 7471813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 7481813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 7491813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 7501813087dSJoe Perches qr{long\s+(?:un)?signed}, 7511813087dSJoe Perches); 7521813087dSJoe Perches 7538905a67cSAndy Whitcroftour @typeList = ( 7548905a67cSAndy Whitcroft qr{void}, 7550c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 7560c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 7570c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 7580c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 7590c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 7600c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 7610c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 7620c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 7630c773d9dSJoe Perches qr{(?:un)?signed}, 7648905a67cSAndy Whitcroft qr{float}, 7658905a67cSAndy Whitcroft qr{double}, 7668905a67cSAndy Whitcroft qr{bool}, 7678905a67cSAndy Whitcroft qr{struct\s+$Ident}, 7688905a67cSAndy Whitcroft qr{union\s+$Ident}, 7698905a67cSAndy Whitcroft qr{enum\s+$Ident}, 7708905a67cSAndy Whitcroft qr{${Ident}_t}, 7718905a67cSAndy Whitcroft qr{${Ident}_handler}, 7728905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 7731813087dSJoe Perches @typeListMisordered, 7748905a67cSAndy Whitcroft); 775938224b5SJoe Perches 776938224b5SJoe Perchesour $C90_int_types = qr{(?x: 777938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 778938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 779938224b5SJoe Perches long\s+long\s+(?:un)?signed| 780938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 781938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 782938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 783938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 784938224b5SJoe Perches 785938224b5SJoe Perches long\s+int\s+(?:un)?signed| 786938224b5SJoe Perches long\s+(?:un)?signed\s+int| 787938224b5SJoe Perches long\s+(?:un)?signed| 788938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 789938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 790938224b5SJoe Perches int\s+long\s+(?:un)?signed| 791938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 792938224b5SJoe Perches 793938224b5SJoe Perches int\s+(?:un)?signed| 794938224b5SJoe Perches (?:(?:un)?signed\s+)?int 795938224b5SJoe Perches)}; 796938224b5SJoe Perches 797485ff23eSAlex Dowadour @typeListFile = (); 7988716de38SJoe Perchesour @typeListWithAttr = ( 7998716de38SJoe Perches @typeList, 8008716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 8018716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 8028716de38SJoe Perches); 8038716de38SJoe Perches 804c45dcabdSAndy Whitcroftour @modifierList = ( 805c45dcabdSAndy Whitcroft qr{fastcall}, 806c45dcabdSAndy Whitcroft); 807485ff23eSAlex Dowadour @modifierListFile = (); 8088905a67cSAndy Whitcroft 8092435880fSJoe Perchesour @mode_permission_funcs = ( 8102435880fSJoe Perches ["module_param", 3], 8112435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 8122435880fSJoe Perches ["module_param_array_named", 5], 8132435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 8142435880fSJoe Perches ["proc_create(?:_data|)", 2], 815459cf0aeSJoe Perches ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2], 816459cf0aeSJoe Perches ["IIO_DEV_ATTR_[A-Z_]+", 1], 817459cf0aeSJoe Perches ["SENSOR_(?:DEVICE_|)ATTR_2", 2], 818459cf0aeSJoe Perches ["SENSOR_TEMPLATE(?:_2|)", 3], 819459cf0aeSJoe Perches ["__ATTR", 2], 8202435880fSJoe Perches); 8212435880fSJoe Perches 8221a3dcf2eSJoe Perchesmy $word_pattern = '\b[A-Z]?[a-z]{2,}\b'; 8231a3dcf2eSJoe Perches 824515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 825515a235eSJoe Perchesour $mode_perms_search = ""; 826515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 827515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 828515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 829515a235eSJoe Perches} 83000180468SJoe Perches$mode_perms_search = "(?:${mode_perms_search})"; 831515a235eSJoe Perches 8329189c7e7SJoe Perchesour %deprecated_apis = ( 8339189c7e7SJoe Perches "synchronize_rcu_bh" => "synchronize_rcu", 8349189c7e7SJoe Perches "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited", 8359189c7e7SJoe Perches "call_rcu_bh" => "call_rcu", 8369189c7e7SJoe Perches "rcu_barrier_bh" => "rcu_barrier", 8379189c7e7SJoe Perches "synchronize_sched" => "synchronize_rcu", 8389189c7e7SJoe Perches "synchronize_sched_expedited" => "synchronize_rcu_expedited", 8399189c7e7SJoe Perches "call_rcu_sched" => "call_rcu", 8409189c7e7SJoe Perches "rcu_barrier_sched" => "rcu_barrier", 8419189c7e7SJoe Perches "get_state_synchronize_sched" => "get_state_synchronize_rcu", 8429189c7e7SJoe Perches "cond_synchronize_sched" => "cond_synchronize_rcu", 843defdaff1SIra Weiny "kmap" => "kmap_local_page", 844a3ea42ffSIra Weiny "kunmap" => "kunmap_local", 845defdaff1SIra Weiny "kmap_atomic" => "kmap_local_page", 846a3ea42ffSIra Weiny "kunmap_atomic" => "kunmap_local", 8479189c7e7SJoe Perches); 8489189c7e7SJoe Perches 8499189c7e7SJoe Perches#Create a search pattern for all these strings to speed up a loop below 8509189c7e7SJoe Perchesour $deprecated_apis_search = ""; 8519189c7e7SJoe Perchesforeach my $entry (keys %deprecated_apis) { 8529189c7e7SJoe Perches $deprecated_apis_search .= '|' if ($deprecated_apis_search ne ""); 8539189c7e7SJoe Perches $deprecated_apis_search .= $entry; 8549189c7e7SJoe Perches} 8559189c7e7SJoe Perches$deprecated_apis_search = "(?:${deprecated_apis_search})"; 8569189c7e7SJoe Perches 857b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 858b392c64fSJoe Perches S_IWUGO | 859b392c64fSJoe Perches S_IWOTH | 860b392c64fSJoe Perches S_IRWXUGO | 861b392c64fSJoe Perches S_IALLUGO | 862b392c64fSJoe Perches 0[0-7][0-7][2367] 863b392c64fSJoe Perches}x; 864b392c64fSJoe Perches 865f90774e1SJoe Perchesour %mode_permission_string_types = ( 866f90774e1SJoe Perches "S_IRWXU" => 0700, 867f90774e1SJoe Perches "S_IRUSR" => 0400, 868f90774e1SJoe Perches "S_IWUSR" => 0200, 869f90774e1SJoe Perches "S_IXUSR" => 0100, 870f90774e1SJoe Perches "S_IRWXG" => 0070, 871f90774e1SJoe Perches "S_IRGRP" => 0040, 872f90774e1SJoe Perches "S_IWGRP" => 0020, 873f90774e1SJoe Perches "S_IXGRP" => 0010, 874f90774e1SJoe Perches "S_IRWXO" => 0007, 875f90774e1SJoe Perches "S_IROTH" => 0004, 876f90774e1SJoe Perches "S_IWOTH" => 0002, 877f90774e1SJoe Perches "S_IXOTH" => 0001, 878f90774e1SJoe Perches "S_IRWXUGO" => 0777, 879f90774e1SJoe Perches "S_IRUGO" => 0444, 880f90774e1SJoe Perches "S_IWUGO" => 0222, 881f90774e1SJoe Perches "S_IXUGO" => 0111, 882f90774e1SJoe Perches); 883f90774e1SJoe Perches 884f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below 885f90774e1SJoe Perchesour $mode_perms_string_search = ""; 886f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) { 887f90774e1SJoe Perches $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); 888f90774e1SJoe Perches $mode_perms_string_search .= $entry; 889f90774e1SJoe Perches} 89000180468SJoe Perchesour $single_mode_perms_string_search = "(?:${mode_perms_string_search})"; 89100180468SJoe Perchesour $multi_mode_perms_string_search = qr{ 89200180468SJoe Perches ${single_mode_perms_string_search} 89300180468SJoe Perches (?:\s*\|\s*${single_mode_perms_string_search})* 89400180468SJoe Perches}x; 89500180468SJoe Perches 89600180468SJoe Perchessub perms_to_octal { 89700180468SJoe Perches my ($string) = @_; 89800180468SJoe Perches 89900180468SJoe Perches return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/); 90000180468SJoe Perches 90100180468SJoe Perches my $val = ""; 90200180468SJoe Perches my $oval = ""; 90300180468SJoe Perches my $to = 0; 90400180468SJoe Perches my $curpos = 0; 90500180468SJoe Perches my $lastpos = 0; 90600180468SJoe Perches while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) { 90700180468SJoe Perches $curpos = pos($string); 90800180468SJoe Perches my $match = $2; 90900180468SJoe Perches my $omatch = $1; 91000180468SJoe Perches last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos)); 91100180468SJoe Perches $lastpos = $curpos; 91200180468SJoe Perches $to |= $mode_permission_string_types{$match}; 91300180468SJoe Perches $val .= '\s*\|\s*' if ($val ne ""); 91400180468SJoe Perches $val .= $match; 91500180468SJoe Perches $oval .= $omatch; 91600180468SJoe Perches } 91700180468SJoe Perches $oval =~ s/^\s*\|\s*//; 91800180468SJoe Perches $oval =~ s/\s*\|\s*$//; 91900180468SJoe Perches return sprintf("%04o", $to); 92000180468SJoe Perches} 921f90774e1SJoe Perches 9227840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 9237840a94cSWolfram Sang irq| 924cdcee686SSergey Ryazanov memory| 925cdcee686SSergey Ryazanov time| 926cdcee686SSergey Ryazanov reboot 9277840a94cSWolfram Sang)}; 9287840a94cSWolfram Sang# memory.h: ARM has a custom one 9297840a94cSWolfram Sang 93066b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 93166b47b4aSKees Cookmy $misspellings; 93266b47b4aSKees Cookmy %spelling_fix; 93336061e38SJoe Perches 93436061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 93566b47b4aSKees Cook while (<$spelling>) { 93666b47b4aSKees Cook my $line = $_; 93766b47b4aSKees Cook 93866b47b4aSKees Cook $line =~ s/\s*\n?$//g; 93966b47b4aSKees Cook $line =~ s/^\s*//g; 94066b47b4aSKees Cook 94166b47b4aSKees Cook next if ($line =~ m/^\s*#/); 94266b47b4aSKees Cook next if ($line =~ m/^\s*$/); 94366b47b4aSKees Cook 94466b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 94566b47b4aSKees Cook 94666b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 94766b47b4aSKees Cook } 94866b47b4aSKees Cook close($spelling); 94936061e38SJoe Perches} else { 95036061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 95136061e38SJoe Perches} 95266b47b4aSKees Cook 953ebfd7d62SJoe Perchesif ($codespell) { 954ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 955ebfd7d62SJoe Perches while (<$spelling>) { 956ebfd7d62SJoe Perches my $line = $_; 957ebfd7d62SJoe Perches 958ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 959ebfd7d62SJoe Perches $line =~ s/^\s*//g; 960ebfd7d62SJoe Perches 961ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 962ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 963ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 964ebfd7d62SJoe Perches 965ebfd7d62SJoe Perches $line =~ s/,.*$//; 966ebfd7d62SJoe Perches 967ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 968ebfd7d62SJoe Perches 969ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 970ebfd7d62SJoe Perches } 971ebfd7d62SJoe Perches close($spelling); 972ebfd7d62SJoe Perches } else { 973ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 974ebfd7d62SJoe Perches } 975ebfd7d62SJoe Perches} 976ebfd7d62SJoe Perches 977ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 978ebfd7d62SJoe Perches 97975ad8c57SJerome Forissiersub read_words { 98075ad8c57SJerome Forissier my ($wordsRef, $file) = @_; 98175ad8c57SJerome Forissier 98275ad8c57SJerome Forissier if (open(my $words, '<', $file)) { 98375ad8c57SJerome Forissier while (<$words>) { 984bf1fa1daSJoe Perches my $line = $_; 985bf1fa1daSJoe Perches 986bf1fa1daSJoe Perches $line =~ s/\s*\n?$//g; 987bf1fa1daSJoe Perches $line =~ s/^\s*//g; 988bf1fa1daSJoe Perches 989bf1fa1daSJoe Perches next if ($line =~ m/^\s*#/); 990bf1fa1daSJoe Perches next if ($line =~ m/^\s*$/); 991bf1fa1daSJoe Perches if ($line =~ /\s/) { 99275ad8c57SJerome Forissier print("$file: '$line' invalid - ignored\n"); 993bf1fa1daSJoe Perches next; 994bf1fa1daSJoe Perches } 995bf1fa1daSJoe Perches 996ced69da1SQuentin Monnet $$wordsRef .= '|' if (defined $$wordsRef); 99775ad8c57SJerome Forissier $$wordsRef .= $line; 998bf1fa1daSJoe Perches } 99975ad8c57SJerome Forissier close($file); 100075ad8c57SJerome Forissier return 1; 1001bf1fa1daSJoe Perches } 1002bf1fa1daSJoe Perches 100375ad8c57SJerome Forissier return 0; 100475ad8c57SJerome Forissier} 100575ad8c57SJerome Forissier 1006ced69da1SQuentin Monnetmy $const_structs; 1007ced69da1SQuentin Monnetif (show_type("CONST_STRUCT")) { 100875ad8c57SJerome Forissier read_words(\$const_structs, $conststructsfile) 100975ad8c57SJerome Forissier or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 1010ced69da1SQuentin Monnet} 101175ad8c57SJerome Forissier 1012ced69da1SQuentin Monnetif (defined($typedefsfile)) { 1013ced69da1SQuentin Monnet my $typeOtherTypedefs; 101475ad8c57SJerome Forissier read_words(\$typeOtherTypedefs, $typedefsfile) 101575ad8c57SJerome Forissier or warn "No additional types will be considered - file '$typedefsfile': $!\n"; 1016ced69da1SQuentin Monnet $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs); 101775ad8c57SJerome Forissier} 101875ad8c57SJerome Forissier 10198905a67cSAndy Whitcroftsub build_types { 1020485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 1021485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 10221813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 10238716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 1024c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 1025ab7e23f3SJoe Perches $BasicType = qr{ 1026ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 1027ab7e23f3SJoe Perches (?:${all}\b) 1028ab7e23f3SJoe Perches }x; 10298905a67cSAndy Whitcroft $NonptrType = qr{ 1030d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 1031cf655043SAndy Whitcroft (?: 10326b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 10338ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 1034c45dcabdSAndy Whitcroft (?:${all}\b) 1035cf655043SAndy Whitcroft ) 1036c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 10378905a67cSAndy Whitcroft }x; 10381813087dSJoe Perches $NonptrTypeMisordered = qr{ 10391813087dSJoe Perches (?:$Modifier\s+|const\s+)* 10401813087dSJoe Perches (?: 10411813087dSJoe Perches (?:${Misordered}\b) 10421813087dSJoe Perches ) 10431813087dSJoe Perches (?:\s+$Modifier|\s+const)* 10441813087dSJoe Perches }x; 10458716de38SJoe Perches $NonptrTypeWithAttr = qr{ 10468716de38SJoe Perches (?:$Modifier\s+|const\s+)* 10478716de38SJoe Perches (?: 10488716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 10498716de38SJoe Perches (?:$typeTypedefs\b)| 10508716de38SJoe Perches (?:${allWithAttr}\b) 10518716de38SJoe Perches ) 10528716de38SJoe Perches (?:\s+$Modifier|\s+const)* 10538716de38SJoe Perches }x; 10548905a67cSAndy Whitcroft $Type = qr{ 1055c45dcabdSAndy Whitcroft $NonptrType 10567b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 1057c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 10588905a67cSAndy Whitcroft }x; 10591813087dSJoe Perches $TypeMisordered = qr{ 10601813087dSJoe Perches $NonptrTypeMisordered 10617b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 10621813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 10631813087dSJoe Perches }x; 106491cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 10651813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 10668905a67cSAndy Whitcroft} 10678905a67cSAndy Whitcroftbuild_types(); 10686c72ffaaSAndy Whitcroft 10697d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 1070d1fe9c09SJoe Perches 1071d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 1072d1fe9c09SJoe Perches# requires at least perl version v5.10.0 1073d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 1074d1fe9c09SJoe Perches 1075d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 10762435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 1077c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 10787d2367afSJoe Perches 1079f8422308SJoe Perchesour $declaration_macros = qr{(?x: 10803e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 1081fe658f94SSteffen Maier (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(| 1082dcea7964SJoe Perches (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(| 1083dcea7964SJoe Perches (?:$Storage\s+)?(?:XA_STATE|XA_STATE_ORDER)\s*\( 1084f8422308SJoe Perches)}; 1085f8422308SJoe Perches 10868d0325ccSAditya Srivastavaour %allow_repeated_words = ( 10878d0325ccSAditya Srivastava add => '', 10888d0325ccSAditya Srivastava added => '', 10898d0325ccSAditya Srivastava bad => '', 10908d0325ccSAditya Srivastava be => '', 10918d0325ccSAditya Srivastava); 10928d0325ccSAditya Srivastava 10937d2367afSJoe Perchessub deparenthesize { 10947d2367afSJoe Perches my ($string) = @_; 10957d2367afSJoe Perches return "" if (!defined($string)); 10965b9553abSJoe Perches 10975b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 10985b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 10995b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 11005b9553abSJoe Perches } 11015b9553abSJoe Perches 11027d2367afSJoe Perches $string =~ s@\s+@ @g; 11035b9553abSJoe Perches 11047d2367afSJoe Perches return $string; 11057d2367afSJoe Perches} 11067d2367afSJoe Perches 11073445686aSJoe Perchessub seed_camelcase_file { 11083445686aSJoe Perches my ($file) = @_; 11093445686aSJoe Perches 11103445686aSJoe Perches return if (!(-f $file)); 11113445686aSJoe Perches 11123445686aSJoe Perches local $/; 11133445686aSJoe Perches 11143445686aSJoe Perches open(my $include_file, '<', "$file") 11153445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 11163445686aSJoe Perches my $text = <$include_file>; 11173445686aSJoe Perches close($include_file); 11183445686aSJoe Perches 11193445686aSJoe Perches my @lines = split('\n', $text); 11203445686aSJoe Perches 11213445686aSJoe Perches foreach my $line (@lines) { 11223445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 11233445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 11243445686aSJoe Perches $camelcase{$1} = 1; 112511ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 112611ea516aSJoe Perches $camelcase{$1} = 1; 112711ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 11283445686aSJoe Perches $camelcase{$1} = 1; 11293445686aSJoe Perches } 11303445686aSJoe Perches } 11313445686aSJoe Perches} 11323445686aSJoe Perches 1133cd28b119SJoe Perchesour %maintained_status = (); 1134cd28b119SJoe Perches 113585b0ee18SJoe Perchessub is_maintained_obsolete { 113685b0ee18SJoe Perches my ($filename) = @_; 113785b0ee18SJoe Perches 1138f2c19c2fSJerome Forissier return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 113985b0ee18SJoe Perches 1140cd28b119SJoe Perches if (!exists($maintained_status{$filename})) { 1141cd28b119SJoe Perches $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 1142cd28b119SJoe Perches } 114385b0ee18SJoe Perches 1144cd28b119SJoe Perches return $maintained_status{$filename} =~ /obsolete/i; 114585b0ee18SJoe Perches} 114685b0ee18SJoe Perches 11473b6e8ac9SJoe Perchessub is_SPDX_License_valid { 11483b6e8ac9SJoe Perches my ($license) = @_; 11493b6e8ac9SJoe Perches 1150f9363b31SGuenter Roeck return 1 if (!$tree || which("python3") eq "" || !(-x "$root/scripts/spdxcheck.py") || !(-e "$gitroot")); 11513b6e8ac9SJoe Perches 115256294112SJoe Perches my $root_path = abs_path($root); 1153f9363b31SGuenter Roeck my $status = `cd "$root_path"; echo "$license" | scripts/spdxcheck.py -`; 11543b6e8ac9SJoe Perches return 0 if ($status ne ""); 11553b6e8ac9SJoe Perches return 1; 11563b6e8ac9SJoe Perches} 11573b6e8ac9SJoe Perches 11583445686aSJoe Perchesmy $camelcase_seeded = 0; 11593445686aSJoe Perchessub seed_camelcase_includes { 11603445686aSJoe Perches return if ($camelcase_seeded); 11613445686aSJoe Perches 11623445686aSJoe Perches my $files; 1163c707a81dSJoe Perches my $camelcase_cache = ""; 1164c707a81dSJoe Perches my @include_files = (); 1165c707a81dSJoe Perches 1166c707a81dSJoe Perches $camelcase_seeded = 1; 1167351b2a1fSJoe Perches 11680f7f635bSJoe Perches if (-e "$gitroot") { 1169dbbf869dSJoe Perches my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`; 1170351b2a1fSJoe Perches chomp $git_last_include_commit; 1171c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 1172c707a81dSJoe Perches } else { 1173c707a81dSJoe Perches my $last_mod_date = 0; 1174c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 1175c707a81dSJoe Perches @include_files = split('\n', $files); 1176c707a81dSJoe Perches foreach my $file (@include_files) { 1177c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 1178c707a81dSJoe Perches localtime((stat $file)[9])); 1179c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 1180c707a81dSJoe Perches } 1181c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 1182c707a81dSJoe Perches } 1183c707a81dSJoe Perches 1184c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 1185c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 1186c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 1187351b2a1fSJoe Perches while (<$camelcase_file>) { 1188351b2a1fSJoe Perches chomp; 1189351b2a1fSJoe Perches $camelcase{$_} = 1; 1190351b2a1fSJoe Perches } 1191351b2a1fSJoe Perches close($camelcase_file); 1192351b2a1fSJoe Perches 1193351b2a1fSJoe Perches return; 1194351b2a1fSJoe Perches } 1195c707a81dSJoe Perches 11960f7f635bSJoe Perches if (-e "$gitroot") { 1197dbbf869dSJoe Perches $files = `${git_command} ls-files "include/*.h"`; 1198c707a81dSJoe Perches @include_files = split('\n', $files); 11993445686aSJoe Perches } 1200c707a81dSJoe Perches 12013445686aSJoe Perches foreach my $file (@include_files) { 12023445686aSJoe Perches seed_camelcase_file($file); 12033445686aSJoe Perches } 1204351b2a1fSJoe Perches 1205c707a81dSJoe Perches if ($camelcase_cache ne "") { 1206351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 1207c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 1208c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 1209351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 1210351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 1211351b2a1fSJoe Perches } 1212351b2a1fSJoe Perches close($camelcase_file); 1213351b2a1fSJoe Perches } 12143445686aSJoe Perches} 12153445686aSJoe Perches 1216f5f61325SJoe Perchessub git_is_single_file { 1217f5f61325SJoe Perches my ($filename) = @_; 1218f5f61325SJoe Perches 1219f5f61325SJoe Perches return 0 if ((which("git") eq "") || !(-e "$gitroot")); 1220f5f61325SJoe Perches 1221f5f61325SJoe Perches my $output = `${git_command} ls-files -- $filename 2>/dev/null`; 1222f5f61325SJoe Perches my $count = $output =~ tr/\n//; 1223f5f61325SJoe Perches return $count eq 1 && $output =~ m{^${filename}$}; 1224f5f61325SJoe Perches} 1225f5f61325SJoe Perches 1226d311cd44SJoe Perchessub git_commit_info { 1227d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 1228d311cd44SJoe Perches 12290f7f635bSJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot")); 1230d311cd44SJoe Perches 1231dbbf869dSJoe Perches my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`; 1232d311cd44SJoe Perches $output =~ s/^\s*//gm; 1233d311cd44SJoe Perches my @lines = split("\n", $output); 1234d311cd44SJoe Perches 12350d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 12360d7835fcSJoe Perches 12375a7f4455SSean Christopherson if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) { 1238d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 1239d311cd44SJoe Perches# all matching commit ids, but it's very slow... 1240d311cd44SJoe Perches# 1241d311cd44SJoe Perches# echo "checking commits $1..." 1242d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 1243d311cd44SJoe Perches# while read line ; do 1244d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 1245d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 1246d311cd44SJoe Perches# done 12474ce9f970SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./ || 12484ce9f970SJoe Perches $lines[0] =~ /^fatal: bad object $commit/) { 1249948b133aSHeinrich Schuchardt $id = undef; 1250d311cd44SJoe Perches } else { 1251d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 1252d311cd44SJoe Perches $desc = substr($lines[0], 41); 1253d311cd44SJoe Perches } 1254d311cd44SJoe Perches 1255d311cd44SJoe Perches return ($id, $desc); 1256d311cd44SJoe Perches} 1257d311cd44SJoe Perches 12586c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 12590a920b5bSAndy Whitcroft 126000df344fSAndy Whitcroftmy @rawlines = (); 1261c2fdda0dSAndy Whitcroftmy @lines = (); 12623705ce5bSJoe Perchesmy @fixed = (); 1263d752fcc8SJoe Perchesmy @fixed_inserted = (); 1264d752fcc8SJoe Perchesmy @fixed_deleted = (); 1265194f66fcSJoe Perchesmy $fixlinenr = -1; 1266194f66fcSJoe Perches 12674a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 12684a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 12690f7f635bSJoe Perchesdie "$P: No git repository found\n" if ($git && !-e "$gitroot"); 12704a593c34SDu, Changbin 12714a593c34SDu, Changbinif ($git) { 12724a593c34SDu, Changbin my @commits = (); 12730dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 12744a593c34SDu, Changbin my $git_range; 127528898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 127628898fd1SJoe Perches $git_range = "-$2 $1"; 12774a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 12784a593c34SDu, Changbin $git_range = "$commit_expr"; 12794a593c34SDu, Changbin } else { 12800dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 12810dea9f1eSJoe Perches } 1282dbbf869dSJoe Perches my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 12830dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 128428898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 128528898fd1SJoe Perches next if (!defined($1) || !defined($2)); 12860dea9f1eSJoe Perches my $sha1 = $1; 12870dea9f1eSJoe Perches my $subject = $2; 12880dea9f1eSJoe Perches unshift(@commits, $sha1); 12890dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 12904a593c34SDu, Changbin } 12914a593c34SDu, Changbin } 12924a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 12934a593c34SDu, Changbin @ARGV = @commits; 12944a593c34SDu, Changbin} 12954a593c34SDu, Changbin 1296c2fdda0dSAndy Whitcroftmy $vname; 129798005e8cSVadim Bendebury$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"}; 12986c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 129921caa13cSAndy Whitcroft my $FILE; 1300f5f61325SJoe Perches my $is_git_file = git_is_single_file($filename); 1301f5f61325SJoe Perches my $oldfile = $file; 1302f5f61325SJoe Perches $file = 1 if ($is_git_file); 13034a593c34SDu, Changbin if ($git) { 13044a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 13054a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 13064a593c34SDu, Changbin } elsif ($file) { 130721caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 13086c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 130921caa13cSAndy Whitcroft } elsif ($filename eq '-') { 131021caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 13116c72ffaaSAndy Whitcroft } else { 131221caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 13136c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 13146c72ffaaSAndy Whitcroft } 1315c2fdda0dSAndy Whitcroft if ($filename eq '-') { 1316c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 13174a593c34SDu, Changbin } elsif ($git) { 13180dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 1319c2fdda0dSAndy Whitcroft } else { 1320c2fdda0dSAndy Whitcroft $vname = $filename; 1321c2fdda0dSAndy Whitcroft } 132221caa13cSAndy Whitcroft while (<$FILE>) { 13230a920b5bSAndy Whitcroft chomp; 132400df344fSAndy Whitcroft push(@rawlines, $_); 1325c7f574d0SGeert Uytterhoeven $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i); 13266c72ffaaSAndy Whitcroft } 132721caa13cSAndy Whitcroft close($FILE); 1328d8469f16SJoe Perches 1329d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 1330d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1331d8469f16SJoe Perches print "$vname\n"; 1332d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1333d8469f16SJoe Perches } 1334d8469f16SJoe Perches 1335c2fdda0dSAndy Whitcroft if (!process($filename)) { 13360a920b5bSAndy Whitcroft $exit = 1; 13370a920b5bSAndy Whitcroft } 133800df344fSAndy Whitcroft @rawlines = (); 133913214adfSAndy Whitcroft @lines = (); 13403705ce5bSJoe Perches @fixed = (); 1341d752fcc8SJoe Perches @fixed_inserted = (); 1342d752fcc8SJoe Perches @fixed_deleted = (); 1343194f66fcSJoe Perches $fixlinenr = -1; 1344485ff23eSAlex Dowad @modifierListFile = (); 1345485ff23eSAlex Dowad @typeListFile = (); 1346485ff23eSAlex Dowad build_types(); 1347f5f61325SJoe Perches $file = $oldfile if ($is_git_file); 13480a920b5bSAndy Whitcroft} 13490a920b5bSAndy Whitcroft 1350d8469f16SJoe Perchesif (!$quiet) { 13513c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 13523c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 13533c816e49SJoe Perches 13545b57980dSJoe Perches if (!$perl_version_ok) { 1355d8469f16SJoe Perches print << "EOM" 1356d8469f16SJoe Perches 1357d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 13585b57980dSJoe Perches An upgrade to at least perl $minimum_perl_version is suggested. 1359d8469f16SJoe PerchesEOM 1360d8469f16SJoe Perches } 1361d8469f16SJoe Perches if ($exit) { 1362d8469f16SJoe Perches print << "EOM" 1363d8469f16SJoe Perches 1364d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 1365d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 1366d8469f16SJoe PerchesEOM 1367d8469f16SJoe Perches } 1368d8469f16SJoe Perches} 1369d8469f16SJoe Perches 13700a920b5bSAndy Whitcroftexit($exit); 13710a920b5bSAndy Whitcroft 13720a920b5bSAndy Whitcroftsub top_of_kernel_tree { 13736c72ffaaSAndy Whitcroft my ($root) = @_; 13746c72ffaaSAndy Whitcroft 13756c72ffaaSAndy Whitcroft my @tree_check = ( 13766c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 13776c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 13786c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 13796c72ffaaSAndy Whitcroft ); 13806c72ffaaSAndy Whitcroft 13816c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 13826c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 13830a920b5bSAndy Whitcroft return 0; 13840a920b5bSAndy Whitcroft } 13856c72ffaaSAndy Whitcroft } 13866c72ffaaSAndy Whitcroft return 1; 13876c72ffaaSAndy Whitcroft} 13880a920b5bSAndy Whitcroft 138920112475SJoe Perchessub parse_email { 139020112475SJoe Perches my ($formatted_email) = @_; 139120112475SJoe Perches 139220112475SJoe Perches my $name = ""; 1393fccaebf0SDwaipayan Ray my $quoted = ""; 1394dfa05c28SJoe Perches my $name_comment = ""; 139520112475SJoe Perches my $address = ""; 139620112475SJoe Perches my $comment = ""; 139720112475SJoe Perches 139820112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 139920112475SJoe Perches $name = $1; 140020112475SJoe Perches $address = $2; 140120112475SJoe Perches $comment = $3 if defined $3; 140220112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 140320112475SJoe Perches $address = $1; 140420112475SJoe Perches $comment = $2 if defined $2; 140520112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 140620112475SJoe Perches $address = $1; 140720112475SJoe Perches $comment = $2 if defined $2; 140885e12066SJoe Perches $formatted_email =~ s/\Q$address\E.*$//; 140920112475SJoe Perches $name = $formatted_email; 14103705ce5bSJoe Perches $name = trim($name); 141120112475SJoe Perches $name =~ s/^\"|\"$//g; 141220112475SJoe Perches # If there's a name left after stripping spaces and 141320112475SJoe Perches # leading quotes, and the address doesn't have both 141420112475SJoe Perches # leading and trailing angle brackets, the address 141520112475SJoe Perches # is invalid. ie: 141620112475SJoe Perches # "joe smith [email protected]" bad 141720112475SJoe Perches # "joe smith <[email protected]" bad 141820112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 141920112475SJoe Perches $name = ""; 142020112475SJoe Perches $address = ""; 142120112475SJoe Perches $comment = ""; 142220112475SJoe Perches } 142320112475SJoe Perches } 142420112475SJoe Perches 1425fccaebf0SDwaipayan Ray # Extract comments from names excluding quoted parts 1426fccaebf0SDwaipayan Ray # "John D. (Doe)" - Do not extract 1427fccaebf0SDwaipayan Ray if ($name =~ s/\"(.+)\"//) { 1428fccaebf0SDwaipayan Ray $quoted = $1; 1429dfa05c28SJoe Perches } 1430fccaebf0SDwaipayan Ray while ($name =~ s/\s*($balanced_parens)\s*/ /) { 1431fccaebf0SDwaipayan Ray $name_comment .= trim($1); 1432fccaebf0SDwaipayan Ray } 1433fccaebf0SDwaipayan Ray $name =~ s/^[ \"]+|[ \"]+$//g; 1434fccaebf0SDwaipayan Ray $name = trim("$quoted $name"); 1435fccaebf0SDwaipayan Ray 14363705ce5bSJoe Perches $address = trim($address); 143720112475SJoe Perches $address =~ s/^\<|\>$//g; 1438fccaebf0SDwaipayan Ray $comment = trim($comment); 143920112475SJoe Perches 144020112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 144120112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 144220112475SJoe Perches $name = "\"$name\""; 144320112475SJoe Perches } 144420112475SJoe Perches 1445dfa05c28SJoe Perches return ($name, $name_comment, $address, $comment); 144620112475SJoe Perches} 144720112475SJoe Perches 144820112475SJoe Perchessub format_email { 144948ca2d8aSDwaipayan Ray my ($name, $name_comment, $address, $comment) = @_; 145020112475SJoe Perches 145120112475SJoe Perches my $formatted_email; 145220112475SJoe Perches 1453fccaebf0SDwaipayan Ray $name =~ s/^[ \"]+|[ \"]+$//g; 14543705ce5bSJoe Perches $address = trim($address); 1455fccaebf0SDwaipayan Ray $address =~ s/(?:\.|\,|\")+$//; ##trailing commas, dots or quotes 145620112475SJoe Perches 145720112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 145820112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 145920112475SJoe Perches $name = "\"$name\""; 146020112475SJoe Perches } 146120112475SJoe Perches 1462fccaebf0SDwaipayan Ray $name_comment = trim($name_comment); 1463fccaebf0SDwaipayan Ray $name_comment = " $name_comment" if ($name_comment ne ""); 1464fccaebf0SDwaipayan Ray $comment = trim($comment); 1465fccaebf0SDwaipayan Ray $comment = " $comment" if ($comment ne ""); 1466fccaebf0SDwaipayan Ray 146720112475SJoe Perches if ("$name" eq "") { 146820112475SJoe Perches $formatted_email = "$address"; 146920112475SJoe Perches } else { 147048ca2d8aSDwaipayan Ray $formatted_email = "$name$name_comment <$address>"; 147120112475SJoe Perches } 147248ca2d8aSDwaipayan Ray $formatted_email .= "$comment"; 147320112475SJoe Perches return $formatted_email; 147420112475SJoe Perches} 147520112475SJoe Perches 1476dfa05c28SJoe Perchessub reformat_email { 1477dfa05c28SJoe Perches my ($email) = @_; 1478dfa05c28SJoe Perches 1479dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 148048ca2d8aSDwaipayan Ray return format_email($email_name, $name_comment, $email_address, $comment); 1481dfa05c28SJoe Perches} 1482dfa05c28SJoe Perches 1483dfa05c28SJoe Perchessub same_email_addresses { 1484fccaebf0SDwaipayan Ray my ($email1, $email2) = @_; 1485dfa05c28SJoe Perches 1486dfa05c28SJoe Perches my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1); 1487dfa05c28SJoe Perches my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2); 1488dfa05c28SJoe Perches 148948ca2d8aSDwaipayan Ray return $email1_name eq $email2_name && 149048ca2d8aSDwaipayan Ray $email1_address eq $email2_address && 149148ca2d8aSDwaipayan Ray $name1_comment eq $name2_comment && 149248ca2d8aSDwaipayan Ray $comment1 eq $comment2; 149348ca2d8aSDwaipayan Ray} 1494dfa05c28SJoe Perches 1495d311cd44SJoe Perchessub which { 1496d311cd44SJoe Perches my ($bin) = @_; 1497d311cd44SJoe Perches 1498d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1499d311cd44SJoe Perches if (-e "$path/$bin") { 1500d311cd44SJoe Perches return "$path/$bin"; 1501d311cd44SJoe Perches } 1502d311cd44SJoe Perches } 1503d311cd44SJoe Perches 1504d311cd44SJoe Perches return ""; 1505d311cd44SJoe Perches} 1506d311cd44SJoe Perches 1507000d1cc1SJoe Perchessub which_conf { 1508000d1cc1SJoe Perches my ($conf) = @_; 1509000d1cc1SJoe Perches 1510000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1511000d1cc1SJoe Perches if (-e "$path/$conf") { 1512000d1cc1SJoe Perches return "$path/$conf"; 1513000d1cc1SJoe Perches } 1514000d1cc1SJoe Perches } 1515000d1cc1SJoe Perches 1516000d1cc1SJoe Perches return ""; 1517000d1cc1SJoe Perches} 1518000d1cc1SJoe Perches 15190a920b5bSAndy Whitcroftsub expand_tabs { 15200a920b5bSAndy Whitcroft my ($str) = @_; 15210a920b5bSAndy Whitcroft 15220a920b5bSAndy Whitcroft my $res = ''; 15230a920b5bSAndy Whitcroft my $n = 0; 15240a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 15250a920b5bSAndy Whitcroft if ($c eq "\t") { 15260a920b5bSAndy Whitcroft $res .= ' '; 15270a920b5bSAndy Whitcroft $n++; 1528713a09deSAntonio Borneo for (; ($n % $tabsize) != 0; $n++) { 15290a920b5bSAndy Whitcroft $res .= ' '; 15300a920b5bSAndy Whitcroft } 15310a920b5bSAndy Whitcroft next; 15320a920b5bSAndy Whitcroft } 15330a920b5bSAndy Whitcroft $res .= $c; 15340a920b5bSAndy Whitcroft $n++; 15350a920b5bSAndy Whitcroft } 15360a920b5bSAndy Whitcroft 15370a920b5bSAndy Whitcroft return $res; 15380a920b5bSAndy Whitcroft} 15396c72ffaaSAndy Whitcroftsub copy_spacing { 1540773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 15416c72ffaaSAndy Whitcroft return $res; 15426c72ffaaSAndy Whitcroft} 15430a920b5bSAndy Whitcroft 15444a0df2efSAndy Whitcroftsub line_stats { 15454a0df2efSAndy Whitcroft my ($line) = @_; 15464a0df2efSAndy Whitcroft 15474a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 15484a0df2efSAndy Whitcroft $line =~ s/^.//; 15494a0df2efSAndy Whitcroft $line = expand_tabs($line); 15504a0df2efSAndy Whitcroft 15514a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 15524a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 15534a0df2efSAndy Whitcroft 15544a0df2efSAndy Whitcroft return (length($line), length($white)); 15554a0df2efSAndy Whitcroft} 15564a0df2efSAndy Whitcroft 1557773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1558773647a0SAndy Whitcroft 1559773647a0SAndy Whitcroftsub sanitise_line_reset { 1560773647a0SAndy Whitcroft my ($in_comment) = @_; 1561773647a0SAndy Whitcroft 1562773647a0SAndy Whitcroft if ($in_comment) { 1563773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1564773647a0SAndy Whitcroft } else { 1565773647a0SAndy Whitcroft $sanitise_quote = ''; 1566773647a0SAndy Whitcroft } 1567773647a0SAndy Whitcroft} 156800df344fSAndy Whitcroftsub sanitise_line { 156900df344fSAndy Whitcroft my ($line) = @_; 157000df344fSAndy Whitcroft 157100df344fSAndy Whitcroft my $res = ''; 157200df344fSAndy Whitcroft my $l = ''; 157300df344fSAndy Whitcroft 1574c2fdda0dSAndy Whitcroft my $qlen = 0; 1575773647a0SAndy Whitcroft my $off = 0; 1576773647a0SAndy Whitcroft my $c; 157700df344fSAndy Whitcroft 1578773647a0SAndy Whitcroft # Always copy over the diff marker. 1579773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1580773647a0SAndy Whitcroft 1581773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1582773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1583773647a0SAndy Whitcroft 15848d2e11b2SClaudio Fontana # Comments we are whacking completely including the begin 1585773647a0SAndy Whitcroft # and end, all to $;. 1586773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1587773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1588773647a0SAndy Whitcroft 1589773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1590773647a0SAndy Whitcroft $off++; 159100df344fSAndy Whitcroft next; 1592773647a0SAndy Whitcroft } 159381bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1594773647a0SAndy Whitcroft $sanitise_quote = ''; 1595773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1596773647a0SAndy Whitcroft $off++; 1597773647a0SAndy Whitcroft next; 1598773647a0SAndy Whitcroft } 1599113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1600113f04a8SDaniel Walker $sanitise_quote = '//'; 1601113f04a8SDaniel Walker 1602113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1603113f04a8SDaniel Walker $off++; 1604113f04a8SDaniel Walker next; 1605113f04a8SDaniel Walker } 1606773647a0SAndy Whitcroft 1607773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1608773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1609773647a0SAndy Whitcroft $c eq "\\") { 1610773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1611773647a0SAndy Whitcroft $off++; 1612773647a0SAndy Whitcroft next; 1613773647a0SAndy Whitcroft } 1614773647a0SAndy Whitcroft # Regular quotes. 1615773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1616773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1617773647a0SAndy Whitcroft $sanitise_quote = $c; 1618773647a0SAndy Whitcroft 1619773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1620773647a0SAndy Whitcroft next; 1621773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1622773647a0SAndy Whitcroft $sanitise_quote = ''; 162300df344fSAndy Whitcroft } 162400df344fSAndy Whitcroft } 1625773647a0SAndy Whitcroft 1626fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1627773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1628773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1629113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1630113f04a8SDaniel Walker substr($res, $off, 1, $;); 1631773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1632773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 163300df344fSAndy Whitcroft } else { 1634773647a0SAndy Whitcroft substr($res, $off, 1, $c); 163500df344fSAndy Whitcroft } 1636c2fdda0dSAndy Whitcroft } 1637c2fdda0dSAndy Whitcroft 1638113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1639113f04a8SDaniel Walker $sanitise_quote = ''; 1640113f04a8SDaniel Walker } 1641113f04a8SDaniel Walker 1642c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1643c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1644c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1645c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1646c2fdda0dSAndy Whitcroft 1647c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1648c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1649c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1650c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1651c2fdda0dSAndy Whitcroft } 1652c2fdda0dSAndy Whitcroft 1653dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1654dadf680dSJoe Perches my $match = $1; 1655dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1656dadf680dSJoe Perches } 1657dadf680dSJoe Perches 165800df344fSAndy Whitcroft return $res; 165900df344fSAndy Whitcroft} 166000df344fSAndy Whitcroft 1661a6962d72SJoe Perchessub get_quoted_string { 1662a6962d72SJoe Perches my ($line, $rawline) = @_; 1663a6962d72SJoe Perches 1664478b1799SJoe Perches return "" if (!defined($line) || !defined($rawline)); 166533acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1666a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1667a6962d72SJoe Perches} 1668a6962d72SJoe Perches 16698905a67cSAndy Whitcroftsub ctx_statement_block { 16708905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 16718905a67cSAndy Whitcroft my $line = $linenr - 1; 16728905a67cSAndy Whitcroft my $blk = ''; 16738905a67cSAndy Whitcroft my $soff = $off; 16748905a67cSAndy Whitcroft my $coff = $off - 1; 1675773647a0SAndy Whitcroft my $coff_set = 0; 16768905a67cSAndy Whitcroft 167713214adfSAndy Whitcroft my $loff = 0; 167813214adfSAndy Whitcroft 16798905a67cSAndy Whitcroft my $type = ''; 16808905a67cSAndy Whitcroft my $level = 0; 1681a2750645SAndy Whitcroft my @stack = (); 1682cf655043SAndy Whitcroft my $p; 16838905a67cSAndy Whitcroft my $c; 16848905a67cSAndy Whitcroft my $len = 0; 168513214adfSAndy Whitcroft 168613214adfSAndy Whitcroft my $remainder; 16878905a67cSAndy Whitcroft while (1) { 1688a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1689a2750645SAndy Whitcroft 1690773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 16918905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 16928905a67cSAndy Whitcroft # context. 16938905a67cSAndy Whitcroft if ($off >= $len) { 16948905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1695dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1696c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 16978905a67cSAndy Whitcroft $remain--; 169813214adfSAndy Whitcroft $loff = $len; 1699c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 17008905a67cSAndy Whitcroft $len = length($blk); 17018905a67cSAndy Whitcroft $line++; 17028905a67cSAndy Whitcroft last; 17038905a67cSAndy Whitcroft } 17048905a67cSAndy Whitcroft # Bail if there is no further context. 17058905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 170613214adfSAndy Whitcroft if ($off >= $len) { 17078905a67cSAndy Whitcroft last; 17088905a67cSAndy Whitcroft } 1709f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1710f74bd194SAndy Whitcroft $level++; 1711f74bd194SAndy Whitcroft $type = '#'; 1712f74bd194SAndy Whitcroft } 17138905a67cSAndy Whitcroft } 1714cf655043SAndy Whitcroft $p = $c; 17158905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 171613214adfSAndy Whitcroft $remainder = substr($blk, $off); 17178905a67cSAndy Whitcroft 1718773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 17194635f4fbSAndy Whitcroft 17204635f4fbSAndy Whitcroft # Handle nested #if/#else. 17214635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 17224635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 17234635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 17244635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 17254635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 17264635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 17274635f4fbSAndy Whitcroft } 17284635f4fbSAndy Whitcroft 17298905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 17308905a67cSAndy Whitcroft # outermost level. 17318905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 17328905a67cSAndy Whitcroft last; 17338905a67cSAndy Whitcroft } 17348905a67cSAndy Whitcroft 173513214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1736773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1737773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1738773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1739773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1740773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1741773647a0SAndy Whitcroft $coff_set = 1; 1742773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1743773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 174413214adfSAndy Whitcroft } 174513214adfSAndy Whitcroft 17468905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 17478905a67cSAndy Whitcroft $level++; 17488905a67cSAndy Whitcroft $type = '('; 17498905a67cSAndy Whitcroft } 17508905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 17518905a67cSAndy Whitcroft $level--; 17528905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 17538905a67cSAndy Whitcroft 17548905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 17558905a67cSAndy Whitcroft $coff = $off; 1756773647a0SAndy Whitcroft $coff_set = 1; 1757773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 17588905a67cSAndy Whitcroft } 17598905a67cSAndy Whitcroft } 17608905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 17618905a67cSAndy Whitcroft $level++; 17628905a67cSAndy Whitcroft $type = '{'; 17638905a67cSAndy Whitcroft } 17648905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 17658905a67cSAndy Whitcroft $level--; 17668905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 17678905a67cSAndy Whitcroft 17688905a67cSAndy Whitcroft if ($level == 0) { 1769b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1770b998e001SPatrick Pannuto $off++; 1771b998e001SPatrick Pannuto } 17728905a67cSAndy Whitcroft last; 17738905a67cSAndy Whitcroft } 17748905a67cSAndy Whitcroft } 1775f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1776f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1777f74bd194SAndy Whitcroft $level--; 1778f74bd194SAndy Whitcroft $type = ''; 1779f74bd194SAndy Whitcroft $off++; 1780f74bd194SAndy Whitcroft last; 1781f74bd194SAndy Whitcroft } 17828905a67cSAndy Whitcroft $off++; 17838905a67cSAndy Whitcroft } 1784a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 178513214adfSAndy Whitcroft if ($off == $len) { 1786a3bb97a7SAndy Whitcroft $loff = $len + 1; 178713214adfSAndy Whitcroft $line++; 178813214adfSAndy Whitcroft $remain--; 178913214adfSAndy Whitcroft } 17908905a67cSAndy Whitcroft 17918905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 17928905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 17938905a67cSAndy Whitcroft 17948905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 17958905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 17968905a67cSAndy Whitcroft 1797773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 179813214adfSAndy Whitcroft 179913214adfSAndy Whitcroft return ($statement, $condition, 180013214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 180113214adfSAndy Whitcroft} 180213214adfSAndy Whitcroft 1803cf655043SAndy Whitcroftsub statement_lines { 1804cf655043SAndy Whitcroft my ($stmt) = @_; 1805cf655043SAndy Whitcroft 1806cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1807cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1808cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1809cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1810cf655043SAndy Whitcroft 1811cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1812cf655043SAndy Whitcroft 1813cf655043SAndy Whitcroft return $#stmt_lines + 2; 1814cf655043SAndy Whitcroft} 1815cf655043SAndy Whitcroft 1816cf655043SAndy Whitcroftsub statement_rawlines { 1817cf655043SAndy Whitcroft my ($stmt) = @_; 1818cf655043SAndy Whitcroft 1819cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1820cf655043SAndy Whitcroft 1821cf655043SAndy Whitcroft return $#stmt_lines + 2; 1822cf655043SAndy Whitcroft} 1823cf655043SAndy Whitcroft 1824cf655043SAndy Whitcroftsub statement_block_size { 1825cf655043SAndy Whitcroft my ($stmt) = @_; 1826cf655043SAndy Whitcroft 1827cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1828cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1829cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1830cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1831cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1832cf655043SAndy Whitcroft 1833cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1834cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1835cf655043SAndy Whitcroft 1836cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1837cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1838cf655043SAndy Whitcroft 1839cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1840cf655043SAndy Whitcroft return $stmt_lines; 1841cf655043SAndy Whitcroft } else { 1842cf655043SAndy Whitcroft return $stmt_statements; 1843cf655043SAndy Whitcroft } 1844cf655043SAndy Whitcroft} 1845cf655043SAndy Whitcroft 184613214adfSAndy Whitcroftsub ctx_statement_full { 184713214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 184813214adfSAndy Whitcroft my ($statement, $condition, $level); 184913214adfSAndy Whitcroft 185013214adfSAndy Whitcroft my (@chunks); 185113214adfSAndy Whitcroft 1852cf655043SAndy Whitcroft # Grab the first conditional/block pair. 185313214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 185413214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1855773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 185613214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1857cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1858cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1859cf655043SAndy Whitcroft } 1860cf655043SAndy Whitcroft 1861cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1862cf655043SAndy Whitcroft # could continue the statement. 1863cf655043SAndy Whitcroft for (;;) { 186413214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 186513214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1866cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1867773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1868cf655043SAndy Whitcroft #print "C: push\n"; 1869cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 187013214adfSAndy Whitcroft } 187113214adfSAndy Whitcroft 187213214adfSAndy Whitcroft return ($level, $linenr, @chunks); 18738905a67cSAndy Whitcroft} 18748905a67cSAndy Whitcroft 18754a0df2efSAndy Whitcroftsub ctx_block_get { 1876f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 18774a0df2efSAndy Whitcroft my $line; 18784a0df2efSAndy Whitcroft my $start = $linenr - 1; 18794a0df2efSAndy Whitcroft my $blk = ''; 18804a0df2efSAndy Whitcroft my @o; 18814a0df2efSAndy Whitcroft my @c; 18824a0df2efSAndy Whitcroft my @res = (); 18834a0df2efSAndy Whitcroft 1884f0a594c1SAndy Whitcroft my $level = 0; 18854635f4fbSAndy Whitcroft my @stack = ($level); 188600df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 188700df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 188800df344fSAndy Whitcroft $remain--; 188900df344fSAndy Whitcroft 189000df344fSAndy Whitcroft $blk .= $rawlines[$line]; 18914635f4fbSAndy Whitcroft 18924635f4fbSAndy Whitcroft # Handle nested #if/#else. 189301464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 18944635f4fbSAndy Whitcroft push(@stack, $level); 189501464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 18964635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 189701464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 18984635f4fbSAndy Whitcroft $level = pop(@stack); 18994635f4fbSAndy Whitcroft } 19004635f4fbSAndy Whitcroft 190101464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1902f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1903f0a594c1SAndy Whitcroft if ($off > 0) { 1904f0a594c1SAndy Whitcroft $off--; 1905f0a594c1SAndy Whitcroft next; 1906f0a594c1SAndy Whitcroft } 19074a0df2efSAndy Whitcroft 1908f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1909f0a594c1SAndy Whitcroft $level--; 1910f0a594c1SAndy Whitcroft last if ($level == 0); 1911f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1912f0a594c1SAndy Whitcroft $level++; 1913f0a594c1SAndy Whitcroft } 1914f0a594c1SAndy Whitcroft } 19154a0df2efSAndy Whitcroft 1916f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 191700df344fSAndy Whitcroft push(@res, $rawlines[$line]); 19184a0df2efSAndy Whitcroft } 19194a0df2efSAndy Whitcroft 1920f0a594c1SAndy Whitcroft last if ($level == 0); 19214a0df2efSAndy Whitcroft } 19224a0df2efSAndy Whitcroft 1923f0a594c1SAndy Whitcroft return ($level, @res); 19244a0df2efSAndy Whitcroft} 19254a0df2efSAndy Whitcroftsub ctx_block_outer { 19264a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 19274a0df2efSAndy Whitcroft 1928f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1929f0a594c1SAndy Whitcroft return @r; 19304a0df2efSAndy Whitcroft} 19314a0df2efSAndy Whitcroftsub ctx_block { 19324a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 19334a0df2efSAndy Whitcroft 1934f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1935f0a594c1SAndy Whitcroft return @r; 1936653d4876SAndy Whitcroft} 1937653d4876SAndy Whitcroftsub ctx_statement { 1938f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1939f0a594c1SAndy Whitcroft 1940f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1941f0a594c1SAndy Whitcroft return @r; 1942f0a594c1SAndy Whitcroft} 1943f0a594c1SAndy Whitcroftsub ctx_block_level { 1944653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1945653d4876SAndy Whitcroft 1946f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 19474a0df2efSAndy Whitcroft} 19489c0ca6f9SAndy Whitcroftsub ctx_statement_level { 19499c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 19509c0ca6f9SAndy Whitcroft 19519c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 19529c0ca6f9SAndy Whitcroft} 19534a0df2efSAndy Whitcroft 19544a0df2efSAndy Whitcroftsub ctx_locate_comment { 19554a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 19564a0df2efSAndy Whitcroft 1957a55ee0ccSJoe Perches # If c99 comment on the current line, or the line before or after 1958a55ee0ccSJoe Perches my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@); 1959a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1960a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@); 1961a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1962a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@); 1963a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1964a55ee0ccSJoe Perches 19654a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1966a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 19674a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 19684a0df2efSAndy Whitcroft 19694a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 19704a0df2efSAndy Whitcroft # comment. 19714a0df2efSAndy Whitcroft my $in_comment = 0; 19724a0df2efSAndy Whitcroft $current_comment = ''; 19734a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 197400df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 197500df344fSAndy Whitcroft #warn " $line\n"; 19764a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 19774a0df2efSAndy Whitcroft $in_comment = 1; 19784a0df2efSAndy Whitcroft } 19794a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 19804a0df2efSAndy Whitcroft $in_comment = 1; 19814a0df2efSAndy Whitcroft } 19824a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 19834a0df2efSAndy Whitcroft $current_comment = ''; 19844a0df2efSAndy Whitcroft } 19854a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 19864a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 19874a0df2efSAndy Whitcroft $in_comment = 0; 19884a0df2efSAndy Whitcroft } 19894a0df2efSAndy Whitcroft } 19904a0df2efSAndy Whitcroft 19914a0df2efSAndy Whitcroft chomp($current_comment); 19924a0df2efSAndy Whitcroft return($current_comment); 19934a0df2efSAndy Whitcroft} 19944a0df2efSAndy Whitcroftsub ctx_has_comment { 19954a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 19964a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 19974a0df2efSAndy Whitcroft 199800df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 19994a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 20004a0df2efSAndy Whitcroft 20014a0df2efSAndy Whitcroft return ($cmt ne ''); 20024a0df2efSAndy Whitcroft} 20034a0df2efSAndy Whitcroft 20044d001e4dSAndy Whitcroftsub raw_line { 20054d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 20064d001e4dSAndy Whitcroft 20074d001e4dSAndy Whitcroft my $offset = $linenr - 1; 20084d001e4dSAndy Whitcroft $cnt++; 20094d001e4dSAndy Whitcroft 20104d001e4dSAndy Whitcroft my $line; 20114d001e4dSAndy Whitcroft while ($cnt) { 20124d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 20134d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 20144d001e4dSAndy Whitcroft $cnt--; 20154d001e4dSAndy Whitcroft } 20164d001e4dSAndy Whitcroft 20174d001e4dSAndy Whitcroft return $line; 20184d001e4dSAndy Whitcroft} 20194d001e4dSAndy Whitcroft 20202a9f9d85STobin C. Hardingsub get_stat_real { 20212a9f9d85STobin C. Harding my ($linenr, $lc) = @_; 20222a9f9d85STobin C. Harding 20232a9f9d85STobin C. Harding my $stat_real = raw_line($linenr, 0); 20242a9f9d85STobin C. Harding for (my $count = $linenr + 1; $count <= $lc; $count++) { 20252a9f9d85STobin C. Harding $stat_real = $stat_real . "\n" . raw_line($count, 0); 20262a9f9d85STobin C. Harding } 20272a9f9d85STobin C. Harding 20282a9f9d85STobin C. Harding return $stat_real; 20292a9f9d85STobin C. Harding} 20302a9f9d85STobin C. Harding 2031e3d95a2aSTobin C. Hardingsub get_stat_here { 2032e3d95a2aSTobin C. Harding my ($linenr, $cnt, $here) = @_; 2033e3d95a2aSTobin C. Harding 2034e3d95a2aSTobin C. Harding my $herectx = $here . "\n"; 2035e3d95a2aSTobin C. Harding for (my $n = 0; $n < $cnt; $n++) { 2036e3d95a2aSTobin C. Harding $herectx .= raw_line($linenr, $n) . "\n"; 2037e3d95a2aSTobin C. Harding } 2038e3d95a2aSTobin C. Harding 2039e3d95a2aSTobin C. Harding return $herectx; 2040e3d95a2aSTobin C. Harding} 2041e3d95a2aSTobin C. Harding 20420a920b5bSAndy Whitcroftsub cat_vet { 20430a920b5bSAndy Whitcroft my ($vet) = @_; 20449c0ca6f9SAndy Whitcroft my ($res, $coded); 20450a920b5bSAndy Whitcroft 20469c0ca6f9SAndy Whitcroft $res = ''; 20476c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 20486c72ffaaSAndy Whitcroft $res .= $1; 20496c72ffaaSAndy Whitcroft if ($2 ne '') { 20509c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 20516c72ffaaSAndy Whitcroft $res .= $coded; 20526c72ffaaSAndy Whitcroft } 20539c0ca6f9SAndy Whitcroft } 20549c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 20550a920b5bSAndy Whitcroft 20569c0ca6f9SAndy Whitcroft return $res; 20570a920b5bSAndy Whitcroft} 20580a920b5bSAndy Whitcroft 2059c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 2060cf655043SAndy Whitcroftmy $av_pending; 2061c2fdda0dSAndy Whitcroftmy @av_paren_type; 20621f65f947SAndy Whitcroftmy $av_pend_colon; 2063c2fdda0dSAndy Whitcroft 2064c2fdda0dSAndy Whitcroftsub annotate_reset { 2065c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 2066cf655043SAndy Whitcroft $av_pending = '_'; 2067cf655043SAndy Whitcroft @av_paren_type = ('E'); 20681f65f947SAndy Whitcroft $av_pend_colon = 'O'; 2069c2fdda0dSAndy Whitcroft} 2070c2fdda0dSAndy Whitcroft 20716c72ffaaSAndy Whitcroftsub annotate_values { 20726c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 20736c72ffaaSAndy Whitcroft 20746c72ffaaSAndy Whitcroft my $res; 20751f65f947SAndy Whitcroft my $var = '_' x length($stream); 20766c72ffaaSAndy Whitcroft my $cur = $stream; 20776c72ffaaSAndy Whitcroft 2078c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 20796c72ffaaSAndy Whitcroft 20806c72ffaaSAndy Whitcroft while (length($cur)) { 2081773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 2082cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 2083171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 20846c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 2085c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 2086c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 2087cf655043SAndy Whitcroft $type = pop(@av_paren_type); 2088c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 20896c72ffaaSAndy Whitcroft } 20906c72ffaaSAndy Whitcroft 2091c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 20929446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 20939446ef56SAndy Whitcroft push(@av_paren_type, $type); 2094addcdceaSAndy Whitcroft $type = 'c'; 20959446ef56SAndy Whitcroft 2096e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 2097c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 20986c72ffaaSAndy Whitcroft $type = 'T'; 20996c72ffaaSAndy Whitcroft 2100389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 2101389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 2102389a2fe5SAndy Whitcroft $type = 'T'; 2103389a2fe5SAndy Whitcroft 2104c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 2105171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 2106c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 2107171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 2108171ae1a4SAndy Whitcroft if ($2 ne '') { 2109cf655043SAndy Whitcroft $av_pending = 'N'; 2110171ae1a4SAndy Whitcroft } 2111171ae1a4SAndy Whitcroft $type = 'E'; 2112171ae1a4SAndy Whitcroft 2113c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 2114171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 2115171ae1a4SAndy Whitcroft $av_preprocessor = 1; 2116171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 21176c72ffaaSAndy Whitcroft 2118c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 2119cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 2120c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 2121cf655043SAndy Whitcroft 2122cf655043SAndy Whitcroft push(@av_paren_type, $type); 2123cf655043SAndy Whitcroft push(@av_paren_type, $type); 2124171ae1a4SAndy Whitcroft $type = 'E'; 2125cf655043SAndy Whitcroft 2126c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 2127cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 2128cf655043SAndy Whitcroft $av_preprocessor = 1; 2129cf655043SAndy Whitcroft 2130cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 2131cf655043SAndy Whitcroft 2132171ae1a4SAndy Whitcroft $type = 'E'; 2133cf655043SAndy Whitcroft 2134c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 2135cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 2136cf655043SAndy Whitcroft 2137cf655043SAndy Whitcroft $av_preprocessor = 1; 2138cf655043SAndy Whitcroft 2139cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 2140cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 2141cf655043SAndy Whitcroft pop(@av_paren_type); 2142cf655043SAndy Whitcroft push(@av_paren_type, $type); 2143171ae1a4SAndy Whitcroft $type = 'E'; 21446c72ffaaSAndy Whitcroft 21456c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 2146c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 21476c72ffaaSAndy Whitcroft 2148171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 2149171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 2150171ae1a4SAndy Whitcroft $av_pending = $type; 2151171ae1a4SAndy Whitcroft $type = 'N'; 2152171ae1a4SAndy Whitcroft 21536c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 2154c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 21556c72ffaaSAndy Whitcroft if (defined $2) { 2156cf655043SAndy Whitcroft $av_pending = 'V'; 21576c72ffaaSAndy Whitcroft } 21586c72ffaaSAndy Whitcroft $type = 'N'; 21596c72ffaaSAndy Whitcroft 216014b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 2161c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 216214b111c1SAndy Whitcroft $av_pending = 'E'; 21636c72ffaaSAndy Whitcroft $type = 'N'; 21646c72ffaaSAndy Whitcroft 21651f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 21661f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 21671f65f947SAndy Whitcroft $av_pend_colon = 'C'; 21681f65f947SAndy Whitcroft $type = 'N'; 21691f65f947SAndy Whitcroft 217014b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 2171c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 21726c72ffaaSAndy Whitcroft $type = 'N'; 21736c72ffaaSAndy Whitcroft 21746c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 2175c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 2176cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 2177cf655043SAndy Whitcroft $av_pending = '_'; 21786c72ffaaSAndy Whitcroft $type = 'N'; 21796c72ffaaSAndy Whitcroft 21806c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 2181cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 2182cf655043SAndy Whitcroft if ($new_type ne '_') { 2183cf655043SAndy Whitcroft $type = $new_type; 2184c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 2185c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 21866c72ffaaSAndy Whitcroft } else { 2187c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 21886c72ffaaSAndy Whitcroft } 21896c72ffaaSAndy Whitcroft 2190c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 2191c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 2192c8cb2ca3SAndy Whitcroft $type = 'V'; 2193cf655043SAndy Whitcroft $av_pending = 'V'; 21946c72ffaaSAndy Whitcroft 21958e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 21968e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 21971f65f947SAndy Whitcroft $av_pend_colon = 'B'; 21988e761b04SAndy Whitcroft } elsif ($type eq 'E') { 21998e761b04SAndy Whitcroft $av_pend_colon = 'L'; 22001f65f947SAndy Whitcroft } 22011f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 22021f65f947SAndy Whitcroft $type = 'V'; 22031f65f947SAndy Whitcroft 22046c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 2205c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 22066c72ffaaSAndy Whitcroft $type = 'V'; 22076c72ffaaSAndy Whitcroft 22086c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 2209c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 22106c72ffaaSAndy Whitcroft $type = 'N'; 22116c72ffaaSAndy Whitcroft 2212cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 2213c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 221413214adfSAndy Whitcroft $type = 'E'; 22151f65f947SAndy Whitcroft $av_pend_colon = 'O'; 221613214adfSAndy Whitcroft 22178e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 22188e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 22198e761b04SAndy Whitcroft $type = 'C'; 22208e761b04SAndy Whitcroft 22211f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 22221f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 22231f65f947SAndy Whitcroft $type = 'N'; 22241f65f947SAndy Whitcroft 22251f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 22261f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 22271f65f947SAndy Whitcroft 22281f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 22291f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 22301f65f947SAndy Whitcroft $type = 'E'; 22311f65f947SAndy Whitcroft } else { 22321f65f947SAndy Whitcroft $type = 'N'; 22331f65f947SAndy Whitcroft } 22341f65f947SAndy Whitcroft $av_pend_colon = 'O'; 22351f65f947SAndy Whitcroft 22368e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 223713214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 22386c72ffaaSAndy Whitcroft $type = 'N'; 22396c72ffaaSAndy Whitcroft 22400d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 224174048ed8SAndy Whitcroft my $variant; 224274048ed8SAndy Whitcroft 224374048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 224474048ed8SAndy Whitcroft if ($type eq 'V') { 224574048ed8SAndy Whitcroft $variant = 'B'; 224674048ed8SAndy Whitcroft } else { 224774048ed8SAndy Whitcroft $variant = 'U'; 224874048ed8SAndy Whitcroft } 224974048ed8SAndy Whitcroft 225074048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 225174048ed8SAndy Whitcroft $type = 'N'; 225274048ed8SAndy Whitcroft 22536c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 2254c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 22556c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 22566c72ffaaSAndy Whitcroft $type = 'N'; 22576c72ffaaSAndy Whitcroft } 22586c72ffaaSAndy Whitcroft 22596c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 2260c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 22616c72ffaaSAndy Whitcroft } 22626c72ffaaSAndy Whitcroft if (defined $1) { 22636c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 22646c72ffaaSAndy Whitcroft $res .= $type x length($1); 22656c72ffaaSAndy Whitcroft } 22666c72ffaaSAndy Whitcroft } 22676c72ffaaSAndy Whitcroft 22681f65f947SAndy Whitcroft return ($res, $var); 22696c72ffaaSAndy Whitcroft} 22706c72ffaaSAndy Whitcroft 22718905a67cSAndy Whitcroftsub possible { 227213214adfSAndy Whitcroft my ($possible, $line) = @_; 22739a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 22740776e594SAndy Whitcroft ^(?: 22750776e594SAndy Whitcroft $Modifier| 22760776e594SAndy Whitcroft $Storage| 22770776e594SAndy Whitcroft $Type| 22789a974fdbSAndy Whitcroft DEFINE_\S+ 22799a974fdbSAndy Whitcroft )$| 22809a974fdbSAndy Whitcroft ^(?: 22810776e594SAndy Whitcroft goto| 22820776e594SAndy Whitcroft return| 22830776e594SAndy Whitcroft case| 22840776e594SAndy Whitcroft else| 22850776e594SAndy Whitcroft asm|__asm__| 228689a88353SAndy Whitcroft do| 228789a88353SAndy Whitcroft \#| 228889a88353SAndy Whitcroft \#\#| 22899a974fdbSAndy Whitcroft )(?:\s|$)| 22900776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 22919a974fdbSAndy Whitcroft )}x; 22929a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 22939a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 2294c45dcabdSAndy Whitcroft # Check for modifiers. 2295c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 2296c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 2297c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 2298c45dcabdSAndy Whitcroft 2299c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 2300c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 2301d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 23029a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 2303d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 2304485ff23eSAlex Dowad push(@modifierListFile, $modifier); 2305d2506586SAndy Whitcroft } 23069a974fdbSAndy Whitcroft } 2307c45dcabdSAndy Whitcroft 2308c45dcabdSAndy Whitcroft } else { 230913214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 2310485ff23eSAlex Dowad push(@typeListFile, $possible); 2311c45dcabdSAndy Whitcroft } 23128905a67cSAndy Whitcroft build_types(); 23130776e594SAndy Whitcroft } else { 23140776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 23158905a67cSAndy Whitcroft } 23168905a67cSAndy Whitcroft} 23178905a67cSAndy Whitcroft 23186c72ffaaSAndy Whitcroftmy $prefix = ''; 23196c72ffaaSAndy Whitcroft 2320000d1cc1SJoe Perchessub show_type { 2321cbec18afSJoe Perches my ($type) = @_; 232291bfe484SJoe Perches 2323522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 2324522b837cSAlexey Dobriyan 2325cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 2326cbec18afSJoe Perches 2327cbec18afSJoe Perches return !defined $ignore_type{$type}; 2328000d1cc1SJoe Perches} 2329000d1cc1SJoe Perches 2330f0a594c1SAndy Whitcroftsub report { 2331cbec18afSJoe Perches my ($level, $type, $msg) = @_; 2332cbec18afSJoe Perches 2333cbec18afSJoe Perches if (!show_type($type) || 2334cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 2335773647a0SAndy Whitcroft return 0; 2336773647a0SAndy Whitcroft } 233757230297SJoe Perches my $output = ''; 2338737c0767SJohn Brooks if ($color) { 233957230297SJoe Perches if ($level eq 'ERROR') { 234057230297SJoe Perches $output .= RED; 234157230297SJoe Perches } elsif ($level eq 'WARNING') { 234257230297SJoe Perches $output .= YELLOW; 2343000d1cc1SJoe Perches } else { 234457230297SJoe Perches $output .= GREEN; 2345000d1cc1SJoe Perches } 234657230297SJoe Perches } 234757230297SJoe Perches $output .= $prefix . $level . ':'; 234857230297SJoe Perches if ($show_types) { 2349737c0767SJohn Brooks $output .= BLUE if ($color); 235057230297SJoe Perches $output .= "$type:"; 235157230297SJoe Perches } 2352737c0767SJohn Brooks $output .= RESET if ($color); 235357230297SJoe Perches $output .= ' ' . $msg . "\n"; 235434d8815fSJoe Perches 235534d8815fSJoe Perches if ($showfile) { 235634d8815fSJoe Perches my @lines = split("\n", $output, -1); 235734d8815fSJoe Perches splice(@lines, 1, 1); 235834d8815fSJoe Perches $output = join("\n", @lines); 235934d8815fSJoe Perches } 236052178ce0SDwaipayan Ray 236152178ce0SDwaipayan Ray if ($terse) { 236252178ce0SDwaipayan Ray $output = (split('\n', $output))[0] . "\n"; 236352178ce0SDwaipayan Ray } 236452178ce0SDwaipayan Ray 236552178ce0SDwaipayan Ray if ($verbose && exists($verbose_messages{$type}) && 236652178ce0SDwaipayan Ray !exists($verbose_emitted{$type})) { 236752178ce0SDwaipayan Ray $output .= $verbose_messages{$type} . "\n\n"; 236852178ce0SDwaipayan Ray $verbose_emitted{$type} = 1; 236952178ce0SDwaipayan Ray } 23708905a67cSAndy Whitcroft 237157230297SJoe Perches push(our @report, $output); 2372773647a0SAndy Whitcroft 2373773647a0SAndy Whitcroft return 1; 2374f0a594c1SAndy Whitcroft} 2375cbec18afSJoe Perches 2376f0a594c1SAndy Whitcroftsub report_dump { 237713214adfSAndy Whitcroft our @report; 2378f0a594c1SAndy Whitcroft} 2379000d1cc1SJoe Perches 2380d752fcc8SJoe Perchessub fixup_current_range { 2381d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 2382d752fcc8SJoe Perches 2383d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 2384d752fcc8SJoe Perches my $o = $1; 2385d752fcc8SJoe Perches my $l = $2; 2386d752fcc8SJoe Perches my $no = $o + $offset; 2387d752fcc8SJoe Perches my $nl = $l + $length; 2388d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 2389d752fcc8SJoe Perches } 2390d752fcc8SJoe Perches} 2391d752fcc8SJoe Perches 2392d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 2393d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 2394d752fcc8SJoe Perches 2395d752fcc8SJoe Perches my $range_last_linenr = 0; 2396d752fcc8SJoe Perches my $delta_offset = 0; 2397d752fcc8SJoe Perches 2398d752fcc8SJoe Perches my $old_linenr = 0; 2399d752fcc8SJoe Perches my $new_linenr = 0; 2400d752fcc8SJoe Perches 2401d752fcc8SJoe Perches my $next_insert = 0; 2402d752fcc8SJoe Perches my $next_delete = 0; 2403d752fcc8SJoe Perches 2404d752fcc8SJoe Perches my @lines = (); 2405d752fcc8SJoe Perches 2406d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 2407d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 2408d752fcc8SJoe Perches 2409d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 2410d752fcc8SJoe Perches my $save_line = 1; 2411d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 2412323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2413d752fcc8SJoe Perches $delta_offset = 0; 2414d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2415d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 2416d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 2417d752fcc8SJoe Perches } 2418d752fcc8SJoe Perches 2419d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2420d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 2421d752fcc8SJoe Perches $save_line = 0; 2422d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2423d752fcc8SJoe Perches } 2424d752fcc8SJoe Perches 2425d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2426d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 2427d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 2428d752fcc8SJoe Perches $new_linenr++; 2429d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2430d752fcc8SJoe Perches } 2431d752fcc8SJoe Perches 2432d752fcc8SJoe Perches if ($save_line) { 2433d752fcc8SJoe Perches push(@lines, $line); 2434d752fcc8SJoe Perches $new_linenr++; 2435d752fcc8SJoe Perches } 2436d752fcc8SJoe Perches 2437d752fcc8SJoe Perches $old_linenr++; 2438d752fcc8SJoe Perches } 2439d752fcc8SJoe Perches 2440d752fcc8SJoe Perches return @lines; 2441d752fcc8SJoe Perches} 2442d752fcc8SJoe Perches 2443f2d7e4d4SJoe Perchessub fix_insert_line { 2444f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2445f2d7e4d4SJoe Perches 2446f2d7e4d4SJoe Perches my $inserted = { 2447f2d7e4d4SJoe Perches LINENR => $linenr, 2448f2d7e4d4SJoe Perches LINE => $line, 2449f2d7e4d4SJoe Perches }; 2450f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2451f2d7e4d4SJoe Perches} 2452f2d7e4d4SJoe Perches 2453f2d7e4d4SJoe Perchessub fix_delete_line { 2454f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2455f2d7e4d4SJoe Perches 2456f2d7e4d4SJoe Perches my $deleted = { 2457f2d7e4d4SJoe Perches LINENR => $linenr, 2458f2d7e4d4SJoe Perches LINE => $line, 2459f2d7e4d4SJoe Perches }; 2460f2d7e4d4SJoe Perches 2461f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2462f2d7e4d4SJoe Perches} 2463f2d7e4d4SJoe Perches 2464de7d4f0eSAndy Whitcroftsub ERROR { 2465cbec18afSJoe Perches my ($type, $msg) = @_; 2466cbec18afSJoe Perches 2467cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2468de7d4f0eSAndy Whitcroft our $clean = 0; 24696c72ffaaSAndy Whitcroft our $cnt_error++; 24703705ce5bSJoe Perches return 1; 2471de7d4f0eSAndy Whitcroft } 24723705ce5bSJoe Perches return 0; 2473773647a0SAndy Whitcroft} 2474de7d4f0eSAndy Whitcroftsub WARN { 2475cbec18afSJoe Perches my ($type, $msg) = @_; 2476cbec18afSJoe Perches 2477cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2478de7d4f0eSAndy Whitcroft our $clean = 0; 24796c72ffaaSAndy Whitcroft our $cnt_warn++; 24803705ce5bSJoe Perches return 1; 2481de7d4f0eSAndy Whitcroft } 24823705ce5bSJoe Perches return 0; 2483773647a0SAndy Whitcroft} 2484de7d4f0eSAndy Whitcroftsub CHK { 2485cbec18afSJoe Perches my ($type, $msg) = @_; 2486cbec18afSJoe Perches 2487cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2488de7d4f0eSAndy Whitcroft our $clean = 0; 24896c72ffaaSAndy Whitcroft our $cnt_chk++; 24903705ce5bSJoe Perches return 1; 24916c72ffaaSAndy Whitcroft } 24923705ce5bSJoe Perches return 0; 2493de7d4f0eSAndy Whitcroft} 2494de7d4f0eSAndy Whitcroft 24956ecd9674SAndy Whitcroftsub check_absolute_file { 24966ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 24976ecd9674SAndy Whitcroft my $file = $absolute; 24986ecd9674SAndy Whitcroft 24996ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 25006ecd9674SAndy Whitcroft 25016ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 25026ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 25036ecd9674SAndy Whitcroft if (-f "$root/$file") { 25046ecd9674SAndy Whitcroft ##print "file<$file>\n"; 25056ecd9674SAndy Whitcroft last; 25066ecd9674SAndy Whitcroft } 25076ecd9674SAndy Whitcroft } 25086ecd9674SAndy Whitcroft if (! -f _) { 25096ecd9674SAndy Whitcroft return 0; 25106ecd9674SAndy Whitcroft } 25116ecd9674SAndy Whitcroft 25126ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 25136ecd9674SAndy Whitcroft my $prefix = $absolute; 25146ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 25156ecd9674SAndy Whitcroft 25166ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 25176ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2518000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2519000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 25206ecd9674SAndy Whitcroft } 25216ecd9674SAndy Whitcroft} 25226ecd9674SAndy Whitcroft 25233705ce5bSJoe Perchessub trim { 25243705ce5bSJoe Perches my ($string) = @_; 25253705ce5bSJoe Perches 2526b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2527b34c648bSJoe Perches 2528b34c648bSJoe Perches return $string; 2529b34c648bSJoe Perches} 2530b34c648bSJoe Perches 2531b34c648bSJoe Perchessub ltrim { 2532b34c648bSJoe Perches my ($string) = @_; 2533b34c648bSJoe Perches 2534b34c648bSJoe Perches $string =~ s/^\s+//; 2535b34c648bSJoe Perches 2536b34c648bSJoe Perches return $string; 2537b34c648bSJoe Perches} 2538b34c648bSJoe Perches 2539b34c648bSJoe Perchessub rtrim { 2540b34c648bSJoe Perches my ($string) = @_; 2541b34c648bSJoe Perches 2542b34c648bSJoe Perches $string =~ s/\s+$//; 25433705ce5bSJoe Perches 25443705ce5bSJoe Perches return $string; 25453705ce5bSJoe Perches} 25463705ce5bSJoe Perches 254752ea8506SJoe Perchessub string_find_replace { 254852ea8506SJoe Perches my ($string, $find, $replace) = @_; 254952ea8506SJoe Perches 255052ea8506SJoe Perches $string =~ s/$find/$replace/g; 255152ea8506SJoe Perches 255252ea8506SJoe Perches return $string; 255352ea8506SJoe Perches} 255452ea8506SJoe Perches 25553705ce5bSJoe Perchessub tabify { 25563705ce5bSJoe Perches my ($leading) = @_; 25573705ce5bSJoe Perches 2558713a09deSAntonio Borneo my $source_indent = $tabsize; 25593705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 25603705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 25613705ce5bSJoe Perches 25623705ce5bSJoe Perches #convert leading spaces to tabs 25633705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 25643705ce5bSJoe Perches #Remove spaces before a tab 25653705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 25663705ce5bSJoe Perches 25673705ce5bSJoe Perches return "$leading"; 25683705ce5bSJoe Perches} 25693705ce5bSJoe Perches 2570d1fe9c09SJoe Perchessub pos_last_openparen { 2571d1fe9c09SJoe Perches my ($line) = @_; 2572d1fe9c09SJoe Perches 2573d1fe9c09SJoe Perches my $pos = 0; 2574d1fe9c09SJoe Perches 2575d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2576d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2577d1fe9c09SJoe Perches 2578d1fe9c09SJoe Perches my $last_openparen = 0; 2579d1fe9c09SJoe Perches 2580d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2581d1fe9c09SJoe Perches return -1; 2582d1fe9c09SJoe Perches } 2583d1fe9c09SJoe Perches 2584d1fe9c09SJoe Perches my $len = length($line); 2585d1fe9c09SJoe Perches 2586d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2587d1fe9c09SJoe Perches my $string = substr($line, $pos); 2588d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2589d1fe9c09SJoe Perches $pos += length($1) - 1; 2590d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2591d1fe9c09SJoe Perches $last_openparen = $pos; 2592d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2593d1fe9c09SJoe Perches last; 2594d1fe9c09SJoe Perches } 2595d1fe9c09SJoe Perches } 2596d1fe9c09SJoe Perches 259791cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2598d1fe9c09SJoe Perches} 2599d1fe9c09SJoe Perches 2600f36d3eb8SJoe Perchessub get_raw_comment { 2601f36d3eb8SJoe Perches my ($line, $rawline) = @_; 2602f36d3eb8SJoe Perches my $comment = ''; 2603f36d3eb8SJoe Perches 2604f36d3eb8SJoe Perches for my $i (0 .. (length($line) - 1)) { 2605f36d3eb8SJoe Perches if (substr($line, $i, 1) eq "$;") { 2606f36d3eb8SJoe Perches $comment .= substr($rawline, $i, 1); 2607f36d3eb8SJoe Perches } 2608f36d3eb8SJoe Perches } 2609f36d3eb8SJoe Perches 2610f36d3eb8SJoe Perches return $comment; 2611f36d3eb8SJoe Perches} 2612f36d3eb8SJoe Perches 26135b8f82e1SSong Liusub exclude_global_initialisers { 26145b8f82e1SSong Liu my ($realfile) = @_; 26155b8f82e1SSong Liu 26165b8f82e1SSong Liu # Do not check for BPF programs (tools/testing/selftests/bpf/progs/*.c, samples/bpf/*_kern.c, *.bpf.c). 26175b8f82e1SSong Liu return $realfile =~ m@^tools/testing/selftests/bpf/progs/.*\.c$@ || 26185b8f82e1SSong Liu $realfile =~ m@^samples/bpf/.*_kern\.c$@ || 26195b8f82e1SSong Liu $realfile =~ m@/bpf/.*\.bpf\.c$@; 26205b8f82e1SSong Liu} 26215b8f82e1SSong Liu 26220a920b5bSAndy Whitcroftsub process { 26230a920b5bSAndy Whitcroft my $filename = shift; 26240a920b5bSAndy Whitcroft 26250a920b5bSAndy Whitcroft my $linenr=0; 26260a920b5bSAndy Whitcroft my $prevline=""; 2627c2fdda0dSAndy Whitcroft my $prevrawline=""; 26280a920b5bSAndy Whitcroft my $stashline=""; 2629c2fdda0dSAndy Whitcroft my $stashrawline=""; 26300a920b5bSAndy Whitcroft 26314a0df2efSAndy Whitcroft my $length; 26320a920b5bSAndy Whitcroft my $indent; 26330a920b5bSAndy Whitcroft my $previndent=0; 26340a920b5bSAndy Whitcroft my $stashindent=0; 26350a920b5bSAndy Whitcroft 2636de7d4f0eSAndy Whitcroft our $clean = 1; 26370a920b5bSAndy Whitcroft my $signoff = 0; 2638cd261496SGeert Uytterhoeven my $author = ''; 2639cd261496SGeert Uytterhoeven my $authorsignoff = 0; 264048ca2d8aSDwaipayan Ray my $author_sob = ''; 26410a920b5bSAndy Whitcroft my $is_patch = 0; 2642133712a2SRob Herring my $is_binding_patch = -1; 264329ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 264415662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 264544d303ebSJoe Perches my $has_patch_separator = 0; #Found a --- line 2646ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2647490b292cSJoe Perches my $commit_log_lines = 0; #Number of commit log lines 2648bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 26492a076f40SJoe Perches my $commit_log_long_line = 0; 2650e518e9a5SJoe Perches my $commit_log_has_diff = 0; 265113f1937eSJoe Perches my $reported_maintainer_file = 0; 2652fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2653fa64205dSPasi Savanainen 26544ce9f970SJoe Perches my $last_git_commit_id_linenr = -1; 26554ce9f970SJoe Perches 2656365dd4eaSJoe Perches my $last_blank_line = 0; 26575e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2658365dd4eaSJoe Perches 265913214adfSAndy Whitcroft our @report = (); 26606c72ffaaSAndy Whitcroft our $cnt_lines = 0; 26616c72ffaaSAndy Whitcroft our $cnt_error = 0; 26626c72ffaaSAndy Whitcroft our $cnt_warn = 0; 26636c72ffaaSAndy Whitcroft our $cnt_chk = 0; 26646c72ffaaSAndy Whitcroft 26650a920b5bSAndy Whitcroft # Trace the real file/line as we go. 26660a920b5bSAndy Whitcroft my $realfile = ''; 26670a920b5bSAndy Whitcroft my $realline = 0; 26680a920b5bSAndy Whitcroft my $realcnt = 0; 26690a920b5bSAndy Whitcroft my $here = ''; 267077cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 26710a920b5bSAndy Whitcroft my $in_comment = 0; 2672c2fdda0dSAndy Whitcroft my $comment_edge = 0; 26730a920b5bSAndy Whitcroft my $first_line = 0; 26741e855726SWolfram Sang my $p1_prefix = ''; 26750a920b5bSAndy Whitcroft 267613214adfSAndy Whitcroft my $prev_values = 'E'; 267713214adfSAndy Whitcroft 267813214adfSAndy Whitcroft # suppression flags 2679773647a0SAndy Whitcroft my %suppress_ifbraces; 2680170d3a22SAndy Whitcroft my %suppress_whiletrailers; 26812b474a1aSAndy Whitcroft my %suppress_export; 26823e469cdcSAndy Whitcroft my $suppress_statement = 0; 2683653d4876SAndy Whitcroft 26847e51f197SJoe Perches my %signatures = (); 2685323c1260SJoe Perches 2686c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2687de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2688c2fdda0dSAndy Whitcroft # 2689de7d4f0eSAndy Whitcroft my @setup_docs = (); 2690de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2691773647a0SAndy Whitcroft 2692d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2693d8b07710SJoe Perches 26949f3a8992SRob Herring my $checklicenseline = 1; 26959f3a8992SRob Herring 2696773647a0SAndy Whitcroft sanitise_line_reset(); 2697c2fdda0dSAndy Whitcroft my $line; 2698c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2699773647a0SAndy Whitcroft $linenr++; 2700773647a0SAndy Whitcroft $line = $rawline; 2701c2fdda0dSAndy Whitcroft 27023705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 27033705ce5bSJoe Perches 2704773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2705de7d4f0eSAndy Whitcroft $setup_docs = 0; 27062581ac7cSTim Froidcoeur if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) { 2707de7d4f0eSAndy Whitcroft $setup_docs = 1; 2708de7d4f0eSAndy Whitcroft } 2709773647a0SAndy Whitcroft #next; 2710de7d4f0eSAndy Whitcroft } 271174fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2712773647a0SAndy Whitcroft $realline=$1-1; 2713773647a0SAndy Whitcroft if (defined $2) { 2714773647a0SAndy Whitcroft $realcnt=$3+1; 2715773647a0SAndy Whitcroft } else { 2716773647a0SAndy Whitcroft $realcnt=1+1; 2717773647a0SAndy Whitcroft } 2718c45dcabdSAndy Whitcroft $in_comment = 0; 2719773647a0SAndy Whitcroft 2720773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2721773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2722773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2723773647a0SAndy Whitcroft # at context start. 2724773647a0SAndy Whitcroft my $edge; 272501fa9147SAndy Whitcroft my $cnt = $realcnt; 272601fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 272701fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 272801fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 272901fa9147SAndy Whitcroft $cnt--; 273001fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2731721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2732fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2733fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2734fae17daeSAndy Whitcroft ($edge) = $1; 2735fae17daeSAndy Whitcroft last; 2736fae17daeSAndy Whitcroft } 2737773647a0SAndy Whitcroft } 2738773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2739773647a0SAndy Whitcroft $in_comment = 1; 2740773647a0SAndy Whitcroft } 2741773647a0SAndy Whitcroft 2742773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2743773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2744773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2745773647a0SAndy Whitcroft if (!defined $edge && 274683242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2747773647a0SAndy Whitcroft { 2748773647a0SAndy Whitcroft $in_comment = 1; 2749773647a0SAndy Whitcroft } 2750773647a0SAndy Whitcroft 2751773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2752773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2753773647a0SAndy Whitcroft 2754171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2755773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2756171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2757773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2758773647a0SAndy Whitcroft } 2759773647a0SAndy Whitcroft push(@lines, $line); 2760773647a0SAndy Whitcroft 2761773647a0SAndy Whitcroft if ($realcnt > 1) { 2762773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2763773647a0SAndy Whitcroft } else { 2764773647a0SAndy Whitcroft $realcnt = 0; 2765773647a0SAndy Whitcroft } 2766773647a0SAndy Whitcroft 2767773647a0SAndy Whitcroft #print "==>$rawline\n"; 2768773647a0SAndy Whitcroft #print "-->$line\n"; 2769de7d4f0eSAndy Whitcroft 2770de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2771de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2772de7d4f0eSAndy Whitcroft } 2773de7d4f0eSAndy Whitcroft } 2774de7d4f0eSAndy Whitcroft 27756c72ffaaSAndy Whitcroft $prefix = ''; 27766c72ffaaSAndy Whitcroft 2777773647a0SAndy Whitcroft $realcnt = 0; 2778773647a0SAndy Whitcroft $linenr = 0; 2779194f66fcSJoe Perches $fixlinenr = -1; 27800a920b5bSAndy Whitcroft foreach my $line (@lines) { 27810a920b5bSAndy Whitcroft $linenr++; 2782194f66fcSJoe Perches $fixlinenr++; 27831b5539b1SJoe Perches my $sline = $line; #copy of $line 27841b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 27850a920b5bSAndy Whitcroft 2786c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 2787f36d3eb8SJoe Perches my $raw_comment = get_raw_comment($line, $rawline); 27886c72ffaaSAndy Whitcroft 278912c253abSJoe Perches# check if it's a mode change, rename or start of a patch 279012c253abSJoe Perches if (!$in_commit_log && 279112c253abSJoe Perches ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 279212c253abSJoe Perches ($line =~ /^rename (?:from|to) \S+\s*$/ || 279312c253abSJoe Perches $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 279412c253abSJoe Perches $is_patch = 1; 279512c253abSJoe Perches } 279612c253abSJoe Perches 27970a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2798e518e9a5SJoe Perches if (!$in_commit_log && 279974fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 280074fd4f34SJoe Perches my $context = $4; 28010a920b5bSAndy Whitcroft $is_patch = 1; 28024a0df2efSAndy Whitcroft $first_line = $linenr + 1; 28030a920b5bSAndy Whitcroft $realline=$1-1; 28040a920b5bSAndy Whitcroft if (defined $2) { 28050a920b5bSAndy Whitcroft $realcnt=$3+1; 28060a920b5bSAndy Whitcroft } else { 28070a920b5bSAndy Whitcroft $realcnt=1+1; 28080a920b5bSAndy Whitcroft } 2809c2fdda0dSAndy Whitcroft annotate_reset(); 281013214adfSAndy Whitcroft $prev_values = 'E'; 281113214adfSAndy Whitcroft 2812773647a0SAndy Whitcroft %suppress_ifbraces = (); 2813170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 28142b474a1aSAndy Whitcroft %suppress_export = (); 28153e469cdcSAndy Whitcroft $suppress_statement = 0; 281674fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 281774fd4f34SJoe Perches $context_function = $1; 281874fd4f34SJoe Perches } else { 281974fd4f34SJoe Perches undef $context_function; 282074fd4f34SJoe Perches } 28210a920b5bSAndy Whitcroft next; 28220a920b5bSAndy Whitcroft 28234a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 28244a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 28254a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2826773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 28270a920b5bSAndy Whitcroft $realline++; 2828d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 28290a920b5bSAndy Whitcroft 28304a0df2efSAndy Whitcroft # Measure the line length and indent. 2831c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 28320a920b5bSAndy Whitcroft 28330a920b5bSAndy Whitcroft # Track the previous line. 28340a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 28350a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2836c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2837c2fdda0dSAndy Whitcroft 2838773647a0SAndy Whitcroft #warn "line<$line>\n"; 28396c72ffaaSAndy Whitcroft 2840d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2841d8aaf121SAndy Whitcroft $realcnt--; 28420a920b5bSAndy Whitcroft } 28430a920b5bSAndy Whitcroft 2844cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2845cc77cdcaSAndy Whitcroft 28466c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 28476c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2848773647a0SAndy Whitcroft 28492ac73b4fSJoe Perches my $found_file = 0; 2850773647a0SAndy Whitcroft # extract the filename as it passes 28513bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 28523bf9a009SRabin Vincent $realfile = $1; 28532b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2854270c49a0SJoe Perches $in_commit_log = 0; 28552ac73b4fSJoe Perches $found_file = 1; 28563bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2857773647a0SAndy Whitcroft $realfile = $1; 28582b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2859270c49a0SJoe Perches $in_commit_log = 0; 28601e855726SWolfram Sang 28611e855726SWolfram Sang $p1_prefix = $1; 2862e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2863e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2864000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2865000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 28661e855726SWolfram Sang } 2867773647a0SAndy Whitcroft 2868c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2869000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2870000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2871773647a0SAndy Whitcroft } 28722ac73b4fSJoe Perches $found_file = 1; 28732ac73b4fSJoe Perches } 28742ac73b4fSJoe Perches 287534d8815fSJoe Perches#make up the handle for any error we report on this line 287634d8815fSJoe Perches if ($showfile) { 287734d8815fSJoe Perches $prefix = "$realfile:$realline: " 287834d8815fSJoe Perches } elsif ($emacs) { 28797d3a9f67SJoe Perches if ($file) { 28807d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 28817d3a9f67SJoe Perches } else { 288234d8815fSJoe Perches $prefix = "$filename:$linenr: "; 288334d8815fSJoe Perches } 28847d3a9f67SJoe Perches } 288534d8815fSJoe Perches 28862ac73b4fSJoe Perches if ($found_file) { 288785b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 288885b0ee18SJoe Perches WARN("OBSOLETE", 288985b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 289085b0ee18SJoe Perches } 28917bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 28922ac73b4fSJoe Perches $check = 1; 28932ac73b4fSJoe Perches } else { 28942ac73b4fSJoe Perches $check = $check_orig; 28952ac73b4fSJoe Perches } 28969f3a8992SRob Herring $checklicenseline = 1; 2897133712a2SRob Herring 2898133712a2SRob Herring if ($realfile !~ /^MAINTAINERS/) { 2899133712a2SRob Herring my $last_binding_patch = $is_binding_patch; 2900133712a2SRob Herring 2901133712a2SRob Herring $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@; 2902133712a2SRob Herring 2903133712a2SRob Herring if (($last_binding_patch != -1) && 2904133712a2SRob Herring ($last_binding_patch ^ $is_binding_patch)) { 2905133712a2SRob Herring WARN("DT_SPLIT_BINDING_PATCH", 2906858e6845SMauro Carvalho Chehab "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n"); 2907133712a2SRob Herring } 2908133712a2SRob Herring } 2909133712a2SRob Herring 2910773647a0SAndy Whitcroft next; 2911773647a0SAndy Whitcroft } 2912773647a0SAndy Whitcroft 2913389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 29140a920b5bSAndy Whitcroft 2915c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2916c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2917c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 29180a920b5bSAndy Whitcroft 29196c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 29206c72ffaaSAndy Whitcroft 2921490b292cSJoe Perches# Verify the existence of a commit log if appropriate 2922490b292cSJoe Perches# 2 is used because a $signature is counted in $commit_log_lines 2923490b292cSJoe Perches if ($in_commit_log) { 2924490b292cSJoe Perches if ($line !~ /^\s*$/) { 2925490b292cSJoe Perches $commit_log_lines++; #could be a $signature 2926490b292cSJoe Perches } 2927490b292cSJoe Perches } elsif ($has_commit_log && $commit_log_lines < 2) { 2928490b292cSJoe Perches WARN("COMMIT_MESSAGE", 2929490b292cSJoe Perches "Missing commit description - Add an appropriate one\n"); 2930490b292cSJoe Perches $commit_log_lines = 2; #warn only once 2931490b292cSJoe Perches } 2932490b292cSJoe Perches 2933e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2934e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 293513e45417SMrinal Pandey (($line =~ m@^\s+diff\b.*a/([\w/]+)@ && 293613e45417SMrinal Pandey $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) || 2937e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2938e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2939e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2940e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2941e518e9a5SJoe Perches $commit_log_has_diff = 1; 2942e518e9a5SJoe Perches } 2943e518e9a5SJoe Perches 29443bf9a009SRabin Vincent# Check for incorrect file permissions 29453bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 29463bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 294704db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 294804db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2949000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2950000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 29513bf9a009SRabin Vincent } 29523bf9a009SRabin Vincent } 29533bf9a009SRabin Vincent 2954cd261496SGeert Uytterhoeven# Check the patch for a From: 2955cd261496SGeert Uytterhoeven if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { 2956cd261496SGeert Uytterhoeven $author = $1; 2957e7f929f3SDwaipayan Ray my $curline = $linenr; 2958e7f929f3SDwaipayan Ray while(defined($rawlines[$curline]) && ($rawlines[$curline++] =~ /^[ \t]\s*(.*)/)) { 2959e7f929f3SDwaipayan Ray $author .= $1; 2960e7f929f3SDwaipayan Ray } 2961cd261496SGeert Uytterhoeven $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); 2962cd261496SGeert Uytterhoeven $author =~ s/"//g; 2963dfa05c28SJoe Perches $author = reformat_email($author); 2964cd261496SGeert Uytterhoeven } 2965cd261496SGeert Uytterhoeven 296620112475SJoe Perches# Check the patch for a signoff: 2967dfa05c28SJoe Perches if ($line =~ /^\s*signed-off-by:\s*(.*)/i) { 29684a0df2efSAndy Whitcroft $signoff++; 296915662b3eSJoe Perches $in_commit_log = 0; 297048ca2d8aSDwaipayan Ray if ($author ne '' && $authorsignoff != 1) { 2971fccaebf0SDwaipayan Ray if (same_email_addresses($1, $author)) { 2972cd261496SGeert Uytterhoeven $authorsignoff = 1; 297348ca2d8aSDwaipayan Ray } else { 297448ca2d8aSDwaipayan Ray my $ctx = $1; 297548ca2d8aSDwaipayan Ray my ($email_name, $email_comment, $email_address, $comment1) = parse_email($ctx); 297648ca2d8aSDwaipayan Ray my ($author_name, $author_comment, $author_address, $comment2) = parse_email($author); 297748ca2d8aSDwaipayan Ray 2978046fc741SMimi Zohar if (lc $email_address eq lc $author_address && $email_name eq $author_name) { 297948ca2d8aSDwaipayan Ray $author_sob = $ctx; 298048ca2d8aSDwaipayan Ray $authorsignoff = 2; 2981046fc741SMimi Zohar } elsif (lc $email_address eq lc $author_address) { 298248ca2d8aSDwaipayan Ray $author_sob = $ctx; 298348ca2d8aSDwaipayan Ray $authorsignoff = 3; 298448ca2d8aSDwaipayan Ray } elsif ($email_name eq $author_name) { 298548ca2d8aSDwaipayan Ray $author_sob = $ctx; 298648ca2d8aSDwaipayan Ray $authorsignoff = 4; 298748ca2d8aSDwaipayan Ray 298848ca2d8aSDwaipayan Ray my $address1 = $email_address; 298948ca2d8aSDwaipayan Ray my $address2 = $author_address; 299048ca2d8aSDwaipayan Ray 299148ca2d8aSDwaipayan Ray if ($address1 =~ /(\S+)\+\S+(\@.*)/) { 299248ca2d8aSDwaipayan Ray $address1 = "$1$2"; 299348ca2d8aSDwaipayan Ray } 299448ca2d8aSDwaipayan Ray if ($address2 =~ /(\S+)\+\S+(\@.*)/) { 299548ca2d8aSDwaipayan Ray $address2 = "$1$2"; 299648ca2d8aSDwaipayan Ray } 299748ca2d8aSDwaipayan Ray if ($address1 eq $address2) { 299848ca2d8aSDwaipayan Ray $authorsignoff = 5; 299948ca2d8aSDwaipayan Ray } 300048ca2d8aSDwaipayan Ray } 3001cd261496SGeert Uytterhoeven } 3002cd261496SGeert Uytterhoeven } 30030a920b5bSAndy Whitcroft } 300420112475SJoe Perches 300544d303ebSJoe Perches# Check for patch separator 300644d303ebSJoe Perches if ($line =~ /^---$/) { 300744d303ebSJoe Perches $has_patch_separator = 1; 300844d303ebSJoe Perches $in_commit_log = 0; 300944d303ebSJoe Perches } 301044d303ebSJoe Perches 3011e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 3012e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 3013e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 3014e0d975b1SJoe Perches $reported_maintainer_file = 1; 3015e0d975b1SJoe Perches } 3016e0d975b1SJoe Perches 301720112475SJoe Perches# Check signature styles 3018270c49a0SJoe Perches if (!$in_header_lines && 3019ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 302020112475SJoe Perches my $space_before = $1; 302120112475SJoe Perches my $sign_off = $2; 302220112475SJoe Perches my $space_after = $3; 302320112475SJoe Perches my $email = $4; 302420112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 302520112475SJoe Perches 3026ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 3027831242abSAditya Srivastava my $suggested_signature = find_standard_signature($sign_off); 3028831242abSAditya Srivastava if ($suggested_signature eq "") { 3029ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 3030ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 3031831242abSAditya Srivastava } else { 3032831242abSAditya Srivastava if (WARN("BAD_SIGN_OFF", 3033831242abSAditya Srivastava "Non-standard signature: '$sign_off' - perhaps '$suggested_signature'?\n" . $herecurr) && 3034831242abSAditya Srivastava $fix) { 3035831242abSAditya Srivastava $fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/; 3036831242abSAditya Srivastava } 3037831242abSAditya Srivastava } 3038ce0338dfSJoe Perches } 303920112475SJoe Perches if (defined $space_before && $space_before ne "") { 30403705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 30413705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 30423705ce5bSJoe Perches $fix) { 3043194f66fcSJoe Perches $fixed[$fixlinenr] = 30443705ce5bSJoe Perches "$ucfirst_sign_off $email"; 30453705ce5bSJoe Perches } 304620112475SJoe Perches } 304720112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 30483705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 30493705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 30503705ce5bSJoe Perches $fix) { 3051194f66fcSJoe Perches $fixed[$fixlinenr] = 30523705ce5bSJoe Perches "$ucfirst_sign_off $email"; 30533705ce5bSJoe Perches } 30543705ce5bSJoe Perches 305520112475SJoe Perches } 305620112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 30573705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 30583705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 30593705ce5bSJoe Perches $fix) { 3060194f66fcSJoe Perches $fixed[$fixlinenr] = 30613705ce5bSJoe Perches "$ucfirst_sign_off $email"; 30623705ce5bSJoe Perches } 306320112475SJoe Perches } 306420112475SJoe Perches 3065dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 306648ca2d8aSDwaipayan Ray my $suggested_email = format_email(($email_name, $name_comment, $email_address, $comment)); 306720112475SJoe Perches if ($suggested_email eq "") { 3068000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 3069000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 307020112475SJoe Perches } else { 307120112475SJoe Perches my $dequoted = $suggested_email; 307220112475SJoe Perches $dequoted =~ s/^"//; 307320112475SJoe Perches $dequoted =~ s/" </ </; 307420112475SJoe Perches # Don't force email to have quotes 307520112475SJoe Perches # Allow just an angle bracketed address 3076fccaebf0SDwaipayan Ray if (!same_email_addresses($email, $suggested_email)) { 3077fccaebf0SDwaipayan Ray if (WARN("BAD_SIGN_OFF", 3078fccaebf0SDwaipayan Ray "email address '$email' might be better as '$suggested_email'\n" . $herecurr) && 3079fccaebf0SDwaipayan Ray $fix) { 3080fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email\E/$suggested_email/; 3081fccaebf0SDwaipayan Ray } 3082fccaebf0SDwaipayan Ray } 3083fccaebf0SDwaipayan Ray 3084fccaebf0SDwaipayan Ray # Address part shouldn't have comments 3085fccaebf0SDwaipayan Ray my $stripped_address = $email_address; 3086fccaebf0SDwaipayan Ray $stripped_address =~ s/\([^\(\)]*\)//g; 3087fccaebf0SDwaipayan Ray if ($email_address ne $stripped_address) { 3088fccaebf0SDwaipayan Ray if (WARN("BAD_SIGN_OFF", 3089fccaebf0SDwaipayan Ray "address part of email should not have comments: '$email_address'\n" . $herecurr) && 3090fccaebf0SDwaipayan Ray $fix) { 3091fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email_address\E/$stripped_address/; 3092fccaebf0SDwaipayan Ray } 3093fccaebf0SDwaipayan Ray } 3094fccaebf0SDwaipayan Ray 3095fccaebf0SDwaipayan Ray # Only one name comment should be allowed 3096fccaebf0SDwaipayan Ray my $comment_count = () = $name_comment =~ /\([^\)]+\)/g; 3097fccaebf0SDwaipayan Ray if ($comment_count > 1) { 3098000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 3099fccaebf0SDwaipayan Ray "Use a single name comment in email: '$email'\n" . $herecurr); 3100fccaebf0SDwaipayan Ray } 3101fccaebf0SDwaipayan Ray 3102fccaebf0SDwaipayan Ray 3103fccaebf0SDwaipayan Ray # [email protected] or [email protected] shouldn't 3104e73d2715SDwaipayan Ray # have an email name. In addition comments should strictly 3105fccaebf0SDwaipayan Ray # begin with a # 3106fccaebf0SDwaipayan Ray if ($email =~ /^.*stable\@(?:vger\.)?kernel\.org/i) { 3107fccaebf0SDwaipayan Ray if (($comment ne "" && $comment !~ /^#.+/) || 3108fccaebf0SDwaipayan Ray ($email_name ne "")) { 3109fccaebf0SDwaipayan Ray my $cur_name = $email_name; 3110fccaebf0SDwaipayan Ray my $new_comment = $comment; 3111fccaebf0SDwaipayan Ray $cur_name =~ s/[a-zA-Z\s\-\"]+//g; 3112fccaebf0SDwaipayan Ray 3113fccaebf0SDwaipayan Ray # Remove brackets enclosing comment text 3114fccaebf0SDwaipayan Ray # and # from start of comments to get comment text 3115fccaebf0SDwaipayan Ray $new_comment =~ s/^\((.*)\)$/$1/; 3116fccaebf0SDwaipayan Ray $new_comment =~ s/^\[(.*)\]$/$1/; 3117fccaebf0SDwaipayan Ray $new_comment =~ s/^[\s\#]+|\s+$//g; 3118fccaebf0SDwaipayan Ray 3119fccaebf0SDwaipayan Ray $new_comment = trim("$new_comment $cur_name") if ($cur_name ne $new_comment); 3120fccaebf0SDwaipayan Ray $new_comment = " # $new_comment" if ($new_comment ne ""); 3121fccaebf0SDwaipayan Ray my $new_email = "$email_address$new_comment"; 3122fccaebf0SDwaipayan Ray 3123fccaebf0SDwaipayan Ray if (WARN("BAD_STABLE_ADDRESS_STYLE", 3124fccaebf0SDwaipayan Ray "Invalid email format for stable: '$email', prefer '$new_email'\n" . $herecurr) && 3125fccaebf0SDwaipayan Ray $fix) { 3126fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/; 3127fccaebf0SDwaipayan Ray } 3128fccaebf0SDwaipayan Ray } 3129fccaebf0SDwaipayan Ray } elsif ($comment ne "" && $comment !~ /^(?:#.+|\(.+\))$/) { 3130fccaebf0SDwaipayan Ray my $new_comment = $comment; 3131fccaebf0SDwaipayan Ray 3132fccaebf0SDwaipayan Ray # Extract comment text from within brackets or 3133fccaebf0SDwaipayan Ray # c89 style /*...*/ comments 3134fccaebf0SDwaipayan Ray $new_comment =~ s/^\[(.*)\]$/$1/; 3135fccaebf0SDwaipayan Ray $new_comment =~ s/^\/\*(.*)\*\/$/$1/; 3136fccaebf0SDwaipayan Ray 3137fccaebf0SDwaipayan Ray $new_comment = trim($new_comment); 3138fccaebf0SDwaipayan Ray $new_comment =~ s/^[^\w]$//; # Single lettered comment with non word character is usually a typo 3139fccaebf0SDwaipayan Ray $new_comment = "($new_comment)" if ($new_comment ne ""); 3140fccaebf0SDwaipayan Ray my $new_email = format_email($email_name, $name_comment, $email_address, $new_comment); 3141fccaebf0SDwaipayan Ray 3142fccaebf0SDwaipayan Ray if (WARN("BAD_SIGN_OFF", 3143fccaebf0SDwaipayan Ray "Unexpected content after email: '$email', should be: '$new_email'\n" . $herecurr) && 3144fccaebf0SDwaipayan Ray $fix) { 3145fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/; 3146fccaebf0SDwaipayan Ray } 314720112475SJoe Perches } 31480a920b5bSAndy Whitcroft } 31497e51f197SJoe Perches 31507e51f197SJoe Perches# Check for duplicate signatures 31517e51f197SJoe Perches my $sig_nospace = $line; 31527e51f197SJoe Perches $sig_nospace =~ s/\s//g; 31537e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 31547e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 31557e51f197SJoe Perches WARN("BAD_SIGN_OFF", 31567e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 31577e51f197SJoe Perches } else { 31587e51f197SJoe Perches $signatures{$sig_nospace} = 1; 31597e51f197SJoe Perches } 31606c5d24eeSSean Christopherson 31616c5d24eeSSean Christopherson# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email 31626c5d24eeSSean Christopherson if ($sign_off =~ /^co-developed-by:$/i) { 31636c5d24eeSSean Christopherson if ($email eq $author) { 31646c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31651916f777SThorsten Leemhuis "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . $herecurr); 31666c5d24eeSSean Christopherson } 31676c5d24eeSSean Christopherson if (!defined $lines[$linenr]) { 31686c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31691916f777SThorsten Leemhuis "Co-developed-by: must be immediately followed by Signed-off-by:\n" . $herecurr); 31701916f777SThorsten Leemhuis } elsif ($rawlines[$linenr] !~ /^signed-off-by:\s*(.*)/i) { 31716c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31721916f777SThorsten Leemhuis "Co-developed-by: must be immediately followed by Signed-off-by:\n" . $herecurr . $rawlines[$linenr] . "\n"); 31736c5d24eeSSean Christopherson } elsif ($1 ne $email) { 31746c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31751916f777SThorsten Leemhuis "Co-developed-by and Signed-off-by: name/email do not match\n" . $herecurr . $rawlines[$linenr] . "\n"); 31766c5d24eeSSean Christopherson } 31776c5d24eeSSean Christopherson } 3178d7f1d71eSKai Wasserbäch 317944c31888SMatthieu Baerts# check if Reported-by: is followed by a Closes: tag 3180d7f1d71eSKai Wasserbäch if ($sign_off =~ /^reported(?:|-and-tested)-by:$/i) { 3181d7f1d71eSKai Wasserbäch if (!defined $lines[$linenr]) { 3182d7f1d71eSKai Wasserbäch WARN("BAD_REPORTED_BY_LINK", 318344c31888SMatthieu Baerts "Reported-by: should be immediately followed by Closes: with a URL to the report\n" . $herecurr . "\n"); 3184d6ccdd67SMatthieu Baerts } elsif ($rawlines[$linenr] !~ /^closes:\s*/i) { 3185d7f1d71eSKai Wasserbäch WARN("BAD_REPORTED_BY_LINK", 318644c31888SMatthieu Baerts "Reported-by: should be immediately followed by Closes: with a URL to the report\n" . $herecurr . $rawlines[$linenr] . "\n"); 31870a920b5bSAndy Whitcroft } 3188d7f1d71eSKai Wasserbäch } 3189d7f1d71eSKai Wasserbäch } 3190d7f1d71eSKai Wasserbäch 31910a920b5bSAndy Whitcroft 3192bd17e036SNiklas Söderlund# Check Fixes: styles is correct 3193bd17e036SNiklas Söderlund if (!$in_header_lines && 3194bd17e036SNiklas Söderlund $line =~ /^\s*fixes:?\s*(?:commit\s*)?[0-9a-f]{5,}\b/i) { 3195bd17e036SNiklas Söderlund my $orig_commit = ""; 3196bd17e036SNiklas Söderlund my $id = "0123456789ab"; 3197bd17e036SNiklas Söderlund my $title = "commit title"; 3198bd17e036SNiklas Söderlund my $tag_case = 1; 3199bd17e036SNiklas Söderlund my $tag_space = 1; 3200bd17e036SNiklas Söderlund my $id_length = 1; 3201bd17e036SNiklas Söderlund my $id_case = 1; 3202bd17e036SNiklas Söderlund my $title_has_quotes = 0; 3203bd17e036SNiklas Söderlund 3204bd17e036SNiklas Söderlund if ($line =~ /(\s*fixes:?)\s+([0-9a-f]{5,})\s+($balanced_parens)/i) { 3205bd17e036SNiklas Söderlund my $tag = $1; 3206bd17e036SNiklas Söderlund $orig_commit = $2; 3207bd17e036SNiklas Söderlund $title = $3; 3208bd17e036SNiklas Söderlund 3209bd17e036SNiklas Söderlund $tag_case = 0 if $tag eq "Fixes:"; 3210bd17e036SNiklas Söderlund $tag_space = 0 if ($line =~ /^fixes:? [0-9a-f]{5,} ($balanced_parens)/i); 3211bd17e036SNiklas Söderlund 3212bd17e036SNiklas Söderlund $id_length = 0 if ($orig_commit =~ /^[0-9a-f]{12}$/i); 3213bd17e036SNiklas Söderlund $id_case = 0 if ($orig_commit !~ /[A-F]/); 3214bd17e036SNiklas Söderlund 3215bd17e036SNiklas Söderlund # Always strip leading/trailing parens then double quotes if existing 3216bd17e036SNiklas Söderlund $title = substr($title, 1, -1); 3217bd17e036SNiklas Söderlund if ($title =~ /^".*"$/) { 3218bd17e036SNiklas Söderlund $title = substr($title, 1, -1); 3219bd17e036SNiklas Söderlund $title_has_quotes = 1; 3220bd17e036SNiklas Söderlund } 3221bd17e036SNiklas Söderlund } 3222bd17e036SNiklas Söderlund 3223bd17e036SNiklas Söderlund my ($cid, $ctitle) = git_commit_info($orig_commit, $id, 3224bd17e036SNiklas Söderlund $title); 3225bd17e036SNiklas Söderlund 3226bd17e036SNiklas Söderlund if ($ctitle ne $title || $tag_case || $tag_space || 3227bd17e036SNiklas Söderlund $id_length || $id_case || !$title_has_quotes) { 3228bd17e036SNiklas Söderlund if (WARN("BAD_FIXES_TAG", 3229bd17e036SNiklas Söderlund "Please use correct Fixes: style 'Fixes: <12 chars of sha1> (\"<title line>\")' - ie: 'Fixes: $cid (\"$ctitle\")'\n" . $herecurr) && 3230bd17e036SNiklas Söderlund $fix) { 3231bd17e036SNiklas Söderlund $fixed[$fixlinenr] = "Fixes: $cid (\"$ctitle\")"; 3232bd17e036SNiklas Söderlund } 3233bd17e036SNiklas Söderlund } 3234bd17e036SNiklas Söderlund } 3235bd17e036SNiklas Söderlund 3236a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 3237a2fe16b9SJoe Perches if ($in_header_lines && 3238a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 3239a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 3240a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 3241a2fe16b9SJoe Perches } 3242a2fe16b9SJoe Perches 324344d303ebSJoe Perches# Check for Gerrit Change-Ids not in any patch context 324444d303ebSJoe Perches if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) { 32457580c5b9SAditya Srivastava if (ERROR("GERRIT_CHANGE_ID", 32467580c5b9SAditya Srivastava "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr) && 32477580c5b9SAditya Srivastava $fix) { 32487580c5b9SAditya Srivastava fix_delete_line($fixlinenr, $rawline); 32497580c5b9SAditya Srivastava } 32507ebd05efSChristopher Covington } 32517ebd05efSChristopher Covington 3252369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 3253369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 3254369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 3255369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 3256369c8dd3SJoe Perches # timestamp 3257634cffccSJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) || 3258634cffccSJoe Perches $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ || 3259634cffccSJoe Perches $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) { 3260634cffccSJoe Perches # stack dump address styles 3261369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 3262369c8dd3SJoe Perches } 3263369c8dd3SJoe Perches 32642a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 32652a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 3266bf4daf12SJoe Perches length($line) > 75 && 3267bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 3268bf4daf12SJoe Perches # file delta changes 326936f8b348SJerome Forissier $line =~ /^\s*(?:[\w\.\-\+]*\/)++[\w\.\-\+]+:/ || 3270bf4daf12SJoe Perches # filename then : 3271f94e40eaSMatthieu Baerts $line =~ /^\s*(?:Fixes:|$link_tags_search|$signature_tags)/i || 3272f94e40eaSMatthieu Baerts # A Fixes:, link or signature tag line 3273bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 32742a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 3275*8e7b7ffbSJim Cromie "Prefer a maximum 75 chars per line (possible unwrapped commit description?)\n" . $herecurr); 32762a076f40SJoe Perches $commit_log_long_line = 1; 32772a076f40SJoe Perches } 32782a076f40SJoe Perches 3279bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 3280bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 3281bf4daf12SJoe Perches $line =~ /^\s*$/) { 3282bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 3283bf4daf12SJoe Perches } 3284bf4daf12SJoe Perches 328576f381bbSKai Wasserbäch# Check for odd tags before a URI/URL 328676f381bbSKai Wasserbäch if ($in_commit_log && 3287f94e40eaSMatthieu Baerts $line =~ /^\s*(\w+:)\s*http/ && $1 !~ /^$link_tags_search$/) { 328876f381bbSKai Wasserbäch if ($1 =~ /^v(?:ersion)?\d+/i) { 328976f381bbSKai Wasserbäch WARN("COMMIT_LOG_VERSIONING", 329076f381bbSKai Wasserbäch "Patch version information should be after the --- line\n" . $herecurr); 329176f381bbSKai Wasserbäch } else { 329276f381bbSKai Wasserbäch WARN("COMMIT_LOG_USE_LINK", 3293f94e40eaSMatthieu Baerts "Unknown link reference '$1', use $link_tags_print instead\n" . $herecurr); 329476f381bbSKai Wasserbäch } 329576f381bbSKai Wasserbäch } 329676f381bbSKai Wasserbäch 3297d6ccdd67SMatthieu Baerts# Check for misuse of the link tags 3298d6ccdd67SMatthieu Baerts if ($in_commit_log && 3299d6ccdd67SMatthieu Baerts $line =~ /^\s*(\w+:)\s*(\S+)/) { 3300d6ccdd67SMatthieu Baerts my $tag = $1; 3301d6ccdd67SMatthieu Baerts my $value = $2; 3302d6ccdd67SMatthieu Baerts if ($tag =~ /^$link_tags_search$/ && $value !~ m{^https?://}) { 3303d6ccdd67SMatthieu Baerts WARN("COMMIT_LOG_WRONG_LINK", 3304d6ccdd67SMatthieu Baerts "'$tag' should be followed by a public http(s) link\n" . $herecurr); 33050d7835fcSJoe Perches } 33064ce9f970SJoe Perches } 33074ce9f970SJoe Perches 33084ce9f970SJoe Perches# Check for lines starting with a # 33094ce9f970SJoe Perches if ($in_commit_log && $line =~ /^#/) { 33104ce9f970SJoe Perches if (WARN("COMMIT_COMMENT_SYMBOL", 33114ce9f970SJoe Perches "Commit log lines starting with '#' are dropped by git as comments\n" . $herecurr) && 33124ce9f970SJoe Perches $fix) { 33134ce9f970SJoe Perches $fixed[$fixlinenr] =~ s/^/ /; 33144ce9f970SJoe Perches } 33154ce9f970SJoe Perches } 3316a8972573SJohn Hubbard 3317e882dbfcSWei Wang# Check for git id commit length and improperly formed commit descriptions 33184ce9f970SJoe Perches# A correctly formed commit description is: 33194ce9f970SJoe Perches# commit <SHA-1 hash length 12+ chars> ("Complete commit subject") 3320aab38f51SJoe Perches# with the commit subject '("' prefix and '")' suffix 3321369c8dd3SJoe Perches# This is a fairly compilicated block as it tests for what appears to be 3322bf4daf12SJoe Perches# bare SHA-1 hash with minimum length of 5. It also avoids several types of 3323fe043ea1SJoe Perches# possible SHA-1 matches. 3324fe043ea1SJoe Perches# A commit match can span multiple lines so this block attempts to find a 33250d7835fcSJoe Perches# complete typical commit on a maximum of 3 lines 33260d7835fcSJoe Perches if ($perl_version_ok && 33270d7835fcSJoe Perches $in_commit_log && !$commit_log_possible_stack_dump && 33280d7835fcSJoe Perches $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i && 33290d7835fcSJoe Perches $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 33300d7835fcSJoe Perches (($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 33310d7835fcSJoe Perches ($line =~ /\bcommit\s*$/i && defined($rawlines[$linenr]) && $rawlines[$linenr] =~ /^\s*[0-9a-f]{5,}\b/i)) || 33324ce9f970SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 33334ce9f970SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 33344ce9f970SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 33350d7835fcSJoe Perches my $init_char = "c"; 33364ce9f970SJoe Perches my $orig_commit = ""; 33374ce9f970SJoe Perches my $short = 1; 33384ce9f970SJoe Perches my $long = 0; 33394ce9f970SJoe Perches my $case = 1; 33404ce9f970SJoe Perches my $space = 1; 33414ce9f970SJoe Perches my $id = '0123456789ab'; 33424ce9f970SJoe Perches my $orig_desc = "commit description"; 33434ce9f970SJoe Perches my $description = ""; 33444ce9f970SJoe Perches my $herectx = $herecurr; 33454ce9f970SJoe Perches my $has_parens = 0; 33464ce9f970SJoe Perches my $has_quotes = 0; 33474ce9f970SJoe Perches 33484ce9f970SJoe Perches my $input = $line; 33494ce9f970SJoe Perches if ($line =~ /(?:\bcommit\s+[0-9a-f]{5,}|\bcommit\s*$)/i) { 33504ce9f970SJoe Perches for (my $n = 0; $n < 2; $n++) { 33514ce9f970SJoe Perches if ($input =~ /\bcommit\s+[0-9a-f]{5,}\s*($balanced_parens)/i) { 33524ce9f970SJoe Perches $orig_desc = $1; 33534ce9f970SJoe Perches $has_parens = 1; 33544ce9f970SJoe Perches # Always strip leading/trailing parens then double quotes if existing 3355fe043ea1SJoe Perches $orig_desc = substr($orig_desc, 1, -1); 3356fe043ea1SJoe Perches if ($orig_desc =~ /^".*"$/) { 33574ce9f970SJoe Perches $orig_desc = substr($orig_desc, 1, -1); 33584ce9f970SJoe Perches $has_quotes = 1; 33594ce9f970SJoe Perches } 33604ce9f970SJoe Perches last; 33614ce9f970SJoe Perches } 33624ce9f970SJoe Perches last if ($#lines < $linenr + $n); 33634ce9f970SJoe Perches $input .= " " . trim($rawlines[$linenr + $n]); 33644ce9f970SJoe Perches $herectx .= "$rawlines[$linenr + $n]\n"; 33654ce9f970SJoe Perches } 33660d7835fcSJoe Perches $herectx = $herecurr if (!$has_parens); 33670d7835fcSJoe Perches } 33680d7835fcSJoe Perches 33690d7835fcSJoe Perches if ($input =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 33700d7835fcSJoe Perches $init_char = $1; 3371948b133aSHeinrich Schuchardt $orig_commit = lc($2); 33724ce9f970SJoe Perches $short = 0 if ($input =~ /\bcommit\s+[0-9a-f]{12,40}/i); 33734ce9f970SJoe Perches $long = 1 if ($input =~ /\bcommit\s+[0-9a-f]{41,}/i); 3374d311cd44SJoe Perches $space = 0 if ($input =~ /\bcommit [0-9a-f]/i); 33754ce9f970SJoe Perches $case = 0 if ($input =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 33760d7835fcSJoe Perches } elsif ($input =~ /\b([0-9a-f]{12,40})\b/i) { 33774ce9f970SJoe Perches $orig_commit = lc($1); 33784ce9f970SJoe Perches } 3379d311cd44SJoe Perches 3380d311cd44SJoe Perches ($id, $description) = git_commit_info($orig_commit, 33819b71f79fSBjorn Helgaas $id, $orig_desc); 33829b71f79fSBjorn Helgaas 33839b71f79fSBjorn Helgaas if (defined($id) && 33849b71f79fSBjorn Helgaas ($short || $long || $space || $case || ($orig_desc ne $description) || !$has_quotes) && 33859b71f79fSBjorn Helgaas $last_git_commit_id_linenr != $linenr - 1) { 33869b71f79fSBjorn Helgaas ERROR("GIT_COMMIT_ID", 338713f1937eSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herectx); 338813f1937eSJoe Perches } 338913f1937eSJoe Perches #don't report the next line if this line ends in commit and the sha1 hash is the next line 339013f1937eSJoe Perches $last_git_commit_id_linenr = $linenr if ($line =~ /\bcommit\s*$/i); 339113f1937eSJoe Perches } 339213f1937eSJoe Perches 3393a82603a8SAndrew Jeffery# Check for mailing list archives other than lore.kernel.org 339413f1937eSJoe Perches if ($rawline =~ m{http.*\b$obsolete_archives}) { 339513f1937eSJoe Perches WARN("PREFER_LORE_ARCHIVE", 339613f1937eSJoe Perches "Use lore.kernel.org archive links when possible - see https://lore.kernel.org/lists.html\n" . $herecurr); 339713f1937eSJoe Perches } 339813f1937eSJoe Perches 3399e400edb1SRob Herring# Check for added, moved or deleted files 3400e400edb1SRob Herring if (!$reported_maintainer_file && !$in_commit_log && 3401e400edb1SRob Herring ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 3402e400edb1SRob Herring $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 3403e400edb1SRob Herring ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 340456ddc4cdSMauro Carvalho Chehab (defined($1) || defined($2))))) { 3405e400edb1SRob Herring $is_patch = 1; 3406e400edb1SRob Herring $reported_maintainer_file = 1; 340700df344fSAndy Whitcroft WARN("FILE_PATH_CHANGES", 34088905a67cSAndy Whitcroft "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 3409000d1cc1SJoe Perches } 3410000d1cc1SJoe Perches 34116c72ffaaSAndy Whitcroft# Check for adding new DT bindings not in schema format 3412de7d4f0eSAndy Whitcroft if (!$in_commit_log && 3413de7d4f0eSAndy Whitcroft ($line =~ /^new file mode\s*\d+\s*$/) && 3414de7d4f0eSAndy Whitcroft ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) { 3415de7d4f0eSAndy Whitcroft WARN("DT_SCHEMA_BINDING_PATCH", 3416171ae1a4SAndy Whitcroft "DT bindings should be in DT schema format. See: Documentation/devicetree/bindings/writing-schema.rst\n"); 3417171ae1a4SAndy Whitcroft } 3418171ae1a4SAndy Whitcroft 3419171ae1a4SAndy Whitcroft# Check for wrappage within a valid hunk of the file 3420171ae1a4SAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 3421171ae1a4SAndy Whitcroft ERROR("CORRUPTED_PATCH", 3422171ae1a4SAndy Whitcroft "patch seems to be corrupt (line wrapped?)\n" . 342334d99219SJoe Perches $herecurr) if (!$emitted_corrupt++); 3424000d1cc1SJoe Perches } 342500df344fSAndy Whitcroft 34260a920b5bSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 342715662b3eSJoe Perches if (($realfile =~ /^$/ || $line =~ /^\+/) && 342815662b3eSJoe Perches $rawline !~ m/^$UTF8*$/) { 342915662b3eSJoe Perches my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 3430eb3a58deSJoe Perches 3431eb3a58deSJoe Perches my $blank = copy_spacing($rawline); 343215662b3eSJoe Perches my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 343315662b3eSJoe Perches my $hereptr = "$hereline$ptr\n"; 3434ed43c4e5SAllen Hubbe 343515662b3eSJoe Perches CHK("INVALID_UTF8", 343615662b3eSJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 3437fa64205dSPasi Savanainen } 3438fa64205dSPasi Savanainen 3439fa64205dSPasi Savanainen# Check if it's the start of a commit log 3440fa64205dSPasi Savanainen# (not a header line and we haven't seen the patch filename) 3441fa64205dSPasi Savanainen if ($in_header_lines && $realfile =~ /^$/ && 3442fa64205dSPasi Savanainen !($rawline =~ /^\s+(?:\S|$)/ || 3443fa64205dSPasi Savanainen $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 3444fa64205dSPasi Savanainen $in_header_lines = 0; 3445fa64205dSPasi Savanainen $in_commit_log = 1; 344615662b3eSJoe Perches $has_commit_log = 1; 3447fa64205dSPasi Savanainen } 344815662b3eSJoe Perches 344915662b3eSJoe Perches# Check if there is UTF-8 in a commit log when a mail header has explicitly 345015662b3eSJoe Perches# declined it, i.e defined some charset where it is missing. 3451d6430f71SJoe Perches if ($in_header_lines && 3452d6430f71SJoe Perches $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 3453d6430f71SJoe Perches $1 !~ /utf-8/i) { 3454d6430f71SJoe Perches $non_utf8_charset = 1; 3455d6430f71SJoe Perches } 3456d6430f71SJoe Perches 3457d6430f71SJoe Perches if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 3458d6430f71SJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 3459d6430f71SJoe Perches WARN("UTF8_BEFORE_PATCH", 3460d6430f71SJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 3461d6430f71SJoe Perches } 3462d6430f71SJoe Perches 3463d6430f71SJoe Perches# Check for absolute kernel paths in commit message 3464d6430f71SJoe Perches if ($tree && $in_commit_log) { 346566b47b4aSKees Cook while ($line =~ m{(?:^|\s)(/\S*)}g) { 346666d7a382SJoe Perches my $file = $1; 346766d7a382SJoe Perches 34687da07c31SDwaipayan Ray if ($file =~ m{^(.*?)(?::\d+)+:?$} && 346966b47b4aSKees Cook check_absolute_file($1, $herecurr)) { 34707da07c31SDwaipayan Ray # 34717da07c31SDwaipayan Ray } else { 34727da07c31SDwaipayan Ray check_absolute_file($file, $herecurr); 347366b47b4aSKees Cook } 347466b47b4aSKees Cook } 347566b47b4aSKees Cook } 34760675a8fbSJean Delvare 34770675a8fbSJean Delvare# Check for various typo / spelling mistakes 34780675a8fbSJean Delvare if (defined($misspellings) && 34797da07c31SDwaipayan Ray ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 348066b47b4aSKees Cook while ($rawline =~ /(?:^|[^\w\-'`])($misspellings)(?:[^\w\-'`]|$)/gi) { 348166b47b4aSKees Cook my $typo = $1; 348266b47b4aSKees Cook my $blank = copy_spacing($rawline); 348366b47b4aSKees Cook my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo); 348466b47b4aSKees Cook my $hereptr = "$hereline$ptr\n"; 348566b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 3486a8dd86bfSMatteo Croce $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 3487a8dd86bfSMatteo Croce $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 3488a8dd86bfSMatteo Croce my $msg_level = \&WARN; 3489a8dd86bfSMatteo Croce $msg_level = \&CHK if ($file); 3490a8dd86bfSMatteo Croce if (&{$msg_level}("TYPO_SPELLING", 3491a8dd86bfSMatteo Croce "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $hereptr) && 3492a8dd86bfSMatteo Croce $fix) { 3493a8dd86bfSMatteo Croce $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 3494a8dd86bfSMatteo Croce } 3495a8dd86bfSMatteo Croce } 3496a8dd86bfSMatteo Croce } 3497310cd06bSJoe Perches 34988d0325ccSAditya Srivastava# check for invalid commit id 34998d0325ccSAditya Srivastava if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) { 35008d0325ccSAditya Srivastava my $id; 35011db81a68SDwaipayan Ray my $description; 3502310cd06bSJoe Perches ($id, $description) = git_commit_info($2, undef, undef); 3503310cd06bSJoe Perches if (!defined($id)) { 3504310cd06bSJoe Perches WARN("UNKNOWN_COMMIT_ID", 3505310cd06bSJoe Perches "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr); 35061db81a68SDwaipayan Ray } 35071db81a68SDwaipayan Ray } 3508310cd06bSJoe Perches 3509310cd06bSJoe Perches# check for repeated words separated by a single space 3510310cd06bSJoe Perches# avoid false positive from list command eg, '-rw-r--r-- 1 root root' 3511310cd06bSJoe Perches if (($rawline =~ /^\+/ || $in_commit_log) && 3512310cd06bSJoe Perches $rawline !~ /[bcCdDlMnpPs\?-][rwxsStT-]{9}/) { 35131db81a68SDwaipayan Ray pos($rawline) = 1 if (!$in_commit_log); 3514310cd06bSJoe Perches while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) { 3515310cd06bSJoe Perches 35161db81a68SDwaipayan Ray my $first = $1; 35171db81a68SDwaipayan Ray my $second = $2; 35181db81a68SDwaipayan Ray my $start_pos = $-[1]; 35191db81a68SDwaipayan Ray my $end_pos = $+[2]; 35201db81a68SDwaipayan Ray if ($first =~ /(?:struct|union|enum)/) { 35211db81a68SDwaipayan Ray pos($rawline) += length($first) + length($second) + 1; 35221db81a68SDwaipayan Ray next; 35231db81a68SDwaipayan Ray } 35241db81a68SDwaipayan Ray 35258d0325ccSAditya Srivastava next if (lc($first) ne lc($second)); 35268d0325ccSAditya Srivastava next if ($first eq 'long'); 35278d0325ccSAditya Srivastava 35288d0325ccSAditya Srivastava # check for character before and after the word matches 35298d0325ccSAditya Srivastava my $start_char = ''; 3530310cd06bSJoe Perches my $end_char = ''; 3531310cd06bSJoe Perches $start_char = substr($rawline, $start_pos - 1, 1) if ($start_pos > ($in_commit_log ? 0 : 1)); 3532310cd06bSJoe Perches $end_char = substr($rawline, $end_pos, 1) if ($end_pos < length($rawline)); 3533310cd06bSJoe Perches 3534310cd06bSJoe Perches next if ($start_char =~ /^\S$/); 3535310cd06bSJoe Perches next if (index(" \t.,;?!", $end_char) == -1); 3536310cd06bSJoe Perches 3537310cd06bSJoe Perches # avoid repeating hex occurrences like 'ff ff fe 09 ...' 3538310cd06bSJoe Perches if ($first =~ /\b[0-9a-f]{2,}\b/i) { 3539310cd06bSJoe Perches next if (!exists($allow_repeated_words{lc($first)})); 3540310cd06bSJoe Perches } 3541310cd06bSJoe Perches 3542310cd06bSJoe Perches if (WARN("REPEATED_WORD", 3543310cd06bSJoe Perches "Possible repeated word: '$first'\n" . $herecurr) && 3544310cd06bSJoe Perches $fix) { 3545310cd06bSJoe Perches $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/; 3546310cd06bSJoe Perches } 3547310cd06bSJoe Perches } 3548310cd06bSJoe Perches 3549310cd06bSJoe Perches # if it's a repeated word on consecutive lines in a comment block 3550310cd06bSJoe Perches if ($prevline =~ /$;+\s*$/ && 355130670854SAndy Whitcroft $prevrawline =~ /($word_pattern)\s*$/) { 355230670854SAndy Whitcroft my $last_word = $1; 355300df344fSAndy Whitcroft if ($rawline =~ /^\+\s*\*\s*$last_word /) { 35540a920b5bSAndy Whitcroft if (WARN("REPEATED_WORD", 35559c0ca6f9SAndy Whitcroft "Possible repeated word: '$last_word'\n" . $hereprev) && 3556c2fdda0dSAndy Whitcroft $fix) { 3557d5e616fcSJoe Perches $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/; 3558d5e616fcSJoe Perches } 3559d5e616fcSJoe Perches } 3560194f66fcSJoe Perches } 3561d5e616fcSJoe Perches } 3562c2fdda0dSAndy Whitcroft 3563c2fdda0dSAndy Whitcroft# ignore non-hunk lines and lines being removed 35643705ce5bSJoe Perches next if (!$hunk_line || $line =~ /^-/); 35653705ce5bSJoe Perches 35663705ce5bSJoe Perches#trailing whitespace 3567194f66fcSJoe Perches if ($line =~ /^\+.*\015/) { 35683705ce5bSJoe Perches my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 35693705ce5bSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 3570d2c0a235SAndy Whitcroft "DOS line endings\n" . $herevet) && 35710a920b5bSAndy Whitcroft $fix) { 35725368df20SAndy Whitcroft $fixed[$fixlinenr] =~ s/[\s\015]+$//; 35734783f894SJosh Triplett } 3574109d8cb2SAlexander Duyck } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 35751bde561eSMatthew Wilcox my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 35763e2232f2SJoe Perches if (ERROR("TRAILING_WHITESPACE", 35773e2232f2SJoe Perches "trailing whitespace\n" . $herevet) && 35784783f894SJosh Triplett $fix) { 35790675a8fbSJean Delvare $fixed[$fixlinenr] =~ s/\s+$//; 35800675a8fbSJean Delvare } 35810675a8fbSJean Delvare 35824783f894SJosh Triplett $rpt_cleaners = 1; 35834783f894SJosh Triplett } 35844783f894SJosh Triplett 35853354957aSAndi Kleen# Check for FSF mailing addresses. 35869fe287d7SAndy Whitcroft if ($rawline =~ /\bwrite to the Free/i || 35879fe287d7SAndy Whitcroft $rawline =~ /\b675\s+Mass\s+Ave/i || 35883354957aSAndi Kleen $rawline =~ /\b59\s+Temple\s+Pl/i || 3589678ae162SUlf Magnusson $rawline =~ /\b51\s+Franklin\s+St/i) { 3590678ae162SUlf Magnusson my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3591678ae162SUlf Magnusson my $msg_level = \&ERROR; 3592678ae162SUlf Magnusson $msg_level = \&CHK if ($file); 3593b8709bceSJoe Perches &{$msg_level}("FSF_MAILING_ADDRESS", 3594b8709bceSJoe Perches "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) 3595b8709bceSJoe Perches } 3596b8709bceSJoe Perches 3597b8709bceSJoe Perches# check for Kconfig help text having a real description 3598b8709bceSJoe Perches# Only applies when adding the entry originally, after that we do not have 35999fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 36009fe287d7SAndy Whitcroft if ($realfile =~ /Kconfig/ && 3601b8709bceSJoe Perches # 'choice' is usually the last thing on the line (though 3602a1385803SAndy Whitcroft # Kconfig supports named choices), so use a word boundary 3603b8709bceSJoe Perches # (\b) rather than a whitespace character (\s) 3604b8709bceSJoe Perches $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 3605b8709bceSJoe Perches my $ln = $linenr; 3606b8709bceSJoe Perches my $needs_help = 0; 3607b8709bceSJoe Perches my $has_help = 0; 3608b8709bceSJoe Perches my $help_length = 0; 3609b8709bceSJoe Perches while (defined $lines[$ln]) { 3610a1385803SAndy Whitcroft my $f = $lines[$ln++]; 3611a1385803SAndy Whitcroft 3612b8709bceSJoe Perches next if ($f =~ /^-/); 3613b8709bceSJoe Perches last if ($f !~ /^[\+ ]/); # !patch context 3614b8709bceSJoe Perches 3615b8709bceSJoe Perches if ($f =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 3616678ae162SUlf Magnusson $needs_help = 1; 3617b8709bceSJoe Perches next; 3618678ae162SUlf Magnusson } 3619678ae162SUlf Magnusson if ($f =~ /^\+\s*help\s*$/) { 3620678ae162SUlf Magnusson $has_help = 1; 3621678ae162SUlf Magnusson next; 3622b8709bceSJoe Perches } 3623678ae162SUlf Magnusson 36249fe287d7SAndy Whitcroft $f =~ s/^.//; # strip patch context [+ ] 36259fe287d7SAndy Whitcroft $f =~ s/#.*//; # strip # directives 3626b8709bceSJoe Perches $f =~ s/^\s+//; # strip leading blanks 36273354957aSAndi Kleen next if ($f =~ /^$/); # skip blank lines 3628b8709bceSJoe Perches 3629b8709bceSJoe Perches # At the end of this Kconfig block: 3630b8709bceSJoe Perches # This only checks context lines in the patch 3631000d1cc1SJoe Perches # and so hopefully shouldn't trigger false 3632b8709bceSJoe Perches # positives, even though some of these are 363356193274SVadim Bendebury # common words in help texts 36343354957aSAndi Kleen if ($f =~ /^(?:config|menuconfig|choice|endchoice| 36353354957aSAndi Kleen if|endif|menu|endmenu|source)\b/x) { 36367ccf41a8SJoe Perches last; 36377ccf41a8SJoe Perches } 36387ccf41a8SJoe Perches $help_length++ if ($has_help); 36397ccf41a8SJoe Perches } 3640628f91a2SJoe Perches if ($needs_help && 3641628f91a2SJoe Perches $help_length < $min_conf_desc_length) { 3642628f91a2SJoe Perches my $stat_real = get_stat_real($linenr, $ln - 1); 3643628f91a2SJoe Perches WARN("CONFIG_DESCRIPTION", 3644628f91a2SJoe Perches "please write a help paragraph that fully describes the config symbol\n" . "$here\n$stat_real\n"); 3645628f91a2SJoe Perches } 3646628f91a2SJoe Perches } 36477ccf41a8SJoe Perches 36487ccf41a8SJoe Perches# check MAINTAINERS entries 36497ccf41a8SJoe Perches if ($realfile =~ /^MAINTAINERS$/) { 36507ccf41a8SJoe Perches# check MAINTAINERS entries for the right form 36517ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 36527ccf41a8SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 36537ccf41a8SJoe Perches if (WARN("MAINTAINERS_STYLE", 36547ccf41a8SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 36557ccf41a8SJoe Perches $fix) { 36567ccf41a8SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 36577ccf41a8SJoe Perches } 36587ccf41a8SJoe Perches } 36597ccf41a8SJoe Perches# check MAINTAINERS entries for the right ordering too 36607ccf41a8SJoe Perches my $preferred_order = 'MRLSWQBCPTFXNK'; 36617ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 36627ccf41a8SJoe Perches $prevrawline =~ /^[\+ ][A-Z]:/) { 36637ccf41a8SJoe Perches $rawline =~ /^\+([A-Z]):\s*(.*)/; 36647ccf41a8SJoe Perches my $cur = $1; 36657ccf41a8SJoe Perches my $curval = $2; 36667ccf41a8SJoe Perches $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/; 36677ccf41a8SJoe Perches my $prev = $1; 36687ccf41a8SJoe Perches my $prevval = $2; 36697ccf41a8SJoe Perches my $curindex = index($preferred_order, $cur); 36707ccf41a8SJoe Perches my $previndex = index($preferred_order, $prev); 36717ccf41a8SJoe Perches if ($curindex < 0) { 36727ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 36737ccf41a8SJoe Perches "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr); 36747ccf41a8SJoe Perches } else { 3675628f91a2SJoe Perches if ($previndex >= 0 && $curindex < $previndex) { 3676c68e5878SArnaud Lacombe WARN("MAINTAINERS_STYLE", 3677c68e5878SArnaud Lacombe "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev); 3678c68e5878SArnaud Lacombe } elsif ((($prev eq 'F' && $cur eq 'F') || 3679c68e5878SArnaud Lacombe ($prev eq 'X' && $cur eq 'X')) && 3680c68e5878SArnaud Lacombe ($prevval cmp $curval) > 0) { 3681c68e5878SArnaud Lacombe WARN("MAINTAINERS_STYLE", 3682c68e5878SArnaud Lacombe "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev); 3683c68e5878SArnaud Lacombe } 3684c68e5878SArnaud Lacombe } 3685c68e5878SArnaud Lacombe } 3686c68e5878SArnaud Lacombe } 3687c68e5878SArnaud Lacombe 3688c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 3689c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 3690bff5da43SRob Herring my $flag = $1; 36917dd05b38SFlorian Vaussard my $replacement = { 36927dd05b38SFlorian Vaussard 'EXTRA_AFLAGS' => 'asflags-y', 36937dd05b38SFlorian Vaussard 'EXTRA_CFLAGS' => 'ccflags-y', 36947dd05b38SFlorian Vaussard 'EXTRA_CPPFLAGS' => 'cppflags-y', 3695bff5da43SRob Herring 'EXTRA_LDFLAGS' => 'ldflags-y', 3696bff5da43SRob Herring }; 3697cc93319bSFlorian Vaussard 3698852d095dSRob Herring WARN("DEPRECATED_VARIABLE", 3699cc93319bSFlorian Vaussard "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 3700bff5da43SRob Herring } 3701bff5da43SRob Herring 3702185d566bSRob Herring# check for DT compatible documentation 3703185d566bSRob Herring if (defined $root && 3704185d566bSRob Herring (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 3705185d566bSRob Herring ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 3706bff5da43SRob Herring 3707bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 3708bff5da43SRob Herring 3709bff5da43SRob Herring my $dt_path = $root . "/Documentation/devicetree/bindings/"; 3710bff5da43SRob Herring my $vp_file = $dt_path . "vendor-prefixes.yaml"; 37114fbf32a6SFlorian Vaussard 37124fbf32a6SFlorian Vaussard foreach my $compat (@compats) { 3713852d095dSRob Herring my $compat2 = $compat; 3714bff5da43SRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 3715bff5da43SRob Herring my $compat3 = $compat; 3716cc93319bSFlorian Vaussard $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 3717bff5da43SRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 3718bff5da43SRob Herring if ( $? >> 8 ) { 3719bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3720bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 37219f3a8992SRob Herring } 37229f3a8992SRob Herring 37239f3a8992SRob Herring next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 37249f3a8992SRob Herring my $vendor = $1; 37259f3a8992SRob Herring `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`; 37269f3a8992SRob Herring if ( $? >> 8 ) { 37279f3a8992SRob Herring WARN("UNDOCUMENTED_DT_STRING", 37289f3a8992SRob Herring "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 3729d1d84b5fSMiguel Ojeda } 37309f3a8992SRob Herring } 3731c8df0ab6SLubomir Rintel } 37329f3a8992SRob Herring 37339f3a8992SRob Herring# check for using SPDX license tag at beginning of files 37349f3a8992SRob Herring if ($realline == $checklicenseline) { 37359f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 37369f3a8992SRob Herring $checklicenseline = 2; 3737fdf13693SJoe Perches } elsif ($rawline =~ /^\+/) { 3738fdf13693SJoe Perches my $comment = ""; 3739fdf13693SJoe Perches if ($realfile =~ /\.(h|s|S)$/) { 3740ffbce897SJoe Perches $comment = '/*'; 3741fdf13693SJoe Perches } elsif ($realfile =~ /\.(c|rs|dts|dtsi)$/) { 3742fdf13693SJoe Perches $comment = '//'; 3743fdf13693SJoe Perches } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) { 3744fdf13693SJoe Perches $comment = '#'; 37459f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 3746ffbce897SJoe Perches $comment = '..'; 37479f3a8992SRob Herring } 37489f3a8992SRob Herring 37493b6e8ac9SJoe Perches# check SPDX comment style for .[chsS] files 37503b6e8ac9SJoe Perches if ($realfile =~ /\.[chsS]$/ && 37513b6e8ac9SJoe Perches $rawline =~ /SPDX-License-Identifier:/ && 37523b6e8ac9SJoe Perches $rawline !~ m@^\+\s*\Q$comment\E\s*@) { 37533b6e8ac9SJoe Perches WARN("SPDX_LICENSE_TAG", 37543b6e8ac9SJoe Perches "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr); 375550c92900SLubomir Rintel } 375650c92900SLubomir Rintel 375750c92900SLubomir Rintel if ($comment !~ /^$/ && 375850c92900SLubomir Rintel $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) { 375950c92900SLubomir Rintel WARN("SPDX_LICENSE_TAG", 376050c92900SLubomir Rintel "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 376150c92900SLubomir Rintel } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) { 376250c92900SLubomir Rintel my $spdx_license = $1; 376350c92900SLubomir Rintel if (!is_SPDX_License_valid($spdx_license)) { 376450c92900SLubomir Rintel WARN("SPDX_LICENSE_TAG", 376550c92900SLubomir Rintel "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr); 37669f3a8992SRob Herring } 37679f3a8992SRob Herring if ($realfile =~ m@^Documentation/devicetree/bindings/@ && 3768a04bb4c2SDmitry Rokosov $spdx_license !~ /GPL-2\.0(?:-only)? OR BSD-2-Clause/) { 37699f3a8992SRob Herring my $msg_level = \&WARN; 37709f3a8992SRob Herring $msg_level = \&CHK if ($file); 37715368df20SAndy Whitcroft if (&{$msg_level}("SPDX_LICENSE_TAG", 3772d6430f71SJoe Perches 37735368df20SAndy Whitcroft "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) && 3774a8da38a9SJoe Perches $fix) { 3775a8da38a9SJoe Perches $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/; 3776a8da38a9SJoe Perches } 3777a8da38a9SJoe Perches } 3778a04bb4c2SDmitry Rokosov if ($realfile =~ m@^include/dt-bindings/@ && 3779a04bb4c2SDmitry Rokosov $spdx_license !~ /GPL-2\.0(?:-only)? OR \S+/) { 3780a04bb4c2SDmitry Rokosov WARN("SPDX_LICENSE_TAG", 3781a04bb4c2SDmitry Rokosov "DT binding headers should be licensed (GPL-2.0-only OR .*)\n" . $herecurr); 3782a04bb4c2SDmitry Rokosov } 378347e0c88bSJoe Perches } 378447e0c88bSJoe Perches } 378547e0c88bSJoe Perches } 378647e0c88bSJoe Perches 3787a0154cdbSJoe Perches# check for embedded filenames 378836217357SJoe Perches if ($rawline =~ /^\+.*\b\Q$realfile\E\b/) { 3789a0154cdbSJoe Perches WARN("EMBEDDED_FILENAME", 3790a0154cdbSJoe Perches "It's generally not useful to have the filename in the file\n" . $herecurr); 3791a0154cdbSJoe Perches } 3792a0154cdbSJoe Perches 37935e79d96eSJoe Perches# check we are in a valid source file if not then ignore this hunk 3794d1d84b5fSMiguel Ojeda next if ($realfile !~ /\.(h|c|rs|s|S|sh|dtsi|dts)$/); 37950a920b5bSAndy Whitcroft 3796a8da38a9SJoe Perches# check for using SPDX-License-Identifier on the wrong line number 3797a8da38a9SJoe Perches if ($realline != $checklicenseline && 3798a8da38a9SJoe Perches $rawline =~ /\bSPDX-License-Identifier:/ && 3799a8da38a9SJoe Perches substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) { 3800a8da38a9SJoe Perches WARN("SPDX_LICENSE_TAG", 3801a8da38a9SJoe Perches "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr); 3802a8da38a9SJoe Perches } 3803a8da38a9SJoe Perches 3804c45dcabdSAndy Whitcroft# line length limit (with some exclusions) 380547e0c88bSJoe Perches# 380647e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 380747e0c88bSJoe Perches# logging functions like pr_info that end in a string 380847e0c88bSJoe Perches# lines with a single string 380947e0c88bSJoe Perches# #defines that are a single string 381047e0c88bSJoe Perches# lines with an RFC3986 like URL 381147e0c88bSJoe Perches# 381247e0c88bSJoe Perches# There are 3 different line length message types: 381347e0c88bSJoe Perches# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 381447e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 381547e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 381647e0c88bSJoe Perches# 381747e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 381847e0c88bSJoe Perches# 381947e0c88bSJoe Perches 382047e0c88bSJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 382147e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 382247e0c88bSJoe Perches 382347e0c88bSJoe Perches # Check the allowed long line types first 382447e0c88bSJoe Perches 382547e0c88bSJoe Perches # logging functions that end in a string that starts 382647e0c88bSJoe Perches # before $max_line_length 382747e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 382847e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 382947e0c88bSJoe Perches $msg_type = ""; 383047e0c88bSJoe Perches 383147e0c88bSJoe Perches # lines with only strings (w/ possible termination) 383247e0c88bSJoe Perches # #defines with only strings 383347e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 383447e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 383547e0c88bSJoe Perches $msg_type = ""; 383647e0c88bSJoe Perches 3837cc147506SJoe Perches # More special cases 3838cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3839cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3840d560a5f8SJoe Perches $msg_type = ""; 3841d560a5f8SJoe Perches 38422e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 38432e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 38442e4bbbc5SAndreas Brauchli $msg_type = ""; 38452e4bbbc5SAndreas Brauchli 384647e0c88bSJoe Perches # Otherwise set the alternate message types 384747e0c88bSJoe Perches 384847e0c88bSJoe Perches # a comment starts before $max_line_length 384947e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 385047e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 385147e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 385247e0c88bSJoe Perches 385347e0c88bSJoe Perches # a quoted string starts before $max_line_length 385447e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 385547e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 385647e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 385747e0c88bSJoe Perches } 385847e0c88bSJoe Perches 385947e0c88bSJoe Perches if ($msg_type ne "" && 386047e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 3861bdc48fa1SJoe Perches my $msg_level = \&WARN; 3862bdc48fa1SJoe Perches $msg_level = \&CHK if ($file); 3863bdc48fa1SJoe Perches &{$msg_level}($msg_type, 3864bdc48fa1SJoe Perches "line length of $length exceeds $max_line_length columns\n" . $herecurr); 38650a920b5bSAndy Whitcroft } 386647e0c88bSJoe Perches } 38670a920b5bSAndy Whitcroft 38688905a67cSAndy Whitcroft# check for adding lines without a newline. 38698905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 387047ca69b8STom Rix if (WARN("MISSING_EOF_NEWLINE", 387147ca69b8STom Rix "adding a line without newline at end of file\n" . $herecurr) && 387247ca69b8STom Rix $fix) { 387347ca69b8STom Rix fix_delete_line($fixlinenr+1, "No newline at end of file"); 387447ca69b8STom Rix } 38758905a67cSAndy Whitcroft } 38768905a67cSAndy Whitcroft 3877de93245cSAditya Srivastava# check for .L prefix local symbols in .S files 3878de93245cSAditya Srivastava if ($realfile =~ /\.S$/ && 3879de93245cSAditya Srivastava $line =~ /^\+\s*(?:[A-Z]+_)?SYM_[A-Z]+_(?:START|END)(?:_[A-Z_]+)?\s*\(\s*\.L/) { 3880de93245cSAditya Srivastava WARN("AVOID_L_PREFIX", 3881f4bf1cd4SJonathan 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); 3882de93245cSAditya Srivastava } 3883de93245cSAditya Srivastava 3884b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3885de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 38860a920b5bSAndy Whitcroft 38870a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 3888713a09deSAntonio Borneo# more than $tabsize must use tabs. 3889c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3890c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3891c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3892d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 38933705ce5bSJoe Perches if (ERROR("CODE_INDENT", 38943705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 38953705ce5bSJoe Perches $fix) { 3896194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 38973705ce5bSJoe Perches } 38980a920b5bSAndy Whitcroft } 38990a920b5bSAndy Whitcroft 390008e44365SAlberto Panizzo# check for space before tabs. 390108e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 390208e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 39033705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 39043705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 39053705ce5bSJoe Perches $fix) { 3906194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3907713a09deSAntonio Borneo s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} 3908194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3909c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 39103705ce5bSJoe Perches } 391108e44365SAlberto Panizzo } 391208e44365SAlberto Panizzo 39136a487211SJoe Perches# check for assignments on the start of a line 39146a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 3915da7355abSAditya Srivastava my $operator = $1; 3916da7355abSAditya Srivastava if (CHK("ASSIGNMENT_CONTINUATIONS", 3917da7355abSAditya Srivastava "Assignment operator '$1' should be on the previous line\n" . $hereprev) && 3918da7355abSAditya Srivastava $fix && $prevrawline =~ /^\+/) { 3919da7355abSAditya Srivastava # add assignment operator to the previous line, remove from current line 3920da7355abSAditya Srivastava $fixed[$fixlinenr - 1] .= " $operator"; 3921da7355abSAditya Srivastava $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//; 3922da7355abSAditya Srivastava } 39236a487211SJoe Perches } 39246a487211SJoe Perches 3925d1fe9c09SJoe Perches# check for && or || at the start of a line 3926d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 39278e08f076SAditya Srivastava my $operator = $1; 39288e08f076SAditya Srivastava if (CHK("LOGICAL_CONTINUATIONS", 39298e08f076SAditya Srivastava "Logical continuations should be on the previous line\n" . $hereprev) && 39308e08f076SAditya Srivastava $fix && $prevrawline =~ /^\+/) { 39318e08f076SAditya Srivastava # insert logical operator at last non-comment, non-whitepsace char on previous line 39328e08f076SAditya Srivastava $prevline =~ /[\s$;]*$/; 39338e08f076SAditya Srivastava my $line_end = substr($prevrawline, $-[0]); 39348e08f076SAditya Srivastava $fixed[$fixlinenr - 1] =~ s/\Q$line_end\E$/ $operator$line_end/; 39358e08f076SAditya Srivastava $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//; 39368e08f076SAditya Srivastava } 3937d1fe9c09SJoe Perches } 3938d1fe9c09SJoe Perches 3939a91e8994SJoe Perches# check indentation starts on a tab stop 39405b57980dSJoe Perches if ($perl_version_ok && 3941bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3942a91e8994SJoe Perches my $indent = length($1); 3943713a09deSAntonio Borneo if ($indent % $tabsize) { 3944a91e8994SJoe Perches if (WARN("TABSTOP", 3945a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3946a91e8994SJoe Perches $fix) { 3947713a09deSAntonio Borneo $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; 3948a91e8994SJoe Perches } 3949a91e8994SJoe Perches } 3950a91e8994SJoe Perches } 3951a91e8994SJoe Perches 3952d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 39535b57980dSJoe Perches if ($perl_version_ok && 3954fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3955d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3956d1fe9c09SJoe Perches my $oldindent = $1; 3957d1fe9c09SJoe Perches my $rest = $2; 3958d1fe9c09SJoe Perches 3959d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3960d1fe9c09SJoe Perches if ($pos >= 0) { 3961b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3962b34a26f3SJoe Perches my $newindent = $2; 3963d1fe9c09SJoe Perches 3964d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3965713a09deSAntonio Borneo "\t" x ($pos / $tabsize) . 3966713a09deSAntonio Borneo " " x ($pos % $tabsize); 3967d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3968d1fe9c09SJoe Perches 3969d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3970d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 39713705ce5bSJoe Perches 39723705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 39733705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 39743705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3975194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39763705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 39773705ce5bSJoe Perches } 3978d1fe9c09SJoe Perches } 3979d1fe9c09SJoe Perches } 3980d1fe9c09SJoe Perches } 3981d1fe9c09SJoe Perches 39826ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 39836ab3a970SJoe Perches# avoid checking a few false positives: 39846ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 39856ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 39866ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 39876ab3a970SJoe Perches# multiline macros that define functions 39886ab3a970SJoe Perches# known attributes or the __attribute__ keyword 39896ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 39906ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 39913705ce5bSJoe Perches if (CHK("SPACING", 3992f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 39933705ce5bSJoe Perches $fix) { 3994194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3995f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 39963705ce5bSJoe Perches } 3997aad4f614SJoe Perches } 3998aad4f614SJoe Perches 399986406b1cSJoe Perches# Block comment styles 400086406b1cSJoe Perches# Networking with an initial /* 400105880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 4002fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 400385ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 4004c70735c2SŁukasz Stelmach $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier 400505880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 400605880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 400705880600SJoe Perches } 400805880600SJoe Perches 400986406b1cSJoe Perches# Block comments use * on subsequent lines 401086406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 401186406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 4012a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 401361135e96SJoe Perches $rawline =~ /^\+/ && #line is new 4014a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 401586406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 401686406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 4017a605e32eSJoe Perches } 4018a605e32eSJoe Perches 401986406b1cSJoe Perches# Block comments use */ on trailing lines 402086406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 4021c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 4022c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 4023c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 402486406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 402586406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 402605880600SJoe Perches } 402705880600SJoe Perches 402808eb9b80SJoe Perches# Block comment * alignment 402908eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 4030af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 4031af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 4032af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 403308eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 4034af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 4035af207524SJoe Perches my $oldindent; 403608eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 4037af207524SJoe Perches if (defined($1)) { 4038af207524SJoe Perches $oldindent = expand_tabs($1); 4039af207524SJoe Perches } else { 4040af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 4041af207524SJoe Perches $oldindent = expand_tabs($1); 4042af207524SJoe Perches } 404308eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 404408eb9b80SJoe Perches my $newindent = $1; 404508eb9b80SJoe Perches $newindent = expand_tabs($newindent); 4046af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 404708eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 404808eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 404908eb9b80SJoe Perches } 405008eb9b80SJoe Perches } 405108eb9b80SJoe Perches 40527f619191SJoe Perches# check for missing blank lines after struct/union declarations 40537f619191SJoe Perches# with exceptions for various attributes and macros 40547f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 40557f619191SJoe Perches $line =~ /^\+/ && 40567f619191SJoe Perches !($line =~ /^\+\s*$/ || 405705dc40e6SJoe Perches $line =~ /^\+\s*(?:EXPORT_SYMBOL|early_param)/ || 40587f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 40597f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 40607f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 40617f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 40627f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 40630bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 40647f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 4065d752fcc8SJoe Perches if (CHK("LINE_SPACING", 4066d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 4067d752fcc8SJoe Perches $fix) { 4068f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 4069d752fcc8SJoe Perches } 40707f619191SJoe Perches } 40717f619191SJoe Perches 4072365dd4eaSJoe Perches# check for multiple consecutive blank lines 4073365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 4074365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 4075365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 4076d752fcc8SJoe Perches if (CHK("LINE_SPACING", 4077d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 4078d752fcc8SJoe Perches $fix) { 4079f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 4080d752fcc8SJoe Perches } 4081d752fcc8SJoe Perches 4082365dd4eaSJoe Perches $last_blank_line = $linenr; 4083365dd4eaSJoe Perches } 4084365dd4eaSJoe Perches 40853b617e3bSJoe Perches# check for missing blank lines after declarations 4086b5e8736aSJoe Perches# (declarations must have the same indentation and not be at the start of line) 4087b5e8736aSJoe Perches if (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/) { 4088b5e8736aSJoe Perches # use temporaries 4089b5e8736aSJoe Perches my $sl = $sline; 4090b5e8736aSJoe Perches my $pl = $prevline; 4091b5e8736aSJoe Perches # remove $Attribute/$Sparse uses to simplify comparisons 4092b5e8736aSJoe Perches $sl =~ s/\b(?:$Attribute|$Sparse)\b//g; 4093b5e8736aSJoe Perches $pl =~ s/\b(?:$Attribute|$Sparse)\b//g; 4094b5e8736aSJoe Perches if (($pl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 40955a4e1fd3SJoe Perches # function pointer declarations 4096b5e8736aSJoe Perches $pl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 40973f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 4098b5e8736aSJoe Perches $pl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 40993f7bac03SJoe Perches # known declaration macros 4100b5e8736aSJoe Perches $pl =~ /^\+\s+$declaration_macros/) && 41013f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 4102b5e8736aSJoe Perches !($pl =~ /^\+\s+$c90_Keywords\b/ || 41033f7bac03SJoe Perches # other possible extensions of declaration lines 4104b5e8736aSJoe Perches $pl =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 41053f7bac03SJoe Perches # not starting a section or a macro "\" extended line 4106b5e8736aSJoe Perches $pl =~ /(?:\{\s*|\\)$/) && 41073f7bac03SJoe Perches # looks like a declaration 4108b5e8736aSJoe Perches !($sl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 41095a4e1fd3SJoe Perches # function pointer declarations 4110b5e8736aSJoe Perches $sl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 41113f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 4112b5e8736aSJoe Perches $sl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 41133f7bac03SJoe Perches # known declaration macros 4114b5e8736aSJoe Perches $sl =~ /^\+\s+$declaration_macros/ || 41153f7bac03SJoe Perches # start of struct or union or enum 4116b5e8736aSJoe Perches $sl =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ || 41173f7bac03SJoe Perches # start or end of block or continuation of declaration 4118b5e8736aSJoe Perches $sl =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 41193f7bac03SJoe Perches # bitfield continuation 4120b5e8736aSJoe Perches $sl =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 41213f7bac03SJoe Perches # other possible extensions of declaration lines 4122b5e8736aSJoe Perches $sl =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/)) { 4123d752fcc8SJoe Perches if (WARN("LINE_SPACING", 4124d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 4125d752fcc8SJoe Perches $fix) { 4126f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 4127d752fcc8SJoe Perches } 41283b617e3bSJoe Perches } 4129b5e8736aSJoe Perches } 41303b617e3bSJoe Perches 41315f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 41326b4c5bebSAndy Whitcroft# Exceptions: 41336b4c5bebSAndy Whitcroft# 1) within comments 41346b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 41356b4c5bebSAndy Whitcroft# 3) hanging labels 41363705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 41375f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 41383705ce5bSJoe Perches if (WARN("LEADING_SPACE", 41393705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 41403705ce5bSJoe Perches $fix) { 4141194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 41423705ce5bSJoe Perches } 41435f7ddae6SRaffaele Recalcati } 41445f7ddae6SRaffaele Recalcati 4145b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 4146b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 4147b9ea10d6SAndy Whitcroft 41485751a24eSJoe Perches# check for unusual line ending [ or ( 41495751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 41505751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 41515751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 41525751a24eSJoe Perches } 41535751a24eSJoe Perches 41544dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 41554dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 41564dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 41574dbed76fSJoe Perches $context_function = $1; 41584dbed76fSJoe Perches } 41594dbed76fSJoe Perches 41604dbed76fSJoe Perches# check if this appears to be the end of function declaration 41614dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 41624dbed76fSJoe Perches undef $context_function; 41634dbed76fSJoe Perches } 41644dbed76fSJoe Perches 4165032a4c0fSJoe Perches# check indentation of any line with a bare else 4166840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 4167032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 4168032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 4169032a4c0fSJoe Perches my $tabs = length($1) + 1; 4170840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 4171840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 4172840080a0SJoe Perches defined $lines[$linenr] && 4173840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 4174032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 4175032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 4176032a4c0fSJoe Perches } 4177032a4c0fSJoe Perches } 4178032a4c0fSJoe Perches 4179c00df19aSJoe Perches# check indentation of a line with a break; 4180dc58bc55SJoe Perches# if the previous line is a goto, return or break 4181dc58bc55SJoe Perches# and is indented the same # of tabs 4182c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 4183c00df19aSJoe Perches my $tabs = $1; 4184dc58bc55SJoe Perches if ($prevline =~ /^\+$tabs(goto|return|break)\b/) { 4185dc58bc55SJoe Perches if (WARN("UNNECESSARY_BREAK", 4186dc58bc55SJoe Perches "break is not useful after a $1\n" . $hereprev) && 4187dc58bc55SJoe Perches $fix) { 4188dc58bc55SJoe Perches fix_delete_line($fixlinenr, $rawline); 4189dc58bc55SJoe Perches } 4190c00df19aSJoe Perches } 4191c00df19aSJoe Perches } 4192c00df19aSJoe Perches 4193c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 4194cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 4195000d1cc1SJoe Perches WARN("CVS_KEYWORD", 4196000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 4197c2fdda0dSAndy Whitcroft } 419822f2a2efSAndy Whitcroft 419956e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 420056e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 420156e77d70SJoe Perches WARN("HOTPLUG_SECTION", 420256e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 420356e77d70SJoe Perches } 420456e77d70SJoe Perches 42059c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 42062b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 42072b474a1aSAndy Whitcroft $realline_next); 42083e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 4209ca819864SJoe Perches if ($linenr > $suppress_statement && 42101b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 4211170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 4212f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4213171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 4214171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 4215171ae1a4SAndy Whitcroft 42163e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 42173e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 42183e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 42193e469cdcSAndy Whitcroft # until we hit end of it. 42203e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 42213e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 42223e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 42233e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 42243e469cdcSAndy Whitcroft } 4225f74bd194SAndy Whitcroft 42262b474a1aSAndy Whitcroft # Find the real next line. 42272b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 42282b474a1aSAndy Whitcroft if (defined $realline_next && 42292b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 42302b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 42312b474a1aSAndy Whitcroft $realline_next++; 42322b474a1aSAndy Whitcroft } 42332b474a1aSAndy Whitcroft 4234171ae1a4SAndy Whitcroft my $s = $stat; 4235171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 4236cf655043SAndy Whitcroft 4237c2fdda0dSAndy Whitcroft # Ignore goto labels. 4238171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 4239c2fdda0dSAndy Whitcroft 4240c2fdda0dSAndy Whitcroft # Ignore functions being called 4241171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 4242c2fdda0dSAndy Whitcroft 4243463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 4244463f2864SAndy Whitcroft 4245c45dcabdSAndy Whitcroft # declarations always start with types 4246d2506586SAndy 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) { 4247c45dcabdSAndy Whitcroft my $type = $1; 4248c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 4249c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 4250c45dcabdSAndy Whitcroft 42516c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 4252a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 4253c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 4254c2fdda0dSAndy Whitcroft } 42558905a67cSAndy Whitcroft 42566c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 425765863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 4258c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 42599c0ca6f9SAndy Whitcroft } 42608905a67cSAndy Whitcroft 42618905a67cSAndy Whitcroft # Check for any sort of function declaration. 42628905a67cSAndy Whitcroft # int foo(something bar, other baz); 42638905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 4264171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 42658905a67cSAndy Whitcroft my ($name_len) = length($1); 42668905a67cSAndy Whitcroft 4267cf655043SAndy Whitcroft my $ctx = $s; 4268773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 42698905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 4270cf655043SAndy Whitcroft 42718905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 4272c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 42738905a67cSAndy Whitcroft 4274c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 42758905a67cSAndy Whitcroft } 42768905a67cSAndy Whitcroft } 42778905a67cSAndy Whitcroft } 42788905a67cSAndy Whitcroft 42799c0ca6f9SAndy Whitcroft } 42809c0ca6f9SAndy Whitcroft 428100df344fSAndy Whitcroft# 428200df344fSAndy Whitcroft# Checks which may be anchored in the context. 428300df344fSAndy Whitcroft# 428400df344fSAndy Whitcroft 428500df344fSAndy Whitcroft# Check for switch () and associated case and default 428600df344fSAndy Whitcroft# statements should be at the same indent. 428700df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 428800df344fSAndy Whitcroft my $err = ''; 428900df344fSAndy Whitcroft my $sep = ''; 429000df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 429100df344fSAndy Whitcroft shift(@ctx); 429200df344fSAndy Whitcroft for my $ctx (@ctx) { 429300df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 429400df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 429500df344fSAndy Whitcroft $indent != $cindent) { 429600df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 429700df344fSAndy Whitcroft $sep = ''; 429800df344fSAndy Whitcroft } else { 429900df344fSAndy Whitcroft $sep = "[...]\n"; 430000df344fSAndy Whitcroft } 430100df344fSAndy Whitcroft } 430200df344fSAndy Whitcroft if ($err ne '') { 4303000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 4304000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 4305de7d4f0eSAndy Whitcroft } 4306de7d4f0eSAndy Whitcroft } 4307de7d4f0eSAndy Whitcroft 4308de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 4309de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 43100fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 4311773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 4312773647a0SAndy Whitcroft 43139c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 43148eef05ddSJoe Perches 43158eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 43168eef05ddSJoe Perches WARN("DEEP_INDENTATION", 43178eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 43188eef05ddSJoe Perches } 43198eef05ddSJoe Perches 4320de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 4321de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 4322de7d4f0eSAndy Whitcroft 4323548596d5SAndy Whitcroft my $ctx_ln = $linenr; 4324548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 4325de7d4f0eSAndy Whitcroft 4326548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 4327548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 4328548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 4329548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 4330548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 4331773647a0SAndy Whitcroft $ctx_ln++; 4332773647a0SAndy Whitcroft } 4333548596d5SAndy Whitcroft 433453210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 433553210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 4336773647a0SAndy Whitcroft 4337773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 4338000d1cc1SJoe Perches ERROR("OPEN_BRACE", 4339000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 434001464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 434100df344fSAndy Whitcroft } 4342773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 4343773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 4344773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 4345773647a0SAndy Whitcroft { 43469c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 43479c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 4348000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 4349000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 435001464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 43519c0ca6f9SAndy Whitcroft } 43529c0ca6f9SAndy Whitcroft } 435300df344fSAndy Whitcroft } 435400df344fSAndy Whitcroft 43554d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 4356f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 43573e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 43583e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 43593e469cdcSAndy Whitcroft if (!defined $stat); 43604d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 43614d001e4dSAndy Whitcroft 43624d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 43634d001e4dSAndy Whitcroft 43649f5af480SJoe Perches # remove inline comments 43659f5af480SJoe Perches $s =~ s/$;/ /g; 43669f5af480SJoe Perches $c =~ s/$;/ /g; 43674d001e4dSAndy Whitcroft 43684d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 43696f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 43706f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 43714d001e4dSAndy Whitcroft 43729f5af480SJoe Perches # Make sure we remove the line prefixes as we have 43739f5af480SJoe Perches # none on the first line, and are going to readd them 43749f5af480SJoe Perches # where necessary. 43759f5af480SJoe Perches $s =~ s/\n./\n/gs; 43769f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 43779f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 43789f5af480SJoe Perches } 43799f5af480SJoe Perches 43804d001e4dSAndy Whitcroft # We want to check the first line inside the block 43814d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 43824d001e4dSAndy Whitcroft # 1) any blank line termination 43834d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 43844d001e4dSAndy Whitcroft # 3) any do (...) { 43854d001e4dSAndy Whitcroft my $continuation = 0; 43864d001e4dSAndy Whitcroft my $check = 0; 43874d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 43884d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 43894d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 43904d001e4dSAndy Whitcroft $continuation = 1; 43914d001e4dSAndy Whitcroft } 43929bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 43934d001e4dSAndy Whitcroft $check = 1; 43944d001e4dSAndy Whitcroft $cond_lines++; 43954d001e4dSAndy Whitcroft } 43964d001e4dSAndy Whitcroft 43974d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 43984d001e4dSAndy Whitcroft # preprocessor statement. 43994d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 44004d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 44014d001e4dSAndy Whitcroft $check = 0; 44024d001e4dSAndy Whitcroft } 44034d001e4dSAndy Whitcroft 44049bd49efeSAndy Whitcroft my $cond_ptr = -1; 4405740504c6SAndy Whitcroft $continuation = 0; 44069bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 44079bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 44084d001e4dSAndy Whitcroft 4409f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 4410f16fa28fSAndy Whitcroft # is not linear. 4411f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 4412f16fa28fSAndy Whitcroft $check = 0; 4413f16fa28fSAndy Whitcroft } 4414f16fa28fSAndy Whitcroft 44159bd49efeSAndy Whitcroft # Ignore: 44169bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 44179bd49efeSAndy Whitcroft # 2) preprocessor lines, and 44189bd49efeSAndy Whitcroft # 3) labels. 4419740504c6SAndy Whitcroft if ($continuation || 4420740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 44219bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 44229bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 4423740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 442430dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 44259bd49efeSAndy Whitcroft $cond_lines++; 44269bd49efeSAndy Whitcroft } 44274d001e4dSAndy Whitcroft } 442830dad6ebSAndy Whitcroft } 44294d001e4dSAndy Whitcroft 44304d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 44314d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 44324d001e4dSAndy Whitcroft 44334d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 44344d001e4dSAndy Whitcroft # this is not this patch's fault. 44354d001e4dSAndy Whitcroft if (!defined($stat_real) || 44364d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 44374d001e4dSAndy Whitcroft $check = 0; 44384d001e4dSAndy Whitcroft } 44394d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 44404d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 44414d001e4dSAndy Whitcroft } 44424d001e4dSAndy Whitcroft 44439bd49efeSAndy 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"; 44444d001e4dSAndy Whitcroft 44459f5af480SJoe Perches if ($check && $s ne '' && 4446713a09deSAntonio Borneo (($sindent % $tabsize) != 0 || 44479f5af480SJoe Perches ($sindent < $indent) || 4448f6950a73SJoe Perches ($sindent == $indent && 4449f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 4450713a09deSAntonio Borneo ($sindent > $indent + $tabsize))) { 4451000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 4452000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 44534d001e4dSAndy Whitcroft } 44544d001e4dSAndy Whitcroft } 44554d001e4dSAndy Whitcroft 44566c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 44576c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 44581f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 44591f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 44606c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 4461c2fdda0dSAndy Whitcroft if ($dbg_values) { 4462c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 4463cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 4464cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 44651f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 4466c2fdda0dSAndy Whitcroft } 44676c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 44686c72ffaaSAndy Whitcroft 446900df344fSAndy Whitcroft#ignore lines not being added 44703705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 447100df344fSAndy Whitcroft 447299ca38c2SJoe Perches# check for self assignments used to avoid compiler warnings 447399ca38c2SJoe Perches# e.g.: int foo = foo, *bar = NULL; 447499ca38c2SJoe Perches# struct foo bar = *(&(bar)); 447599ca38c2SJoe Perches if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) { 447699ca38c2SJoe Perches my $var = $1; 447799ca38c2SJoe Perches if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) { 447899ca38c2SJoe Perches WARN("SELF_ASSIGNMENT", 447999ca38c2SJoe Perches "Do not use self-assignments to avoid compiler warnings\n" . $herecurr); 448099ca38c2SJoe Perches } 448199ca38c2SJoe Perches } 448299ca38c2SJoe Perches 448311ca40a0SJoe Perches# check for dereferences that span multiple lines 448411ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 448511ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 448611ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 448711ca40a0SJoe Perches my $ref = $1; 448811ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 448911ca40a0SJoe Perches $ref .= $1; 449011ca40a0SJoe Perches $ref =~ s/\s//g; 449111ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 449211ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 449311ca40a0SJoe Perches } 449411ca40a0SJoe Perches 4495a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 4496c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 4497a1ce18e4SJoe Perches my $type = $1; 4498a1ce18e4SJoe Perches my $var = $2; 4499207a8e84SJoe Perches $var = "" if (!defined $var); 4500207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 4501a1ce18e4SJoe Perches my $sign = $1; 4502a1ce18e4SJoe Perches my $pointer = $2; 4503a1ce18e4SJoe Perches 4504a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 4505a1ce18e4SJoe Perches 4506a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 4507a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 4508a1ce18e4SJoe Perches $fix) { 4509a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 4510207a8e84SJoe Perches my $comp_pointer = $pointer; 4511207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 4512207a8e84SJoe Perches $decl .= $comp_pointer; 4513207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 4514207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 4515a1ce18e4SJoe Perches } 4516a1ce18e4SJoe Perches } 4517a1ce18e4SJoe Perches } 4518a1ce18e4SJoe Perches 4519653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 45207429c690SAndy Whitcroft if ($dbg_type) { 45217429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 4522000d1cc1SJoe Perches ERROR("TEST_TYPE", 4523000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 45247429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 4525000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 4526000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 45277429c690SAndy Whitcroft } 4528653d4876SAndy Whitcroft next; 4529653d4876SAndy Whitcroft } 4530a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 4531a1ef277eSAndy Whitcroft if ($dbg_attr) { 45329360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 4533000d1cc1SJoe Perches ERROR("TEST_ATTR", 4534000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 45359360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 4536000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 4537000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 4538a1ef277eSAndy Whitcroft } 4539a1ef277eSAndy Whitcroft next; 4540a1ef277eSAndy Whitcroft } 4541653d4876SAndy Whitcroft 4542f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 454399423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 454499423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 4545d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 4546d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 4547f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 4548f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4549f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 4550d752fcc8SJoe Perches my $fixedline = $prevrawline; 4551d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 4552f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 4553d752fcc8SJoe Perches $fixedline = $line; 45548d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 4555f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 4556d752fcc8SJoe Perches } 4557f0a594c1SAndy Whitcroft } 4558f0a594c1SAndy Whitcroft 455900df344fSAndy Whitcroft# 456000df344fSAndy Whitcroft# Checks which are anchored on the added line. 456100df344fSAndy Whitcroft# 456200df344fSAndy Whitcroft 4563653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 4564c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 4565653d4876SAndy Whitcroft my $path = $1; 4566653d4876SAndy Whitcroft if ($path =~ m{//}) { 4567000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 4568495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 4569495e9d84SJoe Perches } 4570495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 4571495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 4572495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 4573653d4876SAndy Whitcroft } 4574653d4876SAndy Whitcroft } 4575653d4876SAndy Whitcroft 457600df344fSAndy Whitcroft# no C99 // comments 457700df344fSAndy Whitcroft if ($line =~ m{//}) { 45783705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 45793705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 45803705ce5bSJoe Perches $fix) { 4581194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 45823705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 45833705ce5bSJoe Perches my $comment = trim($1); 4584194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 45853705ce5bSJoe Perches } 45863705ce5bSJoe Perches } 458700df344fSAndy Whitcroft } 458800df344fSAndy Whitcroft # Remove C99 comments. 45890a920b5bSAndy Whitcroft $line =~ s@//.*@@; 45906c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 45910a920b5bSAndy Whitcroft 45922b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 45932b474a1aSAndy Whitcroft# the whole statement. 45942b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 45952b474a1aSAndy Whitcroft if (defined $realline_next && 45962b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 45972b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 459836794822SChristoph Hellwig ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/)) { 45993cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 46003cbf62dfSAndy Whitcroft # a prefix: 46013cbf62dfSAndy Whitcroft # XXX(foo); 46023cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 4603653d4876SAndy Whitcroft my $name = $1; 460470a11659SJoe Perches $name =~ s/^\s*($Ident).*/$1/; 460587a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 46063cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 46073cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 46083cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 46093cbf62dfSAndy Whitcroft 46103cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 46112b474a1aSAndy Whitcroft \n.}\s*$| 461248012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 461348012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 461448012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 46152b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 46162b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 461748012058SAndy Whitcroft )/x) { 46182b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 46192b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 46202b474a1aSAndy Whitcroft } else { 46212b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 46220a920b5bSAndy Whitcroft } 46230a920b5bSAndy Whitcroft } 46242b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 46252b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 462636794822SChristoph Hellwig ($line =~ /EXPORT_SYMBOL.*\((.*)\)/)) { 46272b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 46282b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 46292b474a1aSAndy Whitcroft } 46302b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 46312b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 4632000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 4633000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 46342b474a1aSAndy Whitcroft } 46350a920b5bSAndy Whitcroft 46365150bda4SJoe Eloff# check for global initialisers. 46375b8f82e1SSong Liu if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/ && 46385b8f82e1SSong Liu !exclude_global_initialisers($realfile)) { 4639d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 46406d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 4641d5e616fcSJoe Perches $fix) { 46426d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 4643d5e616fcSJoe Perches } 4644f0a594c1SAndy Whitcroft } 46450a920b5bSAndy Whitcroft# check for static initialisers. 46466d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 4647d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 46486d32f7a3SJoe Perches "do not initialise statics to $1\n" . 4649d5e616fcSJoe Perches $herecurr) && 4650d5e616fcSJoe Perches $fix) { 46516d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 4652d5e616fcSJoe Perches } 46530a920b5bSAndy Whitcroft } 46540a920b5bSAndy Whitcroft 46551813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 46561813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 46571813087dSJoe Perches my $tmp = trim($1); 46581813087dSJoe Perches WARN("MISORDERED_TYPE", 46591813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 46601813087dSJoe Perches } 46611813087dSJoe Perches 4662809e082eSJoe Perches# check for unnecessary <signed> int declarations of short/long/long long 4663809e082eSJoe Perches while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) { 4664809e082eSJoe Perches my $type = trim($1); 4665809e082eSJoe Perches next if ($type !~ /\bint\b/); 4666809e082eSJoe Perches next if ($type !~ /\b(?:short|long\s+long|long)\b/); 4667809e082eSJoe Perches my $new_type = $type; 4668809e082eSJoe Perches $new_type =~ s/\b\s*int\s*\b/ /; 4669809e082eSJoe Perches $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /; 4670809e082eSJoe Perches $new_type =~ s/^const\s+//; 4671809e082eSJoe Perches $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/); 4672809e082eSJoe Perches $new_type = "const $new_type" if ($type =~ /^const\b/); 4673809e082eSJoe Perches $new_type =~ s/\s+/ /g; 4674809e082eSJoe Perches $new_type = trim($new_type); 4675809e082eSJoe Perches if (WARN("UNNECESSARY_INT", 4676809e082eSJoe Perches "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) && 4677809e082eSJoe Perches $fix) { 4678809e082eSJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/; 4679809e082eSJoe Perches } 4680809e082eSJoe Perches } 4681809e082eSJoe Perches 4682cb710ecaSJoe Perches# check for static const char * arrays. 4683cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 4684000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4685000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 4686cb710ecaSJoe Perches $herecurr); 4687cb710ecaSJoe Perches } 4688cb710ecaSJoe Perches 468977b8c0a8SJoe Perches# check for initialized const char arrays that should be static const 469077b8c0a8SJoe Perches if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) { 469177b8c0a8SJoe Perches if (WARN("STATIC_CONST_CHAR_ARRAY", 469277b8c0a8SJoe Perches "const array should probably be static const\n" . $herecurr) && 469377b8c0a8SJoe Perches $fix) { 469477b8c0a8SJoe Perches $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/; 469577b8c0a8SJoe Perches } 469677b8c0a8SJoe Perches } 469777b8c0a8SJoe Perches 4698cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 4699cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 4700000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4701000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 4702cb710ecaSJoe Perches $herecurr); 4703cb710ecaSJoe Perches } 4704cb710ecaSJoe Perches 4705ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 4706ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 4707ab7e23f3SJoe Perches my $found = $1; 4708ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 4709ab7e23f3SJoe Perches WARN("CONST_CONST", 4710ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 4711ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 4712ab7e23f3SJoe Perches WARN("CONST_CONST", 4713ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 4714ab7e23f3SJoe Perches } 4715ab7e23f3SJoe Perches } 4716ab7e23f3SJoe Perches 471773169765SJoe Perches# check for const static or static <non ptr type> const declarations 471873169765SJoe Perches# prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const' 471973169765SJoe Perches if ($sline =~ /^\+\s*const\s+static\s+($Type)\b/ || 472073169765SJoe Perches $sline =~ /^\+\s*static\s+($BasicType)\s+const\b/) { 472173169765SJoe Perches if (WARN("STATIC_CONST", 472273169765SJoe Perches "Move const after static - use 'static const $1'\n" . $herecurr) && 472373169765SJoe Perches $fix) { 472473169765SJoe Perches $fixed[$fixlinenr] =~ s/\bconst\s+static\b/static const/; 472573169765SJoe Perches $fixed[$fixlinenr] =~ s/\bstatic\s+($BasicType)\s+const\b/static const $1/; 472673169765SJoe Perches } 472773169765SJoe Perches } 472873169765SJoe Perches 47299b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 47309b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 47319b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 47329b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 47339b0fa60dSJoe Perches $herecurr); 47349b0fa60dSJoe Perches } 47359b0fa60dSJoe Perches 4736b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 4737b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 4738b598b670SJoe Perches my $array = $1; 4739b598b670SJoe 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*\))@) { 4740b598b670SJoe Perches my $array_div = $1; 4741b598b670SJoe Perches if (WARN("ARRAY_SIZE", 4742b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 4743b598b670SJoe Perches $fix) { 4744b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 4745b598b670SJoe Perches } 4746b598b670SJoe Perches } 4747b598b670SJoe Perches } 4748b598b670SJoe Perches 4749b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 475016b7f3c8SJoe Perches if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) { 4751b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 4752b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 4753b36190c5SJoe Perches $fix) { 4754194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 4755b36190c5SJoe Perches } 4756b36190c5SJoe Perches } 4757b36190c5SJoe Perches 4758653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 4759653d4876SAndy Whitcroft# make sense. 4760653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 47618054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 4762c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 47638ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 476446d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 4765000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 4766000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 47670a920b5bSAndy Whitcroft } 47680a920b5bSAndy Whitcroft 47690a920b5bSAndy Whitcroft# * goes on variable not on type 477065863862SAndy Whitcroft # (char*[ const]) 4771bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 4772bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 47733705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 4774d8aaf121SAndy Whitcroft 477565863862SAndy Whitcroft # Should start with a space. 477665863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 477765863862SAndy Whitcroft # Should not end with a space. 477865863862SAndy Whitcroft $to =~ s/\s+$//; 477965863862SAndy Whitcroft # '*'s should not have spaces between. 4780f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 478165863862SAndy Whitcroft } 4782d8aaf121SAndy Whitcroft 47833705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 478465863862SAndy Whitcroft if ($from ne $to) { 47853705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 47863705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 47873705ce5bSJoe Perches $fix) { 47883705ce5bSJoe Perches my $sub_from = $ident; 47893705ce5bSJoe Perches my $sub_to = $ident; 47903705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4791194f66fcSJoe Perches $fixed[$fixlinenr] =~ 47923705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 47933705ce5bSJoe Perches } 479465863862SAndy Whitcroft } 4795bfcb2cc7SAndy Whitcroft } 4796bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 4797bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 47983705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 4799d8aaf121SAndy Whitcroft 480065863862SAndy Whitcroft # Should start with a space. 480165863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 480265863862SAndy Whitcroft # Should not end with a space. 480365863862SAndy Whitcroft $to =~ s/\s+$//; 480465863862SAndy Whitcroft # '*'s should not have spaces between. 4805f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 480665863862SAndy Whitcroft } 480765863862SAndy Whitcroft # Modifiers should have spaces. 480865863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 480965863862SAndy Whitcroft 48103705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 4811667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 48123705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 48133705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 48143705ce5bSJoe Perches $fix) { 48153705ce5bSJoe Perches 48163705ce5bSJoe Perches my $sub_from = $match; 48173705ce5bSJoe Perches my $sub_to = $match; 48183705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4819194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48203705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 48213705ce5bSJoe Perches } 482265863862SAndy Whitcroft } 48230a920b5bSAndy Whitcroft } 48240a920b5bSAndy Whitcroft 482569d517e6SDavid Hildenbrand# do not use BUG() or variants 482669d517e6SDavid Hildenbrand if ($line =~ /\b(?!AA_|BUILD_|DCCP_|IDA_|KVM_|RWLOCK_|snd_|SPIN_)(?:[a-zA-Z_]*_)?BUG(?:_ON)?(?:_[A-Z_]+)?\s*\(/) { 48270675a8fbSJean Delvare my $msg_level = \&WARN; 48280675a8fbSJean Delvare $msg_level = \&CHK if ($file); 48290675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 483069d517e6SDavid 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); 48319d3e3c70SJoe Perches } 48320a920b5bSAndy Whitcroft 48339d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 48348905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 4835000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 4836000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 48378905a67cSAndy Whitcroft } 48388905a67cSAndy Whitcroft 483917441227SJoe Perches# check for uses of printk_ratelimit 484017441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 4841000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 4842000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 484317441227SJoe Perches } 484417441227SJoe Perches 4845eeef5733SJoe Perches# printk should use KERN_* levels 4846eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 4847000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 4848eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 484900df344fSAndy Whitcroft } 48500a920b5bSAndy Whitcroft 4851f5eea3b0SJoe Perches# prefer variants of (subsystem|netdev|dev|pr)_<level> to printk(KERN_<LEVEL> 4852f5eea3b0SJoe Perches if ($line =~ /\b(printk(_once|_ratelimited)?)\s*\(\s*KERN_([A-Z]+)/) { 4853f5eea3b0SJoe Perches my $printk = $1; 4854f5eea3b0SJoe Perches my $modifier = $2; 4855f5eea3b0SJoe Perches my $orig = $3; 4856f5eea3b0SJoe Perches $modifier = "" if (!defined($modifier)); 4857243f3803SJoe Perches my $level = lc($orig); 4858243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 48598f26b837SJoe Perches my $level2 = $level; 48608f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 4861f5eea3b0SJoe Perches $level .= $modifier; 4862f5eea3b0SJoe Perches $level2 .= $modifier; 4863243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 4864f5eea3b0SJoe Perches "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to $printk(KERN_$orig ...\n" . $herecurr); 4865243f3803SJoe Perches } 4866243f3803SJoe Perches 4867f5eea3b0SJoe Perches# prefer dev_<level> to dev_printk(KERN_<LEVEL> 4868dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 4869dc139313SJoe Perches my $orig = $1; 4870dc139313SJoe Perches my $level = lc($orig); 4871dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 4872dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 4873dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 4874dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 4875dc139313SJoe Perches } 4876dc139313SJoe Perches 48778020b253SNicolas Boichat# trace_printk should not be used in production code. 48788020b253SNicolas Boichat if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) { 48798020b253SNicolas Boichat WARN("TRACE_PRINTK", 48808020b253SNicolas Boichat "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr); 48818020b253SNicolas Boichat } 48828020b253SNicolas Boichat 488391c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 488491c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 488591c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 488691c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 488791c9afafSAndy Lutomirski WARN("ENOSYS", 488891c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 488991c9afafSAndy Lutomirski } 489091c9afafSAndy Lutomirski 48916b9ea5ffSJakub Kicinski# ENOTSUPP is not a standard error code and should be avoided in new patches. 48926b9ea5ffSJakub Kicinski# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP. 48936b9ea5ffSJakub Kicinski# Similarly to ENOSYS warning a small number of false positives is expected. 48946b9ea5ffSJakub Kicinski if (!$file && $line =~ /\bENOTSUPP\b/) { 48956b9ea5ffSJakub Kicinski if (WARN("ENOTSUPP", 48966b9ea5ffSJakub Kicinski "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) && 48976b9ea5ffSJakub Kicinski $fix) { 48986b9ea5ffSJakub Kicinski $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/; 48996b9ea5ffSJakub Kicinski } 49006b9ea5ffSJakub Kicinski } 49016b9ea5ffSJakub Kicinski 4902653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 4903653d4876SAndy Whitcroft# or if closed on same line 49045b57980dSJoe Perches if ($perl_version_ok && 49052d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 49062d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 49072d453e3bSJoe Perches $sline !~ /}/) { 49088d182478SJoe Perches if (ERROR("OPEN_BRACE", 49092d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 49108d182478SJoe Perches $fix) { 49118d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 49128d182478SJoe Perches my $fixed_line = $rawline; 491303f49351SDwaipayan Ray $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*)\{(.*)$/; 49148d182478SJoe Perches my $line1 = $1; 49158d182478SJoe Perches my $line2 = $2; 49168d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 49178d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 49188d182478SJoe Perches if ($line2 !~ /^\s*$/) { 49198d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 49208d182478SJoe Perches } 49218d182478SJoe Perches } 49220a920b5bSAndy Whitcroft } 4923653d4876SAndy Whitcroft 49248905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 49258905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 49268905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 49278d182478SJoe Perches if (ERROR("OPEN_BRACE", 49288d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 49298d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 49308d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 49318d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 49328d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 49338d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 49348d182478SJoe Perches $fixedline = $rawline; 49358d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 49368d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 49378d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 49388d182478SJoe Perches } 49398d182478SJoe Perches } 49408905a67cSAndy Whitcroft } 49418905a67cSAndy Whitcroft 49420c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 49433705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 49443705ce5bSJoe Perches if (WARN("SPACING", 49453705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 49463705ce5bSJoe Perches $fix) { 4947194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49483705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 49493705ce5bSJoe Perches } 49500c73b4ebSAndy Whitcroft } 49510c73b4ebSAndy Whitcroft 495231070b5dSJoe Perches# Function pointer declarations 495331070b5dSJoe Perches# check spacing between type, funcptr, and args 495431070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 495591f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 495631070b5dSJoe Perches my $declare = $1; 495731070b5dSJoe Perches my $pre_pointer_space = $2; 495831070b5dSJoe Perches my $post_pointer_space = $3; 495931070b5dSJoe Perches my $funcname = $4; 496031070b5dSJoe Perches my $post_funcname_space = $5; 496131070b5dSJoe Perches my $pre_args_space = $6; 496231070b5dSJoe Perches 496391f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 496491f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 496591f72e9cSJoe Perches# don't need a space so don't warn for those. 496691f72e9cSJoe Perches my $post_declare_space = ""; 496791f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 496891f72e9cSJoe Perches $post_declare_space = $1; 496991f72e9cSJoe Perches $declare = rtrim($declare); 497091f72e9cSJoe Perches } 497191f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 497231070b5dSJoe Perches WARN("SPACING", 497331070b5dSJoe Perches "missing space after return type\n" . $herecurr); 497491f72e9cSJoe Perches $post_declare_space = " "; 497531070b5dSJoe Perches } 497631070b5dSJoe Perches 497731070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 497891f72e9cSJoe Perches# This test is not currently implemented because these declarations are 497991f72e9cSJoe Perches# equivalent to 498091f72e9cSJoe Perches# int foo(int bar, ...) 498191f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 498291f72e9cSJoe Perches# 498391f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 498491f72e9cSJoe Perches# WARN("SPACING", 498591f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 498691f72e9cSJoe Perches# } 498731070b5dSJoe Perches 498831070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 498931070b5dSJoe Perches if (defined $pre_pointer_space && 499031070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 499131070b5dSJoe Perches WARN("SPACING", 499231070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 499331070b5dSJoe Perches } 499431070b5dSJoe Perches 499531070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 499631070b5dSJoe Perches if (defined $post_pointer_space && 499731070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 499831070b5dSJoe Perches WARN("SPACING", 499931070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 500031070b5dSJoe Perches } 500131070b5dSJoe Perches 500231070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 500331070b5dSJoe Perches if (defined $post_funcname_space && 500431070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 500531070b5dSJoe Perches WARN("SPACING", 500631070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 500731070b5dSJoe Perches } 500831070b5dSJoe Perches 500931070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 501031070b5dSJoe Perches if (defined $pre_args_space && 501131070b5dSJoe Perches $pre_args_space =~ /^\s/) { 501231070b5dSJoe Perches WARN("SPACING", 501331070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 501431070b5dSJoe Perches } 501531070b5dSJoe Perches 501631070b5dSJoe Perches if (show_type("SPACING") && $fix) { 5017194f66fcSJoe Perches $fixed[$fixlinenr] =~ 501891f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 501931070b5dSJoe Perches } 502031070b5dSJoe Perches } 502131070b5dSJoe Perches 50228d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 50238d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 5024fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 5025fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 50268d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 50278d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 50288d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 5029fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 503038dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 50313705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 50323705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 50333705ce5bSJoe Perches $fix) { 5034194f66fcSJoe Perches $fixed[$fixlinenr] =~ 50353705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 50363705ce5bSJoe Perches } 50378d31cfceSAndy Whitcroft } 50388d31cfceSAndy Whitcroft } 50398d31cfceSAndy Whitcroft 5040f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 50416c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 5042c2fdda0dSAndy Whitcroft my $name = $1; 5043773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 5044773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 5045c2fdda0dSAndy Whitcroft 5046c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 5047773647a0SAndy Whitcroft if ($name =~ /^(?: 5048773647a0SAndy Whitcroft if|for|while|switch|return|case| 5049773647a0SAndy Whitcroft volatile|__volatile__| 5050773647a0SAndy Whitcroft __attribute__|format|__extension__| 505154da6a09SPeter Zijlstra asm|__asm__|scoped_guard)$/x) 5052773647a0SAndy Whitcroft { 5053c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 5054c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 5055c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 5056c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 5057773647a0SAndy Whitcroft 5058773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 5059c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 5060c2fdda0dSAndy Whitcroft 5061c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 5062c2fdda0dSAndy Whitcroft # likely a typedef for a function. 5063773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 5064c2fdda0dSAndy Whitcroft 5065c2fdda0dSAndy Whitcroft } else { 50663705ce5bSJoe Perches if (WARN("SPACING", 50673705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 50683705ce5bSJoe Perches $fix) { 5069194f66fcSJoe Perches $fixed[$fixlinenr] =~ 50703705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 50713705ce5bSJoe Perches } 5072f0a594c1SAndy Whitcroft } 50736c72ffaaSAndy Whitcroft } 50749a4cad4eSEric Nelson 5075653d4876SAndy Whitcroft# Check operator spacing. 50760a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 50773705ce5bSJoe Perches my $fixed_line = ""; 50783705ce5bSJoe Perches my $line_fixed = 0; 50793705ce5bSJoe Perches 50809c0ca6f9SAndy Whitcroft my $ops = qr{ 50819c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 50829c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 50839c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 50841f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 508584731623SJoe Perches \?:|\?|: 50869c0ca6f9SAndy Whitcroft }x; 5087cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 50883705ce5bSJoe Perches 50893705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 50903705ce5bSJoe Perches## foreach my $el (@elements) { 50913705ce5bSJoe Perches## print("el: <$el>\n"); 50923705ce5bSJoe Perches## } 50933705ce5bSJoe Perches 50943705ce5bSJoe Perches my @fix_elements = (); 509500df344fSAndy Whitcroft my $off = 0; 50966c72ffaaSAndy Whitcroft 50973705ce5bSJoe Perches foreach my $el (@elements) { 50983705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 50993705ce5bSJoe Perches $off += length($el); 51003705ce5bSJoe Perches } 51013705ce5bSJoe Perches 51023705ce5bSJoe Perches $off = 0; 51033705ce5bSJoe Perches 51046c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 5105b34c648bSJoe Perches my $last_after = -1; 51066c72ffaaSAndy Whitcroft 51070a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 51083705ce5bSJoe Perches 51093705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 51103705ce5bSJoe Perches 51113705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 51123705ce5bSJoe Perches 51134a0df2efSAndy Whitcroft $off += length($elements[$n]); 51144a0df2efSAndy Whitcroft 511525985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 5116773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 5117773647a0SAndy Whitcroft my $cc = ''; 5118773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 5119773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 5120773647a0SAndy Whitcroft } 5121773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 5122773647a0SAndy Whitcroft 51234a0df2efSAndy Whitcroft my $a = ''; 51244a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 51254a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 5126cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 51274a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 51284a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 5129773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 51304a0df2efSAndy Whitcroft 51310a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 51324a0df2efSAndy Whitcroft 51334a0df2efSAndy Whitcroft my $c = ''; 51340a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 51354a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 51364a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 5137cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 51384a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 51394a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 51408b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 51414a0df2efSAndy Whitcroft } else { 51424a0df2efSAndy Whitcroft $c = 'E'; 51430a920b5bSAndy Whitcroft } 51440a920b5bSAndy Whitcroft 51454a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 51464a0df2efSAndy Whitcroft 51474a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 51484a0df2efSAndy Whitcroft 51496c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 5150de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 51510a920b5bSAndy Whitcroft 515274048ed8SAndy Whitcroft # Pull out the value of this operator. 51536c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 51540a920b5bSAndy Whitcroft 51551f65f947SAndy Whitcroft # Get the full operator variant. 51561f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 51571f65f947SAndy Whitcroft 515813214adfSAndy Whitcroft # Ignore operators passed as parameters. 515913214adfSAndy Whitcroft if ($op_type ne 'V' && 5160d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 516113214adfSAndy Whitcroft 5162cf655043SAndy Whitcroft# # Ignore comments 5163cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 516413214adfSAndy Whitcroft 5165d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 516613214adfSAndy Whitcroft } elsif ($op eq ';') { 5167cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 5168cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 51693705ce5bSJoe Perches if (ERROR("SPACING", 51703705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 5171b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 51723705ce5bSJoe Perches $line_fixed = 1; 51733705ce5bSJoe Perches } 5174d8aaf121SAndy Whitcroft } 5175d8aaf121SAndy Whitcroft 5176d8aaf121SAndy Whitcroft # // is a comment 5177d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 51780a920b5bSAndy Whitcroft 5179b00e4814SJoe Perches # : when part of a bitfield 5180b00e4814SJoe Perches } elsif ($opv eq ':B') { 5181b00e4814SJoe Perches # skip the bitfield test for now 5182b00e4814SJoe Perches 51831f65f947SAndy Whitcroft # No spaces for: 51841f65f947SAndy Whitcroft # -> 5185b00e4814SJoe Perches } elsif ($op eq '->') { 51864a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 51873705ce5bSJoe Perches if (ERROR("SPACING", 51883705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 5189b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 51903705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 51913705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 51923705ce5bSJoe Perches } 5193b34c648bSJoe Perches $line_fixed = 1; 51943705ce5bSJoe Perches } 51950a920b5bSAndy Whitcroft } 51960a920b5bSAndy Whitcroft 51972381097bSJoe Perches # , must not have a space before and must have a space on the right. 51980a920b5bSAndy Whitcroft } elsif ($op eq ',') { 51992381097bSJoe Perches my $rtrim_before = 0; 52002381097bSJoe Perches my $space_after = 0; 52012381097bSJoe Perches if ($ctx =~ /Wx./) { 52022381097bSJoe Perches if (ERROR("SPACING", 52032381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 52042381097bSJoe Perches $line_fixed = 1; 52052381097bSJoe Perches $rtrim_before = 1; 52062381097bSJoe Perches } 52072381097bSJoe Perches } 5208cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 52093705ce5bSJoe Perches if (ERROR("SPACING", 52103705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 52113705ce5bSJoe Perches $line_fixed = 1; 5212b34c648bSJoe Perches $last_after = $n; 52132381097bSJoe Perches $space_after = 1; 52142381097bSJoe Perches } 52152381097bSJoe Perches } 52162381097bSJoe Perches if ($rtrim_before || $space_after) { 52172381097bSJoe Perches if ($rtrim_before) { 52182381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 52192381097bSJoe Perches } else { 52202381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 52212381097bSJoe Perches } 52222381097bSJoe Perches if ($space_after) { 52232381097bSJoe Perches $good .= " "; 52243705ce5bSJoe Perches } 52250a920b5bSAndy Whitcroft } 52260a920b5bSAndy Whitcroft 52279c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 522874048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 52299c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 52309c0ca6f9SAndy Whitcroft 52319c0ca6f9SAndy Whitcroft # unary operators should have a space before and 52329c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 52339c0ca6f9SAndy Whitcroft # unary operator, or a cast 52349c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 523574048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 52360d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 5237cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 52383705ce5bSJoe Perches if (ERROR("SPACING", 52393705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 5240b34c648bSJoe Perches if ($n != $last_after + 2) { 5241b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 52423705ce5bSJoe Perches $line_fixed = 1; 52433705ce5bSJoe Perches } 52440a920b5bSAndy Whitcroft } 5245b34c648bSJoe Perches } 5246a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 5247171ae1a4SAndy Whitcroft # A unary '*' may be const 5248171ae1a4SAndy Whitcroft 5249171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 52503705ce5bSJoe Perches if (ERROR("SPACING", 52513705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 5252b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 52533705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 52543705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 52553705ce5bSJoe Perches } 5256b34c648bSJoe Perches $line_fixed = 1; 52573705ce5bSJoe Perches } 52580a920b5bSAndy Whitcroft } 52590a920b5bSAndy Whitcroft 52600a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 52610a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 5262773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 52633705ce5bSJoe Perches if (ERROR("SPACING", 52643705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 5265b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 52663705ce5bSJoe Perches $line_fixed = 1; 52673705ce5bSJoe Perches } 52680a920b5bSAndy Whitcroft } 5269773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 5270773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 52713705ce5bSJoe Perches if (ERROR("SPACING", 52723705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 5273b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 52743705ce5bSJoe Perches $line_fixed = 1; 52753705ce5bSJoe Perches } 5276653d4876SAndy Whitcroft } 5277773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 52783705ce5bSJoe Perches if (ERROR("SPACING", 52793705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 5280b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 52813705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 52823705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5283773647a0SAndy Whitcroft } 5284b34c648bSJoe Perches $line_fixed = 1; 52853705ce5bSJoe Perches } 52863705ce5bSJoe Perches } 52870a920b5bSAndy Whitcroft 52880a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 52899c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 52909c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 52919c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 5292c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 5293c2fdda0dSAndy Whitcroft $op eq '%') 52940a920b5bSAndy Whitcroft { 5295d2e025f3SJoe Perches if ($check) { 5296d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 5297d2e025f3SJoe Perches if (CHK("SPACING", 5298d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 5299d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 5300d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5301d2e025f3SJoe Perches $line_fixed = 1; 5302d2e025f3SJoe Perches } 5303d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 5304d2e025f3SJoe Perches if (CHK("SPACING", 5305d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 5306d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 5307d2e025f3SJoe Perches $line_fixed = 1; 5308d2e025f3SJoe Perches } 5309d2e025f3SJoe Perches } 5310d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 53113705ce5bSJoe Perches if (ERROR("SPACING", 53123705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 5313b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 5314b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 5315b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5316b34c648bSJoe Perches } 53173705ce5bSJoe Perches $line_fixed = 1; 53183705ce5bSJoe Perches } 53190a920b5bSAndy Whitcroft } 53200a920b5bSAndy Whitcroft 53211f65f947SAndy Whitcroft # A colon needs no spaces before when it is 53221f65f947SAndy Whitcroft # terminating a case value or a label. 53231f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 5324263afd39SChris Down if ($ctx =~ /Wx./ and $realfile !~ m@.*\.lds\.h$@) { 53253705ce5bSJoe Perches if (ERROR("SPACING", 53263705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 5327b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 53283705ce5bSJoe Perches $line_fixed = 1; 53293705ce5bSJoe Perches } 53301f65f947SAndy Whitcroft } 53311f65f947SAndy Whitcroft 53320a920b5bSAndy Whitcroft # All the others need spaces both sides. 5333cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 53341f65f947SAndy Whitcroft my $ok = 0; 53351f65f947SAndy Whitcroft 533622f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 53371f65f947SAndy Whitcroft if (($op eq '<' && 53381f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 53391f65f947SAndy Whitcroft ($op eq '>' && 53401f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 53411f65f947SAndy Whitcroft { 53421f65f947SAndy Whitcroft $ok = 1; 53431f65f947SAndy Whitcroft } 53441f65f947SAndy Whitcroft 5345e0df7e1fSJoe Perches # for asm volatile statements 5346e0df7e1fSJoe Perches # ignore a colon with another 5347e0df7e1fSJoe Perches # colon immediately before or after 5348e0df7e1fSJoe Perches if (($op eq ':') && 5349e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 5350e0df7e1fSJoe Perches $ok = 1; 5351e0df7e1fSJoe Perches } 5352e0df7e1fSJoe Perches 535384731623SJoe Perches # messages are ERROR, but ?: are CHK 53541f65f947SAndy Whitcroft if ($ok == 0) { 53550675a8fbSJean Delvare my $msg_level = \&ERROR; 53560675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 535784731623SJoe Perches 53580675a8fbSJean Delvare if (&{$msg_level}("SPACING", 53593705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 5360b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 5361b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 5362b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5363b34c648bSJoe Perches } 53643705ce5bSJoe Perches $line_fixed = 1; 53653705ce5bSJoe Perches } 53660a920b5bSAndy Whitcroft } 536722f2a2efSAndy Whitcroft } 53684a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 53693705ce5bSJoe Perches 53703705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 53713705ce5bSJoe Perches 53723705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 53730a920b5bSAndy Whitcroft } 53743705ce5bSJoe Perches 53753705ce5bSJoe Perches if (($#elements % 2) == 0) { 53763705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 53773705ce5bSJoe Perches } 53783705ce5bSJoe Perches 5379194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 5380194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 53813705ce5bSJoe Perches } 53823705ce5bSJoe Perches 53833705ce5bSJoe Perches 53840a920b5bSAndy Whitcroft } 53850a920b5bSAndy Whitcroft 5386786b6326SJoe Perches# check for whitespace before a non-naked semicolon 5387d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 5388786b6326SJoe Perches if (WARN("SPACING", 5389786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 5390786b6326SJoe Perches $fix) { 5391194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 5392786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 5393786b6326SJoe Perches } 5394786b6326SJoe Perches } 5395786b6326SJoe Perches 5396f0a594c1SAndy Whitcroft# check for multiple assignments 5397f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 5398000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 5399000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 5400f0a594c1SAndy Whitcroft } 5401f0a594c1SAndy Whitcroft 540222f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 540322f2a2efSAndy Whitcroft## # continuation. 540422f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 540522f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 540622f2a2efSAndy Whitcroft## 540722f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 5408e73d2715SDwaipayan Ray## # falsely report the parameters of functions. 540922f2a2efSAndy Whitcroft## my $ln = $line; 541022f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 541122f2a2efSAndy Whitcroft## } 541222f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 5413000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 5414000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 541522f2a2efSAndy Whitcroft## } 541622f2a2efSAndy Whitcroft## } 5417f0a594c1SAndy Whitcroft 54180a920b5bSAndy Whitcroft#need space before brace following if, while, etc 54196b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 54206ad724e2SMichal Zylowski $line =~ /\b(?:else|do)\{/) { 54213705ce5bSJoe Perches if (ERROR("SPACING", 54223705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 54233705ce5bSJoe Perches $fix) { 54246ad724e2SMichal Zylowski $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/; 54253705ce5bSJoe Perches } 5426de7d4f0eSAndy Whitcroft } 5427de7d4f0eSAndy Whitcroft 5428c4a62ef9SJoe Perches## # check for blank lines before declarations 5429c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 5430c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 5431c4a62ef9SJoe Perches## WARN("SPACING", 5432c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 5433c4a62ef9SJoe Perches## } 5434c4a62ef9SJoe Perches## 5435c4a62ef9SJoe Perches 5436de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 5437de7d4f0eSAndy Whitcroft# on the line 543894fb9845SJoe Perches if ($line =~ /}(?!(?:,|;|\)|\}))\S/) { 5439d5e616fcSJoe Perches if (ERROR("SPACING", 5440d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 5441d5e616fcSJoe Perches $fix) { 5442194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5443d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 5444d5e616fcSJoe Perches } 54450a920b5bSAndy Whitcroft } 54460a920b5bSAndy Whitcroft 544722f2a2efSAndy Whitcroft# check spacing on square brackets 544822f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 54493705ce5bSJoe Perches if (ERROR("SPACING", 54503705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 54513705ce5bSJoe Perches $fix) { 5452194f66fcSJoe Perches $fixed[$fixlinenr] =~ 54533705ce5bSJoe Perches s/\[\s+/\[/; 54543705ce5bSJoe Perches } 545522f2a2efSAndy Whitcroft } 545622f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 54573705ce5bSJoe Perches if (ERROR("SPACING", 54583705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 54593705ce5bSJoe Perches $fix) { 5460194f66fcSJoe Perches $fixed[$fixlinenr] =~ 54613705ce5bSJoe Perches s/\s+\]/\]/; 54623705ce5bSJoe Perches } 546322f2a2efSAndy Whitcroft } 546422f2a2efSAndy Whitcroft 5465c45dcabdSAndy Whitcroft# check spacing on parentheses 54669c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 54679c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 54683705ce5bSJoe Perches if (ERROR("SPACING", 54693705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 54703705ce5bSJoe Perches $fix) { 5471194f66fcSJoe Perches $fixed[$fixlinenr] =~ 54723705ce5bSJoe Perches s/\(\s+/\(/; 54733705ce5bSJoe Perches } 547422f2a2efSAndy Whitcroft } 547513214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 5476c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 5477c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 54783705ce5bSJoe Perches if (ERROR("SPACING", 54793705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 54803705ce5bSJoe Perches $fix) { 5481194f66fcSJoe Perches $fixed[$fixlinenr] =~ 54823705ce5bSJoe Perches s/\s+\)/\)/; 54833705ce5bSJoe Perches } 548422f2a2efSAndy Whitcroft } 548522f2a2efSAndy Whitcroft 5486e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 5487e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 5488e2826fd0SJoe Perches 5489e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 5490ea4acbb1SJoe Perches my $var = $1; 5491ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 5492ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 5493ea4acbb1SJoe Perches $fix) { 5494ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 5495ea4acbb1SJoe Perches } 5496ea4acbb1SJoe Perches } 5497ea4acbb1SJoe Perches 5498ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 5499ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 5500ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 5501ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 5502ea4acbb1SJoe Perches my $var = $2; 5503ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 5504ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 5505ea4acbb1SJoe Perches $fix) { 5506ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 5507ea4acbb1SJoe Perches $var2 =~ s/\s//g; 5508ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 5509ea4acbb1SJoe Perches } 5510e2826fd0SJoe Perches } 5511e2826fd0SJoe Perches 551263b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 5513a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 5514a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 55155b57980dSJoe Perches $perl_version_ok && defined($stat) && 551663b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 551763b7c73eSJoe Perches my $if_stat = $1; 551863b7c73eSJoe Perches my $test = substr($2, 1, -1); 551963b7c73eSJoe Perches my $herectx; 552063b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 552163b7c73eSJoe Perches my $match = $1; 552263b7c73eSJoe Perches # avoid parentheses around potential macro args 552363b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 552463b7c73eSJoe Perches if (!defined($herectx)) { 552563b7c73eSJoe Perches $herectx = $here . "\n"; 552663b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 552763b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 552863b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 552963b7c73eSJoe Perches $herectx .= $rl . "\n"; 553063b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 553163b7c73eSJoe Perches } 553263b7c73eSJoe Perches } 553363b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 553463b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 553563b7c73eSJoe Perches } 553663b7c73eSJoe Perches } 553763b7c73eSJoe Perches 553869078651SJoe Perches# check that goto labels aren't indented (allow a single space indentation) 553969078651SJoe Perches# and ignore bitfield definitions like foo:1 554069078651SJoe Perches# Strictly, labels can have whitespace after the identifier and before the : 554169078651SJoe Perches# but this is not allowed here as many ?: uses would appear to be labels 554269078651SJoe Perches if ($sline =~ /^.\s+[A-Za-z_][A-Za-z\d_]*:(?!\s*\d+)/ && 554369078651SJoe Perches $sline !~ /^. [A-Za-z\d_][A-Za-z\d_]*:/ && 554469078651SJoe Perches $sline !~ /^.\s+default:/) { 55453705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 55463705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 55473705ce5bSJoe Perches $fix) { 5548194f66fcSJoe Perches $fixed[$fixlinenr] =~ 55493705ce5bSJoe Perches s/^(.)\s+/$1/; 55503705ce5bSJoe Perches } 55510a920b5bSAndy Whitcroft } 55520a920b5bSAndy Whitcroft 555340873abaSJoe Perches# check if a statement with a comma should be two statements like: 555440873abaSJoe Perches# foo = bar(), /* comma should be semicolon */ 555540873abaSJoe Perches# bar = baz(); 555640873abaSJoe Perches if (defined($stat) && 555740873abaSJoe Perches $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) { 555840873abaSJoe Perches my $cnt = statement_rawlines($stat); 555940873abaSJoe Perches my $herectx = get_stat_here($linenr, $cnt, $here); 556040873abaSJoe Perches WARN("SUSPECT_COMMA_SEMICOLON", 556140873abaSJoe Perches "Possible comma where semicolon could be used\n" . $herectx); 556240873abaSJoe Perches } 556340873abaSJoe Perches 55645b9553abSJoe Perches# return is not a function 5565507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 5566c45dcabdSAndy Whitcroft my $spacing = $1; 55675b57980dSJoe Perches if ($perl_version_ok && 55685b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 55695b9553abSJoe Perches my $value = $1; 55705b9553abSJoe Perches $value = deparenthesize($value); 55715b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 5572000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 5573000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 55745b9553abSJoe Perches } 5575c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 5576000d1cc1SJoe Perches ERROR("SPACING", 5577000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 5578c45dcabdSAndy Whitcroft } 5579c45dcabdSAndy Whitcroft } 5580507e5141SJoe Perches 5581b43ae21bSJoe Perches# unnecessary return in a void function 5582b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 5583b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 5584b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 5585b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 5586b43ae21bSJoe Perches $linenr >= 3 && 5587b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 5588b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 55899819cf25SJoe Perches WARN("RETURN_VOID", 5590b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 55919819cf25SJoe Perches } 55929819cf25SJoe Perches 5593189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 55945b57980dSJoe Perches if ($perl_version_ok && 5595189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 5596189248d8SJoe Perches my $openparens = $1; 5597189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 5598189248d8SJoe Perches my $msg = ""; 5599189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 5600189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 5601189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 5602189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 5603189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 5604189248d8SJoe Perches } 5605189248d8SJoe Perches } 5606189248d8SJoe Perches 5607c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 5608c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 5609c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 5610c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 56115b57980dSJoe Perches if ($perl_version_ok && 5612c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 5613c5595fa2SJoe Perches my $lead = $1; 5614c5595fa2SJoe Perches my $const = $2; 5615c5595fa2SJoe Perches my $comp = $3; 5616c5595fa2SJoe Perches my $to = $4; 5617c5595fa2SJoe Perches my $newcomp = $comp; 5618f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 5619c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 5620c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 5621c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 5622c5595fa2SJoe Perches $fix) { 5623c5595fa2SJoe Perches if ($comp eq "<") { 5624c5595fa2SJoe Perches $newcomp = ">"; 5625c5595fa2SJoe Perches } elsif ($comp eq "<=") { 5626c5595fa2SJoe Perches $newcomp = ">="; 5627c5595fa2SJoe Perches } elsif ($comp eq ">") { 5628c5595fa2SJoe Perches $newcomp = "<"; 5629c5595fa2SJoe Perches } elsif ($comp eq ">=") { 5630c5595fa2SJoe Perches $newcomp = "<="; 5631c5595fa2SJoe Perches } 5632c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 5633c5595fa2SJoe Perches } 5634c5595fa2SJoe Perches } 5635c5595fa2SJoe Perches 5636f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 5637f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 563853a3c448SAndy Whitcroft my $name = $1; 563946b85bf9SGuenter Roeck if ($name ne 'EOF' && $name ne 'ERROR' && $name !~ /^EPOLL/) { 5640000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 5641f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 564253a3c448SAndy Whitcroft } 564353a3c448SAndy Whitcroft } 5644c45dcabdSAndy Whitcroft 56450a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 56464a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 56473705ce5bSJoe Perches if (ERROR("SPACING", 56483705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 56493705ce5bSJoe Perches $fix) { 5650194f66fcSJoe Perches $fixed[$fixlinenr] =~ 56513705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 56523705ce5bSJoe Perches } 56530a920b5bSAndy Whitcroft } 56540a920b5bSAndy Whitcroft 5655f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 5656f5fe35ddSAndy Whitcroft# statements after the conditional. 5657170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 56583e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 56593e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 56603e469cdcSAndy Whitcroft if (!defined $stat); 5661170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 5662170d3a22SAndy Whitcroft $remain_next, $off_next); 5663170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 5664170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 5665170d3a22SAndy Whitcroft 5666170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 5667170d3a22SAndy Whitcroft # If the statement carries leading newlines, 5668170d3a22SAndy Whitcroft # then count those as offsets. 5669170d3a22SAndy Whitcroft my ($whitespace) = 5670170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 5671170d3a22SAndy Whitcroft my $offset = 5672170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 5673170d3a22SAndy Whitcroft 5674170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 5675170d3a22SAndy Whitcroft $offset} = 1; 5676170d3a22SAndy Whitcroft } 5677170d3a22SAndy Whitcroft } 5678170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 5679c11230f4SJoe Perches defined($stat) && defined($cond) && 5680170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 5681171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 5682481efd7bSJoe Perches my $fixed_assign_in_if = 0; 56838905a67cSAndy Whitcroft 5684b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 568565b64b3bSJoe Perches if (ERROR("ASSIGN_IN_IF", 568665b64b3bSJoe Perches "do not use assignment in if condition\n" . $herecurr) && 568765b64b3bSJoe Perches $fix && $perl_version_ok) { 568865b64b3bSJoe Perches if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) { 568965b64b3bSJoe Perches my $space = $1; 569065b64b3bSJoe Perches my $not = $2; 569165b64b3bSJoe Perches my $statement = $3; 569265b64b3bSJoe Perches my $assigned = $4; 569365b64b3bSJoe Perches my $test = $8; 569465b64b3bSJoe Perches my $against = $9; 569565b64b3bSJoe Perches my $brace = $15; 569665b64b3bSJoe Perches fix_delete_line($fixlinenr, $rawline); 569765b64b3bSJoe Perches fix_insert_line($fixlinenr, "$space$statement;"); 569865b64b3bSJoe Perches my $newline = "${space}if ("; 569965b64b3bSJoe Perches $newline .= '!' if defined($not); 570065b64b3bSJoe Perches $newline .= '(' if (defined $not && defined($test) && defined($against)); 570165b64b3bSJoe Perches $newline .= "$assigned"; 570265b64b3bSJoe Perches $newline .= " $test $against" if (defined($test) && defined($against)); 570365b64b3bSJoe Perches $newline .= ')' if (defined $not && defined($test) && defined($against)); 570465b64b3bSJoe Perches $newline .= ')'; 570565b64b3bSJoe Perches $newline .= " {" if (defined($brace)); 570665b64b3bSJoe Perches fix_insert_line($fixlinenr + 1, $newline); 5707481efd7bSJoe Perches $fixed_assign_in_if = 1; 570865b64b3bSJoe Perches } 570965b64b3bSJoe Perches } 57108905a67cSAndy Whitcroft } 57118905a67cSAndy Whitcroft 57128905a67cSAndy Whitcroft # Find out what is on the end of the line after the 57138905a67cSAndy Whitcroft # conditional. 5714773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 57158905a67cSAndy Whitcroft $s =~ s/\n.*//g; 571613214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 571753210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 571853210168SAndy Whitcroft $c !~ /}\s*while\s*/) 5719773647a0SAndy Whitcroft { 5720bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 5721bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 5722bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 572342bdf74cSHidetoshi Seto my $stat_real = ''; 5724bb44ad39SAndy Whitcroft 572542bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 572642bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 5727bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 5728bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 5729bb44ad39SAndy Whitcroft } 5730bb44ad39SAndy Whitcroft 5731481efd7bSJoe Perches if (ERROR("TRAILING_STATEMENTS", 5732481efd7bSJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real) && 5733481efd7bSJoe Perches !$fixed_assign_in_if && 5734481efd7bSJoe Perches $cond_lines == 0 && 5735481efd7bSJoe Perches $fix && $perl_version_ok && 5736481efd7bSJoe Perches $fixed[$fixlinenr] =~ /^\+(\s*)((?:if|while|for)\s*$balanced_parens)\s*(.*)$/) { 5737481efd7bSJoe Perches my $indent = $1; 5738481efd7bSJoe Perches my $test = $2; 5739481efd7bSJoe Perches my $rest = rtrim($4); 5740481efd7bSJoe Perches if ($rest =~ /;$/) { 5741481efd7bSJoe Perches $fixed[$fixlinenr] = "\+$indent$test"; 5742481efd7bSJoe Perches fix_insert_line($fixlinenr + 1, "$indent\t$rest"); 5743481efd7bSJoe Perches } 5744481efd7bSJoe Perches } 57458905a67cSAndy Whitcroft } 57468905a67cSAndy Whitcroft } 57478905a67cSAndy Whitcroft 574813214adfSAndy Whitcroft# Check for bitwise tests written as boolean 574913214adfSAndy Whitcroft if ($line =~ / 575013214adfSAndy Whitcroft (?: 575113214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 575213214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 575313214adfSAndy Whitcroft (?:\&\&|\|\|) 575413214adfSAndy Whitcroft | 575513214adfSAndy Whitcroft (?:\&\&|\|\|) 575613214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 575713214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 575813214adfSAndy Whitcroft )/x) 575913214adfSAndy Whitcroft { 5760000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 5761000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 576213214adfSAndy Whitcroft } 576313214adfSAndy Whitcroft 57648905a67cSAndy Whitcroft# if and else should not have general statements after it 576513214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 576613214adfSAndy Whitcroft my $s = $1; 576713214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 576813214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 5769000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5770000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 57710a920b5bSAndy Whitcroft } 577213214adfSAndy Whitcroft } 577339667782SAndy Whitcroft# if should not continue a brace 577439667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 5775000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5776048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 577739667782SAndy Whitcroft $herecurr); 577839667782SAndy Whitcroft } 5779a1080bf8SAndy Whitcroft# case and default should not have general statements after them 5780a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 5781a1080bf8SAndy Whitcroft $line !~ /\G(?: 57823fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 5783a1080bf8SAndy Whitcroft \s*return\s+ 5784a1080bf8SAndy Whitcroft )/xg) 5785a1080bf8SAndy Whitcroft { 5786000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5787000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 5788a1080bf8SAndy Whitcroft } 57890a920b5bSAndy Whitcroft 57900a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 57910a920b5bSAndy Whitcroft # indent level to be relevant to each other. 57928b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 57930a920b5bSAndy Whitcroft $previndent == $indent) { 57948b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 57958b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 57968b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 57978b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 57988b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 57998b8856f4SJoe Perches my $fixedline = $prevrawline; 58008b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 58018b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 58028b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 58038b8856f4SJoe Perches } 58048b8856f4SJoe Perches $fixedline = $rawline; 58058b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 58068b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 58078b8856f4SJoe Perches } 58080a920b5bSAndy Whitcroft } 58090a920b5bSAndy Whitcroft 58108b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 5811c2fdda0dSAndy Whitcroft $previndent == $indent) { 5812c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 5813c2fdda0dSAndy Whitcroft 5814c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 5815c2fdda0dSAndy Whitcroft # conditional. 5816773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 5817c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 5818c2fdda0dSAndy Whitcroft 5819c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 58208b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 58218b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 58228b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 58238b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 58248b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 58258b8856f4SJoe Perches my $fixedline = $prevrawline; 58268b8856f4SJoe Perches my $trailing = $rawline; 58278b8856f4SJoe Perches $trailing =~ s/^\+//; 58288b8856f4SJoe Perches $trailing = trim($trailing); 58298b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 58308b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 58318b8856f4SJoe Perches } 5832c2fdda0dSAndy Whitcroft } 5833c2fdda0dSAndy Whitcroft } 5834c2fdda0dSAndy Whitcroft 583595e2c602SJoe Perches#Specific variable tests 5836323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 5837323c1260SJoe Perches my $var = $1; 583895e2c602SJoe Perches 583995e2c602SJoe Perches#CamelCase 5840807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 5841be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 58424104a206SŁukasz Stelmach#Ignore some autogenerated defines and enum values 58434104a206SŁukasz Stelmach $var !~ /^(?:[A-Z]+_){1,5}[A-Z]{1,3}[a-z]/ && 584422735ce8SJoe Perches#Ignore Page<foo> variants 5845807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 5846d99a4158SGerhard Engleder#Ignore ETHTOOL_LINK_MODE_<foo> variants 5847d99a4158SGerhard Engleder $var !~ /^ETHTOOL_LINK_MODE_/ && 5848d439e6a5SJoe Perches#Ignore SI style variants like nS, mV and dB 5849d439e6a5SJoe Perches#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE) 5850d439e6a5SJoe Perches $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ && 5851f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 5852f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 5853f858e23aSAntonio Borneo while ($var =~ m{\b($Ident)}g) { 58547e781f67SJoe Perches my $word = $1; 58557e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 5856d8b07710SJoe Perches if ($check) { 5857d8b07710SJoe Perches seed_camelcase_includes(); 5858d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 5859d8b07710SJoe Perches seed_camelcase_file($realfile); 5860d8b07710SJoe Perches $camelcase_file_seeded = 1; 5861d8b07710SJoe Perches } 5862d8b07710SJoe Perches } 58637e781f67SJoe Perches if (!defined $camelcase{$word}) { 58647e781f67SJoe Perches $camelcase{$word} = 1; 5865be79794bSJoe Perches CHK("CAMELCASE", 58667e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 58677e781f67SJoe Perches } 5868323c1260SJoe Perches } 5869323c1260SJoe Perches } 58703445686aSJoe Perches } 58710a920b5bSAndy Whitcroft 58720a920b5bSAndy Whitcroft#no spaces allowed after \ in define 5873d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 5874d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 5875d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 5876d5e616fcSJoe Perches $fix) { 5877194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 5878d5e616fcSJoe Perches } 58790a920b5bSAndy Whitcroft } 58800a920b5bSAndy Whitcroft 58810e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 58820e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 5883c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 5884e09dec48SAndy Whitcroft my $file = "$1.h"; 5885e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 5886e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 5887e09dec48SAndy Whitcroft $realfile ne $checkfile && 58887840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 5889c45dcabdSAndy Whitcroft { 58900e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 58910e212e0aSFabian Frederick if ($asminclude > 0) { 5892e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 5893000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 5894000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5895e09dec48SAndy Whitcroft } else { 5896000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 5897000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5898e09dec48SAndy Whitcroft } 58990a920b5bSAndy Whitcroft } 59000a920b5bSAndy Whitcroft } 59010e212e0aSFabian Frederick } 59020a920b5bSAndy Whitcroft 5903653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 5904653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 5905cf655043SAndy Whitcroft# in a known good container 5906b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 5907b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 5908d8aaf121SAndy Whitcroft my $ln = $linenr; 5909d8aaf121SAndy Whitcroft my $cnt = $realcnt; 5910c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 5911c45dcabdSAndy Whitcroft my $ctx = ''; 591208a2843eSJoe Perches my $has_flow_statement = 0; 591308a2843eSJoe Perches my $has_arg_concat = 0; 5914c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 5915f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 5916f74bd194SAndy Whitcroft $ctx = $dstat; 5917c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 5918a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 5919c45dcabdSAndy Whitcroft 592008a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 592162e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 592208a2843eSJoe Perches 5923f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 5924f59b64bfSJoe Perches my $define_args = $1; 5925f59b64bfSJoe Perches my $define_stmt = $dstat; 5926f59b64bfSJoe Perches my @def_args = (); 5927f59b64bfSJoe Perches 5928f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 5929f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 5930f59b64bfSJoe Perches $define_args =~ s/\s*//g; 59318c8c45cfSJoe Perches $define_args =~ s/\\\+?//g; 5932f59b64bfSJoe Perches @def_args = split(",", $define_args); 5933f59b64bfSJoe Perches } 5934f59b64bfSJoe Perches 5935292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 5936c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 5937c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 5938c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 5939c45dcabdSAndy Whitcroft 5940c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 59412e44e803SDwaipayan Ray while ($dstat =~ s/\([^\(\)]*\)/1u/ || 59422e44e803SDwaipayan Ray $dstat =~ s/\{[^\{\}]*\}/1u/ || 59432e44e803SDwaipayan Ray $dstat =~ s/.\[[^\[\]]*\]/1u/) 5944bf30d6edSAndy Whitcroft { 5945c45dcabdSAndy Whitcroft } 5946c45dcabdSAndy Whitcroft 5947342d3d2fSAntonio Borneo # Flatten any obvious string concatenation. 594833acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 594933acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 5950e45bab8eSAndy Whitcroft { 5951e45bab8eSAndy Whitcroft } 5952e45bab8eSAndy Whitcroft 595342e15293SJoe Perches # Make asm volatile uses seem like a generic function 595442e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 595542e15293SJoe Perches 5956c45dcabdSAndy Whitcroft my $exceptions = qr{ 5957c45dcabdSAndy Whitcroft $Declare| 5958c45dcabdSAndy Whitcroft module_param_named| 5959a0a0a7a9SKees Cook MODULE_PARM_DESC| 5960c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 5961c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 5962383099fdSAndy Whitcroft __typeof__\(| 596322fd2d3eSStefani Seibold union| 596422fd2d3eSStefani Seibold struct| 5965ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 59666b10df42SVladimir Zapolskiy ^\"|\"$| 59676b10df42SVladimir Zapolskiy ^\[ 5968c45dcabdSAndy Whitcroft }x; 59695eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 5970f59b64bfSJoe Perches 5971f59b64bfSJoe Perches $ctx =~ s/\n*$//; 5972f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 5973e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 5974f59b64bfSJoe Perches 5975f74bd194SAndy Whitcroft if ($dstat ne '' && 5976f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 5977f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 59783cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 5979356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5980f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 5981f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5982e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 5983dc3f4deeSStanislaw Gruszka $dstat !~ /^case\b/ && # case ... 598472f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 59852e44e803SDwaipayan Ray $dstat !~ /^while\s*$Constant\s*$Constant\s*$/ && # while (...) {...} 5986f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5987f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5988f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 59894e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5990f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5991c45dcabdSAndy Whitcroft { 5992e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5993e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5994e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5995e795556aSJoe Perches } elsif ($dstat =~ /;/) { 5996f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5997f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5998f74bd194SAndy Whitcroft } else { 5999000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 6000388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 6001d8aaf121SAndy Whitcroft } 6002f59b64bfSJoe Perches 6003f59b64bfSJoe Perches } 60045207649bSJoe Perches 60055207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 60065207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 60075207649bSJoe Perches my $first = 1; 60085207649bSJoe Perches $define_stmt = ""; 60095207649bSJoe Perches foreach my $l (@stmt_array) { 60105207649bSJoe Perches $l =~ s/\\$//; 60115207649bSJoe Perches if ($first) { 60125207649bSJoe Perches $define_stmt = $l; 60135207649bSJoe Perches $first = 0; 60145207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 60155207649bSJoe Perches $define_stmt .= substr($l, 1); 60165207649bSJoe Perches } 60175207649bSJoe Perches } 60185207649bSJoe Perches $define_stmt =~ s/$;//g; 60195207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 60205207649bSJoe Perches $define_stmt = trim($define_stmt); 60215207649bSJoe Perches 6022f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 6023f59b64bfSJoe Perches foreach my $arg (@def_args) { 6024f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 60259192d41aSJoe Perches next if ($arg =~ /^type$/i); 60267fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 60277b844345SVincent 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; 60287fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 60297fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 6030d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 6031f59b64bfSJoe Perches if ($use_cnt > 1) { 6032f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 6033f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 6034f59b64bfSJoe Perches } 60359192d41aSJoe Perches# check if any macro arguments may have other precedence issues 60367fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 60379192d41aSJoe Perches ((defined($1) && $1 ne ',') || 60389192d41aSJoe Perches (defined($2) && $2 ne ','))) { 60399192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 60409192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 60419192d41aSJoe Perches } 60420a920b5bSAndy Whitcroft } 60435023d347SJoe Perches 604408a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 604508a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 604608a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 604708a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 6048e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 604908a2843eSJoe Perches 605008a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 605108a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 605208a2843eSJoe Perches } 605308a2843eSJoe Perches 6054481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 60555023d347SJoe Perches 60565b2c7334SJim Cromie } elsif ($realfile =~ m@/vmlinux.lds.h$@) { 60575b2c7334SJim Cromie $line =~ s/(\w+)/$maybe_linker_symbol{$1}++/ge; 60585b2c7334SJim Cromie #print "REAL: $realfile\nln: $line\nkeys:", sort keys %maybe_linker_symbol; 60595023d347SJoe Perches } else { 60605023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 6061481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 6062481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 60635023d347SJoe Perches $line =~ /^\+.*\\$/) { 60645023d347SJoe Perches WARN("LINE_CONTINUATIONS", 60655023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 60665023d347SJoe Perches } 6067653d4876SAndy Whitcroft } 60680a920b5bSAndy Whitcroft 6069b13edf7fSJoe Perches# do {} while (0) macro tests: 6070b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 6071b13edf7fSJoe Perches# macro should not end with a semicolon 60725b57980dSJoe Perches if ($perl_version_ok && 6073b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 6074b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 6075b13edf7fSJoe Perches my $ln = $linenr; 6076b13edf7fSJoe Perches my $cnt = $realcnt; 6077b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 6078b13edf7fSJoe Perches my $ctx = ''; 6079b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 6080b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 6081b13edf7fSJoe Perches $ctx = $dstat; 6082b13edf7fSJoe Perches 6083b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 60841b36b201SJoe Perches $dstat =~ s/$;/ /g; 6085b13edf7fSJoe Perches 6086b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 6087b13edf7fSJoe Perches my $stmts = $2; 6088b13edf7fSJoe Perches my $semis = $3; 6089b13edf7fSJoe Perches 6090b13edf7fSJoe Perches $ctx =~ s/\n*$//; 6091b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 6092e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6093b13edf7fSJoe Perches 6094ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 6095ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 6096b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 6097b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 6098b13edf7fSJoe Perches } 6099b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 6100b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 6101b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 6102b13edf7fSJoe Perches } 6103f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 6104f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 6105f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 6106e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6107f5ef95b1SJoe Perches 6108f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 6109f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 6110b13edf7fSJoe Perches } 6111b13edf7fSJoe Perches } 6112b13edf7fSJoe Perches 6113f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 611413214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 611513214adfSAndy Whitcroft my ($level, $endln, @chunks) = 6116cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 611713214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 6118cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 6119cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 6120aad4f614SJoe Perches my @allowed = (); 6121aad4f614SJoe Perches my $allow = 0; 612213214adfSAndy Whitcroft my $seen = 0; 6123773647a0SAndy Whitcroft my $herectx = $here . "\n"; 6124cf655043SAndy Whitcroft my $ln = $linenr - 1; 612513214adfSAndy Whitcroft for my $chunk (@chunks) { 612613214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 612713214adfSAndy Whitcroft 6128773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 6129773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 6130773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 6131773647a0SAndy Whitcroft 6132aad4f614SJoe Perches $allowed[$allow] = 0; 6133773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 6134773647a0SAndy Whitcroft 6135773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 6136773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 6137773647a0SAndy Whitcroft 6138773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 6139cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 6140cf655043SAndy Whitcroft 6141773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 614213214adfSAndy Whitcroft 614313214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 614413214adfSAndy Whitcroft 6145aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 6146cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 6147cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 6148aad4f614SJoe Perches $allowed[$allow] = 1; 614913214adfSAndy Whitcroft } 615013214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 6151cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 6152aad4f614SJoe Perches $allowed[$allow] = 1; 615313214adfSAndy Whitcroft } 6154cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 6155cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 6156aad4f614SJoe Perches $allowed[$allow] = 1; 615713214adfSAndy Whitcroft } 6158aad4f614SJoe Perches $allow++; 615913214adfSAndy Whitcroft } 6160aad4f614SJoe Perches if ($seen) { 6161aad4f614SJoe Perches my $sum_allowed = 0; 6162aad4f614SJoe Perches foreach (@allowed) { 6163aad4f614SJoe Perches $sum_allowed += $_; 6164aad4f614SJoe Perches } 6165aad4f614SJoe Perches if ($sum_allowed == 0) { 6166000d1cc1SJoe Perches WARN("BRACES", 6167000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 6168aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 6169aad4f614SJoe Perches $seen != $allow) { 6170aad4f614SJoe Perches CHK("BRACES", 6171aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 6172aad4f614SJoe Perches } 617313214adfSAndy Whitcroft } 617413214adfSAndy Whitcroft } 617513214adfSAndy Whitcroft } 6176773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 617713214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 6178cf655043SAndy Whitcroft my $allowed = 0; 6179f0a594c1SAndy Whitcroft 6180cf655043SAndy Whitcroft # Check the pre-context. 6181cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 6182cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 6183cf655043SAndy Whitcroft $allowed = 1; 6184f0a594c1SAndy Whitcroft } 6185773647a0SAndy Whitcroft 6186773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 6187773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 6188773647a0SAndy Whitcroft 6189cf655043SAndy Whitcroft # Check the condition. 6190cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 6191773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 6192cf655043SAndy Whitcroft if (defined $cond) { 6193773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 6194cf655043SAndy Whitcroft } 6195cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 6196cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 6197cf655043SAndy Whitcroft $allowed = 1; 6198cf655043SAndy Whitcroft } 6199cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 6200cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 6201cf655043SAndy Whitcroft $allowed = 1; 6202cf655043SAndy Whitcroft } 6203cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 6204cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 6205cf655043SAndy Whitcroft $allowed = 1; 6206cf655043SAndy Whitcroft } 6207cf655043SAndy Whitcroft # Check the post-context. 6208cf655043SAndy Whitcroft if (defined $chunks[1]) { 6209cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 6210cf655043SAndy Whitcroft if (defined $cond) { 6211773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 6212cf655043SAndy Whitcroft } 6213cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 6214cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 6215cf655043SAndy Whitcroft $allowed = 1; 6216cf655043SAndy Whitcroft } 6217cf655043SAndy Whitcroft } 6218cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 6219f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 6220e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6221cf655043SAndy Whitcroft 6222000d1cc1SJoe Perches WARN("BRACES", 6223000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 6224f0a594c1SAndy Whitcroft } 6225f0a594c1SAndy Whitcroft } 6226f0a594c1SAndy Whitcroft 6227e4c5babdSJoe Perches# check for single line unbalanced braces 622895330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 622995330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 6230e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 6231e4c5babdSJoe Perches } 6232e4c5babdSJoe Perches 62330979ae66SJoe Perches# check for unnecessary blank lines around braces 623477b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 6235f8e58219SJoe Perches if (CHK("BRACES", 6236f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 6237f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 6238f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 6239f8e58219SJoe Perches } 62400979ae66SJoe Perches } 624177b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 6242f8e58219SJoe Perches if (CHK("BRACES", 6243f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 6244f8e58219SJoe Perches $fix) { 6245f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 6246f8e58219SJoe Perches } 62470979ae66SJoe Perches } 62480979ae66SJoe Perches 62494a0df2efSAndy Whitcroft# no volatiles please 62506c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 62516c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 6252000d1cc1SJoe Perches WARN("VOLATILE", 62538c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 62544a0df2efSAndy Whitcroft } 62554a0df2efSAndy Whitcroft 62565e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 62575e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 62585e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 62595e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 626033acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 62615e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 62625e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 62635e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 62645e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 62655e4f6ba5SJoe Perches $fix && 62665e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 62675e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 62685e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 62695e4f6ba5SJoe Perches my $comma_close = ""; 62705e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 62715e4f6ba5SJoe Perches $comma_close = $1; 62725e4f6ba5SJoe Perches } 62735e4f6ba5SJoe Perches 62745e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 62755e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 62765e4f6ba5SJoe Perches my $fixedline = $prevrawline; 62775e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 62785e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 62795e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 62805e4f6ba5SJoe Perches $fixedline = $rawline; 62815e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 62825e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 62835e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 62845e4f6ba5SJoe Perches } 62855e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 62865e4f6ba5SJoe Perches } 62875e4f6ba5SJoe Perches } 62885e4f6ba5SJoe Perches 62895e4f6ba5SJoe Perches# check for missing a space in a string concatenation 62905e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 62915e4f6ba5SJoe Perches WARN('MISSING_SPACE', 62925e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 62935e4f6ba5SJoe Perches } 62945e4f6ba5SJoe Perches 629577cb8546SJoe Perches# check for an embedded function name in a string when the function is known 6296e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 6297e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 6298e4b7d309SJoe Perches# function declarations 629977cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 630077cb8546SJoe Perches defined($context_function) && 6301e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 6302e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 630377cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 6304e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 630577cb8546SJoe Perches } 630677cb8546SJoe Perches 6307adb2da82SJoe Perches# check for unnecessary function tracing like uses 6308adb2da82SJoe Perches# This does not use $logFunctions because there are many instances like 6309adb2da82SJoe Perches# 'dprintk(FOO, "%s()\n", __func__);' which do not match $logFunctions 6310adb2da82SJoe Perches if ($rawline =~ /^\+.*\([^"]*"$tracing_logging_tags{0,3}%s(?:\s*\(\s*\)\s*)?$tracing_logging_tags{0,3}(?:\\n)?"\s*,\s*__func__\s*\)\s*;/) { 6311adb2da82SJoe Perches if (WARN("TRACING_LOGGING", 6312adb2da82SJoe Perches "Unnecessary ftrace-like logging - prefer using ftrace\n" . $herecurr) && 6313adb2da82SJoe Perches $fix) { 6314adb2da82SJoe Perches fix_delete_line($fixlinenr, $rawline); 6315adb2da82SJoe Perches } 6316adb2da82SJoe Perches } 6317adb2da82SJoe Perches 63185e4f6ba5SJoe Perches# check for spaces before a quoted newline 63195e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 63205e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 63215e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 63225e4f6ba5SJoe Perches $fix) { 63235e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 63245e4f6ba5SJoe Perches } 63255e4f6ba5SJoe Perches 63265e4f6ba5SJoe Perches } 63275e4f6ba5SJoe Perches 6328f17dba4fSJoe Perches# concatenated string without spaces between elements 6329d2af5aa6SJoe Perches if ($line =~ /$String[A-Z_]/ || 6330d2af5aa6SJoe Perches ($line =~ /([A-Za-z0-9_]+)$String/ && $1 !~ /^[Lu]$/)) { 633179682c0cSJoe Perches if (CHK("CONCATENATED_STRING", 633279682c0cSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr) && 633379682c0cSJoe Perches $fix) { 633479682c0cSJoe Perches while ($line =~ /($String)/g) { 633579682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 633679682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/; 633779682c0cSJoe Perches $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/; 633879682c0cSJoe Perches } 633979682c0cSJoe Perches } 6340f17dba4fSJoe Perches } 6341f17dba4fSJoe Perches 634290ad30e5SJoe Perches# uncoalesced string fragments 6343d2af5aa6SJoe Perches if ($line =~ /$String\s*[Lu]?"/) { 634479682c0cSJoe Perches if (WARN("STRING_FRAGMENTS", 634579682c0cSJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr) && 634679682c0cSJoe Perches $fix) { 634779682c0cSJoe Perches while ($line =~ /($String)(?=\s*")/g) { 634879682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 634979682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e; 635079682c0cSJoe Perches } 635179682c0cSJoe Perches } 635290ad30e5SJoe Perches } 635390ad30e5SJoe Perches 6354522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 6355522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 6356522b837cSAlexey Dobriyan my $show_Z = 1; 63575e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 6358522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 63595e4f6ba5SJoe Perches $string =~ s/%%/__/g; 6360522b837cSAlexey Dobriyan # check for %L 6361522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 63625e4f6ba5SJoe Perches WARN("PRINTF_L", 6363522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 6364522b837cSAlexey Dobriyan $show_L = 0; 63655e4f6ba5SJoe Perches } 6366522b837cSAlexey Dobriyan # check for %Z 6367522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 6368522b837cSAlexey Dobriyan WARN("PRINTF_Z", 6369522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 6370522b837cSAlexey Dobriyan $show_Z = 0; 6371522b837cSAlexey Dobriyan } 6372522b837cSAlexey Dobriyan # check for 0x<decimal> 6373522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 6374522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 63756e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 63766e300757SJoe Perches } 63775e4f6ba5SJoe Perches } 63785e4f6ba5SJoe Perches 63795e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 63803f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 63815e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 63825e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 63835e4f6ba5SJoe Perches } 63845e4f6ba5SJoe Perches 638500df344fSAndy Whitcroft# warn about #if 0 6386c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 638760f89010SPrakruthi Deepak Heragu WARN("IF_0", 638860f89010SPrakruthi Deepak Heragu "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr); 638960f89010SPrakruthi Deepak Heragu } 639060f89010SPrakruthi Deepak Heragu 639160f89010SPrakruthi Deepak Heragu# warn about #if 1 639260f89010SPrakruthi Deepak Heragu if ($line =~ /^.\s*\#\s*if\s+1\b/) { 639360f89010SPrakruthi Deepak Heragu WARN("IF_1", 639460f89010SPrakruthi Deepak Heragu "Consider removing the #if 1 and its #endif\n" . $herecurr); 63954a0df2efSAndy Whitcroft } 63964a0df2efSAndy Whitcroft 639703df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 639803df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 6399100425deSJoe Perches my $tested = quotemeta($1); 6400100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 6401100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 6402100425deSJoe Perches my $func = $1; 6403100425deSJoe Perches if (WARN('NEEDLESS_IF', 6404100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 6405100425deSJoe Perches $fix) { 6406100425deSJoe Perches my $do_fix = 1; 6407100425deSJoe Perches my $leading_tabs = ""; 6408100425deSJoe Perches my $new_leading_tabs = ""; 6409100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 6410100425deSJoe Perches $leading_tabs = $1; 6411100425deSJoe Perches } else { 6412100425deSJoe Perches $do_fix = 0; 6413100425deSJoe Perches } 6414100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 6415100425deSJoe Perches $new_leading_tabs = $1; 6416100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 6417100425deSJoe Perches $do_fix = 0; 6418100425deSJoe Perches } 6419100425deSJoe Perches } else { 6420100425deSJoe Perches $do_fix = 0; 6421100425deSJoe Perches } 6422100425deSJoe Perches if ($do_fix) { 6423100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 6424100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 6425100425deSJoe Perches } 6426100425deSJoe Perches } 64274c432a8fSGreg Kroah-Hartman } 64284c432a8fSGreg Kroah-Hartman } 6429f0a594c1SAndy Whitcroft 64301eacac32SJoel Fernandes (Google)# check for soon-to-be-deprecated single-argument k[v]free_rcu() API 64311eacac32SJoel Fernandes (Google) if ($line =~ /\bk[v]?free_rcu\s*\([^(]+\)/) { 64321eacac32SJoel Fernandes (Google) if ($line =~ /\bk[v]?free_rcu\s*\([^,]+\)/) { 64331eacac32SJoel Fernandes (Google) ERROR("DEPRECATED_API", 64341eacac32SJoel Fernandes (Google) "Single-argument k[v]free_rcu() API is deprecated, please pass rcu_head object or call k[v]free_rcu_mightsleep()." . $herecurr); 64351eacac32SJoel Fernandes (Google) } 64361eacac32SJoel Fernandes (Google) } 64371eacac32SJoel Fernandes (Google) 64381eacac32SJoel Fernandes (Google) 6439ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 6440ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 6441ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 6442ebfdc409SJoe Perches (defined $1 || defined $3) && 6443ebfdc409SJoe Perches $linenr > 3) { 6444ebfdc409SJoe Perches my $testval = $2; 6445ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 6446ebfdc409SJoe Perches 6447ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 6448ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 6449ebfdc409SJoe Perches 6450e29a70f1SJoe Perches if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ && 6451e29a70f1SJoe Perches $s !~ /\b__GFP_NOWARN\b/ ) { 6452ebfdc409SJoe Perches WARN("OOM_MESSAGE", 6453ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 6454ebfdc409SJoe Perches } 6455ebfdc409SJoe Perches } 6456ebfdc409SJoe Perches 6457f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 6458dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 6459f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 6460f78d98f6SJoe Perches my $level = $1; 6461f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 6462f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 6463f78d98f6SJoe Perches $fix) { 6464f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 6465f78d98f6SJoe Perches } 6466f78d98f6SJoe Perches } 6467f78d98f6SJoe Perches 646845c55e92SJoe Perches# check for logging continuations 646945c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 647045c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 647145c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 647245c55e92SJoe Perches } 647345c55e92SJoe Perches 647470eb2275SDwaipayan Ray# check for unnecessary use of %h[xudi] and %hh[xudi] in logging functions 647570eb2275SDwaipayan Ray if (defined $stat && 647670eb2275SDwaipayan Ray $line =~ /\b$logFunctions\s*\(/ && 647770eb2275SDwaipayan Ray index($stat, '"') >= 0) { 647870eb2275SDwaipayan Ray my $lc = $stat =~ tr@\n@@; 647970eb2275SDwaipayan Ray $lc = $lc + $linenr; 648070eb2275SDwaipayan Ray my $stat_real = get_stat_real($linenr, $lc); 648170eb2275SDwaipayan Ray pos($stat_real) = index($stat_real, '"'); 648270eb2275SDwaipayan Ray while ($stat_real =~ /[^\"%]*(%[\#\d\.\*\-]*(h+)[idux])/g) { 648370eb2275SDwaipayan Ray my $pspec = $1; 648470eb2275SDwaipayan Ray my $h = $2; 648570eb2275SDwaipayan Ray my $lineoff = substr($stat_real, 0, $-[1]) =~ tr@\n@@; 648670eb2275SDwaipayan Ray if (WARN("UNNECESSARY_MODIFIER", 648770eb2275SDwaipayan Ray "Integer promotion: Using '$h' in '$pspec' is unnecessary\n" . "$here\n$stat_real\n") && 648870eb2275SDwaipayan Ray $fix && $fixed[$fixlinenr + $lineoff] =~ /^\+/) { 648970eb2275SDwaipayan Ray my $nspec = $pspec; 649070eb2275SDwaipayan Ray $nspec =~ s/h//g; 649170eb2275SDwaipayan Ray $fixed[$fixlinenr + $lineoff] =~ s/\Q$pspec\E/$nspec/; 649270eb2275SDwaipayan Ray } 649370eb2275SDwaipayan Ray } 649470eb2275SDwaipayan Ray } 649570eb2275SDwaipayan Ray 6496abb08a53SJoe Perches# check for mask then right shift without a parentheses 64975b57980dSJoe Perches if ($perl_version_ok && 6498abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 6499abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 6500abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 6501abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 6502abb08a53SJoe Perches } 6503abb08a53SJoe Perches 6504b75ac618SJoe Perches# check for pointer comparisons to NULL 65055b57980dSJoe Perches if ($perl_version_ok) { 6506b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 6507b75ac618SJoe Perches my $val = $1; 6508b75ac618SJoe Perches my $equal = "!"; 6509b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 6510b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 6511b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 6512b75ac618SJoe Perches $fix) { 6513b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 6514b75ac618SJoe Perches } 6515b75ac618SJoe Perches } 6516b75ac618SJoe Perches } 6517b75ac618SJoe Perches 65188716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 65198716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 65208716de38SJoe Perches my $attr = $1; 65218716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 65228716de38SJoe Perches my $ptr = $1; 65238716de38SJoe Perches my $var = $2; 65248716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 65258716de38SJoe Perches ERROR("MISPLACED_INIT", 65268716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 65278716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 65288716de38SJoe Perches WARN("MISPLACED_INIT", 65298716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 65308716de38SJoe Perches $fix) { 6531194f66fcSJoe 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; 65328716de38SJoe Perches } 65338716de38SJoe Perches } 65348716de38SJoe Perches } 65358716de38SJoe Perches 6536e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 6537e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 6538e970b884SJoe Perches my $attr = $1; 6539e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 6540e970b884SJoe Perches my $attr_prefix = $1; 6541e970b884SJoe Perches my $attr_type = $2; 6542e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 6543e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 6544e970b884SJoe Perches $fix) { 6545194f66fcSJoe Perches $fixed[$fixlinenr] =~ 6546e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 6547e970b884SJoe Perches } 6548e970b884SJoe Perches } 6549e970b884SJoe Perches 6550e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 6551e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 6552e970b884SJoe Perches my $attr = $1; 6553e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 6554e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 6555e970b884SJoe Perches $fix) { 6556194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 6557e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 6558e970b884SJoe Perches $lead = rtrim($1); 6559e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 6560e970b884SJoe Perches $lead = "${lead}const "; 6561194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 6562e970b884SJoe Perches } 6563e970b884SJoe Perches } 6564e970b884SJoe Perches 6565c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 6566c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 6567c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 6568c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 6569c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 6570c17893c7SJoe Perches $fix) { 6571c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 6572c17893c7SJoe Perches } 6573c17893c7SJoe Perches } 6574c17893c7SJoe Perches 6575fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 6576fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 6577fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 6578fbdb8138SJoe Perches my $constant_func = $1; 6579fbdb8138SJoe Perches my $func = $constant_func; 6580fbdb8138SJoe Perches $func =~ s/^__constant_//; 6581fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 6582fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 6583fbdb8138SJoe Perches $fix) { 6584194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 6585fbdb8138SJoe Perches } 6586fbdb8138SJoe Perches } 6587fbdb8138SJoe Perches 65881a15a250SPatrick Pannuto# prefer usleep_range over udelay 658937581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 659043c1d77cSJoe Perches my $delay = $1; 65911a15a250SPatrick Pannuto # ignore udelay's < 10, however 659243c1d77cSJoe Perches if (! ($delay < 10) ) { 6593000d1cc1SJoe Perches CHK("USLEEP_RANGE", 6594458f69efSMauro Carvalho Chehab "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr); 659543c1d77cSJoe Perches } 659643c1d77cSJoe Perches if ($delay > 2000) { 659743c1d77cSJoe Perches WARN("LONG_UDELAY", 659843c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 65991a15a250SPatrick Pannuto } 66001a15a250SPatrick Pannuto } 66011a15a250SPatrick Pannuto 660209ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 660309ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 660409ef8725SPatrick Pannuto if ($1 < 20) { 6605000d1cc1SJoe Perches WARN("MSLEEP", 6606458f69efSMauro Carvalho Chehab "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr); 660709ef8725SPatrick Pannuto } 660809ef8725SPatrick Pannuto } 660909ef8725SPatrick Pannuto 661036ec1939SJoe Perches# check for comparisons of jiffies 661136ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 661236ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 661336ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 661436ec1939SJoe Perches } 661536ec1939SJoe Perches 66169d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 66179d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 66189d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 66199d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 66209d7a34a5SJoe Perches } 66219d7a34a5SJoe Perches 662200df344fSAndy Whitcroft# warn about #ifdefs in C files 6623c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 662400df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 662500df344fSAndy Whitcroft# print "$herecurr"; 662600df344fSAndy Whitcroft# $clean = 0; 662700df344fSAndy Whitcroft# } 662800df344fSAndy Whitcroft 662922f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 6630c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 66313705ce5bSJoe Perches if (ERROR("SPACING", 66323705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 66333705ce5bSJoe Perches $fix) { 6634194f66fcSJoe Perches $fixed[$fixlinenr] =~ 66353705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 66363705ce5bSJoe Perches } 66373705ce5bSJoe Perches 663822f2a2efSAndy Whitcroft } 663922f2a2efSAndy Whitcroft 66404a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 6641171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 6642171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 66434a0df2efSAndy Whitcroft my $which = $1; 66444a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 6645000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 6646000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 66474a0df2efSAndy Whitcroft } 66484a0df2efSAndy Whitcroft } 66494a0df2efSAndy Whitcroft# check for memory barriers without a comment. 6650402c2553SMichael S. Tsirkin 6651402c2553SMichael S. Tsirkin my $barriers = qr{ 6652402c2553SMichael S. Tsirkin mb| 6653402c2553SMichael S. Tsirkin rmb| 6654ad83ec6cSWill Deacon wmb 6655402c2553SMichael S. Tsirkin }x; 6656402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 6657402c2553SMichael S. Tsirkin mb__before_atomic| 6658402c2553SMichael S. Tsirkin mb__after_atomic| 6659402c2553SMichael S. Tsirkin store_release| 6660402c2553SMichael S. Tsirkin load_acquire| 6661402c2553SMichael S. Tsirkin store_mb| 6662402c2553SMichael S. Tsirkin (?:$barriers) 6663402c2553SMichael S. Tsirkin }x; 6664402c2553SMichael S. Tsirkin my $all_barriers = qr{ 6665402c2553SMichael S. Tsirkin (?:$barriers)| 666643e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 666743e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 6668402c2553SMichael S. Tsirkin }x; 6669402c2553SMichael S. Tsirkin 6670402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 66714a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 6672c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 6673000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 66744a0df2efSAndy Whitcroft } 66754a0df2efSAndy Whitcroft } 66763ad81779SPaul E. McKenney 6677f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 6678f4073b0fSMichael S. Tsirkin 6679f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 6680f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 6681f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 6682f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 6683f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 6684f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 6685f4073b0fSMichael S. Tsirkin } 6686f4073b0fSMichael S. Tsirkin 6687cb426e99SJoe Perches# check for waitqueue_active without a comment. 6688cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 6689cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 6690cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 6691cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 6692cb426e99SJoe Perches } 6693cb426e99SJoe Perches } 66943ad81779SPaul E. McKenney 66955099a722SMarco Elver# check for data_race without a comment. 66965099a722SMarco Elver if ($line =~ /\bdata_race\s*\(/) { 66975099a722SMarco Elver if (!ctx_has_comment($first_line, $linenr)) { 66985099a722SMarco Elver WARN("DATA_RACE", 66995099a722SMarco Elver "data_race without comment\n" . $herecurr); 67005099a722SMarco Elver } 67015099a722SMarco Elver } 67025099a722SMarco Elver 67034a0df2efSAndy Whitcroft# check of hardware specific defines 6704c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 6705000d1cc1SJoe Perches CHK("ARCH_DEFINES", 6706000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 67070a920b5bSAndy Whitcroft } 6708653d4876SAndy Whitcroft 6709596ed45bSJoe Perches# check that the storage class is not after a type 6710596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 6711000d1cc1SJoe Perches WARN("STORAGE_CLASS", 6712596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 6713596ed45bSJoe Perches } 6714596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 6715596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 6716596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 6717596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 6718596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 6719596ed45bSJoe Perches WARN("STORAGE_CLASS", 6720596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 6721d4977c78STobias Klauser } 6722d4977c78STobias Klauser 6723de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 6724de7d4f0eSAndy Whitcroft# storage class and type. 67259c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 67269c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 6727000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 6728000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 6729de7d4f0eSAndy Whitcroft } 6730de7d4f0eSAndy Whitcroft 67318905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 67322b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 67332b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 6734d5e616fcSJoe Perches if (WARN("INLINE", 6735d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 6736d5e616fcSJoe Perches $fix) { 6737194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 6738d5e616fcSJoe Perches 6739d5e616fcSJoe Perches } 67408905a67cSAndy Whitcroft } 67418905a67cSAndy Whitcroft 67427ebe1d17SDwaipayan Ray# Check for compiler attributes 67432b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 67447ebe1d17SDwaipayan Ray $rawline =~ /\b__attribute__\s*\(\s*($balanced_parens)\s*\)/) { 67457ebe1d17SDwaipayan Ray my $attr = $1; 67467ebe1d17SDwaipayan Ray $attr =~ s/\s*\(\s*(.*)\)\s*/$1/; 67477ebe1d17SDwaipayan Ray 67487ebe1d17SDwaipayan Ray my %attr_list = ( 67490830aab0SJoe Perches "alias" => "__alias", 67507ebe1d17SDwaipayan Ray "aligned" => "__aligned", 67517ebe1d17SDwaipayan Ray "always_inline" => "__always_inline", 67527ebe1d17SDwaipayan Ray "assume_aligned" => "__assume_aligned", 67537ebe1d17SDwaipayan Ray "cold" => "__cold", 67547ebe1d17SDwaipayan Ray "const" => "__attribute_const__", 67557ebe1d17SDwaipayan Ray "copy" => "__copy", 67567ebe1d17SDwaipayan Ray "designated_init" => "__designated_init", 67577ebe1d17SDwaipayan Ray "externally_visible" => "__visible", 67587ebe1d17SDwaipayan Ray "format" => "printf|scanf", 67597ebe1d17SDwaipayan Ray "gnu_inline" => "__gnu_inline", 67607ebe1d17SDwaipayan Ray "malloc" => "__malloc", 67617ebe1d17SDwaipayan Ray "mode" => "__mode", 67627ebe1d17SDwaipayan Ray "no_caller_saved_registers" => "__no_caller_saved_registers", 67637ebe1d17SDwaipayan Ray "noclone" => "__noclone", 67647ebe1d17SDwaipayan Ray "noinline" => "noinline", 67657ebe1d17SDwaipayan Ray "nonstring" => "__nonstring", 67667ebe1d17SDwaipayan Ray "noreturn" => "__noreturn", 67677ebe1d17SDwaipayan Ray "packed" => "__packed", 67687ebe1d17SDwaipayan Ray "pure" => "__pure", 6769339f29d9SJoe Perches "section" => "__section", 67700830aab0SJoe Perches "used" => "__used", 67710830aab0SJoe Perches "weak" => "__weak" 67727ebe1d17SDwaipayan Ray ); 67737ebe1d17SDwaipayan Ray 67747ebe1d17SDwaipayan Ray while ($attr =~ /\s*(\w+)\s*(${balanced_parens})?/g) { 6775339f29d9SJoe Perches my $orig_attr = $1; 67767ebe1d17SDwaipayan Ray my $params = ''; 67777ebe1d17SDwaipayan Ray $params = $2 if defined($2); 6778339f29d9SJoe Perches my $curr_attr = $orig_attr; 67797ebe1d17SDwaipayan Ray $curr_attr =~ s/^[\s_]+|[\s_]+$//g; 67807ebe1d17SDwaipayan Ray if (exists($attr_list{$curr_attr})) { 6781339f29d9SJoe Perches my $new = $attr_list{$curr_attr}; 67827ebe1d17SDwaipayan Ray if ($curr_attr eq "format" && $params) { 67837ebe1d17SDwaipayan Ray $params =~ /^\s*\(\s*(\w+)\s*,\s*(.*)/; 6784339f29d9SJoe Perches $new = "__$1\($2"; 67857ebe1d17SDwaipayan Ray } else { 6786339f29d9SJoe Perches $new = "$new$params"; 67877ebe1d17SDwaipayan Ray } 67887ebe1d17SDwaipayan Ray if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", 6789339f29d9SJoe Perches "Prefer $new over __attribute__(($orig_attr$params))\n" . $herecurr) && 67907ebe1d17SDwaipayan Ray $fix) { 6791339f29d9SJoe Perches my $remove = "\Q$orig_attr\E" . '\s*' . "\Q$params\E" . '(?:\s*,\s*)?'; 6792339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/$remove//; 6793339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__/$new __attribute__/; 6794339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/\}\Q$new\E/} $new/; 6795339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/ __attribute__\s*\(\s*\(\s*\)\s*\)//; 67967ebe1d17SDwaipayan Ray } 679739b7e287SJoe Perches } 6798462811d9SJoe Perches } 6799462811d9SJoe Perches 68007ebe1d17SDwaipayan Ray # Check for __attribute__ unused, prefer __always_unused or __maybe_unused 68017ebe1d17SDwaipayan Ray if ($attr =~ /^_*unused/) { 68027ebe1d17SDwaipayan Ray WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", 68037ebe1d17SDwaipayan Ray "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr); 6804d5e616fcSJoe Perches } 68056061d949SJoe Perches } 68066061d949SJoe Perches 6807619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 68085b57980dSJoe Perches if ($perl_version_ok && 6809619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 6810619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 6811619a908aSJoe Perches $line =~ /\b__weak\b/)) { 6812619a908aSJoe Perches ERROR("WEAK_DECLARATION", 6813619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 6814619a908aSJoe Perches } 6815619a908aSJoe Perches 6816fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 6817e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 6818fd39f904STomas Winkler $realfile !~ m@\btools/@ && 6819e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 6820e6176fa4SJoe Perches my $type = $1; 6821e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 6822e6176fa4SJoe Perches $type = $1; 6823e6176fa4SJoe Perches my $kernel_type = 'u'; 6824e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 6825e6176fa4SJoe Perches $type =~ /(\d+)/; 6826e6176fa4SJoe Perches $kernel_type .= $1; 6827e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 6828e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 6829e6176fa4SJoe Perches $fix) { 6830e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 6831e6176fa4SJoe Perches } 6832e6176fa4SJoe Perches } 6833e6176fa4SJoe Perches } 6834e6176fa4SJoe Perches 6835938224b5SJoe Perches# check for cast of C90 native int or longer types constants 6836938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 6837938224b5SJoe Perches my $cast = $1; 6838938224b5SJoe Perches my $const = $2; 6839938224b5SJoe Perches my $suffix = ""; 6840938224b5SJoe Perches my $newconst = $const; 6841938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 6842938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 6843938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 6844938224b5SJoe Perches $suffix .= 'LL'; 6845938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 6846938224b5SJoe Perches $suffix .= 'L'; 6847938224b5SJoe Perches } 68480972b8bfSJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 68490972b8bfSJoe Perches "Unnecessary typecast of c90 int constant - '$cast$const' could be '$const$suffix'\n" . $herecurr) && 68500972b8bfSJoe Perches $fix) { 6851938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 6852938224b5SJoe Perches } 6853938224b5SJoe Perches } 6854938224b5SJoe Perches 68558f53a9b8SJoe Perches# check for sizeof(&) 68568f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 6857000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 6858000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 68598f53a9b8SJoe Perches } 68608f53a9b8SJoe Perches 686166c80b60SJoe Perches# check for sizeof without parenthesis 686266c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 6863d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 6864d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 6865d5e616fcSJoe Perches $fix) { 6866194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 6867d5e616fcSJoe Perches } 686866c80b60SJoe Perches } 686966c80b60SJoe Perches 687088982feaSJoe Perches# check for struct spinlock declarations 687188982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 687288982feaSJoe Perches WARN("USE_SPINLOCK_T", 687388982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 687488982feaSJoe Perches } 687588982feaSJoe Perches 6876a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 687706668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 6878a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 6879caac1d5fSHeba Aamer $fmt =~ s/%%//g; 6880caac1d5fSHeba Aamer if ($fmt !~ /%/) { 6881d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 6882d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 6883d5e616fcSJoe Perches $fix) { 6884194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 6885d5e616fcSJoe Perches } 6886a6962d72SJoe Perches } 6887a6962d72SJoe Perches } 6888a6962d72SJoe Perches 68890b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 68905b57980dSJoe Perches if ($perl_version_ok && 68910b523769SJoe Perches defined $stat && 68920b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 68930b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 6894e3c6bc95STobin C. Harding my $stat_real; 6895e3c6bc95STobin C. Harding 68960b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 68970b523769SJoe Perches $lc = $lc + $linenr; 68980b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 6899ffe07513SJoe Perches my $specifier; 6900ffe07513SJoe Perches my $extension; 69013bd32d6aSSakari Ailus my $qualifier; 6902ffe07513SJoe Perches my $bad_specifier = ""; 69030b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 69040b523769SJoe Perches $fmt =~ s/%%//g; 6905e3c6bc95STobin C. Harding 69063bd32d6aSSakari Ailus while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) { 6907e3c6bc95STobin C. Harding $specifier = $1; 6908e3c6bc95STobin C. Harding $extension = $2; 69093bd32d6aSSakari Ailus $qualifier = $3; 6910af612e43SSakari Ailus if ($extension !~ /[4SsBKRraEehMmIiUDdgVCbGNOxtf]/ || 69113bd32d6aSSakari Ailus ($extension eq "f" && 6912af612e43SSakari Ailus defined $qualifier && $qualifier !~ /^w/) || 6913af612e43SSakari Ailus ($extension eq "4" && 6914af612e43SSakari Ailus defined $qualifier && $qualifier !~ /^cc/)) { 6915e3c6bc95STobin C. Harding $bad_specifier = $specifier; 69160b523769SJoe Perches last; 69170b523769SJoe Perches } 6918e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 6919e3c6bc95STobin C. Harding if (!defined($stat_real)) { 6920e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 69210b523769SJoe Perches } 6922e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 6923e3c6bc95STobin 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"); 6924e3c6bc95STobin C. Harding } 6925e3c6bc95STobin C. Harding } 6926e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 69272a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6928de48fa1aSMiguel Ojeda my $msg_level = \&WARN; 69291df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 69301df7338aSSergey Senozhatsky my $use = ""; 6931e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 69321df7338aSSergey Senozhatsky $use = " - use %pS instead"; 6933e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 6934de48fa1aSMiguel Ojeda } elsif ($bad_specifier =~ /pA/) { 6935de48fa1aSMiguel Ojeda $use = " - '%pA' is only intended to be used from Rust code"; 6936de48fa1aSMiguel Ojeda $msg_level = \&ERROR; 69371df7338aSSergey Senozhatsky } 69382a9f9d85STobin C. Harding 6939de48fa1aSMiguel Ojeda &{$msg_level}("VSPRINTF_POINTER_EXTENSION", 6940e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 6941e3c6bc95STobin C. Harding } 69420b523769SJoe Perches } 69430b523769SJoe Perches } 69440b523769SJoe Perches 6945554e165cSAndy Whitcroft# Check for misused memsets 69465b57980dSJoe Perches if ($perl_version_ok && 6947d1fe9c09SJoe Perches defined $stat && 69489e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 6949554e165cSAndy Whitcroft 6950d7c76ba7SJoe Perches my $ms_addr = $2; 6951d1fe9c09SJoe Perches my $ms_val = $7; 6952d1fe9c09SJoe Perches my $ms_size = $12; 6953d7c76ba7SJoe Perches 6954554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 6955554e165cSAndy Whitcroft ERROR("MEMSET", 6956d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 6957554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 6958554e165cSAndy Whitcroft WARN("MEMSET", 6959d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 6960d7c76ba7SJoe Perches } 6961d7c76ba7SJoe Perches } 6962d7c76ba7SJoe Perches 696398a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 69645b57980dSJoe Perches# if ($perl_version_ok && 6965f333195dSJoe Perches# defined $stat && 6966f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6967f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 6968f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 6969f333195dSJoe Perches# $fix) { 6970f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 6971f333195dSJoe Perches# } 6972f333195dSJoe Perches# } 697398a9bba5SJoe Perches 6974b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 69755b57980dSJoe Perches# if ($perl_version_ok && 6976f333195dSJoe Perches# defined $stat && 6977f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6978f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 6979f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 6980f333195dSJoe Perches# } 6981b6117d17SMateusz Kulikowski 69828617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 69838617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 69845b57980dSJoe Perches# if ($perl_version_ok && 6985f333195dSJoe Perches# defined $stat && 6986f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6987f333195dSJoe Perches# 6988f333195dSJoe Perches# my $ms_val = $7; 6989f333195dSJoe Perches# 6990f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 6991f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 6992f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 6993f333195dSJoe Perches# $fix) { 6994f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 6995f333195dSJoe Perches# } 6996f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 6997f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 6998f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 6999f333195dSJoe Perches# $fix) { 7000f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 7001f333195dSJoe Perches# } 7002f333195dSJoe Perches# } 7003f333195dSJoe Perches# } 70048617cd09SMateusz Kulikowski 7005d0f90841SKees Cook# strcpy uses that should likely be strscpy 7006d0f90841SKees Cook if ($line =~ /\bstrcpy\s*\(/) { 7007d0f90841SKees Cook WARN("STRCPY", 7008d0f90841SKees Cook "Prefer strscpy over strcpy - see: https://github.com/KSPP/linux/issues/88\n" . $herecurr); 7009d0f90841SKees Cook } 7010d0f90841SKees Cook 70115dbdb2d8SJoe Perches# strlcpy uses that should likely be strscpy 70125dbdb2d8SJoe Perches if ($line =~ /\bstrlcpy\s*\(/) { 70135dbdb2d8SJoe Perches WARN("STRLCPY", 7014d0f90841SKees Cook "Prefer strscpy over strlcpy - see: https://github.com/KSPP/linux/issues/89\n" . $herecurr); 7015d0f90841SKees Cook } 7016d0f90841SKees Cook 7017d0f90841SKees Cook# strncpy uses that should likely be strscpy or strscpy_pad 7018d0f90841SKees Cook if ($line =~ /\bstrncpy\s*\(/) { 7019d0f90841SKees Cook WARN("STRNCPY", 7020d0f90841SKees Cook "Prefer strscpy, strscpy_pad, or __nonstring over strncpy - see: https://github.com/KSPP/linux/issues/90\n" . $herecurr); 70215dbdb2d8SJoe Perches } 70225dbdb2d8SJoe Perches 7023d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 70245b57980dSJoe Perches if ($perl_version_ok && 7025d1fe9c09SJoe Perches defined $stat && 7026d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 7027d1fe9c09SJoe Perches if (defined $2 || defined $7) { 7028d7c76ba7SJoe Perches my $call = $1; 7029d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 7030d7c76ba7SJoe Perches my $arg1 = $3; 7031d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 7032d1fe9c09SJoe Perches my $arg2 = $8; 7033d7c76ba7SJoe Perches my $cast; 7034d7c76ba7SJoe Perches 7035d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 7036d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 7037d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 7038d7c76ba7SJoe Perches $cast = $cast1; 7039d7c76ba7SJoe Perches } else { 7040d7c76ba7SJoe Perches $cast = $cast2; 7041d7c76ba7SJoe Perches } 7042d7c76ba7SJoe Perches WARN("MINMAX", 7043d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 7044554e165cSAndy Whitcroft } 7045554e165cSAndy Whitcroft } 7046554e165cSAndy Whitcroft 70474a273195SJoe Perches# check usleep_range arguments 70485b57980dSJoe Perches if ($perl_version_ok && 70494a273195SJoe Perches defined $stat && 70504a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 70514a273195SJoe Perches my $min = $1; 70524a273195SJoe Perches my $max = $7; 70534a273195SJoe Perches if ($min eq $max) { 70544a273195SJoe Perches WARN("USLEEP_RANGE", 7055458f69efSMauro Carvalho Chehab "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 70564a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 70574a273195SJoe Perches $min > $max) { 70584a273195SJoe Perches WARN("USLEEP_RANGE", 7059458f69efSMauro Carvalho Chehab "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 70604a273195SJoe Perches } 70614a273195SJoe Perches } 70624a273195SJoe Perches 7063823b794cSJoe Perches# check for naked sscanf 70645b57980dSJoe Perches if ($perl_version_ok && 7065823b794cSJoe Perches defined $stat && 70666c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 7067823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 7068823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 7069823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 7070823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 7071823b794cSJoe Perches $lc = $lc + $linenr; 70722a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 7073823b794cSJoe Perches WARN("NAKED_SSCANF", 7074823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 7075823b794cSJoe Perches } 7076823b794cSJoe Perches 7077afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 70785b57980dSJoe Perches if ($perl_version_ok && 7079afc819abSJoe Perches defined $stat && 7080afc819abSJoe Perches $line =~ /\bsscanf\b/) { 7081afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 7082afc819abSJoe Perches $lc = $lc + $linenr; 70832a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 7084afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 7085afc819abSJoe Perches my $format = $6; 7086afc819abSJoe Perches my $count = $format =~ tr@%@%@; 7087afc819abSJoe Perches if ($count == 1 && 7088afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 7089afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 7090afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 7091afc819abSJoe Perches } 7092afc819abSJoe Perches } 7093afc819abSJoe Perches } 7094afc819abSJoe Perches 709570dc8a48SJoe Perches# check for new externs in .h files. 709670dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 709770dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 7098d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 709970dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 710070dc8a48SJoe Perches $fix) { 7101194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 710270dc8a48SJoe Perches } 710370dc8a48SJoe Perches } 710470dc8a48SJoe Perches 7105de7d4f0eSAndy Whitcroft# check for new externs in .c files. 7106171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 7107c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 7108171ae1a4SAndy Whitcroft { 7109c45dcabdSAndy Whitcroft my $function_name = $1; 7110c45dcabdSAndy Whitcroft my $paren_space = $2; 7111171ae1a4SAndy Whitcroft 7112171ae1a4SAndy Whitcroft my $s = $stat; 7113171ae1a4SAndy Whitcroft if (defined $cond) { 7114171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 7115171ae1a4SAndy Whitcroft } 7116d8b44b58SKees Cook if ($s =~ /^\s*;/) 7117c45dcabdSAndy Whitcroft { 7118000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 7119000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 7120de7d4f0eSAndy Whitcroft } 7121de7d4f0eSAndy Whitcroft 7122171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 7123000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 7124000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 7125171ae1a4SAndy Whitcroft } 71269c9ba34eSAndy Whitcroft 71279c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 71285b2c7334SJim Cromie $stat =~ /^\+extern struct\s+(\w+)\s+(\w+)\[\];/) 71295b2c7334SJim Cromie { 71305b2c7334SJim Cromie my ($st_type, $st_name) = ($1, $2); 71315b2c7334SJim Cromie 71325b2c7334SJim Cromie for my $s (keys %maybe_linker_symbol) { 71335b2c7334SJim Cromie #print "Linker symbol? $st_name : $s\n"; 71345b2c7334SJim Cromie goto LIKELY_LINKER_SYMBOL 71355b2c7334SJim Cromie if $st_name =~ /$s/; 71365b2c7334SJim Cromie } 71375b2c7334SJim Cromie WARN("AVOID_EXTERNS", 71385b2c7334SJim Cromie "found a file-scoped extern type:$st_type name:$st_name in .c file\n" 71395b2c7334SJim Cromie . "is this a linker symbol ?\n" . $herecurr); 71405b2c7334SJim Cromie LIKELY_LINKER_SYMBOL: 71415b2c7334SJim Cromie 71425b2c7334SJim Cromie } elsif ($realfile =~ /\.c$/ && defined $stat && 71439c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 71449c9ba34eSAndy Whitcroft { 7145000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 7146000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 7147171ae1a4SAndy Whitcroft } 7148171ae1a4SAndy Whitcroft 7149a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 7150a0ad7596SJoe Perches if (defined $stat && 7151d8b44b58SKees Cook $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 7152d8b44b58SKees Cook $1 ne "void") { 7153d8b44b58SKees Cook my $args = trim($1); 7154ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 7155ca0d8929SJoe Perches my $arg = trim($1); 7156d8b44b58SKees Cook if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 7157ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 7158ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 7159ca0d8929SJoe Perches } 7160ca0d8929SJoe Perches } 7161ca0d8929SJoe Perches } 7162ca0d8929SJoe Perches 7163a0ad7596SJoe Perches# check for function definitions 71645b57980dSJoe Perches if ($perl_version_ok && 7165a0ad7596SJoe Perches defined $stat && 7166a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 7167a0ad7596SJoe Perches $context_function = $1; 7168a0ad7596SJoe Perches 7169a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 7170a0ad7596SJoe Perches my $ok = 0; 7171a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 7172a0ad7596SJoe Perches my $herectx = $here . "\n"; 7173a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 7174a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 7175a0ad7596SJoe Perches $herectx .= $rl . "\n"; 7176a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 7177a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 7178a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 7179a0ad7596SJoe Perches } 7180a0ad7596SJoe Perches if (!$ok) { 7181a0ad7596SJoe Perches ERROR("OPEN_BRACE", 7182a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 7183a0ad7596SJoe Perches } 7184a0ad7596SJoe Perches } 7185a0ad7596SJoe Perches 7186de7d4f0eSAndy Whitcroft# checks for new __setup's 7187de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 7188de7d4f0eSAndy Whitcroft my $name = $1; 7189de7d4f0eSAndy Whitcroft 7190de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 7191000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 71922581ac7cSTim Froidcoeur "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr); 7193de7d4f0eSAndy Whitcroft } 7194653d4876SAndy Whitcroft } 71959c0ca6f9SAndy Whitcroft 7196e29a70f1SJoe Perches# check for pointless casting of alloc functions 7197e29a70f1SJoe Perches if ($line =~ /\*\s*\)\s*$allocFunctions\b/) { 7198000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 7199000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 72009c0ca6f9SAndy Whitcroft } 720113214adfSAndy Whitcroft 7202a640d25cSJoe Perches# alloc style 7203a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 72045b57980dSJoe Perches if ($perl_version_ok && 7205e29a70f1SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 7206a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 7207a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 7208a640d25cSJoe Perches } 7209a640d25cSJoe Perches 721073f1d07eSGustavo A. R. Silva# check for (kv|k)[mz]alloc with multiplies that could be kmalloc_array/kvmalloc_array/kvcalloc/kcalloc 72115b57980dSJoe Perches if ($perl_version_ok && 72121b4a2ed4SJoe Perches defined $stat && 721373f1d07eSGustavo A. R. Silva $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k)[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 721460a55369SJoe Perches my $oldfunc = $3; 721560a55369SJoe Perches my $a1 = $4; 721660a55369SJoe Perches my $a2 = $10; 721760a55369SJoe Perches my $newfunc = "kmalloc_array"; 721873f1d07eSGustavo A. R. Silva $newfunc = "kvmalloc_array" if ($oldfunc eq "kvmalloc"); 721973f1d07eSGustavo A. R. Silva $newfunc = "kvcalloc" if ($oldfunc eq "kvzalloc"); 722060a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 722160a55369SJoe Perches my $r1 = $a1; 722260a55369SJoe Perches my $r2 = $a2; 722360a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 722460a55369SJoe Perches $r1 = $a2; 722560a55369SJoe Perches $r2 = $a1; 722660a55369SJoe Perches } 7227e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 7228e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 72291b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 7230e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 7231e3d95a2aSTobin C. Harding 7232e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 72331b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 72341b4a2ed4SJoe Perches $cnt == 1 && 7235e367455aSJoe Perches $fix) { 723673f1d07eSGustavo 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; 723760a55369SJoe Perches } 723860a55369SJoe Perches } 723960a55369SJoe Perches } 724060a55369SJoe Perches 7241972fdea2SJoe Perches# check for krealloc arg reuse 72425b57980dSJoe Perches if ($perl_version_ok && 72434cab63ceSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ && 72444cab63ceSJoe Perches $1 eq $3) { 7245972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 7246972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 7247972fdea2SJoe Perches } 7248972fdea2SJoe Perches 72495ce59ae0SJoe Perches# check for alloc argument mismatch 72503965292aSLiao Chang if ($line =~ /\b((?:devm_)?((?:k|kv)?(calloc|malloc_array)(?:_node)?))\s*\(\s*sizeof\b/) { 72515ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 72525ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 72535ce59ae0SJoe Perches } 72545ce59ae0SJoe Perches 7255caf2a54fSJoe Perches# check for multiple semicolons 7256caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 7257d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 7258d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 7259d5e616fcSJoe Perches $fix) { 7260194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 7261d5e616fcSJoe Perches } 7262d1e2ad07SJoe Perches } 7263d1e2ad07SJoe Perches 7264cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 7265cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 7266cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 72670ab90191SJoe Perches my $ull = ""; 72680ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 72690ab90191SJoe Perches if (CHK("BIT_MACRO", 72700ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 72710ab90191SJoe Perches $fix) { 72720ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 72730ab90191SJoe Perches } 72740ab90191SJoe Perches } 72750ab90191SJoe Perches 727650161266SJoe Perches# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too) 72773e89ad85SJerome Forissier if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) { 727850161266SJoe Perches WARN("IS_ENABLED_CONFIG", 72793e89ad85SJerome Forissier "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr); 728050161266SJoe Perches } 728150161266SJoe Perches 72822d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 72833e89ad85SJerome 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*$/) { 72842d632745SJoe Perches my $config = $1; 72852d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 72863e89ad85SJerome Forissier "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) && 72872d632745SJoe Perches $fix) { 72882d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 72892d632745SJoe Perches } 72902d632745SJoe Perches } 72912d632745SJoe Perches 7292f36d3eb8SJoe Perches# check for /* fallthrough */ like comment, prefer fallthrough; 7293f36d3eb8SJoe Perches my @fallthroughs = ( 7294f36d3eb8SJoe Perches 'fallthrough', 7295f36d3eb8SJoe Perches '@fallthrough@', 7296f36d3eb8SJoe Perches 'lint -fallthrough[ \t]*', 7297f36d3eb8SJoe Perches 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)', 7298f36d3eb8SJoe Perches '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?', 7299f36d3eb8SJoe Perches 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 7300f36d3eb8SJoe Perches 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 7301f36d3eb8SJoe Perches ); 7302f36d3eb8SJoe Perches if ($raw_comment ne '') { 7303f36d3eb8SJoe Perches foreach my $ft (@fallthroughs) { 7304f36d3eb8SJoe Perches if ($raw_comment =~ /$ft/) { 7305f36d3eb8SJoe Perches my $msg_level = \&WARN; 7306f36d3eb8SJoe Perches $msg_level = \&CHK if ($file); 7307f36d3eb8SJoe Perches &{$msg_level}("PREFER_FALLTHROUGH", 7308f36d3eb8SJoe Perches "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr); 7309f36d3eb8SJoe Perches last; 7310f36d3eb8SJoe Perches } 7311f36d3eb8SJoe Perches } 7312f36d3eb8SJoe Perches } 7313f36d3eb8SJoe Perches 7314d1e2ad07SJoe Perches# check for switch/default statements without a break; 73155b57980dSJoe Perches if ($perl_version_ok && 7316d1e2ad07SJoe Perches defined $stat && 7317d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 7318d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 7319e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 7320e3d95a2aSTobin C. Harding 7321d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 7322d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 7323caf2a54fSJoe Perches } 7324caf2a54fSJoe Perches 732513214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 7326d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 7327d5e616fcSJoe Perches if (WARN("USE_FUNC", 7328d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 7329d5e616fcSJoe Perches $fix) { 7330194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 7331d5e616fcSJoe Perches } 733213214adfSAndy Whitcroft } 7333773647a0SAndy Whitcroft 733462ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 733562ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 733662ec818fSJoe Perches ERROR("DATE_TIME", 733762ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 733862ec818fSJoe Perches } 733962ec818fSJoe Perches 73402c92488aSJoe Perches# check for use of yield() 73412c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 73422c92488aSJoe Perches WARN("YIELD", 73432c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 73442c92488aSJoe Perches } 73452c92488aSJoe Perches 7346179f8f40SJoe Perches# check for comparisons against true and false 7347179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 7348179f8f40SJoe Perches my $lead = $1; 7349179f8f40SJoe Perches my $arg = $2; 7350179f8f40SJoe Perches my $test = $3; 7351179f8f40SJoe Perches my $otype = $4; 7352179f8f40SJoe Perches my $trail = $5; 7353179f8f40SJoe Perches my $op = "!"; 7354179f8f40SJoe Perches 7355179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 7356179f8f40SJoe Perches 7357179f8f40SJoe Perches my $type = lc($otype); 7358179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 7359179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 7360179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 7361179f8f40SJoe Perches $op = ""; 7362179f8f40SJoe Perches } 7363179f8f40SJoe Perches 7364179f8f40SJoe Perches CHK("BOOL_COMPARISON", 7365179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 7366179f8f40SJoe Perches 7367179f8f40SJoe Perches## maybe suggesting a correct construct would better 7368179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 7369179f8f40SJoe Perches 7370179f8f40SJoe Perches } 7371179f8f40SJoe Perches } 7372179f8f40SJoe Perches 73734882720bSThomas Gleixner# check for semaphores initialized locked 73744882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 7375000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 7376000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 7377773647a0SAndy Whitcroft } 73786712d858SJoe Perches 737967d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 738067d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 7381000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 738267d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 7383773647a0SAndy Whitcroft } 73846712d858SJoe Perches 7385ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 7386f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 7387000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 7388ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 7389f3db6639SMichael Ellerman } 73906712d858SJoe Perches 73913d709ab5SPaul E. McKenney# check for spin_is_locked(), suggest lockdep instead 73923d709ab5SPaul E. McKenney if ($line =~ /\bspin_is_locked\(/) { 73933d709ab5SPaul E. McKenney WARN("USE_LOCKDEP", 73943d709ab5SPaul E. McKenney "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr); 73953d709ab5SPaul E. McKenney } 73963d709ab5SPaul E. McKenney 73979189c7e7SJoe Perches# check for deprecated apis 73989189c7e7SJoe Perches if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) { 73999189c7e7SJoe Perches my $deprecated_api = $1; 74009189c7e7SJoe Perches my $new_api = $deprecated_apis{$deprecated_api}; 74019189c7e7SJoe Perches WARN("DEPRECATED_API", 74029189c7e7SJoe Perches "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr); 74039189c7e7SJoe Perches } 74049189c7e7SJoe Perches 74050f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 7406d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 7407ced69da1SQuentin Monnet if (defined($const_structs) && 7408ced69da1SQuentin Monnet $line !~ /\bconst\b/ && 7409d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 7410000d1cc1SJoe Perches WARN("CONST_STRUCT", 7411d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 74122b6db5cbSAndy Whitcroft } 7413773647a0SAndy Whitcroft 7414773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 7415773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 741635cdcbfcSPeng Wang# ignore designated initializers using NR_CPUS 7417773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 7418c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 7419c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 7420171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 7421171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 742235cdcbfcSPeng Wang $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/ && 742335cdcbfcSPeng Wang $line !~ /^.\s*\.\w+\s*=\s*.*\bNR_CPUS\b/) 7424773647a0SAndy Whitcroft { 7425000d1cc1SJoe Perches WARN("NR_CPUS", 7426000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 7427773647a0SAndy Whitcroft } 74289c9ba34eSAndy Whitcroft 742952ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 743052ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 743152ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 743252ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 743352ea8506SJoe Perches } 743452ea8506SJoe Perches 7435acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 74365b57980dSJoe Perches if ($perl_version_ok && 7437acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 7438acd9362cSJoe Perches WARN("LIKELY_MISUSE", 7439acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 7440acd9362cSJoe Perches } 7441acd9362cSJoe Perches 7442fbe74541SJoe Perches# return sysfs_emit(foo, fmt, ...) fmt without newline 7443fbe74541SJoe Perches if ($line =~ /\breturn\s+sysfs_emit\s*\(\s*$FuncArg\s*,\s*($String)/ && 7444fbe74541SJoe Perches substr($rawline, $-[6], $+[6] - $-[6]) !~ /\\n"$/) { 7445fbe74541SJoe Perches my $offset = $+[6] - 1; 7446fbe74541SJoe Perches if (WARN("SYSFS_EMIT", 7447fbe74541SJoe Perches "return sysfs_emit(...) formats should include a terminating newline\n" . $herecurr) && 7448fbe74541SJoe Perches $fix) { 7449fbe74541SJoe Perches substr($fixed[$fixlinenr], $offset, 0) = '\\n'; 7450fbe74541SJoe Perches } 7451fbe74541SJoe Perches } 7452fbe74541SJoe Perches 74538515e4a7SKees Cook# check for array definition/declarations that should use flexible arrays instead 74548515e4a7SKees Cook if ($sline =~ /^[\+ ]\s*\}(?:\s*__packed)?\s*;\s*$/ && 74558515e4a7SKees Cook $prevline =~ /^\+\s*(?:\}(?:\s*__packed\s*)?|$Type)\s*$Ident\s*\[\s*(0|1)\s*\]\s*;\s*$/) { 74568515e4a7SKees Cook if (ERROR("FLEXIBLE_ARRAY", 74578515e4a7SKees Cook "Use C99 flexible arrays - see https://docs.kernel.org/process/deprecated.html#zero-length-and-one-element-arrays\n" . $hereprev) && 74588515e4a7SKees Cook $1 == '0' && $fix) { 74598515e4a7SKees Cook $fixed[$fixlinenr - 1] =~ s/\[\s*0\s*\]/[]/; 74608515e4a7SKees Cook } 74618515e4a7SKees Cook } 74628515e4a7SKees Cook 7463de3f186fSDenis Efremov# nested likely/unlikely calls 7464de3f186fSDenis Efremov if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) { 7465de3f186fSDenis Efremov WARN("LIKELY_MISUSE", 7466de3f186fSDenis Efremov "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr); 7467de3f186fSDenis Efremov } 7468de3f186fSDenis Efremov 7469691d77b6SAndy Whitcroft# whine mightly about in_atomic 7470691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 7471691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 7472000d1cc1SJoe Perches ERROR("IN_ATOMIC", 7473000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 7474f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 7475000d1cc1SJoe Perches WARN("IN_ATOMIC", 7476000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 7477691d77b6SAndy Whitcroft } 7478691d77b6SAndy Whitcroft } 74791704f47bSPeter Zijlstra 74801704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 74811704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 74821704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 74831704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 74841704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 74851704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 7486000d1cc1SJoe Perches ERROR("LOCKDEP", 7487000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 74881704f47bSPeter Zijlstra } 74891704f47bSPeter Zijlstra } 749088f8831cSDave Jones 7491b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 7492b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 7493000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 7494000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 749588f8831cSDave Jones } 74962435880fSJoe Perches 749700180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 749800180468SJoe Perches# and whether or not function naming is typical and if 749900180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 75005b57980dSJoe Perches if ($perl_version_ok && 750100180468SJoe Perches defined $stat && 750200180468SJoe 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*\)/) { 750300180468SJoe Perches my $var = $1; 750400180468SJoe Perches my $perms = $2; 750500180468SJoe Perches my $show = $3; 750600180468SJoe Perches my $store = $4; 750700180468SJoe Perches my $octal_perms = perms_to_octal($perms); 750800180468SJoe Perches if ($show =~ /^${var}_show$/ && 750900180468SJoe Perches $store =~ /^${var}_store$/ && 751000180468SJoe Perches $octal_perms eq "0644") { 751100180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 751200180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 751300180468SJoe Perches $fix) { 751400180468SJoe 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})/; 751500180468SJoe Perches } 751600180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 751700180468SJoe Perches $store =~ /^NULL$/ && 751800180468SJoe Perches $octal_perms eq "0444") { 751900180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 752000180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 752100180468SJoe Perches $fix) { 752200180468SJoe 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})/; 752300180468SJoe Perches } 752400180468SJoe Perches } elsif ($show =~ /^NULL$/ && 752500180468SJoe Perches $store =~ /^${var}_store$/ && 752600180468SJoe Perches $octal_perms eq "0200") { 752700180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 752800180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 752900180468SJoe Perches $fix) { 753000180468SJoe 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})/; 753100180468SJoe Perches } 753200180468SJoe Perches } elsif ($octal_perms eq "0644" || 753300180468SJoe Perches $octal_perms eq "0444" || 753400180468SJoe Perches $octal_perms eq "0200") { 753500180468SJoe Perches my $newshow = "$show"; 753600180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 753700180468SJoe Perches my $newstore = $store; 753800180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 753900180468SJoe Perches my $rename = ""; 754000180468SJoe Perches if ($show ne $newshow) { 754100180468SJoe Perches $rename .= " '$show' to '$newshow'"; 754200180468SJoe Perches } 754300180468SJoe Perches if ($store ne $newstore) { 754400180468SJoe Perches $rename .= " '$store' to '$newstore'"; 754500180468SJoe Perches } 754600180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 754700180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 754800180468SJoe Perches } else { 754900180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 755000180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 755100180468SJoe Perches } 755200180468SJoe Perches } 755300180468SJoe Perches 7554515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 7555515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 755673121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 755773121534SJoe Perches# specific definition of not visible in sysfs. 755873121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 755973121534SJoe Perches# use the default permissions 75605b57980dSJoe Perches if ($perl_version_ok && 7561459cf0aeSJoe Perches defined $stat && 7562515a235eSJoe Perches $line =~ /$mode_perms_search/) { 75632435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 75642435880fSJoe Perches my $func = $entry->[0]; 75652435880fSJoe Perches my $arg_pos = $entry->[1]; 75662435880fSJoe Perches 7567459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 7568459cf0aeSJoe Perches $lc = $lc + $linenr; 75692a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 7570459cf0aeSJoe Perches 75712435880fSJoe Perches my $skip_args = ""; 75722435880fSJoe Perches if ($arg_pos > 1) { 75732435880fSJoe Perches $arg_pos--; 75742435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 75752435880fSJoe Perches } 7576f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 7577459cf0aeSJoe Perches if ($stat =~ /$test/) { 75782435880fSJoe Perches my $val = $1; 75792435880fSJoe Perches $val = $6 if ($skip_args ne ""); 758073121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 758173121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 758273121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 75832435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 7584459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 7585f90774e1SJoe Perches } 7586f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 7587c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 7588459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 75892435880fSJoe Perches } 7590459cf0aeSJoe Perches } 7591459cf0aeSJoe Perches } 7592459cf0aeSJoe Perches } 7593459cf0aeSJoe Perches 7594459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 7595bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 759600180468SJoe Perches my $oval = $1; 759700180468SJoe Perches my $octal = perms_to_octal($oval); 7598f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 7599459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 7600f90774e1SJoe Perches $fix) { 760100180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 76022435880fSJoe Perches } 760313214adfSAndy Whitcroft } 76045a6d20ceSBjorn Andersson 76055a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 76065a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 76075a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 76085a6d20ceSBjorn Andersson my $valid_licenses = qr{ 76095a6d20ceSBjorn Andersson GPL| 76105a6d20ceSBjorn Andersson GPL\ v2| 76115a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 76125a6d20ceSBjorn Andersson Dual\ BSD/GPL| 76135a6d20ceSBjorn Andersson Dual\ MIT/GPL| 76145a6d20ceSBjorn Andersson Dual\ MPL/GPL| 76155a6d20ceSBjorn Andersson Proprietary 76165a6d20ceSBjorn Andersson }x; 76175a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 76185a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 76195a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 76205a6d20ceSBjorn Andersson } 76216e8f42dcSJoe Perches if (!$file && $extracted_string eq '"GPL v2"') { 76226e8f42dcSJoe Perches if (WARN("MODULE_LICENSE", 76236e8f42dcSJoe Perches "Prefer \"GPL\" over \"GPL v2\" - see commit bf7fbeeae6db (\"module: Cure the MODULE_LICENSE \"GPL\" vs. \"GPL v2\" bogosity\")\n" . $herecurr) && 76246e8f42dcSJoe Perches $fix) { 76256e8f42dcSJoe Perches $fixed[$fixlinenr] =~ s/\bMODULE_LICENSE\s*\(\s*"GPL v2"\s*\)/MODULE_LICENSE("GPL")/; 76266e8f42dcSJoe Perches } 76276e8f42dcSJoe Perches } 76285a6d20ceSBjorn Andersson } 76296a8d76cbSMatteo Croce 76306a8d76cbSMatteo Croce# check for sysctl duplicate constants 76316a8d76cbSMatteo Croce if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) { 76326a8d76cbSMatteo Croce WARN("DUPLICATED_SYSCTL_CONST", 76336a8d76cbSMatteo Croce "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr); 76346a8d76cbSMatteo Croce } 7635515a235eSJoe Perches } 763613214adfSAndy Whitcroft 763713214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 763813214adfSAndy Whitcroft # so just keep quiet. 763913214adfSAndy Whitcroft if ($#rawlines == -1) { 764013214adfSAndy Whitcroft exit(0); 76410a920b5bSAndy Whitcroft } 76420a920b5bSAndy Whitcroft 76438905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 76448905a67cSAndy Whitcroft # things that appear to be patches. 76458905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 76468905a67cSAndy Whitcroft exit(0); 76478905a67cSAndy Whitcroft } 76488905a67cSAndy Whitcroft 7649e73d2715SDwaipayan Ray # This is not a patch, and we are in 'no-patch' mode so 76508905a67cSAndy Whitcroft # just keep quiet. 76518905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 76528905a67cSAndy Whitcroft exit(0); 76538905a67cSAndy Whitcroft } 76548905a67cSAndy Whitcroft 7655a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 7656000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 7657000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 76580a920b5bSAndy Whitcroft } 7659cd261496SGeert Uytterhoeven if ($is_patch && $has_commit_log && $chk_signoff) { 7660cd261496SGeert Uytterhoeven if ($signoff == 0) { 7661000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 7662000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 766348ca2d8aSDwaipayan Ray } elsif ($authorsignoff != 1) { 766448ca2d8aSDwaipayan Ray # authorsignoff values: 766548ca2d8aSDwaipayan Ray # 0 -> missing sign off 766648ca2d8aSDwaipayan Ray # 1 -> sign off identical 766748ca2d8aSDwaipayan Ray # 2 -> names and addresses match, comments mismatch 766848ca2d8aSDwaipayan Ray # 3 -> addresses match, names different 766948ca2d8aSDwaipayan Ray # 4 -> names match, addresses different 767048ca2d8aSDwaipayan Ray # 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match 767148ca2d8aSDwaipayan Ray 767248ca2d8aSDwaipayan Ray my $sob_msg = "'From: $author' != 'Signed-off-by: $author_sob'"; 767348ca2d8aSDwaipayan Ray 767448ca2d8aSDwaipayan Ray if ($authorsignoff == 0) { 767548ca2d8aSDwaipayan Ray ERROR("NO_AUTHOR_SIGN_OFF", 7676cd261496SGeert Uytterhoeven "Missing Signed-off-by: line by nominal patch author '$author'\n"); 767748ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 2) { 767848ca2d8aSDwaipayan Ray CHK("FROM_SIGN_OFF_MISMATCH", 767948ca2d8aSDwaipayan Ray "From:/Signed-off-by: email comments mismatch: $sob_msg\n"); 768048ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 3) { 768148ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 768248ca2d8aSDwaipayan Ray "From:/Signed-off-by: email name mismatch: $sob_msg\n"); 768348ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 4) { 768448ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 768548ca2d8aSDwaipayan Ray "From:/Signed-off-by: email address mismatch: $sob_msg\n"); 768648ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 5) { 768748ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 768848ca2d8aSDwaipayan Ray "From:/Signed-off-by: email subaddress mismatch: $sob_msg\n"); 768948ca2d8aSDwaipayan Ray } 7690cd261496SGeert Uytterhoeven } 76910a920b5bSAndy Whitcroft } 76920a920b5bSAndy Whitcroft 7693f0a594c1SAndy Whitcroft print report_dump(); 769413214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 769513214adfSAndy Whitcroft print "$filename " if ($summary_file); 76966c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 76976c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 76986c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 76996c72ffaaSAndy Whitcroft } 77008905a67cSAndy Whitcroft 7701d2c0a235SAndy Whitcroft if ($quiet == 0) { 7702ef212196SJoe Perches # If there were any defects found and not already fixing them 7703ef212196SJoe Perches if (!$clean and !$fix) { 7704ef212196SJoe Perches print << "EOM" 7705ef212196SJoe Perches 7706ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 7707ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 7708ef212196SJoe PerchesEOM 7709ef212196SJoe Perches } 7710d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 7711d2c0a235SAndy Whitcroft # then suggest that. 7712d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 7713b0781216SMike Frysinger $rpt_cleaners = 0; 7714d8469f16SJoe Perches print << "EOM" 7715d8469f16SJoe Perches 7716d8469f16SJoe PerchesNOTE: Whitespace errors detected. 7717d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 7718d8469f16SJoe PerchesEOM 7719d2c0a235SAndy Whitcroft } 7720d2c0a235SAndy Whitcroft } 7721d2c0a235SAndy Whitcroft 7722d752fcc8SJoe Perches if ($clean == 0 && $fix && 7723d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 7724d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 77259624b8d6SJoe Perches my $newfile = $filename; 77269624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 77273705ce5bSJoe Perches my $linecount = 0; 77283705ce5bSJoe Perches my $f; 77293705ce5bSJoe Perches 7730d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 7731d752fcc8SJoe Perches 77323705ce5bSJoe Perches open($f, '>', $newfile) 77333705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 77343705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 77353705ce5bSJoe Perches $linecount++; 77363705ce5bSJoe Perches if ($file) { 77373705ce5bSJoe Perches if ($linecount > 3) { 77383705ce5bSJoe Perches $fixed_line =~ s/^\+//; 77393705ce5bSJoe Perches print $f $fixed_line . "\n"; 77403705ce5bSJoe Perches } 77413705ce5bSJoe Perches } else { 77423705ce5bSJoe Perches print $f $fixed_line . "\n"; 77433705ce5bSJoe Perches } 77443705ce5bSJoe Perches } 77453705ce5bSJoe Perches close($f); 77463705ce5bSJoe Perches 77473705ce5bSJoe Perches if (!$quiet) { 77483705ce5bSJoe Perches print << "EOM"; 7749d8469f16SJoe Perches 77503705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 77513705ce5bSJoe Perches 77523705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 77533705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 77543705ce5bSJoe Perches 77553705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 77563705ce5bSJoe PerchesNo warranties, expressed or implied... 77573705ce5bSJoe PerchesEOM 77583705ce5bSJoe Perches } 77593705ce5bSJoe Perches } 77603705ce5bSJoe Perches 7761d8469f16SJoe Perches if ($quiet == 0) { 7762d8469f16SJoe Perches print "\n"; 7763d8469f16SJoe Perches if ($clean == 1) { 7764d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 7765d8469f16SJoe Perches } else { 7766d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 77670a920b5bSAndy Whitcroft } 77680a920b5bSAndy Whitcroft } 77690a920b5bSAndy Whitcroft return $clean; 77700a920b5bSAndy Whitcroft} 7771