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; 31d5d6281aSDan Carpentermy $chk_fixes_tag = 1; 320a920b5bSAndy Whitcroftmy $chk_patch = 1; 33773647a0SAndy Whitcroftmy $tst_only; 346c72ffaaSAndy Whitcroftmy $emacs = 0; 358905a67cSAndy Whitcroftmy $terse = 0; 3634d8815fSJoe Perchesmy $showfile = 0; 376c72ffaaSAndy Whitcroftmy $file = 0; 384a593c34SDu, Changbinmy $git = 0; 390dea9f1eSJoe Perchesmy %git_commits = (); 406c72ffaaSAndy Whitcroftmy $check = 0; 412ac73b4fSJoe Perchesmy $check_orig = 0; 428905a67cSAndy Whitcroftmy $summary = 1; 438905a67cSAndy Whitcroftmy $mailback = 0; 4413214adfSAndy Whitcroftmy $summary_file = 0; 45000d1cc1SJoe Perchesmy $show_types = 0; 463beb42ecSJoe Perchesmy $list_types = 0; 473705ce5bSJoe Perchesmy $fix = 0; 489624b8d6SJoe Perchesmy $fix_inplace = 0; 496c72ffaaSAndy Whitcroftmy $root; 500f7f635bSJoe Perchesmy $gitroot = $ENV{'GIT_DIR'}; 510f7f635bSJoe Perches$gitroot = ".git" if !defined($gitroot); 52c2fdda0dSAndy Whitcroftmy %debug; 533445686aSJoe Perchesmy %camelcase = (); 5491bfe484SJoe Perchesmy %use_type = (); 5591bfe484SJoe Perchesmy @use = (); 5691bfe484SJoe Perchesmy %ignore_type = (); 57000d1cc1SJoe Perchesmy @ignore = (); 5877f5b10aSHannes Edermy $help = 0; 59000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 60bdc48fa1SJoe Perchesmy $max_line_length = 100; 61d62a201fSDave Hansenmy $ignore_perl_version = 0; 62d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 6356193274SVadim Bendeburymy $min_conf_desc_length = 4; 6466b47b4aSKees Cookmy $spelling_file = "$D/spelling.txt"; 65ebfd7d62SJoe Perchesmy $codespell = 0; 66f1a63678SMaxim Uvarovmy $codespellfile = "/usr/share/codespell/dictionary.txt"; 670ee3e7b8SPeter Ujfalusimy $user_codespellfile = ""; 68bf1fa1daSJoe Perchesmy $conststructsfile = "$D/const_structs.checkpatch"; 6952178ce0SDwaipayan Raymy $docsfile = "$D/../Documentation/dev-tools/checkpatch.rst"; 70ced69da1SQuentin Monnetmy $typedefsfile; 71737c0767SJohn Brooksmy $color = "auto"; 7298005e8cSVadim Bendeburymy $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE 73dbbf869dSJoe Perches# git output parsing needs US English output, so first set backtick child process LANGUAGE 74dbbf869dSJoe Perchesmy $git_command ='export LANGUAGE=en_US.UTF-8; git'; 75713a09deSAntonio Borneomy $tabsize = 8; 763e89ad85SJerome Forissiermy ${CONFIG_} = "CONFIG_"; 7777f5b10aSHannes Eder 785b2c7334SJim Cromiemy %maybe_linker_symbol; # for externs in c exceptions, when seen in *vmlinux.lds.h 795b2c7334SJim Cromie 8077f5b10aSHannes Edersub help { 8177f5b10aSHannes Eder my ($exitcode) = @_; 8277f5b10aSHannes Eder 8377f5b10aSHannes Eder print << "EOM"; 8477f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 8577f5b10aSHannes EderVersion: $V 8677f5b10aSHannes Eder 8777f5b10aSHannes EderOptions: 8877f5b10aSHannes Eder -q, --quiet quiet 8952178ce0SDwaipayan Ray -v, --verbose verbose mode 9077f5b10aSHannes Eder --no-tree run without a kernel tree 9177f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 92d5d6281aSDan Carpenter --no-fixes-tag do not check for 'Fixes:' tag 9377f5b10aSHannes Eder --patch treat FILE as patchfile (default) 9477f5b10aSHannes Eder --emacs emacs compile window format 9577f5b10aSHannes Eder --terse one line per report 9634d8815fSJoe Perches --showfile emit diffed file position, not input file position 974a593c34SDu, Changbin -g, --git treat FILE as a single commit or git revision range 984a593c34SDu, Changbin single git commit with: 994a593c34SDu, Changbin <rev> 1004a593c34SDu, Changbin <rev>^ 1014a593c34SDu, Changbin <rev>~n 1024a593c34SDu, Changbin multiple git commits with: 1034a593c34SDu, Changbin <rev1>..<rev2> 1044a593c34SDu, Changbin <rev1>...<rev2> 1054a593c34SDu, Changbin <rev>-<count> 1064a593c34SDu, Changbin git merges are ignored 10777f5b10aSHannes Eder -f, --file treat FILE as regular source file 10877f5b10aSHannes Eder --subjective, --strict enable more subjective tests 1093beb42ecSJoe Perches --list-types list the possible message types 11091bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 111000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 1123beb42ecSJoe Perches --show-types show the specific message type in the output 113bdc48fa1SJoe Perches --max-line-length=n set the maximum line length, (default $max_line_length) 114bdc48fa1SJoe Perches if exceeded, warn on patches 115bdc48fa1SJoe Perches requires --strict for use with --file 11656193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 117bdc48fa1SJoe Perches --tab-size=n set the number of spaces for tab (default $tabsize) 11877f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 11977f5b10aSHannes Eder --no-summary suppress the per-file summary 12077f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 12177f5b10aSHannes Eder --summary-file include the filename in summary 12277f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 12377f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 12477f5b10aSHannes Eder is all off) 12577f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 12677f5b10aSHannes Eder literally 1273705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 1283705ce5bSJoe Perches If correctable single-line errors exist, create 1293705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 1303705ce5bSJoe Perches with potential errors corrected to the preferred 1313705ce5bSJoe Perches checkpatch style 1329624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 1339624b8d6SJoe Perches Is the same as --fix, but overwrites the input 1349624b8d6SJoe Perches file. It's your fault if there's no backup or git 135d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 136d62a201fSDave Hansen runtime errors. 137ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 1380ee3e7b8SPeter Ujfalusi (default:$codespellfile) 139ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 14075ad8c57SJerome Forissier --typedefsfile Read additional types from this file 141737c0767SJohn Brooks --color[=WHEN] Use colors 'always', 'never', or only when output 142737c0767SJohn Brooks is a terminal ('auto'). Default is 'auto'. 1433e89ad85SJerome Forissier --kconfig-prefix=WORD use WORD as a prefix for Kconfig symbols (default 1443e89ad85SJerome Forissier ${CONFIG_}) 14577f5b10aSHannes Eder -h, --help, --version display this help and exit 14677f5b10aSHannes Eder 14777f5b10aSHannes EderWhen FILE is - read standard input. 14877f5b10aSHannes EderEOM 14977f5b10aSHannes Eder 15077f5b10aSHannes Eder exit($exitcode); 15177f5b10aSHannes Eder} 15277f5b10aSHannes Eder 1533beb42ecSJoe Perchessub uniq { 1543beb42ecSJoe Perches my %seen; 1553beb42ecSJoe Perches return grep { !$seen{$_}++ } @_; 1563beb42ecSJoe Perches} 1573beb42ecSJoe Perches 1583beb42ecSJoe Perchessub list_types { 1593beb42ecSJoe Perches my ($exitcode) = @_; 1603beb42ecSJoe Perches 1613beb42ecSJoe Perches my $count = 0; 1623beb42ecSJoe Perches 1633beb42ecSJoe Perches local $/ = undef; 1643beb42ecSJoe Perches 1653beb42ecSJoe Perches open(my $script, '<', abs_path($P)) or 1663beb42ecSJoe Perches die "$P: Can't read '$P' $!\n"; 1673beb42ecSJoe Perches 1683beb42ecSJoe Perches my $text = <$script>; 1693beb42ecSJoe Perches close($script); 1703beb42ecSJoe Perches 17152178ce0SDwaipayan Ray my %types = (); 1720547fa58SJean Delvare # Also catch when type or level is passed through a variable 17352178ce0SDwaipayan Ray while ($text =~ /(?:(\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) { 17452178ce0SDwaipayan Ray if (defined($1)) { 17552178ce0SDwaipayan Ray if (exists($types{$2})) { 17652178ce0SDwaipayan Ray $types{$2} .= ",$1" if ($types{$2} ne $1); 17752178ce0SDwaipayan Ray } else { 17852178ce0SDwaipayan Ray $types{$2} = $1; 1793beb42ecSJoe Perches } 18052178ce0SDwaipayan Ray } else { 18152178ce0SDwaipayan Ray $types{$2} = "UNDETERMINED"; 18252178ce0SDwaipayan Ray } 18352178ce0SDwaipayan Ray } 18452178ce0SDwaipayan Ray 1853beb42ecSJoe Perches print("#\tMessage type\n\n"); 18652178ce0SDwaipayan Ray if ($color) { 18752178ce0SDwaipayan Ray print(" ( Color coding: "); 18852178ce0SDwaipayan Ray print(RED . "ERROR" . RESET); 18952178ce0SDwaipayan Ray print(" | "); 19052178ce0SDwaipayan Ray print(YELLOW . "WARNING" . RESET); 19152178ce0SDwaipayan Ray print(" | "); 19252178ce0SDwaipayan Ray print(GREEN . "CHECK" . RESET); 19352178ce0SDwaipayan Ray print(" | "); 19452178ce0SDwaipayan Ray print("Multiple levels / Undetermined"); 19552178ce0SDwaipayan Ray print(" )\n\n"); 19652178ce0SDwaipayan Ray } 19752178ce0SDwaipayan Ray 19852178ce0SDwaipayan Ray foreach my $type (sort keys %types) { 19952178ce0SDwaipayan Ray my $orig_type = $type; 20052178ce0SDwaipayan Ray if ($color) { 20152178ce0SDwaipayan Ray my $level = $types{$type}; 20252178ce0SDwaipayan Ray if ($level eq "ERROR") { 20352178ce0SDwaipayan Ray $type = RED . $type . RESET; 20452178ce0SDwaipayan Ray } elsif ($level eq "WARN") { 20552178ce0SDwaipayan Ray $type = YELLOW . $type . RESET; 20652178ce0SDwaipayan Ray } elsif ($level eq "CHK") { 20752178ce0SDwaipayan Ray $type = GREEN . $type . RESET; 20852178ce0SDwaipayan Ray } 20952178ce0SDwaipayan Ray } 2103beb42ecSJoe Perches print(++$count . "\t" . $type . "\n"); 21152178ce0SDwaipayan Ray if ($verbose && exists($verbose_messages{$orig_type})) { 21252178ce0SDwaipayan Ray my $message = $verbose_messages{$orig_type}; 21352178ce0SDwaipayan Ray $message =~ s/\n/\n\t/g; 21452178ce0SDwaipayan Ray print("\t" . $message . "\n\n"); 21552178ce0SDwaipayan Ray } 2163beb42ecSJoe Perches } 2173beb42ecSJoe Perches 2183beb42ecSJoe Perches exit($exitcode); 2193beb42ecSJoe Perches} 2203beb42ecSJoe Perches 221000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 222000d1cc1SJoe Perchesif (-f $conf) { 223000d1cc1SJoe Perches my @conf_args; 224000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 225000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 226000d1cc1SJoe Perches 227000d1cc1SJoe Perches while (<$conffile>) { 228000d1cc1SJoe Perches my $line = $_; 229000d1cc1SJoe Perches 230000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 231000d1cc1SJoe Perches $line =~ s/^\s*//g; 232000d1cc1SJoe Perches $line =~ s/\s+/ /g; 233000d1cc1SJoe Perches 234000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 235000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 236000d1cc1SJoe Perches 237000d1cc1SJoe Perches my @words = split(" ", $line); 238000d1cc1SJoe Perches foreach my $word (@words) { 239000d1cc1SJoe Perches last if ($word =~ m/^#/); 240000d1cc1SJoe Perches push (@conf_args, $word); 241000d1cc1SJoe Perches } 242000d1cc1SJoe Perches } 243000d1cc1SJoe Perches close($conffile); 244000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 245000d1cc1SJoe Perches} 246000d1cc1SJoe Perches 24752178ce0SDwaipayan Raysub load_docs { 24852178ce0SDwaipayan Ray open(my $docs, '<', "$docsfile") 24952178ce0SDwaipayan Ray or warn "$P: Can't read the documentation file $docsfile $!\n"; 25052178ce0SDwaipayan Ray 25152178ce0SDwaipayan Ray my $type = ''; 25252178ce0SDwaipayan Ray my $desc = ''; 25352178ce0SDwaipayan Ray my $in_desc = 0; 25452178ce0SDwaipayan Ray 25552178ce0SDwaipayan Ray while (<$docs>) { 25652178ce0SDwaipayan Ray chomp; 25752178ce0SDwaipayan Ray my $line = $_; 25852178ce0SDwaipayan Ray $line =~ s/\s+$//; 25952178ce0SDwaipayan Ray 26052178ce0SDwaipayan Ray if ($line =~ /^\s*\*\*(.+)\*\*$/) { 26152178ce0SDwaipayan Ray if ($desc ne '') { 26252178ce0SDwaipayan Ray $verbose_messages{$type} = trim($desc); 26352178ce0SDwaipayan Ray } 26452178ce0SDwaipayan Ray $type = $1; 26552178ce0SDwaipayan Ray $desc = ''; 26652178ce0SDwaipayan Ray $in_desc = 1; 26752178ce0SDwaipayan Ray } elsif ($in_desc) { 26852178ce0SDwaipayan Ray if ($line =~ /^(?:\s{4,}|$)/) { 26952178ce0SDwaipayan Ray $line =~ s/^\s{4}//; 27052178ce0SDwaipayan Ray $desc .= $line; 27152178ce0SDwaipayan Ray $desc .= "\n"; 27252178ce0SDwaipayan Ray } else { 27352178ce0SDwaipayan Ray $verbose_messages{$type} = trim($desc); 27452178ce0SDwaipayan Ray $type = ''; 27552178ce0SDwaipayan Ray $desc = ''; 27652178ce0SDwaipayan Ray $in_desc = 0; 27752178ce0SDwaipayan Ray } 27852178ce0SDwaipayan Ray } 27952178ce0SDwaipayan Ray } 28052178ce0SDwaipayan Ray 28152178ce0SDwaipayan Ray if ($desc ne '') { 28252178ce0SDwaipayan Ray $verbose_messages{$type} = trim($desc); 28352178ce0SDwaipayan Ray } 28452178ce0SDwaipayan Ray close($docs); 28552178ce0SDwaipayan Ray} 28652178ce0SDwaipayan Ray 287737c0767SJohn Brooks# Perl's Getopt::Long allows options to take optional arguments after a space. 288737c0767SJohn Brooks# Prevent --color by itself from consuming other arguments 289737c0767SJohn Brooksforeach (@ARGV) { 290737c0767SJohn Brooks if ($_ eq "--color" || $_ eq "-color") { 291737c0767SJohn Brooks $_ = "--color=$color"; 292737c0767SJohn Brooks } 293737c0767SJohn Brooks} 294737c0767SJohn Brooks 2950a920b5bSAndy WhitcroftGetOptions( 2966c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 29752178ce0SDwaipayan Ray 'v|verbose!' => \$verbose, 2980a920b5bSAndy Whitcroft 'tree!' => \$tree, 2990a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 300d5d6281aSDan Carpenter 'fixes-tag!' => \$chk_fixes_tag, 3010a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 3026c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 3038905a67cSAndy Whitcroft 'terse!' => \$terse, 30434d8815fSJoe Perches 'showfile!' => \$showfile, 30577f5b10aSHannes Eder 'f|file!' => \$file, 3064a593c34SDu, Changbin 'g|git!' => \$git, 3076c72ffaaSAndy Whitcroft 'subjective!' => \$check, 3086c72ffaaSAndy Whitcroft 'strict!' => \$check, 309000d1cc1SJoe Perches 'ignore=s' => \@ignore, 31091bfe484SJoe Perches 'types=s' => \@use, 311000d1cc1SJoe Perches 'show-types!' => \$show_types, 3123beb42ecSJoe Perches 'list-types!' => \$list_types, 3136cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 31456193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 315713a09deSAntonio Borneo 'tab-size=i' => \$tabsize, 3166c72ffaaSAndy Whitcroft 'root=s' => \$root, 3178905a67cSAndy Whitcroft 'summary!' => \$summary, 3188905a67cSAndy Whitcroft 'mailback!' => \$mailback, 31913214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 3203705ce5bSJoe Perches 'fix!' => \$fix, 3219624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 322d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 323c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 324773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 325ebfd7d62SJoe Perches 'codespell!' => \$codespell, 3260ee3e7b8SPeter Ujfalusi 'codespellfile=s' => \$user_codespellfile, 32775ad8c57SJerome Forissier 'typedefsfile=s' => \$typedefsfile, 328737c0767SJohn Brooks 'color=s' => \$color, 329737c0767SJohn Brooks 'no-color' => \$color, #keep old behaviors of -nocolor 330737c0767SJohn Brooks 'nocolor' => \$color, #keep old behaviors of -nocolor 3313e89ad85SJerome Forissier 'kconfig-prefix=s' => \${CONFIG_}, 33277f5b10aSHannes Eder 'h|help' => \$help, 33377f5b10aSHannes Eder 'version' => \$help 3340ee3e7b8SPeter Ujfalusi) or $help = 2; 33577f5b10aSHannes Eder 3360ee3e7b8SPeter Ujfalusiif ($user_codespellfile) { 3370ee3e7b8SPeter Ujfalusi # Use the user provided codespell file unconditionally 3380ee3e7b8SPeter Ujfalusi $codespellfile = $user_codespellfile; 3390ee3e7b8SPeter Ujfalusi} elsif (!(-f $codespellfile)) { 3400ee3e7b8SPeter Ujfalusi # If /usr/share/codespell/dictionary.txt is not present, try to find it 3410ee3e7b8SPeter Ujfalusi # under codespell's install directory: <codespell_root>/data/dictionary.txt 342c882c6b1SSagar Patel if (($codespell || $help) && which("python3") ne "") { 3430ee3e7b8SPeter Ujfalusi my $python_codespell_dict = << "EOF"; 3440ee3e7b8SPeter Ujfalusi 3450ee3e7b8SPeter Ujfalusiimport os.path as op 3460ee3e7b8SPeter Ujfalusiimport codespell_lib 3470ee3e7b8SPeter Ujfalusicodespell_dir = op.dirname(codespell_lib.__file__) 3480ee3e7b8SPeter Ujfalusicodespell_file = op.join(codespell_dir, 'data', 'dictionary.txt') 3490ee3e7b8SPeter Ujfalusiprint(codespell_file, end='') 3500ee3e7b8SPeter UjfalusiEOF 3510ee3e7b8SPeter Ujfalusi 352c882c6b1SSagar Patel my $codespell_dict = `python3 -c "$python_codespell_dict" 2> /dev/null`; 3530ee3e7b8SPeter Ujfalusi $codespellfile = $codespell_dict if (-f $codespell_dict); 3540ee3e7b8SPeter Ujfalusi } 3550ee3e7b8SPeter Ujfalusi} 3560ee3e7b8SPeter Ujfalusi 3570ee3e7b8SPeter Ujfalusi# $help is 1 if either -h, --help or --version is passed as option - exitcode: 0 3580ee3e7b8SPeter Ujfalusi# $help is 2 if invalid option is passed - exitcode: 1 3590ee3e7b8SPeter Ujfalusihelp($help - 1) if ($help); 3600a920b5bSAndy Whitcroft 36152178ce0SDwaipayan Raydie "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix)); 36252178ce0SDwaipayan Raydie "$P: --verbose cannot be used with --terse\n" if ($verbose && $terse); 36352178ce0SDwaipayan Ray 36452178ce0SDwaipayan Rayif ($color =~ /^[01]$/) { 36552178ce0SDwaipayan Ray $color = !$color; 36652178ce0SDwaipayan Ray} elsif ($color =~ /^always$/i) { 36752178ce0SDwaipayan Ray $color = 1; 36852178ce0SDwaipayan Ray} elsif ($color =~ /^never$/i) { 36952178ce0SDwaipayan Ray $color = 0; 37052178ce0SDwaipayan Ray} elsif ($color =~ /^auto$/i) { 37152178ce0SDwaipayan Ray $color = (-t STDOUT); 37252178ce0SDwaipayan Ray} else { 37352178ce0SDwaipayan Ray die "$P: Invalid color mode: $color\n"; 37452178ce0SDwaipayan Ray} 37552178ce0SDwaipayan Ray 37652178ce0SDwaipayan Rayload_docs() if ($verbose); 3773beb42ecSJoe Percheslist_types(0) if ($list_types); 3783beb42ecSJoe Perches 3799624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 3802ac73b4fSJoe Perches$check_orig = $check; 3819624b8d6SJoe Perches 3820a920b5bSAndy Whitcroftmy $exit = 0; 3830a920b5bSAndy Whitcroft 3845b57980dSJoe Perchesmy $perl_version_ok = 1; 385d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 3865b57980dSJoe Perches $perl_version_ok = 0; 387d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 3885b57980dSJoe Perches exit(1) if (!$ignore_perl_version); 389d62a201fSDave Hansen} 390d62a201fSDave Hansen 39145107ff6SAllen Hubbe#if no filenames are given, push '-' to read patch from stdin 3920a920b5bSAndy Whitcroftif ($#ARGV < 0) { 39345107ff6SAllen Hubbe push(@ARGV, '-'); 3940a920b5bSAndy Whitcroft} 3950a920b5bSAndy Whitcroft 396713a09deSAntonio Borneo# skip TAB size 1 to avoid additional checks on $tabsize - 1 39732f30ca9SJoe Perchesdie "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2); 398713a09deSAntonio Borneo 39991bfe484SJoe Perchessub hash_save_array_words { 40091bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 40191bfe484SJoe Perches 40291bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 40391bfe484SJoe Perches foreach my $word (@array) { 404000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 405000d1cc1SJoe Perches $word =~ s/^\s*//g; 406000d1cc1SJoe Perches $word =~ s/\s+/ /g; 407000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 408000d1cc1SJoe Perches 409000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 410000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 411000d1cc1SJoe Perches 41291bfe484SJoe Perches $hashRef->{$word}++; 413000d1cc1SJoe Perches } 41491bfe484SJoe Perches} 41591bfe484SJoe Perches 41691bfe484SJoe Perchessub hash_show_words { 41791bfe484SJoe Perches my ($hashRef, $prefix) = @_; 41891bfe484SJoe Perches 4193c816e49SJoe Perches if (keys %$hashRef) { 420d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 42158cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 42291bfe484SJoe Perches print " $word"; 42391bfe484SJoe Perches } 424d8469f16SJoe Perches print "\n"; 42591bfe484SJoe Perches } 42691bfe484SJoe Perches} 42791bfe484SJoe Perches 42891bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 42991bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 430000d1cc1SJoe Perches 431c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 432c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 4337429c690SAndy Whitcroftmy $dbg_type = 0; 434a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 435c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 43621caa13cSAndy Whitcroft ## no critic 43721caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 43821caa13cSAndy Whitcroft die "$@" if ($@); 439c2fdda0dSAndy Whitcroft} 440c2fdda0dSAndy Whitcroft 441d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 442d2c0a235SAndy Whitcroft 4438905a67cSAndy Whitcroftif ($terse) { 4448905a67cSAndy Whitcroft $emacs = 1; 4458905a67cSAndy Whitcroft $quiet++; 4468905a67cSAndy Whitcroft} 4478905a67cSAndy Whitcroft 4486c72ffaaSAndy Whitcroftif ($tree) { 4496c72ffaaSAndy Whitcroft if (defined $root) { 4506c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 4516c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 4526c72ffaaSAndy Whitcroft } 4536c72ffaaSAndy Whitcroft } else { 4546c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 4556c72ffaaSAndy Whitcroft $root = '.'; 4566c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 4576c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 4586c72ffaaSAndy Whitcroft $root = $1; 4596c72ffaaSAndy Whitcroft } 4606c72ffaaSAndy Whitcroft } 4616c72ffaaSAndy Whitcroft 4626c72ffaaSAndy Whitcroft if (!defined $root) { 4630a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 4640a920b5bSAndy Whitcroft exit(2); 4650a920b5bSAndy Whitcroft } 4666c72ffaaSAndy Whitcroft} 4676c72ffaaSAndy Whitcroft 4686c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 4696c72ffaaSAndy Whitcroft 4702ceb532bSAndy Whitcroftour $Ident = qr{ 4712ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 4722ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 4732ceb532bSAndy Whitcroft }x; 4746c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 4756c72ffaaSAndy Whitcroftour $Sparse = qr{ 4766c72ffaaSAndy Whitcroft __user| 4776c72ffaaSAndy Whitcroft __kernel| 4786c72ffaaSAndy Whitcroft __force| 4796c72ffaaSAndy Whitcroft __iomem| 4806c72ffaaSAndy Whitcroft __must_check| 481417495edSAndy Whitcroft __kprobes| 482165e72a6SSven Eckelmann __ref| 48333aa4597SGeert Uytterhoeven __refconst| 48433aa4597SGeert Uytterhoeven __refdata| 485ad315455SBoqun Feng __rcu| 486ad315455SBoqun Feng __private 4876c72ffaaSAndy Whitcroft }x; 488e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 489e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 490e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 491e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 492e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 4938716de38SJoe Perches 49452131292SWolfram Sang# Notes to $Attribute: 49552131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 4966c72ffaaSAndy Whitcroftour $Attribute = qr{ 4976c72ffaaSAndy Whitcroft const| 498b5e8736aSJoe Perches volatile| 49903f1df7dSJoe Perches __percpu| 50003f1df7dSJoe Perches __nocast| 50103f1df7dSJoe Perches __safe| 50246d832f5SMichael S. Tsirkin __bitwise| 50303f1df7dSJoe Perches __packed__| 50403f1df7dSJoe Perches __packed2__| 50503f1df7dSJoe Perches __naked| 50603f1df7dSJoe Perches __maybe_unused| 50703f1df7dSJoe Perches __always_unused| 50803f1df7dSJoe Perches __noreturn| 50903f1df7dSJoe Perches __used| 51003f1df7dSJoe Perches __cold| 511e23ef1f3SJoe Perches __pure| 51203f1df7dSJoe Perches __noclone| 51303f1df7dSJoe Perches __deprecated| 5146c72ffaaSAndy Whitcroft __read_mostly| 515c5967e98SJoe Perches __ro_after_init| 5166c72ffaaSAndy Whitcroft __kprobes| 5178716de38SJoe Perches $InitAttribute| 5182f9dadbaSMarcelo Schmitt __aligned\s*\(.*\)| 51924e1d81aSAndy Whitcroft ____cacheline_aligned| 52024e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 5215fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 52286cffecdSKees Cook __weak| 52386cffecdSKees Cook __alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\) 5246c72ffaaSAndy Whitcroft }x; 525c45dcabdSAndy Whitcroftour $Modifier; 52691cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 5276c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 5286c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 5296c72ffaaSAndy Whitcroft 53095e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 53195e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 53295e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 53395e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 5342435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 535d2af5aa6SJoe Perchesour $String = qr{(?:\b[Lu])?"[X\t]*"}; 536326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 537326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 538326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 53974349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 5402435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 541326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 542447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 54323f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 5446c72ffaaSAndy Whitcroftour $Operators = qr{ 5456c72ffaaSAndy Whitcroft <=|>=|==|!=| 5466c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 54723f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 5486c72ffaaSAndy Whitcroft }x; 5496c72ffaaSAndy Whitcroft 55091cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 55191cb5195SJoe Perches 552ab7e23f3SJoe Perchesour $BasicType; 5538905a67cSAndy Whitcroftour $NonptrType; 5541813087dSJoe Perchesour $NonptrTypeMisordered; 5558716de38SJoe Perchesour $NonptrTypeWithAttr; 5568905a67cSAndy Whitcroftour $Type; 5571813087dSJoe Perchesour $TypeMisordered; 5588905a67cSAndy Whitcroftour $Declare; 5591813087dSJoe Perchesour $DeclareMisordered; 5608905a67cSAndy Whitcroft 56115662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 56215662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 563171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 564171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 565171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 566171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 567171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 568171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 569171ae1a4SAndy Whitcroft}x; 570171ae1a4SAndy Whitcroft 57115662b3eSJoe Perchesour $UTF8 = qr{ 57215662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 57315662b3eSJoe Perches | $NON_ASCII_UTF8 57415662b3eSJoe Perches}x; 57515662b3eSJoe Perches 576e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 577021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 578021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 579021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 580021158b4SJoe Perches)}; 581e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 582fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 5838ed22cadSAndy Whitcroft atomic_t 5848ed22cadSAndy Whitcroft)}; 5858ea0114eSMickaël Salaünour $typeStdioTypedefs = qr{(?x: 5868ea0114eSMickaël Salaün FILE 5878ea0114eSMickaël Salaün)}; 588e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 589e6176fa4SJoe Perches $typeC99Typedefs\b| 590e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 5918ea0114eSMickaël Salaün $typeKernelTypedefs\b| 5928ea0114eSMickaël Salaün $typeStdioTypedefs\b 593e6176fa4SJoe Perches)}; 5948ed22cadSAndy Whitcroft 5956d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 5966d32f7a3SJoe Perches 597691e669bSJoe Perchesour $logFunctions = qr{(?x: 598758d7aadSMiles Chen printk(?:_ratelimited|_once|_deferred_once|_deferred|)| 5997d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 60087bd499aSJoe Perches TP_printk| 6016e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 602b0531722SJoe Perches panic| 60306668727SJoe Perches MODULE_[A-Z_]+| 60406668727SJoe Perches seq_vprintf|seq_printf|seq_puts 605691e669bSJoe Perches)}; 606691e669bSJoe Perches 607e29a70f1SJoe Perchesour $allocFunctions = qr{(?x: 608e29a70f1SJoe Perches (?:(?:devm_)? 60958f02267SJoe Perches (?:kv|k|v)[czm]alloc(?:_array)?(?:_node)? | 610e29a70f1SJoe Perches kstrdup(?:_const)? | 611e29a70f1SJoe Perches kmemdup(?:_nul)?) | 612461e1565SChristophe JAILLET (?:\w+)?alloc_skb(?:_ip_align)? | 613e29a70f1SJoe Perches # dev_alloc_skb/netdev_alloc_skb, et al 614e29a70f1SJoe Perches dma_alloc_coherent 615e29a70f1SJoe Perches)}; 616e29a70f1SJoe Perches 61720112475SJoe Perchesour $signature_tags = qr{(?xi: 61820112475SJoe Perches Signed-off-by:| 619d499480cSJorge Ramirez-Ortiz Co-developed-by:| 62020112475SJoe Perches Acked-by:| 62120112475SJoe Perches Tested-by:| 62220112475SJoe Perches Reviewed-by:| 62320112475SJoe Perches Reported-by:| 6248543ae12SMugunthan V N Suggested-by:| 62520112475SJoe Perches To:| 62620112475SJoe Perches Cc: 62720112475SJoe Perches)}; 62820112475SJoe Perches 62944c31888SMatthieu Baertsour @link_tags = qw(Link Closes); 630f94e40eaSMatthieu Baerts 631f94e40eaSMatthieu Baerts#Create a search and print patterns for all these strings to be used directly below 632f94e40eaSMatthieu Baertsour $link_tags_search = ""; 633f94e40eaSMatthieu Baertsour $link_tags_print = ""; 634f94e40eaSMatthieu Baertsforeach my $entry (@link_tags) { 635f94e40eaSMatthieu Baerts if ($link_tags_search ne "") { 636f94e40eaSMatthieu Baerts $link_tags_search .= '|'; 637f94e40eaSMatthieu Baerts $link_tags_print .= ' or '; 638f94e40eaSMatthieu Baerts } 639f94e40eaSMatthieu Baerts $entry .= ':'; 640f94e40eaSMatthieu Baerts $link_tags_search .= $entry; 641f94e40eaSMatthieu Baerts $link_tags_print .= "'$entry'"; 642f94e40eaSMatthieu Baerts} 643f94e40eaSMatthieu Baerts$link_tags_search = "(?:${link_tags_search})"; 644f94e40eaSMatthieu Baerts 645adb2da82SJoe Perchesour $tracing_logging_tags = qr{(?xi: 646adb2da82SJoe Perches [=-]*> | 647adb2da82SJoe Perches <[=-]* | 648adb2da82SJoe Perches \[ | 649adb2da82SJoe Perches \] | 650adb2da82SJoe Perches start | 651adb2da82SJoe Perches called | 652adb2da82SJoe Perches entered | 653adb2da82SJoe Perches entry | 654adb2da82SJoe Perches enter | 655adb2da82SJoe Perches in | 656adb2da82SJoe Perches inside | 657adb2da82SJoe Perches here | 658adb2da82SJoe Perches begin | 659adb2da82SJoe Perches exit | 660adb2da82SJoe Perches end | 661adb2da82SJoe Perches done | 662adb2da82SJoe Perches leave | 663adb2da82SJoe Perches completed | 664adb2da82SJoe Perches out | 665adb2da82SJoe Perches return | 666adb2da82SJoe Perches [\.\!:\s]* 667adb2da82SJoe Perches)}; 668adb2da82SJoe Perches 669831242abSAditya Srivastavasub edit_distance_min { 670831242abSAditya Srivastava my (@arr) = @_; 671831242abSAditya Srivastava my $len = scalar @arr; 672831242abSAditya Srivastava if ((scalar @arr) < 1) { 673831242abSAditya Srivastava # if underflow, return 674831242abSAditya Srivastava return; 675831242abSAditya Srivastava } 676831242abSAditya Srivastava my $min = $arr[0]; 677831242abSAditya Srivastava for my $i (0 .. ($len-1)) { 678831242abSAditya Srivastava if ($arr[$i] < $min) { 679831242abSAditya Srivastava $min = $arr[$i]; 680831242abSAditya Srivastava } 681831242abSAditya Srivastava } 682831242abSAditya Srivastava return $min; 683831242abSAditya Srivastava} 684831242abSAditya Srivastava 685831242abSAditya Srivastavasub get_edit_distance { 686831242abSAditya Srivastava my ($str1, $str2) = @_; 687831242abSAditya Srivastava $str1 = lc($str1); 688831242abSAditya Srivastava $str2 = lc($str2); 689831242abSAditya Srivastava $str1 =~ s/-//g; 690831242abSAditya Srivastava $str2 =~ s/-//g; 691831242abSAditya Srivastava my $len1 = length($str1); 692831242abSAditya Srivastava my $len2 = length($str2); 693831242abSAditya Srivastava # two dimensional array storing minimum edit distance 694831242abSAditya Srivastava my @distance; 695831242abSAditya Srivastava for my $i (0 .. $len1) { 696831242abSAditya Srivastava for my $j (0 .. $len2) { 697831242abSAditya Srivastava if ($i == 0) { 698831242abSAditya Srivastava $distance[$i][$j] = $j; 699831242abSAditya Srivastava } elsif ($j == 0) { 700831242abSAditya Srivastava $distance[$i][$j] = $i; 701831242abSAditya Srivastava } elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) { 702831242abSAditya Srivastava $distance[$i][$j] = $distance[$i - 1][$j - 1]; 703831242abSAditya Srivastava } else { 704831242abSAditya Srivastava my $dist1 = $distance[$i][$j - 1]; #insert distance 705831242abSAditya Srivastava my $dist2 = $distance[$i - 1][$j]; # remove 706831242abSAditya Srivastava my $dist3 = $distance[$i - 1][$j - 1]; #replace 707831242abSAditya Srivastava $distance[$i][$j] = 1 + edit_distance_min($dist1, $dist2, $dist3); 708831242abSAditya Srivastava } 709831242abSAditya Srivastava } 710831242abSAditya Srivastava } 711831242abSAditya Srivastava return $distance[$len1][$len2]; 712831242abSAditya Srivastava} 713831242abSAditya Srivastava 714831242abSAditya Srivastavasub find_standard_signature { 715831242abSAditya Srivastava my ($sign_off) = @_; 716831242abSAditya Srivastava my @standard_signature_tags = ( 717831242abSAditya Srivastava 'Signed-off-by:', 'Co-developed-by:', 'Acked-by:', 'Tested-by:', 718831242abSAditya Srivastava 'Reviewed-by:', 'Reported-by:', 'Suggested-by:' 719831242abSAditya Srivastava ); 720831242abSAditya Srivastava foreach my $signature (@standard_signature_tags) { 721831242abSAditya Srivastava return $signature if (get_edit_distance($sign_off, $signature) <= 2); 722831242abSAditya Srivastava } 723831242abSAditya Srivastava 724831242abSAditya Srivastava return ""; 725831242abSAditya Srivastava} 726831242abSAditya Srivastava 7279b71f79fSBjorn Helgaasour $obsolete_archives = qr{(?xi: 7289b71f79fSBjorn Helgaas \Qfreedesktop.org/archives/dri-devel\E | 7299b71f79fSBjorn Helgaas \Qlists.infradead.org\E | 7309b71f79fSBjorn Helgaas \Qlkml.org\E | 7319b71f79fSBjorn Helgaas \Qmail-archive.com\E | 7329b71f79fSBjorn Helgaas \Qmailman.alsa-project.org/pipermail\E | 7339b71f79fSBjorn Helgaas \Qmarc.info\E | 7349b71f79fSBjorn Helgaas \Qozlabs.org/pipermail\E | 7359b71f79fSBjorn Helgaas \Qspinics.net\E 7369b71f79fSBjorn Helgaas)}; 7379b71f79fSBjorn Helgaas 7381813087dSJoe Perchesour @typeListMisordered = ( 7391813087dSJoe Perches qr{char\s+(?:un)?signed}, 7401813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 7411813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 7421813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 7431813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 7441813087dSJoe Perches qr{short\s+(?:un)?signed}, 7451813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 7461813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 7471813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 7481813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 7491813087dSJoe Perches qr{int\s+(?:un)?signed}, 7501813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 7511813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 7521813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 7531813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 7541813087dSJoe Perches qr{long\s+(?:un)?signed}, 7551813087dSJoe Perches); 7561813087dSJoe Perches 7578905a67cSAndy Whitcroftour @typeList = ( 7588905a67cSAndy Whitcroft qr{void}, 7590c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 7600c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 7610c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 7620c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 7630c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 7640c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 7650c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 7660c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 7670c773d9dSJoe Perches qr{(?:un)?signed}, 7688905a67cSAndy Whitcroft qr{float}, 7698905a67cSAndy Whitcroft qr{double}, 7708905a67cSAndy Whitcroft qr{bool}, 7718905a67cSAndy Whitcroft qr{struct\s+$Ident}, 7728905a67cSAndy Whitcroft qr{union\s+$Ident}, 7738905a67cSAndy Whitcroft qr{enum\s+$Ident}, 7748905a67cSAndy Whitcroft qr{${Ident}_t}, 7758905a67cSAndy Whitcroft qr{${Ident}_handler}, 7768905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 7771813087dSJoe Perches @typeListMisordered, 7788905a67cSAndy Whitcroft); 779938224b5SJoe Perches 780938224b5SJoe Perchesour $C90_int_types = qr{(?x: 781938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 782938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 783938224b5SJoe Perches long\s+long\s+(?:un)?signed| 784938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 785938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 786938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 787938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 788938224b5SJoe Perches 789938224b5SJoe Perches long\s+int\s+(?:un)?signed| 790938224b5SJoe Perches long\s+(?:un)?signed\s+int| 791938224b5SJoe Perches long\s+(?:un)?signed| 792938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 793938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 794938224b5SJoe Perches int\s+long\s+(?:un)?signed| 795938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 796938224b5SJoe Perches 797938224b5SJoe Perches int\s+(?:un)?signed| 798938224b5SJoe Perches (?:(?:un)?signed\s+)?int 799938224b5SJoe Perches)}; 800938224b5SJoe Perches 801485ff23eSAlex Dowadour @typeListFile = (); 8028716de38SJoe Perchesour @typeListWithAttr = ( 8038716de38SJoe Perches @typeList, 8048716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 8058716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 8068716de38SJoe Perches); 8078716de38SJoe Perches 808c45dcabdSAndy Whitcroftour @modifierList = ( 809c45dcabdSAndy Whitcroft qr{fastcall}, 810c45dcabdSAndy Whitcroft); 811485ff23eSAlex Dowadour @modifierListFile = (); 8128905a67cSAndy Whitcroft 8132435880fSJoe Perchesour @mode_permission_funcs = ( 8142435880fSJoe Perches ["module_param", 3], 8152435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 8162435880fSJoe Perches ["module_param_array_named", 5], 8172435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 8182435880fSJoe Perches ["proc_create(?:_data|)", 2], 819459cf0aeSJoe Perches ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2], 820459cf0aeSJoe Perches ["IIO_DEV_ATTR_[A-Z_]+", 1], 821459cf0aeSJoe Perches ["SENSOR_(?:DEVICE_|)ATTR_2", 2], 822459cf0aeSJoe Perches ["SENSOR_TEMPLATE(?:_2|)", 3], 823459cf0aeSJoe Perches ["__ATTR", 2], 8242435880fSJoe Perches); 8252435880fSJoe Perches 8261a3dcf2eSJoe Perchesmy $word_pattern = '\b[A-Z]?[a-z]{2,}\b'; 8271a3dcf2eSJoe Perches 828515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 829515a235eSJoe Perchesour $mode_perms_search = ""; 830515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 831515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 832515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 833515a235eSJoe Perches} 83400180468SJoe Perches$mode_perms_search = "(?:${mode_perms_search})"; 835515a235eSJoe Perches 8369189c7e7SJoe Perchesour %deprecated_apis = ( 8379189c7e7SJoe Perches "synchronize_rcu_bh" => "synchronize_rcu", 8389189c7e7SJoe Perches "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited", 8399189c7e7SJoe Perches "call_rcu_bh" => "call_rcu", 8409189c7e7SJoe Perches "rcu_barrier_bh" => "rcu_barrier", 8419189c7e7SJoe Perches "synchronize_sched" => "synchronize_rcu", 8429189c7e7SJoe Perches "synchronize_sched_expedited" => "synchronize_rcu_expedited", 8439189c7e7SJoe Perches "call_rcu_sched" => "call_rcu", 8449189c7e7SJoe Perches "rcu_barrier_sched" => "rcu_barrier", 8459189c7e7SJoe Perches "get_state_synchronize_sched" => "get_state_synchronize_rcu", 8469189c7e7SJoe Perches "cond_synchronize_sched" => "cond_synchronize_rcu", 847defdaff1SIra Weiny "kmap" => "kmap_local_page", 848a3ea42ffSIra Weiny "kunmap" => "kunmap_local", 849defdaff1SIra Weiny "kmap_atomic" => "kmap_local_page", 850a3ea42ffSIra Weiny "kunmap_atomic" => "kunmap_local", 8519189c7e7SJoe Perches); 8529189c7e7SJoe Perches 8539189c7e7SJoe Perches#Create a search pattern for all these strings to speed up a loop below 8549189c7e7SJoe Perchesour $deprecated_apis_search = ""; 8559189c7e7SJoe Perchesforeach my $entry (keys %deprecated_apis) { 8569189c7e7SJoe Perches $deprecated_apis_search .= '|' if ($deprecated_apis_search ne ""); 8579189c7e7SJoe Perches $deprecated_apis_search .= $entry; 8589189c7e7SJoe Perches} 8599189c7e7SJoe Perches$deprecated_apis_search = "(?:${deprecated_apis_search})"; 8609189c7e7SJoe Perches 861b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 862b392c64fSJoe Perches S_IWUGO | 863b392c64fSJoe Perches S_IWOTH | 864b392c64fSJoe Perches S_IRWXUGO | 865b392c64fSJoe Perches S_IALLUGO | 866b392c64fSJoe Perches 0[0-7][0-7][2367] 867b392c64fSJoe Perches}x; 868b392c64fSJoe Perches 869f90774e1SJoe Perchesour %mode_permission_string_types = ( 870f90774e1SJoe Perches "S_IRWXU" => 0700, 871f90774e1SJoe Perches "S_IRUSR" => 0400, 872f90774e1SJoe Perches "S_IWUSR" => 0200, 873f90774e1SJoe Perches "S_IXUSR" => 0100, 874f90774e1SJoe Perches "S_IRWXG" => 0070, 875f90774e1SJoe Perches "S_IRGRP" => 0040, 876f90774e1SJoe Perches "S_IWGRP" => 0020, 877f90774e1SJoe Perches "S_IXGRP" => 0010, 878f90774e1SJoe Perches "S_IRWXO" => 0007, 879f90774e1SJoe Perches "S_IROTH" => 0004, 880f90774e1SJoe Perches "S_IWOTH" => 0002, 881f90774e1SJoe Perches "S_IXOTH" => 0001, 882f90774e1SJoe Perches "S_IRWXUGO" => 0777, 883f90774e1SJoe Perches "S_IRUGO" => 0444, 884f90774e1SJoe Perches "S_IWUGO" => 0222, 885f90774e1SJoe Perches "S_IXUGO" => 0111, 886f90774e1SJoe Perches); 887f90774e1SJoe Perches 888f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below 889f90774e1SJoe Perchesour $mode_perms_string_search = ""; 890f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) { 891f90774e1SJoe Perches $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); 892f90774e1SJoe Perches $mode_perms_string_search .= $entry; 893f90774e1SJoe Perches} 89400180468SJoe Perchesour $single_mode_perms_string_search = "(?:${mode_perms_string_search})"; 89500180468SJoe Perchesour $multi_mode_perms_string_search = qr{ 89600180468SJoe Perches ${single_mode_perms_string_search} 89700180468SJoe Perches (?:\s*\|\s*${single_mode_perms_string_search})* 89800180468SJoe Perches}x; 89900180468SJoe Perches 90000180468SJoe Perchessub perms_to_octal { 90100180468SJoe Perches my ($string) = @_; 90200180468SJoe Perches 90300180468SJoe Perches return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/); 90400180468SJoe Perches 90500180468SJoe Perches my $val = ""; 90600180468SJoe Perches my $oval = ""; 90700180468SJoe Perches my $to = 0; 90800180468SJoe Perches my $curpos = 0; 90900180468SJoe Perches my $lastpos = 0; 91000180468SJoe Perches while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) { 91100180468SJoe Perches $curpos = pos($string); 91200180468SJoe Perches my $match = $2; 91300180468SJoe Perches my $omatch = $1; 91400180468SJoe Perches last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos)); 91500180468SJoe Perches $lastpos = $curpos; 91600180468SJoe Perches $to |= $mode_permission_string_types{$match}; 91700180468SJoe Perches $val .= '\s*\|\s*' if ($val ne ""); 91800180468SJoe Perches $val .= $match; 91900180468SJoe Perches $oval .= $omatch; 92000180468SJoe Perches } 92100180468SJoe Perches $oval =~ s/^\s*\|\s*//; 92200180468SJoe Perches $oval =~ s/\s*\|\s*$//; 92300180468SJoe Perches return sprintf("%04o", $to); 92400180468SJoe Perches} 925f90774e1SJoe Perches 9267840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 9277840a94cSWolfram Sang irq| 928cdcee686SSergey Ryazanov memory| 929cdcee686SSergey Ryazanov time| 930cdcee686SSergey Ryazanov reboot 9317840a94cSWolfram Sang)}; 9327840a94cSWolfram Sang# memory.h: ARM has a custom one 9337840a94cSWolfram Sang 93466b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 93566b47b4aSKees Cookmy $misspellings; 93666b47b4aSKees Cookmy %spelling_fix; 93736061e38SJoe Perches 93836061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 93966b47b4aSKees Cook while (<$spelling>) { 94066b47b4aSKees Cook my $line = $_; 94166b47b4aSKees Cook 94266b47b4aSKees Cook $line =~ s/\s*\n?$//g; 94366b47b4aSKees Cook $line =~ s/^\s*//g; 94466b47b4aSKees Cook 94566b47b4aSKees Cook next if ($line =~ m/^\s*#/); 94666b47b4aSKees Cook next if ($line =~ m/^\s*$/); 94766b47b4aSKees Cook 94866b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 94966b47b4aSKees Cook 95066b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 95166b47b4aSKees Cook } 95266b47b4aSKees Cook close($spelling); 95336061e38SJoe Perches} else { 95436061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 95536061e38SJoe Perches} 95666b47b4aSKees Cook 957ebfd7d62SJoe Perchesif ($codespell) { 958ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 959ebfd7d62SJoe Perches while (<$spelling>) { 960ebfd7d62SJoe Perches my $line = $_; 961ebfd7d62SJoe Perches 962ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 963ebfd7d62SJoe Perches $line =~ s/^\s*//g; 964ebfd7d62SJoe Perches 965ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 966ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 967ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 968ebfd7d62SJoe Perches 969ebfd7d62SJoe Perches $line =~ s/,.*$//; 970ebfd7d62SJoe Perches 971ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 972ebfd7d62SJoe Perches 973ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 974ebfd7d62SJoe Perches } 975ebfd7d62SJoe Perches close($spelling); 976ebfd7d62SJoe Perches } else { 977ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 978ebfd7d62SJoe Perches } 979ebfd7d62SJoe Perches} 980ebfd7d62SJoe Perches 981ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 982ebfd7d62SJoe Perches 98375ad8c57SJerome Forissiersub read_words { 98475ad8c57SJerome Forissier my ($wordsRef, $file) = @_; 98575ad8c57SJerome Forissier 98675ad8c57SJerome Forissier if (open(my $words, '<', $file)) { 98775ad8c57SJerome Forissier while (<$words>) { 988bf1fa1daSJoe Perches my $line = $_; 989bf1fa1daSJoe Perches 990bf1fa1daSJoe Perches $line =~ s/\s*\n?$//g; 991bf1fa1daSJoe Perches $line =~ s/^\s*//g; 992bf1fa1daSJoe Perches 993bf1fa1daSJoe Perches next if ($line =~ m/^\s*#/); 994bf1fa1daSJoe Perches next if ($line =~ m/^\s*$/); 995bf1fa1daSJoe Perches if ($line =~ /\s/) { 99675ad8c57SJerome Forissier print("$file: '$line' invalid - ignored\n"); 997bf1fa1daSJoe Perches next; 998bf1fa1daSJoe Perches } 999bf1fa1daSJoe Perches 1000ced69da1SQuentin Monnet $$wordsRef .= '|' if (defined $$wordsRef); 100175ad8c57SJerome Forissier $$wordsRef .= $line; 1002bf1fa1daSJoe Perches } 100375ad8c57SJerome Forissier close($file); 100475ad8c57SJerome Forissier return 1; 1005bf1fa1daSJoe Perches } 1006bf1fa1daSJoe Perches 100775ad8c57SJerome Forissier return 0; 100875ad8c57SJerome Forissier} 100975ad8c57SJerome Forissier 1010ced69da1SQuentin Monnetmy $const_structs; 1011ced69da1SQuentin Monnetif (show_type("CONST_STRUCT")) { 101275ad8c57SJerome Forissier read_words(\$const_structs, $conststructsfile) 101375ad8c57SJerome Forissier or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 1014ced69da1SQuentin Monnet} 101575ad8c57SJerome Forissier 1016ced69da1SQuentin Monnetif (defined($typedefsfile)) { 1017ced69da1SQuentin Monnet my $typeOtherTypedefs; 101875ad8c57SJerome Forissier read_words(\$typeOtherTypedefs, $typedefsfile) 101975ad8c57SJerome Forissier or warn "No additional types will be considered - file '$typedefsfile': $!\n"; 1020ced69da1SQuentin Monnet $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs); 102175ad8c57SJerome Forissier} 102275ad8c57SJerome Forissier 10238905a67cSAndy Whitcroftsub build_types { 1024485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 1025485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 10261813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 10278716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 1028c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 1029ab7e23f3SJoe Perches $BasicType = qr{ 1030ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 1031ab7e23f3SJoe Perches (?:${all}\b) 1032ab7e23f3SJoe Perches }x; 10338905a67cSAndy Whitcroft $NonptrType = qr{ 1034d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 1035cf655043SAndy Whitcroft (?: 10366b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 10378ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 1038c45dcabdSAndy Whitcroft (?:${all}\b) 1039cf655043SAndy Whitcroft ) 1040c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 10418905a67cSAndy Whitcroft }x; 10421813087dSJoe Perches $NonptrTypeMisordered = qr{ 10431813087dSJoe Perches (?:$Modifier\s+|const\s+)* 10441813087dSJoe Perches (?: 10451813087dSJoe Perches (?:${Misordered}\b) 10461813087dSJoe Perches ) 10471813087dSJoe Perches (?:\s+$Modifier|\s+const)* 10481813087dSJoe Perches }x; 10498716de38SJoe Perches $NonptrTypeWithAttr = qr{ 10508716de38SJoe Perches (?:$Modifier\s+|const\s+)* 10518716de38SJoe Perches (?: 10528716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 10538716de38SJoe Perches (?:$typeTypedefs\b)| 10548716de38SJoe Perches (?:${allWithAttr}\b) 10558716de38SJoe Perches ) 10568716de38SJoe Perches (?:\s+$Modifier|\s+const)* 10578716de38SJoe Perches }x; 10588905a67cSAndy Whitcroft $Type = qr{ 1059c45dcabdSAndy Whitcroft $NonptrType 10607b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 1061c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 10628905a67cSAndy Whitcroft }x; 10631813087dSJoe Perches $TypeMisordered = qr{ 10641813087dSJoe Perches $NonptrTypeMisordered 10657b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 10661813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 10671813087dSJoe Perches }x; 106891cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 10691813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 10708905a67cSAndy Whitcroft} 10718905a67cSAndy Whitcroftbuild_types(); 10726c72ffaaSAndy Whitcroft 10737d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 1074d1fe9c09SJoe Perches 1075d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 1076d1fe9c09SJoe Perches# requires at least perl version v5.10.0 1077d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 1078d1fe9c09SJoe Perches 1079d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 10802435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 1081c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 10827d2367afSJoe Perches 1083f8422308SJoe Perchesour $declaration_macros = qr{(?x: 10843e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 1085fe658f94SSteffen Maier (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(| 1086dcea7964SJoe Perches (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(| 1087dcea7964SJoe Perches (?:$Storage\s+)?(?:XA_STATE|XA_STATE_ORDER)\s*\( 1088f8422308SJoe Perches)}; 1089f8422308SJoe Perches 10908d0325ccSAditya Srivastavaour %allow_repeated_words = ( 10918d0325ccSAditya Srivastava add => '', 10928d0325ccSAditya Srivastava added => '', 10938d0325ccSAditya Srivastava bad => '', 10948d0325ccSAditya Srivastava be => '', 10958d0325ccSAditya Srivastava); 10968d0325ccSAditya Srivastava 10977d2367afSJoe Perchessub deparenthesize { 10987d2367afSJoe Perches my ($string) = @_; 10997d2367afSJoe Perches return "" if (!defined($string)); 11005b9553abSJoe Perches 11015b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 11025b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 11035b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 11045b9553abSJoe Perches } 11055b9553abSJoe Perches 11067d2367afSJoe Perches $string =~ s@\s+@ @g; 11075b9553abSJoe Perches 11087d2367afSJoe Perches return $string; 11097d2367afSJoe Perches} 11107d2367afSJoe Perches 11113445686aSJoe Perchessub seed_camelcase_file { 11123445686aSJoe Perches my ($file) = @_; 11133445686aSJoe Perches 11143445686aSJoe Perches return if (!(-f $file)); 11153445686aSJoe Perches 11163445686aSJoe Perches local $/; 11173445686aSJoe Perches 11183445686aSJoe Perches open(my $include_file, '<', "$file") 11193445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 11203445686aSJoe Perches my $text = <$include_file>; 11213445686aSJoe Perches close($include_file); 11223445686aSJoe Perches 11233445686aSJoe Perches my @lines = split('\n', $text); 11243445686aSJoe Perches 11253445686aSJoe Perches foreach my $line (@lines) { 11263445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 11273445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 11283445686aSJoe Perches $camelcase{$1} = 1; 112911ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 113011ea516aSJoe Perches $camelcase{$1} = 1; 113111ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 11323445686aSJoe Perches $camelcase{$1} = 1; 11333445686aSJoe Perches } 11343445686aSJoe Perches } 11353445686aSJoe Perches} 11363445686aSJoe Perches 1137cd28b119SJoe Perchesour %maintained_status = (); 1138cd28b119SJoe Perches 113985b0ee18SJoe Perchessub is_maintained_obsolete { 114085b0ee18SJoe Perches my ($filename) = @_; 114185b0ee18SJoe Perches 1142f2c19c2fSJerome Forissier return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 114385b0ee18SJoe Perches 1144cd28b119SJoe Perches if (!exists($maintained_status{$filename})) { 1145cd28b119SJoe Perches $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 1146cd28b119SJoe Perches } 114785b0ee18SJoe Perches 1148cd28b119SJoe Perches return $maintained_status{$filename} =~ /obsolete/i; 114985b0ee18SJoe Perches} 115085b0ee18SJoe Perches 11513b6e8ac9SJoe Perchessub is_SPDX_License_valid { 11523b6e8ac9SJoe Perches my ($license) = @_; 11533b6e8ac9SJoe Perches 1154f9363b31SGuenter Roeck return 1 if (!$tree || which("python3") eq "" || !(-x "$root/scripts/spdxcheck.py") || !(-e "$gitroot")); 11553b6e8ac9SJoe Perches 115656294112SJoe Perches my $root_path = abs_path($root); 1157f9363b31SGuenter Roeck my $status = `cd "$root_path"; echo "$license" | scripts/spdxcheck.py -`; 11583b6e8ac9SJoe Perches return 0 if ($status ne ""); 11593b6e8ac9SJoe Perches return 1; 11603b6e8ac9SJoe Perches} 11613b6e8ac9SJoe Perches 11623445686aSJoe Perchesmy $camelcase_seeded = 0; 11633445686aSJoe Perchessub seed_camelcase_includes { 11643445686aSJoe Perches return if ($camelcase_seeded); 11653445686aSJoe Perches 11663445686aSJoe Perches my $files; 1167c707a81dSJoe Perches my $camelcase_cache = ""; 1168c707a81dSJoe Perches my @include_files = (); 1169c707a81dSJoe Perches 1170c707a81dSJoe Perches $camelcase_seeded = 1; 1171351b2a1fSJoe Perches 11720f7f635bSJoe Perches if (-e "$gitroot") { 1173dbbf869dSJoe Perches my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`; 1174351b2a1fSJoe Perches chomp $git_last_include_commit; 1175c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 1176c707a81dSJoe Perches } else { 1177c707a81dSJoe Perches my $last_mod_date = 0; 1178c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 1179c707a81dSJoe Perches @include_files = split('\n', $files); 1180c707a81dSJoe Perches foreach my $file (@include_files) { 1181c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 1182c707a81dSJoe Perches localtime((stat $file)[9])); 1183c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 1184c707a81dSJoe Perches } 1185c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 1186c707a81dSJoe Perches } 1187c707a81dSJoe Perches 1188c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 1189c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 1190c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 1191351b2a1fSJoe Perches while (<$camelcase_file>) { 1192351b2a1fSJoe Perches chomp; 1193351b2a1fSJoe Perches $camelcase{$_} = 1; 1194351b2a1fSJoe Perches } 1195351b2a1fSJoe Perches close($camelcase_file); 1196351b2a1fSJoe Perches 1197351b2a1fSJoe Perches return; 1198351b2a1fSJoe Perches } 1199c707a81dSJoe Perches 12000f7f635bSJoe Perches if (-e "$gitroot") { 1201dbbf869dSJoe Perches $files = `${git_command} ls-files "include/*.h"`; 1202c707a81dSJoe Perches @include_files = split('\n', $files); 12033445686aSJoe Perches } 1204c707a81dSJoe Perches 12053445686aSJoe Perches foreach my $file (@include_files) { 12063445686aSJoe Perches seed_camelcase_file($file); 12073445686aSJoe Perches } 1208351b2a1fSJoe Perches 1209c707a81dSJoe Perches if ($camelcase_cache ne "") { 1210351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 1211c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 1212c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 1213351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 1214351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 1215351b2a1fSJoe Perches } 1216351b2a1fSJoe Perches close($camelcase_file); 1217351b2a1fSJoe Perches } 12183445686aSJoe Perches} 12193445686aSJoe Perches 1220f5f61325SJoe Perchessub git_is_single_file { 1221f5f61325SJoe Perches my ($filename) = @_; 1222f5f61325SJoe Perches 1223f5f61325SJoe Perches return 0 if ((which("git") eq "") || !(-e "$gitroot")); 1224f5f61325SJoe Perches 1225f5f61325SJoe Perches my $output = `${git_command} ls-files -- $filename 2>/dev/null`; 1226f5f61325SJoe Perches my $count = $output =~ tr/\n//; 1227f5f61325SJoe Perches return $count eq 1 && $output =~ m{^${filename}$}; 1228f5f61325SJoe Perches} 1229f5f61325SJoe Perches 1230d311cd44SJoe Perchessub git_commit_info { 1231d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 1232d311cd44SJoe Perches 12330f7f635bSJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot")); 1234d311cd44SJoe Perches 1235dbbf869dSJoe Perches my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`; 1236d311cd44SJoe Perches $output =~ s/^\s*//gm; 1237d311cd44SJoe Perches my @lines = split("\n", $output); 1238d311cd44SJoe Perches 12390d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 12400d7835fcSJoe Perches 12415a7f4455SSean Christopherson if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) { 1242d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 1243d311cd44SJoe Perches# all matching commit ids, but it's very slow... 1244d311cd44SJoe Perches# 1245d311cd44SJoe Perches# echo "checking commits $1..." 1246d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 1247d311cd44SJoe Perches# while read line ; do 1248d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 1249d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 1250d311cd44SJoe Perches# done 12514ce9f970SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./ || 12524ce9f970SJoe Perches $lines[0] =~ /^fatal: bad object $commit/) { 1253948b133aSHeinrich Schuchardt $id = undef; 1254d311cd44SJoe Perches } else { 1255d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 1256d311cd44SJoe Perches $desc = substr($lines[0], 41); 1257d311cd44SJoe Perches } 1258d311cd44SJoe Perches 1259d311cd44SJoe Perches return ($id, $desc); 1260d311cd44SJoe Perches} 1261d311cd44SJoe Perches 12626c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 1263d5d6281aSDan Carpenter$chk_fixes_tag = 0 if ($file); 12640a920b5bSAndy Whitcroft 126500df344fSAndy Whitcroftmy @rawlines = (); 1266c2fdda0dSAndy Whitcroftmy @lines = (); 12673705ce5bSJoe Perchesmy @fixed = (); 1268d752fcc8SJoe Perchesmy @fixed_inserted = (); 1269d752fcc8SJoe Perchesmy @fixed_deleted = (); 1270194f66fcSJoe Perchesmy $fixlinenr = -1; 1271194f66fcSJoe Perches 12724a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 12734a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 12740f7f635bSJoe Perchesdie "$P: No git repository found\n" if ($git && !-e "$gitroot"); 12754a593c34SDu, Changbin 12764a593c34SDu, Changbinif ($git) { 12774a593c34SDu, Changbin my @commits = (); 12780dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 12794a593c34SDu, Changbin my $git_range; 128028898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 128128898fd1SJoe Perches $git_range = "-$2 $1"; 12824a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 12834a593c34SDu, Changbin $git_range = "$commit_expr"; 12844a593c34SDu, Changbin } else { 12850dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 12860dea9f1eSJoe Perches } 1287dbbf869dSJoe Perches my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 12880dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 128928898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 129028898fd1SJoe Perches next if (!defined($1) || !defined($2)); 12910dea9f1eSJoe Perches my $sha1 = $1; 12920dea9f1eSJoe Perches my $subject = $2; 12930dea9f1eSJoe Perches unshift(@commits, $sha1); 12940dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 12954a593c34SDu, Changbin } 12964a593c34SDu, Changbin } 12974a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 12984a593c34SDu, Changbin @ARGV = @commits; 12994a593c34SDu, Changbin} 13004a593c34SDu, Changbin 1301c2fdda0dSAndy Whitcroftmy $vname; 130298005e8cSVadim Bendebury$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"}; 13036c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 130421caa13cSAndy Whitcroft my $FILE; 1305f5f61325SJoe Perches my $is_git_file = git_is_single_file($filename); 1306f5f61325SJoe Perches my $oldfile = $file; 1307f5f61325SJoe Perches $file = 1 if ($is_git_file); 13084a593c34SDu, Changbin if ($git) { 13094a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 13104a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 13114a593c34SDu, Changbin } elsif ($file) { 131221caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 13136c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 131421caa13cSAndy Whitcroft } elsif ($filename eq '-') { 131521caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 13166c72ffaaSAndy Whitcroft } else { 131721caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 13186c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 13196c72ffaaSAndy Whitcroft } 1320c2fdda0dSAndy Whitcroft if ($filename eq '-') { 1321c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 13224a593c34SDu, Changbin } elsif ($git) { 13230dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 1324c2fdda0dSAndy Whitcroft } else { 1325c2fdda0dSAndy Whitcroft $vname = $filename; 1326c2fdda0dSAndy Whitcroft } 132721caa13cSAndy Whitcroft while (<$FILE>) { 13280a920b5bSAndy Whitcroft chomp; 132900df344fSAndy Whitcroft push(@rawlines, $_); 1330c7f574d0SGeert Uytterhoeven $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i); 13316c72ffaaSAndy Whitcroft } 133221caa13cSAndy Whitcroft close($FILE); 1333d8469f16SJoe Perches 1334d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 1335d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1336d8469f16SJoe Perches print "$vname\n"; 1337d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1338d8469f16SJoe Perches } 1339d8469f16SJoe Perches 1340c2fdda0dSAndy Whitcroft if (!process($filename)) { 13410a920b5bSAndy Whitcroft $exit = 1; 13420a920b5bSAndy Whitcroft } 134300df344fSAndy Whitcroft @rawlines = (); 134413214adfSAndy Whitcroft @lines = (); 13453705ce5bSJoe Perches @fixed = (); 1346d752fcc8SJoe Perches @fixed_inserted = (); 1347d752fcc8SJoe Perches @fixed_deleted = (); 1348194f66fcSJoe Perches $fixlinenr = -1; 1349485ff23eSAlex Dowad @modifierListFile = (); 1350485ff23eSAlex Dowad @typeListFile = (); 1351485ff23eSAlex Dowad build_types(); 1352f5f61325SJoe Perches $file = $oldfile if ($is_git_file); 13530a920b5bSAndy Whitcroft} 13540a920b5bSAndy Whitcroft 1355d8469f16SJoe Perchesif (!$quiet) { 13563c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 13573c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 13583c816e49SJoe Perches 13595b57980dSJoe Perches if (!$perl_version_ok) { 1360d8469f16SJoe Perches print << "EOM" 1361d8469f16SJoe Perches 1362d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 13635b57980dSJoe Perches An upgrade to at least perl $minimum_perl_version is suggested. 1364d8469f16SJoe PerchesEOM 1365d8469f16SJoe Perches } 1366d8469f16SJoe Perches if ($exit) { 1367d8469f16SJoe Perches print << "EOM" 1368d8469f16SJoe Perches 1369d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 1370d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 1371d8469f16SJoe PerchesEOM 1372d8469f16SJoe Perches } 1373d8469f16SJoe Perches} 1374d8469f16SJoe Perches 13750a920b5bSAndy Whitcroftexit($exit); 13760a920b5bSAndy Whitcroft 13770a920b5bSAndy Whitcroftsub top_of_kernel_tree { 13786c72ffaaSAndy Whitcroft my ($root) = @_; 13796c72ffaaSAndy Whitcroft 13806c72ffaaSAndy Whitcroft my @tree_check = ( 13816c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 13826c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 13836c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 13846c72ffaaSAndy Whitcroft ); 13856c72ffaaSAndy Whitcroft 13866c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 13876c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 13880a920b5bSAndy Whitcroft return 0; 13890a920b5bSAndy Whitcroft } 13906c72ffaaSAndy Whitcroft } 13916c72ffaaSAndy Whitcroft return 1; 13926c72ffaaSAndy Whitcroft} 13930a920b5bSAndy Whitcroft 139420112475SJoe Perchessub parse_email { 139520112475SJoe Perches my ($formatted_email) = @_; 139620112475SJoe Perches 139720112475SJoe Perches my $name = ""; 1398fccaebf0SDwaipayan Ray my $quoted = ""; 1399dfa05c28SJoe Perches my $name_comment = ""; 140020112475SJoe Perches my $address = ""; 140120112475SJoe Perches my $comment = ""; 140220112475SJoe Perches 140320112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 140420112475SJoe Perches $name = $1; 140520112475SJoe Perches $address = $2; 140620112475SJoe Perches $comment = $3 if defined $3; 140720112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 140820112475SJoe Perches $address = $1; 140920112475SJoe Perches $comment = $2 if defined $2; 141020112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 141120112475SJoe Perches $address = $1; 141220112475SJoe Perches $comment = $2 if defined $2; 141385e12066SJoe Perches $formatted_email =~ s/\Q$address\E.*$//; 141420112475SJoe Perches $name = $formatted_email; 14153705ce5bSJoe Perches $name = trim($name); 141620112475SJoe Perches $name =~ s/^\"|\"$//g; 141720112475SJoe Perches # If there's a name left after stripping spaces and 141820112475SJoe Perches # leading quotes, and the address doesn't have both 141920112475SJoe Perches # leading and trailing angle brackets, the address 142020112475SJoe Perches # is invalid. ie: 142120112475SJoe Perches # "joe smith [email protected]" bad 142220112475SJoe Perches # "joe smith <[email protected]" bad 142320112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 142420112475SJoe Perches $name = ""; 142520112475SJoe Perches $address = ""; 142620112475SJoe Perches $comment = ""; 142720112475SJoe Perches } 142820112475SJoe Perches } 142920112475SJoe Perches 1430fccaebf0SDwaipayan Ray # Extract comments from names excluding quoted parts 1431fccaebf0SDwaipayan Ray # "John D. (Doe)" - Do not extract 1432fccaebf0SDwaipayan Ray if ($name =~ s/\"(.+)\"//) { 1433fccaebf0SDwaipayan Ray $quoted = $1; 1434dfa05c28SJoe Perches } 1435fccaebf0SDwaipayan Ray while ($name =~ s/\s*($balanced_parens)\s*/ /) { 1436fccaebf0SDwaipayan Ray $name_comment .= trim($1); 1437fccaebf0SDwaipayan Ray } 1438fccaebf0SDwaipayan Ray $name =~ s/^[ \"]+|[ \"]+$//g; 1439fccaebf0SDwaipayan Ray $name = trim("$quoted $name"); 1440fccaebf0SDwaipayan Ray 14413705ce5bSJoe Perches $address = trim($address); 144220112475SJoe Perches $address =~ s/^\<|\>$//g; 1443fccaebf0SDwaipayan Ray $comment = trim($comment); 144420112475SJoe Perches 144520112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 144620112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 144720112475SJoe Perches $name = "\"$name\""; 144820112475SJoe Perches } 144920112475SJoe Perches 1450dfa05c28SJoe Perches return ($name, $name_comment, $address, $comment); 145120112475SJoe Perches} 145220112475SJoe Perches 145320112475SJoe Perchessub format_email { 145448ca2d8aSDwaipayan Ray my ($name, $name_comment, $address, $comment) = @_; 145520112475SJoe Perches 145620112475SJoe Perches my $formatted_email; 145720112475SJoe Perches 1458fccaebf0SDwaipayan Ray $name =~ s/^[ \"]+|[ \"]+$//g; 14593705ce5bSJoe Perches $address = trim($address); 1460fccaebf0SDwaipayan Ray $address =~ s/(?:\.|\,|\")+$//; ##trailing commas, dots or quotes 146120112475SJoe Perches 146220112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 146320112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 146420112475SJoe Perches $name = "\"$name\""; 146520112475SJoe Perches } 146620112475SJoe Perches 1467fccaebf0SDwaipayan Ray $name_comment = trim($name_comment); 1468fccaebf0SDwaipayan Ray $name_comment = " $name_comment" if ($name_comment ne ""); 1469fccaebf0SDwaipayan Ray $comment = trim($comment); 1470fccaebf0SDwaipayan Ray $comment = " $comment" if ($comment ne ""); 1471fccaebf0SDwaipayan Ray 147220112475SJoe Perches if ("$name" eq "") { 147320112475SJoe Perches $formatted_email = "$address"; 147420112475SJoe Perches } else { 147548ca2d8aSDwaipayan Ray $formatted_email = "$name$name_comment <$address>"; 147620112475SJoe Perches } 147748ca2d8aSDwaipayan Ray $formatted_email .= "$comment"; 147820112475SJoe Perches return $formatted_email; 147920112475SJoe Perches} 148020112475SJoe Perches 1481dfa05c28SJoe Perchessub reformat_email { 1482dfa05c28SJoe Perches my ($email) = @_; 1483dfa05c28SJoe Perches 1484dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 148548ca2d8aSDwaipayan Ray return format_email($email_name, $name_comment, $email_address, $comment); 1486dfa05c28SJoe Perches} 1487dfa05c28SJoe Perches 1488dfa05c28SJoe Perchessub same_email_addresses { 1489fccaebf0SDwaipayan Ray my ($email1, $email2) = @_; 1490dfa05c28SJoe Perches 1491dfa05c28SJoe Perches my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1); 1492dfa05c28SJoe Perches my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2); 1493dfa05c28SJoe Perches 149448ca2d8aSDwaipayan Ray return $email1_name eq $email2_name && 149548ca2d8aSDwaipayan Ray $email1_address eq $email2_address && 149648ca2d8aSDwaipayan Ray $name1_comment eq $name2_comment && 149748ca2d8aSDwaipayan Ray $comment1 eq $comment2; 149848ca2d8aSDwaipayan Ray} 1499dfa05c28SJoe Perches 1500d311cd44SJoe Perchessub which { 1501d311cd44SJoe Perches my ($bin) = @_; 1502d311cd44SJoe Perches 1503d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1504d311cd44SJoe Perches if (-e "$path/$bin") { 1505d311cd44SJoe Perches return "$path/$bin"; 1506d311cd44SJoe Perches } 1507d311cd44SJoe Perches } 1508d311cd44SJoe Perches 1509d311cd44SJoe Perches return ""; 1510d311cd44SJoe Perches} 1511d311cd44SJoe Perches 1512000d1cc1SJoe Perchessub which_conf { 1513000d1cc1SJoe Perches my ($conf) = @_; 1514000d1cc1SJoe Perches 1515000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1516000d1cc1SJoe Perches if (-e "$path/$conf") { 1517000d1cc1SJoe Perches return "$path/$conf"; 1518000d1cc1SJoe Perches } 1519000d1cc1SJoe Perches } 1520000d1cc1SJoe Perches 1521000d1cc1SJoe Perches return ""; 1522000d1cc1SJoe Perches} 1523000d1cc1SJoe Perches 15240a920b5bSAndy Whitcroftsub expand_tabs { 15250a920b5bSAndy Whitcroft my ($str) = @_; 15260a920b5bSAndy Whitcroft 15270a920b5bSAndy Whitcroft my $res = ''; 15280a920b5bSAndy Whitcroft my $n = 0; 15290a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 15300a920b5bSAndy Whitcroft if ($c eq "\t") { 15310a920b5bSAndy Whitcroft $res .= ' '; 15320a920b5bSAndy Whitcroft $n++; 1533713a09deSAntonio Borneo for (; ($n % $tabsize) != 0; $n++) { 15340a920b5bSAndy Whitcroft $res .= ' '; 15350a920b5bSAndy Whitcroft } 15360a920b5bSAndy Whitcroft next; 15370a920b5bSAndy Whitcroft } 15380a920b5bSAndy Whitcroft $res .= $c; 15390a920b5bSAndy Whitcroft $n++; 15400a920b5bSAndy Whitcroft } 15410a920b5bSAndy Whitcroft 15420a920b5bSAndy Whitcroft return $res; 15430a920b5bSAndy Whitcroft} 15446c72ffaaSAndy Whitcroftsub copy_spacing { 1545773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 15466c72ffaaSAndy Whitcroft return $res; 15476c72ffaaSAndy Whitcroft} 15480a920b5bSAndy Whitcroft 15494a0df2efSAndy Whitcroftsub line_stats { 15504a0df2efSAndy Whitcroft my ($line) = @_; 15514a0df2efSAndy Whitcroft 15524a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 15534a0df2efSAndy Whitcroft $line =~ s/^.//; 15544a0df2efSAndy Whitcroft $line = expand_tabs($line); 15554a0df2efSAndy Whitcroft 15564a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 15574a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 15584a0df2efSAndy Whitcroft 15594a0df2efSAndy Whitcroft return (length($line), length($white)); 15604a0df2efSAndy Whitcroft} 15614a0df2efSAndy Whitcroft 1562773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1563773647a0SAndy Whitcroft 1564773647a0SAndy Whitcroftsub sanitise_line_reset { 1565773647a0SAndy Whitcroft my ($in_comment) = @_; 1566773647a0SAndy Whitcroft 1567773647a0SAndy Whitcroft if ($in_comment) { 1568773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1569773647a0SAndy Whitcroft } else { 1570773647a0SAndy Whitcroft $sanitise_quote = ''; 1571773647a0SAndy Whitcroft } 1572773647a0SAndy Whitcroft} 157300df344fSAndy Whitcroftsub sanitise_line { 157400df344fSAndy Whitcroft my ($line) = @_; 157500df344fSAndy Whitcroft 157600df344fSAndy Whitcroft my $res = ''; 157700df344fSAndy Whitcroft my $l = ''; 157800df344fSAndy Whitcroft 1579c2fdda0dSAndy Whitcroft my $qlen = 0; 1580773647a0SAndy Whitcroft my $off = 0; 1581773647a0SAndy Whitcroft my $c; 158200df344fSAndy Whitcroft 1583773647a0SAndy Whitcroft # Always copy over the diff marker. 1584773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1585773647a0SAndy Whitcroft 1586773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1587773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1588773647a0SAndy Whitcroft 15898d2e11b2SClaudio Fontana # Comments we are whacking completely including the begin 1590773647a0SAndy Whitcroft # and end, all to $;. 1591773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1592773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1593773647a0SAndy Whitcroft 1594773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1595773647a0SAndy Whitcroft $off++; 159600df344fSAndy Whitcroft next; 1597773647a0SAndy Whitcroft } 159881bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1599773647a0SAndy Whitcroft $sanitise_quote = ''; 1600773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1601773647a0SAndy Whitcroft $off++; 1602773647a0SAndy Whitcroft next; 1603773647a0SAndy Whitcroft } 1604113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1605113f04a8SDaniel Walker $sanitise_quote = '//'; 1606113f04a8SDaniel Walker 1607113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1608113f04a8SDaniel Walker $off++; 1609113f04a8SDaniel Walker next; 1610113f04a8SDaniel Walker } 1611773647a0SAndy Whitcroft 1612773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1613773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1614773647a0SAndy Whitcroft $c eq "\\") { 1615773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1616773647a0SAndy Whitcroft $off++; 1617773647a0SAndy Whitcroft next; 1618773647a0SAndy Whitcroft } 1619773647a0SAndy Whitcroft # Regular quotes. 1620773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1621773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1622773647a0SAndy Whitcroft $sanitise_quote = $c; 1623773647a0SAndy Whitcroft 1624773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1625773647a0SAndy Whitcroft next; 1626773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1627773647a0SAndy Whitcroft $sanitise_quote = ''; 162800df344fSAndy Whitcroft } 162900df344fSAndy Whitcroft } 1630773647a0SAndy Whitcroft 1631fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1632773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1633773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1634113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1635113f04a8SDaniel Walker substr($res, $off, 1, $;); 1636773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1637773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 163800df344fSAndy Whitcroft } else { 1639773647a0SAndy Whitcroft substr($res, $off, 1, $c); 164000df344fSAndy Whitcroft } 1641c2fdda0dSAndy Whitcroft } 1642c2fdda0dSAndy Whitcroft 1643113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1644113f04a8SDaniel Walker $sanitise_quote = ''; 1645113f04a8SDaniel Walker } 1646113f04a8SDaniel Walker 1647c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1648c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1649c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1650c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1651c2fdda0dSAndy Whitcroft 1652c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1653c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1654c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1655c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1656c2fdda0dSAndy Whitcroft } 1657c2fdda0dSAndy Whitcroft 1658dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1659dadf680dSJoe Perches my $match = $1; 1660dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1661dadf680dSJoe Perches } 1662dadf680dSJoe Perches 166300df344fSAndy Whitcroft return $res; 166400df344fSAndy Whitcroft} 166500df344fSAndy Whitcroft 1666a6962d72SJoe Perchessub get_quoted_string { 1667a6962d72SJoe Perches my ($line, $rawline) = @_; 1668a6962d72SJoe Perches 1669478b1799SJoe Perches return "" if (!defined($line) || !defined($rawline)); 167033acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1671a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1672a6962d72SJoe Perches} 1673a6962d72SJoe Perches 16748905a67cSAndy Whitcroftsub ctx_statement_block { 16758905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 16768905a67cSAndy Whitcroft my $line = $linenr - 1; 16778905a67cSAndy Whitcroft my $blk = ''; 16788905a67cSAndy Whitcroft my $soff = $off; 16798905a67cSAndy Whitcroft my $coff = $off - 1; 1680773647a0SAndy Whitcroft my $coff_set = 0; 16818905a67cSAndy Whitcroft 168213214adfSAndy Whitcroft my $loff = 0; 168313214adfSAndy Whitcroft 16848905a67cSAndy Whitcroft my $type = ''; 16858905a67cSAndy Whitcroft my $level = 0; 1686a2750645SAndy Whitcroft my @stack = (); 1687cf655043SAndy Whitcroft my $p; 16888905a67cSAndy Whitcroft my $c; 16898905a67cSAndy Whitcroft my $len = 0; 169013214adfSAndy Whitcroft 169113214adfSAndy Whitcroft my $remainder; 16928905a67cSAndy Whitcroft while (1) { 1693a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1694a2750645SAndy Whitcroft 1695773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 16968905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 16978905a67cSAndy Whitcroft # context. 16988905a67cSAndy Whitcroft if ($off >= $len) { 16998905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1700dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1701c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 17028905a67cSAndy Whitcroft $remain--; 170313214adfSAndy Whitcroft $loff = $len; 1704c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 17058905a67cSAndy Whitcroft $len = length($blk); 17068905a67cSAndy Whitcroft $line++; 17078905a67cSAndy Whitcroft last; 17088905a67cSAndy Whitcroft } 17098905a67cSAndy Whitcroft # Bail if there is no further context. 17108905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 171113214adfSAndy Whitcroft if ($off >= $len) { 17128905a67cSAndy Whitcroft last; 17138905a67cSAndy Whitcroft } 1714f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1715f74bd194SAndy Whitcroft $level++; 1716f74bd194SAndy Whitcroft $type = '#'; 1717f74bd194SAndy Whitcroft } 17188905a67cSAndy Whitcroft } 1719cf655043SAndy Whitcroft $p = $c; 17208905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 172113214adfSAndy Whitcroft $remainder = substr($blk, $off); 17228905a67cSAndy Whitcroft 1723773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 17244635f4fbSAndy Whitcroft 17254635f4fbSAndy Whitcroft # Handle nested #if/#else. 17264635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 17274635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 17284635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 17294635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 17304635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 17314635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 17324635f4fbSAndy Whitcroft } 17334635f4fbSAndy Whitcroft 17348905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 17358905a67cSAndy Whitcroft # outermost level. 17368905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 17378905a67cSAndy Whitcroft last; 17388905a67cSAndy Whitcroft } 17398905a67cSAndy Whitcroft 174013214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1741773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1742773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1743773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1744773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1745773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1746773647a0SAndy Whitcroft $coff_set = 1; 1747773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1748773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 174913214adfSAndy Whitcroft } 175013214adfSAndy Whitcroft 17518905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 17528905a67cSAndy Whitcroft $level++; 17538905a67cSAndy Whitcroft $type = '('; 17548905a67cSAndy Whitcroft } 17558905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 17568905a67cSAndy Whitcroft $level--; 17578905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 17588905a67cSAndy Whitcroft 17598905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 17608905a67cSAndy Whitcroft $coff = $off; 1761773647a0SAndy Whitcroft $coff_set = 1; 1762773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 17638905a67cSAndy Whitcroft } 17648905a67cSAndy Whitcroft } 17658905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 17668905a67cSAndy Whitcroft $level++; 17678905a67cSAndy Whitcroft $type = '{'; 17688905a67cSAndy Whitcroft } 17698905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 17708905a67cSAndy Whitcroft $level--; 17718905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 17728905a67cSAndy Whitcroft 17738905a67cSAndy Whitcroft if ($level == 0) { 1774b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1775b998e001SPatrick Pannuto $off++; 1776b998e001SPatrick Pannuto } 17778905a67cSAndy Whitcroft last; 17788905a67cSAndy Whitcroft } 17798905a67cSAndy Whitcroft } 1780f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1781f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1782f74bd194SAndy Whitcroft $level--; 1783f74bd194SAndy Whitcroft $type = ''; 1784f74bd194SAndy Whitcroft $off++; 1785f74bd194SAndy Whitcroft last; 1786f74bd194SAndy Whitcroft } 17878905a67cSAndy Whitcroft $off++; 17888905a67cSAndy Whitcroft } 1789a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 179013214adfSAndy Whitcroft if ($off == $len) { 1791a3bb97a7SAndy Whitcroft $loff = $len + 1; 179213214adfSAndy Whitcroft $line++; 179313214adfSAndy Whitcroft $remain--; 179413214adfSAndy Whitcroft } 17958905a67cSAndy Whitcroft 17968905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 17978905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 17988905a67cSAndy Whitcroft 17998905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 18008905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 18018905a67cSAndy Whitcroft 1802773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 180313214adfSAndy Whitcroft 180413214adfSAndy Whitcroft return ($statement, $condition, 180513214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 180613214adfSAndy Whitcroft} 180713214adfSAndy Whitcroft 1808cf655043SAndy Whitcroftsub statement_lines { 1809cf655043SAndy Whitcroft my ($stmt) = @_; 1810cf655043SAndy Whitcroft 1811cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1812cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1813cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1814cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1815cf655043SAndy Whitcroft 1816cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1817cf655043SAndy Whitcroft 1818cf655043SAndy Whitcroft return $#stmt_lines + 2; 1819cf655043SAndy Whitcroft} 1820cf655043SAndy Whitcroft 1821cf655043SAndy Whitcroftsub statement_rawlines { 1822cf655043SAndy Whitcroft my ($stmt) = @_; 1823cf655043SAndy Whitcroft 1824cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1825cf655043SAndy Whitcroft 1826cf655043SAndy Whitcroft return $#stmt_lines + 2; 1827cf655043SAndy Whitcroft} 1828cf655043SAndy Whitcroft 1829cf655043SAndy Whitcroftsub statement_block_size { 1830cf655043SAndy Whitcroft my ($stmt) = @_; 1831cf655043SAndy Whitcroft 1832cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1833cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1834cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1835cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1836cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1837cf655043SAndy Whitcroft 1838cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1839cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1840cf655043SAndy Whitcroft 1841cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1842cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1843cf655043SAndy Whitcroft 1844cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1845cf655043SAndy Whitcroft return $stmt_lines; 1846cf655043SAndy Whitcroft } else { 1847cf655043SAndy Whitcroft return $stmt_statements; 1848cf655043SAndy Whitcroft } 1849cf655043SAndy Whitcroft} 1850cf655043SAndy Whitcroft 185113214adfSAndy Whitcroftsub ctx_statement_full { 185213214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 185313214adfSAndy Whitcroft my ($statement, $condition, $level); 185413214adfSAndy Whitcroft 185513214adfSAndy Whitcroft my (@chunks); 185613214adfSAndy Whitcroft 1857cf655043SAndy Whitcroft # Grab the first conditional/block pair. 185813214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 185913214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1860773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 186113214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1862cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1863cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1864cf655043SAndy Whitcroft } 1865cf655043SAndy Whitcroft 1866cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1867cf655043SAndy Whitcroft # could continue the statement. 1868cf655043SAndy Whitcroft for (;;) { 186913214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 187013214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1871cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1872773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1873cf655043SAndy Whitcroft #print "C: push\n"; 1874cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 187513214adfSAndy Whitcroft } 187613214adfSAndy Whitcroft 187713214adfSAndy Whitcroft return ($level, $linenr, @chunks); 18788905a67cSAndy Whitcroft} 18798905a67cSAndy Whitcroft 18804a0df2efSAndy Whitcroftsub ctx_block_get { 1881f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 18824a0df2efSAndy Whitcroft my $line; 18834a0df2efSAndy Whitcroft my $start = $linenr - 1; 18844a0df2efSAndy Whitcroft my $blk = ''; 18854a0df2efSAndy Whitcroft my @o; 18864a0df2efSAndy Whitcroft my @c; 18874a0df2efSAndy Whitcroft my @res = (); 18884a0df2efSAndy Whitcroft 1889f0a594c1SAndy Whitcroft my $level = 0; 18904635f4fbSAndy Whitcroft my @stack = ($level); 189100df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 189200df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 189300df344fSAndy Whitcroft $remain--; 189400df344fSAndy Whitcroft 189500df344fSAndy Whitcroft $blk .= $rawlines[$line]; 18964635f4fbSAndy Whitcroft 18974635f4fbSAndy Whitcroft # Handle nested #if/#else. 189801464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 18994635f4fbSAndy Whitcroft push(@stack, $level); 190001464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 19014635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 190201464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 19034635f4fbSAndy Whitcroft $level = pop(@stack); 19044635f4fbSAndy Whitcroft } 19054635f4fbSAndy Whitcroft 190601464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1907f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1908f0a594c1SAndy Whitcroft if ($off > 0) { 1909f0a594c1SAndy Whitcroft $off--; 1910f0a594c1SAndy Whitcroft next; 1911f0a594c1SAndy Whitcroft } 19124a0df2efSAndy Whitcroft 1913f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1914f0a594c1SAndy Whitcroft $level--; 1915f0a594c1SAndy Whitcroft last if ($level == 0); 1916f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1917f0a594c1SAndy Whitcroft $level++; 1918f0a594c1SAndy Whitcroft } 1919f0a594c1SAndy Whitcroft } 19204a0df2efSAndy Whitcroft 1921f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 192200df344fSAndy Whitcroft push(@res, $rawlines[$line]); 19234a0df2efSAndy Whitcroft } 19244a0df2efSAndy Whitcroft 1925f0a594c1SAndy Whitcroft last if ($level == 0); 19264a0df2efSAndy Whitcroft } 19274a0df2efSAndy Whitcroft 1928f0a594c1SAndy Whitcroft return ($level, @res); 19294a0df2efSAndy Whitcroft} 19304a0df2efSAndy Whitcroftsub ctx_block_outer { 19314a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 19324a0df2efSAndy Whitcroft 1933f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1934f0a594c1SAndy Whitcroft return @r; 19354a0df2efSAndy Whitcroft} 19364a0df2efSAndy Whitcroftsub ctx_block { 19374a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 19384a0df2efSAndy Whitcroft 1939f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1940f0a594c1SAndy Whitcroft return @r; 1941653d4876SAndy Whitcroft} 1942653d4876SAndy Whitcroftsub ctx_statement { 1943f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1944f0a594c1SAndy Whitcroft 1945f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1946f0a594c1SAndy Whitcroft return @r; 1947f0a594c1SAndy Whitcroft} 1948f0a594c1SAndy Whitcroftsub ctx_block_level { 1949653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1950653d4876SAndy Whitcroft 1951f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 19524a0df2efSAndy Whitcroft} 19539c0ca6f9SAndy Whitcroftsub ctx_statement_level { 19549c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 19559c0ca6f9SAndy Whitcroft 19569c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 19579c0ca6f9SAndy Whitcroft} 19584a0df2efSAndy Whitcroft 19594a0df2efSAndy Whitcroftsub ctx_locate_comment { 19604a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 19614a0df2efSAndy Whitcroft 1962a55ee0ccSJoe Perches # If c99 comment on the current line, or the line before or after 1963a55ee0ccSJoe Perches my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@); 1964a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1965a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@); 1966a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1967a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@); 1968a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1969a55ee0ccSJoe Perches 19704a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1971a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 19724a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 19734a0df2efSAndy Whitcroft 19744a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 19754a0df2efSAndy Whitcroft # comment. 19764a0df2efSAndy Whitcroft my $in_comment = 0; 19774a0df2efSAndy Whitcroft $current_comment = ''; 19784a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 197900df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 198000df344fSAndy Whitcroft #warn " $line\n"; 19814a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 19824a0df2efSAndy Whitcroft $in_comment = 1; 19834a0df2efSAndy Whitcroft } 19844a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 19854a0df2efSAndy Whitcroft $in_comment = 1; 19864a0df2efSAndy Whitcroft } 19874a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 19884a0df2efSAndy Whitcroft $current_comment = ''; 19894a0df2efSAndy Whitcroft } 19904a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 19914a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 19924a0df2efSAndy Whitcroft $in_comment = 0; 19934a0df2efSAndy Whitcroft } 19944a0df2efSAndy Whitcroft } 19954a0df2efSAndy Whitcroft 19964a0df2efSAndy Whitcroft chomp($current_comment); 19974a0df2efSAndy Whitcroft return($current_comment); 19984a0df2efSAndy Whitcroft} 19994a0df2efSAndy Whitcroftsub ctx_has_comment { 20004a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 20014a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 20024a0df2efSAndy Whitcroft 200300df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 20044a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 20054a0df2efSAndy Whitcroft 20064a0df2efSAndy Whitcroft return ($cmt ne ''); 20074a0df2efSAndy Whitcroft} 20084a0df2efSAndy Whitcroft 20094d001e4dSAndy Whitcroftsub raw_line { 20104d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 20114d001e4dSAndy Whitcroft 20124d001e4dSAndy Whitcroft my $offset = $linenr - 1; 20134d001e4dSAndy Whitcroft $cnt++; 20144d001e4dSAndy Whitcroft 20154d001e4dSAndy Whitcroft my $line; 20164d001e4dSAndy Whitcroft while ($cnt) { 20174d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 20184d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 20194d001e4dSAndy Whitcroft $cnt--; 20204d001e4dSAndy Whitcroft } 20214d001e4dSAndy Whitcroft 20224d001e4dSAndy Whitcroft return $line; 20234d001e4dSAndy Whitcroft} 20244d001e4dSAndy Whitcroft 20252a9f9d85STobin C. Hardingsub get_stat_real { 20262a9f9d85STobin C. Harding my ($linenr, $lc) = @_; 20272a9f9d85STobin C. Harding 20282a9f9d85STobin C. Harding my $stat_real = raw_line($linenr, 0); 20292a9f9d85STobin C. Harding for (my $count = $linenr + 1; $count <= $lc; $count++) { 20302a9f9d85STobin C. Harding $stat_real = $stat_real . "\n" . raw_line($count, 0); 20312a9f9d85STobin C. Harding } 20322a9f9d85STobin C. Harding 20332a9f9d85STobin C. Harding return $stat_real; 20342a9f9d85STobin C. Harding} 20352a9f9d85STobin C. Harding 2036e3d95a2aSTobin C. Hardingsub get_stat_here { 2037e3d95a2aSTobin C. Harding my ($linenr, $cnt, $here) = @_; 2038e3d95a2aSTobin C. Harding 2039e3d95a2aSTobin C. Harding my $herectx = $here . "\n"; 2040e3d95a2aSTobin C. Harding for (my $n = 0; $n < $cnt; $n++) { 2041e3d95a2aSTobin C. Harding $herectx .= raw_line($linenr, $n) . "\n"; 2042e3d95a2aSTobin C. Harding } 2043e3d95a2aSTobin C. Harding 2044e3d95a2aSTobin C. Harding return $herectx; 2045e3d95a2aSTobin C. Harding} 2046e3d95a2aSTobin C. Harding 20470a920b5bSAndy Whitcroftsub cat_vet { 20480a920b5bSAndy Whitcroft my ($vet) = @_; 20499c0ca6f9SAndy Whitcroft my ($res, $coded); 20500a920b5bSAndy Whitcroft 20519c0ca6f9SAndy Whitcroft $res = ''; 20526c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 20536c72ffaaSAndy Whitcroft $res .= $1; 20546c72ffaaSAndy Whitcroft if ($2 ne '') { 20559c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 20566c72ffaaSAndy Whitcroft $res .= $coded; 20576c72ffaaSAndy Whitcroft } 20589c0ca6f9SAndy Whitcroft } 20599c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 20600a920b5bSAndy Whitcroft 20619c0ca6f9SAndy Whitcroft return $res; 20620a920b5bSAndy Whitcroft} 20630a920b5bSAndy Whitcroft 2064c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 2065cf655043SAndy Whitcroftmy $av_pending; 2066c2fdda0dSAndy Whitcroftmy @av_paren_type; 20671f65f947SAndy Whitcroftmy $av_pend_colon; 2068c2fdda0dSAndy Whitcroft 2069c2fdda0dSAndy Whitcroftsub annotate_reset { 2070c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 2071cf655043SAndy Whitcroft $av_pending = '_'; 2072cf655043SAndy Whitcroft @av_paren_type = ('E'); 20731f65f947SAndy Whitcroft $av_pend_colon = 'O'; 2074c2fdda0dSAndy Whitcroft} 2075c2fdda0dSAndy Whitcroft 20766c72ffaaSAndy Whitcroftsub annotate_values { 20776c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 20786c72ffaaSAndy Whitcroft 20796c72ffaaSAndy Whitcroft my $res; 20801f65f947SAndy Whitcroft my $var = '_' x length($stream); 20816c72ffaaSAndy Whitcroft my $cur = $stream; 20826c72ffaaSAndy Whitcroft 2083c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 20846c72ffaaSAndy Whitcroft 20856c72ffaaSAndy Whitcroft while (length($cur)) { 2086773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 2087cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 2088171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 20896c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 2090c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 2091c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 2092cf655043SAndy Whitcroft $type = pop(@av_paren_type); 2093c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 20946c72ffaaSAndy Whitcroft } 20956c72ffaaSAndy Whitcroft 2096c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 20979446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 20989446ef56SAndy Whitcroft push(@av_paren_type, $type); 2099addcdceaSAndy Whitcroft $type = 'c'; 21009446ef56SAndy Whitcroft 2101e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 2102c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 21036c72ffaaSAndy Whitcroft $type = 'T'; 21046c72ffaaSAndy Whitcroft 2105389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 2106389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 2107389a2fe5SAndy Whitcroft $type = 'T'; 2108389a2fe5SAndy Whitcroft 2109c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 2110171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 2111c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 2112171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 2113171ae1a4SAndy Whitcroft if ($2 ne '') { 2114cf655043SAndy Whitcroft $av_pending = 'N'; 2115171ae1a4SAndy Whitcroft } 2116171ae1a4SAndy Whitcroft $type = 'E'; 2117171ae1a4SAndy Whitcroft 2118c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 2119171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 2120171ae1a4SAndy Whitcroft $av_preprocessor = 1; 2121171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 21226c72ffaaSAndy Whitcroft 2123c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 2124cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 2125c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 2126cf655043SAndy Whitcroft 2127cf655043SAndy Whitcroft push(@av_paren_type, $type); 2128cf655043SAndy Whitcroft push(@av_paren_type, $type); 2129171ae1a4SAndy Whitcroft $type = 'E'; 2130cf655043SAndy Whitcroft 2131c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 2132cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 2133cf655043SAndy Whitcroft $av_preprocessor = 1; 2134cf655043SAndy Whitcroft 2135cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 2136cf655043SAndy Whitcroft 2137171ae1a4SAndy Whitcroft $type = 'E'; 2138cf655043SAndy Whitcroft 2139c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 2140cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 2141cf655043SAndy Whitcroft 2142cf655043SAndy Whitcroft $av_preprocessor = 1; 2143cf655043SAndy Whitcroft 2144cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 2145cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 2146cf655043SAndy Whitcroft pop(@av_paren_type); 2147cf655043SAndy Whitcroft push(@av_paren_type, $type); 2148171ae1a4SAndy Whitcroft $type = 'E'; 21496c72ffaaSAndy Whitcroft 21506c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 2151c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 21526c72ffaaSAndy Whitcroft 2153171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 2154171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 2155171ae1a4SAndy Whitcroft $av_pending = $type; 2156171ae1a4SAndy Whitcroft $type = 'N'; 2157171ae1a4SAndy Whitcroft 21586c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 2159c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 21606c72ffaaSAndy Whitcroft if (defined $2) { 2161cf655043SAndy Whitcroft $av_pending = 'V'; 21626c72ffaaSAndy Whitcroft } 21636c72ffaaSAndy Whitcroft $type = 'N'; 21646c72ffaaSAndy Whitcroft 216514b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 2166c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 216714b111c1SAndy Whitcroft $av_pending = 'E'; 21686c72ffaaSAndy Whitcroft $type = 'N'; 21696c72ffaaSAndy Whitcroft 21701f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 21711f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 21721f65f947SAndy Whitcroft $av_pend_colon = 'C'; 21731f65f947SAndy Whitcroft $type = 'N'; 21741f65f947SAndy Whitcroft 217514b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 2176c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 21776c72ffaaSAndy Whitcroft $type = 'N'; 21786c72ffaaSAndy Whitcroft 21796c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 2180c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 2181cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 2182cf655043SAndy Whitcroft $av_pending = '_'; 21836c72ffaaSAndy Whitcroft $type = 'N'; 21846c72ffaaSAndy Whitcroft 21856c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 2186cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 2187cf655043SAndy Whitcroft if ($new_type ne '_') { 2188cf655043SAndy Whitcroft $type = $new_type; 2189c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 2190c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 21916c72ffaaSAndy Whitcroft } else { 2192c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 21936c72ffaaSAndy Whitcroft } 21946c72ffaaSAndy Whitcroft 2195c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 2196c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 2197c8cb2ca3SAndy Whitcroft $type = 'V'; 2198cf655043SAndy Whitcroft $av_pending = 'V'; 21996c72ffaaSAndy Whitcroft 22008e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 22018e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 22021f65f947SAndy Whitcroft $av_pend_colon = 'B'; 22038e761b04SAndy Whitcroft } elsif ($type eq 'E') { 22048e761b04SAndy Whitcroft $av_pend_colon = 'L'; 22051f65f947SAndy Whitcroft } 22061f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 22071f65f947SAndy Whitcroft $type = 'V'; 22081f65f947SAndy Whitcroft 22096c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 2210c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 22116c72ffaaSAndy Whitcroft $type = 'V'; 22126c72ffaaSAndy Whitcroft 22136c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 2214c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 22156c72ffaaSAndy Whitcroft $type = 'N'; 22166c72ffaaSAndy Whitcroft 2217cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 2218c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 221913214adfSAndy Whitcroft $type = 'E'; 22201f65f947SAndy Whitcroft $av_pend_colon = 'O'; 222113214adfSAndy Whitcroft 22228e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 22238e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 22248e761b04SAndy Whitcroft $type = 'C'; 22258e761b04SAndy Whitcroft 22261f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 22271f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 22281f65f947SAndy Whitcroft $type = 'N'; 22291f65f947SAndy Whitcroft 22301f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 22311f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 22321f65f947SAndy Whitcroft 22331f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 22341f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 22351f65f947SAndy Whitcroft $type = 'E'; 22361f65f947SAndy Whitcroft } else { 22371f65f947SAndy Whitcroft $type = 'N'; 22381f65f947SAndy Whitcroft } 22391f65f947SAndy Whitcroft $av_pend_colon = 'O'; 22401f65f947SAndy Whitcroft 22418e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 224213214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 22436c72ffaaSAndy Whitcroft $type = 'N'; 22446c72ffaaSAndy Whitcroft 22450d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 224674048ed8SAndy Whitcroft my $variant; 224774048ed8SAndy Whitcroft 224874048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 224974048ed8SAndy Whitcroft if ($type eq 'V') { 225074048ed8SAndy Whitcroft $variant = 'B'; 225174048ed8SAndy Whitcroft } else { 225274048ed8SAndy Whitcroft $variant = 'U'; 225374048ed8SAndy Whitcroft } 225474048ed8SAndy Whitcroft 225574048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 225674048ed8SAndy Whitcroft $type = 'N'; 225774048ed8SAndy Whitcroft 22586c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 2259c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 22606c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 22616c72ffaaSAndy Whitcroft $type = 'N'; 22626c72ffaaSAndy Whitcroft } 22636c72ffaaSAndy Whitcroft 22646c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 2265c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 22666c72ffaaSAndy Whitcroft } 22676c72ffaaSAndy Whitcroft if (defined $1) { 22686c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 22696c72ffaaSAndy Whitcroft $res .= $type x length($1); 22706c72ffaaSAndy Whitcroft } 22716c72ffaaSAndy Whitcroft } 22726c72ffaaSAndy Whitcroft 22731f65f947SAndy Whitcroft return ($res, $var); 22746c72ffaaSAndy Whitcroft} 22756c72ffaaSAndy Whitcroft 22768905a67cSAndy Whitcroftsub possible { 227713214adfSAndy Whitcroft my ($possible, $line) = @_; 22789a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 22790776e594SAndy Whitcroft ^(?: 22800776e594SAndy Whitcroft $Modifier| 22810776e594SAndy Whitcroft $Storage| 22820776e594SAndy Whitcroft $Type| 22839a974fdbSAndy Whitcroft DEFINE_\S+ 22849a974fdbSAndy Whitcroft )$| 22859a974fdbSAndy Whitcroft ^(?: 22860776e594SAndy Whitcroft goto| 22870776e594SAndy Whitcroft return| 22880776e594SAndy Whitcroft case| 22890776e594SAndy Whitcroft else| 22900776e594SAndy Whitcroft asm|__asm__| 229189a88353SAndy Whitcroft do| 229289a88353SAndy Whitcroft \#| 229389a88353SAndy Whitcroft \#\#| 22949a974fdbSAndy Whitcroft )(?:\s|$)| 22950776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 22969a974fdbSAndy Whitcroft )}x; 22979a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 22989a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 2299c45dcabdSAndy Whitcroft # Check for modifiers. 2300c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 2301c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 2302c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 2303c45dcabdSAndy Whitcroft 2304c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 2305c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 2306d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 23079a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 2308d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 2309485ff23eSAlex Dowad push(@modifierListFile, $modifier); 2310d2506586SAndy Whitcroft } 23119a974fdbSAndy Whitcroft } 2312c45dcabdSAndy Whitcroft 2313c45dcabdSAndy Whitcroft } else { 231413214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 2315485ff23eSAlex Dowad push(@typeListFile, $possible); 2316c45dcabdSAndy Whitcroft } 23178905a67cSAndy Whitcroft build_types(); 23180776e594SAndy Whitcroft } else { 23190776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 23208905a67cSAndy Whitcroft } 23218905a67cSAndy Whitcroft} 23228905a67cSAndy Whitcroft 23236c72ffaaSAndy Whitcroftmy $prefix = ''; 23246c72ffaaSAndy Whitcroft 2325000d1cc1SJoe Perchessub show_type { 2326cbec18afSJoe Perches my ($type) = @_; 232791bfe484SJoe Perches 2328522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 2329522b837cSAlexey Dobriyan 2330cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 2331cbec18afSJoe Perches 2332cbec18afSJoe Perches return !defined $ignore_type{$type}; 2333000d1cc1SJoe Perches} 2334000d1cc1SJoe Perches 2335f0a594c1SAndy Whitcroftsub report { 2336cbec18afSJoe Perches my ($level, $type, $msg) = @_; 2337cbec18afSJoe Perches 2338cbec18afSJoe Perches if (!show_type($type) || 2339cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 2340773647a0SAndy Whitcroft return 0; 2341773647a0SAndy Whitcroft } 234257230297SJoe Perches my $output = ''; 2343737c0767SJohn Brooks if ($color) { 234457230297SJoe Perches if ($level eq 'ERROR') { 234557230297SJoe Perches $output .= RED; 234657230297SJoe Perches } elsif ($level eq 'WARNING') { 234757230297SJoe Perches $output .= YELLOW; 2348000d1cc1SJoe Perches } else { 234957230297SJoe Perches $output .= GREEN; 2350000d1cc1SJoe Perches } 235157230297SJoe Perches } 235257230297SJoe Perches $output .= $prefix . $level . ':'; 235357230297SJoe Perches if ($show_types) { 2354737c0767SJohn Brooks $output .= BLUE if ($color); 235557230297SJoe Perches $output .= "$type:"; 235657230297SJoe Perches } 2357737c0767SJohn Brooks $output .= RESET if ($color); 235857230297SJoe Perches $output .= ' ' . $msg . "\n"; 235934d8815fSJoe Perches 236034d8815fSJoe Perches if ($showfile) { 236134d8815fSJoe Perches my @lines = split("\n", $output, -1); 236234d8815fSJoe Perches splice(@lines, 1, 1); 236334d8815fSJoe Perches $output = join("\n", @lines); 236434d8815fSJoe Perches } 236552178ce0SDwaipayan Ray 236652178ce0SDwaipayan Ray if ($terse) { 236752178ce0SDwaipayan Ray $output = (split('\n', $output))[0] . "\n"; 236852178ce0SDwaipayan Ray } 236952178ce0SDwaipayan Ray 237052178ce0SDwaipayan Ray if ($verbose && exists($verbose_messages{$type}) && 237152178ce0SDwaipayan Ray !exists($verbose_emitted{$type})) { 237252178ce0SDwaipayan Ray $output .= $verbose_messages{$type} . "\n\n"; 237352178ce0SDwaipayan Ray $verbose_emitted{$type} = 1; 237452178ce0SDwaipayan Ray } 23758905a67cSAndy Whitcroft 237657230297SJoe Perches push(our @report, $output); 2377773647a0SAndy Whitcroft 2378773647a0SAndy Whitcroft return 1; 2379f0a594c1SAndy Whitcroft} 2380cbec18afSJoe Perches 2381f0a594c1SAndy Whitcroftsub report_dump { 238213214adfSAndy Whitcroft our @report; 2383f0a594c1SAndy Whitcroft} 2384000d1cc1SJoe Perches 2385d752fcc8SJoe Perchessub fixup_current_range { 2386d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 2387d752fcc8SJoe Perches 2388d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 2389d752fcc8SJoe Perches my $o = $1; 2390d752fcc8SJoe Perches my $l = $2; 2391d752fcc8SJoe Perches my $no = $o + $offset; 2392d752fcc8SJoe Perches my $nl = $l + $length; 2393d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 2394d752fcc8SJoe Perches } 2395d752fcc8SJoe Perches} 2396d752fcc8SJoe Perches 2397d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 2398d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 2399d752fcc8SJoe Perches 2400d752fcc8SJoe Perches my $range_last_linenr = 0; 2401d752fcc8SJoe Perches my $delta_offset = 0; 2402d752fcc8SJoe Perches 2403d752fcc8SJoe Perches my $old_linenr = 0; 2404d752fcc8SJoe Perches my $new_linenr = 0; 2405d752fcc8SJoe Perches 2406d752fcc8SJoe Perches my $next_insert = 0; 2407d752fcc8SJoe Perches my $next_delete = 0; 2408d752fcc8SJoe Perches 2409d752fcc8SJoe Perches my @lines = (); 2410d752fcc8SJoe Perches 2411d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 2412d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 2413d752fcc8SJoe Perches 2414d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 2415d752fcc8SJoe Perches my $save_line = 1; 2416d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 2417323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2418d752fcc8SJoe Perches $delta_offset = 0; 2419d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2420d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 2421d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 2422d752fcc8SJoe Perches } 2423d752fcc8SJoe Perches 2424d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2425d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 2426d752fcc8SJoe Perches $save_line = 0; 2427d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2428d752fcc8SJoe Perches } 2429d752fcc8SJoe Perches 2430d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2431d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 2432d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 2433d752fcc8SJoe Perches $new_linenr++; 2434d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2435d752fcc8SJoe Perches } 2436d752fcc8SJoe Perches 2437d752fcc8SJoe Perches if ($save_line) { 2438d752fcc8SJoe Perches push(@lines, $line); 2439d752fcc8SJoe Perches $new_linenr++; 2440d752fcc8SJoe Perches } 2441d752fcc8SJoe Perches 2442d752fcc8SJoe Perches $old_linenr++; 2443d752fcc8SJoe Perches } 2444d752fcc8SJoe Perches 2445d752fcc8SJoe Perches return @lines; 2446d752fcc8SJoe Perches} 2447d752fcc8SJoe Perches 2448f2d7e4d4SJoe Perchessub fix_insert_line { 2449f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2450f2d7e4d4SJoe Perches 2451f2d7e4d4SJoe Perches my $inserted = { 2452f2d7e4d4SJoe Perches LINENR => $linenr, 2453f2d7e4d4SJoe Perches LINE => $line, 2454f2d7e4d4SJoe Perches }; 2455f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2456f2d7e4d4SJoe Perches} 2457f2d7e4d4SJoe Perches 2458f2d7e4d4SJoe Perchessub fix_delete_line { 2459f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2460f2d7e4d4SJoe Perches 2461f2d7e4d4SJoe Perches my $deleted = { 2462f2d7e4d4SJoe Perches LINENR => $linenr, 2463f2d7e4d4SJoe Perches LINE => $line, 2464f2d7e4d4SJoe Perches }; 2465f2d7e4d4SJoe Perches 2466f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2467f2d7e4d4SJoe Perches} 2468f2d7e4d4SJoe Perches 2469de7d4f0eSAndy Whitcroftsub ERROR { 2470cbec18afSJoe Perches my ($type, $msg) = @_; 2471cbec18afSJoe Perches 2472cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2473de7d4f0eSAndy Whitcroft our $clean = 0; 24746c72ffaaSAndy Whitcroft our $cnt_error++; 24753705ce5bSJoe Perches return 1; 2476de7d4f0eSAndy Whitcroft } 24773705ce5bSJoe Perches return 0; 2478773647a0SAndy Whitcroft} 2479de7d4f0eSAndy Whitcroftsub WARN { 2480cbec18afSJoe Perches my ($type, $msg) = @_; 2481cbec18afSJoe Perches 2482cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2483de7d4f0eSAndy Whitcroft our $clean = 0; 24846c72ffaaSAndy Whitcroft our $cnt_warn++; 24853705ce5bSJoe Perches return 1; 2486de7d4f0eSAndy Whitcroft } 24873705ce5bSJoe Perches return 0; 2488773647a0SAndy Whitcroft} 2489de7d4f0eSAndy Whitcroftsub CHK { 2490cbec18afSJoe Perches my ($type, $msg) = @_; 2491cbec18afSJoe Perches 2492cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2493de7d4f0eSAndy Whitcroft our $clean = 0; 24946c72ffaaSAndy Whitcroft our $cnt_chk++; 24953705ce5bSJoe Perches return 1; 24966c72ffaaSAndy Whitcroft } 24973705ce5bSJoe Perches return 0; 2498de7d4f0eSAndy Whitcroft} 2499de7d4f0eSAndy Whitcroft 25006ecd9674SAndy Whitcroftsub check_absolute_file { 25016ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 25026ecd9674SAndy Whitcroft my $file = $absolute; 25036ecd9674SAndy Whitcroft 25046ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 25056ecd9674SAndy Whitcroft 25066ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 25076ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 25086ecd9674SAndy Whitcroft if (-f "$root/$file") { 25096ecd9674SAndy Whitcroft ##print "file<$file>\n"; 25106ecd9674SAndy Whitcroft last; 25116ecd9674SAndy Whitcroft } 25126ecd9674SAndy Whitcroft } 25136ecd9674SAndy Whitcroft if (! -f _) { 25146ecd9674SAndy Whitcroft return 0; 25156ecd9674SAndy Whitcroft } 25166ecd9674SAndy Whitcroft 25176ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 25186ecd9674SAndy Whitcroft my $prefix = $absolute; 25196ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 25206ecd9674SAndy Whitcroft 25216ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 25226ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2523000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2524000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 25256ecd9674SAndy Whitcroft } 25266ecd9674SAndy Whitcroft} 25276ecd9674SAndy Whitcroft 25283705ce5bSJoe Perchessub trim { 25293705ce5bSJoe Perches my ($string) = @_; 25303705ce5bSJoe Perches 2531b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2532b34c648bSJoe Perches 2533b34c648bSJoe Perches return $string; 2534b34c648bSJoe Perches} 2535b34c648bSJoe Perches 2536b34c648bSJoe Perchessub ltrim { 2537b34c648bSJoe Perches my ($string) = @_; 2538b34c648bSJoe Perches 2539b34c648bSJoe Perches $string =~ s/^\s+//; 2540b34c648bSJoe Perches 2541b34c648bSJoe Perches return $string; 2542b34c648bSJoe Perches} 2543b34c648bSJoe Perches 2544b34c648bSJoe Perchessub rtrim { 2545b34c648bSJoe Perches my ($string) = @_; 2546b34c648bSJoe Perches 2547b34c648bSJoe Perches $string =~ s/\s+$//; 25483705ce5bSJoe Perches 25493705ce5bSJoe Perches return $string; 25503705ce5bSJoe Perches} 25513705ce5bSJoe Perches 255252ea8506SJoe Perchessub string_find_replace { 255352ea8506SJoe Perches my ($string, $find, $replace) = @_; 255452ea8506SJoe Perches 255552ea8506SJoe Perches $string =~ s/$find/$replace/g; 255652ea8506SJoe Perches 255752ea8506SJoe Perches return $string; 255852ea8506SJoe Perches} 255952ea8506SJoe Perches 25603705ce5bSJoe Perchessub tabify { 25613705ce5bSJoe Perches my ($leading) = @_; 25623705ce5bSJoe Perches 2563713a09deSAntonio Borneo my $source_indent = $tabsize; 25643705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 25653705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 25663705ce5bSJoe Perches 25673705ce5bSJoe Perches #convert leading spaces to tabs 25683705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 25693705ce5bSJoe Perches #Remove spaces before a tab 25703705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 25713705ce5bSJoe Perches 25723705ce5bSJoe Perches return "$leading"; 25733705ce5bSJoe Perches} 25743705ce5bSJoe Perches 2575d1fe9c09SJoe Perchessub pos_last_openparen { 2576d1fe9c09SJoe Perches my ($line) = @_; 2577d1fe9c09SJoe Perches 2578d1fe9c09SJoe Perches my $pos = 0; 2579d1fe9c09SJoe Perches 2580d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2581d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2582d1fe9c09SJoe Perches 2583d1fe9c09SJoe Perches my $last_openparen = 0; 2584d1fe9c09SJoe Perches 2585d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2586d1fe9c09SJoe Perches return -1; 2587d1fe9c09SJoe Perches } 2588d1fe9c09SJoe Perches 2589d1fe9c09SJoe Perches my $len = length($line); 2590d1fe9c09SJoe Perches 2591d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2592d1fe9c09SJoe Perches my $string = substr($line, $pos); 2593d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2594d1fe9c09SJoe Perches $pos += length($1) - 1; 2595d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2596d1fe9c09SJoe Perches $last_openparen = $pos; 2597d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2598d1fe9c09SJoe Perches last; 2599d1fe9c09SJoe Perches } 2600d1fe9c09SJoe Perches } 2601d1fe9c09SJoe Perches 260291cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2603d1fe9c09SJoe Perches} 2604d1fe9c09SJoe Perches 2605f36d3eb8SJoe Perchessub get_raw_comment { 2606f36d3eb8SJoe Perches my ($line, $rawline) = @_; 2607f36d3eb8SJoe Perches my $comment = ''; 2608f36d3eb8SJoe Perches 2609f36d3eb8SJoe Perches for my $i (0 .. (length($line) - 1)) { 2610f36d3eb8SJoe Perches if (substr($line, $i, 1) eq "$;") { 2611f36d3eb8SJoe Perches $comment .= substr($rawline, $i, 1); 2612f36d3eb8SJoe Perches } 2613f36d3eb8SJoe Perches } 2614f36d3eb8SJoe Perches 2615f36d3eb8SJoe Perches return $comment; 2616f36d3eb8SJoe Perches} 2617f36d3eb8SJoe Perches 26185b8f82e1SSong Liusub exclude_global_initialisers { 26195b8f82e1SSong Liu my ($realfile) = @_; 26205b8f82e1SSong Liu 26215b8f82e1SSong Liu # Do not check for BPF programs (tools/testing/selftests/bpf/progs/*.c, samples/bpf/*_kern.c, *.bpf.c). 26225b8f82e1SSong Liu return $realfile =~ m@^tools/testing/selftests/bpf/progs/.*\.c$@ || 26235b8f82e1SSong Liu $realfile =~ m@^samples/bpf/.*_kern\.c$@ || 26245b8f82e1SSong Liu $realfile =~ m@/bpf/.*\.bpf\.c$@; 26255b8f82e1SSong Liu} 26265b8f82e1SSong Liu 26270a920b5bSAndy Whitcroftsub process { 26280a920b5bSAndy Whitcroft my $filename = shift; 26290a920b5bSAndy Whitcroft 26300a920b5bSAndy Whitcroft my $linenr=0; 26310a920b5bSAndy Whitcroft my $prevline=""; 2632c2fdda0dSAndy Whitcroft my $prevrawline=""; 26330a920b5bSAndy Whitcroft my $stashline=""; 2634c2fdda0dSAndy Whitcroft my $stashrawline=""; 26350a920b5bSAndy Whitcroft 26364a0df2efSAndy Whitcroft my $length; 26370a920b5bSAndy Whitcroft my $indent; 26380a920b5bSAndy Whitcroft my $previndent=0; 26390a920b5bSAndy Whitcroft my $stashindent=0; 26400a920b5bSAndy Whitcroft 2641de7d4f0eSAndy Whitcroft our $clean = 1; 26420a920b5bSAndy Whitcroft my $signoff = 0; 2643d5d6281aSDan Carpenter my $fixes_tag = 0; 2644d5d6281aSDan Carpenter my $is_revert = 0; 2645d5d6281aSDan Carpenter my $needs_fixes_tag = ""; 2646cd261496SGeert Uytterhoeven my $author = ''; 2647cd261496SGeert Uytterhoeven my $authorsignoff = 0; 264848ca2d8aSDwaipayan Ray my $author_sob = ''; 26490a920b5bSAndy Whitcroft my $is_patch = 0; 2650133712a2SRob Herring my $is_binding_patch = -1; 265129ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 265215662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 265344d303ebSJoe Perches my $has_patch_separator = 0; #Found a --- line 2654ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2655490b292cSJoe Perches my $commit_log_lines = 0; #Number of commit log lines 2656bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 26572a076f40SJoe Perches my $commit_log_long_line = 0; 2658e518e9a5SJoe Perches my $commit_log_has_diff = 0; 265913f1937eSJoe Perches my $reported_maintainer_file = 0; 2660fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2661fa64205dSPasi Savanainen 26624ce9f970SJoe Perches my $last_git_commit_id_linenr = -1; 26634ce9f970SJoe Perches 2664365dd4eaSJoe Perches my $last_blank_line = 0; 26655e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2666365dd4eaSJoe Perches 266713214adfSAndy Whitcroft our @report = (); 26686c72ffaaSAndy Whitcroft our $cnt_lines = 0; 26696c72ffaaSAndy Whitcroft our $cnt_error = 0; 26706c72ffaaSAndy Whitcroft our $cnt_warn = 0; 26716c72ffaaSAndy Whitcroft our $cnt_chk = 0; 26726c72ffaaSAndy Whitcroft 26730a920b5bSAndy Whitcroft # Trace the real file/line as we go. 26740a920b5bSAndy Whitcroft my $realfile = ''; 26750a920b5bSAndy Whitcroft my $realline = 0; 26760a920b5bSAndy Whitcroft my $realcnt = 0; 26770a920b5bSAndy Whitcroft my $here = ''; 267877cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 26790a920b5bSAndy Whitcroft my $in_comment = 0; 2680c2fdda0dSAndy Whitcroft my $comment_edge = 0; 26810a920b5bSAndy Whitcroft my $first_line = 0; 26821e855726SWolfram Sang my $p1_prefix = ''; 26830a920b5bSAndy Whitcroft 268413214adfSAndy Whitcroft my $prev_values = 'E'; 268513214adfSAndy Whitcroft 268613214adfSAndy Whitcroft # suppression flags 2687773647a0SAndy Whitcroft my %suppress_ifbraces; 2688170d3a22SAndy Whitcroft my %suppress_whiletrailers; 26892b474a1aSAndy Whitcroft my %suppress_export; 26903e469cdcSAndy Whitcroft my $suppress_statement = 0; 2691653d4876SAndy Whitcroft 26927e51f197SJoe Perches my %signatures = (); 2693323c1260SJoe Perches 2694c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2695de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2696c2fdda0dSAndy Whitcroft # 2697de7d4f0eSAndy Whitcroft my @setup_docs = (); 2698de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2699773647a0SAndy Whitcroft 2700d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2701d8b07710SJoe Perches 27029f3a8992SRob Herring my $checklicenseline = 1; 27039f3a8992SRob Herring 2704773647a0SAndy Whitcroft sanitise_line_reset(); 2705c2fdda0dSAndy Whitcroft my $line; 2706c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2707773647a0SAndy Whitcroft $linenr++; 2708773647a0SAndy Whitcroft $line = $rawline; 2709c2fdda0dSAndy Whitcroft 27103705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 27113705ce5bSJoe Perches 2712773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2713de7d4f0eSAndy Whitcroft $setup_docs = 0; 27142581ac7cSTim Froidcoeur if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) { 2715de7d4f0eSAndy Whitcroft $setup_docs = 1; 2716de7d4f0eSAndy Whitcroft } 2717773647a0SAndy Whitcroft #next; 2718de7d4f0eSAndy Whitcroft } 271974fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2720773647a0SAndy Whitcroft $realline=$1-1; 2721773647a0SAndy Whitcroft if (defined $2) { 2722773647a0SAndy Whitcroft $realcnt=$3+1; 2723773647a0SAndy Whitcroft } else { 2724773647a0SAndy Whitcroft $realcnt=1+1; 2725773647a0SAndy Whitcroft } 2726c45dcabdSAndy Whitcroft $in_comment = 0; 2727773647a0SAndy Whitcroft 2728773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2729773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2730773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2731773647a0SAndy Whitcroft # at context start. 2732773647a0SAndy Whitcroft my $edge; 273301fa9147SAndy Whitcroft my $cnt = $realcnt; 273401fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 273501fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 273601fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 273701fa9147SAndy Whitcroft $cnt--; 273801fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2739721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2740fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2741fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2742fae17daeSAndy Whitcroft ($edge) = $1; 2743fae17daeSAndy Whitcroft last; 2744fae17daeSAndy Whitcroft } 2745773647a0SAndy Whitcroft } 2746773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2747773647a0SAndy Whitcroft $in_comment = 1; 2748773647a0SAndy Whitcroft } 2749773647a0SAndy Whitcroft 2750773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2751773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2752773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2753773647a0SAndy Whitcroft if (!defined $edge && 275483242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2755773647a0SAndy Whitcroft { 2756773647a0SAndy Whitcroft $in_comment = 1; 2757773647a0SAndy Whitcroft } 2758773647a0SAndy Whitcroft 2759773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2760773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2761773647a0SAndy Whitcroft 2762171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2763773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2764171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2765773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2766773647a0SAndy Whitcroft } 2767773647a0SAndy Whitcroft push(@lines, $line); 2768773647a0SAndy Whitcroft 2769773647a0SAndy Whitcroft if ($realcnt > 1) { 2770773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2771773647a0SAndy Whitcroft } else { 2772773647a0SAndy Whitcroft $realcnt = 0; 2773773647a0SAndy Whitcroft } 2774773647a0SAndy Whitcroft 2775773647a0SAndy Whitcroft #print "==>$rawline\n"; 2776773647a0SAndy Whitcroft #print "-->$line\n"; 2777de7d4f0eSAndy Whitcroft 2778de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2779de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2780de7d4f0eSAndy Whitcroft } 2781de7d4f0eSAndy Whitcroft } 2782de7d4f0eSAndy Whitcroft 27836c72ffaaSAndy Whitcroft $prefix = ''; 27846c72ffaaSAndy Whitcroft 2785773647a0SAndy Whitcroft $realcnt = 0; 2786773647a0SAndy Whitcroft $linenr = 0; 2787194f66fcSJoe Perches $fixlinenr = -1; 27880a920b5bSAndy Whitcroft foreach my $line (@lines) { 27890a920b5bSAndy Whitcroft $linenr++; 2790194f66fcSJoe Perches $fixlinenr++; 27911b5539b1SJoe Perches my $sline = $line; #copy of $line 27921b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 27930a920b5bSAndy Whitcroft 2794c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 2795f36d3eb8SJoe Perches my $raw_comment = get_raw_comment($line, $rawline); 27966c72ffaaSAndy Whitcroft 279712c253abSJoe Perches# check if it's a mode change, rename or start of a patch 279812c253abSJoe Perches if (!$in_commit_log && 279912c253abSJoe Perches ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 280012c253abSJoe Perches ($line =~ /^rename (?:from|to) \S+\s*$/ || 280112c253abSJoe Perches $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 280212c253abSJoe Perches $is_patch = 1; 280312c253abSJoe Perches } 280412c253abSJoe Perches 28050a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2806e518e9a5SJoe Perches if (!$in_commit_log && 280774fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 280874fd4f34SJoe Perches my $context = $4; 28090a920b5bSAndy Whitcroft $is_patch = 1; 28104a0df2efSAndy Whitcroft $first_line = $linenr + 1; 28110a920b5bSAndy Whitcroft $realline=$1-1; 28120a920b5bSAndy Whitcroft if (defined $2) { 28130a920b5bSAndy Whitcroft $realcnt=$3+1; 28140a920b5bSAndy Whitcroft } else { 28150a920b5bSAndy Whitcroft $realcnt=1+1; 28160a920b5bSAndy Whitcroft } 2817c2fdda0dSAndy Whitcroft annotate_reset(); 281813214adfSAndy Whitcroft $prev_values = 'E'; 281913214adfSAndy Whitcroft 2820773647a0SAndy Whitcroft %suppress_ifbraces = (); 2821170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 28222b474a1aSAndy Whitcroft %suppress_export = (); 28233e469cdcSAndy Whitcroft $suppress_statement = 0; 282474fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 282574fd4f34SJoe Perches $context_function = $1; 282674fd4f34SJoe Perches } else { 282774fd4f34SJoe Perches undef $context_function; 282874fd4f34SJoe Perches } 28290a920b5bSAndy Whitcroft next; 28300a920b5bSAndy Whitcroft 28314a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 28324a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 28334a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2834773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 28350a920b5bSAndy Whitcroft $realline++; 2836d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 28370a920b5bSAndy Whitcroft 28384a0df2efSAndy Whitcroft # Measure the line length and indent. 2839c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 28400a920b5bSAndy Whitcroft 28410a920b5bSAndy Whitcroft # Track the previous line. 28420a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 28430a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2844c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2845c2fdda0dSAndy Whitcroft 2846773647a0SAndy Whitcroft #warn "line<$line>\n"; 28476c72ffaaSAndy Whitcroft 2848d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2849d8aaf121SAndy Whitcroft $realcnt--; 28500a920b5bSAndy Whitcroft } 28510a920b5bSAndy Whitcroft 2852cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2853cc77cdcaSAndy Whitcroft 28546c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 28556c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2856773647a0SAndy Whitcroft 28572ac73b4fSJoe Perches my $found_file = 0; 2858773647a0SAndy Whitcroft # extract the filename as it passes 28593bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 28603bf9a009SRabin Vincent $realfile = $1; 28612b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2862270c49a0SJoe Perches $in_commit_log = 0; 28632ac73b4fSJoe Perches $found_file = 1; 28643bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2865773647a0SAndy Whitcroft $realfile = $1; 28662b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2867270c49a0SJoe Perches $in_commit_log = 0; 28681e855726SWolfram Sang 28691e855726SWolfram Sang $p1_prefix = $1; 2870e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2871e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2872000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2873000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 28741e855726SWolfram Sang } 2875773647a0SAndy Whitcroft 2876c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2877000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2878000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2879773647a0SAndy Whitcroft } 28802ac73b4fSJoe Perches $found_file = 1; 28812ac73b4fSJoe Perches } 28822ac73b4fSJoe Perches 288334d8815fSJoe Perches#make up the handle for any error we report on this line 288434d8815fSJoe Perches if ($showfile) { 288534d8815fSJoe Perches $prefix = "$realfile:$realline: " 288634d8815fSJoe Perches } elsif ($emacs) { 28877d3a9f67SJoe Perches if ($file) { 28887d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 28897d3a9f67SJoe Perches } else { 289034d8815fSJoe Perches $prefix = "$filename:$linenr: "; 289134d8815fSJoe Perches } 28927d3a9f67SJoe Perches } 289334d8815fSJoe Perches 28942ac73b4fSJoe Perches if ($found_file) { 289585b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 289685b0ee18SJoe Perches WARN("OBSOLETE", 289785b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 289885b0ee18SJoe Perches } 28997bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 29002ac73b4fSJoe Perches $check = 1; 29012ac73b4fSJoe Perches } else { 29022ac73b4fSJoe Perches $check = $check_orig; 29032ac73b4fSJoe Perches } 29049f3a8992SRob Herring $checklicenseline = 1; 2905133712a2SRob Herring 2906133712a2SRob Herring if ($realfile !~ /^MAINTAINERS/) { 2907133712a2SRob Herring my $last_binding_patch = $is_binding_patch; 2908133712a2SRob Herring 2909133712a2SRob Herring $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@; 2910133712a2SRob Herring 2911133712a2SRob Herring if (($last_binding_patch != -1) && 2912133712a2SRob Herring ($last_binding_patch ^ $is_binding_patch)) { 2913133712a2SRob Herring WARN("DT_SPLIT_BINDING_PATCH", 2914858e6845SMauro Carvalho Chehab "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n"); 2915133712a2SRob Herring } 2916133712a2SRob Herring } 2917133712a2SRob Herring 2918773647a0SAndy Whitcroft next; 2919773647a0SAndy Whitcroft } 2920773647a0SAndy Whitcroft 2921389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 29220a920b5bSAndy Whitcroft 2923c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2924c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2925c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 29260a920b5bSAndy Whitcroft 29276c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 29286c72ffaaSAndy Whitcroft 2929490b292cSJoe Perches# Verify the existence of a commit log if appropriate 2930490b292cSJoe Perches# 2 is used because a $signature is counted in $commit_log_lines 2931490b292cSJoe Perches if ($in_commit_log) { 2932490b292cSJoe Perches if ($line !~ /^\s*$/) { 2933490b292cSJoe Perches $commit_log_lines++; #could be a $signature 2934490b292cSJoe Perches } 2935490b292cSJoe Perches } elsif ($has_commit_log && $commit_log_lines < 2) { 2936490b292cSJoe Perches WARN("COMMIT_MESSAGE", 2937490b292cSJoe Perches "Missing commit description - Add an appropriate one\n"); 2938490b292cSJoe Perches $commit_log_lines = 2; #warn only once 2939490b292cSJoe Perches } 2940490b292cSJoe Perches 2941e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2942e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 294313e45417SMrinal Pandey (($line =~ m@^\s+diff\b.*a/([\w/]+)@ && 294413e45417SMrinal Pandey $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) || 2945e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2946e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2947e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2948e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2949e518e9a5SJoe Perches $commit_log_has_diff = 1; 2950e518e9a5SJoe Perches } 2951e518e9a5SJoe Perches 29523bf9a009SRabin Vincent# Check for incorrect file permissions 29533bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 29543bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 295504db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 295604db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2957000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2958000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 29593bf9a009SRabin Vincent } 29603bf9a009SRabin Vincent } 29613bf9a009SRabin Vincent 2962cd261496SGeert Uytterhoeven# Check the patch for a From: 2963cd261496SGeert Uytterhoeven if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { 2964cd261496SGeert Uytterhoeven $author = $1; 2965e7f929f3SDwaipayan Ray my $curline = $linenr; 2966e7f929f3SDwaipayan Ray while(defined($rawlines[$curline]) && ($rawlines[$curline++] =~ /^[ \t]\s*(.*)/)) { 2967e7f929f3SDwaipayan Ray $author .= $1; 2968e7f929f3SDwaipayan Ray } 2969cd261496SGeert Uytterhoeven $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); 2970cd261496SGeert Uytterhoeven $author =~ s/"//g; 2971dfa05c28SJoe Perches $author = reformat_email($author); 2972cd261496SGeert Uytterhoeven } 2973cd261496SGeert Uytterhoeven 297420112475SJoe Perches# Check the patch for a signoff: 2975dfa05c28SJoe Perches if ($line =~ /^\s*signed-off-by:\s*(.*)/i) { 29764a0df2efSAndy Whitcroft $signoff++; 297715662b3eSJoe Perches $in_commit_log = 0; 297848ca2d8aSDwaipayan Ray if ($author ne '' && $authorsignoff != 1) { 2979fccaebf0SDwaipayan Ray if (same_email_addresses($1, $author)) { 2980cd261496SGeert Uytterhoeven $authorsignoff = 1; 298148ca2d8aSDwaipayan Ray } else { 298248ca2d8aSDwaipayan Ray my $ctx = $1; 298348ca2d8aSDwaipayan Ray my ($email_name, $email_comment, $email_address, $comment1) = parse_email($ctx); 298448ca2d8aSDwaipayan Ray my ($author_name, $author_comment, $author_address, $comment2) = parse_email($author); 298548ca2d8aSDwaipayan Ray 2986046fc741SMimi Zohar if (lc $email_address eq lc $author_address && $email_name eq $author_name) { 298748ca2d8aSDwaipayan Ray $author_sob = $ctx; 298848ca2d8aSDwaipayan Ray $authorsignoff = 2; 2989046fc741SMimi Zohar } elsif (lc $email_address eq lc $author_address) { 299048ca2d8aSDwaipayan Ray $author_sob = $ctx; 299148ca2d8aSDwaipayan Ray $authorsignoff = 3; 299248ca2d8aSDwaipayan Ray } elsif ($email_name eq $author_name) { 299348ca2d8aSDwaipayan Ray $author_sob = $ctx; 299448ca2d8aSDwaipayan Ray $authorsignoff = 4; 299548ca2d8aSDwaipayan Ray 299648ca2d8aSDwaipayan Ray my $address1 = $email_address; 299748ca2d8aSDwaipayan Ray my $address2 = $author_address; 299848ca2d8aSDwaipayan Ray 299948ca2d8aSDwaipayan Ray if ($address1 =~ /(\S+)\+\S+(\@.*)/) { 300048ca2d8aSDwaipayan Ray $address1 = "$1$2"; 300148ca2d8aSDwaipayan Ray } 300248ca2d8aSDwaipayan Ray if ($address2 =~ /(\S+)\+\S+(\@.*)/) { 300348ca2d8aSDwaipayan Ray $address2 = "$1$2"; 300448ca2d8aSDwaipayan Ray } 300548ca2d8aSDwaipayan Ray if ($address1 eq $address2) { 300648ca2d8aSDwaipayan Ray $authorsignoff = 5; 300748ca2d8aSDwaipayan Ray } 300848ca2d8aSDwaipayan Ray } 3009cd261496SGeert Uytterhoeven } 3010cd261496SGeert Uytterhoeven } 30110a920b5bSAndy Whitcroft } 301220112475SJoe Perches 301344d303ebSJoe Perches# Check for patch separator 301444d303ebSJoe Perches if ($line =~ /^---$/) { 301544d303ebSJoe Perches $has_patch_separator = 1; 301644d303ebSJoe Perches $in_commit_log = 0; 301744d303ebSJoe Perches } 301844d303ebSJoe Perches 3019e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 3020e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 3021e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 3022e0d975b1SJoe Perches $reported_maintainer_file = 1; 3023e0d975b1SJoe Perches } 3024e0d975b1SJoe Perches 302520112475SJoe Perches# Check signature styles 3026270c49a0SJoe Perches if (!$in_header_lines && 3027ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 302820112475SJoe Perches my $space_before = $1; 302920112475SJoe Perches my $sign_off = $2; 303020112475SJoe Perches my $space_after = $3; 303120112475SJoe Perches my $email = $4; 303220112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 303320112475SJoe Perches 3034ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 3035831242abSAditya Srivastava my $suggested_signature = find_standard_signature($sign_off); 3036831242abSAditya Srivastava if ($suggested_signature eq "") { 3037ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 3038ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 3039831242abSAditya Srivastava } else { 3040831242abSAditya Srivastava if (WARN("BAD_SIGN_OFF", 3041831242abSAditya Srivastava "Non-standard signature: '$sign_off' - perhaps '$suggested_signature'?\n" . $herecurr) && 3042831242abSAditya Srivastava $fix) { 3043831242abSAditya Srivastava $fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/; 3044831242abSAditya Srivastava } 3045831242abSAditya Srivastava } 3046ce0338dfSJoe Perches } 304720112475SJoe Perches if (defined $space_before && $space_before ne "") { 30483705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 30493705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 30503705ce5bSJoe Perches $fix) { 3051194f66fcSJoe Perches $fixed[$fixlinenr] = 30523705ce5bSJoe Perches "$ucfirst_sign_off $email"; 30533705ce5bSJoe Perches } 305420112475SJoe Perches } 305520112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 30563705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 30573705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 30583705ce5bSJoe Perches $fix) { 3059194f66fcSJoe Perches $fixed[$fixlinenr] = 30603705ce5bSJoe Perches "$ucfirst_sign_off $email"; 30613705ce5bSJoe Perches } 30623705ce5bSJoe Perches 306320112475SJoe Perches } 306420112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 30653705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 30663705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 30673705ce5bSJoe Perches $fix) { 3068194f66fcSJoe Perches $fixed[$fixlinenr] = 30693705ce5bSJoe Perches "$ucfirst_sign_off $email"; 30703705ce5bSJoe Perches } 307120112475SJoe Perches } 307220112475SJoe Perches 3073dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 307448ca2d8aSDwaipayan Ray my $suggested_email = format_email(($email_name, $name_comment, $email_address, $comment)); 307520112475SJoe Perches if ($suggested_email eq "") { 3076000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 3077000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 307820112475SJoe Perches } else { 307920112475SJoe Perches my $dequoted = $suggested_email; 308020112475SJoe Perches $dequoted =~ s/^"//; 308120112475SJoe Perches $dequoted =~ s/" </ </; 308220112475SJoe Perches # Don't force email to have quotes 308320112475SJoe Perches # Allow just an angle bracketed address 3084fccaebf0SDwaipayan Ray if (!same_email_addresses($email, $suggested_email)) { 3085fccaebf0SDwaipayan Ray if (WARN("BAD_SIGN_OFF", 3086fccaebf0SDwaipayan Ray "email address '$email' might be better as '$suggested_email'\n" . $herecurr) && 3087fccaebf0SDwaipayan Ray $fix) { 3088fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email\E/$suggested_email/; 3089fccaebf0SDwaipayan Ray } 3090fccaebf0SDwaipayan Ray } 3091fccaebf0SDwaipayan Ray 3092fccaebf0SDwaipayan Ray # Address part shouldn't have comments 3093fccaebf0SDwaipayan Ray my $stripped_address = $email_address; 3094fccaebf0SDwaipayan Ray $stripped_address =~ s/\([^\(\)]*\)//g; 3095fccaebf0SDwaipayan Ray if ($email_address ne $stripped_address) { 3096fccaebf0SDwaipayan Ray if (WARN("BAD_SIGN_OFF", 3097fccaebf0SDwaipayan Ray "address part of email should not have comments: '$email_address'\n" . $herecurr) && 3098fccaebf0SDwaipayan Ray $fix) { 3099fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email_address\E/$stripped_address/; 3100fccaebf0SDwaipayan Ray } 3101fccaebf0SDwaipayan Ray } 3102fccaebf0SDwaipayan Ray 3103fccaebf0SDwaipayan Ray # Only one name comment should be allowed 3104fccaebf0SDwaipayan Ray my $comment_count = () = $name_comment =~ /\([^\)]+\)/g; 3105fccaebf0SDwaipayan Ray if ($comment_count > 1) { 3106000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 3107fccaebf0SDwaipayan Ray "Use a single name comment in email: '$email'\n" . $herecurr); 3108fccaebf0SDwaipayan Ray } 3109fccaebf0SDwaipayan Ray 3110fccaebf0SDwaipayan Ray 3111fccaebf0SDwaipayan Ray # [email protected] or [email protected] shouldn't 3112e73d2715SDwaipayan Ray # have an email name. In addition comments should strictly 3113fccaebf0SDwaipayan Ray # begin with a # 3114fccaebf0SDwaipayan Ray if ($email =~ /^.*stable\@(?:vger\.)?kernel\.org/i) { 3115fccaebf0SDwaipayan Ray if (($comment ne "" && $comment !~ /^#.+/) || 3116fccaebf0SDwaipayan Ray ($email_name ne "")) { 3117fccaebf0SDwaipayan Ray my $cur_name = $email_name; 3118fccaebf0SDwaipayan Ray my $new_comment = $comment; 3119fccaebf0SDwaipayan Ray $cur_name =~ s/[a-zA-Z\s\-\"]+//g; 3120fccaebf0SDwaipayan Ray 3121fccaebf0SDwaipayan Ray # Remove brackets enclosing comment text 3122fccaebf0SDwaipayan Ray # and # from start of comments to get comment text 3123fccaebf0SDwaipayan Ray $new_comment =~ s/^\((.*)\)$/$1/; 3124fccaebf0SDwaipayan Ray $new_comment =~ s/^\[(.*)\]$/$1/; 3125fccaebf0SDwaipayan Ray $new_comment =~ s/^[\s\#]+|\s+$//g; 3126fccaebf0SDwaipayan Ray 3127fccaebf0SDwaipayan Ray $new_comment = trim("$new_comment $cur_name") if ($cur_name ne $new_comment); 3128fccaebf0SDwaipayan Ray $new_comment = " # $new_comment" if ($new_comment ne ""); 3129fccaebf0SDwaipayan Ray my $new_email = "$email_address$new_comment"; 3130fccaebf0SDwaipayan Ray 3131fccaebf0SDwaipayan Ray if (WARN("BAD_STABLE_ADDRESS_STYLE", 3132fccaebf0SDwaipayan Ray "Invalid email format for stable: '$email', prefer '$new_email'\n" . $herecurr) && 3133fccaebf0SDwaipayan Ray $fix) { 3134fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/; 3135fccaebf0SDwaipayan Ray } 3136fccaebf0SDwaipayan Ray } 3137fccaebf0SDwaipayan Ray } elsif ($comment ne "" && $comment !~ /^(?:#.+|\(.+\))$/) { 3138fccaebf0SDwaipayan Ray my $new_comment = $comment; 3139fccaebf0SDwaipayan Ray 3140fccaebf0SDwaipayan Ray # Extract comment text from within brackets or 3141fccaebf0SDwaipayan Ray # c89 style /*...*/ comments 3142fccaebf0SDwaipayan Ray $new_comment =~ s/^\[(.*)\]$/$1/; 3143fccaebf0SDwaipayan Ray $new_comment =~ s/^\/\*(.*)\*\/$/$1/; 3144fccaebf0SDwaipayan Ray 3145fccaebf0SDwaipayan Ray $new_comment = trim($new_comment); 3146fccaebf0SDwaipayan Ray $new_comment =~ s/^[^\w]$//; # Single lettered comment with non word character is usually a typo 3147fccaebf0SDwaipayan Ray $new_comment = "($new_comment)" if ($new_comment ne ""); 3148fccaebf0SDwaipayan Ray my $new_email = format_email($email_name, $name_comment, $email_address, $new_comment); 3149fccaebf0SDwaipayan Ray 3150fccaebf0SDwaipayan Ray if (WARN("BAD_SIGN_OFF", 3151fccaebf0SDwaipayan Ray "Unexpected content after email: '$email', should be: '$new_email'\n" . $herecurr) && 3152fccaebf0SDwaipayan Ray $fix) { 3153fccaebf0SDwaipayan Ray $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/; 3154fccaebf0SDwaipayan Ray } 315520112475SJoe Perches } 31560a920b5bSAndy Whitcroft } 31577e51f197SJoe Perches 31587e51f197SJoe Perches# Check for duplicate signatures 31597e51f197SJoe Perches my $sig_nospace = $line; 31607e51f197SJoe Perches $sig_nospace =~ s/\s//g; 31617e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 31627e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 31637e51f197SJoe Perches WARN("BAD_SIGN_OFF", 31647e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 31657e51f197SJoe Perches } else { 31667e51f197SJoe Perches $signatures{$sig_nospace} = 1; 31677e51f197SJoe Perches } 31686c5d24eeSSean Christopherson 31696c5d24eeSSean Christopherson# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email 31706c5d24eeSSean Christopherson if ($sign_off =~ /^co-developed-by:$/i) { 31716c5d24eeSSean Christopherson if ($email eq $author) { 31726c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31731916f777SThorsten Leemhuis "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . $herecurr); 31746c5d24eeSSean Christopherson } 31756c5d24eeSSean Christopherson if (!defined $lines[$linenr]) { 31766c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31771916f777SThorsten Leemhuis "Co-developed-by: must be immediately followed by Signed-off-by:\n" . $herecurr); 31781916f777SThorsten Leemhuis } elsif ($rawlines[$linenr] !~ /^signed-off-by:\s*(.*)/i) { 31796c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31801916f777SThorsten Leemhuis "Co-developed-by: must be immediately followed by Signed-off-by:\n" . $herecurr . $rawlines[$linenr] . "\n"); 31816c5d24eeSSean Christopherson } elsif ($1 ne $email) { 31826c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 31831916f777SThorsten Leemhuis "Co-developed-by and Signed-off-by: name/email do not match\n" . $herecurr . $rawlines[$linenr] . "\n"); 31846c5d24eeSSean Christopherson } 31856c5d24eeSSean Christopherson } 3186d7f1d71eSKai Wasserbäch 318744c31888SMatthieu Baerts# check if Reported-by: is followed by a Closes: tag 3188d7f1d71eSKai Wasserbäch if ($sign_off =~ /^reported(?:|-and-tested)-by:$/i) { 3189d7f1d71eSKai Wasserbäch if (!defined $lines[$linenr]) { 3190d7f1d71eSKai Wasserbäch WARN("BAD_REPORTED_BY_LINK", 319144c31888SMatthieu Baerts "Reported-by: should be immediately followed by Closes: with a URL to the report\n" . $herecurr . "\n"); 3192d6ccdd67SMatthieu Baerts } elsif ($rawlines[$linenr] !~ /^closes:\s*/i) { 3193d7f1d71eSKai Wasserbäch WARN("BAD_REPORTED_BY_LINK", 319444c31888SMatthieu Baerts "Reported-by: should be immediately followed by Closes: with a URL to the report\n" . $herecurr . $rawlines[$linenr] . "\n"); 31950a920b5bSAndy Whitcroft } 3196d7f1d71eSKai Wasserbäch } 3197d7f1d71eSKai Wasserbäch } 3198d7f1d71eSKai Wasserbäch 3199d5d6281aSDan Carpenter# These indicate a bug fix 3200d5d6281aSDan Carpenter if (!$in_header_lines && !$is_patch && 3201d5d6281aSDan Carpenter $line =~ /^This reverts commit/) { 3202d5d6281aSDan Carpenter $is_revert = 1; 3203d5d6281aSDan Carpenter } 3204d5d6281aSDan Carpenter 3205d5d6281aSDan Carpenter if (!$in_header_lines && !$is_patch && 3206d5d6281aSDan Carpenter $line =~ /((?:(?:BUG: K.|UB)SAN: |Call Trace:|stable\@|syzkaller))/) { 3207d5d6281aSDan Carpenter $needs_fixes_tag = $1; 3208d5d6281aSDan Carpenter } 32090a920b5bSAndy Whitcroft 3210bd17e036SNiklas Söderlund# Check Fixes: styles is correct 3211bd17e036SNiklas Söderlund if (!$in_header_lines && 3212*2f07b652STamir Duberstein $line =~ /^\s*(fixes:?)\s*(?:commit\s*)?([0-9a-f]{5,40})(?:\s*($balanced_parens))?/i) { 3213*2f07b652STamir Duberstein my $tag = $1; 3214*2f07b652STamir Duberstein my $orig_commit = $2; 3215*2f07b652STamir Duberstein my $title; 3216bd17e036SNiklas Söderlund my $title_has_quotes = 0; 3217d5d6281aSDan Carpenter $fixes_tag = 1; 3218*2f07b652STamir Duberstein if (defined $3) { 3219bd17e036SNiklas Söderlund # Always strip leading/trailing parens then double quotes if existing 3220*2f07b652STamir Duberstein $title = substr($3, 1, -1); 3221bd17e036SNiklas Söderlund if ($title =~ /^".*"$/) { 3222bd17e036SNiklas Söderlund $title = substr($title, 1, -1); 3223bd17e036SNiklas Söderlund $title_has_quotes = 1; 3224bd17e036SNiklas Söderlund } 3225*2f07b652STamir Duberstein } else { 3226*2f07b652STamir Duberstein $title = "commit title" 3227bd17e036SNiklas Söderlund } 3228bd17e036SNiklas Söderlund 3229*2f07b652STamir Duberstein 3230*2f07b652STamir Duberstein my $tag_case = not ($tag eq "Fixes:"); 3231*2f07b652STamir Duberstein my $tag_space = not ($line =~ /^fixes:? [0-9a-f]{5,40} ($balanced_parens)/i); 3232*2f07b652STamir Duberstein 3233*2f07b652STamir Duberstein my $id_length = not ($orig_commit =~ /^[0-9a-f]{12}$/i); 3234*2f07b652STamir Duberstein my $id_case = not ($orig_commit !~ /[A-F]/); 3235*2f07b652STamir Duberstein 3236*2f07b652STamir Duberstein my $id = "0123456789ab"; 3237bd17e036SNiklas Söderlund my ($cid, $ctitle) = git_commit_info($orig_commit, $id, 3238bd17e036SNiklas Söderlund $title); 3239bd17e036SNiklas Söderlund 3240bd17e036SNiklas Söderlund if ($ctitle ne $title || $tag_case || $tag_space || 3241bd17e036SNiklas Söderlund $id_length || $id_case || !$title_has_quotes) { 3242bd17e036SNiklas Söderlund if (WARN("BAD_FIXES_TAG", 3243bd17e036SNiklas Söderlund "Please use correct Fixes: style 'Fixes: <12 chars of sha1> (\"<title line>\")' - ie: 'Fixes: $cid (\"$ctitle\")'\n" . $herecurr) && 3244bd17e036SNiklas Söderlund $fix) { 3245bd17e036SNiklas Söderlund $fixed[$fixlinenr] = "Fixes: $cid (\"$ctitle\")"; 3246bd17e036SNiklas Söderlund } 3247bd17e036SNiklas Söderlund } 3248bd17e036SNiklas Söderlund } 3249bd17e036SNiklas Söderlund 3250a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 3251a2fe16b9SJoe Perches if ($in_header_lines && 3252a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 3253a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 3254a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 3255a2fe16b9SJoe Perches } 3256a2fe16b9SJoe Perches 325744d303ebSJoe Perches# Check for Gerrit Change-Ids not in any patch context 325844d303ebSJoe Perches if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) { 32597580c5b9SAditya Srivastava if (ERROR("GERRIT_CHANGE_ID", 32607580c5b9SAditya Srivastava "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr) && 32617580c5b9SAditya Srivastava $fix) { 32627580c5b9SAditya Srivastava fix_delete_line($fixlinenr, $rawline); 32637580c5b9SAditya Srivastava } 32647ebd05efSChristopher Covington } 32657ebd05efSChristopher Covington 3266369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 3267369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 3268369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 3269369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 3270369c8dd3SJoe Perches # timestamp 3271634cffccSJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) || 3272634cffccSJoe Perches $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ || 3273634cffccSJoe Perches $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) { 3274634cffccSJoe Perches # stack dump address styles 3275369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 3276369c8dd3SJoe Perches } 3277369c8dd3SJoe Perches 32782a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 32792a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 3280bf4daf12SJoe Perches length($line) > 75 && 3281bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 3282bf4daf12SJoe Perches # file delta changes 328336f8b348SJerome Forissier $line =~ /^\s*(?:[\w\.\-\+]*\/)++[\w\.\-\+]+:/ || 3284bf4daf12SJoe Perches # filename then : 3285f94e40eaSMatthieu Baerts $line =~ /^\s*(?:Fixes:|$link_tags_search|$signature_tags)/i || 3286f94e40eaSMatthieu Baerts # A Fixes:, link or signature tag line 3287bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 32882a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 32898e7b7ffbSJim Cromie "Prefer a maximum 75 chars per line (possible unwrapped commit description?)\n" . $herecurr); 32902a076f40SJoe Perches $commit_log_long_line = 1; 32912a076f40SJoe Perches } 32922a076f40SJoe Perches 3293bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 3294bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 3295bf4daf12SJoe Perches $line =~ /^\s*$/) { 3296bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 3297bf4daf12SJoe Perches } 3298bf4daf12SJoe Perches 329976f381bbSKai Wasserbäch# Check for odd tags before a URI/URL 330076f381bbSKai Wasserbäch if ($in_commit_log && 3301f94e40eaSMatthieu Baerts $line =~ /^\s*(\w+:)\s*http/ && $1 !~ /^$link_tags_search$/) { 330276f381bbSKai Wasserbäch if ($1 =~ /^v(?:ersion)?\d+/i) { 330376f381bbSKai Wasserbäch WARN("COMMIT_LOG_VERSIONING", 330476f381bbSKai Wasserbäch "Patch version information should be after the --- line\n" . $herecurr); 330576f381bbSKai Wasserbäch } else { 330676f381bbSKai Wasserbäch WARN("COMMIT_LOG_USE_LINK", 3307f94e40eaSMatthieu Baerts "Unknown link reference '$1', use $link_tags_print instead\n" . $herecurr); 330876f381bbSKai Wasserbäch } 330976f381bbSKai Wasserbäch } 331076f381bbSKai Wasserbäch 3311d6ccdd67SMatthieu Baerts# Check for misuse of the link tags 3312d6ccdd67SMatthieu Baerts if ($in_commit_log && 3313d6ccdd67SMatthieu Baerts $line =~ /^\s*(\w+:)\s*(\S+)/) { 3314d6ccdd67SMatthieu Baerts my $tag = $1; 3315d6ccdd67SMatthieu Baerts my $value = $2; 3316d6ccdd67SMatthieu Baerts if ($tag =~ /^$link_tags_search$/ && $value !~ m{^https?://}) { 3317d6ccdd67SMatthieu Baerts WARN("COMMIT_LOG_WRONG_LINK", 3318d6ccdd67SMatthieu Baerts "'$tag' should be followed by a public http(s) link\n" . $herecurr); 33190d7835fcSJoe Perches } 33204ce9f970SJoe Perches } 33214ce9f970SJoe Perches 33224ce9f970SJoe Perches# Check for lines starting with a # 33234ce9f970SJoe Perches if ($in_commit_log && $line =~ /^#/) { 33244ce9f970SJoe Perches if (WARN("COMMIT_COMMENT_SYMBOL", 33254ce9f970SJoe Perches "Commit log lines starting with '#' are dropped by git as comments\n" . $herecurr) && 33264ce9f970SJoe Perches $fix) { 33274ce9f970SJoe Perches $fixed[$fixlinenr] =~ s/^/ /; 33284ce9f970SJoe Perches } 33294ce9f970SJoe Perches } 3330a8972573SJohn Hubbard 3331e882dbfcSWei Wang# Check for git id commit length and improperly formed commit descriptions 33324ce9f970SJoe Perches# A correctly formed commit description is: 33334ce9f970SJoe Perches# commit <SHA-1 hash length 12+ chars> ("Complete commit subject") 3334aab38f51SJoe Perches# with the commit subject '("' prefix and '")' suffix 3335369c8dd3SJoe Perches# This is a fairly compilicated block as it tests for what appears to be 3336bf4daf12SJoe Perches# bare SHA-1 hash with minimum length of 5. It also avoids several types of 3337fe043ea1SJoe Perches# possible SHA-1 matches. 3338fe043ea1SJoe Perches# A commit match can span multiple lines so this block attempts to find a 33390d7835fcSJoe Perches# complete typical commit on a maximum of 3 lines 33400d7835fcSJoe Perches if ($perl_version_ok && 33410d7835fcSJoe Perches $in_commit_log && !$commit_log_possible_stack_dump && 33420d7835fcSJoe Perches $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i && 33430d7835fcSJoe Perches $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 33440d7835fcSJoe Perches (($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 33450d7835fcSJoe Perches ($line =~ /\bcommit\s*$/i && defined($rawlines[$linenr]) && $rawlines[$linenr] =~ /^\s*[0-9a-f]{5,}\b/i)) || 33464ce9f970SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 33474ce9f970SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 33484ce9f970SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 33490d7835fcSJoe Perches my $init_char = "c"; 33504ce9f970SJoe Perches my $orig_commit = ""; 33514ce9f970SJoe Perches my $short = 1; 33524ce9f970SJoe Perches my $long = 0; 33534ce9f970SJoe Perches my $case = 1; 33544ce9f970SJoe Perches my $space = 1; 33554ce9f970SJoe Perches my $id = '0123456789ab'; 33564ce9f970SJoe Perches my $orig_desc = "commit description"; 33574ce9f970SJoe Perches my $description = ""; 33584ce9f970SJoe Perches my $herectx = $herecurr; 33594ce9f970SJoe Perches my $has_parens = 0; 33604ce9f970SJoe Perches my $has_quotes = 0; 33614ce9f970SJoe Perches 33624ce9f970SJoe Perches my $input = $line; 33634ce9f970SJoe Perches if ($line =~ /(?:\bcommit\s+[0-9a-f]{5,}|\bcommit\s*$)/i) { 33644ce9f970SJoe Perches for (my $n = 0; $n < 2; $n++) { 33654ce9f970SJoe Perches if ($input =~ /\bcommit\s+[0-9a-f]{5,}\s*($balanced_parens)/i) { 33664ce9f970SJoe Perches $orig_desc = $1; 33674ce9f970SJoe Perches $has_parens = 1; 33684ce9f970SJoe Perches # Always strip leading/trailing parens then double quotes if existing 3369fe043ea1SJoe Perches $orig_desc = substr($orig_desc, 1, -1); 3370fe043ea1SJoe Perches if ($orig_desc =~ /^".*"$/) { 33714ce9f970SJoe Perches $orig_desc = substr($orig_desc, 1, -1); 33724ce9f970SJoe Perches $has_quotes = 1; 33734ce9f970SJoe Perches } 33744ce9f970SJoe Perches last; 33754ce9f970SJoe Perches } 33764ce9f970SJoe Perches last if ($#lines < $linenr + $n); 33774ce9f970SJoe Perches $input .= " " . trim($rawlines[$linenr + $n]); 33784ce9f970SJoe Perches $herectx .= "$rawlines[$linenr + $n]\n"; 33794ce9f970SJoe Perches } 33800d7835fcSJoe Perches $herectx = $herecurr if (!$has_parens); 33810d7835fcSJoe Perches } 33820d7835fcSJoe Perches 33830d7835fcSJoe Perches if ($input =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 33840d7835fcSJoe Perches $init_char = $1; 3385948b133aSHeinrich Schuchardt $orig_commit = lc($2); 33864ce9f970SJoe Perches $short = 0 if ($input =~ /\bcommit\s+[0-9a-f]{12,40}/i); 33874ce9f970SJoe Perches $long = 1 if ($input =~ /\bcommit\s+[0-9a-f]{41,}/i); 3388d311cd44SJoe Perches $space = 0 if ($input =~ /\bcommit [0-9a-f]/i); 33894ce9f970SJoe Perches $case = 0 if ($input =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 33900d7835fcSJoe Perches } elsif ($input =~ /\b([0-9a-f]{12,40})\b/i) { 33914ce9f970SJoe Perches $orig_commit = lc($1); 33924ce9f970SJoe Perches } 3393d311cd44SJoe Perches 3394d311cd44SJoe Perches ($id, $description) = git_commit_info($orig_commit, 33959b71f79fSBjorn Helgaas $id, $orig_desc); 33969b71f79fSBjorn Helgaas 33979b71f79fSBjorn Helgaas if (defined($id) && 33989b71f79fSBjorn Helgaas ($short || $long || $space || $case || ($orig_desc ne $description) || !$has_quotes) && 33999b71f79fSBjorn Helgaas $last_git_commit_id_linenr != $linenr - 1) { 34009b71f79fSBjorn Helgaas ERROR("GIT_COMMIT_ID", 340113f1937eSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herectx); 340213f1937eSJoe Perches } 340313f1937eSJoe Perches #don't report the next line if this line ends in commit and the sha1 hash is the next line 340413f1937eSJoe Perches $last_git_commit_id_linenr = $linenr if ($line =~ /\bcommit\s*$/i); 340513f1937eSJoe Perches } 340613f1937eSJoe Perches 3407a82603a8SAndrew Jeffery# Check for mailing list archives other than lore.kernel.org 340813f1937eSJoe Perches if ($rawline =~ m{http.*\b$obsolete_archives}) { 340913f1937eSJoe Perches WARN("PREFER_LORE_ARCHIVE", 341013f1937eSJoe Perches "Use lore.kernel.org archive links when possible - see https://lore.kernel.org/lists.html\n" . $herecurr); 341113f1937eSJoe Perches } 341213f1937eSJoe Perches 3413e400edb1SRob Herring# Check for added, moved or deleted files 3414e400edb1SRob Herring if (!$reported_maintainer_file && !$in_commit_log && 3415e400edb1SRob Herring ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 3416e400edb1SRob Herring $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 3417e400edb1SRob Herring ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 341856ddc4cdSMauro Carvalho Chehab (defined($1) || defined($2))))) { 3419e400edb1SRob Herring $is_patch = 1; 3420e400edb1SRob Herring $reported_maintainer_file = 1; 342100df344fSAndy Whitcroft WARN("FILE_PATH_CHANGES", 34228905a67cSAndy Whitcroft "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 3423000d1cc1SJoe Perches } 3424000d1cc1SJoe Perches 34256c72ffaaSAndy Whitcroft# Check for adding new DT bindings not in schema format 3426de7d4f0eSAndy Whitcroft if (!$in_commit_log && 3427de7d4f0eSAndy Whitcroft ($line =~ /^new file mode\s*\d+\s*$/) && 3428de7d4f0eSAndy Whitcroft ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) { 3429de7d4f0eSAndy Whitcroft WARN("DT_SCHEMA_BINDING_PATCH", 3430171ae1a4SAndy Whitcroft "DT bindings should be in DT schema format. See: Documentation/devicetree/bindings/writing-schema.rst\n"); 3431171ae1a4SAndy Whitcroft } 3432171ae1a4SAndy Whitcroft 3433171ae1a4SAndy Whitcroft# Check for wrappage within a valid hunk of the file 3434171ae1a4SAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 3435171ae1a4SAndy Whitcroft ERROR("CORRUPTED_PATCH", 3436171ae1a4SAndy Whitcroft "patch seems to be corrupt (line wrapped?)\n" . 343734d99219SJoe Perches $herecurr) if (!$emitted_corrupt++); 3438000d1cc1SJoe Perches } 343900df344fSAndy Whitcroft 34400a920b5bSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 344115662b3eSJoe Perches if (($realfile =~ /^$/ || $line =~ /^\+/) && 344215662b3eSJoe Perches $rawline !~ m/^$UTF8*$/) { 344315662b3eSJoe Perches my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 3444eb3a58deSJoe Perches 3445eb3a58deSJoe Perches my $blank = copy_spacing($rawline); 344615662b3eSJoe Perches my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 344715662b3eSJoe Perches my $hereptr = "$hereline$ptr\n"; 3448ed43c4e5SAllen Hubbe 344915662b3eSJoe Perches CHK("INVALID_UTF8", 345015662b3eSJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 3451fa64205dSPasi Savanainen } 3452fa64205dSPasi Savanainen 3453fa64205dSPasi Savanainen# Check if it's the start of a commit log 3454fa64205dSPasi Savanainen# (not a header line and we haven't seen the patch filename) 3455fa64205dSPasi Savanainen if ($in_header_lines && $realfile =~ /^$/ && 3456fa64205dSPasi Savanainen !($rawline =~ /^\s+(?:\S|$)/ || 3457fa64205dSPasi Savanainen $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 3458fa64205dSPasi Savanainen $in_header_lines = 0; 3459fa64205dSPasi Savanainen $in_commit_log = 1; 346015662b3eSJoe Perches $has_commit_log = 1; 3461fa64205dSPasi Savanainen } 346215662b3eSJoe Perches 346315662b3eSJoe Perches# Check if there is UTF-8 in a commit log when a mail header has explicitly 346415662b3eSJoe Perches# declined it, i.e defined some charset where it is missing. 3465d6430f71SJoe Perches if ($in_header_lines && 3466d6430f71SJoe Perches $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 3467d6430f71SJoe Perches $1 !~ /utf-8/i) { 3468d6430f71SJoe Perches $non_utf8_charset = 1; 3469d6430f71SJoe Perches } 3470d6430f71SJoe Perches 3471d6430f71SJoe Perches if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 3472d6430f71SJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 3473d6430f71SJoe Perches WARN("UTF8_BEFORE_PATCH", 3474d6430f71SJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 3475d6430f71SJoe Perches } 3476d6430f71SJoe Perches 3477d6430f71SJoe Perches# Check for absolute kernel paths in commit message 3478d6430f71SJoe Perches if ($tree && $in_commit_log) { 347966b47b4aSKees Cook while ($line =~ m{(?:^|\s)(/\S*)}g) { 348066d7a382SJoe Perches my $file = $1; 348166d7a382SJoe Perches 34827da07c31SDwaipayan Ray if ($file =~ m{^(.*?)(?::\d+)+:?$} && 348366b47b4aSKees Cook check_absolute_file($1, $herecurr)) { 34847da07c31SDwaipayan Ray # 34857da07c31SDwaipayan Ray } else { 34867da07c31SDwaipayan Ray check_absolute_file($file, $herecurr); 348766b47b4aSKees Cook } 348866b47b4aSKees Cook } 348966b47b4aSKees Cook } 34900675a8fbSJean Delvare 34910675a8fbSJean Delvare# Check for various typo / spelling mistakes 34920675a8fbSJean Delvare if (defined($misspellings) && 34937da07c31SDwaipayan Ray ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 349466b47b4aSKees Cook while ($rawline =~ /(?:^|[^\w\-'`])($misspellings)(?:[^\w\-'`]|$)/gi) { 349566b47b4aSKees Cook my $typo = $1; 349666b47b4aSKees Cook my $blank = copy_spacing($rawline); 349766b47b4aSKees Cook my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo); 349866b47b4aSKees Cook my $hereptr = "$hereline$ptr\n"; 349966b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 3500a8dd86bfSMatteo Croce $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 3501a8dd86bfSMatteo Croce $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 3502a8dd86bfSMatteo Croce my $msg_level = \&WARN; 3503a8dd86bfSMatteo Croce $msg_level = \&CHK if ($file); 3504a8dd86bfSMatteo Croce if (&{$msg_level}("TYPO_SPELLING", 3505a8dd86bfSMatteo Croce "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $hereptr) && 3506a8dd86bfSMatteo Croce $fix) { 3507a8dd86bfSMatteo Croce $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 3508a8dd86bfSMatteo Croce } 3509a8dd86bfSMatteo Croce } 3510a8dd86bfSMatteo Croce } 3511310cd06bSJoe Perches 35128d0325ccSAditya Srivastava# check for invalid commit id 35138d0325ccSAditya Srivastava if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) { 35148d0325ccSAditya Srivastava my $id; 35151db81a68SDwaipayan Ray my $description; 3516310cd06bSJoe Perches ($id, $description) = git_commit_info($2, undef, undef); 3517310cd06bSJoe Perches if (!defined($id)) { 3518310cd06bSJoe Perches WARN("UNKNOWN_COMMIT_ID", 3519310cd06bSJoe Perches "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr); 35201db81a68SDwaipayan Ray } 35211db81a68SDwaipayan Ray } 3522310cd06bSJoe Perches 3523310cd06bSJoe Perches# check for repeated words separated by a single space 3524310cd06bSJoe Perches# avoid false positive from list command eg, '-rw-r--r-- 1 root root' 3525310cd06bSJoe Perches if (($rawline =~ /^\+/ || $in_commit_log) && 3526310cd06bSJoe Perches $rawline !~ /[bcCdDlMnpPs\?-][rwxsStT-]{9}/) { 35271db81a68SDwaipayan Ray pos($rawline) = 1 if (!$in_commit_log); 3528310cd06bSJoe Perches while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) { 3529310cd06bSJoe Perches 35301db81a68SDwaipayan Ray my $first = $1; 35311db81a68SDwaipayan Ray my $second = $2; 35321db81a68SDwaipayan Ray my $start_pos = $-[1]; 35331db81a68SDwaipayan Ray my $end_pos = $+[2]; 35341db81a68SDwaipayan Ray if ($first =~ /(?:struct|union|enum)/) { 35351db81a68SDwaipayan Ray pos($rawline) += length($first) + length($second) + 1; 35361db81a68SDwaipayan Ray next; 35371db81a68SDwaipayan Ray } 35381db81a68SDwaipayan Ray 35398d0325ccSAditya Srivastava next if (lc($first) ne lc($second)); 35408d0325ccSAditya Srivastava next if ($first eq 'long'); 35418d0325ccSAditya Srivastava 35428d0325ccSAditya Srivastava # check for character before and after the word matches 35438d0325ccSAditya Srivastava my $start_char = ''; 3544310cd06bSJoe Perches my $end_char = ''; 3545310cd06bSJoe Perches $start_char = substr($rawline, $start_pos - 1, 1) if ($start_pos > ($in_commit_log ? 0 : 1)); 3546310cd06bSJoe Perches $end_char = substr($rawline, $end_pos, 1) if ($end_pos < length($rawline)); 3547310cd06bSJoe Perches 3548310cd06bSJoe Perches next if ($start_char =~ /^\S$/); 3549310cd06bSJoe Perches next if (index(" \t.,;?!", $end_char) == -1); 3550310cd06bSJoe Perches 3551310cd06bSJoe Perches # avoid repeating hex occurrences like 'ff ff fe 09 ...' 3552310cd06bSJoe Perches if ($first =~ /\b[0-9a-f]{2,}\b/i) { 3553310cd06bSJoe Perches next if (!exists($allow_repeated_words{lc($first)})); 3554310cd06bSJoe Perches } 3555310cd06bSJoe Perches 3556310cd06bSJoe Perches if (WARN("REPEATED_WORD", 3557310cd06bSJoe Perches "Possible repeated word: '$first'\n" . $herecurr) && 3558310cd06bSJoe Perches $fix) { 3559310cd06bSJoe Perches $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/; 3560310cd06bSJoe Perches } 3561310cd06bSJoe Perches } 3562310cd06bSJoe Perches 3563310cd06bSJoe Perches # if it's a repeated word on consecutive lines in a comment block 3564310cd06bSJoe Perches if ($prevline =~ /$;+\s*$/ && 356530670854SAndy Whitcroft $prevrawline =~ /($word_pattern)\s*$/) { 356630670854SAndy Whitcroft my $last_word = $1; 356700df344fSAndy Whitcroft if ($rawline =~ /^\+\s*\*\s*$last_word /) { 35680a920b5bSAndy Whitcroft if (WARN("REPEATED_WORD", 35699c0ca6f9SAndy Whitcroft "Possible repeated word: '$last_word'\n" . $hereprev) && 3570c2fdda0dSAndy Whitcroft $fix) { 3571d5e616fcSJoe Perches $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/; 3572d5e616fcSJoe Perches } 3573d5e616fcSJoe Perches } 3574194f66fcSJoe Perches } 3575d5e616fcSJoe Perches } 3576c2fdda0dSAndy Whitcroft 3577c2fdda0dSAndy Whitcroft# ignore non-hunk lines and lines being removed 35783705ce5bSJoe Perches next if (!$hunk_line || $line =~ /^-/); 35793705ce5bSJoe Perches 35803705ce5bSJoe Perches#trailing whitespace 3581194f66fcSJoe Perches if ($line =~ /^\+.*\015/) { 35823705ce5bSJoe Perches my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 35833705ce5bSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 3584d2c0a235SAndy Whitcroft "DOS line endings\n" . $herevet) && 35850a920b5bSAndy Whitcroft $fix) { 35865368df20SAndy Whitcroft $fixed[$fixlinenr] =~ s/[\s\015]+$//; 35874783f894SJosh Triplett } 3588109d8cb2SAlexander Duyck } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 35891bde561eSMatthew Wilcox my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 35903e2232f2SJoe Perches if (ERROR("TRAILING_WHITESPACE", 35913e2232f2SJoe Perches "trailing whitespace\n" . $herevet) && 35924783f894SJosh Triplett $fix) { 35930675a8fbSJean Delvare $fixed[$fixlinenr] =~ s/\s+$//; 35940675a8fbSJean Delvare } 35950675a8fbSJean Delvare 35964783f894SJosh Triplett $rpt_cleaners = 1; 35974783f894SJosh Triplett } 35984783f894SJosh Triplett 35993354957aSAndi Kleen# Check for FSF mailing addresses. 36009fe287d7SAndy Whitcroft if ($rawline =~ /\bwrite to the Free/i || 36019fe287d7SAndy Whitcroft $rawline =~ /\b675\s+Mass\s+Ave/i || 36023354957aSAndi Kleen $rawline =~ /\b59\s+Temple\s+Pl/i || 3603678ae162SUlf Magnusson $rawline =~ /\b51\s+Franklin\s+St/i) { 3604678ae162SUlf Magnusson my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3605678ae162SUlf Magnusson my $msg_level = \&ERROR; 3606678ae162SUlf Magnusson $msg_level = \&CHK if ($file); 3607b8709bceSJoe Perches &{$msg_level}("FSF_MAILING_ADDRESS", 3608b8709bceSJoe Perches "Do not include the paragraph about writing to the Free Software Foundation's mailing address from the sample GPL notice. The FSF has changed addresses in the past, and may do so again. Linux already includes a copy of the GPL.\n" . $herevet) 3609b8709bceSJoe Perches } 3610b8709bceSJoe Perches 3611b8709bceSJoe Perches# check for Kconfig help text having a real description 3612b8709bceSJoe Perches# Only applies when adding the entry originally, after that we do not have 36139fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 36149fe287d7SAndy Whitcroft if ($realfile =~ /Kconfig/ && 3615b8709bceSJoe Perches # 'choice' is usually the last thing on the line (though 3616a1385803SAndy Whitcroft # Kconfig supports named choices), so use a word boundary 3617b8709bceSJoe Perches # (\b) rather than a whitespace character (\s) 3618b8709bceSJoe Perches $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 3619b8709bceSJoe Perches my $ln = $linenr; 3620b8709bceSJoe Perches my $needs_help = 0; 3621b8709bceSJoe Perches my $has_help = 0; 3622b8709bceSJoe Perches my $help_length = 0; 3623b8709bceSJoe Perches while (defined $lines[$ln]) { 3624a1385803SAndy Whitcroft my $f = $lines[$ln++]; 3625a1385803SAndy Whitcroft 3626b8709bceSJoe Perches next if ($f =~ /^-/); 3627b8709bceSJoe Perches last if ($f !~ /^[\+ ]/); # !patch context 3628b8709bceSJoe Perches 3629b8709bceSJoe Perches if ($f =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 3630678ae162SUlf Magnusson $needs_help = 1; 3631b8709bceSJoe Perches next; 3632678ae162SUlf Magnusson } 3633678ae162SUlf Magnusson if ($f =~ /^\+\s*help\s*$/) { 3634678ae162SUlf Magnusson $has_help = 1; 3635678ae162SUlf Magnusson next; 3636b8709bceSJoe Perches } 3637678ae162SUlf Magnusson 36389fe287d7SAndy Whitcroft $f =~ s/^.//; # strip patch context [+ ] 36399fe287d7SAndy Whitcroft $f =~ s/#.*//; # strip # directives 3640b8709bceSJoe Perches $f =~ s/^\s+//; # strip leading blanks 36413354957aSAndi Kleen next if ($f =~ /^$/); # skip blank lines 3642b8709bceSJoe Perches 3643b8709bceSJoe Perches # At the end of this Kconfig block: 3644b8709bceSJoe Perches # This only checks context lines in the patch 3645000d1cc1SJoe Perches # and so hopefully shouldn't trigger false 3646b8709bceSJoe Perches # positives, even though some of these are 364756193274SVadim Bendebury # common words in help texts 36483354957aSAndi Kleen if ($f =~ /^(?:config|menuconfig|choice|endchoice| 36493354957aSAndi Kleen if|endif|menu|endmenu|source)\b/x) { 36507ccf41a8SJoe Perches last; 36517ccf41a8SJoe Perches } 36527ccf41a8SJoe Perches $help_length++ if ($has_help); 36537ccf41a8SJoe Perches } 3654628f91a2SJoe Perches if ($needs_help && 3655628f91a2SJoe Perches $help_length < $min_conf_desc_length) { 3656628f91a2SJoe Perches my $stat_real = get_stat_real($linenr, $ln - 1); 3657628f91a2SJoe Perches WARN("CONFIG_DESCRIPTION", 3658628f91a2SJoe Perches "please write a help paragraph that fully describes the config symbol\n" . "$here\n$stat_real\n"); 3659628f91a2SJoe Perches } 3660628f91a2SJoe Perches } 36617ccf41a8SJoe Perches 36627ccf41a8SJoe Perches# check MAINTAINERS entries 36637ccf41a8SJoe Perches if ($realfile =~ /^MAINTAINERS$/) { 36647ccf41a8SJoe Perches# check MAINTAINERS entries for the right form 36657ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 36667ccf41a8SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 36677ccf41a8SJoe Perches if (WARN("MAINTAINERS_STYLE", 36687ccf41a8SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 36697ccf41a8SJoe Perches $fix) { 36707ccf41a8SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 36717ccf41a8SJoe Perches } 36727ccf41a8SJoe Perches } 36737ccf41a8SJoe Perches# check MAINTAINERS entries for the right ordering too 36747ccf41a8SJoe Perches my $preferred_order = 'MRLSWQBCPTFXNK'; 36757ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 36767ccf41a8SJoe Perches $prevrawline =~ /^[\+ ][A-Z]:/) { 36777ccf41a8SJoe Perches $rawline =~ /^\+([A-Z]):\s*(.*)/; 36787ccf41a8SJoe Perches my $cur = $1; 36797ccf41a8SJoe Perches my $curval = $2; 36807ccf41a8SJoe Perches $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/; 36817ccf41a8SJoe Perches my $prev = $1; 36827ccf41a8SJoe Perches my $prevval = $2; 36837ccf41a8SJoe Perches my $curindex = index($preferred_order, $cur); 36847ccf41a8SJoe Perches my $previndex = index($preferred_order, $prev); 36857ccf41a8SJoe Perches if ($curindex < 0) { 36867ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 36877ccf41a8SJoe Perches "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr); 36887ccf41a8SJoe Perches } else { 3689628f91a2SJoe Perches if ($previndex >= 0 && $curindex < $previndex) { 3690c68e5878SArnaud Lacombe WARN("MAINTAINERS_STYLE", 3691c68e5878SArnaud Lacombe "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev); 3692c68e5878SArnaud Lacombe } elsif ((($prev eq 'F' && $cur eq 'F') || 3693c68e5878SArnaud Lacombe ($prev eq 'X' && $cur eq 'X')) && 3694c68e5878SArnaud Lacombe ($prevval cmp $curval) > 0) { 3695c68e5878SArnaud Lacombe WARN("MAINTAINERS_STYLE", 3696c68e5878SArnaud Lacombe "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev); 3697c68e5878SArnaud Lacombe } 3698c68e5878SArnaud Lacombe } 3699c68e5878SArnaud Lacombe } 3700c68e5878SArnaud Lacombe } 3701c68e5878SArnaud Lacombe 3702c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 3703c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 3704bff5da43SRob Herring my $flag = $1; 37057dd05b38SFlorian Vaussard my $replacement = { 37067dd05b38SFlorian Vaussard 'EXTRA_AFLAGS' => 'asflags-y', 37077dd05b38SFlorian Vaussard 'EXTRA_CFLAGS' => 'ccflags-y', 37087dd05b38SFlorian Vaussard 'EXTRA_CPPFLAGS' => 'cppflags-y', 3709bff5da43SRob Herring 'EXTRA_LDFLAGS' => 'ldflags-y', 3710bff5da43SRob Herring }; 3711cc93319bSFlorian Vaussard 3712852d095dSRob Herring WARN("DEPRECATED_VARIABLE", 3713cc93319bSFlorian Vaussard "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 3714bff5da43SRob Herring } 3715bff5da43SRob Herring 3716185d566bSRob Herring# check for DT compatible documentation 3717185d566bSRob Herring if (defined $root && 3718185d566bSRob Herring (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 3719185d566bSRob Herring ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 3720bff5da43SRob Herring 3721bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 3722bff5da43SRob Herring 3723bff5da43SRob Herring my $dt_path = $root . "/Documentation/devicetree/bindings/"; 3724bff5da43SRob Herring my $vp_file = $dt_path . "vendor-prefixes.yaml"; 37254fbf32a6SFlorian Vaussard 37264fbf32a6SFlorian Vaussard foreach my $compat (@compats) { 3727852d095dSRob Herring my $compat2 = $compat; 3728bff5da43SRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 3729bff5da43SRob Herring my $compat3 = $compat; 3730cc93319bSFlorian Vaussard $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 3731bff5da43SRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 3732bff5da43SRob Herring if ( $? >> 8 ) { 3733bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3734bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 37359f3a8992SRob Herring } 37369f3a8992SRob Herring 37379f3a8992SRob Herring next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 37389f3a8992SRob Herring my $vendor = $1; 37399f3a8992SRob Herring `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`; 37409f3a8992SRob Herring if ( $? >> 8 ) { 37419f3a8992SRob Herring WARN("UNDOCUMENTED_DT_STRING", 37429f3a8992SRob Herring "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 3743d1d84b5fSMiguel Ojeda } 37449f3a8992SRob Herring } 3745c8df0ab6SLubomir Rintel } 37469f3a8992SRob Herring 37479f3a8992SRob Herring# check for using SPDX license tag at beginning of files 37489f3a8992SRob Herring if ($realline == $checklicenseline) { 37499f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 37509f3a8992SRob Herring $checklicenseline = 2; 3751fdf13693SJoe Perches } elsif ($rawline =~ /^\+/) { 3752fdf13693SJoe Perches my $comment = ""; 3753fdf13693SJoe Perches if ($realfile =~ /\.(h|s|S)$/) { 3754ffbce897SJoe Perches $comment = '/*'; 3755fdf13693SJoe Perches } elsif ($realfile =~ /\.(c|rs|dts|dtsi)$/) { 3756fdf13693SJoe Perches $comment = '//'; 3757fdf13693SJoe Perches } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) { 3758fdf13693SJoe Perches $comment = '#'; 37599f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 3760ffbce897SJoe Perches $comment = '..'; 37619f3a8992SRob Herring } 37629f3a8992SRob Herring 37633b6e8ac9SJoe Perches# check SPDX comment style for .[chsS] files 37643b6e8ac9SJoe Perches if ($realfile =~ /\.[chsS]$/ && 37653b6e8ac9SJoe Perches $rawline =~ /SPDX-License-Identifier:/ && 37663b6e8ac9SJoe Perches $rawline !~ m@^\+\s*\Q$comment\E\s*@) { 37673b6e8ac9SJoe Perches WARN("SPDX_LICENSE_TAG", 37683b6e8ac9SJoe Perches "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr); 376950c92900SLubomir Rintel } 377050c92900SLubomir Rintel 377150c92900SLubomir Rintel if ($comment !~ /^$/ && 377250c92900SLubomir Rintel $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) { 377350c92900SLubomir Rintel WARN("SPDX_LICENSE_TAG", 377450c92900SLubomir Rintel "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 377550c92900SLubomir Rintel } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) { 377650c92900SLubomir Rintel my $spdx_license = $1; 377750c92900SLubomir Rintel if (!is_SPDX_License_valid($spdx_license)) { 377850c92900SLubomir Rintel WARN("SPDX_LICENSE_TAG", 377950c92900SLubomir Rintel "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr); 37809f3a8992SRob Herring } 37819f3a8992SRob Herring if ($realfile =~ m@^Documentation/devicetree/bindings/@ && 3782a04bb4c2SDmitry Rokosov $spdx_license !~ /GPL-2\.0(?:-only)? OR BSD-2-Clause/) { 37839f3a8992SRob Herring my $msg_level = \&WARN; 37849f3a8992SRob Herring $msg_level = \&CHK if ($file); 37855368df20SAndy Whitcroft if (&{$msg_level}("SPDX_LICENSE_TAG", 3786d6430f71SJoe Perches 37875368df20SAndy Whitcroft "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) && 3788a8da38a9SJoe Perches $fix) { 3789a8da38a9SJoe Perches $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/; 3790a8da38a9SJoe Perches } 3791a8da38a9SJoe Perches } 3792a04bb4c2SDmitry Rokosov if ($realfile =~ m@^include/dt-bindings/@ && 3793a04bb4c2SDmitry Rokosov $spdx_license !~ /GPL-2\.0(?:-only)? OR \S+/) { 3794a04bb4c2SDmitry Rokosov WARN("SPDX_LICENSE_TAG", 3795a04bb4c2SDmitry Rokosov "DT binding headers should be licensed (GPL-2.0-only OR .*)\n" . $herecurr); 3796a04bb4c2SDmitry Rokosov } 379747e0c88bSJoe Perches } 379847e0c88bSJoe Perches } 379947e0c88bSJoe Perches } 380047e0c88bSJoe Perches 3801a0154cdbSJoe Perches# check for embedded filenames 380236217357SJoe Perches if ($rawline =~ /^\+.*\b\Q$realfile\E\b/) { 3803a0154cdbSJoe Perches WARN("EMBEDDED_FILENAME", 3804a0154cdbSJoe Perches "It's generally not useful to have the filename in the file\n" . $herecurr); 3805a0154cdbSJoe Perches } 3806a0154cdbSJoe Perches 38075e79d96eSJoe Perches# check we are in a valid source file if not then ignore this hunk 3808d1d84b5fSMiguel Ojeda next if ($realfile !~ /\.(h|c|rs|s|S|sh|dtsi|dts)$/); 38090a920b5bSAndy Whitcroft 3810a8da38a9SJoe Perches# check for using SPDX-License-Identifier on the wrong line number 3811a8da38a9SJoe Perches if ($realline != $checklicenseline && 3812a8da38a9SJoe Perches $rawline =~ /\bSPDX-License-Identifier:/ && 3813a8da38a9SJoe Perches substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) { 3814a8da38a9SJoe Perches WARN("SPDX_LICENSE_TAG", 3815a8da38a9SJoe Perches "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr); 3816a8da38a9SJoe Perches } 3817a8da38a9SJoe Perches 3818c45dcabdSAndy Whitcroft# line length limit (with some exclusions) 381947e0c88bSJoe Perches# 382047e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 382147e0c88bSJoe Perches# logging functions like pr_info that end in a string 382247e0c88bSJoe Perches# lines with a single string 382347e0c88bSJoe Perches# #defines that are a single string 382447e0c88bSJoe Perches# lines with an RFC3986 like URL 382547e0c88bSJoe Perches# 382647e0c88bSJoe Perches# There are 3 different line length message types: 382747e0c88bSJoe Perches# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 382847e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 382947e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 383047e0c88bSJoe Perches# 383147e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 383247e0c88bSJoe Perches# 383347e0c88bSJoe Perches 383447e0c88bSJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 383547e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 383647e0c88bSJoe Perches 383747e0c88bSJoe Perches # Check the allowed long line types first 383847e0c88bSJoe Perches 383947e0c88bSJoe Perches # logging functions that end in a string that starts 384047e0c88bSJoe Perches # before $max_line_length 384147e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 384247e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 384347e0c88bSJoe Perches $msg_type = ""; 384447e0c88bSJoe Perches 384547e0c88bSJoe Perches # lines with only strings (w/ possible termination) 384647e0c88bSJoe Perches # #defines with only strings 384747e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 384847e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 384947e0c88bSJoe Perches $msg_type = ""; 385047e0c88bSJoe Perches 3851cc147506SJoe Perches # More special cases 3852cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3853cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3854d560a5f8SJoe Perches $msg_type = ""; 3855d560a5f8SJoe Perches 38562e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 38572e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 38582e4bbbc5SAndreas Brauchli $msg_type = ""; 38592e4bbbc5SAndreas Brauchli 386047e0c88bSJoe Perches # Otherwise set the alternate message types 386147e0c88bSJoe Perches 386247e0c88bSJoe Perches # a comment starts before $max_line_length 386347e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 386447e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 386547e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 386647e0c88bSJoe Perches 386747e0c88bSJoe Perches # a quoted string starts before $max_line_length 386847e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 386947e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 387047e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 387147e0c88bSJoe Perches } 387247e0c88bSJoe Perches 387347e0c88bSJoe Perches if ($msg_type ne "" && 3874d6bb3951SWolfram Sang show_type("LONG_LINE") && show_type($msg_type)) { 3875bdc48fa1SJoe Perches my $msg_level = \&WARN; 3876bdc48fa1SJoe Perches $msg_level = \&CHK if ($file); 3877bdc48fa1SJoe Perches &{$msg_level}($msg_type, 3878bdc48fa1SJoe Perches "line length of $length exceeds $max_line_length columns\n" . $herecurr); 38790a920b5bSAndy Whitcroft } 388047e0c88bSJoe Perches } 38810a920b5bSAndy Whitcroft 38828905a67cSAndy Whitcroft# check for adding lines without a newline. 38838905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 388447ca69b8STom Rix if (WARN("MISSING_EOF_NEWLINE", 388547ca69b8STom Rix "adding a line without newline at end of file\n" . $herecurr) && 388647ca69b8STom Rix $fix) { 388747ca69b8STom Rix fix_delete_line($fixlinenr+1, "No newline at end of file"); 388847ca69b8STom Rix } 38898905a67cSAndy Whitcroft } 38908905a67cSAndy Whitcroft 3891de93245cSAditya Srivastava# check for .L prefix local symbols in .S files 3892de93245cSAditya Srivastava if ($realfile =~ /\.S$/ && 3893de93245cSAditya Srivastava $line =~ /^\+\s*(?:[A-Z]+_)?SYM_[A-Z]+_(?:START|END)(?:_[A-Z_]+)?\s*\(\s*\.L/) { 3894de93245cSAditya Srivastava WARN("AVOID_L_PREFIX", 3895f4bf1cd4SJonathan Corbet "Avoid using '.L' prefixed local symbol names for denoting a range of code via 'SYM_*_START/END' annotations; see Documentation/core-api/asm-annotations.rst\n" . $herecurr); 3896de93245cSAditya Srivastava } 3897de93245cSAditya Srivastava 3898b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3899de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 39000a920b5bSAndy Whitcroft 39010a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 3902713a09deSAntonio Borneo# more than $tabsize must use tabs. 3903c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3904c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3905c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3906d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 39073705ce5bSJoe Perches if (ERROR("CODE_INDENT", 39083705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 39093705ce5bSJoe Perches $fix) { 3910194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 39113705ce5bSJoe Perches } 39120a920b5bSAndy Whitcroft } 39130a920b5bSAndy Whitcroft 391408e44365SAlberto Panizzo# check for space before tabs. 391508e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 391608e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 39173705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 39183705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 39193705ce5bSJoe Perches $fix) { 3920194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3921713a09deSAntonio Borneo s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} 3922194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3923c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 39243705ce5bSJoe Perches } 392508e44365SAlberto Panizzo } 392608e44365SAlberto Panizzo 39276a487211SJoe Perches# check for assignments on the start of a line 39286a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 3929da7355abSAditya Srivastava my $operator = $1; 3930da7355abSAditya Srivastava if (CHK("ASSIGNMENT_CONTINUATIONS", 3931da7355abSAditya Srivastava "Assignment operator '$1' should be on the previous line\n" . $hereprev) && 3932da7355abSAditya Srivastava $fix && $prevrawline =~ /^\+/) { 3933da7355abSAditya Srivastava # add assignment operator to the previous line, remove from current line 3934da7355abSAditya Srivastava $fixed[$fixlinenr - 1] .= " $operator"; 3935da7355abSAditya Srivastava $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//; 3936da7355abSAditya Srivastava } 39376a487211SJoe Perches } 39386a487211SJoe Perches 3939d1fe9c09SJoe Perches# check for && or || at the start of a line 3940d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 39418e08f076SAditya Srivastava my $operator = $1; 39428e08f076SAditya Srivastava if (CHK("LOGICAL_CONTINUATIONS", 39438e08f076SAditya Srivastava "Logical continuations should be on the previous line\n" . $hereprev) && 39448e08f076SAditya Srivastava $fix && $prevrawline =~ /^\+/) { 39458e08f076SAditya Srivastava # insert logical operator at last non-comment, non-whitepsace char on previous line 39468e08f076SAditya Srivastava $prevline =~ /[\s$;]*$/; 39478e08f076SAditya Srivastava my $line_end = substr($prevrawline, $-[0]); 39488e08f076SAditya Srivastava $fixed[$fixlinenr - 1] =~ s/\Q$line_end\E$/ $operator$line_end/; 39498e08f076SAditya Srivastava $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//; 39508e08f076SAditya Srivastava } 3951d1fe9c09SJoe Perches } 3952d1fe9c09SJoe Perches 3953a91e8994SJoe Perches# check indentation starts on a tab stop 39545b57980dSJoe Perches if ($perl_version_ok && 3955bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3956a91e8994SJoe Perches my $indent = length($1); 3957713a09deSAntonio Borneo if ($indent % $tabsize) { 3958a91e8994SJoe Perches if (WARN("TABSTOP", 3959a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3960a91e8994SJoe Perches $fix) { 3961713a09deSAntonio Borneo $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; 3962a91e8994SJoe Perches } 3963a91e8994SJoe Perches } 3964a91e8994SJoe Perches } 3965a91e8994SJoe Perches 3966d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 39675b57980dSJoe Perches if ($perl_version_ok && 3968fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3969d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3970d1fe9c09SJoe Perches my $oldindent = $1; 3971d1fe9c09SJoe Perches my $rest = $2; 3972d1fe9c09SJoe Perches 3973d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3974d1fe9c09SJoe Perches if ($pos >= 0) { 3975b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3976b34a26f3SJoe Perches my $newindent = $2; 3977d1fe9c09SJoe Perches 3978d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3979713a09deSAntonio Borneo "\t" x ($pos / $tabsize) . 3980713a09deSAntonio Borneo " " x ($pos % $tabsize); 3981d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3982d1fe9c09SJoe Perches 3983d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3984d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 39853705ce5bSJoe Perches 39863705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 39873705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 39883705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3989194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39903705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 39913705ce5bSJoe Perches } 3992d1fe9c09SJoe Perches } 3993d1fe9c09SJoe Perches } 3994d1fe9c09SJoe Perches } 3995d1fe9c09SJoe Perches 39966ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 39976ab3a970SJoe Perches# avoid checking a few false positives: 39986ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 39996ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 40006ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 40016ab3a970SJoe Perches# multiline macros that define functions 40026ab3a970SJoe Perches# known attributes or the __attribute__ keyword 40036ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 40046ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 40053705ce5bSJoe Perches if (CHK("SPACING", 4006f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 40073705ce5bSJoe Perches $fix) { 4008194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4009f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 40103705ce5bSJoe Perches } 4011aad4f614SJoe Perches } 4012aad4f614SJoe Perches 401386406b1cSJoe Perches# Block comments use * on subsequent lines 401486406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 401586406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 4016a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 401761135e96SJoe Perches $rawline =~ /^\+/ && #line is new 4018a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 401986406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 402086406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 4021a605e32eSJoe Perches } 4022a605e32eSJoe Perches 402386406b1cSJoe Perches# Block comments use */ on trailing lines 402486406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 4025c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 4026c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 4027c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 402886406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 402986406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 403005880600SJoe Perches } 403105880600SJoe Perches 403208eb9b80SJoe Perches# Block comment * alignment 403308eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 4034af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 4035af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 4036af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 403708eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 4038af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 4039af207524SJoe Perches my $oldindent; 404008eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 4041af207524SJoe Perches if (defined($1)) { 4042af207524SJoe Perches $oldindent = expand_tabs($1); 4043af207524SJoe Perches } else { 4044af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 4045af207524SJoe Perches $oldindent = expand_tabs($1); 4046af207524SJoe Perches } 404708eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 404808eb9b80SJoe Perches my $newindent = $1; 404908eb9b80SJoe Perches $newindent = expand_tabs($newindent); 4050af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 405108eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 405208eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 405308eb9b80SJoe Perches } 405408eb9b80SJoe Perches } 405508eb9b80SJoe Perches 40567f619191SJoe Perches# check for missing blank lines after struct/union declarations 40577f619191SJoe Perches# with exceptions for various attributes and macros 40587f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 40597f619191SJoe Perches $line =~ /^\+/ && 40607f619191SJoe Perches !($line =~ /^\+\s*$/ || 406171aa3419SSergey Senozhatsky $line =~ /^\+\s*(?:EXPORT_SYMBOL|early_param|ALLOW_ERROR_INJECTION)/ || 40627f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 40637f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 40647f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 40657f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 40667f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 40670bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 40687f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 4069d752fcc8SJoe Perches if (CHK("LINE_SPACING", 4070d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 4071d752fcc8SJoe Perches $fix) { 4072f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 4073d752fcc8SJoe Perches } 40747f619191SJoe Perches } 40757f619191SJoe Perches 4076365dd4eaSJoe Perches# check for multiple consecutive blank lines 4077365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 4078365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 4079365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 4080d752fcc8SJoe Perches if (CHK("LINE_SPACING", 4081d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 4082d752fcc8SJoe Perches $fix) { 4083f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 4084d752fcc8SJoe Perches } 4085d752fcc8SJoe Perches 4086365dd4eaSJoe Perches $last_blank_line = $linenr; 4087365dd4eaSJoe Perches } 4088365dd4eaSJoe Perches 40893b617e3bSJoe Perches# check for missing blank lines after declarations 4090b5e8736aSJoe Perches# (declarations must have the same indentation and not be at the start of line) 4091b5e8736aSJoe Perches if (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/) { 4092b5e8736aSJoe Perches # use temporaries 4093b5e8736aSJoe Perches my $sl = $sline; 4094b5e8736aSJoe Perches my $pl = $prevline; 4095b5e8736aSJoe Perches # remove $Attribute/$Sparse uses to simplify comparisons 4096b5e8736aSJoe Perches $sl =~ s/\b(?:$Attribute|$Sparse)\b//g; 4097b5e8736aSJoe Perches $pl =~ s/\b(?:$Attribute|$Sparse)\b//g; 4098b5e8736aSJoe Perches if (($pl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 40995a4e1fd3SJoe Perches # function pointer declarations 4100b5e8736aSJoe Perches $pl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 41013f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 4102b5e8736aSJoe Perches $pl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 41033f7bac03SJoe Perches # known declaration macros 4104b5e8736aSJoe Perches $pl =~ /^\+\s+$declaration_macros/) && 41053f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 4106b5e8736aSJoe Perches !($pl =~ /^\+\s+$c90_Keywords\b/ || 41073f7bac03SJoe Perches # other possible extensions of declaration lines 4108b5e8736aSJoe Perches $pl =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 41093f7bac03SJoe Perches # not starting a section or a macro "\" extended line 4110b5e8736aSJoe Perches $pl =~ /(?:\{\s*|\\)$/) && 41113f7bac03SJoe Perches # looks like a declaration 4112b5e8736aSJoe Perches !($sl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 41135a4e1fd3SJoe Perches # function pointer declarations 4114b5e8736aSJoe Perches $sl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 41153f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 4116b5e8736aSJoe Perches $sl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 41173f7bac03SJoe Perches # known declaration macros 4118b5e8736aSJoe Perches $sl =~ /^\+\s+$declaration_macros/ || 41193f7bac03SJoe Perches # start of struct or union or enum 4120b5e8736aSJoe Perches $sl =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ || 41213f7bac03SJoe Perches # start or end of block or continuation of declaration 4122b5e8736aSJoe Perches $sl =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 41233f7bac03SJoe Perches # bitfield continuation 4124b5e8736aSJoe Perches $sl =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 41253f7bac03SJoe Perches # other possible extensions of declaration lines 4126b5e8736aSJoe Perches $sl =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/)) { 4127d752fcc8SJoe Perches if (WARN("LINE_SPACING", 4128d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 4129d752fcc8SJoe Perches $fix) { 4130f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 4131d752fcc8SJoe Perches } 41323b617e3bSJoe Perches } 4133b5e8736aSJoe Perches } 41343b617e3bSJoe Perches 41355f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 41366b4c5bebSAndy Whitcroft# Exceptions: 41376b4c5bebSAndy Whitcroft# 1) within comments 41386b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 41396b4c5bebSAndy Whitcroft# 3) hanging labels 41403705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 41415f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 41423705ce5bSJoe Perches if (WARN("LEADING_SPACE", 41433705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 41443705ce5bSJoe Perches $fix) { 4145194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 41463705ce5bSJoe Perches } 41475f7ddae6SRaffaele Recalcati } 41485f7ddae6SRaffaele Recalcati 4149b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 4150b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 4151b9ea10d6SAndy Whitcroft 41525751a24eSJoe Perches# check for unusual line ending [ or ( 41535751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 41545751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 41555751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 41565751a24eSJoe Perches } 41575751a24eSJoe Perches 41584dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 41594dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 41604dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 41614dbed76fSJoe Perches $context_function = $1; 41624dbed76fSJoe Perches } 41634dbed76fSJoe Perches 41644dbed76fSJoe Perches# check if this appears to be the end of function declaration 41654dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 41664dbed76fSJoe Perches undef $context_function; 41674dbed76fSJoe Perches } 41684dbed76fSJoe Perches 4169032a4c0fSJoe Perches# check indentation of any line with a bare else 4170840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 4171032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 4172032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 4173032a4c0fSJoe Perches my $tabs = length($1) + 1; 4174840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 4175840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 4176840080a0SJoe Perches defined $lines[$linenr] && 4177840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 4178032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 4179032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 4180032a4c0fSJoe Perches } 4181032a4c0fSJoe Perches } 4182032a4c0fSJoe Perches 4183c00df19aSJoe Perches# check indentation of a line with a break; 4184dc58bc55SJoe Perches# if the previous line is a goto, return or break 4185dc58bc55SJoe Perches# and is indented the same # of tabs 4186c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 4187c00df19aSJoe Perches my $tabs = $1; 4188dc58bc55SJoe Perches if ($prevline =~ /^\+$tabs(goto|return|break)\b/) { 4189dc58bc55SJoe Perches if (WARN("UNNECESSARY_BREAK", 4190dc58bc55SJoe Perches "break is not useful after a $1\n" . $hereprev) && 4191dc58bc55SJoe Perches $fix) { 4192dc58bc55SJoe Perches fix_delete_line($fixlinenr, $rawline); 4193dc58bc55SJoe Perches } 4194c00df19aSJoe Perches } 4195c00df19aSJoe Perches } 4196c00df19aSJoe Perches 4197c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 4198cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 4199000d1cc1SJoe Perches WARN("CVS_KEYWORD", 4200000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 4201c2fdda0dSAndy Whitcroft } 420222f2a2efSAndy Whitcroft 420356e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 420456e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 420556e77d70SJoe Perches WARN("HOTPLUG_SECTION", 420656e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 420756e77d70SJoe Perches } 420856e77d70SJoe Perches 42099c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 42102b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 42112b474a1aSAndy Whitcroft $realline_next); 42123e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 4213ca819864SJoe Perches if ($linenr > $suppress_statement && 42141b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 4215170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 4216f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4217171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 4218171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 4219171ae1a4SAndy Whitcroft 42203e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 42213e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 42223e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 42233e469cdcSAndy Whitcroft # until we hit end of it. 42243e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 42253e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 42263e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 42273e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 42283e469cdcSAndy Whitcroft } 4229f74bd194SAndy Whitcroft 42302b474a1aSAndy Whitcroft # Find the real next line. 42312b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 42322b474a1aSAndy Whitcroft if (defined $realline_next && 42332b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 42342b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 42352b474a1aSAndy Whitcroft $realline_next++; 42362b474a1aSAndy Whitcroft } 42372b474a1aSAndy Whitcroft 4238171ae1a4SAndy Whitcroft my $s = $stat; 4239171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 4240cf655043SAndy Whitcroft 4241c2fdda0dSAndy Whitcroft # Ignore goto labels. 4242171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 4243c2fdda0dSAndy Whitcroft 4244c2fdda0dSAndy Whitcroft # Ignore functions being called 4245171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 4246c2fdda0dSAndy Whitcroft 4247463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 4248463f2864SAndy Whitcroft 4249c45dcabdSAndy Whitcroft # declarations always start with types 4250d2506586SAndy 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) { 4251c45dcabdSAndy Whitcroft my $type = $1; 4252c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 4253c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 4254c45dcabdSAndy Whitcroft 42556c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 4256a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 4257c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 4258c2fdda0dSAndy Whitcroft } 42598905a67cSAndy Whitcroft 42606c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 426165863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 4262c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 42639c0ca6f9SAndy Whitcroft } 42648905a67cSAndy Whitcroft 42658905a67cSAndy Whitcroft # Check for any sort of function declaration. 42668905a67cSAndy Whitcroft # int foo(something bar, other baz); 42678905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 4268171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 42698905a67cSAndy Whitcroft my ($name_len) = length($1); 42708905a67cSAndy Whitcroft 4271cf655043SAndy Whitcroft my $ctx = $s; 4272773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 42738905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 4274cf655043SAndy Whitcroft 42758905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 4276c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 42778905a67cSAndy Whitcroft 4278c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 42798905a67cSAndy Whitcroft } 42808905a67cSAndy Whitcroft } 42818905a67cSAndy Whitcroft } 42828905a67cSAndy Whitcroft 42839c0ca6f9SAndy Whitcroft } 42849c0ca6f9SAndy Whitcroft 428500df344fSAndy Whitcroft# 428600df344fSAndy Whitcroft# Checks which may be anchored in the context. 428700df344fSAndy Whitcroft# 428800df344fSAndy Whitcroft 428900df344fSAndy Whitcroft# Check for switch () and associated case and default 429000df344fSAndy Whitcroft# statements should be at the same indent. 429100df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 429200df344fSAndy Whitcroft my $err = ''; 429300df344fSAndy Whitcroft my $sep = ''; 429400df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 429500df344fSAndy Whitcroft shift(@ctx); 429600df344fSAndy Whitcroft for my $ctx (@ctx) { 429700df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 429800df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 429900df344fSAndy Whitcroft $indent != $cindent) { 430000df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 430100df344fSAndy Whitcroft $sep = ''; 430200df344fSAndy Whitcroft } else { 430300df344fSAndy Whitcroft $sep = "[...]\n"; 430400df344fSAndy Whitcroft } 430500df344fSAndy Whitcroft } 430600df344fSAndy Whitcroft if ($err ne '') { 4307000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 4308000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 4309de7d4f0eSAndy Whitcroft } 4310de7d4f0eSAndy Whitcroft } 4311de7d4f0eSAndy Whitcroft 4312de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 4313de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 43140fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 4315773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 4316773647a0SAndy Whitcroft 43179c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 43188eef05ddSJoe Perches 43198eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 43208eef05ddSJoe Perches WARN("DEEP_INDENTATION", 43218eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 43228eef05ddSJoe Perches } 43238eef05ddSJoe Perches 4324de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 4325de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 4326de7d4f0eSAndy Whitcroft 4327548596d5SAndy Whitcroft my $ctx_ln = $linenr; 4328548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 4329de7d4f0eSAndy Whitcroft 4330548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 4331548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 4332548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 4333548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 4334548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 4335773647a0SAndy Whitcroft $ctx_ln++; 4336773647a0SAndy Whitcroft } 4337548596d5SAndy Whitcroft 433853210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 433953210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 4340773647a0SAndy Whitcroft 4341773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 4342000d1cc1SJoe Perches ERROR("OPEN_BRACE", 4343000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 434401464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 434500df344fSAndy Whitcroft } 4346773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 4347773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 4348773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 4349773647a0SAndy Whitcroft { 43509c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 43519c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 4352000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 4353000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 435401464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 43559c0ca6f9SAndy Whitcroft } 43569c0ca6f9SAndy Whitcroft } 435700df344fSAndy Whitcroft } 435800df344fSAndy Whitcroft 43594d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 4360f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 43613e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 43623e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 43633e469cdcSAndy Whitcroft if (!defined $stat); 43644d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 43654d001e4dSAndy Whitcroft 43664d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 43674d001e4dSAndy Whitcroft 43689f5af480SJoe Perches # remove inline comments 43699f5af480SJoe Perches $s =~ s/$;/ /g; 43709f5af480SJoe Perches $c =~ s/$;/ /g; 43714d001e4dSAndy Whitcroft 43724d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 43736f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 43746f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 43754d001e4dSAndy Whitcroft 43769f5af480SJoe Perches # Make sure we remove the line prefixes as we have 43779f5af480SJoe Perches # none on the first line, and are going to readd them 43789f5af480SJoe Perches # where necessary. 43799f5af480SJoe Perches $s =~ s/\n./\n/gs; 43809f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 43819f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 43829f5af480SJoe Perches } 43839f5af480SJoe Perches 43844d001e4dSAndy Whitcroft # We want to check the first line inside the block 43854d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 43864d001e4dSAndy Whitcroft # 1) any blank line termination 43874d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 43884d001e4dSAndy Whitcroft # 3) any do (...) { 43894d001e4dSAndy Whitcroft my $continuation = 0; 43904d001e4dSAndy Whitcroft my $check = 0; 43914d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 43924d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 43934d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 43944d001e4dSAndy Whitcroft $continuation = 1; 43954d001e4dSAndy Whitcroft } 43969bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 43974d001e4dSAndy Whitcroft $check = 1; 43984d001e4dSAndy Whitcroft $cond_lines++; 43994d001e4dSAndy Whitcroft } 44004d001e4dSAndy Whitcroft 44014d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 44024d001e4dSAndy Whitcroft # preprocessor statement. 44034d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 44044d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 44054d001e4dSAndy Whitcroft $check = 0; 44064d001e4dSAndy Whitcroft } 44074d001e4dSAndy Whitcroft 44089bd49efeSAndy Whitcroft my $cond_ptr = -1; 4409740504c6SAndy Whitcroft $continuation = 0; 44109bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 44119bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 44124d001e4dSAndy Whitcroft 4413f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 4414f16fa28fSAndy Whitcroft # is not linear. 4415f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 4416f16fa28fSAndy Whitcroft $check = 0; 4417f16fa28fSAndy Whitcroft } 4418f16fa28fSAndy Whitcroft 44199bd49efeSAndy Whitcroft # Ignore: 44209bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 44219bd49efeSAndy Whitcroft # 2) preprocessor lines, and 44229bd49efeSAndy Whitcroft # 3) labels. 4423740504c6SAndy Whitcroft if ($continuation || 4424740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 44259bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 44269bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 4427740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 442830dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 44299bd49efeSAndy Whitcroft $cond_lines++; 44309bd49efeSAndy Whitcroft } 44314d001e4dSAndy Whitcroft } 443230dad6ebSAndy Whitcroft } 44334d001e4dSAndy Whitcroft 44344d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 44354d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 44364d001e4dSAndy Whitcroft 44374d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 44384d001e4dSAndy Whitcroft # this is not this patch's fault. 44394d001e4dSAndy Whitcroft if (!defined($stat_real) || 44404d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 44414d001e4dSAndy Whitcroft $check = 0; 44424d001e4dSAndy Whitcroft } 44434d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 44444d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 44454d001e4dSAndy Whitcroft } 44464d001e4dSAndy Whitcroft 44479bd49efeSAndy 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"; 44484d001e4dSAndy Whitcroft 44499f5af480SJoe Perches if ($check && $s ne '' && 4450713a09deSAntonio Borneo (($sindent % $tabsize) != 0 || 44519f5af480SJoe Perches ($sindent < $indent) || 4452f6950a73SJoe Perches ($sindent == $indent && 4453f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 4454713a09deSAntonio Borneo ($sindent > $indent + $tabsize))) { 4455000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 4456000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 44574d001e4dSAndy Whitcroft } 44584d001e4dSAndy Whitcroft } 44594d001e4dSAndy Whitcroft 44606c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 44616c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 44621f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 44631f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 44646c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 4465c2fdda0dSAndy Whitcroft if ($dbg_values) { 4466c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 4467cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 4468cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 44691f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 4470c2fdda0dSAndy Whitcroft } 44716c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 44726c72ffaaSAndy Whitcroft 447300df344fSAndy Whitcroft#ignore lines not being added 44743705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 447500df344fSAndy Whitcroft 447699ca38c2SJoe Perches# check for self assignments used to avoid compiler warnings 447799ca38c2SJoe Perches# e.g.: int foo = foo, *bar = NULL; 447899ca38c2SJoe Perches# struct foo bar = *(&(bar)); 447999ca38c2SJoe Perches if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) { 448099ca38c2SJoe Perches my $var = $1; 448199ca38c2SJoe Perches if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) { 448299ca38c2SJoe Perches WARN("SELF_ASSIGNMENT", 448399ca38c2SJoe Perches "Do not use self-assignments to avoid compiler warnings\n" . $herecurr); 448499ca38c2SJoe Perches } 448599ca38c2SJoe Perches } 448699ca38c2SJoe Perches 448711ca40a0SJoe Perches# check for dereferences that span multiple lines 448811ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 448911ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 449011ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 449111ca40a0SJoe Perches my $ref = $1; 449211ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 449311ca40a0SJoe Perches $ref .= $1; 449411ca40a0SJoe Perches $ref =~ s/\s//g; 449511ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 449611ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 449711ca40a0SJoe Perches } 449811ca40a0SJoe Perches 4499a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 4500c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 4501a1ce18e4SJoe Perches my $type = $1; 4502a1ce18e4SJoe Perches my $var = $2; 4503207a8e84SJoe Perches $var = "" if (!defined $var); 4504207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 4505a1ce18e4SJoe Perches my $sign = $1; 4506a1ce18e4SJoe Perches my $pointer = $2; 4507a1ce18e4SJoe Perches 4508a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 4509a1ce18e4SJoe Perches 4510a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 4511a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 4512a1ce18e4SJoe Perches $fix) { 4513a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 4514207a8e84SJoe Perches my $comp_pointer = $pointer; 4515207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 4516207a8e84SJoe Perches $decl .= $comp_pointer; 4517207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 4518207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 4519a1ce18e4SJoe Perches } 4520a1ce18e4SJoe Perches } 4521a1ce18e4SJoe Perches } 4522a1ce18e4SJoe Perches 4523653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 45247429c690SAndy Whitcroft if ($dbg_type) { 45257429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 4526000d1cc1SJoe Perches ERROR("TEST_TYPE", 4527000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 45287429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 4529000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 4530000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 45317429c690SAndy Whitcroft } 4532653d4876SAndy Whitcroft next; 4533653d4876SAndy Whitcroft } 4534a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 4535a1ef277eSAndy Whitcroft if ($dbg_attr) { 45369360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 4537000d1cc1SJoe Perches ERROR("TEST_ATTR", 4538000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 45399360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 4540000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 4541000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 4542a1ef277eSAndy Whitcroft } 4543a1ef277eSAndy Whitcroft next; 4544a1ef277eSAndy Whitcroft } 4545653d4876SAndy Whitcroft 4546f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 454799423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 454899423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 4549d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 4550d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 4551f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 4552f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4553f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 4554d752fcc8SJoe Perches my $fixedline = $prevrawline; 4555d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 4556f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 4557d752fcc8SJoe Perches $fixedline = $line; 45588d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 4559f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 4560d752fcc8SJoe Perches } 4561f0a594c1SAndy Whitcroft } 4562f0a594c1SAndy Whitcroft 456300df344fSAndy Whitcroft# 456400df344fSAndy Whitcroft# Checks which are anchored on the added line. 456500df344fSAndy Whitcroft# 456600df344fSAndy Whitcroft 4567653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 4568c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 4569653d4876SAndy Whitcroft my $path = $1; 4570653d4876SAndy Whitcroft if ($path =~ m{//}) { 4571000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 4572495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 4573495e9d84SJoe Perches } 4574495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 4575495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 4576495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 4577653d4876SAndy Whitcroft } 4578653d4876SAndy Whitcroft } 4579653d4876SAndy Whitcroft 458000df344fSAndy Whitcroft# no C99 // comments 458100df344fSAndy Whitcroft if ($line =~ m{//}) { 45823705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 45833705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 45843705ce5bSJoe Perches $fix) { 4585194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 45863705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 45873705ce5bSJoe Perches my $comment = trim($1); 4588194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 45893705ce5bSJoe Perches } 45903705ce5bSJoe Perches } 459100df344fSAndy Whitcroft } 459200df344fSAndy Whitcroft # Remove C99 comments. 45930a920b5bSAndy Whitcroft $line =~ s@//.*@@; 45946c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 45950a920b5bSAndy Whitcroft 45962b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 45972b474a1aSAndy Whitcroft# the whole statement. 45982b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 45992b474a1aSAndy Whitcroft if (defined $realline_next && 46002b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 46012b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 460236794822SChristoph Hellwig ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/)) { 46033cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 46043cbf62dfSAndy Whitcroft # a prefix: 46053cbf62dfSAndy Whitcroft # XXX(foo); 46063cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 4607653d4876SAndy Whitcroft my $name = $1; 460870a11659SJoe Perches $name =~ s/^\s*($Ident).*/$1/; 460987a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 46103cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 46113cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 46123cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 46133cbf62dfSAndy Whitcroft 46143cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 46152b474a1aSAndy Whitcroft \n.}\s*$| 461648012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 461748012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 461848012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 46192b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 46202b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 462148012058SAndy Whitcroft )/x) { 46222b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 46232b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 46242b474a1aSAndy Whitcroft } else { 46252b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 46260a920b5bSAndy Whitcroft } 46270a920b5bSAndy Whitcroft } 46282b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 46292b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 463036794822SChristoph Hellwig ($line =~ /EXPORT_SYMBOL.*\((.*)\)/)) { 46312b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 46322b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 46332b474a1aSAndy Whitcroft } 46342b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 46352b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 4636000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 4637000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 46382b474a1aSAndy Whitcroft } 46390a920b5bSAndy Whitcroft 46405150bda4SJoe Eloff# check for global initialisers. 46415b8f82e1SSong Liu if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/ && 46425b8f82e1SSong Liu !exclude_global_initialisers($realfile)) { 4643d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 46446d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 4645d5e616fcSJoe Perches $fix) { 46466d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 4647d5e616fcSJoe Perches } 4648f0a594c1SAndy Whitcroft } 46490a920b5bSAndy Whitcroft# check for static initialisers. 46506d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 4651d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 46526d32f7a3SJoe Perches "do not initialise statics to $1\n" . 4653d5e616fcSJoe Perches $herecurr) && 4654d5e616fcSJoe Perches $fix) { 46556d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 4656d5e616fcSJoe Perches } 46570a920b5bSAndy Whitcroft } 46580a920b5bSAndy Whitcroft 46591813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 46601813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 46611813087dSJoe Perches my $tmp = trim($1); 46621813087dSJoe Perches WARN("MISORDERED_TYPE", 46631813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 46641813087dSJoe Perches } 46651813087dSJoe Perches 4666809e082eSJoe Perches# check for unnecessary <signed> int declarations of short/long/long long 4667809e082eSJoe Perches while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) { 4668809e082eSJoe Perches my $type = trim($1); 4669809e082eSJoe Perches next if ($type !~ /\bint\b/); 4670809e082eSJoe Perches next if ($type !~ /\b(?:short|long\s+long|long)\b/); 4671809e082eSJoe Perches my $new_type = $type; 4672809e082eSJoe Perches $new_type =~ s/\b\s*int\s*\b/ /; 4673809e082eSJoe Perches $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /; 4674809e082eSJoe Perches $new_type =~ s/^const\s+//; 4675809e082eSJoe Perches $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/); 4676809e082eSJoe Perches $new_type = "const $new_type" if ($type =~ /^const\b/); 4677809e082eSJoe Perches $new_type =~ s/\s+/ /g; 4678809e082eSJoe Perches $new_type = trim($new_type); 4679809e082eSJoe Perches if (WARN("UNNECESSARY_INT", 4680809e082eSJoe Perches "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) && 4681809e082eSJoe Perches $fix) { 4682809e082eSJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/; 4683809e082eSJoe Perches } 4684809e082eSJoe Perches } 4685809e082eSJoe Perches 4686cb710ecaSJoe Perches# check for static const char * arrays. 4687cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 4688000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4689000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 4690cb710ecaSJoe Perches $herecurr); 4691cb710ecaSJoe Perches } 4692cb710ecaSJoe Perches 469377b8c0a8SJoe Perches# check for initialized const char arrays that should be static const 469477b8c0a8SJoe Perches if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) { 469577b8c0a8SJoe Perches if (WARN("STATIC_CONST_CHAR_ARRAY", 469677b8c0a8SJoe Perches "const array should probably be static const\n" . $herecurr) && 469777b8c0a8SJoe Perches $fix) { 469877b8c0a8SJoe Perches $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/; 469977b8c0a8SJoe Perches } 470077b8c0a8SJoe Perches } 470177b8c0a8SJoe Perches 4702cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 4703cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 4704000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4705000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 4706cb710ecaSJoe Perches $herecurr); 4707cb710ecaSJoe Perches } 4708cb710ecaSJoe Perches 4709ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 4710ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 4711ab7e23f3SJoe Perches my $found = $1; 4712ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 4713ab7e23f3SJoe Perches WARN("CONST_CONST", 4714ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 4715ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 4716ab7e23f3SJoe Perches WARN("CONST_CONST", 4717ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 4718ab7e23f3SJoe Perches } 4719ab7e23f3SJoe Perches } 4720ab7e23f3SJoe Perches 472173169765SJoe Perches# check for const static or static <non ptr type> const declarations 472273169765SJoe Perches# prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const' 472373169765SJoe Perches if ($sline =~ /^\+\s*const\s+static\s+($Type)\b/ || 472473169765SJoe Perches $sline =~ /^\+\s*static\s+($BasicType)\s+const\b/) { 472573169765SJoe Perches if (WARN("STATIC_CONST", 472673169765SJoe Perches "Move const after static - use 'static const $1'\n" . $herecurr) && 472773169765SJoe Perches $fix) { 472873169765SJoe Perches $fixed[$fixlinenr] =~ s/\bconst\s+static\b/static const/; 472973169765SJoe Perches $fixed[$fixlinenr] =~ s/\bstatic\s+($BasicType)\s+const\b/static const $1/; 473073169765SJoe Perches } 473173169765SJoe Perches } 473273169765SJoe Perches 47339b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 47349b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 47359b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 47369b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 47379b0fa60dSJoe Perches $herecurr); 47389b0fa60dSJoe Perches } 47399b0fa60dSJoe Perches 4740b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 4741b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 4742b598b670SJoe Perches my $array = $1; 4743b598b670SJoe 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*\))@) { 4744b598b670SJoe Perches my $array_div = $1; 4745b598b670SJoe Perches if (WARN("ARRAY_SIZE", 4746b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 4747b598b670SJoe Perches $fix) { 4748b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 4749b598b670SJoe Perches } 4750b598b670SJoe Perches } 4751b598b670SJoe Perches } 4752b598b670SJoe Perches 4753b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 475416b7f3c8SJoe Perches if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) { 4755b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 4756b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 4757b36190c5SJoe Perches $fix) { 4758194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 4759b36190c5SJoe Perches } 4760b36190c5SJoe Perches } 4761b36190c5SJoe Perches 4762653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 4763653d4876SAndy Whitcroft# make sense. 4764653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 47658054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 4766c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 47678ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 476846d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 4769000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 4770000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 47710a920b5bSAndy Whitcroft } 47720a920b5bSAndy Whitcroft 47730a920b5bSAndy Whitcroft# * goes on variable not on type 477465863862SAndy Whitcroft # (char*[ const]) 4775bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 4776bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 47773705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 4778d8aaf121SAndy Whitcroft 477965863862SAndy Whitcroft # Should start with a space. 478065863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 478165863862SAndy Whitcroft # Should not end with a space. 478265863862SAndy Whitcroft $to =~ s/\s+$//; 478365863862SAndy Whitcroft # '*'s should not have spaces between. 4784f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 478565863862SAndy Whitcroft } 4786d8aaf121SAndy Whitcroft 47873705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 478865863862SAndy Whitcroft if ($from ne $to) { 47893705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 47903705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 47913705ce5bSJoe Perches $fix) { 47923705ce5bSJoe Perches my $sub_from = $ident; 47933705ce5bSJoe Perches my $sub_to = $ident; 47943705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4795194f66fcSJoe Perches $fixed[$fixlinenr] =~ 47963705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 47973705ce5bSJoe Perches } 479865863862SAndy Whitcroft } 4799bfcb2cc7SAndy Whitcroft } 4800bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 4801bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 48023705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 4803d8aaf121SAndy Whitcroft 480465863862SAndy Whitcroft # Should start with a space. 480565863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 480665863862SAndy Whitcroft # Should not end with a space. 480765863862SAndy Whitcroft $to =~ s/\s+$//; 480865863862SAndy Whitcroft # '*'s should not have spaces between. 4809f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 481065863862SAndy Whitcroft } 481165863862SAndy Whitcroft # Modifiers should have spaces. 481265863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 481365863862SAndy Whitcroft 48143705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 4815667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 48163705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 48173705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 48183705ce5bSJoe Perches $fix) { 48193705ce5bSJoe Perches 48203705ce5bSJoe Perches my $sub_from = $match; 48213705ce5bSJoe Perches my $sub_to = $match; 48223705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4823194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48243705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 48253705ce5bSJoe Perches } 482665863862SAndy Whitcroft } 48270a920b5bSAndy Whitcroft } 48280a920b5bSAndy Whitcroft 482969d517e6SDavid Hildenbrand# do not use BUG() or variants 483069d517e6SDavid Hildenbrand if ($line =~ /\b(?!AA_|BUILD_|DCCP_|IDA_|KVM_|RWLOCK_|snd_|SPIN_)(?:[a-zA-Z_]*_)?BUG(?:_ON)?(?:_[A-Z_]+)?\s*\(/) { 48310675a8fbSJean Delvare my $msg_level = \&WARN; 48320675a8fbSJean Delvare $msg_level = \&CHK if ($file); 48330675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 483469d517e6SDavid Hildenbrand "Do not crash the kernel unless it is absolutely unavoidable--use WARN_ON_ONCE() plus recovery code (if feasible) instead of BUG() or variants\n" . $herecurr); 48359d3e3c70SJoe Perches } 48360a920b5bSAndy Whitcroft 48379d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 48388905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 4839000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 4840000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 48418905a67cSAndy Whitcroft } 48428905a67cSAndy Whitcroft 484317441227SJoe Perches# check for uses of printk_ratelimit 484417441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 4845000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 4846000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 484717441227SJoe Perches } 484817441227SJoe Perches 4849eeef5733SJoe Perches# printk should use KERN_* levels 4850eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 4851000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 4852eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 485300df344fSAndy Whitcroft } 48540a920b5bSAndy Whitcroft 4855f5eea3b0SJoe Perches# prefer variants of (subsystem|netdev|dev|pr)_<level> to printk(KERN_<LEVEL> 4856f5eea3b0SJoe Perches if ($line =~ /\b(printk(_once|_ratelimited)?)\s*\(\s*KERN_([A-Z]+)/) { 4857f5eea3b0SJoe Perches my $printk = $1; 4858f5eea3b0SJoe Perches my $modifier = $2; 4859f5eea3b0SJoe Perches my $orig = $3; 4860f5eea3b0SJoe Perches $modifier = "" if (!defined($modifier)); 4861243f3803SJoe Perches my $level = lc($orig); 4862243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 48638f26b837SJoe Perches my $level2 = $level; 48648f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 4865f5eea3b0SJoe Perches $level .= $modifier; 4866f5eea3b0SJoe Perches $level2 .= $modifier; 4867243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 4868f5eea3b0SJoe Perches "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to $printk(KERN_$orig ...\n" . $herecurr); 4869243f3803SJoe Perches } 4870243f3803SJoe Perches 4871f5eea3b0SJoe Perches# prefer dev_<level> to dev_printk(KERN_<LEVEL> 4872dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 4873dc139313SJoe Perches my $orig = $1; 4874dc139313SJoe Perches my $level = lc($orig); 4875dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 4876dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 4877dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 4878dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 4879dc139313SJoe Perches } 4880dc139313SJoe Perches 48818020b253SNicolas Boichat# trace_printk should not be used in production code. 48828020b253SNicolas Boichat if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) { 48838020b253SNicolas Boichat WARN("TRACE_PRINTK", 48848020b253SNicolas Boichat "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr); 48858020b253SNicolas Boichat } 48868020b253SNicolas Boichat 488791c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 488891c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 488991c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 489091c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 489191c9afafSAndy Lutomirski WARN("ENOSYS", 489291c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 489391c9afafSAndy Lutomirski } 489491c9afafSAndy Lutomirski 48956b9ea5ffSJakub Kicinski# ENOTSUPP is not a standard error code and should be avoided in new patches. 48966b9ea5ffSJakub Kicinski# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP. 48976b9ea5ffSJakub Kicinski# Similarly to ENOSYS warning a small number of false positives is expected. 48986b9ea5ffSJakub Kicinski if (!$file && $line =~ /\bENOTSUPP\b/) { 48996b9ea5ffSJakub Kicinski if (WARN("ENOTSUPP", 49006b9ea5ffSJakub Kicinski "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) && 49016b9ea5ffSJakub Kicinski $fix) { 49026b9ea5ffSJakub Kicinski $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/; 49036b9ea5ffSJakub Kicinski } 49046b9ea5ffSJakub Kicinski } 49056b9ea5ffSJakub Kicinski 4906653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 4907653d4876SAndy Whitcroft# or if closed on same line 49085b57980dSJoe Perches if ($perl_version_ok && 49092d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 49102d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 49112d453e3bSJoe Perches $sline !~ /}/) { 49128d182478SJoe Perches if (ERROR("OPEN_BRACE", 49132d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 49148d182478SJoe Perches $fix) { 49158d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 49168d182478SJoe Perches my $fixed_line = $rawline; 491703f49351SDwaipayan Ray $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*)\{(.*)$/; 49188d182478SJoe Perches my $line1 = $1; 49198d182478SJoe Perches my $line2 = $2; 49208d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 49218d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 49228d182478SJoe Perches if ($line2 !~ /^\s*$/) { 49238d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 49248d182478SJoe Perches } 49258d182478SJoe Perches } 49260a920b5bSAndy Whitcroft } 4927653d4876SAndy Whitcroft 49288905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 49298905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 49308905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 49318d182478SJoe Perches if (ERROR("OPEN_BRACE", 49328d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 49338d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 49348d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 49358d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 49368d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 49378d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 49388d182478SJoe Perches $fixedline = $rawline; 49398d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 49408d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 49418d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 49428d182478SJoe Perches } 49438d182478SJoe Perches } 49448905a67cSAndy Whitcroft } 49458905a67cSAndy Whitcroft 49460c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 49473705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 49483705ce5bSJoe Perches if (WARN("SPACING", 49493705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 49503705ce5bSJoe Perches $fix) { 4951194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49523705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 49533705ce5bSJoe Perches } 49540c73b4ebSAndy Whitcroft } 49550c73b4ebSAndy Whitcroft 495631070b5dSJoe Perches# Function pointer declarations 495731070b5dSJoe Perches# check spacing between type, funcptr, and args 495831070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 495991f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 496031070b5dSJoe Perches my $declare = $1; 496131070b5dSJoe Perches my $pre_pointer_space = $2; 496231070b5dSJoe Perches my $post_pointer_space = $3; 496331070b5dSJoe Perches my $funcname = $4; 496431070b5dSJoe Perches my $post_funcname_space = $5; 496531070b5dSJoe Perches my $pre_args_space = $6; 496631070b5dSJoe Perches 496791f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 496891f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 496991f72e9cSJoe Perches# don't need a space so don't warn for those. 497091f72e9cSJoe Perches my $post_declare_space = ""; 497191f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 497291f72e9cSJoe Perches $post_declare_space = $1; 497391f72e9cSJoe Perches $declare = rtrim($declare); 497491f72e9cSJoe Perches } 497591f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 497631070b5dSJoe Perches WARN("SPACING", 497731070b5dSJoe Perches "missing space after return type\n" . $herecurr); 497891f72e9cSJoe Perches $post_declare_space = " "; 497931070b5dSJoe Perches } 498031070b5dSJoe Perches 498131070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 498291f72e9cSJoe Perches# This test is not currently implemented because these declarations are 498391f72e9cSJoe Perches# equivalent to 498491f72e9cSJoe Perches# int foo(int bar, ...) 498591f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 498691f72e9cSJoe Perches# 498791f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 498891f72e9cSJoe Perches# WARN("SPACING", 498991f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 499091f72e9cSJoe Perches# } 499131070b5dSJoe Perches 499231070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 499331070b5dSJoe Perches if (defined $pre_pointer_space && 499431070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 499531070b5dSJoe Perches WARN("SPACING", 499631070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 499731070b5dSJoe Perches } 499831070b5dSJoe Perches 499931070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 500031070b5dSJoe Perches if (defined $post_pointer_space && 500131070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 500231070b5dSJoe Perches WARN("SPACING", 500331070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 500431070b5dSJoe Perches } 500531070b5dSJoe Perches 500631070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 500731070b5dSJoe Perches if (defined $post_funcname_space && 500831070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 500931070b5dSJoe Perches WARN("SPACING", 501031070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 501131070b5dSJoe Perches } 501231070b5dSJoe Perches 501331070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 501431070b5dSJoe Perches if (defined $pre_args_space && 501531070b5dSJoe Perches $pre_args_space =~ /^\s/) { 501631070b5dSJoe Perches WARN("SPACING", 501731070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 501831070b5dSJoe Perches } 501931070b5dSJoe Perches 502031070b5dSJoe Perches if (show_type("SPACING") && $fix) { 5021194f66fcSJoe Perches $fixed[$fixlinenr] =~ 502291f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 502331070b5dSJoe Perches } 502431070b5dSJoe Perches } 502531070b5dSJoe Perches 50268d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 50278d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 5028fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 5029fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 50308d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 50318d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 50328d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 5033fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 503438dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 50353705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 50363705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 50373705ce5bSJoe Perches $fix) { 5038194f66fcSJoe Perches $fixed[$fixlinenr] =~ 50393705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 50403705ce5bSJoe Perches } 50418d31cfceSAndy Whitcroft } 50428d31cfceSAndy Whitcroft } 50438d31cfceSAndy Whitcroft 5044f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 50456c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 5046c2fdda0dSAndy Whitcroft my $name = $1; 5047773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 5048773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 5049c2fdda0dSAndy Whitcroft 5050c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 5051773647a0SAndy Whitcroft if ($name =~ /^(?: 5052773647a0SAndy Whitcroft if|for|while|switch|return|case| 5053773647a0SAndy Whitcroft volatile|__volatile__| 5054773647a0SAndy Whitcroft __attribute__|format|__extension__| 505554da6a09SPeter Zijlstra asm|__asm__|scoped_guard)$/x) 5056773647a0SAndy Whitcroft { 5057c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 5058c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 5059c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 5060c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 5061773647a0SAndy Whitcroft 5062773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 5063c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 5064c2fdda0dSAndy Whitcroft 5065c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 5066c2fdda0dSAndy Whitcroft # likely a typedef for a function. 5067773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 5068c2fdda0dSAndy Whitcroft 5069c2fdda0dSAndy Whitcroft } else { 50703705ce5bSJoe Perches if (WARN("SPACING", 50713705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 50723705ce5bSJoe Perches $fix) { 5073194f66fcSJoe Perches $fixed[$fixlinenr] =~ 50743705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 50753705ce5bSJoe Perches } 5076f0a594c1SAndy Whitcroft } 50776c72ffaaSAndy Whitcroft } 50789a4cad4eSEric Nelson 5079653d4876SAndy Whitcroft# Check operator spacing. 50800a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 50813705ce5bSJoe Perches my $fixed_line = ""; 50823705ce5bSJoe Perches my $line_fixed = 0; 50833705ce5bSJoe Perches 50849c0ca6f9SAndy Whitcroft my $ops = qr{ 50859c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 50869c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 50879c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 50881f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 508984731623SJoe Perches \?:|\?|: 50909c0ca6f9SAndy Whitcroft }x; 5091cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 50923705ce5bSJoe Perches 50933705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 50943705ce5bSJoe Perches## foreach my $el (@elements) { 50953705ce5bSJoe Perches## print("el: <$el>\n"); 50963705ce5bSJoe Perches## } 50973705ce5bSJoe Perches 50983705ce5bSJoe Perches my @fix_elements = (); 509900df344fSAndy Whitcroft my $off = 0; 51006c72ffaaSAndy Whitcroft 51013705ce5bSJoe Perches foreach my $el (@elements) { 51023705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 51033705ce5bSJoe Perches $off += length($el); 51043705ce5bSJoe Perches } 51053705ce5bSJoe Perches 51063705ce5bSJoe Perches $off = 0; 51073705ce5bSJoe Perches 51086c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 5109b34c648bSJoe Perches my $last_after = -1; 51106c72ffaaSAndy Whitcroft 51110a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 51123705ce5bSJoe Perches 51133705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 51143705ce5bSJoe Perches 51153705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 51163705ce5bSJoe Perches 51174a0df2efSAndy Whitcroft $off += length($elements[$n]); 51184a0df2efSAndy Whitcroft 511925985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 5120773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 5121773647a0SAndy Whitcroft my $cc = ''; 5122773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 5123773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 5124773647a0SAndy Whitcroft } 5125773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 5126773647a0SAndy Whitcroft 51274a0df2efSAndy Whitcroft my $a = ''; 51284a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 51294a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 5130cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 51314a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 51324a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 5133773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 51344a0df2efSAndy Whitcroft 51350a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 51364a0df2efSAndy Whitcroft 51374a0df2efSAndy Whitcroft my $c = ''; 51380a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 51394a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 51404a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 5141cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 51424a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 51434a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 51448b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 51454a0df2efSAndy Whitcroft } else { 51464a0df2efSAndy Whitcroft $c = 'E'; 51470a920b5bSAndy Whitcroft } 51480a920b5bSAndy Whitcroft 51494a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 51504a0df2efSAndy Whitcroft 51514a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 51524a0df2efSAndy Whitcroft 51536c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 5154de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 51550a920b5bSAndy Whitcroft 515674048ed8SAndy Whitcroft # Pull out the value of this operator. 51576c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 51580a920b5bSAndy Whitcroft 51591f65f947SAndy Whitcroft # Get the full operator variant. 51601f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 51611f65f947SAndy Whitcroft 516213214adfSAndy Whitcroft # Ignore operators passed as parameters. 516313214adfSAndy Whitcroft if ($op_type ne 'V' && 5164d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 516513214adfSAndy Whitcroft 5166cf655043SAndy Whitcroft# # Ignore comments 5167cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 516813214adfSAndy Whitcroft 5169d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 517013214adfSAndy Whitcroft } elsif ($op eq ';') { 5171cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 5172cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 51733705ce5bSJoe Perches if (ERROR("SPACING", 51743705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 5175b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 51763705ce5bSJoe Perches $line_fixed = 1; 51773705ce5bSJoe Perches } 5178d8aaf121SAndy Whitcroft } 5179d8aaf121SAndy Whitcroft 5180d8aaf121SAndy Whitcroft # // is a comment 5181d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 51820a920b5bSAndy Whitcroft 5183b00e4814SJoe Perches # : when part of a bitfield 5184b00e4814SJoe Perches } elsif ($opv eq ':B') { 5185b00e4814SJoe Perches # skip the bitfield test for now 5186b00e4814SJoe Perches 51871f65f947SAndy Whitcroft # No spaces for: 51881f65f947SAndy Whitcroft # -> 5189b00e4814SJoe Perches } elsif ($op eq '->') { 51904a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 51913705ce5bSJoe Perches if (ERROR("SPACING", 51923705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 5193b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 51943705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 51953705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 51963705ce5bSJoe Perches } 5197b34c648bSJoe Perches $line_fixed = 1; 51983705ce5bSJoe Perches } 51990a920b5bSAndy Whitcroft } 52000a920b5bSAndy Whitcroft 52012381097bSJoe Perches # , must not have a space before and must have a space on the right. 52020a920b5bSAndy Whitcroft } elsif ($op eq ',') { 52032381097bSJoe Perches my $rtrim_before = 0; 52042381097bSJoe Perches my $space_after = 0; 52052381097bSJoe Perches if ($ctx =~ /Wx./) { 52062381097bSJoe Perches if (ERROR("SPACING", 52072381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 52082381097bSJoe Perches $line_fixed = 1; 52092381097bSJoe Perches $rtrim_before = 1; 52102381097bSJoe Perches } 52112381097bSJoe Perches } 5212cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 52133705ce5bSJoe Perches if (ERROR("SPACING", 52143705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 52153705ce5bSJoe Perches $line_fixed = 1; 5216b34c648bSJoe Perches $last_after = $n; 52172381097bSJoe Perches $space_after = 1; 52182381097bSJoe Perches } 52192381097bSJoe Perches } 52202381097bSJoe Perches if ($rtrim_before || $space_after) { 52212381097bSJoe Perches if ($rtrim_before) { 52222381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 52232381097bSJoe Perches } else { 52242381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 52252381097bSJoe Perches } 52262381097bSJoe Perches if ($space_after) { 52272381097bSJoe Perches $good .= " "; 52283705ce5bSJoe Perches } 52290a920b5bSAndy Whitcroft } 52300a920b5bSAndy Whitcroft 52319c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 523274048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 52339c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 52349c0ca6f9SAndy Whitcroft 52359c0ca6f9SAndy Whitcroft # unary operators should have a space before and 52369c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 52379c0ca6f9SAndy Whitcroft # unary operator, or a cast 52389c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 523974048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 52400d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 5241cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 52423705ce5bSJoe Perches if (ERROR("SPACING", 52433705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 5244b34c648bSJoe Perches if ($n != $last_after + 2) { 5245b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 52463705ce5bSJoe Perches $line_fixed = 1; 52473705ce5bSJoe Perches } 52480a920b5bSAndy Whitcroft } 5249b34c648bSJoe Perches } 5250a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 5251171ae1a4SAndy Whitcroft # A unary '*' may be const 5252171ae1a4SAndy Whitcroft 5253171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 52543705ce5bSJoe Perches if (ERROR("SPACING", 52553705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 5256b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 52573705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 52583705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 52593705ce5bSJoe Perches } 5260b34c648bSJoe Perches $line_fixed = 1; 52613705ce5bSJoe Perches } 52620a920b5bSAndy Whitcroft } 52630a920b5bSAndy Whitcroft 52640a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 52650a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 5266773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 52673705ce5bSJoe Perches if (ERROR("SPACING", 52683705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 5269b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 52703705ce5bSJoe Perches $line_fixed = 1; 52713705ce5bSJoe Perches } 52720a920b5bSAndy Whitcroft } 5273773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 5274773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 52753705ce5bSJoe Perches if (ERROR("SPACING", 52763705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 5277b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 52783705ce5bSJoe Perches $line_fixed = 1; 52793705ce5bSJoe Perches } 5280653d4876SAndy Whitcroft } 5281773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 52823705ce5bSJoe Perches if (ERROR("SPACING", 52833705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 5284b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 52853705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 52863705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5287773647a0SAndy Whitcroft } 5288b34c648bSJoe Perches $line_fixed = 1; 52893705ce5bSJoe Perches } 52903705ce5bSJoe Perches } 52910a920b5bSAndy Whitcroft 52920a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 52939c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 52949c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 52959c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 5296c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 5297c2fdda0dSAndy Whitcroft $op eq '%') 52980a920b5bSAndy Whitcroft { 5299d2e025f3SJoe Perches if ($check) { 5300d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 5301d2e025f3SJoe Perches if (CHK("SPACING", 5302d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 5303d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 5304d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5305d2e025f3SJoe Perches $line_fixed = 1; 5306d2e025f3SJoe Perches } 5307d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 5308d2e025f3SJoe Perches if (CHK("SPACING", 5309d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 5310d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 5311d2e025f3SJoe Perches $line_fixed = 1; 5312d2e025f3SJoe Perches } 5313d2e025f3SJoe Perches } 5314d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 53153705ce5bSJoe Perches if (ERROR("SPACING", 53163705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 5317b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 5318b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 5319b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5320b34c648bSJoe Perches } 53213705ce5bSJoe Perches $line_fixed = 1; 53223705ce5bSJoe Perches } 53230a920b5bSAndy Whitcroft } 53240a920b5bSAndy Whitcroft 53251f65f947SAndy Whitcroft # A colon needs no spaces before when it is 53261f65f947SAndy Whitcroft # terminating a case value or a label. 53271f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 5328263afd39SChris Down if ($ctx =~ /Wx./ and $realfile !~ m@.*\.lds\.h$@) { 53293705ce5bSJoe Perches if (ERROR("SPACING", 53303705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 5331b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 53323705ce5bSJoe Perches $line_fixed = 1; 53333705ce5bSJoe Perches } 53341f65f947SAndy Whitcroft } 53351f65f947SAndy Whitcroft 53360a920b5bSAndy Whitcroft # All the others need spaces both sides. 5337cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 53381f65f947SAndy Whitcroft my $ok = 0; 53391f65f947SAndy Whitcroft 534022f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 53411f65f947SAndy Whitcroft if (($op eq '<' && 53421f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 53431f65f947SAndy Whitcroft ($op eq '>' && 53441f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 53451f65f947SAndy Whitcroft { 53461f65f947SAndy Whitcroft $ok = 1; 53471f65f947SAndy Whitcroft } 53481f65f947SAndy Whitcroft 5349e0df7e1fSJoe Perches # for asm volatile statements 5350e0df7e1fSJoe Perches # ignore a colon with another 5351e0df7e1fSJoe Perches # colon immediately before or after 5352e0df7e1fSJoe Perches if (($op eq ':') && 5353e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 5354e0df7e1fSJoe Perches $ok = 1; 5355e0df7e1fSJoe Perches } 5356e0df7e1fSJoe Perches 535784731623SJoe Perches # messages are ERROR, but ?: are CHK 53581f65f947SAndy Whitcroft if ($ok == 0) { 53590675a8fbSJean Delvare my $msg_level = \&ERROR; 53600675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 536184731623SJoe Perches 53620675a8fbSJean Delvare if (&{$msg_level}("SPACING", 53633705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 5364b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 5365b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 5366b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 5367b34c648bSJoe Perches } 53683705ce5bSJoe Perches $line_fixed = 1; 53693705ce5bSJoe Perches } 53700a920b5bSAndy Whitcroft } 537122f2a2efSAndy Whitcroft } 53724a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 53733705ce5bSJoe Perches 53743705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 53753705ce5bSJoe Perches 53763705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 53770a920b5bSAndy Whitcroft } 53783705ce5bSJoe Perches 53793705ce5bSJoe Perches if (($#elements % 2) == 0) { 53803705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 53813705ce5bSJoe Perches } 53823705ce5bSJoe Perches 5383194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 5384194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 53853705ce5bSJoe Perches } 53863705ce5bSJoe Perches 53873705ce5bSJoe Perches 53880a920b5bSAndy Whitcroft } 53890a920b5bSAndy Whitcroft 5390786b6326SJoe Perches# check for whitespace before a non-naked semicolon 5391d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 5392786b6326SJoe Perches if (WARN("SPACING", 5393786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 5394786b6326SJoe Perches $fix) { 5395194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 5396786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 5397786b6326SJoe Perches } 5398786b6326SJoe Perches } 5399786b6326SJoe Perches 5400f0a594c1SAndy Whitcroft# check for multiple assignments 5401f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 5402000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 5403000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 5404f0a594c1SAndy Whitcroft } 5405f0a594c1SAndy Whitcroft 540622f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 540722f2a2efSAndy Whitcroft## # continuation. 540822f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 540922f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 541022f2a2efSAndy Whitcroft## 541122f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 5412e73d2715SDwaipayan Ray## # falsely report the parameters of functions. 541322f2a2efSAndy Whitcroft## my $ln = $line; 541422f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 541522f2a2efSAndy Whitcroft## } 541622f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 5417000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 5418000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 541922f2a2efSAndy Whitcroft## } 542022f2a2efSAndy Whitcroft## } 5421f0a594c1SAndy Whitcroft 54220a920b5bSAndy Whitcroft#need space before brace following if, while, etc 54236b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 54246ad724e2SMichal Zylowski $line =~ /\b(?:else|do)\{/) { 54253705ce5bSJoe Perches if (ERROR("SPACING", 54263705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 54273705ce5bSJoe Perches $fix) { 54286ad724e2SMichal Zylowski $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/; 54293705ce5bSJoe Perches } 5430de7d4f0eSAndy Whitcroft } 5431de7d4f0eSAndy Whitcroft 5432c4a62ef9SJoe Perches## # check for blank lines before declarations 5433c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 5434c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 5435c4a62ef9SJoe Perches## WARN("SPACING", 5436c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 5437c4a62ef9SJoe Perches## } 5438c4a62ef9SJoe Perches## 5439c4a62ef9SJoe Perches 5440de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 5441de7d4f0eSAndy Whitcroft# on the line 544294fb9845SJoe Perches if ($line =~ /}(?!(?:,|;|\)|\}))\S/) { 5443d5e616fcSJoe Perches if (ERROR("SPACING", 5444d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 5445d5e616fcSJoe Perches $fix) { 5446194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5447d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 5448d5e616fcSJoe Perches } 54490a920b5bSAndy Whitcroft } 54500a920b5bSAndy Whitcroft 545122f2a2efSAndy Whitcroft# check spacing on square brackets 545222f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 54533705ce5bSJoe Perches if (ERROR("SPACING", 54543705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 54553705ce5bSJoe Perches $fix) { 5456194f66fcSJoe Perches $fixed[$fixlinenr] =~ 54573705ce5bSJoe Perches s/\[\s+/\[/; 54583705ce5bSJoe Perches } 545922f2a2efSAndy Whitcroft } 546022f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 54613705ce5bSJoe Perches if (ERROR("SPACING", 54623705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 54633705ce5bSJoe Perches $fix) { 5464194f66fcSJoe Perches $fixed[$fixlinenr] =~ 54653705ce5bSJoe Perches s/\s+\]/\]/; 54663705ce5bSJoe Perches } 546722f2a2efSAndy Whitcroft } 546822f2a2efSAndy Whitcroft 5469c45dcabdSAndy Whitcroft# check spacing on parentheses 54709c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 54719c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 54723705ce5bSJoe Perches if (ERROR("SPACING", 54733705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 54743705ce5bSJoe Perches $fix) { 5475194f66fcSJoe Perches $fixed[$fixlinenr] =~ 54763705ce5bSJoe Perches s/\(\s+/\(/; 54773705ce5bSJoe Perches } 547822f2a2efSAndy Whitcroft } 547913214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 5480c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 5481c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 54823705ce5bSJoe Perches if (ERROR("SPACING", 54833705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 54843705ce5bSJoe Perches $fix) { 5485194f66fcSJoe Perches $fixed[$fixlinenr] =~ 54863705ce5bSJoe Perches s/\s+\)/\)/; 54873705ce5bSJoe Perches } 548822f2a2efSAndy Whitcroft } 548922f2a2efSAndy Whitcroft 5490e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 5491e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 5492e2826fd0SJoe Perches 5493e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 5494ea4acbb1SJoe Perches my $var = $1; 5495ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 5496ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 5497ea4acbb1SJoe Perches $fix) { 5498ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 5499ea4acbb1SJoe Perches } 5500ea4acbb1SJoe Perches } 5501ea4acbb1SJoe Perches 5502ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 5503ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 5504ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 5505ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 5506ea4acbb1SJoe Perches my $var = $2; 5507ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 5508ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 5509ea4acbb1SJoe Perches $fix) { 5510ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 5511ea4acbb1SJoe Perches $var2 =~ s/\s//g; 5512ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 5513ea4acbb1SJoe Perches } 5514e2826fd0SJoe Perches } 5515e2826fd0SJoe Perches 551663b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 5517a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 5518a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 55195b57980dSJoe Perches $perl_version_ok && defined($stat) && 552063b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 552163b7c73eSJoe Perches my $if_stat = $1; 552263b7c73eSJoe Perches my $test = substr($2, 1, -1); 552363b7c73eSJoe Perches my $herectx; 552463b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 552563b7c73eSJoe Perches my $match = $1; 552663b7c73eSJoe Perches # avoid parentheses around potential macro args 552763b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 552863b7c73eSJoe Perches if (!defined($herectx)) { 552963b7c73eSJoe Perches $herectx = $here . "\n"; 553063b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 553163b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 553263b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 553363b7c73eSJoe Perches $herectx .= $rl . "\n"; 553463b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 553563b7c73eSJoe Perches } 553663b7c73eSJoe Perches } 553763b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 553863b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 553963b7c73eSJoe Perches } 554063b7c73eSJoe Perches } 554163b7c73eSJoe Perches 554269078651SJoe Perches# check that goto labels aren't indented (allow a single space indentation) 554369078651SJoe Perches# and ignore bitfield definitions like foo:1 554469078651SJoe Perches# Strictly, labels can have whitespace after the identifier and before the : 554569078651SJoe Perches# but this is not allowed here as many ?: uses would appear to be labels 554669078651SJoe Perches if ($sline =~ /^.\s+[A-Za-z_][A-Za-z\d_]*:(?!\s*\d+)/ && 554769078651SJoe Perches $sline !~ /^. [A-Za-z\d_][A-Za-z\d_]*:/ && 554869078651SJoe Perches $sline !~ /^.\s+default:/) { 55493705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 55503705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 55513705ce5bSJoe Perches $fix) { 5552194f66fcSJoe Perches $fixed[$fixlinenr] =~ 55533705ce5bSJoe Perches s/^(.)\s+/$1/; 55543705ce5bSJoe Perches } 55550a920b5bSAndy Whitcroft } 55560a920b5bSAndy Whitcroft 555740873abaSJoe Perches# check if a statement with a comma should be two statements like: 555840873abaSJoe Perches# foo = bar(), /* comma should be semicolon */ 555940873abaSJoe Perches# bar = baz(); 556040873abaSJoe Perches if (defined($stat) && 556140873abaSJoe Perches $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) { 556240873abaSJoe Perches my $cnt = statement_rawlines($stat); 556340873abaSJoe Perches my $herectx = get_stat_here($linenr, $cnt, $here); 556440873abaSJoe Perches WARN("SUSPECT_COMMA_SEMICOLON", 556540873abaSJoe Perches "Possible comma where semicolon could be used\n" . $herectx); 556640873abaSJoe Perches } 556740873abaSJoe Perches 55685b9553abSJoe Perches# return is not a function 5569507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 5570c45dcabdSAndy Whitcroft my $spacing = $1; 55715b57980dSJoe Perches if ($perl_version_ok && 55725b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 55735b9553abSJoe Perches my $value = $1; 55745b9553abSJoe Perches $value = deparenthesize($value); 55755b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 5576000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 5577000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 55785b9553abSJoe Perches } 5579c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 5580000d1cc1SJoe Perches ERROR("SPACING", 5581000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 5582c45dcabdSAndy Whitcroft } 5583c45dcabdSAndy Whitcroft } 5584507e5141SJoe Perches 5585b43ae21bSJoe Perches# unnecessary return in a void function 5586b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 5587b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 5588b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 5589b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 5590b43ae21bSJoe Perches $linenr >= 3 && 5591b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 5592b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 55939819cf25SJoe Perches WARN("RETURN_VOID", 5594b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 55959819cf25SJoe Perches } 55969819cf25SJoe Perches 5597189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 55985b57980dSJoe Perches if ($perl_version_ok && 5599189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 5600189248d8SJoe Perches my $openparens = $1; 5601189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 5602189248d8SJoe Perches my $msg = ""; 5603189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 5604189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 5605189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 5606189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 5607189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 5608189248d8SJoe Perches } 5609189248d8SJoe Perches } 5610189248d8SJoe Perches 5611c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 5612c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 5613c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 5614c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 56155b57980dSJoe Perches if ($perl_version_ok && 5616c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 5617c5595fa2SJoe Perches my $lead = $1; 5618c5595fa2SJoe Perches my $const = $2; 5619c5595fa2SJoe Perches my $comp = $3; 5620c5595fa2SJoe Perches my $to = $4; 5621c5595fa2SJoe Perches my $newcomp = $comp; 5622f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 5623c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 5624c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 5625c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 5626c5595fa2SJoe Perches $fix) { 5627c5595fa2SJoe Perches if ($comp eq "<") { 5628c5595fa2SJoe Perches $newcomp = ">"; 5629c5595fa2SJoe Perches } elsif ($comp eq "<=") { 5630c5595fa2SJoe Perches $newcomp = ">="; 5631c5595fa2SJoe Perches } elsif ($comp eq ">") { 5632c5595fa2SJoe Perches $newcomp = "<"; 5633c5595fa2SJoe Perches } elsif ($comp eq ">=") { 5634c5595fa2SJoe Perches $newcomp = "<="; 5635c5595fa2SJoe Perches } 5636c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 5637c5595fa2SJoe Perches } 5638c5595fa2SJoe Perches } 5639c5595fa2SJoe Perches 5640f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 5641f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 564253a3c448SAndy Whitcroft my $name = $1; 564346b85bf9SGuenter Roeck if ($name ne 'EOF' && $name ne 'ERROR' && $name !~ /^EPOLL/) { 5644000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 5645f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 564653a3c448SAndy Whitcroft } 564753a3c448SAndy Whitcroft } 5648c45dcabdSAndy Whitcroft 56490a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 56504a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 56513705ce5bSJoe Perches if (ERROR("SPACING", 56523705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 56533705ce5bSJoe Perches $fix) { 5654194f66fcSJoe Perches $fixed[$fixlinenr] =~ 56553705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 56563705ce5bSJoe Perches } 56570a920b5bSAndy Whitcroft } 56580a920b5bSAndy Whitcroft 5659f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 5660f5fe35ddSAndy Whitcroft# statements after the conditional. 5661170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 56623e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 56633e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 56643e469cdcSAndy Whitcroft if (!defined $stat); 5665170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 5666170d3a22SAndy Whitcroft $remain_next, $off_next); 5667170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 5668170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 5669170d3a22SAndy Whitcroft 5670170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 5671170d3a22SAndy Whitcroft # If the statement carries leading newlines, 5672170d3a22SAndy Whitcroft # then count those as offsets. 5673170d3a22SAndy Whitcroft my ($whitespace) = 5674170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 5675170d3a22SAndy Whitcroft my $offset = 5676170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 5677170d3a22SAndy Whitcroft 5678170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 5679170d3a22SAndy Whitcroft $offset} = 1; 5680170d3a22SAndy Whitcroft } 5681170d3a22SAndy Whitcroft } 5682170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 5683c11230f4SJoe Perches defined($stat) && defined($cond) && 5684170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 5685171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 5686481efd7bSJoe Perches my $fixed_assign_in_if = 0; 56878905a67cSAndy Whitcroft 5688b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 568965b64b3bSJoe Perches if (ERROR("ASSIGN_IN_IF", 569065b64b3bSJoe Perches "do not use assignment in if condition\n" . $herecurr) && 569165b64b3bSJoe Perches $fix && $perl_version_ok) { 569265b64b3bSJoe Perches if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) { 569365b64b3bSJoe Perches my $space = $1; 569465b64b3bSJoe Perches my $not = $2; 569565b64b3bSJoe Perches my $statement = $3; 569665b64b3bSJoe Perches my $assigned = $4; 569765b64b3bSJoe Perches my $test = $8; 569865b64b3bSJoe Perches my $against = $9; 569965b64b3bSJoe Perches my $brace = $15; 570065b64b3bSJoe Perches fix_delete_line($fixlinenr, $rawline); 570165b64b3bSJoe Perches fix_insert_line($fixlinenr, "$space$statement;"); 570265b64b3bSJoe Perches my $newline = "${space}if ("; 570365b64b3bSJoe Perches $newline .= '!' if defined($not); 570465b64b3bSJoe Perches $newline .= '(' if (defined $not && defined($test) && defined($against)); 570565b64b3bSJoe Perches $newline .= "$assigned"; 570665b64b3bSJoe Perches $newline .= " $test $against" if (defined($test) && defined($against)); 570765b64b3bSJoe Perches $newline .= ')' if (defined $not && defined($test) && defined($against)); 570865b64b3bSJoe Perches $newline .= ')'; 570965b64b3bSJoe Perches $newline .= " {" if (defined($brace)); 571065b64b3bSJoe Perches fix_insert_line($fixlinenr + 1, $newline); 5711481efd7bSJoe Perches $fixed_assign_in_if = 1; 571265b64b3bSJoe Perches } 571365b64b3bSJoe Perches } 57148905a67cSAndy Whitcroft } 57158905a67cSAndy Whitcroft 57168905a67cSAndy Whitcroft # Find out what is on the end of the line after the 57178905a67cSAndy Whitcroft # conditional. 5718773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 57198905a67cSAndy Whitcroft $s =~ s/\n.*//g; 572013214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 572153210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 572253210168SAndy Whitcroft $c !~ /}\s*while\s*/) 5723773647a0SAndy Whitcroft { 5724bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 5725bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 5726bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 572742bdf74cSHidetoshi Seto my $stat_real = ''; 5728bb44ad39SAndy Whitcroft 572942bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 573042bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 5731bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 5732bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 5733bb44ad39SAndy Whitcroft } 5734bb44ad39SAndy Whitcroft 5735481efd7bSJoe Perches if (ERROR("TRAILING_STATEMENTS", 5736481efd7bSJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real) && 5737481efd7bSJoe Perches !$fixed_assign_in_if && 5738481efd7bSJoe Perches $cond_lines == 0 && 5739481efd7bSJoe Perches $fix && $perl_version_ok && 5740481efd7bSJoe Perches $fixed[$fixlinenr] =~ /^\+(\s*)((?:if|while|for)\s*$balanced_parens)\s*(.*)$/) { 5741481efd7bSJoe Perches my $indent = $1; 5742481efd7bSJoe Perches my $test = $2; 5743481efd7bSJoe Perches my $rest = rtrim($4); 5744481efd7bSJoe Perches if ($rest =~ /;$/) { 5745481efd7bSJoe Perches $fixed[$fixlinenr] = "\+$indent$test"; 5746481efd7bSJoe Perches fix_insert_line($fixlinenr + 1, "$indent\t$rest"); 5747481efd7bSJoe Perches } 5748481efd7bSJoe Perches } 57498905a67cSAndy Whitcroft } 57508905a67cSAndy Whitcroft } 57518905a67cSAndy Whitcroft 575213214adfSAndy Whitcroft# Check for bitwise tests written as boolean 575313214adfSAndy Whitcroft if ($line =~ / 575413214adfSAndy Whitcroft (?: 575513214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 575613214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 575713214adfSAndy Whitcroft (?:\&\&|\|\|) 575813214adfSAndy Whitcroft | 575913214adfSAndy Whitcroft (?:\&\&|\|\|) 576013214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 576113214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 576213214adfSAndy Whitcroft )/x) 576313214adfSAndy Whitcroft { 5764000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 5765000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 576613214adfSAndy Whitcroft } 576713214adfSAndy Whitcroft 57688905a67cSAndy Whitcroft# if and else should not have general statements after it 576913214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 577013214adfSAndy Whitcroft my $s = $1; 577113214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 577213214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 5773000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5774000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 57750a920b5bSAndy Whitcroft } 577613214adfSAndy Whitcroft } 577739667782SAndy Whitcroft# if should not continue a brace 577839667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 5779000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5780048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 578139667782SAndy Whitcroft $herecurr); 578239667782SAndy Whitcroft } 5783a1080bf8SAndy Whitcroft# case and default should not have general statements after them 5784a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 5785a1080bf8SAndy Whitcroft $line !~ /\G(?: 57863fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 5787a1080bf8SAndy Whitcroft \s*return\s+ 5788a1080bf8SAndy Whitcroft )/xg) 5789a1080bf8SAndy Whitcroft { 5790000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5791000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 5792a1080bf8SAndy Whitcroft } 57930a920b5bSAndy Whitcroft 57940a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 57950a920b5bSAndy Whitcroft # indent level to be relevant to each other. 57968b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 57970a920b5bSAndy Whitcroft $previndent == $indent) { 57988b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 57998b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 58008b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 58018b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 58028b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 58038b8856f4SJoe Perches my $fixedline = $prevrawline; 58048b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 58058b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 58068b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 58078b8856f4SJoe Perches } 58088b8856f4SJoe Perches $fixedline = $rawline; 58098b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 58108b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 58118b8856f4SJoe Perches } 58120a920b5bSAndy Whitcroft } 58130a920b5bSAndy Whitcroft 58148b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 5815c2fdda0dSAndy Whitcroft $previndent == $indent) { 5816c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 5817c2fdda0dSAndy Whitcroft 5818c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 5819c2fdda0dSAndy Whitcroft # conditional. 5820773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 5821c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 5822c2fdda0dSAndy Whitcroft 5823c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 58248b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 58258b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 58268b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 58278b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 58288b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 58298b8856f4SJoe Perches my $fixedline = $prevrawline; 58308b8856f4SJoe Perches my $trailing = $rawline; 58318b8856f4SJoe Perches $trailing =~ s/^\+//; 58328b8856f4SJoe Perches $trailing = trim($trailing); 58338b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 58348b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 58358b8856f4SJoe Perches } 5836c2fdda0dSAndy Whitcroft } 5837c2fdda0dSAndy Whitcroft } 5838c2fdda0dSAndy Whitcroft 583995e2c602SJoe Perches#Specific variable tests 5840323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 5841323c1260SJoe Perches my $var = $1; 584295e2c602SJoe Perches 584395e2c602SJoe Perches#CamelCase 5844807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 5845be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 58464104a206SŁukasz Stelmach#Ignore some autogenerated defines and enum values 58474104a206SŁukasz Stelmach $var !~ /^(?:[A-Z]+_){1,5}[A-Z]{1,3}[a-z]/ && 584822735ce8SJoe Perches#Ignore Page<foo> variants 5849807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 5850d99a4158SGerhard Engleder#Ignore ETHTOOL_LINK_MODE_<foo> variants 5851d99a4158SGerhard Engleder $var !~ /^ETHTOOL_LINK_MODE_/ && 5852d439e6a5SJoe Perches#Ignore SI style variants like nS, mV and dB 5853d439e6a5SJoe Perches#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE) 5854d439e6a5SJoe Perches $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ && 5855f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 5856f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 5857f858e23aSAntonio Borneo while ($var =~ m{\b($Ident)}g) { 58587e781f67SJoe Perches my $word = $1; 58597e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 5860d8b07710SJoe Perches if ($check) { 5861d8b07710SJoe Perches seed_camelcase_includes(); 5862d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 5863d8b07710SJoe Perches seed_camelcase_file($realfile); 5864d8b07710SJoe Perches $camelcase_file_seeded = 1; 5865d8b07710SJoe Perches } 5866d8b07710SJoe Perches } 58677e781f67SJoe Perches if (!defined $camelcase{$word}) { 58687e781f67SJoe Perches $camelcase{$word} = 1; 5869be79794bSJoe Perches CHK("CAMELCASE", 58707e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 58717e781f67SJoe Perches } 5872323c1260SJoe Perches } 5873323c1260SJoe Perches } 58743445686aSJoe Perches } 58750a920b5bSAndy Whitcroft 58760a920b5bSAndy Whitcroft#no spaces allowed after \ in define 5877d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 5878d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 5879d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 5880d5e616fcSJoe Perches $fix) { 5881194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 5882d5e616fcSJoe Perches } 58830a920b5bSAndy Whitcroft } 58840a920b5bSAndy Whitcroft 58850e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 58860e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 5887c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 5888e09dec48SAndy Whitcroft my $file = "$1.h"; 5889e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 5890e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 5891e09dec48SAndy Whitcroft $realfile ne $checkfile && 58927840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 5893c45dcabdSAndy Whitcroft { 58940e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 58950e212e0aSFabian Frederick if ($asminclude > 0) { 5896e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 5897000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 5898000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5899e09dec48SAndy Whitcroft } else { 5900000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 5901000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5902e09dec48SAndy Whitcroft } 59030a920b5bSAndy Whitcroft } 59040a920b5bSAndy Whitcroft } 59050e212e0aSFabian Frederick } 59060a920b5bSAndy Whitcroft 5907653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 5908653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 5909cf655043SAndy Whitcroft# in a known good container 5910b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 5911b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 5912d8aaf121SAndy Whitcroft my $ln = $linenr; 5913d8aaf121SAndy Whitcroft my $cnt = $realcnt; 5914c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 5915c45dcabdSAndy Whitcroft my $ctx = ''; 591608a2843eSJoe Perches my $has_flow_statement = 0; 591708a2843eSJoe Perches my $has_arg_concat = 0; 5918c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 5919f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 5920f74bd194SAndy Whitcroft $ctx = $dstat; 5921c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 5922a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 5923c45dcabdSAndy Whitcroft 592408a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 592562e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 592608a2843eSJoe Perches 5927f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 5928f59b64bfSJoe Perches my $define_args = $1; 5929f59b64bfSJoe Perches my $define_stmt = $dstat; 5930f59b64bfSJoe Perches my @def_args = (); 5931f59b64bfSJoe Perches 5932f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 5933f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 5934f59b64bfSJoe Perches $define_args =~ s/\s*//g; 59358c8c45cfSJoe Perches $define_args =~ s/\\\+?//g; 5936f59b64bfSJoe Perches @def_args = split(",", $define_args); 5937f59b64bfSJoe Perches } 5938f59b64bfSJoe Perches 5939292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 5940c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 5941c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 5942c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 5943c45dcabdSAndy Whitcroft 5944c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 59452e44e803SDwaipayan Ray while ($dstat =~ s/\([^\(\)]*\)/1u/ || 59462e44e803SDwaipayan Ray $dstat =~ s/\{[^\{\}]*\}/1u/ || 59472e44e803SDwaipayan Ray $dstat =~ s/.\[[^\[\]]*\]/1u/) 5948bf30d6edSAndy Whitcroft { 5949c45dcabdSAndy Whitcroft } 5950c45dcabdSAndy Whitcroft 5951342d3d2fSAntonio Borneo # Flatten any obvious string concatenation. 595233acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 595333acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 5954e45bab8eSAndy Whitcroft { 5955e45bab8eSAndy Whitcroft } 5956e45bab8eSAndy Whitcroft 595742e15293SJoe Perches # Make asm volatile uses seem like a generic function 595842e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 595942e15293SJoe Perches 5960c45dcabdSAndy Whitcroft my $exceptions = qr{ 5961c45dcabdSAndy Whitcroft $Declare| 5962c45dcabdSAndy Whitcroft module_param_named| 5963a0a0a7a9SKees Cook MODULE_PARM_DESC| 5964c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 5965c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 5966383099fdSAndy Whitcroft __typeof__\(| 596722fd2d3eSStefani Seibold union| 596822fd2d3eSStefani Seibold struct| 5969ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 59706b10df42SVladimir Zapolskiy ^\"|\"$| 59716b10df42SVladimir Zapolskiy ^\[ 5972c45dcabdSAndy Whitcroft }x; 59735eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 5974f59b64bfSJoe Perches 5975f59b64bfSJoe Perches $ctx =~ s/\n*$//; 5976f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 5977e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 5978f59b64bfSJoe Perches 5979f74bd194SAndy Whitcroft if ($dstat ne '' && 5980f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 5981f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 59823cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 5983356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5984f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 5985f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5986e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 5987dc3f4deeSStanislaw Gruszka $dstat !~ /^case\b/ && # case ... 598872f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 59892e44e803SDwaipayan Ray $dstat !~ /^while\s*$Constant\s*$Constant\s*$/ && # while (...) {...} 5990f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5991f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5992f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 59934e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5994f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5995c45dcabdSAndy Whitcroft { 5996e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5997e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5998e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5999e795556aSJoe Perches } elsif ($dstat =~ /;/) { 6000f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 6001f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 6002f74bd194SAndy Whitcroft } else { 6003000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 6004388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 6005d8aaf121SAndy Whitcroft } 6006f59b64bfSJoe Perches 6007f59b64bfSJoe Perches } 60085207649bSJoe Perches 60095207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 60105207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 60115207649bSJoe Perches my $first = 1; 60125207649bSJoe Perches $define_stmt = ""; 60135207649bSJoe Perches foreach my $l (@stmt_array) { 60145207649bSJoe Perches $l =~ s/\\$//; 60155207649bSJoe Perches if ($first) { 60165207649bSJoe Perches $define_stmt = $l; 60175207649bSJoe Perches $first = 0; 60185207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 60195207649bSJoe Perches $define_stmt .= substr($l, 1); 60205207649bSJoe Perches } 60215207649bSJoe Perches } 60225207649bSJoe Perches $define_stmt =~ s/$;//g; 60235207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 60245207649bSJoe Perches $define_stmt = trim($define_stmt); 60255207649bSJoe Perches 6026f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 6027f59b64bfSJoe Perches foreach my $arg (@def_args) { 6028f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 60299192d41aSJoe Perches next if ($arg =~ /^type$/i); 60307fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 60317b844345SVincent 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; 60327fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 60337fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 6034d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 6035f59b64bfSJoe Perches if ($use_cnt > 1) { 6036f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 6037f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 6038f59b64bfSJoe Perches } 60399192d41aSJoe Perches# check if any macro arguments may have other precedence issues 60407fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 60419192d41aSJoe Perches ((defined($1) && $1 ne ',') || 60429192d41aSJoe Perches (defined($2) && $2 ne ','))) { 60439192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 60449192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 60459192d41aSJoe Perches } 6046b1be5844SXining Xu 6047b1be5844SXining Xu# check if this is an unused argument 6048b1be5844SXining Xu if ($define_stmt !~ /\b$arg\b/) { 6049b1be5844SXining Xu WARN("MACRO_ARG_UNUSED", 6050b1be5844SXining Xu "Argument '$arg' is not used in function-like macro\n" . "$herectx"); 6051b1be5844SXining Xu } 60520a920b5bSAndy Whitcroft } 60535023d347SJoe Perches 605408a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 605508a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 605608a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 605708a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 6058e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 605908a2843eSJoe Perches 606008a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 606108a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 606208a2843eSJoe Perches } 606308a2843eSJoe Perches 6064481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 60655023d347SJoe Perches 60665b2c7334SJim Cromie } elsif ($realfile =~ m@/vmlinux.lds.h$@) { 60675b2c7334SJim Cromie $line =~ s/(\w+)/$maybe_linker_symbol{$1}++/ge; 60685b2c7334SJim Cromie #print "REAL: $realfile\nln: $line\nkeys:", sort keys %maybe_linker_symbol; 60695023d347SJoe Perches } else { 60705023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 6071481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 6072481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 60735023d347SJoe Perches $line =~ /^\+.*\\$/) { 60745023d347SJoe Perches WARN("LINE_CONTINUATIONS", 60755023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 60765023d347SJoe Perches } 6077653d4876SAndy Whitcroft } 60780a920b5bSAndy Whitcroft 6079b13edf7fSJoe Perches# do {} while (0) macro tests: 6080b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 6081b13edf7fSJoe Perches# macro should not end with a semicolon 60825b57980dSJoe Perches if ($perl_version_ok && 6083b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 6084b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 6085b13edf7fSJoe Perches my $ln = $linenr; 6086b13edf7fSJoe Perches my $cnt = $realcnt; 6087b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 6088b13edf7fSJoe Perches my $ctx = ''; 6089b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 6090b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 6091b13edf7fSJoe Perches $ctx = $dstat; 6092b13edf7fSJoe Perches 6093b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 60941b36b201SJoe Perches $dstat =~ s/$;/ /g; 6095b13edf7fSJoe Perches 6096b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 6097b13edf7fSJoe Perches my $stmts = $2; 6098b13edf7fSJoe Perches my $semis = $3; 6099b13edf7fSJoe Perches 6100b13edf7fSJoe Perches $ctx =~ s/\n*$//; 6101b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 6102e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6103b13edf7fSJoe Perches 6104ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 6105ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 6106b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 6107b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 6108b13edf7fSJoe Perches } 6109b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 6110b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 6111b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 6112b13edf7fSJoe Perches } 6113f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 6114f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 6115f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 6116e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6117f5ef95b1SJoe Perches 6118f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 6119f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 6120b13edf7fSJoe Perches } 6121b13edf7fSJoe Perches } 6122b13edf7fSJoe Perches 6123f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 612413214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 612513214adfSAndy Whitcroft my ($level, $endln, @chunks) = 6126cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 612713214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 6128cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 6129cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 6130aad4f614SJoe Perches my @allowed = (); 6131aad4f614SJoe Perches my $allow = 0; 613213214adfSAndy Whitcroft my $seen = 0; 6133773647a0SAndy Whitcroft my $herectx = $here . "\n"; 6134cf655043SAndy Whitcroft my $ln = $linenr - 1; 613513214adfSAndy Whitcroft for my $chunk (@chunks) { 613613214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 613713214adfSAndy Whitcroft 6138773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 6139773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 6140773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 6141773647a0SAndy Whitcroft 6142aad4f614SJoe Perches $allowed[$allow] = 0; 6143773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 6144773647a0SAndy Whitcroft 6145773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 6146773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 6147773647a0SAndy Whitcroft 6148773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 6149cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 6150cf655043SAndy Whitcroft 6151773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 615213214adfSAndy Whitcroft 615313214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 615413214adfSAndy Whitcroft 6155aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 6156cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 6157cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 6158aad4f614SJoe Perches $allowed[$allow] = 1; 615913214adfSAndy Whitcroft } 616013214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 6161cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 6162aad4f614SJoe Perches $allowed[$allow] = 1; 616313214adfSAndy Whitcroft } 6164cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 6165cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 6166aad4f614SJoe Perches $allowed[$allow] = 1; 616713214adfSAndy Whitcroft } 6168aad4f614SJoe Perches $allow++; 616913214adfSAndy Whitcroft } 6170aad4f614SJoe Perches if ($seen) { 6171aad4f614SJoe Perches my $sum_allowed = 0; 6172aad4f614SJoe Perches foreach (@allowed) { 6173aad4f614SJoe Perches $sum_allowed += $_; 6174aad4f614SJoe Perches } 6175aad4f614SJoe Perches if ($sum_allowed == 0) { 6176000d1cc1SJoe Perches WARN("BRACES", 6177000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 6178aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 6179aad4f614SJoe Perches $seen != $allow) { 6180aad4f614SJoe Perches CHK("BRACES", 6181aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 6182aad4f614SJoe Perches } 618313214adfSAndy Whitcroft } 618413214adfSAndy Whitcroft } 618513214adfSAndy Whitcroft } 6186773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 618713214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 6188cf655043SAndy Whitcroft my $allowed = 0; 6189f0a594c1SAndy Whitcroft 6190cf655043SAndy Whitcroft # Check the pre-context. 6191cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 6192cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 6193cf655043SAndy Whitcroft $allowed = 1; 6194f0a594c1SAndy Whitcroft } 6195773647a0SAndy Whitcroft 6196773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 6197773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 6198773647a0SAndy Whitcroft 6199cf655043SAndy Whitcroft # Check the condition. 6200cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 6201773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 6202cf655043SAndy Whitcroft if (defined $cond) { 6203773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 6204cf655043SAndy Whitcroft } 6205cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 6206cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 6207cf655043SAndy Whitcroft $allowed = 1; 6208cf655043SAndy Whitcroft } 6209cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 6210cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 6211cf655043SAndy Whitcroft $allowed = 1; 6212cf655043SAndy Whitcroft } 6213cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 6214cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 6215cf655043SAndy Whitcroft $allowed = 1; 6216cf655043SAndy Whitcroft } 6217cf655043SAndy Whitcroft # Check the post-context. 6218cf655043SAndy Whitcroft if (defined $chunks[1]) { 6219cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 6220cf655043SAndy Whitcroft if (defined $cond) { 6221773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 6222cf655043SAndy Whitcroft } 6223cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 6224cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 6225cf655043SAndy Whitcroft $allowed = 1; 6226cf655043SAndy Whitcroft } 6227cf655043SAndy Whitcroft } 6228cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 6229f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 6230e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6231cf655043SAndy Whitcroft 6232000d1cc1SJoe Perches WARN("BRACES", 6233000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 6234f0a594c1SAndy Whitcroft } 6235f0a594c1SAndy Whitcroft } 6236f0a594c1SAndy Whitcroft 6237e4c5babdSJoe Perches# check for single line unbalanced braces 623895330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 623995330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 6240e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 6241e4c5babdSJoe Perches } 6242e4c5babdSJoe Perches 62430979ae66SJoe Perches# check for unnecessary blank lines around braces 624477b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 6245f8e58219SJoe Perches if (CHK("BRACES", 6246f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 6247f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 6248f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 6249f8e58219SJoe Perches } 62500979ae66SJoe Perches } 625177b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 6252f8e58219SJoe Perches if (CHK("BRACES", 6253f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 6254f8e58219SJoe Perches $fix) { 6255f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 6256f8e58219SJoe Perches } 62570979ae66SJoe Perches } 62580979ae66SJoe Perches 62594a0df2efSAndy Whitcroft# no volatiles please 62606c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 62616c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 6262000d1cc1SJoe Perches WARN("VOLATILE", 62638c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 62644a0df2efSAndy Whitcroft } 62654a0df2efSAndy Whitcroft 62665e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 62675e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 62685e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 62695e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 627033acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 62715e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 62725e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 62735e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 62745e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 62755e4f6ba5SJoe Perches $fix && 62765e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 62775e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 62785e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 62795e4f6ba5SJoe Perches my $comma_close = ""; 62805e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 62815e4f6ba5SJoe Perches $comma_close = $1; 62825e4f6ba5SJoe Perches } 62835e4f6ba5SJoe Perches 62845e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 62855e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 62865e4f6ba5SJoe Perches my $fixedline = $prevrawline; 62875e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 62885e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 62895e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 62905e4f6ba5SJoe Perches $fixedline = $rawline; 62915e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 62925e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 62935e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 62945e4f6ba5SJoe Perches } 62955e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 62965e4f6ba5SJoe Perches } 62975e4f6ba5SJoe Perches } 62985e4f6ba5SJoe Perches 62995e4f6ba5SJoe Perches# check for missing a space in a string concatenation 63005e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 63015e4f6ba5SJoe Perches WARN('MISSING_SPACE', 63025e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 63035e4f6ba5SJoe Perches } 63045e4f6ba5SJoe Perches 630577cb8546SJoe Perches# check for an embedded function name in a string when the function is known 6306e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 6307e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 6308e4b7d309SJoe Perches# function declarations 630977cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 631077cb8546SJoe Perches defined($context_function) && 6311e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 6312e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 631377cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 6314e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 631577cb8546SJoe Perches } 631677cb8546SJoe Perches 6317adb2da82SJoe Perches# check for unnecessary function tracing like uses 6318adb2da82SJoe Perches# This does not use $logFunctions because there are many instances like 6319adb2da82SJoe Perches# 'dprintk(FOO, "%s()\n", __func__);' which do not match $logFunctions 6320adb2da82SJoe Perches if ($rawline =~ /^\+.*\([^"]*"$tracing_logging_tags{0,3}%s(?:\s*\(\s*\)\s*)?$tracing_logging_tags{0,3}(?:\\n)?"\s*,\s*__func__\s*\)\s*;/) { 6321adb2da82SJoe Perches if (WARN("TRACING_LOGGING", 6322adb2da82SJoe Perches "Unnecessary ftrace-like logging - prefer using ftrace\n" . $herecurr) && 6323adb2da82SJoe Perches $fix) { 6324adb2da82SJoe Perches fix_delete_line($fixlinenr, $rawline); 6325adb2da82SJoe Perches } 6326adb2da82SJoe Perches } 6327adb2da82SJoe Perches 63285e4f6ba5SJoe Perches# check for spaces before a quoted newline 63295e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 63305e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 63315e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 63325e4f6ba5SJoe Perches $fix) { 63335e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 63345e4f6ba5SJoe Perches } 63355e4f6ba5SJoe Perches 63365e4f6ba5SJoe Perches } 63375e4f6ba5SJoe Perches 6338f17dba4fSJoe Perches# concatenated string without spaces between elements 6339d2af5aa6SJoe Perches if ($line =~ /$String[A-Z_]/ || 6340d2af5aa6SJoe Perches ($line =~ /([A-Za-z0-9_]+)$String/ && $1 !~ /^[Lu]$/)) { 634179682c0cSJoe Perches if (CHK("CONCATENATED_STRING", 634279682c0cSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr) && 634379682c0cSJoe Perches $fix) { 634479682c0cSJoe Perches while ($line =~ /($String)/g) { 634579682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 634679682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/; 634779682c0cSJoe Perches $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/; 634879682c0cSJoe Perches } 634979682c0cSJoe Perches } 6350f17dba4fSJoe Perches } 6351f17dba4fSJoe Perches 635290ad30e5SJoe Perches# uncoalesced string fragments 6353d2af5aa6SJoe Perches if ($line =~ /$String\s*[Lu]?"/) { 635479682c0cSJoe Perches if (WARN("STRING_FRAGMENTS", 635579682c0cSJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr) && 635679682c0cSJoe Perches $fix) { 635779682c0cSJoe Perches while ($line =~ /($String)(?=\s*")/g) { 635879682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 635979682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e; 636079682c0cSJoe Perches } 636179682c0cSJoe Perches } 636290ad30e5SJoe Perches } 636390ad30e5SJoe Perches 6364522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 6365522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 6366522b837cSAlexey Dobriyan my $show_Z = 1; 63675e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 6368522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 63695e4f6ba5SJoe Perches $string =~ s/%%/__/g; 6370522b837cSAlexey Dobriyan # check for %L 6371522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 63725e4f6ba5SJoe Perches WARN("PRINTF_L", 6373522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 6374522b837cSAlexey Dobriyan $show_L = 0; 63755e4f6ba5SJoe Perches } 6376522b837cSAlexey Dobriyan # check for %Z 6377522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 6378522b837cSAlexey Dobriyan WARN("PRINTF_Z", 6379522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 6380522b837cSAlexey Dobriyan $show_Z = 0; 6381522b837cSAlexey Dobriyan } 6382522b837cSAlexey Dobriyan # check for 0x<decimal> 6383522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 6384522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 63856e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 63866e300757SJoe Perches } 63875e4f6ba5SJoe Perches } 63885e4f6ba5SJoe Perches 63895e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 63903f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 63915e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 63925e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 63935e4f6ba5SJoe Perches } 63945e4f6ba5SJoe Perches 639500df344fSAndy Whitcroft# warn about #if 0 6396c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 639760f89010SPrakruthi Deepak Heragu WARN("IF_0", 639860f89010SPrakruthi Deepak Heragu "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr); 639960f89010SPrakruthi Deepak Heragu } 640060f89010SPrakruthi Deepak Heragu 640160f89010SPrakruthi Deepak Heragu# warn about #if 1 640260f89010SPrakruthi Deepak Heragu if ($line =~ /^.\s*\#\s*if\s+1\b/) { 640360f89010SPrakruthi Deepak Heragu WARN("IF_1", 640460f89010SPrakruthi Deepak Heragu "Consider removing the #if 1 and its #endif\n" . $herecurr); 64054a0df2efSAndy Whitcroft } 64064a0df2efSAndy Whitcroft 640703df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 640803df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 6409100425deSJoe Perches my $tested = quotemeta($1); 6410100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 6411100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 6412100425deSJoe Perches my $func = $1; 6413100425deSJoe Perches if (WARN('NEEDLESS_IF', 6414100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 6415100425deSJoe Perches $fix) { 6416100425deSJoe Perches my $do_fix = 1; 6417100425deSJoe Perches my $leading_tabs = ""; 6418100425deSJoe Perches my $new_leading_tabs = ""; 6419100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 6420100425deSJoe Perches $leading_tabs = $1; 6421100425deSJoe Perches } else { 6422100425deSJoe Perches $do_fix = 0; 6423100425deSJoe Perches } 6424100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 6425100425deSJoe Perches $new_leading_tabs = $1; 6426100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 6427100425deSJoe Perches $do_fix = 0; 6428100425deSJoe Perches } 6429100425deSJoe Perches } else { 6430100425deSJoe Perches $do_fix = 0; 6431100425deSJoe Perches } 6432100425deSJoe Perches if ($do_fix) { 6433100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 6434100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 6435100425deSJoe Perches } 6436100425deSJoe Perches } 64374c432a8fSGreg Kroah-Hartman } 64384c432a8fSGreg Kroah-Hartman } 6439f0a594c1SAndy Whitcroft 6440ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 6441ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 6442ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 6443ebfdc409SJoe Perches (defined $1 || defined $3) && 6444ebfdc409SJoe Perches $linenr > 3) { 6445ebfdc409SJoe Perches my $testval = $2; 6446ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 6447ebfdc409SJoe Perches 6448ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 6449ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 6450ebfdc409SJoe Perches 6451e29a70f1SJoe Perches if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ && 6452e29a70f1SJoe Perches $s !~ /\b__GFP_NOWARN\b/ ) { 6453ebfdc409SJoe Perches WARN("OOM_MESSAGE", 6454ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 6455ebfdc409SJoe Perches } 6456ebfdc409SJoe Perches } 6457ebfdc409SJoe Perches 6458f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 6459dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 6460f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 6461f78d98f6SJoe Perches my $level = $1; 6462f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 6463f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 6464f78d98f6SJoe Perches $fix) { 6465f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 6466f78d98f6SJoe Perches } 6467f78d98f6SJoe Perches } 6468f78d98f6SJoe Perches 646945c55e92SJoe Perches# check for logging continuations 647045c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 647145c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 647245c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 647345c55e92SJoe Perches } 647445c55e92SJoe Perches 647570eb2275SDwaipayan Ray# check for unnecessary use of %h[xudi] and %hh[xudi] in logging functions 647670eb2275SDwaipayan Ray if (defined $stat && 647770eb2275SDwaipayan Ray $line =~ /\b$logFunctions\s*\(/ && 647870eb2275SDwaipayan Ray index($stat, '"') >= 0) { 647970eb2275SDwaipayan Ray my $lc = $stat =~ tr@\n@@; 648070eb2275SDwaipayan Ray $lc = $lc + $linenr; 648170eb2275SDwaipayan Ray my $stat_real = get_stat_real($linenr, $lc); 648270eb2275SDwaipayan Ray pos($stat_real) = index($stat_real, '"'); 648370eb2275SDwaipayan Ray while ($stat_real =~ /[^\"%]*(%[\#\d\.\*\-]*(h+)[idux])/g) { 648470eb2275SDwaipayan Ray my $pspec = $1; 648570eb2275SDwaipayan Ray my $h = $2; 648670eb2275SDwaipayan Ray my $lineoff = substr($stat_real, 0, $-[1]) =~ tr@\n@@; 648770eb2275SDwaipayan Ray if (WARN("UNNECESSARY_MODIFIER", 648870eb2275SDwaipayan Ray "Integer promotion: Using '$h' in '$pspec' is unnecessary\n" . "$here\n$stat_real\n") && 648970eb2275SDwaipayan Ray $fix && $fixed[$fixlinenr + $lineoff] =~ /^\+/) { 649070eb2275SDwaipayan Ray my $nspec = $pspec; 649170eb2275SDwaipayan Ray $nspec =~ s/h//g; 649270eb2275SDwaipayan Ray $fixed[$fixlinenr + $lineoff] =~ s/\Q$pspec\E/$nspec/; 649370eb2275SDwaipayan Ray } 649470eb2275SDwaipayan Ray } 649570eb2275SDwaipayan Ray } 649670eb2275SDwaipayan Ray 6497abb08a53SJoe Perches# check for mask then right shift without a parentheses 64985b57980dSJoe Perches if ($perl_version_ok && 6499abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 6500abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 6501abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 6502abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 6503abb08a53SJoe Perches } 6504abb08a53SJoe Perches 6505b75ac618SJoe Perches# check for pointer comparisons to NULL 65065b57980dSJoe Perches if ($perl_version_ok) { 6507b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 6508b75ac618SJoe Perches my $val = $1; 6509b75ac618SJoe Perches my $equal = "!"; 6510b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 6511b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 6512b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 6513b75ac618SJoe Perches $fix) { 6514b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 6515b75ac618SJoe Perches } 6516b75ac618SJoe Perches } 6517b75ac618SJoe Perches } 6518b75ac618SJoe Perches 65198716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 65208716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 65218716de38SJoe Perches my $attr = $1; 65228716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 65238716de38SJoe Perches my $ptr = $1; 65248716de38SJoe Perches my $var = $2; 65258716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 65268716de38SJoe Perches ERROR("MISPLACED_INIT", 65278716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 65288716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 65298716de38SJoe Perches WARN("MISPLACED_INIT", 65308716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 65318716de38SJoe Perches $fix) { 6532194f66fcSJoe 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; 65338716de38SJoe Perches } 65348716de38SJoe Perches } 65358716de38SJoe Perches } 65368716de38SJoe Perches 6537e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 6538e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 6539e970b884SJoe Perches my $attr = $1; 6540e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 6541e970b884SJoe Perches my $attr_prefix = $1; 6542e970b884SJoe Perches my $attr_type = $2; 6543e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 6544e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 6545e970b884SJoe Perches $fix) { 6546194f66fcSJoe Perches $fixed[$fixlinenr] =~ 6547e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 6548e970b884SJoe Perches } 6549e970b884SJoe Perches } 6550e970b884SJoe Perches 6551e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 6552e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 6553e970b884SJoe Perches my $attr = $1; 6554e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 6555e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 6556e970b884SJoe Perches $fix) { 6557194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 6558e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 6559e970b884SJoe Perches $lead = rtrim($1); 6560e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 6561e970b884SJoe Perches $lead = "${lead}const "; 6562194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 6563e970b884SJoe Perches } 6564e970b884SJoe Perches } 6565e970b884SJoe Perches 6566c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 6567c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 6568c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 6569c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 6570c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 6571c17893c7SJoe Perches $fix) { 6572c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 6573c17893c7SJoe Perches } 6574c17893c7SJoe Perches } 6575c17893c7SJoe Perches 6576fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 6577fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 6578fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 6579fbdb8138SJoe Perches my $constant_func = $1; 6580fbdb8138SJoe Perches my $func = $constant_func; 6581fbdb8138SJoe Perches $func =~ s/^__constant_//; 6582fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 6583fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 6584fbdb8138SJoe Perches $fix) { 6585194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 6586fbdb8138SJoe Perches } 6587fbdb8138SJoe Perches } 6588fbdb8138SJoe Perches 65891a15a250SPatrick Pannuto# prefer usleep_range over udelay 659037581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 659143c1d77cSJoe Perches my $delay = $1; 65921a15a250SPatrick Pannuto # ignore udelay's < 10, however 659343c1d77cSJoe Perches if (! ($delay < 10) ) { 6594000d1cc1SJoe Perches CHK("USLEEP_RANGE", 6595458f69efSMauro Carvalho Chehab "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr); 659643c1d77cSJoe Perches } 659743c1d77cSJoe Perches if ($delay > 2000) { 659843c1d77cSJoe Perches WARN("LONG_UDELAY", 659943c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 66001a15a250SPatrick Pannuto } 66011a15a250SPatrick Pannuto } 66021a15a250SPatrick Pannuto 660309ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 660409ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 660509ef8725SPatrick Pannuto if ($1 < 20) { 6606000d1cc1SJoe Perches WARN("MSLEEP", 6607458f69efSMauro Carvalho Chehab "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr); 660809ef8725SPatrick Pannuto } 660909ef8725SPatrick Pannuto } 661009ef8725SPatrick Pannuto 661136ec1939SJoe Perches# check for comparisons of jiffies 661236ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 661336ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 661436ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 661536ec1939SJoe Perches } 661636ec1939SJoe Perches 66179d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 66189d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 66199d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 66209d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 66219d7a34a5SJoe Perches } 66229d7a34a5SJoe Perches 662300df344fSAndy Whitcroft# warn about #ifdefs in C files 6624c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 662500df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 662600df344fSAndy Whitcroft# print "$herecurr"; 662700df344fSAndy Whitcroft# $clean = 0; 662800df344fSAndy Whitcroft# } 662900df344fSAndy Whitcroft 663022f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 6631c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 66323705ce5bSJoe Perches if (ERROR("SPACING", 66333705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 66343705ce5bSJoe Perches $fix) { 6635194f66fcSJoe Perches $fixed[$fixlinenr] =~ 66363705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 66373705ce5bSJoe Perches } 66383705ce5bSJoe Perches 663922f2a2efSAndy Whitcroft } 664022f2a2efSAndy Whitcroft 66414a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 6642171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 6643171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 66444a0df2efSAndy Whitcroft my $which = $1; 66454a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 6646000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 6647000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 66484a0df2efSAndy Whitcroft } 66494a0df2efSAndy Whitcroft } 66504a0df2efSAndy Whitcroft# check for memory barriers without a comment. 6651402c2553SMichael S. Tsirkin 6652402c2553SMichael S. Tsirkin my $barriers = qr{ 6653402c2553SMichael S. Tsirkin mb| 6654402c2553SMichael S. Tsirkin rmb| 6655ad83ec6cSWill Deacon wmb 6656402c2553SMichael S. Tsirkin }x; 6657402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 6658402c2553SMichael S. Tsirkin mb__before_atomic| 6659402c2553SMichael S. Tsirkin mb__after_atomic| 6660402c2553SMichael S. Tsirkin store_release| 6661402c2553SMichael S. Tsirkin load_acquire| 6662402c2553SMichael S. Tsirkin store_mb| 6663402c2553SMichael S. Tsirkin (?:$barriers) 6664402c2553SMichael S. Tsirkin }x; 6665402c2553SMichael S. Tsirkin my $all_barriers = qr{ 6666402c2553SMichael S. Tsirkin (?:$barriers)| 666743e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 666843e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 6669402c2553SMichael S. Tsirkin }x; 6670402c2553SMichael S. Tsirkin 6671402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 66724a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 6673c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 6674000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 66754a0df2efSAndy Whitcroft } 66764a0df2efSAndy Whitcroft } 66773ad81779SPaul E. McKenney 6678f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 6679f4073b0fSMichael S. Tsirkin 6680f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 6681f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 6682f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 6683f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 6684f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 6685f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 6686f4073b0fSMichael S. Tsirkin } 6687f4073b0fSMichael S. Tsirkin 6688cb426e99SJoe Perches# check for waitqueue_active without a comment. 6689cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 6690cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 6691cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 6692cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 6693cb426e99SJoe Perches } 6694cb426e99SJoe Perches } 66953ad81779SPaul E. McKenney 66965099a722SMarco Elver# check for data_race without a comment. 66975099a722SMarco Elver if ($line =~ /\bdata_race\s*\(/) { 66985099a722SMarco Elver if (!ctx_has_comment($first_line, $linenr)) { 66995099a722SMarco Elver WARN("DATA_RACE", 67005099a722SMarco Elver "data_race without comment\n" . $herecurr); 67015099a722SMarco Elver } 67025099a722SMarco Elver } 67035099a722SMarco Elver 67044a0df2efSAndy Whitcroft# check of hardware specific defines 6705c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 6706000d1cc1SJoe Perches CHK("ARCH_DEFINES", 6707000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 67080a920b5bSAndy Whitcroft } 6709653d4876SAndy Whitcroft 6710596ed45bSJoe Perches# check that the storage class is not after a type 6711596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 6712000d1cc1SJoe Perches WARN("STORAGE_CLASS", 6713596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 6714596ed45bSJoe Perches } 6715596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 6716596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 6717596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 6718596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 6719596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 6720596ed45bSJoe Perches WARN("STORAGE_CLASS", 6721596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 6722d4977c78STobias Klauser } 6723d4977c78STobias Klauser 6724de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 6725de7d4f0eSAndy Whitcroft# storage class and type. 67269c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 67279c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 6728000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 6729000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 6730de7d4f0eSAndy Whitcroft } 6731de7d4f0eSAndy Whitcroft 67328905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 67332b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 67342b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 6735d5e616fcSJoe Perches if (WARN("INLINE", 6736d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 6737d5e616fcSJoe Perches $fix) { 6738194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 6739d5e616fcSJoe Perches 6740d5e616fcSJoe Perches } 67418905a67cSAndy Whitcroft } 67428905a67cSAndy Whitcroft 67437ebe1d17SDwaipayan Ray# Check for compiler attributes 67442b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 67457ebe1d17SDwaipayan Ray $rawline =~ /\b__attribute__\s*\(\s*($balanced_parens)\s*\)/) { 67467ebe1d17SDwaipayan Ray my $attr = $1; 67477ebe1d17SDwaipayan Ray $attr =~ s/\s*\(\s*(.*)\)\s*/$1/; 67487ebe1d17SDwaipayan Ray 67497ebe1d17SDwaipayan Ray my %attr_list = ( 67500830aab0SJoe Perches "alias" => "__alias", 67517ebe1d17SDwaipayan Ray "aligned" => "__aligned", 67527ebe1d17SDwaipayan Ray "always_inline" => "__always_inline", 67537ebe1d17SDwaipayan Ray "assume_aligned" => "__assume_aligned", 67547ebe1d17SDwaipayan Ray "cold" => "__cold", 67557ebe1d17SDwaipayan Ray "const" => "__attribute_const__", 67567ebe1d17SDwaipayan Ray "copy" => "__copy", 67577ebe1d17SDwaipayan Ray "designated_init" => "__designated_init", 67587ebe1d17SDwaipayan Ray "externally_visible" => "__visible", 67597ebe1d17SDwaipayan Ray "format" => "printf|scanf", 67607ebe1d17SDwaipayan Ray "gnu_inline" => "__gnu_inline", 67617ebe1d17SDwaipayan Ray "malloc" => "__malloc", 67627ebe1d17SDwaipayan Ray "mode" => "__mode", 67637ebe1d17SDwaipayan Ray "no_caller_saved_registers" => "__no_caller_saved_registers", 67647ebe1d17SDwaipayan Ray "noclone" => "__noclone", 67657ebe1d17SDwaipayan Ray "noinline" => "noinline", 67667ebe1d17SDwaipayan Ray "nonstring" => "__nonstring", 67677ebe1d17SDwaipayan Ray "noreturn" => "__noreturn", 67687ebe1d17SDwaipayan Ray "packed" => "__packed", 67697ebe1d17SDwaipayan Ray "pure" => "__pure", 6770339f29d9SJoe Perches "section" => "__section", 67710830aab0SJoe Perches "used" => "__used", 67720830aab0SJoe Perches "weak" => "__weak" 67737ebe1d17SDwaipayan Ray ); 67747ebe1d17SDwaipayan Ray 67757ebe1d17SDwaipayan Ray while ($attr =~ /\s*(\w+)\s*(${balanced_parens})?/g) { 6776339f29d9SJoe Perches my $orig_attr = $1; 67777ebe1d17SDwaipayan Ray my $params = ''; 67787ebe1d17SDwaipayan Ray $params = $2 if defined($2); 6779339f29d9SJoe Perches my $curr_attr = $orig_attr; 67807ebe1d17SDwaipayan Ray $curr_attr =~ s/^[\s_]+|[\s_]+$//g; 67817ebe1d17SDwaipayan Ray if (exists($attr_list{$curr_attr})) { 6782339f29d9SJoe Perches my $new = $attr_list{$curr_attr}; 67837ebe1d17SDwaipayan Ray if ($curr_attr eq "format" && $params) { 67847ebe1d17SDwaipayan Ray $params =~ /^\s*\(\s*(\w+)\s*,\s*(.*)/; 6785339f29d9SJoe Perches $new = "__$1\($2"; 67867ebe1d17SDwaipayan Ray } else { 6787339f29d9SJoe Perches $new = "$new$params"; 67887ebe1d17SDwaipayan Ray } 67897ebe1d17SDwaipayan Ray if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", 6790339f29d9SJoe Perches "Prefer $new over __attribute__(($orig_attr$params))\n" . $herecurr) && 67917ebe1d17SDwaipayan Ray $fix) { 6792339f29d9SJoe Perches my $remove = "\Q$orig_attr\E" . '\s*' . "\Q$params\E" . '(?:\s*,\s*)?'; 6793339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/$remove//; 6794339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__/$new __attribute__/; 6795339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/\}\Q$new\E/} $new/; 6796339f29d9SJoe Perches $fixed[$fixlinenr] =~ s/ __attribute__\s*\(\s*\(\s*\)\s*\)//; 67977ebe1d17SDwaipayan Ray } 679839b7e287SJoe Perches } 6799462811d9SJoe Perches } 6800462811d9SJoe Perches 68017ebe1d17SDwaipayan Ray # Check for __attribute__ unused, prefer __always_unused or __maybe_unused 68027ebe1d17SDwaipayan Ray if ($attr =~ /^_*unused/) { 68037ebe1d17SDwaipayan Ray WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", 68047ebe1d17SDwaipayan Ray "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr); 6805d5e616fcSJoe Perches } 68066061d949SJoe Perches } 68076061d949SJoe Perches 6808619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 68095b57980dSJoe Perches if ($perl_version_ok && 6810619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 6811619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 6812619a908aSJoe Perches $line =~ /\b__weak\b/)) { 6813619a908aSJoe Perches ERROR("WEAK_DECLARATION", 6814619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 6815619a908aSJoe Perches } 6816619a908aSJoe Perches 6817fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 6818e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 6819fd39f904STomas Winkler $realfile !~ m@\btools/@ && 6820e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 6821e6176fa4SJoe Perches my $type = $1; 6822e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 6823e6176fa4SJoe Perches $type = $1; 6824e6176fa4SJoe Perches my $kernel_type = 'u'; 6825e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 6826e6176fa4SJoe Perches $type =~ /(\d+)/; 6827e6176fa4SJoe Perches $kernel_type .= $1; 6828e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 6829e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 6830e6176fa4SJoe Perches $fix) { 6831e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 6832e6176fa4SJoe Perches } 6833e6176fa4SJoe Perches } 6834e6176fa4SJoe Perches } 6835e6176fa4SJoe Perches 6836938224b5SJoe Perches# check for cast of C90 native int or longer types constants 6837938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 6838938224b5SJoe Perches my $cast = $1; 6839938224b5SJoe Perches my $const = $2; 6840938224b5SJoe Perches my $suffix = ""; 6841938224b5SJoe Perches my $newconst = $const; 6842938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 6843938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 6844938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 6845938224b5SJoe Perches $suffix .= 'LL'; 6846938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 6847938224b5SJoe Perches $suffix .= 'L'; 6848938224b5SJoe Perches } 68490972b8bfSJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 68500972b8bfSJoe Perches "Unnecessary typecast of c90 int constant - '$cast$const' could be '$const$suffix'\n" . $herecurr) && 68510972b8bfSJoe Perches $fix) { 6852938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 6853938224b5SJoe Perches } 6854938224b5SJoe Perches } 6855938224b5SJoe Perches 68568f53a9b8SJoe Perches# check for sizeof(&) 68578f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 6858000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 6859000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 68608f53a9b8SJoe Perches } 68618f53a9b8SJoe Perches 686266c80b60SJoe Perches# check for sizeof without parenthesis 686366c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 6864d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 6865d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 6866d5e616fcSJoe Perches $fix) { 6867194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 6868d5e616fcSJoe Perches } 686966c80b60SJoe Perches } 687066c80b60SJoe Perches 687188982feaSJoe Perches# check for struct spinlock declarations 687288982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 687388982feaSJoe Perches WARN("USE_SPINLOCK_T", 687488982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 687588982feaSJoe Perches } 687688982feaSJoe Perches 6877a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 687806668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 6879a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 6880caac1d5fSHeba Aamer $fmt =~ s/%%//g; 6881caac1d5fSHeba Aamer if ($fmt !~ /%/) { 6882d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 6883d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 6884d5e616fcSJoe Perches $fix) { 6885194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 6886d5e616fcSJoe Perches } 6887a6962d72SJoe Perches } 6888a6962d72SJoe Perches } 6889a6962d72SJoe Perches 68900b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 68915b57980dSJoe Perches if ($perl_version_ok && 68920b523769SJoe Perches defined $stat && 68930b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 68940b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 6895e3c6bc95STobin C. Harding my $stat_real; 6896e3c6bc95STobin C. Harding 68970b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 68980b523769SJoe Perches $lc = $lc + $linenr; 68990b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 6900ffe07513SJoe Perches my $specifier; 6901ffe07513SJoe Perches my $extension; 69023bd32d6aSSakari Ailus my $qualifier; 6903ffe07513SJoe Perches my $bad_specifier = ""; 69040b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 69050b523769SJoe Perches $fmt =~ s/%%//g; 6906e3c6bc95STobin C. Harding 69073bd32d6aSSakari Ailus while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) { 6908e3c6bc95STobin C. Harding $specifier = $1; 6909e3c6bc95STobin C. Harding $extension = $2; 69103bd32d6aSSakari Ailus $qualifier = $3; 6911af612e43SSakari Ailus if ($extension !~ /[4SsBKRraEehMmIiUDdgVCbGNOxtf]/ || 69123bd32d6aSSakari Ailus ($extension eq "f" && 6913af612e43SSakari Ailus defined $qualifier && $qualifier !~ /^w/) || 6914af612e43SSakari Ailus ($extension eq "4" && 6915af612e43SSakari Ailus defined $qualifier && $qualifier !~ /^cc/)) { 6916e3c6bc95STobin C. Harding $bad_specifier = $specifier; 69170b523769SJoe Perches last; 69180b523769SJoe Perches } 6919e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 6920e3c6bc95STobin C. Harding if (!defined($stat_real)) { 6921e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 69220b523769SJoe Perches } 6923e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 6924e3c6bc95STobin 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"); 6925e3c6bc95STobin C. Harding } 6926e3c6bc95STobin C. Harding } 6927e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 69282a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6929de48fa1aSMiguel Ojeda my $msg_level = \&WARN; 69301df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 69311df7338aSSergey Senozhatsky my $use = ""; 6932e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 69331df7338aSSergey Senozhatsky $use = " - use %pS instead"; 6934e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 6935de48fa1aSMiguel Ojeda } elsif ($bad_specifier =~ /pA/) { 6936de48fa1aSMiguel Ojeda $use = " - '%pA' is only intended to be used from Rust code"; 6937de48fa1aSMiguel Ojeda $msg_level = \&ERROR; 69381df7338aSSergey Senozhatsky } 69392a9f9d85STobin C. Harding 6940de48fa1aSMiguel Ojeda &{$msg_level}("VSPRINTF_POINTER_EXTENSION", 6941e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 6942e3c6bc95STobin C. Harding } 69430b523769SJoe Perches } 69440b523769SJoe Perches } 69450b523769SJoe Perches 6946554e165cSAndy Whitcroft# Check for misused memsets 69475b57980dSJoe Perches if ($perl_version_ok && 6948d1fe9c09SJoe Perches defined $stat && 69499e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 6950554e165cSAndy Whitcroft 6951d7c76ba7SJoe Perches my $ms_addr = $2; 6952d1fe9c09SJoe Perches my $ms_val = $7; 6953d1fe9c09SJoe Perches my $ms_size = $12; 6954d7c76ba7SJoe Perches 6955554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 6956554e165cSAndy Whitcroft ERROR("MEMSET", 6957d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 6958554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 6959554e165cSAndy Whitcroft WARN("MEMSET", 6960d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 6961d7c76ba7SJoe Perches } 6962d7c76ba7SJoe Perches } 6963d7c76ba7SJoe Perches 696498a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 69655b57980dSJoe Perches# if ($perl_version_ok && 6966f333195dSJoe Perches# defined $stat && 6967f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6968f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 6969f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 6970f333195dSJoe Perches# $fix) { 6971f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 6972f333195dSJoe Perches# } 6973f333195dSJoe Perches# } 697498a9bba5SJoe Perches 6975b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 69765b57980dSJoe Perches# if ($perl_version_ok && 6977f333195dSJoe Perches# defined $stat && 6978f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6979f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 6980f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 6981f333195dSJoe Perches# } 6982b6117d17SMateusz Kulikowski 69838617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 69848617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 69855b57980dSJoe Perches# if ($perl_version_ok && 6986f333195dSJoe Perches# defined $stat && 6987f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6988f333195dSJoe Perches# 6989f333195dSJoe Perches# my $ms_val = $7; 6990f333195dSJoe Perches# 6991f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 6992f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 6993f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 6994f333195dSJoe Perches# $fix) { 6995f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 6996f333195dSJoe Perches# } 6997f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 6998f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 6999f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 7000f333195dSJoe Perches# $fix) { 7001f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 7002f333195dSJoe Perches# } 7003f333195dSJoe Perches# } 7004f333195dSJoe Perches# } 70058617cd09SMateusz Kulikowski 7006d0f90841SKees Cook# strcpy uses that should likely be strscpy 7007d0f90841SKees Cook if ($line =~ /\bstrcpy\s*\(/) { 7008d0f90841SKees Cook WARN("STRCPY", 7009d0f90841SKees Cook "Prefer strscpy over strcpy - see: https://github.com/KSPP/linux/issues/88\n" . $herecurr); 7010d0f90841SKees Cook } 7011d0f90841SKees Cook 70125dbdb2d8SJoe Perches# strlcpy uses that should likely be strscpy 70135dbdb2d8SJoe Perches if ($line =~ /\bstrlcpy\s*\(/) { 70145dbdb2d8SJoe Perches WARN("STRLCPY", 7015d0f90841SKees Cook "Prefer strscpy over strlcpy - see: https://github.com/KSPP/linux/issues/89\n" . $herecurr); 7016d0f90841SKees Cook } 7017d0f90841SKees Cook 7018d0f90841SKees Cook# strncpy uses that should likely be strscpy or strscpy_pad 7019d0f90841SKees Cook if ($line =~ /\bstrncpy\s*\(/) { 7020d0f90841SKees Cook WARN("STRNCPY", 7021d0f90841SKees Cook "Prefer strscpy, strscpy_pad, or __nonstring over strncpy - see: https://github.com/KSPP/linux/issues/90\n" . $herecurr); 70225dbdb2d8SJoe Perches } 70235dbdb2d8SJoe Perches 70249b5f621cS[email protected]# ethtool_sprintf uses that should likely be ethtool_puts 70259b5f621cS[email protected] if ($line =~ /\bethtool_sprintf\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 70269b5f621cS[email protected] if (WARN("PREFER_ETHTOOL_PUTS", 70279b5f621cS[email protected] "Prefer ethtool_puts over ethtool_sprintf with only two arguments\n" . $herecurr) && 70289b5f621cS[email protected] $fix) { 70299b5f621cS[email protected] $fixed[$fixlinenr] =~ s/\bethtool_sprintf\s*\(\s*($FuncArg)\s*,\s*($FuncArg)/ethtool_puts($1, $7)/; 70309b5f621cS[email protected] } 70319b5f621cS[email protected] } 70329b5f621cS[email protected] 70339b5f621cS[email protected] # use $rawline because $line loses %s via sanitization and thus we can't match against it. 70349b5f621cS[email protected] if ($rawline =~ /\bethtool_sprintf\s*\(\s*$FuncArg\s*,\s*\"\%s\"\s*,\s*$FuncArg\s*\)/) { 70359b5f621cS[email protected] if (WARN("PREFER_ETHTOOL_PUTS", 70369b5f621cS[email protected] "Prefer ethtool_puts over ethtool_sprintf with standalone \"%s\" specifier\n" . $herecurr) && 70379b5f621cS[email protected] $fix) { 70389b5f621cS[email protected] $fixed[$fixlinenr] =~ s/\bethtool_sprintf\s*\(\s*($FuncArg)\s*,\s*"\%s"\s*,\s*($FuncArg)/ethtool_puts($1, $7)/; 70399b5f621cS[email protected] } 70409b5f621cS[email protected] } 70419b5f621cS[email protected] 70429b5f621cS[email protected] 7043d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 70445b57980dSJoe Perches if ($perl_version_ok && 7045d1fe9c09SJoe Perches defined $stat && 7046d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 7047d1fe9c09SJoe Perches if (defined $2 || defined $7) { 7048d7c76ba7SJoe Perches my $call = $1; 7049d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 7050d7c76ba7SJoe Perches my $arg1 = $3; 7051d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 7052d1fe9c09SJoe Perches my $arg2 = $8; 7053d7c76ba7SJoe Perches my $cast; 7054d7c76ba7SJoe Perches 7055d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 7056d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 7057d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 7058d7c76ba7SJoe Perches $cast = $cast1; 7059d7c76ba7SJoe Perches } else { 7060d7c76ba7SJoe Perches $cast = $cast2; 7061d7c76ba7SJoe Perches } 7062d7c76ba7SJoe Perches WARN("MINMAX", 7063d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 7064554e165cSAndy Whitcroft } 7065554e165cSAndy Whitcroft } 7066554e165cSAndy Whitcroft 70674a273195SJoe Perches# check usleep_range arguments 70685b57980dSJoe Perches if ($perl_version_ok && 70694a273195SJoe Perches defined $stat && 70704a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 70714a273195SJoe Perches my $min = $1; 70724a273195SJoe Perches my $max = $7; 70734a273195SJoe Perches if ($min eq $max) { 70744a273195SJoe Perches WARN("USLEEP_RANGE", 7075458f69efSMauro Carvalho Chehab "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 70764a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 70774a273195SJoe Perches $min > $max) { 70784a273195SJoe Perches WARN("USLEEP_RANGE", 7079458f69efSMauro Carvalho Chehab "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 70804a273195SJoe Perches } 70814a273195SJoe Perches } 70824a273195SJoe Perches 7083823b794cSJoe Perches# check for naked sscanf 70845b57980dSJoe Perches if ($perl_version_ok && 7085823b794cSJoe Perches defined $stat && 70866c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 7087823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 7088823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 7089823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 7090823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 7091823b794cSJoe Perches $lc = $lc + $linenr; 70922a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 7093823b794cSJoe Perches WARN("NAKED_SSCANF", 7094823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 7095823b794cSJoe Perches } 7096823b794cSJoe Perches 7097afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 70985b57980dSJoe Perches if ($perl_version_ok && 7099afc819abSJoe Perches defined $stat && 7100afc819abSJoe Perches $line =~ /\bsscanf\b/) { 7101afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 7102afc819abSJoe Perches $lc = $lc + $linenr; 71032a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 7104afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 7105afc819abSJoe Perches my $format = $6; 7106afc819abSJoe Perches my $count = $format =~ tr@%@%@; 7107afc819abSJoe Perches if ($count == 1 && 7108afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 7109afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 7110afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 7111afc819abSJoe Perches } 7112afc819abSJoe Perches } 7113afc819abSJoe Perches } 7114afc819abSJoe Perches 711570dc8a48SJoe Perches# check for new externs in .h files. 711670dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 711770dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 7118d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 711970dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 712070dc8a48SJoe Perches $fix) { 7121194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 712270dc8a48SJoe Perches } 712370dc8a48SJoe Perches } 712470dc8a48SJoe Perches 7125de7d4f0eSAndy Whitcroft# check for new externs in .c files. 7126171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 7127c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 7128171ae1a4SAndy Whitcroft { 7129c45dcabdSAndy Whitcroft my $function_name = $1; 7130c45dcabdSAndy Whitcroft my $paren_space = $2; 7131171ae1a4SAndy Whitcroft 7132171ae1a4SAndy Whitcroft my $s = $stat; 7133171ae1a4SAndy Whitcroft if (defined $cond) { 7134171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 7135171ae1a4SAndy Whitcroft } 7136d8b44b58SKees Cook if ($s =~ /^\s*;/) 7137c45dcabdSAndy Whitcroft { 7138000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 7139000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 7140de7d4f0eSAndy Whitcroft } 7141de7d4f0eSAndy Whitcroft 7142171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 7143000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 7144000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 7145171ae1a4SAndy Whitcroft } 71469c9ba34eSAndy Whitcroft 71479c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 71485b2c7334SJim Cromie $stat =~ /^\+extern struct\s+(\w+)\s+(\w+)\[\];/) 71495b2c7334SJim Cromie { 71505b2c7334SJim Cromie my ($st_type, $st_name) = ($1, $2); 71515b2c7334SJim Cromie 71525b2c7334SJim Cromie for my $s (keys %maybe_linker_symbol) { 71535b2c7334SJim Cromie #print "Linker symbol? $st_name : $s\n"; 71545b2c7334SJim Cromie goto LIKELY_LINKER_SYMBOL 71555b2c7334SJim Cromie if $st_name =~ /$s/; 71565b2c7334SJim Cromie } 71575b2c7334SJim Cromie WARN("AVOID_EXTERNS", 71585b2c7334SJim Cromie "found a file-scoped extern type:$st_type name:$st_name in .c file\n" 71595b2c7334SJim Cromie . "is this a linker symbol ?\n" . $herecurr); 71605b2c7334SJim Cromie LIKELY_LINKER_SYMBOL: 71615b2c7334SJim Cromie 71625b2c7334SJim Cromie } elsif ($realfile =~ /\.c$/ && defined $stat && 71639c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 71649c9ba34eSAndy Whitcroft { 7165000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 7166000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 7167171ae1a4SAndy Whitcroft } 7168171ae1a4SAndy Whitcroft 7169a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 7170a0ad7596SJoe Perches if (defined $stat && 7171d8b44b58SKees Cook $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 7172d8b44b58SKees Cook $1 ne "void") { 7173d8b44b58SKees Cook my $args = trim($1); 7174ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 7175ca0d8929SJoe Perches my $arg = trim($1); 7176d8b44b58SKees Cook if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 7177ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 7178ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 7179ca0d8929SJoe Perches } 7180ca0d8929SJoe Perches } 7181ca0d8929SJoe Perches } 7182ca0d8929SJoe Perches 7183a0ad7596SJoe Perches# check for function definitions 71845b57980dSJoe Perches if ($perl_version_ok && 7185a0ad7596SJoe Perches defined $stat && 7186a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 7187a0ad7596SJoe Perches $context_function = $1; 7188a0ad7596SJoe Perches 7189a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 7190a0ad7596SJoe Perches my $ok = 0; 7191a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 7192a0ad7596SJoe Perches my $herectx = $here . "\n"; 7193a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 7194a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 7195a0ad7596SJoe Perches $herectx .= $rl . "\n"; 7196a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 7197a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 7198a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 7199a0ad7596SJoe Perches } 7200a0ad7596SJoe Perches if (!$ok) { 7201a0ad7596SJoe Perches ERROR("OPEN_BRACE", 7202a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 7203a0ad7596SJoe Perches } 7204a0ad7596SJoe Perches } 7205a0ad7596SJoe Perches 7206de7d4f0eSAndy Whitcroft# checks for new __setup's 7207de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 7208de7d4f0eSAndy Whitcroft my $name = $1; 7209de7d4f0eSAndy Whitcroft 7210de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 7211000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 72122581ac7cSTim Froidcoeur "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr); 7213de7d4f0eSAndy Whitcroft } 7214653d4876SAndy Whitcroft } 72159c0ca6f9SAndy Whitcroft 7216e29a70f1SJoe Perches# check for pointless casting of alloc functions 7217e29a70f1SJoe Perches if ($line =~ /\*\s*\)\s*$allocFunctions\b/) { 7218000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 7219000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 72209c0ca6f9SAndy Whitcroft } 722113214adfSAndy Whitcroft 7222a640d25cSJoe Perches# alloc style 7223a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 72245b57980dSJoe Perches if ($perl_version_ok && 7225e29a70f1SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 7226a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 7227a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 7228a640d25cSJoe Perches } 7229a640d25cSJoe Perches 723073f1d07eSGustavo A. R. Silva# check for (kv|k)[mz]alloc with multiplies that could be kmalloc_array/kvmalloc_array/kvcalloc/kcalloc 72315b57980dSJoe Perches if ($perl_version_ok && 72321b4a2ed4SJoe Perches defined $stat && 723373f1d07eSGustavo A. R. Silva $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k)[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 723460a55369SJoe Perches my $oldfunc = $3; 723560a55369SJoe Perches my $a1 = $4; 723660a55369SJoe Perches my $a2 = $10; 723760a55369SJoe Perches my $newfunc = "kmalloc_array"; 723873f1d07eSGustavo A. R. Silva $newfunc = "kvmalloc_array" if ($oldfunc eq "kvmalloc"); 723973f1d07eSGustavo A. R. Silva $newfunc = "kvcalloc" if ($oldfunc eq "kvzalloc"); 724060a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 724160a55369SJoe Perches my $r1 = $a1; 724260a55369SJoe Perches my $r2 = $a2; 724360a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 724460a55369SJoe Perches $r1 = $a2; 724560a55369SJoe Perches $r2 = $a1; 724660a55369SJoe Perches } 7247e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 7248e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 72491b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 7250e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 7251e3d95a2aSTobin C. Harding 7252e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 72531b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 72541b4a2ed4SJoe Perches $cnt == 1 && 7255e367455aSJoe Perches $fix) { 725673f1d07eSGustavo A. R. Silva $fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k)[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e; 725760a55369SJoe Perches } 725860a55369SJoe Perches } 725960a55369SJoe Perches } 726060a55369SJoe Perches 7261972fdea2SJoe Perches# check for krealloc arg reuse 72625b57980dSJoe Perches if ($perl_version_ok && 72634cab63ceSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ && 72644cab63ceSJoe Perches $1 eq $3) { 7265972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 7266972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 7267972fdea2SJoe Perches } 7268972fdea2SJoe Perches 72695ce59ae0SJoe Perches# check for alloc argument mismatch 72703965292aSLiao Chang if ($line =~ /\b((?:devm_)?((?:k|kv)?(calloc|malloc_array)(?:_node)?))\s*\(\s*sizeof\b/) { 72715ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 72725ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 72735ce59ae0SJoe Perches } 72745ce59ae0SJoe Perches 7275caf2a54fSJoe Perches# check for multiple semicolons 7276caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 7277d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 7278d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 7279d5e616fcSJoe Perches $fix) { 7280194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 7281d5e616fcSJoe Perches } 7282d1e2ad07SJoe Perches } 7283d1e2ad07SJoe Perches 7284cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 7285cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 7286cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 72870ab90191SJoe Perches my $ull = ""; 72880ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 72890ab90191SJoe Perches if (CHK("BIT_MACRO", 72900ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 72910ab90191SJoe Perches $fix) { 72920ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 72930ab90191SJoe Perches } 72940ab90191SJoe Perches } 72950ab90191SJoe Perches 729650161266SJoe Perches# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too) 72973e89ad85SJerome Forissier if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) { 729850161266SJoe Perches WARN("IS_ENABLED_CONFIG", 72993e89ad85SJerome Forissier "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr); 730050161266SJoe Perches } 730150161266SJoe Perches 73022d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 73033e89ad85SJerome 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*$/) { 73042d632745SJoe Perches my $config = $1; 73052d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 73063e89ad85SJerome Forissier "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) && 73072d632745SJoe Perches $fix) { 73082d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 73092d632745SJoe Perches } 73102d632745SJoe Perches } 73112d632745SJoe Perches 7312f36d3eb8SJoe Perches# check for /* fallthrough */ like comment, prefer fallthrough; 7313f36d3eb8SJoe Perches my @fallthroughs = ( 7314f36d3eb8SJoe Perches 'fallthrough', 7315f36d3eb8SJoe Perches '@fallthrough@', 7316f36d3eb8SJoe Perches 'lint -fallthrough[ \t]*', 7317f36d3eb8SJoe Perches 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)', 7318f36d3eb8SJoe Perches '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?', 7319f36d3eb8SJoe Perches 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 7320f36d3eb8SJoe Perches 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 7321f36d3eb8SJoe Perches ); 7322f36d3eb8SJoe Perches if ($raw_comment ne '') { 7323f36d3eb8SJoe Perches foreach my $ft (@fallthroughs) { 7324f36d3eb8SJoe Perches if ($raw_comment =~ /$ft/) { 7325f36d3eb8SJoe Perches my $msg_level = \&WARN; 7326f36d3eb8SJoe Perches $msg_level = \&CHK if ($file); 7327f36d3eb8SJoe Perches &{$msg_level}("PREFER_FALLTHROUGH", 7328f36d3eb8SJoe Perches "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr); 7329f36d3eb8SJoe Perches last; 7330f36d3eb8SJoe Perches } 7331f36d3eb8SJoe Perches } 7332f36d3eb8SJoe Perches } 7333f36d3eb8SJoe Perches 7334d1e2ad07SJoe Perches# check for switch/default statements without a break; 73355b57980dSJoe Perches if ($perl_version_ok && 7336d1e2ad07SJoe Perches defined $stat && 7337d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 7338d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 7339e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 7340e3d95a2aSTobin C. Harding 7341d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 7342d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 7343caf2a54fSJoe Perches } 7344caf2a54fSJoe Perches 734513214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 7346d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 7347d5e616fcSJoe Perches if (WARN("USE_FUNC", 7348d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 7349d5e616fcSJoe Perches $fix) { 7350194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 7351d5e616fcSJoe Perches } 735213214adfSAndy Whitcroft } 7353773647a0SAndy Whitcroft 735462ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 735562ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 735662ec818fSJoe Perches ERROR("DATE_TIME", 735762ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 735862ec818fSJoe Perches } 735962ec818fSJoe Perches 73602c92488aSJoe Perches# check for use of yield() 73612c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 73622c92488aSJoe Perches WARN("YIELD", 73632c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 73642c92488aSJoe Perches } 73652c92488aSJoe Perches 7366179f8f40SJoe Perches# check for comparisons against true and false 7367179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 7368179f8f40SJoe Perches my $lead = $1; 7369179f8f40SJoe Perches my $arg = $2; 7370179f8f40SJoe Perches my $test = $3; 7371179f8f40SJoe Perches my $otype = $4; 7372179f8f40SJoe Perches my $trail = $5; 7373179f8f40SJoe Perches my $op = "!"; 7374179f8f40SJoe Perches 7375179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 7376179f8f40SJoe Perches 7377179f8f40SJoe Perches my $type = lc($otype); 7378179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 7379179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 7380179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 7381179f8f40SJoe Perches $op = ""; 7382179f8f40SJoe Perches } 7383179f8f40SJoe Perches 7384179f8f40SJoe Perches CHK("BOOL_COMPARISON", 7385179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 7386179f8f40SJoe Perches 7387179f8f40SJoe Perches## maybe suggesting a correct construct would better 7388179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 7389179f8f40SJoe Perches 7390179f8f40SJoe Perches } 7391179f8f40SJoe Perches } 7392179f8f40SJoe Perches 73934882720bSThomas Gleixner# check for semaphores initialized locked 73944882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 7395000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 7396000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 7397773647a0SAndy Whitcroft } 73986712d858SJoe Perches 739967d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 740067d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 7401000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 740267d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 7403773647a0SAndy Whitcroft } 74046712d858SJoe Perches 7405ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 7406f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 7407000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 7408ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 7409f3db6639SMichael Ellerman } 74106712d858SJoe Perches 74113d709ab5SPaul E. McKenney# check for spin_is_locked(), suggest lockdep instead 74123d709ab5SPaul E. McKenney if ($line =~ /\bspin_is_locked\(/) { 74133d709ab5SPaul E. McKenney WARN("USE_LOCKDEP", 74143d709ab5SPaul E. McKenney "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr); 74153d709ab5SPaul E. McKenney } 74163d709ab5SPaul E. McKenney 74179189c7e7SJoe Perches# check for deprecated apis 74189189c7e7SJoe Perches if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) { 74199189c7e7SJoe Perches my $deprecated_api = $1; 74209189c7e7SJoe Perches my $new_api = $deprecated_apis{$deprecated_api}; 74219189c7e7SJoe Perches WARN("DEPRECATED_API", 74229189c7e7SJoe Perches "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr); 74239189c7e7SJoe Perches } 74249189c7e7SJoe Perches 74250f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 7426d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 7427ced69da1SQuentin Monnet if (defined($const_structs) && 7428ced69da1SQuentin Monnet $line !~ /\bconst\b/ && 7429d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 7430000d1cc1SJoe Perches WARN("CONST_STRUCT", 7431d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 74322b6db5cbSAndy Whitcroft } 7433773647a0SAndy Whitcroft 7434773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 7435773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 743635cdcbfcSPeng Wang# ignore designated initializers using NR_CPUS 7437773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 7438c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 7439c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 7440171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 7441171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 744235cdcbfcSPeng Wang $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/ && 744335cdcbfcSPeng Wang $line !~ /^.\s*\.\w+\s*=\s*.*\bNR_CPUS\b/) 7444773647a0SAndy Whitcroft { 7445000d1cc1SJoe Perches WARN("NR_CPUS", 7446000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 7447773647a0SAndy Whitcroft } 74489c9ba34eSAndy Whitcroft 744952ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 745052ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 745152ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 745252ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 745352ea8506SJoe Perches } 745452ea8506SJoe Perches 7455acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 74565b57980dSJoe Perches if ($perl_version_ok && 7457acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 7458acd9362cSJoe Perches WARN("LIKELY_MISUSE", 7459acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 7460acd9362cSJoe Perches } 7461acd9362cSJoe Perches 7462fbe74541SJoe Perches# return sysfs_emit(foo, fmt, ...) fmt without newline 7463fbe74541SJoe Perches if ($line =~ /\breturn\s+sysfs_emit\s*\(\s*$FuncArg\s*,\s*($String)/ && 7464fbe74541SJoe Perches substr($rawline, $-[6], $+[6] - $-[6]) !~ /\\n"$/) { 7465fbe74541SJoe Perches my $offset = $+[6] - 1; 7466fbe74541SJoe Perches if (WARN("SYSFS_EMIT", 7467fbe74541SJoe Perches "return sysfs_emit(...) formats should include a terminating newline\n" . $herecurr) && 7468fbe74541SJoe Perches $fix) { 7469fbe74541SJoe Perches substr($fixed[$fixlinenr], $offset, 0) = '\\n'; 7470fbe74541SJoe Perches } 7471fbe74541SJoe Perches } 7472fbe74541SJoe Perches 74738515e4a7SKees Cook# check for array definition/declarations that should use flexible arrays instead 74748515e4a7SKees Cook if ($sline =~ /^[\+ ]\s*\}(?:\s*__packed)?\s*;\s*$/ && 74758515e4a7SKees Cook $prevline =~ /^\+\s*(?:\}(?:\s*__packed\s*)?|$Type)\s*$Ident\s*\[\s*(0|1)\s*\]\s*;\s*$/) { 74768515e4a7SKees Cook if (ERROR("FLEXIBLE_ARRAY", 74778515e4a7SKees Cook "Use C99 flexible arrays - see https://docs.kernel.org/process/deprecated.html#zero-length-and-one-element-arrays\n" . $hereprev) && 74788515e4a7SKees Cook $1 == '0' && $fix) { 74798515e4a7SKees Cook $fixed[$fixlinenr - 1] =~ s/\[\s*0\s*\]/[]/; 74808515e4a7SKees Cook } 74818515e4a7SKees Cook } 74828515e4a7SKees Cook 7483de3f186fSDenis Efremov# nested likely/unlikely calls 7484de3f186fSDenis Efremov if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) { 7485de3f186fSDenis Efremov WARN("LIKELY_MISUSE", 7486de3f186fSDenis Efremov "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr); 7487de3f186fSDenis Efremov } 7488de3f186fSDenis Efremov 7489691d77b6SAndy Whitcroft# whine mightly about in_atomic 7490691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 7491691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 7492000d1cc1SJoe Perches ERROR("IN_ATOMIC", 7493000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 7494f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 7495000d1cc1SJoe Perches WARN("IN_ATOMIC", 7496000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 7497691d77b6SAndy Whitcroft } 7498691d77b6SAndy Whitcroft } 74991704f47bSPeter Zijlstra 750084dd7f19SPaul E. McKenney# Complain about RCU Tasks Trace used outside of BPF (and of course, RCU). 750184dd7f19SPaul E. McKenney our $rcu_trace_funcs = qr{(?x: 750284dd7f19SPaul E. McKenney rcu_read_lock_trace | 750384dd7f19SPaul E. McKenney rcu_read_lock_trace_held | 750484dd7f19SPaul E. McKenney rcu_read_unlock_trace | 750584dd7f19SPaul E. McKenney call_rcu_tasks_trace | 750684dd7f19SPaul E. McKenney synchronize_rcu_tasks_trace | 750784dd7f19SPaul E. McKenney rcu_barrier_tasks_trace | 750884dd7f19SPaul E. McKenney rcu_request_urgent_qs_task 750984dd7f19SPaul E. McKenney )}; 751084dd7f19SPaul E. McKenney our $rcu_trace_paths = qr{(?x: 751184dd7f19SPaul E. McKenney kernel/bpf/ | 751284dd7f19SPaul E. McKenney include/linux/bpf | 751384dd7f19SPaul E. McKenney net/bpf/ | 751484dd7f19SPaul E. McKenney kernel/rcu/ | 751584dd7f19SPaul E. McKenney include/linux/rcu 751684dd7f19SPaul E. McKenney )}; 751784dd7f19SPaul E. McKenney if ($line =~ /\b($rcu_trace_funcs)\s*\(/) { 751884dd7f19SPaul E. McKenney if ($realfile !~ m{^$rcu_trace_paths}) { 751984dd7f19SPaul E. McKenney WARN("RCU_TASKS_TRACE", 752084dd7f19SPaul E. McKenney "use of RCU tasks trace is incorrect outside BPF or core RCU code\n" . $herecurr); 752184dd7f19SPaul E. McKenney } 752284dd7f19SPaul E. McKenney } 752384dd7f19SPaul E. McKenney 75241704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 75251704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 75261704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 75271704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 75281704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 75291704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 7530000d1cc1SJoe Perches ERROR("LOCKDEP", 7531000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 75321704f47bSPeter Zijlstra } 75331704f47bSPeter Zijlstra } 753488f8831cSDave Jones 7535b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 7536b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 7537000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 7538000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 753988f8831cSDave Jones } 75402435880fSJoe Perches 754100180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 754200180468SJoe Perches# and whether or not function naming is typical and if 754300180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 75445b57980dSJoe Perches if ($perl_version_ok && 754500180468SJoe Perches defined $stat && 754600180468SJoe 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*\)/) { 754700180468SJoe Perches my $var = $1; 754800180468SJoe Perches my $perms = $2; 754900180468SJoe Perches my $show = $3; 755000180468SJoe Perches my $store = $4; 755100180468SJoe Perches my $octal_perms = perms_to_octal($perms); 755200180468SJoe Perches if ($show =~ /^${var}_show$/ && 755300180468SJoe Perches $store =~ /^${var}_store$/ && 755400180468SJoe Perches $octal_perms eq "0644") { 755500180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 755600180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 755700180468SJoe Perches $fix) { 755800180468SJoe 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})/; 755900180468SJoe Perches } 756000180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 756100180468SJoe Perches $store =~ /^NULL$/ && 756200180468SJoe Perches $octal_perms eq "0444") { 756300180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 756400180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 756500180468SJoe Perches $fix) { 756600180468SJoe 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})/; 756700180468SJoe Perches } 756800180468SJoe Perches } elsif ($show =~ /^NULL$/ && 756900180468SJoe Perches $store =~ /^${var}_store$/ && 757000180468SJoe Perches $octal_perms eq "0200") { 757100180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 757200180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 757300180468SJoe Perches $fix) { 757400180468SJoe 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})/; 757500180468SJoe Perches } 757600180468SJoe Perches } elsif ($octal_perms eq "0644" || 757700180468SJoe Perches $octal_perms eq "0444" || 757800180468SJoe Perches $octal_perms eq "0200") { 757900180468SJoe Perches my $newshow = "$show"; 758000180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 758100180468SJoe Perches my $newstore = $store; 758200180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 758300180468SJoe Perches my $rename = ""; 758400180468SJoe Perches if ($show ne $newshow) { 758500180468SJoe Perches $rename .= " '$show' to '$newshow'"; 758600180468SJoe Perches } 758700180468SJoe Perches if ($store ne $newstore) { 758800180468SJoe Perches $rename .= " '$store' to '$newstore'"; 758900180468SJoe Perches } 759000180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 759100180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 759200180468SJoe Perches } else { 759300180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 759400180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 759500180468SJoe Perches } 759600180468SJoe Perches } 759700180468SJoe Perches 7598515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 7599515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 760073121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 760173121534SJoe Perches# specific definition of not visible in sysfs. 760273121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 760373121534SJoe Perches# use the default permissions 76045b57980dSJoe Perches if ($perl_version_ok && 7605459cf0aeSJoe Perches defined $stat && 7606515a235eSJoe Perches $line =~ /$mode_perms_search/) { 76072435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 76082435880fSJoe Perches my $func = $entry->[0]; 76092435880fSJoe Perches my $arg_pos = $entry->[1]; 76102435880fSJoe Perches 7611459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 7612459cf0aeSJoe Perches $lc = $lc + $linenr; 76132a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 7614459cf0aeSJoe Perches 76152435880fSJoe Perches my $skip_args = ""; 76162435880fSJoe Perches if ($arg_pos > 1) { 76172435880fSJoe Perches $arg_pos--; 76182435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 76192435880fSJoe Perches } 7620f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 7621459cf0aeSJoe Perches if ($stat =~ /$test/) { 76222435880fSJoe Perches my $val = $1; 76232435880fSJoe Perches $val = $6 if ($skip_args ne ""); 762473121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 762573121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 762673121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 76272435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 7628459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 7629f90774e1SJoe Perches } 7630f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 7631c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 7632459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 76332435880fSJoe Perches } 7634459cf0aeSJoe Perches } 7635459cf0aeSJoe Perches } 7636459cf0aeSJoe Perches } 7637459cf0aeSJoe Perches 7638459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 7639bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 764000180468SJoe Perches my $oval = $1; 764100180468SJoe Perches my $octal = perms_to_octal($oval); 7642f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 7643459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 7644f90774e1SJoe Perches $fix) { 764500180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 76462435880fSJoe Perches } 764713214adfSAndy Whitcroft } 76485a6d20ceSBjorn Andersson 76495a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 76505a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 76515a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 76525a6d20ceSBjorn Andersson my $valid_licenses = qr{ 76535a6d20ceSBjorn Andersson GPL| 76545a6d20ceSBjorn Andersson GPL\ v2| 76555a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 76565a6d20ceSBjorn Andersson Dual\ BSD/GPL| 76575a6d20ceSBjorn Andersson Dual\ MIT/GPL| 76585a6d20ceSBjorn Andersson Dual\ MPL/GPL| 76595a6d20ceSBjorn Andersson Proprietary 76605a6d20ceSBjorn Andersson }x; 76615a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 76625a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 76635a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 76645a6d20ceSBjorn Andersson } 76656e8f42dcSJoe Perches if (!$file && $extracted_string eq '"GPL v2"') { 76666e8f42dcSJoe Perches if (WARN("MODULE_LICENSE", 76676e8f42dcSJoe Perches "Prefer \"GPL\" over \"GPL v2\" - see commit bf7fbeeae6db (\"module: Cure the MODULE_LICENSE \"GPL\" vs. \"GPL v2\" bogosity\")\n" . $herecurr) && 76686e8f42dcSJoe Perches $fix) { 76696e8f42dcSJoe Perches $fixed[$fixlinenr] =~ s/\bMODULE_LICENSE\s*\(\s*"GPL v2"\s*\)/MODULE_LICENSE("GPL")/; 76706e8f42dcSJoe Perches } 76716e8f42dcSJoe Perches } 76725a6d20ceSBjorn Andersson } 76736a8d76cbSMatteo Croce 76746a8d76cbSMatteo Croce# check for sysctl duplicate constants 76756a8d76cbSMatteo Croce if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) { 76766a8d76cbSMatteo Croce WARN("DUPLICATED_SYSCTL_CONST", 76776a8d76cbSMatteo Croce "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr); 76786a8d76cbSMatteo Croce } 7679515a235eSJoe Perches } 768013214adfSAndy Whitcroft 768113214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 768213214adfSAndy Whitcroft # so just keep quiet. 768313214adfSAndy Whitcroft if ($#rawlines == -1) { 768413214adfSAndy Whitcroft exit(0); 76850a920b5bSAndy Whitcroft } 76860a920b5bSAndy Whitcroft 76878905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 76888905a67cSAndy Whitcroft # things that appear to be patches. 76898905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 76908905a67cSAndy Whitcroft exit(0); 76918905a67cSAndy Whitcroft } 76928905a67cSAndy Whitcroft 7693e73d2715SDwaipayan Ray # This is not a patch, and we are in 'no-patch' mode so 76948905a67cSAndy Whitcroft # just keep quiet. 76958905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 76968905a67cSAndy Whitcroft exit(0); 76978905a67cSAndy Whitcroft } 76988905a67cSAndy Whitcroft 7699a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 7700000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 7701000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 77020a920b5bSAndy Whitcroft } 7703d5d6281aSDan Carpenter if ($is_patch && $has_commit_log && $chk_fixes_tag) { 7704d5d6281aSDan Carpenter if ($needs_fixes_tag ne "" && !$is_revert && !$fixes_tag) { 7705d5d6281aSDan Carpenter WARN("MISSING_FIXES_TAG", 7706d5d6281aSDan Carpenter "The commit message has '$needs_fixes_tag', perhaps it also needs a 'Fixes:' tag?\n"); 7707d5d6281aSDan Carpenter } 7708d5d6281aSDan Carpenter } 7709cd261496SGeert Uytterhoeven if ($is_patch && $has_commit_log && $chk_signoff) { 7710cd261496SGeert Uytterhoeven if ($signoff == 0) { 7711000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 7712000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 771348ca2d8aSDwaipayan Ray } elsif ($authorsignoff != 1) { 771448ca2d8aSDwaipayan Ray # authorsignoff values: 771548ca2d8aSDwaipayan Ray # 0 -> missing sign off 771648ca2d8aSDwaipayan Ray # 1 -> sign off identical 771748ca2d8aSDwaipayan Ray # 2 -> names and addresses match, comments mismatch 771848ca2d8aSDwaipayan Ray # 3 -> addresses match, names different 771948ca2d8aSDwaipayan Ray # 4 -> names match, addresses different 772048ca2d8aSDwaipayan Ray # 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match 772148ca2d8aSDwaipayan Ray 772248ca2d8aSDwaipayan Ray my $sob_msg = "'From: $author' != 'Signed-off-by: $author_sob'"; 772348ca2d8aSDwaipayan Ray 772448ca2d8aSDwaipayan Ray if ($authorsignoff == 0) { 772548ca2d8aSDwaipayan Ray ERROR("NO_AUTHOR_SIGN_OFF", 7726cd261496SGeert Uytterhoeven "Missing Signed-off-by: line by nominal patch author '$author'\n"); 772748ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 2) { 772848ca2d8aSDwaipayan Ray CHK("FROM_SIGN_OFF_MISMATCH", 772948ca2d8aSDwaipayan Ray "From:/Signed-off-by: email comments mismatch: $sob_msg\n"); 773048ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 3) { 773148ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 773248ca2d8aSDwaipayan Ray "From:/Signed-off-by: email name mismatch: $sob_msg\n"); 773348ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 4) { 773448ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 773548ca2d8aSDwaipayan Ray "From:/Signed-off-by: email address mismatch: $sob_msg\n"); 773648ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 5) { 773748ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 773848ca2d8aSDwaipayan Ray "From:/Signed-off-by: email subaddress mismatch: $sob_msg\n"); 773948ca2d8aSDwaipayan Ray } 7740cd261496SGeert Uytterhoeven } 77410a920b5bSAndy Whitcroft } 77420a920b5bSAndy Whitcroft 7743f0a594c1SAndy Whitcroft print report_dump(); 774413214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 774513214adfSAndy Whitcroft print "$filename " if ($summary_file); 77466c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 77476c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 77486c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 77496c72ffaaSAndy Whitcroft } 77508905a67cSAndy Whitcroft 7751d2c0a235SAndy Whitcroft if ($quiet == 0) { 7752ef212196SJoe Perches # If there were any defects found and not already fixing them 7753ef212196SJoe Perches if (!$clean and !$fix) { 7754ef212196SJoe Perches print << "EOM" 7755ef212196SJoe Perches 7756ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 7757ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 7758ef212196SJoe PerchesEOM 7759ef212196SJoe Perches } 7760d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 7761d2c0a235SAndy Whitcroft # then suggest that. 7762d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 7763b0781216SMike Frysinger $rpt_cleaners = 0; 7764d8469f16SJoe Perches print << "EOM" 7765d8469f16SJoe Perches 7766d8469f16SJoe PerchesNOTE: Whitespace errors detected. 7767d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 7768d8469f16SJoe PerchesEOM 7769d2c0a235SAndy Whitcroft } 7770d2c0a235SAndy Whitcroft } 7771d2c0a235SAndy Whitcroft 7772d752fcc8SJoe Perches if ($clean == 0 && $fix && 7773d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 7774d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 77759624b8d6SJoe Perches my $newfile = $filename; 77769624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 77773705ce5bSJoe Perches my $linecount = 0; 77783705ce5bSJoe Perches my $f; 77793705ce5bSJoe Perches 7780d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 7781d752fcc8SJoe Perches 77823705ce5bSJoe Perches open($f, '>', $newfile) 77833705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 77843705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 77853705ce5bSJoe Perches $linecount++; 77863705ce5bSJoe Perches if ($file) { 77873705ce5bSJoe Perches if ($linecount > 3) { 77883705ce5bSJoe Perches $fixed_line =~ s/^\+//; 77893705ce5bSJoe Perches print $f $fixed_line . "\n"; 77903705ce5bSJoe Perches } 77913705ce5bSJoe Perches } else { 77923705ce5bSJoe Perches print $f $fixed_line . "\n"; 77933705ce5bSJoe Perches } 77943705ce5bSJoe Perches } 77953705ce5bSJoe Perches close($f); 77963705ce5bSJoe Perches 77973705ce5bSJoe Perches if (!$quiet) { 77983705ce5bSJoe Perches print << "EOM"; 7799d8469f16SJoe Perches 78003705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 78013705ce5bSJoe Perches 78023705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 78033705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 78043705ce5bSJoe Perches 78053705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 78063705ce5bSJoe PerchesNo warranties, expressed or implied... 78073705ce5bSJoe PerchesEOM 78083705ce5bSJoe Perches } 78093705ce5bSJoe Perches } 78103705ce5bSJoe Perches 7811d8469f16SJoe Perches if ($quiet == 0) { 7812d8469f16SJoe Perches print "\n"; 7813d8469f16SJoe Perches if ($clean == 1) { 7814d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 7815d8469f16SJoe Perches } else { 7816d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 78170a920b5bSAndy Whitcroft } 78180a920b5bSAndy Whitcroft } 78190a920b5bSAndy Whitcroft return $clean; 78200a920b5bSAndy Whitcroft} 7821