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; 260a920b5bSAndy Whitcroftmy $tree = 1; 270a920b5bSAndy Whitcroftmy $chk_signoff = 1; 280a920b5bSAndy Whitcroftmy $chk_patch = 1; 29773647a0SAndy Whitcroftmy $tst_only; 306c72ffaaSAndy Whitcroftmy $emacs = 0; 318905a67cSAndy Whitcroftmy $terse = 0; 3234d8815fSJoe Perchesmy $showfile = 0; 336c72ffaaSAndy Whitcroftmy $file = 0; 344a593c34SDu, Changbinmy $git = 0; 350dea9f1eSJoe Perchesmy %git_commits = (); 366c72ffaaSAndy Whitcroftmy $check = 0; 372ac73b4fSJoe Perchesmy $check_orig = 0; 388905a67cSAndy Whitcroftmy $summary = 1; 398905a67cSAndy Whitcroftmy $mailback = 0; 4013214adfSAndy Whitcroftmy $summary_file = 0; 41000d1cc1SJoe Perchesmy $show_types = 0; 423beb42ecSJoe Perchesmy $list_types = 0; 433705ce5bSJoe Perchesmy $fix = 0; 449624b8d6SJoe Perchesmy $fix_inplace = 0; 456c72ffaaSAndy Whitcroftmy $root; 460f7f635bSJoe Perchesmy $gitroot = $ENV{'GIT_DIR'}; 470f7f635bSJoe Perches$gitroot = ".git" if !defined($gitroot); 48c2fdda0dSAndy Whitcroftmy %debug; 493445686aSJoe Perchesmy %camelcase = (); 5091bfe484SJoe Perchesmy %use_type = (); 5191bfe484SJoe Perchesmy @use = (); 5291bfe484SJoe Perchesmy %ignore_type = (); 53000d1cc1SJoe Perchesmy @ignore = (); 5477f5b10aSHannes Edermy $help = 0; 55000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 56bdc48fa1SJoe Perchesmy $max_line_length = 100; 57d62a201fSDave Hansenmy $ignore_perl_version = 0; 58d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 5956193274SVadim Bendeburymy $min_conf_desc_length = 4; 6066b47b4aSKees Cookmy $spelling_file = "$D/spelling.txt"; 61ebfd7d62SJoe Perchesmy $codespell = 0; 62f1a63678SMaxim Uvarovmy $codespellfile = "/usr/share/codespell/dictionary.txt"; 63bf1fa1daSJoe Perchesmy $conststructsfile = "$D/const_structs.checkpatch"; 64ced69da1SQuentin Monnetmy $typedefsfile; 65737c0767SJohn Brooksmy $color = "auto"; 6698005e8cSVadim Bendeburymy $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE 67dbbf869dSJoe Perches# git output parsing needs US English output, so first set backtick child process LANGUAGE 68dbbf869dSJoe Perchesmy $git_command ='export LANGUAGE=en_US.UTF-8; git'; 69713a09deSAntonio Borneomy $tabsize = 8; 703e89ad85SJerome Forissiermy ${CONFIG_} = "CONFIG_"; 7177f5b10aSHannes Eder 7277f5b10aSHannes Edersub help { 7377f5b10aSHannes Eder my ($exitcode) = @_; 7477f5b10aSHannes Eder 7577f5b10aSHannes Eder print << "EOM"; 7677f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 7777f5b10aSHannes EderVersion: $V 7877f5b10aSHannes Eder 7977f5b10aSHannes EderOptions: 8077f5b10aSHannes Eder -q, --quiet quiet 8177f5b10aSHannes Eder --no-tree run without a kernel tree 8277f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 8377f5b10aSHannes Eder --patch treat FILE as patchfile (default) 8477f5b10aSHannes Eder --emacs emacs compile window format 8577f5b10aSHannes Eder --terse one line per report 8634d8815fSJoe Perches --showfile emit diffed file position, not input file position 874a593c34SDu, Changbin -g, --git treat FILE as a single commit or git revision range 884a593c34SDu, Changbin single git commit with: 894a593c34SDu, Changbin <rev> 904a593c34SDu, Changbin <rev>^ 914a593c34SDu, Changbin <rev>~n 924a593c34SDu, Changbin multiple git commits with: 934a593c34SDu, Changbin <rev1>..<rev2> 944a593c34SDu, Changbin <rev1>...<rev2> 954a593c34SDu, Changbin <rev>-<count> 964a593c34SDu, Changbin git merges are ignored 9777f5b10aSHannes Eder -f, --file treat FILE as regular source file 9877f5b10aSHannes Eder --subjective, --strict enable more subjective tests 993beb42ecSJoe Perches --list-types list the possible message types 10091bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 101000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 1023beb42ecSJoe Perches --show-types show the specific message type in the output 103bdc48fa1SJoe Perches --max-line-length=n set the maximum line length, (default $max_line_length) 104bdc48fa1SJoe Perches if exceeded, warn on patches 105bdc48fa1SJoe Perches requires --strict for use with --file 10656193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 107bdc48fa1SJoe Perches --tab-size=n set the number of spaces for tab (default $tabsize) 10877f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 10977f5b10aSHannes Eder --no-summary suppress the per-file summary 11077f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 11177f5b10aSHannes Eder --summary-file include the filename in summary 11277f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 11377f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 11477f5b10aSHannes Eder is all off) 11577f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 11677f5b10aSHannes Eder literally 1173705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 1183705ce5bSJoe Perches If correctable single-line errors exist, create 1193705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 1203705ce5bSJoe Perches with potential errors corrected to the preferred 1213705ce5bSJoe Perches checkpatch style 1229624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 1239624b8d6SJoe Perches Is the same as --fix, but overwrites the input 1249624b8d6SJoe Perches file. It's your fault if there's no backup or git 125d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 126d62a201fSDave Hansen runtime errors. 127ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 128f1a63678SMaxim Uvarov (default:/usr/share/codespell/dictionary.txt) 129ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 13075ad8c57SJerome Forissier --typedefsfile Read additional types from this file 131737c0767SJohn Brooks --color[=WHEN] Use colors 'always', 'never', or only when output 132737c0767SJohn Brooks is a terminal ('auto'). Default is 'auto'. 1333e89ad85SJerome Forissier --kconfig-prefix=WORD use WORD as a prefix for Kconfig symbols (default 1343e89ad85SJerome Forissier ${CONFIG_}) 13577f5b10aSHannes Eder -h, --help, --version display this help and exit 13677f5b10aSHannes Eder 13777f5b10aSHannes EderWhen FILE is - read standard input. 13877f5b10aSHannes EderEOM 13977f5b10aSHannes Eder 14077f5b10aSHannes Eder exit($exitcode); 14177f5b10aSHannes Eder} 14277f5b10aSHannes Eder 1433beb42ecSJoe Perchessub uniq { 1443beb42ecSJoe Perches my %seen; 1453beb42ecSJoe Perches return grep { !$seen{$_}++ } @_; 1463beb42ecSJoe Perches} 1473beb42ecSJoe Perches 1483beb42ecSJoe Perchessub list_types { 1493beb42ecSJoe Perches my ($exitcode) = @_; 1503beb42ecSJoe Perches 1513beb42ecSJoe Perches my $count = 0; 1523beb42ecSJoe Perches 1533beb42ecSJoe Perches local $/ = undef; 1543beb42ecSJoe Perches 1553beb42ecSJoe Perches open(my $script, '<', abs_path($P)) or 1563beb42ecSJoe Perches die "$P: Can't read '$P' $!\n"; 1573beb42ecSJoe Perches 1583beb42ecSJoe Perches my $text = <$script>; 1593beb42ecSJoe Perches close($script); 1603beb42ecSJoe Perches 1613beb42ecSJoe Perches my @types = (); 1620547fa58SJean Delvare # Also catch when type or level is passed through a variable 1630547fa58SJean Delvare for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) { 1643beb42ecSJoe Perches push (@types, $_); 1653beb42ecSJoe Perches } 1663beb42ecSJoe Perches @types = sort(uniq(@types)); 1673beb42ecSJoe Perches print("#\tMessage type\n\n"); 1683beb42ecSJoe Perches foreach my $type (@types) { 1693beb42ecSJoe Perches print(++$count . "\t" . $type . "\n"); 1703beb42ecSJoe Perches } 1713beb42ecSJoe Perches 1723beb42ecSJoe Perches exit($exitcode); 1733beb42ecSJoe Perches} 1743beb42ecSJoe Perches 175000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 176000d1cc1SJoe Perchesif (-f $conf) { 177000d1cc1SJoe Perches my @conf_args; 178000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 179000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 180000d1cc1SJoe Perches 181000d1cc1SJoe Perches while (<$conffile>) { 182000d1cc1SJoe Perches my $line = $_; 183000d1cc1SJoe Perches 184000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 185000d1cc1SJoe Perches $line =~ s/^\s*//g; 186000d1cc1SJoe Perches $line =~ s/\s+/ /g; 187000d1cc1SJoe Perches 188000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 189000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 190000d1cc1SJoe Perches 191000d1cc1SJoe Perches my @words = split(" ", $line); 192000d1cc1SJoe Perches foreach my $word (@words) { 193000d1cc1SJoe Perches last if ($word =~ m/^#/); 194000d1cc1SJoe Perches push (@conf_args, $word); 195000d1cc1SJoe Perches } 196000d1cc1SJoe Perches } 197000d1cc1SJoe Perches close($conffile); 198000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 199000d1cc1SJoe Perches} 200000d1cc1SJoe Perches 201737c0767SJohn Brooks# Perl's Getopt::Long allows options to take optional arguments after a space. 202737c0767SJohn Brooks# Prevent --color by itself from consuming other arguments 203737c0767SJohn Brooksforeach (@ARGV) { 204737c0767SJohn Brooks if ($_ eq "--color" || $_ eq "-color") { 205737c0767SJohn Brooks $_ = "--color=$color"; 206737c0767SJohn Brooks } 207737c0767SJohn Brooks} 208737c0767SJohn Brooks 2090a920b5bSAndy WhitcroftGetOptions( 2106c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 2110a920b5bSAndy Whitcroft 'tree!' => \$tree, 2120a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 2130a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 2146c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 2158905a67cSAndy Whitcroft 'terse!' => \$terse, 21634d8815fSJoe Perches 'showfile!' => \$showfile, 21777f5b10aSHannes Eder 'f|file!' => \$file, 2184a593c34SDu, Changbin 'g|git!' => \$git, 2196c72ffaaSAndy Whitcroft 'subjective!' => \$check, 2206c72ffaaSAndy Whitcroft 'strict!' => \$check, 221000d1cc1SJoe Perches 'ignore=s' => \@ignore, 22291bfe484SJoe Perches 'types=s' => \@use, 223000d1cc1SJoe Perches 'show-types!' => \$show_types, 2243beb42ecSJoe Perches 'list-types!' => \$list_types, 2256cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 22656193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 227713a09deSAntonio Borneo 'tab-size=i' => \$tabsize, 2286c72ffaaSAndy Whitcroft 'root=s' => \$root, 2298905a67cSAndy Whitcroft 'summary!' => \$summary, 2308905a67cSAndy Whitcroft 'mailback!' => \$mailback, 23113214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 2323705ce5bSJoe Perches 'fix!' => \$fix, 2339624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 234d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 235c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 236773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 237ebfd7d62SJoe Perches 'codespell!' => \$codespell, 238ebfd7d62SJoe Perches 'codespellfile=s' => \$codespellfile, 23975ad8c57SJerome Forissier 'typedefsfile=s' => \$typedefsfile, 240737c0767SJohn Brooks 'color=s' => \$color, 241737c0767SJohn Brooks 'no-color' => \$color, #keep old behaviors of -nocolor 242737c0767SJohn Brooks 'nocolor' => \$color, #keep old behaviors of -nocolor 2433e89ad85SJerome Forissier 'kconfig-prefix=s' => \${CONFIG_}, 24477f5b10aSHannes Eder 'h|help' => \$help, 24577f5b10aSHannes Eder 'version' => \$help 24677f5b10aSHannes Eder) or help(1); 24777f5b10aSHannes Eder 24877f5b10aSHannes Ederhelp(0) if ($help); 2490a920b5bSAndy Whitcroft 2503beb42ecSJoe Percheslist_types(0) if ($list_types); 2513beb42ecSJoe Perches 2529624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 2532ac73b4fSJoe Perches$check_orig = $check; 2549624b8d6SJoe Perches 25532f30ca9SJoe Perchesdie "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix)); 25632f30ca9SJoe Perches 2570a920b5bSAndy Whitcroftmy $exit = 0; 2580a920b5bSAndy Whitcroft 2595b57980dSJoe Perchesmy $perl_version_ok = 1; 260d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 2615b57980dSJoe Perches $perl_version_ok = 0; 262d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 2635b57980dSJoe Perches exit(1) if (!$ignore_perl_version); 264d62a201fSDave Hansen} 265d62a201fSDave Hansen 26645107ff6SAllen Hubbe#if no filenames are given, push '-' to read patch from stdin 2670a920b5bSAndy Whitcroftif ($#ARGV < 0) { 26845107ff6SAllen Hubbe push(@ARGV, '-'); 2690a920b5bSAndy Whitcroft} 2700a920b5bSAndy Whitcroft 271737c0767SJohn Brooksif ($color =~ /^[01]$/) { 272737c0767SJohn Brooks $color = !$color; 273737c0767SJohn Brooks} elsif ($color =~ /^always$/i) { 274737c0767SJohn Brooks $color = 1; 275737c0767SJohn Brooks} elsif ($color =~ /^never$/i) { 276737c0767SJohn Brooks $color = 0; 277737c0767SJohn Brooks} elsif ($color =~ /^auto$/i) { 278737c0767SJohn Brooks $color = (-t STDOUT); 279737c0767SJohn Brooks} else { 28032f30ca9SJoe Perches die "$P: Invalid color mode: $color\n"; 281737c0767SJohn Brooks} 282737c0767SJohn Brooks 283713a09deSAntonio Borneo# skip TAB size 1 to avoid additional checks on $tabsize - 1 28432f30ca9SJoe Perchesdie "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2); 285713a09deSAntonio Borneo 28691bfe484SJoe Perchessub hash_save_array_words { 28791bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 28891bfe484SJoe Perches 28991bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 29091bfe484SJoe Perches foreach my $word (@array) { 291000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 292000d1cc1SJoe Perches $word =~ s/^\s*//g; 293000d1cc1SJoe Perches $word =~ s/\s+/ /g; 294000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 295000d1cc1SJoe Perches 296000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 297000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 298000d1cc1SJoe Perches 29991bfe484SJoe Perches $hashRef->{$word}++; 300000d1cc1SJoe Perches } 30191bfe484SJoe Perches} 30291bfe484SJoe Perches 30391bfe484SJoe Perchessub hash_show_words { 30491bfe484SJoe Perches my ($hashRef, $prefix) = @_; 30591bfe484SJoe Perches 3063c816e49SJoe Perches if (keys %$hashRef) { 307d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 30858cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 30991bfe484SJoe Perches print " $word"; 31091bfe484SJoe Perches } 311d8469f16SJoe Perches print "\n"; 31291bfe484SJoe Perches } 31391bfe484SJoe Perches} 31491bfe484SJoe Perches 31591bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 31691bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 317000d1cc1SJoe Perches 318c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 319c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 3207429c690SAndy Whitcroftmy $dbg_type = 0; 321a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 322c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 32321caa13cSAndy Whitcroft ## no critic 32421caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 32521caa13cSAndy Whitcroft die "$@" if ($@); 326c2fdda0dSAndy Whitcroft} 327c2fdda0dSAndy Whitcroft 328d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 329d2c0a235SAndy Whitcroft 3308905a67cSAndy Whitcroftif ($terse) { 3318905a67cSAndy Whitcroft $emacs = 1; 3328905a67cSAndy Whitcroft $quiet++; 3338905a67cSAndy Whitcroft} 3348905a67cSAndy Whitcroft 3356c72ffaaSAndy Whitcroftif ($tree) { 3366c72ffaaSAndy Whitcroft if (defined $root) { 3376c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 3386c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 3396c72ffaaSAndy Whitcroft } 3406c72ffaaSAndy Whitcroft } else { 3416c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 3426c72ffaaSAndy Whitcroft $root = '.'; 3436c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 3446c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 3456c72ffaaSAndy Whitcroft $root = $1; 3466c72ffaaSAndy Whitcroft } 3476c72ffaaSAndy Whitcroft } 3486c72ffaaSAndy Whitcroft 3496c72ffaaSAndy Whitcroft if (!defined $root) { 3500a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 3510a920b5bSAndy Whitcroft exit(2); 3520a920b5bSAndy Whitcroft } 3536c72ffaaSAndy Whitcroft} 3546c72ffaaSAndy Whitcroft 3556c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 3566c72ffaaSAndy Whitcroft 3572ceb532bSAndy Whitcroftour $Ident = qr{ 3582ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 3592ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 3602ceb532bSAndy Whitcroft }x; 3616c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 3626c72ffaaSAndy Whitcroftour $Sparse = qr{ 3636c72ffaaSAndy Whitcroft __user| 3646c72ffaaSAndy Whitcroft __kernel| 3656c72ffaaSAndy Whitcroft __force| 3666c72ffaaSAndy Whitcroft __iomem| 3676c72ffaaSAndy Whitcroft __must_check| 368417495edSAndy Whitcroft __kprobes| 369165e72a6SSven Eckelmann __ref| 37033aa4597SGeert Uytterhoeven __refconst| 37133aa4597SGeert Uytterhoeven __refdata| 372ad315455SBoqun Feng __rcu| 373ad315455SBoqun Feng __private 3746c72ffaaSAndy Whitcroft }x; 375e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 376e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 377e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 378e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 379e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 3808716de38SJoe Perches 38152131292SWolfram Sang# Notes to $Attribute: 38252131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 3836c72ffaaSAndy Whitcroftour $Attribute = qr{ 3846c72ffaaSAndy Whitcroft const| 38503f1df7dSJoe Perches __percpu| 38603f1df7dSJoe Perches __nocast| 38703f1df7dSJoe Perches __safe| 38846d832f5SMichael S. Tsirkin __bitwise| 38903f1df7dSJoe Perches __packed__| 39003f1df7dSJoe Perches __packed2__| 39103f1df7dSJoe Perches __naked| 39203f1df7dSJoe Perches __maybe_unused| 39303f1df7dSJoe Perches __always_unused| 39403f1df7dSJoe Perches __noreturn| 39503f1df7dSJoe Perches __used| 39603f1df7dSJoe Perches __cold| 397e23ef1f3SJoe Perches __pure| 39803f1df7dSJoe Perches __noclone| 39903f1df7dSJoe Perches __deprecated| 4006c72ffaaSAndy Whitcroft __read_mostly| 401c5967e98SJoe Perches __ro_after_init| 4026c72ffaaSAndy Whitcroft __kprobes| 4038716de38SJoe Perches $InitAttribute| 40424e1d81aSAndy Whitcroft ____cacheline_aligned| 40524e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 4065fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 4075fe3af11SAndy Whitcroft __weak 4086c72ffaaSAndy Whitcroft }x; 409c45dcabdSAndy Whitcroftour $Modifier; 41091cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 4116c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 4126c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 4136c72ffaaSAndy Whitcroft 41495e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 41595e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 41695e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 41795e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 4182435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 419c0a5c898SJoe Perchesour $String = qr{"[X\t]*"}; 420326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 421326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 422326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 42374349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 4242435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 425326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 426447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 42723f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 4286c72ffaaSAndy Whitcroftour $Operators = qr{ 4296c72ffaaSAndy Whitcroft <=|>=|==|!=| 4306c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 43123f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 4326c72ffaaSAndy Whitcroft }x; 4336c72ffaaSAndy Whitcroft 43491cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 43591cb5195SJoe Perches 436ab7e23f3SJoe Perchesour $BasicType; 4378905a67cSAndy Whitcroftour $NonptrType; 4381813087dSJoe Perchesour $NonptrTypeMisordered; 4398716de38SJoe Perchesour $NonptrTypeWithAttr; 4408905a67cSAndy Whitcroftour $Type; 4411813087dSJoe Perchesour $TypeMisordered; 4428905a67cSAndy Whitcroftour $Declare; 4431813087dSJoe Perchesour $DeclareMisordered; 4448905a67cSAndy Whitcroft 44515662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 44615662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 447171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 448171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 449171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 450171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 451171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 452171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 453171ae1a4SAndy Whitcroft}x; 454171ae1a4SAndy Whitcroft 45515662b3eSJoe Perchesour $UTF8 = qr{ 45615662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 45715662b3eSJoe Perches | $NON_ASCII_UTF8 45815662b3eSJoe Perches}x; 45915662b3eSJoe Perches 460e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 461021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 462021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 463021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 464021158b4SJoe Perches)}; 465e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 466fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 4678ed22cadSAndy Whitcroft atomic_t 4688ed22cadSAndy Whitcroft)}; 469e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 470e6176fa4SJoe Perches $typeC99Typedefs\b| 471e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 472e6176fa4SJoe Perches $typeKernelTypedefs\b 473e6176fa4SJoe Perches)}; 4748ed22cadSAndy Whitcroft 4756d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 4766d32f7a3SJoe Perches 477691e669bSJoe Perchesour $logFunctions = qr{(?x: 478758d7aadSMiles Chen printk(?:_ratelimited|_once|_deferred_once|_deferred|)| 4797d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 48087bd499aSJoe Perches TP_printk| 4816e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 482b0531722SJoe Perches panic| 48306668727SJoe Perches MODULE_[A-Z_]+| 48406668727SJoe Perches seq_vprintf|seq_printf|seq_puts 485691e669bSJoe Perches)}; 486691e669bSJoe Perches 487e29a70f1SJoe Perchesour $allocFunctions = qr{(?x: 488e29a70f1SJoe Perches (?:(?:devm_)? 489e29a70f1SJoe Perches (?:kv|k|v)[czm]alloc(?:_node|_array)? | 490e29a70f1SJoe Perches kstrdup(?:_const)? | 491e29a70f1SJoe Perches kmemdup(?:_nul)?) | 492461e1565SChristophe JAILLET (?:\w+)?alloc_skb(?:_ip_align)? | 493e29a70f1SJoe Perches # dev_alloc_skb/netdev_alloc_skb, et al 494e29a70f1SJoe Perches dma_alloc_coherent 495e29a70f1SJoe Perches)}; 496e29a70f1SJoe Perches 49720112475SJoe Perchesour $signature_tags = qr{(?xi: 49820112475SJoe Perches Signed-off-by:| 499d499480cSJorge Ramirez-Ortiz Co-developed-by:| 50020112475SJoe Perches Acked-by:| 50120112475SJoe Perches Tested-by:| 50220112475SJoe Perches Reviewed-by:| 50320112475SJoe Perches Reported-by:| 5048543ae12SMugunthan V N Suggested-by:| 50520112475SJoe Perches To:| 50620112475SJoe Perches Cc: 50720112475SJoe Perches)}; 50820112475SJoe Perches 5091813087dSJoe Perchesour @typeListMisordered = ( 5101813087dSJoe Perches qr{char\s+(?:un)?signed}, 5111813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 5121813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 5131813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 5141813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 5151813087dSJoe Perches qr{short\s+(?:un)?signed}, 5161813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 5171813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 5181813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 5191813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 5201813087dSJoe Perches qr{int\s+(?:un)?signed}, 5211813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 5221813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 5231813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 5241813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 5251813087dSJoe Perches qr{long\s+(?:un)?signed}, 5261813087dSJoe Perches); 5271813087dSJoe Perches 5288905a67cSAndy Whitcroftour @typeList = ( 5298905a67cSAndy Whitcroft qr{void}, 5300c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 5310c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 5320c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 5330c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 5340c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 5350c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 5360c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 5370c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 5380c773d9dSJoe Perches qr{(?:un)?signed}, 5398905a67cSAndy Whitcroft qr{float}, 5408905a67cSAndy Whitcroft qr{double}, 5418905a67cSAndy Whitcroft qr{bool}, 5428905a67cSAndy Whitcroft qr{struct\s+$Ident}, 5438905a67cSAndy Whitcroft qr{union\s+$Ident}, 5448905a67cSAndy Whitcroft qr{enum\s+$Ident}, 5458905a67cSAndy Whitcroft qr{${Ident}_t}, 5468905a67cSAndy Whitcroft qr{${Ident}_handler}, 5478905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 5481813087dSJoe Perches @typeListMisordered, 5498905a67cSAndy Whitcroft); 550938224b5SJoe Perches 551938224b5SJoe Perchesour $C90_int_types = qr{(?x: 552938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 553938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 554938224b5SJoe Perches long\s+long\s+(?:un)?signed| 555938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 556938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 557938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 558938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 559938224b5SJoe Perches 560938224b5SJoe Perches long\s+int\s+(?:un)?signed| 561938224b5SJoe Perches long\s+(?:un)?signed\s+int| 562938224b5SJoe Perches long\s+(?:un)?signed| 563938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 564938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 565938224b5SJoe Perches int\s+long\s+(?:un)?signed| 566938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 567938224b5SJoe Perches 568938224b5SJoe Perches int\s+(?:un)?signed| 569938224b5SJoe Perches (?:(?:un)?signed\s+)?int 570938224b5SJoe Perches)}; 571938224b5SJoe Perches 572485ff23eSAlex Dowadour @typeListFile = (); 5738716de38SJoe Perchesour @typeListWithAttr = ( 5748716de38SJoe Perches @typeList, 5758716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 5768716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 5778716de38SJoe Perches); 5788716de38SJoe Perches 579c45dcabdSAndy Whitcroftour @modifierList = ( 580c45dcabdSAndy Whitcroft qr{fastcall}, 581c45dcabdSAndy Whitcroft); 582485ff23eSAlex Dowadour @modifierListFile = (); 5838905a67cSAndy Whitcroft 5842435880fSJoe Perchesour @mode_permission_funcs = ( 5852435880fSJoe Perches ["module_param", 3], 5862435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 5872435880fSJoe Perches ["module_param_array_named", 5], 5882435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 5892435880fSJoe Perches ["proc_create(?:_data|)", 2], 590459cf0aeSJoe Perches ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2], 591459cf0aeSJoe Perches ["IIO_DEV_ATTR_[A-Z_]+", 1], 592459cf0aeSJoe Perches ["SENSOR_(?:DEVICE_|)ATTR_2", 2], 593459cf0aeSJoe Perches ["SENSOR_TEMPLATE(?:_2|)", 3], 594459cf0aeSJoe Perches ["__ATTR", 2], 5952435880fSJoe Perches); 5962435880fSJoe Perches 5971a3dcf2eSJoe Perchesmy $word_pattern = '\b[A-Z]?[a-z]{2,}\b'; 5981a3dcf2eSJoe Perches 599515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 600515a235eSJoe Perchesour $mode_perms_search = ""; 601515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 602515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 603515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 604515a235eSJoe Perches} 60500180468SJoe Perches$mode_perms_search = "(?:${mode_perms_search})"; 606515a235eSJoe Perches 6079189c7e7SJoe Perchesour %deprecated_apis = ( 6089189c7e7SJoe Perches "synchronize_rcu_bh" => "synchronize_rcu", 6099189c7e7SJoe Perches "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited", 6109189c7e7SJoe Perches "call_rcu_bh" => "call_rcu", 6119189c7e7SJoe Perches "rcu_barrier_bh" => "rcu_barrier", 6129189c7e7SJoe Perches "synchronize_sched" => "synchronize_rcu", 6139189c7e7SJoe Perches "synchronize_sched_expedited" => "synchronize_rcu_expedited", 6149189c7e7SJoe Perches "call_rcu_sched" => "call_rcu", 6159189c7e7SJoe Perches "rcu_barrier_sched" => "rcu_barrier", 6169189c7e7SJoe Perches "get_state_synchronize_sched" => "get_state_synchronize_rcu", 6179189c7e7SJoe Perches "cond_synchronize_sched" => "cond_synchronize_rcu", 6189189c7e7SJoe Perches); 6199189c7e7SJoe Perches 6209189c7e7SJoe Perches#Create a search pattern for all these strings to speed up a loop below 6219189c7e7SJoe Perchesour $deprecated_apis_search = ""; 6229189c7e7SJoe Perchesforeach my $entry (keys %deprecated_apis) { 6239189c7e7SJoe Perches $deprecated_apis_search .= '|' if ($deprecated_apis_search ne ""); 6249189c7e7SJoe Perches $deprecated_apis_search .= $entry; 6259189c7e7SJoe Perches} 6269189c7e7SJoe Perches$deprecated_apis_search = "(?:${deprecated_apis_search})"; 6279189c7e7SJoe Perches 628b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 629b392c64fSJoe Perches S_IWUGO | 630b392c64fSJoe Perches S_IWOTH | 631b392c64fSJoe Perches S_IRWXUGO | 632b392c64fSJoe Perches S_IALLUGO | 633b392c64fSJoe Perches 0[0-7][0-7][2367] 634b392c64fSJoe Perches}x; 635b392c64fSJoe Perches 636f90774e1SJoe Perchesour %mode_permission_string_types = ( 637f90774e1SJoe Perches "S_IRWXU" => 0700, 638f90774e1SJoe Perches "S_IRUSR" => 0400, 639f90774e1SJoe Perches "S_IWUSR" => 0200, 640f90774e1SJoe Perches "S_IXUSR" => 0100, 641f90774e1SJoe Perches "S_IRWXG" => 0070, 642f90774e1SJoe Perches "S_IRGRP" => 0040, 643f90774e1SJoe Perches "S_IWGRP" => 0020, 644f90774e1SJoe Perches "S_IXGRP" => 0010, 645f90774e1SJoe Perches "S_IRWXO" => 0007, 646f90774e1SJoe Perches "S_IROTH" => 0004, 647f90774e1SJoe Perches "S_IWOTH" => 0002, 648f90774e1SJoe Perches "S_IXOTH" => 0001, 649f90774e1SJoe Perches "S_IRWXUGO" => 0777, 650f90774e1SJoe Perches "S_IRUGO" => 0444, 651f90774e1SJoe Perches "S_IWUGO" => 0222, 652f90774e1SJoe Perches "S_IXUGO" => 0111, 653f90774e1SJoe Perches); 654f90774e1SJoe Perches 655f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below 656f90774e1SJoe Perchesour $mode_perms_string_search = ""; 657f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) { 658f90774e1SJoe Perches $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); 659f90774e1SJoe Perches $mode_perms_string_search .= $entry; 660f90774e1SJoe Perches} 66100180468SJoe Perchesour $single_mode_perms_string_search = "(?:${mode_perms_string_search})"; 66200180468SJoe Perchesour $multi_mode_perms_string_search = qr{ 66300180468SJoe Perches ${single_mode_perms_string_search} 66400180468SJoe Perches (?:\s*\|\s*${single_mode_perms_string_search})* 66500180468SJoe Perches}x; 66600180468SJoe Perches 66700180468SJoe Perchessub perms_to_octal { 66800180468SJoe Perches my ($string) = @_; 66900180468SJoe Perches 67000180468SJoe Perches return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/); 67100180468SJoe Perches 67200180468SJoe Perches my $val = ""; 67300180468SJoe Perches my $oval = ""; 67400180468SJoe Perches my $to = 0; 67500180468SJoe Perches my $curpos = 0; 67600180468SJoe Perches my $lastpos = 0; 67700180468SJoe Perches while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) { 67800180468SJoe Perches $curpos = pos($string); 67900180468SJoe Perches my $match = $2; 68000180468SJoe Perches my $omatch = $1; 68100180468SJoe Perches last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos)); 68200180468SJoe Perches $lastpos = $curpos; 68300180468SJoe Perches $to |= $mode_permission_string_types{$match}; 68400180468SJoe Perches $val .= '\s*\|\s*' if ($val ne ""); 68500180468SJoe Perches $val .= $match; 68600180468SJoe Perches $oval .= $omatch; 68700180468SJoe Perches } 68800180468SJoe Perches $oval =~ s/^\s*\|\s*//; 68900180468SJoe Perches $oval =~ s/\s*\|\s*$//; 69000180468SJoe Perches return sprintf("%04o", $to); 69100180468SJoe Perches} 692f90774e1SJoe Perches 6937840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 6947840a94cSWolfram Sang irq| 695cdcee686SSergey Ryazanov memory| 696cdcee686SSergey Ryazanov time| 697cdcee686SSergey Ryazanov reboot 6987840a94cSWolfram Sang)}; 6997840a94cSWolfram Sang# memory.h: ARM has a custom one 7007840a94cSWolfram Sang 70166b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 70266b47b4aSKees Cookmy $misspellings; 70366b47b4aSKees Cookmy %spelling_fix; 70436061e38SJoe Perches 70536061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 70666b47b4aSKees Cook while (<$spelling>) { 70766b47b4aSKees Cook my $line = $_; 70866b47b4aSKees Cook 70966b47b4aSKees Cook $line =~ s/\s*\n?$//g; 71066b47b4aSKees Cook $line =~ s/^\s*//g; 71166b47b4aSKees Cook 71266b47b4aSKees Cook next if ($line =~ m/^\s*#/); 71366b47b4aSKees Cook next if ($line =~ m/^\s*$/); 71466b47b4aSKees Cook 71566b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 71666b47b4aSKees Cook 71766b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 71866b47b4aSKees Cook } 71966b47b4aSKees Cook close($spelling); 72036061e38SJoe Perches} else { 72136061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 72236061e38SJoe Perches} 72366b47b4aSKees Cook 724ebfd7d62SJoe Perchesif ($codespell) { 725ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 726ebfd7d62SJoe Perches while (<$spelling>) { 727ebfd7d62SJoe Perches my $line = $_; 728ebfd7d62SJoe Perches 729ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 730ebfd7d62SJoe Perches $line =~ s/^\s*//g; 731ebfd7d62SJoe Perches 732ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 733ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 734ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 735ebfd7d62SJoe Perches 736ebfd7d62SJoe Perches $line =~ s/,.*$//; 737ebfd7d62SJoe Perches 738ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 739ebfd7d62SJoe Perches 740ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 741ebfd7d62SJoe Perches } 742ebfd7d62SJoe Perches close($spelling); 743ebfd7d62SJoe Perches } else { 744ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 745ebfd7d62SJoe Perches } 746ebfd7d62SJoe Perches} 747ebfd7d62SJoe Perches 748ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 749ebfd7d62SJoe Perches 75075ad8c57SJerome Forissiersub read_words { 75175ad8c57SJerome Forissier my ($wordsRef, $file) = @_; 75275ad8c57SJerome Forissier 75375ad8c57SJerome Forissier if (open(my $words, '<', $file)) { 75475ad8c57SJerome Forissier while (<$words>) { 755bf1fa1daSJoe Perches my $line = $_; 756bf1fa1daSJoe Perches 757bf1fa1daSJoe Perches $line =~ s/\s*\n?$//g; 758bf1fa1daSJoe Perches $line =~ s/^\s*//g; 759bf1fa1daSJoe Perches 760bf1fa1daSJoe Perches next if ($line =~ m/^\s*#/); 761bf1fa1daSJoe Perches next if ($line =~ m/^\s*$/); 762bf1fa1daSJoe Perches if ($line =~ /\s/) { 76375ad8c57SJerome Forissier print("$file: '$line' invalid - ignored\n"); 764bf1fa1daSJoe Perches next; 765bf1fa1daSJoe Perches } 766bf1fa1daSJoe Perches 767ced69da1SQuentin Monnet $$wordsRef .= '|' if (defined $$wordsRef); 76875ad8c57SJerome Forissier $$wordsRef .= $line; 769bf1fa1daSJoe Perches } 77075ad8c57SJerome Forissier close($file); 77175ad8c57SJerome Forissier return 1; 772bf1fa1daSJoe Perches } 773bf1fa1daSJoe Perches 77475ad8c57SJerome Forissier return 0; 77575ad8c57SJerome Forissier} 77675ad8c57SJerome Forissier 777ced69da1SQuentin Monnetmy $const_structs; 778ced69da1SQuentin Monnetif (show_type("CONST_STRUCT")) { 77975ad8c57SJerome Forissier read_words(\$const_structs, $conststructsfile) 78075ad8c57SJerome Forissier or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 781ced69da1SQuentin Monnet} 78275ad8c57SJerome Forissier 783ced69da1SQuentin Monnetif (defined($typedefsfile)) { 784ced69da1SQuentin Monnet my $typeOtherTypedefs; 78575ad8c57SJerome Forissier read_words(\$typeOtherTypedefs, $typedefsfile) 78675ad8c57SJerome Forissier or warn "No additional types will be considered - file '$typedefsfile': $!\n"; 787ced69da1SQuentin Monnet $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs); 78875ad8c57SJerome Forissier} 78975ad8c57SJerome Forissier 7908905a67cSAndy Whitcroftsub build_types { 791485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 792485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 7931813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 7948716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 795c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 796ab7e23f3SJoe Perches $BasicType = qr{ 797ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 798ab7e23f3SJoe Perches (?:${all}\b) 799ab7e23f3SJoe Perches }x; 8008905a67cSAndy Whitcroft $NonptrType = qr{ 801d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 802cf655043SAndy Whitcroft (?: 8036b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 8048ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 805c45dcabdSAndy Whitcroft (?:${all}\b) 806cf655043SAndy Whitcroft ) 807c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 8088905a67cSAndy Whitcroft }x; 8091813087dSJoe Perches $NonptrTypeMisordered = qr{ 8101813087dSJoe Perches (?:$Modifier\s+|const\s+)* 8111813087dSJoe Perches (?: 8121813087dSJoe Perches (?:${Misordered}\b) 8131813087dSJoe Perches ) 8141813087dSJoe Perches (?:\s+$Modifier|\s+const)* 8151813087dSJoe Perches }x; 8168716de38SJoe Perches $NonptrTypeWithAttr = qr{ 8178716de38SJoe Perches (?:$Modifier\s+|const\s+)* 8188716de38SJoe Perches (?: 8198716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 8208716de38SJoe Perches (?:$typeTypedefs\b)| 8218716de38SJoe Perches (?:${allWithAttr}\b) 8228716de38SJoe Perches ) 8238716de38SJoe Perches (?:\s+$Modifier|\s+const)* 8248716de38SJoe Perches }x; 8258905a67cSAndy Whitcroft $Type = qr{ 826c45dcabdSAndy Whitcroft $NonptrType 8277b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 828c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 8298905a67cSAndy Whitcroft }x; 8301813087dSJoe Perches $TypeMisordered = qr{ 8311813087dSJoe Perches $NonptrTypeMisordered 8327b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 8331813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 8341813087dSJoe Perches }x; 83591cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 8361813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 8378905a67cSAndy Whitcroft} 8388905a67cSAndy Whitcroftbuild_types(); 8396c72ffaaSAndy Whitcroft 8407d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 841d1fe9c09SJoe Perches 842d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 843d1fe9c09SJoe Perches# requires at least perl version v5.10.0 844d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 845d1fe9c09SJoe Perches 846d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 8472435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 848c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 8497d2367afSJoe Perches 850f8422308SJoe Perchesour $declaration_macros = qr{(?x: 8513e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 852fe658f94SSteffen Maier (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(| 8533d102fc0SGilad Ben-Yossef (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\( 854f8422308SJoe Perches)}; 855f8422308SJoe Perches 856*8d0325ccSAditya Srivastavaour %allow_repeated_words = ( 857*8d0325ccSAditya Srivastava add => '', 858*8d0325ccSAditya Srivastava added => '', 859*8d0325ccSAditya Srivastava bad => '', 860*8d0325ccSAditya Srivastava be => '', 861*8d0325ccSAditya Srivastava); 862*8d0325ccSAditya Srivastava 8637d2367afSJoe Perchessub deparenthesize { 8647d2367afSJoe Perches my ($string) = @_; 8657d2367afSJoe Perches return "" if (!defined($string)); 8665b9553abSJoe Perches 8675b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 8685b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 8695b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 8705b9553abSJoe Perches } 8715b9553abSJoe Perches 8727d2367afSJoe Perches $string =~ s@\s+@ @g; 8735b9553abSJoe Perches 8747d2367afSJoe Perches return $string; 8757d2367afSJoe Perches} 8767d2367afSJoe Perches 8773445686aSJoe Perchessub seed_camelcase_file { 8783445686aSJoe Perches my ($file) = @_; 8793445686aSJoe Perches 8803445686aSJoe Perches return if (!(-f $file)); 8813445686aSJoe Perches 8823445686aSJoe Perches local $/; 8833445686aSJoe Perches 8843445686aSJoe Perches open(my $include_file, '<', "$file") 8853445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 8863445686aSJoe Perches my $text = <$include_file>; 8873445686aSJoe Perches close($include_file); 8883445686aSJoe Perches 8893445686aSJoe Perches my @lines = split('\n', $text); 8903445686aSJoe Perches 8913445686aSJoe Perches foreach my $line (@lines) { 8923445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 8933445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 8943445686aSJoe Perches $camelcase{$1} = 1; 89511ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 89611ea516aSJoe Perches $camelcase{$1} = 1; 89711ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 8983445686aSJoe Perches $camelcase{$1} = 1; 8993445686aSJoe Perches } 9003445686aSJoe Perches } 9013445686aSJoe Perches} 9023445686aSJoe Perches 903cd28b119SJoe Perchesour %maintained_status = (); 904cd28b119SJoe Perches 90585b0ee18SJoe Perchessub is_maintained_obsolete { 90685b0ee18SJoe Perches my ($filename) = @_; 90785b0ee18SJoe Perches 908f2c19c2fSJerome Forissier return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 90985b0ee18SJoe Perches 910cd28b119SJoe Perches if (!exists($maintained_status{$filename})) { 911cd28b119SJoe Perches $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 912cd28b119SJoe Perches } 91385b0ee18SJoe Perches 914cd28b119SJoe Perches return $maintained_status{$filename} =~ /obsolete/i; 91585b0ee18SJoe Perches} 91685b0ee18SJoe Perches 9173b6e8ac9SJoe Perchessub is_SPDX_License_valid { 9183b6e8ac9SJoe Perches my ($license) = @_; 9193b6e8ac9SJoe Perches 9200f7f635bSJoe Perches return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$gitroot")); 9213b6e8ac9SJoe Perches 92256294112SJoe Perches my $root_path = abs_path($root); 92356294112SJoe Perches my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`; 9243b6e8ac9SJoe Perches return 0 if ($status ne ""); 9253b6e8ac9SJoe Perches return 1; 9263b6e8ac9SJoe Perches} 9273b6e8ac9SJoe Perches 9283445686aSJoe Perchesmy $camelcase_seeded = 0; 9293445686aSJoe Perchessub seed_camelcase_includes { 9303445686aSJoe Perches return if ($camelcase_seeded); 9313445686aSJoe Perches 9323445686aSJoe Perches my $files; 933c707a81dSJoe Perches my $camelcase_cache = ""; 934c707a81dSJoe Perches my @include_files = (); 935c707a81dSJoe Perches 936c707a81dSJoe Perches $camelcase_seeded = 1; 937351b2a1fSJoe Perches 9380f7f635bSJoe Perches if (-e "$gitroot") { 939dbbf869dSJoe Perches my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`; 940351b2a1fSJoe Perches chomp $git_last_include_commit; 941c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 942c707a81dSJoe Perches } else { 943c707a81dSJoe Perches my $last_mod_date = 0; 944c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 945c707a81dSJoe Perches @include_files = split('\n', $files); 946c707a81dSJoe Perches foreach my $file (@include_files) { 947c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 948c707a81dSJoe Perches localtime((stat $file)[9])); 949c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 950c707a81dSJoe Perches } 951c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 952c707a81dSJoe Perches } 953c707a81dSJoe Perches 954c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 955c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 956c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 957351b2a1fSJoe Perches while (<$camelcase_file>) { 958351b2a1fSJoe Perches chomp; 959351b2a1fSJoe Perches $camelcase{$_} = 1; 960351b2a1fSJoe Perches } 961351b2a1fSJoe Perches close($camelcase_file); 962351b2a1fSJoe Perches 963351b2a1fSJoe Perches return; 964351b2a1fSJoe Perches } 965c707a81dSJoe Perches 9660f7f635bSJoe Perches if (-e "$gitroot") { 967dbbf869dSJoe Perches $files = `${git_command} ls-files "include/*.h"`; 968c707a81dSJoe Perches @include_files = split('\n', $files); 9693445686aSJoe Perches } 970c707a81dSJoe Perches 9713445686aSJoe Perches foreach my $file (@include_files) { 9723445686aSJoe Perches seed_camelcase_file($file); 9733445686aSJoe Perches } 974351b2a1fSJoe Perches 975c707a81dSJoe Perches if ($camelcase_cache ne "") { 976351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 977c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 978c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 979351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 980351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 981351b2a1fSJoe Perches } 982351b2a1fSJoe Perches close($camelcase_file); 983351b2a1fSJoe Perches } 9843445686aSJoe Perches} 9853445686aSJoe Perches 986f5f61325SJoe Perchessub git_is_single_file { 987f5f61325SJoe Perches my ($filename) = @_; 988f5f61325SJoe Perches 989f5f61325SJoe Perches return 0 if ((which("git") eq "") || !(-e "$gitroot")); 990f5f61325SJoe Perches 991f5f61325SJoe Perches my $output = `${git_command} ls-files -- $filename 2>/dev/null`; 992f5f61325SJoe Perches my $count = $output =~ tr/\n//; 993f5f61325SJoe Perches return $count eq 1 && $output =~ m{^${filename}$}; 994f5f61325SJoe Perches} 995f5f61325SJoe Perches 996d311cd44SJoe Perchessub git_commit_info { 997d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 998d311cd44SJoe Perches 9990f7f635bSJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot")); 1000d311cd44SJoe Perches 1001dbbf869dSJoe Perches my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`; 1002d311cd44SJoe Perches $output =~ s/^\s*//gm; 1003d311cd44SJoe Perches my @lines = split("\n", $output); 1004d311cd44SJoe Perches 10050d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 10060d7835fcSJoe Perches 10075a7f4455SSean Christopherson if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) { 1008d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 1009d311cd44SJoe Perches# all matching commit ids, but it's very slow... 1010d311cd44SJoe Perches# 1011d311cd44SJoe Perches# echo "checking commits $1..." 1012d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 1013d311cd44SJoe Perches# while read line ; do 1014d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 1015d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 1016d311cd44SJoe Perches# done 1017d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 1018948b133aSHeinrich Schuchardt $id = undef; 1019d311cd44SJoe Perches } else { 1020d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 1021d311cd44SJoe Perches $desc = substr($lines[0], 41); 1022d311cd44SJoe Perches } 1023d311cd44SJoe Perches 1024d311cd44SJoe Perches return ($id, $desc); 1025d311cd44SJoe Perches} 1026d311cd44SJoe Perches 10276c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 10280a920b5bSAndy Whitcroft 102900df344fSAndy Whitcroftmy @rawlines = (); 1030c2fdda0dSAndy Whitcroftmy @lines = (); 10313705ce5bSJoe Perchesmy @fixed = (); 1032d752fcc8SJoe Perchesmy @fixed_inserted = (); 1033d752fcc8SJoe Perchesmy @fixed_deleted = (); 1034194f66fcSJoe Perchesmy $fixlinenr = -1; 1035194f66fcSJoe Perches 10364a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 10374a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 10380f7f635bSJoe Perchesdie "$P: No git repository found\n" if ($git && !-e "$gitroot"); 10394a593c34SDu, Changbin 10404a593c34SDu, Changbinif ($git) { 10414a593c34SDu, Changbin my @commits = (); 10420dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 10434a593c34SDu, Changbin my $git_range; 104428898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 104528898fd1SJoe Perches $git_range = "-$2 $1"; 10464a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 10474a593c34SDu, Changbin $git_range = "$commit_expr"; 10484a593c34SDu, Changbin } else { 10490dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 10500dea9f1eSJoe Perches } 1051dbbf869dSJoe Perches my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 10520dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 105328898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 105428898fd1SJoe Perches next if (!defined($1) || !defined($2)); 10550dea9f1eSJoe Perches my $sha1 = $1; 10560dea9f1eSJoe Perches my $subject = $2; 10570dea9f1eSJoe Perches unshift(@commits, $sha1); 10580dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 10594a593c34SDu, Changbin } 10604a593c34SDu, Changbin } 10614a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 10624a593c34SDu, Changbin @ARGV = @commits; 10634a593c34SDu, Changbin} 10644a593c34SDu, Changbin 1065c2fdda0dSAndy Whitcroftmy $vname; 106698005e8cSVadim Bendebury$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"}; 10676c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 106821caa13cSAndy Whitcroft my $FILE; 1069f5f61325SJoe Perches my $is_git_file = git_is_single_file($filename); 1070f5f61325SJoe Perches my $oldfile = $file; 1071f5f61325SJoe Perches $file = 1 if ($is_git_file); 10724a593c34SDu, Changbin if ($git) { 10734a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 10744a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 10754a593c34SDu, Changbin } elsif ($file) { 107621caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 10776c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 107821caa13cSAndy Whitcroft } elsif ($filename eq '-') { 107921caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 10806c72ffaaSAndy Whitcroft } else { 108121caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 10826c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 10836c72ffaaSAndy Whitcroft } 1084c2fdda0dSAndy Whitcroft if ($filename eq '-') { 1085c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 10864a593c34SDu, Changbin } elsif ($git) { 10870dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 1088c2fdda0dSAndy Whitcroft } else { 1089c2fdda0dSAndy Whitcroft $vname = $filename; 1090c2fdda0dSAndy Whitcroft } 109121caa13cSAndy Whitcroft while (<$FILE>) { 10920a920b5bSAndy Whitcroft chomp; 109300df344fSAndy Whitcroft push(@rawlines, $_); 1094c7f574d0SGeert Uytterhoeven $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i); 10956c72ffaaSAndy Whitcroft } 109621caa13cSAndy Whitcroft close($FILE); 1097d8469f16SJoe Perches 1098d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 1099d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1100d8469f16SJoe Perches print "$vname\n"; 1101d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1102d8469f16SJoe Perches } 1103d8469f16SJoe Perches 1104c2fdda0dSAndy Whitcroft if (!process($filename)) { 11050a920b5bSAndy Whitcroft $exit = 1; 11060a920b5bSAndy Whitcroft } 110700df344fSAndy Whitcroft @rawlines = (); 110813214adfSAndy Whitcroft @lines = (); 11093705ce5bSJoe Perches @fixed = (); 1110d752fcc8SJoe Perches @fixed_inserted = (); 1111d752fcc8SJoe Perches @fixed_deleted = (); 1112194f66fcSJoe Perches $fixlinenr = -1; 1113485ff23eSAlex Dowad @modifierListFile = (); 1114485ff23eSAlex Dowad @typeListFile = (); 1115485ff23eSAlex Dowad build_types(); 1116f5f61325SJoe Perches $file = $oldfile if ($is_git_file); 11170a920b5bSAndy Whitcroft} 11180a920b5bSAndy Whitcroft 1119d8469f16SJoe Perchesif (!$quiet) { 11203c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 11213c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 11223c816e49SJoe Perches 11235b57980dSJoe Perches if (!$perl_version_ok) { 1124d8469f16SJoe Perches print << "EOM" 1125d8469f16SJoe Perches 1126d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 11275b57980dSJoe Perches An upgrade to at least perl $minimum_perl_version is suggested. 1128d8469f16SJoe PerchesEOM 1129d8469f16SJoe Perches } 1130d8469f16SJoe Perches if ($exit) { 1131d8469f16SJoe Perches print << "EOM" 1132d8469f16SJoe Perches 1133d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 1134d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 1135d8469f16SJoe PerchesEOM 1136d8469f16SJoe Perches } 1137d8469f16SJoe Perches} 1138d8469f16SJoe Perches 11390a920b5bSAndy Whitcroftexit($exit); 11400a920b5bSAndy Whitcroft 11410a920b5bSAndy Whitcroftsub top_of_kernel_tree { 11426c72ffaaSAndy Whitcroft my ($root) = @_; 11436c72ffaaSAndy Whitcroft 11446c72ffaaSAndy Whitcroft my @tree_check = ( 11456c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 11466c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 11476c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 11486c72ffaaSAndy Whitcroft ); 11496c72ffaaSAndy Whitcroft 11506c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 11516c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 11520a920b5bSAndy Whitcroft return 0; 11530a920b5bSAndy Whitcroft } 11546c72ffaaSAndy Whitcroft } 11556c72ffaaSAndy Whitcroft return 1; 11566c72ffaaSAndy Whitcroft} 11570a920b5bSAndy Whitcroft 115820112475SJoe Perchessub parse_email { 115920112475SJoe Perches my ($formatted_email) = @_; 116020112475SJoe Perches 116120112475SJoe Perches my $name = ""; 1162dfa05c28SJoe Perches my $name_comment = ""; 116320112475SJoe Perches my $address = ""; 116420112475SJoe Perches my $comment = ""; 116520112475SJoe Perches 116620112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 116720112475SJoe Perches $name = $1; 116820112475SJoe Perches $address = $2; 116920112475SJoe Perches $comment = $3 if defined $3; 117020112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 117120112475SJoe Perches $address = $1; 117220112475SJoe Perches $comment = $2 if defined $2; 117320112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 117420112475SJoe Perches $address = $1; 117520112475SJoe Perches $comment = $2 if defined $2; 117685e12066SJoe Perches $formatted_email =~ s/\Q$address\E.*$//; 117720112475SJoe Perches $name = $formatted_email; 11783705ce5bSJoe Perches $name = trim($name); 117920112475SJoe Perches $name =~ s/^\"|\"$//g; 118020112475SJoe Perches # If there's a name left after stripping spaces and 118120112475SJoe Perches # leading quotes, and the address doesn't have both 118220112475SJoe Perches # leading and trailing angle brackets, the address 118320112475SJoe Perches # is invalid. ie: 118420112475SJoe Perches # "joe smith [email protected]" bad 118520112475SJoe Perches # "joe smith <[email protected]" bad 118620112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 118720112475SJoe Perches $name = ""; 118820112475SJoe Perches $address = ""; 118920112475SJoe Perches $comment = ""; 119020112475SJoe Perches } 119120112475SJoe Perches } 119220112475SJoe Perches 119348ca2d8aSDwaipayan Ray $comment = trim($comment); 11943705ce5bSJoe Perches $name = trim($name); 119520112475SJoe Perches $name =~ s/^\"|\"$//g; 119648ca2d8aSDwaipayan Ray if ($name =~ s/(\s*\([^\)]+\))\s*//) { 1197dfa05c28SJoe Perches $name_comment = trim($1); 1198dfa05c28SJoe Perches } 11993705ce5bSJoe Perches $address = trim($address); 120020112475SJoe Perches $address =~ s/^\<|\>$//g; 120120112475SJoe Perches 120220112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 120320112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 120420112475SJoe Perches $name = "\"$name\""; 120520112475SJoe Perches } 120620112475SJoe Perches 1207dfa05c28SJoe Perches return ($name, $name_comment, $address, $comment); 120820112475SJoe Perches} 120920112475SJoe Perches 121020112475SJoe Perchessub format_email { 121148ca2d8aSDwaipayan Ray my ($name, $name_comment, $address, $comment) = @_; 121220112475SJoe Perches 121320112475SJoe Perches my $formatted_email; 121420112475SJoe Perches 121548ca2d8aSDwaipayan Ray $name_comment = trim($name_comment); 121648ca2d8aSDwaipayan Ray $comment = trim($comment); 12173705ce5bSJoe Perches $name = trim($name); 121820112475SJoe Perches $name =~ s/^\"|\"$//g; 12193705ce5bSJoe Perches $address = trim($address); 122020112475SJoe Perches 122120112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 122220112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 122320112475SJoe Perches $name = "\"$name\""; 122420112475SJoe Perches } 122520112475SJoe Perches 122620112475SJoe Perches if ("$name" eq "") { 122720112475SJoe Perches $formatted_email = "$address"; 122820112475SJoe Perches } else { 122948ca2d8aSDwaipayan Ray $formatted_email = "$name$name_comment <$address>"; 123020112475SJoe Perches } 123148ca2d8aSDwaipayan Ray $formatted_email .= "$comment"; 123220112475SJoe Perches return $formatted_email; 123320112475SJoe Perches} 123420112475SJoe Perches 1235dfa05c28SJoe Perchessub reformat_email { 1236dfa05c28SJoe Perches my ($email) = @_; 1237dfa05c28SJoe Perches 1238dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 123948ca2d8aSDwaipayan Ray return format_email($email_name, $name_comment, $email_address, $comment); 1240dfa05c28SJoe Perches} 1241dfa05c28SJoe Perches 1242dfa05c28SJoe Perchessub same_email_addresses { 124348ca2d8aSDwaipayan Ray my ($email1, $email2, $match_comment) = @_; 1244dfa05c28SJoe Perches 1245dfa05c28SJoe Perches my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1); 1246dfa05c28SJoe Perches my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2); 1247dfa05c28SJoe Perches 124848ca2d8aSDwaipayan Ray if ($match_comment != 1) { 1249dfa05c28SJoe Perches return $email1_name eq $email2_name && 1250dfa05c28SJoe Perches $email1_address eq $email2_address; 1251dfa05c28SJoe Perches } 125248ca2d8aSDwaipayan Ray return $email1_name eq $email2_name && 125348ca2d8aSDwaipayan Ray $email1_address eq $email2_address && 125448ca2d8aSDwaipayan Ray $name1_comment eq $name2_comment && 125548ca2d8aSDwaipayan Ray $comment1 eq $comment2; 125648ca2d8aSDwaipayan Ray} 1257dfa05c28SJoe Perches 1258d311cd44SJoe Perchessub which { 1259d311cd44SJoe Perches my ($bin) = @_; 1260d311cd44SJoe Perches 1261d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1262d311cd44SJoe Perches if (-e "$path/$bin") { 1263d311cd44SJoe Perches return "$path/$bin"; 1264d311cd44SJoe Perches } 1265d311cd44SJoe Perches } 1266d311cd44SJoe Perches 1267d311cd44SJoe Perches return ""; 1268d311cd44SJoe Perches} 1269d311cd44SJoe Perches 1270000d1cc1SJoe Perchessub which_conf { 1271000d1cc1SJoe Perches my ($conf) = @_; 1272000d1cc1SJoe Perches 1273000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1274000d1cc1SJoe Perches if (-e "$path/$conf") { 1275000d1cc1SJoe Perches return "$path/$conf"; 1276000d1cc1SJoe Perches } 1277000d1cc1SJoe Perches } 1278000d1cc1SJoe Perches 1279000d1cc1SJoe Perches return ""; 1280000d1cc1SJoe Perches} 1281000d1cc1SJoe Perches 12820a920b5bSAndy Whitcroftsub expand_tabs { 12830a920b5bSAndy Whitcroft my ($str) = @_; 12840a920b5bSAndy Whitcroft 12850a920b5bSAndy Whitcroft my $res = ''; 12860a920b5bSAndy Whitcroft my $n = 0; 12870a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 12880a920b5bSAndy Whitcroft if ($c eq "\t") { 12890a920b5bSAndy Whitcroft $res .= ' '; 12900a920b5bSAndy Whitcroft $n++; 1291713a09deSAntonio Borneo for (; ($n % $tabsize) != 0; $n++) { 12920a920b5bSAndy Whitcroft $res .= ' '; 12930a920b5bSAndy Whitcroft } 12940a920b5bSAndy Whitcroft next; 12950a920b5bSAndy Whitcroft } 12960a920b5bSAndy Whitcroft $res .= $c; 12970a920b5bSAndy Whitcroft $n++; 12980a920b5bSAndy Whitcroft } 12990a920b5bSAndy Whitcroft 13000a920b5bSAndy Whitcroft return $res; 13010a920b5bSAndy Whitcroft} 13026c72ffaaSAndy Whitcroftsub copy_spacing { 1303773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 13046c72ffaaSAndy Whitcroft return $res; 13056c72ffaaSAndy Whitcroft} 13060a920b5bSAndy Whitcroft 13074a0df2efSAndy Whitcroftsub line_stats { 13084a0df2efSAndy Whitcroft my ($line) = @_; 13094a0df2efSAndy Whitcroft 13104a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 13114a0df2efSAndy Whitcroft $line =~ s/^.//; 13124a0df2efSAndy Whitcroft $line = expand_tabs($line); 13134a0df2efSAndy Whitcroft 13144a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 13154a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 13164a0df2efSAndy Whitcroft 13174a0df2efSAndy Whitcroft return (length($line), length($white)); 13184a0df2efSAndy Whitcroft} 13194a0df2efSAndy Whitcroft 1320773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1321773647a0SAndy Whitcroft 1322773647a0SAndy Whitcroftsub sanitise_line_reset { 1323773647a0SAndy Whitcroft my ($in_comment) = @_; 1324773647a0SAndy Whitcroft 1325773647a0SAndy Whitcroft if ($in_comment) { 1326773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1327773647a0SAndy Whitcroft } else { 1328773647a0SAndy Whitcroft $sanitise_quote = ''; 1329773647a0SAndy Whitcroft } 1330773647a0SAndy Whitcroft} 133100df344fSAndy Whitcroftsub sanitise_line { 133200df344fSAndy Whitcroft my ($line) = @_; 133300df344fSAndy Whitcroft 133400df344fSAndy Whitcroft my $res = ''; 133500df344fSAndy Whitcroft my $l = ''; 133600df344fSAndy Whitcroft 1337c2fdda0dSAndy Whitcroft my $qlen = 0; 1338773647a0SAndy Whitcroft my $off = 0; 1339773647a0SAndy Whitcroft my $c; 134000df344fSAndy Whitcroft 1341773647a0SAndy Whitcroft # Always copy over the diff marker. 1342773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1343773647a0SAndy Whitcroft 1344773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1345773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1346773647a0SAndy Whitcroft 13478d2e11b2SClaudio Fontana # Comments we are whacking completely including the begin 1348773647a0SAndy Whitcroft # and end, all to $;. 1349773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1350773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1351773647a0SAndy Whitcroft 1352773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1353773647a0SAndy Whitcroft $off++; 135400df344fSAndy Whitcroft next; 1355773647a0SAndy Whitcroft } 135681bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1357773647a0SAndy Whitcroft $sanitise_quote = ''; 1358773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1359773647a0SAndy Whitcroft $off++; 1360773647a0SAndy Whitcroft next; 1361773647a0SAndy Whitcroft } 1362113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1363113f04a8SDaniel Walker $sanitise_quote = '//'; 1364113f04a8SDaniel Walker 1365113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1366113f04a8SDaniel Walker $off++; 1367113f04a8SDaniel Walker next; 1368113f04a8SDaniel Walker } 1369773647a0SAndy Whitcroft 1370773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1371773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1372773647a0SAndy Whitcroft $c eq "\\") { 1373773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1374773647a0SAndy Whitcroft $off++; 1375773647a0SAndy Whitcroft next; 1376773647a0SAndy Whitcroft } 1377773647a0SAndy Whitcroft # Regular quotes. 1378773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1379773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1380773647a0SAndy Whitcroft $sanitise_quote = $c; 1381773647a0SAndy Whitcroft 1382773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1383773647a0SAndy Whitcroft next; 1384773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1385773647a0SAndy Whitcroft $sanitise_quote = ''; 138600df344fSAndy Whitcroft } 138700df344fSAndy Whitcroft } 1388773647a0SAndy Whitcroft 1389fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1390773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1391773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1392113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1393113f04a8SDaniel Walker substr($res, $off, 1, $;); 1394773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1395773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 139600df344fSAndy Whitcroft } else { 1397773647a0SAndy Whitcroft substr($res, $off, 1, $c); 139800df344fSAndy Whitcroft } 1399c2fdda0dSAndy Whitcroft } 1400c2fdda0dSAndy Whitcroft 1401113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1402113f04a8SDaniel Walker $sanitise_quote = ''; 1403113f04a8SDaniel Walker } 1404113f04a8SDaniel Walker 1405c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1406c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1407c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1408c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1409c2fdda0dSAndy Whitcroft 1410c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1411c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1412c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1413c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1414c2fdda0dSAndy Whitcroft } 1415c2fdda0dSAndy Whitcroft 1416dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1417dadf680dSJoe Perches my $match = $1; 1418dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1419dadf680dSJoe Perches } 1420dadf680dSJoe Perches 142100df344fSAndy Whitcroft return $res; 142200df344fSAndy Whitcroft} 142300df344fSAndy Whitcroft 1424a6962d72SJoe Perchessub get_quoted_string { 1425a6962d72SJoe Perches my ($line, $rawline) = @_; 1426a6962d72SJoe Perches 1427478b1799SJoe Perches return "" if (!defined($line) || !defined($rawline)); 142833acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1429a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1430a6962d72SJoe Perches} 1431a6962d72SJoe Perches 14328905a67cSAndy Whitcroftsub ctx_statement_block { 14338905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 14348905a67cSAndy Whitcroft my $line = $linenr - 1; 14358905a67cSAndy Whitcroft my $blk = ''; 14368905a67cSAndy Whitcroft my $soff = $off; 14378905a67cSAndy Whitcroft my $coff = $off - 1; 1438773647a0SAndy Whitcroft my $coff_set = 0; 14398905a67cSAndy Whitcroft 144013214adfSAndy Whitcroft my $loff = 0; 144113214adfSAndy Whitcroft 14428905a67cSAndy Whitcroft my $type = ''; 14438905a67cSAndy Whitcroft my $level = 0; 1444a2750645SAndy Whitcroft my @stack = (); 1445cf655043SAndy Whitcroft my $p; 14468905a67cSAndy Whitcroft my $c; 14478905a67cSAndy Whitcroft my $len = 0; 144813214adfSAndy Whitcroft 144913214adfSAndy Whitcroft my $remainder; 14508905a67cSAndy Whitcroft while (1) { 1451a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1452a2750645SAndy Whitcroft 1453773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 14548905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 14558905a67cSAndy Whitcroft # context. 14568905a67cSAndy Whitcroft if ($off >= $len) { 14578905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1458dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1459c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 14608905a67cSAndy Whitcroft $remain--; 146113214adfSAndy Whitcroft $loff = $len; 1462c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 14638905a67cSAndy Whitcroft $len = length($blk); 14648905a67cSAndy Whitcroft $line++; 14658905a67cSAndy Whitcroft last; 14668905a67cSAndy Whitcroft } 14678905a67cSAndy Whitcroft # Bail if there is no further context. 14688905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 146913214adfSAndy Whitcroft if ($off >= $len) { 14708905a67cSAndy Whitcroft last; 14718905a67cSAndy Whitcroft } 1472f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1473f74bd194SAndy Whitcroft $level++; 1474f74bd194SAndy Whitcroft $type = '#'; 1475f74bd194SAndy Whitcroft } 14768905a67cSAndy Whitcroft } 1477cf655043SAndy Whitcroft $p = $c; 14788905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 147913214adfSAndy Whitcroft $remainder = substr($blk, $off); 14808905a67cSAndy Whitcroft 1481773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 14824635f4fbSAndy Whitcroft 14834635f4fbSAndy Whitcroft # Handle nested #if/#else. 14844635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 14854635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 14864635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 14874635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 14884635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 14894635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 14904635f4fbSAndy Whitcroft } 14914635f4fbSAndy Whitcroft 14928905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 14938905a67cSAndy Whitcroft # outermost level. 14948905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 14958905a67cSAndy Whitcroft last; 14968905a67cSAndy Whitcroft } 14978905a67cSAndy Whitcroft 149813214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1499773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1500773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1501773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1502773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1503773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1504773647a0SAndy Whitcroft $coff_set = 1; 1505773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1506773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 150713214adfSAndy Whitcroft } 150813214adfSAndy Whitcroft 15098905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 15108905a67cSAndy Whitcroft $level++; 15118905a67cSAndy Whitcroft $type = '('; 15128905a67cSAndy Whitcroft } 15138905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 15148905a67cSAndy Whitcroft $level--; 15158905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 15168905a67cSAndy Whitcroft 15178905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 15188905a67cSAndy Whitcroft $coff = $off; 1519773647a0SAndy Whitcroft $coff_set = 1; 1520773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 15218905a67cSAndy Whitcroft } 15228905a67cSAndy Whitcroft } 15238905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 15248905a67cSAndy Whitcroft $level++; 15258905a67cSAndy Whitcroft $type = '{'; 15268905a67cSAndy Whitcroft } 15278905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 15288905a67cSAndy Whitcroft $level--; 15298905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 15308905a67cSAndy Whitcroft 15318905a67cSAndy Whitcroft if ($level == 0) { 1532b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1533b998e001SPatrick Pannuto $off++; 1534b998e001SPatrick Pannuto } 15358905a67cSAndy Whitcroft last; 15368905a67cSAndy Whitcroft } 15378905a67cSAndy Whitcroft } 1538f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1539f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1540f74bd194SAndy Whitcroft $level--; 1541f74bd194SAndy Whitcroft $type = ''; 1542f74bd194SAndy Whitcroft $off++; 1543f74bd194SAndy Whitcroft last; 1544f74bd194SAndy Whitcroft } 15458905a67cSAndy Whitcroft $off++; 15468905a67cSAndy Whitcroft } 1547a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 154813214adfSAndy Whitcroft if ($off == $len) { 1549a3bb97a7SAndy Whitcroft $loff = $len + 1; 155013214adfSAndy Whitcroft $line++; 155113214adfSAndy Whitcroft $remain--; 155213214adfSAndy Whitcroft } 15538905a67cSAndy Whitcroft 15548905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 15558905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 15568905a67cSAndy Whitcroft 15578905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 15588905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 15598905a67cSAndy Whitcroft 1560773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 156113214adfSAndy Whitcroft 156213214adfSAndy Whitcroft return ($statement, $condition, 156313214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 156413214adfSAndy Whitcroft} 156513214adfSAndy Whitcroft 1566cf655043SAndy Whitcroftsub statement_lines { 1567cf655043SAndy Whitcroft my ($stmt) = @_; 1568cf655043SAndy Whitcroft 1569cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1570cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1571cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1572cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1573cf655043SAndy Whitcroft 1574cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1575cf655043SAndy Whitcroft 1576cf655043SAndy Whitcroft return $#stmt_lines + 2; 1577cf655043SAndy Whitcroft} 1578cf655043SAndy Whitcroft 1579cf655043SAndy Whitcroftsub statement_rawlines { 1580cf655043SAndy Whitcroft my ($stmt) = @_; 1581cf655043SAndy Whitcroft 1582cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1583cf655043SAndy Whitcroft 1584cf655043SAndy Whitcroft return $#stmt_lines + 2; 1585cf655043SAndy Whitcroft} 1586cf655043SAndy Whitcroft 1587cf655043SAndy Whitcroftsub statement_block_size { 1588cf655043SAndy Whitcroft my ($stmt) = @_; 1589cf655043SAndy Whitcroft 1590cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1591cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1592cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1593cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1594cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1595cf655043SAndy Whitcroft 1596cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1597cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1598cf655043SAndy Whitcroft 1599cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1600cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1601cf655043SAndy Whitcroft 1602cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1603cf655043SAndy Whitcroft return $stmt_lines; 1604cf655043SAndy Whitcroft } else { 1605cf655043SAndy Whitcroft return $stmt_statements; 1606cf655043SAndy Whitcroft } 1607cf655043SAndy Whitcroft} 1608cf655043SAndy Whitcroft 160913214adfSAndy Whitcroftsub ctx_statement_full { 161013214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 161113214adfSAndy Whitcroft my ($statement, $condition, $level); 161213214adfSAndy Whitcroft 161313214adfSAndy Whitcroft my (@chunks); 161413214adfSAndy Whitcroft 1615cf655043SAndy Whitcroft # Grab the first conditional/block pair. 161613214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 161713214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1618773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 161913214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1620cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1621cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1622cf655043SAndy Whitcroft } 1623cf655043SAndy Whitcroft 1624cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1625cf655043SAndy Whitcroft # could continue the statement. 1626cf655043SAndy Whitcroft for (;;) { 162713214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 162813214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1629cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1630773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1631cf655043SAndy Whitcroft #print "C: push\n"; 1632cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 163313214adfSAndy Whitcroft } 163413214adfSAndy Whitcroft 163513214adfSAndy Whitcroft return ($level, $linenr, @chunks); 16368905a67cSAndy Whitcroft} 16378905a67cSAndy Whitcroft 16384a0df2efSAndy Whitcroftsub ctx_block_get { 1639f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 16404a0df2efSAndy Whitcroft my $line; 16414a0df2efSAndy Whitcroft my $start = $linenr - 1; 16424a0df2efSAndy Whitcroft my $blk = ''; 16434a0df2efSAndy Whitcroft my @o; 16444a0df2efSAndy Whitcroft my @c; 16454a0df2efSAndy Whitcroft my @res = (); 16464a0df2efSAndy Whitcroft 1647f0a594c1SAndy Whitcroft my $level = 0; 16484635f4fbSAndy Whitcroft my @stack = ($level); 164900df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 165000df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 165100df344fSAndy Whitcroft $remain--; 165200df344fSAndy Whitcroft 165300df344fSAndy Whitcroft $blk .= $rawlines[$line]; 16544635f4fbSAndy Whitcroft 16554635f4fbSAndy Whitcroft # Handle nested #if/#else. 165601464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 16574635f4fbSAndy Whitcroft push(@stack, $level); 165801464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 16594635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 166001464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 16614635f4fbSAndy Whitcroft $level = pop(@stack); 16624635f4fbSAndy Whitcroft } 16634635f4fbSAndy Whitcroft 166401464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1665f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1666f0a594c1SAndy Whitcroft if ($off > 0) { 1667f0a594c1SAndy Whitcroft $off--; 1668f0a594c1SAndy Whitcroft next; 1669f0a594c1SAndy Whitcroft } 16704a0df2efSAndy Whitcroft 1671f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1672f0a594c1SAndy Whitcroft $level--; 1673f0a594c1SAndy Whitcroft last if ($level == 0); 1674f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1675f0a594c1SAndy Whitcroft $level++; 1676f0a594c1SAndy Whitcroft } 1677f0a594c1SAndy Whitcroft } 16784a0df2efSAndy Whitcroft 1679f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 168000df344fSAndy Whitcroft push(@res, $rawlines[$line]); 16814a0df2efSAndy Whitcroft } 16824a0df2efSAndy Whitcroft 1683f0a594c1SAndy Whitcroft last if ($level == 0); 16844a0df2efSAndy Whitcroft } 16854a0df2efSAndy Whitcroft 1686f0a594c1SAndy Whitcroft return ($level, @res); 16874a0df2efSAndy Whitcroft} 16884a0df2efSAndy Whitcroftsub ctx_block_outer { 16894a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 16904a0df2efSAndy Whitcroft 1691f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1692f0a594c1SAndy Whitcroft return @r; 16934a0df2efSAndy Whitcroft} 16944a0df2efSAndy Whitcroftsub ctx_block { 16954a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 16964a0df2efSAndy Whitcroft 1697f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1698f0a594c1SAndy Whitcroft return @r; 1699653d4876SAndy Whitcroft} 1700653d4876SAndy Whitcroftsub ctx_statement { 1701f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1702f0a594c1SAndy Whitcroft 1703f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1704f0a594c1SAndy Whitcroft return @r; 1705f0a594c1SAndy Whitcroft} 1706f0a594c1SAndy Whitcroftsub ctx_block_level { 1707653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1708653d4876SAndy Whitcroft 1709f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 17104a0df2efSAndy Whitcroft} 17119c0ca6f9SAndy Whitcroftsub ctx_statement_level { 17129c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 17139c0ca6f9SAndy Whitcroft 17149c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 17159c0ca6f9SAndy Whitcroft} 17164a0df2efSAndy Whitcroft 17174a0df2efSAndy Whitcroftsub ctx_locate_comment { 17184a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 17194a0df2efSAndy Whitcroft 1720a55ee0ccSJoe Perches # If c99 comment on the current line, or the line before or after 1721a55ee0ccSJoe Perches my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@); 1722a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1723a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@); 1724a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1725a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@); 1726a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1727a55ee0ccSJoe Perches 17284a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1729a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 17304a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 17314a0df2efSAndy Whitcroft 17324a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 17334a0df2efSAndy Whitcroft # comment. 17344a0df2efSAndy Whitcroft my $in_comment = 0; 17354a0df2efSAndy Whitcroft $current_comment = ''; 17364a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 173700df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 173800df344fSAndy Whitcroft #warn " $line\n"; 17394a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 17404a0df2efSAndy Whitcroft $in_comment = 1; 17414a0df2efSAndy Whitcroft } 17424a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 17434a0df2efSAndy Whitcroft $in_comment = 1; 17444a0df2efSAndy Whitcroft } 17454a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 17464a0df2efSAndy Whitcroft $current_comment = ''; 17474a0df2efSAndy Whitcroft } 17484a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 17494a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 17504a0df2efSAndy Whitcroft $in_comment = 0; 17514a0df2efSAndy Whitcroft } 17524a0df2efSAndy Whitcroft } 17534a0df2efSAndy Whitcroft 17544a0df2efSAndy Whitcroft chomp($current_comment); 17554a0df2efSAndy Whitcroft return($current_comment); 17564a0df2efSAndy Whitcroft} 17574a0df2efSAndy Whitcroftsub ctx_has_comment { 17584a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 17594a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 17604a0df2efSAndy Whitcroft 176100df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 17624a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 17634a0df2efSAndy Whitcroft 17644a0df2efSAndy Whitcroft return ($cmt ne ''); 17654a0df2efSAndy Whitcroft} 17664a0df2efSAndy Whitcroft 17674d001e4dSAndy Whitcroftsub raw_line { 17684d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 17694d001e4dSAndy Whitcroft 17704d001e4dSAndy Whitcroft my $offset = $linenr - 1; 17714d001e4dSAndy Whitcroft $cnt++; 17724d001e4dSAndy Whitcroft 17734d001e4dSAndy Whitcroft my $line; 17744d001e4dSAndy Whitcroft while ($cnt) { 17754d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 17764d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 17774d001e4dSAndy Whitcroft $cnt--; 17784d001e4dSAndy Whitcroft } 17794d001e4dSAndy Whitcroft 17804d001e4dSAndy Whitcroft return $line; 17814d001e4dSAndy Whitcroft} 17824d001e4dSAndy Whitcroft 17832a9f9d85STobin C. Hardingsub get_stat_real { 17842a9f9d85STobin C. Harding my ($linenr, $lc) = @_; 17852a9f9d85STobin C. Harding 17862a9f9d85STobin C. Harding my $stat_real = raw_line($linenr, 0); 17872a9f9d85STobin C. Harding for (my $count = $linenr + 1; $count <= $lc; $count++) { 17882a9f9d85STobin C. Harding $stat_real = $stat_real . "\n" . raw_line($count, 0); 17892a9f9d85STobin C. Harding } 17902a9f9d85STobin C. Harding 17912a9f9d85STobin C. Harding return $stat_real; 17922a9f9d85STobin C. Harding} 17932a9f9d85STobin C. Harding 1794e3d95a2aSTobin C. Hardingsub get_stat_here { 1795e3d95a2aSTobin C. Harding my ($linenr, $cnt, $here) = @_; 1796e3d95a2aSTobin C. Harding 1797e3d95a2aSTobin C. Harding my $herectx = $here . "\n"; 1798e3d95a2aSTobin C. Harding for (my $n = 0; $n < $cnt; $n++) { 1799e3d95a2aSTobin C. Harding $herectx .= raw_line($linenr, $n) . "\n"; 1800e3d95a2aSTobin C. Harding } 1801e3d95a2aSTobin C. Harding 1802e3d95a2aSTobin C. Harding return $herectx; 1803e3d95a2aSTobin C. Harding} 1804e3d95a2aSTobin C. Harding 18050a920b5bSAndy Whitcroftsub cat_vet { 18060a920b5bSAndy Whitcroft my ($vet) = @_; 18079c0ca6f9SAndy Whitcroft my ($res, $coded); 18080a920b5bSAndy Whitcroft 18099c0ca6f9SAndy Whitcroft $res = ''; 18106c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 18116c72ffaaSAndy Whitcroft $res .= $1; 18126c72ffaaSAndy Whitcroft if ($2 ne '') { 18139c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 18146c72ffaaSAndy Whitcroft $res .= $coded; 18156c72ffaaSAndy Whitcroft } 18169c0ca6f9SAndy Whitcroft } 18179c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 18180a920b5bSAndy Whitcroft 18199c0ca6f9SAndy Whitcroft return $res; 18200a920b5bSAndy Whitcroft} 18210a920b5bSAndy Whitcroft 1822c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1823cf655043SAndy Whitcroftmy $av_pending; 1824c2fdda0dSAndy Whitcroftmy @av_paren_type; 18251f65f947SAndy Whitcroftmy $av_pend_colon; 1826c2fdda0dSAndy Whitcroft 1827c2fdda0dSAndy Whitcroftsub annotate_reset { 1828c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1829cf655043SAndy Whitcroft $av_pending = '_'; 1830cf655043SAndy Whitcroft @av_paren_type = ('E'); 18311f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1832c2fdda0dSAndy Whitcroft} 1833c2fdda0dSAndy Whitcroft 18346c72ffaaSAndy Whitcroftsub annotate_values { 18356c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 18366c72ffaaSAndy Whitcroft 18376c72ffaaSAndy Whitcroft my $res; 18381f65f947SAndy Whitcroft my $var = '_' x length($stream); 18396c72ffaaSAndy Whitcroft my $cur = $stream; 18406c72ffaaSAndy Whitcroft 1841c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 18426c72ffaaSAndy Whitcroft 18436c72ffaaSAndy Whitcroft while (length($cur)) { 1844773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1845cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1846171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 18476c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1848c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1849c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1850cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1851c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 18526c72ffaaSAndy Whitcroft } 18536c72ffaaSAndy Whitcroft 1854c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 18559446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 18569446ef56SAndy Whitcroft push(@av_paren_type, $type); 1857addcdceaSAndy Whitcroft $type = 'c'; 18589446ef56SAndy Whitcroft 1859e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1860c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 18616c72ffaaSAndy Whitcroft $type = 'T'; 18626c72ffaaSAndy Whitcroft 1863389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1864389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1865389a2fe5SAndy Whitcroft $type = 'T'; 1866389a2fe5SAndy Whitcroft 1867c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1868171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1869c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1870171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1871171ae1a4SAndy Whitcroft if ($2 ne '') { 1872cf655043SAndy Whitcroft $av_pending = 'N'; 1873171ae1a4SAndy Whitcroft } 1874171ae1a4SAndy Whitcroft $type = 'E'; 1875171ae1a4SAndy Whitcroft 1876c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1877171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1878171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1879171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 18806c72ffaaSAndy Whitcroft 1881c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1882cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1883c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1884cf655043SAndy Whitcroft 1885cf655043SAndy Whitcroft push(@av_paren_type, $type); 1886cf655043SAndy Whitcroft push(@av_paren_type, $type); 1887171ae1a4SAndy Whitcroft $type = 'E'; 1888cf655043SAndy Whitcroft 1889c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1890cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1891cf655043SAndy Whitcroft $av_preprocessor = 1; 1892cf655043SAndy Whitcroft 1893cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1894cf655043SAndy Whitcroft 1895171ae1a4SAndy Whitcroft $type = 'E'; 1896cf655043SAndy Whitcroft 1897c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1898cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1899cf655043SAndy Whitcroft 1900cf655043SAndy Whitcroft $av_preprocessor = 1; 1901cf655043SAndy Whitcroft 1902cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1903cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1904cf655043SAndy Whitcroft pop(@av_paren_type); 1905cf655043SAndy Whitcroft push(@av_paren_type, $type); 1906171ae1a4SAndy Whitcroft $type = 'E'; 19076c72ffaaSAndy Whitcroft 19086c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1909c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 19106c72ffaaSAndy Whitcroft 1911171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1912171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1913171ae1a4SAndy Whitcroft $av_pending = $type; 1914171ae1a4SAndy Whitcroft $type = 'N'; 1915171ae1a4SAndy Whitcroft 19166c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1917c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 19186c72ffaaSAndy Whitcroft if (defined $2) { 1919cf655043SAndy Whitcroft $av_pending = 'V'; 19206c72ffaaSAndy Whitcroft } 19216c72ffaaSAndy Whitcroft $type = 'N'; 19226c72ffaaSAndy Whitcroft 192314b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1924c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 192514b111c1SAndy Whitcroft $av_pending = 'E'; 19266c72ffaaSAndy Whitcroft $type = 'N'; 19276c72ffaaSAndy Whitcroft 19281f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 19291f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 19301f65f947SAndy Whitcroft $av_pend_colon = 'C'; 19311f65f947SAndy Whitcroft $type = 'N'; 19321f65f947SAndy Whitcroft 193314b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1934c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 19356c72ffaaSAndy Whitcroft $type = 'N'; 19366c72ffaaSAndy Whitcroft 19376c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1938c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1939cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1940cf655043SAndy Whitcroft $av_pending = '_'; 19416c72ffaaSAndy Whitcroft $type = 'N'; 19426c72ffaaSAndy Whitcroft 19436c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1944cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1945cf655043SAndy Whitcroft if ($new_type ne '_') { 1946cf655043SAndy Whitcroft $type = $new_type; 1947c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1948c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 19496c72ffaaSAndy Whitcroft } else { 1950c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 19516c72ffaaSAndy Whitcroft } 19526c72ffaaSAndy Whitcroft 1953c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1954c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1955c8cb2ca3SAndy Whitcroft $type = 'V'; 1956cf655043SAndy Whitcroft $av_pending = 'V'; 19576c72ffaaSAndy Whitcroft 19588e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 19598e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 19601f65f947SAndy Whitcroft $av_pend_colon = 'B'; 19618e761b04SAndy Whitcroft } elsif ($type eq 'E') { 19628e761b04SAndy Whitcroft $av_pend_colon = 'L'; 19631f65f947SAndy Whitcroft } 19641f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 19651f65f947SAndy Whitcroft $type = 'V'; 19661f65f947SAndy Whitcroft 19676c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1968c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 19696c72ffaaSAndy Whitcroft $type = 'V'; 19706c72ffaaSAndy Whitcroft 19716c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1972c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 19736c72ffaaSAndy Whitcroft $type = 'N'; 19746c72ffaaSAndy Whitcroft 1975cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1976c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 197713214adfSAndy Whitcroft $type = 'E'; 19781f65f947SAndy Whitcroft $av_pend_colon = 'O'; 197913214adfSAndy Whitcroft 19808e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 19818e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 19828e761b04SAndy Whitcroft $type = 'C'; 19838e761b04SAndy Whitcroft 19841f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 19851f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 19861f65f947SAndy Whitcroft $type = 'N'; 19871f65f947SAndy Whitcroft 19881f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 19891f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 19901f65f947SAndy Whitcroft 19911f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 19921f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 19931f65f947SAndy Whitcroft $type = 'E'; 19941f65f947SAndy Whitcroft } else { 19951f65f947SAndy Whitcroft $type = 'N'; 19961f65f947SAndy Whitcroft } 19971f65f947SAndy Whitcroft $av_pend_colon = 'O'; 19981f65f947SAndy Whitcroft 19998e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 200013214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 20016c72ffaaSAndy Whitcroft $type = 'N'; 20026c72ffaaSAndy Whitcroft 20030d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 200474048ed8SAndy Whitcroft my $variant; 200574048ed8SAndy Whitcroft 200674048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 200774048ed8SAndy Whitcroft if ($type eq 'V') { 200874048ed8SAndy Whitcroft $variant = 'B'; 200974048ed8SAndy Whitcroft } else { 201074048ed8SAndy Whitcroft $variant = 'U'; 201174048ed8SAndy Whitcroft } 201274048ed8SAndy Whitcroft 201374048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 201474048ed8SAndy Whitcroft $type = 'N'; 201574048ed8SAndy Whitcroft 20166c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 2017c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 20186c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 20196c72ffaaSAndy Whitcroft $type = 'N'; 20206c72ffaaSAndy Whitcroft } 20216c72ffaaSAndy Whitcroft 20226c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 2023c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 20246c72ffaaSAndy Whitcroft } 20256c72ffaaSAndy Whitcroft if (defined $1) { 20266c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 20276c72ffaaSAndy Whitcroft $res .= $type x length($1); 20286c72ffaaSAndy Whitcroft } 20296c72ffaaSAndy Whitcroft } 20306c72ffaaSAndy Whitcroft 20311f65f947SAndy Whitcroft return ($res, $var); 20326c72ffaaSAndy Whitcroft} 20336c72ffaaSAndy Whitcroft 20348905a67cSAndy Whitcroftsub possible { 203513214adfSAndy Whitcroft my ($possible, $line) = @_; 20369a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 20370776e594SAndy Whitcroft ^(?: 20380776e594SAndy Whitcroft $Modifier| 20390776e594SAndy Whitcroft $Storage| 20400776e594SAndy Whitcroft $Type| 20419a974fdbSAndy Whitcroft DEFINE_\S+ 20429a974fdbSAndy Whitcroft )$| 20439a974fdbSAndy Whitcroft ^(?: 20440776e594SAndy Whitcroft goto| 20450776e594SAndy Whitcroft return| 20460776e594SAndy Whitcroft case| 20470776e594SAndy Whitcroft else| 20480776e594SAndy Whitcroft asm|__asm__| 204989a88353SAndy Whitcroft do| 205089a88353SAndy Whitcroft \#| 205189a88353SAndy Whitcroft \#\#| 20529a974fdbSAndy Whitcroft )(?:\s|$)| 20530776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 20549a974fdbSAndy Whitcroft )}x; 20559a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 20569a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 2057c45dcabdSAndy Whitcroft # Check for modifiers. 2058c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 2059c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 2060c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 2061c45dcabdSAndy Whitcroft 2062c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 2063c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 2064d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 20659a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 2066d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 2067485ff23eSAlex Dowad push(@modifierListFile, $modifier); 2068d2506586SAndy Whitcroft } 20699a974fdbSAndy Whitcroft } 2070c45dcabdSAndy Whitcroft 2071c45dcabdSAndy Whitcroft } else { 207213214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 2073485ff23eSAlex Dowad push(@typeListFile, $possible); 2074c45dcabdSAndy Whitcroft } 20758905a67cSAndy Whitcroft build_types(); 20760776e594SAndy Whitcroft } else { 20770776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 20788905a67cSAndy Whitcroft } 20798905a67cSAndy Whitcroft} 20808905a67cSAndy Whitcroft 20816c72ffaaSAndy Whitcroftmy $prefix = ''; 20826c72ffaaSAndy Whitcroft 2083000d1cc1SJoe Perchessub show_type { 2084cbec18afSJoe Perches my ($type) = @_; 208591bfe484SJoe Perches 2086522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 2087522b837cSAlexey Dobriyan 2088cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 2089cbec18afSJoe Perches 2090cbec18afSJoe Perches return !defined $ignore_type{$type}; 2091000d1cc1SJoe Perches} 2092000d1cc1SJoe Perches 2093f0a594c1SAndy Whitcroftsub report { 2094cbec18afSJoe Perches my ($level, $type, $msg) = @_; 2095cbec18afSJoe Perches 2096cbec18afSJoe Perches if (!show_type($type) || 2097cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 2098773647a0SAndy Whitcroft return 0; 2099773647a0SAndy Whitcroft } 210057230297SJoe Perches my $output = ''; 2101737c0767SJohn Brooks if ($color) { 210257230297SJoe Perches if ($level eq 'ERROR') { 210357230297SJoe Perches $output .= RED; 210457230297SJoe Perches } elsif ($level eq 'WARNING') { 210557230297SJoe Perches $output .= YELLOW; 2106000d1cc1SJoe Perches } else { 210757230297SJoe Perches $output .= GREEN; 2108000d1cc1SJoe Perches } 210957230297SJoe Perches } 211057230297SJoe Perches $output .= $prefix . $level . ':'; 211157230297SJoe Perches if ($show_types) { 2112737c0767SJohn Brooks $output .= BLUE if ($color); 211357230297SJoe Perches $output .= "$type:"; 211457230297SJoe Perches } 2115737c0767SJohn Brooks $output .= RESET if ($color); 211657230297SJoe Perches $output .= ' ' . $msg . "\n"; 211734d8815fSJoe Perches 211834d8815fSJoe Perches if ($showfile) { 211934d8815fSJoe Perches my @lines = split("\n", $output, -1); 212034d8815fSJoe Perches splice(@lines, 1, 1); 212134d8815fSJoe Perches $output = join("\n", @lines); 212234d8815fSJoe Perches } 212357230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 21248905a67cSAndy Whitcroft 212557230297SJoe Perches push(our @report, $output); 2126773647a0SAndy Whitcroft 2127773647a0SAndy Whitcroft return 1; 2128f0a594c1SAndy Whitcroft} 2129cbec18afSJoe Perches 2130f0a594c1SAndy Whitcroftsub report_dump { 213113214adfSAndy Whitcroft our @report; 2132f0a594c1SAndy Whitcroft} 2133000d1cc1SJoe Perches 2134d752fcc8SJoe Perchessub fixup_current_range { 2135d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 2136d752fcc8SJoe Perches 2137d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 2138d752fcc8SJoe Perches my $o = $1; 2139d752fcc8SJoe Perches my $l = $2; 2140d752fcc8SJoe Perches my $no = $o + $offset; 2141d752fcc8SJoe Perches my $nl = $l + $length; 2142d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 2143d752fcc8SJoe Perches } 2144d752fcc8SJoe Perches} 2145d752fcc8SJoe Perches 2146d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 2147d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 2148d752fcc8SJoe Perches 2149d752fcc8SJoe Perches my $range_last_linenr = 0; 2150d752fcc8SJoe Perches my $delta_offset = 0; 2151d752fcc8SJoe Perches 2152d752fcc8SJoe Perches my $old_linenr = 0; 2153d752fcc8SJoe Perches my $new_linenr = 0; 2154d752fcc8SJoe Perches 2155d752fcc8SJoe Perches my $next_insert = 0; 2156d752fcc8SJoe Perches my $next_delete = 0; 2157d752fcc8SJoe Perches 2158d752fcc8SJoe Perches my @lines = (); 2159d752fcc8SJoe Perches 2160d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 2161d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 2162d752fcc8SJoe Perches 2163d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 2164d752fcc8SJoe Perches my $save_line = 1; 2165d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 2166323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2167d752fcc8SJoe Perches $delta_offset = 0; 2168d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2169d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 2170d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 2171d752fcc8SJoe Perches } 2172d752fcc8SJoe Perches 2173d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2174d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 2175d752fcc8SJoe Perches $save_line = 0; 2176d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2177d752fcc8SJoe Perches } 2178d752fcc8SJoe Perches 2179d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2180d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 2181d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 2182d752fcc8SJoe Perches $new_linenr++; 2183d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2184d752fcc8SJoe Perches } 2185d752fcc8SJoe Perches 2186d752fcc8SJoe Perches if ($save_line) { 2187d752fcc8SJoe Perches push(@lines, $line); 2188d752fcc8SJoe Perches $new_linenr++; 2189d752fcc8SJoe Perches } 2190d752fcc8SJoe Perches 2191d752fcc8SJoe Perches $old_linenr++; 2192d752fcc8SJoe Perches } 2193d752fcc8SJoe Perches 2194d752fcc8SJoe Perches return @lines; 2195d752fcc8SJoe Perches} 2196d752fcc8SJoe Perches 2197f2d7e4d4SJoe Perchessub fix_insert_line { 2198f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2199f2d7e4d4SJoe Perches 2200f2d7e4d4SJoe Perches my $inserted = { 2201f2d7e4d4SJoe Perches LINENR => $linenr, 2202f2d7e4d4SJoe Perches LINE => $line, 2203f2d7e4d4SJoe Perches }; 2204f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2205f2d7e4d4SJoe Perches} 2206f2d7e4d4SJoe Perches 2207f2d7e4d4SJoe Perchessub fix_delete_line { 2208f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2209f2d7e4d4SJoe Perches 2210f2d7e4d4SJoe Perches my $deleted = { 2211f2d7e4d4SJoe Perches LINENR => $linenr, 2212f2d7e4d4SJoe Perches LINE => $line, 2213f2d7e4d4SJoe Perches }; 2214f2d7e4d4SJoe Perches 2215f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2216f2d7e4d4SJoe Perches} 2217f2d7e4d4SJoe Perches 2218de7d4f0eSAndy Whitcroftsub ERROR { 2219cbec18afSJoe Perches my ($type, $msg) = @_; 2220cbec18afSJoe Perches 2221cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2222de7d4f0eSAndy Whitcroft our $clean = 0; 22236c72ffaaSAndy Whitcroft our $cnt_error++; 22243705ce5bSJoe Perches return 1; 2225de7d4f0eSAndy Whitcroft } 22263705ce5bSJoe Perches return 0; 2227773647a0SAndy Whitcroft} 2228de7d4f0eSAndy Whitcroftsub WARN { 2229cbec18afSJoe Perches my ($type, $msg) = @_; 2230cbec18afSJoe Perches 2231cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2232de7d4f0eSAndy Whitcroft our $clean = 0; 22336c72ffaaSAndy Whitcroft our $cnt_warn++; 22343705ce5bSJoe Perches return 1; 2235de7d4f0eSAndy Whitcroft } 22363705ce5bSJoe Perches return 0; 2237773647a0SAndy Whitcroft} 2238de7d4f0eSAndy Whitcroftsub CHK { 2239cbec18afSJoe Perches my ($type, $msg) = @_; 2240cbec18afSJoe Perches 2241cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2242de7d4f0eSAndy Whitcroft our $clean = 0; 22436c72ffaaSAndy Whitcroft our $cnt_chk++; 22443705ce5bSJoe Perches return 1; 22456c72ffaaSAndy Whitcroft } 22463705ce5bSJoe Perches return 0; 2247de7d4f0eSAndy Whitcroft} 2248de7d4f0eSAndy Whitcroft 22496ecd9674SAndy Whitcroftsub check_absolute_file { 22506ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 22516ecd9674SAndy Whitcroft my $file = $absolute; 22526ecd9674SAndy Whitcroft 22536ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 22546ecd9674SAndy Whitcroft 22556ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 22566ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 22576ecd9674SAndy Whitcroft if (-f "$root/$file") { 22586ecd9674SAndy Whitcroft ##print "file<$file>\n"; 22596ecd9674SAndy Whitcroft last; 22606ecd9674SAndy Whitcroft } 22616ecd9674SAndy Whitcroft } 22626ecd9674SAndy Whitcroft if (! -f _) { 22636ecd9674SAndy Whitcroft return 0; 22646ecd9674SAndy Whitcroft } 22656ecd9674SAndy Whitcroft 22666ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 22676ecd9674SAndy Whitcroft my $prefix = $absolute; 22686ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 22696ecd9674SAndy Whitcroft 22706ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 22716ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2272000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2273000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 22746ecd9674SAndy Whitcroft } 22756ecd9674SAndy Whitcroft} 22766ecd9674SAndy Whitcroft 22773705ce5bSJoe Perchessub trim { 22783705ce5bSJoe Perches my ($string) = @_; 22793705ce5bSJoe Perches 2280b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2281b34c648bSJoe Perches 2282b34c648bSJoe Perches return $string; 2283b34c648bSJoe Perches} 2284b34c648bSJoe Perches 2285b34c648bSJoe Perchessub ltrim { 2286b34c648bSJoe Perches my ($string) = @_; 2287b34c648bSJoe Perches 2288b34c648bSJoe Perches $string =~ s/^\s+//; 2289b34c648bSJoe Perches 2290b34c648bSJoe Perches return $string; 2291b34c648bSJoe Perches} 2292b34c648bSJoe Perches 2293b34c648bSJoe Perchessub rtrim { 2294b34c648bSJoe Perches my ($string) = @_; 2295b34c648bSJoe Perches 2296b34c648bSJoe Perches $string =~ s/\s+$//; 22973705ce5bSJoe Perches 22983705ce5bSJoe Perches return $string; 22993705ce5bSJoe Perches} 23003705ce5bSJoe Perches 230152ea8506SJoe Perchessub string_find_replace { 230252ea8506SJoe Perches my ($string, $find, $replace) = @_; 230352ea8506SJoe Perches 230452ea8506SJoe Perches $string =~ s/$find/$replace/g; 230552ea8506SJoe Perches 230652ea8506SJoe Perches return $string; 230752ea8506SJoe Perches} 230852ea8506SJoe Perches 23093705ce5bSJoe Perchessub tabify { 23103705ce5bSJoe Perches my ($leading) = @_; 23113705ce5bSJoe Perches 2312713a09deSAntonio Borneo my $source_indent = $tabsize; 23133705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 23143705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 23153705ce5bSJoe Perches 23163705ce5bSJoe Perches #convert leading spaces to tabs 23173705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 23183705ce5bSJoe Perches #Remove spaces before a tab 23193705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 23203705ce5bSJoe Perches 23213705ce5bSJoe Perches return "$leading"; 23223705ce5bSJoe Perches} 23233705ce5bSJoe Perches 2324d1fe9c09SJoe Perchessub pos_last_openparen { 2325d1fe9c09SJoe Perches my ($line) = @_; 2326d1fe9c09SJoe Perches 2327d1fe9c09SJoe Perches my $pos = 0; 2328d1fe9c09SJoe Perches 2329d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2330d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2331d1fe9c09SJoe Perches 2332d1fe9c09SJoe Perches my $last_openparen = 0; 2333d1fe9c09SJoe Perches 2334d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2335d1fe9c09SJoe Perches return -1; 2336d1fe9c09SJoe Perches } 2337d1fe9c09SJoe Perches 2338d1fe9c09SJoe Perches my $len = length($line); 2339d1fe9c09SJoe Perches 2340d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2341d1fe9c09SJoe Perches my $string = substr($line, $pos); 2342d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2343d1fe9c09SJoe Perches $pos += length($1) - 1; 2344d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2345d1fe9c09SJoe Perches $last_openparen = $pos; 2346d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2347d1fe9c09SJoe Perches last; 2348d1fe9c09SJoe Perches } 2349d1fe9c09SJoe Perches } 2350d1fe9c09SJoe Perches 235191cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2352d1fe9c09SJoe Perches} 2353d1fe9c09SJoe Perches 2354f36d3eb8SJoe Perchessub get_raw_comment { 2355f36d3eb8SJoe Perches my ($line, $rawline) = @_; 2356f36d3eb8SJoe Perches my $comment = ''; 2357f36d3eb8SJoe Perches 2358f36d3eb8SJoe Perches for my $i (0 .. (length($line) - 1)) { 2359f36d3eb8SJoe Perches if (substr($line, $i, 1) eq "$;") { 2360f36d3eb8SJoe Perches $comment .= substr($rawline, $i, 1); 2361f36d3eb8SJoe Perches } 2362f36d3eb8SJoe Perches } 2363f36d3eb8SJoe Perches 2364f36d3eb8SJoe Perches return $comment; 2365f36d3eb8SJoe Perches} 2366f36d3eb8SJoe Perches 23670a920b5bSAndy Whitcroftsub process { 23680a920b5bSAndy Whitcroft my $filename = shift; 23690a920b5bSAndy Whitcroft 23700a920b5bSAndy Whitcroft my $linenr=0; 23710a920b5bSAndy Whitcroft my $prevline=""; 2372c2fdda0dSAndy Whitcroft my $prevrawline=""; 23730a920b5bSAndy Whitcroft my $stashline=""; 2374c2fdda0dSAndy Whitcroft my $stashrawline=""; 23750a920b5bSAndy Whitcroft 23764a0df2efSAndy Whitcroft my $length; 23770a920b5bSAndy Whitcroft my $indent; 23780a920b5bSAndy Whitcroft my $previndent=0; 23790a920b5bSAndy Whitcroft my $stashindent=0; 23800a920b5bSAndy Whitcroft 2381de7d4f0eSAndy Whitcroft our $clean = 1; 23820a920b5bSAndy Whitcroft my $signoff = 0; 2383cd261496SGeert Uytterhoeven my $author = ''; 2384cd261496SGeert Uytterhoeven my $authorsignoff = 0; 238548ca2d8aSDwaipayan Ray my $author_sob = ''; 23860a920b5bSAndy Whitcroft my $is_patch = 0; 2387133712a2SRob Herring my $is_binding_patch = -1; 238829ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 238915662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 239044d303ebSJoe Perches my $has_patch_separator = 0; #Found a --- line 2391ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2392490b292cSJoe Perches my $commit_log_lines = 0; #Number of commit log lines 2393bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 23942a076f40SJoe Perches my $commit_log_long_line = 0; 2395e518e9a5SJoe Perches my $commit_log_has_diff = 0; 239613f1937eSJoe Perches my $reported_maintainer_file = 0; 2397fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2398fa64205dSPasi Savanainen 2399365dd4eaSJoe Perches my $last_blank_line = 0; 24005e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2401365dd4eaSJoe Perches 240213214adfSAndy Whitcroft our @report = (); 24036c72ffaaSAndy Whitcroft our $cnt_lines = 0; 24046c72ffaaSAndy Whitcroft our $cnt_error = 0; 24056c72ffaaSAndy Whitcroft our $cnt_warn = 0; 24066c72ffaaSAndy Whitcroft our $cnt_chk = 0; 24076c72ffaaSAndy Whitcroft 24080a920b5bSAndy Whitcroft # Trace the real file/line as we go. 24090a920b5bSAndy Whitcroft my $realfile = ''; 24100a920b5bSAndy Whitcroft my $realline = 0; 24110a920b5bSAndy Whitcroft my $realcnt = 0; 24120a920b5bSAndy Whitcroft my $here = ''; 241377cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 24140a920b5bSAndy Whitcroft my $in_comment = 0; 2415c2fdda0dSAndy Whitcroft my $comment_edge = 0; 24160a920b5bSAndy Whitcroft my $first_line = 0; 24171e855726SWolfram Sang my $p1_prefix = ''; 24180a920b5bSAndy Whitcroft 241913214adfSAndy Whitcroft my $prev_values = 'E'; 242013214adfSAndy Whitcroft 242113214adfSAndy Whitcroft # suppression flags 2422773647a0SAndy Whitcroft my %suppress_ifbraces; 2423170d3a22SAndy Whitcroft my %suppress_whiletrailers; 24242b474a1aSAndy Whitcroft my %suppress_export; 24253e469cdcSAndy Whitcroft my $suppress_statement = 0; 2426653d4876SAndy Whitcroft 24277e51f197SJoe Perches my %signatures = (); 2428323c1260SJoe Perches 2429c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2430de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2431c2fdda0dSAndy Whitcroft # 2432de7d4f0eSAndy Whitcroft my @setup_docs = (); 2433de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2434773647a0SAndy Whitcroft 2435d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2436d8b07710SJoe Perches 24379f3a8992SRob Herring my $checklicenseline = 1; 24389f3a8992SRob Herring 2439773647a0SAndy Whitcroft sanitise_line_reset(); 2440c2fdda0dSAndy Whitcroft my $line; 2441c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2442773647a0SAndy Whitcroft $linenr++; 2443773647a0SAndy Whitcroft $line = $rawline; 2444c2fdda0dSAndy Whitcroft 24453705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 24463705ce5bSJoe Perches 2447773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2448de7d4f0eSAndy Whitcroft $setup_docs = 0; 24492581ac7cSTim Froidcoeur if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) { 2450de7d4f0eSAndy Whitcroft $setup_docs = 1; 2451de7d4f0eSAndy Whitcroft } 2452773647a0SAndy Whitcroft #next; 2453de7d4f0eSAndy Whitcroft } 245474fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2455773647a0SAndy Whitcroft $realline=$1-1; 2456773647a0SAndy Whitcroft if (defined $2) { 2457773647a0SAndy Whitcroft $realcnt=$3+1; 2458773647a0SAndy Whitcroft } else { 2459773647a0SAndy Whitcroft $realcnt=1+1; 2460773647a0SAndy Whitcroft } 2461c45dcabdSAndy Whitcroft $in_comment = 0; 2462773647a0SAndy Whitcroft 2463773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2464773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2465773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2466773647a0SAndy Whitcroft # at context start. 2467773647a0SAndy Whitcroft my $edge; 246801fa9147SAndy Whitcroft my $cnt = $realcnt; 246901fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 247001fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 247101fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 247201fa9147SAndy Whitcroft $cnt--; 247301fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2474721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2475fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2476fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2477fae17daeSAndy Whitcroft ($edge) = $1; 2478fae17daeSAndy Whitcroft last; 2479fae17daeSAndy Whitcroft } 2480773647a0SAndy Whitcroft } 2481773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2482773647a0SAndy Whitcroft $in_comment = 1; 2483773647a0SAndy Whitcroft } 2484773647a0SAndy Whitcroft 2485773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2486773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2487773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2488773647a0SAndy Whitcroft if (!defined $edge && 248983242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2490773647a0SAndy Whitcroft { 2491773647a0SAndy Whitcroft $in_comment = 1; 2492773647a0SAndy Whitcroft } 2493773647a0SAndy Whitcroft 2494773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2495773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2496773647a0SAndy Whitcroft 2497171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2498773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2499171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2500773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2501773647a0SAndy Whitcroft } 2502773647a0SAndy Whitcroft push(@lines, $line); 2503773647a0SAndy Whitcroft 2504773647a0SAndy Whitcroft if ($realcnt > 1) { 2505773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2506773647a0SAndy Whitcroft } else { 2507773647a0SAndy Whitcroft $realcnt = 0; 2508773647a0SAndy Whitcroft } 2509773647a0SAndy Whitcroft 2510773647a0SAndy Whitcroft #print "==>$rawline\n"; 2511773647a0SAndy Whitcroft #print "-->$line\n"; 2512de7d4f0eSAndy Whitcroft 2513de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2514de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2515de7d4f0eSAndy Whitcroft } 2516de7d4f0eSAndy Whitcroft } 2517de7d4f0eSAndy Whitcroft 25186c72ffaaSAndy Whitcroft $prefix = ''; 25196c72ffaaSAndy Whitcroft 2520773647a0SAndy Whitcroft $realcnt = 0; 2521773647a0SAndy Whitcroft $linenr = 0; 2522194f66fcSJoe Perches $fixlinenr = -1; 25230a920b5bSAndy Whitcroft foreach my $line (@lines) { 25240a920b5bSAndy Whitcroft $linenr++; 2525194f66fcSJoe Perches $fixlinenr++; 25261b5539b1SJoe Perches my $sline = $line; #copy of $line 25271b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 25280a920b5bSAndy Whitcroft 2529c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 2530f36d3eb8SJoe Perches my $raw_comment = get_raw_comment($line, $rawline); 25316c72ffaaSAndy Whitcroft 253212c253abSJoe Perches# check if it's a mode change, rename or start of a patch 253312c253abSJoe Perches if (!$in_commit_log && 253412c253abSJoe Perches ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 253512c253abSJoe Perches ($line =~ /^rename (?:from|to) \S+\s*$/ || 253612c253abSJoe Perches $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 253712c253abSJoe Perches $is_patch = 1; 253812c253abSJoe Perches } 253912c253abSJoe Perches 25400a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2541e518e9a5SJoe Perches if (!$in_commit_log && 254274fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 254374fd4f34SJoe Perches my $context = $4; 25440a920b5bSAndy Whitcroft $is_patch = 1; 25454a0df2efSAndy Whitcroft $first_line = $linenr + 1; 25460a920b5bSAndy Whitcroft $realline=$1-1; 25470a920b5bSAndy Whitcroft if (defined $2) { 25480a920b5bSAndy Whitcroft $realcnt=$3+1; 25490a920b5bSAndy Whitcroft } else { 25500a920b5bSAndy Whitcroft $realcnt=1+1; 25510a920b5bSAndy Whitcroft } 2552c2fdda0dSAndy Whitcroft annotate_reset(); 255313214adfSAndy Whitcroft $prev_values = 'E'; 255413214adfSAndy Whitcroft 2555773647a0SAndy Whitcroft %suppress_ifbraces = (); 2556170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 25572b474a1aSAndy Whitcroft %suppress_export = (); 25583e469cdcSAndy Whitcroft $suppress_statement = 0; 255974fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 256074fd4f34SJoe Perches $context_function = $1; 256174fd4f34SJoe Perches } else { 256274fd4f34SJoe Perches undef $context_function; 256374fd4f34SJoe Perches } 25640a920b5bSAndy Whitcroft next; 25650a920b5bSAndy Whitcroft 25664a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 25674a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 25684a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2569773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 25700a920b5bSAndy Whitcroft $realline++; 2571d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 25720a920b5bSAndy Whitcroft 25734a0df2efSAndy Whitcroft # Measure the line length and indent. 2574c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 25750a920b5bSAndy Whitcroft 25760a920b5bSAndy Whitcroft # Track the previous line. 25770a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 25780a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2579c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2580c2fdda0dSAndy Whitcroft 2581773647a0SAndy Whitcroft #warn "line<$line>\n"; 25826c72ffaaSAndy Whitcroft 2583d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2584d8aaf121SAndy Whitcroft $realcnt--; 25850a920b5bSAndy Whitcroft } 25860a920b5bSAndy Whitcroft 2587cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2588cc77cdcaSAndy Whitcroft 25896c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 25906c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2591773647a0SAndy Whitcroft 25922ac73b4fSJoe Perches my $found_file = 0; 2593773647a0SAndy Whitcroft # extract the filename as it passes 25943bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 25953bf9a009SRabin Vincent $realfile = $1; 25962b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2597270c49a0SJoe Perches $in_commit_log = 0; 25982ac73b4fSJoe Perches $found_file = 1; 25993bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2600773647a0SAndy Whitcroft $realfile = $1; 26012b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2602270c49a0SJoe Perches $in_commit_log = 0; 26031e855726SWolfram Sang 26041e855726SWolfram Sang $p1_prefix = $1; 2605e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2606e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2607000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2608000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 26091e855726SWolfram Sang } 2610773647a0SAndy Whitcroft 2611c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2612000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2613000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2614773647a0SAndy Whitcroft } 26152ac73b4fSJoe Perches $found_file = 1; 26162ac73b4fSJoe Perches } 26172ac73b4fSJoe Perches 261834d8815fSJoe Perches#make up the handle for any error we report on this line 261934d8815fSJoe Perches if ($showfile) { 262034d8815fSJoe Perches $prefix = "$realfile:$realline: " 262134d8815fSJoe Perches } elsif ($emacs) { 26227d3a9f67SJoe Perches if ($file) { 26237d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 26247d3a9f67SJoe Perches } else { 262534d8815fSJoe Perches $prefix = "$filename:$linenr: "; 262634d8815fSJoe Perches } 26277d3a9f67SJoe Perches } 262834d8815fSJoe Perches 26292ac73b4fSJoe Perches if ($found_file) { 263085b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 263185b0ee18SJoe Perches WARN("OBSOLETE", 263285b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 263385b0ee18SJoe Perches } 26347bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 26352ac73b4fSJoe Perches $check = 1; 26362ac73b4fSJoe Perches } else { 26372ac73b4fSJoe Perches $check = $check_orig; 26382ac73b4fSJoe Perches } 26399f3a8992SRob Herring $checklicenseline = 1; 2640133712a2SRob Herring 2641133712a2SRob Herring if ($realfile !~ /^MAINTAINERS/) { 2642133712a2SRob Herring my $last_binding_patch = $is_binding_patch; 2643133712a2SRob Herring 2644133712a2SRob Herring $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@; 2645133712a2SRob Herring 2646133712a2SRob Herring if (($last_binding_patch != -1) && 2647133712a2SRob Herring ($last_binding_patch ^ $is_binding_patch)) { 2648133712a2SRob Herring WARN("DT_SPLIT_BINDING_PATCH", 2649858e6845SMauro Carvalho Chehab "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n"); 2650133712a2SRob Herring } 2651133712a2SRob Herring } 2652133712a2SRob Herring 2653773647a0SAndy Whitcroft next; 2654773647a0SAndy Whitcroft } 2655773647a0SAndy Whitcroft 2656389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 26570a920b5bSAndy Whitcroft 2658c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2659c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2660c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 26610a920b5bSAndy Whitcroft 26626c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 26636c72ffaaSAndy Whitcroft 2664490b292cSJoe Perches# Verify the existence of a commit log if appropriate 2665490b292cSJoe Perches# 2 is used because a $signature is counted in $commit_log_lines 2666490b292cSJoe Perches if ($in_commit_log) { 2667490b292cSJoe Perches if ($line !~ /^\s*$/) { 2668490b292cSJoe Perches $commit_log_lines++; #could be a $signature 2669490b292cSJoe Perches } 2670490b292cSJoe Perches } elsif ($has_commit_log && $commit_log_lines < 2) { 2671490b292cSJoe Perches WARN("COMMIT_MESSAGE", 2672490b292cSJoe Perches "Missing commit description - Add an appropriate one\n"); 2673490b292cSJoe Perches $commit_log_lines = 2; #warn only once 2674490b292cSJoe Perches } 2675490b292cSJoe Perches 2676e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2677e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 267813e45417SMrinal Pandey (($line =~ m@^\s+diff\b.*a/([\w/]+)@ && 267913e45417SMrinal Pandey $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) || 2680e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2681e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2682e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2683e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2684e518e9a5SJoe Perches $commit_log_has_diff = 1; 2685e518e9a5SJoe Perches } 2686e518e9a5SJoe Perches 26873bf9a009SRabin Vincent# Check for incorrect file permissions 26883bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 26893bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 269004db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 269104db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2692000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2693000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 26943bf9a009SRabin Vincent } 26953bf9a009SRabin Vincent } 26963bf9a009SRabin Vincent 2697cd261496SGeert Uytterhoeven# Check the patch for a From: 2698cd261496SGeert Uytterhoeven if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { 2699cd261496SGeert Uytterhoeven $author = $1; 2700e7f929f3SDwaipayan Ray my $curline = $linenr; 2701e7f929f3SDwaipayan Ray while(defined($rawlines[$curline]) && ($rawlines[$curline++] =~ /^[ \t]\s*(.*)/)) { 2702e7f929f3SDwaipayan Ray $author .= $1; 2703e7f929f3SDwaipayan Ray } 2704cd261496SGeert Uytterhoeven $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); 2705cd261496SGeert Uytterhoeven $author =~ s/"//g; 2706dfa05c28SJoe Perches $author = reformat_email($author); 2707cd261496SGeert Uytterhoeven } 2708cd261496SGeert Uytterhoeven 270920112475SJoe Perches# Check the patch for a signoff: 2710dfa05c28SJoe Perches if ($line =~ /^\s*signed-off-by:\s*(.*)/i) { 27114a0df2efSAndy Whitcroft $signoff++; 271215662b3eSJoe Perches $in_commit_log = 0; 271348ca2d8aSDwaipayan Ray if ($author ne '' && $authorsignoff != 1) { 271448ca2d8aSDwaipayan Ray if (same_email_addresses($1, $author, 1)) { 2715cd261496SGeert Uytterhoeven $authorsignoff = 1; 271648ca2d8aSDwaipayan Ray } else { 271748ca2d8aSDwaipayan Ray my $ctx = $1; 271848ca2d8aSDwaipayan Ray my ($email_name, $email_comment, $email_address, $comment1) = parse_email($ctx); 271948ca2d8aSDwaipayan Ray my ($author_name, $author_comment, $author_address, $comment2) = parse_email($author); 272048ca2d8aSDwaipayan Ray 272148ca2d8aSDwaipayan Ray if ($email_address eq $author_address && $email_name eq $author_name) { 272248ca2d8aSDwaipayan Ray $author_sob = $ctx; 272348ca2d8aSDwaipayan Ray $authorsignoff = 2; 272448ca2d8aSDwaipayan Ray } elsif ($email_address eq $author_address) { 272548ca2d8aSDwaipayan Ray $author_sob = $ctx; 272648ca2d8aSDwaipayan Ray $authorsignoff = 3; 272748ca2d8aSDwaipayan Ray } elsif ($email_name eq $author_name) { 272848ca2d8aSDwaipayan Ray $author_sob = $ctx; 272948ca2d8aSDwaipayan Ray $authorsignoff = 4; 273048ca2d8aSDwaipayan Ray 273148ca2d8aSDwaipayan Ray my $address1 = $email_address; 273248ca2d8aSDwaipayan Ray my $address2 = $author_address; 273348ca2d8aSDwaipayan Ray 273448ca2d8aSDwaipayan Ray if ($address1 =~ /(\S+)\+\S+(\@.*)/) { 273548ca2d8aSDwaipayan Ray $address1 = "$1$2"; 273648ca2d8aSDwaipayan Ray } 273748ca2d8aSDwaipayan Ray if ($address2 =~ /(\S+)\+\S+(\@.*)/) { 273848ca2d8aSDwaipayan Ray $address2 = "$1$2"; 273948ca2d8aSDwaipayan Ray } 274048ca2d8aSDwaipayan Ray if ($address1 eq $address2) { 274148ca2d8aSDwaipayan Ray $authorsignoff = 5; 274248ca2d8aSDwaipayan Ray } 274348ca2d8aSDwaipayan Ray } 2744cd261496SGeert Uytterhoeven } 2745cd261496SGeert Uytterhoeven } 27460a920b5bSAndy Whitcroft } 274720112475SJoe Perches 274844d303ebSJoe Perches# Check for patch separator 274944d303ebSJoe Perches if ($line =~ /^---$/) { 275044d303ebSJoe Perches $has_patch_separator = 1; 275144d303ebSJoe Perches $in_commit_log = 0; 275244d303ebSJoe Perches } 275344d303ebSJoe Perches 2754e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2755e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2756e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2757e0d975b1SJoe Perches $reported_maintainer_file = 1; 2758e0d975b1SJoe Perches } 2759e0d975b1SJoe Perches 276020112475SJoe Perches# Check signature styles 2761270c49a0SJoe Perches if (!$in_header_lines && 2762ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 276320112475SJoe Perches my $space_before = $1; 276420112475SJoe Perches my $sign_off = $2; 276520112475SJoe Perches my $space_after = $3; 276620112475SJoe Perches my $email = $4; 276720112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 276820112475SJoe Perches 2769ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2770ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2771ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2772ce0338dfSJoe Perches } 277320112475SJoe Perches if (defined $space_before && $space_before ne "") { 27743705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 27753705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 27763705ce5bSJoe Perches $fix) { 2777194f66fcSJoe Perches $fixed[$fixlinenr] = 27783705ce5bSJoe Perches "$ucfirst_sign_off $email"; 27793705ce5bSJoe Perches } 278020112475SJoe Perches } 278120112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 27823705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 27833705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 27843705ce5bSJoe Perches $fix) { 2785194f66fcSJoe Perches $fixed[$fixlinenr] = 27863705ce5bSJoe Perches "$ucfirst_sign_off $email"; 27873705ce5bSJoe Perches } 27883705ce5bSJoe Perches 278920112475SJoe Perches } 279020112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 27913705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 27923705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 27933705ce5bSJoe Perches $fix) { 2794194f66fcSJoe Perches $fixed[$fixlinenr] = 27953705ce5bSJoe Perches "$ucfirst_sign_off $email"; 27963705ce5bSJoe Perches } 279720112475SJoe Perches } 279820112475SJoe Perches 2799dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 280048ca2d8aSDwaipayan Ray my $suggested_email = format_email(($email_name, $name_comment, $email_address, $comment)); 280120112475SJoe Perches if ($suggested_email eq "") { 2802000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2803000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 280420112475SJoe Perches } else { 280520112475SJoe Perches my $dequoted = $suggested_email; 280620112475SJoe Perches $dequoted =~ s/^"//; 280720112475SJoe Perches $dequoted =~ s/" </ </; 280820112475SJoe Perches # Don't force email to have quotes 280920112475SJoe Perches # Allow just an angle bracketed address 281048ca2d8aSDwaipayan Ray if (!same_email_addresses($email, $suggested_email, 0)) { 2811000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 281248ca2d8aSDwaipayan Ray "email address '$email' might be better as '$suggested_email'\n" . $herecurr); 281320112475SJoe Perches } 28140a920b5bSAndy Whitcroft } 28157e51f197SJoe Perches 28167e51f197SJoe Perches# Check for duplicate signatures 28177e51f197SJoe Perches my $sig_nospace = $line; 28187e51f197SJoe Perches $sig_nospace =~ s/\s//g; 28197e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 28207e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 28217e51f197SJoe Perches WARN("BAD_SIGN_OFF", 28227e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 28237e51f197SJoe Perches } else { 28247e51f197SJoe Perches $signatures{$sig_nospace} = 1; 28257e51f197SJoe Perches } 28266c5d24eeSSean Christopherson 28276c5d24eeSSean Christopherson# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email 28286c5d24eeSSean Christopherson if ($sign_off =~ /^co-developed-by:$/i) { 28296c5d24eeSSean Christopherson if ($email eq $author) { 28306c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 28316c5d24eeSSean Christopherson "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline); 28326c5d24eeSSean Christopherson } 28336c5d24eeSSean Christopherson if (!defined $lines[$linenr]) { 28346c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 28356c5d24eeSSean Christopherson "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline); 28366c5d24eeSSean Christopherson } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) { 28376c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 28386c5d24eeSSean Christopherson "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 28396c5d24eeSSean Christopherson } elsif ($1 ne $email) { 28406c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 28416c5d24eeSSean Christopherson "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 28426c5d24eeSSean Christopherson } 28436c5d24eeSSean Christopherson } 28440a920b5bSAndy Whitcroft } 28450a920b5bSAndy Whitcroft 2846a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2847a2fe16b9SJoe Perches if ($in_header_lines && 2848a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2849a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2850a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2851a2fe16b9SJoe Perches } 2852a2fe16b9SJoe Perches 285344d303ebSJoe Perches# Check for Gerrit Change-Ids not in any patch context 285444d303ebSJoe Perches if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) { 28557ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 285644d303ebSJoe Perches "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr); 28577ebd05efSChristopher Covington } 28587ebd05efSChristopher Covington 2859369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2860369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2861369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2862369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2863369c8dd3SJoe Perches # timestamp 2864634cffccSJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) || 2865634cffccSJoe Perches $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ || 2866634cffccSJoe Perches $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) { 2867634cffccSJoe Perches # stack dump address styles 2868369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2869369c8dd3SJoe Perches } 2870369c8dd3SJoe Perches 28712a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 28722a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2873bf4daf12SJoe Perches length($line) > 75 && 2874bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2875bf4daf12SJoe Perches # file delta changes 2876bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2877bf4daf12SJoe Perches # filename then : 2878bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2879bf4daf12SJoe Perches # A Fixes: or Link: line 2880bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 28812a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 28822a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 28832a076f40SJoe Perches $commit_log_long_line = 1; 28842a076f40SJoe Perches } 28852a076f40SJoe Perches 2886bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2887bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2888bf4daf12SJoe Perches $line =~ /^\s*$/) { 2889bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2890bf4daf12SJoe Perches } 2891bf4daf12SJoe Perches 28920d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2893369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2894a8972573SJohn Hubbard $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i && 2895e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 2896fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2897aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2898369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2899bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2900fe043ea1SJoe Perches my $init_char = "c"; 2901fe043ea1SJoe Perches my $orig_commit = ""; 29020d7835fcSJoe Perches my $short = 1; 29030d7835fcSJoe Perches my $long = 0; 29040d7835fcSJoe Perches my $case = 1; 29050d7835fcSJoe Perches my $space = 1; 29060d7835fcSJoe Perches my $hasdesc = 0; 290719c146a6SJoe Perches my $hasparens = 0; 29080d7835fcSJoe Perches my $id = '0123456789ab'; 29090d7835fcSJoe Perches my $orig_desc = "commit description"; 29100d7835fcSJoe Perches my $description = ""; 29110d7835fcSJoe Perches 2912fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2913fe043ea1SJoe Perches $init_char = $1; 2914fe043ea1SJoe Perches $orig_commit = lc($2); 2915fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2916fe043ea1SJoe Perches $orig_commit = lc($1); 2917fe043ea1SJoe Perches } 2918fe043ea1SJoe Perches 29190d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 29200d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 29210d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 29220d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 29230d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 29240d7835fcSJoe Perches $orig_desc = $1; 292519c146a6SJoe Perches $hasparens = 1; 29260d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 29270d7835fcSJoe Perches defined $rawlines[$linenr] && 29280d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 29290d7835fcSJoe Perches $orig_desc = $1; 293019c146a6SJoe Perches $hasparens = 1; 2931b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2932b671fde0SJoe Perches defined $rawlines[$linenr] && 2933b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2934b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2935b671fde0SJoe Perches $orig_desc = $1; 2936b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2937b671fde0SJoe Perches $orig_desc .= " " . $1; 293819c146a6SJoe Perches $hasparens = 1; 29390d7835fcSJoe Perches } 29400d7835fcSJoe Perches 29410d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 29420d7835fcSJoe Perches $id, $orig_desc); 29430d7835fcSJoe Perches 2944948b133aSHeinrich Schuchardt if (defined($id) && 2945948b133aSHeinrich Schuchardt ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { 2946d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 29470d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 29480d7835fcSJoe Perches } 2949d311cd44SJoe Perches } 2950d311cd44SJoe Perches 295113f1937eSJoe Perches# Check for added, moved or deleted files 295213f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 295313f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 295413f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 295513f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 295613f1937eSJoe Perches (defined($1) || defined($2))))) { 2957a82603a8SAndrew Jeffery $is_patch = 1; 295813f1937eSJoe Perches $reported_maintainer_file = 1; 295913f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 296013f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 296113f1937eSJoe Perches } 296213f1937eSJoe Perches 2963e400edb1SRob Herring# Check for adding new DT bindings not in schema format 2964e400edb1SRob Herring if (!$in_commit_log && 2965e400edb1SRob Herring ($line =~ /^new file mode\s*\d+\s*$/) && 2966e400edb1SRob Herring ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) { 2967e400edb1SRob Herring WARN("DT_SCHEMA_BINDING_PATCH", 2968e400edb1SRob Herring "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n"); 2969e400edb1SRob Herring } 2970e400edb1SRob Herring 297100df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 29728905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2973000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2974000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 29756c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2976de7d4f0eSAndy Whitcroft } 2977de7d4f0eSAndy Whitcroft 2978de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2979de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2980171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2981171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2982171ae1a4SAndy Whitcroft 2983171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2984171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2985171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2986171ae1a4SAndy Whitcroft 298734d99219SJoe Perches CHK("INVALID_UTF8", 2988000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 298900df344fSAndy Whitcroft } 29900a920b5bSAndy Whitcroft 299115662b3eSJoe Perches# Check if it's the start of a commit log 299215662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 299315662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 2994eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 2995eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 299615662b3eSJoe Perches $in_header_lines = 0; 299715662b3eSJoe Perches $in_commit_log = 1; 2998ed43c4e5SAllen Hubbe $has_commit_log = 1; 299915662b3eSJoe Perches } 300015662b3eSJoe Perches 3001fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 3002fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 3003fa64205dSPasi Savanainen if ($in_header_lines && 3004fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 3005fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 3006fa64205dSPasi Savanainen $non_utf8_charset = 1; 3007fa64205dSPasi Savanainen } 3008fa64205dSPasi Savanainen 3009fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 301015662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 3011fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 301215662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 301315662b3eSJoe Perches } 301415662b3eSJoe Perches 3015d6430f71SJoe Perches# Check for absolute kernel paths in commit message 3016d6430f71SJoe Perches if ($tree && $in_commit_log) { 3017d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 3018d6430f71SJoe Perches my $file = $1; 3019d6430f71SJoe Perches 3020d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 3021d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 3022d6430f71SJoe Perches # 3023d6430f71SJoe Perches } else { 3024d6430f71SJoe Perches check_absolute_file($file, $herecurr); 3025d6430f71SJoe Perches } 3026d6430f71SJoe Perches } 3027d6430f71SJoe Perches } 3028d6430f71SJoe Perches 302966b47b4aSKees Cook# Check for various typo / spelling mistakes 303066d7a382SJoe Perches if (defined($misspellings) && 303166d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 3032ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 303366b47b4aSKees Cook my $typo = $1; 303466b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 303566b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 303666b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 30370675a8fbSJean Delvare my $msg_level = \&WARN; 30380675a8fbSJean Delvare $msg_level = \&CHK if ($file); 30390675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 304066b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 304166b47b4aSKees Cook $fix) { 304266b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 304366b47b4aSKees Cook } 304466b47b4aSKees Cook } 304566b47b4aSKees Cook } 304666b47b4aSKees Cook 3047a8dd86bfSMatteo Croce# check for invalid commit id 3048a8dd86bfSMatteo Croce if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) { 3049a8dd86bfSMatteo Croce my $id; 3050a8dd86bfSMatteo Croce my $description; 3051a8dd86bfSMatteo Croce ($id, $description) = git_commit_info($2, undef, undef); 3052a8dd86bfSMatteo Croce if (!defined($id)) { 3053a8dd86bfSMatteo Croce WARN("UNKNOWN_COMMIT_ID", 3054a8dd86bfSMatteo Croce "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr); 3055a8dd86bfSMatteo Croce } 3056a8dd86bfSMatteo Croce } 3057a8dd86bfSMatteo Croce 3058310cd06bSJoe Perches# check for repeated words separated by a single space 3059*8d0325ccSAditya Srivastava# avoid false positive from list command eg, '-rw-r--r-- 1 root root' 3060*8d0325ccSAditya Srivastava if (($rawline =~ /^\+/ || $in_commit_log) && 3061*8d0325ccSAditya Srivastava $rawline !~ /[bcCdDlMnpPs\?-][rwxsStT-]{9}/) { 30621db81a68SDwaipayan Ray pos($rawline) = 1 if (!$in_commit_log); 3063310cd06bSJoe Perches while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) { 3064310cd06bSJoe Perches 3065310cd06bSJoe Perches my $first = $1; 3066310cd06bSJoe Perches my $second = $2; 30671db81a68SDwaipayan Ray my $start_pos = $-[1]; 30681db81a68SDwaipayan Ray my $end_pos = $+[2]; 3069310cd06bSJoe Perches if ($first =~ /(?:struct|union|enum)/) { 3070310cd06bSJoe Perches pos($rawline) += length($first) + length($second) + 1; 3071310cd06bSJoe Perches next; 3072310cd06bSJoe Perches } 3073310cd06bSJoe Perches 30741db81a68SDwaipayan Ray next if (lc($first) ne lc($second)); 3075310cd06bSJoe Perches next if ($first eq 'long'); 3076310cd06bSJoe Perches 30771db81a68SDwaipayan Ray # check for character before and after the word matches 30781db81a68SDwaipayan Ray my $start_char = ''; 30791db81a68SDwaipayan Ray my $end_char = ''; 30801db81a68SDwaipayan Ray $start_char = substr($rawline, $start_pos - 1, 1) if ($start_pos > ($in_commit_log ? 0 : 1)); 30811db81a68SDwaipayan Ray $end_char = substr($rawline, $end_pos, 1) if ($end_pos < length($rawline)); 30821db81a68SDwaipayan Ray 30831db81a68SDwaipayan Ray next if ($start_char =~ /^\S$/); 30841db81a68SDwaipayan Ray next if (index(" \t.,;?!", $end_char) == -1); 30851db81a68SDwaipayan Ray 3086*8d0325ccSAditya Srivastava # avoid repeating hex occurrences like 'ff ff fe 09 ...' 3087*8d0325ccSAditya Srivastava if ($first =~ /\b[0-9a-f]{2,}\b/i) { 3088*8d0325ccSAditya Srivastava next if (!exists($allow_repeated_words{lc($first)})); 3089*8d0325ccSAditya Srivastava } 3090*8d0325ccSAditya Srivastava 3091310cd06bSJoe Perches if (WARN("REPEATED_WORD", 3092310cd06bSJoe Perches "Possible repeated word: '$first'\n" . $herecurr) && 3093310cd06bSJoe Perches $fix) { 3094310cd06bSJoe Perches $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/; 3095310cd06bSJoe Perches } 3096310cd06bSJoe Perches } 3097310cd06bSJoe Perches 3098310cd06bSJoe Perches # if it's a repeated word on consecutive lines in a comment block 3099310cd06bSJoe Perches if ($prevline =~ /$;+\s*$/ && 3100310cd06bSJoe Perches $prevrawline =~ /($word_pattern)\s*$/) { 3101310cd06bSJoe Perches my $last_word = $1; 3102310cd06bSJoe Perches if ($rawline =~ /^\+\s*\*\s*$last_word /) { 3103310cd06bSJoe Perches if (WARN("REPEATED_WORD", 3104310cd06bSJoe Perches "Possible repeated word: '$last_word'\n" . $hereprev) && 3105310cd06bSJoe Perches $fix) { 3106310cd06bSJoe Perches $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/; 3107310cd06bSJoe Perches } 3108310cd06bSJoe Perches } 3109310cd06bSJoe Perches } 3110310cd06bSJoe Perches } 3111310cd06bSJoe Perches 311230670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 311330670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 311400df344fSAndy Whitcroft 31150a920b5bSAndy Whitcroft#trailing whitespace 31169c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 3117c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3118d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 3119d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 3120d5e616fcSJoe Perches $fix) { 3121194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 3122d5e616fcSJoe Perches } 3123c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 3124c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 31253705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 31263705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 31273705ce5bSJoe Perches $fix) { 3128194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 31293705ce5bSJoe Perches } 31303705ce5bSJoe Perches 3131d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 31320a920b5bSAndy Whitcroft } 31335368df20SAndy Whitcroft 31344783f894SJosh Triplett# Check for FSF mailing addresses. 3135109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 31361bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 31373e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 31383e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 31394783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 31400675a8fbSJean Delvare my $msg_level = \&ERROR; 31410675a8fbSJean Delvare $msg_level = \&CHK if ($file); 31420675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 31434783f894SJosh Triplett "Do not include the paragraph about writing to the Free Software Foundation's mailing address from the sample GPL notice. The FSF has changed addresses in the past, and may do so again. Linux already includes a copy of the GPL.\n" . $herevet) 31444783f894SJosh Triplett } 31454783f894SJosh Triplett 31463354957aSAndi Kleen# check for Kconfig help text having a real description 31479fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 31489fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 31493354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 3150678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 3151678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 3152678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 3153678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 31543354957aSAndi Kleen my $length = 0; 31559fe287d7SAndy Whitcroft my $cnt = $realcnt; 31569fe287d7SAndy Whitcroft my $ln = $linenr + 1; 31579fe287d7SAndy Whitcroft my $f; 3158a1385803SAndy Whitcroft my $is_start = 0; 31599fe287d7SAndy Whitcroft my $is_end = 0; 3160a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 31619fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 31629fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 31639fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 31649fe287d7SAndy Whitcroft 31659fe287d7SAndy Whitcroft next if ($f =~ /^-/); 31668d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 3167a1385803SAndy Whitcroft 316886adf1a0SUlf Magnusson if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 3169a1385803SAndy Whitcroft $is_start = 1; 317022a4ac02SMasahiro Yamada } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 3171a1385803SAndy Whitcroft $length = -1; 3172a1385803SAndy Whitcroft } 3173a1385803SAndy Whitcroft 31749fe287d7SAndy Whitcroft $f =~ s/^.//; 31753354957aSAndi Kleen $f =~ s/#.*//; 31763354957aSAndi Kleen $f =~ s/^\s+//; 31773354957aSAndi Kleen next if ($f =~ /^$/); 3178678ae162SUlf Magnusson 3179678ae162SUlf Magnusson # This only checks context lines in the patch 3180678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 3181678ae162SUlf Magnusson # positives, even though some of these are 3182678ae162SUlf Magnusson # common words in help texts 3183678ae162SUlf Magnusson if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| 3184678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 31859fe287d7SAndy Whitcroft $is_end = 1; 31869fe287d7SAndy Whitcroft last; 31879fe287d7SAndy Whitcroft } 31883354957aSAndi Kleen $length++; 31893354957aSAndi Kleen } 319056193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 3191000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 319256193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 319356193274SVadim Bendebury } 3194a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 31953354957aSAndi Kleen } 31963354957aSAndi Kleen 31977ccf41a8SJoe Perches# check MAINTAINERS entries 31987ccf41a8SJoe Perches if ($realfile =~ /^MAINTAINERS$/) { 31997ccf41a8SJoe Perches# check MAINTAINERS entries for the right form 32007ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 3201628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 3202628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 3203628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 3204628f91a2SJoe Perches $fix) { 3205628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 3206628f91a2SJoe Perches } 3207628f91a2SJoe Perches } 32087ccf41a8SJoe Perches# check MAINTAINERS entries for the right ordering too 32097ccf41a8SJoe Perches my $preferred_order = 'MRLSWQBCPTFXNK'; 32107ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 32117ccf41a8SJoe Perches $prevrawline =~ /^[\+ ][A-Z]:/) { 32127ccf41a8SJoe Perches $rawline =~ /^\+([A-Z]):\s*(.*)/; 32137ccf41a8SJoe Perches my $cur = $1; 32147ccf41a8SJoe Perches my $curval = $2; 32157ccf41a8SJoe Perches $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/; 32167ccf41a8SJoe Perches my $prev = $1; 32177ccf41a8SJoe Perches my $prevval = $2; 32187ccf41a8SJoe Perches my $curindex = index($preferred_order, $cur); 32197ccf41a8SJoe Perches my $previndex = index($preferred_order, $prev); 32207ccf41a8SJoe Perches if ($curindex < 0) { 32217ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 32227ccf41a8SJoe Perches "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr); 32237ccf41a8SJoe Perches } else { 32247ccf41a8SJoe Perches if ($previndex >= 0 && $curindex < $previndex) { 32257ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 32267ccf41a8SJoe Perches "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev); 32277ccf41a8SJoe Perches } elsif ((($prev eq 'F' && $cur eq 'F') || 32287ccf41a8SJoe Perches ($prev eq 'X' && $cur eq 'X')) && 32297ccf41a8SJoe Perches ($prevval cmp $curval) > 0) { 32307ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 32317ccf41a8SJoe Perches "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev); 32327ccf41a8SJoe Perches } 32337ccf41a8SJoe Perches } 32347ccf41a8SJoe Perches } 32357ccf41a8SJoe Perches } 3236628f91a2SJoe Perches 3237327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 3238327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 3239327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 3240327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 3241327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 3242327953e9SChristoph Jaeger } 3243327953e9SChristoph Jaeger 3244c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 3245c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 3246c68e5878SArnaud Lacombe my $flag = $1; 3247c68e5878SArnaud Lacombe my $replacement = { 3248c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 3249c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 3250c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 3251c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 3252c68e5878SArnaud Lacombe }; 3253c68e5878SArnaud Lacombe 3254c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 3255c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 3256c68e5878SArnaud Lacombe } 3257c68e5878SArnaud Lacombe 3258bff5da43SRob Herring# check for DT compatible documentation 32597dd05b38SFlorian Vaussard if (defined $root && 32607dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 32617dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 32627dd05b38SFlorian Vaussard 3263bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 3264bff5da43SRob Herring 3265cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 3266852d095dSRob Herring my $vp_file = $dt_path . "vendor-prefixes.yaml"; 3267cc93319bSFlorian Vaussard 3268bff5da43SRob Herring foreach my $compat (@compats) { 3269bff5da43SRob Herring my $compat2 = $compat; 3270185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 3271185d566bSRob Herring my $compat3 = $compat; 3272185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 3273185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 3274bff5da43SRob Herring if ( $? >> 8 ) { 3275bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3276bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 3277bff5da43SRob Herring } 3278bff5da43SRob Herring 32794fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 32804fbf32a6SFlorian Vaussard my $vendor = $1; 3281852d095dSRob Herring `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`; 3282bff5da43SRob Herring if ( $? >> 8 ) { 3283bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3284cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 3285bff5da43SRob Herring } 3286bff5da43SRob Herring } 3287bff5da43SRob Herring } 3288bff5da43SRob Herring 32899f3a8992SRob Herring# check for using SPDX license tag at beginning of files 32909f3a8992SRob Herring if ($realline == $checklicenseline) { 32919f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 32929f3a8992SRob Herring $checklicenseline = 2; 32939f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 32949f3a8992SRob Herring my $comment = ""; 32959f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 32969f3a8992SRob Herring $comment = '/*'; 32979f3a8992SRob Herring } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 32989f3a8992SRob Herring $comment = '//'; 3299c8df0ab6SLubomir Rintel } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) { 33009f3a8992SRob Herring $comment = '#'; 33019f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 33029f3a8992SRob Herring $comment = '..'; 33039f3a8992SRob Herring } 33049f3a8992SRob Herring 3305fdf13693SJoe Perches# check SPDX comment style for .[chsS] files 3306fdf13693SJoe Perches if ($realfile =~ /\.[chsS]$/ && 3307fdf13693SJoe Perches $rawline =~ /SPDX-License-Identifier:/ && 3308ffbce897SJoe Perches $rawline !~ m@^\+\s*\Q$comment\E\s*@) { 3309fdf13693SJoe Perches WARN("SPDX_LICENSE_TAG", 3310fdf13693SJoe Perches "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr); 3311fdf13693SJoe Perches } 3312fdf13693SJoe Perches 33139f3a8992SRob Herring if ($comment !~ /^$/ && 3314ffbce897SJoe Perches $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) { 33159f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 33169f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 33173b6e8ac9SJoe Perches } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) { 33183b6e8ac9SJoe Perches my $spdx_license = $1; 33193b6e8ac9SJoe Perches if (!is_SPDX_License_valid($spdx_license)) { 33203b6e8ac9SJoe Perches WARN("SPDX_LICENSE_TAG", 33213b6e8ac9SJoe Perches "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr); 33223b6e8ac9SJoe Perches } 332350c92900SLubomir Rintel if ($realfile =~ m@^Documentation/devicetree/bindings/@ && 332450c92900SLubomir Rintel not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) { 332550c92900SLubomir Rintel my $msg_level = \&WARN; 332650c92900SLubomir Rintel $msg_level = \&CHK if ($file); 332750c92900SLubomir Rintel if (&{$msg_level}("SPDX_LICENSE_TAG", 332850c92900SLubomir Rintel 332950c92900SLubomir Rintel "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) && 333050c92900SLubomir Rintel $fix) { 333150c92900SLubomir Rintel $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/; 333250c92900SLubomir Rintel } 333350c92900SLubomir Rintel } 33349f3a8992SRob Herring } 33359f3a8992SRob Herring } 33369f3a8992SRob Herring } 33379f3a8992SRob Herring 3338a0154cdbSJoe Perches# check for embedded filenames 3339a0154cdbSJoe Perches if ($rawline =~ /^\+.*\Q$realfile\E/) { 3340a0154cdbSJoe Perches WARN("EMBEDDED_FILENAME", 3341a0154cdbSJoe Perches "It's generally not useful to have the filename in the file\n" . $herecurr); 3342a0154cdbSJoe Perches } 3343a0154cdbSJoe Perches 33445368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 3345d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 33465368df20SAndy Whitcroft 3347a8da38a9SJoe Perches# check for using SPDX-License-Identifier on the wrong line number 3348a8da38a9SJoe Perches if ($realline != $checklicenseline && 3349a8da38a9SJoe Perches $rawline =~ /\bSPDX-License-Identifier:/ && 3350a8da38a9SJoe Perches substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) { 3351a8da38a9SJoe Perches WARN("SPDX_LICENSE_TAG", 3352a8da38a9SJoe Perches "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr); 3353a8da38a9SJoe Perches } 3354a8da38a9SJoe Perches 335547e0c88bSJoe Perches# line length limit (with some exclusions) 335647e0c88bSJoe Perches# 335747e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 335847e0c88bSJoe Perches# logging functions like pr_info that end in a string 335947e0c88bSJoe Perches# lines with a single string 336047e0c88bSJoe Perches# #defines that are a single string 33612e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 336247e0c88bSJoe Perches# 336347e0c88bSJoe Perches# There are 3 different line length message types: 3364ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 336547e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 336647e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 336747e0c88bSJoe Perches# 336847e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 336947e0c88bSJoe Perches# 337047e0c88bSJoe Perches 3371b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 337247e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 337347e0c88bSJoe Perches 337447e0c88bSJoe Perches # Check the allowed long line types first 337547e0c88bSJoe Perches 337647e0c88bSJoe Perches # logging functions that end in a string that starts 337747e0c88bSJoe Perches # before $max_line_length 337847e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 337947e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 338047e0c88bSJoe Perches $msg_type = ""; 338147e0c88bSJoe Perches 338247e0c88bSJoe Perches # lines with only strings (w/ possible termination) 338347e0c88bSJoe Perches # #defines with only strings 338447e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 338547e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 338647e0c88bSJoe Perches $msg_type = ""; 338747e0c88bSJoe Perches 3388cc147506SJoe Perches # More special cases 3389cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3390cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3391d560a5f8SJoe Perches $msg_type = ""; 3392d560a5f8SJoe Perches 33932e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 33942e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 33952e4bbbc5SAndreas Brauchli $msg_type = ""; 33962e4bbbc5SAndreas Brauchli 339747e0c88bSJoe Perches # Otherwise set the alternate message types 339847e0c88bSJoe Perches 339947e0c88bSJoe Perches # a comment starts before $max_line_length 340047e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 340147e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 340247e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 340347e0c88bSJoe Perches 340447e0c88bSJoe Perches # a quoted string starts before $max_line_length 340547e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 340647e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 340747e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 340847e0c88bSJoe Perches } 340947e0c88bSJoe Perches 341047e0c88bSJoe Perches if ($msg_type ne "" && 341147e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 3412bdc48fa1SJoe Perches my $msg_level = \&WARN; 3413bdc48fa1SJoe Perches $msg_level = \&CHK if ($file); 3414bdc48fa1SJoe Perches &{$msg_level}($msg_type, 3415bdc48fa1SJoe Perches "line length of $length exceeds $max_line_length columns\n" . $herecurr); 34160a920b5bSAndy Whitcroft } 341747e0c88bSJoe Perches } 34180a920b5bSAndy Whitcroft 34198905a67cSAndy Whitcroft# check for adding lines without a newline. 34208905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 3421000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 3422000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 34238905a67cSAndy Whitcroft } 34248905a67cSAndy Whitcroft 3425b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3426de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 34270a920b5bSAndy Whitcroft 34280a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 3429713a09deSAntonio Borneo# more than $tabsize must use tabs. 3430c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3431c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3432c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3433d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 34343705ce5bSJoe Perches if (ERROR("CODE_INDENT", 34353705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 34363705ce5bSJoe Perches $fix) { 3437194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 34383705ce5bSJoe Perches } 34390a920b5bSAndy Whitcroft } 34400a920b5bSAndy Whitcroft 344108e44365SAlberto Panizzo# check for space before tabs. 344208e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 344308e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 34443705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 34453705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 34463705ce5bSJoe Perches $fix) { 3447194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3448713a09deSAntonio Borneo s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} 3449194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3450c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 34513705ce5bSJoe Perches } 345208e44365SAlberto Panizzo } 345308e44365SAlberto Panizzo 34546a487211SJoe Perches# check for assignments on the start of a line 34556a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 34566a487211SJoe Perches CHK("ASSIGNMENT_CONTINUATIONS", 34576a487211SJoe Perches "Assignment operator '$1' should be on the previous line\n" . $hereprev); 34586a487211SJoe Perches } 34596a487211SJoe Perches 3460d1fe9c09SJoe Perches# check for && or || at the start of a line 3461d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 3462d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 3463d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 3464d1fe9c09SJoe Perches } 3465d1fe9c09SJoe Perches 3466a91e8994SJoe Perches# check indentation starts on a tab stop 34675b57980dSJoe Perches if ($perl_version_ok && 3468bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3469a91e8994SJoe Perches my $indent = length($1); 3470713a09deSAntonio Borneo if ($indent % $tabsize) { 3471a91e8994SJoe Perches if (WARN("TABSTOP", 3472a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3473a91e8994SJoe Perches $fix) { 3474713a09deSAntonio Borneo $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; 3475a91e8994SJoe Perches } 3476a91e8994SJoe Perches } 3477a91e8994SJoe Perches } 3478a91e8994SJoe Perches 3479d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 34805b57980dSJoe Perches if ($perl_version_ok && 3481fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3482d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3483d1fe9c09SJoe Perches my $oldindent = $1; 3484d1fe9c09SJoe Perches my $rest = $2; 3485d1fe9c09SJoe Perches 3486d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3487d1fe9c09SJoe Perches if ($pos >= 0) { 3488b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3489b34a26f3SJoe Perches my $newindent = $2; 3490d1fe9c09SJoe Perches 3491d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3492713a09deSAntonio Borneo "\t" x ($pos / $tabsize) . 3493713a09deSAntonio Borneo " " x ($pos % $tabsize); 3494d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3495d1fe9c09SJoe Perches 3496d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3497d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 34983705ce5bSJoe Perches 34993705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 35003705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 35013705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3502194f66fcSJoe Perches $fixed[$fixlinenr] =~ 35033705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 35043705ce5bSJoe Perches } 3505d1fe9c09SJoe Perches } 3506d1fe9c09SJoe Perches } 3507d1fe9c09SJoe Perches } 3508d1fe9c09SJoe Perches 35096ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 35106ab3a970SJoe Perches# avoid checking a few false positives: 35116ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 35126ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 35136ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 35146ab3a970SJoe Perches# multiline macros that define functions 35156ab3a970SJoe Perches# known attributes or the __attribute__ keyword 35166ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 35176ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 35183705ce5bSJoe Perches if (CHK("SPACING", 3519f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 35203705ce5bSJoe Perches $fix) { 3521194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3522f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 35233705ce5bSJoe Perches } 3524aad4f614SJoe Perches } 3525aad4f614SJoe Perches 352686406b1cSJoe Perches# Block comment styles 352786406b1cSJoe Perches# Networking with an initial /* 352805880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3529fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 353085ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 3531c70735c2SŁukasz Stelmach $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier 353205880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 353305880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 353405880600SJoe Perches } 353505880600SJoe Perches 353686406b1cSJoe Perches# Block comments use * on subsequent lines 353786406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 353886406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3539a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 354061135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3541a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 354286406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 354386406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3544a605e32eSJoe Perches } 3545a605e32eSJoe Perches 354686406b1cSJoe Perches# Block comments use */ on trailing lines 354786406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3548c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3549c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3550c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 355186406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 355286406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 355305880600SJoe Perches } 355405880600SJoe Perches 355508eb9b80SJoe Perches# Block comment * alignment 355608eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3557af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3558af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3559af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 356008eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3561af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3562af207524SJoe Perches my $oldindent; 356308eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3564af207524SJoe Perches if (defined($1)) { 3565af207524SJoe Perches $oldindent = expand_tabs($1); 3566af207524SJoe Perches } else { 3567af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3568af207524SJoe Perches $oldindent = expand_tabs($1); 3569af207524SJoe Perches } 357008eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 357108eb9b80SJoe Perches my $newindent = $1; 357208eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3573af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 357408eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 357508eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 357608eb9b80SJoe Perches } 357708eb9b80SJoe Perches } 357808eb9b80SJoe Perches 35797f619191SJoe Perches# check for missing blank lines after struct/union declarations 35807f619191SJoe Perches# with exceptions for various attributes and macros 35817f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 35827f619191SJoe Perches $line =~ /^\+/ && 35837f619191SJoe Perches !($line =~ /^\+\s*$/ || 35847f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 35857f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 35867f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 35877f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 35887f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 35897f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 35900bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 35917f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3592d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3593d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3594d752fcc8SJoe Perches $fix) { 3595f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3596d752fcc8SJoe Perches } 35977f619191SJoe Perches } 35987f619191SJoe Perches 3599365dd4eaSJoe Perches# check for multiple consecutive blank lines 3600365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3601365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3602365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3603d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3604d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3605d752fcc8SJoe Perches $fix) { 3606f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3607d752fcc8SJoe Perches } 3608d752fcc8SJoe Perches 3609365dd4eaSJoe Perches $last_blank_line = $linenr; 3610365dd4eaSJoe Perches } 3611365dd4eaSJoe Perches 36123b617e3bSJoe Perches# check for missing blank lines after declarations 36133f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 36143f7bac03SJoe Perches # actual declarations 36153f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 36165a4e1fd3SJoe Perches # function pointer declarations 36175a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 36183f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 36193f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 36203f7bac03SJoe Perches # known declaration macros 36213f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 36223f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 36233f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 36243f7bac03SJoe Perches # other possible extensions of declaration lines 36253f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 36263f7bac03SJoe Perches # not starting a section or a macro "\" extended line 36273f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 36283f7bac03SJoe Perches # looks like a declaration 36293f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 36305a4e1fd3SJoe Perches # function pointer declarations 36315a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 36323f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 36333f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 36343f7bac03SJoe Perches # known declaration macros 36353f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 36363f7bac03SJoe Perches # start of struct or union or enum 3637328b5f41SJoe Perches $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ || 36383f7bac03SJoe Perches # start or end of block or continuation of declaration 36393f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 36403f7bac03SJoe Perches # bitfield continuation 36413f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 36423f7bac03SJoe Perches # other possible extensions of declaration lines 36433f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 36443f7bac03SJoe Perches # indentation of previous and current line are the same 36453f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3646d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3647d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3648d752fcc8SJoe Perches $fix) { 3649f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3650d752fcc8SJoe Perches } 36513b617e3bSJoe Perches } 36523b617e3bSJoe Perches 36535f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 36546b4c5bebSAndy Whitcroft# Exceptions: 36556b4c5bebSAndy Whitcroft# 1) within comments 36566b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 36576b4c5bebSAndy Whitcroft# 3) hanging labels 36583705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 36595f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 36603705ce5bSJoe Perches if (WARN("LEADING_SPACE", 36613705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 36623705ce5bSJoe Perches $fix) { 3663194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 36643705ce5bSJoe Perches } 36655f7ddae6SRaffaele Recalcati } 36665f7ddae6SRaffaele Recalcati 3667b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3668b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3669b9ea10d6SAndy Whitcroft 36705751a24eSJoe Perches# check for unusual line ending [ or ( 36715751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 36725751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 36735751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 36745751a24eSJoe Perches } 36755751a24eSJoe Perches 36764dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 36774dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 36784dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 36794dbed76fSJoe Perches $context_function = $1; 36804dbed76fSJoe Perches } 36814dbed76fSJoe Perches 36824dbed76fSJoe Perches# check if this appears to be the end of function declaration 36834dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 36844dbed76fSJoe Perches undef $context_function; 36854dbed76fSJoe Perches } 36864dbed76fSJoe Perches 3687032a4c0fSJoe Perches# check indentation of any line with a bare else 3688840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3689032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3690032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3691032a4c0fSJoe Perches my $tabs = length($1) + 1; 3692840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3693840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3694840080a0SJoe Perches defined $lines[$linenr] && 3695840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3696032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3697032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3698032a4c0fSJoe Perches } 3699032a4c0fSJoe Perches } 3700032a4c0fSJoe Perches 3701c00df19aSJoe Perches# check indentation of a line with a break; 3702c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3703c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3704c00df19aSJoe Perches my $tabs = $1; 3705c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3706c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3707c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3708c00df19aSJoe Perches } 3709c00df19aSJoe Perches } 3710c00df19aSJoe Perches 3711c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3712cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3713000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3714000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3715c2fdda0dSAndy Whitcroft } 371622f2a2efSAndy Whitcroft 371756e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 371856e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 371956e77d70SJoe Perches WARN("HOTPLUG_SECTION", 372056e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 372156e77d70SJoe Perches } 372256e77d70SJoe Perches 37239c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 37242b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 37252b474a1aSAndy Whitcroft $realline_next); 37263e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 3727ca819864SJoe Perches if ($linenr > $suppress_statement && 37281b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3729170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3730f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3731171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3732171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3733171ae1a4SAndy Whitcroft 37343e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 37353e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 37363e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 37373e469cdcSAndy Whitcroft # until we hit end of it. 37383e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 37393e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 37403e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 37413e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 37423e469cdcSAndy Whitcroft } 3743f74bd194SAndy Whitcroft 37442b474a1aSAndy Whitcroft # Find the real next line. 37452b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 37462b474a1aSAndy Whitcroft if (defined $realline_next && 37472b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 37482b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 37492b474a1aSAndy Whitcroft $realline_next++; 37502b474a1aSAndy Whitcroft } 37512b474a1aSAndy Whitcroft 3752171ae1a4SAndy Whitcroft my $s = $stat; 3753171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3754cf655043SAndy Whitcroft 3755c2fdda0dSAndy Whitcroft # Ignore goto labels. 3756171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3757c2fdda0dSAndy Whitcroft 3758c2fdda0dSAndy Whitcroft # Ignore functions being called 3759171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3760c2fdda0dSAndy Whitcroft 3761463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3762463f2864SAndy Whitcroft 3763c45dcabdSAndy Whitcroft # declarations always start with types 3764d2506586SAndy 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) { 3765c45dcabdSAndy Whitcroft my $type = $1; 3766c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3767c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3768c45dcabdSAndy Whitcroft 37696c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3770a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3771c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3772c2fdda0dSAndy Whitcroft } 37738905a67cSAndy Whitcroft 37746c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 377565863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3776c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 37779c0ca6f9SAndy Whitcroft } 37788905a67cSAndy Whitcroft 37798905a67cSAndy Whitcroft # Check for any sort of function declaration. 37808905a67cSAndy Whitcroft # int foo(something bar, other baz); 37818905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3782171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 37838905a67cSAndy Whitcroft my ($name_len) = length($1); 37848905a67cSAndy Whitcroft 3785cf655043SAndy Whitcroft my $ctx = $s; 3786773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 37878905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3788cf655043SAndy Whitcroft 37898905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3790c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 37918905a67cSAndy Whitcroft 3792c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 37938905a67cSAndy Whitcroft } 37948905a67cSAndy Whitcroft } 37958905a67cSAndy Whitcroft } 37968905a67cSAndy Whitcroft 37979c0ca6f9SAndy Whitcroft } 37989c0ca6f9SAndy Whitcroft 379900df344fSAndy Whitcroft# 380000df344fSAndy Whitcroft# Checks which may be anchored in the context. 380100df344fSAndy Whitcroft# 380200df344fSAndy Whitcroft 380300df344fSAndy Whitcroft# Check for switch () and associated case and default 380400df344fSAndy Whitcroft# statements should be at the same indent. 380500df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 380600df344fSAndy Whitcroft my $err = ''; 380700df344fSAndy Whitcroft my $sep = ''; 380800df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 380900df344fSAndy Whitcroft shift(@ctx); 381000df344fSAndy Whitcroft for my $ctx (@ctx) { 381100df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 381200df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 381300df344fSAndy Whitcroft $indent != $cindent) { 381400df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 381500df344fSAndy Whitcroft $sep = ''; 381600df344fSAndy Whitcroft } else { 381700df344fSAndy Whitcroft $sep = "[...]\n"; 381800df344fSAndy Whitcroft } 381900df344fSAndy Whitcroft } 382000df344fSAndy Whitcroft if ($err ne '') { 3821000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3822000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3823de7d4f0eSAndy Whitcroft } 3824de7d4f0eSAndy Whitcroft } 3825de7d4f0eSAndy Whitcroft 3826de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3827de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 38280fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3829773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3830773647a0SAndy Whitcroft 38319c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 38328eef05ddSJoe Perches 38338eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 38348eef05ddSJoe Perches WARN("DEEP_INDENTATION", 38358eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 38368eef05ddSJoe Perches } 38378eef05ddSJoe Perches 3838de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3839de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3840de7d4f0eSAndy Whitcroft 3841548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3842548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3843de7d4f0eSAndy Whitcroft 3844548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3845548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3846548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3847548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3848548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3849773647a0SAndy Whitcroft $ctx_ln++; 3850773647a0SAndy Whitcroft } 3851548596d5SAndy Whitcroft 385253210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 385353210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3854773647a0SAndy Whitcroft 3855773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3856000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3857000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 385801464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 385900df344fSAndy Whitcroft } 3860773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3861773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3862773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3863773647a0SAndy Whitcroft { 38649c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 38659c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3866000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3867000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 386801464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 38699c0ca6f9SAndy Whitcroft } 38709c0ca6f9SAndy Whitcroft } 387100df344fSAndy Whitcroft } 387200df344fSAndy Whitcroft 38734d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 3874f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 38753e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 38763e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 38773e469cdcSAndy Whitcroft if (!defined $stat); 38784d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 38794d001e4dSAndy Whitcroft 38804d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 38814d001e4dSAndy Whitcroft 38829f5af480SJoe Perches # remove inline comments 38839f5af480SJoe Perches $s =~ s/$;/ /g; 38849f5af480SJoe Perches $c =~ s/$;/ /g; 38854d001e4dSAndy Whitcroft 38864d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 38876f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 38886f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 38894d001e4dSAndy Whitcroft 38909f5af480SJoe Perches # Make sure we remove the line prefixes as we have 38919f5af480SJoe Perches # none on the first line, and are going to readd them 38929f5af480SJoe Perches # where necessary. 38939f5af480SJoe Perches $s =~ s/\n./\n/gs; 38949f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 38959f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 38969f5af480SJoe Perches } 38979f5af480SJoe Perches 38984d001e4dSAndy Whitcroft # We want to check the first line inside the block 38994d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 39004d001e4dSAndy Whitcroft # 1) any blank line termination 39014d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 39024d001e4dSAndy Whitcroft # 3) any do (...) { 39034d001e4dSAndy Whitcroft my $continuation = 0; 39044d001e4dSAndy Whitcroft my $check = 0; 39054d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 39064d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 39074d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 39084d001e4dSAndy Whitcroft $continuation = 1; 39094d001e4dSAndy Whitcroft } 39109bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 39114d001e4dSAndy Whitcroft $check = 1; 39124d001e4dSAndy Whitcroft $cond_lines++; 39134d001e4dSAndy Whitcroft } 39144d001e4dSAndy Whitcroft 39154d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 39164d001e4dSAndy Whitcroft # preprocessor statement. 39174d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 39184d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 39194d001e4dSAndy Whitcroft $check = 0; 39204d001e4dSAndy Whitcroft } 39214d001e4dSAndy Whitcroft 39229bd49efeSAndy Whitcroft my $cond_ptr = -1; 3923740504c6SAndy Whitcroft $continuation = 0; 39249bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 39259bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 39264d001e4dSAndy Whitcroft 3927f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3928f16fa28fSAndy Whitcroft # is not linear. 3929f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3930f16fa28fSAndy Whitcroft $check = 0; 3931f16fa28fSAndy Whitcroft } 3932f16fa28fSAndy Whitcroft 39339bd49efeSAndy Whitcroft # Ignore: 39349bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 39359bd49efeSAndy Whitcroft # 2) preprocessor lines, and 39369bd49efeSAndy Whitcroft # 3) labels. 3937740504c6SAndy Whitcroft if ($continuation || 3938740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 39399bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 39409bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3941740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 394230dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 39439bd49efeSAndy Whitcroft $cond_lines++; 39449bd49efeSAndy Whitcroft } 39454d001e4dSAndy Whitcroft } 394630dad6ebSAndy Whitcroft } 39474d001e4dSAndy Whitcroft 39484d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 39494d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 39504d001e4dSAndy Whitcroft 39514d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 39524d001e4dSAndy Whitcroft # this is not this patch's fault. 39534d001e4dSAndy Whitcroft if (!defined($stat_real) || 39544d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 39554d001e4dSAndy Whitcroft $check = 0; 39564d001e4dSAndy Whitcroft } 39574d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 39584d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 39594d001e4dSAndy Whitcroft } 39604d001e4dSAndy Whitcroft 39619bd49efeSAndy 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"; 39624d001e4dSAndy Whitcroft 39639f5af480SJoe Perches if ($check && $s ne '' && 3964713a09deSAntonio Borneo (($sindent % $tabsize) != 0 || 39659f5af480SJoe Perches ($sindent < $indent) || 3966f6950a73SJoe Perches ($sindent == $indent && 3967f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 3968713a09deSAntonio Borneo ($sindent > $indent + $tabsize))) { 3969000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3970000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 39714d001e4dSAndy Whitcroft } 39724d001e4dSAndy Whitcroft } 39734d001e4dSAndy Whitcroft 39746c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 39756c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 39761f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 39771f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 39786c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3979c2fdda0dSAndy Whitcroft if ($dbg_values) { 3980c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3981cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3982cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 39831f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3984c2fdda0dSAndy Whitcroft } 39856c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 39866c72ffaaSAndy Whitcroft 398700df344fSAndy Whitcroft#ignore lines not being added 39883705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 398900df344fSAndy Whitcroft 399099ca38c2SJoe Perches# check for self assignments used to avoid compiler warnings 399199ca38c2SJoe Perches# e.g.: int foo = foo, *bar = NULL; 399299ca38c2SJoe Perches# struct foo bar = *(&(bar)); 399399ca38c2SJoe Perches if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) { 399499ca38c2SJoe Perches my $var = $1; 399599ca38c2SJoe Perches if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) { 399699ca38c2SJoe Perches WARN("SELF_ASSIGNMENT", 399799ca38c2SJoe Perches "Do not use self-assignments to avoid compiler warnings\n" . $herecurr); 399899ca38c2SJoe Perches } 399999ca38c2SJoe Perches } 400099ca38c2SJoe Perches 400111ca40a0SJoe Perches# check for dereferences that span multiple lines 400211ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 400311ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 400411ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 400511ca40a0SJoe Perches my $ref = $1; 400611ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 400711ca40a0SJoe Perches $ref .= $1; 400811ca40a0SJoe Perches $ref =~ s/\s//g; 400911ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 401011ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 401111ca40a0SJoe Perches } 401211ca40a0SJoe Perches 4013a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 4014c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 4015a1ce18e4SJoe Perches my $type = $1; 4016a1ce18e4SJoe Perches my $var = $2; 4017207a8e84SJoe Perches $var = "" if (!defined $var); 4018207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 4019a1ce18e4SJoe Perches my $sign = $1; 4020a1ce18e4SJoe Perches my $pointer = $2; 4021a1ce18e4SJoe Perches 4022a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 4023a1ce18e4SJoe Perches 4024a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 4025a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 4026a1ce18e4SJoe Perches $fix) { 4027a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 4028207a8e84SJoe Perches my $comp_pointer = $pointer; 4029207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 4030207a8e84SJoe Perches $decl .= $comp_pointer; 4031207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 4032207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 4033a1ce18e4SJoe Perches } 4034a1ce18e4SJoe Perches } 4035a1ce18e4SJoe Perches } 4036a1ce18e4SJoe Perches 4037653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 40387429c690SAndy Whitcroft if ($dbg_type) { 40397429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 4040000d1cc1SJoe Perches ERROR("TEST_TYPE", 4041000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 40427429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 4043000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 4044000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 40457429c690SAndy Whitcroft } 4046653d4876SAndy Whitcroft next; 4047653d4876SAndy Whitcroft } 4048a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 4049a1ef277eSAndy Whitcroft if ($dbg_attr) { 40509360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 4051000d1cc1SJoe Perches ERROR("TEST_ATTR", 4052000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 40539360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 4054000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 4055000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 4056a1ef277eSAndy Whitcroft } 4057a1ef277eSAndy Whitcroft next; 4058a1ef277eSAndy Whitcroft } 4059653d4876SAndy Whitcroft 4060f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 406199423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 406299423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 4063d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 4064d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 4065f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 4066f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4067f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 4068d752fcc8SJoe Perches my $fixedline = $prevrawline; 4069d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 4070f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 4071d752fcc8SJoe Perches $fixedline = $line; 40728d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 4073f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 4074d752fcc8SJoe Perches } 4075f0a594c1SAndy Whitcroft } 4076f0a594c1SAndy Whitcroft 407700df344fSAndy Whitcroft# 407800df344fSAndy Whitcroft# Checks which are anchored on the added line. 407900df344fSAndy Whitcroft# 408000df344fSAndy Whitcroft 4081653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 4082c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 4083653d4876SAndy Whitcroft my $path = $1; 4084653d4876SAndy Whitcroft if ($path =~ m{//}) { 4085000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 4086495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 4087495e9d84SJoe Perches } 4088495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 4089495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 4090495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 4091653d4876SAndy Whitcroft } 4092653d4876SAndy Whitcroft } 4093653d4876SAndy Whitcroft 409400df344fSAndy Whitcroft# no C99 // comments 409500df344fSAndy Whitcroft if ($line =~ m{//}) { 40963705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 40973705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 40983705ce5bSJoe Perches $fix) { 4099194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 41003705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 41013705ce5bSJoe Perches my $comment = trim($1); 4102194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 41033705ce5bSJoe Perches } 41043705ce5bSJoe Perches } 410500df344fSAndy Whitcroft } 410600df344fSAndy Whitcroft # Remove C99 comments. 41070a920b5bSAndy Whitcroft $line =~ s@//.*@@; 41086c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 41090a920b5bSAndy Whitcroft 41102b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 41112b474a1aSAndy Whitcroft# the whole statement. 41122b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 41132b474a1aSAndy Whitcroft if (defined $realline_next && 41142b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 41152b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 41162b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 41172b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 41183cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 41193cbf62dfSAndy Whitcroft # a prefix: 41203cbf62dfSAndy Whitcroft # XXX(foo); 41213cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 4122653d4876SAndy Whitcroft my $name = $1; 412387a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 41243cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 41253cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 41263cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 41273cbf62dfSAndy Whitcroft 41283cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 41292b474a1aSAndy Whitcroft \n.}\s*$| 413048012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 413148012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 413248012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 41332b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 41342b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 413548012058SAndy Whitcroft )/x) { 41362b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 41372b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 41382b474a1aSAndy Whitcroft } else { 41392b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 41400a920b5bSAndy Whitcroft } 41410a920b5bSAndy Whitcroft } 41422b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 41432b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 41442b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 41452b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 41462b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 41472b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 41482b474a1aSAndy Whitcroft } 41492b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 41502b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 4151000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 4152000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 41532b474a1aSAndy Whitcroft } 41540a920b5bSAndy Whitcroft 41555150bda4SJoe Eloff# check for global initialisers. 41566d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 4157d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 41586d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 4159d5e616fcSJoe Perches $fix) { 41606d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 4161d5e616fcSJoe Perches } 4162f0a594c1SAndy Whitcroft } 41630a920b5bSAndy Whitcroft# check for static initialisers. 41646d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 4165d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 41666d32f7a3SJoe Perches "do not initialise statics to $1\n" . 4167d5e616fcSJoe Perches $herecurr) && 4168d5e616fcSJoe Perches $fix) { 41696d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 4170d5e616fcSJoe Perches } 41710a920b5bSAndy Whitcroft } 41720a920b5bSAndy Whitcroft 41731813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 41741813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 41751813087dSJoe Perches my $tmp = trim($1); 41761813087dSJoe Perches WARN("MISORDERED_TYPE", 41771813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 41781813087dSJoe Perches } 41791813087dSJoe Perches 4180809e082eSJoe Perches# check for unnecessary <signed> int declarations of short/long/long long 4181809e082eSJoe Perches while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) { 4182809e082eSJoe Perches my $type = trim($1); 4183809e082eSJoe Perches next if ($type !~ /\bint\b/); 4184809e082eSJoe Perches next if ($type !~ /\b(?:short|long\s+long|long)\b/); 4185809e082eSJoe Perches my $new_type = $type; 4186809e082eSJoe Perches $new_type =~ s/\b\s*int\s*\b/ /; 4187809e082eSJoe Perches $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /; 4188809e082eSJoe Perches $new_type =~ s/^const\s+//; 4189809e082eSJoe Perches $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/); 4190809e082eSJoe Perches $new_type = "const $new_type" if ($type =~ /^const\b/); 4191809e082eSJoe Perches $new_type =~ s/\s+/ /g; 4192809e082eSJoe Perches $new_type = trim($new_type); 4193809e082eSJoe Perches if (WARN("UNNECESSARY_INT", 4194809e082eSJoe Perches "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) && 4195809e082eSJoe Perches $fix) { 4196809e082eSJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/; 4197809e082eSJoe Perches } 4198809e082eSJoe Perches } 4199809e082eSJoe Perches 4200cb710ecaSJoe Perches# check for static const char * arrays. 4201cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 4202000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4203000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 4204cb710ecaSJoe Perches $herecurr); 4205cb710ecaSJoe Perches } 4206cb710ecaSJoe Perches 420777b8c0a8SJoe Perches# check for initialized const char arrays that should be static const 420877b8c0a8SJoe Perches if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) { 420977b8c0a8SJoe Perches if (WARN("STATIC_CONST_CHAR_ARRAY", 421077b8c0a8SJoe Perches "const array should probably be static const\n" . $herecurr) && 421177b8c0a8SJoe Perches $fix) { 421277b8c0a8SJoe Perches $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/; 421377b8c0a8SJoe Perches } 421477b8c0a8SJoe Perches } 421577b8c0a8SJoe Perches 4216cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 4217cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 4218000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4219000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 4220cb710ecaSJoe Perches $herecurr); 4221cb710ecaSJoe Perches } 4222cb710ecaSJoe Perches 4223ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 4224ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 4225ab7e23f3SJoe Perches my $found = $1; 4226ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 4227ab7e23f3SJoe Perches WARN("CONST_CONST", 4228ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 4229ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 4230ab7e23f3SJoe Perches WARN("CONST_CONST", 4231ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 4232ab7e23f3SJoe Perches } 4233ab7e23f3SJoe Perches } 4234ab7e23f3SJoe Perches 42359b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 42369b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 42379b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 42389b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 42399b0fa60dSJoe Perches $herecurr); 42409b0fa60dSJoe Perches } 42419b0fa60dSJoe Perches 4242b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 4243b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 4244b598b670SJoe Perches my $array = $1; 4245b598b670SJoe 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*\))@) { 4246b598b670SJoe Perches my $array_div = $1; 4247b598b670SJoe Perches if (WARN("ARRAY_SIZE", 4248b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 4249b598b670SJoe Perches $fix) { 4250b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 4251b598b670SJoe Perches } 4252b598b670SJoe Perches } 4253b598b670SJoe Perches } 4254b598b670SJoe Perches 4255b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 425616b7f3c8SJoe Perches if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) { 4257b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 4258b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 4259b36190c5SJoe Perches $fix) { 4260194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 4261b36190c5SJoe Perches } 4262b36190c5SJoe Perches } 4263b36190c5SJoe Perches 4264653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 4265653d4876SAndy Whitcroft# make sense. 4266653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 42678054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 4268c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 42698ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 427046d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 4271000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 4272000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 42730a920b5bSAndy Whitcroft } 42740a920b5bSAndy Whitcroft 42750a920b5bSAndy Whitcroft# * goes on variable not on type 427665863862SAndy Whitcroft # (char*[ const]) 4277bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 4278bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 42793705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 4280d8aaf121SAndy Whitcroft 428165863862SAndy Whitcroft # Should start with a space. 428265863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 428365863862SAndy Whitcroft # Should not end with a space. 428465863862SAndy Whitcroft $to =~ s/\s+$//; 428565863862SAndy Whitcroft # '*'s should not have spaces between. 4286f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 428765863862SAndy Whitcroft } 4288d8aaf121SAndy Whitcroft 42893705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 429065863862SAndy Whitcroft if ($from ne $to) { 42913705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 42923705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 42933705ce5bSJoe Perches $fix) { 42943705ce5bSJoe Perches my $sub_from = $ident; 42953705ce5bSJoe Perches my $sub_to = $ident; 42963705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4297194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42983705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 42993705ce5bSJoe Perches } 430065863862SAndy Whitcroft } 4301bfcb2cc7SAndy Whitcroft } 4302bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 4303bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 43043705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 4305d8aaf121SAndy Whitcroft 430665863862SAndy Whitcroft # Should start with a space. 430765863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 430865863862SAndy Whitcroft # Should not end with a space. 430965863862SAndy Whitcroft $to =~ s/\s+$//; 431065863862SAndy Whitcroft # '*'s should not have spaces between. 4311f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 431265863862SAndy Whitcroft } 431365863862SAndy Whitcroft # Modifiers should have spaces. 431465863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 431565863862SAndy Whitcroft 43163705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 4317667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 43183705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 43193705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 43203705ce5bSJoe Perches $fix) { 43213705ce5bSJoe Perches 43223705ce5bSJoe Perches my $sub_from = $match; 43233705ce5bSJoe Perches my $sub_to = $match; 43243705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4325194f66fcSJoe Perches $fixed[$fixlinenr] =~ 43263705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 43273705ce5bSJoe Perches } 432865863862SAndy Whitcroft } 43290a920b5bSAndy Whitcroft } 43300a920b5bSAndy Whitcroft 43319d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 43329d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 43330675a8fbSJean Delvare my $msg_level = \&WARN; 43340675a8fbSJean Delvare $msg_level = \&CHK if ($file); 43350675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 43369d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 43379d3e3c70SJoe Perches } 43380a920b5bSAndy Whitcroft 43399d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 43408905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 4341000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 4342000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 43438905a67cSAndy Whitcroft } 43448905a67cSAndy Whitcroft 434517441227SJoe Perches# check for uses of printk_ratelimit 434617441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 4347000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 4348000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 434917441227SJoe Perches } 435017441227SJoe Perches 4351eeef5733SJoe Perches# printk should use KERN_* levels 4352eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 4353000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 4354eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 435500df344fSAndy Whitcroft } 43560a920b5bSAndy Whitcroft 4357243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 4358243f3803SJoe Perches my $orig = $1; 4359243f3803SJoe Perches my $level = lc($orig); 4360243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 43618f26b837SJoe Perches my $level2 = $level; 43628f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 4363243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 4364daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 4365243f3803SJoe Perches } 4366243f3803SJoe Perches 4367dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 4368dc139313SJoe Perches my $orig = $1; 4369dc139313SJoe Perches my $level = lc($orig); 4370dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 4371dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 4372dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 4373dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 4374dc139313SJoe Perches } 4375dc139313SJoe Perches 43768020b253SNicolas Boichat# trace_printk should not be used in production code. 43778020b253SNicolas Boichat if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) { 43788020b253SNicolas Boichat WARN("TRACE_PRINTK", 43798020b253SNicolas Boichat "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr); 43808020b253SNicolas Boichat } 43818020b253SNicolas Boichat 438291c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 438391c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 438491c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 438591c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 438691c9afafSAndy Lutomirski WARN("ENOSYS", 438791c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 438891c9afafSAndy Lutomirski } 438991c9afafSAndy Lutomirski 43906b9ea5ffSJakub Kicinski# ENOTSUPP is not a standard error code and should be avoided in new patches. 43916b9ea5ffSJakub Kicinski# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP. 43926b9ea5ffSJakub Kicinski# Similarly to ENOSYS warning a small number of false positives is expected. 43936b9ea5ffSJakub Kicinski if (!$file && $line =~ /\bENOTSUPP\b/) { 43946b9ea5ffSJakub Kicinski if (WARN("ENOTSUPP", 43956b9ea5ffSJakub Kicinski "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) && 43966b9ea5ffSJakub Kicinski $fix) { 43976b9ea5ffSJakub Kicinski $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/; 43986b9ea5ffSJakub Kicinski } 43996b9ea5ffSJakub Kicinski } 44006b9ea5ffSJakub Kicinski 4401653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 4402653d4876SAndy Whitcroft# or if closed on same line 44035b57980dSJoe Perches if ($perl_version_ok && 44042d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 44052d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 44062d453e3bSJoe Perches $sline !~ /}/) { 44078d182478SJoe Perches if (ERROR("OPEN_BRACE", 44082d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 44098d182478SJoe Perches $fix) { 44108d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 44118d182478SJoe Perches my $fixed_line = $rawline; 44128d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 44138d182478SJoe Perches my $line1 = $1; 44148d182478SJoe Perches my $line2 = $2; 44158d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 44168d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 44178d182478SJoe Perches if ($line2 !~ /^\s*$/) { 44188d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 44198d182478SJoe Perches } 44208d182478SJoe Perches } 44210a920b5bSAndy Whitcroft } 4422653d4876SAndy Whitcroft 44238905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 44248905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 44258905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 44268d182478SJoe Perches if (ERROR("OPEN_BRACE", 44278d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 44288d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 44298d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 44308d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 44318d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 44328d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 44338d182478SJoe Perches $fixedline = $rawline; 44348d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 44358d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 44368d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 44378d182478SJoe Perches } 44388d182478SJoe Perches } 44398905a67cSAndy Whitcroft } 44408905a67cSAndy Whitcroft 44410c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 44423705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 44433705ce5bSJoe Perches if (WARN("SPACING", 44443705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 44453705ce5bSJoe Perches $fix) { 4446194f66fcSJoe Perches $fixed[$fixlinenr] =~ 44473705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 44483705ce5bSJoe Perches } 44490c73b4ebSAndy Whitcroft } 44500c73b4ebSAndy Whitcroft 445131070b5dSJoe Perches# Function pointer declarations 445231070b5dSJoe Perches# check spacing between type, funcptr, and args 445331070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 445491f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 445531070b5dSJoe Perches my $declare = $1; 445631070b5dSJoe Perches my $pre_pointer_space = $2; 445731070b5dSJoe Perches my $post_pointer_space = $3; 445831070b5dSJoe Perches my $funcname = $4; 445931070b5dSJoe Perches my $post_funcname_space = $5; 446031070b5dSJoe Perches my $pre_args_space = $6; 446131070b5dSJoe Perches 446291f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 446391f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 446491f72e9cSJoe Perches# don't need a space so don't warn for those. 446591f72e9cSJoe Perches my $post_declare_space = ""; 446691f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 446791f72e9cSJoe Perches $post_declare_space = $1; 446891f72e9cSJoe Perches $declare = rtrim($declare); 446991f72e9cSJoe Perches } 447091f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 447131070b5dSJoe Perches WARN("SPACING", 447231070b5dSJoe Perches "missing space after return type\n" . $herecurr); 447391f72e9cSJoe Perches $post_declare_space = " "; 447431070b5dSJoe Perches } 447531070b5dSJoe Perches 447631070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 447791f72e9cSJoe Perches# This test is not currently implemented because these declarations are 447891f72e9cSJoe Perches# equivalent to 447991f72e9cSJoe Perches# int foo(int bar, ...) 448091f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 448191f72e9cSJoe Perches# 448291f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 448391f72e9cSJoe Perches# WARN("SPACING", 448491f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 448591f72e9cSJoe Perches# } 448631070b5dSJoe Perches 448731070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 448831070b5dSJoe Perches if (defined $pre_pointer_space && 448931070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 449031070b5dSJoe Perches WARN("SPACING", 449131070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 449231070b5dSJoe Perches } 449331070b5dSJoe Perches 449431070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 449531070b5dSJoe Perches if (defined $post_pointer_space && 449631070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 449731070b5dSJoe Perches WARN("SPACING", 449831070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 449931070b5dSJoe Perches } 450031070b5dSJoe Perches 450131070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 450231070b5dSJoe Perches if (defined $post_funcname_space && 450331070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 450431070b5dSJoe Perches WARN("SPACING", 450531070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 450631070b5dSJoe Perches } 450731070b5dSJoe Perches 450831070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 450931070b5dSJoe Perches if (defined $pre_args_space && 451031070b5dSJoe Perches $pre_args_space =~ /^\s/) { 451131070b5dSJoe Perches WARN("SPACING", 451231070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 451331070b5dSJoe Perches } 451431070b5dSJoe Perches 451531070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4516194f66fcSJoe Perches $fixed[$fixlinenr] =~ 451791f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 451831070b5dSJoe Perches } 451931070b5dSJoe Perches } 452031070b5dSJoe Perches 45218d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 45228d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4523fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4524fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 45258d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 45268d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 45278d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4528fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 452938dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 45303705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 45313705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 45323705ce5bSJoe Perches $fix) { 4533194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45343705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 45353705ce5bSJoe Perches } 45368d31cfceSAndy Whitcroft } 45378d31cfceSAndy Whitcroft } 45388d31cfceSAndy Whitcroft 4539f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 45406c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4541c2fdda0dSAndy Whitcroft my $name = $1; 4542773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4543773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4544c2fdda0dSAndy Whitcroft 4545c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4546773647a0SAndy Whitcroft if ($name =~ /^(?: 4547773647a0SAndy Whitcroft if|for|while|switch|return|case| 4548773647a0SAndy Whitcroft volatile|__volatile__| 4549773647a0SAndy Whitcroft __attribute__|format|__extension__| 4550773647a0SAndy Whitcroft asm|__asm__)$/x) 4551773647a0SAndy Whitcroft { 4552c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4553c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4554c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4555c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4556773647a0SAndy Whitcroft 4557773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4558c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4559c2fdda0dSAndy Whitcroft 4560c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4561c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4562773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4563c2fdda0dSAndy Whitcroft 4564c2fdda0dSAndy Whitcroft } else { 45653705ce5bSJoe Perches if (WARN("SPACING", 45663705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 45673705ce5bSJoe Perches $fix) { 4568194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45693705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 45703705ce5bSJoe Perches } 4571f0a594c1SAndy Whitcroft } 45726c72ffaaSAndy Whitcroft } 45739a4cad4eSEric Nelson 4574653d4876SAndy Whitcroft# Check operator spacing. 45750a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 45763705ce5bSJoe Perches my $fixed_line = ""; 45773705ce5bSJoe Perches my $line_fixed = 0; 45783705ce5bSJoe Perches 45799c0ca6f9SAndy Whitcroft my $ops = qr{ 45809c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 45819c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 45829c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 45831f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 458484731623SJoe Perches \?:|\?|: 45859c0ca6f9SAndy Whitcroft }x; 4586cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 45873705ce5bSJoe Perches 45883705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 45893705ce5bSJoe Perches## foreach my $el (@elements) { 45903705ce5bSJoe Perches## print("el: <$el>\n"); 45913705ce5bSJoe Perches## } 45923705ce5bSJoe Perches 45933705ce5bSJoe Perches my @fix_elements = (); 459400df344fSAndy Whitcroft my $off = 0; 45956c72ffaaSAndy Whitcroft 45963705ce5bSJoe Perches foreach my $el (@elements) { 45973705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 45983705ce5bSJoe Perches $off += length($el); 45993705ce5bSJoe Perches } 46003705ce5bSJoe Perches 46013705ce5bSJoe Perches $off = 0; 46023705ce5bSJoe Perches 46036c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4604b34c648bSJoe Perches my $last_after = -1; 46056c72ffaaSAndy Whitcroft 46060a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 46073705ce5bSJoe Perches 46083705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 46093705ce5bSJoe Perches 46103705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 46113705ce5bSJoe Perches 46124a0df2efSAndy Whitcroft $off += length($elements[$n]); 46134a0df2efSAndy Whitcroft 461425985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4615773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4616773647a0SAndy Whitcroft my $cc = ''; 4617773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4618773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4619773647a0SAndy Whitcroft } 4620773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4621773647a0SAndy Whitcroft 46224a0df2efSAndy Whitcroft my $a = ''; 46234a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 46244a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4625cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 46264a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 46274a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 4628773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 46294a0df2efSAndy Whitcroft 46300a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 46314a0df2efSAndy Whitcroft 46324a0df2efSAndy Whitcroft my $c = ''; 46330a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 46344a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 46354a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4636cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 46374a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 46384a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 46398b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 46404a0df2efSAndy Whitcroft } else { 46414a0df2efSAndy Whitcroft $c = 'E'; 46420a920b5bSAndy Whitcroft } 46430a920b5bSAndy Whitcroft 46444a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 46454a0df2efSAndy Whitcroft 46464a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 46474a0df2efSAndy Whitcroft 46486c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 4649de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 46500a920b5bSAndy Whitcroft 465174048ed8SAndy Whitcroft # Pull out the value of this operator. 46526c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 46530a920b5bSAndy Whitcroft 46541f65f947SAndy Whitcroft # Get the full operator variant. 46551f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 46561f65f947SAndy Whitcroft 465713214adfSAndy Whitcroft # Ignore operators passed as parameters. 465813214adfSAndy Whitcroft if ($op_type ne 'V' && 4659d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 466013214adfSAndy Whitcroft 4661cf655043SAndy Whitcroft# # Ignore comments 4662cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 466313214adfSAndy Whitcroft 4664d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 466513214adfSAndy Whitcroft } elsif ($op eq ';') { 4666cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 4667cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 46683705ce5bSJoe Perches if (ERROR("SPACING", 46693705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 4670b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 46713705ce5bSJoe Perches $line_fixed = 1; 46723705ce5bSJoe Perches } 4673d8aaf121SAndy Whitcroft } 4674d8aaf121SAndy Whitcroft 4675d8aaf121SAndy Whitcroft # // is a comment 4676d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 46770a920b5bSAndy Whitcroft 4678b00e4814SJoe Perches # : when part of a bitfield 4679b00e4814SJoe Perches } elsif ($opv eq ':B') { 4680b00e4814SJoe Perches # skip the bitfield test for now 4681b00e4814SJoe Perches 46821f65f947SAndy Whitcroft # No spaces for: 46831f65f947SAndy Whitcroft # -> 4684b00e4814SJoe Perches } elsif ($op eq '->') { 46854a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 46863705ce5bSJoe Perches if (ERROR("SPACING", 46873705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4688b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 46893705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 46903705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 46913705ce5bSJoe Perches } 4692b34c648bSJoe Perches $line_fixed = 1; 46933705ce5bSJoe Perches } 46940a920b5bSAndy Whitcroft } 46950a920b5bSAndy Whitcroft 46962381097bSJoe Perches # , must not have a space before and must have a space on the right. 46970a920b5bSAndy Whitcroft } elsif ($op eq ',') { 46982381097bSJoe Perches my $rtrim_before = 0; 46992381097bSJoe Perches my $space_after = 0; 47002381097bSJoe Perches if ($ctx =~ /Wx./) { 47012381097bSJoe Perches if (ERROR("SPACING", 47022381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 47032381097bSJoe Perches $line_fixed = 1; 47042381097bSJoe Perches $rtrim_before = 1; 47052381097bSJoe Perches } 47062381097bSJoe Perches } 4707cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 47083705ce5bSJoe Perches if (ERROR("SPACING", 47093705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 47103705ce5bSJoe Perches $line_fixed = 1; 4711b34c648bSJoe Perches $last_after = $n; 47122381097bSJoe Perches $space_after = 1; 47132381097bSJoe Perches } 47142381097bSJoe Perches } 47152381097bSJoe Perches if ($rtrim_before || $space_after) { 47162381097bSJoe Perches if ($rtrim_before) { 47172381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 47182381097bSJoe Perches } else { 47192381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 47202381097bSJoe Perches } 47212381097bSJoe Perches if ($space_after) { 47222381097bSJoe Perches $good .= " "; 47233705ce5bSJoe Perches } 47240a920b5bSAndy Whitcroft } 47250a920b5bSAndy Whitcroft 47269c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 472774048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 47289c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 47299c0ca6f9SAndy Whitcroft 47309c0ca6f9SAndy Whitcroft # unary operators should have a space before and 47319c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 47329c0ca6f9SAndy Whitcroft # unary operator, or a cast 47339c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 473474048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 47350d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4736cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 47373705ce5bSJoe Perches if (ERROR("SPACING", 47383705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4739b34c648bSJoe Perches if ($n != $last_after + 2) { 4740b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 47413705ce5bSJoe Perches $line_fixed = 1; 47423705ce5bSJoe Perches } 47430a920b5bSAndy Whitcroft } 4744b34c648bSJoe Perches } 4745a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4746171ae1a4SAndy Whitcroft # A unary '*' may be const 4747171ae1a4SAndy Whitcroft 4748171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 47493705ce5bSJoe Perches if (ERROR("SPACING", 47503705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4751b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 47523705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 47533705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 47543705ce5bSJoe Perches } 4755b34c648bSJoe Perches $line_fixed = 1; 47563705ce5bSJoe Perches } 47570a920b5bSAndy Whitcroft } 47580a920b5bSAndy Whitcroft 47590a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 47600a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4761773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 47623705ce5bSJoe Perches if (ERROR("SPACING", 47633705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4764b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 47653705ce5bSJoe Perches $line_fixed = 1; 47663705ce5bSJoe Perches } 47670a920b5bSAndy Whitcroft } 4768773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4769773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 47703705ce5bSJoe Perches if (ERROR("SPACING", 47713705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4772b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 47733705ce5bSJoe Perches $line_fixed = 1; 47743705ce5bSJoe Perches } 4775653d4876SAndy Whitcroft } 4776773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 47773705ce5bSJoe Perches if (ERROR("SPACING", 47783705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4779b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 47803705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 47813705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4782773647a0SAndy Whitcroft } 4783b34c648bSJoe Perches $line_fixed = 1; 47843705ce5bSJoe Perches } 47853705ce5bSJoe Perches } 47860a920b5bSAndy Whitcroft 47870a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 47889c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 47899c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 47909c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4791c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4792c2fdda0dSAndy Whitcroft $op eq '%') 47930a920b5bSAndy Whitcroft { 4794d2e025f3SJoe Perches if ($check) { 4795d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4796d2e025f3SJoe Perches if (CHK("SPACING", 4797d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4798d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4799d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4800d2e025f3SJoe Perches $line_fixed = 1; 4801d2e025f3SJoe Perches } 4802d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4803d2e025f3SJoe Perches if (CHK("SPACING", 4804d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4805d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4806d2e025f3SJoe Perches $line_fixed = 1; 4807d2e025f3SJoe Perches } 4808d2e025f3SJoe Perches } 4809d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 48103705ce5bSJoe Perches if (ERROR("SPACING", 48113705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4812b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4813b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4814b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4815b34c648bSJoe Perches } 48163705ce5bSJoe Perches $line_fixed = 1; 48173705ce5bSJoe Perches } 48180a920b5bSAndy Whitcroft } 48190a920b5bSAndy Whitcroft 48201f65f947SAndy Whitcroft # A colon needs no spaces before when it is 48211f65f947SAndy Whitcroft # terminating a case value or a label. 48221f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 48231f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 48243705ce5bSJoe Perches if (ERROR("SPACING", 48253705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4826b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 48273705ce5bSJoe Perches $line_fixed = 1; 48283705ce5bSJoe Perches } 48291f65f947SAndy Whitcroft } 48301f65f947SAndy Whitcroft 48310a920b5bSAndy Whitcroft # All the others need spaces both sides. 4832cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 48331f65f947SAndy Whitcroft my $ok = 0; 48341f65f947SAndy Whitcroft 483522f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 48361f65f947SAndy Whitcroft if (($op eq '<' && 48371f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 48381f65f947SAndy Whitcroft ($op eq '>' && 48391f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 48401f65f947SAndy Whitcroft { 48411f65f947SAndy Whitcroft $ok = 1; 48421f65f947SAndy Whitcroft } 48431f65f947SAndy Whitcroft 4844e0df7e1fSJoe Perches # for asm volatile statements 4845e0df7e1fSJoe Perches # ignore a colon with another 4846e0df7e1fSJoe Perches # colon immediately before or after 4847e0df7e1fSJoe Perches if (($op eq ':') && 4848e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4849e0df7e1fSJoe Perches $ok = 1; 4850e0df7e1fSJoe Perches } 4851e0df7e1fSJoe Perches 485284731623SJoe Perches # messages are ERROR, but ?: are CHK 48531f65f947SAndy Whitcroft if ($ok == 0) { 48540675a8fbSJean Delvare my $msg_level = \&ERROR; 48550675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 485684731623SJoe Perches 48570675a8fbSJean Delvare if (&{$msg_level}("SPACING", 48583705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4859b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4860b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4861b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4862b34c648bSJoe Perches } 48633705ce5bSJoe Perches $line_fixed = 1; 48643705ce5bSJoe Perches } 48650a920b5bSAndy Whitcroft } 486622f2a2efSAndy Whitcroft } 48674a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 48683705ce5bSJoe Perches 48693705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 48703705ce5bSJoe Perches 48713705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 48720a920b5bSAndy Whitcroft } 48733705ce5bSJoe Perches 48743705ce5bSJoe Perches if (($#elements % 2) == 0) { 48753705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 48763705ce5bSJoe Perches } 48773705ce5bSJoe Perches 4878194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4879194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 48803705ce5bSJoe Perches } 48813705ce5bSJoe Perches 48823705ce5bSJoe Perches 48830a920b5bSAndy Whitcroft } 48840a920b5bSAndy Whitcroft 4885786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4886d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4887786b6326SJoe Perches if (WARN("SPACING", 4888786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4889786b6326SJoe Perches $fix) { 4890194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4891786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4892786b6326SJoe Perches } 4893786b6326SJoe Perches } 4894786b6326SJoe Perches 4895f0a594c1SAndy Whitcroft# check for multiple assignments 4896f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4897000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4898000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4899f0a594c1SAndy Whitcroft } 4900f0a594c1SAndy Whitcroft 490122f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 490222f2a2efSAndy Whitcroft## # continuation. 490322f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 490422f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 490522f2a2efSAndy Whitcroft## 490622f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 490722f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 490822f2a2efSAndy Whitcroft## my $ln = $line; 490922f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 491022f2a2efSAndy Whitcroft## } 491122f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4912000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4913000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 491422f2a2efSAndy Whitcroft## } 491522f2a2efSAndy Whitcroft## } 4916f0a594c1SAndy Whitcroft 49170a920b5bSAndy Whitcroft#need space before brace following if, while, etc 49186b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 49196ad724e2SMichal Zylowski $line =~ /\b(?:else|do)\{/) { 49203705ce5bSJoe Perches if (ERROR("SPACING", 49213705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 49223705ce5bSJoe Perches $fix) { 49236ad724e2SMichal Zylowski $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/; 49243705ce5bSJoe Perches } 4925de7d4f0eSAndy Whitcroft } 4926de7d4f0eSAndy Whitcroft 4927c4a62ef9SJoe Perches## # check for blank lines before declarations 4928c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4929c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4930c4a62ef9SJoe Perches## WARN("SPACING", 4931c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4932c4a62ef9SJoe Perches## } 4933c4a62ef9SJoe Perches## 4934c4a62ef9SJoe Perches 4935de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4936de7d4f0eSAndy Whitcroft# on the line 493794fb9845SJoe Perches if ($line =~ /}(?!(?:,|;|\)|\}))\S/) { 4938d5e616fcSJoe Perches if (ERROR("SPACING", 4939d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4940d5e616fcSJoe Perches $fix) { 4941194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4942d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4943d5e616fcSJoe Perches } 49440a920b5bSAndy Whitcroft } 49450a920b5bSAndy Whitcroft 494622f2a2efSAndy Whitcroft# check spacing on square brackets 494722f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 49483705ce5bSJoe Perches if (ERROR("SPACING", 49493705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 49503705ce5bSJoe Perches $fix) { 4951194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49523705ce5bSJoe Perches s/\[\s+/\[/; 49533705ce5bSJoe Perches } 495422f2a2efSAndy Whitcroft } 495522f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 49563705ce5bSJoe Perches if (ERROR("SPACING", 49573705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 49583705ce5bSJoe Perches $fix) { 4959194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49603705ce5bSJoe Perches s/\s+\]/\]/; 49613705ce5bSJoe Perches } 496222f2a2efSAndy Whitcroft } 496322f2a2efSAndy Whitcroft 4964c45dcabdSAndy Whitcroft# check spacing on parentheses 49659c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 49669c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 49673705ce5bSJoe Perches if (ERROR("SPACING", 49683705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 49693705ce5bSJoe Perches $fix) { 4970194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49713705ce5bSJoe Perches s/\(\s+/\(/; 49723705ce5bSJoe Perches } 497322f2a2efSAndy Whitcroft } 497413214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4975c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4976c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 49773705ce5bSJoe Perches if (ERROR("SPACING", 49783705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 49793705ce5bSJoe Perches $fix) { 4980194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49813705ce5bSJoe Perches s/\s+\)/\)/; 49823705ce5bSJoe Perches } 498322f2a2efSAndy Whitcroft } 498422f2a2efSAndy Whitcroft 4985e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4986e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4987e2826fd0SJoe Perches 4988e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4989ea4acbb1SJoe Perches my $var = $1; 4990ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4991ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4992ea4acbb1SJoe Perches $fix) { 4993ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4994ea4acbb1SJoe Perches } 4995ea4acbb1SJoe Perches } 4996ea4acbb1SJoe Perches 4997ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4998ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4999ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 5000ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 5001ea4acbb1SJoe Perches my $var = $2; 5002ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 5003ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 5004ea4acbb1SJoe Perches $fix) { 5005ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 5006ea4acbb1SJoe Perches $var2 =~ s/\s//g; 5007ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 5008ea4acbb1SJoe Perches } 5009e2826fd0SJoe Perches } 5010e2826fd0SJoe Perches 501163b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 5012a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 5013a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 50145b57980dSJoe Perches $perl_version_ok && defined($stat) && 501563b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 501663b7c73eSJoe Perches my $if_stat = $1; 501763b7c73eSJoe Perches my $test = substr($2, 1, -1); 501863b7c73eSJoe Perches my $herectx; 501963b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 502063b7c73eSJoe Perches my $match = $1; 502163b7c73eSJoe Perches # avoid parentheses around potential macro args 502263b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 502363b7c73eSJoe Perches if (!defined($herectx)) { 502463b7c73eSJoe Perches $herectx = $here . "\n"; 502563b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 502663b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 502763b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 502863b7c73eSJoe Perches $herectx .= $rl . "\n"; 502963b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 503063b7c73eSJoe Perches } 503163b7c73eSJoe Perches } 503263b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 503363b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 503463b7c73eSJoe Perches } 503563b7c73eSJoe Perches } 503663b7c73eSJoe Perches 50370a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 50384a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 50390a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 50403705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 50413705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 50423705ce5bSJoe Perches $fix) { 5043194f66fcSJoe Perches $fixed[$fixlinenr] =~ 50443705ce5bSJoe Perches s/^(.)\s+/$1/; 50453705ce5bSJoe Perches } 50460a920b5bSAndy Whitcroft } 50470a920b5bSAndy Whitcroft 504840873abaSJoe Perches# check if a statement with a comma should be two statements like: 504940873abaSJoe Perches# foo = bar(), /* comma should be semicolon */ 505040873abaSJoe Perches# bar = baz(); 505140873abaSJoe Perches if (defined($stat) && 505240873abaSJoe Perches $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) { 505340873abaSJoe Perches my $cnt = statement_rawlines($stat); 505440873abaSJoe Perches my $herectx = get_stat_here($linenr, $cnt, $here); 505540873abaSJoe Perches WARN("SUSPECT_COMMA_SEMICOLON", 505640873abaSJoe Perches "Possible comma where semicolon could be used\n" . $herectx); 505740873abaSJoe Perches } 505840873abaSJoe Perches 50595b9553abSJoe Perches# return is not a function 5060507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 5061c45dcabdSAndy Whitcroft my $spacing = $1; 50625b57980dSJoe Perches if ($perl_version_ok && 50635b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 50645b9553abSJoe Perches my $value = $1; 50655b9553abSJoe Perches $value = deparenthesize($value); 50665b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 5067000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 5068000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 50695b9553abSJoe Perches } 5070c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 5071000d1cc1SJoe Perches ERROR("SPACING", 5072000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 5073c45dcabdSAndy Whitcroft } 5074c45dcabdSAndy Whitcroft } 5075507e5141SJoe Perches 5076b43ae21bSJoe Perches# unnecessary return in a void function 5077b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 5078b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 5079b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 5080b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 5081b43ae21bSJoe Perches $linenr >= 3 && 5082b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 5083b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 50849819cf25SJoe Perches WARN("RETURN_VOID", 5085b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 50869819cf25SJoe Perches } 50879819cf25SJoe Perches 5088189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 50895b57980dSJoe Perches if ($perl_version_ok && 5090189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 5091189248d8SJoe Perches my $openparens = $1; 5092189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 5093189248d8SJoe Perches my $msg = ""; 5094189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 5095189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 5096189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 5097189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 5098189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 5099189248d8SJoe Perches } 5100189248d8SJoe Perches } 5101189248d8SJoe Perches 5102c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 5103c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 5104c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 5105c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 51065b57980dSJoe Perches if ($perl_version_ok && 5107c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 5108c5595fa2SJoe Perches my $lead = $1; 5109c5595fa2SJoe Perches my $const = $2; 5110c5595fa2SJoe Perches my $comp = $3; 5111c5595fa2SJoe Perches my $to = $4; 5112c5595fa2SJoe Perches my $newcomp = $comp; 5113f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 5114c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 5115c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 5116c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 5117c5595fa2SJoe Perches $fix) { 5118c5595fa2SJoe Perches if ($comp eq "<") { 5119c5595fa2SJoe Perches $newcomp = ">"; 5120c5595fa2SJoe Perches } elsif ($comp eq "<=") { 5121c5595fa2SJoe Perches $newcomp = ">="; 5122c5595fa2SJoe Perches } elsif ($comp eq ">") { 5123c5595fa2SJoe Perches $newcomp = "<"; 5124c5595fa2SJoe Perches } elsif ($comp eq ">=") { 5125c5595fa2SJoe Perches $newcomp = "<="; 5126c5595fa2SJoe Perches } 5127c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 5128c5595fa2SJoe Perches } 5129c5595fa2SJoe Perches } 5130c5595fa2SJoe Perches 5131f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 5132f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 513353a3c448SAndy Whitcroft my $name = $1; 513453a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 5135000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 5136f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 513753a3c448SAndy Whitcroft } 513853a3c448SAndy Whitcroft } 5139c45dcabdSAndy Whitcroft 51400a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 51414a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 51423705ce5bSJoe Perches if (ERROR("SPACING", 51433705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 51443705ce5bSJoe Perches $fix) { 5145194f66fcSJoe Perches $fixed[$fixlinenr] =~ 51463705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 51473705ce5bSJoe Perches } 51480a920b5bSAndy Whitcroft } 51490a920b5bSAndy Whitcroft 5150f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 5151f5fe35ddSAndy Whitcroft# statements after the conditional. 5152170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 51533e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 51543e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 51553e469cdcSAndy Whitcroft if (!defined $stat); 5156170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 5157170d3a22SAndy Whitcroft $remain_next, $off_next); 5158170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 5159170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 5160170d3a22SAndy Whitcroft 5161170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 5162170d3a22SAndy Whitcroft # If the statement carries leading newlines, 5163170d3a22SAndy Whitcroft # then count those as offsets. 5164170d3a22SAndy Whitcroft my ($whitespace) = 5165170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 5166170d3a22SAndy Whitcroft my $offset = 5167170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 5168170d3a22SAndy Whitcroft 5169170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 5170170d3a22SAndy Whitcroft $offset} = 1; 5171170d3a22SAndy Whitcroft } 5172170d3a22SAndy Whitcroft } 5173170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 5174c11230f4SJoe Perches defined($stat) && defined($cond) && 5175170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 5176171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 51778905a67cSAndy Whitcroft 5178b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 517965b64b3bSJoe Perches if (ERROR("ASSIGN_IN_IF", 518065b64b3bSJoe Perches "do not use assignment in if condition\n" . $herecurr) && 518165b64b3bSJoe Perches $fix && $perl_version_ok) { 518265b64b3bSJoe Perches if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) { 518365b64b3bSJoe Perches my $space = $1; 518465b64b3bSJoe Perches my $not = $2; 518565b64b3bSJoe Perches my $statement = $3; 518665b64b3bSJoe Perches my $assigned = $4; 518765b64b3bSJoe Perches my $test = $8; 518865b64b3bSJoe Perches my $against = $9; 518965b64b3bSJoe Perches my $brace = $15; 519065b64b3bSJoe Perches fix_delete_line($fixlinenr, $rawline); 519165b64b3bSJoe Perches fix_insert_line($fixlinenr, "$space$statement;"); 519265b64b3bSJoe Perches my $newline = "${space}if ("; 519365b64b3bSJoe Perches $newline .= '!' if defined($not); 519465b64b3bSJoe Perches $newline .= '(' if (defined $not && defined($test) && defined($against)); 519565b64b3bSJoe Perches $newline .= "$assigned"; 519665b64b3bSJoe Perches $newline .= " $test $against" if (defined($test) && defined($against)); 519765b64b3bSJoe Perches $newline .= ')' if (defined $not && defined($test) && defined($against)); 519865b64b3bSJoe Perches $newline .= ')'; 519965b64b3bSJoe Perches $newline .= " {" if (defined($brace)); 520065b64b3bSJoe Perches fix_insert_line($fixlinenr + 1, $newline); 520165b64b3bSJoe Perches } 520265b64b3bSJoe Perches } 52038905a67cSAndy Whitcroft } 52048905a67cSAndy Whitcroft 52058905a67cSAndy Whitcroft # Find out what is on the end of the line after the 52068905a67cSAndy Whitcroft # conditional. 5207773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 52088905a67cSAndy Whitcroft $s =~ s/\n.*//g; 520913214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 521053210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 521153210168SAndy Whitcroft $c !~ /}\s*while\s*/) 5212773647a0SAndy Whitcroft { 5213bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 5214bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 5215bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 521642bdf74cSHidetoshi Seto my $stat_real = ''; 5217bb44ad39SAndy Whitcroft 521842bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 521942bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 5220bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 5221bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 5222bb44ad39SAndy Whitcroft } 5223bb44ad39SAndy Whitcroft 5224000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5225000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 52268905a67cSAndy Whitcroft } 52278905a67cSAndy Whitcroft } 52288905a67cSAndy Whitcroft 522913214adfSAndy Whitcroft# Check for bitwise tests written as boolean 523013214adfSAndy Whitcroft if ($line =~ / 523113214adfSAndy Whitcroft (?: 523213214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 523313214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 523413214adfSAndy Whitcroft (?:\&\&|\|\|) 523513214adfSAndy Whitcroft | 523613214adfSAndy Whitcroft (?:\&\&|\|\|) 523713214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 523813214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 523913214adfSAndy Whitcroft )/x) 524013214adfSAndy Whitcroft { 5241000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 5242000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 524313214adfSAndy Whitcroft } 524413214adfSAndy Whitcroft 52458905a67cSAndy Whitcroft# if and else should not have general statements after it 524613214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 524713214adfSAndy Whitcroft my $s = $1; 524813214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 524913214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 5250000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5251000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 52520a920b5bSAndy Whitcroft } 525313214adfSAndy Whitcroft } 525439667782SAndy Whitcroft# if should not continue a brace 525539667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 5256000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5257048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 525839667782SAndy Whitcroft $herecurr); 525939667782SAndy Whitcroft } 5260a1080bf8SAndy Whitcroft# case and default should not have general statements after them 5261a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 5262a1080bf8SAndy Whitcroft $line !~ /\G(?: 52633fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 5264a1080bf8SAndy Whitcroft \s*return\s+ 5265a1080bf8SAndy Whitcroft )/xg) 5266a1080bf8SAndy Whitcroft { 5267000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5268000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 5269a1080bf8SAndy Whitcroft } 52700a920b5bSAndy Whitcroft 52710a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 52720a920b5bSAndy Whitcroft # indent level to be relevant to each other. 52738b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 52740a920b5bSAndy Whitcroft $previndent == $indent) { 52758b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 52768b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 52778b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 52788b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 52798b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 52808b8856f4SJoe Perches my $fixedline = $prevrawline; 52818b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 52828b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 52838b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 52848b8856f4SJoe Perches } 52858b8856f4SJoe Perches $fixedline = $rawline; 52868b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 52878b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 52888b8856f4SJoe Perches } 52890a920b5bSAndy Whitcroft } 52900a920b5bSAndy Whitcroft 52918b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 5292c2fdda0dSAndy Whitcroft $previndent == $indent) { 5293c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 5294c2fdda0dSAndy Whitcroft 5295c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 5296c2fdda0dSAndy Whitcroft # conditional. 5297773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 5298c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 5299c2fdda0dSAndy Whitcroft 5300c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 53018b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 53028b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 53038b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 53048b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 53058b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 53068b8856f4SJoe Perches my $fixedline = $prevrawline; 53078b8856f4SJoe Perches my $trailing = $rawline; 53088b8856f4SJoe Perches $trailing =~ s/^\+//; 53098b8856f4SJoe Perches $trailing = trim($trailing); 53108b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 53118b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 53128b8856f4SJoe Perches } 5313c2fdda0dSAndy Whitcroft } 5314c2fdda0dSAndy Whitcroft } 5315c2fdda0dSAndy Whitcroft 531695e2c602SJoe Perches#Specific variable tests 5317323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 5318323c1260SJoe Perches my $var = $1; 531995e2c602SJoe Perches 532095e2c602SJoe Perches#CamelCase 5321807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 5322be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 532322735ce8SJoe Perches#Ignore Page<foo> variants 5324807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 5325d439e6a5SJoe Perches#Ignore SI style variants like nS, mV and dB 5326d439e6a5SJoe Perches#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE) 5327d439e6a5SJoe Perches $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ && 5328f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 5329f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 53307e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 53317e781f67SJoe Perches my $word = $1; 53327e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 5333d8b07710SJoe Perches if ($check) { 5334d8b07710SJoe Perches seed_camelcase_includes(); 5335d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 5336d8b07710SJoe Perches seed_camelcase_file($realfile); 5337d8b07710SJoe Perches $camelcase_file_seeded = 1; 5338d8b07710SJoe Perches } 5339d8b07710SJoe Perches } 53407e781f67SJoe Perches if (!defined $camelcase{$word}) { 53417e781f67SJoe Perches $camelcase{$word} = 1; 5342be79794bSJoe Perches CHK("CAMELCASE", 53437e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 53447e781f67SJoe Perches } 5345323c1260SJoe Perches } 5346323c1260SJoe Perches } 53473445686aSJoe Perches } 53480a920b5bSAndy Whitcroft 53490a920b5bSAndy Whitcroft#no spaces allowed after \ in define 5350d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 5351d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 5352d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 5353d5e616fcSJoe Perches $fix) { 5354194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 5355d5e616fcSJoe Perches } 53560a920b5bSAndy Whitcroft } 53570a920b5bSAndy Whitcroft 53580e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 53590e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 5360c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 5361e09dec48SAndy Whitcroft my $file = "$1.h"; 5362e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 5363e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 5364e09dec48SAndy Whitcroft $realfile ne $checkfile && 53657840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 5366c45dcabdSAndy Whitcroft { 53670e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 53680e212e0aSFabian Frederick if ($asminclude > 0) { 5369e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 5370000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 5371000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5372e09dec48SAndy Whitcroft } else { 5373000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 5374000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5375e09dec48SAndy Whitcroft } 53760a920b5bSAndy Whitcroft } 53770a920b5bSAndy Whitcroft } 53780e212e0aSFabian Frederick } 53790a920b5bSAndy Whitcroft 5380653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 5381653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 5382cf655043SAndy Whitcroft# in a known good container 5383b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 5384b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 5385d8aaf121SAndy Whitcroft my $ln = $linenr; 5386d8aaf121SAndy Whitcroft my $cnt = $realcnt; 5387c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 5388c45dcabdSAndy Whitcroft my $ctx = ''; 538908a2843eSJoe Perches my $has_flow_statement = 0; 539008a2843eSJoe Perches my $has_arg_concat = 0; 5391c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 5392f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 5393f74bd194SAndy Whitcroft $ctx = $dstat; 5394c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 5395a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 5396c45dcabdSAndy Whitcroft 539708a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 539862e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 539908a2843eSJoe Perches 5400f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 5401f59b64bfSJoe Perches my $define_args = $1; 5402f59b64bfSJoe Perches my $define_stmt = $dstat; 5403f59b64bfSJoe Perches my @def_args = (); 5404f59b64bfSJoe Perches 5405f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 5406f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 5407f59b64bfSJoe Perches $define_args =~ s/\s*//g; 54088c8c45cfSJoe Perches $define_args =~ s/\\\+?//g; 5409f59b64bfSJoe Perches @def_args = split(",", $define_args); 5410f59b64bfSJoe Perches } 5411f59b64bfSJoe Perches 5412292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 5413c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 5414c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 5415c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 5416c45dcabdSAndy Whitcroft 5417c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 54182e44e803SDwaipayan Ray while ($dstat =~ s/\([^\(\)]*\)/1u/ || 54192e44e803SDwaipayan Ray $dstat =~ s/\{[^\{\}]*\}/1u/ || 54202e44e803SDwaipayan Ray $dstat =~ s/.\[[^\[\]]*\]/1u/) 5421bf30d6edSAndy Whitcroft { 5422c45dcabdSAndy Whitcroft } 5423c45dcabdSAndy Whitcroft 5424342d3d2fSAntonio Borneo # Flatten any obvious string concatenation. 542533acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 542633acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 5427e45bab8eSAndy Whitcroft { 5428e45bab8eSAndy Whitcroft } 5429e45bab8eSAndy Whitcroft 543042e15293SJoe Perches # Make asm volatile uses seem like a generic function 543142e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 543242e15293SJoe Perches 5433c45dcabdSAndy Whitcroft my $exceptions = qr{ 5434c45dcabdSAndy Whitcroft $Declare| 5435c45dcabdSAndy Whitcroft module_param_named| 5436a0a0a7a9SKees Cook MODULE_PARM_DESC| 5437c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 5438c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 5439383099fdSAndy Whitcroft __typeof__\(| 544022fd2d3eSStefani Seibold union| 544122fd2d3eSStefani Seibold struct| 5442ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 54436b10df42SVladimir Zapolskiy ^\"|\"$| 54446b10df42SVladimir Zapolskiy ^\[ 5445c45dcabdSAndy Whitcroft }x; 54465eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 5447f59b64bfSJoe Perches 5448f59b64bfSJoe Perches $ctx =~ s/\n*$//; 5449f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 5450e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 5451f59b64bfSJoe Perches 5452f74bd194SAndy Whitcroft if ($dstat ne '' && 5453f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 5454f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 54553cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 5456356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5457f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 5458f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5459e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 546072f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 54612e44e803SDwaipayan Ray $dstat !~ /^while\s*$Constant\s*$Constant\s*$/ && # while (...) {...} 5462f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5463f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5464f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 54654e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5466f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5467c45dcabdSAndy Whitcroft { 5468e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5469e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5470e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5471e795556aSJoe Perches } elsif ($dstat =~ /;/) { 5472f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5473f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5474f74bd194SAndy Whitcroft } else { 5475000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 5476388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5477d8aaf121SAndy Whitcroft } 5478f59b64bfSJoe Perches 5479f59b64bfSJoe Perches } 54805207649bSJoe Perches 54815207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 54825207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 54835207649bSJoe Perches my $first = 1; 54845207649bSJoe Perches $define_stmt = ""; 54855207649bSJoe Perches foreach my $l (@stmt_array) { 54865207649bSJoe Perches $l =~ s/\\$//; 54875207649bSJoe Perches if ($first) { 54885207649bSJoe Perches $define_stmt = $l; 54895207649bSJoe Perches $first = 0; 54905207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 54915207649bSJoe Perches $define_stmt .= substr($l, 1); 54925207649bSJoe Perches } 54935207649bSJoe Perches } 54945207649bSJoe Perches $define_stmt =~ s/$;//g; 54955207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 54965207649bSJoe Perches $define_stmt = trim($define_stmt); 54975207649bSJoe Perches 5498f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5499f59b64bfSJoe Perches foreach my $arg (@def_args) { 5500f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 55019192d41aSJoe Perches next if ($arg =~ /^type$/i); 55027fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 55036dba824eSBrendan Jackman $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 55047fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 55057fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 5506d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 5507f59b64bfSJoe Perches if ($use_cnt > 1) { 5508f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5509f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5510f59b64bfSJoe Perches } 55119192d41aSJoe Perches# check if any macro arguments may have other precedence issues 55127fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 55139192d41aSJoe Perches ((defined($1) && $1 ne ',') || 55149192d41aSJoe Perches (defined($2) && $2 ne ','))) { 55159192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 55169192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 55179192d41aSJoe Perches } 55180a920b5bSAndy Whitcroft } 55195023d347SJoe Perches 552008a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 552108a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 552208a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 552308a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 5524e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 552508a2843eSJoe Perches 552608a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 552708a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 552808a2843eSJoe Perches } 552908a2843eSJoe Perches 5530481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 55315023d347SJoe Perches 55325023d347SJoe Perches } else { 55335023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5534481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5535481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 55365023d347SJoe Perches $line =~ /^\+.*\\$/) { 55375023d347SJoe Perches WARN("LINE_CONTINUATIONS", 55385023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 55395023d347SJoe Perches } 5540653d4876SAndy Whitcroft } 55410a920b5bSAndy Whitcroft 5542b13edf7fSJoe Perches# do {} while (0) macro tests: 5543b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5544b13edf7fSJoe Perches# macro should not end with a semicolon 55455b57980dSJoe Perches if ($perl_version_ok && 5546b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5547b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5548b13edf7fSJoe Perches my $ln = $linenr; 5549b13edf7fSJoe Perches my $cnt = $realcnt; 5550b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5551b13edf7fSJoe Perches my $ctx = ''; 5552b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5553b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5554b13edf7fSJoe Perches $ctx = $dstat; 5555b13edf7fSJoe Perches 5556b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 55571b36b201SJoe Perches $dstat =~ s/$;/ /g; 5558b13edf7fSJoe Perches 5559b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5560b13edf7fSJoe Perches my $stmts = $2; 5561b13edf7fSJoe Perches my $semis = $3; 5562b13edf7fSJoe Perches 5563b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5564b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5565e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5566b13edf7fSJoe Perches 5567ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5568ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5569b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5570b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5571b13edf7fSJoe Perches } 5572b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5573b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5574b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5575b13edf7fSJoe Perches } 5576f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5577f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5578f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5579e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5580f5ef95b1SJoe Perches 5581f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5582f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5583b13edf7fSJoe Perches } 5584b13edf7fSJoe Perches } 5585b13edf7fSJoe Perches 5586f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 558713214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 558813214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5589cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 559013214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5591cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5592cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5593aad4f614SJoe Perches my @allowed = (); 5594aad4f614SJoe Perches my $allow = 0; 559513214adfSAndy Whitcroft my $seen = 0; 5596773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5597cf655043SAndy Whitcroft my $ln = $linenr - 1; 559813214adfSAndy Whitcroft for my $chunk (@chunks) { 559913214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 560013214adfSAndy Whitcroft 5601773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5602773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5603773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 5604773647a0SAndy Whitcroft 5605aad4f614SJoe Perches $allowed[$allow] = 0; 5606773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5607773647a0SAndy Whitcroft 5608773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 5609773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 5610773647a0SAndy Whitcroft 5611773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5612cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 5613cf655043SAndy Whitcroft 5614773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 561513214adfSAndy Whitcroft 561613214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 561713214adfSAndy Whitcroft 5618aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5619cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5620cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5621aad4f614SJoe Perches $allowed[$allow] = 1; 562213214adfSAndy Whitcroft } 562313214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5624cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5625aad4f614SJoe Perches $allowed[$allow] = 1; 562613214adfSAndy Whitcroft } 5627cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5628cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5629aad4f614SJoe Perches $allowed[$allow] = 1; 563013214adfSAndy Whitcroft } 5631aad4f614SJoe Perches $allow++; 563213214adfSAndy Whitcroft } 5633aad4f614SJoe Perches if ($seen) { 5634aad4f614SJoe Perches my $sum_allowed = 0; 5635aad4f614SJoe Perches foreach (@allowed) { 5636aad4f614SJoe Perches $sum_allowed += $_; 5637aad4f614SJoe Perches } 5638aad4f614SJoe Perches if ($sum_allowed == 0) { 5639000d1cc1SJoe Perches WARN("BRACES", 5640000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 5641aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 5642aad4f614SJoe Perches $seen != $allow) { 5643aad4f614SJoe Perches CHK("BRACES", 5644aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 5645aad4f614SJoe Perches } 564613214adfSAndy Whitcroft } 564713214adfSAndy Whitcroft } 564813214adfSAndy Whitcroft } 5649773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 565013214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 5651cf655043SAndy Whitcroft my $allowed = 0; 5652f0a594c1SAndy Whitcroft 5653cf655043SAndy Whitcroft # Check the pre-context. 5654cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 5655cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 5656cf655043SAndy Whitcroft $allowed = 1; 5657f0a594c1SAndy Whitcroft } 5658773647a0SAndy Whitcroft 5659773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 5660773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 5661773647a0SAndy Whitcroft 5662cf655043SAndy Whitcroft # Check the condition. 5663cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 5664773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 5665cf655043SAndy Whitcroft if (defined $cond) { 5666773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5667cf655043SAndy Whitcroft } 5668cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5669cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5670cf655043SAndy Whitcroft $allowed = 1; 5671cf655043SAndy Whitcroft } 5672cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5673cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5674cf655043SAndy Whitcroft $allowed = 1; 5675cf655043SAndy Whitcroft } 5676cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5677cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5678cf655043SAndy Whitcroft $allowed = 1; 5679cf655043SAndy Whitcroft } 5680cf655043SAndy Whitcroft # Check the post-context. 5681cf655043SAndy Whitcroft if (defined $chunks[1]) { 5682cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 5683cf655043SAndy Whitcroft if (defined $cond) { 5684773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5685cf655043SAndy Whitcroft } 5686cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 5687cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5688cf655043SAndy Whitcroft $allowed = 1; 5689cf655043SAndy Whitcroft } 5690cf655043SAndy Whitcroft } 5691cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 5692f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 5693e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5694cf655043SAndy Whitcroft 5695000d1cc1SJoe Perches WARN("BRACES", 5696000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 5697f0a594c1SAndy Whitcroft } 5698f0a594c1SAndy Whitcroft } 5699f0a594c1SAndy Whitcroft 5700e4c5babdSJoe Perches# check for single line unbalanced braces 570195330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 570295330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 5703e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 5704e4c5babdSJoe Perches } 5705e4c5babdSJoe Perches 57060979ae66SJoe Perches# check for unnecessary blank lines around braces 570777b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5708f8e58219SJoe Perches if (CHK("BRACES", 5709f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5710f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 5711f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5712f8e58219SJoe Perches } 57130979ae66SJoe Perches } 571477b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5715f8e58219SJoe Perches if (CHK("BRACES", 5716f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5717f8e58219SJoe Perches $fix) { 5718f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 5719f8e58219SJoe Perches } 57200979ae66SJoe Perches } 57210979ae66SJoe Perches 57224a0df2efSAndy Whitcroft# no volatiles please 57236c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 57246c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5725000d1cc1SJoe Perches WARN("VOLATILE", 57268c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 57274a0df2efSAndy Whitcroft } 57284a0df2efSAndy Whitcroft 57295e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 57305e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 57315e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 57325e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 573333acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 57345e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 57355e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 57365e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 57375e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 57385e4f6ba5SJoe Perches $fix && 57395e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 57405e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 57415e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 57425e4f6ba5SJoe Perches my $comma_close = ""; 57435e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 57445e4f6ba5SJoe Perches $comma_close = $1; 57455e4f6ba5SJoe Perches } 57465e4f6ba5SJoe Perches 57475e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 57485e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 57495e4f6ba5SJoe Perches my $fixedline = $prevrawline; 57505e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 57515e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 57525e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 57535e4f6ba5SJoe Perches $fixedline = $rawline; 57545e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 57555e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 57565e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 57575e4f6ba5SJoe Perches } 57585e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 57595e4f6ba5SJoe Perches } 57605e4f6ba5SJoe Perches } 57615e4f6ba5SJoe Perches 57625e4f6ba5SJoe Perches# check for missing a space in a string concatenation 57635e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 57645e4f6ba5SJoe Perches WARN('MISSING_SPACE', 57655e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 57665e4f6ba5SJoe Perches } 57675e4f6ba5SJoe Perches 576877cb8546SJoe Perches# check for an embedded function name in a string when the function is known 5769e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 5770e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 5771e4b7d309SJoe Perches# function declarations 577277cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 577377cb8546SJoe Perches defined($context_function) && 5774e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 5775e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 577677cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 5777e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 577877cb8546SJoe Perches } 577977cb8546SJoe Perches 57805e4f6ba5SJoe Perches# check for spaces before a quoted newline 57815e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 57825e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 57835e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 57845e4f6ba5SJoe Perches $fix) { 57855e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 57865e4f6ba5SJoe Perches } 57875e4f6ba5SJoe Perches 57885e4f6ba5SJoe Perches } 57895e4f6ba5SJoe Perches 5790f17dba4fSJoe Perches# concatenated string without spaces between elements 579179682c0cSJoe Perches if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) { 579279682c0cSJoe Perches if (CHK("CONCATENATED_STRING", 579379682c0cSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr) && 579479682c0cSJoe Perches $fix) { 579579682c0cSJoe Perches while ($line =~ /($String)/g) { 579679682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 579779682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/; 579879682c0cSJoe Perches $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/; 579979682c0cSJoe Perches } 580079682c0cSJoe Perches } 5801f17dba4fSJoe Perches } 5802f17dba4fSJoe Perches 580390ad30e5SJoe Perches# uncoalesced string fragments 580433acb54aSJoe Perches if ($line =~ /$String\s*"/) { 580579682c0cSJoe Perches if (WARN("STRING_FRAGMENTS", 580679682c0cSJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr) && 580779682c0cSJoe Perches $fix) { 580879682c0cSJoe Perches while ($line =~ /($String)(?=\s*")/g) { 580979682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 581079682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e; 581179682c0cSJoe Perches } 581279682c0cSJoe Perches } 581390ad30e5SJoe Perches } 581490ad30e5SJoe Perches 5815522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 5816522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 5817522b837cSAlexey Dobriyan my $show_Z = 1; 58185e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 5819522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 58205e4f6ba5SJoe Perches $string =~ s/%%/__/g; 5821522b837cSAlexey Dobriyan # check for %L 5822522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 58235e4f6ba5SJoe Perches WARN("PRINTF_L", 5824522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 5825522b837cSAlexey Dobriyan $show_L = 0; 58265e4f6ba5SJoe Perches } 5827522b837cSAlexey Dobriyan # check for %Z 5828522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 5829522b837cSAlexey Dobriyan WARN("PRINTF_Z", 5830522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 5831522b837cSAlexey Dobriyan $show_Z = 0; 5832522b837cSAlexey Dobriyan } 5833522b837cSAlexey Dobriyan # check for 0x<decimal> 5834522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 5835522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 58366e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 58376e300757SJoe Perches } 58385e4f6ba5SJoe Perches } 58395e4f6ba5SJoe Perches 58405e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 58413f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 58425e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 58435e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 58445e4f6ba5SJoe Perches } 58455e4f6ba5SJoe Perches 584600df344fSAndy Whitcroft# warn about #if 0 5847c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 584860f89010SPrakruthi Deepak Heragu WARN("IF_0", 584960f89010SPrakruthi Deepak Heragu "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr); 585060f89010SPrakruthi Deepak Heragu } 585160f89010SPrakruthi Deepak Heragu 585260f89010SPrakruthi Deepak Heragu# warn about #if 1 585360f89010SPrakruthi Deepak Heragu if ($line =~ /^.\s*\#\s*if\s+1\b/) { 585460f89010SPrakruthi Deepak Heragu WARN("IF_1", 585560f89010SPrakruthi Deepak Heragu "Consider removing the #if 1 and its #endif\n" . $herecurr); 58564a0df2efSAndy Whitcroft } 58574a0df2efSAndy Whitcroft 585803df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 585903df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5860100425deSJoe Perches my $tested = quotemeta($1); 5861100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5862100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5863100425deSJoe Perches my $func = $1; 5864100425deSJoe Perches if (WARN('NEEDLESS_IF', 5865100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5866100425deSJoe Perches $fix) { 5867100425deSJoe Perches my $do_fix = 1; 5868100425deSJoe Perches my $leading_tabs = ""; 5869100425deSJoe Perches my $new_leading_tabs = ""; 5870100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5871100425deSJoe Perches $leading_tabs = $1; 5872100425deSJoe Perches } else { 5873100425deSJoe Perches $do_fix = 0; 5874100425deSJoe Perches } 5875100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5876100425deSJoe Perches $new_leading_tabs = $1; 5877100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5878100425deSJoe Perches $do_fix = 0; 5879100425deSJoe Perches } 5880100425deSJoe Perches } else { 5881100425deSJoe Perches $do_fix = 0; 5882100425deSJoe Perches } 5883100425deSJoe Perches if ($do_fix) { 5884100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5885100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5886100425deSJoe Perches } 5887100425deSJoe Perches } 58884c432a8fSGreg Kroah-Hartman } 58894c432a8fSGreg Kroah-Hartman } 5890f0a594c1SAndy Whitcroft 5891ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5892ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5893ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5894ebfdc409SJoe Perches (defined $1 || defined $3) && 5895ebfdc409SJoe Perches $linenr > 3) { 5896ebfdc409SJoe Perches my $testval = $2; 5897ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5898ebfdc409SJoe Perches 5899ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5900ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5901ebfdc409SJoe Perches 5902e29a70f1SJoe Perches if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ && 5903e29a70f1SJoe Perches $s !~ /\b__GFP_NOWARN\b/ ) { 5904ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5905ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5906ebfdc409SJoe Perches } 5907ebfdc409SJoe Perches } 5908ebfdc409SJoe Perches 5909f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5910dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5911f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5912f78d98f6SJoe Perches my $level = $1; 5913f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5914f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5915f78d98f6SJoe Perches $fix) { 5916f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5917f78d98f6SJoe Perches } 5918f78d98f6SJoe Perches } 5919f78d98f6SJoe Perches 592045c55e92SJoe Perches# check for logging continuations 592145c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 592245c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 592345c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 592445c55e92SJoe Perches } 592545c55e92SJoe Perches 5926abb08a53SJoe Perches# check for mask then right shift without a parentheses 59275b57980dSJoe Perches if ($perl_version_ok && 5928abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5929abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5930abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5931abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5932abb08a53SJoe Perches } 5933abb08a53SJoe Perches 5934b75ac618SJoe Perches# check for pointer comparisons to NULL 59355b57980dSJoe Perches if ($perl_version_ok) { 5936b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5937b75ac618SJoe Perches my $val = $1; 5938b75ac618SJoe Perches my $equal = "!"; 5939b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5940b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5941b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5942b75ac618SJoe Perches $fix) { 5943b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5944b75ac618SJoe Perches } 5945b75ac618SJoe Perches } 5946b75ac618SJoe Perches } 5947b75ac618SJoe Perches 59488716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 59498716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 59508716de38SJoe Perches my $attr = $1; 59518716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 59528716de38SJoe Perches my $ptr = $1; 59538716de38SJoe Perches my $var = $2; 59548716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 59558716de38SJoe Perches ERROR("MISPLACED_INIT", 59568716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 59578716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 59588716de38SJoe Perches WARN("MISPLACED_INIT", 59598716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 59608716de38SJoe Perches $fix) { 5961194f66fcSJoe 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; 59628716de38SJoe Perches } 59638716de38SJoe Perches } 59648716de38SJoe Perches } 59658716de38SJoe Perches 5966e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5967e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5968e970b884SJoe Perches my $attr = $1; 5969e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5970e970b884SJoe Perches my $attr_prefix = $1; 5971e970b884SJoe Perches my $attr_type = $2; 5972e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5973e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5974e970b884SJoe Perches $fix) { 5975194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5976e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5977e970b884SJoe Perches } 5978e970b884SJoe Perches } 5979e970b884SJoe Perches 5980e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5981e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5982e970b884SJoe Perches my $attr = $1; 5983e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5984e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5985e970b884SJoe Perches $fix) { 5986194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5987e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5988e970b884SJoe Perches $lead = rtrim($1); 5989e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5990e970b884SJoe Perches $lead = "${lead}const "; 5991194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5992e970b884SJoe Perches } 5993e970b884SJoe Perches } 5994e970b884SJoe Perches 5995c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5996c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5997c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5998c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5999c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 6000c17893c7SJoe Perches $fix) { 6001c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 6002c17893c7SJoe Perches } 6003c17893c7SJoe Perches } 6004c17893c7SJoe Perches 6005fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 6006fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 6007fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 6008fbdb8138SJoe Perches my $constant_func = $1; 6009fbdb8138SJoe Perches my $func = $constant_func; 6010fbdb8138SJoe Perches $func =~ s/^__constant_//; 6011fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 6012fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 6013fbdb8138SJoe Perches $fix) { 6014194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 6015fbdb8138SJoe Perches } 6016fbdb8138SJoe Perches } 6017fbdb8138SJoe Perches 60181a15a250SPatrick Pannuto# prefer usleep_range over udelay 601937581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 602043c1d77cSJoe Perches my $delay = $1; 60211a15a250SPatrick Pannuto # ignore udelay's < 10, however 602243c1d77cSJoe Perches if (! ($delay < 10) ) { 6023000d1cc1SJoe Perches CHK("USLEEP_RANGE", 6024458f69efSMauro Carvalho Chehab "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr); 602543c1d77cSJoe Perches } 602643c1d77cSJoe Perches if ($delay > 2000) { 602743c1d77cSJoe Perches WARN("LONG_UDELAY", 602843c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 60291a15a250SPatrick Pannuto } 60301a15a250SPatrick Pannuto } 60311a15a250SPatrick Pannuto 603209ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 603309ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 603409ef8725SPatrick Pannuto if ($1 < 20) { 6035000d1cc1SJoe Perches WARN("MSLEEP", 6036458f69efSMauro Carvalho Chehab "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr); 603709ef8725SPatrick Pannuto } 603809ef8725SPatrick Pannuto } 603909ef8725SPatrick Pannuto 604036ec1939SJoe Perches# check for comparisons of jiffies 604136ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 604236ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 604336ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 604436ec1939SJoe Perches } 604536ec1939SJoe Perches 60469d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 60479d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 60489d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 60499d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 60509d7a34a5SJoe Perches } 60519d7a34a5SJoe Perches 605200df344fSAndy Whitcroft# warn about #ifdefs in C files 6053c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 605400df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 605500df344fSAndy Whitcroft# print "$herecurr"; 605600df344fSAndy Whitcroft# $clean = 0; 605700df344fSAndy Whitcroft# } 605800df344fSAndy Whitcroft 605922f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 6060c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 60613705ce5bSJoe Perches if (ERROR("SPACING", 60623705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 60633705ce5bSJoe Perches $fix) { 6064194f66fcSJoe Perches $fixed[$fixlinenr] =~ 60653705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 60663705ce5bSJoe Perches } 60673705ce5bSJoe Perches 606822f2a2efSAndy Whitcroft } 606922f2a2efSAndy Whitcroft 60704a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 6071171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 6072171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 60734a0df2efSAndy Whitcroft my $which = $1; 60744a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 6075000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 6076000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 60774a0df2efSAndy Whitcroft } 60784a0df2efSAndy Whitcroft } 60794a0df2efSAndy Whitcroft# check for memory barriers without a comment. 6080402c2553SMichael S. Tsirkin 6081402c2553SMichael S. Tsirkin my $barriers = qr{ 6082402c2553SMichael S. Tsirkin mb| 6083402c2553SMichael S. Tsirkin rmb| 6084ad83ec6cSWill Deacon wmb 6085402c2553SMichael S. Tsirkin }x; 6086402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 6087402c2553SMichael S. Tsirkin mb__before_atomic| 6088402c2553SMichael S. Tsirkin mb__after_atomic| 6089402c2553SMichael S. Tsirkin store_release| 6090402c2553SMichael S. Tsirkin load_acquire| 6091402c2553SMichael S. Tsirkin store_mb| 6092402c2553SMichael S. Tsirkin (?:$barriers) 6093402c2553SMichael S. Tsirkin }x; 6094402c2553SMichael S. Tsirkin my $all_barriers = qr{ 6095402c2553SMichael S. Tsirkin (?:$barriers)| 609643e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 609743e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 6098402c2553SMichael S. Tsirkin }x; 6099402c2553SMichael S. Tsirkin 6100402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 61014a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 6102c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 6103000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 61044a0df2efSAndy Whitcroft } 61054a0df2efSAndy Whitcroft } 61063ad81779SPaul E. McKenney 6107f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 6108f4073b0fSMichael S. Tsirkin 6109f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 6110f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 6111f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 6112f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 6113f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 6114f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 6115f4073b0fSMichael S. Tsirkin } 6116f4073b0fSMichael S. Tsirkin 6117cb426e99SJoe Perches# check for waitqueue_active without a comment. 6118cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 6119cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 6120cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 6121cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 6122cb426e99SJoe Perches } 6123cb426e99SJoe Perches } 61243ad81779SPaul E. McKenney 61255099a722SMarco Elver# check for data_race without a comment. 61265099a722SMarco Elver if ($line =~ /\bdata_race\s*\(/) { 61275099a722SMarco Elver if (!ctx_has_comment($first_line, $linenr)) { 61285099a722SMarco Elver WARN("DATA_RACE", 61295099a722SMarco Elver "data_race without comment\n" . $herecurr); 61305099a722SMarco Elver } 61315099a722SMarco Elver } 61325099a722SMarco Elver 61334a0df2efSAndy Whitcroft# check of hardware specific defines 6134c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 6135000d1cc1SJoe Perches CHK("ARCH_DEFINES", 6136000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 61370a920b5bSAndy Whitcroft } 6138653d4876SAndy Whitcroft 6139596ed45bSJoe Perches# check that the storage class is not after a type 6140596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 6141000d1cc1SJoe Perches WARN("STORAGE_CLASS", 6142596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 6143596ed45bSJoe Perches } 6144596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 6145596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 6146596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 6147596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 6148596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 6149596ed45bSJoe Perches WARN("STORAGE_CLASS", 6150596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 6151d4977c78STobias Klauser } 6152d4977c78STobias Klauser 6153de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 6154de7d4f0eSAndy Whitcroft# storage class and type. 61559c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 61569c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 6157000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 6158000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 6159de7d4f0eSAndy Whitcroft } 6160de7d4f0eSAndy Whitcroft 61618905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 61622b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 61632b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 6164d5e616fcSJoe Perches if (WARN("INLINE", 6165d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 6166d5e616fcSJoe Perches $fix) { 6167194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 6168d5e616fcSJoe Perches 6169d5e616fcSJoe Perches } 61708905a67cSAndy Whitcroft } 61718905a67cSAndy Whitcroft 61723d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 61732b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 61742b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 6175000d1cc1SJoe Perches WARN("PREFER_PACKED", 6176000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 61773d130fd0SJoe Perches } 61783d130fd0SJoe Perches 617939b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 61802b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 61812b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 6182000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 6183000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 618439b7e287SJoe Perches } 618539b7e287SJoe Perches 6186462811d9SJoe Perches# Check for __attribute__ section, prefer __section 6187462811d9SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 6188462811d9SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) { 6189462811d9SJoe Perches my $old = substr($rawline, $-[1], $+[1] - $-[1]); 6190462811d9SJoe Perches my $new = substr($old, 1, -1); 6191462811d9SJoe Perches if (WARN("PREFER_SECTION", 6192462811d9SJoe Perches "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) && 6193462811d9SJoe Perches $fix) { 6194462811d9SJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/; 6195462811d9SJoe Perches } 6196462811d9SJoe Perches } 6197462811d9SJoe Perches 61985f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 61992b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 62002b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 6201d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 6202d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 6203d5e616fcSJoe Perches $fix) { 6204194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 6205d5e616fcSJoe Perches 6206d5e616fcSJoe Perches } 62075f14d3bdSJoe Perches } 62085f14d3bdSJoe Perches 62096061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 62102b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 62112b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 6212d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 6213d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 6214d5e616fcSJoe Perches $fix) { 6215194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 6216d5e616fcSJoe Perches } 62176061d949SJoe Perches } 62186061d949SJoe Perches 6219619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 62205b57980dSJoe Perches if ($perl_version_ok && 6221619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 6222619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 6223619a908aSJoe Perches $line =~ /\b__weak\b/)) { 6224619a908aSJoe Perches ERROR("WEAK_DECLARATION", 6225619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 6226619a908aSJoe Perches } 6227619a908aSJoe Perches 6228fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 6229e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 6230fd39f904STomas Winkler $realfile !~ m@\btools/@ && 6231e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 6232e6176fa4SJoe Perches my $type = $1; 6233e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 6234e6176fa4SJoe Perches $type = $1; 6235e6176fa4SJoe Perches my $kernel_type = 'u'; 6236e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 6237e6176fa4SJoe Perches $type =~ /(\d+)/; 6238e6176fa4SJoe Perches $kernel_type .= $1; 6239e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 6240e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 6241e6176fa4SJoe Perches $fix) { 6242e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 6243e6176fa4SJoe Perches } 6244e6176fa4SJoe Perches } 6245e6176fa4SJoe Perches } 6246e6176fa4SJoe Perches 6247938224b5SJoe Perches# check for cast of C90 native int or longer types constants 6248938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 6249938224b5SJoe Perches my $cast = $1; 6250938224b5SJoe Perches my $const = $2; 6251938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 6252938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 6253938224b5SJoe Perches $fix) { 6254938224b5SJoe Perches my $suffix = ""; 6255938224b5SJoe Perches my $newconst = $const; 6256938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 6257938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 6258938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 6259938224b5SJoe Perches $suffix .= 'LL'; 6260938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 6261938224b5SJoe Perches $suffix .= 'L'; 6262938224b5SJoe Perches } 6263938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 6264938224b5SJoe Perches } 6265938224b5SJoe Perches } 6266938224b5SJoe Perches 62678f53a9b8SJoe Perches# check for sizeof(&) 62688f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 6269000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 6270000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 62718f53a9b8SJoe Perches } 62728f53a9b8SJoe Perches 627366c80b60SJoe Perches# check for sizeof without parenthesis 627466c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 6275d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 6276d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 6277d5e616fcSJoe Perches $fix) { 6278194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 6279d5e616fcSJoe Perches } 628066c80b60SJoe Perches } 628166c80b60SJoe Perches 628288982feaSJoe Perches# check for struct spinlock declarations 628388982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 628488982feaSJoe Perches WARN("USE_SPINLOCK_T", 628588982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 628688982feaSJoe Perches } 628788982feaSJoe Perches 6288a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 628906668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 6290a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 6291caac1d5fSHeba Aamer $fmt =~ s/%%//g; 6292caac1d5fSHeba Aamer if ($fmt !~ /%/) { 6293d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 6294d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 6295d5e616fcSJoe Perches $fix) { 6296194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 6297d5e616fcSJoe Perches } 6298a6962d72SJoe Perches } 6299a6962d72SJoe Perches } 6300a6962d72SJoe Perches 63010b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 63025b57980dSJoe Perches if ($perl_version_ok && 63030b523769SJoe Perches defined $stat && 63040b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 63050b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 6306e3c6bc95STobin C. Harding my $stat_real; 6307e3c6bc95STobin C. Harding 63080b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 63090b523769SJoe Perches $lc = $lc + $linenr; 63100b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 6311ffe07513SJoe Perches my $specifier; 6312ffe07513SJoe Perches my $extension; 63133bd32d6aSSakari Ailus my $qualifier; 6314ffe07513SJoe Perches my $bad_specifier = ""; 63150b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 63160b523769SJoe Perches $fmt =~ s/%%//g; 6317e3c6bc95STobin C. Harding 63183bd32d6aSSakari Ailus while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) { 6319e3c6bc95STobin C. Harding $specifier = $1; 6320e3c6bc95STobin C. Harding $extension = $2; 63213bd32d6aSSakari Ailus $qualifier = $3; 6322361b0d28SLinus Torvalds if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ || 63233bd32d6aSSakari Ailus ($extension eq "f" && 63243bd32d6aSSakari Ailus defined $qualifier && $qualifier !~ /^w/)) { 6325e3c6bc95STobin C. Harding $bad_specifier = $specifier; 63260b523769SJoe Perches last; 63270b523769SJoe Perches } 6328e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 6329e3c6bc95STobin C. Harding if (!defined($stat_real)) { 6330e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 63310b523769SJoe Perches } 6332e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 6333e3c6bc95STobin 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"); 6334e3c6bc95STobin C. Harding } 6335e3c6bc95STobin C. Harding } 6336e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 63372a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 63381df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 63391df7338aSSergey Senozhatsky my $use = ""; 6340e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 63411df7338aSSergey Senozhatsky $use = " - use %pS instead"; 6342e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 63431df7338aSSergey Senozhatsky } 63442a9f9d85STobin C. Harding 63450b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 6346e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 6347e3c6bc95STobin C. Harding } 63480b523769SJoe Perches } 63490b523769SJoe Perches } 63500b523769SJoe Perches 6351554e165cSAndy Whitcroft# Check for misused memsets 63525b57980dSJoe Perches if ($perl_version_ok && 6353d1fe9c09SJoe Perches defined $stat && 63549e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 6355554e165cSAndy Whitcroft 6356d7c76ba7SJoe Perches my $ms_addr = $2; 6357d1fe9c09SJoe Perches my $ms_val = $7; 6358d1fe9c09SJoe Perches my $ms_size = $12; 6359d7c76ba7SJoe Perches 6360554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 6361554e165cSAndy Whitcroft ERROR("MEMSET", 6362d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 6363554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 6364554e165cSAndy Whitcroft WARN("MEMSET", 6365d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 6366d7c76ba7SJoe Perches } 6367d7c76ba7SJoe Perches } 6368d7c76ba7SJoe Perches 636998a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 63705b57980dSJoe Perches# if ($perl_version_ok && 6371f333195dSJoe Perches# defined $stat && 6372f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6373f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 6374f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 6375f333195dSJoe Perches# $fix) { 6376f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 6377f333195dSJoe Perches# } 6378f333195dSJoe Perches# } 637998a9bba5SJoe Perches 6380b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 63815b57980dSJoe Perches# if ($perl_version_ok && 6382f333195dSJoe Perches# defined $stat && 6383f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6384f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 6385f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 6386f333195dSJoe Perches# } 6387b6117d17SMateusz Kulikowski 63888617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 63898617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 63905b57980dSJoe Perches# if ($perl_version_ok && 6391f333195dSJoe Perches# defined $stat && 6392f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6393f333195dSJoe Perches# 6394f333195dSJoe Perches# my $ms_val = $7; 6395f333195dSJoe Perches# 6396f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 6397f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 6398f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 6399f333195dSJoe Perches# $fix) { 6400f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 6401f333195dSJoe Perches# } 6402f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 6403f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 6404f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 6405f333195dSJoe Perches# $fix) { 6406f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 6407f333195dSJoe Perches# } 6408f333195dSJoe Perches# } 6409f333195dSJoe Perches# } 64108617cd09SMateusz Kulikowski 6411d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 64125b57980dSJoe Perches if ($perl_version_ok && 6413d1fe9c09SJoe Perches defined $stat && 6414d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 6415d1fe9c09SJoe Perches if (defined $2 || defined $7) { 6416d7c76ba7SJoe Perches my $call = $1; 6417d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 6418d7c76ba7SJoe Perches my $arg1 = $3; 6419d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 6420d1fe9c09SJoe Perches my $arg2 = $8; 6421d7c76ba7SJoe Perches my $cast; 6422d7c76ba7SJoe Perches 6423d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 6424d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 6425d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 6426d7c76ba7SJoe Perches $cast = $cast1; 6427d7c76ba7SJoe Perches } else { 6428d7c76ba7SJoe Perches $cast = $cast2; 6429d7c76ba7SJoe Perches } 6430d7c76ba7SJoe Perches WARN("MINMAX", 6431d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 6432554e165cSAndy Whitcroft } 6433554e165cSAndy Whitcroft } 6434554e165cSAndy Whitcroft 64354a273195SJoe Perches# check usleep_range arguments 64365b57980dSJoe Perches if ($perl_version_ok && 64374a273195SJoe Perches defined $stat && 64384a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 64394a273195SJoe Perches my $min = $1; 64404a273195SJoe Perches my $max = $7; 64414a273195SJoe Perches if ($min eq $max) { 64424a273195SJoe Perches WARN("USLEEP_RANGE", 6443458f69efSMauro Carvalho Chehab "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 64444a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 64454a273195SJoe Perches $min > $max) { 64464a273195SJoe Perches WARN("USLEEP_RANGE", 6447458f69efSMauro Carvalho Chehab "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 64484a273195SJoe Perches } 64494a273195SJoe Perches } 64504a273195SJoe Perches 6451823b794cSJoe Perches# check for naked sscanf 64525b57980dSJoe Perches if ($perl_version_ok && 6453823b794cSJoe Perches defined $stat && 64546c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 6455823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 6456823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 6457823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 6458823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 6459823b794cSJoe Perches $lc = $lc + $linenr; 64602a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6461823b794cSJoe Perches WARN("NAKED_SSCANF", 6462823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 6463823b794cSJoe Perches } 6464823b794cSJoe Perches 6465afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 64665b57980dSJoe Perches if ($perl_version_ok && 6467afc819abSJoe Perches defined $stat && 6468afc819abSJoe Perches $line =~ /\bsscanf\b/) { 6469afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 6470afc819abSJoe Perches $lc = $lc + $linenr; 64712a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6472afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 6473afc819abSJoe Perches my $format = $6; 6474afc819abSJoe Perches my $count = $format =~ tr@%@%@; 6475afc819abSJoe Perches if ($count == 1 && 6476afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 6477afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 6478afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 6479afc819abSJoe Perches } 6480afc819abSJoe Perches } 6481afc819abSJoe Perches } 6482afc819abSJoe Perches 648370dc8a48SJoe Perches# check for new externs in .h files. 648470dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 648570dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 6486d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 648770dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 648870dc8a48SJoe Perches $fix) { 6489194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 649070dc8a48SJoe Perches } 649170dc8a48SJoe Perches } 649270dc8a48SJoe Perches 6493de7d4f0eSAndy Whitcroft# check for new externs in .c files. 6494171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 6495c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 6496171ae1a4SAndy Whitcroft { 6497c45dcabdSAndy Whitcroft my $function_name = $1; 6498c45dcabdSAndy Whitcroft my $paren_space = $2; 6499171ae1a4SAndy Whitcroft 6500171ae1a4SAndy Whitcroft my $s = $stat; 6501171ae1a4SAndy Whitcroft if (defined $cond) { 6502171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 6503171ae1a4SAndy Whitcroft } 6504d8b44b58SKees Cook if ($s =~ /^\s*;/) 6505c45dcabdSAndy Whitcroft { 6506000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6507000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6508de7d4f0eSAndy Whitcroft } 6509de7d4f0eSAndy Whitcroft 6510171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 6511000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 6512000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 6513171ae1a4SAndy Whitcroft } 65149c9ba34eSAndy Whitcroft 65159c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 65169c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 65179c9ba34eSAndy Whitcroft { 6518000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6519000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6520171ae1a4SAndy Whitcroft } 6521171ae1a4SAndy Whitcroft 6522a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 6523a0ad7596SJoe Perches if (defined $stat && 6524d8b44b58SKees Cook $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 6525d8b44b58SKees Cook $1 ne "void") { 6526d8b44b58SKees Cook my $args = trim($1); 6527ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6528ca0d8929SJoe Perches my $arg = trim($1); 6529d8b44b58SKees Cook if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 6530ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 6531ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6532ca0d8929SJoe Perches } 6533ca0d8929SJoe Perches } 6534ca0d8929SJoe Perches } 6535ca0d8929SJoe Perches 6536a0ad7596SJoe Perches# check for function definitions 65375b57980dSJoe Perches if ($perl_version_ok && 6538a0ad7596SJoe Perches defined $stat && 6539a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6540a0ad7596SJoe Perches $context_function = $1; 6541a0ad7596SJoe Perches 6542a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 6543a0ad7596SJoe Perches my $ok = 0; 6544a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 6545a0ad7596SJoe Perches my $herectx = $here . "\n"; 6546a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6547a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 6548a0ad7596SJoe Perches $herectx .= $rl . "\n"; 6549a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 6550a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 6551a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 6552a0ad7596SJoe Perches } 6553a0ad7596SJoe Perches if (!$ok) { 6554a0ad7596SJoe Perches ERROR("OPEN_BRACE", 6555a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 6556a0ad7596SJoe Perches } 6557a0ad7596SJoe Perches } 6558a0ad7596SJoe Perches 6559de7d4f0eSAndy Whitcroft# checks for new __setup's 6560de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 6561de7d4f0eSAndy Whitcroft my $name = $1; 6562de7d4f0eSAndy Whitcroft 6563de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 6564000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 65652581ac7cSTim Froidcoeur "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr); 6566de7d4f0eSAndy Whitcroft } 6567653d4876SAndy Whitcroft } 65689c0ca6f9SAndy Whitcroft 6569e29a70f1SJoe Perches# check for pointless casting of alloc functions 6570e29a70f1SJoe Perches if ($line =~ /\*\s*\)\s*$allocFunctions\b/) { 6571000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 6572000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 65739c0ca6f9SAndy Whitcroft } 657413214adfSAndy Whitcroft 6575a640d25cSJoe Perches# alloc style 6576a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 65775b57980dSJoe Perches if ($perl_version_ok && 6578e29a70f1SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 6579a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 6580a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 6581a640d25cSJoe Perches } 6582a640d25cSJoe Perches 658360a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 65845b57980dSJoe Perches if ($perl_version_ok && 65851b4a2ed4SJoe Perches defined $stat && 65861b4a2ed4SJoe Perches $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 658760a55369SJoe Perches my $oldfunc = $3; 658860a55369SJoe Perches my $a1 = $4; 658960a55369SJoe Perches my $a2 = $10; 659060a55369SJoe Perches my $newfunc = "kmalloc_array"; 659160a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 659260a55369SJoe Perches my $r1 = $a1; 659360a55369SJoe Perches my $r2 = $a2; 659460a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 659560a55369SJoe Perches $r1 = $a2; 659660a55369SJoe Perches $r2 = $a1; 659760a55369SJoe Perches } 6598e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 6599e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 66001b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 6601e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6602e3d95a2aSTobin C. Harding 6603e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 66041b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 66051b4a2ed4SJoe Perches $cnt == 1 && 6606e367455aSJoe Perches $fix) { 6607194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e; 660860a55369SJoe Perches } 660960a55369SJoe Perches } 661060a55369SJoe Perches } 661160a55369SJoe Perches 6612972fdea2SJoe Perches# check for krealloc arg reuse 66135b57980dSJoe Perches if ($perl_version_ok && 66144cab63ceSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ && 66154cab63ceSJoe Perches $1 eq $3) { 6616972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 6617972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 6618972fdea2SJoe Perches } 6619972fdea2SJoe Perches 66205ce59ae0SJoe Perches# check for alloc argument mismatch 66215ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 66225ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 66235ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 66245ce59ae0SJoe Perches } 66255ce59ae0SJoe Perches 6626caf2a54fSJoe Perches# check for multiple semicolons 6627caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 6628d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 6629d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 6630d5e616fcSJoe Perches $fix) { 6631194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 6632d5e616fcSJoe Perches } 6633d1e2ad07SJoe Perches } 6634d1e2ad07SJoe Perches 6635cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 6636cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 6637cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 66380ab90191SJoe Perches my $ull = ""; 66390ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 66400ab90191SJoe Perches if (CHK("BIT_MACRO", 66410ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 66420ab90191SJoe Perches $fix) { 66430ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 66440ab90191SJoe Perches } 66450ab90191SJoe Perches } 66460ab90191SJoe Perches 664750161266SJoe Perches# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too) 66483e89ad85SJerome Forissier if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) { 664950161266SJoe Perches WARN("IS_ENABLED_CONFIG", 66503e89ad85SJerome Forissier "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr); 665150161266SJoe Perches } 665250161266SJoe Perches 66532d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 66543e89ad85SJerome 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*$/) { 66552d632745SJoe Perches my $config = $1; 66562d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 66573e89ad85SJerome Forissier "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) && 66582d632745SJoe Perches $fix) { 66592d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 66602d632745SJoe Perches } 66612d632745SJoe Perches } 66622d632745SJoe Perches 6663f36d3eb8SJoe Perches# check for /* fallthrough */ like comment, prefer fallthrough; 6664f36d3eb8SJoe Perches my @fallthroughs = ( 6665f36d3eb8SJoe Perches 'fallthrough', 6666f36d3eb8SJoe Perches '@fallthrough@', 6667f36d3eb8SJoe Perches 'lint -fallthrough[ \t]*', 6668f36d3eb8SJoe Perches 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)', 6669f36d3eb8SJoe Perches '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?', 6670f36d3eb8SJoe Perches 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 6671f36d3eb8SJoe Perches 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 6672f36d3eb8SJoe Perches ); 6673f36d3eb8SJoe Perches if ($raw_comment ne '') { 6674f36d3eb8SJoe Perches foreach my $ft (@fallthroughs) { 6675f36d3eb8SJoe Perches if ($raw_comment =~ /$ft/) { 6676f36d3eb8SJoe Perches my $msg_level = \&WARN; 6677f36d3eb8SJoe Perches $msg_level = \&CHK if ($file); 6678f36d3eb8SJoe Perches &{$msg_level}("PREFER_FALLTHROUGH", 6679f36d3eb8SJoe Perches "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr); 6680f36d3eb8SJoe Perches last; 6681f36d3eb8SJoe Perches } 6682f36d3eb8SJoe Perches } 6683f36d3eb8SJoe Perches } 6684f36d3eb8SJoe Perches 6685d1e2ad07SJoe Perches# check for switch/default statements without a break; 66865b57980dSJoe Perches if ($perl_version_ok && 6687d1e2ad07SJoe Perches defined $stat && 6688d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 6689d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 6690e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6691e3d95a2aSTobin C. Harding 6692d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 6693d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 6694caf2a54fSJoe Perches } 6695caf2a54fSJoe Perches 669613214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 6697d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 6698d5e616fcSJoe Perches if (WARN("USE_FUNC", 6699d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 6700d5e616fcSJoe Perches $fix) { 6701194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 6702d5e616fcSJoe Perches } 670313214adfSAndy Whitcroft } 6704773647a0SAndy Whitcroft 670562ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 670662ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 670762ec818fSJoe Perches ERROR("DATE_TIME", 670862ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 670962ec818fSJoe Perches } 671062ec818fSJoe Perches 67112c92488aSJoe Perches# check for use of yield() 67122c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 67132c92488aSJoe Perches WARN("YIELD", 67142c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 67152c92488aSJoe Perches } 67162c92488aSJoe Perches 6717179f8f40SJoe Perches# check for comparisons against true and false 6718179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 6719179f8f40SJoe Perches my $lead = $1; 6720179f8f40SJoe Perches my $arg = $2; 6721179f8f40SJoe Perches my $test = $3; 6722179f8f40SJoe Perches my $otype = $4; 6723179f8f40SJoe Perches my $trail = $5; 6724179f8f40SJoe Perches my $op = "!"; 6725179f8f40SJoe Perches 6726179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 6727179f8f40SJoe Perches 6728179f8f40SJoe Perches my $type = lc($otype); 6729179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 6730179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 6731179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 6732179f8f40SJoe Perches $op = ""; 6733179f8f40SJoe Perches } 6734179f8f40SJoe Perches 6735179f8f40SJoe Perches CHK("BOOL_COMPARISON", 6736179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 6737179f8f40SJoe Perches 6738179f8f40SJoe Perches## maybe suggesting a correct construct would better 6739179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 6740179f8f40SJoe Perches 6741179f8f40SJoe Perches } 6742179f8f40SJoe Perches } 6743179f8f40SJoe Perches 67444882720bSThomas Gleixner# check for semaphores initialized locked 67454882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 6746000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 6747000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 6748773647a0SAndy Whitcroft } 67496712d858SJoe Perches 675067d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 675167d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 6752000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 675367d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 6754773647a0SAndy Whitcroft } 67556712d858SJoe Perches 6756ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 6757f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 6758000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 6759ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 6760f3db6639SMichael Ellerman } 67616712d858SJoe Perches 67623d709ab5SPaul E. McKenney# check for spin_is_locked(), suggest lockdep instead 67633d709ab5SPaul E. McKenney if ($line =~ /\bspin_is_locked\(/) { 67643d709ab5SPaul E. McKenney WARN("USE_LOCKDEP", 67653d709ab5SPaul E. McKenney "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr); 67663d709ab5SPaul E. McKenney } 67673d709ab5SPaul E. McKenney 67689189c7e7SJoe Perches# check for deprecated apis 67699189c7e7SJoe Perches if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) { 67709189c7e7SJoe Perches my $deprecated_api = $1; 67719189c7e7SJoe Perches my $new_api = $deprecated_apis{$deprecated_api}; 67729189c7e7SJoe Perches WARN("DEPRECATED_API", 67739189c7e7SJoe Perches "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr); 67749189c7e7SJoe Perches } 67759189c7e7SJoe Perches 67760f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 6777d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 6778ced69da1SQuentin Monnet if (defined($const_structs) && 6779ced69da1SQuentin Monnet $line !~ /\bconst\b/ && 6780d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 6781000d1cc1SJoe Perches WARN("CONST_STRUCT", 6782d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 67832b6db5cbSAndy Whitcroft } 6784773647a0SAndy Whitcroft 6785773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 6786773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 6787773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 6788c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 6789c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 6790171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 6791171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 6792171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 6793773647a0SAndy Whitcroft { 6794000d1cc1SJoe Perches WARN("NR_CPUS", 6795000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 6796773647a0SAndy Whitcroft } 67979c9ba34eSAndy Whitcroft 679852ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 679952ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 680052ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 680152ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 680252ea8506SJoe Perches } 680352ea8506SJoe Perches 6804acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 68055b57980dSJoe Perches if ($perl_version_ok && 6806acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 6807acd9362cSJoe Perches WARN("LIKELY_MISUSE", 6808acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 6809acd9362cSJoe Perches } 6810acd9362cSJoe Perches 6811de3f186fSDenis Efremov# nested likely/unlikely calls 6812de3f186fSDenis Efremov if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) { 6813de3f186fSDenis Efremov WARN("LIKELY_MISUSE", 6814de3f186fSDenis Efremov "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr); 6815de3f186fSDenis Efremov } 6816de3f186fSDenis Efremov 6817691d77b6SAndy Whitcroft# whine mightly about in_atomic 6818691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 6819691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 6820000d1cc1SJoe Perches ERROR("IN_ATOMIC", 6821000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 6822f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 6823000d1cc1SJoe Perches WARN("IN_ATOMIC", 6824000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 6825691d77b6SAndy Whitcroft } 6826691d77b6SAndy Whitcroft } 68271704f47bSPeter Zijlstra 68280f5225b0SPeter Zijlstra# check for mutex_trylock_recursive usage 68290f5225b0SPeter Zijlstra if ($line =~ /mutex_trylock_recursive/) { 68300f5225b0SPeter Zijlstra ERROR("LOCKING", 68310f5225b0SPeter Zijlstra "recursive locking is bad, do not use this ever.\n" . $herecurr); 68320f5225b0SPeter Zijlstra } 68330f5225b0SPeter Zijlstra 68341704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 68351704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 68361704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 68371704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 68381704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 68391704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 6840000d1cc1SJoe Perches ERROR("LOCKDEP", 6841000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 68421704f47bSPeter Zijlstra } 68431704f47bSPeter Zijlstra } 684488f8831cSDave Jones 6845b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 6846b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 6847000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 6848000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 684988f8831cSDave Jones } 68502435880fSJoe Perches 685100180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 685200180468SJoe Perches# and whether or not function naming is typical and if 685300180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 68545b57980dSJoe Perches if ($perl_version_ok && 685500180468SJoe Perches defined $stat && 685600180468SJoe 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*\)/) { 685700180468SJoe Perches my $var = $1; 685800180468SJoe Perches my $perms = $2; 685900180468SJoe Perches my $show = $3; 686000180468SJoe Perches my $store = $4; 686100180468SJoe Perches my $octal_perms = perms_to_octal($perms); 686200180468SJoe Perches if ($show =~ /^${var}_show$/ && 686300180468SJoe Perches $store =~ /^${var}_store$/ && 686400180468SJoe Perches $octal_perms eq "0644") { 686500180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 686600180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 686700180468SJoe Perches $fix) { 686800180468SJoe 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})/; 686900180468SJoe Perches } 687000180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 687100180468SJoe Perches $store =~ /^NULL$/ && 687200180468SJoe Perches $octal_perms eq "0444") { 687300180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 687400180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 687500180468SJoe Perches $fix) { 687600180468SJoe 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})/; 687700180468SJoe Perches } 687800180468SJoe Perches } elsif ($show =~ /^NULL$/ && 687900180468SJoe Perches $store =~ /^${var}_store$/ && 688000180468SJoe Perches $octal_perms eq "0200") { 688100180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 688200180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 688300180468SJoe Perches $fix) { 688400180468SJoe 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})/; 688500180468SJoe Perches } 688600180468SJoe Perches } elsif ($octal_perms eq "0644" || 688700180468SJoe Perches $octal_perms eq "0444" || 688800180468SJoe Perches $octal_perms eq "0200") { 688900180468SJoe Perches my $newshow = "$show"; 689000180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 689100180468SJoe Perches my $newstore = $store; 689200180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 689300180468SJoe Perches my $rename = ""; 689400180468SJoe Perches if ($show ne $newshow) { 689500180468SJoe Perches $rename .= " '$show' to '$newshow'"; 689600180468SJoe Perches } 689700180468SJoe Perches if ($store ne $newstore) { 689800180468SJoe Perches $rename .= " '$store' to '$newstore'"; 689900180468SJoe Perches } 690000180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 690100180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 690200180468SJoe Perches } else { 690300180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 690400180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 690500180468SJoe Perches } 690600180468SJoe Perches } 690700180468SJoe Perches 6908515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 6909515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 691073121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 691173121534SJoe Perches# specific definition of not visible in sysfs. 691273121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 691373121534SJoe Perches# use the default permissions 69145b57980dSJoe Perches if ($perl_version_ok && 6915459cf0aeSJoe Perches defined $stat && 6916515a235eSJoe Perches $line =~ /$mode_perms_search/) { 69172435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 69182435880fSJoe Perches my $func = $entry->[0]; 69192435880fSJoe Perches my $arg_pos = $entry->[1]; 69202435880fSJoe Perches 6921459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 6922459cf0aeSJoe Perches $lc = $lc + $linenr; 69232a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6924459cf0aeSJoe Perches 69252435880fSJoe Perches my $skip_args = ""; 69262435880fSJoe Perches if ($arg_pos > 1) { 69272435880fSJoe Perches $arg_pos--; 69282435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 69292435880fSJoe Perches } 6930f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 6931459cf0aeSJoe Perches if ($stat =~ /$test/) { 69322435880fSJoe Perches my $val = $1; 69332435880fSJoe Perches $val = $6 if ($skip_args ne ""); 693473121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 693573121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 693673121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 69372435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 6938459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 6939f90774e1SJoe Perches } 6940f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6941c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6942459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 69432435880fSJoe Perches } 6944459cf0aeSJoe Perches } 6945459cf0aeSJoe Perches } 6946459cf0aeSJoe Perches } 6947459cf0aeSJoe Perches 6948459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 6949bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 695000180468SJoe Perches my $oval = $1; 695100180468SJoe Perches my $octal = perms_to_octal($oval); 6952f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 6953459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 6954f90774e1SJoe Perches $fix) { 695500180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 69562435880fSJoe Perches } 695713214adfSAndy Whitcroft } 69585a6d20ceSBjorn Andersson 69595a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 69605a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 69615a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 69625a6d20ceSBjorn Andersson my $valid_licenses = qr{ 69635a6d20ceSBjorn Andersson GPL| 69645a6d20ceSBjorn Andersson GPL\ v2| 69655a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 69665a6d20ceSBjorn Andersson Dual\ BSD/GPL| 69675a6d20ceSBjorn Andersson Dual\ MIT/GPL| 69685a6d20ceSBjorn Andersson Dual\ MPL/GPL| 69695a6d20ceSBjorn Andersson Proprietary 69705a6d20ceSBjorn Andersson }x; 69715a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 69725a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 69735a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 69745a6d20ceSBjorn Andersson } 69755a6d20ceSBjorn Andersson } 69766a8d76cbSMatteo Croce 69776a8d76cbSMatteo Croce# check for sysctl duplicate constants 69786a8d76cbSMatteo Croce if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) { 69796a8d76cbSMatteo Croce WARN("DUPLICATED_SYSCTL_CONST", 69806a8d76cbSMatteo Croce "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr); 69816a8d76cbSMatteo Croce } 6982515a235eSJoe Perches } 698313214adfSAndy Whitcroft 698413214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 698513214adfSAndy Whitcroft # so just keep quiet. 698613214adfSAndy Whitcroft if ($#rawlines == -1) { 698713214adfSAndy Whitcroft exit(0); 69880a920b5bSAndy Whitcroft } 69890a920b5bSAndy Whitcroft 69908905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 69918905a67cSAndy Whitcroft # things that appear to be patches. 69928905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 69938905a67cSAndy Whitcroft exit(0); 69948905a67cSAndy Whitcroft } 69958905a67cSAndy Whitcroft 69968905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 69978905a67cSAndy Whitcroft # just keep quiet. 69988905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 69998905a67cSAndy Whitcroft exit(0); 70008905a67cSAndy Whitcroft } 70018905a67cSAndy Whitcroft 7002a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 7003000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 7004000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 70050a920b5bSAndy Whitcroft } 7006cd261496SGeert Uytterhoeven if ($is_patch && $has_commit_log && $chk_signoff) { 7007cd261496SGeert Uytterhoeven if ($signoff == 0) { 7008000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 7009000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 701048ca2d8aSDwaipayan Ray } elsif ($authorsignoff != 1) { 701148ca2d8aSDwaipayan Ray # authorsignoff values: 701248ca2d8aSDwaipayan Ray # 0 -> missing sign off 701348ca2d8aSDwaipayan Ray # 1 -> sign off identical 701448ca2d8aSDwaipayan Ray # 2 -> names and addresses match, comments mismatch 701548ca2d8aSDwaipayan Ray # 3 -> addresses match, names different 701648ca2d8aSDwaipayan Ray # 4 -> names match, addresses different 701748ca2d8aSDwaipayan Ray # 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match 701848ca2d8aSDwaipayan Ray 701948ca2d8aSDwaipayan Ray my $sob_msg = "'From: $author' != 'Signed-off-by: $author_sob'"; 702048ca2d8aSDwaipayan Ray 702148ca2d8aSDwaipayan Ray if ($authorsignoff == 0) { 702248ca2d8aSDwaipayan Ray ERROR("NO_AUTHOR_SIGN_OFF", 7023cd261496SGeert Uytterhoeven "Missing Signed-off-by: line by nominal patch author '$author'\n"); 702448ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 2) { 702548ca2d8aSDwaipayan Ray CHK("FROM_SIGN_OFF_MISMATCH", 702648ca2d8aSDwaipayan Ray "From:/Signed-off-by: email comments mismatch: $sob_msg\n"); 702748ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 3) { 702848ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 702948ca2d8aSDwaipayan Ray "From:/Signed-off-by: email name mismatch: $sob_msg\n"); 703048ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 4) { 703148ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 703248ca2d8aSDwaipayan Ray "From:/Signed-off-by: email address mismatch: $sob_msg\n"); 703348ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 5) { 703448ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 703548ca2d8aSDwaipayan Ray "From:/Signed-off-by: email subaddress mismatch: $sob_msg\n"); 703648ca2d8aSDwaipayan Ray } 7037cd261496SGeert Uytterhoeven } 70380a920b5bSAndy Whitcroft } 70390a920b5bSAndy Whitcroft 7040f0a594c1SAndy Whitcroft print report_dump(); 704113214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 704213214adfSAndy Whitcroft print "$filename " if ($summary_file); 70436c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 70446c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 70456c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 70466c72ffaaSAndy Whitcroft } 70478905a67cSAndy Whitcroft 7048d2c0a235SAndy Whitcroft if ($quiet == 0) { 7049ef212196SJoe Perches # If there were any defects found and not already fixing them 7050ef212196SJoe Perches if (!$clean and !$fix) { 7051ef212196SJoe Perches print << "EOM" 7052ef212196SJoe Perches 7053ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 7054ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 7055ef212196SJoe PerchesEOM 7056ef212196SJoe Perches } 7057d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 7058d2c0a235SAndy Whitcroft # then suggest that. 7059d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 7060b0781216SMike Frysinger $rpt_cleaners = 0; 7061d8469f16SJoe Perches print << "EOM" 7062d8469f16SJoe Perches 7063d8469f16SJoe PerchesNOTE: Whitespace errors detected. 7064d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 7065d8469f16SJoe PerchesEOM 7066d2c0a235SAndy Whitcroft } 7067d2c0a235SAndy Whitcroft } 7068d2c0a235SAndy Whitcroft 7069d752fcc8SJoe Perches if ($clean == 0 && $fix && 7070d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 7071d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 70729624b8d6SJoe Perches my $newfile = $filename; 70739624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 70743705ce5bSJoe Perches my $linecount = 0; 70753705ce5bSJoe Perches my $f; 70763705ce5bSJoe Perches 7077d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 7078d752fcc8SJoe Perches 70793705ce5bSJoe Perches open($f, '>', $newfile) 70803705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 70813705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 70823705ce5bSJoe Perches $linecount++; 70833705ce5bSJoe Perches if ($file) { 70843705ce5bSJoe Perches if ($linecount > 3) { 70853705ce5bSJoe Perches $fixed_line =~ s/^\+//; 70863705ce5bSJoe Perches print $f $fixed_line . "\n"; 70873705ce5bSJoe Perches } 70883705ce5bSJoe Perches } else { 70893705ce5bSJoe Perches print $f $fixed_line . "\n"; 70903705ce5bSJoe Perches } 70913705ce5bSJoe Perches } 70923705ce5bSJoe Perches close($f); 70933705ce5bSJoe Perches 70943705ce5bSJoe Perches if (!$quiet) { 70953705ce5bSJoe Perches print << "EOM"; 7096d8469f16SJoe Perches 70973705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 70983705ce5bSJoe Perches 70993705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 71003705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 71013705ce5bSJoe Perches 71023705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 71033705ce5bSJoe PerchesNo warranties, expressed or implied... 71043705ce5bSJoe PerchesEOM 71053705ce5bSJoe Perches } 71063705ce5bSJoe Perches } 71073705ce5bSJoe Perches 7108d8469f16SJoe Perches if ($quiet == 0) { 7109d8469f16SJoe Perches print "\n"; 7110d8469f16SJoe Perches if ($clean == 1) { 7111d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 7112d8469f16SJoe Perches } else { 7113d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 71140a920b5bSAndy Whitcroft } 71150a920b5bSAndy Whitcroft } 71160a920b5bSAndy Whitcroft return $clean; 71170a920b5bSAndy Whitcroft} 7118