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; 46c2fdda0dSAndy Whitcroftmy %debug; 473445686aSJoe Perchesmy %camelcase = (); 4891bfe484SJoe Perchesmy %use_type = (); 4991bfe484SJoe Perchesmy @use = (); 5091bfe484SJoe Perchesmy %ignore_type = (); 51000d1cc1SJoe Perchesmy @ignore = (); 5277f5b10aSHannes Edermy $help = 0; 53000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 54bdc48fa1SJoe Perchesmy $max_line_length = 100; 55d62a201fSDave Hansenmy $ignore_perl_version = 0; 56d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 5756193274SVadim Bendeburymy $min_conf_desc_length = 4; 5866b47b4aSKees Cookmy $spelling_file = "$D/spelling.txt"; 59ebfd7d62SJoe Perchesmy $codespell = 0; 60f1a63678SMaxim Uvarovmy $codespellfile = "/usr/share/codespell/dictionary.txt"; 61bf1fa1daSJoe Perchesmy $conststructsfile = "$D/const_structs.checkpatch"; 62ced69da1SQuentin Monnetmy $typedefsfile; 63737c0767SJohn Brooksmy $color = "auto"; 6498005e8cSVadim Bendeburymy $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE 65dbbf869dSJoe Perches# git output parsing needs US English output, so first set backtick child process LANGUAGE 66dbbf869dSJoe Perchesmy $git_command ='export LANGUAGE=en_US.UTF-8; git'; 67713a09deSAntonio Borneomy $tabsize = 8; 683e89ad85SJerome Forissiermy ${CONFIG_} = "CONFIG_"; 6977f5b10aSHannes Eder 7077f5b10aSHannes Edersub help { 7177f5b10aSHannes Eder my ($exitcode) = @_; 7277f5b10aSHannes Eder 7377f5b10aSHannes Eder print << "EOM"; 7477f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 7577f5b10aSHannes EderVersion: $V 7677f5b10aSHannes Eder 7777f5b10aSHannes EderOptions: 7877f5b10aSHannes Eder -q, --quiet quiet 7977f5b10aSHannes Eder --no-tree run without a kernel tree 8077f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 8177f5b10aSHannes Eder --patch treat FILE as patchfile (default) 8277f5b10aSHannes Eder --emacs emacs compile window format 8377f5b10aSHannes Eder --terse one line per report 8434d8815fSJoe Perches --showfile emit diffed file position, not input file position 854a593c34SDu, Changbin -g, --git treat FILE as a single commit or git revision range 864a593c34SDu, Changbin single git commit with: 874a593c34SDu, Changbin <rev> 884a593c34SDu, Changbin <rev>^ 894a593c34SDu, Changbin <rev>~n 904a593c34SDu, Changbin multiple git commits with: 914a593c34SDu, Changbin <rev1>..<rev2> 924a593c34SDu, Changbin <rev1>...<rev2> 934a593c34SDu, Changbin <rev>-<count> 944a593c34SDu, Changbin git merges are ignored 9577f5b10aSHannes Eder -f, --file treat FILE as regular source file 9677f5b10aSHannes Eder --subjective, --strict enable more subjective tests 973beb42ecSJoe Perches --list-types list the possible message types 9891bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 99000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 1003beb42ecSJoe Perches --show-types show the specific message type in the output 101bdc48fa1SJoe Perches --max-line-length=n set the maximum line length, (default $max_line_length) 102bdc48fa1SJoe Perches if exceeded, warn on patches 103bdc48fa1SJoe Perches requires --strict for use with --file 10456193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 105bdc48fa1SJoe Perches --tab-size=n set the number of spaces for tab (default $tabsize) 10677f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 10777f5b10aSHannes Eder --no-summary suppress the per-file summary 10877f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 10977f5b10aSHannes Eder --summary-file include the filename in summary 11077f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 11177f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 11277f5b10aSHannes Eder is all off) 11377f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 11477f5b10aSHannes Eder literally 1153705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 1163705ce5bSJoe Perches If correctable single-line errors exist, create 1173705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 1183705ce5bSJoe Perches with potential errors corrected to the preferred 1193705ce5bSJoe Perches checkpatch style 1209624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 1219624b8d6SJoe Perches Is the same as --fix, but overwrites the input 1229624b8d6SJoe Perches file. It's your fault if there's no backup or git 123d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 124d62a201fSDave Hansen runtime errors. 125ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 126f1a63678SMaxim Uvarov (default:/usr/share/codespell/dictionary.txt) 127ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 12875ad8c57SJerome Forissier --typedefsfile Read additional types from this file 129737c0767SJohn Brooks --color[=WHEN] Use colors 'always', 'never', or only when output 130737c0767SJohn Brooks is a terminal ('auto'). Default is 'auto'. 1313e89ad85SJerome Forissier --kconfig-prefix=WORD use WORD as a prefix for Kconfig symbols (default 1323e89ad85SJerome Forissier ${CONFIG_}) 13377f5b10aSHannes Eder -h, --help, --version display this help and exit 13477f5b10aSHannes Eder 13577f5b10aSHannes EderWhen FILE is - read standard input. 13677f5b10aSHannes EderEOM 13777f5b10aSHannes Eder 13877f5b10aSHannes Eder exit($exitcode); 13977f5b10aSHannes Eder} 14077f5b10aSHannes Eder 1413beb42ecSJoe Perchessub uniq { 1423beb42ecSJoe Perches my %seen; 1433beb42ecSJoe Perches return grep { !$seen{$_}++ } @_; 1443beb42ecSJoe Perches} 1453beb42ecSJoe Perches 1463beb42ecSJoe Perchessub list_types { 1473beb42ecSJoe Perches my ($exitcode) = @_; 1483beb42ecSJoe Perches 1493beb42ecSJoe Perches my $count = 0; 1503beb42ecSJoe Perches 1513beb42ecSJoe Perches local $/ = undef; 1523beb42ecSJoe Perches 1533beb42ecSJoe Perches open(my $script, '<', abs_path($P)) or 1543beb42ecSJoe Perches die "$P: Can't read '$P' $!\n"; 1553beb42ecSJoe Perches 1563beb42ecSJoe Perches my $text = <$script>; 1573beb42ecSJoe Perches close($script); 1583beb42ecSJoe Perches 1593beb42ecSJoe Perches my @types = (); 1600547fa58SJean Delvare # Also catch when type or level is passed through a variable 1610547fa58SJean Delvare for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) { 1623beb42ecSJoe Perches push (@types, $_); 1633beb42ecSJoe Perches } 1643beb42ecSJoe Perches @types = sort(uniq(@types)); 1653beb42ecSJoe Perches print("#\tMessage type\n\n"); 1663beb42ecSJoe Perches foreach my $type (@types) { 1673beb42ecSJoe Perches print(++$count . "\t" . $type . "\n"); 1683beb42ecSJoe Perches } 1693beb42ecSJoe Perches 1703beb42ecSJoe Perches exit($exitcode); 1713beb42ecSJoe Perches} 1723beb42ecSJoe Perches 173000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 174000d1cc1SJoe Perchesif (-f $conf) { 175000d1cc1SJoe Perches my @conf_args; 176000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 177000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 178000d1cc1SJoe Perches 179000d1cc1SJoe Perches while (<$conffile>) { 180000d1cc1SJoe Perches my $line = $_; 181000d1cc1SJoe Perches 182000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 183000d1cc1SJoe Perches $line =~ s/^\s*//g; 184000d1cc1SJoe Perches $line =~ s/\s+/ /g; 185000d1cc1SJoe Perches 186000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 187000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 188000d1cc1SJoe Perches 189000d1cc1SJoe Perches my @words = split(" ", $line); 190000d1cc1SJoe Perches foreach my $word (@words) { 191000d1cc1SJoe Perches last if ($word =~ m/^#/); 192000d1cc1SJoe Perches push (@conf_args, $word); 193000d1cc1SJoe Perches } 194000d1cc1SJoe Perches } 195000d1cc1SJoe Perches close($conffile); 196000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 197000d1cc1SJoe Perches} 198000d1cc1SJoe Perches 199737c0767SJohn Brooks# Perl's Getopt::Long allows options to take optional arguments after a space. 200737c0767SJohn Brooks# Prevent --color by itself from consuming other arguments 201737c0767SJohn Brooksforeach (@ARGV) { 202737c0767SJohn Brooks if ($_ eq "--color" || $_ eq "-color") { 203737c0767SJohn Brooks $_ = "--color=$color"; 204737c0767SJohn Brooks } 205737c0767SJohn Brooks} 206737c0767SJohn Brooks 2070a920b5bSAndy WhitcroftGetOptions( 2086c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 2090a920b5bSAndy Whitcroft 'tree!' => \$tree, 2100a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 2110a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 2126c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 2138905a67cSAndy Whitcroft 'terse!' => \$terse, 21434d8815fSJoe Perches 'showfile!' => \$showfile, 21577f5b10aSHannes Eder 'f|file!' => \$file, 2164a593c34SDu, Changbin 'g|git!' => \$git, 2176c72ffaaSAndy Whitcroft 'subjective!' => \$check, 2186c72ffaaSAndy Whitcroft 'strict!' => \$check, 219000d1cc1SJoe Perches 'ignore=s' => \@ignore, 22091bfe484SJoe Perches 'types=s' => \@use, 221000d1cc1SJoe Perches 'show-types!' => \$show_types, 2223beb42ecSJoe Perches 'list-types!' => \$list_types, 2236cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 22456193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 225713a09deSAntonio Borneo 'tab-size=i' => \$tabsize, 2266c72ffaaSAndy Whitcroft 'root=s' => \$root, 2278905a67cSAndy Whitcroft 'summary!' => \$summary, 2288905a67cSAndy Whitcroft 'mailback!' => \$mailback, 22913214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 2303705ce5bSJoe Perches 'fix!' => \$fix, 2319624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 232d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 233c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 234773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 235ebfd7d62SJoe Perches 'codespell!' => \$codespell, 236ebfd7d62SJoe Perches 'codespellfile=s' => \$codespellfile, 23775ad8c57SJerome Forissier 'typedefsfile=s' => \$typedefsfile, 238737c0767SJohn Brooks 'color=s' => \$color, 239737c0767SJohn Brooks 'no-color' => \$color, #keep old behaviors of -nocolor 240737c0767SJohn Brooks 'nocolor' => \$color, #keep old behaviors of -nocolor 2413e89ad85SJerome Forissier 'kconfig-prefix=s' => \${CONFIG_}, 24277f5b10aSHannes Eder 'h|help' => \$help, 24377f5b10aSHannes Eder 'version' => \$help 24477f5b10aSHannes Eder) or help(1); 24577f5b10aSHannes Eder 24677f5b10aSHannes Ederhelp(0) if ($help); 2470a920b5bSAndy Whitcroft 2483beb42ecSJoe Percheslist_types(0) if ($list_types); 2493beb42ecSJoe Perches 2509624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 2512ac73b4fSJoe Perches$check_orig = $check; 2529624b8d6SJoe Perches 25332f30ca9SJoe Perchesdie "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix)); 25432f30ca9SJoe Perches 2550a920b5bSAndy Whitcroftmy $exit = 0; 2560a920b5bSAndy Whitcroft 2575b57980dSJoe Perchesmy $perl_version_ok = 1; 258d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 2595b57980dSJoe Perches $perl_version_ok = 0; 260d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 2615b57980dSJoe Perches exit(1) if (!$ignore_perl_version); 262d62a201fSDave Hansen} 263d62a201fSDave Hansen 26445107ff6SAllen Hubbe#if no filenames are given, push '-' to read patch from stdin 2650a920b5bSAndy Whitcroftif ($#ARGV < 0) { 26645107ff6SAllen Hubbe push(@ARGV, '-'); 2670a920b5bSAndy Whitcroft} 2680a920b5bSAndy Whitcroft 269737c0767SJohn Brooksif ($color =~ /^[01]$/) { 270737c0767SJohn Brooks $color = !$color; 271737c0767SJohn Brooks} elsif ($color =~ /^always$/i) { 272737c0767SJohn Brooks $color = 1; 273737c0767SJohn Brooks} elsif ($color =~ /^never$/i) { 274737c0767SJohn Brooks $color = 0; 275737c0767SJohn Brooks} elsif ($color =~ /^auto$/i) { 276737c0767SJohn Brooks $color = (-t STDOUT); 277737c0767SJohn Brooks} else { 27832f30ca9SJoe Perches die "$P: Invalid color mode: $color\n"; 279737c0767SJohn Brooks} 280737c0767SJohn Brooks 281713a09deSAntonio Borneo# skip TAB size 1 to avoid additional checks on $tabsize - 1 28232f30ca9SJoe Perchesdie "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2); 283713a09deSAntonio Borneo 28491bfe484SJoe Perchessub hash_save_array_words { 28591bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 28691bfe484SJoe Perches 28791bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 28891bfe484SJoe Perches foreach my $word (@array) { 289000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 290000d1cc1SJoe Perches $word =~ s/^\s*//g; 291000d1cc1SJoe Perches $word =~ s/\s+/ /g; 292000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 293000d1cc1SJoe Perches 294000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 295000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 296000d1cc1SJoe Perches 29791bfe484SJoe Perches $hashRef->{$word}++; 298000d1cc1SJoe Perches } 29991bfe484SJoe Perches} 30091bfe484SJoe Perches 30191bfe484SJoe Perchessub hash_show_words { 30291bfe484SJoe Perches my ($hashRef, $prefix) = @_; 30391bfe484SJoe Perches 3043c816e49SJoe Perches if (keys %$hashRef) { 305d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 30658cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 30791bfe484SJoe Perches print " $word"; 30891bfe484SJoe Perches } 309d8469f16SJoe Perches print "\n"; 31091bfe484SJoe Perches } 31191bfe484SJoe Perches} 31291bfe484SJoe Perches 31391bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 31491bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 315000d1cc1SJoe Perches 316c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 317c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 3187429c690SAndy Whitcroftmy $dbg_type = 0; 319a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 320c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 32121caa13cSAndy Whitcroft ## no critic 32221caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 32321caa13cSAndy Whitcroft die "$@" if ($@); 324c2fdda0dSAndy Whitcroft} 325c2fdda0dSAndy Whitcroft 326d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 327d2c0a235SAndy Whitcroft 3288905a67cSAndy Whitcroftif ($terse) { 3298905a67cSAndy Whitcroft $emacs = 1; 3308905a67cSAndy Whitcroft $quiet++; 3318905a67cSAndy Whitcroft} 3328905a67cSAndy Whitcroft 3336c72ffaaSAndy Whitcroftif ($tree) { 3346c72ffaaSAndy Whitcroft if (defined $root) { 3356c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 3366c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 3376c72ffaaSAndy Whitcroft } 3386c72ffaaSAndy Whitcroft } else { 3396c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 3406c72ffaaSAndy Whitcroft $root = '.'; 3416c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 3426c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 3436c72ffaaSAndy Whitcroft $root = $1; 3446c72ffaaSAndy Whitcroft } 3456c72ffaaSAndy Whitcroft } 3466c72ffaaSAndy Whitcroft 3476c72ffaaSAndy Whitcroft if (!defined $root) { 3480a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 3490a920b5bSAndy Whitcroft exit(2); 3500a920b5bSAndy Whitcroft } 3516c72ffaaSAndy Whitcroft} 3526c72ffaaSAndy Whitcroft 3536c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 3546c72ffaaSAndy Whitcroft 3552ceb532bSAndy Whitcroftour $Ident = qr{ 3562ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 3572ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 3582ceb532bSAndy Whitcroft }x; 3596c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 3606c72ffaaSAndy Whitcroftour $Sparse = qr{ 3616c72ffaaSAndy Whitcroft __user| 3626c72ffaaSAndy Whitcroft __kernel| 3636c72ffaaSAndy Whitcroft __force| 3646c72ffaaSAndy Whitcroft __iomem| 3656c72ffaaSAndy Whitcroft __must_check| 366417495edSAndy Whitcroft __kprobes| 367165e72a6SSven Eckelmann __ref| 36833aa4597SGeert Uytterhoeven __refconst| 36933aa4597SGeert Uytterhoeven __refdata| 370ad315455SBoqun Feng __rcu| 371ad315455SBoqun Feng __private 3726c72ffaaSAndy Whitcroft }x; 373e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 374e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 375e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 376e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 377e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 3788716de38SJoe Perches 37952131292SWolfram Sang# Notes to $Attribute: 38052131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 3816c72ffaaSAndy Whitcroftour $Attribute = qr{ 3826c72ffaaSAndy Whitcroft const| 38303f1df7dSJoe Perches __percpu| 38403f1df7dSJoe Perches __nocast| 38503f1df7dSJoe Perches __safe| 38646d832f5SMichael S. Tsirkin __bitwise| 38703f1df7dSJoe Perches __packed__| 38803f1df7dSJoe Perches __packed2__| 38903f1df7dSJoe Perches __naked| 39003f1df7dSJoe Perches __maybe_unused| 39103f1df7dSJoe Perches __always_unused| 39203f1df7dSJoe Perches __noreturn| 39303f1df7dSJoe Perches __used| 39403f1df7dSJoe Perches __cold| 395e23ef1f3SJoe Perches __pure| 39603f1df7dSJoe Perches __noclone| 39703f1df7dSJoe Perches __deprecated| 3986c72ffaaSAndy Whitcroft __read_mostly| 399c5967e98SJoe Perches __ro_after_init| 4006c72ffaaSAndy Whitcroft __kprobes| 4018716de38SJoe Perches $InitAttribute| 40224e1d81aSAndy Whitcroft ____cacheline_aligned| 40324e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 4045fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 4055fe3af11SAndy Whitcroft __weak 4066c72ffaaSAndy Whitcroft }x; 407c45dcabdSAndy Whitcroftour $Modifier; 40891cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 4096c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 4106c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 4116c72ffaaSAndy Whitcroft 41295e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 41395e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 41495e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 41595e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 4162435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 417c0a5c898SJoe Perchesour $String = qr{"[X\t]*"}; 418326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 419326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 420326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 42174349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 4222435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 423326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 424447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 42523f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 4266c72ffaaSAndy Whitcroftour $Operators = qr{ 4276c72ffaaSAndy Whitcroft <=|>=|==|!=| 4286c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 42923f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 4306c72ffaaSAndy Whitcroft }x; 4316c72ffaaSAndy Whitcroft 43291cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 43391cb5195SJoe Perches 434ab7e23f3SJoe Perchesour $BasicType; 4358905a67cSAndy Whitcroftour $NonptrType; 4361813087dSJoe Perchesour $NonptrTypeMisordered; 4378716de38SJoe Perchesour $NonptrTypeWithAttr; 4388905a67cSAndy Whitcroftour $Type; 4391813087dSJoe Perchesour $TypeMisordered; 4408905a67cSAndy Whitcroftour $Declare; 4411813087dSJoe Perchesour $DeclareMisordered; 4428905a67cSAndy Whitcroft 44315662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 44415662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 445171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 446171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 447171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 448171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 449171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 450171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 451171ae1a4SAndy Whitcroft}x; 452171ae1a4SAndy Whitcroft 45315662b3eSJoe Perchesour $UTF8 = qr{ 45415662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 45515662b3eSJoe Perches | $NON_ASCII_UTF8 45615662b3eSJoe Perches}x; 45715662b3eSJoe Perches 458e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 459021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 460021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 461021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 462021158b4SJoe Perches)}; 463e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 464fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 4658ed22cadSAndy Whitcroft atomic_t 4668ed22cadSAndy Whitcroft)}; 467e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 468e6176fa4SJoe Perches $typeC99Typedefs\b| 469e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 470e6176fa4SJoe Perches $typeKernelTypedefs\b 471e6176fa4SJoe Perches)}; 4728ed22cadSAndy Whitcroft 4736d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 4746d32f7a3SJoe Perches 475691e669bSJoe Perchesour $logFunctions = qr{(?x: 476758d7aadSMiles Chen printk(?:_ratelimited|_once|_deferred_once|_deferred|)| 4777d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 47887bd499aSJoe Perches TP_printk| 4796e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 480b0531722SJoe Perches panic| 48106668727SJoe Perches MODULE_[A-Z_]+| 48206668727SJoe Perches seq_vprintf|seq_printf|seq_puts 483691e669bSJoe Perches)}; 484691e669bSJoe Perches 485e29a70f1SJoe Perchesour $allocFunctions = qr{(?x: 486e29a70f1SJoe Perches (?:(?:devm_)? 487e29a70f1SJoe Perches (?:kv|k|v)[czm]alloc(?:_node|_array)? | 488e29a70f1SJoe Perches kstrdup(?:_const)? | 489e29a70f1SJoe Perches kmemdup(?:_nul)?) | 490461e1565SChristophe JAILLET (?:\w+)?alloc_skb(?:_ip_align)? | 491e29a70f1SJoe Perches # dev_alloc_skb/netdev_alloc_skb, et al 492e29a70f1SJoe Perches dma_alloc_coherent 493e29a70f1SJoe Perches)}; 494e29a70f1SJoe Perches 49520112475SJoe Perchesour $signature_tags = qr{(?xi: 49620112475SJoe Perches Signed-off-by:| 497d499480cSJorge Ramirez-Ortiz Co-developed-by:| 49820112475SJoe Perches Acked-by:| 49920112475SJoe Perches Tested-by:| 50020112475SJoe Perches Reviewed-by:| 50120112475SJoe Perches Reported-by:| 5028543ae12SMugunthan V N Suggested-by:| 50320112475SJoe Perches To:| 50420112475SJoe Perches Cc: 50520112475SJoe Perches)}; 50620112475SJoe Perches 5071813087dSJoe Perchesour @typeListMisordered = ( 5081813087dSJoe Perches qr{char\s+(?:un)?signed}, 5091813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 5101813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 5111813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 5121813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 5131813087dSJoe Perches qr{short\s+(?:un)?signed}, 5141813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 5151813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 5161813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 5171813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 5181813087dSJoe Perches qr{int\s+(?:un)?signed}, 5191813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 5201813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 5211813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 5221813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 5231813087dSJoe Perches qr{long\s+(?:un)?signed}, 5241813087dSJoe Perches); 5251813087dSJoe Perches 5268905a67cSAndy Whitcroftour @typeList = ( 5278905a67cSAndy Whitcroft qr{void}, 5280c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 5290c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 5300c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 5310c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 5320c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 5330c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 5340c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 5350c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 5360c773d9dSJoe Perches qr{(?:un)?signed}, 5378905a67cSAndy Whitcroft qr{float}, 5388905a67cSAndy Whitcroft qr{double}, 5398905a67cSAndy Whitcroft qr{bool}, 5408905a67cSAndy Whitcroft qr{struct\s+$Ident}, 5418905a67cSAndy Whitcroft qr{union\s+$Ident}, 5428905a67cSAndy Whitcroft qr{enum\s+$Ident}, 5438905a67cSAndy Whitcroft qr{${Ident}_t}, 5448905a67cSAndy Whitcroft qr{${Ident}_handler}, 5458905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 5461813087dSJoe Perches @typeListMisordered, 5478905a67cSAndy Whitcroft); 548938224b5SJoe Perches 549938224b5SJoe Perchesour $C90_int_types = qr{(?x: 550938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 551938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 552938224b5SJoe Perches long\s+long\s+(?:un)?signed| 553938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 554938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 555938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 556938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 557938224b5SJoe Perches 558938224b5SJoe Perches long\s+int\s+(?:un)?signed| 559938224b5SJoe Perches long\s+(?:un)?signed\s+int| 560938224b5SJoe Perches long\s+(?:un)?signed| 561938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 562938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 563938224b5SJoe Perches int\s+long\s+(?:un)?signed| 564938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 565938224b5SJoe Perches 566938224b5SJoe Perches int\s+(?:un)?signed| 567938224b5SJoe Perches (?:(?:un)?signed\s+)?int 568938224b5SJoe Perches)}; 569938224b5SJoe Perches 570485ff23eSAlex Dowadour @typeListFile = (); 5718716de38SJoe Perchesour @typeListWithAttr = ( 5728716de38SJoe Perches @typeList, 5738716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 5748716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 5758716de38SJoe Perches); 5768716de38SJoe Perches 577c45dcabdSAndy Whitcroftour @modifierList = ( 578c45dcabdSAndy Whitcroft qr{fastcall}, 579c45dcabdSAndy Whitcroft); 580485ff23eSAlex Dowadour @modifierListFile = (); 5818905a67cSAndy Whitcroft 5822435880fSJoe Perchesour @mode_permission_funcs = ( 5832435880fSJoe Perches ["module_param", 3], 5842435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 5852435880fSJoe Perches ["module_param_array_named", 5], 5862435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 5872435880fSJoe Perches ["proc_create(?:_data|)", 2], 588459cf0aeSJoe Perches ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2], 589459cf0aeSJoe Perches ["IIO_DEV_ATTR_[A-Z_]+", 1], 590459cf0aeSJoe Perches ["SENSOR_(?:DEVICE_|)ATTR_2", 2], 591459cf0aeSJoe Perches ["SENSOR_TEMPLATE(?:_2|)", 3], 592459cf0aeSJoe Perches ["__ATTR", 2], 5932435880fSJoe Perches); 5942435880fSJoe Perches 5951a3dcf2eSJoe Perchesmy $word_pattern = '\b[A-Z]?[a-z]{2,}\b'; 5961a3dcf2eSJoe Perches 597515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 598515a235eSJoe Perchesour $mode_perms_search = ""; 599515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 600515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 601515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 602515a235eSJoe Perches} 60300180468SJoe Perches$mode_perms_search = "(?:${mode_perms_search})"; 604515a235eSJoe Perches 6059189c7e7SJoe Perchesour %deprecated_apis = ( 6069189c7e7SJoe Perches "synchronize_rcu_bh" => "synchronize_rcu", 6079189c7e7SJoe Perches "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited", 6089189c7e7SJoe Perches "call_rcu_bh" => "call_rcu", 6099189c7e7SJoe Perches "rcu_barrier_bh" => "rcu_barrier", 6109189c7e7SJoe Perches "synchronize_sched" => "synchronize_rcu", 6119189c7e7SJoe Perches "synchronize_sched_expedited" => "synchronize_rcu_expedited", 6129189c7e7SJoe Perches "call_rcu_sched" => "call_rcu", 6139189c7e7SJoe Perches "rcu_barrier_sched" => "rcu_barrier", 6149189c7e7SJoe Perches "get_state_synchronize_sched" => "get_state_synchronize_rcu", 6159189c7e7SJoe Perches "cond_synchronize_sched" => "cond_synchronize_rcu", 6169189c7e7SJoe Perches); 6179189c7e7SJoe Perches 6189189c7e7SJoe Perches#Create a search pattern for all these strings to speed up a loop below 6199189c7e7SJoe Perchesour $deprecated_apis_search = ""; 6209189c7e7SJoe Perchesforeach my $entry (keys %deprecated_apis) { 6219189c7e7SJoe Perches $deprecated_apis_search .= '|' if ($deprecated_apis_search ne ""); 6229189c7e7SJoe Perches $deprecated_apis_search .= $entry; 6239189c7e7SJoe Perches} 6249189c7e7SJoe Perches$deprecated_apis_search = "(?:${deprecated_apis_search})"; 6259189c7e7SJoe Perches 626b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 627b392c64fSJoe Perches S_IWUGO | 628b392c64fSJoe Perches S_IWOTH | 629b392c64fSJoe Perches S_IRWXUGO | 630b392c64fSJoe Perches S_IALLUGO | 631b392c64fSJoe Perches 0[0-7][0-7][2367] 632b392c64fSJoe Perches}x; 633b392c64fSJoe Perches 634f90774e1SJoe Perchesour %mode_permission_string_types = ( 635f90774e1SJoe Perches "S_IRWXU" => 0700, 636f90774e1SJoe Perches "S_IRUSR" => 0400, 637f90774e1SJoe Perches "S_IWUSR" => 0200, 638f90774e1SJoe Perches "S_IXUSR" => 0100, 639f90774e1SJoe Perches "S_IRWXG" => 0070, 640f90774e1SJoe Perches "S_IRGRP" => 0040, 641f90774e1SJoe Perches "S_IWGRP" => 0020, 642f90774e1SJoe Perches "S_IXGRP" => 0010, 643f90774e1SJoe Perches "S_IRWXO" => 0007, 644f90774e1SJoe Perches "S_IROTH" => 0004, 645f90774e1SJoe Perches "S_IWOTH" => 0002, 646f90774e1SJoe Perches "S_IXOTH" => 0001, 647f90774e1SJoe Perches "S_IRWXUGO" => 0777, 648f90774e1SJoe Perches "S_IRUGO" => 0444, 649f90774e1SJoe Perches "S_IWUGO" => 0222, 650f90774e1SJoe Perches "S_IXUGO" => 0111, 651f90774e1SJoe Perches); 652f90774e1SJoe Perches 653f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below 654f90774e1SJoe Perchesour $mode_perms_string_search = ""; 655f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) { 656f90774e1SJoe Perches $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); 657f90774e1SJoe Perches $mode_perms_string_search .= $entry; 658f90774e1SJoe Perches} 65900180468SJoe Perchesour $single_mode_perms_string_search = "(?:${mode_perms_string_search})"; 66000180468SJoe Perchesour $multi_mode_perms_string_search = qr{ 66100180468SJoe Perches ${single_mode_perms_string_search} 66200180468SJoe Perches (?:\s*\|\s*${single_mode_perms_string_search})* 66300180468SJoe Perches}x; 66400180468SJoe Perches 66500180468SJoe Perchessub perms_to_octal { 66600180468SJoe Perches my ($string) = @_; 66700180468SJoe Perches 66800180468SJoe Perches return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/); 66900180468SJoe Perches 67000180468SJoe Perches my $val = ""; 67100180468SJoe Perches my $oval = ""; 67200180468SJoe Perches my $to = 0; 67300180468SJoe Perches my $curpos = 0; 67400180468SJoe Perches my $lastpos = 0; 67500180468SJoe Perches while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) { 67600180468SJoe Perches $curpos = pos($string); 67700180468SJoe Perches my $match = $2; 67800180468SJoe Perches my $omatch = $1; 67900180468SJoe Perches last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos)); 68000180468SJoe Perches $lastpos = $curpos; 68100180468SJoe Perches $to |= $mode_permission_string_types{$match}; 68200180468SJoe Perches $val .= '\s*\|\s*' if ($val ne ""); 68300180468SJoe Perches $val .= $match; 68400180468SJoe Perches $oval .= $omatch; 68500180468SJoe Perches } 68600180468SJoe Perches $oval =~ s/^\s*\|\s*//; 68700180468SJoe Perches $oval =~ s/\s*\|\s*$//; 68800180468SJoe Perches return sprintf("%04o", $to); 68900180468SJoe Perches} 690f90774e1SJoe Perches 6917840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 6927840a94cSWolfram Sang irq| 693cdcee686SSergey Ryazanov memory| 694cdcee686SSergey Ryazanov time| 695cdcee686SSergey Ryazanov reboot 6967840a94cSWolfram Sang)}; 6977840a94cSWolfram Sang# memory.h: ARM has a custom one 6987840a94cSWolfram Sang 69966b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 70066b47b4aSKees Cookmy $misspellings; 70166b47b4aSKees Cookmy %spelling_fix; 70236061e38SJoe Perches 70336061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 70466b47b4aSKees Cook while (<$spelling>) { 70566b47b4aSKees Cook my $line = $_; 70666b47b4aSKees Cook 70766b47b4aSKees Cook $line =~ s/\s*\n?$//g; 70866b47b4aSKees Cook $line =~ s/^\s*//g; 70966b47b4aSKees Cook 71066b47b4aSKees Cook next if ($line =~ m/^\s*#/); 71166b47b4aSKees Cook next if ($line =~ m/^\s*$/); 71266b47b4aSKees Cook 71366b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 71466b47b4aSKees Cook 71566b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 71666b47b4aSKees Cook } 71766b47b4aSKees Cook close($spelling); 71836061e38SJoe Perches} else { 71936061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 72036061e38SJoe Perches} 72166b47b4aSKees Cook 722ebfd7d62SJoe Perchesif ($codespell) { 723ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 724ebfd7d62SJoe Perches while (<$spelling>) { 725ebfd7d62SJoe Perches my $line = $_; 726ebfd7d62SJoe Perches 727ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 728ebfd7d62SJoe Perches $line =~ s/^\s*//g; 729ebfd7d62SJoe Perches 730ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 731ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 732ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 733ebfd7d62SJoe Perches 734ebfd7d62SJoe Perches $line =~ s/,.*$//; 735ebfd7d62SJoe Perches 736ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 737ebfd7d62SJoe Perches 738ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 739ebfd7d62SJoe Perches } 740ebfd7d62SJoe Perches close($spelling); 741ebfd7d62SJoe Perches } else { 742ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 743ebfd7d62SJoe Perches } 744ebfd7d62SJoe Perches} 745ebfd7d62SJoe Perches 746ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 747ebfd7d62SJoe Perches 74875ad8c57SJerome Forissiersub read_words { 74975ad8c57SJerome Forissier my ($wordsRef, $file) = @_; 75075ad8c57SJerome Forissier 75175ad8c57SJerome Forissier if (open(my $words, '<', $file)) { 75275ad8c57SJerome Forissier while (<$words>) { 753bf1fa1daSJoe Perches my $line = $_; 754bf1fa1daSJoe Perches 755bf1fa1daSJoe Perches $line =~ s/\s*\n?$//g; 756bf1fa1daSJoe Perches $line =~ s/^\s*//g; 757bf1fa1daSJoe Perches 758bf1fa1daSJoe Perches next if ($line =~ m/^\s*#/); 759bf1fa1daSJoe Perches next if ($line =~ m/^\s*$/); 760bf1fa1daSJoe Perches if ($line =~ /\s/) { 76175ad8c57SJerome Forissier print("$file: '$line' invalid - ignored\n"); 762bf1fa1daSJoe Perches next; 763bf1fa1daSJoe Perches } 764bf1fa1daSJoe Perches 765ced69da1SQuentin Monnet $$wordsRef .= '|' if (defined $$wordsRef); 76675ad8c57SJerome Forissier $$wordsRef .= $line; 767bf1fa1daSJoe Perches } 76875ad8c57SJerome Forissier close($file); 76975ad8c57SJerome Forissier return 1; 770bf1fa1daSJoe Perches } 771bf1fa1daSJoe Perches 77275ad8c57SJerome Forissier return 0; 77375ad8c57SJerome Forissier} 77475ad8c57SJerome Forissier 775ced69da1SQuentin Monnetmy $const_structs; 776ced69da1SQuentin Monnetif (show_type("CONST_STRUCT")) { 77775ad8c57SJerome Forissier read_words(\$const_structs, $conststructsfile) 77875ad8c57SJerome Forissier or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 779ced69da1SQuentin Monnet} 78075ad8c57SJerome Forissier 781ced69da1SQuentin Monnetif (defined($typedefsfile)) { 782ced69da1SQuentin Monnet my $typeOtherTypedefs; 78375ad8c57SJerome Forissier read_words(\$typeOtherTypedefs, $typedefsfile) 78475ad8c57SJerome Forissier or warn "No additional types will be considered - file '$typedefsfile': $!\n"; 785ced69da1SQuentin Monnet $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs); 78675ad8c57SJerome Forissier} 78775ad8c57SJerome Forissier 7888905a67cSAndy Whitcroftsub build_types { 789485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 790485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 7911813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 7928716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 793c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 794ab7e23f3SJoe Perches $BasicType = qr{ 795ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 796ab7e23f3SJoe Perches (?:${all}\b) 797ab7e23f3SJoe Perches }x; 7988905a67cSAndy Whitcroft $NonptrType = qr{ 799d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 800cf655043SAndy Whitcroft (?: 8016b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 8028ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 803c45dcabdSAndy Whitcroft (?:${all}\b) 804cf655043SAndy Whitcroft ) 805c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 8068905a67cSAndy Whitcroft }x; 8071813087dSJoe Perches $NonptrTypeMisordered = qr{ 8081813087dSJoe Perches (?:$Modifier\s+|const\s+)* 8091813087dSJoe Perches (?: 8101813087dSJoe Perches (?:${Misordered}\b) 8111813087dSJoe Perches ) 8121813087dSJoe Perches (?:\s+$Modifier|\s+const)* 8131813087dSJoe Perches }x; 8148716de38SJoe Perches $NonptrTypeWithAttr = qr{ 8158716de38SJoe Perches (?:$Modifier\s+|const\s+)* 8168716de38SJoe Perches (?: 8178716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 8188716de38SJoe Perches (?:$typeTypedefs\b)| 8198716de38SJoe Perches (?:${allWithAttr}\b) 8208716de38SJoe Perches ) 8218716de38SJoe Perches (?:\s+$Modifier|\s+const)* 8228716de38SJoe Perches }x; 8238905a67cSAndy Whitcroft $Type = qr{ 824c45dcabdSAndy Whitcroft $NonptrType 8257b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 826c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 8278905a67cSAndy Whitcroft }x; 8281813087dSJoe Perches $TypeMisordered = qr{ 8291813087dSJoe Perches $NonptrTypeMisordered 8307b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 8311813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 8321813087dSJoe Perches }x; 83391cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 8341813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 8358905a67cSAndy Whitcroft} 8368905a67cSAndy Whitcroftbuild_types(); 8376c72ffaaSAndy Whitcroft 8387d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 839d1fe9c09SJoe Perches 840d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 841d1fe9c09SJoe Perches# requires at least perl version v5.10.0 842d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 843d1fe9c09SJoe Perches 844d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 8452435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 846c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 8477d2367afSJoe Perches 848f8422308SJoe Perchesour $declaration_macros = qr{(?x: 8493e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 850fe658f94SSteffen Maier (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(| 8513d102fc0SGilad Ben-Yossef (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\( 852f8422308SJoe Perches)}; 853f8422308SJoe Perches 8547d2367afSJoe Perchessub deparenthesize { 8557d2367afSJoe Perches my ($string) = @_; 8567d2367afSJoe Perches return "" if (!defined($string)); 8575b9553abSJoe Perches 8585b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 8595b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 8605b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 8615b9553abSJoe Perches } 8625b9553abSJoe Perches 8637d2367afSJoe Perches $string =~ s@\s+@ @g; 8645b9553abSJoe Perches 8657d2367afSJoe Perches return $string; 8667d2367afSJoe Perches} 8677d2367afSJoe Perches 8683445686aSJoe Perchessub seed_camelcase_file { 8693445686aSJoe Perches my ($file) = @_; 8703445686aSJoe Perches 8713445686aSJoe Perches return if (!(-f $file)); 8723445686aSJoe Perches 8733445686aSJoe Perches local $/; 8743445686aSJoe Perches 8753445686aSJoe Perches open(my $include_file, '<', "$file") 8763445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 8773445686aSJoe Perches my $text = <$include_file>; 8783445686aSJoe Perches close($include_file); 8793445686aSJoe Perches 8803445686aSJoe Perches my @lines = split('\n', $text); 8813445686aSJoe Perches 8823445686aSJoe Perches foreach my $line (@lines) { 8833445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 8843445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 8853445686aSJoe Perches $camelcase{$1} = 1; 88611ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 88711ea516aSJoe Perches $camelcase{$1} = 1; 88811ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 8893445686aSJoe Perches $camelcase{$1} = 1; 8903445686aSJoe Perches } 8913445686aSJoe Perches } 8923445686aSJoe Perches} 8933445686aSJoe Perches 894cd28b119SJoe Perchesour %maintained_status = (); 895cd28b119SJoe Perches 89685b0ee18SJoe Perchessub is_maintained_obsolete { 89785b0ee18SJoe Perches my ($filename) = @_; 89885b0ee18SJoe Perches 899f2c19c2fSJerome Forissier return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 90085b0ee18SJoe Perches 901cd28b119SJoe Perches if (!exists($maintained_status{$filename})) { 902cd28b119SJoe Perches $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 903cd28b119SJoe Perches } 90485b0ee18SJoe Perches 905cd28b119SJoe Perches return $maintained_status{$filename} =~ /obsolete/i; 90685b0ee18SJoe Perches} 90785b0ee18SJoe Perches 9083b6e8ac9SJoe Perchessub is_SPDX_License_valid { 9093b6e8ac9SJoe Perches my ($license) = @_; 9103b6e8ac9SJoe Perches 91156294112SJoe Perches return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git")); 9123b6e8ac9SJoe Perches 91356294112SJoe Perches my $root_path = abs_path($root); 91456294112SJoe Perches my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`; 9153b6e8ac9SJoe Perches return 0 if ($status ne ""); 9163b6e8ac9SJoe Perches return 1; 9173b6e8ac9SJoe Perches} 9183b6e8ac9SJoe Perches 9193445686aSJoe Perchesmy $camelcase_seeded = 0; 9203445686aSJoe Perchessub seed_camelcase_includes { 9213445686aSJoe Perches return if ($camelcase_seeded); 9223445686aSJoe Perches 9233445686aSJoe Perches my $files; 924c707a81dSJoe Perches my $camelcase_cache = ""; 925c707a81dSJoe Perches my @include_files = (); 926c707a81dSJoe Perches 927c707a81dSJoe Perches $camelcase_seeded = 1; 928351b2a1fSJoe Perches 9293645e328SRichard Genoud if (-e ".git") { 930dbbf869dSJoe Perches my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`; 931351b2a1fSJoe Perches chomp $git_last_include_commit; 932c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 933c707a81dSJoe Perches } else { 934c707a81dSJoe Perches my $last_mod_date = 0; 935c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 936c707a81dSJoe Perches @include_files = split('\n', $files); 937c707a81dSJoe Perches foreach my $file (@include_files) { 938c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 939c707a81dSJoe Perches localtime((stat $file)[9])); 940c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 941c707a81dSJoe Perches } 942c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 943c707a81dSJoe Perches } 944c707a81dSJoe Perches 945c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 946c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 947c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 948351b2a1fSJoe Perches while (<$camelcase_file>) { 949351b2a1fSJoe Perches chomp; 950351b2a1fSJoe Perches $camelcase{$_} = 1; 951351b2a1fSJoe Perches } 952351b2a1fSJoe Perches close($camelcase_file); 953351b2a1fSJoe Perches 954351b2a1fSJoe Perches return; 955351b2a1fSJoe Perches } 956c707a81dSJoe Perches 9573645e328SRichard Genoud if (-e ".git") { 958dbbf869dSJoe Perches $files = `${git_command} ls-files "include/*.h"`; 959c707a81dSJoe Perches @include_files = split('\n', $files); 9603445686aSJoe Perches } 961c707a81dSJoe Perches 9623445686aSJoe Perches foreach my $file (@include_files) { 9633445686aSJoe Perches seed_camelcase_file($file); 9643445686aSJoe Perches } 965351b2a1fSJoe Perches 966c707a81dSJoe Perches if ($camelcase_cache ne "") { 967351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 968c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 969c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 970351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 971351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 972351b2a1fSJoe Perches } 973351b2a1fSJoe Perches close($camelcase_file); 974351b2a1fSJoe Perches } 9753445686aSJoe Perches} 9763445686aSJoe Perches 977f5f61325SJoe Perchessub git_is_single_file { 978f5f61325SJoe Perches my ($filename) = @_; 979f5f61325SJoe Perches 980f5f61325SJoe Perches return 0 if ((which("git") eq "") || !(-e "$gitroot")); 981f5f61325SJoe Perches 982f5f61325SJoe Perches my $output = `${git_command} ls-files -- $filename 2>/dev/null`; 983f5f61325SJoe Perches my $count = $output =~ tr/\n//; 984f5f61325SJoe Perches return $count eq 1 && $output =~ m{^${filename}$}; 985f5f61325SJoe Perches} 986f5f61325SJoe Perches 987d311cd44SJoe Perchessub git_commit_info { 988d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 989d311cd44SJoe Perches 990d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 991d311cd44SJoe Perches 992dbbf869dSJoe Perches my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`; 993d311cd44SJoe Perches $output =~ s/^\s*//gm; 994d311cd44SJoe Perches my @lines = split("\n", $output); 995d311cd44SJoe Perches 9960d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 9970d7835fcSJoe Perches 9985a7f4455SSean Christopherson if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) { 999d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 1000d311cd44SJoe Perches# all matching commit ids, but it's very slow... 1001d311cd44SJoe Perches# 1002d311cd44SJoe Perches# echo "checking commits $1..." 1003d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 1004d311cd44SJoe Perches# while read line ; do 1005d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 1006d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 1007d311cd44SJoe Perches# done 1008d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 1009948b133aSHeinrich Schuchardt $id = undef; 1010d311cd44SJoe Perches } else { 1011d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 1012d311cd44SJoe Perches $desc = substr($lines[0], 41); 1013d311cd44SJoe Perches } 1014d311cd44SJoe Perches 1015d311cd44SJoe Perches return ($id, $desc); 1016d311cd44SJoe Perches} 1017d311cd44SJoe Perches 10186c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 10190a920b5bSAndy Whitcroft 102000df344fSAndy Whitcroftmy @rawlines = (); 1021c2fdda0dSAndy Whitcroftmy @lines = (); 10223705ce5bSJoe Perchesmy @fixed = (); 1023d752fcc8SJoe Perchesmy @fixed_inserted = (); 1024d752fcc8SJoe Perchesmy @fixed_deleted = (); 1025194f66fcSJoe Perchesmy $fixlinenr = -1; 1026194f66fcSJoe Perches 10274a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 10284a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 10294a593c34SDu, Changbindie "$P: No git repository found\n" if ($git && !-e ".git"); 10304a593c34SDu, Changbin 10314a593c34SDu, Changbinif ($git) { 10324a593c34SDu, Changbin my @commits = (); 10330dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 10344a593c34SDu, Changbin my $git_range; 103528898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 103628898fd1SJoe Perches $git_range = "-$2 $1"; 10374a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 10384a593c34SDu, Changbin $git_range = "$commit_expr"; 10394a593c34SDu, Changbin } else { 10400dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 10410dea9f1eSJoe Perches } 1042dbbf869dSJoe Perches my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 10430dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 104428898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 104528898fd1SJoe Perches next if (!defined($1) || !defined($2)); 10460dea9f1eSJoe Perches my $sha1 = $1; 10470dea9f1eSJoe Perches my $subject = $2; 10480dea9f1eSJoe Perches unshift(@commits, $sha1); 10490dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 10504a593c34SDu, Changbin } 10514a593c34SDu, Changbin } 10524a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 10534a593c34SDu, Changbin @ARGV = @commits; 10544a593c34SDu, Changbin} 10554a593c34SDu, Changbin 1056c2fdda0dSAndy Whitcroftmy $vname; 105798005e8cSVadim Bendebury$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"}; 10586c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 105921caa13cSAndy Whitcroft my $FILE; 1060f5f61325SJoe Perches my $is_git_file = git_is_single_file($filename); 1061f5f61325SJoe Perches my $oldfile = $file; 1062f5f61325SJoe Perches $file = 1 if ($is_git_file); 10634a593c34SDu, Changbin if ($git) { 10644a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 10654a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 10664a593c34SDu, Changbin } elsif ($file) { 106721caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 10686c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 106921caa13cSAndy Whitcroft } elsif ($filename eq '-') { 107021caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 10716c72ffaaSAndy Whitcroft } else { 107221caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 10736c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 10746c72ffaaSAndy Whitcroft } 1075c2fdda0dSAndy Whitcroft if ($filename eq '-') { 1076c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 10774a593c34SDu, Changbin } elsif ($git) { 10780dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 1079c2fdda0dSAndy Whitcroft } else { 1080c2fdda0dSAndy Whitcroft $vname = $filename; 1081c2fdda0dSAndy Whitcroft } 108221caa13cSAndy Whitcroft while (<$FILE>) { 10830a920b5bSAndy Whitcroft chomp; 108400df344fSAndy Whitcroft push(@rawlines, $_); 1085c7f574d0SGeert Uytterhoeven $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i); 10866c72ffaaSAndy Whitcroft } 108721caa13cSAndy Whitcroft close($FILE); 1088d8469f16SJoe Perches 1089d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 1090d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1091d8469f16SJoe Perches print "$vname\n"; 1092d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1093d8469f16SJoe Perches } 1094d8469f16SJoe Perches 1095c2fdda0dSAndy Whitcroft if (!process($filename)) { 10960a920b5bSAndy Whitcroft $exit = 1; 10970a920b5bSAndy Whitcroft } 109800df344fSAndy Whitcroft @rawlines = (); 109913214adfSAndy Whitcroft @lines = (); 11003705ce5bSJoe Perches @fixed = (); 1101d752fcc8SJoe Perches @fixed_inserted = (); 1102d752fcc8SJoe Perches @fixed_deleted = (); 1103194f66fcSJoe Perches $fixlinenr = -1; 1104485ff23eSAlex Dowad @modifierListFile = (); 1105485ff23eSAlex Dowad @typeListFile = (); 1106485ff23eSAlex Dowad build_types(); 1107f5f61325SJoe Perches $file = $oldfile if ($is_git_file); 11080a920b5bSAndy Whitcroft} 11090a920b5bSAndy Whitcroft 1110d8469f16SJoe Perchesif (!$quiet) { 11113c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 11123c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 11133c816e49SJoe Perches 11145b57980dSJoe Perches if (!$perl_version_ok) { 1115d8469f16SJoe Perches print << "EOM" 1116d8469f16SJoe Perches 1117d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 11185b57980dSJoe Perches An upgrade to at least perl $minimum_perl_version is suggested. 1119d8469f16SJoe PerchesEOM 1120d8469f16SJoe Perches } 1121d8469f16SJoe Perches if ($exit) { 1122d8469f16SJoe Perches print << "EOM" 1123d8469f16SJoe Perches 1124d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 1125d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 1126d8469f16SJoe PerchesEOM 1127d8469f16SJoe Perches } 1128d8469f16SJoe Perches} 1129d8469f16SJoe Perches 11300a920b5bSAndy Whitcroftexit($exit); 11310a920b5bSAndy Whitcroft 11320a920b5bSAndy Whitcroftsub top_of_kernel_tree { 11336c72ffaaSAndy Whitcroft my ($root) = @_; 11346c72ffaaSAndy Whitcroft 11356c72ffaaSAndy Whitcroft my @tree_check = ( 11366c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 11376c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 11386c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 11396c72ffaaSAndy Whitcroft ); 11406c72ffaaSAndy Whitcroft 11416c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 11426c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 11430a920b5bSAndy Whitcroft return 0; 11440a920b5bSAndy Whitcroft } 11456c72ffaaSAndy Whitcroft } 11466c72ffaaSAndy Whitcroft return 1; 11476c72ffaaSAndy Whitcroft} 11480a920b5bSAndy Whitcroft 114920112475SJoe Perchessub parse_email { 115020112475SJoe Perches my ($formatted_email) = @_; 115120112475SJoe Perches 115220112475SJoe Perches my $name = ""; 1153dfa05c28SJoe Perches my $name_comment = ""; 115420112475SJoe Perches my $address = ""; 115520112475SJoe Perches my $comment = ""; 115620112475SJoe Perches 115720112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 115820112475SJoe Perches $name = $1; 115920112475SJoe Perches $address = $2; 116020112475SJoe Perches $comment = $3 if defined $3; 116120112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 116220112475SJoe Perches $address = $1; 116320112475SJoe Perches $comment = $2 if defined $2; 116420112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 116520112475SJoe Perches $address = $1; 116620112475SJoe Perches $comment = $2 if defined $2; 116785e12066SJoe Perches $formatted_email =~ s/\Q$address\E.*$//; 116820112475SJoe Perches $name = $formatted_email; 11693705ce5bSJoe Perches $name = trim($name); 117020112475SJoe Perches $name =~ s/^\"|\"$//g; 117120112475SJoe Perches # If there's a name left after stripping spaces and 117220112475SJoe Perches # leading quotes, and the address doesn't have both 117320112475SJoe Perches # leading and trailing angle brackets, the address 117420112475SJoe Perches # is invalid. ie: 117520112475SJoe Perches # "joe smith [email protected]" bad 117620112475SJoe Perches # "joe smith <[email protected]" bad 117720112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 117820112475SJoe Perches $name = ""; 117920112475SJoe Perches $address = ""; 118020112475SJoe Perches $comment = ""; 118120112475SJoe Perches } 118220112475SJoe Perches } 118320112475SJoe Perches 1184*48ca2d8aSDwaipayan Ray $comment = trim($comment); 11853705ce5bSJoe Perches $name = trim($name); 118620112475SJoe Perches $name =~ s/^\"|\"$//g; 1187*48ca2d8aSDwaipayan Ray if ($name =~ s/(\s*\([^\)]+\))\s*//) { 1188dfa05c28SJoe Perches $name_comment = trim($1); 1189dfa05c28SJoe Perches } 11903705ce5bSJoe Perches $address = trim($address); 119120112475SJoe Perches $address =~ s/^\<|\>$//g; 119220112475SJoe Perches 119320112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 119420112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 119520112475SJoe Perches $name = "\"$name\""; 119620112475SJoe Perches } 119720112475SJoe Perches 1198dfa05c28SJoe Perches return ($name, $name_comment, $address, $comment); 119920112475SJoe Perches} 120020112475SJoe Perches 120120112475SJoe Perchessub format_email { 1202*48ca2d8aSDwaipayan Ray my ($name, $name_comment, $address, $comment) = @_; 120320112475SJoe Perches 120420112475SJoe Perches my $formatted_email; 120520112475SJoe Perches 1206*48ca2d8aSDwaipayan Ray $name_comment = trim($name_comment); 1207*48ca2d8aSDwaipayan Ray $comment = trim($comment); 12083705ce5bSJoe Perches $name = trim($name); 120920112475SJoe Perches $name =~ s/^\"|\"$//g; 12103705ce5bSJoe Perches $address = trim($address); 121120112475SJoe Perches 121220112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 121320112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 121420112475SJoe Perches $name = "\"$name\""; 121520112475SJoe Perches } 121620112475SJoe Perches 121720112475SJoe Perches if ("$name" eq "") { 121820112475SJoe Perches $formatted_email = "$address"; 121920112475SJoe Perches } else { 1220*48ca2d8aSDwaipayan Ray $formatted_email = "$name$name_comment <$address>"; 122120112475SJoe Perches } 1222*48ca2d8aSDwaipayan Ray $formatted_email .= "$comment"; 122320112475SJoe Perches return $formatted_email; 122420112475SJoe Perches} 122520112475SJoe Perches 1226dfa05c28SJoe Perchessub reformat_email { 1227dfa05c28SJoe Perches my ($email) = @_; 1228dfa05c28SJoe Perches 1229dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 1230*48ca2d8aSDwaipayan Ray return format_email($email_name, $name_comment, $email_address, $comment); 1231dfa05c28SJoe Perches} 1232dfa05c28SJoe Perches 1233dfa05c28SJoe Perchessub same_email_addresses { 1234*48ca2d8aSDwaipayan Ray my ($email1, $email2, $match_comment) = @_; 1235dfa05c28SJoe Perches 1236dfa05c28SJoe Perches my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1); 1237dfa05c28SJoe Perches my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2); 1238dfa05c28SJoe Perches 1239*48ca2d8aSDwaipayan Ray if ($match_comment != 1) { 1240dfa05c28SJoe Perches return $email1_name eq $email2_name && 1241dfa05c28SJoe Perches $email1_address eq $email2_address; 1242dfa05c28SJoe Perches } 1243*48ca2d8aSDwaipayan Ray return $email1_name eq $email2_name && 1244*48ca2d8aSDwaipayan Ray $email1_address eq $email2_address && 1245*48ca2d8aSDwaipayan Ray $name1_comment eq $name2_comment && 1246*48ca2d8aSDwaipayan Ray $comment1 eq $comment2; 1247*48ca2d8aSDwaipayan Ray} 1248dfa05c28SJoe Perches 1249d311cd44SJoe Perchessub which { 1250d311cd44SJoe Perches my ($bin) = @_; 1251d311cd44SJoe Perches 1252d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1253d311cd44SJoe Perches if (-e "$path/$bin") { 1254d311cd44SJoe Perches return "$path/$bin"; 1255d311cd44SJoe Perches } 1256d311cd44SJoe Perches } 1257d311cd44SJoe Perches 1258d311cd44SJoe Perches return ""; 1259d311cd44SJoe Perches} 1260d311cd44SJoe Perches 1261000d1cc1SJoe Perchessub which_conf { 1262000d1cc1SJoe Perches my ($conf) = @_; 1263000d1cc1SJoe Perches 1264000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1265000d1cc1SJoe Perches if (-e "$path/$conf") { 1266000d1cc1SJoe Perches return "$path/$conf"; 1267000d1cc1SJoe Perches } 1268000d1cc1SJoe Perches } 1269000d1cc1SJoe Perches 1270000d1cc1SJoe Perches return ""; 1271000d1cc1SJoe Perches} 1272000d1cc1SJoe Perches 12730a920b5bSAndy Whitcroftsub expand_tabs { 12740a920b5bSAndy Whitcroft my ($str) = @_; 12750a920b5bSAndy Whitcroft 12760a920b5bSAndy Whitcroft my $res = ''; 12770a920b5bSAndy Whitcroft my $n = 0; 12780a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 12790a920b5bSAndy Whitcroft if ($c eq "\t") { 12800a920b5bSAndy Whitcroft $res .= ' '; 12810a920b5bSAndy Whitcroft $n++; 1282713a09deSAntonio Borneo for (; ($n % $tabsize) != 0; $n++) { 12830a920b5bSAndy Whitcroft $res .= ' '; 12840a920b5bSAndy Whitcroft } 12850a920b5bSAndy Whitcroft next; 12860a920b5bSAndy Whitcroft } 12870a920b5bSAndy Whitcroft $res .= $c; 12880a920b5bSAndy Whitcroft $n++; 12890a920b5bSAndy Whitcroft } 12900a920b5bSAndy Whitcroft 12910a920b5bSAndy Whitcroft return $res; 12920a920b5bSAndy Whitcroft} 12936c72ffaaSAndy Whitcroftsub copy_spacing { 1294773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 12956c72ffaaSAndy Whitcroft return $res; 12966c72ffaaSAndy Whitcroft} 12970a920b5bSAndy Whitcroft 12984a0df2efSAndy Whitcroftsub line_stats { 12994a0df2efSAndy Whitcroft my ($line) = @_; 13004a0df2efSAndy Whitcroft 13014a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 13024a0df2efSAndy Whitcroft $line =~ s/^.//; 13034a0df2efSAndy Whitcroft $line = expand_tabs($line); 13044a0df2efSAndy Whitcroft 13054a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 13064a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 13074a0df2efSAndy Whitcroft 13084a0df2efSAndy Whitcroft return (length($line), length($white)); 13094a0df2efSAndy Whitcroft} 13104a0df2efSAndy Whitcroft 1311773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1312773647a0SAndy Whitcroft 1313773647a0SAndy Whitcroftsub sanitise_line_reset { 1314773647a0SAndy Whitcroft my ($in_comment) = @_; 1315773647a0SAndy Whitcroft 1316773647a0SAndy Whitcroft if ($in_comment) { 1317773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1318773647a0SAndy Whitcroft } else { 1319773647a0SAndy Whitcroft $sanitise_quote = ''; 1320773647a0SAndy Whitcroft } 1321773647a0SAndy Whitcroft} 132200df344fSAndy Whitcroftsub sanitise_line { 132300df344fSAndy Whitcroft my ($line) = @_; 132400df344fSAndy Whitcroft 132500df344fSAndy Whitcroft my $res = ''; 132600df344fSAndy Whitcroft my $l = ''; 132700df344fSAndy Whitcroft 1328c2fdda0dSAndy Whitcroft my $qlen = 0; 1329773647a0SAndy Whitcroft my $off = 0; 1330773647a0SAndy Whitcroft my $c; 133100df344fSAndy Whitcroft 1332773647a0SAndy Whitcroft # Always copy over the diff marker. 1333773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1334773647a0SAndy Whitcroft 1335773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1336773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1337773647a0SAndy Whitcroft 13388d2e11b2SClaudio Fontana # Comments we are whacking completely including the begin 1339773647a0SAndy Whitcroft # and end, all to $;. 1340773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1341773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1342773647a0SAndy Whitcroft 1343773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1344773647a0SAndy Whitcroft $off++; 134500df344fSAndy Whitcroft next; 1346773647a0SAndy Whitcroft } 134781bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1348773647a0SAndy Whitcroft $sanitise_quote = ''; 1349773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1350773647a0SAndy Whitcroft $off++; 1351773647a0SAndy Whitcroft next; 1352773647a0SAndy Whitcroft } 1353113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1354113f04a8SDaniel Walker $sanitise_quote = '//'; 1355113f04a8SDaniel Walker 1356113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1357113f04a8SDaniel Walker $off++; 1358113f04a8SDaniel Walker next; 1359113f04a8SDaniel Walker } 1360773647a0SAndy Whitcroft 1361773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1362773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1363773647a0SAndy Whitcroft $c eq "\\") { 1364773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1365773647a0SAndy Whitcroft $off++; 1366773647a0SAndy Whitcroft next; 1367773647a0SAndy Whitcroft } 1368773647a0SAndy Whitcroft # Regular quotes. 1369773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1370773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1371773647a0SAndy Whitcroft $sanitise_quote = $c; 1372773647a0SAndy Whitcroft 1373773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1374773647a0SAndy Whitcroft next; 1375773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1376773647a0SAndy Whitcroft $sanitise_quote = ''; 137700df344fSAndy Whitcroft } 137800df344fSAndy Whitcroft } 1379773647a0SAndy Whitcroft 1380fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1381773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1382773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1383113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1384113f04a8SDaniel Walker substr($res, $off, 1, $;); 1385773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1386773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 138700df344fSAndy Whitcroft } else { 1388773647a0SAndy Whitcroft substr($res, $off, 1, $c); 138900df344fSAndy Whitcroft } 1390c2fdda0dSAndy Whitcroft } 1391c2fdda0dSAndy Whitcroft 1392113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1393113f04a8SDaniel Walker $sanitise_quote = ''; 1394113f04a8SDaniel Walker } 1395113f04a8SDaniel Walker 1396c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1397c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1398c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1399c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1400c2fdda0dSAndy Whitcroft 1401c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1402c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1403c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1404c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1405c2fdda0dSAndy Whitcroft } 1406c2fdda0dSAndy Whitcroft 1407dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1408dadf680dSJoe Perches my $match = $1; 1409dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1410dadf680dSJoe Perches } 1411dadf680dSJoe Perches 141200df344fSAndy Whitcroft return $res; 141300df344fSAndy Whitcroft} 141400df344fSAndy Whitcroft 1415a6962d72SJoe Perchessub get_quoted_string { 1416a6962d72SJoe Perches my ($line, $rawline) = @_; 1417a6962d72SJoe Perches 1418478b1799SJoe Perches return "" if (!defined($line) || !defined($rawline)); 141933acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1420a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1421a6962d72SJoe Perches} 1422a6962d72SJoe Perches 14238905a67cSAndy Whitcroftsub ctx_statement_block { 14248905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 14258905a67cSAndy Whitcroft my $line = $linenr - 1; 14268905a67cSAndy Whitcroft my $blk = ''; 14278905a67cSAndy Whitcroft my $soff = $off; 14288905a67cSAndy Whitcroft my $coff = $off - 1; 1429773647a0SAndy Whitcroft my $coff_set = 0; 14308905a67cSAndy Whitcroft 143113214adfSAndy Whitcroft my $loff = 0; 143213214adfSAndy Whitcroft 14338905a67cSAndy Whitcroft my $type = ''; 14348905a67cSAndy Whitcroft my $level = 0; 1435a2750645SAndy Whitcroft my @stack = (); 1436cf655043SAndy Whitcroft my $p; 14378905a67cSAndy Whitcroft my $c; 14388905a67cSAndy Whitcroft my $len = 0; 143913214adfSAndy Whitcroft 144013214adfSAndy Whitcroft my $remainder; 14418905a67cSAndy Whitcroft while (1) { 1442a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1443a2750645SAndy Whitcroft 1444773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 14458905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 14468905a67cSAndy Whitcroft # context. 14478905a67cSAndy Whitcroft if ($off >= $len) { 14488905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1449dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1450c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 14518905a67cSAndy Whitcroft $remain--; 145213214adfSAndy Whitcroft $loff = $len; 1453c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 14548905a67cSAndy Whitcroft $len = length($blk); 14558905a67cSAndy Whitcroft $line++; 14568905a67cSAndy Whitcroft last; 14578905a67cSAndy Whitcroft } 14588905a67cSAndy Whitcroft # Bail if there is no further context. 14598905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 146013214adfSAndy Whitcroft if ($off >= $len) { 14618905a67cSAndy Whitcroft last; 14628905a67cSAndy Whitcroft } 1463f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1464f74bd194SAndy Whitcroft $level++; 1465f74bd194SAndy Whitcroft $type = '#'; 1466f74bd194SAndy Whitcroft } 14678905a67cSAndy Whitcroft } 1468cf655043SAndy Whitcroft $p = $c; 14698905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 147013214adfSAndy Whitcroft $remainder = substr($blk, $off); 14718905a67cSAndy Whitcroft 1472773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 14734635f4fbSAndy Whitcroft 14744635f4fbSAndy Whitcroft # Handle nested #if/#else. 14754635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 14764635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 14774635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 14784635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 14794635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 14804635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 14814635f4fbSAndy Whitcroft } 14824635f4fbSAndy Whitcroft 14838905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 14848905a67cSAndy Whitcroft # outermost level. 14858905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 14868905a67cSAndy Whitcroft last; 14878905a67cSAndy Whitcroft } 14888905a67cSAndy Whitcroft 148913214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1490773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1491773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1492773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1493773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1494773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1495773647a0SAndy Whitcroft $coff_set = 1; 1496773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1497773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 149813214adfSAndy Whitcroft } 149913214adfSAndy Whitcroft 15008905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 15018905a67cSAndy Whitcroft $level++; 15028905a67cSAndy Whitcroft $type = '('; 15038905a67cSAndy Whitcroft } 15048905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 15058905a67cSAndy Whitcroft $level--; 15068905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 15078905a67cSAndy Whitcroft 15088905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 15098905a67cSAndy Whitcroft $coff = $off; 1510773647a0SAndy Whitcroft $coff_set = 1; 1511773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 15128905a67cSAndy Whitcroft } 15138905a67cSAndy Whitcroft } 15148905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 15158905a67cSAndy Whitcroft $level++; 15168905a67cSAndy Whitcroft $type = '{'; 15178905a67cSAndy Whitcroft } 15188905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 15198905a67cSAndy Whitcroft $level--; 15208905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 15218905a67cSAndy Whitcroft 15228905a67cSAndy Whitcroft if ($level == 0) { 1523b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1524b998e001SPatrick Pannuto $off++; 1525b998e001SPatrick Pannuto } 15268905a67cSAndy Whitcroft last; 15278905a67cSAndy Whitcroft } 15288905a67cSAndy Whitcroft } 1529f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1530f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1531f74bd194SAndy Whitcroft $level--; 1532f74bd194SAndy Whitcroft $type = ''; 1533f74bd194SAndy Whitcroft $off++; 1534f74bd194SAndy Whitcroft last; 1535f74bd194SAndy Whitcroft } 15368905a67cSAndy Whitcroft $off++; 15378905a67cSAndy Whitcroft } 1538a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 153913214adfSAndy Whitcroft if ($off == $len) { 1540a3bb97a7SAndy Whitcroft $loff = $len + 1; 154113214adfSAndy Whitcroft $line++; 154213214adfSAndy Whitcroft $remain--; 154313214adfSAndy Whitcroft } 15448905a67cSAndy Whitcroft 15458905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 15468905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 15478905a67cSAndy Whitcroft 15488905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 15498905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 15508905a67cSAndy Whitcroft 1551773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 155213214adfSAndy Whitcroft 155313214adfSAndy Whitcroft return ($statement, $condition, 155413214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 155513214adfSAndy Whitcroft} 155613214adfSAndy Whitcroft 1557cf655043SAndy Whitcroftsub statement_lines { 1558cf655043SAndy Whitcroft my ($stmt) = @_; 1559cf655043SAndy Whitcroft 1560cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1561cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1562cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1563cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1564cf655043SAndy Whitcroft 1565cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1566cf655043SAndy Whitcroft 1567cf655043SAndy Whitcroft return $#stmt_lines + 2; 1568cf655043SAndy Whitcroft} 1569cf655043SAndy Whitcroft 1570cf655043SAndy Whitcroftsub statement_rawlines { 1571cf655043SAndy Whitcroft my ($stmt) = @_; 1572cf655043SAndy Whitcroft 1573cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1574cf655043SAndy Whitcroft 1575cf655043SAndy Whitcroft return $#stmt_lines + 2; 1576cf655043SAndy Whitcroft} 1577cf655043SAndy Whitcroft 1578cf655043SAndy Whitcroftsub statement_block_size { 1579cf655043SAndy Whitcroft my ($stmt) = @_; 1580cf655043SAndy Whitcroft 1581cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1582cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1583cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1584cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1585cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1586cf655043SAndy Whitcroft 1587cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1588cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1589cf655043SAndy Whitcroft 1590cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1591cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1592cf655043SAndy Whitcroft 1593cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1594cf655043SAndy Whitcroft return $stmt_lines; 1595cf655043SAndy Whitcroft } else { 1596cf655043SAndy Whitcroft return $stmt_statements; 1597cf655043SAndy Whitcroft } 1598cf655043SAndy Whitcroft} 1599cf655043SAndy Whitcroft 160013214adfSAndy Whitcroftsub ctx_statement_full { 160113214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 160213214adfSAndy Whitcroft my ($statement, $condition, $level); 160313214adfSAndy Whitcroft 160413214adfSAndy Whitcroft my (@chunks); 160513214adfSAndy Whitcroft 1606cf655043SAndy Whitcroft # Grab the first conditional/block pair. 160713214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 160813214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1609773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 161013214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1611cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1612cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1613cf655043SAndy Whitcroft } 1614cf655043SAndy Whitcroft 1615cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1616cf655043SAndy Whitcroft # could continue the statement. 1617cf655043SAndy Whitcroft for (;;) { 161813214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 161913214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1620cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1621773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1622cf655043SAndy Whitcroft #print "C: push\n"; 1623cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 162413214adfSAndy Whitcroft } 162513214adfSAndy Whitcroft 162613214adfSAndy Whitcroft return ($level, $linenr, @chunks); 16278905a67cSAndy Whitcroft} 16288905a67cSAndy Whitcroft 16294a0df2efSAndy Whitcroftsub ctx_block_get { 1630f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 16314a0df2efSAndy Whitcroft my $line; 16324a0df2efSAndy Whitcroft my $start = $linenr - 1; 16334a0df2efSAndy Whitcroft my $blk = ''; 16344a0df2efSAndy Whitcroft my @o; 16354a0df2efSAndy Whitcroft my @c; 16364a0df2efSAndy Whitcroft my @res = (); 16374a0df2efSAndy Whitcroft 1638f0a594c1SAndy Whitcroft my $level = 0; 16394635f4fbSAndy Whitcroft my @stack = ($level); 164000df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 164100df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 164200df344fSAndy Whitcroft $remain--; 164300df344fSAndy Whitcroft 164400df344fSAndy Whitcroft $blk .= $rawlines[$line]; 16454635f4fbSAndy Whitcroft 16464635f4fbSAndy Whitcroft # Handle nested #if/#else. 164701464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 16484635f4fbSAndy Whitcroft push(@stack, $level); 164901464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 16504635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 165101464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 16524635f4fbSAndy Whitcroft $level = pop(@stack); 16534635f4fbSAndy Whitcroft } 16544635f4fbSAndy Whitcroft 165501464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1656f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1657f0a594c1SAndy Whitcroft if ($off > 0) { 1658f0a594c1SAndy Whitcroft $off--; 1659f0a594c1SAndy Whitcroft next; 1660f0a594c1SAndy Whitcroft } 16614a0df2efSAndy Whitcroft 1662f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1663f0a594c1SAndy Whitcroft $level--; 1664f0a594c1SAndy Whitcroft last if ($level == 0); 1665f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1666f0a594c1SAndy Whitcroft $level++; 1667f0a594c1SAndy Whitcroft } 1668f0a594c1SAndy Whitcroft } 16694a0df2efSAndy Whitcroft 1670f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 167100df344fSAndy Whitcroft push(@res, $rawlines[$line]); 16724a0df2efSAndy Whitcroft } 16734a0df2efSAndy Whitcroft 1674f0a594c1SAndy Whitcroft last if ($level == 0); 16754a0df2efSAndy Whitcroft } 16764a0df2efSAndy Whitcroft 1677f0a594c1SAndy Whitcroft return ($level, @res); 16784a0df2efSAndy Whitcroft} 16794a0df2efSAndy Whitcroftsub ctx_block_outer { 16804a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 16814a0df2efSAndy Whitcroft 1682f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1683f0a594c1SAndy Whitcroft return @r; 16844a0df2efSAndy Whitcroft} 16854a0df2efSAndy Whitcroftsub ctx_block { 16864a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 16874a0df2efSAndy Whitcroft 1688f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1689f0a594c1SAndy Whitcroft return @r; 1690653d4876SAndy Whitcroft} 1691653d4876SAndy Whitcroftsub ctx_statement { 1692f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1693f0a594c1SAndy Whitcroft 1694f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1695f0a594c1SAndy Whitcroft return @r; 1696f0a594c1SAndy Whitcroft} 1697f0a594c1SAndy Whitcroftsub ctx_block_level { 1698653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1699653d4876SAndy Whitcroft 1700f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 17014a0df2efSAndy Whitcroft} 17029c0ca6f9SAndy Whitcroftsub ctx_statement_level { 17039c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 17049c0ca6f9SAndy Whitcroft 17059c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 17069c0ca6f9SAndy Whitcroft} 17074a0df2efSAndy Whitcroft 17084a0df2efSAndy Whitcroftsub ctx_locate_comment { 17094a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 17104a0df2efSAndy Whitcroft 1711a55ee0ccSJoe Perches # If c99 comment on the current line, or the line before or after 1712a55ee0ccSJoe Perches my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@); 1713a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1714a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@); 1715a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1716a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@); 1717a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1718a55ee0ccSJoe Perches 17194a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1720a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 17214a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 17224a0df2efSAndy Whitcroft 17234a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 17244a0df2efSAndy Whitcroft # comment. 17254a0df2efSAndy Whitcroft my $in_comment = 0; 17264a0df2efSAndy Whitcroft $current_comment = ''; 17274a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 172800df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 172900df344fSAndy Whitcroft #warn " $line\n"; 17304a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 17314a0df2efSAndy Whitcroft $in_comment = 1; 17324a0df2efSAndy Whitcroft } 17334a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 17344a0df2efSAndy Whitcroft $in_comment = 1; 17354a0df2efSAndy Whitcroft } 17364a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 17374a0df2efSAndy Whitcroft $current_comment = ''; 17384a0df2efSAndy Whitcroft } 17394a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 17404a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 17414a0df2efSAndy Whitcroft $in_comment = 0; 17424a0df2efSAndy Whitcroft } 17434a0df2efSAndy Whitcroft } 17444a0df2efSAndy Whitcroft 17454a0df2efSAndy Whitcroft chomp($current_comment); 17464a0df2efSAndy Whitcroft return($current_comment); 17474a0df2efSAndy Whitcroft} 17484a0df2efSAndy Whitcroftsub ctx_has_comment { 17494a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 17504a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 17514a0df2efSAndy Whitcroft 175200df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 17534a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 17544a0df2efSAndy Whitcroft 17554a0df2efSAndy Whitcroft return ($cmt ne ''); 17564a0df2efSAndy Whitcroft} 17574a0df2efSAndy Whitcroft 17584d001e4dSAndy Whitcroftsub raw_line { 17594d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 17604d001e4dSAndy Whitcroft 17614d001e4dSAndy Whitcroft my $offset = $linenr - 1; 17624d001e4dSAndy Whitcroft $cnt++; 17634d001e4dSAndy Whitcroft 17644d001e4dSAndy Whitcroft my $line; 17654d001e4dSAndy Whitcroft while ($cnt) { 17664d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 17674d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 17684d001e4dSAndy Whitcroft $cnt--; 17694d001e4dSAndy Whitcroft } 17704d001e4dSAndy Whitcroft 17714d001e4dSAndy Whitcroft return $line; 17724d001e4dSAndy Whitcroft} 17734d001e4dSAndy Whitcroft 17742a9f9d85STobin C. Hardingsub get_stat_real { 17752a9f9d85STobin C. Harding my ($linenr, $lc) = @_; 17762a9f9d85STobin C. Harding 17772a9f9d85STobin C. Harding my $stat_real = raw_line($linenr, 0); 17782a9f9d85STobin C. Harding for (my $count = $linenr + 1; $count <= $lc; $count++) { 17792a9f9d85STobin C. Harding $stat_real = $stat_real . "\n" . raw_line($count, 0); 17802a9f9d85STobin C. Harding } 17812a9f9d85STobin C. Harding 17822a9f9d85STobin C. Harding return $stat_real; 17832a9f9d85STobin C. Harding} 17842a9f9d85STobin C. Harding 1785e3d95a2aSTobin C. Hardingsub get_stat_here { 1786e3d95a2aSTobin C. Harding my ($linenr, $cnt, $here) = @_; 1787e3d95a2aSTobin C. Harding 1788e3d95a2aSTobin C. Harding my $herectx = $here . "\n"; 1789e3d95a2aSTobin C. Harding for (my $n = 0; $n < $cnt; $n++) { 1790e3d95a2aSTobin C. Harding $herectx .= raw_line($linenr, $n) . "\n"; 1791e3d95a2aSTobin C. Harding } 1792e3d95a2aSTobin C. Harding 1793e3d95a2aSTobin C. Harding return $herectx; 1794e3d95a2aSTobin C. Harding} 1795e3d95a2aSTobin C. Harding 17960a920b5bSAndy Whitcroftsub cat_vet { 17970a920b5bSAndy Whitcroft my ($vet) = @_; 17989c0ca6f9SAndy Whitcroft my ($res, $coded); 17990a920b5bSAndy Whitcroft 18009c0ca6f9SAndy Whitcroft $res = ''; 18016c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 18026c72ffaaSAndy Whitcroft $res .= $1; 18036c72ffaaSAndy Whitcroft if ($2 ne '') { 18049c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 18056c72ffaaSAndy Whitcroft $res .= $coded; 18066c72ffaaSAndy Whitcroft } 18079c0ca6f9SAndy Whitcroft } 18089c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 18090a920b5bSAndy Whitcroft 18109c0ca6f9SAndy Whitcroft return $res; 18110a920b5bSAndy Whitcroft} 18120a920b5bSAndy Whitcroft 1813c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1814cf655043SAndy Whitcroftmy $av_pending; 1815c2fdda0dSAndy Whitcroftmy @av_paren_type; 18161f65f947SAndy Whitcroftmy $av_pend_colon; 1817c2fdda0dSAndy Whitcroft 1818c2fdda0dSAndy Whitcroftsub annotate_reset { 1819c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1820cf655043SAndy Whitcroft $av_pending = '_'; 1821cf655043SAndy Whitcroft @av_paren_type = ('E'); 18221f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1823c2fdda0dSAndy Whitcroft} 1824c2fdda0dSAndy Whitcroft 18256c72ffaaSAndy Whitcroftsub annotate_values { 18266c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 18276c72ffaaSAndy Whitcroft 18286c72ffaaSAndy Whitcroft my $res; 18291f65f947SAndy Whitcroft my $var = '_' x length($stream); 18306c72ffaaSAndy Whitcroft my $cur = $stream; 18316c72ffaaSAndy Whitcroft 1832c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 18336c72ffaaSAndy Whitcroft 18346c72ffaaSAndy Whitcroft while (length($cur)) { 1835773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1836cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1837171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 18386c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1839c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1840c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1841cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1842c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 18436c72ffaaSAndy Whitcroft } 18446c72ffaaSAndy Whitcroft 1845c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 18469446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 18479446ef56SAndy Whitcroft push(@av_paren_type, $type); 1848addcdceaSAndy Whitcroft $type = 'c'; 18499446ef56SAndy Whitcroft 1850e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1851c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 18526c72ffaaSAndy Whitcroft $type = 'T'; 18536c72ffaaSAndy Whitcroft 1854389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1855389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1856389a2fe5SAndy Whitcroft $type = 'T'; 1857389a2fe5SAndy Whitcroft 1858c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1859171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1860c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1861171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1862171ae1a4SAndy Whitcroft if ($2 ne '') { 1863cf655043SAndy Whitcroft $av_pending = 'N'; 1864171ae1a4SAndy Whitcroft } 1865171ae1a4SAndy Whitcroft $type = 'E'; 1866171ae1a4SAndy Whitcroft 1867c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1868171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1869171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1870171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 18716c72ffaaSAndy Whitcroft 1872c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1873cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1874c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1875cf655043SAndy Whitcroft 1876cf655043SAndy Whitcroft push(@av_paren_type, $type); 1877cf655043SAndy Whitcroft push(@av_paren_type, $type); 1878171ae1a4SAndy Whitcroft $type = 'E'; 1879cf655043SAndy Whitcroft 1880c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1881cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1882cf655043SAndy Whitcroft $av_preprocessor = 1; 1883cf655043SAndy Whitcroft 1884cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1885cf655043SAndy Whitcroft 1886171ae1a4SAndy Whitcroft $type = 'E'; 1887cf655043SAndy Whitcroft 1888c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1889cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1890cf655043SAndy Whitcroft 1891cf655043SAndy Whitcroft $av_preprocessor = 1; 1892cf655043SAndy Whitcroft 1893cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1894cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1895cf655043SAndy Whitcroft pop(@av_paren_type); 1896cf655043SAndy Whitcroft push(@av_paren_type, $type); 1897171ae1a4SAndy Whitcroft $type = 'E'; 18986c72ffaaSAndy Whitcroft 18996c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1900c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 19016c72ffaaSAndy Whitcroft 1902171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1903171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1904171ae1a4SAndy Whitcroft $av_pending = $type; 1905171ae1a4SAndy Whitcroft $type = 'N'; 1906171ae1a4SAndy Whitcroft 19076c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1908c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 19096c72ffaaSAndy Whitcroft if (defined $2) { 1910cf655043SAndy Whitcroft $av_pending = 'V'; 19116c72ffaaSAndy Whitcroft } 19126c72ffaaSAndy Whitcroft $type = 'N'; 19136c72ffaaSAndy Whitcroft 191414b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1915c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 191614b111c1SAndy Whitcroft $av_pending = 'E'; 19176c72ffaaSAndy Whitcroft $type = 'N'; 19186c72ffaaSAndy Whitcroft 19191f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 19201f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 19211f65f947SAndy Whitcroft $av_pend_colon = 'C'; 19221f65f947SAndy Whitcroft $type = 'N'; 19231f65f947SAndy Whitcroft 192414b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1925c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 19266c72ffaaSAndy Whitcroft $type = 'N'; 19276c72ffaaSAndy Whitcroft 19286c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1929c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1930cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1931cf655043SAndy Whitcroft $av_pending = '_'; 19326c72ffaaSAndy Whitcroft $type = 'N'; 19336c72ffaaSAndy Whitcroft 19346c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1935cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1936cf655043SAndy Whitcroft if ($new_type ne '_') { 1937cf655043SAndy Whitcroft $type = $new_type; 1938c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1939c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 19406c72ffaaSAndy Whitcroft } else { 1941c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 19426c72ffaaSAndy Whitcroft } 19436c72ffaaSAndy Whitcroft 1944c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1945c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1946c8cb2ca3SAndy Whitcroft $type = 'V'; 1947cf655043SAndy Whitcroft $av_pending = 'V'; 19486c72ffaaSAndy Whitcroft 19498e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 19508e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 19511f65f947SAndy Whitcroft $av_pend_colon = 'B'; 19528e761b04SAndy Whitcroft } elsif ($type eq 'E') { 19538e761b04SAndy Whitcroft $av_pend_colon = 'L'; 19541f65f947SAndy Whitcroft } 19551f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 19561f65f947SAndy Whitcroft $type = 'V'; 19571f65f947SAndy Whitcroft 19586c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1959c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 19606c72ffaaSAndy Whitcroft $type = 'V'; 19616c72ffaaSAndy Whitcroft 19626c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1963c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 19646c72ffaaSAndy Whitcroft $type = 'N'; 19656c72ffaaSAndy Whitcroft 1966cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1967c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 196813214adfSAndy Whitcroft $type = 'E'; 19691f65f947SAndy Whitcroft $av_pend_colon = 'O'; 197013214adfSAndy Whitcroft 19718e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 19728e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 19738e761b04SAndy Whitcroft $type = 'C'; 19748e761b04SAndy Whitcroft 19751f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 19761f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 19771f65f947SAndy Whitcroft $type = 'N'; 19781f65f947SAndy Whitcroft 19791f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 19801f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 19811f65f947SAndy Whitcroft 19821f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 19831f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 19841f65f947SAndy Whitcroft $type = 'E'; 19851f65f947SAndy Whitcroft } else { 19861f65f947SAndy Whitcroft $type = 'N'; 19871f65f947SAndy Whitcroft } 19881f65f947SAndy Whitcroft $av_pend_colon = 'O'; 19891f65f947SAndy Whitcroft 19908e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 199113214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 19926c72ffaaSAndy Whitcroft $type = 'N'; 19936c72ffaaSAndy Whitcroft 19940d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 199574048ed8SAndy Whitcroft my $variant; 199674048ed8SAndy Whitcroft 199774048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 199874048ed8SAndy Whitcroft if ($type eq 'V') { 199974048ed8SAndy Whitcroft $variant = 'B'; 200074048ed8SAndy Whitcroft } else { 200174048ed8SAndy Whitcroft $variant = 'U'; 200274048ed8SAndy Whitcroft } 200374048ed8SAndy Whitcroft 200474048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 200574048ed8SAndy Whitcroft $type = 'N'; 200674048ed8SAndy Whitcroft 20076c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 2008c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 20096c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 20106c72ffaaSAndy Whitcroft $type = 'N'; 20116c72ffaaSAndy Whitcroft } 20126c72ffaaSAndy Whitcroft 20136c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 2014c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 20156c72ffaaSAndy Whitcroft } 20166c72ffaaSAndy Whitcroft if (defined $1) { 20176c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 20186c72ffaaSAndy Whitcroft $res .= $type x length($1); 20196c72ffaaSAndy Whitcroft } 20206c72ffaaSAndy Whitcroft } 20216c72ffaaSAndy Whitcroft 20221f65f947SAndy Whitcroft return ($res, $var); 20236c72ffaaSAndy Whitcroft} 20246c72ffaaSAndy Whitcroft 20258905a67cSAndy Whitcroftsub possible { 202613214adfSAndy Whitcroft my ($possible, $line) = @_; 20279a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 20280776e594SAndy Whitcroft ^(?: 20290776e594SAndy Whitcroft $Modifier| 20300776e594SAndy Whitcroft $Storage| 20310776e594SAndy Whitcroft $Type| 20329a974fdbSAndy Whitcroft DEFINE_\S+ 20339a974fdbSAndy Whitcroft )$| 20349a974fdbSAndy Whitcroft ^(?: 20350776e594SAndy Whitcroft goto| 20360776e594SAndy Whitcroft return| 20370776e594SAndy Whitcroft case| 20380776e594SAndy Whitcroft else| 20390776e594SAndy Whitcroft asm|__asm__| 204089a88353SAndy Whitcroft do| 204189a88353SAndy Whitcroft \#| 204289a88353SAndy Whitcroft \#\#| 20439a974fdbSAndy Whitcroft )(?:\s|$)| 20440776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 20459a974fdbSAndy Whitcroft )}x; 20469a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 20479a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 2048c45dcabdSAndy Whitcroft # Check for modifiers. 2049c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 2050c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 2051c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 2052c45dcabdSAndy Whitcroft 2053c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 2054c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 2055d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 20569a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 2057d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 2058485ff23eSAlex Dowad push(@modifierListFile, $modifier); 2059d2506586SAndy Whitcroft } 20609a974fdbSAndy Whitcroft } 2061c45dcabdSAndy Whitcroft 2062c45dcabdSAndy Whitcroft } else { 206313214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 2064485ff23eSAlex Dowad push(@typeListFile, $possible); 2065c45dcabdSAndy Whitcroft } 20668905a67cSAndy Whitcroft build_types(); 20670776e594SAndy Whitcroft } else { 20680776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 20698905a67cSAndy Whitcroft } 20708905a67cSAndy Whitcroft} 20718905a67cSAndy Whitcroft 20726c72ffaaSAndy Whitcroftmy $prefix = ''; 20736c72ffaaSAndy Whitcroft 2074000d1cc1SJoe Perchessub show_type { 2075cbec18afSJoe Perches my ($type) = @_; 207691bfe484SJoe Perches 2077522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 2078522b837cSAlexey Dobriyan 2079cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 2080cbec18afSJoe Perches 2081cbec18afSJoe Perches return !defined $ignore_type{$type}; 2082000d1cc1SJoe Perches} 2083000d1cc1SJoe Perches 2084f0a594c1SAndy Whitcroftsub report { 2085cbec18afSJoe Perches my ($level, $type, $msg) = @_; 2086cbec18afSJoe Perches 2087cbec18afSJoe Perches if (!show_type($type) || 2088cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 2089773647a0SAndy Whitcroft return 0; 2090773647a0SAndy Whitcroft } 209157230297SJoe Perches my $output = ''; 2092737c0767SJohn Brooks if ($color) { 209357230297SJoe Perches if ($level eq 'ERROR') { 209457230297SJoe Perches $output .= RED; 209557230297SJoe Perches } elsif ($level eq 'WARNING') { 209657230297SJoe Perches $output .= YELLOW; 2097000d1cc1SJoe Perches } else { 209857230297SJoe Perches $output .= GREEN; 2099000d1cc1SJoe Perches } 210057230297SJoe Perches } 210157230297SJoe Perches $output .= $prefix . $level . ':'; 210257230297SJoe Perches if ($show_types) { 2103737c0767SJohn Brooks $output .= BLUE if ($color); 210457230297SJoe Perches $output .= "$type:"; 210557230297SJoe Perches } 2106737c0767SJohn Brooks $output .= RESET if ($color); 210757230297SJoe Perches $output .= ' ' . $msg . "\n"; 210834d8815fSJoe Perches 210934d8815fSJoe Perches if ($showfile) { 211034d8815fSJoe Perches my @lines = split("\n", $output, -1); 211134d8815fSJoe Perches splice(@lines, 1, 1); 211234d8815fSJoe Perches $output = join("\n", @lines); 211334d8815fSJoe Perches } 211457230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 21158905a67cSAndy Whitcroft 211657230297SJoe Perches push(our @report, $output); 2117773647a0SAndy Whitcroft 2118773647a0SAndy Whitcroft return 1; 2119f0a594c1SAndy Whitcroft} 2120cbec18afSJoe Perches 2121f0a594c1SAndy Whitcroftsub report_dump { 212213214adfSAndy Whitcroft our @report; 2123f0a594c1SAndy Whitcroft} 2124000d1cc1SJoe Perches 2125d752fcc8SJoe Perchessub fixup_current_range { 2126d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 2127d752fcc8SJoe Perches 2128d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 2129d752fcc8SJoe Perches my $o = $1; 2130d752fcc8SJoe Perches my $l = $2; 2131d752fcc8SJoe Perches my $no = $o + $offset; 2132d752fcc8SJoe Perches my $nl = $l + $length; 2133d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 2134d752fcc8SJoe Perches } 2135d752fcc8SJoe Perches} 2136d752fcc8SJoe Perches 2137d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 2138d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 2139d752fcc8SJoe Perches 2140d752fcc8SJoe Perches my $range_last_linenr = 0; 2141d752fcc8SJoe Perches my $delta_offset = 0; 2142d752fcc8SJoe Perches 2143d752fcc8SJoe Perches my $old_linenr = 0; 2144d752fcc8SJoe Perches my $new_linenr = 0; 2145d752fcc8SJoe Perches 2146d752fcc8SJoe Perches my $next_insert = 0; 2147d752fcc8SJoe Perches my $next_delete = 0; 2148d752fcc8SJoe Perches 2149d752fcc8SJoe Perches my @lines = (); 2150d752fcc8SJoe Perches 2151d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 2152d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 2153d752fcc8SJoe Perches 2154d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 2155d752fcc8SJoe Perches my $save_line = 1; 2156d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 2157323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2158d752fcc8SJoe Perches $delta_offset = 0; 2159d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2160d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 2161d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 2162d752fcc8SJoe Perches } 2163d752fcc8SJoe Perches 2164d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2165d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 2166d752fcc8SJoe Perches $save_line = 0; 2167d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2168d752fcc8SJoe Perches } 2169d752fcc8SJoe Perches 2170d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2171d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 2172d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 2173d752fcc8SJoe Perches $new_linenr++; 2174d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2175d752fcc8SJoe Perches } 2176d752fcc8SJoe Perches 2177d752fcc8SJoe Perches if ($save_line) { 2178d752fcc8SJoe Perches push(@lines, $line); 2179d752fcc8SJoe Perches $new_linenr++; 2180d752fcc8SJoe Perches } 2181d752fcc8SJoe Perches 2182d752fcc8SJoe Perches $old_linenr++; 2183d752fcc8SJoe Perches } 2184d752fcc8SJoe Perches 2185d752fcc8SJoe Perches return @lines; 2186d752fcc8SJoe Perches} 2187d752fcc8SJoe Perches 2188f2d7e4d4SJoe Perchessub fix_insert_line { 2189f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2190f2d7e4d4SJoe Perches 2191f2d7e4d4SJoe Perches my $inserted = { 2192f2d7e4d4SJoe Perches LINENR => $linenr, 2193f2d7e4d4SJoe Perches LINE => $line, 2194f2d7e4d4SJoe Perches }; 2195f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2196f2d7e4d4SJoe Perches} 2197f2d7e4d4SJoe Perches 2198f2d7e4d4SJoe Perchessub fix_delete_line { 2199f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2200f2d7e4d4SJoe Perches 2201f2d7e4d4SJoe Perches my $deleted = { 2202f2d7e4d4SJoe Perches LINENR => $linenr, 2203f2d7e4d4SJoe Perches LINE => $line, 2204f2d7e4d4SJoe Perches }; 2205f2d7e4d4SJoe Perches 2206f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2207f2d7e4d4SJoe Perches} 2208f2d7e4d4SJoe Perches 2209de7d4f0eSAndy Whitcroftsub ERROR { 2210cbec18afSJoe Perches my ($type, $msg) = @_; 2211cbec18afSJoe Perches 2212cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2213de7d4f0eSAndy Whitcroft our $clean = 0; 22146c72ffaaSAndy Whitcroft our $cnt_error++; 22153705ce5bSJoe Perches return 1; 2216de7d4f0eSAndy Whitcroft } 22173705ce5bSJoe Perches return 0; 2218773647a0SAndy Whitcroft} 2219de7d4f0eSAndy Whitcroftsub WARN { 2220cbec18afSJoe Perches my ($type, $msg) = @_; 2221cbec18afSJoe Perches 2222cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2223de7d4f0eSAndy Whitcroft our $clean = 0; 22246c72ffaaSAndy Whitcroft our $cnt_warn++; 22253705ce5bSJoe Perches return 1; 2226de7d4f0eSAndy Whitcroft } 22273705ce5bSJoe Perches return 0; 2228773647a0SAndy Whitcroft} 2229de7d4f0eSAndy Whitcroftsub CHK { 2230cbec18afSJoe Perches my ($type, $msg) = @_; 2231cbec18afSJoe Perches 2232cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2233de7d4f0eSAndy Whitcroft our $clean = 0; 22346c72ffaaSAndy Whitcroft our $cnt_chk++; 22353705ce5bSJoe Perches return 1; 22366c72ffaaSAndy Whitcroft } 22373705ce5bSJoe Perches return 0; 2238de7d4f0eSAndy Whitcroft} 2239de7d4f0eSAndy Whitcroft 22406ecd9674SAndy Whitcroftsub check_absolute_file { 22416ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 22426ecd9674SAndy Whitcroft my $file = $absolute; 22436ecd9674SAndy Whitcroft 22446ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 22456ecd9674SAndy Whitcroft 22466ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 22476ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 22486ecd9674SAndy Whitcroft if (-f "$root/$file") { 22496ecd9674SAndy Whitcroft ##print "file<$file>\n"; 22506ecd9674SAndy Whitcroft last; 22516ecd9674SAndy Whitcroft } 22526ecd9674SAndy Whitcroft } 22536ecd9674SAndy Whitcroft if (! -f _) { 22546ecd9674SAndy Whitcroft return 0; 22556ecd9674SAndy Whitcroft } 22566ecd9674SAndy Whitcroft 22576ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 22586ecd9674SAndy Whitcroft my $prefix = $absolute; 22596ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 22606ecd9674SAndy Whitcroft 22616ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 22626ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2263000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2264000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 22656ecd9674SAndy Whitcroft } 22666ecd9674SAndy Whitcroft} 22676ecd9674SAndy Whitcroft 22683705ce5bSJoe Perchessub trim { 22693705ce5bSJoe Perches my ($string) = @_; 22703705ce5bSJoe Perches 2271b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2272b34c648bSJoe Perches 2273b34c648bSJoe Perches return $string; 2274b34c648bSJoe Perches} 2275b34c648bSJoe Perches 2276b34c648bSJoe Perchessub ltrim { 2277b34c648bSJoe Perches my ($string) = @_; 2278b34c648bSJoe Perches 2279b34c648bSJoe Perches $string =~ s/^\s+//; 2280b34c648bSJoe Perches 2281b34c648bSJoe Perches return $string; 2282b34c648bSJoe Perches} 2283b34c648bSJoe Perches 2284b34c648bSJoe Perchessub rtrim { 2285b34c648bSJoe Perches my ($string) = @_; 2286b34c648bSJoe Perches 2287b34c648bSJoe Perches $string =~ s/\s+$//; 22883705ce5bSJoe Perches 22893705ce5bSJoe Perches return $string; 22903705ce5bSJoe Perches} 22913705ce5bSJoe Perches 229252ea8506SJoe Perchessub string_find_replace { 229352ea8506SJoe Perches my ($string, $find, $replace) = @_; 229452ea8506SJoe Perches 229552ea8506SJoe Perches $string =~ s/$find/$replace/g; 229652ea8506SJoe Perches 229752ea8506SJoe Perches return $string; 229852ea8506SJoe Perches} 229952ea8506SJoe Perches 23003705ce5bSJoe Perchessub tabify { 23013705ce5bSJoe Perches my ($leading) = @_; 23023705ce5bSJoe Perches 2303713a09deSAntonio Borneo my $source_indent = $tabsize; 23043705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 23053705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 23063705ce5bSJoe Perches 23073705ce5bSJoe Perches #convert leading spaces to tabs 23083705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 23093705ce5bSJoe Perches #Remove spaces before a tab 23103705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 23113705ce5bSJoe Perches 23123705ce5bSJoe Perches return "$leading"; 23133705ce5bSJoe Perches} 23143705ce5bSJoe Perches 2315d1fe9c09SJoe Perchessub pos_last_openparen { 2316d1fe9c09SJoe Perches my ($line) = @_; 2317d1fe9c09SJoe Perches 2318d1fe9c09SJoe Perches my $pos = 0; 2319d1fe9c09SJoe Perches 2320d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2321d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2322d1fe9c09SJoe Perches 2323d1fe9c09SJoe Perches my $last_openparen = 0; 2324d1fe9c09SJoe Perches 2325d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2326d1fe9c09SJoe Perches return -1; 2327d1fe9c09SJoe Perches } 2328d1fe9c09SJoe Perches 2329d1fe9c09SJoe Perches my $len = length($line); 2330d1fe9c09SJoe Perches 2331d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2332d1fe9c09SJoe Perches my $string = substr($line, $pos); 2333d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2334d1fe9c09SJoe Perches $pos += length($1) - 1; 2335d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2336d1fe9c09SJoe Perches $last_openparen = $pos; 2337d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2338d1fe9c09SJoe Perches last; 2339d1fe9c09SJoe Perches } 2340d1fe9c09SJoe Perches } 2341d1fe9c09SJoe Perches 234291cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2343d1fe9c09SJoe Perches} 2344d1fe9c09SJoe Perches 2345f36d3eb8SJoe Perchessub get_raw_comment { 2346f36d3eb8SJoe Perches my ($line, $rawline) = @_; 2347f36d3eb8SJoe Perches my $comment = ''; 2348f36d3eb8SJoe Perches 2349f36d3eb8SJoe Perches for my $i (0 .. (length($line) - 1)) { 2350f36d3eb8SJoe Perches if (substr($line, $i, 1) eq "$;") { 2351f36d3eb8SJoe Perches $comment .= substr($rawline, $i, 1); 2352f36d3eb8SJoe Perches } 2353f36d3eb8SJoe Perches } 2354f36d3eb8SJoe Perches 2355f36d3eb8SJoe Perches return $comment; 2356f36d3eb8SJoe Perches} 2357f36d3eb8SJoe Perches 23580a920b5bSAndy Whitcroftsub process { 23590a920b5bSAndy Whitcroft my $filename = shift; 23600a920b5bSAndy Whitcroft 23610a920b5bSAndy Whitcroft my $linenr=0; 23620a920b5bSAndy Whitcroft my $prevline=""; 2363c2fdda0dSAndy Whitcroft my $prevrawline=""; 23640a920b5bSAndy Whitcroft my $stashline=""; 2365c2fdda0dSAndy Whitcroft my $stashrawline=""; 23660a920b5bSAndy Whitcroft 23674a0df2efSAndy Whitcroft my $length; 23680a920b5bSAndy Whitcroft my $indent; 23690a920b5bSAndy Whitcroft my $previndent=0; 23700a920b5bSAndy Whitcroft my $stashindent=0; 23710a920b5bSAndy Whitcroft 2372de7d4f0eSAndy Whitcroft our $clean = 1; 23730a920b5bSAndy Whitcroft my $signoff = 0; 2374cd261496SGeert Uytterhoeven my $author = ''; 2375cd261496SGeert Uytterhoeven my $authorsignoff = 0; 2376*48ca2d8aSDwaipayan Ray my $author_sob = ''; 23770a920b5bSAndy Whitcroft my $is_patch = 0; 2378133712a2SRob Herring my $is_binding_patch = -1; 237929ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 238015662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 238144d303ebSJoe Perches my $has_patch_separator = 0; #Found a --- line 2382ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2383490b292cSJoe Perches my $commit_log_lines = 0; #Number of commit log lines 2384bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 23852a076f40SJoe Perches my $commit_log_long_line = 0; 2386e518e9a5SJoe Perches my $commit_log_has_diff = 0; 238713f1937eSJoe Perches my $reported_maintainer_file = 0; 2388fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2389fa64205dSPasi Savanainen 2390365dd4eaSJoe Perches my $last_blank_line = 0; 23915e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2392365dd4eaSJoe Perches 239313214adfSAndy Whitcroft our @report = (); 23946c72ffaaSAndy Whitcroft our $cnt_lines = 0; 23956c72ffaaSAndy Whitcroft our $cnt_error = 0; 23966c72ffaaSAndy Whitcroft our $cnt_warn = 0; 23976c72ffaaSAndy Whitcroft our $cnt_chk = 0; 23986c72ffaaSAndy Whitcroft 23990a920b5bSAndy Whitcroft # Trace the real file/line as we go. 24000a920b5bSAndy Whitcroft my $realfile = ''; 24010a920b5bSAndy Whitcroft my $realline = 0; 24020a920b5bSAndy Whitcroft my $realcnt = 0; 24030a920b5bSAndy Whitcroft my $here = ''; 240477cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 24050a920b5bSAndy Whitcroft my $in_comment = 0; 2406c2fdda0dSAndy Whitcroft my $comment_edge = 0; 24070a920b5bSAndy Whitcroft my $first_line = 0; 24081e855726SWolfram Sang my $p1_prefix = ''; 24090a920b5bSAndy Whitcroft 241013214adfSAndy Whitcroft my $prev_values = 'E'; 241113214adfSAndy Whitcroft 241213214adfSAndy Whitcroft # suppression flags 2413773647a0SAndy Whitcroft my %suppress_ifbraces; 2414170d3a22SAndy Whitcroft my %suppress_whiletrailers; 24152b474a1aSAndy Whitcroft my %suppress_export; 24163e469cdcSAndy Whitcroft my $suppress_statement = 0; 2417653d4876SAndy Whitcroft 24187e51f197SJoe Perches my %signatures = (); 2419323c1260SJoe Perches 2420c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2421de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2422c2fdda0dSAndy Whitcroft # 2423de7d4f0eSAndy Whitcroft my @setup_docs = (); 2424de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2425773647a0SAndy Whitcroft 2426d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2427d8b07710SJoe Perches 24289f3a8992SRob Herring my $checklicenseline = 1; 24299f3a8992SRob Herring 2430773647a0SAndy Whitcroft sanitise_line_reset(); 2431c2fdda0dSAndy Whitcroft my $line; 2432c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2433773647a0SAndy Whitcroft $linenr++; 2434773647a0SAndy Whitcroft $line = $rawline; 2435c2fdda0dSAndy Whitcroft 24363705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 24373705ce5bSJoe Perches 2438773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2439de7d4f0eSAndy Whitcroft $setup_docs = 0; 24402581ac7cSTim Froidcoeur if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) { 2441de7d4f0eSAndy Whitcroft $setup_docs = 1; 2442de7d4f0eSAndy Whitcroft } 2443773647a0SAndy Whitcroft #next; 2444de7d4f0eSAndy Whitcroft } 244574fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2446773647a0SAndy Whitcroft $realline=$1-1; 2447773647a0SAndy Whitcroft if (defined $2) { 2448773647a0SAndy Whitcroft $realcnt=$3+1; 2449773647a0SAndy Whitcroft } else { 2450773647a0SAndy Whitcroft $realcnt=1+1; 2451773647a0SAndy Whitcroft } 2452c45dcabdSAndy Whitcroft $in_comment = 0; 2453773647a0SAndy Whitcroft 2454773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2455773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2456773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2457773647a0SAndy Whitcroft # at context start. 2458773647a0SAndy Whitcroft my $edge; 245901fa9147SAndy Whitcroft my $cnt = $realcnt; 246001fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 246101fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 246201fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 246301fa9147SAndy Whitcroft $cnt--; 246401fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2465721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2466fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2467fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2468fae17daeSAndy Whitcroft ($edge) = $1; 2469fae17daeSAndy Whitcroft last; 2470fae17daeSAndy Whitcroft } 2471773647a0SAndy Whitcroft } 2472773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2473773647a0SAndy Whitcroft $in_comment = 1; 2474773647a0SAndy Whitcroft } 2475773647a0SAndy Whitcroft 2476773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2477773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2478773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2479773647a0SAndy Whitcroft if (!defined $edge && 248083242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2481773647a0SAndy Whitcroft { 2482773647a0SAndy Whitcroft $in_comment = 1; 2483773647a0SAndy Whitcroft } 2484773647a0SAndy Whitcroft 2485773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2486773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2487773647a0SAndy Whitcroft 2488171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2489773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2490171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2491773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2492773647a0SAndy Whitcroft } 2493773647a0SAndy Whitcroft push(@lines, $line); 2494773647a0SAndy Whitcroft 2495773647a0SAndy Whitcroft if ($realcnt > 1) { 2496773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2497773647a0SAndy Whitcroft } else { 2498773647a0SAndy Whitcroft $realcnt = 0; 2499773647a0SAndy Whitcroft } 2500773647a0SAndy Whitcroft 2501773647a0SAndy Whitcroft #print "==>$rawline\n"; 2502773647a0SAndy Whitcroft #print "-->$line\n"; 2503de7d4f0eSAndy Whitcroft 2504de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2505de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2506de7d4f0eSAndy Whitcroft } 2507de7d4f0eSAndy Whitcroft } 2508de7d4f0eSAndy Whitcroft 25096c72ffaaSAndy Whitcroft $prefix = ''; 25106c72ffaaSAndy Whitcroft 2511773647a0SAndy Whitcroft $realcnt = 0; 2512773647a0SAndy Whitcroft $linenr = 0; 2513194f66fcSJoe Perches $fixlinenr = -1; 25140a920b5bSAndy Whitcroft foreach my $line (@lines) { 25150a920b5bSAndy Whitcroft $linenr++; 2516194f66fcSJoe Perches $fixlinenr++; 25171b5539b1SJoe Perches my $sline = $line; #copy of $line 25181b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 25190a920b5bSAndy Whitcroft 2520c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 2521f36d3eb8SJoe Perches my $raw_comment = get_raw_comment($line, $rawline); 25226c72ffaaSAndy Whitcroft 252312c253abSJoe Perches# check if it's a mode change, rename or start of a patch 252412c253abSJoe Perches if (!$in_commit_log && 252512c253abSJoe Perches ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 252612c253abSJoe Perches ($line =~ /^rename (?:from|to) \S+\s*$/ || 252712c253abSJoe Perches $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 252812c253abSJoe Perches $is_patch = 1; 252912c253abSJoe Perches } 253012c253abSJoe Perches 25310a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2532e518e9a5SJoe Perches if (!$in_commit_log && 253374fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 253474fd4f34SJoe Perches my $context = $4; 25350a920b5bSAndy Whitcroft $is_patch = 1; 25364a0df2efSAndy Whitcroft $first_line = $linenr + 1; 25370a920b5bSAndy Whitcroft $realline=$1-1; 25380a920b5bSAndy Whitcroft if (defined $2) { 25390a920b5bSAndy Whitcroft $realcnt=$3+1; 25400a920b5bSAndy Whitcroft } else { 25410a920b5bSAndy Whitcroft $realcnt=1+1; 25420a920b5bSAndy Whitcroft } 2543c2fdda0dSAndy Whitcroft annotate_reset(); 254413214adfSAndy Whitcroft $prev_values = 'E'; 254513214adfSAndy Whitcroft 2546773647a0SAndy Whitcroft %suppress_ifbraces = (); 2547170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 25482b474a1aSAndy Whitcroft %suppress_export = (); 25493e469cdcSAndy Whitcroft $suppress_statement = 0; 255074fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 255174fd4f34SJoe Perches $context_function = $1; 255274fd4f34SJoe Perches } else { 255374fd4f34SJoe Perches undef $context_function; 255474fd4f34SJoe Perches } 25550a920b5bSAndy Whitcroft next; 25560a920b5bSAndy Whitcroft 25574a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 25584a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 25594a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2560773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 25610a920b5bSAndy Whitcroft $realline++; 2562d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 25630a920b5bSAndy Whitcroft 25644a0df2efSAndy Whitcroft # Measure the line length and indent. 2565c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 25660a920b5bSAndy Whitcroft 25670a920b5bSAndy Whitcroft # Track the previous line. 25680a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 25690a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2570c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2571c2fdda0dSAndy Whitcroft 2572773647a0SAndy Whitcroft #warn "line<$line>\n"; 25736c72ffaaSAndy Whitcroft 2574d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2575d8aaf121SAndy Whitcroft $realcnt--; 25760a920b5bSAndy Whitcroft } 25770a920b5bSAndy Whitcroft 2578cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2579cc77cdcaSAndy Whitcroft 25806c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 25816c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2582773647a0SAndy Whitcroft 25832ac73b4fSJoe Perches my $found_file = 0; 2584773647a0SAndy Whitcroft # extract the filename as it passes 25853bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 25863bf9a009SRabin Vincent $realfile = $1; 25872b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2588270c49a0SJoe Perches $in_commit_log = 0; 25892ac73b4fSJoe Perches $found_file = 1; 25903bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2591773647a0SAndy Whitcroft $realfile = $1; 25922b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2593270c49a0SJoe Perches $in_commit_log = 0; 25941e855726SWolfram Sang 25951e855726SWolfram Sang $p1_prefix = $1; 2596e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2597e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2598000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2599000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 26001e855726SWolfram Sang } 2601773647a0SAndy Whitcroft 2602c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2603000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2604000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2605773647a0SAndy Whitcroft } 26062ac73b4fSJoe Perches $found_file = 1; 26072ac73b4fSJoe Perches } 26082ac73b4fSJoe Perches 260934d8815fSJoe Perches#make up the handle for any error we report on this line 261034d8815fSJoe Perches if ($showfile) { 261134d8815fSJoe Perches $prefix = "$realfile:$realline: " 261234d8815fSJoe Perches } elsif ($emacs) { 26137d3a9f67SJoe Perches if ($file) { 26147d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 26157d3a9f67SJoe Perches } else { 261634d8815fSJoe Perches $prefix = "$filename:$linenr: "; 261734d8815fSJoe Perches } 26187d3a9f67SJoe Perches } 261934d8815fSJoe Perches 26202ac73b4fSJoe Perches if ($found_file) { 262185b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 262285b0ee18SJoe Perches WARN("OBSOLETE", 262385b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 262485b0ee18SJoe Perches } 26257bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 26262ac73b4fSJoe Perches $check = 1; 26272ac73b4fSJoe Perches } else { 26282ac73b4fSJoe Perches $check = $check_orig; 26292ac73b4fSJoe Perches } 26309f3a8992SRob Herring $checklicenseline = 1; 2631133712a2SRob Herring 2632133712a2SRob Herring if ($realfile !~ /^MAINTAINERS/) { 2633133712a2SRob Herring my $last_binding_patch = $is_binding_patch; 2634133712a2SRob Herring 2635133712a2SRob Herring $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@; 2636133712a2SRob Herring 2637133712a2SRob Herring if (($last_binding_patch != -1) && 2638133712a2SRob Herring ($last_binding_patch ^ $is_binding_patch)) { 2639133712a2SRob Herring WARN("DT_SPLIT_BINDING_PATCH", 2640858e6845SMauro Carvalho Chehab "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n"); 2641133712a2SRob Herring } 2642133712a2SRob Herring } 2643133712a2SRob Herring 2644773647a0SAndy Whitcroft next; 2645773647a0SAndy Whitcroft } 2646773647a0SAndy Whitcroft 2647389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 26480a920b5bSAndy Whitcroft 2649c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2650c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2651c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 26520a920b5bSAndy Whitcroft 26536c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 26546c72ffaaSAndy Whitcroft 2655490b292cSJoe Perches# Verify the existence of a commit log if appropriate 2656490b292cSJoe Perches# 2 is used because a $signature is counted in $commit_log_lines 2657490b292cSJoe Perches if ($in_commit_log) { 2658490b292cSJoe Perches if ($line !~ /^\s*$/) { 2659490b292cSJoe Perches $commit_log_lines++; #could be a $signature 2660490b292cSJoe Perches } 2661490b292cSJoe Perches } elsif ($has_commit_log && $commit_log_lines < 2) { 2662490b292cSJoe Perches WARN("COMMIT_MESSAGE", 2663490b292cSJoe Perches "Missing commit description - Add an appropriate one\n"); 2664490b292cSJoe Perches $commit_log_lines = 2; #warn only once 2665490b292cSJoe Perches } 2666490b292cSJoe Perches 2667e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2668e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 266913e45417SMrinal Pandey (($line =~ m@^\s+diff\b.*a/([\w/]+)@ && 267013e45417SMrinal Pandey $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) || 2671e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2672e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2673e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2674e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2675e518e9a5SJoe Perches $commit_log_has_diff = 1; 2676e518e9a5SJoe Perches } 2677e518e9a5SJoe Perches 26783bf9a009SRabin Vincent# Check for incorrect file permissions 26793bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 26803bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 268104db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 268204db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2683000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2684000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 26853bf9a009SRabin Vincent } 26863bf9a009SRabin Vincent } 26873bf9a009SRabin Vincent 2688cd261496SGeert Uytterhoeven# Check the patch for a From: 2689cd261496SGeert Uytterhoeven if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { 2690cd261496SGeert Uytterhoeven $author = $1; 2691e7f929f3SDwaipayan Ray my $curline = $linenr; 2692e7f929f3SDwaipayan Ray while(defined($rawlines[$curline]) && ($rawlines[$curline++] =~ /^[ \t]\s*(.*)/)) { 2693e7f929f3SDwaipayan Ray $author .= $1; 2694e7f929f3SDwaipayan Ray } 2695cd261496SGeert Uytterhoeven $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); 2696cd261496SGeert Uytterhoeven $author =~ s/"//g; 2697dfa05c28SJoe Perches $author = reformat_email($author); 2698cd261496SGeert Uytterhoeven } 2699cd261496SGeert Uytterhoeven 270020112475SJoe Perches# Check the patch for a signoff: 2701dfa05c28SJoe Perches if ($line =~ /^\s*signed-off-by:\s*(.*)/i) { 27024a0df2efSAndy Whitcroft $signoff++; 270315662b3eSJoe Perches $in_commit_log = 0; 2704*48ca2d8aSDwaipayan Ray if ($author ne '' && $authorsignoff != 1) { 2705*48ca2d8aSDwaipayan Ray if (same_email_addresses($1, $author, 1)) { 2706cd261496SGeert Uytterhoeven $authorsignoff = 1; 2707*48ca2d8aSDwaipayan Ray } else { 2708*48ca2d8aSDwaipayan Ray my $ctx = $1; 2709*48ca2d8aSDwaipayan Ray my ($email_name, $email_comment, $email_address, $comment1) = parse_email($ctx); 2710*48ca2d8aSDwaipayan Ray my ($author_name, $author_comment, $author_address, $comment2) = parse_email($author); 2711*48ca2d8aSDwaipayan Ray 2712*48ca2d8aSDwaipayan Ray if ($email_address eq $author_address && $email_name eq $author_name) { 2713*48ca2d8aSDwaipayan Ray $author_sob = $ctx; 2714*48ca2d8aSDwaipayan Ray $authorsignoff = 2; 2715*48ca2d8aSDwaipayan Ray } elsif ($email_address eq $author_address) { 2716*48ca2d8aSDwaipayan Ray $author_sob = $ctx; 2717*48ca2d8aSDwaipayan Ray $authorsignoff = 3; 2718*48ca2d8aSDwaipayan Ray } elsif ($email_name eq $author_name) { 2719*48ca2d8aSDwaipayan Ray $author_sob = $ctx; 2720*48ca2d8aSDwaipayan Ray $authorsignoff = 4; 2721*48ca2d8aSDwaipayan Ray 2722*48ca2d8aSDwaipayan Ray my $address1 = $email_address; 2723*48ca2d8aSDwaipayan Ray my $address2 = $author_address; 2724*48ca2d8aSDwaipayan Ray 2725*48ca2d8aSDwaipayan Ray if ($address1 =~ /(\S+)\+\S+(\@.*)/) { 2726*48ca2d8aSDwaipayan Ray $address1 = "$1$2"; 2727*48ca2d8aSDwaipayan Ray } 2728*48ca2d8aSDwaipayan Ray if ($address2 =~ /(\S+)\+\S+(\@.*)/) { 2729*48ca2d8aSDwaipayan Ray $address2 = "$1$2"; 2730*48ca2d8aSDwaipayan Ray } 2731*48ca2d8aSDwaipayan Ray if ($address1 eq $address2) { 2732*48ca2d8aSDwaipayan Ray $authorsignoff = 5; 2733*48ca2d8aSDwaipayan Ray } 2734*48ca2d8aSDwaipayan Ray } 2735cd261496SGeert Uytterhoeven } 2736cd261496SGeert Uytterhoeven } 27370a920b5bSAndy Whitcroft } 273820112475SJoe Perches 273944d303ebSJoe Perches# Check for patch separator 274044d303ebSJoe Perches if ($line =~ /^---$/) { 274144d303ebSJoe Perches $has_patch_separator = 1; 274244d303ebSJoe Perches $in_commit_log = 0; 274344d303ebSJoe Perches } 274444d303ebSJoe Perches 2745e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2746e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2747e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2748e0d975b1SJoe Perches $reported_maintainer_file = 1; 2749e0d975b1SJoe Perches } 2750e0d975b1SJoe Perches 275120112475SJoe Perches# Check signature styles 2752270c49a0SJoe Perches if (!$in_header_lines && 2753ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 275420112475SJoe Perches my $space_before = $1; 275520112475SJoe Perches my $sign_off = $2; 275620112475SJoe Perches my $space_after = $3; 275720112475SJoe Perches my $email = $4; 275820112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 275920112475SJoe Perches 2760ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2761ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2762ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2763ce0338dfSJoe Perches } 276420112475SJoe Perches if (defined $space_before && $space_before ne "") { 27653705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 27663705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 27673705ce5bSJoe Perches $fix) { 2768194f66fcSJoe Perches $fixed[$fixlinenr] = 27693705ce5bSJoe Perches "$ucfirst_sign_off $email"; 27703705ce5bSJoe Perches } 277120112475SJoe Perches } 277220112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 27733705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 27743705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 27753705ce5bSJoe Perches $fix) { 2776194f66fcSJoe Perches $fixed[$fixlinenr] = 27773705ce5bSJoe Perches "$ucfirst_sign_off $email"; 27783705ce5bSJoe Perches } 27793705ce5bSJoe Perches 278020112475SJoe Perches } 278120112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 27823705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 27833705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 27843705ce5bSJoe Perches $fix) { 2785194f66fcSJoe Perches $fixed[$fixlinenr] = 27863705ce5bSJoe Perches "$ucfirst_sign_off $email"; 27873705ce5bSJoe Perches } 278820112475SJoe Perches } 278920112475SJoe Perches 2790dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 2791*48ca2d8aSDwaipayan Ray my $suggested_email = format_email(($email_name, $name_comment, $email_address, $comment)); 279220112475SJoe Perches if ($suggested_email eq "") { 2793000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2794000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 279520112475SJoe Perches } else { 279620112475SJoe Perches my $dequoted = $suggested_email; 279720112475SJoe Perches $dequoted =~ s/^"//; 279820112475SJoe Perches $dequoted =~ s/" </ </; 279920112475SJoe Perches # Don't force email to have quotes 280020112475SJoe Perches # Allow just an angle bracketed address 2801*48ca2d8aSDwaipayan Ray if (!same_email_addresses($email, $suggested_email, 0)) { 2802000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2803*48ca2d8aSDwaipayan Ray "email address '$email' might be better as '$suggested_email'\n" . $herecurr); 280420112475SJoe Perches } 28050a920b5bSAndy Whitcroft } 28067e51f197SJoe Perches 28077e51f197SJoe Perches# Check for duplicate signatures 28087e51f197SJoe Perches my $sig_nospace = $line; 28097e51f197SJoe Perches $sig_nospace =~ s/\s//g; 28107e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 28117e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 28127e51f197SJoe Perches WARN("BAD_SIGN_OFF", 28137e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 28147e51f197SJoe Perches } else { 28157e51f197SJoe Perches $signatures{$sig_nospace} = 1; 28167e51f197SJoe Perches } 28176c5d24eeSSean Christopherson 28186c5d24eeSSean Christopherson# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email 28196c5d24eeSSean Christopherson if ($sign_off =~ /^co-developed-by:$/i) { 28206c5d24eeSSean Christopherson if ($email eq $author) { 28216c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 28226c5d24eeSSean Christopherson "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline); 28236c5d24eeSSean Christopherson } 28246c5d24eeSSean Christopherson if (!defined $lines[$linenr]) { 28256c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 28266c5d24eeSSean Christopherson "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline); 28276c5d24eeSSean Christopherson } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) { 28286c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 28296c5d24eeSSean Christopherson "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 28306c5d24eeSSean Christopherson } elsif ($1 ne $email) { 28316c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 28326c5d24eeSSean Christopherson "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 28336c5d24eeSSean Christopherson } 28346c5d24eeSSean Christopherson } 28350a920b5bSAndy Whitcroft } 28360a920b5bSAndy Whitcroft 2837a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2838a2fe16b9SJoe Perches if ($in_header_lines && 2839a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2840a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2841a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2842a2fe16b9SJoe Perches } 2843a2fe16b9SJoe Perches 284444d303ebSJoe Perches# Check for Gerrit Change-Ids not in any patch context 284544d303ebSJoe Perches if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) { 28467ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 284744d303ebSJoe Perches "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr); 28487ebd05efSChristopher Covington } 28497ebd05efSChristopher Covington 2850369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2851369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2852369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2853369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2854369c8dd3SJoe Perches # timestamp 2855634cffccSJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) || 2856634cffccSJoe Perches $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ || 2857634cffccSJoe Perches $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) { 2858634cffccSJoe Perches # stack dump address styles 2859369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2860369c8dd3SJoe Perches } 2861369c8dd3SJoe Perches 28622a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 28632a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2864bf4daf12SJoe Perches length($line) > 75 && 2865bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2866bf4daf12SJoe Perches # file delta changes 2867bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2868bf4daf12SJoe Perches # filename then : 2869bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2870bf4daf12SJoe Perches # A Fixes: or Link: line 2871bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 28722a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 28732a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 28742a076f40SJoe Perches $commit_log_long_line = 1; 28752a076f40SJoe Perches } 28762a076f40SJoe Perches 2877bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2878bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2879bf4daf12SJoe Perches $line =~ /^\s*$/) { 2880bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2881bf4daf12SJoe Perches } 2882bf4daf12SJoe Perches 28830d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2884369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2885a8972573SJohn Hubbard $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i && 2886e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 2887fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2888aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2889369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2890bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2891fe043ea1SJoe Perches my $init_char = "c"; 2892fe043ea1SJoe Perches my $orig_commit = ""; 28930d7835fcSJoe Perches my $short = 1; 28940d7835fcSJoe Perches my $long = 0; 28950d7835fcSJoe Perches my $case = 1; 28960d7835fcSJoe Perches my $space = 1; 28970d7835fcSJoe Perches my $hasdesc = 0; 289819c146a6SJoe Perches my $hasparens = 0; 28990d7835fcSJoe Perches my $id = '0123456789ab'; 29000d7835fcSJoe Perches my $orig_desc = "commit description"; 29010d7835fcSJoe Perches my $description = ""; 29020d7835fcSJoe Perches 2903fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2904fe043ea1SJoe Perches $init_char = $1; 2905fe043ea1SJoe Perches $orig_commit = lc($2); 2906fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2907fe043ea1SJoe Perches $orig_commit = lc($1); 2908fe043ea1SJoe Perches } 2909fe043ea1SJoe Perches 29100d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 29110d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 29120d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 29130d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 29140d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 29150d7835fcSJoe Perches $orig_desc = $1; 291619c146a6SJoe Perches $hasparens = 1; 29170d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 29180d7835fcSJoe Perches defined $rawlines[$linenr] && 29190d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 29200d7835fcSJoe Perches $orig_desc = $1; 292119c146a6SJoe Perches $hasparens = 1; 2922b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2923b671fde0SJoe Perches defined $rawlines[$linenr] && 2924b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2925b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2926b671fde0SJoe Perches $orig_desc = $1; 2927b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2928b671fde0SJoe Perches $orig_desc .= " " . $1; 292919c146a6SJoe Perches $hasparens = 1; 29300d7835fcSJoe Perches } 29310d7835fcSJoe Perches 29320d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 29330d7835fcSJoe Perches $id, $orig_desc); 29340d7835fcSJoe Perches 2935948b133aSHeinrich Schuchardt if (defined($id) && 2936948b133aSHeinrich Schuchardt ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { 2937d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 29380d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 29390d7835fcSJoe Perches } 2940d311cd44SJoe Perches } 2941d311cd44SJoe Perches 294213f1937eSJoe Perches# Check for added, moved or deleted files 294313f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 294413f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 294513f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 294613f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 294713f1937eSJoe Perches (defined($1) || defined($2))))) { 2948a82603a8SAndrew Jeffery $is_patch = 1; 294913f1937eSJoe Perches $reported_maintainer_file = 1; 295013f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 295113f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 295213f1937eSJoe Perches } 295313f1937eSJoe Perches 2954e400edb1SRob Herring# Check for adding new DT bindings not in schema format 2955e400edb1SRob Herring if (!$in_commit_log && 2956e400edb1SRob Herring ($line =~ /^new file mode\s*\d+\s*$/) && 2957e400edb1SRob Herring ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) { 2958e400edb1SRob Herring WARN("DT_SCHEMA_BINDING_PATCH", 2959e400edb1SRob Herring "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n"); 2960e400edb1SRob Herring } 2961e400edb1SRob Herring 296200df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 29638905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2964000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2965000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 29666c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2967de7d4f0eSAndy Whitcroft } 2968de7d4f0eSAndy Whitcroft 2969de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2970de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2971171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2972171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2973171ae1a4SAndy Whitcroft 2974171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2975171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2976171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2977171ae1a4SAndy Whitcroft 297834d99219SJoe Perches CHK("INVALID_UTF8", 2979000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 298000df344fSAndy Whitcroft } 29810a920b5bSAndy Whitcroft 298215662b3eSJoe Perches# Check if it's the start of a commit log 298315662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 298415662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 2985eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 2986eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 298715662b3eSJoe Perches $in_header_lines = 0; 298815662b3eSJoe Perches $in_commit_log = 1; 2989ed43c4e5SAllen Hubbe $has_commit_log = 1; 299015662b3eSJoe Perches } 299115662b3eSJoe Perches 2992fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2993fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2994fa64205dSPasi Savanainen if ($in_header_lines && 2995fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2996fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2997fa64205dSPasi Savanainen $non_utf8_charset = 1; 2998fa64205dSPasi Savanainen } 2999fa64205dSPasi Savanainen 3000fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 300115662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 3002fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 300315662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 300415662b3eSJoe Perches } 300515662b3eSJoe Perches 3006d6430f71SJoe Perches# Check for absolute kernel paths in commit message 3007d6430f71SJoe Perches if ($tree && $in_commit_log) { 3008d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 3009d6430f71SJoe Perches my $file = $1; 3010d6430f71SJoe Perches 3011d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 3012d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 3013d6430f71SJoe Perches # 3014d6430f71SJoe Perches } else { 3015d6430f71SJoe Perches check_absolute_file($file, $herecurr); 3016d6430f71SJoe Perches } 3017d6430f71SJoe Perches } 3018d6430f71SJoe Perches } 3019d6430f71SJoe Perches 302066b47b4aSKees Cook# Check for various typo / spelling mistakes 302166d7a382SJoe Perches if (defined($misspellings) && 302266d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 3023ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 302466b47b4aSKees Cook my $typo = $1; 302566b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 302666b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 302766b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 30280675a8fbSJean Delvare my $msg_level = \&WARN; 30290675a8fbSJean Delvare $msg_level = \&CHK if ($file); 30300675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 303166b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 303266b47b4aSKees Cook $fix) { 303366b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 303466b47b4aSKees Cook } 303566b47b4aSKees Cook } 303666b47b4aSKees Cook } 303766b47b4aSKees Cook 3038a8dd86bfSMatteo Croce# check for invalid commit id 3039a8dd86bfSMatteo Croce if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) { 3040a8dd86bfSMatteo Croce my $id; 3041a8dd86bfSMatteo Croce my $description; 3042a8dd86bfSMatteo Croce ($id, $description) = git_commit_info($2, undef, undef); 3043a8dd86bfSMatteo Croce if (!defined($id)) { 3044a8dd86bfSMatteo Croce WARN("UNKNOWN_COMMIT_ID", 3045a8dd86bfSMatteo Croce "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr); 3046a8dd86bfSMatteo Croce } 3047a8dd86bfSMatteo Croce } 3048a8dd86bfSMatteo Croce 3049310cd06bSJoe Perches# check for repeated words separated by a single space 3050310cd06bSJoe Perches if ($rawline =~ /^\+/ || $in_commit_log) { 3051310cd06bSJoe Perches while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) { 3052310cd06bSJoe Perches 3053310cd06bSJoe Perches my $first = $1; 3054310cd06bSJoe Perches my $second = $2; 3055310cd06bSJoe Perches 3056310cd06bSJoe Perches if ($first =~ /(?:struct|union|enum)/) { 3057310cd06bSJoe Perches pos($rawline) += length($first) + length($second) + 1; 3058310cd06bSJoe Perches next; 3059310cd06bSJoe Perches } 3060310cd06bSJoe Perches 3061310cd06bSJoe Perches next if ($first ne $second); 3062310cd06bSJoe Perches next if ($first eq 'long'); 3063310cd06bSJoe Perches 3064310cd06bSJoe Perches if (WARN("REPEATED_WORD", 3065310cd06bSJoe Perches "Possible repeated word: '$first'\n" . $herecurr) && 3066310cd06bSJoe Perches $fix) { 3067310cd06bSJoe Perches $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/; 3068310cd06bSJoe Perches } 3069310cd06bSJoe Perches } 3070310cd06bSJoe Perches 3071310cd06bSJoe Perches # if it's a repeated word on consecutive lines in a comment block 3072310cd06bSJoe Perches if ($prevline =~ /$;+\s*$/ && 3073310cd06bSJoe Perches $prevrawline =~ /($word_pattern)\s*$/) { 3074310cd06bSJoe Perches my $last_word = $1; 3075310cd06bSJoe Perches if ($rawline =~ /^\+\s*\*\s*$last_word /) { 3076310cd06bSJoe Perches if (WARN("REPEATED_WORD", 3077310cd06bSJoe Perches "Possible repeated word: '$last_word'\n" . $hereprev) && 3078310cd06bSJoe Perches $fix) { 3079310cd06bSJoe Perches $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/; 3080310cd06bSJoe Perches } 3081310cd06bSJoe Perches } 3082310cd06bSJoe Perches } 3083310cd06bSJoe Perches } 3084310cd06bSJoe Perches 308530670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 308630670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 308700df344fSAndy Whitcroft 30880a920b5bSAndy Whitcroft#trailing whitespace 30899c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 3090c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3091d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 3092d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 3093d5e616fcSJoe Perches $fix) { 3094194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 3095d5e616fcSJoe Perches } 3096c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 3097c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 30983705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 30993705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 31003705ce5bSJoe Perches $fix) { 3101194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 31023705ce5bSJoe Perches } 31033705ce5bSJoe Perches 3104d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 31050a920b5bSAndy Whitcroft } 31065368df20SAndy Whitcroft 31074783f894SJosh Triplett# Check for FSF mailing addresses. 3108109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 31091bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 31103e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 31113e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 31124783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 31130675a8fbSJean Delvare my $msg_level = \&ERROR; 31140675a8fbSJean Delvare $msg_level = \&CHK if ($file); 31150675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 31164783f894SJosh 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) 31174783f894SJosh Triplett } 31184783f894SJosh Triplett 31193354957aSAndi Kleen# check for Kconfig help text having a real description 31209fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 31219fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 31223354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 3123678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 3124678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 3125678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 3126678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 31273354957aSAndi Kleen my $length = 0; 31289fe287d7SAndy Whitcroft my $cnt = $realcnt; 31299fe287d7SAndy Whitcroft my $ln = $linenr + 1; 31309fe287d7SAndy Whitcroft my $f; 3131a1385803SAndy Whitcroft my $is_start = 0; 31329fe287d7SAndy Whitcroft my $is_end = 0; 3133a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 31349fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 31359fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 31369fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 31379fe287d7SAndy Whitcroft 31389fe287d7SAndy Whitcroft next if ($f =~ /^-/); 31398d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 3140a1385803SAndy Whitcroft 314186adf1a0SUlf Magnusson if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 3142a1385803SAndy Whitcroft $is_start = 1; 314322a4ac02SMasahiro Yamada } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 3144a1385803SAndy Whitcroft $length = -1; 3145a1385803SAndy Whitcroft } 3146a1385803SAndy Whitcroft 31479fe287d7SAndy Whitcroft $f =~ s/^.//; 31483354957aSAndi Kleen $f =~ s/#.*//; 31493354957aSAndi Kleen $f =~ s/^\s+//; 31503354957aSAndi Kleen next if ($f =~ /^$/); 3151678ae162SUlf Magnusson 3152678ae162SUlf Magnusson # This only checks context lines in the patch 3153678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 3154678ae162SUlf Magnusson # positives, even though some of these are 3155678ae162SUlf Magnusson # common words in help texts 3156678ae162SUlf Magnusson if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| 3157678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 31589fe287d7SAndy Whitcroft $is_end = 1; 31599fe287d7SAndy Whitcroft last; 31609fe287d7SAndy Whitcroft } 31613354957aSAndi Kleen $length++; 31623354957aSAndi Kleen } 316356193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 3164000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 316556193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 316656193274SVadim Bendebury } 3167a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 31683354957aSAndi Kleen } 31693354957aSAndi Kleen 31707ccf41a8SJoe Perches# check MAINTAINERS entries 31717ccf41a8SJoe Perches if ($realfile =~ /^MAINTAINERS$/) { 31727ccf41a8SJoe Perches# check MAINTAINERS entries for the right form 31737ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 3174628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 3175628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 3176628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 3177628f91a2SJoe Perches $fix) { 3178628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 3179628f91a2SJoe Perches } 3180628f91a2SJoe Perches } 31817ccf41a8SJoe Perches# check MAINTAINERS entries for the right ordering too 31827ccf41a8SJoe Perches my $preferred_order = 'MRLSWQBCPTFXNK'; 31837ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 31847ccf41a8SJoe Perches $prevrawline =~ /^[\+ ][A-Z]:/) { 31857ccf41a8SJoe Perches $rawline =~ /^\+([A-Z]):\s*(.*)/; 31867ccf41a8SJoe Perches my $cur = $1; 31877ccf41a8SJoe Perches my $curval = $2; 31887ccf41a8SJoe Perches $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/; 31897ccf41a8SJoe Perches my $prev = $1; 31907ccf41a8SJoe Perches my $prevval = $2; 31917ccf41a8SJoe Perches my $curindex = index($preferred_order, $cur); 31927ccf41a8SJoe Perches my $previndex = index($preferred_order, $prev); 31937ccf41a8SJoe Perches if ($curindex < 0) { 31947ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 31957ccf41a8SJoe Perches "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr); 31967ccf41a8SJoe Perches } else { 31977ccf41a8SJoe Perches if ($previndex >= 0 && $curindex < $previndex) { 31987ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 31997ccf41a8SJoe Perches "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev); 32007ccf41a8SJoe Perches } elsif ((($prev eq 'F' && $cur eq 'F') || 32017ccf41a8SJoe Perches ($prev eq 'X' && $cur eq 'X')) && 32027ccf41a8SJoe Perches ($prevval cmp $curval) > 0) { 32037ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 32047ccf41a8SJoe Perches "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev); 32057ccf41a8SJoe Perches } 32067ccf41a8SJoe Perches } 32077ccf41a8SJoe Perches } 32087ccf41a8SJoe Perches } 3209628f91a2SJoe Perches 3210327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 3211327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 3212327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 3213327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 3214327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 3215327953e9SChristoph Jaeger } 3216327953e9SChristoph Jaeger 3217c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 3218c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 3219c68e5878SArnaud Lacombe my $flag = $1; 3220c68e5878SArnaud Lacombe my $replacement = { 3221c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 3222c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 3223c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 3224c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 3225c68e5878SArnaud Lacombe }; 3226c68e5878SArnaud Lacombe 3227c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 3228c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 3229c68e5878SArnaud Lacombe } 3230c68e5878SArnaud Lacombe 3231bff5da43SRob Herring# check for DT compatible documentation 32327dd05b38SFlorian Vaussard if (defined $root && 32337dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 32347dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 32357dd05b38SFlorian Vaussard 3236bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 3237bff5da43SRob Herring 3238cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 3239852d095dSRob Herring my $vp_file = $dt_path . "vendor-prefixes.yaml"; 3240cc93319bSFlorian Vaussard 3241bff5da43SRob Herring foreach my $compat (@compats) { 3242bff5da43SRob Herring my $compat2 = $compat; 3243185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 3244185d566bSRob Herring my $compat3 = $compat; 3245185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 3246185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 3247bff5da43SRob Herring if ( $? >> 8 ) { 3248bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3249bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 3250bff5da43SRob Herring } 3251bff5da43SRob Herring 32524fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 32534fbf32a6SFlorian Vaussard my $vendor = $1; 3254852d095dSRob Herring `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`; 3255bff5da43SRob Herring if ( $? >> 8 ) { 3256bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3257cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 3258bff5da43SRob Herring } 3259bff5da43SRob Herring } 3260bff5da43SRob Herring } 3261bff5da43SRob Herring 32629f3a8992SRob Herring# check for using SPDX license tag at beginning of files 32639f3a8992SRob Herring if ($realline == $checklicenseline) { 32649f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 32659f3a8992SRob Herring $checklicenseline = 2; 32669f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 32679f3a8992SRob Herring my $comment = ""; 32689f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 32699f3a8992SRob Herring $comment = '/*'; 32709f3a8992SRob Herring } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 32719f3a8992SRob Herring $comment = '//'; 3272c8df0ab6SLubomir Rintel } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) { 32739f3a8992SRob Herring $comment = '#'; 32749f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 32759f3a8992SRob Herring $comment = '..'; 32769f3a8992SRob Herring } 32779f3a8992SRob Herring 3278fdf13693SJoe Perches# check SPDX comment style for .[chsS] files 3279fdf13693SJoe Perches if ($realfile =~ /\.[chsS]$/ && 3280fdf13693SJoe Perches $rawline =~ /SPDX-License-Identifier:/ && 3281ffbce897SJoe Perches $rawline !~ m@^\+\s*\Q$comment\E\s*@) { 3282fdf13693SJoe Perches WARN("SPDX_LICENSE_TAG", 3283fdf13693SJoe Perches "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr); 3284fdf13693SJoe Perches } 3285fdf13693SJoe Perches 32869f3a8992SRob Herring if ($comment !~ /^$/ && 3287ffbce897SJoe Perches $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) { 32889f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 32899f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 32903b6e8ac9SJoe Perches } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) { 32913b6e8ac9SJoe Perches my $spdx_license = $1; 32923b6e8ac9SJoe Perches if (!is_SPDX_License_valid($spdx_license)) { 32933b6e8ac9SJoe Perches WARN("SPDX_LICENSE_TAG", 32943b6e8ac9SJoe Perches "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr); 32953b6e8ac9SJoe Perches } 329650c92900SLubomir Rintel if ($realfile =~ m@^Documentation/devicetree/bindings/@ && 329750c92900SLubomir Rintel not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) { 329850c92900SLubomir Rintel my $msg_level = \&WARN; 329950c92900SLubomir Rintel $msg_level = \&CHK if ($file); 330050c92900SLubomir Rintel if (&{$msg_level}("SPDX_LICENSE_TAG", 330150c92900SLubomir Rintel 330250c92900SLubomir Rintel "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) && 330350c92900SLubomir Rintel $fix) { 330450c92900SLubomir Rintel $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/; 330550c92900SLubomir Rintel } 330650c92900SLubomir Rintel } 33079f3a8992SRob Herring } 33089f3a8992SRob Herring } 33099f3a8992SRob Herring } 33109f3a8992SRob Herring 3311a0154cdbSJoe Perches# check for embedded filenames 3312a0154cdbSJoe Perches if ($rawline =~ /^\+.*\Q$realfile\E/) { 3313a0154cdbSJoe Perches WARN("EMBEDDED_FILENAME", 3314a0154cdbSJoe Perches "It's generally not useful to have the filename in the file\n" . $herecurr); 3315a0154cdbSJoe Perches } 3316a0154cdbSJoe Perches 33175368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 3318d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 33195368df20SAndy Whitcroft 3320a8da38a9SJoe Perches# check for using SPDX-License-Identifier on the wrong line number 3321a8da38a9SJoe Perches if ($realline != $checklicenseline && 3322a8da38a9SJoe Perches $rawline =~ /\bSPDX-License-Identifier:/ && 3323a8da38a9SJoe Perches substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) { 3324a8da38a9SJoe Perches WARN("SPDX_LICENSE_TAG", 3325a8da38a9SJoe Perches "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr); 3326a8da38a9SJoe Perches } 3327a8da38a9SJoe Perches 332847e0c88bSJoe Perches# line length limit (with some exclusions) 332947e0c88bSJoe Perches# 333047e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 333147e0c88bSJoe Perches# logging functions like pr_info that end in a string 333247e0c88bSJoe Perches# lines with a single string 333347e0c88bSJoe Perches# #defines that are a single string 33342e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 333547e0c88bSJoe Perches# 333647e0c88bSJoe Perches# There are 3 different line length message types: 3337ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 333847e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 333947e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 334047e0c88bSJoe Perches# 334147e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 334247e0c88bSJoe Perches# 334347e0c88bSJoe Perches 3344b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 334547e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 334647e0c88bSJoe Perches 334747e0c88bSJoe Perches # Check the allowed long line types first 334847e0c88bSJoe Perches 334947e0c88bSJoe Perches # logging functions that end in a string that starts 335047e0c88bSJoe Perches # before $max_line_length 335147e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 335247e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 335347e0c88bSJoe Perches $msg_type = ""; 335447e0c88bSJoe Perches 335547e0c88bSJoe Perches # lines with only strings (w/ possible termination) 335647e0c88bSJoe Perches # #defines with only strings 335747e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 335847e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 335947e0c88bSJoe Perches $msg_type = ""; 336047e0c88bSJoe Perches 3361cc147506SJoe Perches # More special cases 3362cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3363cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3364d560a5f8SJoe Perches $msg_type = ""; 3365d560a5f8SJoe Perches 33662e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 33672e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 33682e4bbbc5SAndreas Brauchli $msg_type = ""; 33692e4bbbc5SAndreas Brauchli 337047e0c88bSJoe Perches # Otherwise set the alternate message types 337147e0c88bSJoe Perches 337247e0c88bSJoe Perches # a comment starts before $max_line_length 337347e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 337447e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 337547e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 337647e0c88bSJoe Perches 337747e0c88bSJoe Perches # a quoted string starts before $max_line_length 337847e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 337947e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 338047e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 338147e0c88bSJoe Perches } 338247e0c88bSJoe Perches 338347e0c88bSJoe Perches if ($msg_type ne "" && 338447e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 3385bdc48fa1SJoe Perches my $msg_level = \&WARN; 3386bdc48fa1SJoe Perches $msg_level = \&CHK if ($file); 3387bdc48fa1SJoe Perches &{$msg_level}($msg_type, 3388bdc48fa1SJoe Perches "line length of $length exceeds $max_line_length columns\n" . $herecurr); 33890a920b5bSAndy Whitcroft } 339047e0c88bSJoe Perches } 33910a920b5bSAndy Whitcroft 33928905a67cSAndy Whitcroft# check for adding lines without a newline. 33938905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 3394000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 3395000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 33968905a67cSAndy Whitcroft } 33978905a67cSAndy Whitcroft 3398b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3399de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 34000a920b5bSAndy Whitcroft 34010a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 3402713a09deSAntonio Borneo# more than $tabsize must use tabs. 3403c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3404c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3405c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3406d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 34073705ce5bSJoe Perches if (ERROR("CODE_INDENT", 34083705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 34093705ce5bSJoe Perches $fix) { 3410194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 34113705ce5bSJoe Perches } 34120a920b5bSAndy Whitcroft } 34130a920b5bSAndy Whitcroft 341408e44365SAlberto Panizzo# check for space before tabs. 341508e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 341608e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 34173705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 34183705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 34193705ce5bSJoe Perches $fix) { 3420194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3421713a09deSAntonio Borneo s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} 3422194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3423c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 34243705ce5bSJoe Perches } 342508e44365SAlberto Panizzo } 342608e44365SAlberto Panizzo 34276a487211SJoe Perches# check for assignments on the start of a line 34286a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 34296a487211SJoe Perches CHK("ASSIGNMENT_CONTINUATIONS", 34306a487211SJoe Perches "Assignment operator '$1' should be on the previous line\n" . $hereprev); 34316a487211SJoe Perches } 34326a487211SJoe Perches 3433d1fe9c09SJoe Perches# check for && or || at the start of a line 3434d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 3435d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 3436d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 3437d1fe9c09SJoe Perches } 3438d1fe9c09SJoe Perches 3439a91e8994SJoe Perches# check indentation starts on a tab stop 34405b57980dSJoe Perches if ($perl_version_ok && 3441bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3442a91e8994SJoe Perches my $indent = length($1); 3443713a09deSAntonio Borneo if ($indent % $tabsize) { 3444a91e8994SJoe Perches if (WARN("TABSTOP", 3445a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3446a91e8994SJoe Perches $fix) { 3447713a09deSAntonio Borneo $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; 3448a91e8994SJoe Perches } 3449a91e8994SJoe Perches } 3450a91e8994SJoe Perches } 3451a91e8994SJoe Perches 3452d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 34535b57980dSJoe Perches if ($perl_version_ok && 3454fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3455d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3456d1fe9c09SJoe Perches my $oldindent = $1; 3457d1fe9c09SJoe Perches my $rest = $2; 3458d1fe9c09SJoe Perches 3459d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3460d1fe9c09SJoe Perches if ($pos >= 0) { 3461b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3462b34a26f3SJoe Perches my $newindent = $2; 3463d1fe9c09SJoe Perches 3464d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3465713a09deSAntonio Borneo "\t" x ($pos / $tabsize) . 3466713a09deSAntonio Borneo " " x ($pos % $tabsize); 3467d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3468d1fe9c09SJoe Perches 3469d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3470d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 34713705ce5bSJoe Perches 34723705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 34733705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 34743705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3475194f66fcSJoe Perches $fixed[$fixlinenr] =~ 34763705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 34773705ce5bSJoe Perches } 3478d1fe9c09SJoe Perches } 3479d1fe9c09SJoe Perches } 3480d1fe9c09SJoe Perches } 3481d1fe9c09SJoe Perches 34826ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 34836ab3a970SJoe Perches# avoid checking a few false positives: 34846ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 34856ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 34866ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 34876ab3a970SJoe Perches# multiline macros that define functions 34886ab3a970SJoe Perches# known attributes or the __attribute__ keyword 34896ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 34906ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 34913705ce5bSJoe Perches if (CHK("SPACING", 3492f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 34933705ce5bSJoe Perches $fix) { 3494194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3495f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 34963705ce5bSJoe Perches } 3497aad4f614SJoe Perches } 3498aad4f614SJoe Perches 349986406b1cSJoe Perches# Block comment styles 350086406b1cSJoe Perches# Networking with an initial /* 350105880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3502fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 350385ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 3504c70735c2SŁukasz Stelmach $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier 350505880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 350605880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 350705880600SJoe Perches } 350805880600SJoe Perches 350986406b1cSJoe Perches# Block comments use * on subsequent lines 351086406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 351186406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3512a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 351361135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3514a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 351586406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 351686406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3517a605e32eSJoe Perches } 3518a605e32eSJoe Perches 351986406b1cSJoe Perches# Block comments use */ on trailing lines 352086406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3521c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3522c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3523c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 352486406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 352586406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 352605880600SJoe Perches } 352705880600SJoe Perches 352808eb9b80SJoe Perches# Block comment * alignment 352908eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3530af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3531af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3532af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 353308eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3534af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3535af207524SJoe Perches my $oldindent; 353608eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3537af207524SJoe Perches if (defined($1)) { 3538af207524SJoe Perches $oldindent = expand_tabs($1); 3539af207524SJoe Perches } else { 3540af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3541af207524SJoe Perches $oldindent = expand_tabs($1); 3542af207524SJoe Perches } 354308eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 354408eb9b80SJoe Perches my $newindent = $1; 354508eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3546af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 354708eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 354808eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 354908eb9b80SJoe Perches } 355008eb9b80SJoe Perches } 355108eb9b80SJoe Perches 35527f619191SJoe Perches# check for missing blank lines after struct/union declarations 35537f619191SJoe Perches# with exceptions for various attributes and macros 35547f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 35557f619191SJoe Perches $line =~ /^\+/ && 35567f619191SJoe Perches !($line =~ /^\+\s*$/ || 35577f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 35587f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 35597f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 35607f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 35617f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 35627f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 35630bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 35647f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3565d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3566d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3567d752fcc8SJoe Perches $fix) { 3568f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3569d752fcc8SJoe Perches } 35707f619191SJoe Perches } 35717f619191SJoe Perches 3572365dd4eaSJoe Perches# check for multiple consecutive blank lines 3573365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3574365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3575365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3576d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3577d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3578d752fcc8SJoe Perches $fix) { 3579f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3580d752fcc8SJoe Perches } 3581d752fcc8SJoe Perches 3582365dd4eaSJoe Perches $last_blank_line = $linenr; 3583365dd4eaSJoe Perches } 3584365dd4eaSJoe Perches 35853b617e3bSJoe Perches# check for missing blank lines after declarations 35863f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 35873f7bac03SJoe Perches # actual declarations 35883f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 35895a4e1fd3SJoe Perches # function pointer declarations 35905a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 35913f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 35923f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 35933f7bac03SJoe Perches # known declaration macros 35943f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 35953f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 35963f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 35973f7bac03SJoe Perches # other possible extensions of declaration lines 35983f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 35993f7bac03SJoe Perches # not starting a section or a macro "\" extended line 36003f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 36013f7bac03SJoe Perches # looks like a declaration 36023f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 36035a4e1fd3SJoe Perches # function pointer declarations 36045a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 36053f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 36063f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 36073f7bac03SJoe Perches # known declaration macros 36083f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 36093f7bac03SJoe Perches # start of struct or union or enum 3610328b5f41SJoe Perches $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ || 36113f7bac03SJoe Perches # start or end of block or continuation of declaration 36123f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 36133f7bac03SJoe Perches # bitfield continuation 36143f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 36153f7bac03SJoe Perches # other possible extensions of declaration lines 36163f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 36173f7bac03SJoe Perches # indentation of previous and current line are the same 36183f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3619d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3620d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3621d752fcc8SJoe Perches $fix) { 3622f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3623d752fcc8SJoe Perches } 36243b617e3bSJoe Perches } 36253b617e3bSJoe Perches 36265f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 36276b4c5bebSAndy Whitcroft# Exceptions: 36286b4c5bebSAndy Whitcroft# 1) within comments 36296b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 36306b4c5bebSAndy Whitcroft# 3) hanging labels 36313705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 36325f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 36333705ce5bSJoe Perches if (WARN("LEADING_SPACE", 36343705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 36353705ce5bSJoe Perches $fix) { 3636194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 36373705ce5bSJoe Perches } 36385f7ddae6SRaffaele Recalcati } 36395f7ddae6SRaffaele Recalcati 3640b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3641b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3642b9ea10d6SAndy Whitcroft 36435751a24eSJoe Perches# check for unusual line ending [ or ( 36445751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 36455751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 36465751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 36475751a24eSJoe Perches } 36485751a24eSJoe Perches 36494dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 36504dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 36514dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 36524dbed76fSJoe Perches $context_function = $1; 36534dbed76fSJoe Perches } 36544dbed76fSJoe Perches 36554dbed76fSJoe Perches# check if this appears to be the end of function declaration 36564dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 36574dbed76fSJoe Perches undef $context_function; 36584dbed76fSJoe Perches } 36594dbed76fSJoe Perches 3660032a4c0fSJoe Perches# check indentation of any line with a bare else 3661840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3662032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3663032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3664032a4c0fSJoe Perches my $tabs = length($1) + 1; 3665840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3666840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3667840080a0SJoe Perches defined $lines[$linenr] && 3668840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3669032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3670032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3671032a4c0fSJoe Perches } 3672032a4c0fSJoe Perches } 3673032a4c0fSJoe Perches 3674c00df19aSJoe Perches# check indentation of a line with a break; 3675c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3676c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3677c00df19aSJoe Perches my $tabs = $1; 3678c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3679c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3680c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3681c00df19aSJoe Perches } 3682c00df19aSJoe Perches } 3683c00df19aSJoe Perches 3684c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3685cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3686000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3687000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3688c2fdda0dSAndy Whitcroft } 368922f2a2efSAndy Whitcroft 369056e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 369156e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 369256e77d70SJoe Perches WARN("HOTPLUG_SECTION", 369356e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 369456e77d70SJoe Perches } 369556e77d70SJoe Perches 36969c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 36972b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 36982b474a1aSAndy Whitcroft $realline_next); 36993e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 3700ca819864SJoe Perches if ($linenr > $suppress_statement && 37011b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3702170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3703f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3704171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3705171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3706171ae1a4SAndy Whitcroft 37073e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 37083e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 37093e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 37103e469cdcSAndy Whitcroft # until we hit end of it. 37113e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 37123e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 37133e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 37143e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 37153e469cdcSAndy Whitcroft } 3716f74bd194SAndy Whitcroft 37172b474a1aSAndy Whitcroft # Find the real next line. 37182b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 37192b474a1aSAndy Whitcroft if (defined $realline_next && 37202b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 37212b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 37222b474a1aSAndy Whitcroft $realline_next++; 37232b474a1aSAndy Whitcroft } 37242b474a1aSAndy Whitcroft 3725171ae1a4SAndy Whitcroft my $s = $stat; 3726171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3727cf655043SAndy Whitcroft 3728c2fdda0dSAndy Whitcroft # Ignore goto labels. 3729171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3730c2fdda0dSAndy Whitcroft 3731c2fdda0dSAndy Whitcroft # Ignore functions being called 3732171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3733c2fdda0dSAndy Whitcroft 3734463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3735463f2864SAndy Whitcroft 3736c45dcabdSAndy Whitcroft # declarations always start with types 3737d2506586SAndy 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) { 3738c45dcabdSAndy Whitcroft my $type = $1; 3739c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3740c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3741c45dcabdSAndy Whitcroft 37426c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3743a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3744c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3745c2fdda0dSAndy Whitcroft } 37468905a67cSAndy Whitcroft 37476c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 374865863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3749c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 37509c0ca6f9SAndy Whitcroft } 37518905a67cSAndy Whitcroft 37528905a67cSAndy Whitcroft # Check for any sort of function declaration. 37538905a67cSAndy Whitcroft # int foo(something bar, other baz); 37548905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3755171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 37568905a67cSAndy Whitcroft my ($name_len) = length($1); 37578905a67cSAndy Whitcroft 3758cf655043SAndy Whitcroft my $ctx = $s; 3759773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 37608905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3761cf655043SAndy Whitcroft 37628905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3763c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 37648905a67cSAndy Whitcroft 3765c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 37668905a67cSAndy Whitcroft } 37678905a67cSAndy Whitcroft } 37688905a67cSAndy Whitcroft } 37698905a67cSAndy Whitcroft 37709c0ca6f9SAndy Whitcroft } 37719c0ca6f9SAndy Whitcroft 377200df344fSAndy Whitcroft# 377300df344fSAndy Whitcroft# Checks which may be anchored in the context. 377400df344fSAndy Whitcroft# 377500df344fSAndy Whitcroft 377600df344fSAndy Whitcroft# Check for switch () and associated case and default 377700df344fSAndy Whitcroft# statements should be at the same indent. 377800df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 377900df344fSAndy Whitcroft my $err = ''; 378000df344fSAndy Whitcroft my $sep = ''; 378100df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 378200df344fSAndy Whitcroft shift(@ctx); 378300df344fSAndy Whitcroft for my $ctx (@ctx) { 378400df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 378500df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 378600df344fSAndy Whitcroft $indent != $cindent) { 378700df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 378800df344fSAndy Whitcroft $sep = ''; 378900df344fSAndy Whitcroft } else { 379000df344fSAndy Whitcroft $sep = "[...]\n"; 379100df344fSAndy Whitcroft } 379200df344fSAndy Whitcroft } 379300df344fSAndy Whitcroft if ($err ne '') { 3794000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3795000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3796de7d4f0eSAndy Whitcroft } 3797de7d4f0eSAndy Whitcroft } 3798de7d4f0eSAndy Whitcroft 3799de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3800de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 38010fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3802773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3803773647a0SAndy Whitcroft 38049c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 38058eef05ddSJoe Perches 38068eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 38078eef05ddSJoe Perches WARN("DEEP_INDENTATION", 38088eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 38098eef05ddSJoe Perches } 38108eef05ddSJoe Perches 3811de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3812de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3813de7d4f0eSAndy Whitcroft 3814548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3815548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3816de7d4f0eSAndy Whitcroft 3817548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3818548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3819548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3820548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3821548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3822773647a0SAndy Whitcroft $ctx_ln++; 3823773647a0SAndy Whitcroft } 3824548596d5SAndy Whitcroft 382553210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 382653210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3827773647a0SAndy Whitcroft 3828773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3829000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3830000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 383101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 383200df344fSAndy Whitcroft } 3833773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3834773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3835773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3836773647a0SAndy Whitcroft { 38379c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 38389c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3839000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3840000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 384101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 38429c0ca6f9SAndy Whitcroft } 38439c0ca6f9SAndy Whitcroft } 384400df344fSAndy Whitcroft } 384500df344fSAndy Whitcroft 38464d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 3847f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 38483e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 38493e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 38503e469cdcSAndy Whitcroft if (!defined $stat); 38514d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 38524d001e4dSAndy Whitcroft 38534d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 38544d001e4dSAndy Whitcroft 38559f5af480SJoe Perches # remove inline comments 38569f5af480SJoe Perches $s =~ s/$;/ /g; 38579f5af480SJoe Perches $c =~ s/$;/ /g; 38584d001e4dSAndy Whitcroft 38594d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 38606f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 38616f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 38624d001e4dSAndy Whitcroft 38639f5af480SJoe Perches # Make sure we remove the line prefixes as we have 38649f5af480SJoe Perches # none on the first line, and are going to readd them 38659f5af480SJoe Perches # where necessary. 38669f5af480SJoe Perches $s =~ s/\n./\n/gs; 38679f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 38689f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 38699f5af480SJoe Perches } 38709f5af480SJoe Perches 38714d001e4dSAndy Whitcroft # We want to check the first line inside the block 38724d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 38734d001e4dSAndy Whitcroft # 1) any blank line termination 38744d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 38754d001e4dSAndy Whitcroft # 3) any do (...) { 38764d001e4dSAndy Whitcroft my $continuation = 0; 38774d001e4dSAndy Whitcroft my $check = 0; 38784d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 38794d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 38804d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 38814d001e4dSAndy Whitcroft $continuation = 1; 38824d001e4dSAndy Whitcroft } 38839bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 38844d001e4dSAndy Whitcroft $check = 1; 38854d001e4dSAndy Whitcroft $cond_lines++; 38864d001e4dSAndy Whitcroft } 38874d001e4dSAndy Whitcroft 38884d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 38894d001e4dSAndy Whitcroft # preprocessor statement. 38904d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 38914d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 38924d001e4dSAndy Whitcroft $check = 0; 38934d001e4dSAndy Whitcroft } 38944d001e4dSAndy Whitcroft 38959bd49efeSAndy Whitcroft my $cond_ptr = -1; 3896740504c6SAndy Whitcroft $continuation = 0; 38979bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 38989bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 38994d001e4dSAndy Whitcroft 3900f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3901f16fa28fSAndy Whitcroft # is not linear. 3902f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3903f16fa28fSAndy Whitcroft $check = 0; 3904f16fa28fSAndy Whitcroft } 3905f16fa28fSAndy Whitcroft 39069bd49efeSAndy Whitcroft # Ignore: 39079bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 39089bd49efeSAndy Whitcroft # 2) preprocessor lines, and 39099bd49efeSAndy Whitcroft # 3) labels. 3910740504c6SAndy Whitcroft if ($continuation || 3911740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 39129bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 39139bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3914740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 391530dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 39169bd49efeSAndy Whitcroft $cond_lines++; 39179bd49efeSAndy Whitcroft } 39184d001e4dSAndy Whitcroft } 391930dad6ebSAndy Whitcroft } 39204d001e4dSAndy Whitcroft 39214d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 39224d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 39234d001e4dSAndy Whitcroft 39244d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 39254d001e4dSAndy Whitcroft # this is not this patch's fault. 39264d001e4dSAndy Whitcroft if (!defined($stat_real) || 39274d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 39284d001e4dSAndy Whitcroft $check = 0; 39294d001e4dSAndy Whitcroft } 39304d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 39314d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 39324d001e4dSAndy Whitcroft } 39334d001e4dSAndy Whitcroft 39349bd49efeSAndy 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"; 39354d001e4dSAndy Whitcroft 39369f5af480SJoe Perches if ($check && $s ne '' && 3937713a09deSAntonio Borneo (($sindent % $tabsize) != 0 || 39389f5af480SJoe Perches ($sindent < $indent) || 3939f6950a73SJoe Perches ($sindent == $indent && 3940f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 3941713a09deSAntonio Borneo ($sindent > $indent + $tabsize))) { 3942000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3943000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 39444d001e4dSAndy Whitcroft } 39454d001e4dSAndy Whitcroft } 39464d001e4dSAndy Whitcroft 39476c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 39486c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 39491f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 39501f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 39516c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3952c2fdda0dSAndy Whitcroft if ($dbg_values) { 3953c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3954cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3955cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 39561f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3957c2fdda0dSAndy Whitcroft } 39586c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 39596c72ffaaSAndy Whitcroft 396000df344fSAndy Whitcroft#ignore lines not being added 39613705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 396200df344fSAndy Whitcroft 396399ca38c2SJoe Perches# check for self assignments used to avoid compiler warnings 396499ca38c2SJoe Perches# e.g.: int foo = foo, *bar = NULL; 396599ca38c2SJoe Perches# struct foo bar = *(&(bar)); 396699ca38c2SJoe Perches if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) { 396799ca38c2SJoe Perches my $var = $1; 396899ca38c2SJoe Perches if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) { 396999ca38c2SJoe Perches WARN("SELF_ASSIGNMENT", 397099ca38c2SJoe Perches "Do not use self-assignments to avoid compiler warnings\n" . $herecurr); 397199ca38c2SJoe Perches } 397299ca38c2SJoe Perches } 397399ca38c2SJoe Perches 397411ca40a0SJoe Perches# check for dereferences that span multiple lines 397511ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 397611ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 397711ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 397811ca40a0SJoe Perches my $ref = $1; 397911ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 398011ca40a0SJoe Perches $ref .= $1; 398111ca40a0SJoe Perches $ref =~ s/\s//g; 398211ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 398311ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 398411ca40a0SJoe Perches } 398511ca40a0SJoe Perches 3986a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3987c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3988a1ce18e4SJoe Perches my $type = $1; 3989a1ce18e4SJoe Perches my $var = $2; 3990207a8e84SJoe Perches $var = "" if (!defined $var); 3991207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3992a1ce18e4SJoe Perches my $sign = $1; 3993a1ce18e4SJoe Perches my $pointer = $2; 3994a1ce18e4SJoe Perches 3995a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3996a1ce18e4SJoe Perches 3997a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3998a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3999a1ce18e4SJoe Perches $fix) { 4000a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 4001207a8e84SJoe Perches my $comp_pointer = $pointer; 4002207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 4003207a8e84SJoe Perches $decl .= $comp_pointer; 4004207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 4005207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 4006a1ce18e4SJoe Perches } 4007a1ce18e4SJoe Perches } 4008a1ce18e4SJoe Perches } 4009a1ce18e4SJoe Perches 4010653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 40117429c690SAndy Whitcroft if ($dbg_type) { 40127429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 4013000d1cc1SJoe Perches ERROR("TEST_TYPE", 4014000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 40157429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 4016000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 4017000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 40187429c690SAndy Whitcroft } 4019653d4876SAndy Whitcroft next; 4020653d4876SAndy Whitcroft } 4021a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 4022a1ef277eSAndy Whitcroft if ($dbg_attr) { 40239360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 4024000d1cc1SJoe Perches ERROR("TEST_ATTR", 4025000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 40269360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 4027000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 4028000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 4029a1ef277eSAndy Whitcroft } 4030a1ef277eSAndy Whitcroft next; 4031a1ef277eSAndy Whitcroft } 4032653d4876SAndy Whitcroft 4033f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 403499423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 403599423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 4036d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 4037d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 4038f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 4039f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4040f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 4041d752fcc8SJoe Perches my $fixedline = $prevrawline; 4042d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 4043f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 4044d752fcc8SJoe Perches $fixedline = $line; 40458d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 4046f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 4047d752fcc8SJoe Perches } 4048f0a594c1SAndy Whitcroft } 4049f0a594c1SAndy Whitcroft 405000df344fSAndy Whitcroft# 405100df344fSAndy Whitcroft# Checks which are anchored on the added line. 405200df344fSAndy Whitcroft# 405300df344fSAndy Whitcroft 4054653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 4055c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 4056653d4876SAndy Whitcroft my $path = $1; 4057653d4876SAndy Whitcroft if ($path =~ m{//}) { 4058000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 4059495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 4060495e9d84SJoe Perches } 4061495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 4062495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 4063495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 4064653d4876SAndy Whitcroft } 4065653d4876SAndy Whitcroft } 4066653d4876SAndy Whitcroft 406700df344fSAndy Whitcroft# no C99 // comments 406800df344fSAndy Whitcroft if ($line =~ m{//}) { 40693705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 40703705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 40713705ce5bSJoe Perches $fix) { 4072194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 40733705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 40743705ce5bSJoe Perches my $comment = trim($1); 4075194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 40763705ce5bSJoe Perches } 40773705ce5bSJoe Perches } 407800df344fSAndy Whitcroft } 407900df344fSAndy Whitcroft # Remove C99 comments. 40800a920b5bSAndy Whitcroft $line =~ s@//.*@@; 40816c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 40820a920b5bSAndy Whitcroft 40832b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 40842b474a1aSAndy Whitcroft# the whole statement. 40852b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 40862b474a1aSAndy Whitcroft if (defined $realline_next && 40872b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 40882b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 40892b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 40902b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 40913cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 40923cbf62dfSAndy Whitcroft # a prefix: 40933cbf62dfSAndy Whitcroft # XXX(foo); 40943cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 4095653d4876SAndy Whitcroft my $name = $1; 409687a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 40973cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 40983cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 40993cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 41003cbf62dfSAndy Whitcroft 41013cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 41022b474a1aSAndy Whitcroft \n.}\s*$| 410348012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 410448012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 410548012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 41062b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 41072b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 410848012058SAndy Whitcroft )/x) { 41092b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 41102b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 41112b474a1aSAndy Whitcroft } else { 41122b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 41130a920b5bSAndy Whitcroft } 41140a920b5bSAndy Whitcroft } 41152b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 41162b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 41172b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 41182b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 41192b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 41202b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 41212b474a1aSAndy Whitcroft } 41222b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 41232b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 4124000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 4125000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 41262b474a1aSAndy Whitcroft } 41270a920b5bSAndy Whitcroft 41285150bda4SJoe Eloff# check for global initialisers. 41296d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 4130d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 41316d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 4132d5e616fcSJoe Perches $fix) { 41336d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 4134d5e616fcSJoe Perches } 4135f0a594c1SAndy Whitcroft } 41360a920b5bSAndy Whitcroft# check for static initialisers. 41376d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 4138d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 41396d32f7a3SJoe Perches "do not initialise statics to $1\n" . 4140d5e616fcSJoe Perches $herecurr) && 4141d5e616fcSJoe Perches $fix) { 41426d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 4143d5e616fcSJoe Perches } 41440a920b5bSAndy Whitcroft } 41450a920b5bSAndy Whitcroft 41461813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 41471813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 41481813087dSJoe Perches my $tmp = trim($1); 41491813087dSJoe Perches WARN("MISORDERED_TYPE", 41501813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 41511813087dSJoe Perches } 41521813087dSJoe Perches 4153809e082eSJoe Perches# check for unnecessary <signed> int declarations of short/long/long long 4154809e082eSJoe Perches while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) { 4155809e082eSJoe Perches my $type = trim($1); 4156809e082eSJoe Perches next if ($type !~ /\bint\b/); 4157809e082eSJoe Perches next if ($type !~ /\b(?:short|long\s+long|long)\b/); 4158809e082eSJoe Perches my $new_type = $type; 4159809e082eSJoe Perches $new_type =~ s/\b\s*int\s*\b/ /; 4160809e082eSJoe Perches $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /; 4161809e082eSJoe Perches $new_type =~ s/^const\s+//; 4162809e082eSJoe Perches $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/); 4163809e082eSJoe Perches $new_type = "const $new_type" if ($type =~ /^const\b/); 4164809e082eSJoe Perches $new_type =~ s/\s+/ /g; 4165809e082eSJoe Perches $new_type = trim($new_type); 4166809e082eSJoe Perches if (WARN("UNNECESSARY_INT", 4167809e082eSJoe Perches "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) && 4168809e082eSJoe Perches $fix) { 4169809e082eSJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/; 4170809e082eSJoe Perches } 4171809e082eSJoe Perches } 4172809e082eSJoe Perches 4173cb710ecaSJoe Perches# check for static const char * arrays. 4174cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 4175000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4176000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 4177cb710ecaSJoe Perches $herecurr); 4178cb710ecaSJoe Perches } 4179cb710ecaSJoe Perches 418077b8c0a8SJoe Perches# check for initialized const char arrays that should be static const 418177b8c0a8SJoe Perches if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) { 418277b8c0a8SJoe Perches if (WARN("STATIC_CONST_CHAR_ARRAY", 418377b8c0a8SJoe Perches "const array should probably be static const\n" . $herecurr) && 418477b8c0a8SJoe Perches $fix) { 418577b8c0a8SJoe Perches $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/; 418677b8c0a8SJoe Perches } 418777b8c0a8SJoe Perches } 418877b8c0a8SJoe Perches 4189cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 4190cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 4191000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4192000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 4193cb710ecaSJoe Perches $herecurr); 4194cb710ecaSJoe Perches } 4195cb710ecaSJoe Perches 4196ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 4197ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 4198ab7e23f3SJoe Perches my $found = $1; 4199ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 4200ab7e23f3SJoe Perches WARN("CONST_CONST", 4201ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 4202ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 4203ab7e23f3SJoe Perches WARN("CONST_CONST", 4204ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 4205ab7e23f3SJoe Perches } 4206ab7e23f3SJoe Perches } 4207ab7e23f3SJoe Perches 42089b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 42099b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 42109b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 42119b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 42129b0fa60dSJoe Perches $herecurr); 42139b0fa60dSJoe Perches } 42149b0fa60dSJoe Perches 4215b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 4216b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 4217b598b670SJoe Perches my $array = $1; 4218b598b670SJoe 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*\))@) { 4219b598b670SJoe Perches my $array_div = $1; 4220b598b670SJoe Perches if (WARN("ARRAY_SIZE", 4221b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 4222b598b670SJoe Perches $fix) { 4223b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 4224b598b670SJoe Perches } 4225b598b670SJoe Perches } 4226b598b670SJoe Perches } 4227b598b670SJoe Perches 4228b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 422916b7f3c8SJoe Perches if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) { 4230b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 4231b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 4232b36190c5SJoe Perches $fix) { 4233194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 4234b36190c5SJoe Perches } 4235b36190c5SJoe Perches } 4236b36190c5SJoe Perches 4237653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 4238653d4876SAndy Whitcroft# make sense. 4239653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 42408054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 4241c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 42428ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 424346d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 4244000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 4245000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 42460a920b5bSAndy Whitcroft } 42470a920b5bSAndy Whitcroft 42480a920b5bSAndy Whitcroft# * goes on variable not on type 424965863862SAndy Whitcroft # (char*[ const]) 4250bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 4251bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 42523705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 4253d8aaf121SAndy Whitcroft 425465863862SAndy Whitcroft # Should start with a space. 425565863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 425665863862SAndy Whitcroft # Should not end with a space. 425765863862SAndy Whitcroft $to =~ s/\s+$//; 425865863862SAndy Whitcroft # '*'s should not have spaces between. 4259f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 426065863862SAndy Whitcroft } 4261d8aaf121SAndy Whitcroft 42623705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 426365863862SAndy Whitcroft if ($from ne $to) { 42643705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 42653705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 42663705ce5bSJoe Perches $fix) { 42673705ce5bSJoe Perches my $sub_from = $ident; 42683705ce5bSJoe Perches my $sub_to = $ident; 42693705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4270194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42713705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 42723705ce5bSJoe Perches } 427365863862SAndy Whitcroft } 4274bfcb2cc7SAndy Whitcroft } 4275bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 4276bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 42773705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 4278d8aaf121SAndy Whitcroft 427965863862SAndy Whitcroft # Should start with a space. 428065863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 428165863862SAndy Whitcroft # Should not end with a space. 428265863862SAndy Whitcroft $to =~ s/\s+$//; 428365863862SAndy Whitcroft # '*'s should not have spaces between. 4284f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 428565863862SAndy Whitcroft } 428665863862SAndy Whitcroft # Modifiers should have spaces. 428765863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 428865863862SAndy Whitcroft 42893705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 4290667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 42913705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 42923705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 42933705ce5bSJoe Perches $fix) { 42943705ce5bSJoe Perches 42953705ce5bSJoe Perches my $sub_from = $match; 42963705ce5bSJoe Perches my $sub_to = $match; 42973705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4298194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42993705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 43003705ce5bSJoe Perches } 430165863862SAndy Whitcroft } 43020a920b5bSAndy Whitcroft } 43030a920b5bSAndy Whitcroft 43049d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 43059d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 43060675a8fbSJean Delvare my $msg_level = \&WARN; 43070675a8fbSJean Delvare $msg_level = \&CHK if ($file); 43080675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 43099d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 43109d3e3c70SJoe Perches } 43110a920b5bSAndy Whitcroft 43129d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 43138905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 4314000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 4315000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 43168905a67cSAndy Whitcroft } 43178905a67cSAndy Whitcroft 431817441227SJoe Perches# check for uses of printk_ratelimit 431917441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 4320000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 4321000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 432217441227SJoe Perches } 432317441227SJoe Perches 4324eeef5733SJoe Perches# printk should use KERN_* levels 4325eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 4326000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 4327eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 432800df344fSAndy Whitcroft } 43290a920b5bSAndy Whitcroft 4330243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 4331243f3803SJoe Perches my $orig = $1; 4332243f3803SJoe Perches my $level = lc($orig); 4333243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 43348f26b837SJoe Perches my $level2 = $level; 43358f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 4336243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 4337daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 4338243f3803SJoe Perches } 4339243f3803SJoe Perches 4340dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 4341dc139313SJoe Perches my $orig = $1; 4342dc139313SJoe Perches my $level = lc($orig); 4343dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 4344dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 4345dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 4346dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 4347dc139313SJoe Perches } 4348dc139313SJoe Perches 43498020b253SNicolas Boichat# trace_printk should not be used in production code. 43508020b253SNicolas Boichat if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) { 43518020b253SNicolas Boichat WARN("TRACE_PRINTK", 43528020b253SNicolas Boichat "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr); 43538020b253SNicolas Boichat } 43548020b253SNicolas Boichat 435591c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 435691c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 435791c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 435891c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 435991c9afafSAndy Lutomirski WARN("ENOSYS", 436091c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 436191c9afafSAndy Lutomirski } 436291c9afafSAndy Lutomirski 43636b9ea5ffSJakub Kicinski# ENOTSUPP is not a standard error code and should be avoided in new patches. 43646b9ea5ffSJakub Kicinski# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP. 43656b9ea5ffSJakub Kicinski# Similarly to ENOSYS warning a small number of false positives is expected. 43666b9ea5ffSJakub Kicinski if (!$file && $line =~ /\bENOTSUPP\b/) { 43676b9ea5ffSJakub Kicinski if (WARN("ENOTSUPP", 43686b9ea5ffSJakub Kicinski "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) && 43696b9ea5ffSJakub Kicinski $fix) { 43706b9ea5ffSJakub Kicinski $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/; 43716b9ea5ffSJakub Kicinski } 43726b9ea5ffSJakub Kicinski } 43736b9ea5ffSJakub Kicinski 4374653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 4375653d4876SAndy Whitcroft# or if closed on same line 43765b57980dSJoe Perches if ($perl_version_ok && 43772d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 43782d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 43792d453e3bSJoe Perches $sline !~ /}/) { 43808d182478SJoe Perches if (ERROR("OPEN_BRACE", 43812d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 43828d182478SJoe Perches $fix) { 43838d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 43848d182478SJoe Perches my $fixed_line = $rawline; 43858d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 43868d182478SJoe Perches my $line1 = $1; 43878d182478SJoe Perches my $line2 = $2; 43888d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 43898d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 43908d182478SJoe Perches if ($line2 !~ /^\s*$/) { 43918d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 43928d182478SJoe Perches } 43938d182478SJoe Perches } 43940a920b5bSAndy Whitcroft } 4395653d4876SAndy Whitcroft 43968905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 43978905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 43988905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 43998d182478SJoe Perches if (ERROR("OPEN_BRACE", 44008d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 44018d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 44028d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 44038d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 44048d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 44058d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 44068d182478SJoe Perches $fixedline = $rawline; 44078d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 44088d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 44098d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 44108d182478SJoe Perches } 44118d182478SJoe Perches } 44128905a67cSAndy Whitcroft } 44138905a67cSAndy Whitcroft 44140c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 44153705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 44163705ce5bSJoe Perches if (WARN("SPACING", 44173705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 44183705ce5bSJoe Perches $fix) { 4419194f66fcSJoe Perches $fixed[$fixlinenr] =~ 44203705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 44213705ce5bSJoe Perches } 44220c73b4ebSAndy Whitcroft } 44230c73b4ebSAndy Whitcroft 442431070b5dSJoe Perches# Function pointer declarations 442531070b5dSJoe Perches# check spacing between type, funcptr, and args 442631070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 442791f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 442831070b5dSJoe Perches my $declare = $1; 442931070b5dSJoe Perches my $pre_pointer_space = $2; 443031070b5dSJoe Perches my $post_pointer_space = $3; 443131070b5dSJoe Perches my $funcname = $4; 443231070b5dSJoe Perches my $post_funcname_space = $5; 443331070b5dSJoe Perches my $pre_args_space = $6; 443431070b5dSJoe Perches 443591f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 443691f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 443791f72e9cSJoe Perches# don't need a space so don't warn for those. 443891f72e9cSJoe Perches my $post_declare_space = ""; 443991f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 444091f72e9cSJoe Perches $post_declare_space = $1; 444191f72e9cSJoe Perches $declare = rtrim($declare); 444291f72e9cSJoe Perches } 444391f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 444431070b5dSJoe Perches WARN("SPACING", 444531070b5dSJoe Perches "missing space after return type\n" . $herecurr); 444691f72e9cSJoe Perches $post_declare_space = " "; 444731070b5dSJoe Perches } 444831070b5dSJoe Perches 444931070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 445091f72e9cSJoe Perches# This test is not currently implemented because these declarations are 445191f72e9cSJoe Perches# equivalent to 445291f72e9cSJoe Perches# int foo(int bar, ...) 445391f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 445491f72e9cSJoe Perches# 445591f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 445691f72e9cSJoe Perches# WARN("SPACING", 445791f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 445891f72e9cSJoe Perches# } 445931070b5dSJoe Perches 446031070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 446131070b5dSJoe Perches if (defined $pre_pointer_space && 446231070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 446331070b5dSJoe Perches WARN("SPACING", 446431070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 446531070b5dSJoe Perches } 446631070b5dSJoe Perches 446731070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 446831070b5dSJoe Perches if (defined $post_pointer_space && 446931070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 447031070b5dSJoe Perches WARN("SPACING", 447131070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 447231070b5dSJoe Perches } 447331070b5dSJoe Perches 447431070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 447531070b5dSJoe Perches if (defined $post_funcname_space && 447631070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 447731070b5dSJoe Perches WARN("SPACING", 447831070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 447931070b5dSJoe Perches } 448031070b5dSJoe Perches 448131070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 448231070b5dSJoe Perches if (defined $pre_args_space && 448331070b5dSJoe Perches $pre_args_space =~ /^\s/) { 448431070b5dSJoe Perches WARN("SPACING", 448531070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 448631070b5dSJoe Perches } 448731070b5dSJoe Perches 448831070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4489194f66fcSJoe Perches $fixed[$fixlinenr] =~ 449091f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 449131070b5dSJoe Perches } 449231070b5dSJoe Perches } 449331070b5dSJoe Perches 44948d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 44958d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4496fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4497fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 44988d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 44998d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 45008d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4501fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 450238dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 45033705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 45043705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 45053705ce5bSJoe Perches $fix) { 4506194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45073705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 45083705ce5bSJoe Perches } 45098d31cfceSAndy Whitcroft } 45108d31cfceSAndy Whitcroft } 45118d31cfceSAndy Whitcroft 4512f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 45136c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4514c2fdda0dSAndy Whitcroft my $name = $1; 4515773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4516773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4517c2fdda0dSAndy Whitcroft 4518c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4519773647a0SAndy Whitcroft if ($name =~ /^(?: 4520773647a0SAndy Whitcroft if|for|while|switch|return|case| 4521773647a0SAndy Whitcroft volatile|__volatile__| 4522773647a0SAndy Whitcroft __attribute__|format|__extension__| 4523773647a0SAndy Whitcroft asm|__asm__)$/x) 4524773647a0SAndy Whitcroft { 4525c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4526c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4527c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4528c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4529773647a0SAndy Whitcroft 4530773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4531c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4532c2fdda0dSAndy Whitcroft 4533c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4534c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4535773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4536c2fdda0dSAndy Whitcroft 4537c2fdda0dSAndy Whitcroft } else { 45383705ce5bSJoe Perches if (WARN("SPACING", 45393705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 45403705ce5bSJoe Perches $fix) { 4541194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45423705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 45433705ce5bSJoe Perches } 4544f0a594c1SAndy Whitcroft } 45456c72ffaaSAndy Whitcroft } 45469a4cad4eSEric Nelson 4547653d4876SAndy Whitcroft# Check operator spacing. 45480a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 45493705ce5bSJoe Perches my $fixed_line = ""; 45503705ce5bSJoe Perches my $line_fixed = 0; 45513705ce5bSJoe Perches 45529c0ca6f9SAndy Whitcroft my $ops = qr{ 45539c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 45549c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 45559c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 45561f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 455784731623SJoe Perches \?:|\?|: 45589c0ca6f9SAndy Whitcroft }x; 4559cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 45603705ce5bSJoe Perches 45613705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 45623705ce5bSJoe Perches## foreach my $el (@elements) { 45633705ce5bSJoe Perches## print("el: <$el>\n"); 45643705ce5bSJoe Perches## } 45653705ce5bSJoe Perches 45663705ce5bSJoe Perches my @fix_elements = (); 456700df344fSAndy Whitcroft my $off = 0; 45686c72ffaaSAndy Whitcroft 45693705ce5bSJoe Perches foreach my $el (@elements) { 45703705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 45713705ce5bSJoe Perches $off += length($el); 45723705ce5bSJoe Perches } 45733705ce5bSJoe Perches 45743705ce5bSJoe Perches $off = 0; 45753705ce5bSJoe Perches 45766c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4577b34c648bSJoe Perches my $last_after = -1; 45786c72ffaaSAndy Whitcroft 45790a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 45803705ce5bSJoe Perches 45813705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 45823705ce5bSJoe Perches 45833705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 45843705ce5bSJoe Perches 45854a0df2efSAndy Whitcroft $off += length($elements[$n]); 45864a0df2efSAndy Whitcroft 458725985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4588773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4589773647a0SAndy Whitcroft my $cc = ''; 4590773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4591773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4592773647a0SAndy Whitcroft } 4593773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4594773647a0SAndy Whitcroft 45954a0df2efSAndy Whitcroft my $a = ''; 45964a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 45974a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4598cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 45994a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 46004a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 4601773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 46024a0df2efSAndy Whitcroft 46030a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 46044a0df2efSAndy Whitcroft 46054a0df2efSAndy Whitcroft my $c = ''; 46060a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 46074a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 46084a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4609cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 46104a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 46114a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 46128b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 46134a0df2efSAndy Whitcroft } else { 46144a0df2efSAndy Whitcroft $c = 'E'; 46150a920b5bSAndy Whitcroft } 46160a920b5bSAndy Whitcroft 46174a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 46184a0df2efSAndy Whitcroft 46194a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 46204a0df2efSAndy Whitcroft 46216c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 4622de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 46230a920b5bSAndy Whitcroft 462474048ed8SAndy Whitcroft # Pull out the value of this operator. 46256c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 46260a920b5bSAndy Whitcroft 46271f65f947SAndy Whitcroft # Get the full operator variant. 46281f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 46291f65f947SAndy Whitcroft 463013214adfSAndy Whitcroft # Ignore operators passed as parameters. 463113214adfSAndy Whitcroft if ($op_type ne 'V' && 4632d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 463313214adfSAndy Whitcroft 4634cf655043SAndy Whitcroft# # Ignore comments 4635cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 463613214adfSAndy Whitcroft 4637d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 463813214adfSAndy Whitcroft } elsif ($op eq ';') { 4639cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 4640cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 46413705ce5bSJoe Perches if (ERROR("SPACING", 46423705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 4643b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 46443705ce5bSJoe Perches $line_fixed = 1; 46453705ce5bSJoe Perches } 4646d8aaf121SAndy Whitcroft } 4647d8aaf121SAndy Whitcroft 4648d8aaf121SAndy Whitcroft # // is a comment 4649d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 46500a920b5bSAndy Whitcroft 4651b00e4814SJoe Perches # : when part of a bitfield 4652b00e4814SJoe Perches } elsif ($opv eq ':B') { 4653b00e4814SJoe Perches # skip the bitfield test for now 4654b00e4814SJoe Perches 46551f65f947SAndy Whitcroft # No spaces for: 46561f65f947SAndy Whitcroft # -> 4657b00e4814SJoe Perches } elsif ($op eq '->') { 46584a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 46593705ce5bSJoe Perches if (ERROR("SPACING", 46603705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4661b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 46623705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 46633705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 46643705ce5bSJoe Perches } 4665b34c648bSJoe Perches $line_fixed = 1; 46663705ce5bSJoe Perches } 46670a920b5bSAndy Whitcroft } 46680a920b5bSAndy Whitcroft 46692381097bSJoe Perches # , must not have a space before and must have a space on the right. 46700a920b5bSAndy Whitcroft } elsif ($op eq ',') { 46712381097bSJoe Perches my $rtrim_before = 0; 46722381097bSJoe Perches my $space_after = 0; 46732381097bSJoe Perches if ($ctx =~ /Wx./) { 46742381097bSJoe Perches if (ERROR("SPACING", 46752381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 46762381097bSJoe Perches $line_fixed = 1; 46772381097bSJoe Perches $rtrim_before = 1; 46782381097bSJoe Perches } 46792381097bSJoe Perches } 4680cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 46813705ce5bSJoe Perches if (ERROR("SPACING", 46823705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 46833705ce5bSJoe Perches $line_fixed = 1; 4684b34c648bSJoe Perches $last_after = $n; 46852381097bSJoe Perches $space_after = 1; 46862381097bSJoe Perches } 46872381097bSJoe Perches } 46882381097bSJoe Perches if ($rtrim_before || $space_after) { 46892381097bSJoe Perches if ($rtrim_before) { 46902381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 46912381097bSJoe Perches } else { 46922381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 46932381097bSJoe Perches } 46942381097bSJoe Perches if ($space_after) { 46952381097bSJoe Perches $good .= " "; 46963705ce5bSJoe Perches } 46970a920b5bSAndy Whitcroft } 46980a920b5bSAndy Whitcroft 46999c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 470074048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 47019c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 47029c0ca6f9SAndy Whitcroft 47039c0ca6f9SAndy Whitcroft # unary operators should have a space before and 47049c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 47059c0ca6f9SAndy Whitcroft # unary operator, or a cast 47069c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 470774048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 47080d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4709cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 47103705ce5bSJoe Perches if (ERROR("SPACING", 47113705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4712b34c648bSJoe Perches if ($n != $last_after + 2) { 4713b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 47143705ce5bSJoe Perches $line_fixed = 1; 47153705ce5bSJoe Perches } 47160a920b5bSAndy Whitcroft } 4717b34c648bSJoe Perches } 4718a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4719171ae1a4SAndy Whitcroft # A unary '*' may be const 4720171ae1a4SAndy Whitcroft 4721171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 47223705ce5bSJoe Perches if (ERROR("SPACING", 47233705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4724b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 47253705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 47263705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 47273705ce5bSJoe Perches } 4728b34c648bSJoe Perches $line_fixed = 1; 47293705ce5bSJoe Perches } 47300a920b5bSAndy Whitcroft } 47310a920b5bSAndy Whitcroft 47320a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 47330a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4734773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 47353705ce5bSJoe Perches if (ERROR("SPACING", 47363705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4737b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 47383705ce5bSJoe Perches $line_fixed = 1; 47393705ce5bSJoe Perches } 47400a920b5bSAndy Whitcroft } 4741773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4742773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 47433705ce5bSJoe Perches if (ERROR("SPACING", 47443705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4745b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 47463705ce5bSJoe Perches $line_fixed = 1; 47473705ce5bSJoe Perches } 4748653d4876SAndy Whitcroft } 4749773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 47503705ce5bSJoe Perches if (ERROR("SPACING", 47513705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4752b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 47533705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 47543705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4755773647a0SAndy Whitcroft } 4756b34c648bSJoe Perches $line_fixed = 1; 47573705ce5bSJoe Perches } 47583705ce5bSJoe Perches } 47590a920b5bSAndy Whitcroft 47600a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 47619c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 47629c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 47639c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4764c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4765c2fdda0dSAndy Whitcroft $op eq '%') 47660a920b5bSAndy Whitcroft { 4767d2e025f3SJoe Perches if ($check) { 4768d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4769d2e025f3SJoe Perches if (CHK("SPACING", 4770d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4771d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4772d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4773d2e025f3SJoe Perches $line_fixed = 1; 4774d2e025f3SJoe Perches } 4775d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4776d2e025f3SJoe Perches if (CHK("SPACING", 4777d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4778d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4779d2e025f3SJoe Perches $line_fixed = 1; 4780d2e025f3SJoe Perches } 4781d2e025f3SJoe Perches } 4782d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 47833705ce5bSJoe Perches if (ERROR("SPACING", 47843705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4785b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4786b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4787b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4788b34c648bSJoe Perches } 47893705ce5bSJoe Perches $line_fixed = 1; 47903705ce5bSJoe Perches } 47910a920b5bSAndy Whitcroft } 47920a920b5bSAndy Whitcroft 47931f65f947SAndy Whitcroft # A colon needs no spaces before when it is 47941f65f947SAndy Whitcroft # terminating a case value or a label. 47951f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 47961f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 47973705ce5bSJoe Perches if (ERROR("SPACING", 47983705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4799b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 48003705ce5bSJoe Perches $line_fixed = 1; 48013705ce5bSJoe Perches } 48021f65f947SAndy Whitcroft } 48031f65f947SAndy Whitcroft 48040a920b5bSAndy Whitcroft # All the others need spaces both sides. 4805cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 48061f65f947SAndy Whitcroft my $ok = 0; 48071f65f947SAndy Whitcroft 480822f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 48091f65f947SAndy Whitcroft if (($op eq '<' && 48101f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 48111f65f947SAndy Whitcroft ($op eq '>' && 48121f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 48131f65f947SAndy Whitcroft { 48141f65f947SAndy Whitcroft $ok = 1; 48151f65f947SAndy Whitcroft } 48161f65f947SAndy Whitcroft 4817e0df7e1fSJoe Perches # for asm volatile statements 4818e0df7e1fSJoe Perches # ignore a colon with another 4819e0df7e1fSJoe Perches # colon immediately before or after 4820e0df7e1fSJoe Perches if (($op eq ':') && 4821e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4822e0df7e1fSJoe Perches $ok = 1; 4823e0df7e1fSJoe Perches } 4824e0df7e1fSJoe Perches 482584731623SJoe Perches # messages are ERROR, but ?: are CHK 48261f65f947SAndy Whitcroft if ($ok == 0) { 48270675a8fbSJean Delvare my $msg_level = \&ERROR; 48280675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 482984731623SJoe Perches 48300675a8fbSJean Delvare if (&{$msg_level}("SPACING", 48313705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4832b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4833b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4834b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4835b34c648bSJoe Perches } 48363705ce5bSJoe Perches $line_fixed = 1; 48373705ce5bSJoe Perches } 48380a920b5bSAndy Whitcroft } 483922f2a2efSAndy Whitcroft } 48404a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 48413705ce5bSJoe Perches 48423705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 48433705ce5bSJoe Perches 48443705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 48450a920b5bSAndy Whitcroft } 48463705ce5bSJoe Perches 48473705ce5bSJoe Perches if (($#elements % 2) == 0) { 48483705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 48493705ce5bSJoe Perches } 48503705ce5bSJoe Perches 4851194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4852194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 48533705ce5bSJoe Perches } 48543705ce5bSJoe Perches 48553705ce5bSJoe Perches 48560a920b5bSAndy Whitcroft } 48570a920b5bSAndy Whitcroft 4858786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4859d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4860786b6326SJoe Perches if (WARN("SPACING", 4861786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4862786b6326SJoe Perches $fix) { 4863194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4864786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4865786b6326SJoe Perches } 4866786b6326SJoe Perches } 4867786b6326SJoe Perches 4868f0a594c1SAndy Whitcroft# check for multiple assignments 4869f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4870000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4871000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4872f0a594c1SAndy Whitcroft } 4873f0a594c1SAndy Whitcroft 487422f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 487522f2a2efSAndy Whitcroft## # continuation. 487622f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 487722f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 487822f2a2efSAndy Whitcroft## 487922f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 488022f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 488122f2a2efSAndy Whitcroft## my $ln = $line; 488222f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 488322f2a2efSAndy Whitcroft## } 488422f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4885000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4886000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 488722f2a2efSAndy Whitcroft## } 488822f2a2efSAndy Whitcroft## } 4889f0a594c1SAndy Whitcroft 48900a920b5bSAndy Whitcroft#need space before brace following if, while, etc 48916b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 48926ad724e2SMichal Zylowski $line =~ /\b(?:else|do)\{/) { 48933705ce5bSJoe Perches if (ERROR("SPACING", 48943705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 48953705ce5bSJoe Perches $fix) { 48966ad724e2SMichal Zylowski $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/; 48973705ce5bSJoe Perches } 4898de7d4f0eSAndy Whitcroft } 4899de7d4f0eSAndy Whitcroft 4900c4a62ef9SJoe Perches## # check for blank lines before declarations 4901c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4902c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4903c4a62ef9SJoe Perches## WARN("SPACING", 4904c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4905c4a62ef9SJoe Perches## } 4906c4a62ef9SJoe Perches## 4907c4a62ef9SJoe Perches 4908de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4909de7d4f0eSAndy Whitcroft# on the line 491094fb9845SJoe Perches if ($line =~ /}(?!(?:,|;|\)|\}))\S/) { 4911d5e616fcSJoe Perches if (ERROR("SPACING", 4912d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4913d5e616fcSJoe Perches $fix) { 4914194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4915d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4916d5e616fcSJoe Perches } 49170a920b5bSAndy Whitcroft } 49180a920b5bSAndy Whitcroft 491922f2a2efSAndy Whitcroft# check spacing on square brackets 492022f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 49213705ce5bSJoe Perches if (ERROR("SPACING", 49223705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 49233705ce5bSJoe Perches $fix) { 4924194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49253705ce5bSJoe Perches s/\[\s+/\[/; 49263705ce5bSJoe Perches } 492722f2a2efSAndy Whitcroft } 492822f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 49293705ce5bSJoe Perches if (ERROR("SPACING", 49303705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 49313705ce5bSJoe Perches $fix) { 4932194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49333705ce5bSJoe Perches s/\s+\]/\]/; 49343705ce5bSJoe Perches } 493522f2a2efSAndy Whitcroft } 493622f2a2efSAndy Whitcroft 4937c45dcabdSAndy Whitcroft# check spacing on parentheses 49389c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 49399c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 49403705ce5bSJoe Perches if (ERROR("SPACING", 49413705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 49423705ce5bSJoe Perches $fix) { 4943194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49443705ce5bSJoe Perches s/\(\s+/\(/; 49453705ce5bSJoe Perches } 494622f2a2efSAndy Whitcroft } 494713214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4948c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4949c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 49503705ce5bSJoe Perches if (ERROR("SPACING", 49513705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 49523705ce5bSJoe Perches $fix) { 4953194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49543705ce5bSJoe Perches s/\s+\)/\)/; 49553705ce5bSJoe Perches } 495622f2a2efSAndy Whitcroft } 495722f2a2efSAndy Whitcroft 4958e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4959e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4960e2826fd0SJoe Perches 4961e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4962ea4acbb1SJoe Perches my $var = $1; 4963ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4964ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4965ea4acbb1SJoe Perches $fix) { 4966ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4967ea4acbb1SJoe Perches } 4968ea4acbb1SJoe Perches } 4969ea4acbb1SJoe Perches 4970ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4971ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4972ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4973ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4974ea4acbb1SJoe Perches my $var = $2; 4975ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4976ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4977ea4acbb1SJoe Perches $fix) { 4978ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4979ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4980ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4981ea4acbb1SJoe Perches } 4982e2826fd0SJoe Perches } 4983e2826fd0SJoe Perches 498463b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 4985a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 4986a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 49875b57980dSJoe Perches $perl_version_ok && defined($stat) && 498863b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 498963b7c73eSJoe Perches my $if_stat = $1; 499063b7c73eSJoe Perches my $test = substr($2, 1, -1); 499163b7c73eSJoe Perches my $herectx; 499263b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 499363b7c73eSJoe Perches my $match = $1; 499463b7c73eSJoe Perches # avoid parentheses around potential macro args 499563b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 499663b7c73eSJoe Perches if (!defined($herectx)) { 499763b7c73eSJoe Perches $herectx = $here . "\n"; 499863b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 499963b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 500063b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 500163b7c73eSJoe Perches $herectx .= $rl . "\n"; 500263b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 500363b7c73eSJoe Perches } 500463b7c73eSJoe Perches } 500563b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 500663b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 500763b7c73eSJoe Perches } 500863b7c73eSJoe Perches } 500963b7c73eSJoe Perches 50100a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 50114a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 50120a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 50133705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 50143705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 50153705ce5bSJoe Perches $fix) { 5016194f66fcSJoe Perches $fixed[$fixlinenr] =~ 50173705ce5bSJoe Perches s/^(.)\s+/$1/; 50183705ce5bSJoe Perches } 50190a920b5bSAndy Whitcroft } 50200a920b5bSAndy Whitcroft 502140873abaSJoe Perches# check if a statement with a comma should be two statements like: 502240873abaSJoe Perches# foo = bar(), /* comma should be semicolon */ 502340873abaSJoe Perches# bar = baz(); 502440873abaSJoe Perches if (defined($stat) && 502540873abaSJoe Perches $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) { 502640873abaSJoe Perches my $cnt = statement_rawlines($stat); 502740873abaSJoe Perches my $herectx = get_stat_here($linenr, $cnt, $here); 502840873abaSJoe Perches WARN("SUSPECT_COMMA_SEMICOLON", 502940873abaSJoe Perches "Possible comma where semicolon could be used\n" . $herectx); 503040873abaSJoe Perches } 503140873abaSJoe Perches 50325b9553abSJoe Perches# return is not a function 5033507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 5034c45dcabdSAndy Whitcroft my $spacing = $1; 50355b57980dSJoe Perches if ($perl_version_ok && 50365b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 50375b9553abSJoe Perches my $value = $1; 50385b9553abSJoe Perches $value = deparenthesize($value); 50395b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 5040000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 5041000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 50425b9553abSJoe Perches } 5043c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 5044000d1cc1SJoe Perches ERROR("SPACING", 5045000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 5046c45dcabdSAndy Whitcroft } 5047c45dcabdSAndy Whitcroft } 5048507e5141SJoe Perches 5049b43ae21bSJoe Perches# unnecessary return in a void function 5050b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 5051b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 5052b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 5053b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 5054b43ae21bSJoe Perches $linenr >= 3 && 5055b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 5056b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 50579819cf25SJoe Perches WARN("RETURN_VOID", 5058b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 50599819cf25SJoe Perches } 50609819cf25SJoe Perches 5061189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 50625b57980dSJoe Perches if ($perl_version_ok && 5063189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 5064189248d8SJoe Perches my $openparens = $1; 5065189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 5066189248d8SJoe Perches my $msg = ""; 5067189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 5068189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 5069189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 5070189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 5071189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 5072189248d8SJoe Perches } 5073189248d8SJoe Perches } 5074189248d8SJoe Perches 5075c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 5076c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 5077c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 5078c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 50795b57980dSJoe Perches if ($perl_version_ok && 5080c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 5081c5595fa2SJoe Perches my $lead = $1; 5082c5595fa2SJoe Perches my $const = $2; 5083c5595fa2SJoe Perches my $comp = $3; 5084c5595fa2SJoe Perches my $to = $4; 5085c5595fa2SJoe Perches my $newcomp = $comp; 5086f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 5087c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 5088c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 5089c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 5090c5595fa2SJoe Perches $fix) { 5091c5595fa2SJoe Perches if ($comp eq "<") { 5092c5595fa2SJoe Perches $newcomp = ">"; 5093c5595fa2SJoe Perches } elsif ($comp eq "<=") { 5094c5595fa2SJoe Perches $newcomp = ">="; 5095c5595fa2SJoe Perches } elsif ($comp eq ">") { 5096c5595fa2SJoe Perches $newcomp = "<"; 5097c5595fa2SJoe Perches } elsif ($comp eq ">=") { 5098c5595fa2SJoe Perches $newcomp = "<="; 5099c5595fa2SJoe Perches } 5100c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 5101c5595fa2SJoe Perches } 5102c5595fa2SJoe Perches } 5103c5595fa2SJoe Perches 5104f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 5105f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 510653a3c448SAndy Whitcroft my $name = $1; 510753a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 5108000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 5109f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 511053a3c448SAndy Whitcroft } 511153a3c448SAndy Whitcroft } 5112c45dcabdSAndy Whitcroft 51130a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 51144a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 51153705ce5bSJoe Perches if (ERROR("SPACING", 51163705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 51173705ce5bSJoe Perches $fix) { 5118194f66fcSJoe Perches $fixed[$fixlinenr] =~ 51193705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 51203705ce5bSJoe Perches } 51210a920b5bSAndy Whitcroft } 51220a920b5bSAndy Whitcroft 5123f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 5124f5fe35ddSAndy Whitcroft# statements after the conditional. 5125170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 51263e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 51273e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 51283e469cdcSAndy Whitcroft if (!defined $stat); 5129170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 5130170d3a22SAndy Whitcroft $remain_next, $off_next); 5131170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 5132170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 5133170d3a22SAndy Whitcroft 5134170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 5135170d3a22SAndy Whitcroft # If the statement carries leading newlines, 5136170d3a22SAndy Whitcroft # then count those as offsets. 5137170d3a22SAndy Whitcroft my ($whitespace) = 5138170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 5139170d3a22SAndy Whitcroft my $offset = 5140170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 5141170d3a22SAndy Whitcroft 5142170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 5143170d3a22SAndy Whitcroft $offset} = 1; 5144170d3a22SAndy Whitcroft } 5145170d3a22SAndy Whitcroft } 5146170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 5147c11230f4SJoe Perches defined($stat) && defined($cond) && 5148170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 5149171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 51508905a67cSAndy Whitcroft 5151b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 515265b64b3bSJoe Perches if (ERROR("ASSIGN_IN_IF", 515365b64b3bSJoe Perches "do not use assignment in if condition\n" . $herecurr) && 515465b64b3bSJoe Perches $fix && $perl_version_ok) { 515565b64b3bSJoe Perches if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) { 515665b64b3bSJoe Perches my $space = $1; 515765b64b3bSJoe Perches my $not = $2; 515865b64b3bSJoe Perches my $statement = $3; 515965b64b3bSJoe Perches my $assigned = $4; 516065b64b3bSJoe Perches my $test = $8; 516165b64b3bSJoe Perches my $against = $9; 516265b64b3bSJoe Perches my $brace = $15; 516365b64b3bSJoe Perches fix_delete_line($fixlinenr, $rawline); 516465b64b3bSJoe Perches fix_insert_line($fixlinenr, "$space$statement;"); 516565b64b3bSJoe Perches my $newline = "${space}if ("; 516665b64b3bSJoe Perches $newline .= '!' if defined($not); 516765b64b3bSJoe Perches $newline .= '(' if (defined $not && defined($test) && defined($against)); 516865b64b3bSJoe Perches $newline .= "$assigned"; 516965b64b3bSJoe Perches $newline .= " $test $against" if (defined($test) && defined($against)); 517065b64b3bSJoe Perches $newline .= ')' if (defined $not && defined($test) && defined($against)); 517165b64b3bSJoe Perches $newline .= ')'; 517265b64b3bSJoe Perches $newline .= " {" if (defined($brace)); 517365b64b3bSJoe Perches fix_insert_line($fixlinenr + 1, $newline); 517465b64b3bSJoe Perches } 517565b64b3bSJoe Perches } 51768905a67cSAndy Whitcroft } 51778905a67cSAndy Whitcroft 51788905a67cSAndy Whitcroft # Find out what is on the end of the line after the 51798905a67cSAndy Whitcroft # conditional. 5180773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 51818905a67cSAndy Whitcroft $s =~ s/\n.*//g; 518213214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 518353210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 518453210168SAndy Whitcroft $c !~ /}\s*while\s*/) 5185773647a0SAndy Whitcroft { 5186bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 5187bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 5188bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 518942bdf74cSHidetoshi Seto my $stat_real = ''; 5190bb44ad39SAndy Whitcroft 519142bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 519242bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 5193bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 5194bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 5195bb44ad39SAndy Whitcroft } 5196bb44ad39SAndy Whitcroft 5197000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5198000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 51998905a67cSAndy Whitcroft } 52008905a67cSAndy Whitcroft } 52018905a67cSAndy Whitcroft 520213214adfSAndy Whitcroft# Check for bitwise tests written as boolean 520313214adfSAndy Whitcroft if ($line =~ / 520413214adfSAndy Whitcroft (?: 520513214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 520613214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 520713214adfSAndy Whitcroft (?:\&\&|\|\|) 520813214adfSAndy Whitcroft | 520913214adfSAndy Whitcroft (?:\&\&|\|\|) 521013214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 521113214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 521213214adfSAndy Whitcroft )/x) 521313214adfSAndy Whitcroft { 5214000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 5215000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 521613214adfSAndy Whitcroft } 521713214adfSAndy Whitcroft 52188905a67cSAndy Whitcroft# if and else should not have general statements after it 521913214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 522013214adfSAndy Whitcroft my $s = $1; 522113214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 522213214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 5223000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5224000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 52250a920b5bSAndy Whitcroft } 522613214adfSAndy Whitcroft } 522739667782SAndy Whitcroft# if should not continue a brace 522839667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 5229000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5230048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 523139667782SAndy Whitcroft $herecurr); 523239667782SAndy Whitcroft } 5233a1080bf8SAndy Whitcroft# case and default should not have general statements after them 5234a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 5235a1080bf8SAndy Whitcroft $line !~ /\G(?: 52363fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 5237a1080bf8SAndy Whitcroft \s*return\s+ 5238a1080bf8SAndy Whitcroft )/xg) 5239a1080bf8SAndy Whitcroft { 5240000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5241000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 5242a1080bf8SAndy Whitcroft } 52430a920b5bSAndy Whitcroft 52440a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 52450a920b5bSAndy Whitcroft # indent level to be relevant to each other. 52468b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 52470a920b5bSAndy Whitcroft $previndent == $indent) { 52488b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 52498b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 52508b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 52518b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 52528b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 52538b8856f4SJoe Perches my $fixedline = $prevrawline; 52548b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 52558b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 52568b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 52578b8856f4SJoe Perches } 52588b8856f4SJoe Perches $fixedline = $rawline; 52598b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 52608b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 52618b8856f4SJoe Perches } 52620a920b5bSAndy Whitcroft } 52630a920b5bSAndy Whitcroft 52648b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 5265c2fdda0dSAndy Whitcroft $previndent == $indent) { 5266c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 5267c2fdda0dSAndy Whitcroft 5268c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 5269c2fdda0dSAndy Whitcroft # conditional. 5270773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 5271c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 5272c2fdda0dSAndy Whitcroft 5273c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 52748b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 52758b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 52768b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 52778b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 52788b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 52798b8856f4SJoe Perches my $fixedline = $prevrawline; 52808b8856f4SJoe Perches my $trailing = $rawline; 52818b8856f4SJoe Perches $trailing =~ s/^\+//; 52828b8856f4SJoe Perches $trailing = trim($trailing); 52838b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 52848b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 52858b8856f4SJoe Perches } 5286c2fdda0dSAndy Whitcroft } 5287c2fdda0dSAndy Whitcroft } 5288c2fdda0dSAndy Whitcroft 528995e2c602SJoe Perches#Specific variable tests 5290323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 5291323c1260SJoe Perches my $var = $1; 529295e2c602SJoe Perches 529395e2c602SJoe Perches#CamelCase 5294807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 5295be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 529622735ce8SJoe Perches#Ignore Page<foo> variants 5297807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 5298d439e6a5SJoe Perches#Ignore SI style variants like nS, mV and dB 5299d439e6a5SJoe Perches#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE) 5300d439e6a5SJoe Perches $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ && 5301f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 5302f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 53037e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 53047e781f67SJoe Perches my $word = $1; 53057e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 5306d8b07710SJoe Perches if ($check) { 5307d8b07710SJoe Perches seed_camelcase_includes(); 5308d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 5309d8b07710SJoe Perches seed_camelcase_file($realfile); 5310d8b07710SJoe Perches $camelcase_file_seeded = 1; 5311d8b07710SJoe Perches } 5312d8b07710SJoe Perches } 53137e781f67SJoe Perches if (!defined $camelcase{$word}) { 53147e781f67SJoe Perches $camelcase{$word} = 1; 5315be79794bSJoe Perches CHK("CAMELCASE", 53167e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 53177e781f67SJoe Perches } 5318323c1260SJoe Perches } 5319323c1260SJoe Perches } 53203445686aSJoe Perches } 53210a920b5bSAndy Whitcroft 53220a920b5bSAndy Whitcroft#no spaces allowed after \ in define 5323d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 5324d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 5325d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 5326d5e616fcSJoe Perches $fix) { 5327194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 5328d5e616fcSJoe Perches } 53290a920b5bSAndy Whitcroft } 53300a920b5bSAndy Whitcroft 53310e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 53320e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 5333c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 5334e09dec48SAndy Whitcroft my $file = "$1.h"; 5335e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 5336e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 5337e09dec48SAndy Whitcroft $realfile ne $checkfile && 53387840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 5339c45dcabdSAndy Whitcroft { 53400e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 53410e212e0aSFabian Frederick if ($asminclude > 0) { 5342e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 5343000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 5344000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5345e09dec48SAndy Whitcroft } else { 5346000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 5347000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5348e09dec48SAndy Whitcroft } 53490a920b5bSAndy Whitcroft } 53500a920b5bSAndy Whitcroft } 53510e212e0aSFabian Frederick } 53520a920b5bSAndy Whitcroft 5353653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 5354653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 5355cf655043SAndy Whitcroft# in a known good container 5356b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 5357b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 5358d8aaf121SAndy Whitcroft my $ln = $linenr; 5359d8aaf121SAndy Whitcroft my $cnt = $realcnt; 5360c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 5361c45dcabdSAndy Whitcroft my $ctx = ''; 536208a2843eSJoe Perches my $has_flow_statement = 0; 536308a2843eSJoe Perches my $has_arg_concat = 0; 5364c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 5365f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 5366f74bd194SAndy Whitcroft $ctx = $dstat; 5367c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 5368a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 5369c45dcabdSAndy Whitcroft 537008a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 537162e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 537208a2843eSJoe Perches 5373f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 5374f59b64bfSJoe Perches my $define_args = $1; 5375f59b64bfSJoe Perches my $define_stmt = $dstat; 5376f59b64bfSJoe Perches my @def_args = (); 5377f59b64bfSJoe Perches 5378f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 5379f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 5380f59b64bfSJoe Perches $define_args =~ s/\s*//g; 53818c8c45cfSJoe Perches $define_args =~ s/\\\+?//g; 5382f59b64bfSJoe Perches @def_args = split(",", $define_args); 5383f59b64bfSJoe Perches } 5384f59b64bfSJoe Perches 5385292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 5386c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 5387c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 5388c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 5389c45dcabdSAndy Whitcroft 5390c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 53912e44e803SDwaipayan Ray while ($dstat =~ s/\([^\(\)]*\)/1u/ || 53922e44e803SDwaipayan Ray $dstat =~ s/\{[^\{\}]*\}/1u/ || 53932e44e803SDwaipayan Ray $dstat =~ s/.\[[^\[\]]*\]/1u/) 5394bf30d6edSAndy Whitcroft { 5395c45dcabdSAndy Whitcroft } 5396c45dcabdSAndy Whitcroft 5397342d3d2fSAntonio Borneo # Flatten any obvious string concatenation. 539833acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 539933acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 5400e45bab8eSAndy Whitcroft { 5401e45bab8eSAndy Whitcroft } 5402e45bab8eSAndy Whitcroft 540342e15293SJoe Perches # Make asm volatile uses seem like a generic function 540442e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 540542e15293SJoe Perches 5406c45dcabdSAndy Whitcroft my $exceptions = qr{ 5407c45dcabdSAndy Whitcroft $Declare| 5408c45dcabdSAndy Whitcroft module_param_named| 5409a0a0a7a9SKees Cook MODULE_PARM_DESC| 5410c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 5411c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 5412383099fdSAndy Whitcroft __typeof__\(| 541322fd2d3eSStefani Seibold union| 541422fd2d3eSStefani Seibold struct| 5415ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 54166b10df42SVladimir Zapolskiy ^\"|\"$| 54176b10df42SVladimir Zapolskiy ^\[ 5418c45dcabdSAndy Whitcroft }x; 54195eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 5420f59b64bfSJoe Perches 5421f59b64bfSJoe Perches $ctx =~ s/\n*$//; 5422f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 5423e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 5424f59b64bfSJoe Perches 5425f74bd194SAndy Whitcroft if ($dstat ne '' && 5426f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 5427f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 54283cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 5429356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5430f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 5431f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5432e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 543372f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 54342e44e803SDwaipayan Ray $dstat !~ /^while\s*$Constant\s*$Constant\s*$/ && # while (...) {...} 5435f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5436f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5437f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 54384e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5439f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5440c45dcabdSAndy Whitcroft { 5441e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5442e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5443e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5444e795556aSJoe Perches } elsif ($dstat =~ /;/) { 5445f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5446f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5447f74bd194SAndy Whitcroft } else { 5448000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 5449388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5450d8aaf121SAndy Whitcroft } 5451f59b64bfSJoe Perches 5452f59b64bfSJoe Perches } 54535207649bSJoe Perches 54545207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 54555207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 54565207649bSJoe Perches my $first = 1; 54575207649bSJoe Perches $define_stmt = ""; 54585207649bSJoe Perches foreach my $l (@stmt_array) { 54595207649bSJoe Perches $l =~ s/\\$//; 54605207649bSJoe Perches if ($first) { 54615207649bSJoe Perches $define_stmt = $l; 54625207649bSJoe Perches $first = 0; 54635207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 54645207649bSJoe Perches $define_stmt .= substr($l, 1); 54655207649bSJoe Perches } 54665207649bSJoe Perches } 54675207649bSJoe Perches $define_stmt =~ s/$;//g; 54685207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 54695207649bSJoe Perches $define_stmt = trim($define_stmt); 54705207649bSJoe Perches 5471f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5472f59b64bfSJoe Perches foreach my $arg (@def_args) { 5473f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 54749192d41aSJoe Perches next if ($arg =~ /^type$/i); 54757fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 54766dba824eSBrendan Jackman $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 54777fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 54787fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 5479d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 5480f59b64bfSJoe Perches if ($use_cnt > 1) { 5481f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5482f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5483f59b64bfSJoe Perches } 54849192d41aSJoe Perches# check if any macro arguments may have other precedence issues 54857fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 54869192d41aSJoe Perches ((defined($1) && $1 ne ',') || 54879192d41aSJoe Perches (defined($2) && $2 ne ','))) { 54889192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 54899192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 54909192d41aSJoe Perches } 54910a920b5bSAndy Whitcroft } 54925023d347SJoe Perches 549308a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 549408a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 549508a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 549608a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 5497e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 549808a2843eSJoe Perches 549908a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 550008a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 550108a2843eSJoe Perches } 550208a2843eSJoe Perches 5503481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 55045023d347SJoe Perches 55055023d347SJoe Perches } else { 55065023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5507481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5508481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 55095023d347SJoe Perches $line =~ /^\+.*\\$/) { 55105023d347SJoe Perches WARN("LINE_CONTINUATIONS", 55115023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 55125023d347SJoe Perches } 5513653d4876SAndy Whitcroft } 55140a920b5bSAndy Whitcroft 5515b13edf7fSJoe Perches# do {} while (0) macro tests: 5516b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5517b13edf7fSJoe Perches# macro should not end with a semicolon 55185b57980dSJoe Perches if ($perl_version_ok && 5519b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5520b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5521b13edf7fSJoe Perches my $ln = $linenr; 5522b13edf7fSJoe Perches my $cnt = $realcnt; 5523b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5524b13edf7fSJoe Perches my $ctx = ''; 5525b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5526b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5527b13edf7fSJoe Perches $ctx = $dstat; 5528b13edf7fSJoe Perches 5529b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 55301b36b201SJoe Perches $dstat =~ s/$;/ /g; 5531b13edf7fSJoe Perches 5532b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5533b13edf7fSJoe Perches my $stmts = $2; 5534b13edf7fSJoe Perches my $semis = $3; 5535b13edf7fSJoe Perches 5536b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5537b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5538e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5539b13edf7fSJoe Perches 5540ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5541ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5542b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5543b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5544b13edf7fSJoe Perches } 5545b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5546b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5547b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5548b13edf7fSJoe Perches } 5549f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5550f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5551f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5552e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5553f5ef95b1SJoe Perches 5554f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5555f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5556b13edf7fSJoe Perches } 5557b13edf7fSJoe Perches } 5558b13edf7fSJoe Perches 5559f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 556013214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 556113214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5562cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 556313214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5564cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5565cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5566aad4f614SJoe Perches my @allowed = (); 5567aad4f614SJoe Perches my $allow = 0; 556813214adfSAndy Whitcroft my $seen = 0; 5569773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5570cf655043SAndy Whitcroft my $ln = $linenr - 1; 557113214adfSAndy Whitcroft for my $chunk (@chunks) { 557213214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 557313214adfSAndy Whitcroft 5574773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5575773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5576773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 5577773647a0SAndy Whitcroft 5578aad4f614SJoe Perches $allowed[$allow] = 0; 5579773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5580773647a0SAndy Whitcroft 5581773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 5582773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 5583773647a0SAndy Whitcroft 5584773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5585cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 5586cf655043SAndy Whitcroft 5587773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 558813214adfSAndy Whitcroft 558913214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 559013214adfSAndy Whitcroft 5591aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5592cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5593cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5594aad4f614SJoe Perches $allowed[$allow] = 1; 559513214adfSAndy Whitcroft } 559613214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5597cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5598aad4f614SJoe Perches $allowed[$allow] = 1; 559913214adfSAndy Whitcroft } 5600cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5601cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5602aad4f614SJoe Perches $allowed[$allow] = 1; 560313214adfSAndy Whitcroft } 5604aad4f614SJoe Perches $allow++; 560513214adfSAndy Whitcroft } 5606aad4f614SJoe Perches if ($seen) { 5607aad4f614SJoe Perches my $sum_allowed = 0; 5608aad4f614SJoe Perches foreach (@allowed) { 5609aad4f614SJoe Perches $sum_allowed += $_; 5610aad4f614SJoe Perches } 5611aad4f614SJoe Perches if ($sum_allowed == 0) { 5612000d1cc1SJoe Perches WARN("BRACES", 5613000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 5614aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 5615aad4f614SJoe Perches $seen != $allow) { 5616aad4f614SJoe Perches CHK("BRACES", 5617aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 5618aad4f614SJoe Perches } 561913214adfSAndy Whitcroft } 562013214adfSAndy Whitcroft } 562113214adfSAndy Whitcroft } 5622773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 562313214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 5624cf655043SAndy Whitcroft my $allowed = 0; 5625f0a594c1SAndy Whitcroft 5626cf655043SAndy Whitcroft # Check the pre-context. 5627cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 5628cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 5629cf655043SAndy Whitcroft $allowed = 1; 5630f0a594c1SAndy Whitcroft } 5631773647a0SAndy Whitcroft 5632773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 5633773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 5634773647a0SAndy Whitcroft 5635cf655043SAndy Whitcroft # Check the condition. 5636cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 5637773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 5638cf655043SAndy Whitcroft if (defined $cond) { 5639773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5640cf655043SAndy Whitcroft } 5641cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5642cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5643cf655043SAndy Whitcroft $allowed = 1; 5644cf655043SAndy Whitcroft } 5645cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5646cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5647cf655043SAndy Whitcroft $allowed = 1; 5648cf655043SAndy Whitcroft } 5649cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5650cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5651cf655043SAndy Whitcroft $allowed = 1; 5652cf655043SAndy Whitcroft } 5653cf655043SAndy Whitcroft # Check the post-context. 5654cf655043SAndy Whitcroft if (defined $chunks[1]) { 5655cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 5656cf655043SAndy Whitcroft if (defined $cond) { 5657773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5658cf655043SAndy Whitcroft } 5659cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 5660cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5661cf655043SAndy Whitcroft $allowed = 1; 5662cf655043SAndy Whitcroft } 5663cf655043SAndy Whitcroft } 5664cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 5665f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 5666e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5667cf655043SAndy Whitcroft 5668000d1cc1SJoe Perches WARN("BRACES", 5669000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 5670f0a594c1SAndy Whitcroft } 5671f0a594c1SAndy Whitcroft } 5672f0a594c1SAndy Whitcroft 5673e4c5babdSJoe Perches# check for single line unbalanced braces 567495330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 567595330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 5676e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 5677e4c5babdSJoe Perches } 5678e4c5babdSJoe Perches 56790979ae66SJoe Perches# check for unnecessary blank lines around braces 568077b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5681f8e58219SJoe Perches if (CHK("BRACES", 5682f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5683f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 5684f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5685f8e58219SJoe Perches } 56860979ae66SJoe Perches } 568777b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5688f8e58219SJoe Perches if (CHK("BRACES", 5689f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5690f8e58219SJoe Perches $fix) { 5691f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 5692f8e58219SJoe Perches } 56930979ae66SJoe Perches } 56940979ae66SJoe Perches 56954a0df2efSAndy Whitcroft# no volatiles please 56966c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 56976c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5698000d1cc1SJoe Perches WARN("VOLATILE", 56998c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 57004a0df2efSAndy Whitcroft } 57014a0df2efSAndy Whitcroft 57025e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 57035e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 57045e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 57055e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 570633acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 57075e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 57085e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 57095e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 57105e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 57115e4f6ba5SJoe Perches $fix && 57125e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 57135e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 57145e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 57155e4f6ba5SJoe Perches my $comma_close = ""; 57165e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 57175e4f6ba5SJoe Perches $comma_close = $1; 57185e4f6ba5SJoe Perches } 57195e4f6ba5SJoe Perches 57205e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 57215e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 57225e4f6ba5SJoe Perches my $fixedline = $prevrawline; 57235e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 57245e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 57255e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 57265e4f6ba5SJoe Perches $fixedline = $rawline; 57275e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 57285e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 57295e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 57305e4f6ba5SJoe Perches } 57315e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 57325e4f6ba5SJoe Perches } 57335e4f6ba5SJoe Perches } 57345e4f6ba5SJoe Perches 57355e4f6ba5SJoe Perches# check for missing a space in a string concatenation 57365e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 57375e4f6ba5SJoe Perches WARN('MISSING_SPACE', 57385e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 57395e4f6ba5SJoe Perches } 57405e4f6ba5SJoe Perches 574177cb8546SJoe Perches# check for an embedded function name in a string when the function is known 5742e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 5743e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 5744e4b7d309SJoe Perches# function declarations 574577cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 574677cb8546SJoe Perches defined($context_function) && 5747e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 5748e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 574977cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 5750e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 575177cb8546SJoe Perches } 575277cb8546SJoe Perches 57535e4f6ba5SJoe Perches# check for spaces before a quoted newline 57545e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 57555e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 57565e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 57575e4f6ba5SJoe Perches $fix) { 57585e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 57595e4f6ba5SJoe Perches } 57605e4f6ba5SJoe Perches 57615e4f6ba5SJoe Perches } 57625e4f6ba5SJoe Perches 5763f17dba4fSJoe Perches# concatenated string without spaces between elements 576479682c0cSJoe Perches if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) { 576579682c0cSJoe Perches if (CHK("CONCATENATED_STRING", 576679682c0cSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr) && 576779682c0cSJoe Perches $fix) { 576879682c0cSJoe Perches while ($line =~ /($String)/g) { 576979682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 577079682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/; 577179682c0cSJoe Perches $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/; 577279682c0cSJoe Perches } 577379682c0cSJoe Perches } 5774f17dba4fSJoe Perches } 5775f17dba4fSJoe Perches 577690ad30e5SJoe Perches# uncoalesced string fragments 577733acb54aSJoe Perches if ($line =~ /$String\s*"/) { 577879682c0cSJoe Perches if (WARN("STRING_FRAGMENTS", 577979682c0cSJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr) && 578079682c0cSJoe Perches $fix) { 578179682c0cSJoe Perches while ($line =~ /($String)(?=\s*")/g) { 578279682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 578379682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e; 578479682c0cSJoe Perches } 578579682c0cSJoe Perches } 578690ad30e5SJoe Perches } 578790ad30e5SJoe Perches 5788522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 5789522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 5790522b837cSAlexey Dobriyan my $show_Z = 1; 57915e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 5792522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 57935e4f6ba5SJoe Perches $string =~ s/%%/__/g; 5794522b837cSAlexey Dobriyan # check for %L 5795522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 57965e4f6ba5SJoe Perches WARN("PRINTF_L", 5797522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 5798522b837cSAlexey Dobriyan $show_L = 0; 57995e4f6ba5SJoe Perches } 5800522b837cSAlexey Dobriyan # check for %Z 5801522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 5802522b837cSAlexey Dobriyan WARN("PRINTF_Z", 5803522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 5804522b837cSAlexey Dobriyan $show_Z = 0; 5805522b837cSAlexey Dobriyan } 5806522b837cSAlexey Dobriyan # check for 0x<decimal> 5807522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 5808522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 58096e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 58106e300757SJoe Perches } 58115e4f6ba5SJoe Perches } 58125e4f6ba5SJoe Perches 58135e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 58143f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 58155e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 58165e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 58175e4f6ba5SJoe Perches } 58185e4f6ba5SJoe Perches 581900df344fSAndy Whitcroft# warn about #if 0 5820c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 582160f89010SPrakruthi Deepak Heragu WARN("IF_0", 582260f89010SPrakruthi Deepak Heragu "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr); 582360f89010SPrakruthi Deepak Heragu } 582460f89010SPrakruthi Deepak Heragu 582560f89010SPrakruthi Deepak Heragu# warn about #if 1 582660f89010SPrakruthi Deepak Heragu if ($line =~ /^.\s*\#\s*if\s+1\b/) { 582760f89010SPrakruthi Deepak Heragu WARN("IF_1", 582860f89010SPrakruthi Deepak Heragu "Consider removing the #if 1 and its #endif\n" . $herecurr); 58294a0df2efSAndy Whitcroft } 58304a0df2efSAndy Whitcroft 583103df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 583203df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5833100425deSJoe Perches my $tested = quotemeta($1); 5834100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5835100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5836100425deSJoe Perches my $func = $1; 5837100425deSJoe Perches if (WARN('NEEDLESS_IF', 5838100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5839100425deSJoe Perches $fix) { 5840100425deSJoe Perches my $do_fix = 1; 5841100425deSJoe Perches my $leading_tabs = ""; 5842100425deSJoe Perches my $new_leading_tabs = ""; 5843100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5844100425deSJoe Perches $leading_tabs = $1; 5845100425deSJoe Perches } else { 5846100425deSJoe Perches $do_fix = 0; 5847100425deSJoe Perches } 5848100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5849100425deSJoe Perches $new_leading_tabs = $1; 5850100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5851100425deSJoe Perches $do_fix = 0; 5852100425deSJoe Perches } 5853100425deSJoe Perches } else { 5854100425deSJoe Perches $do_fix = 0; 5855100425deSJoe Perches } 5856100425deSJoe Perches if ($do_fix) { 5857100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5858100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5859100425deSJoe Perches } 5860100425deSJoe Perches } 58614c432a8fSGreg Kroah-Hartman } 58624c432a8fSGreg Kroah-Hartman } 5863f0a594c1SAndy Whitcroft 5864ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5865ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5866ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5867ebfdc409SJoe Perches (defined $1 || defined $3) && 5868ebfdc409SJoe Perches $linenr > 3) { 5869ebfdc409SJoe Perches my $testval = $2; 5870ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5871ebfdc409SJoe Perches 5872ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5873ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5874ebfdc409SJoe Perches 5875e29a70f1SJoe Perches if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ && 5876e29a70f1SJoe Perches $s !~ /\b__GFP_NOWARN\b/ ) { 5877ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5878ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5879ebfdc409SJoe Perches } 5880ebfdc409SJoe Perches } 5881ebfdc409SJoe Perches 5882f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5883dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5884f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5885f78d98f6SJoe Perches my $level = $1; 5886f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5887f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5888f78d98f6SJoe Perches $fix) { 5889f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5890f78d98f6SJoe Perches } 5891f78d98f6SJoe Perches } 5892f78d98f6SJoe Perches 589345c55e92SJoe Perches# check for logging continuations 589445c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 589545c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 589645c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 589745c55e92SJoe Perches } 589845c55e92SJoe Perches 5899abb08a53SJoe Perches# check for mask then right shift without a parentheses 59005b57980dSJoe Perches if ($perl_version_ok && 5901abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5902abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5903abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5904abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5905abb08a53SJoe Perches } 5906abb08a53SJoe Perches 5907b75ac618SJoe Perches# check for pointer comparisons to NULL 59085b57980dSJoe Perches if ($perl_version_ok) { 5909b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5910b75ac618SJoe Perches my $val = $1; 5911b75ac618SJoe Perches my $equal = "!"; 5912b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5913b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5914b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5915b75ac618SJoe Perches $fix) { 5916b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5917b75ac618SJoe Perches } 5918b75ac618SJoe Perches } 5919b75ac618SJoe Perches } 5920b75ac618SJoe Perches 59218716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 59228716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 59238716de38SJoe Perches my $attr = $1; 59248716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 59258716de38SJoe Perches my $ptr = $1; 59268716de38SJoe Perches my $var = $2; 59278716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 59288716de38SJoe Perches ERROR("MISPLACED_INIT", 59298716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 59308716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 59318716de38SJoe Perches WARN("MISPLACED_INIT", 59328716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 59338716de38SJoe Perches $fix) { 5934194f66fcSJoe 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; 59358716de38SJoe Perches } 59368716de38SJoe Perches } 59378716de38SJoe Perches } 59388716de38SJoe Perches 5939e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5940e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5941e970b884SJoe Perches my $attr = $1; 5942e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5943e970b884SJoe Perches my $attr_prefix = $1; 5944e970b884SJoe Perches my $attr_type = $2; 5945e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5946e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5947e970b884SJoe Perches $fix) { 5948194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5949e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5950e970b884SJoe Perches } 5951e970b884SJoe Perches } 5952e970b884SJoe Perches 5953e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5954e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5955e970b884SJoe Perches my $attr = $1; 5956e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5957e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5958e970b884SJoe Perches $fix) { 5959194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5960e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5961e970b884SJoe Perches $lead = rtrim($1); 5962e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5963e970b884SJoe Perches $lead = "${lead}const "; 5964194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5965e970b884SJoe Perches } 5966e970b884SJoe Perches } 5967e970b884SJoe Perches 5968c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5969c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5970c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5971c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5972c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5973c17893c7SJoe Perches $fix) { 5974c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5975c17893c7SJoe Perches } 5976c17893c7SJoe Perches } 5977c17893c7SJoe Perches 5978fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5979fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5980fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5981fbdb8138SJoe Perches my $constant_func = $1; 5982fbdb8138SJoe Perches my $func = $constant_func; 5983fbdb8138SJoe Perches $func =~ s/^__constant_//; 5984fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5985fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5986fbdb8138SJoe Perches $fix) { 5987194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5988fbdb8138SJoe Perches } 5989fbdb8138SJoe Perches } 5990fbdb8138SJoe Perches 59911a15a250SPatrick Pannuto# prefer usleep_range over udelay 599237581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 599343c1d77cSJoe Perches my $delay = $1; 59941a15a250SPatrick Pannuto # ignore udelay's < 10, however 599543c1d77cSJoe Perches if (! ($delay < 10) ) { 5996000d1cc1SJoe Perches CHK("USLEEP_RANGE", 5997458f69efSMauro Carvalho Chehab "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr); 599843c1d77cSJoe Perches } 599943c1d77cSJoe Perches if ($delay > 2000) { 600043c1d77cSJoe Perches WARN("LONG_UDELAY", 600143c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 60021a15a250SPatrick Pannuto } 60031a15a250SPatrick Pannuto } 60041a15a250SPatrick Pannuto 600509ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 600609ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 600709ef8725SPatrick Pannuto if ($1 < 20) { 6008000d1cc1SJoe Perches WARN("MSLEEP", 6009458f69efSMauro Carvalho Chehab "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr); 601009ef8725SPatrick Pannuto } 601109ef8725SPatrick Pannuto } 601209ef8725SPatrick Pannuto 601336ec1939SJoe Perches# check for comparisons of jiffies 601436ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 601536ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 601636ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 601736ec1939SJoe Perches } 601836ec1939SJoe Perches 60199d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 60209d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 60219d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 60229d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 60239d7a34a5SJoe Perches } 60249d7a34a5SJoe Perches 602500df344fSAndy Whitcroft# warn about #ifdefs in C files 6026c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 602700df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 602800df344fSAndy Whitcroft# print "$herecurr"; 602900df344fSAndy Whitcroft# $clean = 0; 603000df344fSAndy Whitcroft# } 603100df344fSAndy Whitcroft 603222f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 6033c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 60343705ce5bSJoe Perches if (ERROR("SPACING", 60353705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 60363705ce5bSJoe Perches $fix) { 6037194f66fcSJoe Perches $fixed[$fixlinenr] =~ 60383705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 60393705ce5bSJoe Perches } 60403705ce5bSJoe Perches 604122f2a2efSAndy Whitcroft } 604222f2a2efSAndy Whitcroft 60434a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 6044171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 6045171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 60464a0df2efSAndy Whitcroft my $which = $1; 60474a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 6048000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 6049000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 60504a0df2efSAndy Whitcroft } 60514a0df2efSAndy Whitcroft } 60524a0df2efSAndy Whitcroft# check for memory barriers without a comment. 6053402c2553SMichael S. Tsirkin 6054402c2553SMichael S. Tsirkin my $barriers = qr{ 6055402c2553SMichael S. Tsirkin mb| 6056402c2553SMichael S. Tsirkin rmb| 6057ad83ec6cSWill Deacon wmb 6058402c2553SMichael S. Tsirkin }x; 6059402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 6060402c2553SMichael S. Tsirkin mb__before_atomic| 6061402c2553SMichael S. Tsirkin mb__after_atomic| 6062402c2553SMichael S. Tsirkin store_release| 6063402c2553SMichael S. Tsirkin load_acquire| 6064402c2553SMichael S. Tsirkin store_mb| 6065402c2553SMichael S. Tsirkin (?:$barriers) 6066402c2553SMichael S. Tsirkin }x; 6067402c2553SMichael S. Tsirkin my $all_barriers = qr{ 6068402c2553SMichael S. Tsirkin (?:$barriers)| 606943e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 607043e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 6071402c2553SMichael S. Tsirkin }x; 6072402c2553SMichael S. Tsirkin 6073402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 60744a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 6075c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 6076000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 60774a0df2efSAndy Whitcroft } 60784a0df2efSAndy Whitcroft } 60793ad81779SPaul E. McKenney 6080f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 6081f4073b0fSMichael S. Tsirkin 6082f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 6083f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 6084f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 6085f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 6086f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 6087f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 6088f4073b0fSMichael S. Tsirkin } 6089f4073b0fSMichael S. Tsirkin 6090cb426e99SJoe Perches# check for waitqueue_active without a comment. 6091cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 6092cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 6093cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 6094cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 6095cb426e99SJoe Perches } 6096cb426e99SJoe Perches } 60973ad81779SPaul E. McKenney 60985099a722SMarco Elver# check for data_race without a comment. 60995099a722SMarco Elver if ($line =~ /\bdata_race\s*\(/) { 61005099a722SMarco Elver if (!ctx_has_comment($first_line, $linenr)) { 61015099a722SMarco Elver WARN("DATA_RACE", 61025099a722SMarco Elver "data_race without comment\n" . $herecurr); 61035099a722SMarco Elver } 61045099a722SMarco Elver } 61055099a722SMarco Elver 61064a0df2efSAndy Whitcroft# check of hardware specific defines 6107c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 6108000d1cc1SJoe Perches CHK("ARCH_DEFINES", 6109000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 61100a920b5bSAndy Whitcroft } 6111653d4876SAndy Whitcroft 6112596ed45bSJoe Perches# check that the storage class is not after a type 6113596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 6114000d1cc1SJoe Perches WARN("STORAGE_CLASS", 6115596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 6116596ed45bSJoe Perches } 6117596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 6118596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 6119596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 6120596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 6121596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 6122596ed45bSJoe Perches WARN("STORAGE_CLASS", 6123596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 6124d4977c78STobias Klauser } 6125d4977c78STobias Klauser 6126de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 6127de7d4f0eSAndy Whitcroft# storage class and type. 61289c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 61299c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 6130000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 6131000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 6132de7d4f0eSAndy Whitcroft } 6133de7d4f0eSAndy Whitcroft 61348905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 61352b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 61362b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 6137d5e616fcSJoe Perches if (WARN("INLINE", 6138d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 6139d5e616fcSJoe Perches $fix) { 6140194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 6141d5e616fcSJoe Perches 6142d5e616fcSJoe Perches } 61438905a67cSAndy Whitcroft } 61448905a67cSAndy Whitcroft 61453d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 61462b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 61472b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 6148000d1cc1SJoe Perches WARN("PREFER_PACKED", 6149000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 61503d130fd0SJoe Perches } 61513d130fd0SJoe Perches 615239b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 61532b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 61542b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 6155000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 6156000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 615739b7e287SJoe Perches } 615839b7e287SJoe Perches 6159462811d9SJoe Perches# Check for __attribute__ section, prefer __section 6160462811d9SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 6161462811d9SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) { 6162462811d9SJoe Perches my $old = substr($rawline, $-[1], $+[1] - $-[1]); 6163462811d9SJoe Perches my $new = substr($old, 1, -1); 6164462811d9SJoe Perches if (WARN("PREFER_SECTION", 6165462811d9SJoe Perches "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) && 6166462811d9SJoe Perches $fix) { 6167462811d9SJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/; 6168462811d9SJoe Perches } 6169462811d9SJoe Perches } 6170462811d9SJoe Perches 61715f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 61722b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 61732b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 6174d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 6175d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 6176d5e616fcSJoe Perches $fix) { 6177194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 6178d5e616fcSJoe Perches 6179d5e616fcSJoe Perches } 61805f14d3bdSJoe Perches } 61815f14d3bdSJoe Perches 61826061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 61832b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 61842b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 6185d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 6186d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 6187d5e616fcSJoe Perches $fix) { 6188194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 6189d5e616fcSJoe Perches } 61906061d949SJoe Perches } 61916061d949SJoe Perches 6192619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 61935b57980dSJoe Perches if ($perl_version_ok && 6194619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 6195619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 6196619a908aSJoe Perches $line =~ /\b__weak\b/)) { 6197619a908aSJoe Perches ERROR("WEAK_DECLARATION", 6198619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 6199619a908aSJoe Perches } 6200619a908aSJoe Perches 6201fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 6202e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 6203fd39f904STomas Winkler $realfile !~ m@\btools/@ && 6204e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 6205e6176fa4SJoe Perches my $type = $1; 6206e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 6207e6176fa4SJoe Perches $type = $1; 6208e6176fa4SJoe Perches my $kernel_type = 'u'; 6209e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 6210e6176fa4SJoe Perches $type =~ /(\d+)/; 6211e6176fa4SJoe Perches $kernel_type .= $1; 6212e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 6213e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 6214e6176fa4SJoe Perches $fix) { 6215e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 6216e6176fa4SJoe Perches } 6217e6176fa4SJoe Perches } 6218e6176fa4SJoe Perches } 6219e6176fa4SJoe Perches 6220938224b5SJoe Perches# check for cast of C90 native int or longer types constants 6221938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 6222938224b5SJoe Perches my $cast = $1; 6223938224b5SJoe Perches my $const = $2; 6224938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 6225938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 6226938224b5SJoe Perches $fix) { 6227938224b5SJoe Perches my $suffix = ""; 6228938224b5SJoe Perches my $newconst = $const; 6229938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 6230938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 6231938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 6232938224b5SJoe Perches $suffix .= 'LL'; 6233938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 6234938224b5SJoe Perches $suffix .= 'L'; 6235938224b5SJoe Perches } 6236938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 6237938224b5SJoe Perches } 6238938224b5SJoe Perches } 6239938224b5SJoe Perches 62408f53a9b8SJoe Perches# check for sizeof(&) 62418f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 6242000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 6243000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 62448f53a9b8SJoe Perches } 62458f53a9b8SJoe Perches 624666c80b60SJoe Perches# check for sizeof without parenthesis 624766c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 6248d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 6249d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 6250d5e616fcSJoe Perches $fix) { 6251194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 6252d5e616fcSJoe Perches } 625366c80b60SJoe Perches } 625466c80b60SJoe Perches 625588982feaSJoe Perches# check for struct spinlock declarations 625688982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 625788982feaSJoe Perches WARN("USE_SPINLOCK_T", 625888982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 625988982feaSJoe Perches } 626088982feaSJoe Perches 6261a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 626206668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 6263a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 6264caac1d5fSHeba Aamer $fmt =~ s/%%//g; 6265caac1d5fSHeba Aamer if ($fmt !~ /%/) { 6266d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 6267d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 6268d5e616fcSJoe Perches $fix) { 6269194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 6270d5e616fcSJoe Perches } 6271a6962d72SJoe Perches } 6272a6962d72SJoe Perches } 6273a6962d72SJoe Perches 62740b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 62755b57980dSJoe Perches if ($perl_version_ok && 62760b523769SJoe Perches defined $stat && 62770b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 62780b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 6279e3c6bc95STobin C. Harding my $stat_real; 6280e3c6bc95STobin C. Harding 62810b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 62820b523769SJoe Perches $lc = $lc + $linenr; 62830b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 6284ffe07513SJoe Perches my $specifier; 6285ffe07513SJoe Perches my $extension; 62863bd32d6aSSakari Ailus my $qualifier; 6287ffe07513SJoe Perches my $bad_specifier = ""; 62880b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 62890b523769SJoe Perches $fmt =~ s/%%//g; 6290e3c6bc95STobin C. Harding 62913bd32d6aSSakari Ailus while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) { 6292e3c6bc95STobin C. Harding $specifier = $1; 6293e3c6bc95STobin C. Harding $extension = $2; 62943bd32d6aSSakari Ailus $qualifier = $3; 6295361b0d28SLinus Torvalds if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ || 62963bd32d6aSSakari Ailus ($extension eq "f" && 62973bd32d6aSSakari Ailus defined $qualifier && $qualifier !~ /^w/)) { 6298e3c6bc95STobin C. Harding $bad_specifier = $specifier; 62990b523769SJoe Perches last; 63000b523769SJoe Perches } 6301e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 6302e3c6bc95STobin C. Harding if (!defined($stat_real)) { 6303e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 63040b523769SJoe Perches } 6305e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 6306e3c6bc95STobin 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"); 6307e3c6bc95STobin C. Harding } 6308e3c6bc95STobin C. Harding } 6309e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 63102a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 63111df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 63121df7338aSSergey Senozhatsky my $use = ""; 6313e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 63141df7338aSSergey Senozhatsky $use = " - use %pS instead"; 6315e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 63161df7338aSSergey Senozhatsky } 63172a9f9d85STobin C. Harding 63180b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 6319e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 6320e3c6bc95STobin C. Harding } 63210b523769SJoe Perches } 63220b523769SJoe Perches } 63230b523769SJoe Perches 6324554e165cSAndy Whitcroft# Check for misused memsets 63255b57980dSJoe Perches if ($perl_version_ok && 6326d1fe9c09SJoe Perches defined $stat && 63279e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 6328554e165cSAndy Whitcroft 6329d7c76ba7SJoe Perches my $ms_addr = $2; 6330d1fe9c09SJoe Perches my $ms_val = $7; 6331d1fe9c09SJoe Perches my $ms_size = $12; 6332d7c76ba7SJoe Perches 6333554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 6334554e165cSAndy Whitcroft ERROR("MEMSET", 6335d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 6336554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 6337554e165cSAndy Whitcroft WARN("MEMSET", 6338d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 6339d7c76ba7SJoe Perches } 6340d7c76ba7SJoe Perches } 6341d7c76ba7SJoe Perches 634298a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 63435b57980dSJoe Perches# if ($perl_version_ok && 6344f333195dSJoe Perches# defined $stat && 6345f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6346f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 6347f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 6348f333195dSJoe Perches# $fix) { 6349f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 6350f333195dSJoe Perches# } 6351f333195dSJoe Perches# } 635298a9bba5SJoe Perches 6353b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 63545b57980dSJoe Perches# if ($perl_version_ok && 6355f333195dSJoe Perches# defined $stat && 6356f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6357f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 6358f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 6359f333195dSJoe Perches# } 6360b6117d17SMateusz Kulikowski 63618617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 63628617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 63635b57980dSJoe Perches# if ($perl_version_ok && 6364f333195dSJoe Perches# defined $stat && 6365f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6366f333195dSJoe Perches# 6367f333195dSJoe Perches# my $ms_val = $7; 6368f333195dSJoe Perches# 6369f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 6370f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 6371f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 6372f333195dSJoe Perches# $fix) { 6373f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 6374f333195dSJoe Perches# } 6375f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 6376f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 6377f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 6378f333195dSJoe Perches# $fix) { 6379f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 6380f333195dSJoe Perches# } 6381f333195dSJoe Perches# } 6382f333195dSJoe Perches# } 63838617cd09SMateusz Kulikowski 6384d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 63855b57980dSJoe Perches if ($perl_version_ok && 6386d1fe9c09SJoe Perches defined $stat && 6387d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 6388d1fe9c09SJoe Perches if (defined $2 || defined $7) { 6389d7c76ba7SJoe Perches my $call = $1; 6390d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 6391d7c76ba7SJoe Perches my $arg1 = $3; 6392d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 6393d1fe9c09SJoe Perches my $arg2 = $8; 6394d7c76ba7SJoe Perches my $cast; 6395d7c76ba7SJoe Perches 6396d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 6397d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 6398d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 6399d7c76ba7SJoe Perches $cast = $cast1; 6400d7c76ba7SJoe Perches } else { 6401d7c76ba7SJoe Perches $cast = $cast2; 6402d7c76ba7SJoe Perches } 6403d7c76ba7SJoe Perches WARN("MINMAX", 6404d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 6405554e165cSAndy Whitcroft } 6406554e165cSAndy Whitcroft } 6407554e165cSAndy Whitcroft 64084a273195SJoe Perches# check usleep_range arguments 64095b57980dSJoe Perches if ($perl_version_ok && 64104a273195SJoe Perches defined $stat && 64114a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 64124a273195SJoe Perches my $min = $1; 64134a273195SJoe Perches my $max = $7; 64144a273195SJoe Perches if ($min eq $max) { 64154a273195SJoe Perches WARN("USLEEP_RANGE", 6416458f69efSMauro Carvalho Chehab "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 64174a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 64184a273195SJoe Perches $min > $max) { 64194a273195SJoe Perches WARN("USLEEP_RANGE", 6420458f69efSMauro Carvalho Chehab "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 64214a273195SJoe Perches } 64224a273195SJoe Perches } 64234a273195SJoe Perches 6424823b794cSJoe Perches# check for naked sscanf 64255b57980dSJoe Perches if ($perl_version_ok && 6426823b794cSJoe Perches defined $stat && 64276c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 6428823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 6429823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 6430823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 6431823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 6432823b794cSJoe Perches $lc = $lc + $linenr; 64332a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6434823b794cSJoe Perches WARN("NAKED_SSCANF", 6435823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 6436823b794cSJoe Perches } 6437823b794cSJoe Perches 6438afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 64395b57980dSJoe Perches if ($perl_version_ok && 6440afc819abSJoe Perches defined $stat && 6441afc819abSJoe Perches $line =~ /\bsscanf\b/) { 6442afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 6443afc819abSJoe Perches $lc = $lc + $linenr; 64442a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6445afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 6446afc819abSJoe Perches my $format = $6; 6447afc819abSJoe Perches my $count = $format =~ tr@%@%@; 6448afc819abSJoe Perches if ($count == 1 && 6449afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 6450afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 6451afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 6452afc819abSJoe Perches } 6453afc819abSJoe Perches } 6454afc819abSJoe Perches } 6455afc819abSJoe Perches 645670dc8a48SJoe Perches# check for new externs in .h files. 645770dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 645870dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 6459d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 646070dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 646170dc8a48SJoe Perches $fix) { 6462194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 646370dc8a48SJoe Perches } 646470dc8a48SJoe Perches } 646570dc8a48SJoe Perches 6466de7d4f0eSAndy Whitcroft# check for new externs in .c files. 6467171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 6468c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 6469171ae1a4SAndy Whitcroft { 6470c45dcabdSAndy Whitcroft my $function_name = $1; 6471c45dcabdSAndy Whitcroft my $paren_space = $2; 6472171ae1a4SAndy Whitcroft 6473171ae1a4SAndy Whitcroft my $s = $stat; 6474171ae1a4SAndy Whitcroft if (defined $cond) { 6475171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 6476171ae1a4SAndy Whitcroft } 6477d8b44b58SKees Cook if ($s =~ /^\s*;/) 6478c45dcabdSAndy Whitcroft { 6479000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6480000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6481de7d4f0eSAndy Whitcroft } 6482de7d4f0eSAndy Whitcroft 6483171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 6484000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 6485000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 6486171ae1a4SAndy Whitcroft } 64879c9ba34eSAndy Whitcroft 64889c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 64899c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 64909c9ba34eSAndy Whitcroft { 6491000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6492000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6493171ae1a4SAndy Whitcroft } 6494171ae1a4SAndy Whitcroft 6495a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 6496a0ad7596SJoe Perches if (defined $stat && 6497d8b44b58SKees Cook $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 6498d8b44b58SKees Cook $1 ne "void") { 6499d8b44b58SKees Cook my $args = trim($1); 6500ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6501ca0d8929SJoe Perches my $arg = trim($1); 6502d8b44b58SKees Cook if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 6503ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 6504ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6505ca0d8929SJoe Perches } 6506ca0d8929SJoe Perches } 6507ca0d8929SJoe Perches } 6508ca0d8929SJoe Perches 6509a0ad7596SJoe Perches# check for function definitions 65105b57980dSJoe Perches if ($perl_version_ok && 6511a0ad7596SJoe Perches defined $stat && 6512a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6513a0ad7596SJoe Perches $context_function = $1; 6514a0ad7596SJoe Perches 6515a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 6516a0ad7596SJoe Perches my $ok = 0; 6517a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 6518a0ad7596SJoe Perches my $herectx = $here . "\n"; 6519a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6520a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 6521a0ad7596SJoe Perches $herectx .= $rl . "\n"; 6522a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 6523a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 6524a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 6525a0ad7596SJoe Perches } 6526a0ad7596SJoe Perches if (!$ok) { 6527a0ad7596SJoe Perches ERROR("OPEN_BRACE", 6528a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 6529a0ad7596SJoe Perches } 6530a0ad7596SJoe Perches } 6531a0ad7596SJoe Perches 6532de7d4f0eSAndy Whitcroft# checks for new __setup's 6533de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 6534de7d4f0eSAndy Whitcroft my $name = $1; 6535de7d4f0eSAndy Whitcroft 6536de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 6537000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 65382581ac7cSTim Froidcoeur "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr); 6539de7d4f0eSAndy Whitcroft } 6540653d4876SAndy Whitcroft } 65419c0ca6f9SAndy Whitcroft 6542e29a70f1SJoe Perches# check for pointless casting of alloc functions 6543e29a70f1SJoe Perches if ($line =~ /\*\s*\)\s*$allocFunctions\b/) { 6544000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 6545000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 65469c0ca6f9SAndy Whitcroft } 654713214adfSAndy Whitcroft 6548a640d25cSJoe Perches# alloc style 6549a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 65505b57980dSJoe Perches if ($perl_version_ok && 6551e29a70f1SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 6552a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 6553a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 6554a640d25cSJoe Perches } 6555a640d25cSJoe Perches 655660a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 65575b57980dSJoe Perches if ($perl_version_ok && 65581b4a2ed4SJoe Perches defined $stat && 65591b4a2ed4SJoe Perches $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 656060a55369SJoe Perches my $oldfunc = $3; 656160a55369SJoe Perches my $a1 = $4; 656260a55369SJoe Perches my $a2 = $10; 656360a55369SJoe Perches my $newfunc = "kmalloc_array"; 656460a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 656560a55369SJoe Perches my $r1 = $a1; 656660a55369SJoe Perches my $r2 = $a2; 656760a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 656860a55369SJoe Perches $r1 = $a2; 656960a55369SJoe Perches $r2 = $a1; 657060a55369SJoe Perches } 6571e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 6572e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 65731b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 6574e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6575e3d95a2aSTobin C. Harding 6576e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 65771b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 65781b4a2ed4SJoe Perches $cnt == 1 && 6579e367455aSJoe Perches $fix) { 6580194f66fcSJoe 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; 658160a55369SJoe Perches } 658260a55369SJoe Perches } 658360a55369SJoe Perches } 658460a55369SJoe Perches 6585972fdea2SJoe Perches# check for krealloc arg reuse 65865b57980dSJoe Perches if ($perl_version_ok && 65874cab63ceSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ && 65884cab63ceSJoe Perches $1 eq $3) { 6589972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 6590972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 6591972fdea2SJoe Perches } 6592972fdea2SJoe Perches 65935ce59ae0SJoe Perches# check for alloc argument mismatch 65945ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 65955ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 65965ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 65975ce59ae0SJoe Perches } 65985ce59ae0SJoe Perches 6599caf2a54fSJoe Perches# check for multiple semicolons 6600caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 6601d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 6602d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 6603d5e616fcSJoe Perches $fix) { 6604194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 6605d5e616fcSJoe Perches } 6606d1e2ad07SJoe Perches } 6607d1e2ad07SJoe Perches 6608cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 6609cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 6610cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 66110ab90191SJoe Perches my $ull = ""; 66120ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 66130ab90191SJoe Perches if (CHK("BIT_MACRO", 66140ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 66150ab90191SJoe Perches $fix) { 66160ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 66170ab90191SJoe Perches } 66180ab90191SJoe Perches } 66190ab90191SJoe Perches 662050161266SJoe Perches# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too) 66213e89ad85SJerome Forissier if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) { 662250161266SJoe Perches WARN("IS_ENABLED_CONFIG", 66233e89ad85SJerome Forissier "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr); 662450161266SJoe Perches } 662550161266SJoe Perches 66262d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 66273e89ad85SJerome 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*$/) { 66282d632745SJoe Perches my $config = $1; 66292d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 66303e89ad85SJerome Forissier "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) && 66312d632745SJoe Perches $fix) { 66322d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 66332d632745SJoe Perches } 66342d632745SJoe Perches } 66352d632745SJoe Perches 6636f36d3eb8SJoe Perches# check for /* fallthrough */ like comment, prefer fallthrough; 6637f36d3eb8SJoe Perches my @fallthroughs = ( 6638f36d3eb8SJoe Perches 'fallthrough', 6639f36d3eb8SJoe Perches '@fallthrough@', 6640f36d3eb8SJoe Perches 'lint -fallthrough[ \t]*', 6641f36d3eb8SJoe Perches 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)', 6642f36d3eb8SJoe Perches '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?', 6643f36d3eb8SJoe Perches 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 6644f36d3eb8SJoe Perches 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 6645f36d3eb8SJoe Perches ); 6646f36d3eb8SJoe Perches if ($raw_comment ne '') { 6647f36d3eb8SJoe Perches foreach my $ft (@fallthroughs) { 6648f36d3eb8SJoe Perches if ($raw_comment =~ /$ft/) { 6649f36d3eb8SJoe Perches my $msg_level = \&WARN; 6650f36d3eb8SJoe Perches $msg_level = \&CHK if ($file); 6651f36d3eb8SJoe Perches &{$msg_level}("PREFER_FALLTHROUGH", 6652f36d3eb8SJoe Perches "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr); 6653f36d3eb8SJoe Perches last; 6654f36d3eb8SJoe Perches } 6655f36d3eb8SJoe Perches } 6656f36d3eb8SJoe Perches } 6657f36d3eb8SJoe Perches 6658d1e2ad07SJoe Perches# check for switch/default statements without a break; 66595b57980dSJoe Perches if ($perl_version_ok && 6660d1e2ad07SJoe Perches defined $stat && 6661d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 6662d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 6663e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6664e3d95a2aSTobin C. Harding 6665d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 6666d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 6667caf2a54fSJoe Perches } 6668caf2a54fSJoe Perches 666913214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 6670d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 6671d5e616fcSJoe Perches if (WARN("USE_FUNC", 6672d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 6673d5e616fcSJoe Perches $fix) { 6674194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 6675d5e616fcSJoe Perches } 667613214adfSAndy Whitcroft } 6677773647a0SAndy Whitcroft 667862ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 667962ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 668062ec818fSJoe Perches ERROR("DATE_TIME", 668162ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 668262ec818fSJoe Perches } 668362ec818fSJoe Perches 66842c92488aSJoe Perches# check for use of yield() 66852c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 66862c92488aSJoe Perches WARN("YIELD", 66872c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 66882c92488aSJoe Perches } 66892c92488aSJoe Perches 6690179f8f40SJoe Perches# check for comparisons against true and false 6691179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 6692179f8f40SJoe Perches my $lead = $1; 6693179f8f40SJoe Perches my $arg = $2; 6694179f8f40SJoe Perches my $test = $3; 6695179f8f40SJoe Perches my $otype = $4; 6696179f8f40SJoe Perches my $trail = $5; 6697179f8f40SJoe Perches my $op = "!"; 6698179f8f40SJoe Perches 6699179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 6700179f8f40SJoe Perches 6701179f8f40SJoe Perches my $type = lc($otype); 6702179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 6703179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 6704179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 6705179f8f40SJoe Perches $op = ""; 6706179f8f40SJoe Perches } 6707179f8f40SJoe Perches 6708179f8f40SJoe Perches CHK("BOOL_COMPARISON", 6709179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 6710179f8f40SJoe Perches 6711179f8f40SJoe Perches## maybe suggesting a correct construct would better 6712179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 6713179f8f40SJoe Perches 6714179f8f40SJoe Perches } 6715179f8f40SJoe Perches } 6716179f8f40SJoe Perches 67174882720bSThomas Gleixner# check for semaphores initialized locked 67184882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 6719000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 6720000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 6721773647a0SAndy Whitcroft } 67226712d858SJoe Perches 672367d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 672467d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 6725000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 672667d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 6727773647a0SAndy Whitcroft } 67286712d858SJoe Perches 6729ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 6730f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 6731000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 6732ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 6733f3db6639SMichael Ellerman } 67346712d858SJoe Perches 67353d709ab5SPaul E. McKenney# check for spin_is_locked(), suggest lockdep instead 67363d709ab5SPaul E. McKenney if ($line =~ /\bspin_is_locked\(/) { 67373d709ab5SPaul E. McKenney WARN("USE_LOCKDEP", 67383d709ab5SPaul E. McKenney "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr); 67393d709ab5SPaul E. McKenney } 67403d709ab5SPaul E. McKenney 67419189c7e7SJoe Perches# check for deprecated apis 67429189c7e7SJoe Perches if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) { 67439189c7e7SJoe Perches my $deprecated_api = $1; 67449189c7e7SJoe Perches my $new_api = $deprecated_apis{$deprecated_api}; 67459189c7e7SJoe Perches WARN("DEPRECATED_API", 67469189c7e7SJoe Perches "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr); 67479189c7e7SJoe Perches } 67489189c7e7SJoe Perches 67490f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 6750d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 6751ced69da1SQuentin Monnet if (defined($const_structs) && 6752ced69da1SQuentin Monnet $line !~ /\bconst\b/ && 6753d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 6754000d1cc1SJoe Perches WARN("CONST_STRUCT", 6755d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 67562b6db5cbSAndy Whitcroft } 6757773647a0SAndy Whitcroft 6758773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 6759773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 6760773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 6761c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 6762c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 6763171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 6764171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 6765171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 6766773647a0SAndy Whitcroft { 6767000d1cc1SJoe Perches WARN("NR_CPUS", 6768000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 6769773647a0SAndy Whitcroft } 67709c9ba34eSAndy Whitcroft 677152ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 677252ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 677352ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 677452ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 677552ea8506SJoe Perches } 677652ea8506SJoe Perches 6777acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 67785b57980dSJoe Perches if ($perl_version_ok && 6779acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 6780acd9362cSJoe Perches WARN("LIKELY_MISUSE", 6781acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 6782acd9362cSJoe Perches } 6783acd9362cSJoe Perches 6784de3f186fSDenis Efremov# nested likely/unlikely calls 6785de3f186fSDenis Efremov if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) { 6786de3f186fSDenis Efremov WARN("LIKELY_MISUSE", 6787de3f186fSDenis Efremov "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr); 6788de3f186fSDenis Efremov } 6789de3f186fSDenis Efremov 6790691d77b6SAndy Whitcroft# whine mightly about in_atomic 6791691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 6792691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 6793000d1cc1SJoe Perches ERROR("IN_ATOMIC", 6794000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 6795f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 6796000d1cc1SJoe Perches WARN("IN_ATOMIC", 6797000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 6798691d77b6SAndy Whitcroft } 6799691d77b6SAndy Whitcroft } 68001704f47bSPeter Zijlstra 68010f5225b0SPeter Zijlstra# check for mutex_trylock_recursive usage 68020f5225b0SPeter Zijlstra if ($line =~ /mutex_trylock_recursive/) { 68030f5225b0SPeter Zijlstra ERROR("LOCKING", 68040f5225b0SPeter Zijlstra "recursive locking is bad, do not use this ever.\n" . $herecurr); 68050f5225b0SPeter Zijlstra } 68060f5225b0SPeter Zijlstra 68071704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 68081704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 68091704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 68101704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 68111704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 68121704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 6813000d1cc1SJoe Perches ERROR("LOCKDEP", 6814000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 68151704f47bSPeter Zijlstra } 68161704f47bSPeter Zijlstra } 681788f8831cSDave Jones 6818b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 6819b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 6820000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 6821000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 682288f8831cSDave Jones } 68232435880fSJoe Perches 682400180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 682500180468SJoe Perches# and whether or not function naming is typical and if 682600180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 68275b57980dSJoe Perches if ($perl_version_ok && 682800180468SJoe Perches defined $stat && 682900180468SJoe 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*\)/) { 683000180468SJoe Perches my $var = $1; 683100180468SJoe Perches my $perms = $2; 683200180468SJoe Perches my $show = $3; 683300180468SJoe Perches my $store = $4; 683400180468SJoe Perches my $octal_perms = perms_to_octal($perms); 683500180468SJoe Perches if ($show =~ /^${var}_show$/ && 683600180468SJoe Perches $store =~ /^${var}_store$/ && 683700180468SJoe Perches $octal_perms eq "0644") { 683800180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 683900180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 684000180468SJoe Perches $fix) { 684100180468SJoe 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})/; 684200180468SJoe Perches } 684300180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 684400180468SJoe Perches $store =~ /^NULL$/ && 684500180468SJoe Perches $octal_perms eq "0444") { 684600180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 684700180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 684800180468SJoe Perches $fix) { 684900180468SJoe 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})/; 685000180468SJoe Perches } 685100180468SJoe Perches } elsif ($show =~ /^NULL$/ && 685200180468SJoe Perches $store =~ /^${var}_store$/ && 685300180468SJoe Perches $octal_perms eq "0200") { 685400180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 685500180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 685600180468SJoe Perches $fix) { 685700180468SJoe 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})/; 685800180468SJoe Perches } 685900180468SJoe Perches } elsif ($octal_perms eq "0644" || 686000180468SJoe Perches $octal_perms eq "0444" || 686100180468SJoe Perches $octal_perms eq "0200") { 686200180468SJoe Perches my $newshow = "$show"; 686300180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 686400180468SJoe Perches my $newstore = $store; 686500180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 686600180468SJoe Perches my $rename = ""; 686700180468SJoe Perches if ($show ne $newshow) { 686800180468SJoe Perches $rename .= " '$show' to '$newshow'"; 686900180468SJoe Perches } 687000180468SJoe Perches if ($store ne $newstore) { 687100180468SJoe Perches $rename .= " '$store' to '$newstore'"; 687200180468SJoe Perches } 687300180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 687400180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 687500180468SJoe Perches } else { 687600180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 687700180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 687800180468SJoe Perches } 687900180468SJoe Perches } 688000180468SJoe Perches 6881515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 6882515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 688373121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 688473121534SJoe Perches# specific definition of not visible in sysfs. 688573121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 688673121534SJoe Perches# use the default permissions 68875b57980dSJoe Perches if ($perl_version_ok && 6888459cf0aeSJoe Perches defined $stat && 6889515a235eSJoe Perches $line =~ /$mode_perms_search/) { 68902435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 68912435880fSJoe Perches my $func = $entry->[0]; 68922435880fSJoe Perches my $arg_pos = $entry->[1]; 68932435880fSJoe Perches 6894459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 6895459cf0aeSJoe Perches $lc = $lc + $linenr; 68962a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6897459cf0aeSJoe Perches 68982435880fSJoe Perches my $skip_args = ""; 68992435880fSJoe Perches if ($arg_pos > 1) { 69002435880fSJoe Perches $arg_pos--; 69012435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 69022435880fSJoe Perches } 6903f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 6904459cf0aeSJoe Perches if ($stat =~ /$test/) { 69052435880fSJoe Perches my $val = $1; 69062435880fSJoe Perches $val = $6 if ($skip_args ne ""); 690773121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 690873121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 690973121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 69102435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 6911459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 6912f90774e1SJoe Perches } 6913f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6914c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6915459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 69162435880fSJoe Perches } 6917459cf0aeSJoe Perches } 6918459cf0aeSJoe Perches } 6919459cf0aeSJoe Perches } 6920459cf0aeSJoe Perches 6921459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 6922bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 692300180468SJoe Perches my $oval = $1; 692400180468SJoe Perches my $octal = perms_to_octal($oval); 6925f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 6926459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 6927f90774e1SJoe Perches $fix) { 692800180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 69292435880fSJoe Perches } 693013214adfSAndy Whitcroft } 69315a6d20ceSBjorn Andersson 69325a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 69335a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 69345a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 69355a6d20ceSBjorn Andersson my $valid_licenses = qr{ 69365a6d20ceSBjorn Andersson GPL| 69375a6d20ceSBjorn Andersson GPL\ v2| 69385a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 69395a6d20ceSBjorn Andersson Dual\ BSD/GPL| 69405a6d20ceSBjorn Andersson Dual\ MIT/GPL| 69415a6d20ceSBjorn Andersson Dual\ MPL/GPL| 69425a6d20ceSBjorn Andersson Proprietary 69435a6d20ceSBjorn Andersson }x; 69445a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 69455a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 69465a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 69475a6d20ceSBjorn Andersson } 69485a6d20ceSBjorn Andersson } 69496a8d76cbSMatteo Croce 69506a8d76cbSMatteo Croce# check for sysctl duplicate constants 69516a8d76cbSMatteo Croce if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) { 69526a8d76cbSMatteo Croce WARN("DUPLICATED_SYSCTL_CONST", 69536a8d76cbSMatteo Croce "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr); 69546a8d76cbSMatteo Croce } 6955515a235eSJoe Perches } 695613214adfSAndy Whitcroft 695713214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 695813214adfSAndy Whitcroft # so just keep quiet. 695913214adfSAndy Whitcroft if ($#rawlines == -1) { 696013214adfSAndy Whitcroft exit(0); 69610a920b5bSAndy Whitcroft } 69620a920b5bSAndy Whitcroft 69638905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 69648905a67cSAndy Whitcroft # things that appear to be patches. 69658905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 69668905a67cSAndy Whitcroft exit(0); 69678905a67cSAndy Whitcroft } 69688905a67cSAndy Whitcroft 69698905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 69708905a67cSAndy Whitcroft # just keep quiet. 69718905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 69728905a67cSAndy Whitcroft exit(0); 69738905a67cSAndy Whitcroft } 69748905a67cSAndy Whitcroft 6975a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 6976000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6977000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 69780a920b5bSAndy Whitcroft } 6979cd261496SGeert Uytterhoeven if ($is_patch && $has_commit_log && $chk_signoff) { 6980cd261496SGeert Uytterhoeven if ($signoff == 0) { 6981000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6982000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 6983*48ca2d8aSDwaipayan Ray } elsif ($authorsignoff != 1) { 6984*48ca2d8aSDwaipayan Ray # authorsignoff values: 6985*48ca2d8aSDwaipayan Ray # 0 -> missing sign off 6986*48ca2d8aSDwaipayan Ray # 1 -> sign off identical 6987*48ca2d8aSDwaipayan Ray # 2 -> names and addresses match, comments mismatch 6988*48ca2d8aSDwaipayan Ray # 3 -> addresses match, names different 6989*48ca2d8aSDwaipayan Ray # 4 -> names match, addresses different 6990*48ca2d8aSDwaipayan Ray # 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match 6991*48ca2d8aSDwaipayan Ray 6992*48ca2d8aSDwaipayan Ray my $sob_msg = "'From: $author' != 'Signed-off-by: $author_sob'"; 6993*48ca2d8aSDwaipayan Ray 6994*48ca2d8aSDwaipayan Ray if ($authorsignoff == 0) { 6995*48ca2d8aSDwaipayan Ray ERROR("NO_AUTHOR_SIGN_OFF", 6996cd261496SGeert Uytterhoeven "Missing Signed-off-by: line by nominal patch author '$author'\n"); 6997*48ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 2) { 6998*48ca2d8aSDwaipayan Ray CHK("FROM_SIGN_OFF_MISMATCH", 6999*48ca2d8aSDwaipayan Ray "From:/Signed-off-by: email comments mismatch: $sob_msg\n"); 7000*48ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 3) { 7001*48ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 7002*48ca2d8aSDwaipayan Ray "From:/Signed-off-by: email name mismatch: $sob_msg\n"); 7003*48ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 4) { 7004*48ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 7005*48ca2d8aSDwaipayan Ray "From:/Signed-off-by: email address mismatch: $sob_msg\n"); 7006*48ca2d8aSDwaipayan Ray } elsif ($authorsignoff == 5) { 7007*48ca2d8aSDwaipayan Ray WARN("FROM_SIGN_OFF_MISMATCH", 7008*48ca2d8aSDwaipayan Ray "From:/Signed-off-by: email subaddress mismatch: $sob_msg\n"); 7009*48ca2d8aSDwaipayan Ray } 7010cd261496SGeert Uytterhoeven } 70110a920b5bSAndy Whitcroft } 70120a920b5bSAndy Whitcroft 7013f0a594c1SAndy Whitcroft print report_dump(); 701413214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 701513214adfSAndy Whitcroft print "$filename " if ($summary_file); 70166c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 70176c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 70186c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 70196c72ffaaSAndy Whitcroft } 70208905a67cSAndy Whitcroft 7021d2c0a235SAndy Whitcroft if ($quiet == 0) { 7022ef212196SJoe Perches # If there were any defects found and not already fixing them 7023ef212196SJoe Perches if (!$clean and !$fix) { 7024ef212196SJoe Perches print << "EOM" 7025ef212196SJoe Perches 7026ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 7027ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 7028ef212196SJoe PerchesEOM 7029ef212196SJoe Perches } 7030d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 7031d2c0a235SAndy Whitcroft # then suggest that. 7032d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 7033b0781216SMike Frysinger $rpt_cleaners = 0; 7034d8469f16SJoe Perches print << "EOM" 7035d8469f16SJoe Perches 7036d8469f16SJoe PerchesNOTE: Whitespace errors detected. 7037d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 7038d8469f16SJoe PerchesEOM 7039d2c0a235SAndy Whitcroft } 7040d2c0a235SAndy Whitcroft } 7041d2c0a235SAndy Whitcroft 7042d752fcc8SJoe Perches if ($clean == 0 && $fix && 7043d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 7044d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 70459624b8d6SJoe Perches my $newfile = $filename; 70469624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 70473705ce5bSJoe Perches my $linecount = 0; 70483705ce5bSJoe Perches my $f; 70493705ce5bSJoe Perches 7050d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 7051d752fcc8SJoe Perches 70523705ce5bSJoe Perches open($f, '>', $newfile) 70533705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 70543705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 70553705ce5bSJoe Perches $linecount++; 70563705ce5bSJoe Perches if ($file) { 70573705ce5bSJoe Perches if ($linecount > 3) { 70583705ce5bSJoe Perches $fixed_line =~ s/^\+//; 70593705ce5bSJoe Perches print $f $fixed_line . "\n"; 70603705ce5bSJoe Perches } 70613705ce5bSJoe Perches } else { 70623705ce5bSJoe Perches print $f $fixed_line . "\n"; 70633705ce5bSJoe Perches } 70643705ce5bSJoe Perches } 70653705ce5bSJoe Perches close($f); 70663705ce5bSJoe Perches 70673705ce5bSJoe Perches if (!$quiet) { 70683705ce5bSJoe Perches print << "EOM"; 7069d8469f16SJoe Perches 70703705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 70713705ce5bSJoe Perches 70723705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 70733705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 70743705ce5bSJoe Perches 70753705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 70763705ce5bSJoe PerchesNo warranties, expressed or implied... 70773705ce5bSJoe PerchesEOM 70783705ce5bSJoe Perches } 70793705ce5bSJoe Perches } 70803705ce5bSJoe Perches 7081d8469f16SJoe Perches if ($quiet == 0) { 7082d8469f16SJoe Perches print "\n"; 7083d8469f16SJoe Perches if ($clean == 1) { 7084d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 7085d8469f16SJoe Perches } else { 7086d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 70870a920b5bSAndy Whitcroft } 70880a920b5bSAndy Whitcroft } 70890a920b5bSAndy Whitcroft return $clean; 70900a920b5bSAndy Whitcroft} 7091