1cb77f0d6SKamil Rytarowski#!/usr/bin/env perl 2882ea1d6SJoe Perches# SPDX-License-Identifier: GPL-2.0 3882ea1d6SJoe Perches# 4dbf004d7SDave Jones# (c) 2001, Dave Jones. (the file handling bit) 500df344fSAndy Whitcroft# (c) 2005, Joel Schopp <[email protected]> (the ugly bit) 62a5a2c25SAndy Whitcroft# (c) 2007,2008, Andy Whitcroft <[email protected]> (new conditions, test suite) 7015830beSAndy Whitcroft# (c) 2008-2010 Andy Whitcroft <[email protected]> 8882ea1d6SJoe Perches# (c) 2010-2018 Joe Perches <[email protected]> 90a920b5bSAndy Whitcroft 100a920b5bSAndy Whitcroftuse strict; 11cb77f0d6SKamil Rytarowskiuse warnings; 12c707a81dSJoe Perchesuse POSIX; 1336061e38SJoe Perchesuse File::Basename; 1436061e38SJoe Perchesuse Cwd 'abs_path'; 1557230297SJoe Perchesuse Term::ANSIColor qw(:constants); 16cd261496SGeert Uytterhoevenuse Encode qw(decode encode); 170a920b5bSAndy Whitcroft 180a920b5bSAndy Whitcroftmy $P = $0; 1936061e38SJoe Perchesmy $D = dirname(abs_path($P)); 200a920b5bSAndy Whitcroft 21000d1cc1SJoe Perchesmy $V = '0.32'; 220a920b5bSAndy Whitcroft 230a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 240a920b5bSAndy Whitcroft 250a920b5bSAndy Whitcroftmy $quiet = 0; 2652178ce0SDwaipayan Raymy $verbose = 0; 2752178ce0SDwaipayan Raymy %verbose_messages = (); 2852178ce0SDwaipayan Raymy %verbose_emitted = (); 290a920b5bSAndy Whitcroftmy $tree = 1; 300a920b5bSAndy Whitcroftmy $chk_signoff = 1; 310a920b5bSAndy Whitcroftmy $chk_patch = 1; 32773647a0SAndy Whitcroftmy $tst_only; 336c72ffaaSAndy Whitcroftmy $emacs = 0; 348905a67cSAndy Whitcroftmy $terse = 0; 3534d8815fSJoe Perchesmy $showfile = 0; 366c72ffaaSAndy Whitcroftmy $file = 0; 374a593c34SDu, Changbinmy $git = 0; 380dea9f1eSJoe Perchesmy %git_commits = (); 396c72ffaaSAndy Whitcroftmy $check = 0; 402ac73b4fSJoe Perchesmy $check_orig = 0; 418905a67cSAndy Whitcroftmy $summary = 1; 428905a67cSAndy Whitcroftmy $mailback = 0; 4313214adfSAndy Whitcroftmy $summary_file = 0; 44000d1cc1SJoe Perchesmy $show_types = 0; 453beb42ecSJoe Perchesmy $list_types = 0; 463705ce5bSJoe Perchesmy $fix = 0; 479624b8d6SJoe Perchesmy $fix_inplace = 0; 486c72ffaaSAndy Whitcroftmy $root; 490f7f635bSJoe Perchesmy $gitroot = $ENV{'GIT_DIR'}; 500f7f635bSJoe Perches$gitroot = ".git" if !defined($gitroot); 51c2fdda0dSAndy Whitcroftmy %debug; 523445686aSJoe Perchesmy %camelcase = (); 5391bfe484SJoe Perchesmy %use_type = (); 5491bfe484SJoe Perchesmy @use = (); 5591bfe484SJoe Perchesmy %ignore_type = (); 56000d1cc1SJoe Perchesmy @ignore = (); 5777f5b10aSHannes Edermy $help = 0; 58000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 59bdc48fa1SJoe Perchesmy $max_line_length = 100; 60d62a201fSDave Hansenmy $ignore_perl_version = 0; 61d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 6256193274SVadim Bendeburymy $min_conf_desc_length = 4; 6366b47b4aSKees Cookmy $spelling_file = "$D/spelling.txt"; 64ebfd7d62SJoe Perchesmy $codespell = 0; 65f1a63678SMaxim Uvarovmy $codespellfile = "/usr/share/codespell/dictionary.txt"; 660ee3e7b8SPeter Ujfalusimy $user_codespellfile = ""; 67bf1fa1daSJoe Perchesmy $conststructsfile = "$D/const_structs.checkpatch"; 6852178ce0SDwaipayan Raymy $docsfile = "$D/../Documentation/dev-tools/checkpatch.rst"; 69ced69da1SQuentin Monnetmy $typedefsfile; 70737c0767SJohn Brooksmy $color = "auto"; 7198005e8cSVadim Bendeburymy $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE 72dbbf869dSJoe Perches# git output parsing needs US English output, so first set backtick child process LANGUAGE 73dbbf869dSJoe Perchesmy $git_command ='export LANGUAGE=en_US.UTF-8; git'; 74713a09deSAntonio Borneomy $tabsize = 8; 753e89ad85SJerome Forissiermy ${CONFIG_} = "CONFIG_"; 7677f5b10aSHannes Eder 7777f5b10aSHannes Edersub help { 7877f5b10aSHannes Eder my ($exitcode) = @_; 7977f5b10aSHannes Eder 8077f5b10aSHannes Eder print << "EOM"; 8177f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 8277f5b10aSHannes EderVersion: $V 8377f5b10aSHannes Eder 8477f5b10aSHannes EderOptions: 8577f5b10aSHannes Eder -q, --quiet quiet 8652178ce0SDwaipayan Ray -v, --verbose verbose mode 8777f5b10aSHannes Eder --no-tree run without a kernel tree 8877f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 8977f5b10aSHannes Eder --patch treat FILE as patchfile (default) 9077f5b10aSHannes Eder --emacs emacs compile window format 9177f5b10aSHannes Eder --terse one line per report 9234d8815fSJoe Perches --showfile emit diffed file position, not input file position 934a593c34SDu, Changbin -g, --git treat FILE as a single commit or git revision range 944a593c34SDu, Changbin single git commit with: 954a593c34SDu, Changbin <rev> 964a593c34SDu, Changbin <rev>^ 974a593c34SDu, Changbin <rev>~n 984a593c34SDu, Changbin multiple git commits with: 994a593c34SDu, Changbin <rev1>..<rev2> 1004a593c34SDu, Changbin <rev1>...<rev2> 1014a593c34SDu, Changbin <rev>-<count> 1024a593c34SDu, Changbin git merges are ignored 10377f5b10aSHannes Eder -f, --file treat FILE as regular source file 10477f5b10aSHannes Eder --subjective, --strict enable more subjective tests 1053beb42ecSJoe Perches --list-types list the possible message types 10691bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 107000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 1083beb42ecSJoe Perches --show-types show the specific message type in the output 109bdc48fa1SJoe Perches --max-line-length=n set the maximum line length, (default $max_line_length) 110bdc48fa1SJoe Perches if exceeded, warn on patches 111bdc48fa1SJoe Perches requires --strict for use with --file 11256193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 113bdc48fa1SJoe Perches --tab-size=n set the number of spaces for tab (default $tabsize) 11477f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 11577f5b10aSHannes Eder --no-summary suppress the per-file summary 11677f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 11777f5b10aSHannes Eder --summary-file include the filename in summary 11877f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 11977f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 12077f5b10aSHannes Eder is all off) 12177f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 12277f5b10aSHannes Eder literally 1233705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 1243705ce5bSJoe Perches If correctable single-line errors exist, create 1253705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 1263705ce5bSJoe Perches with potential errors corrected to the preferred 1273705ce5bSJoe Perches checkpatch style 1289624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 1299624b8d6SJoe Perches Is the same as --fix, but overwrites the input 1309624b8d6SJoe Perches file. It's your fault if there's no backup or git 131d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 132d62a201fSDave Hansen runtime errors. 133ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 1340ee3e7b8SPeter Ujfalusi (default:$codespellfile) 135ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 13675ad8c57SJerome Forissier --typedefsfile Read additional types from this file 137737c0767SJohn Brooks --color[=WHEN] Use colors 'always', 'never', or only when output 138737c0767SJohn Brooks is a terminal ('auto'). Default is 'auto'. 1393e89ad85SJerome Forissier --kconfig-prefix=WORD use WORD as a prefix for Kconfig symbols (default 1403e89ad85SJerome Forissier ${CONFIG_}) 14177f5b10aSHannes Eder -h, --help, --version display this help and exit 14277f5b10aSHannes Eder 14377f5b10aSHannes EderWhen FILE is - read standard input. 14477f5b10aSHannes EderEOM 14577f5b10aSHannes Eder 14677f5b10aSHannes Eder exit($exitcode); 14777f5b10aSHannes Eder} 14877f5b10aSHannes Eder 1493beb42ecSJoe Perchessub uniq { 1503beb42ecSJoe Perches my %seen; 1513beb42ecSJoe Perches return grep { !$seen{$_}++ } @_; 1523beb42ecSJoe Perches} 1533beb42ecSJoe Perches 1543beb42ecSJoe Perchessub list_types { 1553beb42ecSJoe Perches my ($exitcode) = @_; 1563beb42ecSJoe Perches 1573beb42ecSJoe Perches my $count = 0; 1583beb42ecSJoe Perches 1593beb42ecSJoe Perches local $/ = undef; 1603beb42ecSJoe Perches 1613beb42ecSJoe Perches open(my $script, '<', abs_path($P)) or 1623beb42ecSJoe Perches die "$P: Can't read '$P' $!\n"; 1633beb42ecSJoe Perches 1643beb42ecSJoe Perches my $text = <$script>; 1653beb42ecSJoe Perches close($script); 1663beb42ecSJoe Perches 16752178ce0SDwaipayan Ray my %types = (); 1680547fa58SJean Delvare # Also catch when type or level is passed through a variable 16952178ce0SDwaipayan Ray while ($text =~ /(?:(\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) { 17052178ce0SDwaipayan Ray if (defined($1)) { 17152178ce0SDwaipayan Ray if (exists($types{$2})) { 17252178ce0SDwaipayan Ray $types{$2} .= ",$1" if ($types{$2} ne $1); 17352178ce0SDwaipayan Ray } else { 17452178ce0SDwaipayan Ray $types{$2} = $1; 1753beb42ecSJoe Perches } 17652178ce0SDwaipayan Ray } else { 17752178ce0SDwaipayan Ray $types{$2} = "UNDETERMINED"; 17852178ce0SDwaipayan Ray } 17952178ce0SDwaipayan Ray } 18052178ce0SDwaipayan Ray 1813beb42ecSJoe Perches print("#\tMessage type\n\n"); 18252178ce0SDwaipayan Ray if ($color) { 18352178ce0SDwaipayan Ray print(" ( Color coding: "); 18452178ce0SDwaipayan Ray print(RED . "ERROR" . RESET); 18552178ce0SDwaipayan Ray print(" | "); 18652178ce0SDwaipayan Ray print(YELLOW . "WARNING" . RESET); 18752178ce0SDwaipayan Ray print(" | "); 18852178ce0SDwaipayan Ray print(GREEN . "CHECK" . RESET); 18952178ce0SDwaipayan Ray print(" | "); 19052178ce0SDwaipayan Ray print("Multiple levels / Undetermined"); 19152178ce0SDwaipayan Ray print(" )\n\n"); 19252178ce0SDwaipayan Ray } 19352178ce0SDwaipayan Ray 19452178ce0SDwaipayan Ray foreach my $type (sort keys %types) { 19552178ce0SDwaipayan Ray my $orig_type = $type; 19652178ce0SDwaipayan Ray if ($color) { 19752178ce0SDwaipayan Ray my $level = $types{$type}; 19852178ce0SDwaipayan Ray if ($level eq "ERROR") { 19952178ce0SDwaipayan Ray $type = RED . $type . RESET; 20052178ce0SDwaipayan Ray } elsif ($level eq "WARN") { 20152178ce0SDwaipayan Ray $type = YELLOW . $type . RESET; 20252178ce0SDwaipayan Ray } elsif ($level eq "CHK") { 20352178ce0SDwaipayan Ray $type = GREEN . $type . RESET; 20452178ce0SDwaipayan Ray } 20552178ce0SDwaipayan Ray } 2063beb42ecSJoe Perches print(++$count . "\t" . $type . "\n"); 20752178ce0SDwaipayan Ray if ($verbose && exists($verbose_messages{$orig_type})) { 20852178ce0SDwaipayan Ray my $message = $verbose_messages{$orig_type}; 20952178ce0SDwaipayan Ray $message =~ s/\n/\n\t/g; 21052178ce0SDwaipayan Ray print("\t" . $message . "\n\n"); 21152178ce0SDwaipayan Ray } 2123beb42ecSJoe Perches } 2133beb42ecSJoe Perches 2143beb42ecSJoe Perches exit($exitcode); 2153beb42ecSJoe Perches} 2163beb42ecSJoe Perches 217000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 218000d1cc1SJoe Perchesif (-f $conf) { 219000d1cc1SJoe Perches my @conf_args; 220000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 221000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 222000d1cc1SJoe Perches 223000d1cc1SJoe Perches while (<$conffile>) { 224000d1cc1SJoe Perches my $line = $_; 225000d1cc1SJoe Perches 226000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 227000d1cc1SJoe Perches $line =~ s/^\s*//g; 228000d1cc1SJoe Perches $line =~ s/\s+/ /g; 229000d1cc1SJoe Perches 230000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 231000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 232000d1cc1SJoe Perches 233000d1cc1SJoe Perches my @words = split(" ", $line); 234000d1cc1SJoe Perches foreach my $word (@words) { 235000d1cc1SJoe Perches last if ($word =~ m/^#/); 236000d1cc1SJoe Perches push (@conf_args, $word); 237000d1cc1SJoe Perches } 238000d1cc1SJoe Perches } 239000d1cc1SJoe Perches close($conffile); 240000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 241000d1cc1SJoe Perches} 242000d1cc1SJoe Perches 24352178ce0SDwaipayan Raysub load_docs { 24452178ce0SDwaipayan Ray open(my $docs, '<', "$docsfile") 24552178ce0SDwaipayan Ray or warn "$P: Can't read the documentation file $docsfile $!\n"; 24652178ce0SDwaipayan Ray 24752178ce0SDwaipayan Ray my $type = ''; 24852178ce0SDwaipayan Ray my $desc = ''; 24952178ce0SDwaipayan Ray my $in_desc = 0; 25052178ce0SDwaipayan Ray 25152178ce0SDwaipayan Ray while (<$docs>) { 25252178ce0SDwaipayan Ray chomp; 25352178ce0SDwaipayan Ray my $line = $_; 25452178ce0SDwaipayan Ray $line =~ s/\s+$//; 25552178ce0SDwaipayan Ray 25652178ce0SDwaipayan Ray if ($line =~ /^\s*\*\*(.+)\*\*$/) { 25752178ce0SDwaipayan Ray if ($desc ne '') { 25852178ce0SDwaipayan Ray $verbose_messages{$type} = trim($desc); 25952178ce0SDwaipayan Ray } 26052178ce0SDwaipayan Ray $type = $1; 26152178ce0SDwaipayan Ray $desc = ''; 26252178ce0SDwaipayan Ray $in_desc = 1; 26352178ce0SDwaipayan Ray } elsif ($in_desc) { 26452178ce0SDwaipayan Ray if ($line =~ /^(?:\s{4,}|$)/) { 26552178ce0SDwaipayan Ray $line =~ s/^\s{4}//; 26652178ce0SDwaipayan Ray $desc .= $line; 26752178ce0SDwaipayan Ray $desc .= "\n"; 26852178ce0SDwaipayan Ray } else { 26952178ce0SDwaipayan Ray $verbose_messages{$type} = trim($desc); 27052178ce0SDwaipayan Ray $type = ''; 27152178ce0SDwaipayan Ray $desc = ''; 27252178ce0SDwaipayan Ray $in_desc = 0; 27352178ce0SDwaipayan Ray } 27452178ce0SDwaipayan Ray } 27552178ce0SDwaipayan Ray } 27652178ce0SDwaipayan Ray 27752178ce0SDwaipayan Ray if ($desc ne '') { 27852178ce0SDwaipayan Ray $verbose_messages{$type} = trim($desc); 27952178ce0SDwaipayan Ray } 28052178ce0SDwaipayan Ray close($docs); 28152178ce0SDwaipayan Ray} 28252178ce0SDwaipayan Ray 283737c0767SJohn Brooks# Perl's Getopt::Long allows options to take optional arguments after a space. 284737c0767SJohn Brooks# Prevent --color by itself from consuming other arguments 285737c0767SJohn Brooksforeach (@ARGV) { 286737c0767SJohn Brooks if ($_ eq "--color" || $_ eq "-color") { 287737c0767SJohn Brooks $_ = "--color=$color"; 288737c0767SJohn Brooks } 289737c0767SJohn Brooks} 290737c0767SJohn Brooks 2910a920b5bSAndy WhitcroftGetOptions( 2926c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 29352178ce0SDwaipayan Ray 'v|verbose!' => \$verbose, 2940a920b5bSAndy Whitcroft 'tree!' => \$tree, 2950a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 2960a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 2976c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 2988905a67cSAndy Whitcroft 'terse!' => \$terse, 29934d8815fSJoe Perches 'showfile!' => \$showfile, 30077f5b10aSHannes Eder 'f|file!' => \$file, 3014a593c34SDu, Changbin 'g|git!' => \$git, 3026c72ffaaSAndy Whitcroft 'subjective!' => \$check, 3036c72ffaaSAndy Whitcroft 'strict!' => \$check, 304000d1cc1SJoe Perches 'ignore=s' => \@ignore, 30591bfe484SJoe Perches 'types=s' => \@use, 306000d1cc1SJoe Perches 'show-types!' => \$show_types, 3073beb42ecSJoe Perches 'list-types!' => \$list_types, 3086cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 30956193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 310713a09deSAntonio Borneo 'tab-size=i' => \$tabsize, 3116c72ffaaSAndy Whitcroft 'root=s' => \$root, 3128905a67cSAndy Whitcroft 'summary!' => \$summary, 3138905a67cSAndy Whitcroft 'mailback!' => \$mailback, 31413214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 3153705ce5bSJoe Perches 'fix!' => \$fix, 3169624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 317d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 318c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 319773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 320ebfd7d62SJoe Perches 'codespell!' => \$codespell, 3210ee3e7b8SPeter Ujfalusi 'codespellfile=s' => \$user_codespellfile, 32275ad8c57SJerome Forissier 'typedefsfile=s' => \$typedefsfile, 323737c0767SJohn Brooks 'color=s' => \$color, 324737c0767SJohn Brooks 'no-color' => \$color, #keep old behaviors of -nocolor 325737c0767SJohn Brooks 'nocolor' => \$color, #keep old behaviors of -nocolor 3263e89ad85SJerome Forissier 'kconfig-prefix=s' => \${CONFIG_}, 32777f5b10aSHannes Eder 'h|help' => \$help, 32877f5b10aSHannes Eder 'version' => \$help 3290ee3e7b8SPeter Ujfalusi) or $help = 2; 33077f5b10aSHannes Eder 3310ee3e7b8SPeter Ujfalusiif ($user_codespellfile) { 3320ee3e7b8SPeter Ujfalusi # Use the user provided codespell file unconditionally 3330ee3e7b8SPeter Ujfalusi $codespellfile = $user_codespellfile; 3340ee3e7b8SPeter Ujfalusi} elsif (!(-f $codespellfile)) { 3350ee3e7b8SPeter Ujfalusi # If /usr/share/codespell/dictionary.txt is not present, try to find it 3360ee3e7b8SPeter Ujfalusi # under codespell's install directory: <codespell_root>/data/dictionary.txt 337c882c6b1SSagar Patel if (($codespell || $help) && which("python3") ne "") { 3380ee3e7b8SPeter Ujfalusi my $python_codespell_dict = << "EOF"; 3390ee3e7b8SPeter Ujfalusi 3400ee3e7b8SPeter Ujfalusiimport os.path as op 3410ee3e7b8SPeter Ujfalusiimport codespell_lib 3420ee3e7b8SPeter Ujfalusicodespell_dir = op.dirname(codespell_lib.__file__) 3430ee3e7b8SPeter Ujfalusicodespell_file = op.join(codespell_dir, 'data', 'dictionary.txt') 3440ee3e7b8SPeter Ujfalusiprint(codespell_file, end='') 3450ee3e7b8SPeter UjfalusiEOF 3460ee3e7b8SPeter Ujfalusi 347c882c6b1SSagar Patel my $codespell_dict = `python3 -c "$python_codespell_dict" 2> /dev/null`; 3480ee3e7b8SPeter Ujfalusi $codespellfile = $codespell_dict if (-f $codespell_dict); 3490ee3e7b8SPeter Ujfalusi } 3500ee3e7b8SPeter Ujfalusi} 3510ee3e7b8SPeter Ujfalusi 3520ee3e7b8SPeter Ujfalusi# $help is 1 if either -h, --help or --version is passed as option - exitcode: 0 3530ee3e7b8SPeter Ujfalusi# $help is 2 if invalid option is passed - exitcode: 1 3540ee3e7b8SPeter Ujfalusihelp($help - 1) if ($help); 3550a920b5bSAndy Whitcroft 35652178ce0SDwaipayan Raydie "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix)); 35752178ce0SDwaipayan Raydie "$P: --verbose cannot be used with --terse\n" if ($verbose && $terse); 35852178ce0SDwaipayan Ray 35952178ce0SDwaipayan Rayif ($color =~ /^[01]$/) { 36052178ce0SDwaipayan Ray $color = !$color; 36152178ce0SDwaipayan Ray} elsif ($color =~ /^always$/i) { 36252178ce0SDwaipayan Ray $color = 1; 36352178ce0SDwaipayan Ray} elsif ($color =~ /^never$/i) { 36452178ce0SDwaipayan Ray $color = 0; 36552178ce0SDwaipayan Ray} elsif ($color =~ /^auto$/i) { 36652178ce0SDwaipayan Ray $color = (-t STDOUT); 36752178ce0SDwaipayan Ray} else { 36852178ce0SDwaipayan Ray die "$P: Invalid color mode: $color\n"; 36952178ce0SDwaipayan Ray} 37052178ce0SDwaipayan Ray 37152178ce0SDwaipayan Rayload_docs() if ($verbose); 3723beb42ecSJoe Percheslist_types(0) if ($list_types); 3733beb42ecSJoe Perches 3749624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 3752ac73b4fSJoe Perches$check_orig = $check; 3769624b8d6SJoe Perches 3770a920b5bSAndy Whitcroftmy $exit = 0; 3780a920b5bSAndy Whitcroft 3795b57980dSJoe Perchesmy $perl_version_ok = 1; 380d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 3815b57980dSJoe Perches $perl_version_ok = 0; 382d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 3835b57980dSJoe Perches exit(1) if (!$ignore_perl_version); 384d62a201fSDave Hansen} 385d62a201fSDave Hansen 38645107ff6SAllen Hubbe#if no filenames are given, push '-' to read patch from stdin 3870a920b5bSAndy Whitcroftif ($#ARGV < 0) { 38845107ff6SAllen Hubbe push(@ARGV, '-'); 3890a920b5bSAndy Whitcroft} 3900a920b5bSAndy Whitcroft 391713a09deSAntonio Borneo# skip TAB size 1 to avoid additional checks on $tabsize - 1 39232f30ca9SJoe Perchesdie "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2); 393713a09deSAntonio Borneo 39491bfe484SJoe Perchessub hash_save_array_words { 39591bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 39691bfe484SJoe Perches 39791bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 39891bfe484SJoe Perches foreach my $word (@array) { 399000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 400000d1cc1SJoe Perches $word =~ s/^\s*//g; 401000d1cc1SJoe Perches $word =~ s/\s+/ /g; 402000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 403000d1cc1SJoe Perches 404000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 405000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 406000d1cc1SJoe Perches 40791bfe484SJoe Perches $hashRef->{$word}++; 408000d1cc1SJoe Perches } 40991bfe484SJoe Perches} 41091bfe484SJoe Perches 41191bfe484SJoe Perchessub hash_show_words { 41291bfe484SJoe Perches my ($hashRef, $prefix) = @_; 41391bfe484SJoe Perches 4143c816e49SJoe Perches if (keys %$hashRef) { 415d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 41658cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 41791bfe484SJoe Perches print " $word"; 41891bfe484SJoe Perches } 419d8469f16SJoe Perches print "\n"; 42091bfe484SJoe Perches } 42191bfe484SJoe Perches} 42291bfe484SJoe Perches 42391bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 42491bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 425000d1cc1SJoe Perches 426c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 427c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 4287429c690SAndy Whitcroftmy $dbg_type = 0; 429a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 430c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 43121caa13cSAndy Whitcroft ## no critic 43221caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 43321caa13cSAndy Whitcroft die "$@" if ($@); 434c2fdda0dSAndy Whitcroft} 435c2fdda0dSAndy Whitcroft 436d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 437d2c0a235SAndy Whitcroft 4388905a67cSAndy Whitcroftif ($terse) { 4398905a67cSAndy Whitcroft $emacs = 1; 4408905a67cSAndy Whitcroft $quiet++; 4418905a67cSAndy Whitcroft} 4428905a67cSAndy Whitcroft 4436c72ffaaSAndy Whitcroftif ($tree) { 4446c72ffaaSAndy Whitcroft if (defined $root) { 4456c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 4466c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 4476c72ffaaSAndy Whitcroft } 4486c72ffaaSAndy Whitcroft } else { 4496c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 4506c72ffaaSAndy Whitcroft $root = '.'; 4516c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 4526c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 4536c72ffaaSAndy Whitcroft $root = $1; 4546c72ffaaSAndy Whitcroft } 4556c72ffaaSAndy Whitcroft } 4566c72ffaaSAndy Whitcroft 4576c72ffaaSAndy Whitcroft if (!defined $root) { 4580a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 4590a920b5bSAndy Whitcroft exit(2); 4600a920b5bSAndy Whitcroft } 4616c72ffaaSAndy Whitcroft} 4626c72ffaaSAndy Whitcroft 4636c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 4646c72ffaaSAndy Whitcroft 4652ceb532bSAndy Whitcroftour $Ident = qr{ 4662ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 4672ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 4682ceb532bSAndy Whitcroft }x; 4696c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 4706c72ffaaSAndy Whitcroftour $Sparse = qr{ 4716c72ffaaSAndy Whitcroft __user| 4726c72ffaaSAndy Whitcroft __kernel| 4736c72ffaaSAndy Whitcroft __force| 4746c72ffaaSAndy Whitcroft __iomem| 4756c72ffaaSAndy Whitcroft __must_check| 476417495edSAndy Whitcroft __kprobes| 477165e72a6SSven Eckelmann __ref| 47833aa4597SGeert Uytterhoeven __refconst| 47933aa4597SGeert Uytterhoeven __refdata| 480ad315455SBoqun Feng __rcu| 481ad315455SBoqun Feng __private 4826c72ffaaSAndy Whitcroft }x; 483e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 484e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 485e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 486e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 487e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 4888716de38SJoe Perches 48952131292SWolfram Sang# Notes to $Attribute: 49052131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 4916c72ffaaSAndy Whitcroftour $Attribute = qr{ 4926c72ffaaSAndy Whitcroft const| 493b5e8736aSJoe Perches volatile| 49403f1df7dSJoe Perches __percpu| 49503f1df7dSJoe Perches __nocast| 49603f1df7dSJoe Perches __safe| 49746d832f5SMichael S. Tsirkin __bitwise| 49803f1df7dSJoe Perches __packed__| 49903f1df7dSJoe Perches __packed2__| 50003f1df7dSJoe Perches __naked| 50103f1df7dSJoe Perches __maybe_unused| 50203f1df7dSJoe Perches __always_unused| 50303f1df7dSJoe Perches __noreturn| 50403f1df7dSJoe Perches __used| 50503f1df7dSJoe Perches __cold| 506e23ef1f3SJoe Perches __pure| 50703f1df7dSJoe Perches __noclone| 50803f1df7dSJoe Perches __deprecated| 5096c72ffaaSAndy Whitcroft __read_mostly| 510c5967e98SJoe Perches __ro_after_init| 5116c72ffaaSAndy Whitcroft __kprobes| 5128716de38SJoe Perches $InitAttribute| 51324e1d81aSAndy Whitcroft ____cacheline_aligned| 51424e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 5155fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 51686cffecdSKees Cook __weak| 51786cffecdSKees Cook __alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\) 5186c72ffaaSAndy Whitcroft }x; 519c45dcabdSAndy Whitcroftour $Modifier; 52091cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 5216c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 5226c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 5236c72ffaaSAndy Whitcroft 52495e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 52595e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 52695e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 52795e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 5282435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 529d2af5aa6SJoe Perchesour $String = qr{(?:\b[Lu])?"[X\t]*"}; 530326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 531326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 532326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 53374349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 5342435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 535326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 536447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 53723f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 5386c72ffaaSAndy Whitcroftour $Operators = qr{ 5396c72ffaaSAndy Whitcroft <=|>=|==|!=| 5406c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 54123f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 5426c72ffaaSAndy Whitcroft }x; 5436c72ffaaSAndy Whitcroft 54491cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 54591cb5195SJoe Perches 546ab7e23f3SJoe Perchesour $BasicType; 5478905a67cSAndy Whitcroftour $NonptrType; 5481813087dSJoe Perchesour $NonptrTypeMisordered; 5498716de38SJoe Perchesour $NonptrTypeWithAttr; 5508905a67cSAndy Whitcroftour $Type; 5511813087dSJoe Perchesour $TypeMisordered; 5528905a67cSAndy Whitcroftour $Declare; 5531813087dSJoe Perchesour $DeclareMisordered; 5548905a67cSAndy Whitcroft 55515662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 55615662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 557171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 558171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 559171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 560171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 561171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 562171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 563171ae1a4SAndy Whitcroft}x; 564171ae1a4SAndy Whitcroft 56515662b3eSJoe Perchesour $UTF8 = qr{ 56615662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 56715662b3eSJoe Perches | $NON_ASCII_UTF8 56815662b3eSJoe Perches}x; 56915662b3eSJoe Perches 570e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 571021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 572021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 573021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 574021158b4SJoe Perches)}; 575e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 576fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 5778ed22cadSAndy Whitcroft atomic_t 5788ed22cadSAndy Whitcroft)}; 579e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 580e6176fa4SJoe Perches $typeC99Typedefs\b| 581e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 582e6176fa4SJoe Perches $typeKernelTypedefs\b 583e6176fa4SJoe Perches)}; 5848ed22cadSAndy Whitcroft 5856d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 5866d32f7a3SJoe Perches 587691e669bSJoe Perchesour $logFunctions = qr{(?x: 588758d7aadSMiles Chen printk(?:_ratelimited|_once|_deferred_once|_deferred|)| 5897d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 59087bd499aSJoe Perches TP_printk| 5916e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 592b0531722SJoe Perches panic| 59306668727SJoe Perches MODULE_[A-Z_]+| 59406668727SJoe Perches seq_vprintf|seq_printf|seq_puts 595691e669bSJoe Perches)}; 596691e669bSJoe Perches 597e29a70f1SJoe Perchesour $allocFunctions = qr{(?x: 598e29a70f1SJoe Perches (?:(?:devm_)? 59958f02267SJoe Perches (?:kv|k|v)[czm]alloc(?:_array)?(?:_node)? | 600e29a70f1SJoe Perches kstrdup(?:_const)? | 601e29a70f1SJoe Perches kmemdup(?:_nul)?) | 602461e1565SChristophe JAILLET (?:\w+)?alloc_skb(?:_ip_align)? | 603e29a70f1SJoe Perches # dev_alloc_skb/netdev_alloc_skb, et al 604e29a70f1SJoe Perches dma_alloc_coherent 605e29a70f1SJoe Perches)}; 606e29a70f1SJoe Perches 60720112475SJoe Perchesour $signature_tags = qr{(?xi: 60820112475SJoe Perches Signed-off-by:| 609d499480cSJorge Ramirez-Ortiz Co-developed-by:| 61020112475SJoe Perches Acked-by:| 61120112475SJoe Perches Tested-by:| 61220112475SJoe Perches Reviewed-by:| 61320112475SJoe Perches Reported-by:| 6148543ae12SMugunthan V N Suggested-by:| 61520112475SJoe Perches To:| 61620112475SJoe Perches Cc: 61720112475SJoe Perches)}; 61820112475SJoe Perches 619adb2da82SJoe Perchesour $tracing_logging_tags = qr{(?xi: 620adb2da82SJoe Perches [=-]*> | 621adb2da82SJoe Perches <[=-]* | 622adb2da82SJoe Perches \[ | 623adb2da82SJoe Perches \] | 624adb2da82SJoe Perches start | 625adb2da82SJoe Perches called | 626adb2da82SJoe Perches entered | 627adb2da82SJoe Perches entry | 628adb2da82SJoe Perches enter | 629adb2da82SJoe Perches in | 630adb2da82SJoe Perches inside | 631adb2da82SJoe Perches here | 632adb2da82SJoe Perches begin | 633adb2da82SJoe Perches exit | 634adb2da82SJoe Perches end | 635adb2da82SJoe Perches done | 636adb2da82SJoe Perches leave | 637adb2da82SJoe Perches completed | 638adb2da82SJoe Perches out | 639adb2da82SJoe Perches return | 640adb2da82SJoe Perches [\.\!:\s]* 641adb2da82SJoe Perches)}; 642adb2da82SJoe Perches 643831242abSAditya Srivastavasub edit_distance_min { 644831242abSAditya Srivastava my (@arr) = @_; 645831242abSAditya Srivastava my $len = scalar @arr; 646831242abSAditya Srivastava if ((scalar @arr) < 1) { 647831242abSAditya Srivastava # if underflow, return 648831242abSAditya Srivastava return; 649831242abSAditya Srivastava } 650831242abSAditya Srivastava my $min = $arr[0]; 651831242abSAditya Srivastava for my $i (0 .. ($len-1)) { 652831242abSAditya Srivastava if ($arr[$i] < $min) { 653831242abSAditya Srivastava $min = $arr[$i]; 654831242abSAditya Srivastava } 655831242abSAditya Srivastava } 656831242abSAditya Srivastava return $min; 657831242abSAditya Srivastava} 658831242abSAditya Srivastava 659831242abSAditya Srivastavasub get_edit_distance { 660831242abSAditya Srivastava my ($str1, $str2) = @_; 661831242abSAditya Srivastava $str1 = lc($str1); 662831242abSAditya Srivastava $str2 = lc($str2); 663831242abSAditya Srivastava $str1 =~ s/-//g; 664831242abSAditya Srivastava $str2 =~ s/-//g; 665831242abSAditya Srivastava my $len1 = length($str1); 666831242abSAditya Srivastava my $len2 = length($str2); 667831242abSAditya Srivastava # two dimensional array storing minimum edit distance 668831242abSAditya Srivastava my @distance; 669831242abSAditya Srivastava for my $i (0 .. $len1) { 670831242abSAditya Srivastava for my $j (0 .. $len2) { 671831242abSAditya Srivastava if ($i == 0) { 672831242abSAditya Srivastava $distance[$i][$j] = $j; 673831242abSAditya Srivastava } elsif ($j == 0) { 674831242abSAditya Srivastava $distance[$i][$j] = $i; 675831242abSAditya Srivastava } elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) { 676831242abSAditya Srivastava $distance[$i][$j] = $distance[$i - 1][$j - 1]; 677831242abSAditya Srivastava } else { 678831242abSAditya Srivastava my $dist1 = $distance[$i][$j - 1]; #insert distance 679831242abSAditya Srivastava my $dist2 = $distance[$i - 1][$j]; # remove 680831242abSAditya Srivastava my $dist3 = $distance[$i - 1][$j - 1]; #replace 681831242abSAditya Srivastava $distance[$i][$j] = 1 + edit_distance_min($dist1, $dist2, $dist3); 682831242abSAditya Srivastava } 683831242abSAditya Srivastava } 684831242abSAditya Srivastava } 685831242abSAditya Srivastava return $distance[$len1][$len2]; 686831242abSAditya Srivastava} 687831242abSAditya Srivastava 688831242abSAditya Srivastavasub find_standard_signature { 689831242abSAditya Srivastava my ($sign_off) = @_; 690831242abSAditya Srivastava my @standard_signature_tags = ( 691831242abSAditya Srivastava 'Signed-off-by:', 'Co-developed-by:', 'Acked-by:', 'Tested-by:', 692831242abSAditya Srivastava 'Reviewed-by:', 'Reported-by:', 'Suggested-by:' 693831242abSAditya Srivastava ); 694831242abSAditya Srivastava foreach my $signature (@standard_signature_tags) { 695831242abSAditya Srivastava return $signature if (get_edit_distance($sign_off, $signature) <= 2); 696831242abSAditya Srivastava } 697831242abSAditya Srivastava 698831242abSAditya Srivastava return ""; 699831242abSAditya Srivastava} 700831242abSAditya Srivastava 7011813087dSJoe Perchesour @typeListMisordered = ( 7021813087dSJoe Perches qr{char\s+(?:un)?signed}, 7031813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 7041813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 7051813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 7061813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 7071813087dSJoe Perches qr{short\s+(?:un)?signed}, 7081813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 7091813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 7101813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 7111813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 7121813087dSJoe Perches qr{int\s+(?:un)?signed}, 7131813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 7141813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 7151813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 7161813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 7171813087dSJoe Perches qr{long\s+(?:un)?signed}, 7181813087dSJoe Perches); 7191813087dSJoe Perches 7208905a67cSAndy Whitcroftour @typeList = ( 7218905a67cSAndy Whitcroft qr{void}, 7220c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 7230c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 7240c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 7250c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 7260c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 7270c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 7280c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 7290c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 7300c773d9dSJoe Perches qr{(?:un)?signed}, 7318905a67cSAndy Whitcroft qr{float}, 7328905a67cSAndy Whitcroft qr{double}, 7338905a67cSAndy Whitcroft qr{bool}, 7348905a67cSAndy Whitcroft qr{struct\s+$Ident}, 7358905a67cSAndy Whitcroft qr{union\s+$Ident}, 7368905a67cSAndy Whitcroft qr{enum\s+$Ident}, 7378905a67cSAndy Whitcroft qr{${Ident}_t}, 7388905a67cSAndy Whitcroft qr{${Ident}_handler}, 7398905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 7401813087dSJoe Perches @typeListMisordered, 7418905a67cSAndy Whitcroft); 742938224b5SJoe Perches 743938224b5SJoe Perchesour $C90_int_types = qr{(?x: 744938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 745938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 746938224b5SJoe Perches long\s+long\s+(?:un)?signed| 747938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 748938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 749938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 750938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 751938224b5SJoe Perches 752938224b5SJoe Perches long\s+int\s+(?:un)?signed| 753938224b5SJoe Perches long\s+(?:un)?signed\s+int| 754938224b5SJoe Perches long\s+(?:un)?signed| 755938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 756938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 757938224b5SJoe Perches int\s+long\s+(?:un)?signed| 758938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 759938224b5SJoe Perches 760938224b5SJoe Perches int\s+(?:un)?signed| 761938224b5SJoe Perches (?:(?:un)?signed\s+)?int 762938224b5SJoe Perches)}; 763938224b5SJoe Perches 764485ff23eSAlex Dowadour @typeListFile = (); 7658716de38SJoe Perchesour @typeListWithAttr = ( 7668716de38SJoe Perches @typeList, 7678716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 7688716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 7698716de38SJoe Perches); 7708716de38SJoe Perches 771c45dcabdSAndy Whitcroftour @modifierList = ( 772c45dcabdSAndy Whitcroft qr{fastcall}, 773c45dcabdSAndy Whitcroft); 774485ff23eSAlex Dowadour @modifierListFile = (); 7758905a67cSAndy Whitcroft 7762435880fSJoe Perchesour @mode_permission_funcs = ( 7772435880fSJoe Perches ["module_param", 3], 7782435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 7792435880fSJoe Perches ["module_param_array_named", 5], 7802435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 7812435880fSJoe Perches ["proc_create(?:_data|)", 2], 782459cf0aeSJoe Perches ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2], 783459cf0aeSJoe Perches ["IIO_DEV_ATTR_[A-Z_]+", 1], 784459cf0aeSJoe Perches ["SENSOR_(?:DEVICE_|)ATTR_2", 2], 785459cf0aeSJoe Perches ["SENSOR_TEMPLATE(?:_2|)", 3], 786459cf0aeSJoe Perches ["__ATTR", 2], 7872435880fSJoe Perches); 7882435880fSJoe Perches 7891a3dcf2eSJoe Perchesmy $word_pattern = '\b[A-Z]?[a-z]{2,}\b'; 7901a3dcf2eSJoe Perches 791515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 792515a235eSJoe Perchesour $mode_perms_search = ""; 793515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 794515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 795515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 796515a235eSJoe Perches} 79700180468SJoe Perches$mode_perms_search = "(?:${mode_perms_search})"; 798515a235eSJoe Perches 7999189c7e7SJoe Perchesour %deprecated_apis = ( 8009189c7e7SJoe Perches "synchronize_rcu_bh" => "synchronize_rcu", 8019189c7e7SJoe Perches "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited", 8029189c7e7SJoe Perches "call_rcu_bh" => "call_rcu", 8039189c7e7SJoe Perches "rcu_barrier_bh" => "rcu_barrier", 8049189c7e7SJoe Perches "synchronize_sched" => "synchronize_rcu", 8059189c7e7SJoe Perches "synchronize_sched_expedited" => "synchronize_rcu_expedited", 8069189c7e7SJoe Perches "call_rcu_sched" => "call_rcu", 8079189c7e7SJoe Perches "rcu_barrier_sched" => "rcu_barrier", 8089189c7e7SJoe Perches "get_state_synchronize_sched" => "get_state_synchronize_rcu", 8099189c7e7SJoe Perches "cond_synchronize_sched" => "cond_synchronize_rcu", 810*defdaff1SIra Weiny "kmap" => "kmap_local_page", 811*defdaff1SIra Weiny "kmap_atomic" => "kmap_local_page", 8129189c7e7SJoe Perches); 8139189c7e7SJoe Perches 8149189c7e7SJoe Perches#Create a search pattern for all these strings to speed up a loop below 8159189c7e7SJoe Perchesour $deprecated_apis_search = ""; 8169189c7e7SJoe Perchesforeach my $entry (keys %deprecated_apis) { 8179189c7e7SJoe Perches $deprecated_apis_search .= '|' if ($deprecated_apis_search ne ""); 8189189c7e7SJoe Perches $deprecated_apis_search .= $entry; 8199189c7e7SJoe Perches} 8209189c7e7SJoe Perches$deprecated_apis_search = "(?:${deprecated_apis_search})"; 8219189c7e7SJoe Perches 822b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 823b392c64fSJoe Perches S_IWUGO | 824b392c64fSJoe Perches S_IWOTH | 825b392c64fSJoe Perches S_IRWXUGO | 826b392c64fSJoe Perches S_IALLUGO | 827b392c64fSJoe Perches 0[0-7][0-7][2367] 828b392c64fSJoe Perches}x; 829b392c64fSJoe Perches 830f90774e1SJoe Perchesour %mode_permission_string_types = ( 831f90774e1SJoe Perches "S_IRWXU" => 0700, 832f90774e1SJoe Perches "S_IRUSR" => 0400, 833f90774e1SJoe Perches "S_IWUSR" => 0200, 834f90774e1SJoe Perches "S_IXUSR" => 0100, 835f90774e1SJoe Perches "S_IRWXG" => 0070, 836f90774e1SJoe Perches "S_IRGRP" => 0040, 837f90774e1SJoe Perches "S_IWGRP" => 0020, 838f90774e1SJoe Perches "S_IXGRP" => 0010, 839f90774e1SJoe Perches "S_IRWXO" => 0007, 840f90774e1SJoe Perches "S_IROTH" => 0004, 841f90774e1SJoe Perches "S_IWOTH" => 0002, 842f90774e1SJoe Perches "S_IXOTH" => 0001, 843f90774e1SJoe Perches "S_IRWXUGO" => 0777, 844f90774e1SJoe Perches "S_IRUGO" => 0444, 845f90774e1SJoe Perches "S_IWUGO" => 0222, 846f90774e1SJoe Perches "S_IXUGO" => 0111, 847f90774e1SJoe Perches); 848f90774e1SJoe Perches 849f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below 850f90774e1SJoe Perchesour $mode_perms_string_search = ""; 851f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) { 852f90774e1SJoe Perches $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); 853f90774e1SJoe Perches $mode_perms_string_search .= $entry; 854f90774e1SJoe Perches} 85500180468SJoe Perchesour $single_mode_perms_string_search = "(?:${mode_perms_string_search})"; 85600180468SJoe Perchesour $multi_mode_perms_string_search = qr{ 85700180468SJoe Perches ${single_mode_perms_string_search} 85800180468SJoe Perches (?:\s*\|\s*${single_mode_perms_string_search})* 85900180468SJoe Perches}x; 86000180468SJoe Perches 86100180468SJoe Perchessub perms_to_octal { 86200180468SJoe Perches my ($string) = @_; 86300180468SJoe Perches 86400180468SJoe Perches return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/); 86500180468SJoe Perches 86600180468SJoe Perches my $val = ""; 86700180468SJoe Perches my $oval = ""; 86800180468SJoe Perches my $to = 0; 86900180468SJoe Perches my $curpos = 0; 87000180468SJoe Perches my $lastpos = 0; 87100180468SJoe Perches while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) { 87200180468SJoe Perches $curpos = pos($string); 87300180468SJoe Perches my $match = $2; 87400180468SJoe Perches my $omatch = $1; 87500180468SJoe Perches last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos)); 87600180468SJoe Perches $lastpos = $curpos; 87700180468SJoe Perches $to |= $mode_permission_string_types{$match}; 87800180468SJoe Perches $val .= '\s*\|\s*' if ($val ne ""); 87900180468SJoe Perches $val .= $match; 88000180468SJoe Perches $oval .= $omatch; 88100180468SJoe Perches } 88200180468SJoe Perches $oval =~ s/^\s*\|\s*//; 88300180468SJoe Perches $oval =~ s/\s*\|\s*$//; 88400180468SJoe Perches return sprintf("%04o", $to); 88500180468SJoe Perches} 886f90774e1SJoe Perches 8877840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 8887840a94cSWolfram Sang irq| 889cdcee686SSergey Ryazanov memory| 890cdcee686SSergey Ryazanov time| 891cdcee686SSergey Ryazanov reboot 8927840a94cSWolfram Sang)}; 8937840a94cSWolfram Sang# memory.h: ARM has a custom one 8947840a94cSWolfram Sang 89566b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 89666b47b4aSKees Cookmy $misspellings; 89766b47b4aSKees Cookmy %spelling_fix; 89836061e38SJoe Perches 89936061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 90066b47b4aSKees Cook while (<$spelling>) { 90166b47b4aSKees Cook my $line = $_; 90266b47b4aSKees Cook 90366b47b4aSKees Cook $line =~ s/\s*\n?$//g; 90466b47b4aSKees Cook $line =~ s/^\s*//g; 90566b47b4aSKees Cook 90666b47b4aSKees Cook next if ($line =~ m/^\s*#/); 90766b47b4aSKees Cook next if ($line =~ m/^\s*$/); 90866b47b4aSKees Cook 90966b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 91066b47b4aSKees Cook 91166b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 91266b47b4aSKees Cook } 91366b47b4aSKees Cook close($spelling); 91436061e38SJoe Perches} else { 91536061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 91636061e38SJoe Perches} 91766b47b4aSKees Cook 918ebfd7d62SJoe Perchesif ($codespell) { 919ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 920ebfd7d62SJoe Perches while (<$spelling>) { 921ebfd7d62SJoe Perches my $line = $_; 922ebfd7d62SJoe Perches 923ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 924ebfd7d62SJoe Perches $line =~ s/^\s*//g; 925ebfd7d62SJoe Perches 926ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 927ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 928ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 929ebfd7d62SJoe Perches 930ebfd7d62SJoe Perches $line =~ s/,.*$//; 931ebfd7d62SJoe Perches 932ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 933ebfd7d62SJoe Perches 934ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 935ebfd7d62SJoe Perches } 936ebfd7d62SJoe Perches close($spelling); 937ebfd7d62SJoe Perches } else { 938ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 939ebfd7d62SJoe Perches } 940ebfd7d62SJoe Perches} 941ebfd7d62SJoe Perches 942ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 943ebfd7d62SJoe Perches 94475ad8c57SJerome Forissiersub read_words { 94575ad8c57SJerome Forissier my ($wordsRef, $file) = @_; 94675ad8c57SJerome Forissier 94775ad8c57SJerome Forissier if (open(my $words, '<', $file)) { 94875ad8c57SJerome Forissier while (<$words>) { 949bf1fa1daSJoe Perches my $line = $_; 950bf1fa1daSJoe Perches 951bf1fa1daSJoe Perches $line =~ s/\s*\n?$//g; 952bf1fa1daSJoe Perches $line =~ s/^\s*//g; 953bf1fa1daSJoe Perches 954bf1fa1daSJoe Perches next if ($line =~ m/^\s*#/); 955bf1fa1daSJoe Perches next if ($line =~ m/^\s*$/); 956bf1fa1daSJoe Perches if ($line =~ /\s/) { 95775ad8c57SJerome Forissier print("$file: '$line' invalid - ignored\n"); 958bf1fa1daSJoe Perches next; 959bf1fa1daSJoe Perches } 960bf1fa1daSJoe Perches 961ced69da1SQuentin Monnet $$wordsRef .= '|' if (defined $$wordsRef); 96275ad8c57SJerome Forissier $$wordsRef .= $line; 963bf1fa1daSJoe Perches } 96475ad8c57SJerome Forissier close($file); 96575ad8c57SJerome Forissier return 1; 966bf1fa1daSJoe Perches } 967bf1fa1daSJoe Perches 96875ad8c57SJerome Forissier return 0; 96975ad8c57SJerome Forissier} 97075ad8c57SJerome Forissier 971ced69da1SQuentin Monnetmy $const_structs; 972ced69da1SQuentin Monnetif (show_type("CONST_STRUCT")) { 97375ad8c57SJerome Forissier read_words(\$const_structs, $conststructsfile) 97475ad8c57SJerome Forissier or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 975ced69da1SQuentin Monnet} 97675ad8c57SJerome Forissier 977ced69da1SQuentin Monnetif (defined($typedefsfile)) { 978ced69da1SQuentin Monnet my $typeOtherTypedefs; 97975ad8c57SJerome Forissier read_words(\$typeOtherTypedefs, $typedefsfile) 98075ad8c57SJerome Forissier or warn "No additional types will be considered - file '$typedefsfile': $!\n"; 981ced69da1SQuentin Monnet $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs); 98275ad8c57SJerome Forissier} 98375ad8c57SJerome Forissier 9848905a67cSAndy Whitcroftsub build_types { 985485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 986485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 9871813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 9888716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 989c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 990ab7e23f3SJoe Perches $BasicType = qr{ 991ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 992ab7e23f3SJoe Perches (?:${all}\b) 993ab7e23f3SJoe Perches }x; 9948905a67cSAndy Whitcroft $NonptrType = qr{ 995d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 996cf655043SAndy Whitcroft (?: 9976b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 9988ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 999c45dcabdSAndy Whitcroft (?:${all}\b) 1000cf655043SAndy Whitcroft ) 1001c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 10028905a67cSAndy Whitcroft }x; 10031813087dSJoe Perches $NonptrTypeMisordered = qr{ 10041813087dSJoe Perches (?:$Modifier\s+|const\s+)* 10051813087dSJoe Perches (?: 10061813087dSJoe Perches (?:${Misordered}\b) 10071813087dSJoe Perches ) 10081813087dSJoe Perches (?:\s+$Modifier|\s+const)* 10091813087dSJoe Perches }x; 10108716de38SJoe Perches $NonptrTypeWithAttr = qr{ 10118716de38SJoe Perches (?:$Modifier\s+|const\s+)* 10128716de38SJoe Perches (?: 10138716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 10148716de38SJoe Perches (?:$typeTypedefs\b)| 10158716de38SJoe Perches (?:${allWithAttr}\b) 10168716de38SJoe Perches ) 10178716de38SJoe Perches (?:\s+$Modifier|\s+const)* 10188716de38SJoe Perches }x; 10198905a67cSAndy Whitcroft $Type = qr{ 1020c45dcabdSAndy Whitcroft $NonptrType 10217b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 1022c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 10238905a67cSAndy Whitcroft }x; 10241813087dSJoe Perches $TypeMisordered = qr{ 10251813087dSJoe Perches $NonptrTypeMisordered 10267b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 10271813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 10281813087dSJoe Perches }x; 102991cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 10301813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 10318905a67cSAndy Whitcroft} 10328905a67cSAndy Whitcroftbuild_types(); 10336c72ffaaSAndy Whitcroft 10347d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 1035d1fe9c09SJoe Perches 1036d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 1037d1fe9c09SJoe Perches# requires at least perl version v5.10.0 1038d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 1039d1fe9c09SJoe Perches 1040d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 10412435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 1042c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 10437d2367afSJoe Perches 1044f8422308SJoe Perchesour $declaration_macros = qr{(?x: 10453e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 1046fe658f94SSteffen Maier (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(| 1047dcea7964SJoe Perches (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(| 1048dcea7964SJoe Perches (?:$Storage\s+)?(?:XA_STATE|XA_STATE_ORDER)\s*\( 1049f8422308SJoe Perches)}; 1050f8422308SJoe Perches 10518d0325ccSAditya Srivastavaour %allow_repeated_words = ( 10528d0325ccSAditya Srivastava add => '', 10538d0325ccSAditya Srivastava added => '', 10548d0325ccSAditya Srivastava bad => '', 10558d0325ccSAditya Srivastava be => '', 10568d0325ccSAditya Srivastava); 10578d0325ccSAditya Srivastava 10587d2367afSJoe Perchessub deparenthesize { 10597d2367afSJoe Perches my ($string) = @_; 10607d2367afSJoe Perches return "" if (!defined($string)); 10615b9553abSJoe Perches 10625b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 10635b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 10645b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 10655b9553abSJoe Perches } 10665b9553abSJoe Perches 10677d2367afSJoe Perches $string =~ s@\s+@ @g; 10685b9553abSJoe Perches 10697d2367afSJoe Perches return $string; 10707d2367afSJoe Perches} 10717d2367afSJoe Perches 10723445686aSJoe Perchessub seed_camelcase_file { 10733445686aSJoe Perches my ($file) = @_; 10743445686aSJoe Perches 10753445686aSJoe Perches return if (!(-f $file)); 10763445686aSJoe Perches 10773445686aSJoe Perches local $/; 10783445686aSJoe Perches 10793445686aSJoe Perches open(my $include_file, '<', "$file") 10803445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 10813445686aSJoe Perches my $text = <$include_file>; 10823445686aSJoe Perches close($include_file); 10833445686aSJoe Perches 10843445686aSJoe Perches my @lines = split('\n', $text); 10853445686aSJoe Perches 10863445686aSJoe Perches foreach my $line (@lines) { 10873445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 10883445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 10893445686aSJoe Perches $camelcase{$1} = 1; 109011ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 109111ea516aSJoe Perches $camelcase{$1} = 1; 109211ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 10933445686aSJoe Perches $camelcase{$1} = 1; 10943445686aSJoe Perches } 10953445686aSJoe Perches } 10963445686aSJoe Perches} 10973445686aSJoe Perches 1098cd28b119SJoe Perchesour %maintained_status = (); 1099cd28b119SJoe Perches 110085b0ee18SJoe Perchessub is_maintained_obsolete { 110185b0ee18SJoe Perches my ($filename) = @_; 110285b0ee18SJoe Perches 1103f2c19c2fSJerome Forissier return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 110485b0ee18SJoe Perches 1105cd28b119SJoe Perches if (!exists($maintained_status{$filename})) { 1106cd28b119SJoe Perches $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 1107cd28b119SJoe Perches } 110885b0ee18SJoe Perches 1109cd28b119SJoe Perches return $maintained_status{$filename} =~ /obsolete/i; 111085b0ee18SJoe Perches} 111185b0ee18SJoe Perches 11123b6e8ac9SJoe Perchessub is_SPDX_License_valid { 11133b6e8ac9SJoe Perches my ($license) = @_; 11143b6e8ac9SJoe Perches 1115f9363b31SGuenter Roeck return 1 if (!$tree || which("python3") eq "" || !(-x "$root/scripts/spdxcheck.py") || !(-e "$gitroot")); 11163b6e8ac9SJoe Perches 111756294112SJoe Perches my $root_path = abs_path($root); 1118f9363b31SGuenter Roeck my $status = `cd "$root_path"; echo "$license" | scripts/spdxcheck.py -`; 11193b6e8ac9SJoe Perches return 0 if ($status ne ""); 11203b6e8ac9SJoe Perches return 1; 11213b6e8ac9SJoe Perches} 11223b6e8ac9SJoe Perches 11233445686aSJoe Perchesmy $camelcase_seeded = 0; 11243445686aSJoe Perchessub seed_camelcase_includes { 11253445686aSJoe Perches return if ($camelcase_seeded); 11263445686aSJoe Perches 11273445686aSJoe Perches my $files; 1128c707a81dSJoe Perches my $camelcase_cache = ""; 1129c707a81dSJoe Perches my @include_files = (); 1130c707a81dSJoe Perches 1131c707a81dSJoe Perches $camelcase_seeded = 1; 1132351b2a1fSJoe Perches 11330f7f635bSJoe Perches if (-e "$gitroot") { 1134dbbf869dSJoe Perches my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`; 1135351b2a1fSJoe Perches chomp $git_last_include_commit; 1136c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 1137c707a81dSJoe Perches } else { 1138c707a81dSJoe Perches my $last_mod_date = 0; 1139c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 1140c707a81dSJoe Perches @include_files = split('\n', $files); 1141c707a81dSJoe Perches foreach my $file (@include_files) { 1142c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 1143c707a81dSJoe Perches localtime((stat $file)[9])); 1144c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 1145c707a81dSJoe Perches } 1146c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 1147c707a81dSJoe Perches } 1148c707a81dSJoe Perches 1149c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 1150c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 1151c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 1152351b2a1fSJoe Perches while (<$camelcase_file>) { 1153351b2a1fSJoe Perches chomp; 1154351b2a1fSJoe Perches $camelcase{$_} = 1; 1155351b2a1fSJoe Perches } 1156351b2a1fSJoe Perches close($camelcase_file); 1157351b2a1fSJoe Perches 1158351b2a1fSJoe Perches return; 1159351b2a1fSJoe Perches } 1160c707a81dSJoe Perches 11610f7f635bSJoe Perches if (-e "$gitroot") { 1162dbbf869dSJoe Perches $files = `${git_command} ls-files "include/*.h"`; 1163c707a81dSJoe Perches @include_files = split('\n', $files); 11643445686aSJoe Perches } 1165c707a81dSJoe Perches 11663445686aSJoe Perches foreach my $file (@include_files) { 11673445686aSJoe Perches seed_camelcase_file($file); 11683445686aSJoe Perches } 1169351b2a1fSJoe Perches 1170c707a81dSJoe Perches if ($camelcase_cache ne "") { 1171351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 1172c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 1173c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 1174351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 1175351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 1176351b2a1fSJoe Perches } 1177351b2a1fSJoe Perches close($camelcase_file); 1178351b2a1fSJoe Perches } 11793445686aSJoe Perches} 11803445686aSJoe Perches 1181f5f61325SJoe Perchessub git_is_single_file { 1182f5f61325SJoe Perches my ($filename) = @_; 1183f5f61325SJoe Perches 1184f5f61325SJoe Perches return 0 if ((which("git") eq "") || !(-e "$gitroot")); 1185f5f61325SJoe Perches 1186f5f61325SJoe Perches my $output = `${git_command} ls-files -- $filename 2>/dev/null`; 1187f5f61325SJoe Perches my $count = $output =~ tr/\n//; 1188f5f61325SJoe Perches return $count eq 1 && $output =~ m{^${filename}$}; 1189f5f61325SJoe Perches} 1190f5f61325SJoe Perches 1191d311cd44SJoe Perchessub git_commit_info { 1192d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 1193d311cd44SJoe Perches 11940f7f635bSJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot")); 1195d311cd44SJoe Perches 1196dbbf869dSJoe Perches my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`; 1197d311cd44SJoe Perches $output =~ s/^\s*//gm; 1198d311cd44SJoe Perches my @lines = split("\n", $output); 1199d311cd44SJoe Perches 12000d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 12010d7835fcSJoe Perches 12025a7f4455SSean Christopherson if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) { 1203d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 1204d311cd44SJoe Perches# all matching commit ids, but it's very slow... 1205d311cd44SJoe Perches# 1206d311cd44SJoe Perches# echo "checking commits $1..." 1207d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 1208d311cd44SJoe Perches# while read line ; do 1209d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 1210d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 1211d311cd44SJoe Perches# done 12124ce9f970SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./ || 12134ce9f970SJoe Perches $lines[0] =~ /^fatal: bad object $commit/) { 1214948b133aSHeinrich Schuchardt $id = undef; 1215d311cd44SJoe Perches } else { 1216d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 1217d311cd44SJoe Perches $desc = substr($lines[0], 41); 1218d311cd44SJoe Perches } 1219d311cd44SJoe Perches 1220d311cd44SJoe Perches return ($id, $desc); 1221d311cd44SJoe Perches} 1222d311cd44SJoe Perches 12236c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 12240a920b5bSAndy Whitcroft 122500df344fSAndy Whitcroftmy @rawlines = (); 1226c2fdda0dSAndy Whitcroftmy @lines = (); 12273705ce5bSJoe Perchesmy @fixed = (); 1228d752fcc8SJoe Perchesmy @fixed_inserted = (); 1229d752fcc8SJoe Perchesmy @fixed_deleted = (); 1230194f66fcSJoe Perchesmy $fixlinenr = -1; 1231194f66fcSJoe Perches 12324a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 12334a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 12340f7f635bSJoe Perchesdie "$P: No git repository found\n" if ($git && !-e "$gitroot"); 12354a593c34SDu, Changbin 12364a593c34SDu, Changbinif ($git) { 12374a593c34SDu, Changbin my @commits = (); 12380dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 12394a593c34SDu, Changbin my $git_range; 124028898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 124128898fd1SJoe Perches $git_range = "-$2 $1"; 12424a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 12434a593c34SDu, Changbin $git_range = "$commit_expr"; 12444a593c34SDu, Changbin } else { 12450dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 12460dea9f1eSJoe Perches } 1247dbbf869dSJoe Perches my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 12480dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 124928898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 125028898fd1SJoe Perches next if (!defined($1) || !defined($2)); 12510dea9f1eSJoe Perches my $sha1 = $1; 12520dea9f1eSJoe Perches my $subject = $2; 12530dea9f1eSJoe Perches unshift(@commits, $sha1); 12540dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 12554a593c34SDu, Changbin } 12564a593c34SDu, Changbin } 12574a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 12584a593c34SDu, Changbin @ARGV = @commits; 12594a593c34SDu, Changbin} 12604a593c34SDu, Changbin 1261c2fdda0dSAndy Whitcroftmy $vname; 126298005e8cSVadim Bendebury$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"}; 12636c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 126421caa13cSAndy Whitcroft my $FILE; 1265f5f61325SJoe Perches my $is_git_file = git_is_single_file($filename); 1266f5f61325SJoe Perches my $oldfile = $file; 1267f5f61325SJoe Perches $file = 1 if ($is_git_file); 12684a593c34SDu, Changbin if ($git) { 12694a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 12704a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 12714a593c34SDu, Changbin } elsif ($file) { 127221caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 12736c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 127421caa13cSAndy Whitcroft } elsif ($filename eq '-') { 127521caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 12766c72ffaaSAndy Whitcroft } else { 127721caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 12786c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 12796c72ffaaSAndy Whitcroft } 1280c2fdda0dSAndy Whitcroft if ($filename eq '-') { 1281c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 12824a593c34SDu, Changbin } elsif ($git) { 12830dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 1284c2fdda0dSAndy Whitcroft } else { 1285c2fdda0dSAndy Whitcroft $vname = $filename; 1286c2fdda0dSAndy Whitcroft } 128721caa13cSAndy Whitcroft while (<$FILE>) { 12880a920b5bSAndy Whitcroft chomp; 128900df344fSAndy Whitcroft push(@rawlines, $_); 1290c7f574d0SGeert Uytterhoeven $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i); 12916c72ffaaSAndy Whitcroft } 129221caa13cSAndy Whitcroft close($FILE); 1293d8469f16SJoe Perches 1294d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 1295d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1296d8469f16SJoe Perches print "$vname\n"; 1297d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1298d8469f16SJoe Perches } 1299d8469f16SJoe Perches 1300c2fdda0dSAndy Whitcroft if (!process($filename)) { 13010a920b5bSAndy Whitcroft $exit = 1; 13020a920b5bSAndy Whitcroft } 130300df344fSAndy Whitcroft @rawlines = (); 130413214adfSAndy Whitcroft @lines = (); 13053705ce5bSJoe Perches @fixed = (); 1306d752fcc8SJoe Perches @fixed_inserted = (); 1307d752fcc8SJoe Perches @fixed_deleted = (); 1308194f66fcSJoe Perches $fixlinenr = -1; 1309485ff23eSAlex Dowad @modifierListFile = (); 1310485ff23eSAlex Dowad @typeListFile = (); 1311485ff23eSAlex Dowad build_types(); 1312f5f61325SJoe Perches $file = $oldfile if ($is_git_file); 13130a920b5bSAndy Whitcroft} 13140a920b5bSAndy Whitcroft 1315d8469f16SJoe Perchesif (!$quiet) { 13163c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 13173c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 13183c816e49SJoe Perches 13195b57980dSJoe Perches if (!$perl_version_ok) { 1320d8469f16SJoe Perches print << "EOM" 1321d8469f16SJoe Perches 1322d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 13235b57980dSJoe Perches An upgrade to at least perl $minimum_perl_version is suggested. 1324d8469f16SJoe PerchesEOM 1325d8469f16SJoe Perches } 1326d8469f16SJoe Perches if ($exit) { 1327d8469f16SJoe Perches print << "EOM" 1328d8469f16SJoe Perches 1329d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 1330d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 1331d8469f16SJoe PerchesEOM 1332d8469f16SJoe Perches } 1333d8469f16SJoe Perches} 1334d8469f16SJoe Perches 13350a920b5bSAndy Whitcroftexit($exit); 13360a920b5bSAndy Whitcroft 13370a920b5bSAndy Whitcroftsub top_of_kernel_tree { 13386c72ffaaSAndy Whitcroft my ($root) = @_; 13396c72ffaaSAndy Whitcroft 13406c72ffaaSAndy Whitcroft my @tree_check = ( 13416c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 13426c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 13436c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 13446c72ffaaSAndy Whitcroft ); 13456c72ffaaSAndy Whitcroft 13466c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 13476c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 13480a920b5bSAndy Whitcroft return 0; 13490a920b5bSAndy Whitcroft } 13506c72ffaaSAndy Whitcroft } 13516c72ffaaSAndy Whitcroft return 1; 13526c72ffaaSAndy Whitcroft} 13530a920b5bSAndy Whitcroft 135420112475SJoe Perchessub parse_email { 135520112475SJoe Perches my ($formatted_email) = @_; 135620112475SJoe Perches 135720112475SJoe Perches my $name = ""; 1358fccaebf0SDwaipayan Ray my $quoted = ""; 1359dfa05c28SJoe Perches my $name_comment = ""; 136020112475SJoe Perches my $address = ""; 136120112475SJoe Perches my $comment = ""; 136220112475SJoe Perches 136320112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 136420112475SJoe Perches $name = $1; 136520112475SJoe Perches $address = $2; 136620112475SJoe Perches $comment = $3 if defined $3; 136720112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 136820112475SJoe Perches $address = $1; 136920112475SJoe Perches $comment = $2 if defined $2; 137020112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 137120112475SJoe Perches $address = $1; 137220112475SJoe Perches $comment = $2 if defined $2; 137385e12066SJoe Perches $formatted_email =~ s/\Q$address\E.*$//; 137420112475SJoe Perches $name = $formatted_email; 13753705ce5bSJoe Perches $name = trim($name); 137620112475SJoe Perches $name =~ s/^\"|\"$//g; 137720112475SJoe Perches # If there's a name left after stripping spaces and 137820112475SJoe Perches # leading quotes, and the address doesn't have both 137920112475SJoe Perches # leading and trailing angle brackets, the address 138020112475SJoe Perches # is invalid. ie: 138120112475SJoe Perches # "joe smith [email protected]" bad 138220112475SJoe Perches # "joe smith <[email protected]" bad 138320112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 138420112475SJoe Perches $name = ""; 138520112475SJoe Perches $address = ""; 138620112475SJoe Perches $comment = ""; 138720112475SJoe Perches } 138820112475SJoe Perches } 138920112475SJoe Perches 1390fccaebf0SDwaipayan Ray # Extract comments from names excluding quoted parts 1391fccaebf0SDwaipayan Ray # "John D. (Doe)" - Do not extract 1392fccaebf0SDwaipayan Ray if ($name =~ s/\"(.+)\"//) { 1393fccaebf0SDwaipayan Ray $quoted = $1; 1394dfa05c28SJoe Perches } 1395fccaebf0SDwaipayan Ray while ($name =~ s/\s*($balanced_parens)\s*/ /) { 1396fccaebf0SDwaipayan Ray $name_comment .= trim($1); 1397fccaebf0SDwaipayan Ray } 1398fccaebf0SDwaipayan Ray $name =~ s/^[ \"]+|[ \"]+$//g; 1399fccaebf0SDwaipayan Ray $name = trim("$quoted $name"); 1400fccaebf0SDwaipayan Ray 14013705ce5bSJoe Perches $address = trim($address); 140220112475SJoe Perches $address =~ s/^\<|\>$//g; 1403fccaebf0SDwaipayan Ray $comment = trim($comment); 140420112475SJoe Perches 140520112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 140620112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 140720112475SJoe Perches $name = "\"$name\""; 140820112475SJoe Perches } 140920112475SJoe Perches 1410dfa05c28SJoe Perches return ($name, $name_comment, $address, $comment); 141120112475SJoe Perches} 141220112475SJoe Perches 141320112475SJoe Perchessub format_email { 141448ca2d8aSDwaipayan Ray my ($name, $name_comment, $address, $comment) = @_; 141520112475SJoe Perches 141620112475SJoe Perches my $formatted_email; 141720112475SJoe Perches 1418fccaebf0SDwaipayan Ray $name =~ s/^[ \"]+|[ \"]+$//g; 14193705ce5bSJoe Perches $address = trim($address); 1420fccaebf0SDwaipayan Ray $address =~ s/(?:\.|\,|\")+$//; ##trailing commas, dots or quotes 142120112475SJoe Perches 142220112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 142320112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 142420112475SJoe Perches $name = "\"$name\""; 142520112475SJoe Perches } 142620112475SJoe Perches 1427fccaebf0SDwaipayan Ray $name_comment = trim($name_comment); 1428fccaebf0SDwaipayan Ray $name_comment = " $name_comment" if ($name_comment ne ""); 1429fccaebf0SDwaipayan Ray $comment = trim($comment); 1430fccaebf0SDwaipayan Ray $comment = " $comment" if ($comment ne ""); 1431fccaebf0SDwaipayan Ray 143220112475SJoe Perches if ("$name" eq "") { 143320112475SJoe Perches $formatted_email = "$address"; 143420112475SJoe Perches } else { 143548ca2d8aSDwaipayan Ray $formatted_email = "$name$name_comment <$address>"; 143620112475SJoe Perches } 143748ca2d8aSDwaipayan Ray $formatted_email .= "$comment"; 143820112475SJoe Perches return $formatted_email; 143920112475SJoe Perches} 144020112475SJoe Perches 1441dfa05c28SJoe Perchessub reformat_email { 1442dfa05c28SJoe Perches my ($email) = @_; 1443dfa05c28SJoe Perches 1444dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 144548ca2d8aSDwaipayan Ray return format_email($email_name, $name_comment, $email_address, $comment); 1446dfa05c28SJoe Perches} 1447dfa05c28SJoe Perches 1448dfa05c28SJoe Perchessub same_email_addresses { 1449fccaebf0SDwaipayan Ray my ($email1, $email2) = @_; 1450dfa05c28SJoe Perches 1451dfa05c28SJoe Perches my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1); 1452dfa05c28SJoe Perches my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2); 1453dfa05c28SJoe Perches 145448ca2d8aSDwaipayan Ray return $email1_name eq $email2_name && 145548ca2d8aSDwaipayan Ray $email1_address eq $email2_address && 145648ca2d8aSDwaipayan Ray $name1_comment eq $name2_comment && 145748ca2d8aSDwaipayan Ray $comment1 eq $comment2; 145848ca2d8aSDwaipayan Ray} 1459dfa05c28SJoe Perches 1460d311cd44SJoe Perchessub which { 1461d311cd44SJoe Perches my ($bin) = @_; 1462d311cd44SJoe Perches 1463d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1464d311cd44SJoe Perches if (-e "$path/$bin") { 1465d311cd44SJoe Perches return "$path/$bin"; 1466d311cd44SJoe Perches } 1467d311cd44SJoe Perches } 1468d311cd44SJoe Perches 1469d311cd44SJoe Perches return ""; 1470d311cd44SJoe Perches} 1471d311cd44SJoe Perches 1472000d1cc1SJoe Perchessub which_conf { 1473000d1cc1SJoe Perches my ($conf) = @_; 1474000d1cc1SJoe Perches 1475000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1476000d1cc1SJoe Perches if (-e "$path/$conf") { 1477000d1cc1SJoe Perches return "$path/$conf"; 1478000d1cc1SJoe Perches } 1479000d1cc1SJoe Perches } 1480000d1cc1SJoe Perches 1481000d1cc1SJoe Perches return ""; 1482000d1cc1SJoe Perches} 1483000d1cc1SJoe Perches 14840a920b5bSAndy Whitcroftsub expand_tabs { 14850a920b5bSAndy Whitcroft my ($str) = @_; 14860a920b5bSAndy Whitcroft 14870a920b5bSAndy Whitcroft my $res = ''; 14880a920b5bSAndy Whitcroft my $n = 0; 14890a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 14900a920b5bSAndy Whitcroft if ($c eq "\t") { 14910a920b5bSAndy Whitcroft $res .= ' '; 14920a920b5bSAndy Whitcroft $n++; 1493713a09deSAntonio Borneo for (; ($n % $tabsize) != 0; $n++) { 14940a920b5bSAndy Whitcroft $res .= ' '; 14950a920b5bSAndy Whitcroft } 14960a920b5bSAndy Whitcroft next; 14970a920b5bSAndy Whitcroft } 14980a920b5bSAndy Whitcroft $res .= $c; 14990a920b5bSAndy Whitcroft $n++; 15000a920b5bSAndy Whitcroft } 15010a920b5bSAndy Whitcroft 15020a920b5bSAndy Whitcroft return $res; 15030a920b5bSAndy Whitcroft} 15046c72ffaaSAndy Whitcroftsub copy_spacing { 1505773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 15066c72ffaaSAndy Whitcroft return $res; 15076c72ffaaSAndy Whitcroft} 15080a920b5bSAndy Whitcroft 15094a0df2efSAndy Whitcroftsub line_stats { 15104a0df2efSAndy Whitcroft my ($line) = @_; 15114a0df2efSAndy Whitcroft 15124a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 15134a0df2efSAndy Whitcroft $line =~ s/^.//; 15144a0df2efSAndy Whitcroft $line = expand_tabs($line); 15154a0df2efSAndy Whitcroft 15164a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 15174a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 15184a0df2efSAndy Whitcroft 15194a0df2efSAndy Whitcroft return (length($line), length($white)); 15204a0df2efSAndy Whitcroft} 15214a0df2efSAndy Whitcroft 1522773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1523773647a0SAndy Whitcroft 1524773647a0SAndy Whitcroftsub sanitise_line_reset { 1525773647a0SAndy Whitcroft my ($in_comment) = @_; 1526773647a0SAndy Whitcroft 1527773647a0SAndy Whitcroft if ($in_comment) { 1528773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1529773647a0SAndy Whitcroft } else { 1530773647a0SAndy Whitcroft $sanitise_quote = ''; 1531773647a0SAndy Whitcroft } 1532773647a0SAndy Whitcroft} 153300df344fSAndy Whitcroftsub sanitise_line { 153400df344fSAndy Whitcroft my ($line) = @_; 153500df344fSAndy Whitcroft 153600df344fSAndy Whitcroft my $res = ''; 153700df344fSAndy Whitcroft my $l = ''; 153800df344fSAndy Whitcroft 1539c2fdda0dSAndy Whitcroft my $qlen = 0; 1540773647a0SAndy Whitcroft my $off = 0; 1541773647a0SAndy Whitcroft my $c; 154200df344fSAndy Whitcroft 1543773647a0SAndy Whitcroft # Always copy over the diff marker. 1544773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1545773647a0SAndy Whitcroft 1546773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1547773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1548773647a0SAndy Whitcroft 15498d2e11b2SClaudio Fontana # Comments we are whacking completely including the begin 1550773647a0SAndy Whitcroft # and end, all to $;. 1551773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1552773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1553773647a0SAndy Whitcroft 1554773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1555773647a0SAndy Whitcroft $off++; 155600df344fSAndy Whitcroft next; 1557773647a0SAndy Whitcroft } 155881bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1559773647a0SAndy Whitcroft $sanitise_quote = ''; 1560773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1561773647a0SAndy Whitcroft $off++; 1562773647a0SAndy Whitcroft next; 1563773647a0SAndy Whitcroft } 1564113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1565113f04a8SDaniel Walker $sanitise_quote = '//'; 1566113f04a8SDaniel Walker 1567113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1568113f04a8SDaniel Walker $off++; 1569113f04a8SDaniel Walker next; 1570113f04a8SDaniel Walker } 1571773647a0SAndy Whitcroft 1572773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1573773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1574773647a0SAndy Whitcroft $c eq "\\") { 1575773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1576773647a0SAndy Whitcroft $off++; 1577773647a0SAndy Whitcroft next; 1578773647a0SAndy Whitcroft } 1579773647a0SAndy Whitcroft # Regular quotes. 1580773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1581773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1582773647a0SAndy Whitcroft $sanitise_quote = $c; 1583773647a0SAndy Whitcroft 1584773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1585773647a0SAndy Whitcroft next; 1586773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1587773647a0SAndy Whitcroft $sanitise_quote = ''; 158800df344fSAndy Whitcroft } 158900df344fSAndy Whitcroft } 1590773647a0SAndy Whitcroft 1591fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1592773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1593773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1594113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1595113f04a8SDaniel Walker substr($res, $off, 1, $;); 1596773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1597773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 159800df344fSAndy Whitcroft } else { 1599773647a0SAndy Whitcroft substr($res, $off, 1, $c); 160000df344fSAndy Whitcroft } 1601c2fdda0dSAndy Whitcroft } 1602c2fdda0dSAndy Whitcroft 1603113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1604113f04a8SDaniel Walker $sanitise_quote = ''; 1605113f04a8SDaniel Walker } 1606113f04a8SDaniel Walker 1607c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1608c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1609c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1610c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1611c2fdda0dSAndy Whitcroft 1612c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1613c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1614c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1615c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1616c2fdda0dSAndy Whitcroft } 1617c2fdda0dSAndy Whitcroft 1618dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1619dadf680dSJoe Perches my $match = $1; 1620dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1621dadf680dSJoe Perches } 1622dadf680dSJoe Perches 162300df344fSAndy Whitcroft return $res; 162400df344fSAndy Whitcroft} 162500df344fSAndy Whitcroft 1626a6962d72SJoe Perchessub get_quoted_string { 1627a6962d72SJoe Perches my ($line, $rawline) = @_; 1628a6962d72SJoe Perches 1629478b1799SJoe Perches return "" if (!defined($line) || !defined($rawline)); 163033acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1631a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1632a6962d72SJoe Perches} 1633a6962d72SJoe Perches 16348905a67cSAndy Whitcroftsub ctx_statement_block { 16358905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 16368905a67cSAndy Whitcroft my $line = $linenr - 1; 16378905a67cSAndy Whitcroft my $blk = ''; 16388905a67cSAndy Whitcroft my $soff = $off; 16398905a67cSAndy Whitcroft my $coff = $off - 1; 1640773647a0SAndy Whitcroft my $coff_set = 0; 16418905a67cSAndy Whitcroft 164213214adfSAndy Whitcroft my $loff = 0; 164313214adfSAndy Whitcroft 16448905a67cSAndy Whitcroft my $type = ''; 16458905a67cSAndy Whitcroft my $level = 0; 1646a2750645SAndy Whitcroft my @stack = (); 1647cf655043SAndy Whitcroft my $p; 16488905a67cSAndy Whitcroft my $c; 16498905a67cSAndy Whitcroft my $len = 0; 165013214adfSAndy Whitcroft 165113214adfSAndy Whitcroft my $remainder; 16528905a67cSAndy Whitcroft while (1) { 1653a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1654a2750645SAndy Whitcroft 1655773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 16568905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 16578905a67cSAndy Whitcroft # context. 16588905a67cSAndy Whitcroft if ($off >= $len) { 16598905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1660dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1661c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 16628905a67cSAndy Whitcroft $remain--; 166313214adfSAndy Whitcroft $loff = $len; 1664c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 16658905a67cSAndy Whitcroft $len = length($blk); 16668905a67cSAndy Whitcroft $line++; 16678905a67cSAndy Whitcroft last; 16688905a67cSAndy Whitcroft } 16698905a67cSAndy Whitcroft # Bail if there is no further context. 16708905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 167113214adfSAndy Whitcroft if ($off >= $len) { 16728905a67cSAndy Whitcroft last; 16738905a67cSAndy Whitcroft } 1674f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1675f74bd194SAndy Whitcroft $level++; 1676f74bd194SAndy Whitcroft $type = '#'; 1677f74bd194SAndy Whitcroft } 16788905a67cSAndy Whitcroft } 1679cf655043SAndy Whitcroft $p = $c; 16808905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 168113214adfSAndy Whitcroft $remainder = substr($blk, $off); 16828905a67cSAndy Whitcroft 1683773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 16844635f4fbSAndy Whitcroft 16854635f4fbSAndy Whitcroft # Handle nested #if/#else. 16864635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 16874635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 16884635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 16894635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 16904635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 16914635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 16924635f4fbSAndy Whitcroft } 16934635f4fbSAndy Whitcroft 16948905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 16958905a67cSAndy Whitcroft # outermost level. 16968905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 16978905a67cSAndy Whitcroft last; 16988905a67cSAndy Whitcroft } 16998905a67cSAndy Whitcroft 170013214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1701773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1702773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1703773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1704773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1705773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1706773647a0SAndy Whitcroft $coff_set = 1; 1707773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1708773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 170913214adfSAndy Whitcroft } 171013214adfSAndy Whitcroft 17118905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 17128905a67cSAndy Whitcroft $level++; 17138905a67cSAndy Whitcroft $type = '('; 17148905a67cSAndy Whitcroft } 17158905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 17168905a67cSAndy Whitcroft $level--; 17178905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 17188905a67cSAndy Whitcroft 17198905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 17208905a67cSAndy Whitcroft $coff = $off; 1721773647a0SAndy Whitcroft $coff_set = 1; 1722773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 17238905a67cSAndy Whitcroft } 17248905a67cSAndy Whitcroft } 17258905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 17268905a67cSAndy Whitcroft $level++; 17278905a67cSAndy Whitcroft $type = '{'; 17288905a67cSAndy Whitcroft } 17298905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 17308905a67cSAndy Whitcroft $level--; 17318905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 17328905a67cSAndy Whitcroft 17338905a67cSAndy Whitcroft if ($level == 0) { 1734b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1735b998e001SPatrick Pannuto $off++; 1736b998e001SPatrick Pannuto } 17378905a67cSAndy Whitcroft last; 17388905a67cSAndy Whitcroft } 17398905a67cSAndy Whitcroft } 1740f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1741f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1742f74bd194SAndy Whitcroft $level--; 1743f74bd194SAndy Whitcroft $type = ''; 1744f74bd194SAndy Whitcroft $off++; 1745f74bd194SAndy Whitcroft last; 1746f74bd194SAndy Whitcroft } 17478905a67cSAndy Whitcroft $off++; 17488905a67cSAndy Whitcroft } 1749a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 175013214adfSAndy Whitcroft if ($off == $len) { 1751a3bb97a7SAndy Whitcroft $loff = $len + 1; 175213214adfSAndy Whitcroft $line++; 175313214adfSAndy Whitcroft $remain--; 175413214adfSAndy Whitcroft } 17558905a67cSAndy Whitcroft 17568905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 17578905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 17588905a67cSAndy Whitcroft 17598905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 17608905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 17618905a67cSAndy Whitcroft 1762773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 176313214adfSAndy Whitcroft 176413214adfSAndy Whitcroft return ($statement, $condition, 176513214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 176613214adfSAndy Whitcroft} 176713214adfSAndy Whitcroft 1768cf655043SAndy Whitcroftsub statement_lines { 1769cf655043SAndy Whitcroft my ($stmt) = @_; 1770cf655043SAndy Whitcroft 1771cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1772cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1773cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1774cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1775cf655043SAndy Whitcroft 1776cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1777cf655043SAndy Whitcroft 1778cf655043SAndy Whitcroft return $#stmt_lines + 2; 1779cf655043SAndy Whitcroft} 1780cf655043SAndy Whitcroft 1781cf655043SAndy Whitcroftsub statement_rawlines { 1782cf655043SAndy Whitcroft my ($stmt) = @_; 1783cf655043SAndy Whitcroft 1784cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1785cf655043SAndy Whitcroft 1786cf655043SAndy Whitcroft return $#stmt_lines + 2; 1787cf655043SAndy Whitcroft} 1788cf655043SAndy Whitcroft 1789cf655043SAndy Whitcroftsub statement_block_size { 1790cf655043SAndy Whitcroft my ($stmt) = @_; 1791cf655043SAndy Whitcroft 1792cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1793cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1794cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1795cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1796cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1797cf655043SAndy Whitcroft 1798cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1799cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1800cf655043SAndy Whitcroft 1801cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1802cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1803cf655043SAndy Whitcroft 1804cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1805cf655043SAndy Whitcroft return $stmt_lines; 1806cf655043SAndy Whitcroft } else { 1807cf655043SAndy Whitcroft return $stmt_statements; 1808cf655043SAndy Whitcroft } 1809cf655043SAndy Whitcroft} 1810cf655043SAndy Whitcroft 181113214adfSAndy Whitcroftsub ctx_statement_full { 181213214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 181313214adfSAndy Whitcroft my ($statement, $condition, $level); 181413214adfSAndy Whitcroft 181513214adfSAndy Whitcroft my (@chunks); 181613214adfSAndy Whitcroft 1817cf655043SAndy Whitcroft # Grab the first conditional/block pair. 181813214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 181913214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1820773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 182113214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1822cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1823cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1824cf655043SAndy Whitcroft } 1825cf655043SAndy Whitcroft 1826cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1827cf655043SAndy Whitcroft # could continue the statement. 1828cf655043SAndy Whitcroft for (;;) { 182913214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 183013214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1831cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1832773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1833cf655043SAndy Whitcroft #print "C: push\n"; 1834cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 183513214adfSAndy Whitcroft } 183613214adfSAndy Whitcroft 183713214adfSAndy Whitcroft return ($level, $linenr, @chunks); 18388905a67cSAndy Whitcroft} 18398905a67cSAndy Whitcroft 18404a0df2efSAndy Whitcroftsub ctx_block_get { 1841f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 18424a0df2efSAndy Whitcroft my $line; 18434a0df2efSAndy Whitcroft my $start = $linenr - 1; 18444a0df2efSAndy Whitcroft my $blk = ''; 18454a0df2efSAndy Whitcroft my @o; 18464a0df2efSAndy Whitcroft my @c; 18474a0df2efSAndy Whitcroft my @res = (); 18484a0df2efSAndy Whitcroft 1849f0a594c1SAndy Whitcroft my $level = 0; 18504635f4fbSAndy Whitcroft my @stack = ($level); 185100df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 185200df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 185300df344fSAndy Whitcroft $remain--; 185400df344fSAndy Whitcroft 185500df344fSAndy Whitcroft $blk .= $rawlines[$line]; 18564635f4fbSAndy Whitcroft 18574635f4fbSAndy Whitcroft # Handle nested #if/#else. 185801464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 18594635f4fbSAndy Whitcroft push(@stack, $level); 186001464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 18614635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 186201464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 18634635f4fbSAndy Whitcroft $level = pop(@stack); 18644635f4fbSAndy Whitcroft } 18654635f4fbSAndy Whitcroft 186601464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1867f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1868f0a594c1SAndy Whitcroft if ($off > 0) { 1869f0a594c1SAndy Whitcroft $off--; 1870f0a594c1SAndy Whitcroft next; 1871f0a594c1SAndy Whitcroft } 18724a0df2efSAndy Whitcroft 1873f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1874f0a594c1SAndy Whitcroft $level--; 1875f0a594c1SAndy Whitcroft last if ($level == 0); 1876f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1877f0a594c1SAndy Whitcroft $level++; 1878f0a594c1SAndy Whitcroft } 1879f0a594c1SAndy Whitcroft } 18804a0df2efSAndy Whitcroft 1881f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 188200df344fSAndy Whitcroft push(@res, $rawlines[$line]); 18834a0df2efSAndy Whitcroft } 18844a0df2efSAndy Whitcroft 1885f0a594c1SAndy Whitcroft last if ($level == 0); 18864a0df2efSAndy Whitcroft } 18874a0df2efSAndy Whitcroft 1888f0a594c1SAndy Whitcroft return ($level, @res); 18894a0df2efSAndy Whitcroft} 18904a0df2efSAndy Whitcroftsub ctx_block_outer { 18914a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 18924a0df2efSAndy Whitcroft 1893f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1894f0a594c1SAndy Whitcroft return @r; 18954a0df2efSAndy Whitcroft} 18964a0df2efSAndy Whitcroftsub ctx_block { 18974a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 18984a0df2efSAndy Whitcroft 1899f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1900f0a594c1SAndy Whitcroft return @r; 1901653d4876SAndy Whitcroft} 1902653d4876SAndy Whitcroftsub ctx_statement { 1903f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1904f0a594c1SAndy Whitcroft 1905f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1906f0a594c1SAndy Whitcroft return @r; 1907f0a594c1SAndy Whitcroft} 1908f0a594c1SAndy Whitcroftsub ctx_block_level { 1909653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1910653d4876SAndy Whitcroft 1911f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 19124a0df2efSAndy Whitcroft} 19139c0ca6f9SAndy Whitcroftsub ctx_statement_level { 19149c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 19159c0ca6f9SAndy Whitcroft 19169c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 19179c0ca6f9SAndy Whitcroft} 19184a0df2efSAndy Whitcroft 19194a0df2efSAndy Whitcroftsub ctx_locate_comment { 19204a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 19214a0df2efSAndy Whitcroft 1922a55ee0ccSJoe Perches # If c99 comment on the current line, or the line before or after 1923a55ee0ccSJoe Perches my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@); 1924a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1925a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@); 1926a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1927a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@); 1928a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1929a55ee0ccSJoe Perches 19304a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1931a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 19324a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 19334a0df2efSAndy Whitcroft 19344a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 19354a0df2efSAndy Whitcroft # comment. 19364a0df2efSAndy Whitcroft my $in_comment = 0; 19374a0df2efSAndy Whitcroft $current_comment = ''; 19384a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 193900df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 194000df344fSAndy Whitcroft #warn " $line\n"; 19414a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 19424a0df2efSAndy Whitcroft $in_comment = 1; 19434a0df2efSAndy Whitcroft } 19444a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 19454a0df2efSAndy Whitcroft $in_comment = 1; 19464a0df2efSAndy Whitcroft } 19474a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 19484a0df2efSAndy Whitcroft $current_comment = ''; 19494a0df2efSAndy Whitcroft } 19504a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 19514a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 19524a0df2efSAndy Whitcroft $in_comment = 0; 19534a0df2efSAndy Whitcroft } 19544a0df2efSAndy Whitcroft } 19554a0df2efSAndy Whitcroft 19564a0df2efSAndy Whitcroft chomp($current_comment); 19574a0df2efSAndy Whitcroft return($current_comment); 19584a0df2efSAndy Whitcroft} 19594a0df2efSAndy Whitcroftsub ctx_has_comment { 19604a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 19614a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 19624a0df2efSAndy Whitcroft 196300df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 19644a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 19654a0df2efSAndy Whitcroft 19664a0df2efSAndy Whitcroft return ($cmt ne ''); 19674a0df2efSAndy Whitcroft} 19684a0df2efSAndy Whitcroft 19694d001e4dSAndy Whitcroftsub raw_line { 19704d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 19714d001e4dSAndy Whitcroft 19724d001e4dSAndy Whitcroft my $offset = $linenr - 1; 19734d001e4dSAndy Whitcroft $cnt++; 19744d001e4dSAndy Whitcroft 19754d001e4dSAndy Whitcroft my $line; 19764d001e4dSAndy Whitcroft while ($cnt) { 19774d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 19784d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 19794d001e4dSAndy Whitcroft $cnt--; 19804d001e4dSAndy Whitcroft } 19814d001e4dSAndy Whitcroft 19824d001e4dSAndy Whitcroft return $line; 19834d001e4dSAndy Whitcroft} 19844d001e4dSAndy Whitcroft 19852a9f9d85STobin C. Hardingsub get_stat_real { 19862a9f9d85STobin C. Harding my ($linenr, $lc) = @_; 19872a9f9d85STobin C. Harding 19882a9f9d85STobin C. Harding my $stat_real = raw_line($linenr, 0); 19892a9f9d85STobin C. Harding for (my $count = $linenr + 1; $count <= $lc; $count++) { 19902a9f9d85STobin C. Harding $stat_real = $stat_real . "\n" . raw_line($count, 0); 19912a9f9d85STobin C. Harding } 19922a9f9d85STobin C. Harding 19932a9f9d85STobin C. Harding return $stat_real; 19942a9f9d85STobin C. Harding} 19952a9f9d85STobin C. Harding 1996e3d95a2aSTobin C. Hardingsub get_stat_here { 1997e3d95a2aSTobin C. Harding my ($linenr, $cnt, $here) = @_; 1998e3d95a2aSTobin C. Harding 1999e3d95a2aSTobin C. Harding my $herectx = $here . "\n"; 2000e3d95a2aSTobin C. Harding for (my $n = 0; $n < $cnt; $n++) { 2001e3d95a2aSTobin C. Harding $herectx .= raw_line($linenr, $n) . "\n"; 2002e3d95a2aSTobin C. Harding } 2003e3d95a2aSTobin C. Harding 2004e3d95a2aSTobin C. Harding return $herectx; 2005e3d95a2aSTobin C. Harding} 2006e3d95a2aSTobin C. Harding 20070a920b5bSAndy Whitcroftsub cat_vet { 20080a920b5bSAndy Whitcroft my ($vet) = @_; 20099c0ca6f9SAndy Whitcroft my ($res, $coded); 20100a920b5bSAndy Whitcroft 20119c0ca6f9SAndy Whitcroft $res = ''; 20126c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 20136c72ffaaSAndy Whitcroft $res .= $1; 20146c72ffaaSAndy Whitcroft if ($2 ne '') { 20159c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 20166c72ffaaSAndy Whitcroft $res .= $coded; 20176c72ffaaSAndy Whitcroft } 20189c0ca6f9SAndy Whitcroft } 20199c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 20200a920b5bSAndy Whitcroft 20219c0ca6f9SAndy Whitcroft return $res; 20220a920b5bSAndy Whitcroft} 20230a920b5bSAndy Whitcroft 2024c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 2025cf655043SAndy Whitcroftmy $av_pending; 2026c2fdda0dSAndy Whitcroftmy @av_paren_type; 20271f65f947SAndy Whitcroftmy $av_pend_colon; 2028c2fdda0dSAndy Whitcroft 2029c2fdda0dSAndy Whitcroftsub annotate_reset { 2030c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 2031cf655043SAndy Whitcroft $av_pending = '_'; 2032cf655043SAndy Whitcroft @av_paren_type = ('E'); 20331f65f947SAndy Whitcroft $av_pend_colon = 'O'; 2034c2fdda0dSAndy Whitcroft} 2035c2fdda0dSAndy Whitcroft 20366c72ffaaSAndy Whitcroftsub annotate_values { 20376c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 20386c72ffaaSAndy Whitcroft 20396c72ffaaSAndy Whitcroft my $res; 20401f65f947SAndy Whitcroft my $var = '_' x length($stream); 20416c72ffaaSAndy Whitcroft my $cur = $stream; 20426c72ffaaSAndy Whitcroft 2043c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 20446c72ffaaSAndy Whitcroft 20456c72ffaaSAndy Whitcroft while (length($cur)) { 2046773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 2047cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 2048171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 20496c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 2050c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 2051c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 2052cf655043SAndy Whitcroft $type = pop(@av_paren_type); 2053c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 20546c72ffaaSAndy Whitcroft } 20556c72ffaaSAndy Whitcroft 2056c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 20579446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 20589446ef56SAndy Whitcroft push(@av_paren_type, $type); 2059addcdceaSAndy Whitcroft $type = 'c'; 20609446ef56SAndy Whitcroft 2061e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 2062c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 20636c72ffaaSAndy Whitcroft $type = 'T'; 20646c72ffaaSAndy Whitcroft 2065389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 2066389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 2067389a2fe5SAndy Whitcroft $type = 'T'; 2068389a2fe5SAndy Whitcroft 2069c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 2070171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 2071c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 2072171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 2073171ae1a4SAndy Whitcroft if ($2 ne '') { 2074cf655043SAndy Whitcroft $av_pending = 'N'; 2075171ae1a4SAndy Whitcroft } 2076171ae1a4SAndy Whitcroft $type = 'E'; 2077171ae1a4SAndy Whitcroft 2078c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 2079171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 2080171ae1a4SAndy Whitcroft $av_preprocessor = 1; 2081171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 20826c72ffaaSAndy Whitcroft 2083c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 2084cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 2085c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 2086cf655043SAndy Whitcroft 2087cf655043SAndy Whitcroft push(@av_paren_type, $type); 2088cf655043SAndy Whitcroft push(@av_paren_type, $type); 2089171ae1a4SAndy Whitcroft $type = 'E'; 2090cf655043SAndy Whitcroft 2091c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 2092cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 2093cf655043SAndy Whitcroft $av_preprocessor = 1; 2094cf655043SAndy Whitcroft 2095cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 2096cf655043SAndy Whitcroft 2097171ae1a4SAndy Whitcroft $type = 'E'; 2098cf655043SAndy Whitcroft 2099c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 2100cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 2101cf655043SAndy Whitcroft 2102cf655043SAndy Whitcroft $av_preprocessor = 1; 2103cf655043SAndy Whitcroft 2104cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 2105cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 2106cf655043SAndy Whitcroft pop(@av_paren_type); 2107cf655043SAndy Whitcroft push(@av_paren_type, $type); 2108171ae1a4SAndy Whitcroft $type = 'E'; 21096c72ffaaSAndy Whitcroft 21106c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 2111c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 21126c72ffaaSAndy Whitcroft 2113171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 2114171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 2115171ae1a4SAndy Whitcroft $av_pending = $type; 2116171ae1a4SAndy Whitcroft $type = 'N'; 2117171ae1a4SAndy Whitcroft 21186c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 2119c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 21206c72ffaaSAndy Whitcroft if (defined $2) { 2121cf655043SAndy Whitcroft $av_pending = 'V'; 21226c72ffaaSAndy Whitcroft } 21236c72ffaaSAndy Whitcroft $type = 'N'; 21246c72ffaaSAndy Whitcroft 212514b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 2126c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 212714b111c1SAndy Whitcroft $av_pending = 'E'; 21286c72ffaaSAndy Whitcroft $type = 'N'; 21296c72ffaaSAndy Whitcroft 21301f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 21311f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 21321f65f947SAndy Whitcroft $av_pend_colon = 'C'; 21331f65f947SAndy Whitcroft $type = 'N'; 21341f65f947SAndy Whitcroft 213514b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 2136c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 21376c72ffaaSAndy Whitcroft $type = 'N'; 21386c72ffaaSAndy Whitcroft 21396c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 2140c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 2141cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 2142cf655043SAndy Whitcroft $av_pending = '_'; 21436c72ffaaSAndy Whitcroft $type = 'N'; 21446c72ffaaSAndy Whitcroft 21456c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 2146cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 2147cf655043SAndy Whitcroft if ($new_type ne '_') { 2148cf655043SAndy Whitcroft $type = $new_type; 2149c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 2150c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 21516c72ffaaSAndy Whitcroft } else { 2152c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 21536c72ffaaSAndy Whitcroft } 21546c72ffaaSAndy Whitcroft 2155c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 2156c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 2157c8cb2ca3SAndy Whitcroft $type = 'V'; 2158cf655043SAndy Whitcroft $av_pending = 'V'; 21596c72ffaaSAndy Whitcroft 21608e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 21618e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 21621f65f947SAndy Whitcroft $av_pend_colon = 'B'; 21638e761b04SAndy Whitcroft } elsif ($type eq 'E') { 21648e761b04SAndy Whitcroft $av_pend_colon = 'L'; 21651f65f947SAndy Whitcroft } 21661f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 21671f65f947SAndy Whitcroft $type = 'V'; 21681f65f947SAndy Whitcroft 21696c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 2170c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 21716c72ffaaSAndy Whitcroft $type = 'V'; 21726c72ffaaSAndy Whitcroft 21736c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 2174c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 21756c72ffaaSAndy Whitcroft $type = 'N'; 21766c72ffaaSAndy Whitcroft 2177cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 2178c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 217913214adfSAndy Whitcroft $type = 'E'; 21801f65f947SAndy Whitcroft $av_pend_colon = 'O'; 218113214adfSAndy Whitcroft 21828e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 21838e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 21848e761b04SAndy Whitcroft $type = 'C'; 21858e761b04SAndy Whitcroft 21861f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 21871f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 21881f65f947SAndy Whitcroft $type = 'N'; 21891f65f947SAndy Whitcroft 21901f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 21911f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 21921f65f947SAndy Whitcroft 21931f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 21941f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 21951f65f947SAndy Whitcroft $type = 'E'; 21961f65f947SAndy Whitcroft } else { 21971f65f947SAndy Whitcroft $type = 'N'; 21981f65f947SAndy Whitcroft } 21991f65f947SAndy Whitcroft $av_pend_colon = 'O'; 22001f65f947SAndy Whitcroft 22018e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 220213214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 22036c72ffaaSAndy Whitcroft $type = 'N'; 22046c72ffaaSAndy Whitcroft 22050d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 220674048ed8SAndy Whitcroft my $variant; 220774048ed8SAndy Whitcroft 220874048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 220974048ed8SAndy Whitcroft if ($type eq 'V') { 221074048ed8SAndy Whitcroft $variant = 'B'; 221174048ed8SAndy Whitcroft } else { 221274048ed8SAndy Whitcroft $variant = 'U'; 221374048ed8SAndy Whitcroft } 221474048ed8SAndy Whitcroft 221574048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 221674048ed8SAndy Whitcroft $type = 'N'; 221774048ed8SAndy Whitcroft 22186c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 2219c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 22206c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 22216c72ffaaSAndy Whitcroft $type = 'N'; 22226c72ffaaSAndy Whitcroft } 22236c72ffaaSAndy Whitcroft 22246c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 2225c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 22266c72ffaaSAndy Whitcroft } 22276c72ffaaSAndy Whitcroft if (defined $1) { 22286c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 22296c72ffaaSAndy Whitcroft $res .= $type x length($1); 22306c72ffaaSAndy Whitcroft } 22316c72ffaaSAndy Whitcroft } 22326c72ffaaSAndy Whitcroft 22331f65f947SAndy Whitcroft return ($res, $var); 22346c72ffaaSAndy Whitcroft} 22356c72ffaaSAndy Whitcroft 22368905a67cSAndy Whitcroftsub possible { 223713214adfSAndy Whitcroft my ($possible, $line) = @_; 22389a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 22390776e594SAndy Whitcroft ^(?: 22400776e594SAndy Whitcroft $Modifier| 22410776e594SAndy Whitcroft $Storage| 22420776e594SAndy Whitcroft $Type| 22439a974fdbSAndy Whitcroft DEFINE_\S+ 22449a974fdbSAndy Whitcroft )$| 22459a974fdbSAndy Whitcroft ^(?: 22460776e594SAndy Whitcroft goto| 22470776e594SAndy Whitcroft return| 22480776e594SAndy Whitcroft case| 22490776e594SAndy Whitcroft else| 22500776e594SAndy Whitcroft asm|__asm__| 225189a88353SAndy Whitcroft do| 225289a88353SAndy Whitcroft \#| 225389a88353SAndy Whitcroft \#\#| 22549a974fdbSAndy Whitcroft )(?:\s|$)| 22550776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 22569a974fdbSAndy Whitcroft )}x; 22579a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 22589a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 2259c45dcabdSAndy Whitcroft # Check for modifiers. 2260c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 2261c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 2262c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 2263c45dcabdSAndy Whitcroft 2264c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 2265c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 2266d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 22679a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 2268d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 2269485ff23eSAlex Dowad push(@modifierListFile, $modifier); 2270d2506586SAndy Whitcroft } 22719a974fdbSAndy Whitcroft } 2272c45dcabdSAndy Whitcroft 2273c45dcabdSAndy Whitcroft } else { 227413214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 2275485ff23eSAlex Dowad push(@typeListFile, $possible); 2276c45dcabdSAndy Whitcroft } 22778905a67cSAndy Whitcroft build_types(); 22780776e594SAndy Whitcroft } else { 22790776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 22808905a67cSAndy Whitcroft } 22818905a67cSAndy Whitcroft} 22828905a67cSAndy Whitcroft 22836c72ffaaSAndy Whitcroftmy $prefix = ''; 22846c72ffaaSAndy Whitcroft 2285000d1cc1SJoe Perchessub show_type { 2286cbec18afSJoe Perches my ($type) = @_; 228791bfe484SJoe Perches 2288522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 2289522b837cSAlexey Dobriyan 2290cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 2291cbec18afSJoe Perches 2292cbec18afSJoe Perches return !defined $ignore_type{$type}; 2293000d1cc1SJoe Perches} 2294000d1cc1SJoe Perches 2295f0a594c1SAndy Whitcroftsub report { 2296cbec18afSJoe Perches my ($level, $type, $msg) = @_; 2297cbec18afSJoe Perches 2298cbec18afSJoe Perches if (!show_type($type) || 2299cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 2300773647a0SAndy Whitcroft return 0; 2301773647a0SAndy Whitcroft } 230257230297SJoe Perches my $output = ''; 2303737c0767SJohn Brooks if ($color) { 230457230297SJoe Perches if ($level eq 'ERROR') { 230557230297SJoe Perches $output .= RED; 230657230297SJoe Perches } elsif ($level eq 'WARNING') { 230757230297SJoe Perches $output .= YELLOW; 2308000d1cc1SJoe Perches } else { 230957230297SJoe Perches $output .= GREEN; 2310000d1cc1SJoe Perches } 231157230297SJoe Perches } 231257230297SJoe Perches $output .= $prefix . $level . ':'; 231357230297SJoe Perches if ($show_types) { 2314737c0767SJohn Brooks $output .= BLUE if ($color); 231557230297SJoe Perches $output .= "$type:"; 231657230297SJoe Perches } 2317737c0767SJohn Brooks $output .= RESET if ($color); 231857230297SJoe Perches $output .= ' ' . $msg . "\n"; 231934d8815fSJoe Perches 232034d8815fSJoe Perches if ($showfile) { 232134d8815fSJoe Perches my @lines = split("\n", $output, -1); 232234d8815fSJoe Perches splice(@lines, 1, 1); 232334d8815fSJoe Perches $output = join("\n", @lines); 232434d8815fSJoe Perches } 232552178ce0SDwaipayan Ray 232652178ce0SDwaipayan Ray if ($terse) { 232752178ce0SDwaipayan Ray $output = (split('\n', $output))[0] . "\n"; 232852178ce0SDwaipayan Ray } 232952178ce0SDwaipayan Ray 233052178ce0SDwaipayan Ray if ($verbose && exists($verbose_messages{$type}) && 233152178ce0SDwaipayan Ray !exists($verbose_emitted{$type})) { 233252178ce0SDwaipayan Ray $output .= $verbose_messages{$type} . "\n\n"; 233352178ce0SDwaipayan Ray $verbose_emitted{$type} = 1; 233452178ce0SDwaipayan Ray } 23358905a67cSAndy Whitcroft 233657230297SJoe Perches push(our @report, $output); 2337773647a0SAndy Whitcroft 2338773647a0SAndy Whitcroft return 1; 2339f0a594c1SAndy Whitcroft} 2340cbec18afSJoe Perches 2341f0a594c1SAndy Whitcroftsub report_dump { 234213214adfSAndy Whitcroft our @report; 2343f0a594c1SAndy Whitcroft} 2344000d1cc1SJoe Perches 2345d752fcc8SJoe Perchessub fixup_current_range { 2346d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 2347d752fcc8SJoe Perches 2348d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 2349d752fcc8SJoe Perches my $o = $1; 2350d752fcc8SJoe Perches my $l = $2; 2351d752fcc8SJoe Perches my $no = $o + $offset; 2352d752fcc8SJoe Perches my $nl = $l + $length; 2353d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 2354d752fcc8SJoe Perches } 2355d752fcc8SJoe Perches} 2356d752fcc8SJoe Perches 2357d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 2358d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 2359d752fcc8SJoe Perches 2360d752fcc8SJoe Perches my $range_last_linenr = 0; 2361d752fcc8SJoe Perches my $delta_offset = 0; 2362d752fcc8SJoe Perches 2363d752fcc8SJoe Perches my $old_linenr = 0; 2364d752fcc8SJoe Perches my $new_linenr = 0; 2365d752fcc8SJoe Perches 2366d752fcc8SJoe Perches my $next_insert = 0; 2367d752fcc8SJoe Perches my $next_delete = 0; 2368d752fcc8SJoe Perches 2369d752fcc8SJoe Perches my @lines = (); 2370d752fcc8SJoe Perches 2371d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 2372d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 2373d752fcc8SJoe Perches 2374d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 2375d752fcc8SJoe Perches my $save_line = 1; 2376d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 2377323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2378d752fcc8SJoe Perches $delta_offset = 0; 2379d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2380d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 2381d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 2382d752fcc8SJoe Perches } 2383d752fcc8SJoe Perches 2384d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2385d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 2386d752fcc8SJoe Perches $save_line = 0; 2387d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2388d752fcc8SJoe Perches } 2389d752fcc8SJoe Perches 2390d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2391d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 2392d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 2393d752fcc8SJoe Perches $new_linenr++; 2394d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2395d752fcc8SJoe Perches } 2396d752fcc8SJoe Perches 2397d752fcc8SJoe Perches if ($save_line) { 2398d752fcc8SJoe Perches push(@lines, $line); 2399d752fcc8SJoe Perches $new_linenr++; 2400d752fcc8SJoe Perches } 2401d752fcc8SJoe Perches 2402d752fcc8SJoe Perches $old_linenr++; 2403d752fcc8SJoe Perches } 2404d752fcc8SJoe Perches 2405d752fcc8SJoe Perches return @lines; 2406d752fcc8SJoe Perches} 2407d752fcc8SJoe Perches 2408f2d7e4d4SJoe Perchessub fix_insert_line { 2409f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2410f2d7e4d4SJoe Perches 2411f2d7e4d4SJoe Perches my $inserted = { 2412f2d7e4d4SJoe Perches LINENR => $linenr, 2413f2d7e4d4SJoe Perches LINE => $line, 2414f2d7e4d4SJoe Perches }; 2415f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2416f2d7e4d4SJoe Perches} 2417f2d7e4d4SJoe Perches 2418f2d7e4d4SJoe Perchessub fix_delete_line { 2419f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2420f2d7e4d4SJoe Perches 2421f2d7e4d4SJoe Perches my $deleted = { 2422f2d7e4d4SJoe Perches LINENR => $linenr, 2423f2d7e4d4SJoe Perches LINE => $line, 2424f2d7e4d4SJoe Perches }; 2425f2d7e4d4SJoe Perches 2426f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2427f2d7e4d4SJoe Perches} 2428f2d7e4d4SJoe Perches 2429de7d4f0eSAndy Whitcroftsub ERROR { 2430cbec18afSJoe Perches my ($type, $msg) = @_; 2431cbec18afSJoe Perches 2432cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2433de7d4f0eSAndy Whitcroft our $clean = 0; 24346c72ffaaSAndy Whitcroft our $cnt_error++; 24353705ce5bSJoe Perches return 1; 2436de7d4f0eSAndy Whitcroft } 24373705ce5bSJoe Perches return 0; 2438773647a0SAndy Whitcroft} 2439de7d4f0eSAndy Whitcroftsub WARN { 2440cbec18afSJoe Perches my ($type, $msg) = @_; 2441cbec18afSJoe Perches 2442cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2443de7d4f0eSAndy Whitcroft our $clean = 0; 24446c72ffaaSAndy Whitcroft our $cnt_warn++; 24453705ce5bSJoe Perches return 1; 2446de7d4f0eSAndy Whitcroft } 24473705ce5bSJoe Perches return 0; 2448773647a0SAndy Whitcroft} 2449de7d4f0eSAndy Whitcroftsub CHK { 2450cbec18afSJoe Perches my ($type, $msg) = @_; 2451cbec18afSJoe Perches 2452cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2453de7d4f0eSAndy Whitcroft our $clean = 0; 24546c72ffaaSAndy Whitcroft our $cnt_chk++; 24553705ce5bSJoe Perches return 1; 24566c72ffaaSAndy Whitcroft } 24573705ce5bSJoe Perches return 0; 2458de7d4f0eSAndy Whitcroft} 2459de7d4f0eSAndy Whitcroft 24606ecd9674SAndy Whitcroftsub check_absolute_file { 24616ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 24626ecd9674SAndy Whitcroft my $file = $absolute; 24636ecd9674SAndy Whitcroft 24646ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 24656ecd9674SAndy Whitcroft 24666ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 24676ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 24686ecd9674SAndy Whitcroft if (-f "$root/$file") { 24696ecd9674SAndy Whitcroft ##print "file<$file>\n"; 24706ecd9674SAndy Whitcroft last; 24716ecd9674SAndy Whitcroft } 24726ecd9674SAndy Whitcroft } 24736ecd9674SAndy Whitcroft if (! -f _) { 24746ecd9674SAndy Whitcroft return 0; 24756ecd9674SAndy Whitcroft } 24766ecd9674SAndy Whitcroft 24776ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 24786ecd9674SAndy Whitcroft my $prefix = $absolute; 24796ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 24806ecd9674SAndy Whitcroft 24816ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 24826ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2483000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2484000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 24856ecd9674SAndy Whitcroft } 24866ecd9674SAndy Whitcroft} 24876ecd9674SAndy Whitcroft 24883705ce5bSJoe Perchessub trim { 24893705ce5bSJoe Perches my ($string) = @_; 24903705ce5bSJoe Perches 2491b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2492b34c648bSJoe Perches 2493b34c648bSJoe Perches return $string; 2494b34c648bSJoe Perches} 2495b34c648bSJoe Perches 2496b34c648bSJoe Perchessub ltrim { 2497b34c648bSJoe Perches my ($string) = @_; 2498b34c648bSJoe Perches 2499b34c648bSJoe Perches $string =~ s/^\s+//; 2500b34c648bSJoe Perches 2501b34c648bSJoe Perches return $string; 2502b34c648bSJoe Perches} 2503b34c648bSJoe Perches 2504b34c648bSJoe Perchessub rtrim { 2505b34c648bSJoe Perches my ($string) = @_; 2506b34c648bSJoe Perches 2507b34c648bSJoe Perches $string =~ s/\s+$//; 25083705ce5bSJoe Perches 25093705ce5bSJoe Perches return $string; 25103705ce5bSJoe Perches} 25113705ce5bSJoe Perches 251252ea8506SJoe Perchessub string_find_replace { 251352ea8506SJoe Perches my ($string, $find, $replace) = @_; 251452ea8506SJoe Perches 251552ea8506SJoe Perches $string =~ s/$find/$replace/g; 251652ea8506SJoe Perches 251752ea8506SJoe Perches return $string; 251852ea8506SJoe Perches} 251952ea8506SJoe Perches 25203705ce5bSJoe Perchessub tabify { 25213705ce5bSJoe Perches my ($leading) = @_; 25223705ce5bSJoe Perches 2523713a09deSAntonio Borneo my $source_indent = $tabsize; 25243705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 25253705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 25263705ce5bSJoe Perches 25273705ce5bSJoe Perches #convert leading spaces to tabs 25283705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 25293705ce5bSJoe Perches #Remove spaces before a tab 25303705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 25313705ce5bSJoe Perches 25323705ce5bSJoe Perches return "$leading"; 25333705ce5bSJoe Perches} 25343705ce5bSJoe Perches 2535d1fe9c09SJoe Perchessub pos_last_openparen { 2536d1fe9c09SJoe Perches my ($line) = @_; 2537d1fe9c09SJoe Perches 2538d1fe9c09SJoe Perches my $pos = 0; 2539d1fe9c09SJoe Perches 2540d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2541d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2542d1fe9c09SJoe Perches 2543d1fe9c09SJoe Perches my $last_openparen = 0; 2544d1fe9c09SJoe Perches 2545d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2546d1fe9c09SJoe Perches return -1; 2547d1fe9c09SJoe Perches } 2548d1fe9c09SJoe Perches 2549d1fe9c09SJoe Perches my $len = length($line); 2550d1fe9c09SJoe Perches 2551d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2552d1fe9c09SJoe Perches my $string = substr($line, $pos); 2553d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2554d1fe9c09SJoe Perches $pos += length($1) - 1; 2555d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2556d1fe9c09SJoe Perches $last_openparen = $pos; 2557d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2558d1fe9c09SJoe Perches last; 2559d1fe9c09SJoe Perches } 2560d1fe9c09SJoe Perches } 2561d1fe9c09SJoe Perches 256291cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2563d1fe9c09SJoe Perches} 2564d1fe9c09SJoe Perches 2565f36d3eb8SJoe Perchessub get_raw_comment { 2566f36d3eb8SJoe Perches my ($line, $rawline) = @_; 2567f36d3eb8SJoe Perches my $comment = ''; 2568f36d3eb8SJoe Perches 2569f36d3eb8SJoe Perches for my $i (0 .. (length($line) - 1)) { 2570f36d3eb8SJoe Perches if (substr($line, $i, 1) eq "$;") { 2571f36d3eb8SJoe Perches $comment .= substr($rawline, $i, 1); 2572f36d3eb8SJoe Perches } 2573f36d3eb8SJoe Perches } 2574f36d3eb8SJoe Perches 2575f36d3eb8SJoe Perches return $comment; 2576f36d3eb8SJoe Perches} 2577f36d3eb8SJoe Perches 25785b8f82e1SSong Liusub exclude_global_initialisers { 25795b8f82e1SSong Liu my ($realfile) = @_; 25805b8f82e1SSong Liu 25815b8f82e1SSong Liu # Do not check for BPF programs (tools/testing/selftests/bpf/progs/*.c, samples/bpf/*_kern.c, *.bpf.c). 25825b8f82e1SSong Liu return $realfile =~ m@^tools/testing/selftests/bpf/progs/.*\.c$@ || 25835b8f82e1SSong Liu $realfile =~ m@^samples/bpf/.*_kern\.c$@ || 25845b8f82e1SSong Liu $realfile =~ m@/bpf/.*\.bpf\.c$@; 25855b8f82e1SSong Liu} 25865b8f82e1SSong Liu 25870a920b5bSAndy Whitcroftsub process { 25880a920b5bSAndy Whitcroft my $filename = shift; 25890a920b5bSAndy Whitcroft 25900a920b5bSAndy Whitcroft my $linenr=0; 25910a920b5bSAndy Whitcroft my $prevline=""; 2592c2fdda0dSAndy Whitcroft my $prevrawline=""; 25930a920b5bSAndy Whitcroft my $stashline=""; 2594c2fdda0dSAndy Whitcroft my $stashrawline=""; 25950a920b5bSAndy Whitcroft 25964a0df2efSAndy Whitcroft my $length; 25970a920b5bSAndy Whitcroft my $indent; 25980a920b5bSAndy Whitcroft my $previndent=0; 25990a920b5bSAndy Whitcroft my $stashindent=0; 26000a920b5bSAndy Whitcroft 2601de7d4f0eSAndy Whitcroft our $clean = 1; 26020a920b5bSAndy Whitcroft my $signoff = 0; 2603cd261496SGeert Uytterhoeven my $author = ''; 2604cd261496SGeert Uytterhoeven my $authorsignoff = 0; 260548ca2d8aSDwaipayan Ray my $author_sob = ''; 26060a920b5bSAndy Whitcroft my $is_patch = 0; 2607133712a2SRob Herring my $is_binding_patch = -1; 260829ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 260915662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 261044d303ebSJoe Perches my $has_patch_separator = 0; #Found a --- line 2611ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2612490b292cSJoe Perches my $commit_log_lines = 0; #Number of commit log lines 2613bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 26142a076f40SJoe Perches my $commit_log_long_line = 0; 2615e518e9a5SJoe Perches my $commit_log_has_diff = 0; 261613f1937eSJoe Perches my $reported_maintainer_file = 0; 2617fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2618fa64205dSPasi Savanainen 26194ce9f970SJoe Perches my $last_git_commit_id_linenr = -1; 26204ce9f970SJoe Perches 2621365dd4eaSJoe Perches my $last_blank_line = 0; 26225e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2623365dd4eaSJoe Perches 262413214adfSAndy Whitcroft our @report = (); 26256c72ffaaSAndy Whitcroft our $cnt_lines = 0; 26266c72ffaaSAndy Whitcroft our $cnt_error = 0; 26276c72ffaaSAndy Whitcroft our $cnt_warn = 0; 26286c72ffaaSAndy Whitcroft our $cnt_chk = 0; 26296c72ffaaSAndy Whitcroft 26300a920b5bSAndy Whitcroft # Trace the real file/line as we go. 26310a920b5bSAndy Whitcroft my $realfile = ''; 26320a920b5bSAndy Whitcroft my $realline = 0; 26330a920b5bSAndy Whitcroft my $realcnt = 0; 26340a920b5bSAndy Whitcroft my $here = ''; 263577cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 26360a920b5bSAndy Whitcroft my $in_comment = 0; 2637c2fdda0dSAndy Whitcroft my $comment_edge = 0; 26380a920b5bSAndy Whitcroft my $first_line = 0; 26391e855726SWolfram Sang my $p1_prefix = ''; 26400a920b5bSAndy Whitcroft 264113214adfSAndy Whitcroft my $prev_values = 'E'; 264213214adfSAndy Whitcroft 264313214adfSAndy Whitcroft # suppression flags 2644773647a0SAndy Whitcroft my %suppress_ifbraces; 2645170d3a22SAndy Whitcroft my %suppress_whiletrailers; 26462b474a1aSAndy Whitcroft my %suppress_export; 26473e469cdcSAndy Whitcroft my $suppress_statement = 0; 2648653d4876SAndy Whitcroft 26497e51f197SJoe Perches my %signatures = (); 2650323c1260SJoe Perches 2651c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2652de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2653c2fdda0dSAndy Whitcroft # 2654de7d4f0eSAndy Whitcroft my @setup_docs = (); 2655de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2656773647a0SAndy Whitcroft 2657d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2658d8b07710SJoe Perches 26599f3a8992SRob Herring my $checklicenseline = 1; 26609f3a8992SRob Herring 2661773647a0SAndy Whitcroft sanitise_line_reset(); 2662c2fdda0dSAndy Whitcroft my $line; 2663c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2664773647a0SAndy Whitcroft $linenr++; 2665773647a0SAndy Whitcroft $line = $rawline; 2666c2fdda0dSAndy Whitcroft 26673705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 26683705ce5bSJoe Perches 2669773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2670de7d4f0eSAndy Whitcroft $setup_docs = 0; 26712581ac7cSTim Froidcoeur if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) { 2672de7d4f0eSAndy Whitcroft $setup_docs = 1; 2673de7d4f0eSAndy Whitcroft } 2674773647a0SAndy Whitcroft #next; 2675de7d4f0eSAndy Whitcroft } 267674fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2677773647a0SAndy Whitcroft $realline=$1-1; 2678773647a0SAndy Whitcroft if (defined $2) { 2679773647a0SAndy Whitcroft $realcnt=$3+1; 2680773647a0SAndy Whitcroft } else { 2681773647a0SAndy Whitcroft $realcnt=1+1; 2682773647a0SAndy Whitcroft } 2683c45dcabdSAndy Whitcroft $in_comment = 0; 2684773647a0SAndy Whitcroft 2685773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2686773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2687773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2688773647a0SAndy Whitcroft # at context start. 2689773647a0SAndy Whitcroft my $edge; 269001fa9147SAndy Whitcroft my $cnt = $realcnt; 269101fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 269201fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 269301fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 269401fa9147SAndy Whitcroft $cnt--; 269501fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2696721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2697fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2698fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2699fae17daeSAndy Whitcroft ($edge) = $1; 2700fae17daeSAndy Whitcroft last; 2701fae17daeSAndy Whitcroft } 2702773647a0SAndy Whitcroft } 2703773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2704773647a0SAndy Whitcroft $in_comment = 1; 2705773647a0SAndy Whitcroft } 2706773647a0SAndy Whitcroft 2707773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2708773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2709773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2710773647a0SAndy Whitcroft if (!defined $edge && 271183242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2712773647a0SAndy Whitcroft { 2713773647a0SAndy Whitcroft $in_comment = 1; 2714773647a0SAndy Whitcroft } 2715773647a0SAndy Whitcroft 2716773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2717773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2718773647a0SAndy Whitcroft 2719171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2720773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2721171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2722773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2723773647a0SAndy Whitcroft } 2724773647a0SAndy Whitcroft push(@lines, $line); 2725773647a0SAndy Whitcroft 2726773647a0SAndy Whitcroft if ($realcnt > 1) { 2727773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2728773647a0SAndy Whitcroft } else { 2729773647a0SAndy Whitcroft $realcnt = 0; 2730773647a0SAndy Whitcroft } 2731773647a0SAndy Whitcroft 2732773647a0SAndy Whitcroft #print "==>$rawline\n"; 2733773647a0SAndy Whitcroft #print "-->$line\n"; 2734de7d4f0eSAndy Whitcroft 2735de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2736de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2737de7d4f0eSAndy Whitcroft } 2738de7d4f0eSAndy Whitcroft } 2739de7d4f0eSAndy Whitcroft 27406c72ffaaSAndy Whitcroft $prefix = ''; 27416c72ffaaSAndy Whitcroft 2742773647a0SAndy Whitcroft $realcnt = 0; 2743773647a0SAndy Whitcroft $linenr = 0; 2744194f66fcSJoe Perches $fixlinenr = -1; 27450a920b5bSAndy Whitcroft foreach my $line (@lines) { 27460a920b5bSAndy Whitcroft $linenr++; 2747194f66fcSJoe Perches $fixlinenr++; 27481b5539b1SJoe Perches my $sline = $line; #copy of $line 27491b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 27500a920b5bSAndy Whitcroft 2751c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 2752f36d3eb8SJoe Perches my $raw_comment = get_raw_comment($line, $rawline); 27536c72ffaaSAndy Whitcroft 275412c253abSJoe Perches# check if it's a mode change, rename or start of a patch 275512c253abSJoe Perches if (!$in_commit_log && 275612c253abSJoe Perches ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 275712c253abSJoe Perches ($line =~ /^rename (?:from|to) \S+\s*$/ || 275812c253abSJoe Perches $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 275912c253abSJoe Perches $is_patch = 1; 276012c253abSJoe Perches } 276112c253abSJoe Perches 27620a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2763e518e9a5SJoe Perches if (!$in_commit_log && 276474fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 276574fd4f34SJoe Perches my $context = $4; 27660a920b5bSAndy Whitcroft $is_patch = 1; 27674a0df2efSAndy Whitcroft $first_line = $linenr + 1; 27680a920b5bSAndy Whitcroft $realline=$1-1; 27690a920b5bSAndy Whitcroft if (defined $2) { 27700a920b5bSAndy Whitcroft $realcnt=$3+1; 27710a920b5bSAndy Whitcroft } else { 27720a920b5bSAndy Whitcroft $realcnt=1+1; 27730a920b5bSAndy Whitcroft } 2774c2fdda0dSAndy Whitcroft annotate_reset(); 277513214adfSAndy Whitcroft $prev_values = 'E'; 277613214adfSAndy Whitcroft 2777773647a0SAndy Whitcroft %suppress_ifbraces = (); 2778170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 27792b474a1aSAndy Whitcroft %suppress_export = (); 27803e469cdcSAndy Whitcroft $suppress_statement = 0; 278174fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 278274fd4f34SJoe Perches $context_function = $1; 278374fd4f34SJoe Perches } else { 278474fd4f34SJoe Perches undef $context_function; 278574fd4f34SJoe Perches } 27860a920b5bSAndy Whitcroft next; 27870a920b5bSAndy Whitcroft 27884a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 27894a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 27904a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2791773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 27920a920b5bSAndy Whitcroft $realline++; 2793d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 27940a920b5bSAndy Whitcroft 27954a0df2efSAndy Whitcroft # Measure the line length and indent. 2796c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 27970a920b5bSAndy Whitcroft 27980a920b5bSAndy Whitcroft # Track the previous line. 27990a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 28000a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2801c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2802c2fdda0dSAndy Whitcroft 2803773647a0SAndy Whitcroft #warn "line<$line>\n"; 28046c72ffaaSAndy Whitcroft 2805d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2806d8aaf121SAndy Whitcroft $realcnt--; 28070a920b5bSAndy Whitcroft } 28080a920b5bSAndy Whitcroft 2809cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2810cc77cdcaSAndy Whitcroft 28116c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 28126c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2813773647a0SAndy Whitcroft 28142ac73b4fSJoe Perches my $found_file = 0; 2815773647a0SAndy Whitcroft # extract the filename as it passes 28163bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 28173bf9a009SRabin Vincent $realfile = $1; 28182b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2819270c49a0SJoe Perches $in_commit_log = 0; 28202ac73b4fSJoe Perches $found_file = 1; 28213bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2822773647a0SAndy Whitcroft $realfile = $1; 28232b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2824270c49a0SJoe Perches $in_commit_log = 0; 28251e855726SWolfram Sang 28261e855726SWolfram Sang $p1_prefix = $1; 2827e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2828e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2829000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2830000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 28311e855726SWolfram Sang } 2832773647a0SAndy Whitcroft 2833c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2834000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2835000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2836773647a0SAndy Whitcroft } 28372ac73b4fSJoe Perches $found_file = 1; 28382ac73b4fSJoe Perches } 28392ac73b4fSJoe Perches 284034d8815fSJoe Perches#make up the handle for any error we report on this line 284134d8815fSJoe Perches if ($showfile) { 284234d8815fSJoe Perches $prefix = "$realfile:$realline: " 284334d8815fSJoe Perches } elsif ($emacs) { 28447d3a9f67SJoe Perches if ($file) { 28457d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 28467d3a9f67SJoe Perches } else { 284734d8815fSJoe Perches $prefix = "$filename:$linenr: "; 284834d8815fSJoe Perches } 28497d3a9f67SJoe Perches } 285034d8815fSJoe Perches 28512ac73b4fSJoe Perches if ($found_file) { 285285b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 285385b0ee18SJoe Perches WARN("OBSOLETE", 285485b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 285585b0ee18SJoe Perches } 28567bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 28572ac73b4fSJoe Perches $check = 1; 28582ac73b4fSJoe Perches } else { 28592ac73b4fSJoe Perches $check = $check_orig; 28602ac73b4fSJoe Perches } 28619f3a8992SRob Herring $checklicenseline = 1; 2862133712a2SRob Herring 2863133712a2SRob Herring if ($realfile !~ /^MAINTAINERS/) { 2864133712a2SRob Herring my $last_binding_patch = $is_binding_patch; 2865133712a2SRob Herring 2866133712a2SRob Herring $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@; 2867133712a2SRob Herring 2868133712a2SRob Herring if (($last_binding_patch != -1) && 2869133712a2SRob Herring ($last_binding_patch ^ $is_binding_patch)) { 2870133712a2SRob Herring WARN("DT_SPLIT_BINDING_PATCH", 2871858e6845SMauro Carvalho Chehab "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n"); 2872133712a2SRob Herring } 2873133712a2SRob Herring } 2874133712a2SRob Herring 2875773647a0SAndy Whitcroft next; 2876773647a0SAndy Whitcroft } 2877773647a0SAndy Whitcroft 2878389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 28790a920b5bSAndy Whitcroft 2880c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2881c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2882c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 28830a920b5bSAndy Whitcroft 28846c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 28856c72ffaaSAndy Whitcroft 2886490b292cSJoe Perches# Verify the existence of a commit log if appropriate 2887490b292cSJoe Perches# 2 is used because a $signature is counted in $commit_log_lines 2888490b292cSJoe Perches if ($in_commit_log) { 2889490b292cSJoe Perches if ($line !~ /^\s*$/) { 2890490b292cSJoe Perches $commit_log_lines++; #could be a $signature 2891490b292cSJoe Perches } 2892490b292cSJoe Perches } elsif ($has_commit_log && $commit_log_lines < 2) { 2893490b292cSJoe Perches WARN("COMMIT_MESSAGE", 2894490b292cSJoe Perches "Missing commit description - Add an appropriate one\n"); 2895490b292cSJoe Perches $commit_log_lines = 2; #warn only once 2896490b292cSJoe Perches } 2897490b292cSJoe Perches 2898e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2899e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 290013e45417SMrinal Pandey (($line =~ m@^\s+diff\b.*a/([\w/]+)@ && 290113e45417SMrinal Pandey $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) || 2902e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2903e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2904e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2905e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2906e518e9a5SJoe Perches $commit_log_has_diff = 1; 2907e518e9a5SJoe Perches } 2908e518e9a5SJoe Perches 29093bf9a009SRabin Vincent# Check for incorrect file permissions 29103bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 29113bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 291204db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 291304db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2914000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2915000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 29163bf9a009SRabin Vincent } 29173bf9a009SRabin Vincent } 29183bf9a009SRabin Vincent 2919cd261496SGeert Uytterhoeven# Check the patch for a From: 2920cd261496SGeert Uytterhoeven if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { 2921cd261496SGeert Uytterhoeven $author = $1; 2922e7f929f3SDwaipayan Ray my $curline = $linenr; 2923e7f929f3SDwaipayan Ray while(defined($rawlines[$curline]) && ($rawlines[$curline++] =~ /^[ \t]\s*(.*)/)) { 2924e7f929f3SDwaipayan Ray $author .= $1; 2925e7f929f3SDwaipayan Ray } 2926cd261496SGeert Uytterhoeven $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); 2927cd261496SGeert Uytterhoeven $author =~ s/"//g; 2928dfa05c28SJoe Perches $author = reformat_email($author); 2929cd261496SGeert Uytterhoeven } 2930cd261496SGeert Uytterhoeven 293120112475SJoe Perches# Check the patch for a signoff: 2932dfa05c28SJoe Perches if ($line =~ /^\s*signed-off-by:\s*(.*)/i) { 29334a0df2efSAndy Whitcroft $signoff++; 293415662b3eSJoe Perches $in_commit_log = 0; 293548ca2d8aSDwaipayan Ray if ($author ne '' && $authorsignoff != 1) { 2936fccaebf0SDwaipayan Ray if (same_email_addresses($1, $author)) { 2937cd261496SGeert Uytterhoeven $authorsignoff = 1; 293848ca2d8aSDwaipayan Ray } else { 293948ca2d8aSDwaipayan Ray my $ctx = $1; 294048ca2d8aSDwaipayan Ray my ($email_name, $email_comment, $email_address, $comment1) = parse_email($ctx); 294148ca2d8aSDwaipayan Ray my ($author_name, $author_comment, $author_address, $comment2) = parse_email($author); 294248ca2d8aSDwaipayan Ray 2943046fc741SMimi Zohar if (lc $email_address eq lc $author_address && $email_name eq $author_name) { 294448ca2d8aSDwaipayan Ray $author_sob = $ctx; 294548ca2d8aSDwaipayan Ray $authorsignoff = 2; 2946046fc741SMimi Zohar } elsif (lc $email_address eq lc $author_address) { 294748ca2d8aSDwaipayan Ray $author_sob = $ctx; 294848ca2d8aSDwaipayan Ray $authorsignoff = 3; 294948ca2d8aSDwaipayan Ray } elsif ($email_name eq $author_name) { 295048ca2d8aSDwaipayan Ray $author_sob = $ctx; 295148ca2d8aSDwaipayan Ray $authorsignoff = 4; 295248ca2d8aSDwaipayan Ray 295348ca2d8aSDwaipayan Ray my $address1 = $email_address; 295448ca2d8aSDwaipayan Ray my $address2 = $author_address; 295548ca2d8aSDwaipayan Ray 295648ca2d8aSDwaipayan Ray if ($address1 =~ /(\S+)\+\S+(\@.*)/) { 295748ca2d8aSDwaipayan Ray $address1 = "$1$2"; 295848ca2d8aSDwaipayan Ray } 295948ca2d8aSDwaipayan Ray if ($address2 =~ /(\S+)\+\S+(\@.*)/) { 296048ca2d8aSDwaipayan Ray $address2 = "$1$2"; 296148ca2d8aSDwaipayan Ray } 296248ca2d8aSDwaipayan Ray if ($address1 eq $address2) { 296348ca2d8aSDwaipayan Ray $authorsignoff = 5; 296448ca2d8aSDwaipayan Ray } 296548ca2d8aSDwaipayan Ray } 2966cd261496SGeert Uytterhoeven } 2967cd261496SGeert Uytterhoeven } 29680a920b5bSAndy Whitcroft } 296920112475SJoe Perches 297044d303ebSJoe Perches# Check for patch separator 297144d303ebSJoe Perches if ($line =~ /^---$/) { 297244d303ebSJoe Perches $has_patch_separator = 1; 297344d303ebSJoe Perches $in_commit_log = 0; 297444d303ebSJoe Perches } 297544d303ebSJoe Perches 2976e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2977e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2978e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2979e0d975b1SJoe Perches $reported_maintainer_file = 1; 2980e0d975b1SJoe Perches } 2981e0d975b1SJoe Perches 298220112475SJoe Perches# Check signature styles 2983270c49a0SJoe Perches if (!$in_header_lines && 2984ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 298520112475SJoe Perches my $space_before = $1; 298620112475SJoe Perches my $sign_off = $2; 298720112475SJoe Perches my $space_after = $3; 298820112475SJoe Perches my $email = $4; 298920112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 299020112475SJoe Perches 2991ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2992831242abSAditya Srivastava my $suggested_signature = find_standard_signature($sign_off); 2993831242abSAditya Srivastava if ($suggested_signature eq "") { 2994ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2995ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2996831242abSAditya Srivastava } else { 2997831242abSAditya Srivastava if (WARN("BAD_SIGN_OFF", 2998831242abSAditya Srivastava "Non-standard signature: '$sign_off' - perhaps '$suggested_signature'?\n" . $herecurr) && 2999831242abSAditya Srivastava $fix) { 3000831242abSAditya Srivastava $fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/; 3001831242abSAditya Srivastava } 3002831242abSAditya Srivastava } 3003ce0338dfSJoe Perches } 300420112475SJoe Perches if (defined $space_before && $space_before ne "") { 30053705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 30063705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 30073705ce5bSJoe Perches $fix) { 3008194f66fcSJoe Perches $fixed[$fixlinenr] = 30093705ce5bSJoe Perches "$ucfirst_sign_off $email"; 30103705ce5bSJoe Perches } 301120112475SJoe Perches } 301220112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 30133705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 30143705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 30153705ce5bSJoe Perches $fix) { 3016194f66fcSJoe Perches $fixed[$fixlinenr] = 30173705ce5bSJoe Perches "$ucfirst_sign_off $email"; 30183705ce5bSJoe Perches } 30193705ce5bSJoe Perches 302020112475SJoe Perches } 302120112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 30223705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 30233705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 30243705ce5bSJoe Perches $fix) { 3025194f66fcSJoe Perches $fixed[$fixlinenr] = 30263705ce5bSJoe Perches "$ucfirst_sign_off $email"; 30273705ce5bSJoe Perches } 302820112475SJoe Perches } 302920112475SJoe Perches 3030dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 303148ca2d8aSDwaipayan Ray my $suggested_email = format_email(($email_name, $name_comment, $email_address, $comment)); 303220112475SJoe Perches if ($suggested_email eq "") { 3033000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 3034000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 303520112475SJoe Perches } else { 303620112475SJoe Perches my $dequoted = $suggested_email; 303720112475SJoe Perches $dequoted =~ s/^"//; 303820112475SJoe Perches $dequoted =~ s/" </ </; 303920112475SJoe Perches # Don't force email to have quotes 304020112475SJoe Perches # Allow just an angle bracketed address 3041fccaebf0SDwaipayan Ray if (!same_email_addresses($email, $suggested_email)) { 3042fccaebf0SDwaipayan Ray if (WARN("BAD_SIGN_OFF", 3043fccaebf0SDwaipayan Ray "email address '$email' might be better as '$suggested_email'\n" . $herecurr) && 3044fccaebf0SDwaipayan Ray $fix) { 3045fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email\E/$suggested_email/; 3046fccaebf0SDwaipayan Ray } 3047fccaebf0SDwaipayan Ray } 3048fccaebf0SDwaipayan Ray 3049fccaebf0SDwaipayan Ray # Address part shouldn't have comments 3050fccaebf0SDwaipayan Ray my $stripped_address = $email_address; 3051fccaebf0SDwaipayan Ray $stripped_address =~ s/\([^\(\)]*\)//g; 3052fccaebf0SDwaipayan Ray if ($email_address ne $stripped_address) { 3053fccaebf0SDwaipayan Ray if (WARN("BAD_SIGN_OFF", 3054fccaebf0SDwaipayan Ray "address part of email should not have comments: '$email_address'\n" . $herecurr) && 3055fccaebf0SDwaipayan Ray $fix) { 3056fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email_address\E/$stripped_address/; 3057fccaebf0SDwaipayan Ray } 3058fccaebf0SDwaipayan Ray } 3059fccaebf0SDwaipayan Ray 3060fccaebf0SDwaipayan Ray # Only one name comment should be allowed 3061fccaebf0SDwaipayan Ray my $comment_count = () = $name_comment =~ /\([^\)]+\)/g; 3062fccaebf0SDwaipayan Ray if ($comment_count > 1) { 3063000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 3064fccaebf0SDwaipayan Ray "Use a single name comment in email: '$email'\n" . $herecurr); 3065fccaebf0SDwaipayan Ray } 3066fccaebf0SDwaipayan Ray 3067fccaebf0SDwaipayan Ray 3068fccaebf0SDwaipayan Ray # [email protected] or [email protected] shouldn't 3069e73d2715SDwaipayan Ray # have an email name. In addition comments should strictly 3070fccaebf0SDwaipayan Ray # begin with a # 3071fccaebf0SDwaipayan Ray if ($email =~ /^.*stable\@(?:vger\.)?kernel\.org/i) { 3072fccaebf0SDwaipayan Ray if (($comment ne "" && $comment !~ /^#.+/) || 3073fccaebf0SDwaipayan Ray ($email_name ne "")) { 3074fccaebf0SDwaipayan Ray my $cur_name = $email_name; 3075fccaebf0SDwaipayan Ray my $new_comment = $comment; 3076fccaebf0SDwaipayan Ray $cur_name =~ s/[a-zA-Z\s\-\"]+//g; 3077fccaebf0SDwaipayan Ray 3078fccaebf0SDwaipayan Ray # Remove brackets enclosing comment text 3079fccaebf0SDwaipayan Ray # and # from start of comments to get comment text 3080fccaebf0SDwaipayan Ray $new_comment =~ s/^\((.*)\)$/$1/; 3081fccaebf0SDwaipayan Ray $new_comment =~ s/^\[(.*)\]$/$1/; 3082fccaebf0SDwaipayan Ray $new_comment =~ s/^[\s\#]+|\s+$//g; 3083fccaebf0SDwaipayan Ray 3084fccaebf0SDwaipayan Ray $new_comment = trim("$new_comment $cur_name") if ($cur_name ne $new_comment); 3085fccaebf0SDwaipayan Ray $new_comment = " # $new_comment" if ($new_comment ne ""); 3086fccaebf0SDwaipayan Ray my $new_email = "$email_address$new_comment"; 3087fccaebf0SDwaipayan Ray 3088fccaebf0SDwaipayan Ray if (WARN("BAD_STABLE_ADDRESS_STYLE", 3089fccaebf0SDwaipayan Ray "Invalid email format for stable: '$email', prefer '$new_email'\n" . $herecurr) && 3090fccaebf0SDwaipayan Ray $fix) { 3091fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/; 3092fccaebf0SDwaipayan Ray } 3093fccaebf0SDwaipayan Ray } 3094fccaebf0SDwaipayan Ray } elsif ($comment ne "" && $comment !~ /^(?:#.+|\(.+\))$/) { 3095fccaebf0SDwaipayan Ray my $new_comment = $comment; 3096fccaebf0SDwaipayan Ray 3097fccaebf0SDwaipayan Ray # Extract comment text from within brackets or 3098fccaebf0SDwaipayan Ray # c89 style /*...*/ comments 3099fccaebf0SDwaipayan Ray $new_comment =~ s/^\[(.*)\]$/$1/; 3100fccaebf0SDwaipayan Ray $new_comment =~ s/^\/\*(.*)\*\/$/$1/; 3101fccaebf0SDwaipayan Ray 3102fccaebf0SDwaipayan Ray $new_comment = trim($new_comment); 3103fccaebf0SDwaipayan Ray $new_comment =~ s/^[^\w]$//; # Single lettered comment with non word character is usually a typo 3104fccaebf0SDwaipayan Ray $new_comment = "($new_comment)" if ($new_comment ne ""); 3105fccaebf0SDwaipayan Ray my $new_email = format_email($email_name, $name_comment, $email_address, $new_comment); 3106fccaebf0SDwaipayan Ray 3107fccaebf0SDwaipayan Ray if (WARN("BAD_SIGN_OFF", 3108fccaebf0SDwaipayan Ray "Unexpected content after email: '$email', should be: '$new_email'\n" . $herecurr) && 3109fccaebf0SDwaipayan Ray $fix) { 3110fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/; 3111fccaebf0SDwaipayan Ray } 311220112475SJoe Perches } 31130a920b5bSAndy Whitcroft } 31147e51f197SJoe Perches 31157e51f197SJoe Perches# Check for duplicate signatures 31167e51f197SJoe Perches my $sig_nospace = $line; 31177e51f197SJoe Perches $sig_nospace =~ s/\s//g; 31187e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 31197e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 31207e51f197SJoe Perches WARN("BAD_SIGN_OFF", 31217e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 31227e51f197SJoe Perches } else { 31237e51f197SJoe Perches $signatures{$sig_nospace} = 1; 31247e51f197SJoe Perches } 31256c5d24eeSSean Christopherson 31266c5d24eeSSean Christopherson# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email 31276c5d24eeSSean Christopherson if ($sign_off =~ /^co-developed-by:$/i) { 31286c5d24eeSSean Christopherson if ($email eq $author) { 31296c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31306c5d24eeSSean Christopherson "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline); 31316c5d24eeSSean Christopherson } 31326c5d24eeSSean Christopherson if (!defined $lines[$linenr]) { 31336c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31346c5d24eeSSean Christopherson "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline); 31356c5d24eeSSean Christopherson } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) { 31366c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31376c5d24eeSSean Christopherson "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 31386c5d24eeSSean Christopherson } elsif ($1 ne $email) { 31396c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31406c5d24eeSSean Christopherson "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 31416c5d24eeSSean Christopherson } 31426c5d24eeSSean Christopherson } 31430a920b5bSAndy Whitcroft } 31440a920b5bSAndy Whitcroft 3145a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 3146a2fe16b9SJoe Perches if ($in_header_lines && 3147a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 3148a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 3149a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 3150a2fe16b9SJoe Perches } 3151a2fe16b9SJoe Perches 315244d303ebSJoe Perches# Check for Gerrit Change-Ids not in any patch context 315344d303ebSJoe Perches if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) { 31547580c5b9SAditya Srivastava if (ERROR("GERRIT_CHANGE_ID", 31557580c5b9SAditya Srivastava "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr) && 31567580c5b9SAditya Srivastava $fix) { 31577580c5b9SAditya Srivastava fix_delete_line($fixlinenr, $rawline); 31587580c5b9SAditya Srivastava } 31597ebd05efSChristopher Covington } 31607ebd05efSChristopher Covington 3161369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 3162369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 3163369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 3164369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 3165369c8dd3SJoe Perches # timestamp 3166634cffccSJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) || 3167634cffccSJoe Perches $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ || 3168634cffccSJoe Perches $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) { 3169634cffccSJoe Perches # stack dump address styles 3170369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 3171369c8dd3SJoe Perches } 3172369c8dd3SJoe Perches 31732a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 31742a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 3175bf4daf12SJoe Perches length($line) > 75 && 3176bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 3177bf4daf12SJoe Perches # file delta changes 317836f8b348SJerome Forissier $line =~ /^\s*(?:[\w\.\-\+]*\/)++[\w\.\-\+]+:/ || 3179bf4daf12SJoe Perches # filename then : 318027b379afSAditya Srivastava $line =~ /^\s*(?:Fixes:|Link:|$signature_tags)/i || 318127b379afSAditya Srivastava # A Fixes: or Link: line or signature tag line 3182bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 31832a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 31842a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 31852a076f40SJoe Perches $commit_log_long_line = 1; 31862a076f40SJoe Perches } 31872a076f40SJoe Perches 3188bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 3189bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 3190bf4daf12SJoe Perches $line =~ /^\s*$/) { 3191bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 3192bf4daf12SJoe Perches } 3193bf4daf12SJoe Perches 3194084a617aSDwaipayan Ray# Check for lines starting with a # 3195084a617aSDwaipayan Ray if ($in_commit_log && $line =~ /^#/) { 3196084a617aSDwaipayan Ray if (WARN("COMMIT_COMMENT_SYMBOL", 3197084a617aSDwaipayan Ray "Commit log lines starting with '#' are dropped by git as comments\n" . $herecurr) && 3198084a617aSDwaipayan Ray $fix) { 3199084a617aSDwaipayan Ray $fixed[$fixlinenr] =~ s/^/ /; 3200084a617aSDwaipayan Ray } 3201084a617aSDwaipayan Ray } 3202084a617aSDwaipayan Ray 32030d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 32044ce9f970SJoe Perches# A correctly formed commit description is: 32054ce9f970SJoe Perches# commit <SHA-1 hash length 12+ chars> ("Complete commit subject") 32064ce9f970SJoe Perches# with the commit subject '("' prefix and '")' suffix 32074ce9f970SJoe Perches# This is a fairly compilicated block as it tests for what appears to be 32084ce9f970SJoe Perches# bare SHA-1 hash with minimum length of 5. It also avoids several types of 32094ce9f970SJoe Perches# possible SHA-1 matches. 32104ce9f970SJoe Perches# A commit match can span multiple lines so this block attempts to find a 32114ce9f970SJoe Perches# complete typical commit on a maximum of 3 lines 32124ce9f970SJoe Perches if ($perl_version_ok && 32134ce9f970SJoe Perches $in_commit_log && !$commit_log_possible_stack_dump && 3214a8972573SJohn Hubbard $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i && 3215e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 32164ce9f970SJoe Perches (($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 32174ce9f970SJoe Perches ($line =~ /\bcommit\s*$/i && defined($rawlines[$linenr]) && $rawlines[$linenr] =~ /^\s*[0-9a-f]{5,}\b/i)) || 3218aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 3219369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 3220bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 3221fe043ea1SJoe Perches my $init_char = "c"; 3222fe043ea1SJoe Perches my $orig_commit = ""; 32230d7835fcSJoe Perches my $short = 1; 32240d7835fcSJoe Perches my $long = 0; 32250d7835fcSJoe Perches my $case = 1; 32260d7835fcSJoe Perches my $space = 1; 32270d7835fcSJoe Perches my $id = '0123456789ab'; 32280d7835fcSJoe Perches my $orig_desc = "commit description"; 32290d7835fcSJoe Perches my $description = ""; 32304ce9f970SJoe Perches my $herectx = $herecurr; 32314ce9f970SJoe Perches my $has_parens = 0; 32324ce9f970SJoe Perches my $has_quotes = 0; 32330d7835fcSJoe Perches 32344ce9f970SJoe Perches my $input = $line; 32354ce9f970SJoe Perches if ($line =~ /(?:\bcommit\s+[0-9a-f]{5,}|\bcommit\s*$)/i) { 32364ce9f970SJoe Perches for (my $n = 0; $n < 2; $n++) { 32374ce9f970SJoe Perches if ($input =~ /\bcommit\s+[0-9a-f]{5,}\s*($balanced_parens)/i) { 32384ce9f970SJoe Perches $orig_desc = $1; 32394ce9f970SJoe Perches $has_parens = 1; 32404ce9f970SJoe Perches # Always strip leading/trailing parens then double quotes if existing 32414ce9f970SJoe Perches $orig_desc = substr($orig_desc, 1, -1); 32424ce9f970SJoe Perches if ($orig_desc =~ /^".*"$/) { 32434ce9f970SJoe Perches $orig_desc = substr($orig_desc, 1, -1); 32444ce9f970SJoe Perches $has_quotes = 1; 32454ce9f970SJoe Perches } 32464ce9f970SJoe Perches last; 32474ce9f970SJoe Perches } 32484ce9f970SJoe Perches last if ($#lines < $linenr + $n); 32494ce9f970SJoe Perches $input .= " " . trim($rawlines[$linenr + $n]); 32504ce9f970SJoe Perches $herectx .= "$rawlines[$linenr + $n]\n"; 32514ce9f970SJoe Perches } 32524ce9f970SJoe Perches $herectx = $herecurr if (!$has_parens); 3253fe043ea1SJoe Perches } 3254fe043ea1SJoe Perches 32554ce9f970SJoe Perches if ($input =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 32564ce9f970SJoe Perches $init_char = $1; 32574ce9f970SJoe Perches $orig_commit = lc($2); 32584ce9f970SJoe Perches $short = 0 if ($input =~ /\bcommit\s+[0-9a-f]{12,40}/i); 32594ce9f970SJoe Perches $long = 1 if ($input =~ /\bcommit\s+[0-9a-f]{41,}/i); 32604ce9f970SJoe Perches $space = 0 if ($input =~ /\bcommit [0-9a-f]/i); 32614ce9f970SJoe Perches $case = 0 if ($input =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 32624ce9f970SJoe Perches } elsif ($input =~ /\b([0-9a-f]{12,40})\b/i) { 32634ce9f970SJoe Perches $orig_commit = lc($1); 32640d7835fcSJoe Perches } 32650d7835fcSJoe Perches 32660d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 32670d7835fcSJoe Perches $id, $orig_desc); 32680d7835fcSJoe Perches 3269948b133aSHeinrich Schuchardt if (defined($id) && 32704ce9f970SJoe Perches ($short || $long || $space || $case || ($orig_desc ne $description) || !$has_quotes) && 32714ce9f970SJoe Perches $last_git_commit_id_linenr != $linenr - 1) { 3272d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 32734ce9f970SJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herectx); 32740d7835fcSJoe Perches } 32754ce9f970SJoe Perches #don't report the next line if this line ends in commit and the sha1 hash is the next line 32764ce9f970SJoe Perches $last_git_commit_id_linenr = $linenr if ($line =~ /\bcommit\s*$/i); 3277d311cd44SJoe Perches } 3278d311cd44SJoe Perches 327913f1937eSJoe Perches# Check for added, moved or deleted files 328013f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 328113f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 328213f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 328313f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 328413f1937eSJoe Perches (defined($1) || defined($2))))) { 3285a82603a8SAndrew Jeffery $is_patch = 1; 328613f1937eSJoe Perches $reported_maintainer_file = 1; 328713f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 328813f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 328913f1937eSJoe Perches } 329013f1937eSJoe Perches 3291e400edb1SRob Herring# Check for adding new DT bindings not in schema format 3292e400edb1SRob Herring if (!$in_commit_log && 3293e400edb1SRob Herring ($line =~ /^new file mode\s*\d+\s*$/) && 3294e400edb1SRob Herring ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) { 3295e400edb1SRob Herring WARN("DT_SCHEMA_BINDING_PATCH", 329656ddc4cdSMauro Carvalho Chehab "DT bindings should be in DT schema format. See: Documentation/devicetree/bindings/writing-schema.rst\n"); 3297e400edb1SRob Herring } 3298e400edb1SRob Herring 329900df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 33008905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 3301000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 3302000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 33036c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 3304de7d4f0eSAndy Whitcroft } 3305de7d4f0eSAndy Whitcroft 3306de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 3307de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 3308171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 3309171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 3310171ae1a4SAndy Whitcroft 3311171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 3312171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 3313171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 3314171ae1a4SAndy Whitcroft 331534d99219SJoe Perches CHK("INVALID_UTF8", 3316000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 331700df344fSAndy Whitcroft } 33180a920b5bSAndy Whitcroft 331915662b3eSJoe Perches# Check if it's the start of a commit log 332015662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 332115662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 3322eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 3323eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 332415662b3eSJoe Perches $in_header_lines = 0; 332515662b3eSJoe Perches $in_commit_log = 1; 3326ed43c4e5SAllen Hubbe $has_commit_log = 1; 332715662b3eSJoe Perches } 332815662b3eSJoe Perches 3329fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 3330fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 3331fa64205dSPasi Savanainen if ($in_header_lines && 3332fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 3333fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 3334fa64205dSPasi Savanainen $non_utf8_charset = 1; 3335fa64205dSPasi Savanainen } 3336fa64205dSPasi Savanainen 3337fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 333815662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 3339fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 334015662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 334115662b3eSJoe Perches } 334215662b3eSJoe Perches 3343d6430f71SJoe Perches# Check for absolute kernel paths in commit message 3344d6430f71SJoe Perches if ($tree && $in_commit_log) { 3345d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 3346d6430f71SJoe Perches my $file = $1; 3347d6430f71SJoe Perches 3348d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 3349d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 3350d6430f71SJoe Perches # 3351d6430f71SJoe Perches } else { 3352d6430f71SJoe Perches check_absolute_file($file, $herecurr); 3353d6430f71SJoe Perches } 3354d6430f71SJoe Perches } 3355d6430f71SJoe Perches } 3356d6430f71SJoe Perches 335766b47b4aSKees Cook# Check for various typo / spelling mistakes 335866d7a382SJoe Perches if (defined($misspellings) && 335966d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 33607da07c31SDwaipayan Ray while ($rawline =~ /(?:^|[^\w\-'`])($misspellings)(?:[^\w\-'`]|$)/gi) { 336166b47b4aSKees Cook my $typo = $1; 33627da07c31SDwaipayan Ray my $blank = copy_spacing($rawline); 33637da07c31SDwaipayan Ray my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo); 33647da07c31SDwaipayan Ray my $hereptr = "$hereline$ptr\n"; 336566b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 336666b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 336766b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 33680675a8fbSJean Delvare my $msg_level = \&WARN; 33690675a8fbSJean Delvare $msg_level = \&CHK if ($file); 33700675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 33717da07c31SDwaipayan Ray "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $hereptr) && 337266b47b4aSKees Cook $fix) { 337366b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 337466b47b4aSKees Cook } 337566b47b4aSKees Cook } 337666b47b4aSKees Cook } 337766b47b4aSKees Cook 3378a8dd86bfSMatteo Croce# check for invalid commit id 3379a8dd86bfSMatteo Croce if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) { 3380a8dd86bfSMatteo Croce my $id; 3381a8dd86bfSMatteo Croce my $description; 3382a8dd86bfSMatteo Croce ($id, $description) = git_commit_info($2, undef, undef); 3383a8dd86bfSMatteo Croce if (!defined($id)) { 3384a8dd86bfSMatteo Croce WARN("UNKNOWN_COMMIT_ID", 3385a8dd86bfSMatteo Croce "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr); 3386a8dd86bfSMatteo Croce } 3387a8dd86bfSMatteo Croce } 3388a8dd86bfSMatteo Croce 3389310cd06bSJoe Perches# check for repeated words separated by a single space 33908d0325ccSAditya Srivastava# avoid false positive from list command eg, '-rw-r--r-- 1 root root' 33918d0325ccSAditya Srivastava if (($rawline =~ /^\+/ || $in_commit_log) && 33928d0325ccSAditya Srivastava $rawline !~ /[bcCdDlMnpPs\?-][rwxsStT-]{9}/) { 33931db81a68SDwaipayan Ray pos($rawline) = 1 if (!$in_commit_log); 3394310cd06bSJoe Perches while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) { 3395310cd06bSJoe Perches 3396310cd06bSJoe Perches my $first = $1; 3397310cd06bSJoe Perches my $second = $2; 33981db81a68SDwaipayan Ray my $start_pos = $-[1]; 33991db81a68SDwaipayan Ray my $end_pos = $+[2]; 3400310cd06bSJoe Perches if ($first =~ /(?:struct|union|enum)/) { 3401310cd06bSJoe Perches pos($rawline) += length($first) + length($second) + 1; 3402310cd06bSJoe Perches next; 3403310cd06bSJoe Perches } 3404310cd06bSJoe Perches 34051db81a68SDwaipayan Ray next if (lc($first) ne lc($second)); 3406310cd06bSJoe Perches next if ($first eq 'long'); 3407310cd06bSJoe Perches 34081db81a68SDwaipayan Ray # check for character before and after the word matches 34091db81a68SDwaipayan Ray my $start_char = ''; 34101db81a68SDwaipayan Ray my $end_char = ''; 34111db81a68SDwaipayan Ray $start_char = substr($rawline, $start_pos - 1, 1) if ($start_pos > ($in_commit_log ? 0 : 1)); 34121db81a68SDwaipayan Ray $end_char = substr($rawline, $end_pos, 1) if ($end_pos < length($rawline)); 34131db81a68SDwaipayan Ray 34141db81a68SDwaipayan Ray next if ($start_char =~ /^\S$/); 34151db81a68SDwaipayan Ray next if (index(" \t.,;?!", $end_char) == -1); 34161db81a68SDwaipayan Ray 34178d0325ccSAditya Srivastava # avoid repeating hex occurrences like 'ff ff fe 09 ...' 34188d0325ccSAditya Srivastava if ($first =~ /\b[0-9a-f]{2,}\b/i) { 34198d0325ccSAditya Srivastava next if (!exists($allow_repeated_words{lc($first)})); 34208d0325ccSAditya Srivastava } 34218d0325ccSAditya Srivastava 3422310cd06bSJoe Perches if (WARN("REPEATED_WORD", 3423310cd06bSJoe Perches "Possible repeated word: '$first'\n" . $herecurr) && 3424310cd06bSJoe Perches $fix) { 3425310cd06bSJoe Perches $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/; 3426310cd06bSJoe Perches } 3427310cd06bSJoe Perches } 3428310cd06bSJoe Perches 3429310cd06bSJoe Perches # if it's a repeated word on consecutive lines in a comment block 3430310cd06bSJoe Perches if ($prevline =~ /$;+\s*$/ && 3431310cd06bSJoe Perches $prevrawline =~ /($word_pattern)\s*$/) { 3432310cd06bSJoe Perches my $last_word = $1; 3433310cd06bSJoe Perches if ($rawline =~ /^\+\s*\*\s*$last_word /) { 3434310cd06bSJoe Perches if (WARN("REPEATED_WORD", 3435310cd06bSJoe Perches "Possible repeated word: '$last_word'\n" . $hereprev) && 3436310cd06bSJoe Perches $fix) { 3437310cd06bSJoe Perches $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/; 3438310cd06bSJoe Perches } 3439310cd06bSJoe Perches } 3440310cd06bSJoe Perches } 3441310cd06bSJoe Perches } 3442310cd06bSJoe Perches 344330670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 344430670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 344500df344fSAndy Whitcroft 34460a920b5bSAndy Whitcroft#trailing whitespace 34479c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 3448c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3449d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 3450d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 3451d5e616fcSJoe Perches $fix) { 3452194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 3453d5e616fcSJoe Perches } 3454c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 3455c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 34563705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 34573705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 34583705ce5bSJoe Perches $fix) { 3459194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 34603705ce5bSJoe Perches } 34613705ce5bSJoe Perches 3462d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 34630a920b5bSAndy Whitcroft } 34645368df20SAndy Whitcroft 34654783f894SJosh Triplett# Check for FSF mailing addresses. 3466109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 34671bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 34683e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 34693e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 34704783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 34710675a8fbSJean Delvare my $msg_level = \&ERROR; 34720675a8fbSJean Delvare $msg_level = \&CHK if ($file); 34730675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 34744783f894SJosh Triplett "Do not include the paragraph about writing to the Free Software Foundation's mailing address from the sample GPL notice. The FSF has changed addresses in the past, and may do so again. Linux already includes a copy of the GPL.\n" . $herevet) 34754783f894SJosh Triplett } 34764783f894SJosh Triplett 34773354957aSAndi Kleen# check for Kconfig help text having a real description 34789fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 34799fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 34803354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 3481678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 3482678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 3483678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 3484678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 3485b8709bceSJoe Perches my $ln = $linenr; 3486b8709bceSJoe Perches my $needs_help = 0; 3487b8709bceSJoe Perches my $has_help = 0; 3488b8709bceSJoe Perches my $help_length = 0; 3489b8709bceSJoe Perches while (defined $lines[$ln]) { 3490b8709bceSJoe Perches my $f = $lines[$ln++]; 34919fe287d7SAndy Whitcroft 34929fe287d7SAndy Whitcroft next if ($f =~ /^-/); 3493b8709bceSJoe Perches last if ($f !~ /^[\+ ]/); # !patch context 3494a1385803SAndy Whitcroft 3495b8709bceSJoe Perches if ($f =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 3496b8709bceSJoe Perches $needs_help = 1; 3497b8709bceSJoe Perches next; 3498b8709bceSJoe Perches } 3499b8709bceSJoe Perches if ($f =~ /^\+\s*help\s*$/) { 3500b8709bceSJoe Perches $has_help = 1; 3501b8709bceSJoe Perches next; 3502a1385803SAndy Whitcroft } 3503a1385803SAndy Whitcroft 3504b8709bceSJoe Perches $f =~ s/^.//; # strip patch context [+ ] 3505b8709bceSJoe Perches $f =~ s/#.*//; # strip # directives 3506b8709bceSJoe Perches $f =~ s/^\s+//; # strip leading blanks 3507b8709bceSJoe Perches next if ($f =~ /^$/); # skip blank lines 3508678ae162SUlf Magnusson 3509b8709bceSJoe Perches # At the end of this Kconfig block: 3510678ae162SUlf Magnusson # This only checks context lines in the patch 3511678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 3512678ae162SUlf Magnusson # positives, even though some of these are 3513678ae162SUlf Magnusson # common words in help texts 3514b8709bceSJoe Perches if ($f =~ /^(?:config|menuconfig|choice|endchoice| 3515678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 35169fe287d7SAndy Whitcroft last; 35179fe287d7SAndy Whitcroft } 3518b8709bceSJoe Perches $help_length++ if ($has_help); 35193354957aSAndi Kleen } 3520b8709bceSJoe Perches if ($needs_help && 3521b8709bceSJoe Perches $help_length < $min_conf_desc_length) { 3522b8709bceSJoe Perches my $stat_real = get_stat_real($linenr, $ln - 1); 3523000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 3524b8709bceSJoe Perches "please write a help paragraph that fully describes the config symbol\n" . "$here\n$stat_real\n"); 352556193274SVadim Bendebury } 35263354957aSAndi Kleen } 35273354957aSAndi Kleen 35287ccf41a8SJoe Perches# check MAINTAINERS entries 35297ccf41a8SJoe Perches if ($realfile =~ /^MAINTAINERS$/) { 35307ccf41a8SJoe Perches# check MAINTAINERS entries for the right form 35317ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 3532628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 3533628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 3534628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 3535628f91a2SJoe Perches $fix) { 3536628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 3537628f91a2SJoe Perches } 3538628f91a2SJoe Perches } 35397ccf41a8SJoe Perches# check MAINTAINERS entries for the right ordering too 35407ccf41a8SJoe Perches my $preferred_order = 'MRLSWQBCPTFXNK'; 35417ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 35427ccf41a8SJoe Perches $prevrawline =~ /^[\+ ][A-Z]:/) { 35437ccf41a8SJoe Perches $rawline =~ /^\+([A-Z]):\s*(.*)/; 35447ccf41a8SJoe Perches my $cur = $1; 35457ccf41a8SJoe Perches my $curval = $2; 35467ccf41a8SJoe Perches $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/; 35477ccf41a8SJoe Perches my $prev = $1; 35487ccf41a8SJoe Perches my $prevval = $2; 35497ccf41a8SJoe Perches my $curindex = index($preferred_order, $cur); 35507ccf41a8SJoe Perches my $previndex = index($preferred_order, $prev); 35517ccf41a8SJoe Perches if ($curindex < 0) { 35527ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 35537ccf41a8SJoe Perches "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr); 35547ccf41a8SJoe Perches } else { 35557ccf41a8SJoe Perches if ($previndex >= 0 && $curindex < $previndex) { 35567ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 35577ccf41a8SJoe Perches "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev); 35587ccf41a8SJoe Perches } elsif ((($prev eq 'F' && $cur eq 'F') || 35597ccf41a8SJoe Perches ($prev eq 'X' && $cur eq 'X')) && 35607ccf41a8SJoe Perches ($prevval cmp $curval) > 0) { 35617ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 35627ccf41a8SJoe Perches "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev); 35637ccf41a8SJoe Perches } 35647ccf41a8SJoe Perches } 35657ccf41a8SJoe Perches } 35667ccf41a8SJoe Perches } 3567628f91a2SJoe Perches 3568c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 3569c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 3570c68e5878SArnaud Lacombe my $flag = $1; 3571c68e5878SArnaud Lacombe my $replacement = { 3572c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 3573c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 3574c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 3575c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 3576c68e5878SArnaud Lacombe }; 3577c68e5878SArnaud Lacombe 3578c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 3579c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 3580c68e5878SArnaud Lacombe } 3581c68e5878SArnaud Lacombe 3582bff5da43SRob Herring# check for DT compatible documentation 35837dd05b38SFlorian Vaussard if (defined $root && 35847dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 35857dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 35867dd05b38SFlorian Vaussard 3587bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 3588bff5da43SRob Herring 3589cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 3590852d095dSRob Herring my $vp_file = $dt_path . "vendor-prefixes.yaml"; 3591cc93319bSFlorian Vaussard 3592bff5da43SRob Herring foreach my $compat (@compats) { 3593bff5da43SRob Herring my $compat2 = $compat; 3594185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 3595185d566bSRob Herring my $compat3 = $compat; 3596185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 3597185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 3598bff5da43SRob Herring if ( $? >> 8 ) { 3599bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3600bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 3601bff5da43SRob Herring } 3602bff5da43SRob Herring 36034fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 36044fbf32a6SFlorian Vaussard my $vendor = $1; 3605852d095dSRob Herring `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`; 3606bff5da43SRob Herring if ( $? >> 8 ) { 3607bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3608cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 3609bff5da43SRob Herring } 3610bff5da43SRob Herring } 3611bff5da43SRob Herring } 3612bff5da43SRob Herring 36139f3a8992SRob Herring# check for using SPDX license tag at beginning of files 36149f3a8992SRob Herring if ($realline == $checklicenseline) { 36159f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 36169f3a8992SRob Herring $checklicenseline = 2; 36179f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 36189f3a8992SRob Herring my $comment = ""; 36199f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 36209f3a8992SRob Herring $comment = '/*'; 36219f3a8992SRob Herring } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 36229f3a8992SRob Herring $comment = '//'; 3623c8df0ab6SLubomir Rintel } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) { 36249f3a8992SRob Herring $comment = '#'; 36259f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 36269f3a8992SRob Herring $comment = '..'; 36279f3a8992SRob Herring } 36289f3a8992SRob Herring 3629fdf13693SJoe Perches# check SPDX comment style for .[chsS] files 3630fdf13693SJoe Perches if ($realfile =~ /\.[chsS]$/ && 3631fdf13693SJoe Perches $rawline =~ /SPDX-License-Identifier:/ && 3632ffbce897SJoe Perches $rawline !~ m@^\+\s*\Q$comment\E\s*@) { 3633fdf13693SJoe Perches WARN("SPDX_LICENSE_TAG", 3634fdf13693SJoe Perches "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr); 3635fdf13693SJoe Perches } 3636fdf13693SJoe Perches 36379f3a8992SRob Herring if ($comment !~ /^$/ && 3638ffbce897SJoe Perches $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) { 36399f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 36409f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 36413b6e8ac9SJoe Perches } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) { 36423b6e8ac9SJoe Perches my $spdx_license = $1; 36433b6e8ac9SJoe Perches if (!is_SPDX_License_valid($spdx_license)) { 36443b6e8ac9SJoe Perches WARN("SPDX_LICENSE_TAG", 36453b6e8ac9SJoe Perches "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr); 36463b6e8ac9SJoe Perches } 364750c92900SLubomir Rintel if ($realfile =~ m@^Documentation/devicetree/bindings/@ && 364850c92900SLubomir Rintel not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) { 364950c92900SLubomir Rintel my $msg_level = \&WARN; 365050c92900SLubomir Rintel $msg_level = \&CHK if ($file); 365150c92900SLubomir Rintel if (&{$msg_level}("SPDX_LICENSE_TAG", 365250c92900SLubomir Rintel 365350c92900SLubomir Rintel "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) && 365450c92900SLubomir Rintel $fix) { 365550c92900SLubomir Rintel $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/; 365650c92900SLubomir Rintel } 365750c92900SLubomir Rintel } 36589f3a8992SRob Herring } 36599f3a8992SRob Herring } 36609f3a8992SRob Herring } 36619f3a8992SRob Herring 3662a0154cdbSJoe Perches# check for embedded filenames 3663a0154cdbSJoe Perches if ($rawline =~ /^\+.*\Q$realfile\E/) { 3664a0154cdbSJoe Perches WARN("EMBEDDED_FILENAME", 3665a0154cdbSJoe Perches "It's generally not useful to have the filename in the file\n" . $herecurr); 3666a0154cdbSJoe Perches } 3667a0154cdbSJoe Perches 36685368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 3669d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 36705368df20SAndy Whitcroft 3671a8da38a9SJoe Perches# check for using SPDX-License-Identifier on the wrong line number 3672a8da38a9SJoe Perches if ($realline != $checklicenseline && 3673a8da38a9SJoe Perches $rawline =~ /\bSPDX-License-Identifier:/ && 3674a8da38a9SJoe Perches substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) { 3675a8da38a9SJoe Perches WARN("SPDX_LICENSE_TAG", 3676a8da38a9SJoe Perches "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr); 3677a8da38a9SJoe Perches } 3678a8da38a9SJoe Perches 367947e0c88bSJoe Perches# line length limit (with some exclusions) 368047e0c88bSJoe Perches# 368147e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 368247e0c88bSJoe Perches# logging functions like pr_info that end in a string 368347e0c88bSJoe Perches# lines with a single string 368447e0c88bSJoe Perches# #defines that are a single string 36852e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 368647e0c88bSJoe Perches# 368747e0c88bSJoe Perches# There are 3 different line length message types: 3688ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 368947e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 369047e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 369147e0c88bSJoe Perches# 369247e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 369347e0c88bSJoe Perches# 369447e0c88bSJoe Perches 3695b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 369647e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 369747e0c88bSJoe Perches 369847e0c88bSJoe Perches # Check the allowed long line types first 369947e0c88bSJoe Perches 370047e0c88bSJoe Perches # logging functions that end in a string that starts 370147e0c88bSJoe Perches # before $max_line_length 370247e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 370347e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 370447e0c88bSJoe Perches $msg_type = ""; 370547e0c88bSJoe Perches 370647e0c88bSJoe Perches # lines with only strings (w/ possible termination) 370747e0c88bSJoe Perches # #defines with only strings 370847e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 370947e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 371047e0c88bSJoe Perches $msg_type = ""; 371147e0c88bSJoe Perches 3712cc147506SJoe Perches # More special cases 3713cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3714cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3715d560a5f8SJoe Perches $msg_type = ""; 3716d560a5f8SJoe Perches 37172e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 37182e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 37192e4bbbc5SAndreas Brauchli $msg_type = ""; 37202e4bbbc5SAndreas Brauchli 372147e0c88bSJoe Perches # Otherwise set the alternate message types 372247e0c88bSJoe Perches 372347e0c88bSJoe Perches # a comment starts before $max_line_length 372447e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 372547e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 372647e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 372747e0c88bSJoe Perches 372847e0c88bSJoe Perches # a quoted string starts before $max_line_length 372947e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 373047e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 373147e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 373247e0c88bSJoe Perches } 373347e0c88bSJoe Perches 373447e0c88bSJoe Perches if ($msg_type ne "" && 373547e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 3736bdc48fa1SJoe Perches my $msg_level = \&WARN; 3737bdc48fa1SJoe Perches $msg_level = \&CHK if ($file); 3738bdc48fa1SJoe Perches &{$msg_level}($msg_type, 3739bdc48fa1SJoe Perches "line length of $length exceeds $max_line_length columns\n" . $herecurr); 37400a920b5bSAndy Whitcroft } 374147e0c88bSJoe Perches } 37420a920b5bSAndy Whitcroft 37438905a67cSAndy Whitcroft# check for adding lines without a newline. 37448905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 374547ca69b8STom Rix if (WARN("MISSING_EOF_NEWLINE", 374647ca69b8STom Rix "adding a line without newline at end of file\n" . $herecurr) && 374747ca69b8STom Rix $fix) { 374847ca69b8STom Rix fix_delete_line($fixlinenr+1, "No newline at end of file"); 374947ca69b8STom Rix } 37508905a67cSAndy Whitcroft } 37518905a67cSAndy Whitcroft 3752de93245cSAditya Srivastava# check for .L prefix local symbols in .S files 3753de93245cSAditya Srivastava if ($realfile =~ /\.S$/ && 3754de93245cSAditya Srivastava $line =~ /^\+\s*(?:[A-Z]+_)?SYM_[A-Z]+_(?:START|END)(?:_[A-Z_]+)?\s*\(\s*\.L/) { 3755de93245cSAditya Srivastava WARN("AVOID_L_PREFIX", 3756de93245cSAditya Srivastava "Avoid using '.L' prefixed local symbol names for denoting a range of code via 'SYM_*_START/END' annotations; see Documentation/asm-annotations.rst\n" . $herecurr); 3757de93245cSAditya Srivastava } 3758de93245cSAditya Srivastava 3759b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3760de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 37610a920b5bSAndy Whitcroft 37620a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 3763713a09deSAntonio Borneo# more than $tabsize must use tabs. 3764c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3765c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3766c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3767d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 37683705ce5bSJoe Perches if (ERROR("CODE_INDENT", 37693705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 37703705ce5bSJoe Perches $fix) { 3771194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 37723705ce5bSJoe Perches } 37730a920b5bSAndy Whitcroft } 37740a920b5bSAndy Whitcroft 377508e44365SAlberto Panizzo# check for space before tabs. 377608e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 377708e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 37783705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 37793705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 37803705ce5bSJoe Perches $fix) { 3781194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3782713a09deSAntonio Borneo s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} 3783194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3784c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 37853705ce5bSJoe Perches } 378608e44365SAlberto Panizzo } 378708e44365SAlberto Panizzo 37886a487211SJoe Perches# check for assignments on the start of a line 37896a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 3790da7355abSAditya Srivastava my $operator = $1; 3791da7355abSAditya Srivastava if (CHK("ASSIGNMENT_CONTINUATIONS", 3792da7355abSAditya Srivastava "Assignment operator '$1' should be on the previous line\n" . $hereprev) && 3793da7355abSAditya Srivastava $fix && $prevrawline =~ /^\+/) { 3794da7355abSAditya Srivastava # add assignment operator to the previous line, remove from current line 3795da7355abSAditya Srivastava $fixed[$fixlinenr - 1] .= " $operator"; 3796da7355abSAditya Srivastava $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//; 3797da7355abSAditya Srivastava } 37986a487211SJoe Perches } 37996a487211SJoe Perches 3800d1fe9c09SJoe Perches# check for && or || at the start of a line 3801d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 38028e08f076SAditya Srivastava my $operator = $1; 38038e08f076SAditya Srivastava if (CHK("LOGICAL_CONTINUATIONS", 38048e08f076SAditya Srivastava "Logical continuations should be on the previous line\n" . $hereprev) && 38058e08f076SAditya Srivastava $fix && $prevrawline =~ /^\+/) { 38068e08f076SAditya Srivastava # insert logical operator at last non-comment, non-whitepsace char on previous line 38078e08f076SAditya Srivastava $prevline =~ /[\s$;]*$/; 38088e08f076SAditya Srivastava my $line_end = substr($prevrawline, $-[0]); 38098e08f076SAditya Srivastava $fixed[$fixlinenr - 1] =~ s/\Q$line_end\E$/ $operator$line_end/; 38108e08f076SAditya Srivastava $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//; 38118e08f076SAditya Srivastava } 3812d1fe9c09SJoe Perches } 3813d1fe9c09SJoe Perches 3814a91e8994SJoe Perches# check indentation starts on a tab stop 38155b57980dSJoe Perches if ($perl_version_ok && 3816bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3817a91e8994SJoe Perches my $indent = length($1); 3818713a09deSAntonio Borneo if ($indent % $tabsize) { 3819a91e8994SJoe Perches if (WARN("TABSTOP", 3820a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3821a91e8994SJoe Perches $fix) { 3822713a09deSAntonio Borneo $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; 3823a91e8994SJoe Perches } 3824a91e8994SJoe Perches } 3825a91e8994SJoe Perches } 3826a91e8994SJoe Perches 3827d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 38285b57980dSJoe Perches if ($perl_version_ok && 3829fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3830d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3831d1fe9c09SJoe Perches my $oldindent = $1; 3832d1fe9c09SJoe Perches my $rest = $2; 3833d1fe9c09SJoe Perches 3834d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3835d1fe9c09SJoe Perches if ($pos >= 0) { 3836b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3837b34a26f3SJoe Perches my $newindent = $2; 3838d1fe9c09SJoe Perches 3839d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3840713a09deSAntonio Borneo "\t" x ($pos / $tabsize) . 3841713a09deSAntonio Borneo " " x ($pos % $tabsize); 3842d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3843d1fe9c09SJoe Perches 3844d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3845d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 38463705ce5bSJoe Perches 38473705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 38483705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 38493705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3850194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38513705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 38523705ce5bSJoe Perches } 3853d1fe9c09SJoe Perches } 3854d1fe9c09SJoe Perches } 3855d1fe9c09SJoe Perches } 3856d1fe9c09SJoe Perches 38576ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 38586ab3a970SJoe Perches# avoid checking a few false positives: 38596ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 38606ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 38616ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 38626ab3a970SJoe Perches# multiline macros that define functions 38636ab3a970SJoe Perches# known attributes or the __attribute__ keyword 38646ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 38656ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 38663705ce5bSJoe Perches if (CHK("SPACING", 3867f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 38683705ce5bSJoe Perches $fix) { 3869194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3870f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 38713705ce5bSJoe Perches } 3872aad4f614SJoe Perches } 3873aad4f614SJoe Perches 387486406b1cSJoe Perches# Block comment styles 387586406b1cSJoe Perches# Networking with an initial /* 387605880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3877fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 387885ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 3879c70735c2SŁukasz Stelmach $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier 388005880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 388105880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 388205880600SJoe Perches } 388305880600SJoe Perches 388486406b1cSJoe Perches# Block comments use * on subsequent lines 388586406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 388686406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3887a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 388861135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3889a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 389086406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 389186406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3892a605e32eSJoe Perches } 3893a605e32eSJoe Perches 389486406b1cSJoe Perches# Block comments use */ on trailing lines 389586406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3896c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3897c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3898c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 389986406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 390086406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 390105880600SJoe Perches } 390205880600SJoe Perches 390308eb9b80SJoe Perches# Block comment * alignment 390408eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3905af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3906af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3907af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 390808eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3909af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3910af207524SJoe Perches my $oldindent; 391108eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3912af207524SJoe Perches if (defined($1)) { 3913af207524SJoe Perches $oldindent = expand_tabs($1); 3914af207524SJoe Perches } else { 3915af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3916af207524SJoe Perches $oldindent = expand_tabs($1); 3917af207524SJoe Perches } 391808eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 391908eb9b80SJoe Perches my $newindent = $1; 392008eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3921af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 392208eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 392308eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 392408eb9b80SJoe Perches } 392508eb9b80SJoe Perches } 392608eb9b80SJoe Perches 39277f619191SJoe Perches# check for missing blank lines after struct/union declarations 39287f619191SJoe Perches# with exceptions for various attributes and macros 39297f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 39307f619191SJoe Perches $line =~ /^\+/ && 39317f619191SJoe Perches !($line =~ /^\+\s*$/ || 393205dc40e6SJoe Perches $line =~ /^\+\s*(?:EXPORT_SYMBOL|early_param)/ || 39337f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 39347f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 39357f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 39367f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 39377f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 39380bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 39397f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3940d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3941d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3942d752fcc8SJoe Perches $fix) { 3943f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3944d752fcc8SJoe Perches } 39457f619191SJoe Perches } 39467f619191SJoe Perches 3947365dd4eaSJoe Perches# check for multiple consecutive blank lines 3948365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3949365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3950365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3951d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3952d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3953d752fcc8SJoe Perches $fix) { 3954f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3955d752fcc8SJoe Perches } 3956d752fcc8SJoe Perches 3957365dd4eaSJoe Perches $last_blank_line = $linenr; 3958365dd4eaSJoe Perches } 3959365dd4eaSJoe Perches 39603b617e3bSJoe Perches# check for missing blank lines after declarations 3961b5e8736aSJoe Perches# (declarations must have the same indentation and not be at the start of line) 3962b5e8736aSJoe Perches if (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/) { 3963b5e8736aSJoe Perches # use temporaries 3964b5e8736aSJoe Perches my $sl = $sline; 3965b5e8736aSJoe Perches my $pl = $prevline; 3966b5e8736aSJoe Perches # remove $Attribute/$Sparse uses to simplify comparisons 3967b5e8736aSJoe Perches $sl =~ s/\b(?:$Attribute|$Sparse)\b//g; 3968b5e8736aSJoe Perches $pl =~ s/\b(?:$Attribute|$Sparse)\b//g; 3969b5e8736aSJoe Perches if (($pl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 39705a4e1fd3SJoe Perches # function pointer declarations 3971b5e8736aSJoe Perches $pl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 39723f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 3973b5e8736aSJoe Perches $pl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 39743f7bac03SJoe Perches # known declaration macros 3975b5e8736aSJoe Perches $pl =~ /^\+\s+$declaration_macros/) && 39763f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 3977b5e8736aSJoe Perches !($pl =~ /^\+\s+$c90_Keywords\b/ || 39783f7bac03SJoe Perches # other possible extensions of declaration lines 3979b5e8736aSJoe Perches $pl =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 39803f7bac03SJoe Perches # not starting a section or a macro "\" extended line 3981b5e8736aSJoe Perches $pl =~ /(?:\{\s*|\\)$/) && 39823f7bac03SJoe Perches # looks like a declaration 3983b5e8736aSJoe Perches !($sl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 39845a4e1fd3SJoe Perches # function pointer declarations 3985b5e8736aSJoe Perches $sl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 39863f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 3987b5e8736aSJoe Perches $sl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 39883f7bac03SJoe Perches # known declaration macros 3989b5e8736aSJoe Perches $sl =~ /^\+\s+$declaration_macros/ || 39903f7bac03SJoe Perches # start of struct or union or enum 3991b5e8736aSJoe Perches $sl =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ || 39923f7bac03SJoe Perches # start or end of block or continuation of declaration 3993b5e8736aSJoe Perches $sl =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 39943f7bac03SJoe Perches # bitfield continuation 3995b5e8736aSJoe Perches $sl =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 39963f7bac03SJoe Perches # other possible extensions of declaration lines 3997b5e8736aSJoe Perches $sl =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/)) { 3998d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3999d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 4000d752fcc8SJoe Perches $fix) { 4001f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 4002d752fcc8SJoe Perches } 40033b617e3bSJoe Perches } 4004b5e8736aSJoe Perches } 40053b617e3bSJoe Perches 40065f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 40076b4c5bebSAndy Whitcroft# Exceptions: 40086b4c5bebSAndy Whitcroft# 1) within comments 40096b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 40106b4c5bebSAndy Whitcroft# 3) hanging labels 40113705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 40125f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 40133705ce5bSJoe Perches if (WARN("LEADING_SPACE", 40143705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 40153705ce5bSJoe Perches $fix) { 4016194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 40173705ce5bSJoe Perches } 40185f7ddae6SRaffaele Recalcati } 40195f7ddae6SRaffaele Recalcati 4020b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 4021b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 4022b9ea10d6SAndy Whitcroft 40235751a24eSJoe Perches# check for unusual line ending [ or ( 40245751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 40255751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 40265751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 40275751a24eSJoe Perches } 40285751a24eSJoe Perches 40294dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 40304dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 40314dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 40324dbed76fSJoe Perches $context_function = $1; 40334dbed76fSJoe Perches } 40344dbed76fSJoe Perches 40354dbed76fSJoe Perches# check if this appears to be the end of function declaration 40364dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 40374dbed76fSJoe Perches undef $context_function; 40384dbed76fSJoe Perches } 40394dbed76fSJoe Perches 4040032a4c0fSJoe Perches# check indentation of any line with a bare else 4041840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 4042032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 4043032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 4044032a4c0fSJoe Perches my $tabs = length($1) + 1; 4045840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 4046840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 4047840080a0SJoe Perches defined $lines[$linenr] && 4048840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 4049032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 4050032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 4051032a4c0fSJoe Perches } 4052032a4c0fSJoe Perches } 4053032a4c0fSJoe Perches 4054c00df19aSJoe Perches# check indentation of a line with a break; 4055dc58bc55SJoe Perches# if the previous line is a goto, return or break 4056dc58bc55SJoe Perches# and is indented the same # of tabs 4057c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 4058c00df19aSJoe Perches my $tabs = $1; 4059dc58bc55SJoe Perches if ($prevline =~ /^\+$tabs(goto|return|break)\b/) { 4060dc58bc55SJoe Perches if (WARN("UNNECESSARY_BREAK", 4061dc58bc55SJoe Perches "break is not useful after a $1\n" . $hereprev) && 4062dc58bc55SJoe Perches $fix) { 4063dc58bc55SJoe Perches fix_delete_line($fixlinenr, $rawline); 4064dc58bc55SJoe Perches } 4065c00df19aSJoe Perches } 4066c00df19aSJoe Perches } 4067c00df19aSJoe Perches 4068c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 4069cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 4070000d1cc1SJoe Perches WARN("CVS_KEYWORD", 4071000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 4072c2fdda0dSAndy Whitcroft } 407322f2a2efSAndy Whitcroft 407456e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 407556e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 407656e77d70SJoe Perches WARN("HOTPLUG_SECTION", 407756e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 407856e77d70SJoe Perches } 407956e77d70SJoe Perches 40809c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 40812b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 40822b474a1aSAndy Whitcroft $realline_next); 40833e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 4084ca819864SJoe Perches if ($linenr > $suppress_statement && 40851b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 4086170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 4087f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4088171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 4089171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 4090171ae1a4SAndy Whitcroft 40913e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 40923e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 40933e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 40943e469cdcSAndy Whitcroft # until we hit end of it. 40953e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 40963e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 40973e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 40983e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 40993e469cdcSAndy Whitcroft } 4100f74bd194SAndy Whitcroft 41012b474a1aSAndy Whitcroft # Find the real next line. 41022b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 41032b474a1aSAndy Whitcroft if (defined $realline_next && 41042b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 41052b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 41062b474a1aSAndy Whitcroft $realline_next++; 41072b474a1aSAndy Whitcroft } 41082b474a1aSAndy Whitcroft 4109171ae1a4SAndy Whitcroft my $s = $stat; 4110171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 4111cf655043SAndy Whitcroft 4112c2fdda0dSAndy Whitcroft # Ignore goto labels. 4113171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 4114c2fdda0dSAndy Whitcroft 4115c2fdda0dSAndy Whitcroft # Ignore functions being called 4116171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 4117c2fdda0dSAndy Whitcroft 4118463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 4119463f2864SAndy Whitcroft 4120c45dcabdSAndy Whitcroft # declarations always start with types 4121d2506586SAndy 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) { 4122c45dcabdSAndy Whitcroft my $type = $1; 4123c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 4124c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 4125c45dcabdSAndy Whitcroft 41266c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 4127a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 4128c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 4129c2fdda0dSAndy Whitcroft } 41308905a67cSAndy Whitcroft 41316c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 413265863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 4133c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 41349c0ca6f9SAndy Whitcroft } 41358905a67cSAndy Whitcroft 41368905a67cSAndy Whitcroft # Check for any sort of function declaration. 41378905a67cSAndy Whitcroft # int foo(something bar, other baz); 41388905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 4139171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 41408905a67cSAndy Whitcroft my ($name_len) = length($1); 41418905a67cSAndy Whitcroft 4142cf655043SAndy Whitcroft my $ctx = $s; 4143773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 41448905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 4145cf655043SAndy Whitcroft 41468905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 4147c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 41488905a67cSAndy Whitcroft 4149c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 41508905a67cSAndy Whitcroft } 41518905a67cSAndy Whitcroft } 41528905a67cSAndy Whitcroft } 41538905a67cSAndy Whitcroft 41549c0ca6f9SAndy Whitcroft } 41559c0ca6f9SAndy Whitcroft 415600df344fSAndy Whitcroft# 415700df344fSAndy Whitcroft# Checks which may be anchored in the context. 415800df344fSAndy Whitcroft# 415900df344fSAndy Whitcroft 416000df344fSAndy Whitcroft# Check for switch () and associated case and default 416100df344fSAndy Whitcroft# statements should be at the same indent. 416200df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 416300df344fSAndy Whitcroft my $err = ''; 416400df344fSAndy Whitcroft my $sep = ''; 416500df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 416600df344fSAndy Whitcroft shift(@ctx); 416700df344fSAndy Whitcroft for my $ctx (@ctx) { 416800df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 416900df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 417000df344fSAndy Whitcroft $indent != $cindent) { 417100df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 417200df344fSAndy Whitcroft $sep = ''; 417300df344fSAndy Whitcroft } else { 417400df344fSAndy Whitcroft $sep = "[...]\n"; 417500df344fSAndy Whitcroft } 417600df344fSAndy Whitcroft } 417700df344fSAndy Whitcroft if ($err ne '') { 4178000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 4179000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 4180de7d4f0eSAndy Whitcroft } 4181de7d4f0eSAndy Whitcroft } 4182de7d4f0eSAndy Whitcroft 4183de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 4184de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 41850fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 4186773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 4187773647a0SAndy Whitcroft 41889c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 41898eef05ddSJoe Perches 41908eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 41918eef05ddSJoe Perches WARN("DEEP_INDENTATION", 41928eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 41938eef05ddSJoe Perches } 41948eef05ddSJoe Perches 4195de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 4196de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 4197de7d4f0eSAndy Whitcroft 4198548596d5SAndy Whitcroft my $ctx_ln = $linenr; 4199548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 4200de7d4f0eSAndy Whitcroft 4201548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 4202548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 4203548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 4204548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 4205548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 4206773647a0SAndy Whitcroft $ctx_ln++; 4207773647a0SAndy Whitcroft } 4208548596d5SAndy Whitcroft 420953210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 421053210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 4211773647a0SAndy Whitcroft 4212773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 4213000d1cc1SJoe Perches ERROR("OPEN_BRACE", 4214000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 421501464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 421600df344fSAndy Whitcroft } 4217773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 4218773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 4219773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 4220773647a0SAndy Whitcroft { 42219c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 42229c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 4223000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 4224000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 422501464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 42269c0ca6f9SAndy Whitcroft } 42279c0ca6f9SAndy Whitcroft } 422800df344fSAndy Whitcroft } 422900df344fSAndy Whitcroft 42304d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 4231f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 42323e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 42333e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 42343e469cdcSAndy Whitcroft if (!defined $stat); 42354d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 42364d001e4dSAndy Whitcroft 42374d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 42384d001e4dSAndy Whitcroft 42399f5af480SJoe Perches # remove inline comments 42409f5af480SJoe Perches $s =~ s/$;/ /g; 42419f5af480SJoe Perches $c =~ s/$;/ /g; 42424d001e4dSAndy Whitcroft 42434d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 42446f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 42456f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 42464d001e4dSAndy Whitcroft 42479f5af480SJoe Perches # Make sure we remove the line prefixes as we have 42489f5af480SJoe Perches # none on the first line, and are going to readd them 42499f5af480SJoe Perches # where necessary. 42509f5af480SJoe Perches $s =~ s/\n./\n/gs; 42519f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 42529f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 42539f5af480SJoe Perches } 42549f5af480SJoe Perches 42554d001e4dSAndy Whitcroft # We want to check the first line inside the block 42564d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 42574d001e4dSAndy Whitcroft # 1) any blank line termination 42584d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 42594d001e4dSAndy Whitcroft # 3) any do (...) { 42604d001e4dSAndy Whitcroft my $continuation = 0; 42614d001e4dSAndy Whitcroft my $check = 0; 42624d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 42634d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 42644d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 42654d001e4dSAndy Whitcroft $continuation = 1; 42664d001e4dSAndy Whitcroft } 42679bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 42684d001e4dSAndy Whitcroft $check = 1; 42694d001e4dSAndy Whitcroft $cond_lines++; 42704d001e4dSAndy Whitcroft } 42714d001e4dSAndy Whitcroft 42724d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 42734d001e4dSAndy Whitcroft # preprocessor statement. 42744d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 42754d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 42764d001e4dSAndy Whitcroft $check = 0; 42774d001e4dSAndy Whitcroft } 42784d001e4dSAndy Whitcroft 42799bd49efeSAndy Whitcroft my $cond_ptr = -1; 4280740504c6SAndy Whitcroft $continuation = 0; 42819bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 42829bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 42834d001e4dSAndy Whitcroft 4284f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 4285f16fa28fSAndy Whitcroft # is not linear. 4286f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 4287f16fa28fSAndy Whitcroft $check = 0; 4288f16fa28fSAndy Whitcroft } 4289f16fa28fSAndy Whitcroft 42909bd49efeSAndy Whitcroft # Ignore: 42919bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 42929bd49efeSAndy Whitcroft # 2) preprocessor lines, and 42939bd49efeSAndy Whitcroft # 3) labels. 4294740504c6SAndy Whitcroft if ($continuation || 4295740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 42969bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 42979bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 4298740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 429930dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 43009bd49efeSAndy Whitcroft $cond_lines++; 43019bd49efeSAndy Whitcroft } 43024d001e4dSAndy Whitcroft } 430330dad6ebSAndy Whitcroft } 43044d001e4dSAndy Whitcroft 43054d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 43064d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 43074d001e4dSAndy Whitcroft 43084d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 43094d001e4dSAndy Whitcroft # this is not this patch's fault. 43104d001e4dSAndy Whitcroft if (!defined($stat_real) || 43114d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 43124d001e4dSAndy Whitcroft $check = 0; 43134d001e4dSAndy Whitcroft } 43144d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 43154d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 43164d001e4dSAndy Whitcroft } 43174d001e4dSAndy Whitcroft 43189bd49efeSAndy 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"; 43194d001e4dSAndy Whitcroft 43209f5af480SJoe Perches if ($check && $s ne '' && 4321713a09deSAntonio Borneo (($sindent % $tabsize) != 0 || 43229f5af480SJoe Perches ($sindent < $indent) || 4323f6950a73SJoe Perches ($sindent == $indent && 4324f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 4325713a09deSAntonio Borneo ($sindent > $indent + $tabsize))) { 4326000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 4327000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 43284d001e4dSAndy Whitcroft } 43294d001e4dSAndy Whitcroft } 43304d001e4dSAndy Whitcroft 43316c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 43326c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 43331f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 43341f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 43356c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 4336c2fdda0dSAndy Whitcroft if ($dbg_values) { 4337c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 4338cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 4339cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 43401f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 4341c2fdda0dSAndy Whitcroft } 43426c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 43436c72ffaaSAndy Whitcroft 434400df344fSAndy Whitcroft#ignore lines not being added 43453705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 434600df344fSAndy Whitcroft 434799ca38c2SJoe Perches# check for self assignments used to avoid compiler warnings 434899ca38c2SJoe Perches# e.g.: int foo = foo, *bar = NULL; 434999ca38c2SJoe Perches# struct foo bar = *(&(bar)); 435099ca38c2SJoe Perches if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) { 435199ca38c2SJoe Perches my $var = $1; 435299ca38c2SJoe Perches if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) { 435399ca38c2SJoe Perches WARN("SELF_ASSIGNMENT", 435499ca38c2SJoe Perches "Do not use self-assignments to avoid compiler warnings\n" . $herecurr); 435599ca38c2SJoe Perches } 435699ca38c2SJoe Perches } 435799ca38c2SJoe Perches 435811ca40a0SJoe Perches# check for dereferences that span multiple lines 435911ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 436011ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 436111ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 436211ca40a0SJoe Perches my $ref = $1; 436311ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 436411ca40a0SJoe Perches $ref .= $1; 436511ca40a0SJoe Perches $ref =~ s/\s//g; 436611ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 436711ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 436811ca40a0SJoe Perches } 436911ca40a0SJoe Perches 4370a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 4371c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 4372a1ce18e4SJoe Perches my $type = $1; 4373a1ce18e4SJoe Perches my $var = $2; 4374207a8e84SJoe Perches $var = "" if (!defined $var); 4375207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 4376a1ce18e4SJoe Perches my $sign = $1; 4377a1ce18e4SJoe Perches my $pointer = $2; 4378a1ce18e4SJoe Perches 4379a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 4380a1ce18e4SJoe Perches 4381a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 4382a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 4383a1ce18e4SJoe Perches $fix) { 4384a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 4385207a8e84SJoe Perches my $comp_pointer = $pointer; 4386207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 4387207a8e84SJoe Perches $decl .= $comp_pointer; 4388207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 4389207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 4390a1ce18e4SJoe Perches } 4391a1ce18e4SJoe Perches } 4392a1ce18e4SJoe Perches } 4393a1ce18e4SJoe Perches 4394653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 43957429c690SAndy Whitcroft if ($dbg_type) { 43967429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 4397000d1cc1SJoe Perches ERROR("TEST_TYPE", 4398000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 43997429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 4400000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 4401000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 44027429c690SAndy Whitcroft } 4403653d4876SAndy Whitcroft next; 4404653d4876SAndy Whitcroft } 4405a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 4406a1ef277eSAndy Whitcroft if ($dbg_attr) { 44079360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 4408000d1cc1SJoe Perches ERROR("TEST_ATTR", 4409000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 44109360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 4411000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 4412000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 4413a1ef277eSAndy Whitcroft } 4414a1ef277eSAndy Whitcroft next; 4415a1ef277eSAndy Whitcroft } 4416653d4876SAndy Whitcroft 4417f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 441899423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 441999423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 4420d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 4421d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 4422f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 4423f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4424f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 4425d752fcc8SJoe Perches my $fixedline = $prevrawline; 4426d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 4427f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 4428d752fcc8SJoe Perches $fixedline = $line; 44298d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 4430f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 4431d752fcc8SJoe Perches } 4432f0a594c1SAndy Whitcroft } 4433f0a594c1SAndy Whitcroft 443400df344fSAndy Whitcroft# 443500df344fSAndy Whitcroft# Checks which are anchored on the added line. 443600df344fSAndy Whitcroft# 443700df344fSAndy Whitcroft 4438653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 4439c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 4440653d4876SAndy Whitcroft my $path = $1; 4441653d4876SAndy Whitcroft if ($path =~ m{//}) { 4442000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 4443495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 4444495e9d84SJoe Perches } 4445495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 4446495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 4447495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 4448653d4876SAndy Whitcroft } 4449653d4876SAndy Whitcroft } 4450653d4876SAndy Whitcroft 445100df344fSAndy Whitcroft# no C99 // comments 445200df344fSAndy Whitcroft if ($line =~ m{//}) { 44533705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 44543705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 44553705ce5bSJoe Perches $fix) { 4456194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 44573705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 44583705ce5bSJoe Perches my $comment = trim($1); 4459194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 44603705ce5bSJoe Perches } 44613705ce5bSJoe Perches } 446200df344fSAndy Whitcroft } 446300df344fSAndy Whitcroft # Remove C99 comments. 44640a920b5bSAndy Whitcroft $line =~ s@//.*@@; 44656c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 44660a920b5bSAndy Whitcroft 44672b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 44682b474a1aSAndy Whitcroft# the whole statement. 44692b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 44702b474a1aSAndy Whitcroft if (defined $realline_next && 44712b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 44722b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 447336794822SChristoph Hellwig ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/)) { 44743cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 44753cbf62dfSAndy Whitcroft # a prefix: 44763cbf62dfSAndy Whitcroft # XXX(foo); 44773cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 4478653d4876SAndy Whitcroft my $name = $1; 447970a11659SJoe Perches $name =~ s/^\s*($Ident).*/$1/; 448087a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 44813cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 44823cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 44833cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 44843cbf62dfSAndy Whitcroft 44853cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 44862b474a1aSAndy Whitcroft \n.}\s*$| 448748012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 448848012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 448948012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 44902b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 44912b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 449248012058SAndy Whitcroft )/x) { 44932b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 44942b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 44952b474a1aSAndy Whitcroft } else { 44962b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 44970a920b5bSAndy Whitcroft } 44980a920b5bSAndy Whitcroft } 44992b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 45002b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 450136794822SChristoph Hellwig ($line =~ /EXPORT_SYMBOL.*\((.*)\)/)) { 45022b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 45032b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 45042b474a1aSAndy Whitcroft } 45052b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 45062b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 4507000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 4508000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 45092b474a1aSAndy Whitcroft } 45100a920b5bSAndy Whitcroft 45115150bda4SJoe Eloff# check for global initialisers. 45125b8f82e1SSong Liu if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/ && 45135b8f82e1SSong Liu !exclude_global_initialisers($realfile)) { 4514d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 45156d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 4516d5e616fcSJoe Perches $fix) { 45176d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 4518d5e616fcSJoe Perches } 4519f0a594c1SAndy Whitcroft } 45200a920b5bSAndy Whitcroft# check for static initialisers. 45216d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 4522d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 45236d32f7a3SJoe Perches "do not initialise statics to $1\n" . 4524d5e616fcSJoe Perches $herecurr) && 4525d5e616fcSJoe Perches $fix) { 45266d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 4527d5e616fcSJoe Perches } 45280a920b5bSAndy Whitcroft } 45290a920b5bSAndy Whitcroft 45301813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 45311813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 45321813087dSJoe Perches my $tmp = trim($1); 45331813087dSJoe Perches WARN("MISORDERED_TYPE", 45341813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 45351813087dSJoe Perches } 45361813087dSJoe Perches 4537809e082eSJoe Perches# check for unnecessary <signed> int declarations of short/long/long long 4538809e082eSJoe Perches while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) { 4539809e082eSJoe Perches my $type = trim($1); 4540809e082eSJoe Perches next if ($type !~ /\bint\b/); 4541809e082eSJoe Perches next if ($type !~ /\b(?:short|long\s+long|long)\b/); 4542809e082eSJoe Perches my $new_type = $type; 4543809e082eSJoe Perches $new_type =~ s/\b\s*int\s*\b/ /; 4544809e082eSJoe Perches $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /; 4545809e082eSJoe Perches $new_type =~ s/^const\s+//; 4546809e082eSJoe Perches $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/); 4547809e082eSJoe Perches $new_type = "const $new_type" if ($type =~ /^const\b/); 4548809e082eSJoe Perches $new_type =~ s/\s+/ /g; 4549809e082eSJoe Perches $new_type = trim($new_type); 4550809e082eSJoe Perches if (WARN("UNNECESSARY_INT", 4551809e082eSJoe Perches "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) && 4552809e082eSJoe Perches $fix) { 4553809e082eSJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/; 4554809e082eSJoe Perches } 4555809e082eSJoe Perches } 4556809e082eSJoe Perches 4557cb710ecaSJoe Perches# check for static const char * arrays. 4558cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 4559000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4560000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 4561cb710ecaSJoe Perches $herecurr); 4562cb710ecaSJoe Perches } 4563cb710ecaSJoe Perches 456477b8c0a8SJoe Perches# check for initialized const char arrays that should be static const 456577b8c0a8SJoe Perches if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) { 456677b8c0a8SJoe Perches if (WARN("STATIC_CONST_CHAR_ARRAY", 456777b8c0a8SJoe Perches "const array should probably be static const\n" . $herecurr) && 456877b8c0a8SJoe Perches $fix) { 456977b8c0a8SJoe Perches $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/; 457077b8c0a8SJoe Perches } 457177b8c0a8SJoe Perches } 457277b8c0a8SJoe Perches 4573cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 4574cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 4575000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4576000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 4577cb710ecaSJoe Perches $herecurr); 4578cb710ecaSJoe Perches } 4579cb710ecaSJoe Perches 4580ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 4581ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 4582ab7e23f3SJoe Perches my $found = $1; 4583ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 4584ab7e23f3SJoe Perches WARN("CONST_CONST", 4585ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 4586ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 4587ab7e23f3SJoe Perches WARN("CONST_CONST", 4588ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 4589ab7e23f3SJoe Perches } 4590ab7e23f3SJoe Perches } 4591ab7e23f3SJoe Perches 459273169765SJoe Perches# check for const static or static <non ptr type> const declarations 459373169765SJoe Perches# prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const' 459473169765SJoe Perches if ($sline =~ /^\+\s*const\s+static\s+($Type)\b/ || 459573169765SJoe Perches $sline =~ /^\+\s*static\s+($BasicType)\s+const\b/) { 459673169765SJoe Perches if (WARN("STATIC_CONST", 459773169765SJoe Perches "Move const after static - use 'static const $1'\n" . $herecurr) && 459873169765SJoe Perches $fix) { 459973169765SJoe Perches $fixed[$fixlinenr] =~ s/\bconst\s+static\b/static const/; 460073169765SJoe Perches $fixed[$fixlinenr] =~ s/\bstatic\s+($BasicType)\s+const\b/static const $1/; 460173169765SJoe Perches } 460273169765SJoe Perches } 460373169765SJoe Perches 46049b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 46059b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 46069b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 46079b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 46089b0fa60dSJoe Perches $herecurr); 46099b0fa60dSJoe Perches } 46109b0fa60dSJoe Perches 4611b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 4612b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 4613b598b670SJoe Perches my $array = $1; 4614b598b670SJoe 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*\))@) { 4615b598b670SJoe Perches my $array_div = $1; 4616b598b670SJoe Perches if (WARN("ARRAY_SIZE", 4617b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 4618b598b670SJoe Perches $fix) { 4619b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 4620b598b670SJoe Perches } 4621b598b670SJoe Perches } 4622b598b670SJoe Perches } 4623b598b670SJoe Perches 4624b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 462516b7f3c8SJoe Perches if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) { 4626b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 4627b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 4628b36190c5SJoe Perches $fix) { 4629194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 4630b36190c5SJoe Perches } 4631b36190c5SJoe Perches } 4632b36190c5SJoe Perches 4633653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 4634653d4876SAndy Whitcroft# make sense. 4635653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 46368054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 4637c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 46388ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 463946d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 4640000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 4641000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 46420a920b5bSAndy Whitcroft } 46430a920b5bSAndy Whitcroft 46440a920b5bSAndy Whitcroft# * goes on variable not on type 464565863862SAndy Whitcroft # (char*[ const]) 4646bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 4647bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 46483705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 4649d8aaf121SAndy Whitcroft 465065863862SAndy Whitcroft # Should start with a space. 465165863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 465265863862SAndy Whitcroft # Should not end with a space. 465365863862SAndy Whitcroft $to =~ s/\s+$//; 465465863862SAndy Whitcroft # '*'s should not have spaces between. 4655f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 465665863862SAndy Whitcroft } 4657d8aaf121SAndy Whitcroft 46583705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 465965863862SAndy Whitcroft if ($from ne $to) { 46603705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 46613705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 46623705ce5bSJoe Perches $fix) { 46633705ce5bSJoe Perches my $sub_from = $ident; 46643705ce5bSJoe Perches my $sub_to = $ident; 46653705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4666194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46673705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 46683705ce5bSJoe Perches } 466965863862SAndy Whitcroft } 4670bfcb2cc7SAndy Whitcroft } 4671bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 4672bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 46733705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 4674d8aaf121SAndy Whitcroft 467565863862SAndy Whitcroft # Should start with a space. 467665863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 467765863862SAndy Whitcroft # Should not end with a space. 467865863862SAndy Whitcroft $to =~ s/\s+$//; 467965863862SAndy Whitcroft # '*'s should not have spaces between. 4680f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 468165863862SAndy Whitcroft } 468265863862SAndy Whitcroft # Modifiers should have spaces. 468365863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 468465863862SAndy Whitcroft 46853705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 4686667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 46873705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 46883705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 46893705ce5bSJoe Perches $fix) { 46903705ce5bSJoe Perches 46913705ce5bSJoe Perches my $sub_from = $match; 46923705ce5bSJoe Perches my $sub_to = $match; 46933705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4694194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46953705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 46963705ce5bSJoe Perches } 469765863862SAndy Whitcroft } 46980a920b5bSAndy Whitcroft } 46990a920b5bSAndy Whitcroft 47009d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 47019d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 47020675a8fbSJean Delvare my $msg_level = \&WARN; 47030675a8fbSJean Delvare $msg_level = \&CHK if ($file); 47040675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 47059d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 47069d3e3c70SJoe Perches } 47070a920b5bSAndy Whitcroft 47089d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 47098905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 4710000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 4711000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 47128905a67cSAndy Whitcroft } 47138905a67cSAndy Whitcroft 471417441227SJoe Perches# check for uses of printk_ratelimit 471517441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 4716000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 4717000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 471817441227SJoe Perches } 471917441227SJoe Perches 4720eeef5733SJoe Perches# printk should use KERN_* levels 4721eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 4722000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 4723eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 472400df344fSAndy Whitcroft } 47250a920b5bSAndy Whitcroft 4726f5eea3b0SJoe Perches# prefer variants of (subsystem|netdev|dev|pr)_<level> to printk(KERN_<LEVEL> 4727f5eea3b0SJoe Perches if ($line =~ /\b(printk(_once|_ratelimited)?)\s*\(\s*KERN_([A-Z]+)/) { 4728f5eea3b0SJoe Perches my $printk = $1; 4729f5eea3b0SJoe Perches my $modifier = $2; 4730f5eea3b0SJoe Perches my $orig = $3; 4731f5eea3b0SJoe Perches $modifier = "" if (!defined($modifier)); 4732243f3803SJoe Perches my $level = lc($orig); 4733243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 47348f26b837SJoe Perches my $level2 = $level; 47358f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 4736f5eea3b0SJoe Perches $level .= $modifier; 4737f5eea3b0SJoe Perches $level2 .= $modifier; 4738243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 4739f5eea3b0SJoe Perches "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to $printk(KERN_$orig ...\n" . $herecurr); 4740243f3803SJoe Perches } 4741243f3803SJoe Perches 4742f5eea3b0SJoe Perches# prefer dev_<level> to dev_printk(KERN_<LEVEL> 4743dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 4744dc139313SJoe Perches my $orig = $1; 4745dc139313SJoe Perches my $level = lc($orig); 4746dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 4747dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 4748dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 4749dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 4750dc139313SJoe Perches } 4751dc139313SJoe Perches 47528020b253SNicolas Boichat# trace_printk should not be used in production code. 47538020b253SNicolas Boichat if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) { 47548020b253SNicolas Boichat WARN("TRACE_PRINTK", 47558020b253SNicolas Boichat "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr); 47568020b253SNicolas Boichat } 47578020b253SNicolas Boichat 475891c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 475991c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 476091c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 476191c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 476291c9afafSAndy Lutomirski WARN("ENOSYS", 476391c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 476491c9afafSAndy Lutomirski } 476591c9afafSAndy Lutomirski 47666b9ea5ffSJakub Kicinski# ENOTSUPP is not a standard error code and should be avoided in new patches. 47676b9ea5ffSJakub Kicinski# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP. 47686b9ea5ffSJakub Kicinski# Similarly to ENOSYS warning a small number of false positives is expected. 47696b9ea5ffSJakub Kicinski if (!$file && $line =~ /\bENOTSUPP\b/) { 47706b9ea5ffSJakub Kicinski if (WARN("ENOTSUPP", 47716b9ea5ffSJakub Kicinski "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) && 47726b9ea5ffSJakub Kicinski $fix) { 47736b9ea5ffSJakub Kicinski $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/; 47746b9ea5ffSJakub Kicinski } 47756b9ea5ffSJakub Kicinski } 47766b9ea5ffSJakub Kicinski 4777653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 4778653d4876SAndy Whitcroft# or if closed on same line 47795b57980dSJoe Perches if ($perl_version_ok && 47802d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 47812d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 47822d453e3bSJoe Perches $sline !~ /}/) { 47838d182478SJoe Perches if (ERROR("OPEN_BRACE", 47842d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 47858d182478SJoe Perches $fix) { 47868d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 47878d182478SJoe Perches my $fixed_line = $rawline; 478803f49351SDwaipayan Ray $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*)\{(.*)$/; 47898d182478SJoe Perches my $line1 = $1; 47908d182478SJoe Perches my $line2 = $2; 47918d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 47928d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 47938d182478SJoe Perches if ($line2 !~ /^\s*$/) { 47948d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 47958d182478SJoe Perches } 47968d182478SJoe Perches } 47970a920b5bSAndy Whitcroft } 4798653d4876SAndy Whitcroft 47998905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 48008905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 48018905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 48028d182478SJoe Perches if (ERROR("OPEN_BRACE", 48038d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 48048d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 48058d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48068d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 48078d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 48088d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48098d182478SJoe Perches $fixedline = $rawline; 48108d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 48118d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 48128d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48138d182478SJoe Perches } 48148d182478SJoe Perches } 48158905a67cSAndy Whitcroft } 48168905a67cSAndy Whitcroft 48170c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 48183705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 48193705ce5bSJoe Perches if (WARN("SPACING", 48203705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 48213705ce5bSJoe Perches $fix) { 4822194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48233705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 48243705ce5bSJoe Perches } 48250c73b4ebSAndy Whitcroft } 48260c73b4ebSAndy Whitcroft 482731070b5dSJoe Perches# Function pointer declarations 482831070b5dSJoe Perches# check spacing between type, funcptr, and args 482931070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 483091f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 483131070b5dSJoe Perches my $declare = $1; 483231070b5dSJoe Perches my $pre_pointer_space = $2; 483331070b5dSJoe Perches my $post_pointer_space = $3; 483431070b5dSJoe Perches my $funcname = $4; 483531070b5dSJoe Perches my $post_funcname_space = $5; 483631070b5dSJoe Perches my $pre_args_space = $6; 483731070b5dSJoe Perches 483891f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 483991f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 484091f72e9cSJoe Perches# don't need a space so don't warn for those. 484191f72e9cSJoe Perches my $post_declare_space = ""; 484291f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 484391f72e9cSJoe Perches $post_declare_space = $1; 484491f72e9cSJoe Perches $declare = rtrim($declare); 484591f72e9cSJoe Perches } 484691f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 484731070b5dSJoe Perches WARN("SPACING", 484831070b5dSJoe Perches "missing space after return type\n" . $herecurr); 484991f72e9cSJoe Perches $post_declare_space = " "; 485031070b5dSJoe Perches } 485131070b5dSJoe Perches 485231070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 485391f72e9cSJoe Perches# This test is not currently implemented because these declarations are 485491f72e9cSJoe Perches# equivalent to 485591f72e9cSJoe Perches# int foo(int bar, ...) 485691f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 485791f72e9cSJoe Perches# 485891f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 485991f72e9cSJoe Perches# WARN("SPACING", 486091f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 486191f72e9cSJoe Perches# } 486231070b5dSJoe Perches 486331070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 486431070b5dSJoe Perches if (defined $pre_pointer_space && 486531070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 486631070b5dSJoe Perches WARN("SPACING", 486731070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 486831070b5dSJoe Perches } 486931070b5dSJoe Perches 487031070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 487131070b5dSJoe Perches if (defined $post_pointer_space && 487231070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 487331070b5dSJoe Perches WARN("SPACING", 487431070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 487531070b5dSJoe Perches } 487631070b5dSJoe Perches 487731070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 487831070b5dSJoe Perches if (defined $post_funcname_space && 487931070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 488031070b5dSJoe Perches WARN("SPACING", 488131070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 488231070b5dSJoe Perches } 488331070b5dSJoe Perches 488431070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 488531070b5dSJoe Perches if (defined $pre_args_space && 488631070b5dSJoe Perches $pre_args_space =~ /^\s/) { 488731070b5dSJoe Perches WARN("SPACING", 488831070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 488931070b5dSJoe Perches } 489031070b5dSJoe Perches 489131070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4892194f66fcSJoe Perches $fixed[$fixlinenr] =~ 489391f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 489431070b5dSJoe Perches } 489531070b5dSJoe Perches } 489631070b5dSJoe Perches 48978d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 48988d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4899fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4900fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 49018d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 49028d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 49038d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4904fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 490538dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 49063705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 49073705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 49083705ce5bSJoe Perches $fix) { 4909194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49103705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 49113705ce5bSJoe Perches } 49128d31cfceSAndy Whitcroft } 49138d31cfceSAndy Whitcroft } 49148d31cfceSAndy Whitcroft 4915f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 49166c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4917c2fdda0dSAndy Whitcroft my $name = $1; 4918773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4919773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4920c2fdda0dSAndy Whitcroft 4921c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4922773647a0SAndy Whitcroft if ($name =~ /^(?: 4923773647a0SAndy Whitcroft if|for|while|switch|return|case| 4924773647a0SAndy Whitcroft volatile|__volatile__| 4925773647a0SAndy Whitcroft __attribute__|format|__extension__| 4926773647a0SAndy Whitcroft asm|__asm__)$/x) 4927773647a0SAndy Whitcroft { 4928c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4929c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4930c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4931c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4932773647a0SAndy Whitcroft 4933773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4934c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4935c2fdda0dSAndy Whitcroft 4936c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4937c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4938773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4939c2fdda0dSAndy Whitcroft 4940c2fdda0dSAndy Whitcroft } else { 49413705ce5bSJoe Perches if (WARN("SPACING", 49423705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 49433705ce5bSJoe Perches $fix) { 4944194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49453705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 49463705ce5bSJoe Perches } 4947f0a594c1SAndy Whitcroft } 49486c72ffaaSAndy Whitcroft } 49499a4cad4eSEric Nelson 4950653d4876SAndy Whitcroft# Check operator spacing. 49510a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 49523705ce5bSJoe Perches my $fixed_line = ""; 49533705ce5bSJoe Perches my $line_fixed = 0; 49543705ce5bSJoe Perches 49559c0ca6f9SAndy Whitcroft my $ops = qr{ 49569c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 49579c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 49589c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 49591f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 496084731623SJoe Perches \?:|\?|: 49619c0ca6f9SAndy Whitcroft }x; 4962cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 49633705ce5bSJoe Perches 49643705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 49653705ce5bSJoe Perches## foreach my $el (@elements) { 49663705ce5bSJoe Perches## print("el: <$el>\n"); 49673705ce5bSJoe Perches## } 49683705ce5bSJoe Perches 49693705ce5bSJoe Perches my @fix_elements = (); 497000df344fSAndy Whitcroft my $off = 0; 49716c72ffaaSAndy Whitcroft 49723705ce5bSJoe Perches foreach my $el (@elements) { 49733705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 49743705ce5bSJoe Perches $off += length($el); 49753705ce5bSJoe Perches } 49763705ce5bSJoe Perches 49773705ce5bSJoe Perches $off = 0; 49783705ce5bSJoe Perches 49796c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4980b34c648bSJoe Perches my $last_after = -1; 49816c72ffaaSAndy Whitcroft 49820a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 49833705ce5bSJoe Perches 49843705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 49853705ce5bSJoe Perches 49863705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 49873705ce5bSJoe Perches 49884a0df2efSAndy Whitcroft $off += length($elements[$n]); 49894a0df2efSAndy Whitcroft 499025985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4991773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4992773647a0SAndy Whitcroft my $cc = ''; 4993773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4994773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4995773647a0SAndy Whitcroft } 4996773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4997773647a0SAndy Whitcroft 49984a0df2efSAndy Whitcroft my $a = ''; 49994a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 50004a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 5001cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 50024a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 50034a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 5004773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 50054a0df2efSAndy Whitcroft 50060a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 50074a0df2efSAndy Whitcroft 50084a0df2efSAndy Whitcroft my $c = ''; 50090a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 50104a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 50114a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 5012cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 50134a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 50144a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 50158b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 50164a0df2efSAndy Whitcroft } else { 50174a0df2efSAndy Whitcroft $c = 'E'; 50180a920b5bSAndy Whitcroft } 50190a920b5bSAndy Whitcroft 50204a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 50214a0df2efSAndy Whitcroft 50224a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 50234a0df2efSAndy Whitcroft 50246c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 5025de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 50260a920b5bSAndy Whitcroft 502774048ed8SAndy Whitcroft # Pull out the value of this operator. 50286c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 50290a920b5bSAndy Whitcroft 50301f65f947SAndy Whitcroft # Get the full operator variant. 50311f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 50321f65f947SAndy Whitcroft 503313214adfSAndy Whitcroft # Ignore operators passed as parameters. 503413214adfSAndy Whitcroft if ($op_type ne 'V' && 5035d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 503613214adfSAndy Whitcroft 5037cf655043SAndy Whitcroft# # Ignore comments 5038cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 503913214adfSAndy Whitcroft 5040d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 504113214adfSAndy Whitcroft } elsif ($op eq ';') { 5042cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 5043cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 50443705ce5bSJoe Perches if (ERROR("SPACING", 50453705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 5046b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 50473705ce5bSJoe Perches $line_fixed = 1; 50483705ce5bSJoe Perches } 5049d8aaf121SAndy Whitcroft } 5050d8aaf121SAndy Whitcroft 5051d8aaf121SAndy Whitcroft # // is a comment 5052d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 50530a920b5bSAndy Whitcroft 5054b00e4814SJoe Perches # : when part of a bitfield 5055b00e4814SJoe Perches } elsif ($opv eq ':B') { 5056b00e4814SJoe Perches # skip the bitfield test for now 5057b00e4814SJoe Perches 50581f65f947SAndy Whitcroft # No spaces for: 50591f65f947SAndy Whitcroft # -> 5060b00e4814SJoe Perches } elsif ($op eq '->') { 50614a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 50623705ce5bSJoe Perches if (ERROR("SPACING", 50633705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 5064b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 50653705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 50663705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 50673705ce5bSJoe Perches } 5068b34c648bSJoe Perches $line_fixed = 1; 50693705ce5bSJoe Perches } 50700a920b5bSAndy Whitcroft } 50710a920b5bSAndy Whitcroft 50722381097bSJoe Perches # , must not have a space before and must have a space on the right. 50730a920b5bSAndy Whitcroft } elsif ($op eq ',') { 50742381097bSJoe Perches my $rtrim_before = 0; 50752381097bSJoe Perches my $space_after = 0; 50762381097bSJoe Perches if ($ctx =~ /Wx./) { 50772381097bSJoe Perches if (ERROR("SPACING", 50782381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 50792381097bSJoe Perches $line_fixed = 1; 50802381097bSJoe Perches $rtrim_before = 1; 50812381097bSJoe Perches } 50822381097bSJoe Perches } 5083cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 50843705ce5bSJoe Perches if (ERROR("SPACING", 50853705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 50863705ce5bSJoe Perches $line_fixed = 1; 5087b34c648bSJoe Perches $last_after = $n; 50882381097bSJoe Perches $space_after = 1; 50892381097bSJoe Perches } 50902381097bSJoe Perches } 50912381097bSJoe Perches if ($rtrim_before || $space_after) { 50922381097bSJoe Perches if ($rtrim_before) { 50932381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 50942381097bSJoe Perches } else { 50952381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 50962381097bSJoe Perches } 50972381097bSJoe Perches if ($space_after) { 50982381097bSJoe Perches $good .= " "; 50993705ce5bSJoe Perches } 51000a920b5bSAndy Whitcroft } 51010a920b5bSAndy Whitcroft 51029c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 510374048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 51049c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 51059c0ca6f9SAndy Whitcroft 51069c0ca6f9SAndy Whitcroft # unary operators should have a space before and 51079c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 51089c0ca6f9SAndy Whitcroft # unary operator, or a cast 51099c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 511074048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 51110d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 5112cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 51133705ce5bSJoe Perches if (ERROR("SPACING", 51143705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 5115b34c648bSJoe Perches if ($n != $last_after + 2) { 5116b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 51173705ce5bSJoe Perches $line_fixed = 1; 51183705ce5bSJoe Perches } 51190a920b5bSAndy Whitcroft } 5120b34c648bSJoe Perches } 5121a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 5122171ae1a4SAndy Whitcroft # A unary '*' may be const 5123171ae1a4SAndy Whitcroft 5124171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 51253705ce5bSJoe Perches if (ERROR("SPACING", 51263705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 5127b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 51283705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 51293705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 51303705ce5bSJoe Perches } 5131b34c648bSJoe Perches $line_fixed = 1; 51323705ce5bSJoe Perches } 51330a920b5bSAndy Whitcroft } 51340a920b5bSAndy Whitcroft 51350a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 51360a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 5137773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 51383705ce5bSJoe Perches if (ERROR("SPACING", 51393705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 5140b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 51413705ce5bSJoe Perches $line_fixed = 1; 51423705ce5bSJoe Perches } 51430a920b5bSAndy Whitcroft } 5144773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 5145773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 51463705ce5bSJoe Perches if (ERROR("SPACING", 51473705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 5148b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 51493705ce5bSJoe Perches $line_fixed = 1; 51503705ce5bSJoe Perches } 5151653d4876SAndy Whitcroft } 5152773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 51533705ce5bSJoe Perches if (ERROR("SPACING", 51543705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 5155b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 51563705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 51573705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5158773647a0SAndy Whitcroft } 5159b34c648bSJoe Perches $line_fixed = 1; 51603705ce5bSJoe Perches } 51613705ce5bSJoe Perches } 51620a920b5bSAndy Whitcroft 51630a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 51649c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 51659c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 51669c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 5167c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 5168c2fdda0dSAndy Whitcroft $op eq '%') 51690a920b5bSAndy Whitcroft { 5170d2e025f3SJoe Perches if ($check) { 5171d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 5172d2e025f3SJoe Perches if (CHK("SPACING", 5173d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 5174d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 5175d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5176d2e025f3SJoe Perches $line_fixed = 1; 5177d2e025f3SJoe Perches } 5178d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 5179d2e025f3SJoe Perches if (CHK("SPACING", 5180d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 5181d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 5182d2e025f3SJoe Perches $line_fixed = 1; 5183d2e025f3SJoe Perches } 5184d2e025f3SJoe Perches } 5185d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 51863705ce5bSJoe Perches if (ERROR("SPACING", 51873705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 5188b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 5189b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 5190b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5191b34c648bSJoe Perches } 51923705ce5bSJoe Perches $line_fixed = 1; 51933705ce5bSJoe Perches } 51940a920b5bSAndy Whitcroft } 51950a920b5bSAndy Whitcroft 51961f65f947SAndy Whitcroft # A colon needs no spaces before when it is 51971f65f947SAndy Whitcroft # terminating a case value or a label. 51981f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 5199263afd39SChris Down if ($ctx =~ /Wx./ and $realfile !~ m@.*\.lds\.h$@) { 52003705ce5bSJoe Perches if (ERROR("SPACING", 52013705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 5202b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 52033705ce5bSJoe Perches $line_fixed = 1; 52043705ce5bSJoe Perches } 52051f65f947SAndy Whitcroft } 52061f65f947SAndy Whitcroft 52070a920b5bSAndy Whitcroft # All the others need spaces both sides. 5208cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 52091f65f947SAndy Whitcroft my $ok = 0; 52101f65f947SAndy Whitcroft 521122f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 52121f65f947SAndy Whitcroft if (($op eq '<' && 52131f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 52141f65f947SAndy Whitcroft ($op eq '>' && 52151f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 52161f65f947SAndy Whitcroft { 52171f65f947SAndy Whitcroft $ok = 1; 52181f65f947SAndy Whitcroft } 52191f65f947SAndy Whitcroft 5220e0df7e1fSJoe Perches # for asm volatile statements 5221e0df7e1fSJoe Perches # ignore a colon with another 5222e0df7e1fSJoe Perches # colon immediately before or after 5223e0df7e1fSJoe Perches if (($op eq ':') && 5224e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 5225e0df7e1fSJoe Perches $ok = 1; 5226e0df7e1fSJoe Perches } 5227e0df7e1fSJoe Perches 522884731623SJoe Perches # messages are ERROR, but ?: are CHK 52291f65f947SAndy Whitcroft if ($ok == 0) { 52300675a8fbSJean Delvare my $msg_level = \&ERROR; 52310675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 523284731623SJoe Perches 52330675a8fbSJean Delvare if (&{$msg_level}("SPACING", 52343705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 5235b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 5236b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 5237b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5238b34c648bSJoe Perches } 52393705ce5bSJoe Perches $line_fixed = 1; 52403705ce5bSJoe Perches } 52410a920b5bSAndy Whitcroft } 524222f2a2efSAndy Whitcroft } 52434a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 52443705ce5bSJoe Perches 52453705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 52463705ce5bSJoe Perches 52473705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 52480a920b5bSAndy Whitcroft } 52493705ce5bSJoe Perches 52503705ce5bSJoe Perches if (($#elements % 2) == 0) { 52513705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 52523705ce5bSJoe Perches } 52533705ce5bSJoe Perches 5254194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 5255194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 52563705ce5bSJoe Perches } 52573705ce5bSJoe Perches 52583705ce5bSJoe Perches 52590a920b5bSAndy Whitcroft } 52600a920b5bSAndy Whitcroft 5261786b6326SJoe Perches# check for whitespace before a non-naked semicolon 5262d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 5263786b6326SJoe Perches if (WARN("SPACING", 5264786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 5265786b6326SJoe Perches $fix) { 5266194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 5267786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 5268786b6326SJoe Perches } 5269786b6326SJoe Perches } 5270786b6326SJoe Perches 5271f0a594c1SAndy Whitcroft# check for multiple assignments 5272f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 5273000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 5274000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 5275f0a594c1SAndy Whitcroft } 5276f0a594c1SAndy Whitcroft 527722f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 527822f2a2efSAndy Whitcroft## # continuation. 527922f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 528022f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 528122f2a2efSAndy Whitcroft## 528222f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 5283e73d2715SDwaipayan Ray## # falsely report the parameters of functions. 528422f2a2efSAndy Whitcroft## my $ln = $line; 528522f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 528622f2a2efSAndy Whitcroft## } 528722f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 5288000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 5289000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 529022f2a2efSAndy Whitcroft## } 529122f2a2efSAndy Whitcroft## } 5292f0a594c1SAndy Whitcroft 52930a920b5bSAndy Whitcroft#need space before brace following if, while, etc 52946b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 52956ad724e2SMichal Zylowski $line =~ /\b(?:else|do)\{/) { 52963705ce5bSJoe Perches if (ERROR("SPACING", 52973705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 52983705ce5bSJoe Perches $fix) { 52996ad724e2SMichal Zylowski $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/; 53003705ce5bSJoe Perches } 5301de7d4f0eSAndy Whitcroft } 5302de7d4f0eSAndy Whitcroft 5303c4a62ef9SJoe Perches## # check for blank lines before declarations 5304c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 5305c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 5306c4a62ef9SJoe Perches## WARN("SPACING", 5307c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 5308c4a62ef9SJoe Perches## } 5309c4a62ef9SJoe Perches## 5310c4a62ef9SJoe Perches 5311de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 5312de7d4f0eSAndy Whitcroft# on the line 531394fb9845SJoe Perches if ($line =~ /}(?!(?:,|;|\)|\}))\S/) { 5314d5e616fcSJoe Perches if (ERROR("SPACING", 5315d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 5316d5e616fcSJoe Perches $fix) { 5317194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5318d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 5319d5e616fcSJoe Perches } 53200a920b5bSAndy Whitcroft } 53210a920b5bSAndy Whitcroft 532222f2a2efSAndy Whitcroft# check spacing on square brackets 532322f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 53243705ce5bSJoe Perches if (ERROR("SPACING", 53253705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 53263705ce5bSJoe Perches $fix) { 5327194f66fcSJoe Perches $fixed[$fixlinenr] =~ 53283705ce5bSJoe Perches s/\[\s+/\[/; 53293705ce5bSJoe Perches } 533022f2a2efSAndy Whitcroft } 533122f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 53323705ce5bSJoe Perches if (ERROR("SPACING", 53333705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 53343705ce5bSJoe Perches $fix) { 5335194f66fcSJoe Perches $fixed[$fixlinenr] =~ 53363705ce5bSJoe Perches s/\s+\]/\]/; 53373705ce5bSJoe Perches } 533822f2a2efSAndy Whitcroft } 533922f2a2efSAndy Whitcroft 5340c45dcabdSAndy Whitcroft# check spacing on parentheses 53419c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 53429c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 53433705ce5bSJoe Perches if (ERROR("SPACING", 53443705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 53453705ce5bSJoe Perches $fix) { 5346194f66fcSJoe Perches $fixed[$fixlinenr] =~ 53473705ce5bSJoe Perches s/\(\s+/\(/; 53483705ce5bSJoe Perches } 534922f2a2efSAndy Whitcroft } 535013214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 5351c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 5352c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 53533705ce5bSJoe Perches if (ERROR("SPACING", 53543705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 53553705ce5bSJoe Perches $fix) { 5356194f66fcSJoe Perches $fixed[$fixlinenr] =~ 53573705ce5bSJoe Perches s/\s+\)/\)/; 53583705ce5bSJoe Perches } 535922f2a2efSAndy Whitcroft } 536022f2a2efSAndy Whitcroft 5361e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 5362e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 5363e2826fd0SJoe Perches 5364e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 5365ea4acbb1SJoe Perches my $var = $1; 5366ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 5367ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 5368ea4acbb1SJoe Perches $fix) { 5369ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 5370ea4acbb1SJoe Perches } 5371ea4acbb1SJoe Perches } 5372ea4acbb1SJoe Perches 5373ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 5374ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 5375ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 5376ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 5377ea4acbb1SJoe Perches my $var = $2; 5378ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 5379ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 5380ea4acbb1SJoe Perches $fix) { 5381ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 5382ea4acbb1SJoe Perches $var2 =~ s/\s//g; 5383ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 5384ea4acbb1SJoe Perches } 5385e2826fd0SJoe Perches } 5386e2826fd0SJoe Perches 538763b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 5388a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 5389a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 53905b57980dSJoe Perches $perl_version_ok && defined($stat) && 539163b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 539263b7c73eSJoe Perches my $if_stat = $1; 539363b7c73eSJoe Perches my $test = substr($2, 1, -1); 539463b7c73eSJoe Perches my $herectx; 539563b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 539663b7c73eSJoe Perches my $match = $1; 539763b7c73eSJoe Perches # avoid parentheses around potential macro args 539863b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 539963b7c73eSJoe Perches if (!defined($herectx)) { 540063b7c73eSJoe Perches $herectx = $here . "\n"; 540163b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 540263b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 540363b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 540463b7c73eSJoe Perches $herectx .= $rl . "\n"; 540563b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 540663b7c73eSJoe Perches } 540763b7c73eSJoe Perches } 540863b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 540963b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 541063b7c73eSJoe Perches } 541163b7c73eSJoe Perches } 541263b7c73eSJoe Perches 541369078651SJoe Perches# check that goto labels aren't indented (allow a single space indentation) 541469078651SJoe Perches# and ignore bitfield definitions like foo:1 541569078651SJoe Perches# Strictly, labels can have whitespace after the identifier and before the : 541669078651SJoe Perches# but this is not allowed here as many ?: uses would appear to be labels 541769078651SJoe Perches if ($sline =~ /^.\s+[A-Za-z_][A-Za-z\d_]*:(?!\s*\d+)/ && 541869078651SJoe Perches $sline !~ /^. [A-Za-z\d_][A-Za-z\d_]*:/ && 541969078651SJoe Perches $sline !~ /^.\s+default:/) { 54203705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 54213705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 54223705ce5bSJoe Perches $fix) { 5423194f66fcSJoe Perches $fixed[$fixlinenr] =~ 54243705ce5bSJoe Perches s/^(.)\s+/$1/; 54253705ce5bSJoe Perches } 54260a920b5bSAndy Whitcroft } 54270a920b5bSAndy Whitcroft 542840873abaSJoe Perches# check if a statement with a comma should be two statements like: 542940873abaSJoe Perches# foo = bar(), /* comma should be semicolon */ 543040873abaSJoe Perches# bar = baz(); 543140873abaSJoe Perches if (defined($stat) && 543240873abaSJoe Perches $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) { 543340873abaSJoe Perches my $cnt = statement_rawlines($stat); 543440873abaSJoe Perches my $herectx = get_stat_here($linenr, $cnt, $here); 543540873abaSJoe Perches WARN("SUSPECT_COMMA_SEMICOLON", 543640873abaSJoe Perches "Possible comma where semicolon could be used\n" . $herectx); 543740873abaSJoe Perches } 543840873abaSJoe Perches 54395b9553abSJoe Perches# return is not a function 5440507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 5441c45dcabdSAndy Whitcroft my $spacing = $1; 54425b57980dSJoe Perches if ($perl_version_ok && 54435b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 54445b9553abSJoe Perches my $value = $1; 54455b9553abSJoe Perches $value = deparenthesize($value); 54465b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 5447000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 5448000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 54495b9553abSJoe Perches } 5450c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 5451000d1cc1SJoe Perches ERROR("SPACING", 5452000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 5453c45dcabdSAndy Whitcroft } 5454c45dcabdSAndy Whitcroft } 5455507e5141SJoe Perches 5456b43ae21bSJoe Perches# unnecessary return in a void function 5457b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 5458b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 5459b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 5460b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 5461b43ae21bSJoe Perches $linenr >= 3 && 5462b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 5463b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 54649819cf25SJoe Perches WARN("RETURN_VOID", 5465b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 54669819cf25SJoe Perches } 54679819cf25SJoe Perches 5468189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 54695b57980dSJoe Perches if ($perl_version_ok && 5470189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 5471189248d8SJoe Perches my $openparens = $1; 5472189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 5473189248d8SJoe Perches my $msg = ""; 5474189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 5475189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 5476189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 5477189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 5478189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 5479189248d8SJoe Perches } 5480189248d8SJoe Perches } 5481189248d8SJoe Perches 5482c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 5483c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 5484c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 5485c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 54865b57980dSJoe Perches if ($perl_version_ok && 5487c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 5488c5595fa2SJoe Perches my $lead = $1; 5489c5595fa2SJoe Perches my $const = $2; 5490c5595fa2SJoe Perches my $comp = $3; 5491c5595fa2SJoe Perches my $to = $4; 5492c5595fa2SJoe Perches my $newcomp = $comp; 5493f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 5494c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 5495c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 5496c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 5497c5595fa2SJoe Perches $fix) { 5498c5595fa2SJoe Perches if ($comp eq "<") { 5499c5595fa2SJoe Perches $newcomp = ">"; 5500c5595fa2SJoe Perches } elsif ($comp eq "<=") { 5501c5595fa2SJoe Perches $newcomp = ">="; 5502c5595fa2SJoe Perches } elsif ($comp eq ">") { 5503c5595fa2SJoe Perches $newcomp = "<"; 5504c5595fa2SJoe Perches } elsif ($comp eq ">=") { 5505c5595fa2SJoe Perches $newcomp = "<="; 5506c5595fa2SJoe Perches } 5507c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 5508c5595fa2SJoe Perches } 5509c5595fa2SJoe Perches } 5510c5595fa2SJoe Perches 5511f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 5512f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 551353a3c448SAndy Whitcroft my $name = $1; 551446b85bf9SGuenter Roeck if ($name ne 'EOF' && $name ne 'ERROR' && $name !~ /^EPOLL/) { 5515000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 5516f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 551753a3c448SAndy Whitcroft } 551853a3c448SAndy Whitcroft } 5519c45dcabdSAndy Whitcroft 55200a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 55214a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 55223705ce5bSJoe Perches if (ERROR("SPACING", 55233705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 55243705ce5bSJoe Perches $fix) { 5525194f66fcSJoe Perches $fixed[$fixlinenr] =~ 55263705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 55273705ce5bSJoe Perches } 55280a920b5bSAndy Whitcroft } 55290a920b5bSAndy Whitcroft 5530f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 5531f5fe35ddSAndy Whitcroft# statements after the conditional. 5532170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 55333e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 55343e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 55353e469cdcSAndy Whitcroft if (!defined $stat); 5536170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 5537170d3a22SAndy Whitcroft $remain_next, $off_next); 5538170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 5539170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 5540170d3a22SAndy Whitcroft 5541170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 5542170d3a22SAndy Whitcroft # If the statement carries leading newlines, 5543170d3a22SAndy Whitcroft # then count those as offsets. 5544170d3a22SAndy Whitcroft my ($whitespace) = 5545170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 5546170d3a22SAndy Whitcroft my $offset = 5547170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 5548170d3a22SAndy Whitcroft 5549170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 5550170d3a22SAndy Whitcroft $offset} = 1; 5551170d3a22SAndy Whitcroft } 5552170d3a22SAndy Whitcroft } 5553170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 5554c11230f4SJoe Perches defined($stat) && defined($cond) && 5555170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 5556171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 5557481efd7bSJoe Perches my $fixed_assign_in_if = 0; 55588905a67cSAndy Whitcroft 5559b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 556065b64b3bSJoe Perches if (ERROR("ASSIGN_IN_IF", 556165b64b3bSJoe Perches "do not use assignment in if condition\n" . $herecurr) && 556265b64b3bSJoe Perches $fix && $perl_version_ok) { 556365b64b3bSJoe Perches if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) { 556465b64b3bSJoe Perches my $space = $1; 556565b64b3bSJoe Perches my $not = $2; 556665b64b3bSJoe Perches my $statement = $3; 556765b64b3bSJoe Perches my $assigned = $4; 556865b64b3bSJoe Perches my $test = $8; 556965b64b3bSJoe Perches my $against = $9; 557065b64b3bSJoe Perches my $brace = $15; 557165b64b3bSJoe Perches fix_delete_line($fixlinenr, $rawline); 557265b64b3bSJoe Perches fix_insert_line($fixlinenr, "$space$statement;"); 557365b64b3bSJoe Perches my $newline = "${space}if ("; 557465b64b3bSJoe Perches $newline .= '!' if defined($not); 557565b64b3bSJoe Perches $newline .= '(' if (defined $not && defined($test) && defined($against)); 557665b64b3bSJoe Perches $newline .= "$assigned"; 557765b64b3bSJoe Perches $newline .= " $test $against" if (defined($test) && defined($against)); 557865b64b3bSJoe Perches $newline .= ')' if (defined $not && defined($test) && defined($against)); 557965b64b3bSJoe Perches $newline .= ')'; 558065b64b3bSJoe Perches $newline .= " {" if (defined($brace)); 558165b64b3bSJoe Perches fix_insert_line($fixlinenr + 1, $newline); 5582481efd7bSJoe Perches $fixed_assign_in_if = 1; 558365b64b3bSJoe Perches } 558465b64b3bSJoe Perches } 55858905a67cSAndy Whitcroft } 55868905a67cSAndy Whitcroft 55878905a67cSAndy Whitcroft # Find out what is on the end of the line after the 55888905a67cSAndy Whitcroft # conditional. 5589773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 55908905a67cSAndy Whitcroft $s =~ s/\n.*//g; 559113214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 559253210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 559353210168SAndy Whitcroft $c !~ /}\s*while\s*/) 5594773647a0SAndy Whitcroft { 5595bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 5596bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 5597bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 559842bdf74cSHidetoshi Seto my $stat_real = ''; 5599bb44ad39SAndy Whitcroft 560042bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 560142bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 5602bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 5603bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 5604bb44ad39SAndy Whitcroft } 5605bb44ad39SAndy Whitcroft 5606481efd7bSJoe Perches if (ERROR("TRAILING_STATEMENTS", 5607481efd7bSJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real) && 5608481efd7bSJoe Perches !$fixed_assign_in_if && 5609481efd7bSJoe Perches $cond_lines == 0 && 5610481efd7bSJoe Perches $fix && $perl_version_ok && 5611481efd7bSJoe Perches $fixed[$fixlinenr] =~ /^\+(\s*)((?:if|while|for)\s*$balanced_parens)\s*(.*)$/) { 5612481efd7bSJoe Perches my $indent = $1; 5613481efd7bSJoe Perches my $test = $2; 5614481efd7bSJoe Perches my $rest = rtrim($4); 5615481efd7bSJoe Perches if ($rest =~ /;$/) { 5616481efd7bSJoe Perches $fixed[$fixlinenr] = "\+$indent$test"; 5617481efd7bSJoe Perches fix_insert_line($fixlinenr + 1, "$indent\t$rest"); 5618481efd7bSJoe Perches } 5619481efd7bSJoe Perches } 56208905a67cSAndy Whitcroft } 56218905a67cSAndy Whitcroft } 56228905a67cSAndy Whitcroft 562313214adfSAndy Whitcroft# Check for bitwise tests written as boolean 562413214adfSAndy Whitcroft if ($line =~ / 562513214adfSAndy Whitcroft (?: 562613214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 562713214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 562813214adfSAndy Whitcroft (?:\&\&|\|\|) 562913214adfSAndy Whitcroft | 563013214adfSAndy Whitcroft (?:\&\&|\|\|) 563113214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 563213214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 563313214adfSAndy Whitcroft )/x) 563413214adfSAndy Whitcroft { 5635000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 5636000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 563713214adfSAndy Whitcroft } 563813214adfSAndy Whitcroft 56398905a67cSAndy Whitcroft# if and else should not have general statements after it 564013214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 564113214adfSAndy Whitcroft my $s = $1; 564213214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 564313214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 5644000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5645000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 56460a920b5bSAndy Whitcroft } 564713214adfSAndy Whitcroft } 564839667782SAndy Whitcroft# if should not continue a brace 564939667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 5650000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5651048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 565239667782SAndy Whitcroft $herecurr); 565339667782SAndy Whitcroft } 5654a1080bf8SAndy Whitcroft# case and default should not have general statements after them 5655a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 5656a1080bf8SAndy Whitcroft $line !~ /\G(?: 56573fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 5658a1080bf8SAndy Whitcroft \s*return\s+ 5659a1080bf8SAndy Whitcroft )/xg) 5660a1080bf8SAndy Whitcroft { 5661000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5662000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 5663a1080bf8SAndy Whitcroft } 56640a920b5bSAndy Whitcroft 56650a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 56660a920b5bSAndy Whitcroft # indent level to be relevant to each other. 56678b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 56680a920b5bSAndy Whitcroft $previndent == $indent) { 56698b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 56708b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 56718b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 56728b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 56738b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 56748b8856f4SJoe Perches my $fixedline = $prevrawline; 56758b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 56768b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 56778b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 56788b8856f4SJoe Perches } 56798b8856f4SJoe Perches $fixedline = $rawline; 56808b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 56818b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 56828b8856f4SJoe Perches } 56830a920b5bSAndy Whitcroft } 56840a920b5bSAndy Whitcroft 56858b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 5686c2fdda0dSAndy Whitcroft $previndent == $indent) { 5687c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 5688c2fdda0dSAndy Whitcroft 5689c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 5690c2fdda0dSAndy Whitcroft # conditional. 5691773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 5692c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 5693c2fdda0dSAndy Whitcroft 5694c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 56958b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 56968b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 56978b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 56988b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 56998b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 57008b8856f4SJoe Perches my $fixedline = $prevrawline; 57018b8856f4SJoe Perches my $trailing = $rawline; 57028b8856f4SJoe Perches $trailing =~ s/^\+//; 57038b8856f4SJoe Perches $trailing = trim($trailing); 57048b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 57058b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 57068b8856f4SJoe Perches } 5707c2fdda0dSAndy Whitcroft } 5708c2fdda0dSAndy Whitcroft } 5709c2fdda0dSAndy Whitcroft 571095e2c602SJoe Perches#Specific variable tests 5711323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 5712323c1260SJoe Perches my $var = $1; 571395e2c602SJoe Perches 571495e2c602SJoe Perches#CamelCase 5715807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 5716be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 57174104a206SŁukasz Stelmach#Ignore some autogenerated defines and enum values 57184104a206SŁukasz Stelmach $var !~ /^(?:[A-Z]+_){1,5}[A-Z]{1,3}[a-z]/ && 571922735ce8SJoe Perches#Ignore Page<foo> variants 5720807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 5721d439e6a5SJoe Perches#Ignore SI style variants like nS, mV and dB 5722d439e6a5SJoe Perches#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE) 5723d439e6a5SJoe Perches $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ && 5724f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 5725f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 5726f858e23aSAntonio Borneo while ($var =~ m{\b($Ident)}g) { 57277e781f67SJoe Perches my $word = $1; 57287e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 5729d8b07710SJoe Perches if ($check) { 5730d8b07710SJoe Perches seed_camelcase_includes(); 5731d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 5732d8b07710SJoe Perches seed_camelcase_file($realfile); 5733d8b07710SJoe Perches $camelcase_file_seeded = 1; 5734d8b07710SJoe Perches } 5735d8b07710SJoe Perches } 57367e781f67SJoe Perches if (!defined $camelcase{$word}) { 57377e781f67SJoe Perches $camelcase{$word} = 1; 5738be79794bSJoe Perches CHK("CAMELCASE", 57397e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 57407e781f67SJoe Perches } 5741323c1260SJoe Perches } 5742323c1260SJoe Perches } 57433445686aSJoe Perches } 57440a920b5bSAndy Whitcroft 57450a920b5bSAndy Whitcroft#no spaces allowed after \ in define 5746d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 5747d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 5748d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 5749d5e616fcSJoe Perches $fix) { 5750194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 5751d5e616fcSJoe Perches } 57520a920b5bSAndy Whitcroft } 57530a920b5bSAndy Whitcroft 57540e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 57550e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 5756c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 5757e09dec48SAndy Whitcroft my $file = "$1.h"; 5758e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 5759e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 5760e09dec48SAndy Whitcroft $realfile ne $checkfile && 57617840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 5762c45dcabdSAndy Whitcroft { 57630e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 57640e212e0aSFabian Frederick if ($asminclude > 0) { 5765e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 5766000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 5767000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5768e09dec48SAndy Whitcroft } else { 5769000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 5770000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5771e09dec48SAndy Whitcroft } 57720a920b5bSAndy Whitcroft } 57730a920b5bSAndy Whitcroft } 57740e212e0aSFabian Frederick } 57750a920b5bSAndy Whitcroft 5776653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 5777653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 5778cf655043SAndy Whitcroft# in a known good container 5779b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 5780b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 5781d8aaf121SAndy Whitcroft my $ln = $linenr; 5782d8aaf121SAndy Whitcroft my $cnt = $realcnt; 5783c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 5784c45dcabdSAndy Whitcroft my $ctx = ''; 578508a2843eSJoe Perches my $has_flow_statement = 0; 578608a2843eSJoe Perches my $has_arg_concat = 0; 5787c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 5788f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 5789f74bd194SAndy Whitcroft $ctx = $dstat; 5790c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 5791a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 5792c45dcabdSAndy Whitcroft 579308a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 579462e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 579508a2843eSJoe Perches 5796f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 5797f59b64bfSJoe Perches my $define_args = $1; 5798f59b64bfSJoe Perches my $define_stmt = $dstat; 5799f59b64bfSJoe Perches my @def_args = (); 5800f59b64bfSJoe Perches 5801f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 5802f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 5803f59b64bfSJoe Perches $define_args =~ s/\s*//g; 58048c8c45cfSJoe Perches $define_args =~ s/\\\+?//g; 5805f59b64bfSJoe Perches @def_args = split(",", $define_args); 5806f59b64bfSJoe Perches } 5807f59b64bfSJoe Perches 5808292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 5809c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 5810c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 5811c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 5812c45dcabdSAndy Whitcroft 5813c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 58142e44e803SDwaipayan Ray while ($dstat =~ s/\([^\(\)]*\)/1u/ || 58152e44e803SDwaipayan Ray $dstat =~ s/\{[^\{\}]*\}/1u/ || 58162e44e803SDwaipayan Ray $dstat =~ s/.\[[^\[\]]*\]/1u/) 5817bf30d6edSAndy Whitcroft { 5818c45dcabdSAndy Whitcroft } 5819c45dcabdSAndy Whitcroft 5820342d3d2fSAntonio Borneo # Flatten any obvious string concatenation. 582133acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 582233acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 5823e45bab8eSAndy Whitcroft { 5824e45bab8eSAndy Whitcroft } 5825e45bab8eSAndy Whitcroft 582642e15293SJoe Perches # Make asm volatile uses seem like a generic function 582742e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 582842e15293SJoe Perches 5829c45dcabdSAndy Whitcroft my $exceptions = qr{ 5830c45dcabdSAndy Whitcroft $Declare| 5831c45dcabdSAndy Whitcroft module_param_named| 5832a0a0a7a9SKees Cook MODULE_PARM_DESC| 5833c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 5834c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 5835383099fdSAndy Whitcroft __typeof__\(| 583622fd2d3eSStefani Seibold union| 583722fd2d3eSStefani Seibold struct| 5838ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 58396b10df42SVladimir Zapolskiy ^\"|\"$| 58406b10df42SVladimir Zapolskiy ^\[ 5841c45dcabdSAndy Whitcroft }x; 58425eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 5843f59b64bfSJoe Perches 5844f59b64bfSJoe Perches $ctx =~ s/\n*$//; 5845f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 5846e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 5847f59b64bfSJoe Perches 5848f74bd194SAndy Whitcroft if ($dstat ne '' && 5849f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 5850f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 58513cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 5852356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5853f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 5854f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5855e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 585672f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 58572e44e803SDwaipayan Ray $dstat !~ /^while\s*$Constant\s*$Constant\s*$/ && # while (...) {...} 5858f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5859f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5860f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 58614e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5862f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5863c45dcabdSAndy Whitcroft { 5864e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5865e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5866e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5867e795556aSJoe Perches } elsif ($dstat =~ /;/) { 5868f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5869f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5870f74bd194SAndy Whitcroft } else { 5871000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 5872388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5873d8aaf121SAndy Whitcroft } 5874f59b64bfSJoe Perches 5875f59b64bfSJoe Perches } 58765207649bSJoe Perches 58775207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 58785207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 58795207649bSJoe Perches my $first = 1; 58805207649bSJoe Perches $define_stmt = ""; 58815207649bSJoe Perches foreach my $l (@stmt_array) { 58825207649bSJoe Perches $l =~ s/\\$//; 58835207649bSJoe Perches if ($first) { 58845207649bSJoe Perches $define_stmt = $l; 58855207649bSJoe Perches $first = 0; 58865207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 58875207649bSJoe Perches $define_stmt .= substr($l, 1); 58885207649bSJoe Perches } 58895207649bSJoe Perches } 58905207649bSJoe Perches $define_stmt =~ s/$;//g; 58915207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 58925207649bSJoe Perches $define_stmt = trim($define_stmt); 58935207649bSJoe Perches 5894f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5895f59b64bfSJoe Perches foreach my $arg (@def_args) { 5896f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 58979192d41aSJoe Perches next if ($arg =~ /^type$/i); 58987fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 58997b844345SVincent 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; 59007fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 59017fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 5902d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 5903f59b64bfSJoe Perches if ($use_cnt > 1) { 5904f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5905f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5906f59b64bfSJoe Perches } 59079192d41aSJoe Perches# check if any macro arguments may have other precedence issues 59087fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 59099192d41aSJoe Perches ((defined($1) && $1 ne ',') || 59109192d41aSJoe Perches (defined($2) && $2 ne ','))) { 59119192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 59129192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 59139192d41aSJoe Perches } 59140a920b5bSAndy Whitcroft } 59155023d347SJoe Perches 591608a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 591708a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 591808a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 591908a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 5920e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 592108a2843eSJoe Perches 592208a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 592308a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 592408a2843eSJoe Perches } 592508a2843eSJoe Perches 5926481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 59275023d347SJoe Perches 59285023d347SJoe Perches } else { 59295023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5930481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5931481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 59325023d347SJoe Perches $line =~ /^\+.*\\$/) { 59335023d347SJoe Perches WARN("LINE_CONTINUATIONS", 59345023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 59355023d347SJoe Perches } 5936653d4876SAndy Whitcroft } 59370a920b5bSAndy Whitcroft 5938b13edf7fSJoe Perches# do {} while (0) macro tests: 5939b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5940b13edf7fSJoe Perches# macro should not end with a semicolon 59415b57980dSJoe Perches if ($perl_version_ok && 5942b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5943b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5944b13edf7fSJoe Perches my $ln = $linenr; 5945b13edf7fSJoe Perches my $cnt = $realcnt; 5946b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5947b13edf7fSJoe Perches my $ctx = ''; 5948b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5949b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5950b13edf7fSJoe Perches $ctx = $dstat; 5951b13edf7fSJoe Perches 5952b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 59531b36b201SJoe Perches $dstat =~ s/$;/ /g; 5954b13edf7fSJoe Perches 5955b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5956b13edf7fSJoe Perches my $stmts = $2; 5957b13edf7fSJoe Perches my $semis = $3; 5958b13edf7fSJoe Perches 5959b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5960b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5961e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5962b13edf7fSJoe Perches 5963ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5964ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5965b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5966b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5967b13edf7fSJoe Perches } 5968b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5969b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5970b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5971b13edf7fSJoe Perches } 5972f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5973f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5974f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5975e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5976f5ef95b1SJoe Perches 5977f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5978f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5979b13edf7fSJoe Perches } 5980b13edf7fSJoe Perches } 5981b13edf7fSJoe Perches 5982f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 598313214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 598413214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5985cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 598613214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5987cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5988cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5989aad4f614SJoe Perches my @allowed = (); 5990aad4f614SJoe Perches my $allow = 0; 599113214adfSAndy Whitcroft my $seen = 0; 5992773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5993cf655043SAndy Whitcroft my $ln = $linenr - 1; 599413214adfSAndy Whitcroft for my $chunk (@chunks) { 599513214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 599613214adfSAndy Whitcroft 5997773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5998773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5999773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 6000773647a0SAndy Whitcroft 6001aad4f614SJoe Perches $allowed[$allow] = 0; 6002773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 6003773647a0SAndy Whitcroft 6004773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 6005773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 6006773647a0SAndy Whitcroft 6007773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 6008cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 6009cf655043SAndy Whitcroft 6010773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 601113214adfSAndy Whitcroft 601213214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 601313214adfSAndy Whitcroft 6014aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 6015cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 6016cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 6017aad4f614SJoe Perches $allowed[$allow] = 1; 601813214adfSAndy Whitcroft } 601913214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 6020cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 6021aad4f614SJoe Perches $allowed[$allow] = 1; 602213214adfSAndy Whitcroft } 6023cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 6024cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 6025aad4f614SJoe Perches $allowed[$allow] = 1; 602613214adfSAndy Whitcroft } 6027aad4f614SJoe Perches $allow++; 602813214adfSAndy Whitcroft } 6029aad4f614SJoe Perches if ($seen) { 6030aad4f614SJoe Perches my $sum_allowed = 0; 6031aad4f614SJoe Perches foreach (@allowed) { 6032aad4f614SJoe Perches $sum_allowed += $_; 6033aad4f614SJoe Perches } 6034aad4f614SJoe Perches if ($sum_allowed == 0) { 6035000d1cc1SJoe Perches WARN("BRACES", 6036000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 6037aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 6038aad4f614SJoe Perches $seen != $allow) { 6039aad4f614SJoe Perches CHK("BRACES", 6040aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 6041aad4f614SJoe Perches } 604213214adfSAndy Whitcroft } 604313214adfSAndy Whitcroft } 604413214adfSAndy Whitcroft } 6045773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 604613214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 6047cf655043SAndy Whitcroft my $allowed = 0; 6048f0a594c1SAndy Whitcroft 6049cf655043SAndy Whitcroft # Check the pre-context. 6050cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 6051cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 6052cf655043SAndy Whitcroft $allowed = 1; 6053f0a594c1SAndy Whitcroft } 6054773647a0SAndy Whitcroft 6055773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 6056773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 6057773647a0SAndy Whitcroft 6058cf655043SAndy Whitcroft # Check the condition. 6059cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 6060773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 6061cf655043SAndy Whitcroft if (defined $cond) { 6062773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 6063cf655043SAndy Whitcroft } 6064cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 6065cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 6066cf655043SAndy Whitcroft $allowed = 1; 6067cf655043SAndy Whitcroft } 6068cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 6069cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 6070cf655043SAndy Whitcroft $allowed = 1; 6071cf655043SAndy Whitcroft } 6072cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 6073cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 6074cf655043SAndy Whitcroft $allowed = 1; 6075cf655043SAndy Whitcroft } 6076cf655043SAndy Whitcroft # Check the post-context. 6077cf655043SAndy Whitcroft if (defined $chunks[1]) { 6078cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 6079cf655043SAndy Whitcroft if (defined $cond) { 6080773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 6081cf655043SAndy Whitcroft } 6082cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 6083cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 6084cf655043SAndy Whitcroft $allowed = 1; 6085cf655043SAndy Whitcroft } 6086cf655043SAndy Whitcroft } 6087cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 6088f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 6089e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6090cf655043SAndy Whitcroft 6091000d1cc1SJoe Perches WARN("BRACES", 6092000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 6093f0a594c1SAndy Whitcroft } 6094f0a594c1SAndy Whitcroft } 6095f0a594c1SAndy Whitcroft 6096e4c5babdSJoe Perches# check for single line unbalanced braces 609795330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 609895330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 6099e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 6100e4c5babdSJoe Perches } 6101e4c5babdSJoe Perches 61020979ae66SJoe Perches# check for unnecessary blank lines around braces 610377b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 6104f8e58219SJoe Perches if (CHK("BRACES", 6105f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 6106f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 6107f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 6108f8e58219SJoe Perches } 61090979ae66SJoe Perches } 611077b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 6111f8e58219SJoe Perches if (CHK("BRACES", 6112f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 6113f8e58219SJoe Perches $fix) { 6114f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 6115f8e58219SJoe Perches } 61160979ae66SJoe Perches } 61170979ae66SJoe Perches 61184a0df2efSAndy Whitcroft# no volatiles please 61196c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 61206c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 6121000d1cc1SJoe Perches WARN("VOLATILE", 61228c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 61234a0df2efSAndy Whitcroft } 61244a0df2efSAndy Whitcroft 61255e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 61265e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 61275e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 61285e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 612933acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 61305e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 61315e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 61325e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 61335e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 61345e4f6ba5SJoe Perches $fix && 61355e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 61365e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 61375e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 61385e4f6ba5SJoe Perches my $comma_close = ""; 61395e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 61405e4f6ba5SJoe Perches $comma_close = $1; 61415e4f6ba5SJoe Perches } 61425e4f6ba5SJoe Perches 61435e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 61445e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 61455e4f6ba5SJoe Perches my $fixedline = $prevrawline; 61465e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 61475e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 61485e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 61495e4f6ba5SJoe Perches $fixedline = $rawline; 61505e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 61515e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 61525e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 61535e4f6ba5SJoe Perches } 61545e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 61555e4f6ba5SJoe Perches } 61565e4f6ba5SJoe Perches } 61575e4f6ba5SJoe Perches 61585e4f6ba5SJoe Perches# check for missing a space in a string concatenation 61595e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 61605e4f6ba5SJoe Perches WARN('MISSING_SPACE', 61615e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 61625e4f6ba5SJoe Perches } 61635e4f6ba5SJoe Perches 616477cb8546SJoe Perches# check for an embedded function name in a string when the function is known 6165e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 6166e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 6167e4b7d309SJoe Perches# function declarations 616877cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 616977cb8546SJoe Perches defined($context_function) && 6170e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 6171e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 617277cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 6173e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 617477cb8546SJoe Perches } 617577cb8546SJoe Perches 6176adb2da82SJoe Perches# check for unnecessary function tracing like uses 6177adb2da82SJoe Perches# This does not use $logFunctions because there are many instances like 6178adb2da82SJoe Perches# 'dprintk(FOO, "%s()\n", __func__);' which do not match $logFunctions 6179adb2da82SJoe Perches if ($rawline =~ /^\+.*\([^"]*"$tracing_logging_tags{0,3}%s(?:\s*\(\s*\)\s*)?$tracing_logging_tags{0,3}(?:\\n)?"\s*,\s*__func__\s*\)\s*;/) { 6180adb2da82SJoe Perches if (WARN("TRACING_LOGGING", 6181adb2da82SJoe Perches "Unnecessary ftrace-like logging - prefer using ftrace\n" . $herecurr) && 6182adb2da82SJoe Perches $fix) { 6183adb2da82SJoe Perches fix_delete_line($fixlinenr, $rawline); 6184adb2da82SJoe Perches } 6185adb2da82SJoe Perches } 6186adb2da82SJoe Perches 61875e4f6ba5SJoe Perches# check for spaces before a quoted newline 61885e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 61895e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 61905e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 61915e4f6ba5SJoe Perches $fix) { 61925e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 61935e4f6ba5SJoe Perches } 61945e4f6ba5SJoe Perches 61955e4f6ba5SJoe Perches } 61965e4f6ba5SJoe Perches 6197f17dba4fSJoe Perches# concatenated string without spaces between elements 6198d2af5aa6SJoe Perches if ($line =~ /$String[A-Z_]/ || 6199d2af5aa6SJoe Perches ($line =~ /([A-Za-z0-9_]+)$String/ && $1 !~ /^[Lu]$/)) { 620079682c0cSJoe Perches if (CHK("CONCATENATED_STRING", 620179682c0cSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr) && 620279682c0cSJoe Perches $fix) { 620379682c0cSJoe Perches while ($line =~ /($String)/g) { 620479682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 620579682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/; 620679682c0cSJoe Perches $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/; 620779682c0cSJoe Perches } 620879682c0cSJoe Perches } 6209f17dba4fSJoe Perches } 6210f17dba4fSJoe Perches 621190ad30e5SJoe Perches# uncoalesced string fragments 6212d2af5aa6SJoe Perches if ($line =~ /$String\s*[Lu]?"/) { 621379682c0cSJoe Perches if (WARN("STRING_FRAGMENTS", 621479682c0cSJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr) && 621579682c0cSJoe Perches $fix) { 621679682c0cSJoe Perches while ($line =~ /($String)(?=\s*")/g) { 621779682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 621879682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e; 621979682c0cSJoe Perches } 622079682c0cSJoe Perches } 622190ad30e5SJoe Perches } 622290ad30e5SJoe Perches 6223522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 6224522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 6225522b837cSAlexey Dobriyan my $show_Z = 1; 62265e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 6227522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 62285e4f6ba5SJoe Perches $string =~ s/%%/__/g; 6229522b837cSAlexey Dobriyan # check for %L 6230522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 62315e4f6ba5SJoe Perches WARN("PRINTF_L", 6232522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 6233522b837cSAlexey Dobriyan $show_L = 0; 62345e4f6ba5SJoe Perches } 6235522b837cSAlexey Dobriyan # check for %Z 6236522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 6237522b837cSAlexey Dobriyan WARN("PRINTF_Z", 6238522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 6239522b837cSAlexey Dobriyan $show_Z = 0; 6240522b837cSAlexey Dobriyan } 6241522b837cSAlexey Dobriyan # check for 0x<decimal> 6242522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 6243522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 62446e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 62456e300757SJoe Perches } 62465e4f6ba5SJoe Perches } 62475e4f6ba5SJoe Perches 62485e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 62493f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 62505e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 62515e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 62525e4f6ba5SJoe Perches } 62535e4f6ba5SJoe Perches 625400df344fSAndy Whitcroft# warn about #if 0 6255c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 625660f89010SPrakruthi Deepak Heragu WARN("IF_0", 625760f89010SPrakruthi Deepak Heragu "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr); 625860f89010SPrakruthi Deepak Heragu } 625960f89010SPrakruthi Deepak Heragu 626060f89010SPrakruthi Deepak Heragu# warn about #if 1 626160f89010SPrakruthi Deepak Heragu if ($line =~ /^.\s*\#\s*if\s+1\b/) { 626260f89010SPrakruthi Deepak Heragu WARN("IF_1", 626360f89010SPrakruthi Deepak Heragu "Consider removing the #if 1 and its #endif\n" . $herecurr); 62644a0df2efSAndy Whitcroft } 62654a0df2efSAndy Whitcroft 626603df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 626703df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 6268100425deSJoe Perches my $tested = quotemeta($1); 6269100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 6270100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 6271100425deSJoe Perches my $func = $1; 6272100425deSJoe Perches if (WARN('NEEDLESS_IF', 6273100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 6274100425deSJoe Perches $fix) { 6275100425deSJoe Perches my $do_fix = 1; 6276100425deSJoe Perches my $leading_tabs = ""; 6277100425deSJoe Perches my $new_leading_tabs = ""; 6278100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 6279100425deSJoe Perches $leading_tabs = $1; 6280100425deSJoe Perches } else { 6281100425deSJoe Perches $do_fix = 0; 6282100425deSJoe Perches } 6283100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 6284100425deSJoe Perches $new_leading_tabs = $1; 6285100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 6286100425deSJoe Perches $do_fix = 0; 6287100425deSJoe Perches } 6288100425deSJoe Perches } else { 6289100425deSJoe Perches $do_fix = 0; 6290100425deSJoe Perches } 6291100425deSJoe Perches if ($do_fix) { 6292100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 6293100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 6294100425deSJoe Perches } 6295100425deSJoe Perches } 62964c432a8fSGreg Kroah-Hartman } 62974c432a8fSGreg Kroah-Hartman } 6298f0a594c1SAndy Whitcroft 6299ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 6300ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 6301ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 6302ebfdc409SJoe Perches (defined $1 || defined $3) && 6303ebfdc409SJoe Perches $linenr > 3) { 6304ebfdc409SJoe Perches my $testval = $2; 6305ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 6306ebfdc409SJoe Perches 6307ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 6308ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 6309ebfdc409SJoe Perches 6310e29a70f1SJoe Perches if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ && 6311e29a70f1SJoe Perches $s !~ /\b__GFP_NOWARN\b/ ) { 6312ebfdc409SJoe Perches WARN("OOM_MESSAGE", 6313ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 6314ebfdc409SJoe Perches } 6315ebfdc409SJoe Perches } 6316ebfdc409SJoe Perches 6317f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 6318dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 6319f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 6320f78d98f6SJoe Perches my $level = $1; 6321f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 6322f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 6323f78d98f6SJoe Perches $fix) { 6324f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 6325f78d98f6SJoe Perches } 6326f78d98f6SJoe Perches } 6327f78d98f6SJoe Perches 632845c55e92SJoe Perches# check for logging continuations 632945c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 633045c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 633145c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 633245c55e92SJoe Perches } 633345c55e92SJoe Perches 633470eb2275SDwaipayan Ray# check for unnecessary use of %h[xudi] and %hh[xudi] in logging functions 633570eb2275SDwaipayan Ray if (defined $stat && 633670eb2275SDwaipayan Ray $line =~ /\b$logFunctions\s*\(/ && 633770eb2275SDwaipayan Ray index($stat, '"') >= 0) { 633870eb2275SDwaipayan Ray my $lc = $stat =~ tr@\n@@; 633970eb2275SDwaipayan Ray $lc = $lc + $linenr; 634070eb2275SDwaipayan Ray my $stat_real = get_stat_real($linenr, $lc); 634170eb2275SDwaipayan Ray pos($stat_real) = index($stat_real, '"'); 634270eb2275SDwaipayan Ray while ($stat_real =~ /[^\"%]*(%[\#\d\.\*\-]*(h+)[idux])/g) { 634370eb2275SDwaipayan Ray my $pspec = $1; 634470eb2275SDwaipayan Ray my $h = $2; 634570eb2275SDwaipayan Ray my $lineoff = substr($stat_real, 0, $-[1]) =~ tr@\n@@; 634670eb2275SDwaipayan Ray if (WARN("UNNECESSARY_MODIFIER", 634770eb2275SDwaipayan Ray "Integer promotion: Using '$h' in '$pspec' is unnecessary\n" . "$here\n$stat_real\n") && 634870eb2275SDwaipayan Ray $fix && $fixed[$fixlinenr + $lineoff] =~ /^\+/) { 634970eb2275SDwaipayan Ray my $nspec = $pspec; 635070eb2275SDwaipayan Ray $nspec =~ s/h//g; 635170eb2275SDwaipayan Ray $fixed[$fixlinenr + $lineoff] =~ s/\Q$pspec\E/$nspec/; 635270eb2275SDwaipayan Ray } 635370eb2275SDwaipayan Ray } 635470eb2275SDwaipayan Ray } 635570eb2275SDwaipayan Ray 6356abb08a53SJoe Perches# check for mask then right shift without a parentheses 63575b57980dSJoe Perches if ($perl_version_ok && 6358abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 6359abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 6360abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 6361abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 6362abb08a53SJoe Perches } 6363abb08a53SJoe Perches 6364b75ac618SJoe Perches# check for pointer comparisons to NULL 63655b57980dSJoe Perches if ($perl_version_ok) { 6366b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 6367b75ac618SJoe Perches my $val = $1; 6368b75ac618SJoe Perches my $equal = "!"; 6369b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 6370b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 6371b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 6372b75ac618SJoe Perches $fix) { 6373b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 6374b75ac618SJoe Perches } 6375b75ac618SJoe Perches } 6376b75ac618SJoe Perches } 6377b75ac618SJoe Perches 63788716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 63798716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 63808716de38SJoe Perches my $attr = $1; 63818716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 63828716de38SJoe Perches my $ptr = $1; 63838716de38SJoe Perches my $var = $2; 63848716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 63858716de38SJoe Perches ERROR("MISPLACED_INIT", 63868716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 63878716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 63888716de38SJoe Perches WARN("MISPLACED_INIT", 63898716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 63908716de38SJoe Perches $fix) { 6391194f66fcSJoe 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; 63928716de38SJoe Perches } 63938716de38SJoe Perches } 63948716de38SJoe Perches } 63958716de38SJoe Perches 6396e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 6397e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 6398e970b884SJoe Perches my $attr = $1; 6399e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 6400e970b884SJoe Perches my $attr_prefix = $1; 6401e970b884SJoe Perches my $attr_type = $2; 6402e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 6403e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 6404e970b884SJoe Perches $fix) { 6405194f66fcSJoe Perches $fixed[$fixlinenr] =~ 6406e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 6407e970b884SJoe Perches } 6408e970b884SJoe Perches } 6409e970b884SJoe Perches 6410e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 6411e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 6412e970b884SJoe Perches my $attr = $1; 6413e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 6414e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 6415e970b884SJoe Perches $fix) { 6416194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 6417e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 6418e970b884SJoe Perches $lead = rtrim($1); 6419e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 6420e970b884SJoe Perches $lead = "${lead}const "; 6421194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 6422e970b884SJoe Perches } 6423e970b884SJoe Perches } 6424e970b884SJoe Perches 6425c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 6426c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 6427c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 6428c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 6429c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 6430c17893c7SJoe Perches $fix) { 6431c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 6432c17893c7SJoe Perches } 6433c17893c7SJoe Perches } 6434c17893c7SJoe Perches 6435fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 6436fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 6437fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 6438fbdb8138SJoe Perches my $constant_func = $1; 6439fbdb8138SJoe Perches my $func = $constant_func; 6440fbdb8138SJoe Perches $func =~ s/^__constant_//; 6441fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 6442fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 6443fbdb8138SJoe Perches $fix) { 6444194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 6445fbdb8138SJoe Perches } 6446fbdb8138SJoe Perches } 6447fbdb8138SJoe Perches 64481a15a250SPatrick Pannuto# prefer usleep_range over udelay 644937581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 645043c1d77cSJoe Perches my $delay = $1; 64511a15a250SPatrick Pannuto # ignore udelay's < 10, however 645243c1d77cSJoe Perches if (! ($delay < 10) ) { 6453000d1cc1SJoe Perches CHK("USLEEP_RANGE", 6454458f69efSMauro Carvalho Chehab "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr); 645543c1d77cSJoe Perches } 645643c1d77cSJoe Perches if ($delay > 2000) { 645743c1d77cSJoe Perches WARN("LONG_UDELAY", 645843c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 64591a15a250SPatrick Pannuto } 64601a15a250SPatrick Pannuto } 64611a15a250SPatrick Pannuto 646209ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 646309ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 646409ef8725SPatrick Pannuto if ($1 < 20) { 6465000d1cc1SJoe Perches WARN("MSLEEP", 6466458f69efSMauro Carvalho Chehab "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr); 646709ef8725SPatrick Pannuto } 646809ef8725SPatrick Pannuto } 646909ef8725SPatrick Pannuto 647036ec1939SJoe Perches# check for comparisons of jiffies 647136ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 647236ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 647336ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 647436ec1939SJoe Perches } 647536ec1939SJoe Perches 64769d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 64779d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 64789d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 64799d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 64809d7a34a5SJoe Perches } 64819d7a34a5SJoe Perches 648200df344fSAndy Whitcroft# warn about #ifdefs in C files 6483c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 648400df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 648500df344fSAndy Whitcroft# print "$herecurr"; 648600df344fSAndy Whitcroft# $clean = 0; 648700df344fSAndy Whitcroft# } 648800df344fSAndy Whitcroft 648922f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 6490c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 64913705ce5bSJoe Perches if (ERROR("SPACING", 64923705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 64933705ce5bSJoe Perches $fix) { 6494194f66fcSJoe Perches $fixed[$fixlinenr] =~ 64953705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 64963705ce5bSJoe Perches } 64973705ce5bSJoe Perches 649822f2a2efSAndy Whitcroft } 649922f2a2efSAndy Whitcroft 65004a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 6501171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 6502171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 65034a0df2efSAndy Whitcroft my $which = $1; 65044a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 6505000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 6506000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 65074a0df2efSAndy Whitcroft } 65084a0df2efSAndy Whitcroft } 65094a0df2efSAndy Whitcroft# check for memory barriers without a comment. 6510402c2553SMichael S. Tsirkin 6511402c2553SMichael S. Tsirkin my $barriers = qr{ 6512402c2553SMichael S. Tsirkin mb| 6513402c2553SMichael S. Tsirkin rmb| 6514ad83ec6cSWill Deacon wmb 6515402c2553SMichael S. Tsirkin }x; 6516402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 6517402c2553SMichael S. Tsirkin mb__before_atomic| 6518402c2553SMichael S. Tsirkin mb__after_atomic| 6519402c2553SMichael S. Tsirkin store_release| 6520402c2553SMichael S. Tsirkin load_acquire| 6521402c2553SMichael S. Tsirkin store_mb| 6522402c2553SMichael S. Tsirkin (?:$barriers) 6523402c2553SMichael S. Tsirkin }x; 6524402c2553SMichael S. Tsirkin my $all_barriers = qr{ 6525402c2553SMichael S. Tsirkin (?:$barriers)| 652643e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 652743e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 6528402c2553SMichael S. Tsirkin }x; 6529402c2553SMichael S. Tsirkin 6530402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 65314a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 6532c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 6533000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 65344a0df2efSAndy Whitcroft } 65354a0df2efSAndy Whitcroft } 65363ad81779SPaul E. McKenney 6537f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 6538f4073b0fSMichael S. Tsirkin 6539f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 6540f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 6541f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 6542f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 6543f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 6544f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 6545f4073b0fSMichael S. Tsirkin } 6546f4073b0fSMichael S. Tsirkin 6547cb426e99SJoe Perches# check for waitqueue_active without a comment. 6548cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 6549cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 6550cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 6551cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 6552cb426e99SJoe Perches } 6553cb426e99SJoe Perches } 65543ad81779SPaul E. McKenney 65555099a722SMarco Elver# check for data_race without a comment. 65565099a722SMarco Elver if ($line =~ /\bdata_race\s*\(/) { 65575099a722SMarco Elver if (!ctx_has_comment($first_line, $linenr)) { 65585099a722SMarco Elver WARN("DATA_RACE", 65595099a722SMarco Elver "data_race without comment\n" . $herecurr); 65605099a722SMarco Elver } 65615099a722SMarco Elver } 65625099a722SMarco Elver 65634a0df2efSAndy Whitcroft# check of hardware specific defines 6564c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 6565000d1cc1SJoe Perches CHK("ARCH_DEFINES", 6566000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 65670a920b5bSAndy Whitcroft } 6568653d4876SAndy Whitcroft 6569596ed45bSJoe Perches# check that the storage class is not after a type 6570596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 6571000d1cc1SJoe Perches WARN("STORAGE_CLASS", 6572596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 6573596ed45bSJoe Perches } 6574596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 6575596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 6576596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 6577596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 6578596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 6579596ed45bSJoe Perches WARN("STORAGE_CLASS", 6580596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 6581d4977c78STobias Klauser } 6582d4977c78STobias Klauser 6583de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 6584de7d4f0eSAndy Whitcroft# storage class and type. 65859c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 65869c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 6587000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 6588000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 6589de7d4f0eSAndy Whitcroft } 6590de7d4f0eSAndy Whitcroft 65918905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 65922b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 65932b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 6594d5e616fcSJoe Perches if (WARN("INLINE", 6595d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 6596d5e616fcSJoe Perches $fix) { 6597194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 6598d5e616fcSJoe Perches 6599d5e616fcSJoe Perches } 66008905a67cSAndy Whitcroft } 66018905a67cSAndy Whitcroft 66027ebe1d17SDwaipayan Ray# Check for compiler attributes 66032b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 66047ebe1d17SDwaipayan Ray $rawline =~ /\b__attribute__\s*\(\s*($balanced_parens)\s*\)/) { 66057ebe1d17SDwaipayan Ray my $attr = $1; 66067ebe1d17SDwaipayan Ray $attr =~ s/\s*\(\s*(.*)\)\s*/$1/; 66077ebe1d17SDwaipayan Ray 66087ebe1d17SDwaipayan Ray my %attr_list = ( 66090830aab0SJoe Perches "alias" => "__alias", 66107ebe1d17SDwaipayan Ray "aligned" => "__aligned", 66117ebe1d17SDwaipayan Ray "always_inline" => "__always_inline", 66127ebe1d17SDwaipayan Ray "assume_aligned" => "__assume_aligned", 66137ebe1d17SDwaipayan Ray "cold" => "__cold", 66147ebe1d17SDwaipayan Ray "const" => "__attribute_const__", 66157ebe1d17SDwaipayan Ray "copy" => "__copy", 66167ebe1d17SDwaipayan Ray "designated_init" => "__designated_init", 66177ebe1d17SDwaipayan Ray "externally_visible" => "__visible", 66187ebe1d17SDwaipayan Ray "format" => "printf|scanf", 66197ebe1d17SDwaipayan Ray "gnu_inline" => "__gnu_inline", 66207ebe1d17SDwaipayan Ray "malloc" => "__malloc", 66217ebe1d17SDwaipayan Ray "mode" => "__mode", 66227ebe1d17SDwaipayan Ray "no_caller_saved_registers" => "__no_caller_saved_registers", 66237ebe1d17SDwaipayan Ray "noclone" => "__noclone", 66247ebe1d17SDwaipayan Ray "noinline" => "noinline", 66257ebe1d17SDwaipayan Ray "nonstring" => "__nonstring", 66267ebe1d17SDwaipayan Ray "noreturn" => "__noreturn", 66277ebe1d17SDwaipayan Ray "packed" => "__packed", 66287ebe1d17SDwaipayan Ray "pure" => "__pure", 6629339f29d9SJoe Perches "section" => "__section", 66300830aab0SJoe Perches "used" => "__used", 66310830aab0SJoe Perches "weak" => "__weak" 66327ebe1d17SDwaipayan Ray ); 66337ebe1d17SDwaipayan Ray 66347ebe1d17SDwaipayan Ray while ($attr =~ /\s*(\w+)\s*(${balanced_parens})?/g) { 6635339f29d9SJoe Perches my $orig_attr = $1; 66367ebe1d17SDwaipayan Ray my $params = ''; 66377ebe1d17SDwaipayan Ray $params = $2 if defined($2); 6638339f29d9SJoe Perches my $curr_attr = $orig_attr; 66397ebe1d17SDwaipayan Ray $curr_attr =~ s/^[\s_]+|[\s_]+$//g; 66407ebe1d17SDwaipayan Ray if (exists($attr_list{$curr_attr})) { 6641339f29d9SJoe Perches my $new = $attr_list{$curr_attr}; 66427ebe1d17SDwaipayan Ray if ($curr_attr eq "format" && $params) { 66437ebe1d17SDwaipayan Ray $params =~ /^\s*\(\s*(\w+)\s*,\s*(.*)/; 6644339f29d9SJoe Perches $new = "__$1\($2"; 66457ebe1d17SDwaipayan Ray } else { 6646339f29d9SJoe Perches $new = "$new$params"; 66477ebe1d17SDwaipayan Ray } 66487ebe1d17SDwaipayan Ray if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", 6649339f29d9SJoe Perches "Prefer $new over __attribute__(($orig_attr$params))\n" . $herecurr) && 66507ebe1d17SDwaipayan Ray $fix) { 6651339f29d9SJoe Perches my $remove = "\Q$orig_attr\E" . '\s*' . "\Q$params\E" . '(?:\s*,\s*)?'; 6652339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/$remove//; 6653339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__/$new __attribute__/; 6654339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/\}\Q$new\E/} $new/; 6655339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/ __attribute__\s*\(\s*\(\s*\)\s*\)//; 66567ebe1d17SDwaipayan Ray } 665739b7e287SJoe Perches } 6658462811d9SJoe Perches } 6659462811d9SJoe Perches 66607ebe1d17SDwaipayan Ray # Check for __attribute__ unused, prefer __always_unused or __maybe_unused 66617ebe1d17SDwaipayan Ray if ($attr =~ /^_*unused/) { 66627ebe1d17SDwaipayan Ray WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", 66637ebe1d17SDwaipayan Ray "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr); 6664d5e616fcSJoe Perches } 66656061d949SJoe Perches } 66666061d949SJoe Perches 6667619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 66685b57980dSJoe Perches if ($perl_version_ok && 6669619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 6670619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 6671619a908aSJoe Perches $line =~ /\b__weak\b/)) { 6672619a908aSJoe Perches ERROR("WEAK_DECLARATION", 6673619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 6674619a908aSJoe Perches } 6675619a908aSJoe Perches 6676fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 6677e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 6678fd39f904STomas Winkler $realfile !~ m@\btools/@ && 6679e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 6680e6176fa4SJoe Perches my $type = $1; 6681e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 6682e6176fa4SJoe Perches $type = $1; 6683e6176fa4SJoe Perches my $kernel_type = 'u'; 6684e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 6685e6176fa4SJoe Perches $type =~ /(\d+)/; 6686e6176fa4SJoe Perches $kernel_type .= $1; 6687e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 6688e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 6689e6176fa4SJoe Perches $fix) { 6690e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 6691e6176fa4SJoe Perches } 6692e6176fa4SJoe Perches } 6693e6176fa4SJoe Perches } 6694e6176fa4SJoe Perches 6695938224b5SJoe Perches# check for cast of C90 native int or longer types constants 6696938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 6697938224b5SJoe Perches my $cast = $1; 6698938224b5SJoe Perches my $const = $2; 6699938224b5SJoe Perches my $suffix = ""; 6700938224b5SJoe Perches my $newconst = $const; 6701938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 6702938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 6703938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 6704938224b5SJoe Perches $suffix .= 'LL'; 6705938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 6706938224b5SJoe Perches $suffix .= 'L'; 6707938224b5SJoe Perches } 67080972b8bfSJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 67090972b8bfSJoe Perches "Unnecessary typecast of c90 int constant - '$cast$const' could be '$const$suffix'\n" . $herecurr) && 67100972b8bfSJoe Perches $fix) { 6711938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 6712938224b5SJoe Perches } 6713938224b5SJoe Perches } 6714938224b5SJoe Perches 67158f53a9b8SJoe Perches# check for sizeof(&) 67168f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 6717000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 6718000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 67198f53a9b8SJoe Perches } 67208f53a9b8SJoe Perches 672166c80b60SJoe Perches# check for sizeof without parenthesis 672266c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 6723d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 6724d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 6725d5e616fcSJoe Perches $fix) { 6726194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 6727d5e616fcSJoe Perches } 672866c80b60SJoe Perches } 672966c80b60SJoe Perches 673088982feaSJoe Perches# check for struct spinlock declarations 673188982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 673288982feaSJoe Perches WARN("USE_SPINLOCK_T", 673388982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 673488982feaSJoe Perches } 673588982feaSJoe Perches 6736a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 673706668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 6738a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 6739caac1d5fSHeba Aamer $fmt =~ s/%%//g; 6740caac1d5fSHeba Aamer if ($fmt !~ /%/) { 6741d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 6742d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 6743d5e616fcSJoe Perches $fix) { 6744194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 6745d5e616fcSJoe Perches } 6746a6962d72SJoe Perches } 6747a6962d72SJoe Perches } 6748a6962d72SJoe Perches 67490b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 67505b57980dSJoe Perches if ($perl_version_ok && 67510b523769SJoe Perches defined $stat && 67520b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 67530b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 6754e3c6bc95STobin C. Harding my $stat_real; 6755e3c6bc95STobin C. Harding 67560b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 67570b523769SJoe Perches $lc = $lc + $linenr; 67580b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 6759ffe07513SJoe Perches my $specifier; 6760ffe07513SJoe Perches my $extension; 67613bd32d6aSSakari Ailus my $qualifier; 6762ffe07513SJoe Perches my $bad_specifier = ""; 67630b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 67640b523769SJoe Perches $fmt =~ s/%%//g; 6765e3c6bc95STobin C. Harding 67663bd32d6aSSakari Ailus while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) { 6767e3c6bc95STobin C. Harding $specifier = $1; 6768e3c6bc95STobin C. Harding $extension = $2; 67693bd32d6aSSakari Ailus $qualifier = $3; 6770af612e43SSakari Ailus if ($extension !~ /[4SsBKRraEehMmIiUDdgVCbGNOxtf]/ || 67713bd32d6aSSakari Ailus ($extension eq "f" && 6772af612e43SSakari Ailus defined $qualifier && $qualifier !~ /^w/) || 6773af612e43SSakari Ailus ($extension eq "4" && 6774af612e43SSakari Ailus defined $qualifier && $qualifier !~ /^cc/)) { 6775e3c6bc95STobin C. Harding $bad_specifier = $specifier; 67760b523769SJoe Perches last; 67770b523769SJoe Perches } 6778e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 6779e3c6bc95STobin C. Harding if (!defined($stat_real)) { 6780e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 67810b523769SJoe Perches } 6782e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 6783e3c6bc95STobin 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"); 6784e3c6bc95STobin C. Harding } 6785e3c6bc95STobin C. Harding } 6786e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 67872a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 67881df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 67891df7338aSSergey Senozhatsky my $use = ""; 6790e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 67911df7338aSSergey Senozhatsky $use = " - use %pS instead"; 6792e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 67931df7338aSSergey Senozhatsky } 67942a9f9d85STobin C. Harding 67950b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 6796e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 6797e3c6bc95STobin C. Harding } 67980b523769SJoe Perches } 67990b523769SJoe Perches } 68000b523769SJoe Perches 6801554e165cSAndy Whitcroft# Check for misused memsets 68025b57980dSJoe Perches if ($perl_version_ok && 6803d1fe9c09SJoe Perches defined $stat && 68049e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 6805554e165cSAndy Whitcroft 6806d7c76ba7SJoe Perches my $ms_addr = $2; 6807d1fe9c09SJoe Perches my $ms_val = $7; 6808d1fe9c09SJoe Perches my $ms_size = $12; 6809d7c76ba7SJoe Perches 6810554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 6811554e165cSAndy Whitcroft ERROR("MEMSET", 6812d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 6813554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 6814554e165cSAndy Whitcroft WARN("MEMSET", 6815d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 6816d7c76ba7SJoe Perches } 6817d7c76ba7SJoe Perches } 6818d7c76ba7SJoe Perches 681998a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 68205b57980dSJoe Perches# if ($perl_version_ok && 6821f333195dSJoe Perches# defined $stat && 6822f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6823f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 6824f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 6825f333195dSJoe Perches# $fix) { 6826f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 6827f333195dSJoe Perches# } 6828f333195dSJoe Perches# } 682998a9bba5SJoe Perches 6830b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 68315b57980dSJoe Perches# if ($perl_version_ok && 6832f333195dSJoe Perches# defined $stat && 6833f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6834f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 6835f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 6836f333195dSJoe Perches# } 6837b6117d17SMateusz Kulikowski 68388617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 68398617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 68405b57980dSJoe Perches# if ($perl_version_ok && 6841f333195dSJoe Perches# defined $stat && 6842f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6843f333195dSJoe Perches# 6844f333195dSJoe Perches# my $ms_val = $7; 6845f333195dSJoe Perches# 6846f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 6847f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 6848f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 6849f333195dSJoe Perches# $fix) { 6850f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 6851f333195dSJoe Perches# } 6852f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 6853f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 6854f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 6855f333195dSJoe Perches# $fix) { 6856f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 6857f333195dSJoe Perches# } 6858f333195dSJoe Perches# } 6859f333195dSJoe Perches# } 68608617cd09SMateusz Kulikowski 68615dbdb2d8SJoe Perches# strlcpy uses that should likely be strscpy 68625dbdb2d8SJoe Perches if ($line =~ /\bstrlcpy\s*\(/) { 68635dbdb2d8SJoe Perches WARN("STRLCPY", 68645dbdb2d8SJoe Perches "Prefer strscpy over strlcpy - see: https://lore.kernel.org/r/CAHk-=wgfRnXz0W3D37d01q3JFkr_i_uTL=V6A6G1oUZcprmknw\@mail.gmail.com/\n" . $herecurr); 68655dbdb2d8SJoe Perches } 68665dbdb2d8SJoe Perches 6867d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 68685b57980dSJoe Perches if ($perl_version_ok && 6869d1fe9c09SJoe Perches defined $stat && 6870d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 6871d1fe9c09SJoe Perches if (defined $2 || defined $7) { 6872d7c76ba7SJoe Perches my $call = $1; 6873d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 6874d7c76ba7SJoe Perches my $arg1 = $3; 6875d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 6876d1fe9c09SJoe Perches my $arg2 = $8; 6877d7c76ba7SJoe Perches my $cast; 6878d7c76ba7SJoe Perches 6879d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 6880d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 6881d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 6882d7c76ba7SJoe Perches $cast = $cast1; 6883d7c76ba7SJoe Perches } else { 6884d7c76ba7SJoe Perches $cast = $cast2; 6885d7c76ba7SJoe Perches } 6886d7c76ba7SJoe Perches WARN("MINMAX", 6887d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 6888554e165cSAndy Whitcroft } 6889554e165cSAndy Whitcroft } 6890554e165cSAndy Whitcroft 68914a273195SJoe Perches# check usleep_range arguments 68925b57980dSJoe Perches if ($perl_version_ok && 68934a273195SJoe Perches defined $stat && 68944a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 68954a273195SJoe Perches my $min = $1; 68964a273195SJoe Perches my $max = $7; 68974a273195SJoe Perches if ($min eq $max) { 68984a273195SJoe Perches WARN("USLEEP_RANGE", 6899458f69efSMauro Carvalho Chehab "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 69004a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 69014a273195SJoe Perches $min > $max) { 69024a273195SJoe Perches WARN("USLEEP_RANGE", 6903458f69efSMauro Carvalho Chehab "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 69044a273195SJoe Perches } 69054a273195SJoe Perches } 69064a273195SJoe Perches 6907823b794cSJoe Perches# check for naked sscanf 69085b57980dSJoe Perches if ($perl_version_ok && 6909823b794cSJoe Perches defined $stat && 69106c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 6911823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 6912823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 6913823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 6914823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 6915823b794cSJoe Perches $lc = $lc + $linenr; 69162a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6917823b794cSJoe Perches WARN("NAKED_SSCANF", 6918823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 6919823b794cSJoe Perches } 6920823b794cSJoe Perches 6921afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 69225b57980dSJoe Perches if ($perl_version_ok && 6923afc819abSJoe Perches defined $stat && 6924afc819abSJoe Perches $line =~ /\bsscanf\b/) { 6925afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 6926afc819abSJoe Perches $lc = $lc + $linenr; 69272a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6928afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 6929afc819abSJoe Perches my $format = $6; 6930afc819abSJoe Perches my $count = $format =~ tr@%@%@; 6931afc819abSJoe Perches if ($count == 1 && 6932afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 6933afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 6934afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 6935afc819abSJoe Perches } 6936afc819abSJoe Perches } 6937afc819abSJoe Perches } 6938afc819abSJoe Perches 693970dc8a48SJoe Perches# check for new externs in .h files. 694070dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 694170dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 6942d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 694370dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 694470dc8a48SJoe Perches $fix) { 6945194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 694670dc8a48SJoe Perches } 694770dc8a48SJoe Perches } 694870dc8a48SJoe Perches 6949de7d4f0eSAndy Whitcroft# check for new externs in .c files. 6950171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 6951c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 6952171ae1a4SAndy Whitcroft { 6953c45dcabdSAndy Whitcroft my $function_name = $1; 6954c45dcabdSAndy Whitcroft my $paren_space = $2; 6955171ae1a4SAndy Whitcroft 6956171ae1a4SAndy Whitcroft my $s = $stat; 6957171ae1a4SAndy Whitcroft if (defined $cond) { 6958171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 6959171ae1a4SAndy Whitcroft } 6960d8b44b58SKees Cook if ($s =~ /^\s*;/) 6961c45dcabdSAndy Whitcroft { 6962000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6963000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6964de7d4f0eSAndy Whitcroft } 6965de7d4f0eSAndy Whitcroft 6966171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 6967000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 6968000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 6969171ae1a4SAndy Whitcroft } 69709c9ba34eSAndy Whitcroft 69719c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 69729c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 69739c9ba34eSAndy Whitcroft { 6974000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6975000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6976171ae1a4SAndy Whitcroft } 6977171ae1a4SAndy Whitcroft 6978a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 6979a0ad7596SJoe Perches if (defined $stat && 6980d8b44b58SKees Cook $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 6981d8b44b58SKees Cook $1 ne "void") { 6982d8b44b58SKees Cook my $args = trim($1); 6983ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6984ca0d8929SJoe Perches my $arg = trim($1); 6985d8b44b58SKees Cook if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 6986ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 6987ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6988ca0d8929SJoe Perches } 6989ca0d8929SJoe Perches } 6990ca0d8929SJoe Perches } 6991ca0d8929SJoe Perches 6992a0ad7596SJoe Perches# check for function definitions 69935b57980dSJoe Perches if ($perl_version_ok && 6994a0ad7596SJoe Perches defined $stat && 6995a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6996a0ad7596SJoe Perches $context_function = $1; 6997a0ad7596SJoe Perches 6998a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 6999a0ad7596SJoe Perches my $ok = 0; 7000a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 7001a0ad7596SJoe Perches my $herectx = $here . "\n"; 7002a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 7003a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 7004a0ad7596SJoe Perches $herectx .= $rl . "\n"; 7005a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 7006a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 7007a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 7008a0ad7596SJoe Perches } 7009a0ad7596SJoe Perches if (!$ok) { 7010a0ad7596SJoe Perches ERROR("OPEN_BRACE", 7011a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 7012a0ad7596SJoe Perches } 7013a0ad7596SJoe Perches } 7014a0ad7596SJoe Perches 7015de7d4f0eSAndy Whitcroft# checks for new __setup's 7016de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 7017de7d4f0eSAndy Whitcroft my $name = $1; 7018de7d4f0eSAndy Whitcroft 7019de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 7020000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 70212581ac7cSTim Froidcoeur "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr); 7022de7d4f0eSAndy Whitcroft } 7023653d4876SAndy Whitcroft } 70249c0ca6f9SAndy Whitcroft 7025e29a70f1SJoe Perches# check for pointless casting of alloc functions 7026e29a70f1SJoe Perches if ($line =~ /\*\s*\)\s*$allocFunctions\b/) { 7027000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 7028000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 70299c0ca6f9SAndy Whitcroft } 703013214adfSAndy Whitcroft 7031a640d25cSJoe Perches# alloc style 7032a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 70335b57980dSJoe Perches if ($perl_version_ok && 7034e29a70f1SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 7035a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 7036a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 7037a640d25cSJoe Perches } 7038a640d25cSJoe Perches 703973f1d07eSGustavo A. R. Silva# check for (kv|k)[mz]alloc with multiplies that could be kmalloc_array/kvmalloc_array/kvcalloc/kcalloc 70405b57980dSJoe Perches if ($perl_version_ok && 70411b4a2ed4SJoe Perches defined $stat && 704273f1d07eSGustavo A. R. Silva $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k)[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 704360a55369SJoe Perches my $oldfunc = $3; 704460a55369SJoe Perches my $a1 = $4; 704560a55369SJoe Perches my $a2 = $10; 704660a55369SJoe Perches my $newfunc = "kmalloc_array"; 704773f1d07eSGustavo A. R. Silva $newfunc = "kvmalloc_array" if ($oldfunc eq "kvmalloc"); 704873f1d07eSGustavo A. R. Silva $newfunc = "kvcalloc" if ($oldfunc eq "kvzalloc"); 704960a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 705060a55369SJoe Perches my $r1 = $a1; 705160a55369SJoe Perches my $r2 = $a2; 705260a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 705360a55369SJoe Perches $r1 = $a2; 705460a55369SJoe Perches $r2 = $a1; 705560a55369SJoe Perches } 7056e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 7057e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 70581b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 7059e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 7060e3d95a2aSTobin C. Harding 7061e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 70621b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 70631b4a2ed4SJoe Perches $cnt == 1 && 7064e367455aSJoe Perches $fix) { 706573f1d07eSGustavo 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; 706660a55369SJoe Perches } 706760a55369SJoe Perches } 706860a55369SJoe Perches } 706960a55369SJoe Perches 7070972fdea2SJoe Perches# check for krealloc arg reuse 70715b57980dSJoe Perches if ($perl_version_ok && 70724cab63ceSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ && 70734cab63ceSJoe Perches $1 eq $3) { 7074972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 7075972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 7076972fdea2SJoe Perches } 7077972fdea2SJoe Perches 70785ce59ae0SJoe Perches# check for alloc argument mismatch 70797e6cdd7fSChristophe JAILLET if ($line =~ /\b((?:devm_)?(?:kcalloc|kmalloc_array))\s*\(\s*sizeof\b/) { 70805ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 70815ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 70825ce59ae0SJoe Perches } 70835ce59ae0SJoe Perches 7084caf2a54fSJoe Perches# check for multiple semicolons 7085caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 7086d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 7087d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 7088d5e616fcSJoe Perches $fix) { 7089194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 7090d5e616fcSJoe Perches } 7091d1e2ad07SJoe Perches } 7092d1e2ad07SJoe Perches 7093cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 7094cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 7095cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 70960ab90191SJoe Perches my $ull = ""; 70970ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 70980ab90191SJoe Perches if (CHK("BIT_MACRO", 70990ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 71000ab90191SJoe Perches $fix) { 71010ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 71020ab90191SJoe Perches } 71030ab90191SJoe Perches } 71040ab90191SJoe Perches 710550161266SJoe Perches# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too) 71063e89ad85SJerome Forissier if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) { 710750161266SJoe Perches WARN("IS_ENABLED_CONFIG", 71083e89ad85SJerome Forissier "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr); 710950161266SJoe Perches } 711050161266SJoe Perches 71112d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 71123e89ad85SJerome 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*$/) { 71132d632745SJoe Perches my $config = $1; 71142d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 71153e89ad85SJerome Forissier "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) && 71162d632745SJoe Perches $fix) { 71172d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 71182d632745SJoe Perches } 71192d632745SJoe Perches } 71202d632745SJoe Perches 7121f36d3eb8SJoe Perches# check for /* fallthrough */ like comment, prefer fallthrough; 7122f36d3eb8SJoe Perches my @fallthroughs = ( 7123f36d3eb8SJoe Perches 'fallthrough', 7124f36d3eb8SJoe Perches '@fallthrough@', 7125f36d3eb8SJoe Perches 'lint -fallthrough[ \t]*', 7126f36d3eb8SJoe Perches 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)', 7127f36d3eb8SJoe Perches '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?', 7128f36d3eb8SJoe Perches 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 7129f36d3eb8SJoe Perches 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 7130f36d3eb8SJoe Perches ); 7131f36d3eb8SJoe Perches if ($raw_comment ne '') { 7132f36d3eb8SJoe Perches foreach my $ft (@fallthroughs) { 7133f36d3eb8SJoe Perches if ($raw_comment =~ /$ft/) { 7134f36d3eb8SJoe Perches my $msg_level = \&WARN; 7135f36d3eb8SJoe Perches $msg_level = \&CHK if ($file); 7136f36d3eb8SJoe Perches &{$msg_level}("PREFER_FALLTHROUGH", 7137f36d3eb8SJoe Perches "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr); 7138f36d3eb8SJoe Perches last; 7139f36d3eb8SJoe Perches } 7140f36d3eb8SJoe Perches } 7141f36d3eb8SJoe Perches } 7142f36d3eb8SJoe Perches 7143d1e2ad07SJoe Perches# check for switch/default statements without a break; 71445b57980dSJoe Perches if ($perl_version_ok && 7145d1e2ad07SJoe Perches defined $stat && 7146d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 7147d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 7148e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 7149e3d95a2aSTobin C. Harding 7150d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 7151d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 7152caf2a54fSJoe Perches } 7153caf2a54fSJoe Perches 715413214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 7155d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 7156d5e616fcSJoe Perches if (WARN("USE_FUNC", 7157d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 7158d5e616fcSJoe Perches $fix) { 7159194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 7160d5e616fcSJoe Perches } 716113214adfSAndy Whitcroft } 7162773647a0SAndy Whitcroft 716362ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 716462ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 716562ec818fSJoe Perches ERROR("DATE_TIME", 716662ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 716762ec818fSJoe Perches } 716862ec818fSJoe Perches 71692c92488aSJoe Perches# check for use of yield() 71702c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 71712c92488aSJoe Perches WARN("YIELD", 71722c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 71732c92488aSJoe Perches } 71742c92488aSJoe Perches 7175179f8f40SJoe Perches# check for comparisons against true and false 7176179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 7177179f8f40SJoe Perches my $lead = $1; 7178179f8f40SJoe Perches my $arg = $2; 7179179f8f40SJoe Perches my $test = $3; 7180179f8f40SJoe Perches my $otype = $4; 7181179f8f40SJoe Perches my $trail = $5; 7182179f8f40SJoe Perches my $op = "!"; 7183179f8f40SJoe Perches 7184179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 7185179f8f40SJoe Perches 7186179f8f40SJoe Perches my $type = lc($otype); 7187179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 7188179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 7189179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 7190179f8f40SJoe Perches $op = ""; 7191179f8f40SJoe Perches } 7192179f8f40SJoe Perches 7193179f8f40SJoe Perches CHK("BOOL_COMPARISON", 7194179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 7195179f8f40SJoe Perches 7196179f8f40SJoe Perches## maybe suggesting a correct construct would better 7197179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 7198179f8f40SJoe Perches 7199179f8f40SJoe Perches } 7200179f8f40SJoe Perches } 7201179f8f40SJoe Perches 72024882720bSThomas Gleixner# check for semaphores initialized locked 72034882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 7204000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 7205000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 7206773647a0SAndy Whitcroft } 72076712d858SJoe Perches 720867d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 720967d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 7210000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 721167d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 7212773647a0SAndy Whitcroft } 72136712d858SJoe Perches 7214ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 7215f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 7216000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 7217ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 7218f3db6639SMichael Ellerman } 72196712d858SJoe Perches 72203d709ab5SPaul E. McKenney# check for spin_is_locked(), suggest lockdep instead 72213d709ab5SPaul E. McKenney if ($line =~ /\bspin_is_locked\(/) { 72223d709ab5SPaul E. McKenney WARN("USE_LOCKDEP", 72233d709ab5SPaul E. McKenney "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr); 72243d709ab5SPaul E. McKenney } 72253d709ab5SPaul E. McKenney 72269189c7e7SJoe Perches# check for deprecated apis 72279189c7e7SJoe Perches if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) { 72289189c7e7SJoe Perches my $deprecated_api = $1; 72299189c7e7SJoe Perches my $new_api = $deprecated_apis{$deprecated_api}; 72309189c7e7SJoe Perches WARN("DEPRECATED_API", 72319189c7e7SJoe Perches "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr); 72329189c7e7SJoe Perches } 72339189c7e7SJoe Perches 72340f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 7235d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 7236ced69da1SQuentin Monnet if (defined($const_structs) && 7237ced69da1SQuentin Monnet $line !~ /\bconst\b/ && 7238d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 7239000d1cc1SJoe Perches WARN("CONST_STRUCT", 7240d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 72412b6db5cbSAndy Whitcroft } 7242773647a0SAndy Whitcroft 7243773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 7244773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 724535cdcbfcSPeng Wang# ignore designated initializers using NR_CPUS 7246773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 7247c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 7248c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 7249171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 7250171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 725135cdcbfcSPeng Wang $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/ && 725235cdcbfcSPeng Wang $line !~ /^.\s*\.\w+\s*=\s*.*\bNR_CPUS\b/) 7253773647a0SAndy Whitcroft { 7254000d1cc1SJoe Perches WARN("NR_CPUS", 7255000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 7256773647a0SAndy Whitcroft } 72579c9ba34eSAndy Whitcroft 725852ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 725952ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 726052ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 726152ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 726252ea8506SJoe Perches } 726352ea8506SJoe Perches 7264acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 72655b57980dSJoe Perches if ($perl_version_ok && 7266acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 7267acd9362cSJoe Perches WARN("LIKELY_MISUSE", 7268acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 7269acd9362cSJoe Perches } 7270acd9362cSJoe Perches 7271fbe74541SJoe Perches# return sysfs_emit(foo, fmt, ...) fmt without newline 7272fbe74541SJoe Perches if ($line =~ /\breturn\s+sysfs_emit\s*\(\s*$FuncArg\s*,\s*($String)/ && 7273fbe74541SJoe Perches substr($rawline, $-[6], $+[6] - $-[6]) !~ /\\n"$/) { 7274fbe74541SJoe Perches my $offset = $+[6] - 1; 7275fbe74541SJoe Perches if (WARN("SYSFS_EMIT", 7276fbe74541SJoe Perches "return sysfs_emit(...) formats should include a terminating newline\n" . $herecurr) && 7277fbe74541SJoe Perches $fix) { 7278fbe74541SJoe Perches substr($fixed[$fixlinenr], $offset, 0) = '\\n'; 7279fbe74541SJoe Perches } 7280fbe74541SJoe Perches } 7281fbe74541SJoe Perches 7282de3f186fSDenis Efremov# nested likely/unlikely calls 7283de3f186fSDenis Efremov if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) { 7284de3f186fSDenis Efremov WARN("LIKELY_MISUSE", 7285de3f186fSDenis Efremov "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr); 7286de3f186fSDenis Efremov } 7287de3f186fSDenis Efremov 7288691d77b6SAndy Whitcroft# whine mightly about in_atomic 7289691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 7290691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 7291000d1cc1SJoe Perches ERROR("IN_ATOMIC", 7292000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 7293f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 7294000d1cc1SJoe Perches WARN("IN_ATOMIC", 7295000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 7296691d77b6SAndy Whitcroft } 7297691d77b6SAndy Whitcroft } 72981704f47bSPeter Zijlstra 72991704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 73001704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 73011704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 73021704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 73031704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 73041704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 7305000d1cc1SJoe Perches ERROR("LOCKDEP", 7306000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 73071704f47bSPeter Zijlstra } 73081704f47bSPeter Zijlstra } 730988f8831cSDave Jones 7310b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 7311b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 7312000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 7313000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 731488f8831cSDave Jones } 73152435880fSJoe Perches 731600180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 731700180468SJoe Perches# and whether or not function naming is typical and if 731800180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 73195b57980dSJoe Perches if ($perl_version_ok && 732000180468SJoe Perches defined $stat && 732100180468SJoe 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*\)/) { 732200180468SJoe Perches my $var = $1; 732300180468SJoe Perches my $perms = $2; 732400180468SJoe Perches my $show = $3; 732500180468SJoe Perches my $store = $4; 732600180468SJoe Perches my $octal_perms = perms_to_octal($perms); 732700180468SJoe Perches if ($show =~ /^${var}_show$/ && 732800180468SJoe Perches $store =~ /^${var}_store$/ && 732900180468SJoe Perches $octal_perms eq "0644") { 733000180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 733100180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 733200180468SJoe Perches $fix) { 733300180468SJoe 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})/; 733400180468SJoe Perches } 733500180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 733600180468SJoe Perches $store =~ /^NULL$/ && 733700180468SJoe Perches $octal_perms eq "0444") { 733800180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 733900180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 734000180468SJoe Perches $fix) { 734100180468SJoe 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})/; 734200180468SJoe Perches } 734300180468SJoe Perches } elsif ($show =~ /^NULL$/ && 734400180468SJoe Perches $store =~ /^${var}_store$/ && 734500180468SJoe Perches $octal_perms eq "0200") { 734600180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 734700180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 734800180468SJoe Perches $fix) { 734900180468SJoe 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})/; 735000180468SJoe Perches } 735100180468SJoe Perches } elsif ($octal_perms eq "0644" || 735200180468SJoe Perches $octal_perms eq "0444" || 735300180468SJoe Perches $octal_perms eq "0200") { 735400180468SJoe Perches my $newshow = "$show"; 735500180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 735600180468SJoe Perches my $newstore = $store; 735700180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 735800180468SJoe Perches my $rename = ""; 735900180468SJoe Perches if ($show ne $newshow) { 736000180468SJoe Perches $rename .= " '$show' to '$newshow'"; 736100180468SJoe Perches } 736200180468SJoe Perches if ($store ne $newstore) { 736300180468SJoe Perches $rename .= " '$store' to '$newstore'"; 736400180468SJoe Perches } 736500180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 736600180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 736700180468SJoe Perches } else { 736800180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 736900180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 737000180468SJoe Perches } 737100180468SJoe Perches } 737200180468SJoe Perches 7373515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 7374515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 737573121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 737673121534SJoe Perches# specific definition of not visible in sysfs. 737773121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 737873121534SJoe Perches# use the default permissions 73795b57980dSJoe Perches if ($perl_version_ok && 7380459cf0aeSJoe Perches defined $stat && 7381515a235eSJoe Perches $line =~ /$mode_perms_search/) { 73822435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 73832435880fSJoe Perches my $func = $entry->[0]; 73842435880fSJoe Perches my $arg_pos = $entry->[1]; 73852435880fSJoe Perches 7386459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 7387459cf0aeSJoe Perches $lc = $lc + $linenr; 73882a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 7389459cf0aeSJoe Perches 73902435880fSJoe Perches my $skip_args = ""; 73912435880fSJoe Perches if ($arg_pos > 1) { 73922435880fSJoe Perches $arg_pos--; 73932435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 73942435880fSJoe Perches } 7395f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 7396459cf0aeSJoe Perches if ($stat =~ /$test/) { 73972435880fSJoe Perches my $val = $1; 73982435880fSJoe Perches $val = $6 if ($skip_args ne ""); 739973121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 740073121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 740173121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 74022435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 7403459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 7404f90774e1SJoe Perches } 7405f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 7406c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 7407459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 74082435880fSJoe Perches } 7409459cf0aeSJoe Perches } 7410459cf0aeSJoe Perches } 7411459cf0aeSJoe Perches } 7412459cf0aeSJoe Perches 7413459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 7414bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 741500180468SJoe Perches my $oval = $1; 741600180468SJoe Perches my $octal = perms_to_octal($oval); 7417f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 7418459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 7419f90774e1SJoe Perches $fix) { 742000180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 74212435880fSJoe Perches } 742213214adfSAndy Whitcroft } 74235a6d20ceSBjorn Andersson 74245a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 74255a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 74265a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 74275a6d20ceSBjorn Andersson my $valid_licenses = qr{ 74285a6d20ceSBjorn Andersson GPL| 74295a6d20ceSBjorn Andersson GPL\ v2| 74305a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 74315a6d20ceSBjorn Andersson Dual\ BSD/GPL| 74325a6d20ceSBjorn Andersson Dual\ MIT/GPL| 74335a6d20ceSBjorn Andersson Dual\ MPL/GPL| 74345a6d20ceSBjorn Andersson Proprietary 74355a6d20ceSBjorn Andersson }x; 74365a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 74375a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 74385a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 74395a6d20ceSBjorn Andersson } 74406e8f42dcSJoe Perches if (!$file && $extracted_string eq '"GPL v2"') { 74416e8f42dcSJoe Perches if (WARN("MODULE_LICENSE", 74426e8f42dcSJoe Perches "Prefer \"GPL\" over \"GPL v2\" - see commit bf7fbeeae6db (\"module: Cure the MODULE_LICENSE \"GPL\" vs. \"GPL v2\" bogosity\")\n" . $herecurr) && 74436e8f42dcSJoe Perches $fix) { 74446e8f42dcSJoe Perches $fixed[$fixlinenr] =~ s/\bMODULE_LICENSE\s*\(\s*"GPL v2"\s*\)/MODULE_LICENSE("GPL")/; 74456e8f42dcSJoe Perches } 74466e8f42dcSJoe Perches } 74475a6d20ceSBjorn Andersson } 74486a8d76cbSMatteo Croce 74496a8d76cbSMatteo Croce# check for sysctl duplicate constants 74506a8d76cbSMatteo Croce if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) { 74516a8d76cbSMatteo Croce WARN("DUPLICATED_SYSCTL_CONST", 74526a8d76cbSMatteo Croce "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr); 74536a8d76cbSMatteo Croce } 7454515a235eSJoe Perches } 745513214adfSAndy Whitcroft 745613214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 745713214adfSAndy Whitcroft # so just keep quiet. 745813214adfSAndy Whitcroft if ($#rawlines == -1) { 745913214adfSAndy Whitcroft exit(0); 74600a920b5bSAndy Whitcroft } 74610a920b5bSAndy Whitcroft 74628905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 74638905a67cSAndy Whitcroft # things that appear to be patches. 74648905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 74658905a67cSAndy Whitcroft exit(0); 74668905a67cSAndy Whitcroft } 74678905a67cSAndy Whitcroft 7468e73d2715SDwaipayan Ray # This is not a patch, and we are in 'no-patch' mode so 74698905a67cSAndy Whitcroft # just keep quiet. 74708905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 74718905a67cSAndy Whitcroft exit(0); 74728905a67cSAndy Whitcroft } 74738905a67cSAndy Whitcroft 7474a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 7475000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 7476000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 74770a920b5bSAndy Whitcroft } 7478cd261496SGeert Uytterhoeven if ($is_patch && $has_commit_log && $chk_signoff) { 7479cd261496SGeert Uytterhoeven if ($signoff == 0) { 7480000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 7481000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 748248ca2d8aSDwaipayan Ray } elsif ($authorsignoff != 1) { 748348ca2d8aSDwaipayan Ray # authorsignoff values: 748448ca2d8aSDwaipayan Ray # 0 -> missing sign off 748548ca2d8aSDwaipayan Ray # 1 -> sign off identical 748648ca2d8aSDwaipayan Ray # 2 -> names and addresses match, comments mismatch 748748ca2d8aSDwaipayan Ray # 3 -> addresses match, names different 748848ca2d8aSDwaipayan Ray # 4 -> names match, addresses different 748948ca2d8aSDwaipayan Ray # 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match 749048ca2d8aSDwaipayan Ray 749148ca2d8aSDwaipayan Ray my $sob_msg = "'From: $author' != 'Signed-off-by: $author_sob'"; 749248ca2d8aSDwaipayan Ray 749348ca2d8aSDwaipayan Ray if ($authorsignoff == 0) { 749448ca2d8aSDwaipayan Ray ERROR("NO_AUTHOR_SIGN_OFF", 7495cd261496SGeert Uytterhoeven "Missing Signed-off-by: line by nominal patch author '$author'\n"); 749648ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 2) { 749748ca2d8aSDwaipayan Ray CHK("FROM_SIGN_OFF_MISMATCH", 749848ca2d8aSDwaipayan Ray "From:/Signed-off-by: email comments mismatch: $sob_msg\n"); 749948ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 3) { 750048ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 750148ca2d8aSDwaipayan Ray "From:/Signed-off-by: email name mismatch: $sob_msg\n"); 750248ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 4) { 750348ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 750448ca2d8aSDwaipayan Ray "From:/Signed-off-by: email address mismatch: $sob_msg\n"); 750548ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 5) { 750648ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 750748ca2d8aSDwaipayan Ray "From:/Signed-off-by: email subaddress mismatch: $sob_msg\n"); 750848ca2d8aSDwaipayan Ray } 7509cd261496SGeert Uytterhoeven } 75100a920b5bSAndy Whitcroft } 75110a920b5bSAndy Whitcroft 7512f0a594c1SAndy Whitcroft print report_dump(); 751313214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 751413214adfSAndy Whitcroft print "$filename " if ($summary_file); 75156c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 75166c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 75176c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 75186c72ffaaSAndy Whitcroft } 75198905a67cSAndy Whitcroft 7520d2c0a235SAndy Whitcroft if ($quiet == 0) { 7521ef212196SJoe Perches # If there were any defects found and not already fixing them 7522ef212196SJoe Perches if (!$clean and !$fix) { 7523ef212196SJoe Perches print << "EOM" 7524ef212196SJoe Perches 7525ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 7526ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 7527ef212196SJoe PerchesEOM 7528ef212196SJoe Perches } 7529d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 7530d2c0a235SAndy Whitcroft # then suggest that. 7531d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 7532b0781216SMike Frysinger $rpt_cleaners = 0; 7533d8469f16SJoe Perches print << "EOM" 7534d8469f16SJoe Perches 7535d8469f16SJoe PerchesNOTE: Whitespace errors detected. 7536d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 7537d8469f16SJoe PerchesEOM 7538d2c0a235SAndy Whitcroft } 7539d2c0a235SAndy Whitcroft } 7540d2c0a235SAndy Whitcroft 7541d752fcc8SJoe Perches if ($clean == 0 && $fix && 7542d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 7543d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 75449624b8d6SJoe Perches my $newfile = $filename; 75459624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 75463705ce5bSJoe Perches my $linecount = 0; 75473705ce5bSJoe Perches my $f; 75483705ce5bSJoe Perches 7549d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 7550d752fcc8SJoe Perches 75513705ce5bSJoe Perches open($f, '>', $newfile) 75523705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 75533705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 75543705ce5bSJoe Perches $linecount++; 75553705ce5bSJoe Perches if ($file) { 75563705ce5bSJoe Perches if ($linecount > 3) { 75573705ce5bSJoe Perches $fixed_line =~ s/^\+//; 75583705ce5bSJoe Perches print $f $fixed_line . "\n"; 75593705ce5bSJoe Perches } 75603705ce5bSJoe Perches } else { 75613705ce5bSJoe Perches print $f $fixed_line . "\n"; 75623705ce5bSJoe Perches } 75633705ce5bSJoe Perches } 75643705ce5bSJoe Perches close($f); 75653705ce5bSJoe Perches 75663705ce5bSJoe Perches if (!$quiet) { 75673705ce5bSJoe Perches print << "EOM"; 7568d8469f16SJoe Perches 75693705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 75703705ce5bSJoe Perches 75713705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 75723705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 75733705ce5bSJoe Perches 75743705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 75753705ce5bSJoe PerchesNo warranties, expressed or implied... 75763705ce5bSJoe PerchesEOM 75773705ce5bSJoe Perches } 75783705ce5bSJoe Perches } 75793705ce5bSJoe Perches 7580d8469f16SJoe Perches if ($quiet == 0) { 7581d8469f16SJoe Perches print "\n"; 7582d8469f16SJoe Perches if ($clean == 1) { 7583d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 7584d8469f16SJoe Perches } else { 7585d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 75860a920b5bSAndy Whitcroft } 75870a920b5bSAndy Whitcroft } 75880a920b5bSAndy Whitcroft return $clean; 75890a920b5bSAndy Whitcroft} 7590