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 3370ee3e7b8SPeter Ujfalusi if (($codespell || $help) && which("codespell") ne "" && which("python") 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 3470ee3e7b8SPeter Ujfalusi my $codespell_dict = `python -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", 8109189c7e7SJoe Perches); 8119189c7e7SJoe Perches 8129189c7e7SJoe Perches#Create a search pattern for all these strings to speed up a loop below 8139189c7e7SJoe Perchesour $deprecated_apis_search = ""; 8149189c7e7SJoe Perchesforeach my $entry (keys %deprecated_apis) { 8159189c7e7SJoe Perches $deprecated_apis_search .= '|' if ($deprecated_apis_search ne ""); 8169189c7e7SJoe Perches $deprecated_apis_search .= $entry; 8179189c7e7SJoe Perches} 8189189c7e7SJoe Perches$deprecated_apis_search = "(?:${deprecated_apis_search})"; 8199189c7e7SJoe Perches 820b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 821b392c64fSJoe Perches S_IWUGO | 822b392c64fSJoe Perches S_IWOTH | 823b392c64fSJoe Perches S_IRWXUGO | 824b392c64fSJoe Perches S_IALLUGO | 825b392c64fSJoe Perches 0[0-7][0-7][2367] 826b392c64fSJoe Perches}x; 827b392c64fSJoe Perches 828f90774e1SJoe Perchesour %mode_permission_string_types = ( 829f90774e1SJoe Perches "S_IRWXU" => 0700, 830f90774e1SJoe Perches "S_IRUSR" => 0400, 831f90774e1SJoe Perches "S_IWUSR" => 0200, 832f90774e1SJoe Perches "S_IXUSR" => 0100, 833f90774e1SJoe Perches "S_IRWXG" => 0070, 834f90774e1SJoe Perches "S_IRGRP" => 0040, 835f90774e1SJoe Perches "S_IWGRP" => 0020, 836f90774e1SJoe Perches "S_IXGRP" => 0010, 837f90774e1SJoe Perches "S_IRWXO" => 0007, 838f90774e1SJoe Perches "S_IROTH" => 0004, 839f90774e1SJoe Perches "S_IWOTH" => 0002, 840f90774e1SJoe Perches "S_IXOTH" => 0001, 841f90774e1SJoe Perches "S_IRWXUGO" => 0777, 842f90774e1SJoe Perches "S_IRUGO" => 0444, 843f90774e1SJoe Perches "S_IWUGO" => 0222, 844f90774e1SJoe Perches "S_IXUGO" => 0111, 845f90774e1SJoe Perches); 846f90774e1SJoe Perches 847f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below 848f90774e1SJoe Perchesour $mode_perms_string_search = ""; 849f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) { 850f90774e1SJoe Perches $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); 851f90774e1SJoe Perches $mode_perms_string_search .= $entry; 852f90774e1SJoe Perches} 85300180468SJoe Perchesour $single_mode_perms_string_search = "(?:${mode_perms_string_search})"; 85400180468SJoe Perchesour $multi_mode_perms_string_search = qr{ 85500180468SJoe Perches ${single_mode_perms_string_search} 85600180468SJoe Perches (?:\s*\|\s*${single_mode_perms_string_search})* 85700180468SJoe Perches}x; 85800180468SJoe Perches 85900180468SJoe Perchessub perms_to_octal { 86000180468SJoe Perches my ($string) = @_; 86100180468SJoe Perches 86200180468SJoe Perches return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/); 86300180468SJoe Perches 86400180468SJoe Perches my $val = ""; 86500180468SJoe Perches my $oval = ""; 86600180468SJoe Perches my $to = 0; 86700180468SJoe Perches my $curpos = 0; 86800180468SJoe Perches my $lastpos = 0; 86900180468SJoe Perches while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) { 87000180468SJoe Perches $curpos = pos($string); 87100180468SJoe Perches my $match = $2; 87200180468SJoe Perches my $omatch = $1; 87300180468SJoe Perches last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos)); 87400180468SJoe Perches $lastpos = $curpos; 87500180468SJoe Perches $to |= $mode_permission_string_types{$match}; 87600180468SJoe Perches $val .= '\s*\|\s*' if ($val ne ""); 87700180468SJoe Perches $val .= $match; 87800180468SJoe Perches $oval .= $omatch; 87900180468SJoe Perches } 88000180468SJoe Perches $oval =~ s/^\s*\|\s*//; 88100180468SJoe Perches $oval =~ s/\s*\|\s*$//; 88200180468SJoe Perches return sprintf("%04o", $to); 88300180468SJoe Perches} 884f90774e1SJoe Perches 8857840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 8867840a94cSWolfram Sang irq| 887cdcee686SSergey Ryazanov memory| 888cdcee686SSergey Ryazanov time| 889cdcee686SSergey Ryazanov reboot 8907840a94cSWolfram Sang)}; 8917840a94cSWolfram Sang# memory.h: ARM has a custom one 8927840a94cSWolfram Sang 89366b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 89466b47b4aSKees Cookmy $misspellings; 89566b47b4aSKees Cookmy %spelling_fix; 89636061e38SJoe Perches 89736061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 89866b47b4aSKees Cook while (<$spelling>) { 89966b47b4aSKees Cook my $line = $_; 90066b47b4aSKees Cook 90166b47b4aSKees Cook $line =~ s/\s*\n?$//g; 90266b47b4aSKees Cook $line =~ s/^\s*//g; 90366b47b4aSKees Cook 90466b47b4aSKees Cook next if ($line =~ m/^\s*#/); 90566b47b4aSKees Cook next if ($line =~ m/^\s*$/); 90666b47b4aSKees Cook 90766b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 90866b47b4aSKees Cook 90966b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 91066b47b4aSKees Cook } 91166b47b4aSKees Cook close($spelling); 91236061e38SJoe Perches} else { 91336061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 91436061e38SJoe Perches} 91566b47b4aSKees Cook 916ebfd7d62SJoe Perchesif ($codespell) { 917ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 918ebfd7d62SJoe Perches while (<$spelling>) { 919ebfd7d62SJoe Perches my $line = $_; 920ebfd7d62SJoe Perches 921ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 922ebfd7d62SJoe Perches $line =~ s/^\s*//g; 923ebfd7d62SJoe Perches 924ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 925ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 926ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 927ebfd7d62SJoe Perches 928ebfd7d62SJoe Perches $line =~ s/,.*$//; 929ebfd7d62SJoe Perches 930ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 931ebfd7d62SJoe Perches 932ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 933ebfd7d62SJoe Perches } 934ebfd7d62SJoe Perches close($spelling); 935ebfd7d62SJoe Perches } else { 936ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 937ebfd7d62SJoe Perches } 938ebfd7d62SJoe Perches} 939ebfd7d62SJoe Perches 940ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 941ebfd7d62SJoe Perches 94275ad8c57SJerome Forissiersub read_words { 94375ad8c57SJerome Forissier my ($wordsRef, $file) = @_; 94475ad8c57SJerome Forissier 94575ad8c57SJerome Forissier if (open(my $words, '<', $file)) { 94675ad8c57SJerome Forissier while (<$words>) { 947bf1fa1daSJoe Perches my $line = $_; 948bf1fa1daSJoe Perches 949bf1fa1daSJoe Perches $line =~ s/\s*\n?$//g; 950bf1fa1daSJoe Perches $line =~ s/^\s*//g; 951bf1fa1daSJoe Perches 952bf1fa1daSJoe Perches next if ($line =~ m/^\s*#/); 953bf1fa1daSJoe Perches next if ($line =~ m/^\s*$/); 954bf1fa1daSJoe Perches if ($line =~ /\s/) { 95575ad8c57SJerome Forissier print("$file: '$line' invalid - ignored\n"); 956bf1fa1daSJoe Perches next; 957bf1fa1daSJoe Perches } 958bf1fa1daSJoe Perches 959ced69da1SQuentin Monnet $$wordsRef .= '|' if (defined $$wordsRef); 96075ad8c57SJerome Forissier $$wordsRef .= $line; 961bf1fa1daSJoe Perches } 96275ad8c57SJerome Forissier close($file); 96375ad8c57SJerome Forissier return 1; 964bf1fa1daSJoe Perches } 965bf1fa1daSJoe Perches 96675ad8c57SJerome Forissier return 0; 96775ad8c57SJerome Forissier} 96875ad8c57SJerome Forissier 969ced69da1SQuentin Monnetmy $const_structs; 970ced69da1SQuentin Monnetif (show_type("CONST_STRUCT")) { 97175ad8c57SJerome Forissier read_words(\$const_structs, $conststructsfile) 97275ad8c57SJerome Forissier or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 973ced69da1SQuentin Monnet} 97475ad8c57SJerome Forissier 975ced69da1SQuentin Monnetif (defined($typedefsfile)) { 976ced69da1SQuentin Monnet my $typeOtherTypedefs; 97775ad8c57SJerome Forissier read_words(\$typeOtherTypedefs, $typedefsfile) 97875ad8c57SJerome Forissier or warn "No additional types will be considered - file '$typedefsfile': $!\n"; 979ced69da1SQuentin Monnet $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs); 98075ad8c57SJerome Forissier} 98175ad8c57SJerome Forissier 9828905a67cSAndy Whitcroftsub build_types { 983485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 984485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 9851813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 9868716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 987c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 988ab7e23f3SJoe Perches $BasicType = qr{ 989ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 990ab7e23f3SJoe Perches (?:${all}\b) 991ab7e23f3SJoe Perches }x; 9928905a67cSAndy Whitcroft $NonptrType = qr{ 993d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 994cf655043SAndy Whitcroft (?: 9956b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 9968ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 997c45dcabdSAndy Whitcroft (?:${all}\b) 998cf655043SAndy Whitcroft ) 999c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 10008905a67cSAndy Whitcroft }x; 10011813087dSJoe Perches $NonptrTypeMisordered = qr{ 10021813087dSJoe Perches (?:$Modifier\s+|const\s+)* 10031813087dSJoe Perches (?: 10041813087dSJoe Perches (?:${Misordered}\b) 10051813087dSJoe Perches ) 10061813087dSJoe Perches (?:\s+$Modifier|\s+const)* 10071813087dSJoe Perches }x; 10088716de38SJoe Perches $NonptrTypeWithAttr = qr{ 10098716de38SJoe Perches (?:$Modifier\s+|const\s+)* 10108716de38SJoe Perches (?: 10118716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 10128716de38SJoe Perches (?:$typeTypedefs\b)| 10138716de38SJoe Perches (?:${allWithAttr}\b) 10148716de38SJoe Perches ) 10158716de38SJoe Perches (?:\s+$Modifier|\s+const)* 10168716de38SJoe Perches }x; 10178905a67cSAndy Whitcroft $Type = qr{ 1018c45dcabdSAndy Whitcroft $NonptrType 10197b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 1020c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 10218905a67cSAndy Whitcroft }x; 10221813087dSJoe Perches $TypeMisordered = qr{ 10231813087dSJoe Perches $NonptrTypeMisordered 10247b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 10251813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 10261813087dSJoe Perches }x; 102791cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 10281813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 10298905a67cSAndy Whitcroft} 10308905a67cSAndy Whitcroftbuild_types(); 10316c72ffaaSAndy Whitcroft 10327d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 1033d1fe9c09SJoe Perches 1034d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 1035d1fe9c09SJoe Perches# requires at least perl version v5.10.0 1036d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 1037d1fe9c09SJoe Perches 1038d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 10392435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 1040c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 10417d2367afSJoe Perches 1042f8422308SJoe Perchesour $declaration_macros = qr{(?x: 10433e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 1044fe658f94SSteffen Maier (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(| 10453d102fc0SGilad Ben-Yossef (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\( 1046f8422308SJoe Perches)}; 1047f8422308SJoe Perches 10488d0325ccSAditya Srivastavaour %allow_repeated_words = ( 10498d0325ccSAditya Srivastava add => '', 10508d0325ccSAditya Srivastava added => '', 10518d0325ccSAditya Srivastava bad => '', 10528d0325ccSAditya Srivastava be => '', 10538d0325ccSAditya Srivastava); 10548d0325ccSAditya Srivastava 10557d2367afSJoe Perchessub deparenthesize { 10567d2367afSJoe Perches my ($string) = @_; 10577d2367afSJoe Perches return "" if (!defined($string)); 10585b9553abSJoe Perches 10595b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 10605b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 10615b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 10625b9553abSJoe Perches } 10635b9553abSJoe Perches 10647d2367afSJoe Perches $string =~ s@\s+@ @g; 10655b9553abSJoe Perches 10667d2367afSJoe Perches return $string; 10677d2367afSJoe Perches} 10687d2367afSJoe Perches 10693445686aSJoe Perchessub seed_camelcase_file { 10703445686aSJoe Perches my ($file) = @_; 10713445686aSJoe Perches 10723445686aSJoe Perches return if (!(-f $file)); 10733445686aSJoe Perches 10743445686aSJoe Perches local $/; 10753445686aSJoe Perches 10763445686aSJoe Perches open(my $include_file, '<', "$file") 10773445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 10783445686aSJoe Perches my $text = <$include_file>; 10793445686aSJoe Perches close($include_file); 10803445686aSJoe Perches 10813445686aSJoe Perches my @lines = split('\n', $text); 10823445686aSJoe Perches 10833445686aSJoe Perches foreach my $line (@lines) { 10843445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 10853445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 10863445686aSJoe Perches $camelcase{$1} = 1; 108711ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 108811ea516aSJoe Perches $camelcase{$1} = 1; 108911ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 10903445686aSJoe Perches $camelcase{$1} = 1; 10913445686aSJoe Perches } 10923445686aSJoe Perches } 10933445686aSJoe Perches} 10943445686aSJoe Perches 1095cd28b119SJoe Perchesour %maintained_status = (); 1096cd28b119SJoe Perches 109785b0ee18SJoe Perchessub is_maintained_obsolete { 109885b0ee18SJoe Perches my ($filename) = @_; 109985b0ee18SJoe Perches 1100f2c19c2fSJerome Forissier return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 110185b0ee18SJoe Perches 1102cd28b119SJoe Perches if (!exists($maintained_status{$filename})) { 1103cd28b119SJoe Perches $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 1104cd28b119SJoe Perches } 110585b0ee18SJoe Perches 1106cd28b119SJoe Perches return $maintained_status{$filename} =~ /obsolete/i; 110785b0ee18SJoe Perches} 110885b0ee18SJoe Perches 11093b6e8ac9SJoe Perchessub is_SPDX_License_valid { 11103b6e8ac9SJoe Perches my ($license) = @_; 11113b6e8ac9SJoe Perches 1112f9363b31SGuenter Roeck return 1 if (!$tree || which("python3") eq "" || !(-x "$root/scripts/spdxcheck.py") || !(-e "$gitroot")); 11133b6e8ac9SJoe Perches 111456294112SJoe Perches my $root_path = abs_path($root); 1115f9363b31SGuenter Roeck my $status = `cd "$root_path"; echo "$license" | scripts/spdxcheck.py -`; 11163b6e8ac9SJoe Perches return 0 if ($status ne ""); 11173b6e8ac9SJoe Perches return 1; 11183b6e8ac9SJoe Perches} 11193b6e8ac9SJoe Perches 11203445686aSJoe Perchesmy $camelcase_seeded = 0; 11213445686aSJoe Perchessub seed_camelcase_includes { 11223445686aSJoe Perches return if ($camelcase_seeded); 11233445686aSJoe Perches 11243445686aSJoe Perches my $files; 1125c707a81dSJoe Perches my $camelcase_cache = ""; 1126c707a81dSJoe Perches my @include_files = (); 1127c707a81dSJoe Perches 1128c707a81dSJoe Perches $camelcase_seeded = 1; 1129351b2a1fSJoe Perches 11300f7f635bSJoe Perches if (-e "$gitroot") { 1131dbbf869dSJoe Perches my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`; 1132351b2a1fSJoe Perches chomp $git_last_include_commit; 1133c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 1134c707a81dSJoe Perches } else { 1135c707a81dSJoe Perches my $last_mod_date = 0; 1136c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 1137c707a81dSJoe Perches @include_files = split('\n', $files); 1138c707a81dSJoe Perches foreach my $file (@include_files) { 1139c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 1140c707a81dSJoe Perches localtime((stat $file)[9])); 1141c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 1142c707a81dSJoe Perches } 1143c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 1144c707a81dSJoe Perches } 1145c707a81dSJoe Perches 1146c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 1147c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 1148c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 1149351b2a1fSJoe Perches while (<$camelcase_file>) { 1150351b2a1fSJoe Perches chomp; 1151351b2a1fSJoe Perches $camelcase{$_} = 1; 1152351b2a1fSJoe Perches } 1153351b2a1fSJoe Perches close($camelcase_file); 1154351b2a1fSJoe Perches 1155351b2a1fSJoe Perches return; 1156351b2a1fSJoe Perches } 1157c707a81dSJoe Perches 11580f7f635bSJoe Perches if (-e "$gitroot") { 1159dbbf869dSJoe Perches $files = `${git_command} ls-files "include/*.h"`; 1160c707a81dSJoe Perches @include_files = split('\n', $files); 11613445686aSJoe Perches } 1162c707a81dSJoe Perches 11633445686aSJoe Perches foreach my $file (@include_files) { 11643445686aSJoe Perches seed_camelcase_file($file); 11653445686aSJoe Perches } 1166351b2a1fSJoe Perches 1167c707a81dSJoe Perches if ($camelcase_cache ne "") { 1168351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 1169c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 1170c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 1171351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 1172351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 1173351b2a1fSJoe Perches } 1174351b2a1fSJoe Perches close($camelcase_file); 1175351b2a1fSJoe Perches } 11763445686aSJoe Perches} 11773445686aSJoe Perches 1178f5f61325SJoe Perchessub git_is_single_file { 1179f5f61325SJoe Perches my ($filename) = @_; 1180f5f61325SJoe Perches 1181f5f61325SJoe Perches return 0 if ((which("git") eq "") || !(-e "$gitroot")); 1182f5f61325SJoe Perches 1183f5f61325SJoe Perches my $output = `${git_command} ls-files -- $filename 2>/dev/null`; 1184f5f61325SJoe Perches my $count = $output =~ tr/\n//; 1185f5f61325SJoe Perches return $count eq 1 && $output =~ m{^${filename}$}; 1186f5f61325SJoe Perches} 1187f5f61325SJoe Perches 1188d311cd44SJoe Perchessub git_commit_info { 1189d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 1190d311cd44SJoe Perches 11910f7f635bSJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot")); 1192d311cd44SJoe Perches 1193dbbf869dSJoe Perches my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`; 1194d311cd44SJoe Perches $output =~ s/^\s*//gm; 1195d311cd44SJoe Perches my @lines = split("\n", $output); 1196d311cd44SJoe Perches 11970d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 11980d7835fcSJoe Perches 11995a7f4455SSean Christopherson if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) { 1200d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 1201d311cd44SJoe Perches# all matching commit ids, but it's very slow... 1202d311cd44SJoe Perches# 1203d311cd44SJoe Perches# echo "checking commits $1..." 1204d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 1205d311cd44SJoe Perches# while read line ; do 1206d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 1207d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 1208d311cd44SJoe Perches# done 12094ce9f970SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./ || 12104ce9f970SJoe Perches $lines[0] =~ /^fatal: bad object $commit/) { 1211948b133aSHeinrich Schuchardt $id = undef; 1212d311cd44SJoe Perches } else { 1213d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 1214d311cd44SJoe Perches $desc = substr($lines[0], 41); 1215d311cd44SJoe Perches } 1216d311cd44SJoe Perches 1217d311cd44SJoe Perches return ($id, $desc); 1218d311cd44SJoe Perches} 1219d311cd44SJoe Perches 12206c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 12210a920b5bSAndy Whitcroft 122200df344fSAndy Whitcroftmy @rawlines = (); 1223c2fdda0dSAndy Whitcroftmy @lines = (); 12243705ce5bSJoe Perchesmy @fixed = (); 1225d752fcc8SJoe Perchesmy @fixed_inserted = (); 1226d752fcc8SJoe Perchesmy @fixed_deleted = (); 1227194f66fcSJoe Perchesmy $fixlinenr = -1; 1228194f66fcSJoe Perches 12294a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 12304a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 12310f7f635bSJoe Perchesdie "$P: No git repository found\n" if ($git && !-e "$gitroot"); 12324a593c34SDu, Changbin 12334a593c34SDu, Changbinif ($git) { 12344a593c34SDu, Changbin my @commits = (); 12350dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 12364a593c34SDu, Changbin my $git_range; 123728898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 123828898fd1SJoe Perches $git_range = "-$2 $1"; 12394a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 12404a593c34SDu, Changbin $git_range = "$commit_expr"; 12414a593c34SDu, Changbin } else { 12420dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 12430dea9f1eSJoe Perches } 1244dbbf869dSJoe Perches my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 12450dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 124628898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 124728898fd1SJoe Perches next if (!defined($1) || !defined($2)); 12480dea9f1eSJoe Perches my $sha1 = $1; 12490dea9f1eSJoe Perches my $subject = $2; 12500dea9f1eSJoe Perches unshift(@commits, $sha1); 12510dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 12524a593c34SDu, Changbin } 12534a593c34SDu, Changbin } 12544a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 12554a593c34SDu, Changbin @ARGV = @commits; 12564a593c34SDu, Changbin} 12574a593c34SDu, Changbin 1258c2fdda0dSAndy Whitcroftmy $vname; 125998005e8cSVadim Bendebury$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"}; 12606c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 126121caa13cSAndy Whitcroft my $FILE; 1262f5f61325SJoe Perches my $is_git_file = git_is_single_file($filename); 1263f5f61325SJoe Perches my $oldfile = $file; 1264f5f61325SJoe Perches $file = 1 if ($is_git_file); 12654a593c34SDu, Changbin if ($git) { 12664a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 12674a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 12684a593c34SDu, Changbin } elsif ($file) { 126921caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 12706c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 127121caa13cSAndy Whitcroft } elsif ($filename eq '-') { 127221caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 12736c72ffaaSAndy Whitcroft } else { 127421caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 12756c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 12766c72ffaaSAndy Whitcroft } 1277c2fdda0dSAndy Whitcroft if ($filename eq '-') { 1278c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 12794a593c34SDu, Changbin } elsif ($git) { 12800dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 1281c2fdda0dSAndy Whitcroft } else { 1282c2fdda0dSAndy Whitcroft $vname = $filename; 1283c2fdda0dSAndy Whitcroft } 128421caa13cSAndy Whitcroft while (<$FILE>) { 12850a920b5bSAndy Whitcroft chomp; 128600df344fSAndy Whitcroft push(@rawlines, $_); 1287c7f574d0SGeert Uytterhoeven $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i); 12886c72ffaaSAndy Whitcroft } 128921caa13cSAndy Whitcroft close($FILE); 1290d8469f16SJoe Perches 1291d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 1292d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1293d8469f16SJoe Perches print "$vname\n"; 1294d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1295d8469f16SJoe Perches } 1296d8469f16SJoe Perches 1297c2fdda0dSAndy Whitcroft if (!process($filename)) { 12980a920b5bSAndy Whitcroft $exit = 1; 12990a920b5bSAndy Whitcroft } 130000df344fSAndy Whitcroft @rawlines = (); 130113214adfSAndy Whitcroft @lines = (); 13023705ce5bSJoe Perches @fixed = (); 1303d752fcc8SJoe Perches @fixed_inserted = (); 1304d752fcc8SJoe Perches @fixed_deleted = (); 1305194f66fcSJoe Perches $fixlinenr = -1; 1306485ff23eSAlex Dowad @modifierListFile = (); 1307485ff23eSAlex Dowad @typeListFile = (); 1308485ff23eSAlex Dowad build_types(); 1309f5f61325SJoe Perches $file = $oldfile if ($is_git_file); 13100a920b5bSAndy Whitcroft} 13110a920b5bSAndy Whitcroft 1312d8469f16SJoe Perchesif (!$quiet) { 13133c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 13143c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 13153c816e49SJoe Perches 13165b57980dSJoe Perches if (!$perl_version_ok) { 1317d8469f16SJoe Perches print << "EOM" 1318d8469f16SJoe Perches 1319d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 13205b57980dSJoe Perches An upgrade to at least perl $minimum_perl_version is suggested. 1321d8469f16SJoe PerchesEOM 1322d8469f16SJoe Perches } 1323d8469f16SJoe Perches if ($exit) { 1324d8469f16SJoe Perches print << "EOM" 1325d8469f16SJoe Perches 1326d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 1327d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 1328d8469f16SJoe PerchesEOM 1329d8469f16SJoe Perches } 1330d8469f16SJoe Perches} 1331d8469f16SJoe Perches 13320a920b5bSAndy Whitcroftexit($exit); 13330a920b5bSAndy Whitcroft 13340a920b5bSAndy Whitcroftsub top_of_kernel_tree { 13356c72ffaaSAndy Whitcroft my ($root) = @_; 13366c72ffaaSAndy Whitcroft 13376c72ffaaSAndy Whitcroft my @tree_check = ( 13386c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 13396c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 13406c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 13416c72ffaaSAndy Whitcroft ); 13426c72ffaaSAndy Whitcroft 13436c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 13446c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 13450a920b5bSAndy Whitcroft return 0; 13460a920b5bSAndy Whitcroft } 13476c72ffaaSAndy Whitcroft } 13486c72ffaaSAndy Whitcroft return 1; 13496c72ffaaSAndy Whitcroft} 13500a920b5bSAndy Whitcroft 135120112475SJoe Perchessub parse_email { 135220112475SJoe Perches my ($formatted_email) = @_; 135320112475SJoe Perches 135420112475SJoe Perches my $name = ""; 1355fccaebf0SDwaipayan Ray my $quoted = ""; 1356dfa05c28SJoe Perches my $name_comment = ""; 135720112475SJoe Perches my $address = ""; 135820112475SJoe Perches my $comment = ""; 135920112475SJoe Perches 136020112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 136120112475SJoe Perches $name = $1; 136220112475SJoe Perches $address = $2; 136320112475SJoe Perches $comment = $3 if defined $3; 136420112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 136520112475SJoe Perches $address = $1; 136620112475SJoe Perches $comment = $2 if defined $2; 136720112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 136820112475SJoe Perches $address = $1; 136920112475SJoe Perches $comment = $2 if defined $2; 137085e12066SJoe Perches $formatted_email =~ s/\Q$address\E.*$//; 137120112475SJoe Perches $name = $formatted_email; 13723705ce5bSJoe Perches $name = trim($name); 137320112475SJoe Perches $name =~ s/^\"|\"$//g; 137420112475SJoe Perches # If there's a name left after stripping spaces and 137520112475SJoe Perches # leading quotes, and the address doesn't have both 137620112475SJoe Perches # leading and trailing angle brackets, the address 137720112475SJoe Perches # is invalid. ie: 137820112475SJoe Perches # "joe smith [email protected]" bad 137920112475SJoe Perches # "joe smith <[email protected]" bad 138020112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 138120112475SJoe Perches $name = ""; 138220112475SJoe Perches $address = ""; 138320112475SJoe Perches $comment = ""; 138420112475SJoe Perches } 138520112475SJoe Perches } 138620112475SJoe Perches 1387fccaebf0SDwaipayan Ray # Extract comments from names excluding quoted parts 1388fccaebf0SDwaipayan Ray # "John D. (Doe)" - Do not extract 1389fccaebf0SDwaipayan Ray if ($name =~ s/\"(.+)\"//) { 1390fccaebf0SDwaipayan Ray $quoted = $1; 1391dfa05c28SJoe Perches } 1392fccaebf0SDwaipayan Ray while ($name =~ s/\s*($balanced_parens)\s*/ /) { 1393fccaebf0SDwaipayan Ray $name_comment .= trim($1); 1394fccaebf0SDwaipayan Ray } 1395fccaebf0SDwaipayan Ray $name =~ s/^[ \"]+|[ \"]+$//g; 1396fccaebf0SDwaipayan Ray $name = trim("$quoted $name"); 1397fccaebf0SDwaipayan Ray 13983705ce5bSJoe Perches $address = trim($address); 139920112475SJoe Perches $address =~ s/^\<|\>$//g; 1400fccaebf0SDwaipayan Ray $comment = trim($comment); 140120112475SJoe Perches 140220112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 140320112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 140420112475SJoe Perches $name = "\"$name\""; 140520112475SJoe Perches } 140620112475SJoe Perches 1407dfa05c28SJoe Perches return ($name, $name_comment, $address, $comment); 140820112475SJoe Perches} 140920112475SJoe Perches 141020112475SJoe Perchessub format_email { 141148ca2d8aSDwaipayan Ray my ($name, $name_comment, $address, $comment) = @_; 141220112475SJoe Perches 141320112475SJoe Perches my $formatted_email; 141420112475SJoe Perches 1415fccaebf0SDwaipayan Ray $name =~ s/^[ \"]+|[ \"]+$//g; 14163705ce5bSJoe Perches $address = trim($address); 1417fccaebf0SDwaipayan Ray $address =~ s/(?:\.|\,|\")+$//; ##trailing commas, dots or quotes 141820112475SJoe Perches 141920112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 142020112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 142120112475SJoe Perches $name = "\"$name\""; 142220112475SJoe Perches } 142320112475SJoe Perches 1424fccaebf0SDwaipayan Ray $name_comment = trim($name_comment); 1425fccaebf0SDwaipayan Ray $name_comment = " $name_comment" if ($name_comment ne ""); 1426fccaebf0SDwaipayan Ray $comment = trim($comment); 1427fccaebf0SDwaipayan Ray $comment = " $comment" if ($comment ne ""); 1428fccaebf0SDwaipayan Ray 142920112475SJoe Perches if ("$name" eq "") { 143020112475SJoe Perches $formatted_email = "$address"; 143120112475SJoe Perches } else { 143248ca2d8aSDwaipayan Ray $formatted_email = "$name$name_comment <$address>"; 143320112475SJoe Perches } 143448ca2d8aSDwaipayan Ray $formatted_email .= "$comment"; 143520112475SJoe Perches return $formatted_email; 143620112475SJoe Perches} 143720112475SJoe Perches 1438dfa05c28SJoe Perchessub reformat_email { 1439dfa05c28SJoe Perches my ($email) = @_; 1440dfa05c28SJoe Perches 1441dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 144248ca2d8aSDwaipayan Ray return format_email($email_name, $name_comment, $email_address, $comment); 1443dfa05c28SJoe Perches} 1444dfa05c28SJoe Perches 1445dfa05c28SJoe Perchessub same_email_addresses { 1446fccaebf0SDwaipayan Ray my ($email1, $email2) = @_; 1447dfa05c28SJoe Perches 1448dfa05c28SJoe Perches my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1); 1449dfa05c28SJoe Perches my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2); 1450dfa05c28SJoe Perches 145148ca2d8aSDwaipayan Ray return $email1_name eq $email2_name && 145248ca2d8aSDwaipayan Ray $email1_address eq $email2_address && 145348ca2d8aSDwaipayan Ray $name1_comment eq $name2_comment && 145448ca2d8aSDwaipayan Ray $comment1 eq $comment2; 145548ca2d8aSDwaipayan Ray} 1456dfa05c28SJoe Perches 1457d311cd44SJoe Perchessub which { 1458d311cd44SJoe Perches my ($bin) = @_; 1459d311cd44SJoe Perches 1460d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1461d311cd44SJoe Perches if (-e "$path/$bin") { 1462d311cd44SJoe Perches return "$path/$bin"; 1463d311cd44SJoe Perches } 1464d311cd44SJoe Perches } 1465d311cd44SJoe Perches 1466d311cd44SJoe Perches return ""; 1467d311cd44SJoe Perches} 1468d311cd44SJoe Perches 1469000d1cc1SJoe Perchessub which_conf { 1470000d1cc1SJoe Perches my ($conf) = @_; 1471000d1cc1SJoe Perches 1472000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1473000d1cc1SJoe Perches if (-e "$path/$conf") { 1474000d1cc1SJoe Perches return "$path/$conf"; 1475000d1cc1SJoe Perches } 1476000d1cc1SJoe Perches } 1477000d1cc1SJoe Perches 1478000d1cc1SJoe Perches return ""; 1479000d1cc1SJoe Perches} 1480000d1cc1SJoe Perches 14810a920b5bSAndy Whitcroftsub expand_tabs { 14820a920b5bSAndy Whitcroft my ($str) = @_; 14830a920b5bSAndy Whitcroft 14840a920b5bSAndy Whitcroft my $res = ''; 14850a920b5bSAndy Whitcroft my $n = 0; 14860a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 14870a920b5bSAndy Whitcroft if ($c eq "\t") { 14880a920b5bSAndy Whitcroft $res .= ' '; 14890a920b5bSAndy Whitcroft $n++; 1490713a09deSAntonio Borneo for (; ($n % $tabsize) != 0; $n++) { 14910a920b5bSAndy Whitcroft $res .= ' '; 14920a920b5bSAndy Whitcroft } 14930a920b5bSAndy Whitcroft next; 14940a920b5bSAndy Whitcroft } 14950a920b5bSAndy Whitcroft $res .= $c; 14960a920b5bSAndy Whitcroft $n++; 14970a920b5bSAndy Whitcroft } 14980a920b5bSAndy Whitcroft 14990a920b5bSAndy Whitcroft return $res; 15000a920b5bSAndy Whitcroft} 15016c72ffaaSAndy Whitcroftsub copy_spacing { 1502773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 15036c72ffaaSAndy Whitcroft return $res; 15046c72ffaaSAndy Whitcroft} 15050a920b5bSAndy Whitcroft 15064a0df2efSAndy Whitcroftsub line_stats { 15074a0df2efSAndy Whitcroft my ($line) = @_; 15084a0df2efSAndy Whitcroft 15094a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 15104a0df2efSAndy Whitcroft $line =~ s/^.//; 15114a0df2efSAndy Whitcroft $line = expand_tabs($line); 15124a0df2efSAndy Whitcroft 15134a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 15144a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 15154a0df2efSAndy Whitcroft 15164a0df2efSAndy Whitcroft return (length($line), length($white)); 15174a0df2efSAndy Whitcroft} 15184a0df2efSAndy Whitcroft 1519773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1520773647a0SAndy Whitcroft 1521773647a0SAndy Whitcroftsub sanitise_line_reset { 1522773647a0SAndy Whitcroft my ($in_comment) = @_; 1523773647a0SAndy Whitcroft 1524773647a0SAndy Whitcroft if ($in_comment) { 1525773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1526773647a0SAndy Whitcroft } else { 1527773647a0SAndy Whitcroft $sanitise_quote = ''; 1528773647a0SAndy Whitcroft } 1529773647a0SAndy Whitcroft} 153000df344fSAndy Whitcroftsub sanitise_line { 153100df344fSAndy Whitcroft my ($line) = @_; 153200df344fSAndy Whitcroft 153300df344fSAndy Whitcroft my $res = ''; 153400df344fSAndy Whitcroft my $l = ''; 153500df344fSAndy Whitcroft 1536c2fdda0dSAndy Whitcroft my $qlen = 0; 1537773647a0SAndy Whitcroft my $off = 0; 1538773647a0SAndy Whitcroft my $c; 153900df344fSAndy Whitcroft 1540773647a0SAndy Whitcroft # Always copy over the diff marker. 1541773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1542773647a0SAndy Whitcroft 1543773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1544773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1545773647a0SAndy Whitcroft 15468d2e11b2SClaudio Fontana # Comments we are whacking completely including the begin 1547773647a0SAndy Whitcroft # and end, all to $;. 1548773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1549773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1550773647a0SAndy Whitcroft 1551773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1552773647a0SAndy Whitcroft $off++; 155300df344fSAndy Whitcroft next; 1554773647a0SAndy Whitcroft } 155581bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1556773647a0SAndy Whitcroft $sanitise_quote = ''; 1557773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1558773647a0SAndy Whitcroft $off++; 1559773647a0SAndy Whitcroft next; 1560773647a0SAndy Whitcroft } 1561113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1562113f04a8SDaniel Walker $sanitise_quote = '//'; 1563113f04a8SDaniel Walker 1564113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1565113f04a8SDaniel Walker $off++; 1566113f04a8SDaniel Walker next; 1567113f04a8SDaniel Walker } 1568773647a0SAndy Whitcroft 1569773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1570773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1571773647a0SAndy Whitcroft $c eq "\\") { 1572773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1573773647a0SAndy Whitcroft $off++; 1574773647a0SAndy Whitcroft next; 1575773647a0SAndy Whitcroft } 1576773647a0SAndy Whitcroft # Regular quotes. 1577773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1578773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1579773647a0SAndy Whitcroft $sanitise_quote = $c; 1580773647a0SAndy Whitcroft 1581773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1582773647a0SAndy Whitcroft next; 1583773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1584773647a0SAndy Whitcroft $sanitise_quote = ''; 158500df344fSAndy Whitcroft } 158600df344fSAndy Whitcroft } 1587773647a0SAndy Whitcroft 1588fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1589773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1590773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1591113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1592113f04a8SDaniel Walker substr($res, $off, 1, $;); 1593773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1594773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 159500df344fSAndy Whitcroft } else { 1596773647a0SAndy Whitcroft substr($res, $off, 1, $c); 159700df344fSAndy Whitcroft } 1598c2fdda0dSAndy Whitcroft } 1599c2fdda0dSAndy Whitcroft 1600113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1601113f04a8SDaniel Walker $sanitise_quote = ''; 1602113f04a8SDaniel Walker } 1603113f04a8SDaniel Walker 1604c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1605c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1606c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1607c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1608c2fdda0dSAndy Whitcroft 1609c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1610c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1611c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1612c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1613c2fdda0dSAndy Whitcroft } 1614c2fdda0dSAndy Whitcroft 1615dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1616dadf680dSJoe Perches my $match = $1; 1617dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1618dadf680dSJoe Perches } 1619dadf680dSJoe Perches 162000df344fSAndy Whitcroft return $res; 162100df344fSAndy Whitcroft} 162200df344fSAndy Whitcroft 1623a6962d72SJoe Perchessub get_quoted_string { 1624a6962d72SJoe Perches my ($line, $rawline) = @_; 1625a6962d72SJoe Perches 1626478b1799SJoe Perches return "" if (!defined($line) || !defined($rawline)); 162733acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1628a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1629a6962d72SJoe Perches} 1630a6962d72SJoe Perches 16318905a67cSAndy Whitcroftsub ctx_statement_block { 16328905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 16338905a67cSAndy Whitcroft my $line = $linenr - 1; 16348905a67cSAndy Whitcroft my $blk = ''; 16358905a67cSAndy Whitcroft my $soff = $off; 16368905a67cSAndy Whitcroft my $coff = $off - 1; 1637773647a0SAndy Whitcroft my $coff_set = 0; 16388905a67cSAndy Whitcroft 163913214adfSAndy Whitcroft my $loff = 0; 164013214adfSAndy Whitcroft 16418905a67cSAndy Whitcroft my $type = ''; 16428905a67cSAndy Whitcroft my $level = 0; 1643a2750645SAndy Whitcroft my @stack = (); 1644cf655043SAndy Whitcroft my $p; 16458905a67cSAndy Whitcroft my $c; 16468905a67cSAndy Whitcroft my $len = 0; 164713214adfSAndy Whitcroft 164813214adfSAndy Whitcroft my $remainder; 16498905a67cSAndy Whitcroft while (1) { 1650a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1651a2750645SAndy Whitcroft 1652773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 16538905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 16548905a67cSAndy Whitcroft # context. 16558905a67cSAndy Whitcroft if ($off >= $len) { 16568905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1657dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1658c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 16598905a67cSAndy Whitcroft $remain--; 166013214adfSAndy Whitcroft $loff = $len; 1661c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 16628905a67cSAndy Whitcroft $len = length($blk); 16638905a67cSAndy Whitcroft $line++; 16648905a67cSAndy Whitcroft last; 16658905a67cSAndy Whitcroft } 16668905a67cSAndy Whitcroft # Bail if there is no further context. 16678905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 166813214adfSAndy Whitcroft if ($off >= $len) { 16698905a67cSAndy Whitcroft last; 16708905a67cSAndy Whitcroft } 1671f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1672f74bd194SAndy Whitcroft $level++; 1673f74bd194SAndy Whitcroft $type = '#'; 1674f74bd194SAndy Whitcroft } 16758905a67cSAndy Whitcroft } 1676cf655043SAndy Whitcroft $p = $c; 16778905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 167813214adfSAndy Whitcroft $remainder = substr($blk, $off); 16798905a67cSAndy Whitcroft 1680773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 16814635f4fbSAndy Whitcroft 16824635f4fbSAndy Whitcroft # Handle nested #if/#else. 16834635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 16844635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 16854635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 16864635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 16874635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 16884635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 16894635f4fbSAndy Whitcroft } 16904635f4fbSAndy Whitcroft 16918905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 16928905a67cSAndy Whitcroft # outermost level. 16938905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 16948905a67cSAndy Whitcroft last; 16958905a67cSAndy Whitcroft } 16968905a67cSAndy Whitcroft 169713214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1698773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1699773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1700773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1701773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1702773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1703773647a0SAndy Whitcroft $coff_set = 1; 1704773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1705773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 170613214adfSAndy Whitcroft } 170713214adfSAndy Whitcroft 17088905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 17098905a67cSAndy Whitcroft $level++; 17108905a67cSAndy Whitcroft $type = '('; 17118905a67cSAndy Whitcroft } 17128905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 17138905a67cSAndy Whitcroft $level--; 17148905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 17158905a67cSAndy Whitcroft 17168905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 17178905a67cSAndy Whitcroft $coff = $off; 1718773647a0SAndy Whitcroft $coff_set = 1; 1719773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 17208905a67cSAndy Whitcroft } 17218905a67cSAndy Whitcroft } 17228905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 17238905a67cSAndy Whitcroft $level++; 17248905a67cSAndy Whitcroft $type = '{'; 17258905a67cSAndy Whitcroft } 17268905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 17278905a67cSAndy Whitcroft $level--; 17288905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 17298905a67cSAndy Whitcroft 17308905a67cSAndy Whitcroft if ($level == 0) { 1731b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1732b998e001SPatrick Pannuto $off++; 1733b998e001SPatrick Pannuto } 17348905a67cSAndy Whitcroft last; 17358905a67cSAndy Whitcroft } 17368905a67cSAndy Whitcroft } 1737f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1738f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1739f74bd194SAndy Whitcroft $level--; 1740f74bd194SAndy Whitcroft $type = ''; 1741f74bd194SAndy Whitcroft $off++; 1742f74bd194SAndy Whitcroft last; 1743f74bd194SAndy Whitcroft } 17448905a67cSAndy Whitcroft $off++; 17458905a67cSAndy Whitcroft } 1746a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 174713214adfSAndy Whitcroft if ($off == $len) { 1748a3bb97a7SAndy Whitcroft $loff = $len + 1; 174913214adfSAndy Whitcroft $line++; 175013214adfSAndy Whitcroft $remain--; 175113214adfSAndy Whitcroft } 17528905a67cSAndy Whitcroft 17538905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 17548905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 17558905a67cSAndy Whitcroft 17568905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 17578905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 17588905a67cSAndy Whitcroft 1759773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 176013214adfSAndy Whitcroft 176113214adfSAndy Whitcroft return ($statement, $condition, 176213214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 176313214adfSAndy Whitcroft} 176413214adfSAndy Whitcroft 1765cf655043SAndy Whitcroftsub statement_lines { 1766cf655043SAndy Whitcroft my ($stmt) = @_; 1767cf655043SAndy Whitcroft 1768cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1769cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1770cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1771cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1772cf655043SAndy Whitcroft 1773cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1774cf655043SAndy Whitcroft 1775cf655043SAndy Whitcroft return $#stmt_lines + 2; 1776cf655043SAndy Whitcroft} 1777cf655043SAndy Whitcroft 1778cf655043SAndy Whitcroftsub statement_rawlines { 1779cf655043SAndy Whitcroft my ($stmt) = @_; 1780cf655043SAndy Whitcroft 1781cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1782cf655043SAndy Whitcroft 1783cf655043SAndy Whitcroft return $#stmt_lines + 2; 1784cf655043SAndy Whitcroft} 1785cf655043SAndy Whitcroft 1786cf655043SAndy Whitcroftsub statement_block_size { 1787cf655043SAndy Whitcroft my ($stmt) = @_; 1788cf655043SAndy Whitcroft 1789cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1790cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1791cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1792cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1793cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1794cf655043SAndy Whitcroft 1795cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1796cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1797cf655043SAndy Whitcroft 1798cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1799cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1800cf655043SAndy Whitcroft 1801cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1802cf655043SAndy Whitcroft return $stmt_lines; 1803cf655043SAndy Whitcroft } else { 1804cf655043SAndy Whitcroft return $stmt_statements; 1805cf655043SAndy Whitcroft } 1806cf655043SAndy Whitcroft} 1807cf655043SAndy Whitcroft 180813214adfSAndy Whitcroftsub ctx_statement_full { 180913214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 181013214adfSAndy Whitcroft my ($statement, $condition, $level); 181113214adfSAndy Whitcroft 181213214adfSAndy Whitcroft my (@chunks); 181313214adfSAndy Whitcroft 1814cf655043SAndy Whitcroft # Grab the first conditional/block pair. 181513214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 181613214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1817773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 181813214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1819cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1820cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1821cf655043SAndy Whitcroft } 1822cf655043SAndy Whitcroft 1823cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1824cf655043SAndy Whitcroft # could continue the statement. 1825cf655043SAndy Whitcroft for (;;) { 182613214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 182713214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1828cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1829773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1830cf655043SAndy Whitcroft #print "C: push\n"; 1831cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 183213214adfSAndy Whitcroft } 183313214adfSAndy Whitcroft 183413214adfSAndy Whitcroft return ($level, $linenr, @chunks); 18358905a67cSAndy Whitcroft} 18368905a67cSAndy Whitcroft 18374a0df2efSAndy Whitcroftsub ctx_block_get { 1838f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 18394a0df2efSAndy Whitcroft my $line; 18404a0df2efSAndy Whitcroft my $start = $linenr - 1; 18414a0df2efSAndy Whitcroft my $blk = ''; 18424a0df2efSAndy Whitcroft my @o; 18434a0df2efSAndy Whitcroft my @c; 18444a0df2efSAndy Whitcroft my @res = (); 18454a0df2efSAndy Whitcroft 1846f0a594c1SAndy Whitcroft my $level = 0; 18474635f4fbSAndy Whitcroft my @stack = ($level); 184800df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 184900df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 185000df344fSAndy Whitcroft $remain--; 185100df344fSAndy Whitcroft 185200df344fSAndy Whitcroft $blk .= $rawlines[$line]; 18534635f4fbSAndy Whitcroft 18544635f4fbSAndy Whitcroft # Handle nested #if/#else. 185501464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 18564635f4fbSAndy Whitcroft push(@stack, $level); 185701464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 18584635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 185901464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 18604635f4fbSAndy Whitcroft $level = pop(@stack); 18614635f4fbSAndy Whitcroft } 18624635f4fbSAndy Whitcroft 186301464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1864f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1865f0a594c1SAndy Whitcroft if ($off > 0) { 1866f0a594c1SAndy Whitcroft $off--; 1867f0a594c1SAndy Whitcroft next; 1868f0a594c1SAndy Whitcroft } 18694a0df2efSAndy Whitcroft 1870f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1871f0a594c1SAndy Whitcroft $level--; 1872f0a594c1SAndy Whitcroft last if ($level == 0); 1873f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1874f0a594c1SAndy Whitcroft $level++; 1875f0a594c1SAndy Whitcroft } 1876f0a594c1SAndy Whitcroft } 18774a0df2efSAndy Whitcroft 1878f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 187900df344fSAndy Whitcroft push(@res, $rawlines[$line]); 18804a0df2efSAndy Whitcroft } 18814a0df2efSAndy Whitcroft 1882f0a594c1SAndy Whitcroft last if ($level == 0); 18834a0df2efSAndy Whitcroft } 18844a0df2efSAndy Whitcroft 1885f0a594c1SAndy Whitcroft return ($level, @res); 18864a0df2efSAndy Whitcroft} 18874a0df2efSAndy Whitcroftsub ctx_block_outer { 18884a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 18894a0df2efSAndy Whitcroft 1890f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1891f0a594c1SAndy Whitcroft return @r; 18924a0df2efSAndy Whitcroft} 18934a0df2efSAndy Whitcroftsub ctx_block { 18944a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 18954a0df2efSAndy Whitcroft 1896f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1897f0a594c1SAndy Whitcroft return @r; 1898653d4876SAndy Whitcroft} 1899653d4876SAndy Whitcroftsub ctx_statement { 1900f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1901f0a594c1SAndy Whitcroft 1902f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1903f0a594c1SAndy Whitcroft return @r; 1904f0a594c1SAndy Whitcroft} 1905f0a594c1SAndy Whitcroftsub ctx_block_level { 1906653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1907653d4876SAndy Whitcroft 1908f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 19094a0df2efSAndy Whitcroft} 19109c0ca6f9SAndy Whitcroftsub ctx_statement_level { 19119c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 19129c0ca6f9SAndy Whitcroft 19139c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 19149c0ca6f9SAndy Whitcroft} 19154a0df2efSAndy Whitcroft 19164a0df2efSAndy Whitcroftsub ctx_locate_comment { 19174a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 19184a0df2efSAndy Whitcroft 1919a55ee0ccSJoe Perches # If c99 comment on the current line, or the line before or after 1920a55ee0ccSJoe Perches my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@); 1921a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1922a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@); 1923a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1924a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@); 1925a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1926a55ee0ccSJoe Perches 19274a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1928a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 19294a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 19304a0df2efSAndy Whitcroft 19314a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 19324a0df2efSAndy Whitcroft # comment. 19334a0df2efSAndy Whitcroft my $in_comment = 0; 19344a0df2efSAndy Whitcroft $current_comment = ''; 19354a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 193600df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 193700df344fSAndy Whitcroft #warn " $line\n"; 19384a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 19394a0df2efSAndy Whitcroft $in_comment = 1; 19404a0df2efSAndy Whitcroft } 19414a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 19424a0df2efSAndy Whitcroft $in_comment = 1; 19434a0df2efSAndy Whitcroft } 19444a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 19454a0df2efSAndy Whitcroft $current_comment = ''; 19464a0df2efSAndy Whitcroft } 19474a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 19484a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 19494a0df2efSAndy Whitcroft $in_comment = 0; 19504a0df2efSAndy Whitcroft } 19514a0df2efSAndy Whitcroft } 19524a0df2efSAndy Whitcroft 19534a0df2efSAndy Whitcroft chomp($current_comment); 19544a0df2efSAndy Whitcroft return($current_comment); 19554a0df2efSAndy Whitcroft} 19564a0df2efSAndy Whitcroftsub ctx_has_comment { 19574a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 19584a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 19594a0df2efSAndy Whitcroft 196000df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 19614a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 19624a0df2efSAndy Whitcroft 19634a0df2efSAndy Whitcroft return ($cmt ne ''); 19644a0df2efSAndy Whitcroft} 19654a0df2efSAndy Whitcroft 19664d001e4dSAndy Whitcroftsub raw_line { 19674d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 19684d001e4dSAndy Whitcroft 19694d001e4dSAndy Whitcroft my $offset = $linenr - 1; 19704d001e4dSAndy Whitcroft $cnt++; 19714d001e4dSAndy Whitcroft 19724d001e4dSAndy Whitcroft my $line; 19734d001e4dSAndy Whitcroft while ($cnt) { 19744d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 19754d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 19764d001e4dSAndy Whitcroft $cnt--; 19774d001e4dSAndy Whitcroft } 19784d001e4dSAndy Whitcroft 19794d001e4dSAndy Whitcroft return $line; 19804d001e4dSAndy Whitcroft} 19814d001e4dSAndy Whitcroft 19822a9f9d85STobin C. Hardingsub get_stat_real { 19832a9f9d85STobin C. Harding my ($linenr, $lc) = @_; 19842a9f9d85STobin C. Harding 19852a9f9d85STobin C. Harding my $stat_real = raw_line($linenr, 0); 19862a9f9d85STobin C. Harding for (my $count = $linenr + 1; $count <= $lc; $count++) { 19872a9f9d85STobin C. Harding $stat_real = $stat_real . "\n" . raw_line($count, 0); 19882a9f9d85STobin C. Harding } 19892a9f9d85STobin C. Harding 19902a9f9d85STobin C. Harding return $stat_real; 19912a9f9d85STobin C. Harding} 19922a9f9d85STobin C. Harding 1993e3d95a2aSTobin C. Hardingsub get_stat_here { 1994e3d95a2aSTobin C. Harding my ($linenr, $cnt, $here) = @_; 1995e3d95a2aSTobin C. Harding 1996e3d95a2aSTobin C. Harding my $herectx = $here . "\n"; 1997e3d95a2aSTobin C. Harding for (my $n = 0; $n < $cnt; $n++) { 1998e3d95a2aSTobin C. Harding $herectx .= raw_line($linenr, $n) . "\n"; 1999e3d95a2aSTobin C. Harding } 2000e3d95a2aSTobin C. Harding 2001e3d95a2aSTobin C. Harding return $herectx; 2002e3d95a2aSTobin C. Harding} 2003e3d95a2aSTobin C. Harding 20040a920b5bSAndy Whitcroftsub cat_vet { 20050a920b5bSAndy Whitcroft my ($vet) = @_; 20069c0ca6f9SAndy Whitcroft my ($res, $coded); 20070a920b5bSAndy Whitcroft 20089c0ca6f9SAndy Whitcroft $res = ''; 20096c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 20106c72ffaaSAndy Whitcroft $res .= $1; 20116c72ffaaSAndy Whitcroft if ($2 ne '') { 20129c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 20136c72ffaaSAndy Whitcroft $res .= $coded; 20146c72ffaaSAndy Whitcroft } 20159c0ca6f9SAndy Whitcroft } 20169c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 20170a920b5bSAndy Whitcroft 20189c0ca6f9SAndy Whitcroft return $res; 20190a920b5bSAndy Whitcroft} 20200a920b5bSAndy Whitcroft 2021c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 2022cf655043SAndy Whitcroftmy $av_pending; 2023c2fdda0dSAndy Whitcroftmy @av_paren_type; 20241f65f947SAndy Whitcroftmy $av_pend_colon; 2025c2fdda0dSAndy Whitcroft 2026c2fdda0dSAndy Whitcroftsub annotate_reset { 2027c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 2028cf655043SAndy Whitcroft $av_pending = '_'; 2029cf655043SAndy Whitcroft @av_paren_type = ('E'); 20301f65f947SAndy Whitcroft $av_pend_colon = 'O'; 2031c2fdda0dSAndy Whitcroft} 2032c2fdda0dSAndy Whitcroft 20336c72ffaaSAndy Whitcroftsub annotate_values { 20346c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 20356c72ffaaSAndy Whitcroft 20366c72ffaaSAndy Whitcroft my $res; 20371f65f947SAndy Whitcroft my $var = '_' x length($stream); 20386c72ffaaSAndy Whitcroft my $cur = $stream; 20396c72ffaaSAndy Whitcroft 2040c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 20416c72ffaaSAndy Whitcroft 20426c72ffaaSAndy Whitcroft while (length($cur)) { 2043773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 2044cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 2045171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 20466c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 2047c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 2048c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 2049cf655043SAndy Whitcroft $type = pop(@av_paren_type); 2050c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 20516c72ffaaSAndy Whitcroft } 20526c72ffaaSAndy Whitcroft 2053c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 20549446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 20559446ef56SAndy Whitcroft push(@av_paren_type, $type); 2056addcdceaSAndy Whitcroft $type = 'c'; 20579446ef56SAndy Whitcroft 2058e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 2059c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 20606c72ffaaSAndy Whitcroft $type = 'T'; 20616c72ffaaSAndy Whitcroft 2062389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 2063389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 2064389a2fe5SAndy Whitcroft $type = 'T'; 2065389a2fe5SAndy Whitcroft 2066c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 2067171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 2068c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 2069171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 2070171ae1a4SAndy Whitcroft if ($2 ne '') { 2071cf655043SAndy Whitcroft $av_pending = 'N'; 2072171ae1a4SAndy Whitcroft } 2073171ae1a4SAndy Whitcroft $type = 'E'; 2074171ae1a4SAndy Whitcroft 2075c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 2076171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 2077171ae1a4SAndy Whitcroft $av_preprocessor = 1; 2078171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 20796c72ffaaSAndy Whitcroft 2080c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 2081cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 2082c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 2083cf655043SAndy Whitcroft 2084cf655043SAndy Whitcroft push(@av_paren_type, $type); 2085cf655043SAndy Whitcroft push(@av_paren_type, $type); 2086171ae1a4SAndy Whitcroft $type = 'E'; 2087cf655043SAndy Whitcroft 2088c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 2089cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 2090cf655043SAndy Whitcroft $av_preprocessor = 1; 2091cf655043SAndy Whitcroft 2092cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 2093cf655043SAndy Whitcroft 2094171ae1a4SAndy Whitcroft $type = 'E'; 2095cf655043SAndy Whitcroft 2096c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 2097cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 2098cf655043SAndy Whitcroft 2099cf655043SAndy Whitcroft $av_preprocessor = 1; 2100cf655043SAndy Whitcroft 2101cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 2102cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 2103cf655043SAndy Whitcroft pop(@av_paren_type); 2104cf655043SAndy Whitcroft push(@av_paren_type, $type); 2105171ae1a4SAndy Whitcroft $type = 'E'; 21066c72ffaaSAndy Whitcroft 21076c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 2108c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 21096c72ffaaSAndy Whitcroft 2110171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 2111171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 2112171ae1a4SAndy Whitcroft $av_pending = $type; 2113171ae1a4SAndy Whitcroft $type = 'N'; 2114171ae1a4SAndy Whitcroft 21156c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 2116c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 21176c72ffaaSAndy Whitcroft if (defined $2) { 2118cf655043SAndy Whitcroft $av_pending = 'V'; 21196c72ffaaSAndy Whitcroft } 21206c72ffaaSAndy Whitcroft $type = 'N'; 21216c72ffaaSAndy Whitcroft 212214b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 2123c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 212414b111c1SAndy Whitcroft $av_pending = 'E'; 21256c72ffaaSAndy Whitcroft $type = 'N'; 21266c72ffaaSAndy Whitcroft 21271f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 21281f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 21291f65f947SAndy Whitcroft $av_pend_colon = 'C'; 21301f65f947SAndy Whitcroft $type = 'N'; 21311f65f947SAndy Whitcroft 213214b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 2133c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 21346c72ffaaSAndy Whitcroft $type = 'N'; 21356c72ffaaSAndy Whitcroft 21366c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 2137c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 2138cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 2139cf655043SAndy Whitcroft $av_pending = '_'; 21406c72ffaaSAndy Whitcroft $type = 'N'; 21416c72ffaaSAndy Whitcroft 21426c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 2143cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 2144cf655043SAndy Whitcroft if ($new_type ne '_') { 2145cf655043SAndy Whitcroft $type = $new_type; 2146c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 2147c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 21486c72ffaaSAndy Whitcroft } else { 2149c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 21506c72ffaaSAndy Whitcroft } 21516c72ffaaSAndy Whitcroft 2152c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 2153c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 2154c8cb2ca3SAndy Whitcroft $type = 'V'; 2155cf655043SAndy Whitcroft $av_pending = 'V'; 21566c72ffaaSAndy Whitcroft 21578e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 21588e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 21591f65f947SAndy Whitcroft $av_pend_colon = 'B'; 21608e761b04SAndy Whitcroft } elsif ($type eq 'E') { 21618e761b04SAndy Whitcroft $av_pend_colon = 'L'; 21621f65f947SAndy Whitcroft } 21631f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 21641f65f947SAndy Whitcroft $type = 'V'; 21651f65f947SAndy Whitcroft 21666c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 2167c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 21686c72ffaaSAndy Whitcroft $type = 'V'; 21696c72ffaaSAndy Whitcroft 21706c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 2171c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 21726c72ffaaSAndy Whitcroft $type = 'N'; 21736c72ffaaSAndy Whitcroft 2174cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 2175c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 217613214adfSAndy Whitcroft $type = 'E'; 21771f65f947SAndy Whitcroft $av_pend_colon = 'O'; 217813214adfSAndy Whitcroft 21798e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 21808e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 21818e761b04SAndy Whitcroft $type = 'C'; 21828e761b04SAndy Whitcroft 21831f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 21841f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 21851f65f947SAndy Whitcroft $type = 'N'; 21861f65f947SAndy Whitcroft 21871f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 21881f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 21891f65f947SAndy Whitcroft 21901f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 21911f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 21921f65f947SAndy Whitcroft $type = 'E'; 21931f65f947SAndy Whitcroft } else { 21941f65f947SAndy Whitcroft $type = 'N'; 21951f65f947SAndy Whitcroft } 21961f65f947SAndy Whitcroft $av_pend_colon = 'O'; 21971f65f947SAndy Whitcroft 21988e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 219913214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 22006c72ffaaSAndy Whitcroft $type = 'N'; 22016c72ffaaSAndy Whitcroft 22020d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 220374048ed8SAndy Whitcroft my $variant; 220474048ed8SAndy Whitcroft 220574048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 220674048ed8SAndy Whitcroft if ($type eq 'V') { 220774048ed8SAndy Whitcroft $variant = 'B'; 220874048ed8SAndy Whitcroft } else { 220974048ed8SAndy Whitcroft $variant = 'U'; 221074048ed8SAndy Whitcroft } 221174048ed8SAndy Whitcroft 221274048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 221374048ed8SAndy Whitcroft $type = 'N'; 221474048ed8SAndy Whitcroft 22156c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 2216c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 22176c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 22186c72ffaaSAndy Whitcroft $type = 'N'; 22196c72ffaaSAndy Whitcroft } 22206c72ffaaSAndy Whitcroft 22216c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 2222c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 22236c72ffaaSAndy Whitcroft } 22246c72ffaaSAndy Whitcroft if (defined $1) { 22256c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 22266c72ffaaSAndy Whitcroft $res .= $type x length($1); 22276c72ffaaSAndy Whitcroft } 22286c72ffaaSAndy Whitcroft } 22296c72ffaaSAndy Whitcroft 22301f65f947SAndy Whitcroft return ($res, $var); 22316c72ffaaSAndy Whitcroft} 22326c72ffaaSAndy Whitcroft 22338905a67cSAndy Whitcroftsub possible { 223413214adfSAndy Whitcroft my ($possible, $line) = @_; 22359a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 22360776e594SAndy Whitcroft ^(?: 22370776e594SAndy Whitcroft $Modifier| 22380776e594SAndy Whitcroft $Storage| 22390776e594SAndy Whitcroft $Type| 22409a974fdbSAndy Whitcroft DEFINE_\S+ 22419a974fdbSAndy Whitcroft )$| 22429a974fdbSAndy Whitcroft ^(?: 22430776e594SAndy Whitcroft goto| 22440776e594SAndy Whitcroft return| 22450776e594SAndy Whitcroft case| 22460776e594SAndy Whitcroft else| 22470776e594SAndy Whitcroft asm|__asm__| 224889a88353SAndy Whitcroft do| 224989a88353SAndy Whitcroft \#| 225089a88353SAndy Whitcroft \#\#| 22519a974fdbSAndy Whitcroft )(?:\s|$)| 22520776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 22539a974fdbSAndy Whitcroft )}x; 22549a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 22559a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 2256c45dcabdSAndy Whitcroft # Check for modifiers. 2257c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 2258c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 2259c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 2260c45dcabdSAndy Whitcroft 2261c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 2262c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 2263d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 22649a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 2265d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 2266485ff23eSAlex Dowad push(@modifierListFile, $modifier); 2267d2506586SAndy Whitcroft } 22689a974fdbSAndy Whitcroft } 2269c45dcabdSAndy Whitcroft 2270c45dcabdSAndy Whitcroft } else { 227113214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 2272485ff23eSAlex Dowad push(@typeListFile, $possible); 2273c45dcabdSAndy Whitcroft } 22748905a67cSAndy Whitcroft build_types(); 22750776e594SAndy Whitcroft } else { 22760776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 22778905a67cSAndy Whitcroft } 22788905a67cSAndy Whitcroft} 22798905a67cSAndy Whitcroft 22806c72ffaaSAndy Whitcroftmy $prefix = ''; 22816c72ffaaSAndy Whitcroft 2282000d1cc1SJoe Perchessub show_type { 2283cbec18afSJoe Perches my ($type) = @_; 228491bfe484SJoe Perches 2285522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 2286522b837cSAlexey Dobriyan 2287cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 2288cbec18afSJoe Perches 2289cbec18afSJoe Perches return !defined $ignore_type{$type}; 2290000d1cc1SJoe Perches} 2291000d1cc1SJoe Perches 2292f0a594c1SAndy Whitcroftsub report { 2293cbec18afSJoe Perches my ($level, $type, $msg) = @_; 2294cbec18afSJoe Perches 2295cbec18afSJoe Perches if (!show_type($type) || 2296cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 2297773647a0SAndy Whitcroft return 0; 2298773647a0SAndy Whitcroft } 229957230297SJoe Perches my $output = ''; 2300737c0767SJohn Brooks if ($color) { 230157230297SJoe Perches if ($level eq 'ERROR') { 230257230297SJoe Perches $output .= RED; 230357230297SJoe Perches } elsif ($level eq 'WARNING') { 230457230297SJoe Perches $output .= YELLOW; 2305000d1cc1SJoe Perches } else { 230657230297SJoe Perches $output .= GREEN; 2307000d1cc1SJoe Perches } 230857230297SJoe Perches } 230957230297SJoe Perches $output .= $prefix . $level . ':'; 231057230297SJoe Perches if ($show_types) { 2311737c0767SJohn Brooks $output .= BLUE if ($color); 231257230297SJoe Perches $output .= "$type:"; 231357230297SJoe Perches } 2314737c0767SJohn Brooks $output .= RESET if ($color); 231557230297SJoe Perches $output .= ' ' . $msg . "\n"; 231634d8815fSJoe Perches 231734d8815fSJoe Perches if ($showfile) { 231834d8815fSJoe Perches my @lines = split("\n", $output, -1); 231934d8815fSJoe Perches splice(@lines, 1, 1); 232034d8815fSJoe Perches $output = join("\n", @lines); 232134d8815fSJoe Perches } 232252178ce0SDwaipayan Ray 232352178ce0SDwaipayan Ray if ($terse) { 232452178ce0SDwaipayan Ray $output = (split('\n', $output))[0] . "\n"; 232552178ce0SDwaipayan Ray } 232652178ce0SDwaipayan Ray 232752178ce0SDwaipayan Ray if ($verbose && exists($verbose_messages{$type}) && 232852178ce0SDwaipayan Ray !exists($verbose_emitted{$type})) { 232952178ce0SDwaipayan Ray $output .= $verbose_messages{$type} . "\n\n"; 233052178ce0SDwaipayan Ray $verbose_emitted{$type} = 1; 233152178ce0SDwaipayan Ray } 23328905a67cSAndy Whitcroft 233357230297SJoe Perches push(our @report, $output); 2334773647a0SAndy Whitcroft 2335773647a0SAndy Whitcroft return 1; 2336f0a594c1SAndy Whitcroft} 2337cbec18afSJoe Perches 2338f0a594c1SAndy Whitcroftsub report_dump { 233913214adfSAndy Whitcroft our @report; 2340f0a594c1SAndy Whitcroft} 2341000d1cc1SJoe Perches 2342d752fcc8SJoe Perchessub fixup_current_range { 2343d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 2344d752fcc8SJoe Perches 2345d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 2346d752fcc8SJoe Perches my $o = $1; 2347d752fcc8SJoe Perches my $l = $2; 2348d752fcc8SJoe Perches my $no = $o + $offset; 2349d752fcc8SJoe Perches my $nl = $l + $length; 2350d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 2351d752fcc8SJoe Perches } 2352d752fcc8SJoe Perches} 2353d752fcc8SJoe Perches 2354d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 2355d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 2356d752fcc8SJoe Perches 2357d752fcc8SJoe Perches my $range_last_linenr = 0; 2358d752fcc8SJoe Perches my $delta_offset = 0; 2359d752fcc8SJoe Perches 2360d752fcc8SJoe Perches my $old_linenr = 0; 2361d752fcc8SJoe Perches my $new_linenr = 0; 2362d752fcc8SJoe Perches 2363d752fcc8SJoe Perches my $next_insert = 0; 2364d752fcc8SJoe Perches my $next_delete = 0; 2365d752fcc8SJoe Perches 2366d752fcc8SJoe Perches my @lines = (); 2367d752fcc8SJoe Perches 2368d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 2369d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 2370d752fcc8SJoe Perches 2371d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 2372d752fcc8SJoe Perches my $save_line = 1; 2373d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 2374323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2375d752fcc8SJoe Perches $delta_offset = 0; 2376d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2377d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 2378d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 2379d752fcc8SJoe Perches } 2380d752fcc8SJoe Perches 2381d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2382d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 2383d752fcc8SJoe Perches $save_line = 0; 2384d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2385d752fcc8SJoe Perches } 2386d752fcc8SJoe Perches 2387d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2388d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 2389d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 2390d752fcc8SJoe Perches $new_linenr++; 2391d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2392d752fcc8SJoe Perches } 2393d752fcc8SJoe Perches 2394d752fcc8SJoe Perches if ($save_line) { 2395d752fcc8SJoe Perches push(@lines, $line); 2396d752fcc8SJoe Perches $new_linenr++; 2397d752fcc8SJoe Perches } 2398d752fcc8SJoe Perches 2399d752fcc8SJoe Perches $old_linenr++; 2400d752fcc8SJoe Perches } 2401d752fcc8SJoe Perches 2402d752fcc8SJoe Perches return @lines; 2403d752fcc8SJoe Perches} 2404d752fcc8SJoe Perches 2405f2d7e4d4SJoe Perchessub fix_insert_line { 2406f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2407f2d7e4d4SJoe Perches 2408f2d7e4d4SJoe Perches my $inserted = { 2409f2d7e4d4SJoe Perches LINENR => $linenr, 2410f2d7e4d4SJoe Perches LINE => $line, 2411f2d7e4d4SJoe Perches }; 2412f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2413f2d7e4d4SJoe Perches} 2414f2d7e4d4SJoe Perches 2415f2d7e4d4SJoe Perchessub fix_delete_line { 2416f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2417f2d7e4d4SJoe Perches 2418f2d7e4d4SJoe Perches my $deleted = { 2419f2d7e4d4SJoe Perches LINENR => $linenr, 2420f2d7e4d4SJoe Perches LINE => $line, 2421f2d7e4d4SJoe Perches }; 2422f2d7e4d4SJoe Perches 2423f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2424f2d7e4d4SJoe Perches} 2425f2d7e4d4SJoe Perches 2426de7d4f0eSAndy Whitcroftsub ERROR { 2427cbec18afSJoe Perches my ($type, $msg) = @_; 2428cbec18afSJoe Perches 2429cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2430de7d4f0eSAndy Whitcroft our $clean = 0; 24316c72ffaaSAndy Whitcroft our $cnt_error++; 24323705ce5bSJoe Perches return 1; 2433de7d4f0eSAndy Whitcroft } 24343705ce5bSJoe Perches return 0; 2435773647a0SAndy Whitcroft} 2436de7d4f0eSAndy Whitcroftsub WARN { 2437cbec18afSJoe Perches my ($type, $msg) = @_; 2438cbec18afSJoe Perches 2439cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2440de7d4f0eSAndy Whitcroft our $clean = 0; 24416c72ffaaSAndy Whitcroft our $cnt_warn++; 24423705ce5bSJoe Perches return 1; 2443de7d4f0eSAndy Whitcroft } 24443705ce5bSJoe Perches return 0; 2445773647a0SAndy Whitcroft} 2446de7d4f0eSAndy Whitcroftsub CHK { 2447cbec18afSJoe Perches my ($type, $msg) = @_; 2448cbec18afSJoe Perches 2449cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2450de7d4f0eSAndy Whitcroft our $clean = 0; 24516c72ffaaSAndy Whitcroft our $cnt_chk++; 24523705ce5bSJoe Perches return 1; 24536c72ffaaSAndy Whitcroft } 24543705ce5bSJoe Perches return 0; 2455de7d4f0eSAndy Whitcroft} 2456de7d4f0eSAndy Whitcroft 24576ecd9674SAndy Whitcroftsub check_absolute_file { 24586ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 24596ecd9674SAndy Whitcroft my $file = $absolute; 24606ecd9674SAndy Whitcroft 24616ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 24626ecd9674SAndy Whitcroft 24636ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 24646ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 24656ecd9674SAndy Whitcroft if (-f "$root/$file") { 24666ecd9674SAndy Whitcroft ##print "file<$file>\n"; 24676ecd9674SAndy Whitcroft last; 24686ecd9674SAndy Whitcroft } 24696ecd9674SAndy Whitcroft } 24706ecd9674SAndy Whitcroft if (! -f _) { 24716ecd9674SAndy Whitcroft return 0; 24726ecd9674SAndy Whitcroft } 24736ecd9674SAndy Whitcroft 24746ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 24756ecd9674SAndy Whitcroft my $prefix = $absolute; 24766ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 24776ecd9674SAndy Whitcroft 24786ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 24796ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2480000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2481000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 24826ecd9674SAndy Whitcroft } 24836ecd9674SAndy Whitcroft} 24846ecd9674SAndy Whitcroft 24853705ce5bSJoe Perchessub trim { 24863705ce5bSJoe Perches my ($string) = @_; 24873705ce5bSJoe Perches 2488b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2489b34c648bSJoe Perches 2490b34c648bSJoe Perches return $string; 2491b34c648bSJoe Perches} 2492b34c648bSJoe Perches 2493b34c648bSJoe Perchessub ltrim { 2494b34c648bSJoe Perches my ($string) = @_; 2495b34c648bSJoe Perches 2496b34c648bSJoe Perches $string =~ s/^\s+//; 2497b34c648bSJoe Perches 2498b34c648bSJoe Perches return $string; 2499b34c648bSJoe Perches} 2500b34c648bSJoe Perches 2501b34c648bSJoe Perchessub rtrim { 2502b34c648bSJoe Perches my ($string) = @_; 2503b34c648bSJoe Perches 2504b34c648bSJoe Perches $string =~ s/\s+$//; 25053705ce5bSJoe Perches 25063705ce5bSJoe Perches return $string; 25073705ce5bSJoe Perches} 25083705ce5bSJoe Perches 250952ea8506SJoe Perchessub string_find_replace { 251052ea8506SJoe Perches my ($string, $find, $replace) = @_; 251152ea8506SJoe Perches 251252ea8506SJoe Perches $string =~ s/$find/$replace/g; 251352ea8506SJoe Perches 251452ea8506SJoe Perches return $string; 251552ea8506SJoe Perches} 251652ea8506SJoe Perches 25173705ce5bSJoe Perchessub tabify { 25183705ce5bSJoe Perches my ($leading) = @_; 25193705ce5bSJoe Perches 2520713a09deSAntonio Borneo my $source_indent = $tabsize; 25213705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 25223705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 25233705ce5bSJoe Perches 25243705ce5bSJoe Perches #convert leading spaces to tabs 25253705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 25263705ce5bSJoe Perches #Remove spaces before a tab 25273705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 25283705ce5bSJoe Perches 25293705ce5bSJoe Perches return "$leading"; 25303705ce5bSJoe Perches} 25313705ce5bSJoe Perches 2532d1fe9c09SJoe Perchessub pos_last_openparen { 2533d1fe9c09SJoe Perches my ($line) = @_; 2534d1fe9c09SJoe Perches 2535d1fe9c09SJoe Perches my $pos = 0; 2536d1fe9c09SJoe Perches 2537d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2538d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2539d1fe9c09SJoe Perches 2540d1fe9c09SJoe Perches my $last_openparen = 0; 2541d1fe9c09SJoe Perches 2542d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2543d1fe9c09SJoe Perches return -1; 2544d1fe9c09SJoe Perches } 2545d1fe9c09SJoe Perches 2546d1fe9c09SJoe Perches my $len = length($line); 2547d1fe9c09SJoe Perches 2548d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2549d1fe9c09SJoe Perches my $string = substr($line, $pos); 2550d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2551d1fe9c09SJoe Perches $pos += length($1) - 1; 2552d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2553d1fe9c09SJoe Perches $last_openparen = $pos; 2554d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2555d1fe9c09SJoe Perches last; 2556d1fe9c09SJoe Perches } 2557d1fe9c09SJoe Perches } 2558d1fe9c09SJoe Perches 255991cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2560d1fe9c09SJoe Perches} 2561d1fe9c09SJoe Perches 2562f36d3eb8SJoe Perchessub get_raw_comment { 2563f36d3eb8SJoe Perches my ($line, $rawline) = @_; 2564f36d3eb8SJoe Perches my $comment = ''; 2565f36d3eb8SJoe Perches 2566f36d3eb8SJoe Perches for my $i (0 .. (length($line) - 1)) { 2567f36d3eb8SJoe Perches if (substr($line, $i, 1) eq "$;") { 2568f36d3eb8SJoe Perches $comment .= substr($rawline, $i, 1); 2569f36d3eb8SJoe Perches } 2570f36d3eb8SJoe Perches } 2571f36d3eb8SJoe Perches 2572f36d3eb8SJoe Perches return $comment; 2573f36d3eb8SJoe Perches} 2574f36d3eb8SJoe Perches 25755b8f82e1SSong Liusub exclude_global_initialisers { 25765b8f82e1SSong Liu my ($realfile) = @_; 25775b8f82e1SSong Liu 25785b8f82e1SSong Liu # Do not check for BPF programs (tools/testing/selftests/bpf/progs/*.c, samples/bpf/*_kern.c, *.bpf.c). 25795b8f82e1SSong Liu return $realfile =~ m@^tools/testing/selftests/bpf/progs/.*\.c$@ || 25805b8f82e1SSong Liu $realfile =~ m@^samples/bpf/.*_kern\.c$@ || 25815b8f82e1SSong Liu $realfile =~ m@/bpf/.*\.bpf\.c$@; 25825b8f82e1SSong Liu} 25835b8f82e1SSong Liu 25840a920b5bSAndy Whitcroftsub process { 25850a920b5bSAndy Whitcroft my $filename = shift; 25860a920b5bSAndy Whitcroft 25870a920b5bSAndy Whitcroft my $linenr=0; 25880a920b5bSAndy Whitcroft my $prevline=""; 2589c2fdda0dSAndy Whitcroft my $prevrawline=""; 25900a920b5bSAndy Whitcroft my $stashline=""; 2591c2fdda0dSAndy Whitcroft my $stashrawline=""; 25920a920b5bSAndy Whitcroft 25934a0df2efSAndy Whitcroft my $length; 25940a920b5bSAndy Whitcroft my $indent; 25950a920b5bSAndy Whitcroft my $previndent=0; 25960a920b5bSAndy Whitcroft my $stashindent=0; 25970a920b5bSAndy Whitcroft 2598de7d4f0eSAndy Whitcroft our $clean = 1; 25990a920b5bSAndy Whitcroft my $signoff = 0; 2600cd261496SGeert Uytterhoeven my $author = ''; 2601cd261496SGeert Uytterhoeven my $authorsignoff = 0; 260248ca2d8aSDwaipayan Ray my $author_sob = ''; 26030a920b5bSAndy Whitcroft my $is_patch = 0; 2604133712a2SRob Herring my $is_binding_patch = -1; 260529ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 260615662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 260744d303ebSJoe Perches my $has_patch_separator = 0; #Found a --- line 2608ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2609490b292cSJoe Perches my $commit_log_lines = 0; #Number of commit log lines 2610bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 26112a076f40SJoe Perches my $commit_log_long_line = 0; 2612e518e9a5SJoe Perches my $commit_log_has_diff = 0; 261313f1937eSJoe Perches my $reported_maintainer_file = 0; 2614fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2615fa64205dSPasi Savanainen 26164ce9f970SJoe Perches my $last_git_commit_id_linenr = -1; 26174ce9f970SJoe Perches 2618365dd4eaSJoe Perches my $last_blank_line = 0; 26195e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2620365dd4eaSJoe Perches 262113214adfSAndy Whitcroft our @report = (); 26226c72ffaaSAndy Whitcroft our $cnt_lines = 0; 26236c72ffaaSAndy Whitcroft our $cnt_error = 0; 26246c72ffaaSAndy Whitcroft our $cnt_warn = 0; 26256c72ffaaSAndy Whitcroft our $cnt_chk = 0; 26266c72ffaaSAndy Whitcroft 26270a920b5bSAndy Whitcroft # Trace the real file/line as we go. 26280a920b5bSAndy Whitcroft my $realfile = ''; 26290a920b5bSAndy Whitcroft my $realline = 0; 26300a920b5bSAndy Whitcroft my $realcnt = 0; 26310a920b5bSAndy Whitcroft my $here = ''; 263277cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 26330a920b5bSAndy Whitcroft my $in_comment = 0; 2634c2fdda0dSAndy Whitcroft my $comment_edge = 0; 26350a920b5bSAndy Whitcroft my $first_line = 0; 26361e855726SWolfram Sang my $p1_prefix = ''; 26370a920b5bSAndy Whitcroft 263813214adfSAndy Whitcroft my $prev_values = 'E'; 263913214adfSAndy Whitcroft 264013214adfSAndy Whitcroft # suppression flags 2641773647a0SAndy Whitcroft my %suppress_ifbraces; 2642170d3a22SAndy Whitcroft my %suppress_whiletrailers; 26432b474a1aSAndy Whitcroft my %suppress_export; 26443e469cdcSAndy Whitcroft my $suppress_statement = 0; 2645653d4876SAndy Whitcroft 26467e51f197SJoe Perches my %signatures = (); 2647323c1260SJoe Perches 2648c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2649de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2650c2fdda0dSAndy Whitcroft # 2651de7d4f0eSAndy Whitcroft my @setup_docs = (); 2652de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2653773647a0SAndy Whitcroft 2654d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2655d8b07710SJoe Perches 26569f3a8992SRob Herring my $checklicenseline = 1; 26579f3a8992SRob Herring 2658773647a0SAndy Whitcroft sanitise_line_reset(); 2659c2fdda0dSAndy Whitcroft my $line; 2660c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2661773647a0SAndy Whitcroft $linenr++; 2662773647a0SAndy Whitcroft $line = $rawline; 2663c2fdda0dSAndy Whitcroft 26643705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 26653705ce5bSJoe Perches 2666773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2667de7d4f0eSAndy Whitcroft $setup_docs = 0; 26682581ac7cSTim Froidcoeur if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) { 2669de7d4f0eSAndy Whitcroft $setup_docs = 1; 2670de7d4f0eSAndy Whitcroft } 2671773647a0SAndy Whitcroft #next; 2672de7d4f0eSAndy Whitcroft } 267374fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2674773647a0SAndy Whitcroft $realline=$1-1; 2675773647a0SAndy Whitcroft if (defined $2) { 2676773647a0SAndy Whitcroft $realcnt=$3+1; 2677773647a0SAndy Whitcroft } else { 2678773647a0SAndy Whitcroft $realcnt=1+1; 2679773647a0SAndy Whitcroft } 2680c45dcabdSAndy Whitcroft $in_comment = 0; 2681773647a0SAndy Whitcroft 2682773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2683773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2684773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2685773647a0SAndy Whitcroft # at context start. 2686773647a0SAndy Whitcroft my $edge; 268701fa9147SAndy Whitcroft my $cnt = $realcnt; 268801fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 268901fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 269001fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 269101fa9147SAndy Whitcroft $cnt--; 269201fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2693721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2694fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2695fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2696fae17daeSAndy Whitcroft ($edge) = $1; 2697fae17daeSAndy Whitcroft last; 2698fae17daeSAndy Whitcroft } 2699773647a0SAndy Whitcroft } 2700773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2701773647a0SAndy Whitcroft $in_comment = 1; 2702773647a0SAndy Whitcroft } 2703773647a0SAndy Whitcroft 2704773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2705773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2706773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2707773647a0SAndy Whitcroft if (!defined $edge && 270883242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2709773647a0SAndy Whitcroft { 2710773647a0SAndy Whitcroft $in_comment = 1; 2711773647a0SAndy Whitcroft } 2712773647a0SAndy Whitcroft 2713773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2714773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2715773647a0SAndy Whitcroft 2716171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2717773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2718171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2719773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2720773647a0SAndy Whitcroft } 2721773647a0SAndy Whitcroft push(@lines, $line); 2722773647a0SAndy Whitcroft 2723773647a0SAndy Whitcroft if ($realcnt > 1) { 2724773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2725773647a0SAndy Whitcroft } else { 2726773647a0SAndy Whitcroft $realcnt = 0; 2727773647a0SAndy Whitcroft } 2728773647a0SAndy Whitcroft 2729773647a0SAndy Whitcroft #print "==>$rawline\n"; 2730773647a0SAndy Whitcroft #print "-->$line\n"; 2731de7d4f0eSAndy Whitcroft 2732de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2733de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2734de7d4f0eSAndy Whitcroft } 2735de7d4f0eSAndy Whitcroft } 2736de7d4f0eSAndy Whitcroft 27376c72ffaaSAndy Whitcroft $prefix = ''; 27386c72ffaaSAndy Whitcroft 2739773647a0SAndy Whitcroft $realcnt = 0; 2740773647a0SAndy Whitcroft $linenr = 0; 2741194f66fcSJoe Perches $fixlinenr = -1; 27420a920b5bSAndy Whitcroft foreach my $line (@lines) { 27430a920b5bSAndy Whitcroft $linenr++; 2744194f66fcSJoe Perches $fixlinenr++; 27451b5539b1SJoe Perches my $sline = $line; #copy of $line 27461b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 27470a920b5bSAndy Whitcroft 2748c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 2749f36d3eb8SJoe Perches my $raw_comment = get_raw_comment($line, $rawline); 27506c72ffaaSAndy Whitcroft 275112c253abSJoe Perches# check if it's a mode change, rename or start of a patch 275212c253abSJoe Perches if (!$in_commit_log && 275312c253abSJoe Perches ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 275412c253abSJoe Perches ($line =~ /^rename (?:from|to) \S+\s*$/ || 275512c253abSJoe Perches $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 275612c253abSJoe Perches $is_patch = 1; 275712c253abSJoe Perches } 275812c253abSJoe Perches 27590a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2760e518e9a5SJoe Perches if (!$in_commit_log && 276174fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 276274fd4f34SJoe Perches my $context = $4; 27630a920b5bSAndy Whitcroft $is_patch = 1; 27644a0df2efSAndy Whitcroft $first_line = $linenr + 1; 27650a920b5bSAndy Whitcroft $realline=$1-1; 27660a920b5bSAndy Whitcroft if (defined $2) { 27670a920b5bSAndy Whitcroft $realcnt=$3+1; 27680a920b5bSAndy Whitcroft } else { 27690a920b5bSAndy Whitcroft $realcnt=1+1; 27700a920b5bSAndy Whitcroft } 2771c2fdda0dSAndy Whitcroft annotate_reset(); 277213214adfSAndy Whitcroft $prev_values = 'E'; 277313214adfSAndy Whitcroft 2774773647a0SAndy Whitcroft %suppress_ifbraces = (); 2775170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 27762b474a1aSAndy Whitcroft %suppress_export = (); 27773e469cdcSAndy Whitcroft $suppress_statement = 0; 277874fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 277974fd4f34SJoe Perches $context_function = $1; 278074fd4f34SJoe Perches } else { 278174fd4f34SJoe Perches undef $context_function; 278274fd4f34SJoe Perches } 27830a920b5bSAndy Whitcroft next; 27840a920b5bSAndy Whitcroft 27854a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 27864a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 27874a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2788773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 27890a920b5bSAndy Whitcroft $realline++; 2790d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 27910a920b5bSAndy Whitcroft 27924a0df2efSAndy Whitcroft # Measure the line length and indent. 2793c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 27940a920b5bSAndy Whitcroft 27950a920b5bSAndy Whitcroft # Track the previous line. 27960a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 27970a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2798c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2799c2fdda0dSAndy Whitcroft 2800773647a0SAndy Whitcroft #warn "line<$line>\n"; 28016c72ffaaSAndy Whitcroft 2802d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2803d8aaf121SAndy Whitcroft $realcnt--; 28040a920b5bSAndy Whitcroft } 28050a920b5bSAndy Whitcroft 2806cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2807cc77cdcaSAndy Whitcroft 28086c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 28096c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2810773647a0SAndy Whitcroft 28112ac73b4fSJoe Perches my $found_file = 0; 2812773647a0SAndy Whitcroft # extract the filename as it passes 28133bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 28143bf9a009SRabin Vincent $realfile = $1; 28152b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2816270c49a0SJoe Perches $in_commit_log = 0; 28172ac73b4fSJoe Perches $found_file = 1; 28183bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2819773647a0SAndy Whitcroft $realfile = $1; 28202b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2821270c49a0SJoe Perches $in_commit_log = 0; 28221e855726SWolfram Sang 28231e855726SWolfram Sang $p1_prefix = $1; 2824e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2825e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2826000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2827000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 28281e855726SWolfram Sang } 2829773647a0SAndy Whitcroft 2830c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2831000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2832000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2833773647a0SAndy Whitcroft } 28342ac73b4fSJoe Perches $found_file = 1; 28352ac73b4fSJoe Perches } 28362ac73b4fSJoe Perches 283734d8815fSJoe Perches#make up the handle for any error we report on this line 283834d8815fSJoe Perches if ($showfile) { 283934d8815fSJoe Perches $prefix = "$realfile:$realline: " 284034d8815fSJoe Perches } elsif ($emacs) { 28417d3a9f67SJoe Perches if ($file) { 28427d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 28437d3a9f67SJoe Perches } else { 284434d8815fSJoe Perches $prefix = "$filename:$linenr: "; 284534d8815fSJoe Perches } 28467d3a9f67SJoe Perches } 284734d8815fSJoe Perches 28482ac73b4fSJoe Perches if ($found_file) { 284985b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 285085b0ee18SJoe Perches WARN("OBSOLETE", 285185b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 285285b0ee18SJoe Perches } 28537bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 28542ac73b4fSJoe Perches $check = 1; 28552ac73b4fSJoe Perches } else { 28562ac73b4fSJoe Perches $check = $check_orig; 28572ac73b4fSJoe Perches } 28589f3a8992SRob Herring $checklicenseline = 1; 2859133712a2SRob Herring 2860133712a2SRob Herring if ($realfile !~ /^MAINTAINERS/) { 2861133712a2SRob Herring my $last_binding_patch = $is_binding_patch; 2862133712a2SRob Herring 2863133712a2SRob Herring $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@; 2864133712a2SRob Herring 2865133712a2SRob Herring if (($last_binding_patch != -1) && 2866133712a2SRob Herring ($last_binding_patch ^ $is_binding_patch)) { 2867133712a2SRob Herring WARN("DT_SPLIT_BINDING_PATCH", 2868858e6845SMauro Carvalho Chehab "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n"); 2869133712a2SRob Herring } 2870133712a2SRob Herring } 2871133712a2SRob Herring 2872773647a0SAndy Whitcroft next; 2873773647a0SAndy Whitcroft } 2874773647a0SAndy Whitcroft 2875389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 28760a920b5bSAndy Whitcroft 2877c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2878c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2879c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 28800a920b5bSAndy Whitcroft 28816c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 28826c72ffaaSAndy Whitcroft 2883490b292cSJoe Perches# Verify the existence of a commit log if appropriate 2884490b292cSJoe Perches# 2 is used because a $signature is counted in $commit_log_lines 2885490b292cSJoe Perches if ($in_commit_log) { 2886490b292cSJoe Perches if ($line !~ /^\s*$/) { 2887490b292cSJoe Perches $commit_log_lines++; #could be a $signature 2888490b292cSJoe Perches } 2889490b292cSJoe Perches } elsif ($has_commit_log && $commit_log_lines < 2) { 2890490b292cSJoe Perches WARN("COMMIT_MESSAGE", 2891490b292cSJoe Perches "Missing commit description - Add an appropriate one\n"); 2892490b292cSJoe Perches $commit_log_lines = 2; #warn only once 2893490b292cSJoe Perches } 2894490b292cSJoe Perches 2895e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2896e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 289713e45417SMrinal Pandey (($line =~ m@^\s+diff\b.*a/([\w/]+)@ && 289813e45417SMrinal Pandey $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) || 2899e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2900e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2901e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2902e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2903e518e9a5SJoe Perches $commit_log_has_diff = 1; 2904e518e9a5SJoe Perches } 2905e518e9a5SJoe Perches 29063bf9a009SRabin Vincent# Check for incorrect file permissions 29073bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 29083bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 290904db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 291004db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2911000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2912000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 29133bf9a009SRabin Vincent } 29143bf9a009SRabin Vincent } 29153bf9a009SRabin Vincent 2916cd261496SGeert Uytterhoeven# Check the patch for a From: 2917cd261496SGeert Uytterhoeven if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { 2918cd261496SGeert Uytterhoeven $author = $1; 2919e7f929f3SDwaipayan Ray my $curline = $linenr; 2920e7f929f3SDwaipayan Ray while(defined($rawlines[$curline]) && ($rawlines[$curline++] =~ /^[ \t]\s*(.*)/)) { 2921e7f929f3SDwaipayan Ray $author .= $1; 2922e7f929f3SDwaipayan Ray } 2923cd261496SGeert Uytterhoeven $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); 2924cd261496SGeert Uytterhoeven $author =~ s/"//g; 2925dfa05c28SJoe Perches $author = reformat_email($author); 2926cd261496SGeert Uytterhoeven } 2927cd261496SGeert Uytterhoeven 292820112475SJoe Perches# Check the patch for a signoff: 2929dfa05c28SJoe Perches if ($line =~ /^\s*signed-off-by:\s*(.*)/i) { 29304a0df2efSAndy Whitcroft $signoff++; 293115662b3eSJoe Perches $in_commit_log = 0; 293248ca2d8aSDwaipayan Ray if ($author ne '' && $authorsignoff != 1) { 2933fccaebf0SDwaipayan Ray if (same_email_addresses($1, $author)) { 2934cd261496SGeert Uytterhoeven $authorsignoff = 1; 293548ca2d8aSDwaipayan Ray } else { 293648ca2d8aSDwaipayan Ray my $ctx = $1; 293748ca2d8aSDwaipayan Ray my ($email_name, $email_comment, $email_address, $comment1) = parse_email($ctx); 293848ca2d8aSDwaipayan Ray my ($author_name, $author_comment, $author_address, $comment2) = parse_email($author); 293948ca2d8aSDwaipayan Ray 2940046fc741SMimi Zohar if (lc $email_address eq lc $author_address && $email_name eq $author_name) { 294148ca2d8aSDwaipayan Ray $author_sob = $ctx; 294248ca2d8aSDwaipayan Ray $authorsignoff = 2; 2943046fc741SMimi Zohar } elsif (lc $email_address eq lc $author_address) { 294448ca2d8aSDwaipayan Ray $author_sob = $ctx; 294548ca2d8aSDwaipayan Ray $authorsignoff = 3; 294648ca2d8aSDwaipayan Ray } elsif ($email_name eq $author_name) { 294748ca2d8aSDwaipayan Ray $author_sob = $ctx; 294848ca2d8aSDwaipayan Ray $authorsignoff = 4; 294948ca2d8aSDwaipayan Ray 295048ca2d8aSDwaipayan Ray my $address1 = $email_address; 295148ca2d8aSDwaipayan Ray my $address2 = $author_address; 295248ca2d8aSDwaipayan Ray 295348ca2d8aSDwaipayan Ray if ($address1 =~ /(\S+)\+\S+(\@.*)/) { 295448ca2d8aSDwaipayan Ray $address1 = "$1$2"; 295548ca2d8aSDwaipayan Ray } 295648ca2d8aSDwaipayan Ray if ($address2 =~ /(\S+)\+\S+(\@.*)/) { 295748ca2d8aSDwaipayan Ray $address2 = "$1$2"; 295848ca2d8aSDwaipayan Ray } 295948ca2d8aSDwaipayan Ray if ($address1 eq $address2) { 296048ca2d8aSDwaipayan Ray $authorsignoff = 5; 296148ca2d8aSDwaipayan Ray } 296248ca2d8aSDwaipayan Ray } 2963cd261496SGeert Uytterhoeven } 2964cd261496SGeert Uytterhoeven } 29650a920b5bSAndy Whitcroft } 296620112475SJoe Perches 296744d303ebSJoe Perches# Check for patch separator 296844d303ebSJoe Perches if ($line =~ /^---$/) { 296944d303ebSJoe Perches $has_patch_separator = 1; 297044d303ebSJoe Perches $in_commit_log = 0; 297144d303ebSJoe Perches } 297244d303ebSJoe Perches 2973e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2974e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2975e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2976e0d975b1SJoe Perches $reported_maintainer_file = 1; 2977e0d975b1SJoe Perches } 2978e0d975b1SJoe Perches 297920112475SJoe Perches# Check signature styles 2980270c49a0SJoe Perches if (!$in_header_lines && 2981ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 298220112475SJoe Perches my $space_before = $1; 298320112475SJoe Perches my $sign_off = $2; 298420112475SJoe Perches my $space_after = $3; 298520112475SJoe Perches my $email = $4; 298620112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 298720112475SJoe Perches 2988ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2989831242abSAditya Srivastava my $suggested_signature = find_standard_signature($sign_off); 2990831242abSAditya Srivastava if ($suggested_signature eq "") { 2991ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2992ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2993831242abSAditya Srivastava } else { 2994831242abSAditya Srivastava if (WARN("BAD_SIGN_OFF", 2995831242abSAditya Srivastava "Non-standard signature: '$sign_off' - perhaps '$suggested_signature'?\n" . $herecurr) && 2996831242abSAditya Srivastava $fix) { 2997831242abSAditya Srivastava $fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/; 2998831242abSAditya Srivastava } 2999831242abSAditya Srivastava } 3000ce0338dfSJoe Perches } 300120112475SJoe Perches if (defined $space_before && $space_before ne "") { 30023705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 30033705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 30043705ce5bSJoe Perches $fix) { 3005194f66fcSJoe Perches $fixed[$fixlinenr] = 30063705ce5bSJoe Perches "$ucfirst_sign_off $email"; 30073705ce5bSJoe Perches } 300820112475SJoe Perches } 300920112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 30103705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 30113705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 30123705ce5bSJoe Perches $fix) { 3013194f66fcSJoe Perches $fixed[$fixlinenr] = 30143705ce5bSJoe Perches "$ucfirst_sign_off $email"; 30153705ce5bSJoe Perches } 30163705ce5bSJoe Perches 301720112475SJoe Perches } 301820112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 30193705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 30203705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 30213705ce5bSJoe Perches $fix) { 3022194f66fcSJoe Perches $fixed[$fixlinenr] = 30233705ce5bSJoe Perches "$ucfirst_sign_off $email"; 30243705ce5bSJoe Perches } 302520112475SJoe Perches } 302620112475SJoe Perches 3027dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 302848ca2d8aSDwaipayan Ray my $suggested_email = format_email(($email_name, $name_comment, $email_address, $comment)); 302920112475SJoe Perches if ($suggested_email eq "") { 3030000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 3031000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 303220112475SJoe Perches } else { 303320112475SJoe Perches my $dequoted = $suggested_email; 303420112475SJoe Perches $dequoted =~ s/^"//; 303520112475SJoe Perches $dequoted =~ s/" </ </; 303620112475SJoe Perches # Don't force email to have quotes 303720112475SJoe Perches # Allow just an angle bracketed address 3038fccaebf0SDwaipayan Ray if (!same_email_addresses($email, $suggested_email)) { 3039fccaebf0SDwaipayan Ray if (WARN("BAD_SIGN_OFF", 3040fccaebf0SDwaipayan Ray "email address '$email' might be better as '$suggested_email'\n" . $herecurr) && 3041fccaebf0SDwaipayan Ray $fix) { 3042fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email\E/$suggested_email/; 3043fccaebf0SDwaipayan Ray } 3044fccaebf0SDwaipayan Ray } 3045fccaebf0SDwaipayan Ray 3046fccaebf0SDwaipayan Ray # Address part shouldn't have comments 3047fccaebf0SDwaipayan Ray my $stripped_address = $email_address; 3048fccaebf0SDwaipayan Ray $stripped_address =~ s/\([^\(\)]*\)//g; 3049fccaebf0SDwaipayan Ray if ($email_address ne $stripped_address) { 3050fccaebf0SDwaipayan Ray if (WARN("BAD_SIGN_OFF", 3051fccaebf0SDwaipayan Ray "address part of email should not have comments: '$email_address'\n" . $herecurr) && 3052fccaebf0SDwaipayan Ray $fix) { 3053fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email_address\E/$stripped_address/; 3054fccaebf0SDwaipayan Ray } 3055fccaebf0SDwaipayan Ray } 3056fccaebf0SDwaipayan Ray 3057fccaebf0SDwaipayan Ray # Only one name comment should be allowed 3058fccaebf0SDwaipayan Ray my $comment_count = () = $name_comment =~ /\([^\)]+\)/g; 3059fccaebf0SDwaipayan Ray if ($comment_count > 1) { 3060000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 3061fccaebf0SDwaipayan Ray "Use a single name comment in email: '$email'\n" . $herecurr); 3062fccaebf0SDwaipayan Ray } 3063fccaebf0SDwaipayan Ray 3064fccaebf0SDwaipayan Ray 3065fccaebf0SDwaipayan Ray # [email protected] or [email protected] shouldn't 3066e73d2715SDwaipayan Ray # have an email name. In addition comments should strictly 3067fccaebf0SDwaipayan Ray # begin with a # 3068fccaebf0SDwaipayan Ray if ($email =~ /^.*stable\@(?:vger\.)?kernel\.org/i) { 3069fccaebf0SDwaipayan Ray if (($comment ne "" && $comment !~ /^#.+/) || 3070fccaebf0SDwaipayan Ray ($email_name ne "")) { 3071fccaebf0SDwaipayan Ray my $cur_name = $email_name; 3072fccaebf0SDwaipayan Ray my $new_comment = $comment; 3073fccaebf0SDwaipayan Ray $cur_name =~ s/[a-zA-Z\s\-\"]+//g; 3074fccaebf0SDwaipayan Ray 3075fccaebf0SDwaipayan Ray # Remove brackets enclosing comment text 3076fccaebf0SDwaipayan Ray # and # from start of comments to get comment text 3077fccaebf0SDwaipayan Ray $new_comment =~ s/^\((.*)\)$/$1/; 3078fccaebf0SDwaipayan Ray $new_comment =~ s/^\[(.*)\]$/$1/; 3079fccaebf0SDwaipayan Ray $new_comment =~ s/^[\s\#]+|\s+$//g; 3080fccaebf0SDwaipayan Ray 3081fccaebf0SDwaipayan Ray $new_comment = trim("$new_comment $cur_name") if ($cur_name ne $new_comment); 3082fccaebf0SDwaipayan Ray $new_comment = " # $new_comment" if ($new_comment ne ""); 3083fccaebf0SDwaipayan Ray my $new_email = "$email_address$new_comment"; 3084fccaebf0SDwaipayan Ray 3085fccaebf0SDwaipayan Ray if (WARN("BAD_STABLE_ADDRESS_STYLE", 3086fccaebf0SDwaipayan Ray "Invalid email format for stable: '$email', prefer '$new_email'\n" . $herecurr) && 3087fccaebf0SDwaipayan Ray $fix) { 3088fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/; 3089fccaebf0SDwaipayan Ray } 3090fccaebf0SDwaipayan Ray } 3091fccaebf0SDwaipayan Ray } elsif ($comment ne "" && $comment !~ /^(?:#.+|\(.+\))$/) { 3092fccaebf0SDwaipayan Ray my $new_comment = $comment; 3093fccaebf0SDwaipayan Ray 3094fccaebf0SDwaipayan Ray # Extract comment text from within brackets or 3095fccaebf0SDwaipayan Ray # c89 style /*...*/ comments 3096fccaebf0SDwaipayan Ray $new_comment =~ s/^\[(.*)\]$/$1/; 3097fccaebf0SDwaipayan Ray $new_comment =~ s/^\/\*(.*)\*\/$/$1/; 3098fccaebf0SDwaipayan Ray 3099fccaebf0SDwaipayan Ray $new_comment = trim($new_comment); 3100fccaebf0SDwaipayan Ray $new_comment =~ s/^[^\w]$//; # Single lettered comment with non word character is usually a typo 3101fccaebf0SDwaipayan Ray $new_comment = "($new_comment)" if ($new_comment ne ""); 3102fccaebf0SDwaipayan Ray my $new_email = format_email($email_name, $name_comment, $email_address, $new_comment); 3103fccaebf0SDwaipayan Ray 3104fccaebf0SDwaipayan Ray if (WARN("BAD_SIGN_OFF", 3105fccaebf0SDwaipayan Ray "Unexpected content after email: '$email', should be: '$new_email'\n" . $herecurr) && 3106fccaebf0SDwaipayan Ray $fix) { 3107fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/; 3108fccaebf0SDwaipayan Ray } 310920112475SJoe Perches } 31100a920b5bSAndy Whitcroft } 31117e51f197SJoe Perches 31127e51f197SJoe Perches# Check for duplicate signatures 31137e51f197SJoe Perches my $sig_nospace = $line; 31147e51f197SJoe Perches $sig_nospace =~ s/\s//g; 31157e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 31167e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 31177e51f197SJoe Perches WARN("BAD_SIGN_OFF", 31187e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 31197e51f197SJoe Perches } else { 31207e51f197SJoe Perches $signatures{$sig_nospace} = 1; 31217e51f197SJoe Perches } 31226c5d24eeSSean Christopherson 31236c5d24eeSSean Christopherson# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email 31246c5d24eeSSean Christopherson if ($sign_off =~ /^co-developed-by:$/i) { 31256c5d24eeSSean Christopherson if ($email eq $author) { 31266c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31276c5d24eeSSean Christopherson "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline); 31286c5d24eeSSean Christopherson } 31296c5d24eeSSean Christopherson if (!defined $lines[$linenr]) { 31306c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31316c5d24eeSSean Christopherson "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline); 31326c5d24eeSSean Christopherson } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) { 31336c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31346c5d24eeSSean Christopherson "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 31356c5d24eeSSean Christopherson } elsif ($1 ne $email) { 31366c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31376c5d24eeSSean Christopherson "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 31386c5d24eeSSean Christopherson } 31396c5d24eeSSean Christopherson } 31400a920b5bSAndy Whitcroft } 31410a920b5bSAndy Whitcroft 3142a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 3143a2fe16b9SJoe Perches if ($in_header_lines && 3144a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 3145a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 3146a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 3147a2fe16b9SJoe Perches } 3148a2fe16b9SJoe Perches 314944d303ebSJoe Perches# Check for Gerrit Change-Ids not in any patch context 315044d303ebSJoe Perches if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) { 31517580c5b9SAditya Srivastava if (ERROR("GERRIT_CHANGE_ID", 31527580c5b9SAditya Srivastava "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr) && 31537580c5b9SAditya Srivastava $fix) { 31547580c5b9SAditya Srivastava fix_delete_line($fixlinenr, $rawline); 31557580c5b9SAditya Srivastava } 31567ebd05efSChristopher Covington } 31577ebd05efSChristopher Covington 3158369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 3159369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 3160369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 3161369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 3162369c8dd3SJoe Perches # timestamp 3163634cffccSJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) || 3164634cffccSJoe Perches $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ || 3165634cffccSJoe Perches $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) { 3166634cffccSJoe Perches # stack dump address styles 3167369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 3168369c8dd3SJoe Perches } 3169369c8dd3SJoe Perches 31702a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 31712a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 3172bf4daf12SJoe Perches length($line) > 75 && 3173bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 3174bf4daf12SJoe Perches # file delta changes 317536f8b348SJerome Forissier $line =~ /^\s*(?:[\w\.\-\+]*\/)++[\w\.\-\+]+:/ || 3176bf4daf12SJoe Perches # filename then : 317727b379afSAditya Srivastava $line =~ /^\s*(?:Fixes:|Link:|$signature_tags)/i || 317827b379afSAditya Srivastava # A Fixes: or Link: line or signature tag line 3179bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 31802a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 31812a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 31822a076f40SJoe Perches $commit_log_long_line = 1; 31832a076f40SJoe Perches } 31842a076f40SJoe Perches 3185bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 3186bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 3187bf4daf12SJoe Perches $line =~ /^\s*$/) { 3188bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 3189bf4daf12SJoe Perches } 3190bf4daf12SJoe Perches 3191084a617aSDwaipayan Ray# Check for lines starting with a # 3192084a617aSDwaipayan Ray if ($in_commit_log && $line =~ /^#/) { 3193084a617aSDwaipayan Ray if (WARN("COMMIT_COMMENT_SYMBOL", 3194084a617aSDwaipayan Ray "Commit log lines starting with '#' are dropped by git as comments\n" . $herecurr) && 3195084a617aSDwaipayan Ray $fix) { 3196084a617aSDwaipayan Ray $fixed[$fixlinenr] =~ s/^/ /; 3197084a617aSDwaipayan Ray } 3198084a617aSDwaipayan Ray } 3199084a617aSDwaipayan Ray 32000d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 32014ce9f970SJoe Perches# A correctly formed commit description is: 32024ce9f970SJoe Perches# commit <SHA-1 hash length 12+ chars> ("Complete commit subject") 32034ce9f970SJoe Perches# with the commit subject '("' prefix and '")' suffix 32044ce9f970SJoe Perches# This is a fairly compilicated block as it tests for what appears to be 32054ce9f970SJoe Perches# bare SHA-1 hash with minimum length of 5. It also avoids several types of 32064ce9f970SJoe Perches# possible SHA-1 matches. 32074ce9f970SJoe Perches# A commit match can span multiple lines so this block attempts to find a 32084ce9f970SJoe Perches# complete typical commit on a maximum of 3 lines 32094ce9f970SJoe Perches if ($perl_version_ok && 32104ce9f970SJoe Perches $in_commit_log && !$commit_log_possible_stack_dump && 3211a8972573SJohn Hubbard $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i && 3212e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 32134ce9f970SJoe Perches (($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 32144ce9f970SJoe Perches ($line =~ /\bcommit\s*$/i && defined($rawlines[$linenr]) && $rawlines[$linenr] =~ /^\s*[0-9a-f]{5,}\b/i)) || 3215aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 3216369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 3217bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 3218fe043ea1SJoe Perches my $init_char = "c"; 3219fe043ea1SJoe Perches my $orig_commit = ""; 32200d7835fcSJoe Perches my $short = 1; 32210d7835fcSJoe Perches my $long = 0; 32220d7835fcSJoe Perches my $case = 1; 32230d7835fcSJoe Perches my $space = 1; 32240d7835fcSJoe Perches my $id = '0123456789ab'; 32250d7835fcSJoe Perches my $orig_desc = "commit description"; 32260d7835fcSJoe Perches my $description = ""; 32274ce9f970SJoe Perches my $herectx = $herecurr; 32284ce9f970SJoe Perches my $has_parens = 0; 32294ce9f970SJoe Perches my $has_quotes = 0; 32300d7835fcSJoe Perches 32314ce9f970SJoe Perches my $input = $line; 32324ce9f970SJoe Perches if ($line =~ /(?:\bcommit\s+[0-9a-f]{5,}|\bcommit\s*$)/i) { 32334ce9f970SJoe Perches for (my $n = 0; $n < 2; $n++) { 32344ce9f970SJoe Perches if ($input =~ /\bcommit\s+[0-9a-f]{5,}\s*($balanced_parens)/i) { 32354ce9f970SJoe Perches $orig_desc = $1; 32364ce9f970SJoe Perches $has_parens = 1; 32374ce9f970SJoe Perches # Always strip leading/trailing parens then double quotes if existing 32384ce9f970SJoe Perches $orig_desc = substr($orig_desc, 1, -1); 32394ce9f970SJoe Perches if ($orig_desc =~ /^".*"$/) { 32404ce9f970SJoe Perches $orig_desc = substr($orig_desc, 1, -1); 32414ce9f970SJoe Perches $has_quotes = 1; 32424ce9f970SJoe Perches } 32434ce9f970SJoe Perches last; 32444ce9f970SJoe Perches } 32454ce9f970SJoe Perches last if ($#lines < $linenr + $n); 32464ce9f970SJoe Perches $input .= " " . trim($rawlines[$linenr + $n]); 32474ce9f970SJoe Perches $herectx .= "$rawlines[$linenr + $n]\n"; 32484ce9f970SJoe Perches } 32494ce9f970SJoe Perches $herectx = $herecurr if (!$has_parens); 3250fe043ea1SJoe Perches } 3251fe043ea1SJoe Perches 32524ce9f970SJoe Perches if ($input =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 32534ce9f970SJoe Perches $init_char = $1; 32544ce9f970SJoe Perches $orig_commit = lc($2); 32554ce9f970SJoe Perches $short = 0 if ($input =~ /\bcommit\s+[0-9a-f]{12,40}/i); 32564ce9f970SJoe Perches $long = 1 if ($input =~ /\bcommit\s+[0-9a-f]{41,}/i); 32574ce9f970SJoe Perches $space = 0 if ($input =~ /\bcommit [0-9a-f]/i); 32584ce9f970SJoe Perches $case = 0 if ($input =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 32594ce9f970SJoe Perches } elsif ($input =~ /\b([0-9a-f]{12,40})\b/i) { 32604ce9f970SJoe Perches $orig_commit = lc($1); 32610d7835fcSJoe Perches } 32620d7835fcSJoe Perches 32630d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 32640d7835fcSJoe Perches $id, $orig_desc); 32650d7835fcSJoe Perches 3266948b133aSHeinrich Schuchardt if (defined($id) && 32674ce9f970SJoe Perches ($short || $long || $space || $case || ($orig_desc ne $description) || !$has_quotes) && 32684ce9f970SJoe Perches $last_git_commit_id_linenr != $linenr - 1) { 3269d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 32704ce9f970SJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herectx); 32710d7835fcSJoe Perches } 32724ce9f970SJoe Perches #don't report the next line if this line ends in commit and the sha1 hash is the next line 32734ce9f970SJoe Perches $last_git_commit_id_linenr = $linenr if ($line =~ /\bcommit\s*$/i); 3274d311cd44SJoe Perches } 3275d311cd44SJoe Perches 327613f1937eSJoe Perches# Check for added, moved or deleted files 327713f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 327813f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 327913f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 328013f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 328113f1937eSJoe Perches (defined($1) || defined($2))))) { 3282a82603a8SAndrew Jeffery $is_patch = 1; 328313f1937eSJoe Perches $reported_maintainer_file = 1; 328413f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 328513f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 328613f1937eSJoe Perches } 328713f1937eSJoe Perches 3288e400edb1SRob Herring# Check for adding new DT bindings not in schema format 3289e400edb1SRob Herring if (!$in_commit_log && 3290e400edb1SRob Herring ($line =~ /^new file mode\s*\d+\s*$/) && 3291e400edb1SRob Herring ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) { 3292e400edb1SRob Herring WARN("DT_SCHEMA_BINDING_PATCH", 329356ddc4cdSMauro Carvalho Chehab "DT bindings should be in DT schema format. See: Documentation/devicetree/bindings/writing-schema.rst\n"); 3294e400edb1SRob Herring } 3295e400edb1SRob Herring 329600df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 32978905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 3298000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 3299000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 33006c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 3301de7d4f0eSAndy Whitcroft } 3302de7d4f0eSAndy Whitcroft 3303de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 3304de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 3305171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 3306171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 3307171ae1a4SAndy Whitcroft 3308171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 3309171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 3310171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 3311171ae1a4SAndy Whitcroft 331234d99219SJoe Perches CHK("INVALID_UTF8", 3313000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 331400df344fSAndy Whitcroft } 33150a920b5bSAndy Whitcroft 331615662b3eSJoe Perches# Check if it's the start of a commit log 331715662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 331815662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 3319eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 3320eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 332115662b3eSJoe Perches $in_header_lines = 0; 332215662b3eSJoe Perches $in_commit_log = 1; 3323ed43c4e5SAllen Hubbe $has_commit_log = 1; 332415662b3eSJoe Perches } 332515662b3eSJoe Perches 3326fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 3327fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 3328fa64205dSPasi Savanainen if ($in_header_lines && 3329fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 3330fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 3331fa64205dSPasi Savanainen $non_utf8_charset = 1; 3332fa64205dSPasi Savanainen } 3333fa64205dSPasi Savanainen 3334fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 333515662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 3336fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 333715662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 333815662b3eSJoe Perches } 333915662b3eSJoe Perches 3340d6430f71SJoe Perches# Check for absolute kernel paths in commit message 3341d6430f71SJoe Perches if ($tree && $in_commit_log) { 3342d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 3343d6430f71SJoe Perches my $file = $1; 3344d6430f71SJoe Perches 3345d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 3346d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 3347d6430f71SJoe Perches # 3348d6430f71SJoe Perches } else { 3349d6430f71SJoe Perches check_absolute_file($file, $herecurr); 3350d6430f71SJoe Perches } 3351d6430f71SJoe Perches } 3352d6430f71SJoe Perches } 3353d6430f71SJoe Perches 335466b47b4aSKees Cook# Check for various typo / spelling mistakes 335566d7a382SJoe Perches if (defined($misspellings) && 335666d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 33577da07c31SDwaipayan Ray while ($rawline =~ /(?:^|[^\w\-'`])($misspellings)(?:[^\w\-'`]|$)/gi) { 335866b47b4aSKees Cook my $typo = $1; 33597da07c31SDwaipayan Ray my $blank = copy_spacing($rawline); 33607da07c31SDwaipayan Ray my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo); 33617da07c31SDwaipayan Ray my $hereptr = "$hereline$ptr\n"; 336266b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 336366b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 336466b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 33650675a8fbSJean Delvare my $msg_level = \&WARN; 33660675a8fbSJean Delvare $msg_level = \&CHK if ($file); 33670675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 33687da07c31SDwaipayan Ray "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $hereptr) && 336966b47b4aSKees Cook $fix) { 337066b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 337166b47b4aSKees Cook } 337266b47b4aSKees Cook } 337366b47b4aSKees Cook } 337466b47b4aSKees Cook 3375a8dd86bfSMatteo Croce# check for invalid commit id 3376a8dd86bfSMatteo Croce if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) { 3377a8dd86bfSMatteo Croce my $id; 3378a8dd86bfSMatteo Croce my $description; 3379a8dd86bfSMatteo Croce ($id, $description) = git_commit_info($2, undef, undef); 3380a8dd86bfSMatteo Croce if (!defined($id)) { 3381a8dd86bfSMatteo Croce WARN("UNKNOWN_COMMIT_ID", 3382a8dd86bfSMatteo Croce "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr); 3383a8dd86bfSMatteo Croce } 3384a8dd86bfSMatteo Croce } 3385a8dd86bfSMatteo Croce 3386310cd06bSJoe Perches# check for repeated words separated by a single space 33878d0325ccSAditya Srivastava# avoid false positive from list command eg, '-rw-r--r-- 1 root root' 33888d0325ccSAditya Srivastava if (($rawline =~ /^\+/ || $in_commit_log) && 33898d0325ccSAditya Srivastava $rawline !~ /[bcCdDlMnpPs\?-][rwxsStT-]{9}/) { 33901db81a68SDwaipayan Ray pos($rawline) = 1 if (!$in_commit_log); 3391310cd06bSJoe Perches while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) { 3392310cd06bSJoe Perches 3393310cd06bSJoe Perches my $first = $1; 3394310cd06bSJoe Perches my $second = $2; 33951db81a68SDwaipayan Ray my $start_pos = $-[1]; 33961db81a68SDwaipayan Ray my $end_pos = $+[2]; 3397310cd06bSJoe Perches if ($first =~ /(?:struct|union|enum)/) { 3398310cd06bSJoe Perches pos($rawline) += length($first) + length($second) + 1; 3399310cd06bSJoe Perches next; 3400310cd06bSJoe Perches } 3401310cd06bSJoe Perches 34021db81a68SDwaipayan Ray next if (lc($first) ne lc($second)); 3403310cd06bSJoe Perches next if ($first eq 'long'); 3404310cd06bSJoe Perches 34051db81a68SDwaipayan Ray # check for character before and after the word matches 34061db81a68SDwaipayan Ray my $start_char = ''; 34071db81a68SDwaipayan Ray my $end_char = ''; 34081db81a68SDwaipayan Ray $start_char = substr($rawline, $start_pos - 1, 1) if ($start_pos > ($in_commit_log ? 0 : 1)); 34091db81a68SDwaipayan Ray $end_char = substr($rawline, $end_pos, 1) if ($end_pos < length($rawline)); 34101db81a68SDwaipayan Ray 34111db81a68SDwaipayan Ray next if ($start_char =~ /^\S$/); 34121db81a68SDwaipayan Ray next if (index(" \t.,;?!", $end_char) == -1); 34131db81a68SDwaipayan Ray 34148d0325ccSAditya Srivastava # avoid repeating hex occurrences like 'ff ff fe 09 ...' 34158d0325ccSAditya Srivastava if ($first =~ /\b[0-9a-f]{2,}\b/i) { 34168d0325ccSAditya Srivastava next if (!exists($allow_repeated_words{lc($first)})); 34178d0325ccSAditya Srivastava } 34188d0325ccSAditya Srivastava 3419310cd06bSJoe Perches if (WARN("REPEATED_WORD", 3420310cd06bSJoe Perches "Possible repeated word: '$first'\n" . $herecurr) && 3421310cd06bSJoe Perches $fix) { 3422310cd06bSJoe Perches $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/; 3423310cd06bSJoe Perches } 3424310cd06bSJoe Perches } 3425310cd06bSJoe Perches 3426310cd06bSJoe Perches # if it's a repeated word on consecutive lines in a comment block 3427310cd06bSJoe Perches if ($prevline =~ /$;+\s*$/ && 3428310cd06bSJoe Perches $prevrawline =~ /($word_pattern)\s*$/) { 3429310cd06bSJoe Perches my $last_word = $1; 3430310cd06bSJoe Perches if ($rawline =~ /^\+\s*\*\s*$last_word /) { 3431310cd06bSJoe Perches if (WARN("REPEATED_WORD", 3432310cd06bSJoe Perches "Possible repeated word: '$last_word'\n" . $hereprev) && 3433310cd06bSJoe Perches $fix) { 3434310cd06bSJoe Perches $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/; 3435310cd06bSJoe Perches } 3436310cd06bSJoe Perches } 3437310cd06bSJoe Perches } 3438310cd06bSJoe Perches } 3439310cd06bSJoe Perches 344030670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 344130670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 344200df344fSAndy Whitcroft 34430a920b5bSAndy Whitcroft#trailing whitespace 34449c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 3445c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3446d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 3447d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 3448d5e616fcSJoe Perches $fix) { 3449194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 3450d5e616fcSJoe Perches } 3451c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 3452c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 34533705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 34543705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 34553705ce5bSJoe Perches $fix) { 3456194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 34573705ce5bSJoe Perches } 34583705ce5bSJoe Perches 3459d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 34600a920b5bSAndy Whitcroft } 34615368df20SAndy Whitcroft 34624783f894SJosh Triplett# Check for FSF mailing addresses. 3463109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 34641bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 34653e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 34663e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 34674783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 34680675a8fbSJean Delvare my $msg_level = \&ERROR; 34690675a8fbSJean Delvare $msg_level = \&CHK if ($file); 34700675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 34714783f894SJosh 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) 34724783f894SJosh Triplett } 34734783f894SJosh Triplett 34743354957aSAndi Kleen# check for Kconfig help text having a real description 34759fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 34769fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 34773354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 3478678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 3479678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 3480678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 3481678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 3482*b8709bceSJoe Perches my $ln = $linenr; 3483*b8709bceSJoe Perches my $needs_help = 0; 3484*b8709bceSJoe Perches my $has_help = 0; 3485*b8709bceSJoe Perches my $help_length = 0; 3486*b8709bceSJoe Perches while (defined $lines[$ln]) { 3487*b8709bceSJoe Perches my $f = $lines[$ln++]; 34889fe287d7SAndy Whitcroft 34899fe287d7SAndy Whitcroft next if ($f =~ /^-/); 3490*b8709bceSJoe Perches last if ($f !~ /^[\+ ]/); # !patch context 3491a1385803SAndy Whitcroft 3492*b8709bceSJoe Perches if ($f =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 3493*b8709bceSJoe Perches $needs_help = 1; 3494*b8709bceSJoe Perches next; 3495*b8709bceSJoe Perches } 3496*b8709bceSJoe Perches if ($f =~ /^\+\s*help\s*$/) { 3497*b8709bceSJoe Perches $has_help = 1; 3498*b8709bceSJoe Perches next; 3499a1385803SAndy Whitcroft } 3500a1385803SAndy Whitcroft 3501*b8709bceSJoe Perches $f =~ s/^.//; # strip patch context [+ ] 3502*b8709bceSJoe Perches $f =~ s/#.*//; # strip # directives 3503*b8709bceSJoe Perches $f =~ s/^\s+//; # strip leading blanks 3504*b8709bceSJoe Perches next if ($f =~ /^$/); # skip blank lines 3505678ae162SUlf Magnusson 3506*b8709bceSJoe Perches # At the end of this Kconfig block: 3507678ae162SUlf Magnusson # This only checks context lines in the patch 3508678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 3509678ae162SUlf Magnusson # positives, even though some of these are 3510678ae162SUlf Magnusson # common words in help texts 3511*b8709bceSJoe Perches if ($f =~ /^(?:config|menuconfig|choice|endchoice| 3512678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 35139fe287d7SAndy Whitcroft last; 35149fe287d7SAndy Whitcroft } 3515*b8709bceSJoe Perches $help_length++ if ($has_help); 35163354957aSAndi Kleen } 3517*b8709bceSJoe Perches if ($needs_help && 3518*b8709bceSJoe Perches $help_length < $min_conf_desc_length) { 3519*b8709bceSJoe Perches my $stat_real = get_stat_real($linenr, $ln - 1); 3520000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 3521*b8709bceSJoe Perches "please write a help paragraph that fully describes the config symbol\n" . "$here\n$stat_real\n"); 352256193274SVadim Bendebury } 35233354957aSAndi Kleen } 35243354957aSAndi Kleen 35257ccf41a8SJoe Perches# check MAINTAINERS entries 35267ccf41a8SJoe Perches if ($realfile =~ /^MAINTAINERS$/) { 35277ccf41a8SJoe Perches# check MAINTAINERS entries for the right form 35287ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 3529628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 3530628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 3531628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 3532628f91a2SJoe Perches $fix) { 3533628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 3534628f91a2SJoe Perches } 3535628f91a2SJoe Perches } 35367ccf41a8SJoe Perches# check MAINTAINERS entries for the right ordering too 35377ccf41a8SJoe Perches my $preferred_order = 'MRLSWQBCPTFXNK'; 35387ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 35397ccf41a8SJoe Perches $prevrawline =~ /^[\+ ][A-Z]:/) { 35407ccf41a8SJoe Perches $rawline =~ /^\+([A-Z]):\s*(.*)/; 35417ccf41a8SJoe Perches my $cur = $1; 35427ccf41a8SJoe Perches my $curval = $2; 35437ccf41a8SJoe Perches $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/; 35447ccf41a8SJoe Perches my $prev = $1; 35457ccf41a8SJoe Perches my $prevval = $2; 35467ccf41a8SJoe Perches my $curindex = index($preferred_order, $cur); 35477ccf41a8SJoe Perches my $previndex = index($preferred_order, $prev); 35487ccf41a8SJoe Perches if ($curindex < 0) { 35497ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 35507ccf41a8SJoe Perches "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr); 35517ccf41a8SJoe Perches } else { 35527ccf41a8SJoe Perches if ($previndex >= 0 && $curindex < $previndex) { 35537ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 35547ccf41a8SJoe Perches "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev); 35557ccf41a8SJoe Perches } elsif ((($prev eq 'F' && $cur eq 'F') || 35567ccf41a8SJoe Perches ($prev eq 'X' && $cur eq 'X')) && 35577ccf41a8SJoe Perches ($prevval cmp $curval) > 0) { 35587ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 35597ccf41a8SJoe Perches "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev); 35607ccf41a8SJoe Perches } 35617ccf41a8SJoe Perches } 35627ccf41a8SJoe Perches } 35637ccf41a8SJoe Perches } 3564628f91a2SJoe Perches 3565c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 3566c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 3567c68e5878SArnaud Lacombe my $flag = $1; 3568c68e5878SArnaud Lacombe my $replacement = { 3569c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 3570c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 3571c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 3572c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 3573c68e5878SArnaud Lacombe }; 3574c68e5878SArnaud Lacombe 3575c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 3576c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 3577c68e5878SArnaud Lacombe } 3578c68e5878SArnaud Lacombe 3579bff5da43SRob Herring# check for DT compatible documentation 35807dd05b38SFlorian Vaussard if (defined $root && 35817dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 35827dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 35837dd05b38SFlorian Vaussard 3584bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 3585bff5da43SRob Herring 3586cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 3587852d095dSRob Herring my $vp_file = $dt_path . "vendor-prefixes.yaml"; 3588cc93319bSFlorian Vaussard 3589bff5da43SRob Herring foreach my $compat (@compats) { 3590bff5da43SRob Herring my $compat2 = $compat; 3591185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 3592185d566bSRob Herring my $compat3 = $compat; 3593185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 3594185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 3595bff5da43SRob Herring if ( $? >> 8 ) { 3596bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3597bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 3598bff5da43SRob Herring } 3599bff5da43SRob Herring 36004fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 36014fbf32a6SFlorian Vaussard my $vendor = $1; 3602852d095dSRob Herring `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`; 3603bff5da43SRob Herring if ( $? >> 8 ) { 3604bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3605cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 3606bff5da43SRob Herring } 3607bff5da43SRob Herring } 3608bff5da43SRob Herring } 3609bff5da43SRob Herring 36109f3a8992SRob Herring# check for using SPDX license tag at beginning of files 36119f3a8992SRob Herring if ($realline == $checklicenseline) { 36129f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 36139f3a8992SRob Herring $checklicenseline = 2; 36149f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 36159f3a8992SRob Herring my $comment = ""; 36169f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 36179f3a8992SRob Herring $comment = '/*'; 36189f3a8992SRob Herring } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 36199f3a8992SRob Herring $comment = '//'; 3620c8df0ab6SLubomir Rintel } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) { 36219f3a8992SRob Herring $comment = '#'; 36229f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 36239f3a8992SRob Herring $comment = '..'; 36249f3a8992SRob Herring } 36259f3a8992SRob Herring 3626fdf13693SJoe Perches# check SPDX comment style for .[chsS] files 3627fdf13693SJoe Perches if ($realfile =~ /\.[chsS]$/ && 3628fdf13693SJoe Perches $rawline =~ /SPDX-License-Identifier:/ && 3629ffbce897SJoe Perches $rawline !~ m@^\+\s*\Q$comment\E\s*@) { 3630fdf13693SJoe Perches WARN("SPDX_LICENSE_TAG", 3631fdf13693SJoe Perches "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr); 3632fdf13693SJoe Perches } 3633fdf13693SJoe Perches 36349f3a8992SRob Herring if ($comment !~ /^$/ && 3635ffbce897SJoe Perches $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) { 36369f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 36379f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 36383b6e8ac9SJoe Perches } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) { 36393b6e8ac9SJoe Perches my $spdx_license = $1; 36403b6e8ac9SJoe Perches if (!is_SPDX_License_valid($spdx_license)) { 36413b6e8ac9SJoe Perches WARN("SPDX_LICENSE_TAG", 36423b6e8ac9SJoe Perches "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr); 36433b6e8ac9SJoe Perches } 364450c92900SLubomir Rintel if ($realfile =~ m@^Documentation/devicetree/bindings/@ && 364550c92900SLubomir Rintel not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) { 364650c92900SLubomir Rintel my $msg_level = \&WARN; 364750c92900SLubomir Rintel $msg_level = \&CHK if ($file); 364850c92900SLubomir Rintel if (&{$msg_level}("SPDX_LICENSE_TAG", 364950c92900SLubomir Rintel 365050c92900SLubomir Rintel "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) && 365150c92900SLubomir Rintel $fix) { 365250c92900SLubomir Rintel $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/; 365350c92900SLubomir Rintel } 365450c92900SLubomir Rintel } 36559f3a8992SRob Herring } 36569f3a8992SRob Herring } 36579f3a8992SRob Herring } 36589f3a8992SRob Herring 3659a0154cdbSJoe Perches# check for embedded filenames 3660a0154cdbSJoe Perches if ($rawline =~ /^\+.*\Q$realfile\E/) { 3661a0154cdbSJoe Perches WARN("EMBEDDED_FILENAME", 3662a0154cdbSJoe Perches "It's generally not useful to have the filename in the file\n" . $herecurr); 3663a0154cdbSJoe Perches } 3664a0154cdbSJoe Perches 36655368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 3666d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 36675368df20SAndy Whitcroft 3668a8da38a9SJoe Perches# check for using SPDX-License-Identifier on the wrong line number 3669a8da38a9SJoe Perches if ($realline != $checklicenseline && 3670a8da38a9SJoe Perches $rawline =~ /\bSPDX-License-Identifier:/ && 3671a8da38a9SJoe Perches substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) { 3672a8da38a9SJoe Perches WARN("SPDX_LICENSE_TAG", 3673a8da38a9SJoe Perches "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr); 3674a8da38a9SJoe Perches } 3675a8da38a9SJoe Perches 367647e0c88bSJoe Perches# line length limit (with some exclusions) 367747e0c88bSJoe Perches# 367847e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 367947e0c88bSJoe Perches# logging functions like pr_info that end in a string 368047e0c88bSJoe Perches# lines with a single string 368147e0c88bSJoe Perches# #defines that are a single string 36822e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 368347e0c88bSJoe Perches# 368447e0c88bSJoe Perches# There are 3 different line length message types: 3685ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 368647e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 368747e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 368847e0c88bSJoe Perches# 368947e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 369047e0c88bSJoe Perches# 369147e0c88bSJoe Perches 3692b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 369347e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 369447e0c88bSJoe Perches 369547e0c88bSJoe Perches # Check the allowed long line types first 369647e0c88bSJoe Perches 369747e0c88bSJoe Perches # logging functions that end in a string that starts 369847e0c88bSJoe Perches # before $max_line_length 369947e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 370047e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 370147e0c88bSJoe Perches $msg_type = ""; 370247e0c88bSJoe Perches 370347e0c88bSJoe Perches # lines with only strings (w/ possible termination) 370447e0c88bSJoe Perches # #defines with only strings 370547e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 370647e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 370747e0c88bSJoe Perches $msg_type = ""; 370847e0c88bSJoe Perches 3709cc147506SJoe Perches # More special cases 3710cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3711cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3712d560a5f8SJoe Perches $msg_type = ""; 3713d560a5f8SJoe Perches 37142e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 37152e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 37162e4bbbc5SAndreas Brauchli $msg_type = ""; 37172e4bbbc5SAndreas Brauchli 371847e0c88bSJoe Perches # Otherwise set the alternate message types 371947e0c88bSJoe Perches 372047e0c88bSJoe Perches # a comment starts before $max_line_length 372147e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 372247e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 372347e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 372447e0c88bSJoe Perches 372547e0c88bSJoe Perches # a quoted string starts before $max_line_length 372647e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 372747e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 372847e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 372947e0c88bSJoe Perches } 373047e0c88bSJoe Perches 373147e0c88bSJoe Perches if ($msg_type ne "" && 373247e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 3733bdc48fa1SJoe Perches my $msg_level = \&WARN; 3734bdc48fa1SJoe Perches $msg_level = \&CHK if ($file); 3735bdc48fa1SJoe Perches &{$msg_level}($msg_type, 3736bdc48fa1SJoe Perches "line length of $length exceeds $max_line_length columns\n" . $herecurr); 37370a920b5bSAndy Whitcroft } 373847e0c88bSJoe Perches } 37390a920b5bSAndy Whitcroft 37408905a67cSAndy Whitcroft# check for adding lines without a newline. 37418905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 374247ca69b8STom Rix if (WARN("MISSING_EOF_NEWLINE", 374347ca69b8STom Rix "adding a line without newline at end of file\n" . $herecurr) && 374447ca69b8STom Rix $fix) { 374547ca69b8STom Rix fix_delete_line($fixlinenr+1, "No newline at end of file"); 374647ca69b8STom Rix } 37478905a67cSAndy Whitcroft } 37488905a67cSAndy Whitcroft 3749de93245cSAditya Srivastava# check for .L prefix local symbols in .S files 3750de93245cSAditya Srivastava if ($realfile =~ /\.S$/ && 3751de93245cSAditya Srivastava $line =~ /^\+\s*(?:[A-Z]+_)?SYM_[A-Z]+_(?:START|END)(?:_[A-Z_]+)?\s*\(\s*\.L/) { 3752de93245cSAditya Srivastava WARN("AVOID_L_PREFIX", 3753de93245cSAditya 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); 3754de93245cSAditya Srivastava } 3755de93245cSAditya Srivastava 3756b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3757de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 37580a920b5bSAndy Whitcroft 37590a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 3760713a09deSAntonio Borneo# more than $tabsize must use tabs. 3761c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3762c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3763c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3764d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 37653705ce5bSJoe Perches if (ERROR("CODE_INDENT", 37663705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 37673705ce5bSJoe Perches $fix) { 3768194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 37693705ce5bSJoe Perches } 37700a920b5bSAndy Whitcroft } 37710a920b5bSAndy Whitcroft 377208e44365SAlberto Panizzo# check for space before tabs. 377308e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 377408e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 37753705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 37763705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 37773705ce5bSJoe Perches $fix) { 3778194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3779713a09deSAntonio Borneo s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} 3780194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3781c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 37823705ce5bSJoe Perches } 378308e44365SAlberto Panizzo } 378408e44365SAlberto Panizzo 37856a487211SJoe Perches# check for assignments on the start of a line 37866a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 3787da7355abSAditya Srivastava my $operator = $1; 3788da7355abSAditya Srivastava if (CHK("ASSIGNMENT_CONTINUATIONS", 3789da7355abSAditya Srivastava "Assignment operator '$1' should be on the previous line\n" . $hereprev) && 3790da7355abSAditya Srivastava $fix && $prevrawline =~ /^\+/) { 3791da7355abSAditya Srivastava # add assignment operator to the previous line, remove from current line 3792da7355abSAditya Srivastava $fixed[$fixlinenr - 1] .= " $operator"; 3793da7355abSAditya Srivastava $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//; 3794da7355abSAditya Srivastava } 37956a487211SJoe Perches } 37966a487211SJoe Perches 3797d1fe9c09SJoe Perches# check for && or || at the start of a line 3798d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 37998e08f076SAditya Srivastava my $operator = $1; 38008e08f076SAditya Srivastava if (CHK("LOGICAL_CONTINUATIONS", 38018e08f076SAditya Srivastava "Logical continuations should be on the previous line\n" . $hereprev) && 38028e08f076SAditya Srivastava $fix && $prevrawline =~ /^\+/) { 38038e08f076SAditya Srivastava # insert logical operator at last non-comment, non-whitepsace char on previous line 38048e08f076SAditya Srivastava $prevline =~ /[\s$;]*$/; 38058e08f076SAditya Srivastava my $line_end = substr($prevrawline, $-[0]); 38068e08f076SAditya Srivastava $fixed[$fixlinenr - 1] =~ s/\Q$line_end\E$/ $operator$line_end/; 38078e08f076SAditya Srivastava $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//; 38088e08f076SAditya Srivastava } 3809d1fe9c09SJoe Perches } 3810d1fe9c09SJoe Perches 3811a91e8994SJoe Perches# check indentation starts on a tab stop 38125b57980dSJoe Perches if ($perl_version_ok && 3813bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3814a91e8994SJoe Perches my $indent = length($1); 3815713a09deSAntonio Borneo if ($indent % $tabsize) { 3816a91e8994SJoe Perches if (WARN("TABSTOP", 3817a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3818a91e8994SJoe Perches $fix) { 3819713a09deSAntonio Borneo $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; 3820a91e8994SJoe Perches } 3821a91e8994SJoe Perches } 3822a91e8994SJoe Perches } 3823a91e8994SJoe Perches 3824d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 38255b57980dSJoe Perches if ($perl_version_ok && 3826fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3827d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3828d1fe9c09SJoe Perches my $oldindent = $1; 3829d1fe9c09SJoe Perches my $rest = $2; 3830d1fe9c09SJoe Perches 3831d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3832d1fe9c09SJoe Perches if ($pos >= 0) { 3833b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3834b34a26f3SJoe Perches my $newindent = $2; 3835d1fe9c09SJoe Perches 3836d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3837713a09deSAntonio Borneo "\t" x ($pos / $tabsize) . 3838713a09deSAntonio Borneo " " x ($pos % $tabsize); 3839d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3840d1fe9c09SJoe Perches 3841d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3842d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 38433705ce5bSJoe Perches 38443705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 38453705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 38463705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3847194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38483705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 38493705ce5bSJoe Perches } 3850d1fe9c09SJoe Perches } 3851d1fe9c09SJoe Perches } 3852d1fe9c09SJoe Perches } 3853d1fe9c09SJoe Perches 38546ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 38556ab3a970SJoe Perches# avoid checking a few false positives: 38566ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 38576ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 38586ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 38596ab3a970SJoe Perches# multiline macros that define functions 38606ab3a970SJoe Perches# known attributes or the __attribute__ keyword 38616ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 38626ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 38633705ce5bSJoe Perches if (CHK("SPACING", 3864f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 38653705ce5bSJoe Perches $fix) { 3866194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3867f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 38683705ce5bSJoe Perches } 3869aad4f614SJoe Perches } 3870aad4f614SJoe Perches 387186406b1cSJoe Perches# Block comment styles 387286406b1cSJoe Perches# Networking with an initial /* 387305880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3874fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 387585ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 3876c70735c2SŁukasz Stelmach $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier 387705880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 387805880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 387905880600SJoe Perches } 388005880600SJoe Perches 388186406b1cSJoe Perches# Block comments use * on subsequent lines 388286406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 388386406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3884a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 388561135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3886a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 388786406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 388886406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3889a605e32eSJoe Perches } 3890a605e32eSJoe Perches 389186406b1cSJoe Perches# Block comments use */ on trailing lines 389286406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3893c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3894c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3895c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 389686406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 389786406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 389805880600SJoe Perches } 389905880600SJoe Perches 390008eb9b80SJoe Perches# Block comment * alignment 390108eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3902af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3903af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3904af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 390508eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3906af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3907af207524SJoe Perches my $oldindent; 390808eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3909af207524SJoe Perches if (defined($1)) { 3910af207524SJoe Perches $oldindent = expand_tabs($1); 3911af207524SJoe Perches } else { 3912af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3913af207524SJoe Perches $oldindent = expand_tabs($1); 3914af207524SJoe Perches } 391508eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 391608eb9b80SJoe Perches my $newindent = $1; 391708eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3918af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 391908eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 392008eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 392108eb9b80SJoe Perches } 392208eb9b80SJoe Perches } 392308eb9b80SJoe Perches 39247f619191SJoe Perches# check for missing blank lines after struct/union declarations 39257f619191SJoe Perches# with exceptions for various attributes and macros 39267f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 39277f619191SJoe Perches $line =~ /^\+/ && 39287f619191SJoe Perches !($line =~ /^\+\s*$/ || 39297f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 39307f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 39317f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 39327f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 39337f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 39347f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 39350bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 39367f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3937d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3938d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3939d752fcc8SJoe Perches $fix) { 3940f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3941d752fcc8SJoe Perches } 39427f619191SJoe Perches } 39437f619191SJoe Perches 3944365dd4eaSJoe Perches# check for multiple consecutive blank lines 3945365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3946365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3947365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3948d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3949d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3950d752fcc8SJoe Perches $fix) { 3951f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3952d752fcc8SJoe Perches } 3953d752fcc8SJoe Perches 3954365dd4eaSJoe Perches $last_blank_line = $linenr; 3955365dd4eaSJoe Perches } 3956365dd4eaSJoe Perches 39573b617e3bSJoe Perches# check for missing blank lines after declarations 3958b5e8736aSJoe Perches# (declarations must have the same indentation and not be at the start of line) 3959b5e8736aSJoe Perches if (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/) { 3960b5e8736aSJoe Perches # use temporaries 3961b5e8736aSJoe Perches my $sl = $sline; 3962b5e8736aSJoe Perches my $pl = $prevline; 3963b5e8736aSJoe Perches # remove $Attribute/$Sparse uses to simplify comparisons 3964b5e8736aSJoe Perches $sl =~ s/\b(?:$Attribute|$Sparse)\b//g; 3965b5e8736aSJoe Perches $pl =~ s/\b(?:$Attribute|$Sparse)\b//g; 3966b5e8736aSJoe Perches if (($pl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 39675a4e1fd3SJoe Perches # function pointer declarations 3968b5e8736aSJoe Perches $pl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 39693f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 3970b5e8736aSJoe Perches $pl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 39713f7bac03SJoe Perches # known declaration macros 3972b5e8736aSJoe Perches $pl =~ /^\+\s+$declaration_macros/) && 39733f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 3974b5e8736aSJoe Perches !($pl =~ /^\+\s+$c90_Keywords\b/ || 39753f7bac03SJoe Perches # other possible extensions of declaration lines 3976b5e8736aSJoe Perches $pl =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 39773f7bac03SJoe Perches # not starting a section or a macro "\" extended line 3978b5e8736aSJoe Perches $pl =~ /(?:\{\s*|\\)$/) && 39793f7bac03SJoe Perches # looks like a declaration 3980b5e8736aSJoe Perches !($sl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 39815a4e1fd3SJoe Perches # function pointer declarations 3982b5e8736aSJoe Perches $sl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 39833f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 3984b5e8736aSJoe Perches $sl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 39853f7bac03SJoe Perches # known declaration macros 3986b5e8736aSJoe Perches $sl =~ /^\+\s+$declaration_macros/ || 39873f7bac03SJoe Perches # start of struct or union or enum 3988b5e8736aSJoe Perches $sl =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ || 39893f7bac03SJoe Perches # start or end of block or continuation of declaration 3990b5e8736aSJoe Perches $sl =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 39913f7bac03SJoe Perches # bitfield continuation 3992b5e8736aSJoe Perches $sl =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 39933f7bac03SJoe Perches # other possible extensions of declaration lines 3994b5e8736aSJoe Perches $sl =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/)) { 3995d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3996d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3997d752fcc8SJoe Perches $fix) { 3998f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3999d752fcc8SJoe Perches } 40003b617e3bSJoe Perches } 4001b5e8736aSJoe Perches } 40023b617e3bSJoe Perches 40035f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 40046b4c5bebSAndy Whitcroft# Exceptions: 40056b4c5bebSAndy Whitcroft# 1) within comments 40066b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 40076b4c5bebSAndy Whitcroft# 3) hanging labels 40083705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 40095f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 40103705ce5bSJoe Perches if (WARN("LEADING_SPACE", 40113705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 40123705ce5bSJoe Perches $fix) { 4013194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 40143705ce5bSJoe Perches } 40155f7ddae6SRaffaele Recalcati } 40165f7ddae6SRaffaele Recalcati 4017b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 4018b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 4019b9ea10d6SAndy Whitcroft 40205751a24eSJoe Perches# check for unusual line ending [ or ( 40215751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 40225751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 40235751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 40245751a24eSJoe Perches } 40255751a24eSJoe Perches 40264dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 40274dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 40284dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 40294dbed76fSJoe Perches $context_function = $1; 40304dbed76fSJoe Perches } 40314dbed76fSJoe Perches 40324dbed76fSJoe Perches# check if this appears to be the end of function declaration 40334dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 40344dbed76fSJoe Perches undef $context_function; 40354dbed76fSJoe Perches } 40364dbed76fSJoe Perches 4037032a4c0fSJoe Perches# check indentation of any line with a bare else 4038840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 4039032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 4040032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 4041032a4c0fSJoe Perches my $tabs = length($1) + 1; 4042840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 4043840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 4044840080a0SJoe Perches defined $lines[$linenr] && 4045840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 4046032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 4047032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 4048032a4c0fSJoe Perches } 4049032a4c0fSJoe Perches } 4050032a4c0fSJoe Perches 4051c00df19aSJoe Perches# check indentation of a line with a break; 4052dc58bc55SJoe Perches# if the previous line is a goto, return or break 4053dc58bc55SJoe Perches# and is indented the same # of tabs 4054c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 4055c00df19aSJoe Perches my $tabs = $1; 4056dc58bc55SJoe Perches if ($prevline =~ /^\+$tabs(goto|return|break)\b/) { 4057dc58bc55SJoe Perches if (WARN("UNNECESSARY_BREAK", 4058dc58bc55SJoe Perches "break is not useful after a $1\n" . $hereprev) && 4059dc58bc55SJoe Perches $fix) { 4060dc58bc55SJoe Perches fix_delete_line($fixlinenr, $rawline); 4061dc58bc55SJoe Perches } 4062c00df19aSJoe Perches } 4063c00df19aSJoe Perches } 4064c00df19aSJoe Perches 4065c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 4066cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 4067000d1cc1SJoe Perches WARN("CVS_KEYWORD", 4068000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 4069c2fdda0dSAndy Whitcroft } 407022f2a2efSAndy Whitcroft 407156e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 407256e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 407356e77d70SJoe Perches WARN("HOTPLUG_SECTION", 407456e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 407556e77d70SJoe Perches } 407656e77d70SJoe Perches 40779c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 40782b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 40792b474a1aSAndy Whitcroft $realline_next); 40803e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 4081ca819864SJoe Perches if ($linenr > $suppress_statement && 40821b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 4083170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 4084f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4085171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 4086171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 4087171ae1a4SAndy Whitcroft 40883e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 40893e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 40903e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 40913e469cdcSAndy Whitcroft # until we hit end of it. 40923e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 40933e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 40943e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 40953e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 40963e469cdcSAndy Whitcroft } 4097f74bd194SAndy Whitcroft 40982b474a1aSAndy Whitcroft # Find the real next line. 40992b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 41002b474a1aSAndy Whitcroft if (defined $realline_next && 41012b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 41022b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 41032b474a1aSAndy Whitcroft $realline_next++; 41042b474a1aSAndy Whitcroft } 41052b474a1aSAndy Whitcroft 4106171ae1a4SAndy Whitcroft my $s = $stat; 4107171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 4108cf655043SAndy Whitcroft 4109c2fdda0dSAndy Whitcroft # Ignore goto labels. 4110171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 4111c2fdda0dSAndy Whitcroft 4112c2fdda0dSAndy Whitcroft # Ignore functions being called 4113171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 4114c2fdda0dSAndy Whitcroft 4115463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 4116463f2864SAndy Whitcroft 4117c45dcabdSAndy Whitcroft # declarations always start with types 4118d2506586SAndy 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) { 4119c45dcabdSAndy Whitcroft my $type = $1; 4120c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 4121c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 4122c45dcabdSAndy Whitcroft 41236c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 4124a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 4125c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 4126c2fdda0dSAndy Whitcroft } 41278905a67cSAndy Whitcroft 41286c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 412965863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 4130c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 41319c0ca6f9SAndy Whitcroft } 41328905a67cSAndy Whitcroft 41338905a67cSAndy Whitcroft # Check for any sort of function declaration. 41348905a67cSAndy Whitcroft # int foo(something bar, other baz); 41358905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 4136171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 41378905a67cSAndy Whitcroft my ($name_len) = length($1); 41388905a67cSAndy Whitcroft 4139cf655043SAndy Whitcroft my $ctx = $s; 4140773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 41418905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 4142cf655043SAndy Whitcroft 41438905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 4144c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 41458905a67cSAndy Whitcroft 4146c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 41478905a67cSAndy Whitcroft } 41488905a67cSAndy Whitcroft } 41498905a67cSAndy Whitcroft } 41508905a67cSAndy Whitcroft 41519c0ca6f9SAndy Whitcroft } 41529c0ca6f9SAndy Whitcroft 415300df344fSAndy Whitcroft# 415400df344fSAndy Whitcroft# Checks which may be anchored in the context. 415500df344fSAndy Whitcroft# 415600df344fSAndy Whitcroft 415700df344fSAndy Whitcroft# Check for switch () and associated case and default 415800df344fSAndy Whitcroft# statements should be at the same indent. 415900df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 416000df344fSAndy Whitcroft my $err = ''; 416100df344fSAndy Whitcroft my $sep = ''; 416200df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 416300df344fSAndy Whitcroft shift(@ctx); 416400df344fSAndy Whitcroft for my $ctx (@ctx) { 416500df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 416600df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 416700df344fSAndy Whitcroft $indent != $cindent) { 416800df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 416900df344fSAndy Whitcroft $sep = ''; 417000df344fSAndy Whitcroft } else { 417100df344fSAndy Whitcroft $sep = "[...]\n"; 417200df344fSAndy Whitcroft } 417300df344fSAndy Whitcroft } 417400df344fSAndy Whitcroft if ($err ne '') { 4175000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 4176000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 4177de7d4f0eSAndy Whitcroft } 4178de7d4f0eSAndy Whitcroft } 4179de7d4f0eSAndy Whitcroft 4180de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 4181de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 41820fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 4183773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 4184773647a0SAndy Whitcroft 41859c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 41868eef05ddSJoe Perches 41878eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 41888eef05ddSJoe Perches WARN("DEEP_INDENTATION", 41898eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 41908eef05ddSJoe Perches } 41918eef05ddSJoe Perches 4192de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 4193de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 4194de7d4f0eSAndy Whitcroft 4195548596d5SAndy Whitcroft my $ctx_ln = $linenr; 4196548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 4197de7d4f0eSAndy Whitcroft 4198548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 4199548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 4200548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 4201548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 4202548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 4203773647a0SAndy Whitcroft $ctx_ln++; 4204773647a0SAndy Whitcroft } 4205548596d5SAndy Whitcroft 420653210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 420753210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 4208773647a0SAndy Whitcroft 4209773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 4210000d1cc1SJoe Perches ERROR("OPEN_BRACE", 4211000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 421201464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 421300df344fSAndy Whitcroft } 4214773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 4215773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 4216773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 4217773647a0SAndy Whitcroft { 42189c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 42199c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 4220000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 4221000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 422201464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 42239c0ca6f9SAndy Whitcroft } 42249c0ca6f9SAndy Whitcroft } 422500df344fSAndy Whitcroft } 422600df344fSAndy Whitcroft 42274d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 4228f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 42293e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 42303e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 42313e469cdcSAndy Whitcroft if (!defined $stat); 42324d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 42334d001e4dSAndy Whitcroft 42344d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 42354d001e4dSAndy Whitcroft 42369f5af480SJoe Perches # remove inline comments 42379f5af480SJoe Perches $s =~ s/$;/ /g; 42389f5af480SJoe Perches $c =~ s/$;/ /g; 42394d001e4dSAndy Whitcroft 42404d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 42416f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 42426f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 42434d001e4dSAndy Whitcroft 42449f5af480SJoe Perches # Make sure we remove the line prefixes as we have 42459f5af480SJoe Perches # none on the first line, and are going to readd them 42469f5af480SJoe Perches # where necessary. 42479f5af480SJoe Perches $s =~ s/\n./\n/gs; 42489f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 42499f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 42509f5af480SJoe Perches } 42519f5af480SJoe Perches 42524d001e4dSAndy Whitcroft # We want to check the first line inside the block 42534d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 42544d001e4dSAndy Whitcroft # 1) any blank line termination 42554d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 42564d001e4dSAndy Whitcroft # 3) any do (...) { 42574d001e4dSAndy Whitcroft my $continuation = 0; 42584d001e4dSAndy Whitcroft my $check = 0; 42594d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 42604d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 42614d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 42624d001e4dSAndy Whitcroft $continuation = 1; 42634d001e4dSAndy Whitcroft } 42649bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 42654d001e4dSAndy Whitcroft $check = 1; 42664d001e4dSAndy Whitcroft $cond_lines++; 42674d001e4dSAndy Whitcroft } 42684d001e4dSAndy Whitcroft 42694d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 42704d001e4dSAndy Whitcroft # preprocessor statement. 42714d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 42724d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 42734d001e4dSAndy Whitcroft $check = 0; 42744d001e4dSAndy Whitcroft } 42754d001e4dSAndy Whitcroft 42769bd49efeSAndy Whitcroft my $cond_ptr = -1; 4277740504c6SAndy Whitcroft $continuation = 0; 42789bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 42799bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 42804d001e4dSAndy Whitcroft 4281f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 4282f16fa28fSAndy Whitcroft # is not linear. 4283f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 4284f16fa28fSAndy Whitcroft $check = 0; 4285f16fa28fSAndy Whitcroft } 4286f16fa28fSAndy Whitcroft 42879bd49efeSAndy Whitcroft # Ignore: 42889bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 42899bd49efeSAndy Whitcroft # 2) preprocessor lines, and 42909bd49efeSAndy Whitcroft # 3) labels. 4291740504c6SAndy Whitcroft if ($continuation || 4292740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 42939bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 42949bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 4295740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 429630dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 42979bd49efeSAndy Whitcroft $cond_lines++; 42989bd49efeSAndy Whitcroft } 42994d001e4dSAndy Whitcroft } 430030dad6ebSAndy Whitcroft } 43014d001e4dSAndy Whitcroft 43024d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 43034d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 43044d001e4dSAndy Whitcroft 43054d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 43064d001e4dSAndy Whitcroft # this is not this patch's fault. 43074d001e4dSAndy Whitcroft if (!defined($stat_real) || 43084d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 43094d001e4dSAndy Whitcroft $check = 0; 43104d001e4dSAndy Whitcroft } 43114d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 43124d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 43134d001e4dSAndy Whitcroft } 43144d001e4dSAndy Whitcroft 43159bd49efeSAndy 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"; 43164d001e4dSAndy Whitcroft 43179f5af480SJoe Perches if ($check && $s ne '' && 4318713a09deSAntonio Borneo (($sindent % $tabsize) != 0 || 43199f5af480SJoe Perches ($sindent < $indent) || 4320f6950a73SJoe Perches ($sindent == $indent && 4321f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 4322713a09deSAntonio Borneo ($sindent > $indent + $tabsize))) { 4323000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 4324000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 43254d001e4dSAndy Whitcroft } 43264d001e4dSAndy Whitcroft } 43274d001e4dSAndy Whitcroft 43286c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 43296c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 43301f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 43311f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 43326c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 4333c2fdda0dSAndy Whitcroft if ($dbg_values) { 4334c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 4335cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 4336cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 43371f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 4338c2fdda0dSAndy Whitcroft } 43396c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 43406c72ffaaSAndy Whitcroft 434100df344fSAndy Whitcroft#ignore lines not being added 43423705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 434300df344fSAndy Whitcroft 434499ca38c2SJoe Perches# check for self assignments used to avoid compiler warnings 434599ca38c2SJoe Perches# e.g.: int foo = foo, *bar = NULL; 434699ca38c2SJoe Perches# struct foo bar = *(&(bar)); 434799ca38c2SJoe Perches if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) { 434899ca38c2SJoe Perches my $var = $1; 434999ca38c2SJoe Perches if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) { 435099ca38c2SJoe Perches WARN("SELF_ASSIGNMENT", 435199ca38c2SJoe Perches "Do not use self-assignments to avoid compiler warnings\n" . $herecurr); 435299ca38c2SJoe Perches } 435399ca38c2SJoe Perches } 435499ca38c2SJoe Perches 435511ca40a0SJoe Perches# check for dereferences that span multiple lines 435611ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 435711ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 435811ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 435911ca40a0SJoe Perches my $ref = $1; 436011ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 436111ca40a0SJoe Perches $ref .= $1; 436211ca40a0SJoe Perches $ref =~ s/\s//g; 436311ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 436411ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 436511ca40a0SJoe Perches } 436611ca40a0SJoe Perches 4367a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 4368c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 4369a1ce18e4SJoe Perches my $type = $1; 4370a1ce18e4SJoe Perches my $var = $2; 4371207a8e84SJoe Perches $var = "" if (!defined $var); 4372207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 4373a1ce18e4SJoe Perches my $sign = $1; 4374a1ce18e4SJoe Perches my $pointer = $2; 4375a1ce18e4SJoe Perches 4376a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 4377a1ce18e4SJoe Perches 4378a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 4379a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 4380a1ce18e4SJoe Perches $fix) { 4381a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 4382207a8e84SJoe Perches my $comp_pointer = $pointer; 4383207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 4384207a8e84SJoe Perches $decl .= $comp_pointer; 4385207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 4386207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 4387a1ce18e4SJoe Perches } 4388a1ce18e4SJoe Perches } 4389a1ce18e4SJoe Perches } 4390a1ce18e4SJoe Perches 4391653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 43927429c690SAndy Whitcroft if ($dbg_type) { 43937429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 4394000d1cc1SJoe Perches ERROR("TEST_TYPE", 4395000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 43967429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 4397000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 4398000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 43997429c690SAndy Whitcroft } 4400653d4876SAndy Whitcroft next; 4401653d4876SAndy Whitcroft } 4402a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 4403a1ef277eSAndy Whitcroft if ($dbg_attr) { 44049360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 4405000d1cc1SJoe Perches ERROR("TEST_ATTR", 4406000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 44079360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 4408000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 4409000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 4410a1ef277eSAndy Whitcroft } 4411a1ef277eSAndy Whitcroft next; 4412a1ef277eSAndy Whitcroft } 4413653d4876SAndy Whitcroft 4414f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 441599423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 441699423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 4417d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 4418d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 4419f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 4420f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4421f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 4422d752fcc8SJoe Perches my $fixedline = $prevrawline; 4423d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 4424f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 4425d752fcc8SJoe Perches $fixedline = $line; 44268d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 4427f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 4428d752fcc8SJoe Perches } 4429f0a594c1SAndy Whitcroft } 4430f0a594c1SAndy Whitcroft 443100df344fSAndy Whitcroft# 443200df344fSAndy Whitcroft# Checks which are anchored on the added line. 443300df344fSAndy Whitcroft# 443400df344fSAndy Whitcroft 4435653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 4436c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 4437653d4876SAndy Whitcroft my $path = $1; 4438653d4876SAndy Whitcroft if ($path =~ m{//}) { 4439000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 4440495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 4441495e9d84SJoe Perches } 4442495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 4443495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 4444495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 4445653d4876SAndy Whitcroft } 4446653d4876SAndy Whitcroft } 4447653d4876SAndy Whitcroft 444800df344fSAndy Whitcroft# no C99 // comments 444900df344fSAndy Whitcroft if ($line =~ m{//}) { 44503705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 44513705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 44523705ce5bSJoe Perches $fix) { 4453194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 44543705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 44553705ce5bSJoe Perches my $comment = trim($1); 4456194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 44573705ce5bSJoe Perches } 44583705ce5bSJoe Perches } 445900df344fSAndy Whitcroft } 446000df344fSAndy Whitcroft # Remove C99 comments. 44610a920b5bSAndy Whitcroft $line =~ s@//.*@@; 44626c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 44630a920b5bSAndy Whitcroft 44642b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 44652b474a1aSAndy Whitcroft# the whole statement. 44662b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 44672b474a1aSAndy Whitcroft if (defined $realline_next && 44682b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 44692b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 447036794822SChristoph Hellwig ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/)) { 44713cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 44723cbf62dfSAndy Whitcroft # a prefix: 44733cbf62dfSAndy Whitcroft # XXX(foo); 44743cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 4475653d4876SAndy Whitcroft my $name = $1; 447670a11659SJoe Perches $name =~ s/^\s*($Ident).*/$1/; 447787a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 44783cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 44793cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 44803cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 44813cbf62dfSAndy Whitcroft 44823cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 44832b474a1aSAndy Whitcroft \n.}\s*$| 448448012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 448548012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 448648012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 44872b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 44882b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 448948012058SAndy Whitcroft )/x) { 44902b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 44912b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 44922b474a1aSAndy Whitcroft } else { 44932b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 44940a920b5bSAndy Whitcroft } 44950a920b5bSAndy Whitcroft } 44962b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 44972b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 449836794822SChristoph Hellwig ($line =~ /EXPORT_SYMBOL.*\((.*)\)/)) { 44992b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 45002b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 45012b474a1aSAndy Whitcroft } 45022b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 45032b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 4504000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 4505000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 45062b474a1aSAndy Whitcroft } 45070a920b5bSAndy Whitcroft 45085150bda4SJoe Eloff# check for global initialisers. 45095b8f82e1SSong Liu if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/ && 45105b8f82e1SSong Liu !exclude_global_initialisers($realfile)) { 4511d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 45126d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 4513d5e616fcSJoe Perches $fix) { 45146d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 4515d5e616fcSJoe Perches } 4516f0a594c1SAndy Whitcroft } 45170a920b5bSAndy Whitcroft# check for static initialisers. 45186d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 4519d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 45206d32f7a3SJoe Perches "do not initialise statics to $1\n" . 4521d5e616fcSJoe Perches $herecurr) && 4522d5e616fcSJoe Perches $fix) { 45236d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 4524d5e616fcSJoe Perches } 45250a920b5bSAndy Whitcroft } 45260a920b5bSAndy Whitcroft 45271813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 45281813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 45291813087dSJoe Perches my $tmp = trim($1); 45301813087dSJoe Perches WARN("MISORDERED_TYPE", 45311813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 45321813087dSJoe Perches } 45331813087dSJoe Perches 4534809e082eSJoe Perches# check for unnecessary <signed> int declarations of short/long/long long 4535809e082eSJoe Perches while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) { 4536809e082eSJoe Perches my $type = trim($1); 4537809e082eSJoe Perches next if ($type !~ /\bint\b/); 4538809e082eSJoe Perches next if ($type !~ /\b(?:short|long\s+long|long)\b/); 4539809e082eSJoe Perches my $new_type = $type; 4540809e082eSJoe Perches $new_type =~ s/\b\s*int\s*\b/ /; 4541809e082eSJoe Perches $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /; 4542809e082eSJoe Perches $new_type =~ s/^const\s+//; 4543809e082eSJoe Perches $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/); 4544809e082eSJoe Perches $new_type = "const $new_type" if ($type =~ /^const\b/); 4545809e082eSJoe Perches $new_type =~ s/\s+/ /g; 4546809e082eSJoe Perches $new_type = trim($new_type); 4547809e082eSJoe Perches if (WARN("UNNECESSARY_INT", 4548809e082eSJoe Perches "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) && 4549809e082eSJoe Perches $fix) { 4550809e082eSJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/; 4551809e082eSJoe Perches } 4552809e082eSJoe Perches } 4553809e082eSJoe Perches 4554cb710ecaSJoe Perches# check for static const char * arrays. 4555cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 4556000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4557000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 4558cb710ecaSJoe Perches $herecurr); 4559cb710ecaSJoe Perches } 4560cb710ecaSJoe Perches 456177b8c0a8SJoe Perches# check for initialized const char arrays that should be static const 456277b8c0a8SJoe Perches if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) { 456377b8c0a8SJoe Perches if (WARN("STATIC_CONST_CHAR_ARRAY", 456477b8c0a8SJoe Perches "const array should probably be static const\n" . $herecurr) && 456577b8c0a8SJoe Perches $fix) { 456677b8c0a8SJoe Perches $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/; 456777b8c0a8SJoe Perches } 456877b8c0a8SJoe Perches } 456977b8c0a8SJoe Perches 4570cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 4571cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 4572000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4573000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 4574cb710ecaSJoe Perches $herecurr); 4575cb710ecaSJoe Perches } 4576cb710ecaSJoe Perches 4577ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 4578ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 4579ab7e23f3SJoe Perches my $found = $1; 4580ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 4581ab7e23f3SJoe Perches WARN("CONST_CONST", 4582ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 4583ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 4584ab7e23f3SJoe Perches WARN("CONST_CONST", 4585ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 4586ab7e23f3SJoe Perches } 4587ab7e23f3SJoe Perches } 4588ab7e23f3SJoe Perches 458973169765SJoe Perches# check for const static or static <non ptr type> const declarations 459073169765SJoe Perches# prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const' 459173169765SJoe Perches if ($sline =~ /^\+\s*const\s+static\s+($Type)\b/ || 459273169765SJoe Perches $sline =~ /^\+\s*static\s+($BasicType)\s+const\b/) { 459373169765SJoe Perches if (WARN("STATIC_CONST", 459473169765SJoe Perches "Move const after static - use 'static const $1'\n" . $herecurr) && 459573169765SJoe Perches $fix) { 459673169765SJoe Perches $fixed[$fixlinenr] =~ s/\bconst\s+static\b/static const/; 459773169765SJoe Perches $fixed[$fixlinenr] =~ s/\bstatic\s+($BasicType)\s+const\b/static const $1/; 459873169765SJoe Perches } 459973169765SJoe Perches } 460073169765SJoe Perches 46019b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 46029b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 46039b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 46049b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 46059b0fa60dSJoe Perches $herecurr); 46069b0fa60dSJoe Perches } 46079b0fa60dSJoe Perches 4608b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 4609b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 4610b598b670SJoe Perches my $array = $1; 4611b598b670SJoe 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*\))@) { 4612b598b670SJoe Perches my $array_div = $1; 4613b598b670SJoe Perches if (WARN("ARRAY_SIZE", 4614b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 4615b598b670SJoe Perches $fix) { 4616b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 4617b598b670SJoe Perches } 4618b598b670SJoe Perches } 4619b598b670SJoe Perches } 4620b598b670SJoe Perches 4621b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 462216b7f3c8SJoe Perches if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) { 4623b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 4624b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 4625b36190c5SJoe Perches $fix) { 4626194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 4627b36190c5SJoe Perches } 4628b36190c5SJoe Perches } 4629b36190c5SJoe Perches 4630653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 4631653d4876SAndy Whitcroft# make sense. 4632653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 46338054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 4634c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 46358ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 463646d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 4637000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 4638000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 46390a920b5bSAndy Whitcroft } 46400a920b5bSAndy Whitcroft 46410a920b5bSAndy Whitcroft# * goes on variable not on type 464265863862SAndy Whitcroft # (char*[ const]) 4643bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 4644bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 46453705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 4646d8aaf121SAndy Whitcroft 464765863862SAndy Whitcroft # Should start with a space. 464865863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 464965863862SAndy Whitcroft # Should not end with a space. 465065863862SAndy Whitcroft $to =~ s/\s+$//; 465165863862SAndy Whitcroft # '*'s should not have spaces between. 4652f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 465365863862SAndy Whitcroft } 4654d8aaf121SAndy Whitcroft 46553705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 465665863862SAndy Whitcroft if ($from ne $to) { 46573705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 46583705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 46593705ce5bSJoe Perches $fix) { 46603705ce5bSJoe Perches my $sub_from = $ident; 46613705ce5bSJoe Perches my $sub_to = $ident; 46623705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4663194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46643705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 46653705ce5bSJoe Perches } 466665863862SAndy Whitcroft } 4667bfcb2cc7SAndy Whitcroft } 4668bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 4669bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 46703705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 4671d8aaf121SAndy Whitcroft 467265863862SAndy Whitcroft # Should start with a space. 467365863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 467465863862SAndy Whitcroft # Should not end with a space. 467565863862SAndy Whitcroft $to =~ s/\s+$//; 467665863862SAndy Whitcroft # '*'s should not have spaces between. 4677f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 467865863862SAndy Whitcroft } 467965863862SAndy Whitcroft # Modifiers should have spaces. 468065863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 468165863862SAndy Whitcroft 46823705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 4683667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 46843705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 46853705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 46863705ce5bSJoe Perches $fix) { 46873705ce5bSJoe Perches 46883705ce5bSJoe Perches my $sub_from = $match; 46893705ce5bSJoe Perches my $sub_to = $match; 46903705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4691194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46923705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 46933705ce5bSJoe Perches } 469465863862SAndy Whitcroft } 46950a920b5bSAndy Whitcroft } 46960a920b5bSAndy Whitcroft 46979d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 46989d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 46990675a8fbSJean Delvare my $msg_level = \&WARN; 47000675a8fbSJean Delvare $msg_level = \&CHK if ($file); 47010675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 47029d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 47039d3e3c70SJoe Perches } 47040a920b5bSAndy Whitcroft 47059d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 47068905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 4707000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 4708000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 47098905a67cSAndy Whitcroft } 47108905a67cSAndy Whitcroft 471117441227SJoe Perches# check for uses of printk_ratelimit 471217441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 4713000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 4714000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 471517441227SJoe Perches } 471617441227SJoe Perches 4717eeef5733SJoe Perches# printk should use KERN_* levels 4718eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 4719000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 4720eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 472100df344fSAndy Whitcroft } 47220a920b5bSAndy Whitcroft 4723f5eea3b0SJoe Perches# prefer variants of (subsystem|netdev|dev|pr)_<level> to printk(KERN_<LEVEL> 4724f5eea3b0SJoe Perches if ($line =~ /\b(printk(_once|_ratelimited)?)\s*\(\s*KERN_([A-Z]+)/) { 4725f5eea3b0SJoe Perches my $printk = $1; 4726f5eea3b0SJoe Perches my $modifier = $2; 4727f5eea3b0SJoe Perches my $orig = $3; 4728f5eea3b0SJoe Perches $modifier = "" if (!defined($modifier)); 4729243f3803SJoe Perches my $level = lc($orig); 4730243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 47318f26b837SJoe Perches my $level2 = $level; 47328f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 4733f5eea3b0SJoe Perches $level .= $modifier; 4734f5eea3b0SJoe Perches $level2 .= $modifier; 4735243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 4736f5eea3b0SJoe Perches "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to $printk(KERN_$orig ...\n" . $herecurr); 4737243f3803SJoe Perches } 4738243f3803SJoe Perches 4739f5eea3b0SJoe Perches# prefer dev_<level> to dev_printk(KERN_<LEVEL> 4740dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 4741dc139313SJoe Perches my $orig = $1; 4742dc139313SJoe Perches my $level = lc($orig); 4743dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 4744dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 4745dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 4746dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 4747dc139313SJoe Perches } 4748dc139313SJoe Perches 47498020b253SNicolas Boichat# trace_printk should not be used in production code. 47508020b253SNicolas Boichat if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) { 47518020b253SNicolas Boichat WARN("TRACE_PRINTK", 47528020b253SNicolas Boichat "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr); 47538020b253SNicolas Boichat } 47548020b253SNicolas Boichat 475591c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 475691c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 475791c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 475891c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 475991c9afafSAndy Lutomirski WARN("ENOSYS", 476091c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 476191c9afafSAndy Lutomirski } 476291c9afafSAndy Lutomirski 47636b9ea5ffSJakub Kicinski# ENOTSUPP is not a standard error code and should be avoided in new patches. 47646b9ea5ffSJakub Kicinski# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP. 47656b9ea5ffSJakub Kicinski# Similarly to ENOSYS warning a small number of false positives is expected. 47666b9ea5ffSJakub Kicinski if (!$file && $line =~ /\bENOTSUPP\b/) { 47676b9ea5ffSJakub Kicinski if (WARN("ENOTSUPP", 47686b9ea5ffSJakub Kicinski "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) && 47696b9ea5ffSJakub Kicinski $fix) { 47706b9ea5ffSJakub Kicinski $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/; 47716b9ea5ffSJakub Kicinski } 47726b9ea5ffSJakub Kicinski } 47736b9ea5ffSJakub Kicinski 4774653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 4775653d4876SAndy Whitcroft# or if closed on same line 47765b57980dSJoe Perches if ($perl_version_ok && 47772d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 47782d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 47792d453e3bSJoe Perches $sline !~ /}/) { 47808d182478SJoe Perches if (ERROR("OPEN_BRACE", 47812d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 47828d182478SJoe Perches $fix) { 47838d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 47848d182478SJoe Perches my $fixed_line = $rawline; 478503f49351SDwaipayan Ray $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*)\{(.*)$/; 47868d182478SJoe Perches my $line1 = $1; 47878d182478SJoe Perches my $line2 = $2; 47888d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 47898d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 47908d182478SJoe Perches if ($line2 !~ /^\s*$/) { 47918d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 47928d182478SJoe Perches } 47938d182478SJoe Perches } 47940a920b5bSAndy Whitcroft } 4795653d4876SAndy Whitcroft 47968905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 47978905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 47988905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 47998d182478SJoe Perches if (ERROR("OPEN_BRACE", 48008d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 48018d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 48028d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48038d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 48048d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 48058d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48068d182478SJoe Perches $fixedline = $rawline; 48078d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 48088d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 48098d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48108d182478SJoe Perches } 48118d182478SJoe Perches } 48128905a67cSAndy Whitcroft } 48138905a67cSAndy Whitcroft 48140c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 48153705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 48163705ce5bSJoe Perches if (WARN("SPACING", 48173705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 48183705ce5bSJoe Perches $fix) { 4819194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48203705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 48213705ce5bSJoe Perches } 48220c73b4ebSAndy Whitcroft } 48230c73b4ebSAndy Whitcroft 482431070b5dSJoe Perches# Function pointer declarations 482531070b5dSJoe Perches# check spacing between type, funcptr, and args 482631070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 482791f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 482831070b5dSJoe Perches my $declare = $1; 482931070b5dSJoe Perches my $pre_pointer_space = $2; 483031070b5dSJoe Perches my $post_pointer_space = $3; 483131070b5dSJoe Perches my $funcname = $4; 483231070b5dSJoe Perches my $post_funcname_space = $5; 483331070b5dSJoe Perches my $pre_args_space = $6; 483431070b5dSJoe Perches 483591f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 483691f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 483791f72e9cSJoe Perches# don't need a space so don't warn for those. 483891f72e9cSJoe Perches my $post_declare_space = ""; 483991f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 484091f72e9cSJoe Perches $post_declare_space = $1; 484191f72e9cSJoe Perches $declare = rtrim($declare); 484291f72e9cSJoe Perches } 484391f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 484431070b5dSJoe Perches WARN("SPACING", 484531070b5dSJoe Perches "missing space after return type\n" . $herecurr); 484691f72e9cSJoe Perches $post_declare_space = " "; 484731070b5dSJoe Perches } 484831070b5dSJoe Perches 484931070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 485091f72e9cSJoe Perches# This test is not currently implemented because these declarations are 485191f72e9cSJoe Perches# equivalent to 485291f72e9cSJoe Perches# int foo(int bar, ...) 485391f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 485491f72e9cSJoe Perches# 485591f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 485691f72e9cSJoe Perches# WARN("SPACING", 485791f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 485891f72e9cSJoe Perches# } 485931070b5dSJoe Perches 486031070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 486131070b5dSJoe Perches if (defined $pre_pointer_space && 486231070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 486331070b5dSJoe Perches WARN("SPACING", 486431070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 486531070b5dSJoe Perches } 486631070b5dSJoe Perches 486731070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 486831070b5dSJoe Perches if (defined $post_pointer_space && 486931070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 487031070b5dSJoe Perches WARN("SPACING", 487131070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 487231070b5dSJoe Perches } 487331070b5dSJoe Perches 487431070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 487531070b5dSJoe Perches if (defined $post_funcname_space && 487631070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 487731070b5dSJoe Perches WARN("SPACING", 487831070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 487931070b5dSJoe Perches } 488031070b5dSJoe Perches 488131070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 488231070b5dSJoe Perches if (defined $pre_args_space && 488331070b5dSJoe Perches $pre_args_space =~ /^\s/) { 488431070b5dSJoe Perches WARN("SPACING", 488531070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 488631070b5dSJoe Perches } 488731070b5dSJoe Perches 488831070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4889194f66fcSJoe Perches $fixed[$fixlinenr] =~ 489091f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 489131070b5dSJoe Perches } 489231070b5dSJoe Perches } 489331070b5dSJoe Perches 48948d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 48958d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4896fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4897fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 48988d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 48998d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 49008d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4901fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 490238dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 49033705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 49043705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 49053705ce5bSJoe Perches $fix) { 4906194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49073705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 49083705ce5bSJoe Perches } 49098d31cfceSAndy Whitcroft } 49108d31cfceSAndy Whitcroft } 49118d31cfceSAndy Whitcroft 4912f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 49136c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4914c2fdda0dSAndy Whitcroft my $name = $1; 4915773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4916773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4917c2fdda0dSAndy Whitcroft 4918c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4919773647a0SAndy Whitcroft if ($name =~ /^(?: 4920773647a0SAndy Whitcroft if|for|while|switch|return|case| 4921773647a0SAndy Whitcroft volatile|__volatile__| 4922773647a0SAndy Whitcroft __attribute__|format|__extension__| 4923773647a0SAndy Whitcroft asm|__asm__)$/x) 4924773647a0SAndy Whitcroft { 4925c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4926c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4927c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4928c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4929773647a0SAndy Whitcroft 4930773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4931c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4932c2fdda0dSAndy Whitcroft 4933c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4934c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4935773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4936c2fdda0dSAndy Whitcroft 4937c2fdda0dSAndy Whitcroft } else { 49383705ce5bSJoe Perches if (WARN("SPACING", 49393705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 49403705ce5bSJoe Perches $fix) { 4941194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49423705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 49433705ce5bSJoe Perches } 4944f0a594c1SAndy Whitcroft } 49456c72ffaaSAndy Whitcroft } 49469a4cad4eSEric Nelson 4947653d4876SAndy Whitcroft# Check operator spacing. 49480a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 49493705ce5bSJoe Perches my $fixed_line = ""; 49503705ce5bSJoe Perches my $line_fixed = 0; 49513705ce5bSJoe Perches 49529c0ca6f9SAndy Whitcroft my $ops = qr{ 49539c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 49549c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 49559c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 49561f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 495784731623SJoe Perches \?:|\?|: 49589c0ca6f9SAndy Whitcroft }x; 4959cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 49603705ce5bSJoe Perches 49613705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 49623705ce5bSJoe Perches## foreach my $el (@elements) { 49633705ce5bSJoe Perches## print("el: <$el>\n"); 49643705ce5bSJoe Perches## } 49653705ce5bSJoe Perches 49663705ce5bSJoe Perches my @fix_elements = (); 496700df344fSAndy Whitcroft my $off = 0; 49686c72ffaaSAndy Whitcroft 49693705ce5bSJoe Perches foreach my $el (@elements) { 49703705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 49713705ce5bSJoe Perches $off += length($el); 49723705ce5bSJoe Perches } 49733705ce5bSJoe Perches 49743705ce5bSJoe Perches $off = 0; 49753705ce5bSJoe Perches 49766c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4977b34c648bSJoe Perches my $last_after = -1; 49786c72ffaaSAndy Whitcroft 49790a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 49803705ce5bSJoe Perches 49813705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 49823705ce5bSJoe Perches 49833705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 49843705ce5bSJoe Perches 49854a0df2efSAndy Whitcroft $off += length($elements[$n]); 49864a0df2efSAndy Whitcroft 498725985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4988773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4989773647a0SAndy Whitcroft my $cc = ''; 4990773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4991773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4992773647a0SAndy Whitcroft } 4993773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4994773647a0SAndy Whitcroft 49954a0df2efSAndy Whitcroft my $a = ''; 49964a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 49974a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4998cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 49994a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 50004a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 5001773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 50024a0df2efSAndy Whitcroft 50030a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 50044a0df2efSAndy Whitcroft 50054a0df2efSAndy Whitcroft my $c = ''; 50060a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 50074a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 50084a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 5009cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 50104a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 50114a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 50128b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 50134a0df2efSAndy Whitcroft } else { 50144a0df2efSAndy Whitcroft $c = 'E'; 50150a920b5bSAndy Whitcroft } 50160a920b5bSAndy Whitcroft 50174a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 50184a0df2efSAndy Whitcroft 50194a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 50204a0df2efSAndy Whitcroft 50216c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 5022de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 50230a920b5bSAndy Whitcroft 502474048ed8SAndy Whitcroft # Pull out the value of this operator. 50256c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 50260a920b5bSAndy Whitcroft 50271f65f947SAndy Whitcroft # Get the full operator variant. 50281f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 50291f65f947SAndy Whitcroft 503013214adfSAndy Whitcroft # Ignore operators passed as parameters. 503113214adfSAndy Whitcroft if ($op_type ne 'V' && 5032d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 503313214adfSAndy Whitcroft 5034cf655043SAndy Whitcroft# # Ignore comments 5035cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 503613214adfSAndy Whitcroft 5037d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 503813214adfSAndy Whitcroft } elsif ($op eq ';') { 5039cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 5040cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 50413705ce5bSJoe Perches if (ERROR("SPACING", 50423705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 5043b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 50443705ce5bSJoe Perches $line_fixed = 1; 50453705ce5bSJoe Perches } 5046d8aaf121SAndy Whitcroft } 5047d8aaf121SAndy Whitcroft 5048d8aaf121SAndy Whitcroft # // is a comment 5049d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 50500a920b5bSAndy Whitcroft 5051b00e4814SJoe Perches # : when part of a bitfield 5052b00e4814SJoe Perches } elsif ($opv eq ':B') { 5053b00e4814SJoe Perches # skip the bitfield test for now 5054b00e4814SJoe Perches 50551f65f947SAndy Whitcroft # No spaces for: 50561f65f947SAndy Whitcroft # -> 5057b00e4814SJoe Perches } elsif ($op eq '->') { 50584a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 50593705ce5bSJoe Perches if (ERROR("SPACING", 50603705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 5061b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 50623705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 50633705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 50643705ce5bSJoe Perches } 5065b34c648bSJoe Perches $line_fixed = 1; 50663705ce5bSJoe Perches } 50670a920b5bSAndy Whitcroft } 50680a920b5bSAndy Whitcroft 50692381097bSJoe Perches # , must not have a space before and must have a space on the right. 50700a920b5bSAndy Whitcroft } elsif ($op eq ',') { 50712381097bSJoe Perches my $rtrim_before = 0; 50722381097bSJoe Perches my $space_after = 0; 50732381097bSJoe Perches if ($ctx =~ /Wx./) { 50742381097bSJoe Perches if (ERROR("SPACING", 50752381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 50762381097bSJoe Perches $line_fixed = 1; 50772381097bSJoe Perches $rtrim_before = 1; 50782381097bSJoe Perches } 50792381097bSJoe Perches } 5080cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 50813705ce5bSJoe Perches if (ERROR("SPACING", 50823705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 50833705ce5bSJoe Perches $line_fixed = 1; 5084b34c648bSJoe Perches $last_after = $n; 50852381097bSJoe Perches $space_after = 1; 50862381097bSJoe Perches } 50872381097bSJoe Perches } 50882381097bSJoe Perches if ($rtrim_before || $space_after) { 50892381097bSJoe Perches if ($rtrim_before) { 50902381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 50912381097bSJoe Perches } else { 50922381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 50932381097bSJoe Perches } 50942381097bSJoe Perches if ($space_after) { 50952381097bSJoe Perches $good .= " "; 50963705ce5bSJoe Perches } 50970a920b5bSAndy Whitcroft } 50980a920b5bSAndy Whitcroft 50999c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 510074048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 51019c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 51029c0ca6f9SAndy Whitcroft 51039c0ca6f9SAndy Whitcroft # unary operators should have a space before and 51049c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 51059c0ca6f9SAndy Whitcroft # unary operator, or a cast 51069c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 510774048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 51080d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 5109cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 51103705ce5bSJoe Perches if (ERROR("SPACING", 51113705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 5112b34c648bSJoe Perches if ($n != $last_after + 2) { 5113b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 51143705ce5bSJoe Perches $line_fixed = 1; 51153705ce5bSJoe Perches } 51160a920b5bSAndy Whitcroft } 5117b34c648bSJoe Perches } 5118a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 5119171ae1a4SAndy Whitcroft # A unary '*' may be const 5120171ae1a4SAndy Whitcroft 5121171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 51223705ce5bSJoe Perches if (ERROR("SPACING", 51233705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 5124b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 51253705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 51263705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 51273705ce5bSJoe Perches } 5128b34c648bSJoe Perches $line_fixed = 1; 51293705ce5bSJoe Perches } 51300a920b5bSAndy Whitcroft } 51310a920b5bSAndy Whitcroft 51320a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 51330a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 5134773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 51353705ce5bSJoe Perches if (ERROR("SPACING", 51363705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 5137b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 51383705ce5bSJoe Perches $line_fixed = 1; 51393705ce5bSJoe Perches } 51400a920b5bSAndy Whitcroft } 5141773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 5142773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 51433705ce5bSJoe Perches if (ERROR("SPACING", 51443705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 5145b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 51463705ce5bSJoe Perches $line_fixed = 1; 51473705ce5bSJoe Perches } 5148653d4876SAndy Whitcroft } 5149773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 51503705ce5bSJoe Perches if (ERROR("SPACING", 51513705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 5152b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 51533705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 51543705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5155773647a0SAndy Whitcroft } 5156b34c648bSJoe Perches $line_fixed = 1; 51573705ce5bSJoe Perches } 51583705ce5bSJoe Perches } 51590a920b5bSAndy Whitcroft 51600a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 51619c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 51629c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 51639c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 5164c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 5165c2fdda0dSAndy Whitcroft $op eq '%') 51660a920b5bSAndy Whitcroft { 5167d2e025f3SJoe Perches if ($check) { 5168d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 5169d2e025f3SJoe Perches if (CHK("SPACING", 5170d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 5171d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 5172d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5173d2e025f3SJoe Perches $line_fixed = 1; 5174d2e025f3SJoe Perches } 5175d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 5176d2e025f3SJoe Perches if (CHK("SPACING", 5177d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 5178d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 5179d2e025f3SJoe Perches $line_fixed = 1; 5180d2e025f3SJoe Perches } 5181d2e025f3SJoe Perches } 5182d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 51833705ce5bSJoe Perches if (ERROR("SPACING", 51843705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 5185b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 5186b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 5187b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5188b34c648bSJoe Perches } 51893705ce5bSJoe Perches $line_fixed = 1; 51903705ce5bSJoe Perches } 51910a920b5bSAndy Whitcroft } 51920a920b5bSAndy Whitcroft 51931f65f947SAndy Whitcroft # A colon needs no spaces before when it is 51941f65f947SAndy Whitcroft # terminating a case value or a label. 51951f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 5196263afd39SChris Down if ($ctx =~ /Wx./ and $realfile !~ m@.*\.lds\.h$@) { 51973705ce5bSJoe Perches if (ERROR("SPACING", 51983705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 5199b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 52003705ce5bSJoe Perches $line_fixed = 1; 52013705ce5bSJoe Perches } 52021f65f947SAndy Whitcroft } 52031f65f947SAndy Whitcroft 52040a920b5bSAndy Whitcroft # All the others need spaces both sides. 5205cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 52061f65f947SAndy Whitcroft my $ok = 0; 52071f65f947SAndy Whitcroft 520822f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 52091f65f947SAndy Whitcroft if (($op eq '<' && 52101f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 52111f65f947SAndy Whitcroft ($op eq '>' && 52121f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 52131f65f947SAndy Whitcroft { 52141f65f947SAndy Whitcroft $ok = 1; 52151f65f947SAndy Whitcroft } 52161f65f947SAndy Whitcroft 5217e0df7e1fSJoe Perches # for asm volatile statements 5218e0df7e1fSJoe Perches # ignore a colon with another 5219e0df7e1fSJoe Perches # colon immediately before or after 5220e0df7e1fSJoe Perches if (($op eq ':') && 5221e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 5222e0df7e1fSJoe Perches $ok = 1; 5223e0df7e1fSJoe Perches } 5224e0df7e1fSJoe Perches 522584731623SJoe Perches # messages are ERROR, but ?: are CHK 52261f65f947SAndy Whitcroft if ($ok == 0) { 52270675a8fbSJean Delvare my $msg_level = \&ERROR; 52280675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 522984731623SJoe Perches 52300675a8fbSJean Delvare if (&{$msg_level}("SPACING", 52313705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 5232b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 5233b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 5234b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5235b34c648bSJoe Perches } 52363705ce5bSJoe Perches $line_fixed = 1; 52373705ce5bSJoe Perches } 52380a920b5bSAndy Whitcroft } 523922f2a2efSAndy Whitcroft } 52404a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 52413705ce5bSJoe Perches 52423705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 52433705ce5bSJoe Perches 52443705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 52450a920b5bSAndy Whitcroft } 52463705ce5bSJoe Perches 52473705ce5bSJoe Perches if (($#elements % 2) == 0) { 52483705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 52493705ce5bSJoe Perches } 52503705ce5bSJoe Perches 5251194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 5252194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 52533705ce5bSJoe Perches } 52543705ce5bSJoe Perches 52553705ce5bSJoe Perches 52560a920b5bSAndy Whitcroft } 52570a920b5bSAndy Whitcroft 5258786b6326SJoe Perches# check for whitespace before a non-naked semicolon 5259d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 5260786b6326SJoe Perches if (WARN("SPACING", 5261786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 5262786b6326SJoe Perches $fix) { 5263194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 5264786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 5265786b6326SJoe Perches } 5266786b6326SJoe Perches } 5267786b6326SJoe Perches 5268f0a594c1SAndy Whitcroft# check for multiple assignments 5269f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 5270000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 5271000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 5272f0a594c1SAndy Whitcroft } 5273f0a594c1SAndy Whitcroft 527422f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 527522f2a2efSAndy Whitcroft## # continuation. 527622f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 527722f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 527822f2a2efSAndy Whitcroft## 527922f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 5280e73d2715SDwaipayan Ray## # falsely report the parameters of functions. 528122f2a2efSAndy Whitcroft## my $ln = $line; 528222f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 528322f2a2efSAndy Whitcroft## } 528422f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 5285000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 5286000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 528722f2a2efSAndy Whitcroft## } 528822f2a2efSAndy Whitcroft## } 5289f0a594c1SAndy Whitcroft 52900a920b5bSAndy Whitcroft#need space before brace following if, while, etc 52916b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 52926ad724e2SMichal Zylowski $line =~ /\b(?:else|do)\{/) { 52933705ce5bSJoe Perches if (ERROR("SPACING", 52943705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 52953705ce5bSJoe Perches $fix) { 52966ad724e2SMichal Zylowski $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/; 52973705ce5bSJoe Perches } 5298de7d4f0eSAndy Whitcroft } 5299de7d4f0eSAndy Whitcroft 5300c4a62ef9SJoe Perches## # check for blank lines before declarations 5301c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 5302c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 5303c4a62ef9SJoe Perches## WARN("SPACING", 5304c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 5305c4a62ef9SJoe Perches## } 5306c4a62ef9SJoe Perches## 5307c4a62ef9SJoe Perches 5308de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 5309de7d4f0eSAndy Whitcroft# on the line 531094fb9845SJoe Perches if ($line =~ /}(?!(?:,|;|\)|\}))\S/) { 5311d5e616fcSJoe Perches if (ERROR("SPACING", 5312d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 5313d5e616fcSJoe Perches $fix) { 5314194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5315d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 5316d5e616fcSJoe Perches } 53170a920b5bSAndy Whitcroft } 53180a920b5bSAndy Whitcroft 531922f2a2efSAndy Whitcroft# check spacing on square brackets 532022f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 53213705ce5bSJoe Perches if (ERROR("SPACING", 53223705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 53233705ce5bSJoe Perches $fix) { 5324194f66fcSJoe Perches $fixed[$fixlinenr] =~ 53253705ce5bSJoe Perches s/\[\s+/\[/; 53263705ce5bSJoe Perches } 532722f2a2efSAndy Whitcroft } 532822f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 53293705ce5bSJoe Perches if (ERROR("SPACING", 53303705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 53313705ce5bSJoe Perches $fix) { 5332194f66fcSJoe Perches $fixed[$fixlinenr] =~ 53333705ce5bSJoe Perches s/\s+\]/\]/; 53343705ce5bSJoe Perches } 533522f2a2efSAndy Whitcroft } 533622f2a2efSAndy Whitcroft 5337c45dcabdSAndy Whitcroft# check spacing on parentheses 53389c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 53399c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 53403705ce5bSJoe Perches if (ERROR("SPACING", 53413705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 53423705ce5bSJoe Perches $fix) { 5343194f66fcSJoe Perches $fixed[$fixlinenr] =~ 53443705ce5bSJoe Perches s/\(\s+/\(/; 53453705ce5bSJoe Perches } 534622f2a2efSAndy Whitcroft } 534713214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 5348c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 5349c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 53503705ce5bSJoe Perches if (ERROR("SPACING", 53513705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 53523705ce5bSJoe Perches $fix) { 5353194f66fcSJoe Perches $fixed[$fixlinenr] =~ 53543705ce5bSJoe Perches s/\s+\)/\)/; 53553705ce5bSJoe Perches } 535622f2a2efSAndy Whitcroft } 535722f2a2efSAndy Whitcroft 5358e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 5359e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 5360e2826fd0SJoe Perches 5361e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 5362ea4acbb1SJoe Perches my $var = $1; 5363ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 5364ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 5365ea4acbb1SJoe Perches $fix) { 5366ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 5367ea4acbb1SJoe Perches } 5368ea4acbb1SJoe Perches } 5369ea4acbb1SJoe Perches 5370ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 5371ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 5372ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 5373ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 5374ea4acbb1SJoe Perches my $var = $2; 5375ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 5376ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 5377ea4acbb1SJoe Perches $fix) { 5378ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 5379ea4acbb1SJoe Perches $var2 =~ s/\s//g; 5380ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 5381ea4acbb1SJoe Perches } 5382e2826fd0SJoe Perches } 5383e2826fd0SJoe Perches 538463b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 5385a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 5386a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 53875b57980dSJoe Perches $perl_version_ok && defined($stat) && 538863b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 538963b7c73eSJoe Perches my $if_stat = $1; 539063b7c73eSJoe Perches my $test = substr($2, 1, -1); 539163b7c73eSJoe Perches my $herectx; 539263b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 539363b7c73eSJoe Perches my $match = $1; 539463b7c73eSJoe Perches # avoid parentheses around potential macro args 539563b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 539663b7c73eSJoe Perches if (!defined($herectx)) { 539763b7c73eSJoe Perches $herectx = $here . "\n"; 539863b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 539963b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 540063b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 540163b7c73eSJoe Perches $herectx .= $rl . "\n"; 540263b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 540363b7c73eSJoe Perches } 540463b7c73eSJoe Perches } 540563b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 540663b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 540763b7c73eSJoe Perches } 540863b7c73eSJoe Perches } 540963b7c73eSJoe Perches 541069078651SJoe Perches# check that goto labels aren't indented (allow a single space indentation) 541169078651SJoe Perches# and ignore bitfield definitions like foo:1 541269078651SJoe Perches# Strictly, labels can have whitespace after the identifier and before the : 541369078651SJoe Perches# but this is not allowed here as many ?: uses would appear to be labels 541469078651SJoe Perches if ($sline =~ /^.\s+[A-Za-z_][A-Za-z\d_]*:(?!\s*\d+)/ && 541569078651SJoe Perches $sline !~ /^. [A-Za-z\d_][A-Za-z\d_]*:/ && 541669078651SJoe Perches $sline !~ /^.\s+default:/) { 54173705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 54183705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 54193705ce5bSJoe Perches $fix) { 5420194f66fcSJoe Perches $fixed[$fixlinenr] =~ 54213705ce5bSJoe Perches s/^(.)\s+/$1/; 54223705ce5bSJoe Perches } 54230a920b5bSAndy Whitcroft } 54240a920b5bSAndy Whitcroft 542540873abaSJoe Perches# check if a statement with a comma should be two statements like: 542640873abaSJoe Perches# foo = bar(), /* comma should be semicolon */ 542740873abaSJoe Perches# bar = baz(); 542840873abaSJoe Perches if (defined($stat) && 542940873abaSJoe Perches $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) { 543040873abaSJoe Perches my $cnt = statement_rawlines($stat); 543140873abaSJoe Perches my $herectx = get_stat_here($linenr, $cnt, $here); 543240873abaSJoe Perches WARN("SUSPECT_COMMA_SEMICOLON", 543340873abaSJoe Perches "Possible comma where semicolon could be used\n" . $herectx); 543440873abaSJoe Perches } 543540873abaSJoe Perches 54365b9553abSJoe Perches# return is not a function 5437507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 5438c45dcabdSAndy Whitcroft my $spacing = $1; 54395b57980dSJoe Perches if ($perl_version_ok && 54405b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 54415b9553abSJoe Perches my $value = $1; 54425b9553abSJoe Perches $value = deparenthesize($value); 54435b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 5444000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 5445000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 54465b9553abSJoe Perches } 5447c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 5448000d1cc1SJoe Perches ERROR("SPACING", 5449000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 5450c45dcabdSAndy Whitcroft } 5451c45dcabdSAndy Whitcroft } 5452507e5141SJoe Perches 5453b43ae21bSJoe Perches# unnecessary return in a void function 5454b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 5455b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 5456b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 5457b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 5458b43ae21bSJoe Perches $linenr >= 3 && 5459b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 5460b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 54619819cf25SJoe Perches WARN("RETURN_VOID", 5462b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 54639819cf25SJoe Perches } 54649819cf25SJoe Perches 5465189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 54665b57980dSJoe Perches if ($perl_version_ok && 5467189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 5468189248d8SJoe Perches my $openparens = $1; 5469189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 5470189248d8SJoe Perches my $msg = ""; 5471189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 5472189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 5473189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 5474189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 5475189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 5476189248d8SJoe Perches } 5477189248d8SJoe Perches } 5478189248d8SJoe Perches 5479c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 5480c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 5481c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 5482c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 54835b57980dSJoe Perches if ($perl_version_ok && 5484c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 5485c5595fa2SJoe Perches my $lead = $1; 5486c5595fa2SJoe Perches my $const = $2; 5487c5595fa2SJoe Perches my $comp = $3; 5488c5595fa2SJoe Perches my $to = $4; 5489c5595fa2SJoe Perches my $newcomp = $comp; 5490f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 5491c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 5492c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 5493c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 5494c5595fa2SJoe Perches $fix) { 5495c5595fa2SJoe Perches if ($comp eq "<") { 5496c5595fa2SJoe Perches $newcomp = ">"; 5497c5595fa2SJoe Perches } elsif ($comp eq "<=") { 5498c5595fa2SJoe Perches $newcomp = ">="; 5499c5595fa2SJoe Perches } elsif ($comp eq ">") { 5500c5595fa2SJoe Perches $newcomp = "<"; 5501c5595fa2SJoe Perches } elsif ($comp eq ">=") { 5502c5595fa2SJoe Perches $newcomp = "<="; 5503c5595fa2SJoe Perches } 5504c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 5505c5595fa2SJoe Perches } 5506c5595fa2SJoe Perches } 5507c5595fa2SJoe Perches 5508f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 5509f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 551053a3c448SAndy Whitcroft my $name = $1; 551146b85bf9SGuenter Roeck if ($name ne 'EOF' && $name ne 'ERROR' && $name !~ /^EPOLL/) { 5512000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 5513f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 551453a3c448SAndy Whitcroft } 551553a3c448SAndy Whitcroft } 5516c45dcabdSAndy Whitcroft 55170a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 55184a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 55193705ce5bSJoe Perches if (ERROR("SPACING", 55203705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 55213705ce5bSJoe Perches $fix) { 5522194f66fcSJoe Perches $fixed[$fixlinenr] =~ 55233705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 55243705ce5bSJoe Perches } 55250a920b5bSAndy Whitcroft } 55260a920b5bSAndy Whitcroft 5527f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 5528f5fe35ddSAndy Whitcroft# statements after the conditional. 5529170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 55303e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 55313e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 55323e469cdcSAndy Whitcroft if (!defined $stat); 5533170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 5534170d3a22SAndy Whitcroft $remain_next, $off_next); 5535170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 5536170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 5537170d3a22SAndy Whitcroft 5538170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 5539170d3a22SAndy Whitcroft # If the statement carries leading newlines, 5540170d3a22SAndy Whitcroft # then count those as offsets. 5541170d3a22SAndy Whitcroft my ($whitespace) = 5542170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 5543170d3a22SAndy Whitcroft my $offset = 5544170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 5545170d3a22SAndy Whitcroft 5546170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 5547170d3a22SAndy Whitcroft $offset} = 1; 5548170d3a22SAndy Whitcroft } 5549170d3a22SAndy Whitcroft } 5550170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 5551c11230f4SJoe Perches defined($stat) && defined($cond) && 5552170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 5553171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 55548905a67cSAndy Whitcroft 5555b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 555665b64b3bSJoe Perches if (ERROR("ASSIGN_IN_IF", 555765b64b3bSJoe Perches "do not use assignment in if condition\n" . $herecurr) && 555865b64b3bSJoe Perches $fix && $perl_version_ok) { 555965b64b3bSJoe Perches if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) { 556065b64b3bSJoe Perches my $space = $1; 556165b64b3bSJoe Perches my $not = $2; 556265b64b3bSJoe Perches my $statement = $3; 556365b64b3bSJoe Perches my $assigned = $4; 556465b64b3bSJoe Perches my $test = $8; 556565b64b3bSJoe Perches my $against = $9; 556665b64b3bSJoe Perches my $brace = $15; 556765b64b3bSJoe Perches fix_delete_line($fixlinenr, $rawline); 556865b64b3bSJoe Perches fix_insert_line($fixlinenr, "$space$statement;"); 556965b64b3bSJoe Perches my $newline = "${space}if ("; 557065b64b3bSJoe Perches $newline .= '!' if defined($not); 557165b64b3bSJoe Perches $newline .= '(' if (defined $not && defined($test) && defined($against)); 557265b64b3bSJoe Perches $newline .= "$assigned"; 557365b64b3bSJoe Perches $newline .= " $test $against" if (defined($test) && defined($against)); 557465b64b3bSJoe Perches $newline .= ')' if (defined $not && defined($test) && defined($against)); 557565b64b3bSJoe Perches $newline .= ')'; 557665b64b3bSJoe Perches $newline .= " {" if (defined($brace)); 557765b64b3bSJoe Perches fix_insert_line($fixlinenr + 1, $newline); 557865b64b3bSJoe Perches } 557965b64b3bSJoe Perches } 55808905a67cSAndy Whitcroft } 55818905a67cSAndy Whitcroft 55828905a67cSAndy Whitcroft # Find out what is on the end of the line after the 55838905a67cSAndy Whitcroft # conditional. 5584773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 55858905a67cSAndy Whitcroft $s =~ s/\n.*//g; 558613214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 558753210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 558853210168SAndy Whitcroft $c !~ /}\s*while\s*/) 5589773647a0SAndy Whitcroft { 5590bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 5591bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 5592bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 559342bdf74cSHidetoshi Seto my $stat_real = ''; 5594bb44ad39SAndy Whitcroft 559542bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 559642bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 5597bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 5598bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 5599bb44ad39SAndy Whitcroft } 5600bb44ad39SAndy Whitcroft 5601000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5602000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 56038905a67cSAndy Whitcroft } 56048905a67cSAndy Whitcroft } 56058905a67cSAndy Whitcroft 560613214adfSAndy Whitcroft# Check for bitwise tests written as boolean 560713214adfSAndy Whitcroft if ($line =~ / 560813214adfSAndy Whitcroft (?: 560913214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 561013214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 561113214adfSAndy Whitcroft (?:\&\&|\|\|) 561213214adfSAndy Whitcroft | 561313214adfSAndy Whitcroft (?:\&\&|\|\|) 561413214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 561513214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 561613214adfSAndy Whitcroft )/x) 561713214adfSAndy Whitcroft { 5618000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 5619000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 562013214adfSAndy Whitcroft } 562113214adfSAndy Whitcroft 56228905a67cSAndy Whitcroft# if and else should not have general statements after it 562313214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 562413214adfSAndy Whitcroft my $s = $1; 562513214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 562613214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 5627000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5628000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 56290a920b5bSAndy Whitcroft } 563013214adfSAndy Whitcroft } 563139667782SAndy Whitcroft# if should not continue a brace 563239667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 5633000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5634048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 563539667782SAndy Whitcroft $herecurr); 563639667782SAndy Whitcroft } 5637a1080bf8SAndy Whitcroft# case and default should not have general statements after them 5638a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 5639a1080bf8SAndy Whitcroft $line !~ /\G(?: 56403fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 5641a1080bf8SAndy Whitcroft \s*return\s+ 5642a1080bf8SAndy Whitcroft )/xg) 5643a1080bf8SAndy Whitcroft { 5644000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5645000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 5646a1080bf8SAndy Whitcroft } 56470a920b5bSAndy Whitcroft 56480a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 56490a920b5bSAndy Whitcroft # indent level to be relevant to each other. 56508b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 56510a920b5bSAndy Whitcroft $previndent == $indent) { 56528b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 56538b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 56548b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 56558b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 56568b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 56578b8856f4SJoe Perches my $fixedline = $prevrawline; 56588b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 56598b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 56608b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 56618b8856f4SJoe Perches } 56628b8856f4SJoe Perches $fixedline = $rawline; 56638b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 56648b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 56658b8856f4SJoe Perches } 56660a920b5bSAndy Whitcroft } 56670a920b5bSAndy Whitcroft 56688b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 5669c2fdda0dSAndy Whitcroft $previndent == $indent) { 5670c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 5671c2fdda0dSAndy Whitcroft 5672c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 5673c2fdda0dSAndy Whitcroft # conditional. 5674773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 5675c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 5676c2fdda0dSAndy Whitcroft 5677c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 56788b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 56798b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 56808b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 56818b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 56828b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 56838b8856f4SJoe Perches my $fixedline = $prevrawline; 56848b8856f4SJoe Perches my $trailing = $rawline; 56858b8856f4SJoe Perches $trailing =~ s/^\+//; 56868b8856f4SJoe Perches $trailing = trim($trailing); 56878b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 56888b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 56898b8856f4SJoe Perches } 5690c2fdda0dSAndy Whitcroft } 5691c2fdda0dSAndy Whitcroft } 5692c2fdda0dSAndy Whitcroft 569395e2c602SJoe Perches#Specific variable tests 5694323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 5695323c1260SJoe Perches my $var = $1; 569695e2c602SJoe Perches 569795e2c602SJoe Perches#CamelCase 5698807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 5699be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 57004104a206SŁukasz Stelmach#Ignore some autogenerated defines and enum values 57014104a206SŁukasz Stelmach $var !~ /^(?:[A-Z]+_){1,5}[A-Z]{1,3}[a-z]/ && 570222735ce8SJoe Perches#Ignore Page<foo> variants 5703807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 5704d439e6a5SJoe Perches#Ignore SI style variants like nS, mV and dB 5705d439e6a5SJoe Perches#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE) 5706d439e6a5SJoe Perches $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ && 5707f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 5708f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 57097e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 57107e781f67SJoe Perches my $word = $1; 57117e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 5712d8b07710SJoe Perches if ($check) { 5713d8b07710SJoe Perches seed_camelcase_includes(); 5714d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 5715d8b07710SJoe Perches seed_camelcase_file($realfile); 5716d8b07710SJoe Perches $camelcase_file_seeded = 1; 5717d8b07710SJoe Perches } 5718d8b07710SJoe Perches } 57197e781f67SJoe Perches if (!defined $camelcase{$word}) { 57207e781f67SJoe Perches $camelcase{$word} = 1; 5721be79794bSJoe Perches CHK("CAMELCASE", 57227e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 57237e781f67SJoe Perches } 5724323c1260SJoe Perches } 5725323c1260SJoe Perches } 57263445686aSJoe Perches } 57270a920b5bSAndy Whitcroft 57280a920b5bSAndy Whitcroft#no spaces allowed after \ in define 5729d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 5730d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 5731d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 5732d5e616fcSJoe Perches $fix) { 5733194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 5734d5e616fcSJoe Perches } 57350a920b5bSAndy Whitcroft } 57360a920b5bSAndy Whitcroft 57370e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 57380e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 5739c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 5740e09dec48SAndy Whitcroft my $file = "$1.h"; 5741e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 5742e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 5743e09dec48SAndy Whitcroft $realfile ne $checkfile && 57447840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 5745c45dcabdSAndy Whitcroft { 57460e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 57470e212e0aSFabian Frederick if ($asminclude > 0) { 5748e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 5749000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 5750000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5751e09dec48SAndy Whitcroft } else { 5752000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 5753000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5754e09dec48SAndy Whitcroft } 57550a920b5bSAndy Whitcroft } 57560a920b5bSAndy Whitcroft } 57570e212e0aSFabian Frederick } 57580a920b5bSAndy Whitcroft 5759653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 5760653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 5761cf655043SAndy Whitcroft# in a known good container 5762b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 5763b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 5764d8aaf121SAndy Whitcroft my $ln = $linenr; 5765d8aaf121SAndy Whitcroft my $cnt = $realcnt; 5766c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 5767c45dcabdSAndy Whitcroft my $ctx = ''; 576808a2843eSJoe Perches my $has_flow_statement = 0; 576908a2843eSJoe Perches my $has_arg_concat = 0; 5770c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 5771f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 5772f74bd194SAndy Whitcroft $ctx = $dstat; 5773c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 5774a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 5775c45dcabdSAndy Whitcroft 577608a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 577762e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 577808a2843eSJoe Perches 5779f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 5780f59b64bfSJoe Perches my $define_args = $1; 5781f59b64bfSJoe Perches my $define_stmt = $dstat; 5782f59b64bfSJoe Perches my @def_args = (); 5783f59b64bfSJoe Perches 5784f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 5785f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 5786f59b64bfSJoe Perches $define_args =~ s/\s*//g; 57878c8c45cfSJoe Perches $define_args =~ s/\\\+?//g; 5788f59b64bfSJoe Perches @def_args = split(",", $define_args); 5789f59b64bfSJoe Perches } 5790f59b64bfSJoe Perches 5791292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 5792c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 5793c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 5794c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 5795c45dcabdSAndy Whitcroft 5796c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 57972e44e803SDwaipayan Ray while ($dstat =~ s/\([^\(\)]*\)/1u/ || 57982e44e803SDwaipayan Ray $dstat =~ s/\{[^\{\}]*\}/1u/ || 57992e44e803SDwaipayan Ray $dstat =~ s/.\[[^\[\]]*\]/1u/) 5800bf30d6edSAndy Whitcroft { 5801c45dcabdSAndy Whitcroft } 5802c45dcabdSAndy Whitcroft 5803342d3d2fSAntonio Borneo # Flatten any obvious string concatenation. 580433acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 580533acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 5806e45bab8eSAndy Whitcroft { 5807e45bab8eSAndy Whitcroft } 5808e45bab8eSAndy Whitcroft 580942e15293SJoe Perches # Make asm volatile uses seem like a generic function 581042e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 581142e15293SJoe Perches 5812c45dcabdSAndy Whitcroft my $exceptions = qr{ 5813c45dcabdSAndy Whitcroft $Declare| 5814c45dcabdSAndy Whitcroft module_param_named| 5815a0a0a7a9SKees Cook MODULE_PARM_DESC| 5816c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 5817c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 5818383099fdSAndy Whitcroft __typeof__\(| 581922fd2d3eSStefani Seibold union| 582022fd2d3eSStefani Seibold struct| 5821ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 58226b10df42SVladimir Zapolskiy ^\"|\"$| 58236b10df42SVladimir Zapolskiy ^\[ 5824c45dcabdSAndy Whitcroft }x; 58255eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 5826f59b64bfSJoe Perches 5827f59b64bfSJoe Perches $ctx =~ s/\n*$//; 5828f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 5829e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 5830f59b64bfSJoe Perches 5831f74bd194SAndy Whitcroft if ($dstat ne '' && 5832f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 5833f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 58343cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 5835356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5836f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 5837f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5838e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 583972f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 58402e44e803SDwaipayan Ray $dstat !~ /^while\s*$Constant\s*$Constant\s*$/ && # while (...) {...} 5841f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5842f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5843f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 58444e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5845f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5846c45dcabdSAndy Whitcroft { 5847e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5848e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5849e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5850e795556aSJoe Perches } elsif ($dstat =~ /;/) { 5851f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5852f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5853f74bd194SAndy Whitcroft } else { 5854000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 5855388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5856d8aaf121SAndy Whitcroft } 5857f59b64bfSJoe Perches 5858f59b64bfSJoe Perches } 58595207649bSJoe Perches 58605207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 58615207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 58625207649bSJoe Perches my $first = 1; 58635207649bSJoe Perches $define_stmt = ""; 58645207649bSJoe Perches foreach my $l (@stmt_array) { 58655207649bSJoe Perches $l =~ s/\\$//; 58665207649bSJoe Perches if ($first) { 58675207649bSJoe Perches $define_stmt = $l; 58685207649bSJoe Perches $first = 0; 58695207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 58705207649bSJoe Perches $define_stmt .= substr($l, 1); 58715207649bSJoe Perches } 58725207649bSJoe Perches } 58735207649bSJoe Perches $define_stmt =~ s/$;//g; 58745207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 58755207649bSJoe Perches $define_stmt = trim($define_stmt); 58765207649bSJoe Perches 5877f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5878f59b64bfSJoe Perches foreach my $arg (@def_args) { 5879f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 58809192d41aSJoe Perches next if ($arg =~ /^type$/i); 58817fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 58827b844345SVincent 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; 58837fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 58847fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 5885d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 5886f59b64bfSJoe Perches if ($use_cnt > 1) { 5887f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5888f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5889f59b64bfSJoe Perches } 58909192d41aSJoe Perches# check if any macro arguments may have other precedence issues 58917fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 58929192d41aSJoe Perches ((defined($1) && $1 ne ',') || 58939192d41aSJoe Perches (defined($2) && $2 ne ','))) { 58949192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 58959192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 58969192d41aSJoe Perches } 58970a920b5bSAndy Whitcroft } 58985023d347SJoe Perches 589908a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 590008a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 590108a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 590208a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 5903e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 590408a2843eSJoe Perches 590508a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 590608a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 590708a2843eSJoe Perches } 590808a2843eSJoe Perches 5909481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 59105023d347SJoe Perches 59115023d347SJoe Perches } else { 59125023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5913481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5914481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 59155023d347SJoe Perches $line =~ /^\+.*\\$/) { 59165023d347SJoe Perches WARN("LINE_CONTINUATIONS", 59175023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 59185023d347SJoe Perches } 5919653d4876SAndy Whitcroft } 59200a920b5bSAndy Whitcroft 5921b13edf7fSJoe Perches# do {} while (0) macro tests: 5922b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5923b13edf7fSJoe Perches# macro should not end with a semicolon 59245b57980dSJoe Perches if ($perl_version_ok && 5925b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5926b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5927b13edf7fSJoe Perches my $ln = $linenr; 5928b13edf7fSJoe Perches my $cnt = $realcnt; 5929b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5930b13edf7fSJoe Perches my $ctx = ''; 5931b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5932b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5933b13edf7fSJoe Perches $ctx = $dstat; 5934b13edf7fSJoe Perches 5935b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 59361b36b201SJoe Perches $dstat =~ s/$;/ /g; 5937b13edf7fSJoe Perches 5938b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5939b13edf7fSJoe Perches my $stmts = $2; 5940b13edf7fSJoe Perches my $semis = $3; 5941b13edf7fSJoe Perches 5942b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5943b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5944e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5945b13edf7fSJoe Perches 5946ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5947ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5948b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5949b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5950b13edf7fSJoe Perches } 5951b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5952b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5953b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5954b13edf7fSJoe Perches } 5955f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5956f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5957f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5958e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5959f5ef95b1SJoe Perches 5960f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5961f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5962b13edf7fSJoe Perches } 5963b13edf7fSJoe Perches } 5964b13edf7fSJoe Perches 5965f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 596613214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 596713214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5968cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 596913214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5970cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5971cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5972aad4f614SJoe Perches my @allowed = (); 5973aad4f614SJoe Perches my $allow = 0; 597413214adfSAndy Whitcroft my $seen = 0; 5975773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5976cf655043SAndy Whitcroft my $ln = $linenr - 1; 597713214adfSAndy Whitcroft for my $chunk (@chunks) { 597813214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 597913214adfSAndy Whitcroft 5980773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5981773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5982773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 5983773647a0SAndy Whitcroft 5984aad4f614SJoe Perches $allowed[$allow] = 0; 5985773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5986773647a0SAndy Whitcroft 5987773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 5988773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 5989773647a0SAndy Whitcroft 5990773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5991cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 5992cf655043SAndy Whitcroft 5993773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 599413214adfSAndy Whitcroft 599513214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 599613214adfSAndy Whitcroft 5997aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5998cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5999cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 6000aad4f614SJoe Perches $allowed[$allow] = 1; 600113214adfSAndy Whitcroft } 600213214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 6003cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 6004aad4f614SJoe Perches $allowed[$allow] = 1; 600513214adfSAndy Whitcroft } 6006cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 6007cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 6008aad4f614SJoe Perches $allowed[$allow] = 1; 600913214adfSAndy Whitcroft } 6010aad4f614SJoe Perches $allow++; 601113214adfSAndy Whitcroft } 6012aad4f614SJoe Perches if ($seen) { 6013aad4f614SJoe Perches my $sum_allowed = 0; 6014aad4f614SJoe Perches foreach (@allowed) { 6015aad4f614SJoe Perches $sum_allowed += $_; 6016aad4f614SJoe Perches } 6017aad4f614SJoe Perches if ($sum_allowed == 0) { 6018000d1cc1SJoe Perches WARN("BRACES", 6019000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 6020aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 6021aad4f614SJoe Perches $seen != $allow) { 6022aad4f614SJoe Perches CHK("BRACES", 6023aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 6024aad4f614SJoe Perches } 602513214adfSAndy Whitcroft } 602613214adfSAndy Whitcroft } 602713214adfSAndy Whitcroft } 6028773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 602913214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 6030cf655043SAndy Whitcroft my $allowed = 0; 6031f0a594c1SAndy Whitcroft 6032cf655043SAndy Whitcroft # Check the pre-context. 6033cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 6034cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 6035cf655043SAndy Whitcroft $allowed = 1; 6036f0a594c1SAndy Whitcroft } 6037773647a0SAndy Whitcroft 6038773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 6039773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 6040773647a0SAndy Whitcroft 6041cf655043SAndy Whitcroft # Check the condition. 6042cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 6043773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 6044cf655043SAndy Whitcroft if (defined $cond) { 6045773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 6046cf655043SAndy Whitcroft } 6047cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 6048cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 6049cf655043SAndy Whitcroft $allowed = 1; 6050cf655043SAndy Whitcroft } 6051cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 6052cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 6053cf655043SAndy Whitcroft $allowed = 1; 6054cf655043SAndy Whitcroft } 6055cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 6056cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 6057cf655043SAndy Whitcroft $allowed = 1; 6058cf655043SAndy Whitcroft } 6059cf655043SAndy Whitcroft # Check the post-context. 6060cf655043SAndy Whitcroft if (defined $chunks[1]) { 6061cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 6062cf655043SAndy Whitcroft if (defined $cond) { 6063773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 6064cf655043SAndy Whitcroft } 6065cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 6066cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 6067cf655043SAndy Whitcroft $allowed = 1; 6068cf655043SAndy Whitcroft } 6069cf655043SAndy Whitcroft } 6070cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 6071f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 6072e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6073cf655043SAndy Whitcroft 6074000d1cc1SJoe Perches WARN("BRACES", 6075000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 6076f0a594c1SAndy Whitcroft } 6077f0a594c1SAndy Whitcroft } 6078f0a594c1SAndy Whitcroft 6079e4c5babdSJoe Perches# check for single line unbalanced braces 608095330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 608195330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 6082e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 6083e4c5babdSJoe Perches } 6084e4c5babdSJoe Perches 60850979ae66SJoe Perches# check for unnecessary blank lines around braces 608677b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 6087f8e58219SJoe Perches if (CHK("BRACES", 6088f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 6089f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 6090f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 6091f8e58219SJoe Perches } 60920979ae66SJoe Perches } 609377b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 6094f8e58219SJoe Perches if (CHK("BRACES", 6095f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 6096f8e58219SJoe Perches $fix) { 6097f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 6098f8e58219SJoe Perches } 60990979ae66SJoe Perches } 61000979ae66SJoe Perches 61014a0df2efSAndy Whitcroft# no volatiles please 61026c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 61036c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 6104000d1cc1SJoe Perches WARN("VOLATILE", 61058c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 61064a0df2efSAndy Whitcroft } 61074a0df2efSAndy Whitcroft 61085e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 61095e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 61105e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 61115e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 611233acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 61135e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 61145e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 61155e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 61165e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 61175e4f6ba5SJoe Perches $fix && 61185e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 61195e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 61205e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 61215e4f6ba5SJoe Perches my $comma_close = ""; 61225e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 61235e4f6ba5SJoe Perches $comma_close = $1; 61245e4f6ba5SJoe Perches } 61255e4f6ba5SJoe Perches 61265e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 61275e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 61285e4f6ba5SJoe Perches my $fixedline = $prevrawline; 61295e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 61305e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 61315e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 61325e4f6ba5SJoe Perches $fixedline = $rawline; 61335e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 61345e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 61355e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 61365e4f6ba5SJoe Perches } 61375e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 61385e4f6ba5SJoe Perches } 61395e4f6ba5SJoe Perches } 61405e4f6ba5SJoe Perches 61415e4f6ba5SJoe Perches# check for missing a space in a string concatenation 61425e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 61435e4f6ba5SJoe Perches WARN('MISSING_SPACE', 61445e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 61455e4f6ba5SJoe Perches } 61465e4f6ba5SJoe Perches 614777cb8546SJoe Perches# check for an embedded function name in a string when the function is known 6148e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 6149e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 6150e4b7d309SJoe Perches# function declarations 615177cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 615277cb8546SJoe Perches defined($context_function) && 6153e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 6154e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 615577cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 6156e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 615777cb8546SJoe Perches } 615877cb8546SJoe Perches 6159adb2da82SJoe Perches# check for unnecessary function tracing like uses 6160adb2da82SJoe Perches# This does not use $logFunctions because there are many instances like 6161adb2da82SJoe Perches# 'dprintk(FOO, "%s()\n", __func__);' which do not match $logFunctions 6162adb2da82SJoe Perches if ($rawline =~ /^\+.*\([^"]*"$tracing_logging_tags{0,3}%s(?:\s*\(\s*\)\s*)?$tracing_logging_tags{0,3}(?:\\n)?"\s*,\s*__func__\s*\)\s*;/) { 6163adb2da82SJoe Perches if (WARN("TRACING_LOGGING", 6164adb2da82SJoe Perches "Unnecessary ftrace-like logging - prefer using ftrace\n" . $herecurr) && 6165adb2da82SJoe Perches $fix) { 6166adb2da82SJoe Perches fix_delete_line($fixlinenr, $rawline); 6167adb2da82SJoe Perches } 6168adb2da82SJoe Perches } 6169adb2da82SJoe Perches 61705e4f6ba5SJoe Perches# check for spaces before a quoted newline 61715e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 61725e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 61735e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 61745e4f6ba5SJoe Perches $fix) { 61755e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 61765e4f6ba5SJoe Perches } 61775e4f6ba5SJoe Perches 61785e4f6ba5SJoe Perches } 61795e4f6ba5SJoe Perches 6180f17dba4fSJoe Perches# concatenated string without spaces between elements 6181d2af5aa6SJoe Perches if ($line =~ /$String[A-Z_]/ || 6182d2af5aa6SJoe Perches ($line =~ /([A-Za-z0-9_]+)$String/ && $1 !~ /^[Lu]$/)) { 618379682c0cSJoe Perches if (CHK("CONCATENATED_STRING", 618479682c0cSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr) && 618579682c0cSJoe Perches $fix) { 618679682c0cSJoe Perches while ($line =~ /($String)/g) { 618779682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 618879682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/; 618979682c0cSJoe Perches $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/; 619079682c0cSJoe Perches } 619179682c0cSJoe Perches } 6192f17dba4fSJoe Perches } 6193f17dba4fSJoe Perches 619490ad30e5SJoe Perches# uncoalesced string fragments 6195d2af5aa6SJoe Perches if ($line =~ /$String\s*[Lu]?"/) { 619679682c0cSJoe Perches if (WARN("STRING_FRAGMENTS", 619779682c0cSJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr) && 619879682c0cSJoe Perches $fix) { 619979682c0cSJoe Perches while ($line =~ /($String)(?=\s*")/g) { 620079682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 620179682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e; 620279682c0cSJoe Perches } 620379682c0cSJoe Perches } 620490ad30e5SJoe Perches } 620590ad30e5SJoe Perches 6206522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 6207522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 6208522b837cSAlexey Dobriyan my $show_Z = 1; 62095e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 6210522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 62115e4f6ba5SJoe Perches $string =~ s/%%/__/g; 6212522b837cSAlexey Dobriyan # check for %L 6213522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 62145e4f6ba5SJoe Perches WARN("PRINTF_L", 6215522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 6216522b837cSAlexey Dobriyan $show_L = 0; 62175e4f6ba5SJoe Perches } 6218522b837cSAlexey Dobriyan # check for %Z 6219522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 6220522b837cSAlexey Dobriyan WARN("PRINTF_Z", 6221522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 6222522b837cSAlexey Dobriyan $show_Z = 0; 6223522b837cSAlexey Dobriyan } 6224522b837cSAlexey Dobriyan # check for 0x<decimal> 6225522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 6226522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 62276e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 62286e300757SJoe Perches } 62295e4f6ba5SJoe Perches } 62305e4f6ba5SJoe Perches 62315e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 62323f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 62335e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 62345e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 62355e4f6ba5SJoe Perches } 62365e4f6ba5SJoe Perches 623700df344fSAndy Whitcroft# warn about #if 0 6238c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 623960f89010SPrakruthi Deepak Heragu WARN("IF_0", 624060f89010SPrakruthi Deepak Heragu "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr); 624160f89010SPrakruthi Deepak Heragu } 624260f89010SPrakruthi Deepak Heragu 624360f89010SPrakruthi Deepak Heragu# warn about #if 1 624460f89010SPrakruthi Deepak Heragu if ($line =~ /^.\s*\#\s*if\s+1\b/) { 624560f89010SPrakruthi Deepak Heragu WARN("IF_1", 624660f89010SPrakruthi Deepak Heragu "Consider removing the #if 1 and its #endif\n" . $herecurr); 62474a0df2efSAndy Whitcroft } 62484a0df2efSAndy Whitcroft 624903df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 625003df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 6251100425deSJoe Perches my $tested = quotemeta($1); 6252100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 6253100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 6254100425deSJoe Perches my $func = $1; 6255100425deSJoe Perches if (WARN('NEEDLESS_IF', 6256100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 6257100425deSJoe Perches $fix) { 6258100425deSJoe Perches my $do_fix = 1; 6259100425deSJoe Perches my $leading_tabs = ""; 6260100425deSJoe Perches my $new_leading_tabs = ""; 6261100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 6262100425deSJoe Perches $leading_tabs = $1; 6263100425deSJoe Perches } else { 6264100425deSJoe Perches $do_fix = 0; 6265100425deSJoe Perches } 6266100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 6267100425deSJoe Perches $new_leading_tabs = $1; 6268100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 6269100425deSJoe Perches $do_fix = 0; 6270100425deSJoe Perches } 6271100425deSJoe Perches } else { 6272100425deSJoe Perches $do_fix = 0; 6273100425deSJoe Perches } 6274100425deSJoe Perches if ($do_fix) { 6275100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 6276100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 6277100425deSJoe Perches } 6278100425deSJoe Perches } 62794c432a8fSGreg Kroah-Hartman } 62804c432a8fSGreg Kroah-Hartman } 6281f0a594c1SAndy Whitcroft 6282ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 6283ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 6284ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 6285ebfdc409SJoe Perches (defined $1 || defined $3) && 6286ebfdc409SJoe Perches $linenr > 3) { 6287ebfdc409SJoe Perches my $testval = $2; 6288ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 6289ebfdc409SJoe Perches 6290ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 6291ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 6292ebfdc409SJoe Perches 6293e29a70f1SJoe Perches if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ && 6294e29a70f1SJoe Perches $s !~ /\b__GFP_NOWARN\b/ ) { 6295ebfdc409SJoe Perches WARN("OOM_MESSAGE", 6296ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 6297ebfdc409SJoe Perches } 6298ebfdc409SJoe Perches } 6299ebfdc409SJoe Perches 6300f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 6301dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 6302f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 6303f78d98f6SJoe Perches my $level = $1; 6304f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 6305f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 6306f78d98f6SJoe Perches $fix) { 6307f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 6308f78d98f6SJoe Perches } 6309f78d98f6SJoe Perches } 6310f78d98f6SJoe Perches 631145c55e92SJoe Perches# check for logging continuations 631245c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 631345c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 631445c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 631545c55e92SJoe Perches } 631645c55e92SJoe Perches 631770eb2275SDwaipayan Ray# check for unnecessary use of %h[xudi] and %hh[xudi] in logging functions 631870eb2275SDwaipayan Ray if (defined $stat && 631970eb2275SDwaipayan Ray $line =~ /\b$logFunctions\s*\(/ && 632070eb2275SDwaipayan Ray index($stat, '"') >= 0) { 632170eb2275SDwaipayan Ray my $lc = $stat =~ tr@\n@@; 632270eb2275SDwaipayan Ray $lc = $lc + $linenr; 632370eb2275SDwaipayan Ray my $stat_real = get_stat_real($linenr, $lc); 632470eb2275SDwaipayan Ray pos($stat_real) = index($stat_real, '"'); 632570eb2275SDwaipayan Ray while ($stat_real =~ /[^\"%]*(%[\#\d\.\*\-]*(h+)[idux])/g) { 632670eb2275SDwaipayan Ray my $pspec = $1; 632770eb2275SDwaipayan Ray my $h = $2; 632870eb2275SDwaipayan Ray my $lineoff = substr($stat_real, 0, $-[1]) =~ tr@\n@@; 632970eb2275SDwaipayan Ray if (WARN("UNNECESSARY_MODIFIER", 633070eb2275SDwaipayan Ray "Integer promotion: Using '$h' in '$pspec' is unnecessary\n" . "$here\n$stat_real\n") && 633170eb2275SDwaipayan Ray $fix && $fixed[$fixlinenr + $lineoff] =~ /^\+/) { 633270eb2275SDwaipayan Ray my $nspec = $pspec; 633370eb2275SDwaipayan Ray $nspec =~ s/h//g; 633470eb2275SDwaipayan Ray $fixed[$fixlinenr + $lineoff] =~ s/\Q$pspec\E/$nspec/; 633570eb2275SDwaipayan Ray } 633670eb2275SDwaipayan Ray } 633770eb2275SDwaipayan Ray } 633870eb2275SDwaipayan Ray 6339abb08a53SJoe Perches# check for mask then right shift without a parentheses 63405b57980dSJoe Perches if ($perl_version_ok && 6341abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 6342abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 6343abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 6344abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 6345abb08a53SJoe Perches } 6346abb08a53SJoe Perches 6347b75ac618SJoe Perches# check for pointer comparisons to NULL 63485b57980dSJoe Perches if ($perl_version_ok) { 6349b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 6350b75ac618SJoe Perches my $val = $1; 6351b75ac618SJoe Perches my $equal = "!"; 6352b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 6353b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 6354b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 6355b75ac618SJoe Perches $fix) { 6356b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 6357b75ac618SJoe Perches } 6358b75ac618SJoe Perches } 6359b75ac618SJoe Perches } 6360b75ac618SJoe Perches 63618716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 63628716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 63638716de38SJoe Perches my $attr = $1; 63648716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 63658716de38SJoe Perches my $ptr = $1; 63668716de38SJoe Perches my $var = $2; 63678716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 63688716de38SJoe Perches ERROR("MISPLACED_INIT", 63698716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 63708716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 63718716de38SJoe Perches WARN("MISPLACED_INIT", 63728716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 63738716de38SJoe Perches $fix) { 6374194f66fcSJoe 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; 63758716de38SJoe Perches } 63768716de38SJoe Perches } 63778716de38SJoe Perches } 63788716de38SJoe Perches 6379e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 6380e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 6381e970b884SJoe Perches my $attr = $1; 6382e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 6383e970b884SJoe Perches my $attr_prefix = $1; 6384e970b884SJoe Perches my $attr_type = $2; 6385e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 6386e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 6387e970b884SJoe Perches $fix) { 6388194f66fcSJoe Perches $fixed[$fixlinenr] =~ 6389e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 6390e970b884SJoe Perches } 6391e970b884SJoe Perches } 6392e970b884SJoe Perches 6393e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 6394e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 6395e970b884SJoe Perches my $attr = $1; 6396e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 6397e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 6398e970b884SJoe Perches $fix) { 6399194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 6400e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 6401e970b884SJoe Perches $lead = rtrim($1); 6402e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 6403e970b884SJoe Perches $lead = "${lead}const "; 6404194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 6405e970b884SJoe Perches } 6406e970b884SJoe Perches } 6407e970b884SJoe Perches 6408c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 6409c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 6410c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 6411c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 6412c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 6413c17893c7SJoe Perches $fix) { 6414c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 6415c17893c7SJoe Perches } 6416c17893c7SJoe Perches } 6417c17893c7SJoe Perches 6418fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 6419fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 6420fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 6421fbdb8138SJoe Perches my $constant_func = $1; 6422fbdb8138SJoe Perches my $func = $constant_func; 6423fbdb8138SJoe Perches $func =~ s/^__constant_//; 6424fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 6425fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 6426fbdb8138SJoe Perches $fix) { 6427194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 6428fbdb8138SJoe Perches } 6429fbdb8138SJoe Perches } 6430fbdb8138SJoe Perches 64311a15a250SPatrick Pannuto# prefer usleep_range over udelay 643237581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 643343c1d77cSJoe Perches my $delay = $1; 64341a15a250SPatrick Pannuto # ignore udelay's < 10, however 643543c1d77cSJoe Perches if (! ($delay < 10) ) { 6436000d1cc1SJoe Perches CHK("USLEEP_RANGE", 6437458f69efSMauro Carvalho Chehab "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr); 643843c1d77cSJoe Perches } 643943c1d77cSJoe Perches if ($delay > 2000) { 644043c1d77cSJoe Perches WARN("LONG_UDELAY", 644143c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 64421a15a250SPatrick Pannuto } 64431a15a250SPatrick Pannuto } 64441a15a250SPatrick Pannuto 644509ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 644609ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 644709ef8725SPatrick Pannuto if ($1 < 20) { 6448000d1cc1SJoe Perches WARN("MSLEEP", 6449458f69efSMauro Carvalho Chehab "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr); 645009ef8725SPatrick Pannuto } 645109ef8725SPatrick Pannuto } 645209ef8725SPatrick Pannuto 645336ec1939SJoe Perches# check for comparisons of jiffies 645436ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 645536ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 645636ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 645736ec1939SJoe Perches } 645836ec1939SJoe Perches 64599d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 64609d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 64619d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 64629d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 64639d7a34a5SJoe Perches } 64649d7a34a5SJoe Perches 646500df344fSAndy Whitcroft# warn about #ifdefs in C files 6466c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 646700df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 646800df344fSAndy Whitcroft# print "$herecurr"; 646900df344fSAndy Whitcroft# $clean = 0; 647000df344fSAndy Whitcroft# } 647100df344fSAndy Whitcroft 647222f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 6473c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 64743705ce5bSJoe Perches if (ERROR("SPACING", 64753705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 64763705ce5bSJoe Perches $fix) { 6477194f66fcSJoe Perches $fixed[$fixlinenr] =~ 64783705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 64793705ce5bSJoe Perches } 64803705ce5bSJoe Perches 648122f2a2efSAndy Whitcroft } 648222f2a2efSAndy Whitcroft 64834a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 6484171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 6485171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 64864a0df2efSAndy Whitcroft my $which = $1; 64874a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 6488000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 6489000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 64904a0df2efSAndy Whitcroft } 64914a0df2efSAndy Whitcroft } 64924a0df2efSAndy Whitcroft# check for memory barriers without a comment. 6493402c2553SMichael S. Tsirkin 6494402c2553SMichael S. Tsirkin my $barriers = qr{ 6495402c2553SMichael S. Tsirkin mb| 6496402c2553SMichael S. Tsirkin rmb| 6497ad83ec6cSWill Deacon wmb 6498402c2553SMichael S. Tsirkin }x; 6499402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 6500402c2553SMichael S. Tsirkin mb__before_atomic| 6501402c2553SMichael S. Tsirkin mb__after_atomic| 6502402c2553SMichael S. Tsirkin store_release| 6503402c2553SMichael S. Tsirkin load_acquire| 6504402c2553SMichael S. Tsirkin store_mb| 6505402c2553SMichael S. Tsirkin (?:$barriers) 6506402c2553SMichael S. Tsirkin }x; 6507402c2553SMichael S. Tsirkin my $all_barriers = qr{ 6508402c2553SMichael S. Tsirkin (?:$barriers)| 650943e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 651043e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 6511402c2553SMichael S. Tsirkin }x; 6512402c2553SMichael S. Tsirkin 6513402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 65144a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 6515c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 6516000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 65174a0df2efSAndy Whitcroft } 65184a0df2efSAndy Whitcroft } 65193ad81779SPaul E. McKenney 6520f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 6521f4073b0fSMichael S. Tsirkin 6522f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 6523f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 6524f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 6525f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 6526f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 6527f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 6528f4073b0fSMichael S. Tsirkin } 6529f4073b0fSMichael S. Tsirkin 6530cb426e99SJoe Perches# check for waitqueue_active without a comment. 6531cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 6532cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 6533cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 6534cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 6535cb426e99SJoe Perches } 6536cb426e99SJoe Perches } 65373ad81779SPaul E. McKenney 65385099a722SMarco Elver# check for data_race without a comment. 65395099a722SMarco Elver if ($line =~ /\bdata_race\s*\(/) { 65405099a722SMarco Elver if (!ctx_has_comment($first_line, $linenr)) { 65415099a722SMarco Elver WARN("DATA_RACE", 65425099a722SMarco Elver "data_race without comment\n" . $herecurr); 65435099a722SMarco Elver } 65445099a722SMarco Elver } 65455099a722SMarco Elver 65464a0df2efSAndy Whitcroft# check of hardware specific defines 6547c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 6548000d1cc1SJoe Perches CHK("ARCH_DEFINES", 6549000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 65500a920b5bSAndy Whitcroft } 6551653d4876SAndy Whitcroft 6552596ed45bSJoe Perches# check that the storage class is not after a type 6553596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 6554000d1cc1SJoe Perches WARN("STORAGE_CLASS", 6555596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 6556596ed45bSJoe Perches } 6557596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 6558596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 6559596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 6560596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 6561596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 6562596ed45bSJoe Perches WARN("STORAGE_CLASS", 6563596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 6564d4977c78STobias Klauser } 6565d4977c78STobias Klauser 6566de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 6567de7d4f0eSAndy Whitcroft# storage class and type. 65689c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 65699c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 6570000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 6571000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 6572de7d4f0eSAndy Whitcroft } 6573de7d4f0eSAndy Whitcroft 65748905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 65752b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 65762b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 6577d5e616fcSJoe Perches if (WARN("INLINE", 6578d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 6579d5e616fcSJoe Perches $fix) { 6580194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 6581d5e616fcSJoe Perches 6582d5e616fcSJoe Perches } 65838905a67cSAndy Whitcroft } 65848905a67cSAndy Whitcroft 65857ebe1d17SDwaipayan Ray# Check for compiler attributes 65862b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 65877ebe1d17SDwaipayan Ray $rawline =~ /\b__attribute__\s*\(\s*($balanced_parens)\s*\)/) { 65887ebe1d17SDwaipayan Ray my $attr = $1; 65897ebe1d17SDwaipayan Ray $attr =~ s/\s*\(\s*(.*)\)\s*/$1/; 65907ebe1d17SDwaipayan Ray 65917ebe1d17SDwaipayan Ray my %attr_list = ( 65920830aab0SJoe Perches "alias" => "__alias", 65937ebe1d17SDwaipayan Ray "aligned" => "__aligned", 65947ebe1d17SDwaipayan Ray "always_inline" => "__always_inline", 65957ebe1d17SDwaipayan Ray "assume_aligned" => "__assume_aligned", 65967ebe1d17SDwaipayan Ray "cold" => "__cold", 65977ebe1d17SDwaipayan Ray "const" => "__attribute_const__", 65987ebe1d17SDwaipayan Ray "copy" => "__copy", 65997ebe1d17SDwaipayan Ray "designated_init" => "__designated_init", 66007ebe1d17SDwaipayan Ray "externally_visible" => "__visible", 66017ebe1d17SDwaipayan Ray "format" => "printf|scanf", 66027ebe1d17SDwaipayan Ray "gnu_inline" => "__gnu_inline", 66037ebe1d17SDwaipayan Ray "malloc" => "__malloc", 66047ebe1d17SDwaipayan Ray "mode" => "__mode", 66057ebe1d17SDwaipayan Ray "no_caller_saved_registers" => "__no_caller_saved_registers", 66067ebe1d17SDwaipayan Ray "noclone" => "__noclone", 66077ebe1d17SDwaipayan Ray "noinline" => "noinline", 66087ebe1d17SDwaipayan Ray "nonstring" => "__nonstring", 66097ebe1d17SDwaipayan Ray "noreturn" => "__noreturn", 66107ebe1d17SDwaipayan Ray "packed" => "__packed", 66117ebe1d17SDwaipayan Ray "pure" => "__pure", 6612339f29d9SJoe Perches "section" => "__section", 66130830aab0SJoe Perches "used" => "__used", 66140830aab0SJoe Perches "weak" => "__weak" 66157ebe1d17SDwaipayan Ray ); 66167ebe1d17SDwaipayan Ray 66177ebe1d17SDwaipayan Ray while ($attr =~ /\s*(\w+)\s*(${balanced_parens})?/g) { 6618339f29d9SJoe Perches my $orig_attr = $1; 66197ebe1d17SDwaipayan Ray my $params = ''; 66207ebe1d17SDwaipayan Ray $params = $2 if defined($2); 6621339f29d9SJoe Perches my $curr_attr = $orig_attr; 66227ebe1d17SDwaipayan Ray $curr_attr =~ s/^[\s_]+|[\s_]+$//g; 66237ebe1d17SDwaipayan Ray if (exists($attr_list{$curr_attr})) { 6624339f29d9SJoe Perches my $new = $attr_list{$curr_attr}; 66257ebe1d17SDwaipayan Ray if ($curr_attr eq "format" && $params) { 66267ebe1d17SDwaipayan Ray $params =~ /^\s*\(\s*(\w+)\s*,\s*(.*)/; 6627339f29d9SJoe Perches $new = "__$1\($2"; 66287ebe1d17SDwaipayan Ray } else { 6629339f29d9SJoe Perches $new = "$new$params"; 66307ebe1d17SDwaipayan Ray } 66317ebe1d17SDwaipayan Ray if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", 6632339f29d9SJoe Perches "Prefer $new over __attribute__(($orig_attr$params))\n" . $herecurr) && 66337ebe1d17SDwaipayan Ray $fix) { 6634339f29d9SJoe Perches my $remove = "\Q$orig_attr\E" . '\s*' . "\Q$params\E" . '(?:\s*,\s*)?'; 6635339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/$remove//; 6636339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__/$new __attribute__/; 6637339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/\}\Q$new\E/} $new/; 6638339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/ __attribute__\s*\(\s*\(\s*\)\s*\)//; 66397ebe1d17SDwaipayan Ray } 664039b7e287SJoe Perches } 6641462811d9SJoe Perches } 6642462811d9SJoe Perches 66437ebe1d17SDwaipayan Ray # Check for __attribute__ unused, prefer __always_unused or __maybe_unused 66447ebe1d17SDwaipayan Ray if ($attr =~ /^_*unused/) { 66457ebe1d17SDwaipayan Ray WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", 66467ebe1d17SDwaipayan Ray "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr); 6647d5e616fcSJoe Perches } 66486061d949SJoe Perches } 66496061d949SJoe Perches 6650619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 66515b57980dSJoe Perches if ($perl_version_ok && 6652619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 6653619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 6654619a908aSJoe Perches $line =~ /\b__weak\b/)) { 6655619a908aSJoe Perches ERROR("WEAK_DECLARATION", 6656619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 6657619a908aSJoe Perches } 6658619a908aSJoe Perches 6659fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 6660e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 6661fd39f904STomas Winkler $realfile !~ m@\btools/@ && 6662e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 6663e6176fa4SJoe Perches my $type = $1; 6664e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 6665e6176fa4SJoe Perches $type = $1; 6666e6176fa4SJoe Perches my $kernel_type = 'u'; 6667e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 6668e6176fa4SJoe Perches $type =~ /(\d+)/; 6669e6176fa4SJoe Perches $kernel_type .= $1; 6670e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 6671e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 6672e6176fa4SJoe Perches $fix) { 6673e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 6674e6176fa4SJoe Perches } 6675e6176fa4SJoe Perches } 6676e6176fa4SJoe Perches } 6677e6176fa4SJoe Perches 6678938224b5SJoe Perches# check for cast of C90 native int or longer types constants 6679938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 6680938224b5SJoe Perches my $cast = $1; 6681938224b5SJoe Perches my $const = $2; 6682938224b5SJoe Perches my $suffix = ""; 6683938224b5SJoe Perches my $newconst = $const; 6684938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 6685938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 6686938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 6687938224b5SJoe Perches $suffix .= 'LL'; 6688938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 6689938224b5SJoe Perches $suffix .= 'L'; 6690938224b5SJoe Perches } 66910972b8bfSJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 66920972b8bfSJoe Perches "Unnecessary typecast of c90 int constant - '$cast$const' could be '$const$suffix'\n" . $herecurr) && 66930972b8bfSJoe Perches $fix) { 6694938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 6695938224b5SJoe Perches } 6696938224b5SJoe Perches } 6697938224b5SJoe Perches 66988f53a9b8SJoe Perches# check for sizeof(&) 66998f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 6700000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 6701000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 67028f53a9b8SJoe Perches } 67038f53a9b8SJoe Perches 670466c80b60SJoe Perches# check for sizeof without parenthesis 670566c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 6706d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 6707d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 6708d5e616fcSJoe Perches $fix) { 6709194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 6710d5e616fcSJoe Perches } 671166c80b60SJoe Perches } 671266c80b60SJoe Perches 671388982feaSJoe Perches# check for struct spinlock declarations 671488982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 671588982feaSJoe Perches WARN("USE_SPINLOCK_T", 671688982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 671788982feaSJoe Perches } 671888982feaSJoe Perches 6719a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 672006668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 6721a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 6722caac1d5fSHeba Aamer $fmt =~ s/%%//g; 6723caac1d5fSHeba Aamer if ($fmt !~ /%/) { 6724d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 6725d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 6726d5e616fcSJoe Perches $fix) { 6727194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 6728d5e616fcSJoe Perches } 6729a6962d72SJoe Perches } 6730a6962d72SJoe Perches } 6731a6962d72SJoe Perches 67320b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 67335b57980dSJoe Perches if ($perl_version_ok && 67340b523769SJoe Perches defined $stat && 67350b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 67360b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 6737e3c6bc95STobin C. Harding my $stat_real; 6738e3c6bc95STobin C. Harding 67390b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 67400b523769SJoe Perches $lc = $lc + $linenr; 67410b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 6742ffe07513SJoe Perches my $specifier; 6743ffe07513SJoe Perches my $extension; 67443bd32d6aSSakari Ailus my $qualifier; 6745ffe07513SJoe Perches my $bad_specifier = ""; 67460b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 67470b523769SJoe Perches $fmt =~ s/%%//g; 6748e3c6bc95STobin C. Harding 67493bd32d6aSSakari Ailus while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) { 6750e3c6bc95STobin C. Harding $specifier = $1; 6751e3c6bc95STobin C. Harding $extension = $2; 67523bd32d6aSSakari Ailus $qualifier = $3; 6753af612e43SSakari Ailus if ($extension !~ /[4SsBKRraEehMmIiUDdgVCbGNOxtf]/ || 67543bd32d6aSSakari Ailus ($extension eq "f" && 6755af612e43SSakari Ailus defined $qualifier && $qualifier !~ /^w/) || 6756af612e43SSakari Ailus ($extension eq "4" && 6757af612e43SSakari Ailus defined $qualifier && $qualifier !~ /^cc/)) { 6758e3c6bc95STobin C. Harding $bad_specifier = $specifier; 67590b523769SJoe Perches last; 67600b523769SJoe Perches } 6761e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 6762e3c6bc95STobin C. Harding if (!defined($stat_real)) { 6763e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 67640b523769SJoe Perches } 6765e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 6766e3c6bc95STobin 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"); 6767e3c6bc95STobin C. Harding } 6768e3c6bc95STobin C. Harding } 6769e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 67702a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 67711df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 67721df7338aSSergey Senozhatsky my $use = ""; 6773e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 67741df7338aSSergey Senozhatsky $use = " - use %pS instead"; 6775e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 67761df7338aSSergey Senozhatsky } 67772a9f9d85STobin C. Harding 67780b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 6779e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 6780e3c6bc95STobin C. Harding } 67810b523769SJoe Perches } 67820b523769SJoe Perches } 67830b523769SJoe Perches 6784554e165cSAndy Whitcroft# Check for misused memsets 67855b57980dSJoe Perches if ($perl_version_ok && 6786d1fe9c09SJoe Perches defined $stat && 67879e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 6788554e165cSAndy Whitcroft 6789d7c76ba7SJoe Perches my $ms_addr = $2; 6790d1fe9c09SJoe Perches my $ms_val = $7; 6791d1fe9c09SJoe Perches my $ms_size = $12; 6792d7c76ba7SJoe Perches 6793554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 6794554e165cSAndy Whitcroft ERROR("MEMSET", 6795d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 6796554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 6797554e165cSAndy Whitcroft WARN("MEMSET", 6798d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 6799d7c76ba7SJoe Perches } 6800d7c76ba7SJoe Perches } 6801d7c76ba7SJoe Perches 680298a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 68035b57980dSJoe Perches# if ($perl_version_ok && 6804f333195dSJoe Perches# defined $stat && 6805f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6806f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 6807f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 6808f333195dSJoe Perches# $fix) { 6809f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 6810f333195dSJoe Perches# } 6811f333195dSJoe Perches# } 681298a9bba5SJoe Perches 6813b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 68145b57980dSJoe Perches# if ($perl_version_ok && 6815f333195dSJoe Perches# defined $stat && 6816f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6817f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 6818f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 6819f333195dSJoe Perches# } 6820b6117d17SMateusz Kulikowski 68218617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 68228617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 68235b57980dSJoe Perches# if ($perl_version_ok && 6824f333195dSJoe Perches# defined $stat && 6825f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6826f333195dSJoe Perches# 6827f333195dSJoe Perches# my $ms_val = $7; 6828f333195dSJoe Perches# 6829f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 6830f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 6831f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 6832f333195dSJoe Perches# $fix) { 6833f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 6834f333195dSJoe Perches# } 6835f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 6836f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 6837f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 6838f333195dSJoe Perches# $fix) { 6839f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 6840f333195dSJoe Perches# } 6841f333195dSJoe Perches# } 6842f333195dSJoe Perches# } 68438617cd09SMateusz Kulikowski 68445dbdb2d8SJoe Perches# strlcpy uses that should likely be strscpy 68455dbdb2d8SJoe Perches if ($line =~ /\bstrlcpy\s*\(/) { 68465dbdb2d8SJoe Perches WARN("STRLCPY", 68475dbdb2d8SJoe Perches "Prefer strscpy over strlcpy - see: https://lore.kernel.org/r/CAHk-=wgfRnXz0W3D37d01q3JFkr_i_uTL=V6A6G1oUZcprmknw\@mail.gmail.com/\n" . $herecurr); 68485dbdb2d8SJoe Perches } 68495dbdb2d8SJoe Perches 6850d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 68515b57980dSJoe Perches if ($perl_version_ok && 6852d1fe9c09SJoe Perches defined $stat && 6853d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 6854d1fe9c09SJoe Perches if (defined $2 || defined $7) { 6855d7c76ba7SJoe Perches my $call = $1; 6856d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 6857d7c76ba7SJoe Perches my $arg1 = $3; 6858d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 6859d1fe9c09SJoe Perches my $arg2 = $8; 6860d7c76ba7SJoe Perches my $cast; 6861d7c76ba7SJoe Perches 6862d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 6863d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 6864d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 6865d7c76ba7SJoe Perches $cast = $cast1; 6866d7c76ba7SJoe Perches } else { 6867d7c76ba7SJoe Perches $cast = $cast2; 6868d7c76ba7SJoe Perches } 6869d7c76ba7SJoe Perches WARN("MINMAX", 6870d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 6871554e165cSAndy Whitcroft } 6872554e165cSAndy Whitcroft } 6873554e165cSAndy Whitcroft 68744a273195SJoe Perches# check usleep_range arguments 68755b57980dSJoe Perches if ($perl_version_ok && 68764a273195SJoe Perches defined $stat && 68774a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 68784a273195SJoe Perches my $min = $1; 68794a273195SJoe Perches my $max = $7; 68804a273195SJoe Perches if ($min eq $max) { 68814a273195SJoe Perches WARN("USLEEP_RANGE", 6882458f69efSMauro Carvalho Chehab "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 68834a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 68844a273195SJoe Perches $min > $max) { 68854a273195SJoe Perches WARN("USLEEP_RANGE", 6886458f69efSMauro Carvalho Chehab "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 68874a273195SJoe Perches } 68884a273195SJoe Perches } 68894a273195SJoe Perches 6890823b794cSJoe Perches# check for naked sscanf 68915b57980dSJoe Perches if ($perl_version_ok && 6892823b794cSJoe Perches defined $stat && 68936c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 6894823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 6895823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 6896823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 6897823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 6898823b794cSJoe Perches $lc = $lc + $linenr; 68992a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6900823b794cSJoe Perches WARN("NAKED_SSCANF", 6901823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 6902823b794cSJoe Perches } 6903823b794cSJoe Perches 6904afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 69055b57980dSJoe Perches if ($perl_version_ok && 6906afc819abSJoe Perches defined $stat && 6907afc819abSJoe Perches $line =~ /\bsscanf\b/) { 6908afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 6909afc819abSJoe Perches $lc = $lc + $linenr; 69102a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6911afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 6912afc819abSJoe Perches my $format = $6; 6913afc819abSJoe Perches my $count = $format =~ tr@%@%@; 6914afc819abSJoe Perches if ($count == 1 && 6915afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 6916afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 6917afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 6918afc819abSJoe Perches } 6919afc819abSJoe Perches } 6920afc819abSJoe Perches } 6921afc819abSJoe Perches 692270dc8a48SJoe Perches# check for new externs in .h files. 692370dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 692470dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 6925d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 692670dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 692770dc8a48SJoe Perches $fix) { 6928194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 692970dc8a48SJoe Perches } 693070dc8a48SJoe Perches } 693170dc8a48SJoe Perches 6932de7d4f0eSAndy Whitcroft# check for new externs in .c files. 6933171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 6934c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 6935171ae1a4SAndy Whitcroft { 6936c45dcabdSAndy Whitcroft my $function_name = $1; 6937c45dcabdSAndy Whitcroft my $paren_space = $2; 6938171ae1a4SAndy Whitcroft 6939171ae1a4SAndy Whitcroft my $s = $stat; 6940171ae1a4SAndy Whitcroft if (defined $cond) { 6941171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 6942171ae1a4SAndy Whitcroft } 6943d8b44b58SKees Cook if ($s =~ /^\s*;/) 6944c45dcabdSAndy Whitcroft { 6945000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6946000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6947de7d4f0eSAndy Whitcroft } 6948de7d4f0eSAndy Whitcroft 6949171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 6950000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 6951000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 6952171ae1a4SAndy Whitcroft } 69539c9ba34eSAndy Whitcroft 69549c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 69559c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 69569c9ba34eSAndy Whitcroft { 6957000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6958000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6959171ae1a4SAndy Whitcroft } 6960171ae1a4SAndy Whitcroft 6961a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 6962a0ad7596SJoe Perches if (defined $stat && 6963d8b44b58SKees Cook $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 6964d8b44b58SKees Cook $1 ne "void") { 6965d8b44b58SKees Cook my $args = trim($1); 6966ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6967ca0d8929SJoe Perches my $arg = trim($1); 6968d8b44b58SKees Cook if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 6969ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 6970ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6971ca0d8929SJoe Perches } 6972ca0d8929SJoe Perches } 6973ca0d8929SJoe Perches } 6974ca0d8929SJoe Perches 6975a0ad7596SJoe Perches# check for function definitions 69765b57980dSJoe Perches if ($perl_version_ok && 6977a0ad7596SJoe Perches defined $stat && 6978a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6979a0ad7596SJoe Perches $context_function = $1; 6980a0ad7596SJoe Perches 6981a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 6982a0ad7596SJoe Perches my $ok = 0; 6983a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 6984a0ad7596SJoe Perches my $herectx = $here . "\n"; 6985a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6986a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 6987a0ad7596SJoe Perches $herectx .= $rl . "\n"; 6988a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 6989a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 6990a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 6991a0ad7596SJoe Perches } 6992a0ad7596SJoe Perches if (!$ok) { 6993a0ad7596SJoe Perches ERROR("OPEN_BRACE", 6994a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 6995a0ad7596SJoe Perches } 6996a0ad7596SJoe Perches } 6997a0ad7596SJoe Perches 6998de7d4f0eSAndy Whitcroft# checks for new __setup's 6999de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 7000de7d4f0eSAndy Whitcroft my $name = $1; 7001de7d4f0eSAndy Whitcroft 7002de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 7003000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 70042581ac7cSTim Froidcoeur "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr); 7005de7d4f0eSAndy Whitcroft } 7006653d4876SAndy Whitcroft } 70079c0ca6f9SAndy Whitcroft 7008e29a70f1SJoe Perches# check for pointless casting of alloc functions 7009e29a70f1SJoe Perches if ($line =~ /\*\s*\)\s*$allocFunctions\b/) { 7010000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 7011000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 70129c0ca6f9SAndy Whitcroft } 701313214adfSAndy Whitcroft 7014a640d25cSJoe Perches# alloc style 7015a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 70165b57980dSJoe Perches if ($perl_version_ok && 7017e29a70f1SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 7018a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 7019a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 7020a640d25cSJoe Perches } 7021a640d25cSJoe Perches 702260a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 70235b57980dSJoe Perches if ($perl_version_ok && 70241b4a2ed4SJoe Perches defined $stat && 70251b4a2ed4SJoe Perches $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 702660a55369SJoe Perches my $oldfunc = $3; 702760a55369SJoe Perches my $a1 = $4; 702860a55369SJoe Perches my $a2 = $10; 702960a55369SJoe Perches my $newfunc = "kmalloc_array"; 703060a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 703160a55369SJoe Perches my $r1 = $a1; 703260a55369SJoe Perches my $r2 = $a2; 703360a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 703460a55369SJoe Perches $r1 = $a2; 703560a55369SJoe Perches $r2 = $a1; 703660a55369SJoe Perches } 7037e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 7038e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 70391b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 7040e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 7041e3d95a2aSTobin C. Harding 7042e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 70431b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 70441b4a2ed4SJoe Perches $cnt == 1 && 7045e367455aSJoe Perches $fix) { 7046194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e; 704760a55369SJoe Perches } 704860a55369SJoe Perches } 704960a55369SJoe Perches } 705060a55369SJoe Perches 7051972fdea2SJoe Perches# check for krealloc arg reuse 70525b57980dSJoe Perches if ($perl_version_ok && 70534cab63ceSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ && 70544cab63ceSJoe Perches $1 eq $3) { 7055972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 7056972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 7057972fdea2SJoe Perches } 7058972fdea2SJoe Perches 70595ce59ae0SJoe Perches# check for alloc argument mismatch 70607e6cdd7fSChristophe JAILLET if ($line =~ /\b((?:devm_)?(?:kcalloc|kmalloc_array))\s*\(\s*sizeof\b/) { 70615ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 70625ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 70635ce59ae0SJoe Perches } 70645ce59ae0SJoe Perches 7065caf2a54fSJoe Perches# check for multiple semicolons 7066caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 7067d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 7068d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 7069d5e616fcSJoe Perches $fix) { 7070194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 7071d5e616fcSJoe Perches } 7072d1e2ad07SJoe Perches } 7073d1e2ad07SJoe Perches 7074cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 7075cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 7076cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 70770ab90191SJoe Perches my $ull = ""; 70780ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 70790ab90191SJoe Perches if (CHK("BIT_MACRO", 70800ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 70810ab90191SJoe Perches $fix) { 70820ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 70830ab90191SJoe Perches } 70840ab90191SJoe Perches } 70850ab90191SJoe Perches 708650161266SJoe Perches# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too) 70873e89ad85SJerome Forissier if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) { 708850161266SJoe Perches WARN("IS_ENABLED_CONFIG", 70893e89ad85SJerome Forissier "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr); 709050161266SJoe Perches } 709150161266SJoe Perches 70922d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 70933e89ad85SJerome 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*$/) { 70942d632745SJoe Perches my $config = $1; 70952d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 70963e89ad85SJerome Forissier "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) && 70972d632745SJoe Perches $fix) { 70982d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 70992d632745SJoe Perches } 71002d632745SJoe Perches } 71012d632745SJoe Perches 7102f36d3eb8SJoe Perches# check for /* fallthrough */ like comment, prefer fallthrough; 7103f36d3eb8SJoe Perches my @fallthroughs = ( 7104f36d3eb8SJoe Perches 'fallthrough', 7105f36d3eb8SJoe Perches '@fallthrough@', 7106f36d3eb8SJoe Perches 'lint -fallthrough[ \t]*', 7107f36d3eb8SJoe Perches 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)', 7108f36d3eb8SJoe Perches '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?', 7109f36d3eb8SJoe Perches 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 7110f36d3eb8SJoe Perches 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 7111f36d3eb8SJoe Perches ); 7112f36d3eb8SJoe Perches if ($raw_comment ne '') { 7113f36d3eb8SJoe Perches foreach my $ft (@fallthroughs) { 7114f36d3eb8SJoe Perches if ($raw_comment =~ /$ft/) { 7115f36d3eb8SJoe Perches my $msg_level = \&WARN; 7116f36d3eb8SJoe Perches $msg_level = \&CHK if ($file); 7117f36d3eb8SJoe Perches &{$msg_level}("PREFER_FALLTHROUGH", 7118f36d3eb8SJoe Perches "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr); 7119f36d3eb8SJoe Perches last; 7120f36d3eb8SJoe Perches } 7121f36d3eb8SJoe Perches } 7122f36d3eb8SJoe Perches } 7123f36d3eb8SJoe Perches 7124d1e2ad07SJoe Perches# check for switch/default statements without a break; 71255b57980dSJoe Perches if ($perl_version_ok && 7126d1e2ad07SJoe Perches defined $stat && 7127d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 7128d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 7129e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 7130e3d95a2aSTobin C. Harding 7131d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 7132d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 7133caf2a54fSJoe Perches } 7134caf2a54fSJoe Perches 713513214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 7136d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 7137d5e616fcSJoe Perches if (WARN("USE_FUNC", 7138d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 7139d5e616fcSJoe Perches $fix) { 7140194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 7141d5e616fcSJoe Perches } 714213214adfSAndy Whitcroft } 7143773647a0SAndy Whitcroft 714462ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 714562ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 714662ec818fSJoe Perches ERROR("DATE_TIME", 714762ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 714862ec818fSJoe Perches } 714962ec818fSJoe Perches 71502c92488aSJoe Perches# check for use of yield() 71512c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 71522c92488aSJoe Perches WARN("YIELD", 71532c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 71542c92488aSJoe Perches } 71552c92488aSJoe Perches 7156179f8f40SJoe Perches# check for comparisons against true and false 7157179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 7158179f8f40SJoe Perches my $lead = $1; 7159179f8f40SJoe Perches my $arg = $2; 7160179f8f40SJoe Perches my $test = $3; 7161179f8f40SJoe Perches my $otype = $4; 7162179f8f40SJoe Perches my $trail = $5; 7163179f8f40SJoe Perches my $op = "!"; 7164179f8f40SJoe Perches 7165179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 7166179f8f40SJoe Perches 7167179f8f40SJoe Perches my $type = lc($otype); 7168179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 7169179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 7170179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 7171179f8f40SJoe Perches $op = ""; 7172179f8f40SJoe Perches } 7173179f8f40SJoe Perches 7174179f8f40SJoe Perches CHK("BOOL_COMPARISON", 7175179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 7176179f8f40SJoe Perches 7177179f8f40SJoe Perches## maybe suggesting a correct construct would better 7178179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 7179179f8f40SJoe Perches 7180179f8f40SJoe Perches } 7181179f8f40SJoe Perches } 7182179f8f40SJoe Perches 71834882720bSThomas Gleixner# check for semaphores initialized locked 71844882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 7185000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 7186000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 7187773647a0SAndy Whitcroft } 71886712d858SJoe Perches 718967d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 719067d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 7191000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 719267d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 7193773647a0SAndy Whitcroft } 71946712d858SJoe Perches 7195ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 7196f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 7197000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 7198ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 7199f3db6639SMichael Ellerman } 72006712d858SJoe Perches 72013d709ab5SPaul E. McKenney# check for spin_is_locked(), suggest lockdep instead 72023d709ab5SPaul E. McKenney if ($line =~ /\bspin_is_locked\(/) { 72033d709ab5SPaul E. McKenney WARN("USE_LOCKDEP", 72043d709ab5SPaul E. McKenney "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr); 72053d709ab5SPaul E. McKenney } 72063d709ab5SPaul E. McKenney 72079189c7e7SJoe Perches# check for deprecated apis 72089189c7e7SJoe Perches if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) { 72099189c7e7SJoe Perches my $deprecated_api = $1; 72109189c7e7SJoe Perches my $new_api = $deprecated_apis{$deprecated_api}; 72119189c7e7SJoe Perches WARN("DEPRECATED_API", 72129189c7e7SJoe Perches "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr); 72139189c7e7SJoe Perches } 72149189c7e7SJoe Perches 72150f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 7216d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 7217ced69da1SQuentin Monnet if (defined($const_structs) && 7218ced69da1SQuentin Monnet $line !~ /\bconst\b/ && 7219d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 7220000d1cc1SJoe Perches WARN("CONST_STRUCT", 7221d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 72222b6db5cbSAndy Whitcroft } 7223773647a0SAndy Whitcroft 7224773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 7225773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 722635cdcbfcSPeng Wang# ignore designated initializers using NR_CPUS 7227773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 7228c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 7229c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 7230171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 7231171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 723235cdcbfcSPeng Wang $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/ && 723335cdcbfcSPeng Wang $line !~ /^.\s*\.\w+\s*=\s*.*\bNR_CPUS\b/) 7234773647a0SAndy Whitcroft { 7235000d1cc1SJoe Perches WARN("NR_CPUS", 7236000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 7237773647a0SAndy Whitcroft } 72389c9ba34eSAndy Whitcroft 723952ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 724052ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 724152ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 724252ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 724352ea8506SJoe Perches } 724452ea8506SJoe Perches 7245acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 72465b57980dSJoe Perches if ($perl_version_ok && 7247acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 7248acd9362cSJoe Perches WARN("LIKELY_MISUSE", 7249acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 7250acd9362cSJoe Perches } 7251acd9362cSJoe Perches 7252fbe74541SJoe Perches# return sysfs_emit(foo, fmt, ...) fmt without newline 7253fbe74541SJoe Perches if ($line =~ /\breturn\s+sysfs_emit\s*\(\s*$FuncArg\s*,\s*($String)/ && 7254fbe74541SJoe Perches substr($rawline, $-[6], $+[6] - $-[6]) !~ /\\n"$/) { 7255fbe74541SJoe Perches my $offset = $+[6] - 1; 7256fbe74541SJoe Perches if (WARN("SYSFS_EMIT", 7257fbe74541SJoe Perches "return sysfs_emit(...) formats should include a terminating newline\n" . $herecurr) && 7258fbe74541SJoe Perches $fix) { 7259fbe74541SJoe Perches substr($fixed[$fixlinenr], $offset, 0) = '\\n'; 7260fbe74541SJoe Perches } 7261fbe74541SJoe Perches } 7262fbe74541SJoe Perches 7263de3f186fSDenis Efremov# nested likely/unlikely calls 7264de3f186fSDenis Efremov if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) { 7265de3f186fSDenis Efremov WARN("LIKELY_MISUSE", 7266de3f186fSDenis Efremov "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr); 7267de3f186fSDenis Efremov } 7268de3f186fSDenis Efremov 7269691d77b6SAndy Whitcroft# whine mightly about in_atomic 7270691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 7271691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 7272000d1cc1SJoe Perches ERROR("IN_ATOMIC", 7273000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 7274f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 7275000d1cc1SJoe Perches WARN("IN_ATOMIC", 7276000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 7277691d77b6SAndy Whitcroft } 7278691d77b6SAndy Whitcroft } 72791704f47bSPeter Zijlstra 72801704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 72811704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 72821704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 72831704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 72841704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 72851704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 7286000d1cc1SJoe Perches ERROR("LOCKDEP", 7287000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 72881704f47bSPeter Zijlstra } 72891704f47bSPeter Zijlstra } 729088f8831cSDave Jones 7291b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 7292b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 7293000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 7294000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 729588f8831cSDave Jones } 72962435880fSJoe Perches 729700180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 729800180468SJoe Perches# and whether or not function naming is typical and if 729900180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 73005b57980dSJoe Perches if ($perl_version_ok && 730100180468SJoe Perches defined $stat && 730200180468SJoe 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*\)/) { 730300180468SJoe Perches my $var = $1; 730400180468SJoe Perches my $perms = $2; 730500180468SJoe Perches my $show = $3; 730600180468SJoe Perches my $store = $4; 730700180468SJoe Perches my $octal_perms = perms_to_octal($perms); 730800180468SJoe Perches if ($show =~ /^${var}_show$/ && 730900180468SJoe Perches $store =~ /^${var}_store$/ && 731000180468SJoe Perches $octal_perms eq "0644") { 731100180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 731200180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 731300180468SJoe Perches $fix) { 731400180468SJoe 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})/; 731500180468SJoe Perches } 731600180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 731700180468SJoe Perches $store =~ /^NULL$/ && 731800180468SJoe Perches $octal_perms eq "0444") { 731900180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 732000180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 732100180468SJoe Perches $fix) { 732200180468SJoe 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})/; 732300180468SJoe Perches } 732400180468SJoe Perches } elsif ($show =~ /^NULL$/ && 732500180468SJoe Perches $store =~ /^${var}_store$/ && 732600180468SJoe Perches $octal_perms eq "0200") { 732700180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 732800180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 732900180468SJoe Perches $fix) { 733000180468SJoe 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})/; 733100180468SJoe Perches } 733200180468SJoe Perches } elsif ($octal_perms eq "0644" || 733300180468SJoe Perches $octal_perms eq "0444" || 733400180468SJoe Perches $octal_perms eq "0200") { 733500180468SJoe Perches my $newshow = "$show"; 733600180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 733700180468SJoe Perches my $newstore = $store; 733800180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 733900180468SJoe Perches my $rename = ""; 734000180468SJoe Perches if ($show ne $newshow) { 734100180468SJoe Perches $rename .= " '$show' to '$newshow'"; 734200180468SJoe Perches } 734300180468SJoe Perches if ($store ne $newstore) { 734400180468SJoe Perches $rename .= " '$store' to '$newstore'"; 734500180468SJoe Perches } 734600180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 734700180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 734800180468SJoe Perches } else { 734900180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 735000180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 735100180468SJoe Perches } 735200180468SJoe Perches } 735300180468SJoe Perches 7354515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 7355515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 735673121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 735773121534SJoe Perches# specific definition of not visible in sysfs. 735873121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 735973121534SJoe Perches# use the default permissions 73605b57980dSJoe Perches if ($perl_version_ok && 7361459cf0aeSJoe Perches defined $stat && 7362515a235eSJoe Perches $line =~ /$mode_perms_search/) { 73632435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 73642435880fSJoe Perches my $func = $entry->[0]; 73652435880fSJoe Perches my $arg_pos = $entry->[1]; 73662435880fSJoe Perches 7367459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 7368459cf0aeSJoe Perches $lc = $lc + $linenr; 73692a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 7370459cf0aeSJoe Perches 73712435880fSJoe Perches my $skip_args = ""; 73722435880fSJoe Perches if ($arg_pos > 1) { 73732435880fSJoe Perches $arg_pos--; 73742435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 73752435880fSJoe Perches } 7376f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 7377459cf0aeSJoe Perches if ($stat =~ /$test/) { 73782435880fSJoe Perches my $val = $1; 73792435880fSJoe Perches $val = $6 if ($skip_args ne ""); 738073121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 738173121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 738273121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 73832435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 7384459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 7385f90774e1SJoe Perches } 7386f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 7387c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 7388459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 73892435880fSJoe Perches } 7390459cf0aeSJoe Perches } 7391459cf0aeSJoe Perches } 7392459cf0aeSJoe Perches } 7393459cf0aeSJoe Perches 7394459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 7395bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 739600180468SJoe Perches my $oval = $1; 739700180468SJoe Perches my $octal = perms_to_octal($oval); 7398f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 7399459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 7400f90774e1SJoe Perches $fix) { 740100180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 74022435880fSJoe Perches } 740313214adfSAndy Whitcroft } 74045a6d20ceSBjorn Andersson 74055a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 74065a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 74075a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 74085a6d20ceSBjorn Andersson my $valid_licenses = qr{ 74095a6d20ceSBjorn Andersson GPL| 74105a6d20ceSBjorn Andersson GPL\ v2| 74115a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 74125a6d20ceSBjorn Andersson Dual\ BSD/GPL| 74135a6d20ceSBjorn Andersson Dual\ MIT/GPL| 74145a6d20ceSBjorn Andersson Dual\ MPL/GPL| 74155a6d20ceSBjorn Andersson Proprietary 74165a6d20ceSBjorn Andersson }x; 74175a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 74185a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 74195a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 74205a6d20ceSBjorn Andersson } 74215a6d20ceSBjorn Andersson } 74226a8d76cbSMatteo Croce 74236a8d76cbSMatteo Croce# check for sysctl duplicate constants 74246a8d76cbSMatteo Croce if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) { 74256a8d76cbSMatteo Croce WARN("DUPLICATED_SYSCTL_CONST", 74266a8d76cbSMatteo Croce "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr); 74276a8d76cbSMatteo Croce } 7428515a235eSJoe Perches } 742913214adfSAndy Whitcroft 743013214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 743113214adfSAndy Whitcroft # so just keep quiet. 743213214adfSAndy Whitcroft if ($#rawlines == -1) { 743313214adfSAndy Whitcroft exit(0); 74340a920b5bSAndy Whitcroft } 74350a920b5bSAndy Whitcroft 74368905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 74378905a67cSAndy Whitcroft # things that appear to be patches. 74388905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 74398905a67cSAndy Whitcroft exit(0); 74408905a67cSAndy Whitcroft } 74418905a67cSAndy Whitcroft 7442e73d2715SDwaipayan Ray # This is not a patch, and we are in 'no-patch' mode so 74438905a67cSAndy Whitcroft # just keep quiet. 74448905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 74458905a67cSAndy Whitcroft exit(0); 74468905a67cSAndy Whitcroft } 74478905a67cSAndy Whitcroft 7448a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 7449000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 7450000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 74510a920b5bSAndy Whitcroft } 7452cd261496SGeert Uytterhoeven if ($is_patch && $has_commit_log && $chk_signoff) { 7453cd261496SGeert Uytterhoeven if ($signoff == 0) { 7454000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 7455000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 745648ca2d8aSDwaipayan Ray } elsif ($authorsignoff != 1) { 745748ca2d8aSDwaipayan Ray # authorsignoff values: 745848ca2d8aSDwaipayan Ray # 0 -> missing sign off 745948ca2d8aSDwaipayan Ray # 1 -> sign off identical 746048ca2d8aSDwaipayan Ray # 2 -> names and addresses match, comments mismatch 746148ca2d8aSDwaipayan Ray # 3 -> addresses match, names different 746248ca2d8aSDwaipayan Ray # 4 -> names match, addresses different 746348ca2d8aSDwaipayan Ray # 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match 746448ca2d8aSDwaipayan Ray 746548ca2d8aSDwaipayan Ray my $sob_msg = "'From: $author' != 'Signed-off-by: $author_sob'"; 746648ca2d8aSDwaipayan Ray 746748ca2d8aSDwaipayan Ray if ($authorsignoff == 0) { 746848ca2d8aSDwaipayan Ray ERROR("NO_AUTHOR_SIGN_OFF", 7469cd261496SGeert Uytterhoeven "Missing Signed-off-by: line by nominal patch author '$author'\n"); 747048ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 2) { 747148ca2d8aSDwaipayan Ray CHK("FROM_SIGN_OFF_MISMATCH", 747248ca2d8aSDwaipayan Ray "From:/Signed-off-by: email comments mismatch: $sob_msg\n"); 747348ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 3) { 747448ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 747548ca2d8aSDwaipayan Ray "From:/Signed-off-by: email name mismatch: $sob_msg\n"); 747648ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 4) { 747748ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 747848ca2d8aSDwaipayan Ray "From:/Signed-off-by: email address mismatch: $sob_msg\n"); 747948ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 5) { 748048ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 748148ca2d8aSDwaipayan Ray "From:/Signed-off-by: email subaddress mismatch: $sob_msg\n"); 748248ca2d8aSDwaipayan Ray } 7483cd261496SGeert Uytterhoeven } 74840a920b5bSAndy Whitcroft } 74850a920b5bSAndy Whitcroft 7486f0a594c1SAndy Whitcroft print report_dump(); 748713214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 748813214adfSAndy Whitcroft print "$filename " if ($summary_file); 74896c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 74906c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 74916c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 74926c72ffaaSAndy Whitcroft } 74938905a67cSAndy Whitcroft 7494d2c0a235SAndy Whitcroft if ($quiet == 0) { 7495ef212196SJoe Perches # If there were any defects found and not already fixing them 7496ef212196SJoe Perches if (!$clean and !$fix) { 7497ef212196SJoe Perches print << "EOM" 7498ef212196SJoe Perches 7499ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 7500ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 7501ef212196SJoe PerchesEOM 7502ef212196SJoe Perches } 7503d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 7504d2c0a235SAndy Whitcroft # then suggest that. 7505d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 7506b0781216SMike Frysinger $rpt_cleaners = 0; 7507d8469f16SJoe Perches print << "EOM" 7508d8469f16SJoe Perches 7509d8469f16SJoe PerchesNOTE: Whitespace errors detected. 7510d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 7511d8469f16SJoe PerchesEOM 7512d2c0a235SAndy Whitcroft } 7513d2c0a235SAndy Whitcroft } 7514d2c0a235SAndy Whitcroft 7515d752fcc8SJoe Perches if ($clean == 0 && $fix && 7516d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 7517d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 75189624b8d6SJoe Perches my $newfile = $filename; 75199624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 75203705ce5bSJoe Perches my $linecount = 0; 75213705ce5bSJoe Perches my $f; 75223705ce5bSJoe Perches 7523d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 7524d752fcc8SJoe Perches 75253705ce5bSJoe Perches open($f, '>', $newfile) 75263705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 75273705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 75283705ce5bSJoe Perches $linecount++; 75293705ce5bSJoe Perches if ($file) { 75303705ce5bSJoe Perches if ($linecount > 3) { 75313705ce5bSJoe Perches $fixed_line =~ s/^\+//; 75323705ce5bSJoe Perches print $f $fixed_line . "\n"; 75333705ce5bSJoe Perches } 75343705ce5bSJoe Perches } else { 75353705ce5bSJoe Perches print $f $fixed_line . "\n"; 75363705ce5bSJoe Perches } 75373705ce5bSJoe Perches } 75383705ce5bSJoe Perches close($f); 75393705ce5bSJoe Perches 75403705ce5bSJoe Perches if (!$quiet) { 75413705ce5bSJoe Perches print << "EOM"; 7542d8469f16SJoe Perches 75433705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 75443705ce5bSJoe Perches 75453705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 75463705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 75473705ce5bSJoe Perches 75483705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 75493705ce5bSJoe PerchesNo warranties, expressed or implied... 75503705ce5bSJoe PerchesEOM 75513705ce5bSJoe Perches } 75523705ce5bSJoe Perches } 75533705ce5bSJoe Perches 7554d8469f16SJoe Perches if ($quiet == 0) { 7555d8469f16SJoe Perches print "\n"; 7556d8469f16SJoe Perches if ($clean == 1) { 7557d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 7558d8469f16SJoe Perches } else { 7559d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 75600a920b5bSAndy Whitcroft } 75610a920b5bSAndy Whitcroft } 75620a920b5bSAndy Whitcroft return $clean; 75630a920b5bSAndy Whitcroft} 7564