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 977*f5f61325SJoe Perchessub git_is_single_file { 978*f5f61325SJoe Perches my ($filename) = @_; 979*f5f61325SJoe Perches 980*f5f61325SJoe Perches return 0 if ((which("git") eq "") || !(-e "$gitroot")); 981*f5f61325SJoe Perches 982*f5f61325SJoe Perches my $output = `${git_command} ls-files -- $filename 2>/dev/null`; 983*f5f61325SJoe Perches my $count = $output =~ tr/\n//; 984*f5f61325SJoe Perches return $count eq 1 && $output =~ m{^${filename}$}; 985*f5f61325SJoe Perches} 986*f5f61325SJoe 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; 1060*f5f61325SJoe Perches my $is_git_file = git_is_single_file($filename); 1061*f5f61325SJoe Perches my $oldfile = $file; 1062*f5f61325SJoe 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(); 1107*f5f61325SJoe 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 11843705ce5bSJoe Perches $name = trim($name); 118520112475SJoe Perches $name =~ s/^\"|\"$//g; 1186dfa05c28SJoe Perches $name =~ s/(\s*\([^\)]+\))\s*//; 1187dfa05c28SJoe Perches if (defined($1)) { 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 { 120220112475SJoe Perches my ($name, $address) = @_; 120320112475SJoe Perches 120420112475SJoe Perches my $formatted_email; 120520112475SJoe Perches 12063705ce5bSJoe Perches $name = trim($name); 120720112475SJoe Perches $name =~ s/^\"|\"$//g; 12083705ce5bSJoe Perches $address = trim($address); 120920112475SJoe Perches 121020112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 121120112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 121220112475SJoe Perches $name = "\"$name\""; 121320112475SJoe Perches } 121420112475SJoe Perches 121520112475SJoe Perches if ("$name" eq "") { 121620112475SJoe Perches $formatted_email = "$address"; 121720112475SJoe Perches } else { 121820112475SJoe Perches $formatted_email = "$name <$address>"; 121920112475SJoe Perches } 122020112475SJoe Perches 122120112475SJoe Perches return $formatted_email; 122220112475SJoe Perches} 122320112475SJoe Perches 1224dfa05c28SJoe Perchessub reformat_email { 1225dfa05c28SJoe Perches my ($email) = @_; 1226dfa05c28SJoe Perches 1227dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 1228dfa05c28SJoe Perches return format_email($email_name, $email_address); 1229dfa05c28SJoe Perches} 1230dfa05c28SJoe Perches 1231dfa05c28SJoe Perchessub same_email_addresses { 1232dfa05c28SJoe Perches my ($email1, $email2) = @_; 1233dfa05c28SJoe Perches 1234dfa05c28SJoe Perches my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1); 1235dfa05c28SJoe Perches my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2); 1236dfa05c28SJoe Perches 1237dfa05c28SJoe Perches return $email1_name eq $email2_name && 1238dfa05c28SJoe Perches $email1_address eq $email2_address; 1239dfa05c28SJoe Perches} 1240dfa05c28SJoe Perches 1241d311cd44SJoe Perchessub which { 1242d311cd44SJoe Perches my ($bin) = @_; 1243d311cd44SJoe Perches 1244d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1245d311cd44SJoe Perches if (-e "$path/$bin") { 1246d311cd44SJoe Perches return "$path/$bin"; 1247d311cd44SJoe Perches } 1248d311cd44SJoe Perches } 1249d311cd44SJoe Perches 1250d311cd44SJoe Perches return ""; 1251d311cd44SJoe Perches} 1252d311cd44SJoe Perches 1253000d1cc1SJoe Perchessub which_conf { 1254000d1cc1SJoe Perches my ($conf) = @_; 1255000d1cc1SJoe Perches 1256000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1257000d1cc1SJoe Perches if (-e "$path/$conf") { 1258000d1cc1SJoe Perches return "$path/$conf"; 1259000d1cc1SJoe Perches } 1260000d1cc1SJoe Perches } 1261000d1cc1SJoe Perches 1262000d1cc1SJoe Perches return ""; 1263000d1cc1SJoe Perches} 1264000d1cc1SJoe Perches 12650a920b5bSAndy Whitcroftsub expand_tabs { 12660a920b5bSAndy Whitcroft my ($str) = @_; 12670a920b5bSAndy Whitcroft 12680a920b5bSAndy Whitcroft my $res = ''; 12690a920b5bSAndy Whitcroft my $n = 0; 12700a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 12710a920b5bSAndy Whitcroft if ($c eq "\t") { 12720a920b5bSAndy Whitcroft $res .= ' '; 12730a920b5bSAndy Whitcroft $n++; 1274713a09deSAntonio Borneo for (; ($n % $tabsize) != 0; $n++) { 12750a920b5bSAndy Whitcroft $res .= ' '; 12760a920b5bSAndy Whitcroft } 12770a920b5bSAndy Whitcroft next; 12780a920b5bSAndy Whitcroft } 12790a920b5bSAndy Whitcroft $res .= $c; 12800a920b5bSAndy Whitcroft $n++; 12810a920b5bSAndy Whitcroft } 12820a920b5bSAndy Whitcroft 12830a920b5bSAndy Whitcroft return $res; 12840a920b5bSAndy Whitcroft} 12856c72ffaaSAndy Whitcroftsub copy_spacing { 1286773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 12876c72ffaaSAndy Whitcroft return $res; 12886c72ffaaSAndy Whitcroft} 12890a920b5bSAndy Whitcroft 12904a0df2efSAndy Whitcroftsub line_stats { 12914a0df2efSAndy Whitcroft my ($line) = @_; 12924a0df2efSAndy Whitcroft 12934a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 12944a0df2efSAndy Whitcroft $line =~ s/^.//; 12954a0df2efSAndy Whitcroft $line = expand_tabs($line); 12964a0df2efSAndy Whitcroft 12974a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 12984a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 12994a0df2efSAndy Whitcroft 13004a0df2efSAndy Whitcroft return (length($line), length($white)); 13014a0df2efSAndy Whitcroft} 13024a0df2efSAndy Whitcroft 1303773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1304773647a0SAndy Whitcroft 1305773647a0SAndy Whitcroftsub sanitise_line_reset { 1306773647a0SAndy Whitcroft my ($in_comment) = @_; 1307773647a0SAndy Whitcroft 1308773647a0SAndy Whitcroft if ($in_comment) { 1309773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1310773647a0SAndy Whitcroft } else { 1311773647a0SAndy Whitcroft $sanitise_quote = ''; 1312773647a0SAndy Whitcroft } 1313773647a0SAndy Whitcroft} 131400df344fSAndy Whitcroftsub sanitise_line { 131500df344fSAndy Whitcroft my ($line) = @_; 131600df344fSAndy Whitcroft 131700df344fSAndy Whitcroft my $res = ''; 131800df344fSAndy Whitcroft my $l = ''; 131900df344fSAndy Whitcroft 1320c2fdda0dSAndy Whitcroft my $qlen = 0; 1321773647a0SAndy Whitcroft my $off = 0; 1322773647a0SAndy Whitcroft my $c; 132300df344fSAndy Whitcroft 1324773647a0SAndy Whitcroft # Always copy over the diff marker. 1325773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1326773647a0SAndy Whitcroft 1327773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1328773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1329773647a0SAndy Whitcroft 13308d2e11b2SClaudio Fontana # Comments we are whacking completely including the begin 1331773647a0SAndy Whitcroft # and end, all to $;. 1332773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1333773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1334773647a0SAndy Whitcroft 1335773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1336773647a0SAndy Whitcroft $off++; 133700df344fSAndy Whitcroft next; 1338773647a0SAndy Whitcroft } 133981bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1340773647a0SAndy Whitcroft $sanitise_quote = ''; 1341773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1342773647a0SAndy Whitcroft $off++; 1343773647a0SAndy Whitcroft next; 1344773647a0SAndy Whitcroft } 1345113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1346113f04a8SDaniel Walker $sanitise_quote = '//'; 1347113f04a8SDaniel Walker 1348113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1349113f04a8SDaniel Walker $off++; 1350113f04a8SDaniel Walker next; 1351113f04a8SDaniel Walker } 1352773647a0SAndy Whitcroft 1353773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1354773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1355773647a0SAndy Whitcroft $c eq "\\") { 1356773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1357773647a0SAndy Whitcroft $off++; 1358773647a0SAndy Whitcroft next; 1359773647a0SAndy Whitcroft } 1360773647a0SAndy Whitcroft # Regular quotes. 1361773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1362773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1363773647a0SAndy Whitcroft $sanitise_quote = $c; 1364773647a0SAndy Whitcroft 1365773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1366773647a0SAndy Whitcroft next; 1367773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1368773647a0SAndy Whitcroft $sanitise_quote = ''; 136900df344fSAndy Whitcroft } 137000df344fSAndy Whitcroft } 1371773647a0SAndy Whitcroft 1372fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1373773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1374773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1375113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1376113f04a8SDaniel Walker substr($res, $off, 1, $;); 1377773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1378773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 137900df344fSAndy Whitcroft } else { 1380773647a0SAndy Whitcroft substr($res, $off, 1, $c); 138100df344fSAndy Whitcroft } 1382c2fdda0dSAndy Whitcroft } 1383c2fdda0dSAndy Whitcroft 1384113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1385113f04a8SDaniel Walker $sanitise_quote = ''; 1386113f04a8SDaniel Walker } 1387113f04a8SDaniel Walker 1388c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1389c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1390c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1391c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1392c2fdda0dSAndy Whitcroft 1393c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1394c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1395c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1396c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1397c2fdda0dSAndy Whitcroft } 1398c2fdda0dSAndy Whitcroft 1399dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1400dadf680dSJoe Perches my $match = $1; 1401dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1402dadf680dSJoe Perches } 1403dadf680dSJoe Perches 140400df344fSAndy Whitcroft return $res; 140500df344fSAndy Whitcroft} 140600df344fSAndy Whitcroft 1407a6962d72SJoe Perchessub get_quoted_string { 1408a6962d72SJoe Perches my ($line, $rawline) = @_; 1409a6962d72SJoe Perches 1410478b1799SJoe Perches return "" if (!defined($line) || !defined($rawline)); 141133acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1412a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1413a6962d72SJoe Perches} 1414a6962d72SJoe Perches 14158905a67cSAndy Whitcroftsub ctx_statement_block { 14168905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 14178905a67cSAndy Whitcroft my $line = $linenr - 1; 14188905a67cSAndy Whitcroft my $blk = ''; 14198905a67cSAndy Whitcroft my $soff = $off; 14208905a67cSAndy Whitcroft my $coff = $off - 1; 1421773647a0SAndy Whitcroft my $coff_set = 0; 14228905a67cSAndy Whitcroft 142313214adfSAndy Whitcroft my $loff = 0; 142413214adfSAndy Whitcroft 14258905a67cSAndy Whitcroft my $type = ''; 14268905a67cSAndy Whitcroft my $level = 0; 1427a2750645SAndy Whitcroft my @stack = (); 1428cf655043SAndy Whitcroft my $p; 14298905a67cSAndy Whitcroft my $c; 14308905a67cSAndy Whitcroft my $len = 0; 143113214adfSAndy Whitcroft 143213214adfSAndy Whitcroft my $remainder; 14338905a67cSAndy Whitcroft while (1) { 1434a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1435a2750645SAndy Whitcroft 1436773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 14378905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 14388905a67cSAndy Whitcroft # context. 14398905a67cSAndy Whitcroft if ($off >= $len) { 14408905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1441dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1442c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 14438905a67cSAndy Whitcroft $remain--; 144413214adfSAndy Whitcroft $loff = $len; 1445c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 14468905a67cSAndy Whitcroft $len = length($blk); 14478905a67cSAndy Whitcroft $line++; 14488905a67cSAndy Whitcroft last; 14498905a67cSAndy Whitcroft } 14508905a67cSAndy Whitcroft # Bail if there is no further context. 14518905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 145213214adfSAndy Whitcroft if ($off >= $len) { 14538905a67cSAndy Whitcroft last; 14548905a67cSAndy Whitcroft } 1455f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1456f74bd194SAndy Whitcroft $level++; 1457f74bd194SAndy Whitcroft $type = '#'; 1458f74bd194SAndy Whitcroft } 14598905a67cSAndy Whitcroft } 1460cf655043SAndy Whitcroft $p = $c; 14618905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 146213214adfSAndy Whitcroft $remainder = substr($blk, $off); 14638905a67cSAndy Whitcroft 1464773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 14654635f4fbSAndy Whitcroft 14664635f4fbSAndy Whitcroft # Handle nested #if/#else. 14674635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 14684635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 14694635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 14704635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 14714635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 14724635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 14734635f4fbSAndy Whitcroft } 14744635f4fbSAndy Whitcroft 14758905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 14768905a67cSAndy Whitcroft # outermost level. 14778905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 14788905a67cSAndy Whitcroft last; 14798905a67cSAndy Whitcroft } 14808905a67cSAndy Whitcroft 148113214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1482773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1483773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1484773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1485773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1486773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1487773647a0SAndy Whitcroft $coff_set = 1; 1488773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1489773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 149013214adfSAndy Whitcroft } 149113214adfSAndy Whitcroft 14928905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 14938905a67cSAndy Whitcroft $level++; 14948905a67cSAndy Whitcroft $type = '('; 14958905a67cSAndy Whitcroft } 14968905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 14978905a67cSAndy Whitcroft $level--; 14988905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 14998905a67cSAndy Whitcroft 15008905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 15018905a67cSAndy Whitcroft $coff = $off; 1502773647a0SAndy Whitcroft $coff_set = 1; 1503773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 15048905a67cSAndy Whitcroft } 15058905a67cSAndy Whitcroft } 15068905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 15078905a67cSAndy Whitcroft $level++; 15088905a67cSAndy Whitcroft $type = '{'; 15098905a67cSAndy Whitcroft } 15108905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 15118905a67cSAndy Whitcroft $level--; 15128905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 15138905a67cSAndy Whitcroft 15148905a67cSAndy Whitcroft if ($level == 0) { 1515b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1516b998e001SPatrick Pannuto $off++; 1517b998e001SPatrick Pannuto } 15188905a67cSAndy Whitcroft last; 15198905a67cSAndy Whitcroft } 15208905a67cSAndy Whitcroft } 1521f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1522f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1523f74bd194SAndy Whitcroft $level--; 1524f74bd194SAndy Whitcroft $type = ''; 1525f74bd194SAndy Whitcroft $off++; 1526f74bd194SAndy Whitcroft last; 1527f74bd194SAndy Whitcroft } 15288905a67cSAndy Whitcroft $off++; 15298905a67cSAndy Whitcroft } 1530a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 153113214adfSAndy Whitcroft if ($off == $len) { 1532a3bb97a7SAndy Whitcroft $loff = $len + 1; 153313214adfSAndy Whitcroft $line++; 153413214adfSAndy Whitcroft $remain--; 153513214adfSAndy Whitcroft } 15368905a67cSAndy Whitcroft 15378905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 15388905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 15398905a67cSAndy Whitcroft 15408905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 15418905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 15428905a67cSAndy Whitcroft 1543773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 154413214adfSAndy Whitcroft 154513214adfSAndy Whitcroft return ($statement, $condition, 154613214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 154713214adfSAndy Whitcroft} 154813214adfSAndy Whitcroft 1549cf655043SAndy Whitcroftsub statement_lines { 1550cf655043SAndy Whitcroft my ($stmt) = @_; 1551cf655043SAndy Whitcroft 1552cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1553cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1554cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1555cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1556cf655043SAndy Whitcroft 1557cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1558cf655043SAndy Whitcroft 1559cf655043SAndy Whitcroft return $#stmt_lines + 2; 1560cf655043SAndy Whitcroft} 1561cf655043SAndy Whitcroft 1562cf655043SAndy Whitcroftsub statement_rawlines { 1563cf655043SAndy Whitcroft my ($stmt) = @_; 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_block_size { 1571cf655043SAndy Whitcroft my ($stmt) = @_; 1572cf655043SAndy Whitcroft 1573cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1574cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1575cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1576cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1577cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1578cf655043SAndy Whitcroft 1579cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1580cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1581cf655043SAndy Whitcroft 1582cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1583cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1584cf655043SAndy Whitcroft 1585cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1586cf655043SAndy Whitcroft return $stmt_lines; 1587cf655043SAndy Whitcroft } else { 1588cf655043SAndy Whitcroft return $stmt_statements; 1589cf655043SAndy Whitcroft } 1590cf655043SAndy Whitcroft} 1591cf655043SAndy Whitcroft 159213214adfSAndy Whitcroftsub ctx_statement_full { 159313214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 159413214adfSAndy Whitcroft my ($statement, $condition, $level); 159513214adfSAndy Whitcroft 159613214adfSAndy Whitcroft my (@chunks); 159713214adfSAndy Whitcroft 1598cf655043SAndy Whitcroft # Grab the first conditional/block pair. 159913214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 160013214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1601773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 160213214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1603cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1604cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1605cf655043SAndy Whitcroft } 1606cf655043SAndy Whitcroft 1607cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1608cf655043SAndy Whitcroft # could continue the statement. 1609cf655043SAndy Whitcroft for (;;) { 161013214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 161113214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1612cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1613773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1614cf655043SAndy Whitcroft #print "C: push\n"; 1615cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 161613214adfSAndy Whitcroft } 161713214adfSAndy Whitcroft 161813214adfSAndy Whitcroft return ($level, $linenr, @chunks); 16198905a67cSAndy Whitcroft} 16208905a67cSAndy Whitcroft 16214a0df2efSAndy Whitcroftsub ctx_block_get { 1622f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 16234a0df2efSAndy Whitcroft my $line; 16244a0df2efSAndy Whitcroft my $start = $linenr - 1; 16254a0df2efSAndy Whitcroft my $blk = ''; 16264a0df2efSAndy Whitcroft my @o; 16274a0df2efSAndy Whitcroft my @c; 16284a0df2efSAndy Whitcroft my @res = (); 16294a0df2efSAndy Whitcroft 1630f0a594c1SAndy Whitcroft my $level = 0; 16314635f4fbSAndy Whitcroft my @stack = ($level); 163200df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 163300df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 163400df344fSAndy Whitcroft $remain--; 163500df344fSAndy Whitcroft 163600df344fSAndy Whitcroft $blk .= $rawlines[$line]; 16374635f4fbSAndy Whitcroft 16384635f4fbSAndy Whitcroft # Handle nested #if/#else. 163901464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 16404635f4fbSAndy Whitcroft push(@stack, $level); 164101464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 16424635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 164301464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 16444635f4fbSAndy Whitcroft $level = pop(@stack); 16454635f4fbSAndy Whitcroft } 16464635f4fbSAndy Whitcroft 164701464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1648f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1649f0a594c1SAndy Whitcroft if ($off > 0) { 1650f0a594c1SAndy Whitcroft $off--; 1651f0a594c1SAndy Whitcroft next; 1652f0a594c1SAndy Whitcroft } 16534a0df2efSAndy Whitcroft 1654f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1655f0a594c1SAndy Whitcroft $level--; 1656f0a594c1SAndy Whitcroft last if ($level == 0); 1657f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1658f0a594c1SAndy Whitcroft $level++; 1659f0a594c1SAndy Whitcroft } 1660f0a594c1SAndy Whitcroft } 16614a0df2efSAndy Whitcroft 1662f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 166300df344fSAndy Whitcroft push(@res, $rawlines[$line]); 16644a0df2efSAndy Whitcroft } 16654a0df2efSAndy Whitcroft 1666f0a594c1SAndy Whitcroft last if ($level == 0); 16674a0df2efSAndy Whitcroft } 16684a0df2efSAndy Whitcroft 1669f0a594c1SAndy Whitcroft return ($level, @res); 16704a0df2efSAndy Whitcroft} 16714a0df2efSAndy Whitcroftsub ctx_block_outer { 16724a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 16734a0df2efSAndy Whitcroft 1674f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1675f0a594c1SAndy Whitcroft return @r; 16764a0df2efSAndy Whitcroft} 16774a0df2efSAndy Whitcroftsub ctx_block { 16784a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 16794a0df2efSAndy Whitcroft 1680f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1681f0a594c1SAndy Whitcroft return @r; 1682653d4876SAndy Whitcroft} 1683653d4876SAndy Whitcroftsub ctx_statement { 1684f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1685f0a594c1SAndy Whitcroft 1686f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1687f0a594c1SAndy Whitcroft return @r; 1688f0a594c1SAndy Whitcroft} 1689f0a594c1SAndy Whitcroftsub ctx_block_level { 1690653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1691653d4876SAndy Whitcroft 1692f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 16934a0df2efSAndy Whitcroft} 16949c0ca6f9SAndy Whitcroftsub ctx_statement_level { 16959c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 16969c0ca6f9SAndy Whitcroft 16979c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 16989c0ca6f9SAndy Whitcroft} 16994a0df2efSAndy Whitcroft 17004a0df2efSAndy Whitcroftsub ctx_locate_comment { 17014a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 17024a0df2efSAndy Whitcroft 1703a55ee0ccSJoe Perches # If c99 comment on the current line, or the line before or after 1704a55ee0ccSJoe Perches my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@); 1705a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1706a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@); 1707a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1708a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@); 1709a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1710a55ee0ccSJoe Perches 17114a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1712a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 17134a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 17144a0df2efSAndy Whitcroft 17154a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 17164a0df2efSAndy Whitcroft # comment. 17174a0df2efSAndy Whitcroft my $in_comment = 0; 17184a0df2efSAndy Whitcroft $current_comment = ''; 17194a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 172000df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 172100df344fSAndy Whitcroft #warn " $line\n"; 17224a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 17234a0df2efSAndy Whitcroft $in_comment = 1; 17244a0df2efSAndy Whitcroft } 17254a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 17264a0df2efSAndy Whitcroft $in_comment = 1; 17274a0df2efSAndy Whitcroft } 17284a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 17294a0df2efSAndy Whitcroft $current_comment = ''; 17304a0df2efSAndy Whitcroft } 17314a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 17324a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 17334a0df2efSAndy Whitcroft $in_comment = 0; 17344a0df2efSAndy Whitcroft } 17354a0df2efSAndy Whitcroft } 17364a0df2efSAndy Whitcroft 17374a0df2efSAndy Whitcroft chomp($current_comment); 17384a0df2efSAndy Whitcroft return($current_comment); 17394a0df2efSAndy Whitcroft} 17404a0df2efSAndy Whitcroftsub ctx_has_comment { 17414a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 17424a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 17434a0df2efSAndy Whitcroft 174400df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 17454a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 17464a0df2efSAndy Whitcroft 17474a0df2efSAndy Whitcroft return ($cmt ne ''); 17484a0df2efSAndy Whitcroft} 17494a0df2efSAndy Whitcroft 17504d001e4dSAndy Whitcroftsub raw_line { 17514d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 17524d001e4dSAndy Whitcroft 17534d001e4dSAndy Whitcroft my $offset = $linenr - 1; 17544d001e4dSAndy Whitcroft $cnt++; 17554d001e4dSAndy Whitcroft 17564d001e4dSAndy Whitcroft my $line; 17574d001e4dSAndy Whitcroft while ($cnt) { 17584d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 17594d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 17604d001e4dSAndy Whitcroft $cnt--; 17614d001e4dSAndy Whitcroft } 17624d001e4dSAndy Whitcroft 17634d001e4dSAndy Whitcroft return $line; 17644d001e4dSAndy Whitcroft} 17654d001e4dSAndy Whitcroft 17662a9f9d85STobin C. Hardingsub get_stat_real { 17672a9f9d85STobin C. Harding my ($linenr, $lc) = @_; 17682a9f9d85STobin C. Harding 17692a9f9d85STobin C. Harding my $stat_real = raw_line($linenr, 0); 17702a9f9d85STobin C. Harding for (my $count = $linenr + 1; $count <= $lc; $count++) { 17712a9f9d85STobin C. Harding $stat_real = $stat_real . "\n" . raw_line($count, 0); 17722a9f9d85STobin C. Harding } 17732a9f9d85STobin C. Harding 17742a9f9d85STobin C. Harding return $stat_real; 17752a9f9d85STobin C. Harding} 17762a9f9d85STobin C. Harding 1777e3d95a2aSTobin C. Hardingsub get_stat_here { 1778e3d95a2aSTobin C. Harding my ($linenr, $cnt, $here) = @_; 1779e3d95a2aSTobin C. Harding 1780e3d95a2aSTobin C. Harding my $herectx = $here . "\n"; 1781e3d95a2aSTobin C. Harding for (my $n = 0; $n < $cnt; $n++) { 1782e3d95a2aSTobin C. Harding $herectx .= raw_line($linenr, $n) . "\n"; 1783e3d95a2aSTobin C. Harding } 1784e3d95a2aSTobin C. Harding 1785e3d95a2aSTobin C. Harding return $herectx; 1786e3d95a2aSTobin C. Harding} 1787e3d95a2aSTobin C. Harding 17880a920b5bSAndy Whitcroftsub cat_vet { 17890a920b5bSAndy Whitcroft my ($vet) = @_; 17909c0ca6f9SAndy Whitcroft my ($res, $coded); 17910a920b5bSAndy Whitcroft 17929c0ca6f9SAndy Whitcroft $res = ''; 17936c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 17946c72ffaaSAndy Whitcroft $res .= $1; 17956c72ffaaSAndy Whitcroft if ($2 ne '') { 17969c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 17976c72ffaaSAndy Whitcroft $res .= $coded; 17986c72ffaaSAndy Whitcroft } 17999c0ca6f9SAndy Whitcroft } 18009c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 18010a920b5bSAndy Whitcroft 18029c0ca6f9SAndy Whitcroft return $res; 18030a920b5bSAndy Whitcroft} 18040a920b5bSAndy Whitcroft 1805c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1806cf655043SAndy Whitcroftmy $av_pending; 1807c2fdda0dSAndy Whitcroftmy @av_paren_type; 18081f65f947SAndy Whitcroftmy $av_pend_colon; 1809c2fdda0dSAndy Whitcroft 1810c2fdda0dSAndy Whitcroftsub annotate_reset { 1811c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1812cf655043SAndy Whitcroft $av_pending = '_'; 1813cf655043SAndy Whitcroft @av_paren_type = ('E'); 18141f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1815c2fdda0dSAndy Whitcroft} 1816c2fdda0dSAndy Whitcroft 18176c72ffaaSAndy Whitcroftsub annotate_values { 18186c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 18196c72ffaaSAndy Whitcroft 18206c72ffaaSAndy Whitcroft my $res; 18211f65f947SAndy Whitcroft my $var = '_' x length($stream); 18226c72ffaaSAndy Whitcroft my $cur = $stream; 18236c72ffaaSAndy Whitcroft 1824c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 18256c72ffaaSAndy Whitcroft 18266c72ffaaSAndy Whitcroft while (length($cur)) { 1827773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1828cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1829171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 18306c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1831c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1832c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1833cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1834c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 18356c72ffaaSAndy Whitcroft } 18366c72ffaaSAndy Whitcroft 1837c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 18389446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 18399446ef56SAndy Whitcroft push(@av_paren_type, $type); 1840addcdceaSAndy Whitcroft $type = 'c'; 18419446ef56SAndy Whitcroft 1842e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1843c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 18446c72ffaaSAndy Whitcroft $type = 'T'; 18456c72ffaaSAndy Whitcroft 1846389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1847389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1848389a2fe5SAndy Whitcroft $type = 'T'; 1849389a2fe5SAndy Whitcroft 1850c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1851171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1852c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1853171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1854171ae1a4SAndy Whitcroft if ($2 ne '') { 1855cf655043SAndy Whitcroft $av_pending = 'N'; 1856171ae1a4SAndy Whitcroft } 1857171ae1a4SAndy Whitcroft $type = 'E'; 1858171ae1a4SAndy Whitcroft 1859c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1860171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1861171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1862171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 18636c72ffaaSAndy Whitcroft 1864c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1865cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1866c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1867cf655043SAndy Whitcroft 1868cf655043SAndy Whitcroft push(@av_paren_type, $type); 1869cf655043SAndy Whitcroft push(@av_paren_type, $type); 1870171ae1a4SAndy Whitcroft $type = 'E'; 1871cf655043SAndy Whitcroft 1872c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1873cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1874cf655043SAndy Whitcroft $av_preprocessor = 1; 1875cf655043SAndy Whitcroft 1876cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1877cf655043SAndy Whitcroft 1878171ae1a4SAndy Whitcroft $type = 'E'; 1879cf655043SAndy Whitcroft 1880c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1881cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1882cf655043SAndy Whitcroft 1883cf655043SAndy Whitcroft $av_preprocessor = 1; 1884cf655043SAndy Whitcroft 1885cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1886cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1887cf655043SAndy Whitcroft pop(@av_paren_type); 1888cf655043SAndy Whitcroft push(@av_paren_type, $type); 1889171ae1a4SAndy Whitcroft $type = 'E'; 18906c72ffaaSAndy Whitcroft 18916c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1892c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 18936c72ffaaSAndy Whitcroft 1894171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1895171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1896171ae1a4SAndy Whitcroft $av_pending = $type; 1897171ae1a4SAndy Whitcroft $type = 'N'; 1898171ae1a4SAndy Whitcroft 18996c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1900c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 19016c72ffaaSAndy Whitcroft if (defined $2) { 1902cf655043SAndy Whitcroft $av_pending = 'V'; 19036c72ffaaSAndy Whitcroft } 19046c72ffaaSAndy Whitcroft $type = 'N'; 19056c72ffaaSAndy Whitcroft 190614b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1907c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 190814b111c1SAndy Whitcroft $av_pending = 'E'; 19096c72ffaaSAndy Whitcroft $type = 'N'; 19106c72ffaaSAndy Whitcroft 19111f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 19121f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 19131f65f947SAndy Whitcroft $av_pend_colon = 'C'; 19141f65f947SAndy Whitcroft $type = 'N'; 19151f65f947SAndy Whitcroft 191614b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1917c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 19186c72ffaaSAndy Whitcroft $type = 'N'; 19196c72ffaaSAndy Whitcroft 19206c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1921c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1922cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1923cf655043SAndy Whitcroft $av_pending = '_'; 19246c72ffaaSAndy Whitcroft $type = 'N'; 19256c72ffaaSAndy Whitcroft 19266c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1927cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1928cf655043SAndy Whitcroft if ($new_type ne '_') { 1929cf655043SAndy Whitcroft $type = $new_type; 1930c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1931c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 19326c72ffaaSAndy Whitcroft } else { 1933c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 19346c72ffaaSAndy Whitcroft } 19356c72ffaaSAndy Whitcroft 1936c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1937c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1938c8cb2ca3SAndy Whitcroft $type = 'V'; 1939cf655043SAndy Whitcroft $av_pending = 'V'; 19406c72ffaaSAndy Whitcroft 19418e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 19428e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 19431f65f947SAndy Whitcroft $av_pend_colon = 'B'; 19448e761b04SAndy Whitcroft } elsif ($type eq 'E') { 19458e761b04SAndy Whitcroft $av_pend_colon = 'L'; 19461f65f947SAndy Whitcroft } 19471f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 19481f65f947SAndy Whitcroft $type = 'V'; 19491f65f947SAndy Whitcroft 19506c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1951c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 19526c72ffaaSAndy Whitcroft $type = 'V'; 19536c72ffaaSAndy Whitcroft 19546c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1955c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 19566c72ffaaSAndy Whitcroft $type = 'N'; 19576c72ffaaSAndy Whitcroft 1958cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1959c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 196013214adfSAndy Whitcroft $type = 'E'; 19611f65f947SAndy Whitcroft $av_pend_colon = 'O'; 196213214adfSAndy Whitcroft 19638e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 19648e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 19658e761b04SAndy Whitcroft $type = 'C'; 19668e761b04SAndy Whitcroft 19671f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 19681f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 19691f65f947SAndy Whitcroft $type = 'N'; 19701f65f947SAndy Whitcroft 19711f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 19721f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 19731f65f947SAndy Whitcroft 19741f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 19751f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 19761f65f947SAndy Whitcroft $type = 'E'; 19771f65f947SAndy Whitcroft } else { 19781f65f947SAndy Whitcroft $type = 'N'; 19791f65f947SAndy Whitcroft } 19801f65f947SAndy Whitcroft $av_pend_colon = 'O'; 19811f65f947SAndy Whitcroft 19828e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 198313214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 19846c72ffaaSAndy Whitcroft $type = 'N'; 19856c72ffaaSAndy Whitcroft 19860d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 198774048ed8SAndy Whitcroft my $variant; 198874048ed8SAndy Whitcroft 198974048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 199074048ed8SAndy Whitcroft if ($type eq 'V') { 199174048ed8SAndy Whitcroft $variant = 'B'; 199274048ed8SAndy Whitcroft } else { 199374048ed8SAndy Whitcroft $variant = 'U'; 199474048ed8SAndy Whitcroft } 199574048ed8SAndy Whitcroft 199674048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 199774048ed8SAndy Whitcroft $type = 'N'; 199874048ed8SAndy Whitcroft 19996c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 2000c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 20016c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 20026c72ffaaSAndy Whitcroft $type = 'N'; 20036c72ffaaSAndy Whitcroft } 20046c72ffaaSAndy Whitcroft 20056c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 2006c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 20076c72ffaaSAndy Whitcroft } 20086c72ffaaSAndy Whitcroft if (defined $1) { 20096c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 20106c72ffaaSAndy Whitcroft $res .= $type x length($1); 20116c72ffaaSAndy Whitcroft } 20126c72ffaaSAndy Whitcroft } 20136c72ffaaSAndy Whitcroft 20141f65f947SAndy Whitcroft return ($res, $var); 20156c72ffaaSAndy Whitcroft} 20166c72ffaaSAndy Whitcroft 20178905a67cSAndy Whitcroftsub possible { 201813214adfSAndy Whitcroft my ($possible, $line) = @_; 20199a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 20200776e594SAndy Whitcroft ^(?: 20210776e594SAndy Whitcroft $Modifier| 20220776e594SAndy Whitcroft $Storage| 20230776e594SAndy Whitcroft $Type| 20249a974fdbSAndy Whitcroft DEFINE_\S+ 20259a974fdbSAndy Whitcroft )$| 20269a974fdbSAndy Whitcroft ^(?: 20270776e594SAndy Whitcroft goto| 20280776e594SAndy Whitcroft return| 20290776e594SAndy Whitcroft case| 20300776e594SAndy Whitcroft else| 20310776e594SAndy Whitcroft asm|__asm__| 203289a88353SAndy Whitcroft do| 203389a88353SAndy Whitcroft \#| 203489a88353SAndy Whitcroft \#\#| 20359a974fdbSAndy Whitcroft )(?:\s|$)| 20360776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 20379a974fdbSAndy Whitcroft )}x; 20389a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 20399a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 2040c45dcabdSAndy Whitcroft # Check for modifiers. 2041c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 2042c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 2043c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 2044c45dcabdSAndy Whitcroft 2045c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 2046c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 2047d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 20489a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 2049d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 2050485ff23eSAlex Dowad push(@modifierListFile, $modifier); 2051d2506586SAndy Whitcroft } 20529a974fdbSAndy Whitcroft } 2053c45dcabdSAndy Whitcroft 2054c45dcabdSAndy Whitcroft } else { 205513214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 2056485ff23eSAlex Dowad push(@typeListFile, $possible); 2057c45dcabdSAndy Whitcroft } 20588905a67cSAndy Whitcroft build_types(); 20590776e594SAndy Whitcroft } else { 20600776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 20618905a67cSAndy Whitcroft } 20628905a67cSAndy Whitcroft} 20638905a67cSAndy Whitcroft 20646c72ffaaSAndy Whitcroftmy $prefix = ''; 20656c72ffaaSAndy Whitcroft 2066000d1cc1SJoe Perchessub show_type { 2067cbec18afSJoe Perches my ($type) = @_; 206891bfe484SJoe Perches 2069522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 2070522b837cSAlexey Dobriyan 2071cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 2072cbec18afSJoe Perches 2073cbec18afSJoe Perches return !defined $ignore_type{$type}; 2074000d1cc1SJoe Perches} 2075000d1cc1SJoe Perches 2076f0a594c1SAndy Whitcroftsub report { 2077cbec18afSJoe Perches my ($level, $type, $msg) = @_; 2078cbec18afSJoe Perches 2079cbec18afSJoe Perches if (!show_type($type) || 2080cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 2081773647a0SAndy Whitcroft return 0; 2082773647a0SAndy Whitcroft } 208357230297SJoe Perches my $output = ''; 2084737c0767SJohn Brooks if ($color) { 208557230297SJoe Perches if ($level eq 'ERROR') { 208657230297SJoe Perches $output .= RED; 208757230297SJoe Perches } elsif ($level eq 'WARNING') { 208857230297SJoe Perches $output .= YELLOW; 2089000d1cc1SJoe Perches } else { 209057230297SJoe Perches $output .= GREEN; 2091000d1cc1SJoe Perches } 209257230297SJoe Perches } 209357230297SJoe Perches $output .= $prefix . $level . ':'; 209457230297SJoe Perches if ($show_types) { 2095737c0767SJohn Brooks $output .= BLUE if ($color); 209657230297SJoe Perches $output .= "$type:"; 209757230297SJoe Perches } 2098737c0767SJohn Brooks $output .= RESET if ($color); 209957230297SJoe Perches $output .= ' ' . $msg . "\n"; 210034d8815fSJoe Perches 210134d8815fSJoe Perches if ($showfile) { 210234d8815fSJoe Perches my @lines = split("\n", $output, -1); 210334d8815fSJoe Perches splice(@lines, 1, 1); 210434d8815fSJoe Perches $output = join("\n", @lines); 210534d8815fSJoe Perches } 210657230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 21078905a67cSAndy Whitcroft 210857230297SJoe Perches push(our @report, $output); 2109773647a0SAndy Whitcroft 2110773647a0SAndy Whitcroft return 1; 2111f0a594c1SAndy Whitcroft} 2112cbec18afSJoe Perches 2113f0a594c1SAndy Whitcroftsub report_dump { 211413214adfSAndy Whitcroft our @report; 2115f0a594c1SAndy Whitcroft} 2116000d1cc1SJoe Perches 2117d752fcc8SJoe Perchessub fixup_current_range { 2118d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 2119d752fcc8SJoe Perches 2120d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 2121d752fcc8SJoe Perches my $o = $1; 2122d752fcc8SJoe Perches my $l = $2; 2123d752fcc8SJoe Perches my $no = $o + $offset; 2124d752fcc8SJoe Perches my $nl = $l + $length; 2125d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 2126d752fcc8SJoe Perches } 2127d752fcc8SJoe Perches} 2128d752fcc8SJoe Perches 2129d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 2130d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 2131d752fcc8SJoe Perches 2132d752fcc8SJoe Perches my $range_last_linenr = 0; 2133d752fcc8SJoe Perches my $delta_offset = 0; 2134d752fcc8SJoe Perches 2135d752fcc8SJoe Perches my $old_linenr = 0; 2136d752fcc8SJoe Perches my $new_linenr = 0; 2137d752fcc8SJoe Perches 2138d752fcc8SJoe Perches my $next_insert = 0; 2139d752fcc8SJoe Perches my $next_delete = 0; 2140d752fcc8SJoe Perches 2141d752fcc8SJoe Perches my @lines = (); 2142d752fcc8SJoe Perches 2143d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 2144d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 2145d752fcc8SJoe Perches 2146d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 2147d752fcc8SJoe Perches my $save_line = 1; 2148d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 2149323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2150d752fcc8SJoe Perches $delta_offset = 0; 2151d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2152d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 2153d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 2154d752fcc8SJoe Perches } 2155d752fcc8SJoe Perches 2156d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2157d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 2158d752fcc8SJoe Perches $save_line = 0; 2159d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2160d752fcc8SJoe Perches } 2161d752fcc8SJoe Perches 2162d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2163d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 2164d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 2165d752fcc8SJoe Perches $new_linenr++; 2166d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2167d752fcc8SJoe Perches } 2168d752fcc8SJoe Perches 2169d752fcc8SJoe Perches if ($save_line) { 2170d752fcc8SJoe Perches push(@lines, $line); 2171d752fcc8SJoe Perches $new_linenr++; 2172d752fcc8SJoe Perches } 2173d752fcc8SJoe Perches 2174d752fcc8SJoe Perches $old_linenr++; 2175d752fcc8SJoe Perches } 2176d752fcc8SJoe Perches 2177d752fcc8SJoe Perches return @lines; 2178d752fcc8SJoe Perches} 2179d752fcc8SJoe Perches 2180f2d7e4d4SJoe Perchessub fix_insert_line { 2181f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2182f2d7e4d4SJoe Perches 2183f2d7e4d4SJoe Perches my $inserted = { 2184f2d7e4d4SJoe Perches LINENR => $linenr, 2185f2d7e4d4SJoe Perches LINE => $line, 2186f2d7e4d4SJoe Perches }; 2187f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2188f2d7e4d4SJoe Perches} 2189f2d7e4d4SJoe Perches 2190f2d7e4d4SJoe Perchessub fix_delete_line { 2191f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2192f2d7e4d4SJoe Perches 2193f2d7e4d4SJoe Perches my $deleted = { 2194f2d7e4d4SJoe Perches LINENR => $linenr, 2195f2d7e4d4SJoe Perches LINE => $line, 2196f2d7e4d4SJoe Perches }; 2197f2d7e4d4SJoe Perches 2198f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2199f2d7e4d4SJoe Perches} 2200f2d7e4d4SJoe Perches 2201de7d4f0eSAndy Whitcroftsub ERROR { 2202cbec18afSJoe Perches my ($type, $msg) = @_; 2203cbec18afSJoe Perches 2204cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2205de7d4f0eSAndy Whitcroft our $clean = 0; 22066c72ffaaSAndy Whitcroft our $cnt_error++; 22073705ce5bSJoe Perches return 1; 2208de7d4f0eSAndy Whitcroft } 22093705ce5bSJoe Perches return 0; 2210773647a0SAndy Whitcroft} 2211de7d4f0eSAndy Whitcroftsub WARN { 2212cbec18afSJoe Perches my ($type, $msg) = @_; 2213cbec18afSJoe Perches 2214cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2215de7d4f0eSAndy Whitcroft our $clean = 0; 22166c72ffaaSAndy Whitcroft our $cnt_warn++; 22173705ce5bSJoe Perches return 1; 2218de7d4f0eSAndy Whitcroft } 22193705ce5bSJoe Perches return 0; 2220773647a0SAndy Whitcroft} 2221de7d4f0eSAndy Whitcroftsub CHK { 2222cbec18afSJoe Perches my ($type, $msg) = @_; 2223cbec18afSJoe Perches 2224cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2225de7d4f0eSAndy Whitcroft our $clean = 0; 22266c72ffaaSAndy Whitcroft our $cnt_chk++; 22273705ce5bSJoe Perches return 1; 22286c72ffaaSAndy Whitcroft } 22293705ce5bSJoe Perches return 0; 2230de7d4f0eSAndy Whitcroft} 2231de7d4f0eSAndy Whitcroft 22326ecd9674SAndy Whitcroftsub check_absolute_file { 22336ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 22346ecd9674SAndy Whitcroft my $file = $absolute; 22356ecd9674SAndy Whitcroft 22366ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 22376ecd9674SAndy Whitcroft 22386ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 22396ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 22406ecd9674SAndy Whitcroft if (-f "$root/$file") { 22416ecd9674SAndy Whitcroft ##print "file<$file>\n"; 22426ecd9674SAndy Whitcroft last; 22436ecd9674SAndy Whitcroft } 22446ecd9674SAndy Whitcroft } 22456ecd9674SAndy Whitcroft if (! -f _) { 22466ecd9674SAndy Whitcroft return 0; 22476ecd9674SAndy Whitcroft } 22486ecd9674SAndy Whitcroft 22496ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 22506ecd9674SAndy Whitcroft my $prefix = $absolute; 22516ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 22526ecd9674SAndy Whitcroft 22536ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 22546ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2255000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2256000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 22576ecd9674SAndy Whitcroft } 22586ecd9674SAndy Whitcroft} 22596ecd9674SAndy Whitcroft 22603705ce5bSJoe Perchessub trim { 22613705ce5bSJoe Perches my ($string) = @_; 22623705ce5bSJoe Perches 2263b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2264b34c648bSJoe Perches 2265b34c648bSJoe Perches return $string; 2266b34c648bSJoe Perches} 2267b34c648bSJoe Perches 2268b34c648bSJoe Perchessub ltrim { 2269b34c648bSJoe Perches my ($string) = @_; 2270b34c648bSJoe Perches 2271b34c648bSJoe Perches $string =~ s/^\s+//; 2272b34c648bSJoe Perches 2273b34c648bSJoe Perches return $string; 2274b34c648bSJoe Perches} 2275b34c648bSJoe Perches 2276b34c648bSJoe Perchessub rtrim { 2277b34c648bSJoe Perches my ($string) = @_; 2278b34c648bSJoe Perches 2279b34c648bSJoe Perches $string =~ s/\s+$//; 22803705ce5bSJoe Perches 22813705ce5bSJoe Perches return $string; 22823705ce5bSJoe Perches} 22833705ce5bSJoe Perches 228452ea8506SJoe Perchessub string_find_replace { 228552ea8506SJoe Perches my ($string, $find, $replace) = @_; 228652ea8506SJoe Perches 228752ea8506SJoe Perches $string =~ s/$find/$replace/g; 228852ea8506SJoe Perches 228952ea8506SJoe Perches return $string; 229052ea8506SJoe Perches} 229152ea8506SJoe Perches 22923705ce5bSJoe Perchessub tabify { 22933705ce5bSJoe Perches my ($leading) = @_; 22943705ce5bSJoe Perches 2295713a09deSAntonio Borneo my $source_indent = $tabsize; 22963705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 22973705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 22983705ce5bSJoe Perches 22993705ce5bSJoe Perches #convert leading spaces to tabs 23003705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 23013705ce5bSJoe Perches #Remove spaces before a tab 23023705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 23033705ce5bSJoe Perches 23043705ce5bSJoe Perches return "$leading"; 23053705ce5bSJoe Perches} 23063705ce5bSJoe Perches 2307d1fe9c09SJoe Perchessub pos_last_openparen { 2308d1fe9c09SJoe Perches my ($line) = @_; 2309d1fe9c09SJoe Perches 2310d1fe9c09SJoe Perches my $pos = 0; 2311d1fe9c09SJoe Perches 2312d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2313d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2314d1fe9c09SJoe Perches 2315d1fe9c09SJoe Perches my $last_openparen = 0; 2316d1fe9c09SJoe Perches 2317d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2318d1fe9c09SJoe Perches return -1; 2319d1fe9c09SJoe Perches } 2320d1fe9c09SJoe Perches 2321d1fe9c09SJoe Perches my $len = length($line); 2322d1fe9c09SJoe Perches 2323d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2324d1fe9c09SJoe Perches my $string = substr($line, $pos); 2325d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2326d1fe9c09SJoe Perches $pos += length($1) - 1; 2327d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2328d1fe9c09SJoe Perches $last_openparen = $pos; 2329d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2330d1fe9c09SJoe Perches last; 2331d1fe9c09SJoe Perches } 2332d1fe9c09SJoe Perches } 2333d1fe9c09SJoe Perches 233491cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2335d1fe9c09SJoe Perches} 2336d1fe9c09SJoe Perches 2337f36d3eb8SJoe Perchessub get_raw_comment { 2338f36d3eb8SJoe Perches my ($line, $rawline) = @_; 2339f36d3eb8SJoe Perches my $comment = ''; 2340f36d3eb8SJoe Perches 2341f36d3eb8SJoe Perches for my $i (0 .. (length($line) - 1)) { 2342f36d3eb8SJoe Perches if (substr($line, $i, 1) eq "$;") { 2343f36d3eb8SJoe Perches $comment .= substr($rawline, $i, 1); 2344f36d3eb8SJoe Perches } 2345f36d3eb8SJoe Perches } 2346f36d3eb8SJoe Perches 2347f36d3eb8SJoe Perches return $comment; 2348f36d3eb8SJoe Perches} 2349f36d3eb8SJoe Perches 23500a920b5bSAndy Whitcroftsub process { 23510a920b5bSAndy Whitcroft my $filename = shift; 23520a920b5bSAndy Whitcroft 23530a920b5bSAndy Whitcroft my $linenr=0; 23540a920b5bSAndy Whitcroft my $prevline=""; 2355c2fdda0dSAndy Whitcroft my $prevrawline=""; 23560a920b5bSAndy Whitcroft my $stashline=""; 2357c2fdda0dSAndy Whitcroft my $stashrawline=""; 23580a920b5bSAndy Whitcroft 23594a0df2efSAndy Whitcroft my $length; 23600a920b5bSAndy Whitcroft my $indent; 23610a920b5bSAndy Whitcroft my $previndent=0; 23620a920b5bSAndy Whitcroft my $stashindent=0; 23630a920b5bSAndy Whitcroft 2364de7d4f0eSAndy Whitcroft our $clean = 1; 23650a920b5bSAndy Whitcroft my $signoff = 0; 2366cd261496SGeert Uytterhoeven my $author = ''; 2367cd261496SGeert Uytterhoeven my $authorsignoff = 0; 23680a920b5bSAndy Whitcroft my $is_patch = 0; 2369133712a2SRob Herring my $is_binding_patch = -1; 237029ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 237115662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 237244d303ebSJoe Perches my $has_patch_separator = 0; #Found a --- line 2373ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2374490b292cSJoe Perches my $commit_log_lines = 0; #Number of commit log lines 2375bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 23762a076f40SJoe Perches my $commit_log_long_line = 0; 2377e518e9a5SJoe Perches my $commit_log_has_diff = 0; 237813f1937eSJoe Perches my $reported_maintainer_file = 0; 2379fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2380fa64205dSPasi Savanainen 2381365dd4eaSJoe Perches my $last_blank_line = 0; 23825e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2383365dd4eaSJoe Perches 238413214adfSAndy Whitcroft our @report = (); 23856c72ffaaSAndy Whitcroft our $cnt_lines = 0; 23866c72ffaaSAndy Whitcroft our $cnt_error = 0; 23876c72ffaaSAndy Whitcroft our $cnt_warn = 0; 23886c72ffaaSAndy Whitcroft our $cnt_chk = 0; 23896c72ffaaSAndy Whitcroft 23900a920b5bSAndy Whitcroft # Trace the real file/line as we go. 23910a920b5bSAndy Whitcroft my $realfile = ''; 23920a920b5bSAndy Whitcroft my $realline = 0; 23930a920b5bSAndy Whitcroft my $realcnt = 0; 23940a920b5bSAndy Whitcroft my $here = ''; 239577cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 23960a920b5bSAndy Whitcroft my $in_comment = 0; 2397c2fdda0dSAndy Whitcroft my $comment_edge = 0; 23980a920b5bSAndy Whitcroft my $first_line = 0; 23991e855726SWolfram Sang my $p1_prefix = ''; 24000a920b5bSAndy Whitcroft 240113214adfSAndy Whitcroft my $prev_values = 'E'; 240213214adfSAndy Whitcroft 240313214adfSAndy Whitcroft # suppression flags 2404773647a0SAndy Whitcroft my %suppress_ifbraces; 2405170d3a22SAndy Whitcroft my %suppress_whiletrailers; 24062b474a1aSAndy Whitcroft my %suppress_export; 24073e469cdcSAndy Whitcroft my $suppress_statement = 0; 2408653d4876SAndy Whitcroft 24097e51f197SJoe Perches my %signatures = (); 2410323c1260SJoe Perches 2411c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2412de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2413c2fdda0dSAndy Whitcroft # 2414de7d4f0eSAndy Whitcroft my @setup_docs = (); 2415de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2416773647a0SAndy Whitcroft 2417d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2418d8b07710SJoe Perches 24199f3a8992SRob Herring my $checklicenseline = 1; 24209f3a8992SRob Herring 2421773647a0SAndy Whitcroft sanitise_line_reset(); 2422c2fdda0dSAndy Whitcroft my $line; 2423c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2424773647a0SAndy Whitcroft $linenr++; 2425773647a0SAndy Whitcroft $line = $rawline; 2426c2fdda0dSAndy Whitcroft 24273705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 24283705ce5bSJoe Perches 2429773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2430de7d4f0eSAndy Whitcroft $setup_docs = 0; 24312581ac7cSTim Froidcoeur if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) { 2432de7d4f0eSAndy Whitcroft $setup_docs = 1; 2433de7d4f0eSAndy Whitcroft } 2434773647a0SAndy Whitcroft #next; 2435de7d4f0eSAndy Whitcroft } 243674fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2437773647a0SAndy Whitcroft $realline=$1-1; 2438773647a0SAndy Whitcroft if (defined $2) { 2439773647a0SAndy Whitcroft $realcnt=$3+1; 2440773647a0SAndy Whitcroft } else { 2441773647a0SAndy Whitcroft $realcnt=1+1; 2442773647a0SAndy Whitcroft } 2443c45dcabdSAndy Whitcroft $in_comment = 0; 2444773647a0SAndy Whitcroft 2445773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2446773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2447773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2448773647a0SAndy Whitcroft # at context start. 2449773647a0SAndy Whitcroft my $edge; 245001fa9147SAndy Whitcroft my $cnt = $realcnt; 245101fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 245201fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 245301fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 245401fa9147SAndy Whitcroft $cnt--; 245501fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2456721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2457fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2458fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2459fae17daeSAndy Whitcroft ($edge) = $1; 2460fae17daeSAndy Whitcroft last; 2461fae17daeSAndy Whitcroft } 2462773647a0SAndy Whitcroft } 2463773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2464773647a0SAndy Whitcroft $in_comment = 1; 2465773647a0SAndy Whitcroft } 2466773647a0SAndy Whitcroft 2467773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2468773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2469773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2470773647a0SAndy Whitcroft if (!defined $edge && 247183242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2472773647a0SAndy Whitcroft { 2473773647a0SAndy Whitcroft $in_comment = 1; 2474773647a0SAndy Whitcroft } 2475773647a0SAndy Whitcroft 2476773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2477773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2478773647a0SAndy Whitcroft 2479171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2480773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2481171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2482773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2483773647a0SAndy Whitcroft } 2484773647a0SAndy Whitcroft push(@lines, $line); 2485773647a0SAndy Whitcroft 2486773647a0SAndy Whitcroft if ($realcnt > 1) { 2487773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2488773647a0SAndy Whitcroft } else { 2489773647a0SAndy Whitcroft $realcnt = 0; 2490773647a0SAndy Whitcroft } 2491773647a0SAndy Whitcroft 2492773647a0SAndy Whitcroft #print "==>$rawline\n"; 2493773647a0SAndy Whitcroft #print "-->$line\n"; 2494de7d4f0eSAndy Whitcroft 2495de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2496de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2497de7d4f0eSAndy Whitcroft } 2498de7d4f0eSAndy Whitcroft } 2499de7d4f0eSAndy Whitcroft 25006c72ffaaSAndy Whitcroft $prefix = ''; 25016c72ffaaSAndy Whitcroft 2502773647a0SAndy Whitcroft $realcnt = 0; 2503773647a0SAndy Whitcroft $linenr = 0; 2504194f66fcSJoe Perches $fixlinenr = -1; 25050a920b5bSAndy Whitcroft foreach my $line (@lines) { 25060a920b5bSAndy Whitcroft $linenr++; 2507194f66fcSJoe Perches $fixlinenr++; 25081b5539b1SJoe Perches my $sline = $line; #copy of $line 25091b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 25100a920b5bSAndy Whitcroft 2511c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 2512f36d3eb8SJoe Perches my $raw_comment = get_raw_comment($line, $rawline); 25136c72ffaaSAndy Whitcroft 251412c253abSJoe Perches# check if it's a mode change, rename or start of a patch 251512c253abSJoe Perches if (!$in_commit_log && 251612c253abSJoe Perches ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 251712c253abSJoe Perches ($line =~ /^rename (?:from|to) \S+\s*$/ || 251812c253abSJoe Perches $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 251912c253abSJoe Perches $is_patch = 1; 252012c253abSJoe Perches } 252112c253abSJoe Perches 25220a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2523e518e9a5SJoe Perches if (!$in_commit_log && 252474fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 252574fd4f34SJoe Perches my $context = $4; 25260a920b5bSAndy Whitcroft $is_patch = 1; 25274a0df2efSAndy Whitcroft $first_line = $linenr + 1; 25280a920b5bSAndy Whitcroft $realline=$1-1; 25290a920b5bSAndy Whitcroft if (defined $2) { 25300a920b5bSAndy Whitcroft $realcnt=$3+1; 25310a920b5bSAndy Whitcroft } else { 25320a920b5bSAndy Whitcroft $realcnt=1+1; 25330a920b5bSAndy Whitcroft } 2534c2fdda0dSAndy Whitcroft annotate_reset(); 253513214adfSAndy Whitcroft $prev_values = 'E'; 253613214adfSAndy Whitcroft 2537773647a0SAndy Whitcroft %suppress_ifbraces = (); 2538170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 25392b474a1aSAndy Whitcroft %suppress_export = (); 25403e469cdcSAndy Whitcroft $suppress_statement = 0; 254174fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 254274fd4f34SJoe Perches $context_function = $1; 254374fd4f34SJoe Perches } else { 254474fd4f34SJoe Perches undef $context_function; 254574fd4f34SJoe Perches } 25460a920b5bSAndy Whitcroft next; 25470a920b5bSAndy Whitcroft 25484a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 25494a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 25504a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2551773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 25520a920b5bSAndy Whitcroft $realline++; 2553d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 25540a920b5bSAndy Whitcroft 25554a0df2efSAndy Whitcroft # Measure the line length and indent. 2556c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 25570a920b5bSAndy Whitcroft 25580a920b5bSAndy Whitcroft # Track the previous line. 25590a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 25600a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2561c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2562c2fdda0dSAndy Whitcroft 2563773647a0SAndy Whitcroft #warn "line<$line>\n"; 25646c72ffaaSAndy Whitcroft 2565d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2566d8aaf121SAndy Whitcroft $realcnt--; 25670a920b5bSAndy Whitcroft } 25680a920b5bSAndy Whitcroft 2569cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2570cc77cdcaSAndy Whitcroft 25716c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 25726c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2573773647a0SAndy Whitcroft 25742ac73b4fSJoe Perches my $found_file = 0; 2575773647a0SAndy Whitcroft # extract the filename as it passes 25763bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 25773bf9a009SRabin Vincent $realfile = $1; 25782b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2579270c49a0SJoe Perches $in_commit_log = 0; 25802ac73b4fSJoe Perches $found_file = 1; 25813bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2582773647a0SAndy Whitcroft $realfile = $1; 25832b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2584270c49a0SJoe Perches $in_commit_log = 0; 25851e855726SWolfram Sang 25861e855726SWolfram Sang $p1_prefix = $1; 2587e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2588e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2589000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2590000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 25911e855726SWolfram Sang } 2592773647a0SAndy Whitcroft 2593c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2594000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2595000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2596773647a0SAndy Whitcroft } 25972ac73b4fSJoe Perches $found_file = 1; 25982ac73b4fSJoe Perches } 25992ac73b4fSJoe Perches 260034d8815fSJoe Perches#make up the handle for any error we report on this line 260134d8815fSJoe Perches if ($showfile) { 260234d8815fSJoe Perches $prefix = "$realfile:$realline: " 260334d8815fSJoe Perches } elsif ($emacs) { 26047d3a9f67SJoe Perches if ($file) { 26057d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 26067d3a9f67SJoe Perches } else { 260734d8815fSJoe Perches $prefix = "$filename:$linenr: "; 260834d8815fSJoe Perches } 26097d3a9f67SJoe Perches } 261034d8815fSJoe Perches 26112ac73b4fSJoe Perches if ($found_file) { 261285b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 261385b0ee18SJoe Perches WARN("OBSOLETE", 261485b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 261585b0ee18SJoe Perches } 26167bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 26172ac73b4fSJoe Perches $check = 1; 26182ac73b4fSJoe Perches } else { 26192ac73b4fSJoe Perches $check = $check_orig; 26202ac73b4fSJoe Perches } 26219f3a8992SRob Herring $checklicenseline = 1; 2622133712a2SRob Herring 2623133712a2SRob Herring if ($realfile !~ /^MAINTAINERS/) { 2624133712a2SRob Herring my $last_binding_patch = $is_binding_patch; 2625133712a2SRob Herring 2626133712a2SRob Herring $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@; 2627133712a2SRob Herring 2628133712a2SRob Herring if (($last_binding_patch != -1) && 2629133712a2SRob Herring ($last_binding_patch ^ $is_binding_patch)) { 2630133712a2SRob Herring WARN("DT_SPLIT_BINDING_PATCH", 2631858e6845SMauro Carvalho Chehab "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n"); 2632133712a2SRob Herring } 2633133712a2SRob Herring } 2634133712a2SRob Herring 2635773647a0SAndy Whitcroft next; 2636773647a0SAndy Whitcroft } 2637773647a0SAndy Whitcroft 2638389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 26390a920b5bSAndy Whitcroft 2640c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2641c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2642c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 26430a920b5bSAndy Whitcroft 26446c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 26456c72ffaaSAndy Whitcroft 2646490b292cSJoe Perches# Verify the existence of a commit log if appropriate 2647490b292cSJoe Perches# 2 is used because a $signature is counted in $commit_log_lines 2648490b292cSJoe Perches if ($in_commit_log) { 2649490b292cSJoe Perches if ($line !~ /^\s*$/) { 2650490b292cSJoe Perches $commit_log_lines++; #could be a $signature 2651490b292cSJoe Perches } 2652490b292cSJoe Perches } elsif ($has_commit_log && $commit_log_lines < 2) { 2653490b292cSJoe Perches WARN("COMMIT_MESSAGE", 2654490b292cSJoe Perches "Missing commit description - Add an appropriate one\n"); 2655490b292cSJoe Perches $commit_log_lines = 2; #warn only once 2656490b292cSJoe Perches } 2657490b292cSJoe Perches 2658e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2659e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 266013e45417SMrinal Pandey (($line =~ m@^\s+diff\b.*a/([\w/]+)@ && 266113e45417SMrinal Pandey $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) || 2662e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2663e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2664e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2665e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2666e518e9a5SJoe Perches $commit_log_has_diff = 1; 2667e518e9a5SJoe Perches } 2668e518e9a5SJoe Perches 26693bf9a009SRabin Vincent# Check for incorrect file permissions 26703bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 26713bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 267204db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 267304db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2674000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2675000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 26763bf9a009SRabin Vincent } 26773bf9a009SRabin Vincent } 26783bf9a009SRabin Vincent 2679cd261496SGeert Uytterhoeven# Check the patch for a From: 2680cd261496SGeert Uytterhoeven if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { 2681cd261496SGeert Uytterhoeven $author = $1; 2682cd261496SGeert Uytterhoeven $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); 2683cd261496SGeert Uytterhoeven $author =~ s/"//g; 2684dfa05c28SJoe Perches $author = reformat_email($author); 2685cd261496SGeert Uytterhoeven } 2686cd261496SGeert Uytterhoeven 268720112475SJoe Perches# Check the patch for a signoff: 2688dfa05c28SJoe Perches if ($line =~ /^\s*signed-off-by:\s*(.*)/i) { 26894a0df2efSAndy Whitcroft $signoff++; 269015662b3eSJoe Perches $in_commit_log = 0; 2691cd261496SGeert Uytterhoeven if ($author ne '') { 2692dfa05c28SJoe Perches if (same_email_addresses($1, $author)) { 2693cd261496SGeert Uytterhoeven $authorsignoff = 1; 2694cd261496SGeert Uytterhoeven } 2695cd261496SGeert Uytterhoeven } 26960a920b5bSAndy Whitcroft } 269720112475SJoe Perches 269844d303ebSJoe Perches# Check for patch separator 269944d303ebSJoe Perches if ($line =~ /^---$/) { 270044d303ebSJoe Perches $has_patch_separator = 1; 270144d303ebSJoe Perches $in_commit_log = 0; 270244d303ebSJoe Perches } 270344d303ebSJoe Perches 2704e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2705e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2706e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2707e0d975b1SJoe Perches $reported_maintainer_file = 1; 2708e0d975b1SJoe Perches } 2709e0d975b1SJoe Perches 271020112475SJoe Perches# Check signature styles 2711270c49a0SJoe Perches if (!$in_header_lines && 2712ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 271320112475SJoe Perches my $space_before = $1; 271420112475SJoe Perches my $sign_off = $2; 271520112475SJoe Perches my $space_after = $3; 271620112475SJoe Perches my $email = $4; 271720112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 271820112475SJoe Perches 2719ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2720ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2721ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2722ce0338dfSJoe Perches } 272320112475SJoe Perches if (defined $space_before && $space_before ne "") { 27243705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 27253705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 27263705ce5bSJoe Perches $fix) { 2727194f66fcSJoe Perches $fixed[$fixlinenr] = 27283705ce5bSJoe Perches "$ucfirst_sign_off $email"; 27293705ce5bSJoe Perches } 273020112475SJoe Perches } 273120112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 27323705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 27333705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 27343705ce5bSJoe Perches $fix) { 2735194f66fcSJoe Perches $fixed[$fixlinenr] = 27363705ce5bSJoe Perches "$ucfirst_sign_off $email"; 27373705ce5bSJoe Perches } 27383705ce5bSJoe Perches 273920112475SJoe Perches } 274020112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 27413705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 27423705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 27433705ce5bSJoe Perches $fix) { 2744194f66fcSJoe Perches $fixed[$fixlinenr] = 27453705ce5bSJoe Perches "$ucfirst_sign_off $email"; 27463705ce5bSJoe Perches } 274720112475SJoe Perches } 274820112475SJoe Perches 2749dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 275020112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 275120112475SJoe Perches if ($suggested_email eq "") { 2752000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2753000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 275420112475SJoe Perches } else { 275520112475SJoe Perches my $dequoted = $suggested_email; 275620112475SJoe Perches $dequoted =~ s/^"//; 275720112475SJoe Perches $dequoted =~ s/" </ </; 275820112475SJoe Perches # Don't force email to have quotes 275920112475SJoe Perches # Allow just an angle bracketed address 2760dfa05c28SJoe Perches if (!same_email_addresses($email, $suggested_email)) { 2761000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2762000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 276320112475SJoe Perches } 27640a920b5bSAndy Whitcroft } 27657e51f197SJoe Perches 27667e51f197SJoe Perches# Check for duplicate signatures 27677e51f197SJoe Perches my $sig_nospace = $line; 27687e51f197SJoe Perches $sig_nospace =~ s/\s//g; 27697e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 27707e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 27717e51f197SJoe Perches WARN("BAD_SIGN_OFF", 27727e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 27737e51f197SJoe Perches } else { 27747e51f197SJoe Perches $signatures{$sig_nospace} = 1; 27757e51f197SJoe Perches } 27766c5d24eeSSean Christopherson 27776c5d24eeSSean Christopherson# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email 27786c5d24eeSSean Christopherson if ($sign_off =~ /^co-developed-by:$/i) { 27796c5d24eeSSean Christopherson if ($email eq $author) { 27806c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 27816c5d24eeSSean Christopherson "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline); 27826c5d24eeSSean Christopherson } 27836c5d24eeSSean Christopherson if (!defined $lines[$linenr]) { 27846c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 27856c5d24eeSSean Christopherson "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline); 27866c5d24eeSSean Christopherson } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) { 27876c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 27886c5d24eeSSean Christopherson "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 27896c5d24eeSSean Christopherson } elsif ($1 ne $email) { 27906c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 27916c5d24eeSSean Christopherson "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 27926c5d24eeSSean Christopherson } 27936c5d24eeSSean Christopherson } 27940a920b5bSAndy Whitcroft } 27950a920b5bSAndy Whitcroft 2796a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2797a2fe16b9SJoe Perches if ($in_header_lines && 2798a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2799a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2800a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2801a2fe16b9SJoe Perches } 2802a2fe16b9SJoe Perches 280344d303ebSJoe Perches# Check for Gerrit Change-Ids not in any patch context 280444d303ebSJoe Perches if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) { 28057ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 280644d303ebSJoe Perches "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr); 28077ebd05efSChristopher Covington } 28087ebd05efSChristopher Covington 2809369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2810369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2811369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2812369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2813369c8dd3SJoe Perches # timestamp 2814634cffccSJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) || 2815634cffccSJoe Perches $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ || 2816634cffccSJoe Perches $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) { 2817634cffccSJoe Perches # stack dump address styles 2818369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2819369c8dd3SJoe Perches } 2820369c8dd3SJoe Perches 28212a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 28222a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2823bf4daf12SJoe Perches length($line) > 75 && 2824bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2825bf4daf12SJoe Perches # file delta changes 2826bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2827bf4daf12SJoe Perches # filename then : 2828bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2829bf4daf12SJoe Perches # A Fixes: or Link: line 2830bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 28312a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 28322a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 28332a076f40SJoe Perches $commit_log_long_line = 1; 28342a076f40SJoe Perches } 28352a076f40SJoe Perches 2836bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2837bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2838bf4daf12SJoe Perches $line =~ /^\s*$/) { 2839bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2840bf4daf12SJoe Perches } 2841bf4daf12SJoe Perches 28420d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2843369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2844a8972573SJohn Hubbard $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i && 2845e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 2846fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2847aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2848369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2849bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2850fe043ea1SJoe Perches my $init_char = "c"; 2851fe043ea1SJoe Perches my $orig_commit = ""; 28520d7835fcSJoe Perches my $short = 1; 28530d7835fcSJoe Perches my $long = 0; 28540d7835fcSJoe Perches my $case = 1; 28550d7835fcSJoe Perches my $space = 1; 28560d7835fcSJoe Perches my $hasdesc = 0; 285719c146a6SJoe Perches my $hasparens = 0; 28580d7835fcSJoe Perches my $id = '0123456789ab'; 28590d7835fcSJoe Perches my $orig_desc = "commit description"; 28600d7835fcSJoe Perches my $description = ""; 28610d7835fcSJoe Perches 2862fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2863fe043ea1SJoe Perches $init_char = $1; 2864fe043ea1SJoe Perches $orig_commit = lc($2); 2865fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2866fe043ea1SJoe Perches $orig_commit = lc($1); 2867fe043ea1SJoe Perches } 2868fe043ea1SJoe Perches 28690d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 28700d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 28710d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 28720d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 28730d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 28740d7835fcSJoe Perches $orig_desc = $1; 287519c146a6SJoe Perches $hasparens = 1; 28760d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 28770d7835fcSJoe Perches defined $rawlines[$linenr] && 28780d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 28790d7835fcSJoe Perches $orig_desc = $1; 288019c146a6SJoe Perches $hasparens = 1; 2881b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2882b671fde0SJoe Perches defined $rawlines[$linenr] && 2883b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2884b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2885b671fde0SJoe Perches $orig_desc = $1; 2886b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2887b671fde0SJoe Perches $orig_desc .= " " . $1; 288819c146a6SJoe Perches $hasparens = 1; 28890d7835fcSJoe Perches } 28900d7835fcSJoe Perches 28910d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 28920d7835fcSJoe Perches $id, $orig_desc); 28930d7835fcSJoe Perches 2894948b133aSHeinrich Schuchardt if (defined($id) && 2895948b133aSHeinrich Schuchardt ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { 2896d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 28970d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 28980d7835fcSJoe Perches } 2899d311cd44SJoe Perches } 2900d311cd44SJoe Perches 290113f1937eSJoe Perches# Check for added, moved or deleted files 290213f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 290313f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 290413f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 290513f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 290613f1937eSJoe Perches (defined($1) || defined($2))))) { 2907a82603a8SAndrew Jeffery $is_patch = 1; 290813f1937eSJoe Perches $reported_maintainer_file = 1; 290913f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 291013f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 291113f1937eSJoe Perches } 291213f1937eSJoe Perches 2913e400edb1SRob Herring# Check for adding new DT bindings not in schema format 2914e400edb1SRob Herring if (!$in_commit_log && 2915e400edb1SRob Herring ($line =~ /^new file mode\s*\d+\s*$/) && 2916e400edb1SRob Herring ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) { 2917e400edb1SRob Herring WARN("DT_SCHEMA_BINDING_PATCH", 2918e400edb1SRob Herring "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n"); 2919e400edb1SRob Herring } 2920e400edb1SRob Herring 292100df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 29228905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2923000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2924000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 29256c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2926de7d4f0eSAndy Whitcroft } 2927de7d4f0eSAndy Whitcroft 2928de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2929de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2930171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2931171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2932171ae1a4SAndy Whitcroft 2933171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2934171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2935171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2936171ae1a4SAndy Whitcroft 293734d99219SJoe Perches CHK("INVALID_UTF8", 2938000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 293900df344fSAndy Whitcroft } 29400a920b5bSAndy Whitcroft 294115662b3eSJoe Perches# Check if it's the start of a commit log 294215662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 294315662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 2944eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 2945eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 294615662b3eSJoe Perches $in_header_lines = 0; 294715662b3eSJoe Perches $in_commit_log = 1; 2948ed43c4e5SAllen Hubbe $has_commit_log = 1; 294915662b3eSJoe Perches } 295015662b3eSJoe Perches 2951fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2952fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2953fa64205dSPasi Savanainen if ($in_header_lines && 2954fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2955fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2956fa64205dSPasi Savanainen $non_utf8_charset = 1; 2957fa64205dSPasi Savanainen } 2958fa64205dSPasi Savanainen 2959fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 296015662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2961fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 296215662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 296315662b3eSJoe Perches } 296415662b3eSJoe Perches 2965d6430f71SJoe Perches# Check for absolute kernel paths in commit message 2966d6430f71SJoe Perches if ($tree && $in_commit_log) { 2967d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 2968d6430f71SJoe Perches my $file = $1; 2969d6430f71SJoe Perches 2970d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 2971d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 2972d6430f71SJoe Perches # 2973d6430f71SJoe Perches } else { 2974d6430f71SJoe Perches check_absolute_file($file, $herecurr); 2975d6430f71SJoe Perches } 2976d6430f71SJoe Perches } 2977d6430f71SJoe Perches } 2978d6430f71SJoe Perches 297966b47b4aSKees Cook# Check for various typo / spelling mistakes 298066d7a382SJoe Perches if (defined($misspellings) && 298166d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2982ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 298366b47b4aSKees Cook my $typo = $1; 298466b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 298566b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 298666b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 29870675a8fbSJean Delvare my $msg_level = \&WARN; 29880675a8fbSJean Delvare $msg_level = \&CHK if ($file); 29890675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 299066b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 299166b47b4aSKees Cook $fix) { 299266b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 299366b47b4aSKees Cook } 299466b47b4aSKees Cook } 299566b47b4aSKees Cook } 299666b47b4aSKees Cook 2997a8dd86bfSMatteo Croce# check for invalid commit id 2998a8dd86bfSMatteo Croce if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) { 2999a8dd86bfSMatteo Croce my $id; 3000a8dd86bfSMatteo Croce my $description; 3001a8dd86bfSMatteo Croce ($id, $description) = git_commit_info($2, undef, undef); 3002a8dd86bfSMatteo Croce if (!defined($id)) { 3003a8dd86bfSMatteo Croce WARN("UNKNOWN_COMMIT_ID", 3004a8dd86bfSMatteo Croce "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr); 3005a8dd86bfSMatteo Croce } 3006a8dd86bfSMatteo Croce } 3007a8dd86bfSMatteo Croce 3008310cd06bSJoe Perches# check for repeated words separated by a single space 3009310cd06bSJoe Perches if ($rawline =~ /^\+/ || $in_commit_log) { 3010310cd06bSJoe Perches while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) { 3011310cd06bSJoe Perches 3012310cd06bSJoe Perches my $first = $1; 3013310cd06bSJoe Perches my $second = $2; 3014310cd06bSJoe Perches 3015310cd06bSJoe Perches if ($first =~ /(?:struct|union|enum)/) { 3016310cd06bSJoe Perches pos($rawline) += length($first) + length($second) + 1; 3017310cd06bSJoe Perches next; 3018310cd06bSJoe Perches } 3019310cd06bSJoe Perches 3020310cd06bSJoe Perches next if ($first ne $second); 3021310cd06bSJoe Perches next if ($first eq 'long'); 3022310cd06bSJoe Perches 3023310cd06bSJoe Perches if (WARN("REPEATED_WORD", 3024310cd06bSJoe Perches "Possible repeated word: '$first'\n" . $herecurr) && 3025310cd06bSJoe Perches $fix) { 3026310cd06bSJoe Perches $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/; 3027310cd06bSJoe Perches } 3028310cd06bSJoe Perches } 3029310cd06bSJoe Perches 3030310cd06bSJoe Perches # if it's a repeated word on consecutive lines in a comment block 3031310cd06bSJoe Perches if ($prevline =~ /$;+\s*$/ && 3032310cd06bSJoe Perches $prevrawline =~ /($word_pattern)\s*$/) { 3033310cd06bSJoe Perches my $last_word = $1; 3034310cd06bSJoe Perches if ($rawline =~ /^\+\s*\*\s*$last_word /) { 3035310cd06bSJoe Perches if (WARN("REPEATED_WORD", 3036310cd06bSJoe Perches "Possible repeated word: '$last_word'\n" . $hereprev) && 3037310cd06bSJoe Perches $fix) { 3038310cd06bSJoe Perches $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/; 3039310cd06bSJoe Perches } 3040310cd06bSJoe Perches } 3041310cd06bSJoe Perches } 3042310cd06bSJoe Perches } 3043310cd06bSJoe Perches 304430670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 304530670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 304600df344fSAndy Whitcroft 30470a920b5bSAndy Whitcroft#trailing whitespace 30489c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 3049c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3050d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 3051d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 3052d5e616fcSJoe Perches $fix) { 3053194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 3054d5e616fcSJoe Perches } 3055c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 3056c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 30573705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 30583705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 30593705ce5bSJoe Perches $fix) { 3060194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 30613705ce5bSJoe Perches } 30623705ce5bSJoe Perches 3063d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 30640a920b5bSAndy Whitcroft } 30655368df20SAndy Whitcroft 30664783f894SJosh Triplett# Check for FSF mailing addresses. 3067109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 30681bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 30693e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 30703e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 30714783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 30720675a8fbSJean Delvare my $msg_level = \&ERROR; 30730675a8fbSJean Delvare $msg_level = \&CHK if ($file); 30740675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 30754783f894SJosh 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) 30764783f894SJosh Triplett } 30774783f894SJosh Triplett 30783354957aSAndi Kleen# check for Kconfig help text having a real description 30799fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 30809fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 30813354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 3082678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 3083678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 3084678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 3085678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 30863354957aSAndi Kleen my $length = 0; 30879fe287d7SAndy Whitcroft my $cnt = $realcnt; 30889fe287d7SAndy Whitcroft my $ln = $linenr + 1; 30899fe287d7SAndy Whitcroft my $f; 3090a1385803SAndy Whitcroft my $is_start = 0; 30919fe287d7SAndy Whitcroft my $is_end = 0; 3092a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 30939fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 30949fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 30959fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 30969fe287d7SAndy Whitcroft 30979fe287d7SAndy Whitcroft next if ($f =~ /^-/); 30988d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 3099a1385803SAndy Whitcroft 310086adf1a0SUlf Magnusson if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 3101a1385803SAndy Whitcroft $is_start = 1; 310222a4ac02SMasahiro Yamada } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 3103a1385803SAndy Whitcroft $length = -1; 3104a1385803SAndy Whitcroft } 3105a1385803SAndy Whitcroft 31069fe287d7SAndy Whitcroft $f =~ s/^.//; 31073354957aSAndi Kleen $f =~ s/#.*//; 31083354957aSAndi Kleen $f =~ s/^\s+//; 31093354957aSAndi Kleen next if ($f =~ /^$/); 3110678ae162SUlf Magnusson 3111678ae162SUlf Magnusson # This only checks context lines in the patch 3112678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 3113678ae162SUlf Magnusson # positives, even though some of these are 3114678ae162SUlf Magnusson # common words in help texts 3115678ae162SUlf Magnusson if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| 3116678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 31179fe287d7SAndy Whitcroft $is_end = 1; 31189fe287d7SAndy Whitcroft last; 31199fe287d7SAndy Whitcroft } 31203354957aSAndi Kleen $length++; 31213354957aSAndi Kleen } 312256193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 3123000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 312456193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 312556193274SVadim Bendebury } 3126a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 31273354957aSAndi Kleen } 31283354957aSAndi Kleen 31297ccf41a8SJoe Perches# check MAINTAINERS entries 31307ccf41a8SJoe Perches if ($realfile =~ /^MAINTAINERS$/) { 31317ccf41a8SJoe Perches# check MAINTAINERS entries for the right form 31327ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 3133628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 3134628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 3135628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 3136628f91a2SJoe Perches $fix) { 3137628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 3138628f91a2SJoe Perches } 3139628f91a2SJoe Perches } 31407ccf41a8SJoe Perches# check MAINTAINERS entries for the right ordering too 31417ccf41a8SJoe Perches my $preferred_order = 'MRLSWQBCPTFXNK'; 31427ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 31437ccf41a8SJoe Perches $prevrawline =~ /^[\+ ][A-Z]:/) { 31447ccf41a8SJoe Perches $rawline =~ /^\+([A-Z]):\s*(.*)/; 31457ccf41a8SJoe Perches my $cur = $1; 31467ccf41a8SJoe Perches my $curval = $2; 31477ccf41a8SJoe Perches $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/; 31487ccf41a8SJoe Perches my $prev = $1; 31497ccf41a8SJoe Perches my $prevval = $2; 31507ccf41a8SJoe Perches my $curindex = index($preferred_order, $cur); 31517ccf41a8SJoe Perches my $previndex = index($preferred_order, $prev); 31527ccf41a8SJoe Perches if ($curindex < 0) { 31537ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 31547ccf41a8SJoe Perches "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr); 31557ccf41a8SJoe Perches } else { 31567ccf41a8SJoe Perches if ($previndex >= 0 && $curindex < $previndex) { 31577ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 31587ccf41a8SJoe Perches "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev); 31597ccf41a8SJoe Perches } elsif ((($prev eq 'F' && $cur eq 'F') || 31607ccf41a8SJoe Perches ($prev eq 'X' && $cur eq 'X')) && 31617ccf41a8SJoe Perches ($prevval cmp $curval) > 0) { 31627ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 31637ccf41a8SJoe Perches "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev); 31647ccf41a8SJoe Perches } 31657ccf41a8SJoe Perches } 31667ccf41a8SJoe Perches } 31677ccf41a8SJoe Perches } 3168628f91a2SJoe Perches 3169327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 3170327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 3171327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 3172327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 3173327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 3174327953e9SChristoph Jaeger } 3175327953e9SChristoph Jaeger 3176c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 3177c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 3178c68e5878SArnaud Lacombe my $flag = $1; 3179c68e5878SArnaud Lacombe my $replacement = { 3180c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 3181c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 3182c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 3183c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 3184c68e5878SArnaud Lacombe }; 3185c68e5878SArnaud Lacombe 3186c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 3187c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 3188c68e5878SArnaud Lacombe } 3189c68e5878SArnaud Lacombe 3190bff5da43SRob Herring# check for DT compatible documentation 31917dd05b38SFlorian Vaussard if (defined $root && 31927dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 31937dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 31947dd05b38SFlorian Vaussard 3195bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 3196bff5da43SRob Herring 3197cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 3198852d095dSRob Herring my $vp_file = $dt_path . "vendor-prefixes.yaml"; 3199cc93319bSFlorian Vaussard 3200bff5da43SRob Herring foreach my $compat (@compats) { 3201bff5da43SRob Herring my $compat2 = $compat; 3202185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 3203185d566bSRob Herring my $compat3 = $compat; 3204185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 3205185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 3206bff5da43SRob Herring if ( $? >> 8 ) { 3207bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3208bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 3209bff5da43SRob Herring } 3210bff5da43SRob Herring 32114fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 32124fbf32a6SFlorian Vaussard my $vendor = $1; 3213852d095dSRob Herring `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`; 3214bff5da43SRob Herring if ( $? >> 8 ) { 3215bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3216cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 3217bff5da43SRob Herring } 3218bff5da43SRob Herring } 3219bff5da43SRob Herring } 3220bff5da43SRob Herring 32219f3a8992SRob Herring# check for using SPDX license tag at beginning of files 32229f3a8992SRob Herring if ($realline == $checklicenseline) { 32239f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 32249f3a8992SRob Herring $checklicenseline = 2; 32259f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 32269f3a8992SRob Herring my $comment = ""; 32279f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 32289f3a8992SRob Herring $comment = '/*'; 32299f3a8992SRob Herring } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 32309f3a8992SRob Herring $comment = '//'; 3231c8df0ab6SLubomir Rintel } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) { 32329f3a8992SRob Herring $comment = '#'; 32339f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 32349f3a8992SRob Herring $comment = '..'; 32359f3a8992SRob Herring } 32369f3a8992SRob Herring 3237fdf13693SJoe Perches# check SPDX comment style for .[chsS] files 3238fdf13693SJoe Perches if ($realfile =~ /\.[chsS]$/ && 3239fdf13693SJoe Perches $rawline =~ /SPDX-License-Identifier:/ && 3240ffbce897SJoe Perches $rawline !~ m@^\+\s*\Q$comment\E\s*@) { 3241fdf13693SJoe Perches WARN("SPDX_LICENSE_TAG", 3242fdf13693SJoe Perches "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr); 3243fdf13693SJoe Perches } 3244fdf13693SJoe Perches 32459f3a8992SRob Herring if ($comment !~ /^$/ && 3246ffbce897SJoe Perches $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) { 32479f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 32489f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 32493b6e8ac9SJoe Perches } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) { 32503b6e8ac9SJoe Perches my $spdx_license = $1; 32513b6e8ac9SJoe Perches if (!is_SPDX_License_valid($spdx_license)) { 32523b6e8ac9SJoe Perches WARN("SPDX_LICENSE_TAG", 32533b6e8ac9SJoe Perches "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr); 32543b6e8ac9SJoe Perches } 325550c92900SLubomir Rintel if ($realfile =~ m@^Documentation/devicetree/bindings/@ && 325650c92900SLubomir Rintel not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) { 325750c92900SLubomir Rintel my $msg_level = \&WARN; 325850c92900SLubomir Rintel $msg_level = \&CHK if ($file); 325950c92900SLubomir Rintel if (&{$msg_level}("SPDX_LICENSE_TAG", 326050c92900SLubomir Rintel 326150c92900SLubomir Rintel "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) && 326250c92900SLubomir Rintel $fix) { 326350c92900SLubomir Rintel $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/; 326450c92900SLubomir Rintel } 326550c92900SLubomir Rintel } 32669f3a8992SRob Herring } 32679f3a8992SRob Herring } 32689f3a8992SRob Herring } 32699f3a8992SRob Herring 32705368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 3271d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 32725368df20SAndy Whitcroft 3273a8da38a9SJoe Perches# check for using SPDX-License-Identifier on the wrong line number 3274a8da38a9SJoe Perches if ($realline != $checklicenseline && 3275a8da38a9SJoe Perches $rawline =~ /\bSPDX-License-Identifier:/ && 3276a8da38a9SJoe Perches substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) { 3277a8da38a9SJoe Perches WARN("SPDX_LICENSE_TAG", 3278a8da38a9SJoe Perches "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr); 3279a8da38a9SJoe Perches } 3280a8da38a9SJoe Perches 328147e0c88bSJoe Perches# line length limit (with some exclusions) 328247e0c88bSJoe Perches# 328347e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 328447e0c88bSJoe Perches# logging functions like pr_info that end in a string 328547e0c88bSJoe Perches# lines with a single string 328647e0c88bSJoe Perches# #defines that are a single string 32872e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 328847e0c88bSJoe Perches# 328947e0c88bSJoe Perches# There are 3 different line length message types: 3290ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 329147e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 329247e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 329347e0c88bSJoe Perches# 329447e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 329547e0c88bSJoe Perches# 329647e0c88bSJoe Perches 3297b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 329847e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 329947e0c88bSJoe Perches 330047e0c88bSJoe Perches # Check the allowed long line types first 330147e0c88bSJoe Perches 330247e0c88bSJoe Perches # logging functions that end in a string that starts 330347e0c88bSJoe Perches # before $max_line_length 330447e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 330547e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 330647e0c88bSJoe Perches $msg_type = ""; 330747e0c88bSJoe Perches 330847e0c88bSJoe Perches # lines with only strings (w/ possible termination) 330947e0c88bSJoe Perches # #defines with only strings 331047e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 331147e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 331247e0c88bSJoe Perches $msg_type = ""; 331347e0c88bSJoe Perches 3314cc147506SJoe Perches # More special cases 3315cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3316cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3317d560a5f8SJoe Perches $msg_type = ""; 3318d560a5f8SJoe Perches 33192e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 33202e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 33212e4bbbc5SAndreas Brauchli $msg_type = ""; 33222e4bbbc5SAndreas Brauchli 332347e0c88bSJoe Perches # Otherwise set the alternate message types 332447e0c88bSJoe Perches 332547e0c88bSJoe Perches # a comment starts before $max_line_length 332647e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 332747e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 332847e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 332947e0c88bSJoe Perches 333047e0c88bSJoe Perches # a quoted string starts before $max_line_length 333147e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 333247e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 333347e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 333447e0c88bSJoe Perches } 333547e0c88bSJoe Perches 333647e0c88bSJoe Perches if ($msg_type ne "" && 333747e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 3338bdc48fa1SJoe Perches my $msg_level = \&WARN; 3339bdc48fa1SJoe Perches $msg_level = \&CHK if ($file); 3340bdc48fa1SJoe Perches &{$msg_level}($msg_type, 3341bdc48fa1SJoe Perches "line length of $length exceeds $max_line_length columns\n" . $herecurr); 33420a920b5bSAndy Whitcroft } 334347e0c88bSJoe Perches } 33440a920b5bSAndy Whitcroft 33458905a67cSAndy Whitcroft# check for adding lines without a newline. 33468905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 3347000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 3348000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 33498905a67cSAndy Whitcroft } 33508905a67cSAndy Whitcroft 3351b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3352de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 33530a920b5bSAndy Whitcroft 33540a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 3355713a09deSAntonio Borneo# more than $tabsize must use tabs. 3356c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3357c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3358c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3359d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 33603705ce5bSJoe Perches if (ERROR("CODE_INDENT", 33613705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 33623705ce5bSJoe Perches $fix) { 3363194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 33643705ce5bSJoe Perches } 33650a920b5bSAndy Whitcroft } 33660a920b5bSAndy Whitcroft 336708e44365SAlberto Panizzo# check for space before tabs. 336808e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 336908e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 33703705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 33713705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 33723705ce5bSJoe Perches $fix) { 3373194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3374713a09deSAntonio Borneo s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} 3375194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3376c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 33773705ce5bSJoe Perches } 337808e44365SAlberto Panizzo } 337908e44365SAlberto Panizzo 33806a487211SJoe Perches# check for assignments on the start of a line 33816a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 33826a487211SJoe Perches CHK("ASSIGNMENT_CONTINUATIONS", 33836a487211SJoe Perches "Assignment operator '$1' should be on the previous line\n" . $hereprev); 33846a487211SJoe Perches } 33856a487211SJoe Perches 3386d1fe9c09SJoe Perches# check for && or || at the start of a line 3387d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 3388d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 3389d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 3390d1fe9c09SJoe Perches } 3391d1fe9c09SJoe Perches 3392a91e8994SJoe Perches# check indentation starts on a tab stop 33935b57980dSJoe Perches if ($perl_version_ok && 3394bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3395a91e8994SJoe Perches my $indent = length($1); 3396713a09deSAntonio Borneo if ($indent % $tabsize) { 3397a91e8994SJoe Perches if (WARN("TABSTOP", 3398a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3399a91e8994SJoe Perches $fix) { 3400713a09deSAntonio Borneo $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; 3401a91e8994SJoe Perches } 3402a91e8994SJoe Perches } 3403a91e8994SJoe Perches } 3404a91e8994SJoe Perches 3405d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 34065b57980dSJoe Perches if ($perl_version_ok && 3407fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3408d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3409d1fe9c09SJoe Perches my $oldindent = $1; 3410d1fe9c09SJoe Perches my $rest = $2; 3411d1fe9c09SJoe Perches 3412d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3413d1fe9c09SJoe Perches if ($pos >= 0) { 3414b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3415b34a26f3SJoe Perches my $newindent = $2; 3416d1fe9c09SJoe Perches 3417d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3418713a09deSAntonio Borneo "\t" x ($pos / $tabsize) . 3419713a09deSAntonio Borneo " " x ($pos % $tabsize); 3420d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3421d1fe9c09SJoe Perches 3422d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3423d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 34243705ce5bSJoe Perches 34253705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 34263705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 34273705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3428194f66fcSJoe Perches $fixed[$fixlinenr] =~ 34293705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 34303705ce5bSJoe Perches } 3431d1fe9c09SJoe Perches } 3432d1fe9c09SJoe Perches } 3433d1fe9c09SJoe Perches } 3434d1fe9c09SJoe Perches 34356ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 34366ab3a970SJoe Perches# avoid checking a few false positives: 34376ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 34386ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 34396ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 34406ab3a970SJoe Perches# multiline macros that define functions 34416ab3a970SJoe Perches# known attributes or the __attribute__ keyword 34426ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 34436ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 34443705ce5bSJoe Perches if (CHK("SPACING", 3445f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 34463705ce5bSJoe Perches $fix) { 3447194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3448f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 34493705ce5bSJoe Perches } 3450aad4f614SJoe Perches } 3451aad4f614SJoe Perches 345286406b1cSJoe Perches# Block comment styles 345386406b1cSJoe Perches# Networking with an initial /* 345405880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3455fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 345685ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 345785ad978cSJoe Perches $realline > 2) { 345805880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 345905880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 346005880600SJoe Perches } 346105880600SJoe Perches 346286406b1cSJoe Perches# Block comments use * on subsequent lines 346386406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 346486406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3465a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 346661135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3467a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 346886406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 346986406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3470a605e32eSJoe Perches } 3471a605e32eSJoe Perches 347286406b1cSJoe Perches# Block comments use */ on trailing lines 347386406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3474c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3475c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3476c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 347786406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 347886406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 347905880600SJoe Perches } 348005880600SJoe Perches 348108eb9b80SJoe Perches# Block comment * alignment 348208eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3483af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3484af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3485af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 348608eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3487af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3488af207524SJoe Perches my $oldindent; 348908eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3490af207524SJoe Perches if (defined($1)) { 3491af207524SJoe Perches $oldindent = expand_tabs($1); 3492af207524SJoe Perches } else { 3493af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3494af207524SJoe Perches $oldindent = expand_tabs($1); 3495af207524SJoe Perches } 349608eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 349708eb9b80SJoe Perches my $newindent = $1; 349808eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3499af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 350008eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 350108eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 350208eb9b80SJoe Perches } 350308eb9b80SJoe Perches } 350408eb9b80SJoe Perches 35057f619191SJoe Perches# check for missing blank lines after struct/union declarations 35067f619191SJoe Perches# with exceptions for various attributes and macros 35077f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 35087f619191SJoe Perches $line =~ /^\+/ && 35097f619191SJoe Perches !($line =~ /^\+\s*$/ || 35107f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 35117f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 35127f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 35137f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 35147f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 35157f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 35160bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 35177f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3518d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3519d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3520d752fcc8SJoe Perches $fix) { 3521f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3522d752fcc8SJoe Perches } 35237f619191SJoe Perches } 35247f619191SJoe Perches 3525365dd4eaSJoe Perches# check for multiple consecutive blank lines 3526365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3527365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3528365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3529d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3530d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3531d752fcc8SJoe Perches $fix) { 3532f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3533d752fcc8SJoe Perches } 3534d752fcc8SJoe Perches 3535365dd4eaSJoe Perches $last_blank_line = $linenr; 3536365dd4eaSJoe Perches } 3537365dd4eaSJoe Perches 35383b617e3bSJoe Perches# check for missing blank lines after declarations 35393f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 35403f7bac03SJoe Perches # actual declarations 35413f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 35425a4e1fd3SJoe Perches # function pointer declarations 35435a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 35443f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 35453f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 35463f7bac03SJoe Perches # known declaration macros 35473f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 35483f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 35493f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 35503f7bac03SJoe Perches # other possible extensions of declaration lines 35513f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 35523f7bac03SJoe Perches # not starting a section or a macro "\" extended line 35533f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 35543f7bac03SJoe Perches # looks like a declaration 35553f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 35565a4e1fd3SJoe Perches # function pointer declarations 35575a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 35583f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 35593f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 35603f7bac03SJoe Perches # known declaration macros 35613f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 35623f7bac03SJoe Perches # start of struct or union or enum 3563328b5f41SJoe Perches $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ || 35643f7bac03SJoe Perches # start or end of block or continuation of declaration 35653f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 35663f7bac03SJoe Perches # bitfield continuation 35673f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 35683f7bac03SJoe Perches # other possible extensions of declaration lines 35693f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 35703f7bac03SJoe Perches # indentation of previous and current line are the same 35713f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3572d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3573d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3574d752fcc8SJoe Perches $fix) { 3575f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3576d752fcc8SJoe Perches } 35773b617e3bSJoe Perches } 35783b617e3bSJoe Perches 35795f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 35806b4c5bebSAndy Whitcroft# Exceptions: 35816b4c5bebSAndy Whitcroft# 1) within comments 35826b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 35836b4c5bebSAndy Whitcroft# 3) hanging labels 35843705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 35855f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 35863705ce5bSJoe Perches if (WARN("LEADING_SPACE", 35873705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 35883705ce5bSJoe Perches $fix) { 3589194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 35903705ce5bSJoe Perches } 35915f7ddae6SRaffaele Recalcati } 35925f7ddae6SRaffaele Recalcati 3593b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3594b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3595b9ea10d6SAndy Whitcroft 35965751a24eSJoe Perches# check for unusual line ending [ or ( 35975751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 35985751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 35995751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 36005751a24eSJoe Perches } 36015751a24eSJoe Perches 36024dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 36034dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 36044dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 36054dbed76fSJoe Perches $context_function = $1; 36064dbed76fSJoe Perches } 36074dbed76fSJoe Perches 36084dbed76fSJoe Perches# check if this appears to be the end of function declaration 36094dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 36104dbed76fSJoe Perches undef $context_function; 36114dbed76fSJoe Perches } 36124dbed76fSJoe Perches 3613032a4c0fSJoe Perches# check indentation of any line with a bare else 3614840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3615032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3616032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3617032a4c0fSJoe Perches my $tabs = length($1) + 1; 3618840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3619840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3620840080a0SJoe Perches defined $lines[$linenr] && 3621840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3622032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3623032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3624032a4c0fSJoe Perches } 3625032a4c0fSJoe Perches } 3626032a4c0fSJoe Perches 3627c00df19aSJoe Perches# check indentation of a line with a break; 3628c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3629c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3630c00df19aSJoe Perches my $tabs = $1; 3631c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3632c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3633c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3634c00df19aSJoe Perches } 3635c00df19aSJoe Perches } 3636c00df19aSJoe Perches 3637c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3638cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3639000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3640000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3641c2fdda0dSAndy Whitcroft } 364222f2a2efSAndy Whitcroft 364356e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 364456e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 364556e77d70SJoe Perches WARN("HOTPLUG_SECTION", 364656e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 364756e77d70SJoe Perches } 364856e77d70SJoe Perches 36499c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 36502b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 36512b474a1aSAndy Whitcroft $realline_next); 36523e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 3653ca819864SJoe Perches if ($linenr > $suppress_statement && 36541b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3655170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3656f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3657171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3658171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3659171ae1a4SAndy Whitcroft 36603e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 36613e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 36623e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 36633e469cdcSAndy Whitcroft # until we hit end of it. 36643e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 36653e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 36663e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 36673e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 36683e469cdcSAndy Whitcroft } 3669f74bd194SAndy Whitcroft 36702b474a1aSAndy Whitcroft # Find the real next line. 36712b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 36722b474a1aSAndy Whitcroft if (defined $realline_next && 36732b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 36742b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 36752b474a1aSAndy Whitcroft $realline_next++; 36762b474a1aSAndy Whitcroft } 36772b474a1aSAndy Whitcroft 3678171ae1a4SAndy Whitcroft my $s = $stat; 3679171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3680cf655043SAndy Whitcroft 3681c2fdda0dSAndy Whitcroft # Ignore goto labels. 3682171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3683c2fdda0dSAndy Whitcroft 3684c2fdda0dSAndy Whitcroft # Ignore functions being called 3685171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3686c2fdda0dSAndy Whitcroft 3687463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3688463f2864SAndy Whitcroft 3689c45dcabdSAndy Whitcroft # declarations always start with types 3690d2506586SAndy 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) { 3691c45dcabdSAndy Whitcroft my $type = $1; 3692c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3693c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3694c45dcabdSAndy Whitcroft 36956c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3696a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3697c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3698c2fdda0dSAndy Whitcroft } 36998905a67cSAndy Whitcroft 37006c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 370165863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3702c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 37039c0ca6f9SAndy Whitcroft } 37048905a67cSAndy Whitcroft 37058905a67cSAndy Whitcroft # Check for any sort of function declaration. 37068905a67cSAndy Whitcroft # int foo(something bar, other baz); 37078905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3708171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 37098905a67cSAndy Whitcroft my ($name_len) = length($1); 37108905a67cSAndy Whitcroft 3711cf655043SAndy Whitcroft my $ctx = $s; 3712773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 37138905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3714cf655043SAndy Whitcroft 37158905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3716c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 37178905a67cSAndy Whitcroft 3718c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 37198905a67cSAndy Whitcroft } 37208905a67cSAndy Whitcroft } 37218905a67cSAndy Whitcroft } 37228905a67cSAndy Whitcroft 37239c0ca6f9SAndy Whitcroft } 37249c0ca6f9SAndy Whitcroft 372500df344fSAndy Whitcroft# 372600df344fSAndy Whitcroft# Checks which may be anchored in the context. 372700df344fSAndy Whitcroft# 372800df344fSAndy Whitcroft 372900df344fSAndy Whitcroft# Check for switch () and associated case and default 373000df344fSAndy Whitcroft# statements should be at the same indent. 373100df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 373200df344fSAndy Whitcroft my $err = ''; 373300df344fSAndy Whitcroft my $sep = ''; 373400df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 373500df344fSAndy Whitcroft shift(@ctx); 373600df344fSAndy Whitcroft for my $ctx (@ctx) { 373700df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 373800df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 373900df344fSAndy Whitcroft $indent != $cindent) { 374000df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 374100df344fSAndy Whitcroft $sep = ''; 374200df344fSAndy Whitcroft } else { 374300df344fSAndy Whitcroft $sep = "[...]\n"; 374400df344fSAndy Whitcroft } 374500df344fSAndy Whitcroft } 374600df344fSAndy Whitcroft if ($err ne '') { 3747000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3748000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3749de7d4f0eSAndy Whitcroft } 3750de7d4f0eSAndy Whitcroft } 3751de7d4f0eSAndy Whitcroft 3752de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3753de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 37540fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3755773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3756773647a0SAndy Whitcroft 37579c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 37588eef05ddSJoe Perches 37598eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 37608eef05ddSJoe Perches WARN("DEEP_INDENTATION", 37618eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 37628eef05ddSJoe Perches } 37638eef05ddSJoe Perches 3764de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3765de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3766de7d4f0eSAndy Whitcroft 3767548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3768548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3769de7d4f0eSAndy Whitcroft 3770548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3771548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3772548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3773548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3774548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3775773647a0SAndy Whitcroft $ctx_ln++; 3776773647a0SAndy Whitcroft } 3777548596d5SAndy Whitcroft 377853210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 377953210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3780773647a0SAndy Whitcroft 3781773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3782000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3783000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 378401464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 378500df344fSAndy Whitcroft } 3786773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3787773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3788773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3789773647a0SAndy Whitcroft { 37909c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 37919c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3792000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3793000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 379401464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 37959c0ca6f9SAndy Whitcroft } 37969c0ca6f9SAndy Whitcroft } 379700df344fSAndy Whitcroft } 379800df344fSAndy Whitcroft 37994d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 3800f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 38013e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 38023e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 38033e469cdcSAndy Whitcroft if (!defined $stat); 38044d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 38054d001e4dSAndy Whitcroft 38064d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 38074d001e4dSAndy Whitcroft 38089f5af480SJoe Perches # remove inline comments 38099f5af480SJoe Perches $s =~ s/$;/ /g; 38109f5af480SJoe Perches $c =~ s/$;/ /g; 38114d001e4dSAndy Whitcroft 38124d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 38136f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 38146f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 38154d001e4dSAndy Whitcroft 38169f5af480SJoe Perches # Make sure we remove the line prefixes as we have 38179f5af480SJoe Perches # none on the first line, and are going to readd them 38189f5af480SJoe Perches # where necessary. 38199f5af480SJoe Perches $s =~ s/\n./\n/gs; 38209f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 38219f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 38229f5af480SJoe Perches } 38239f5af480SJoe Perches 38244d001e4dSAndy Whitcroft # We want to check the first line inside the block 38254d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 38264d001e4dSAndy Whitcroft # 1) any blank line termination 38274d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 38284d001e4dSAndy Whitcroft # 3) any do (...) { 38294d001e4dSAndy Whitcroft my $continuation = 0; 38304d001e4dSAndy Whitcroft my $check = 0; 38314d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 38324d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 38334d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 38344d001e4dSAndy Whitcroft $continuation = 1; 38354d001e4dSAndy Whitcroft } 38369bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 38374d001e4dSAndy Whitcroft $check = 1; 38384d001e4dSAndy Whitcroft $cond_lines++; 38394d001e4dSAndy Whitcroft } 38404d001e4dSAndy Whitcroft 38414d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 38424d001e4dSAndy Whitcroft # preprocessor statement. 38434d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 38444d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 38454d001e4dSAndy Whitcroft $check = 0; 38464d001e4dSAndy Whitcroft } 38474d001e4dSAndy Whitcroft 38489bd49efeSAndy Whitcroft my $cond_ptr = -1; 3849740504c6SAndy Whitcroft $continuation = 0; 38509bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 38519bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 38524d001e4dSAndy Whitcroft 3853f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3854f16fa28fSAndy Whitcroft # is not linear. 3855f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3856f16fa28fSAndy Whitcroft $check = 0; 3857f16fa28fSAndy Whitcroft } 3858f16fa28fSAndy Whitcroft 38599bd49efeSAndy Whitcroft # Ignore: 38609bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 38619bd49efeSAndy Whitcroft # 2) preprocessor lines, and 38629bd49efeSAndy Whitcroft # 3) labels. 3863740504c6SAndy Whitcroft if ($continuation || 3864740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 38659bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 38669bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3867740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 386830dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 38699bd49efeSAndy Whitcroft $cond_lines++; 38709bd49efeSAndy Whitcroft } 38714d001e4dSAndy Whitcroft } 387230dad6ebSAndy Whitcroft } 38734d001e4dSAndy Whitcroft 38744d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 38754d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 38764d001e4dSAndy Whitcroft 38774d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 38784d001e4dSAndy Whitcroft # this is not this patch's fault. 38794d001e4dSAndy Whitcroft if (!defined($stat_real) || 38804d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 38814d001e4dSAndy Whitcroft $check = 0; 38824d001e4dSAndy Whitcroft } 38834d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 38844d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 38854d001e4dSAndy Whitcroft } 38864d001e4dSAndy Whitcroft 38879bd49efeSAndy 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"; 38884d001e4dSAndy Whitcroft 38899f5af480SJoe Perches if ($check && $s ne '' && 3890713a09deSAntonio Borneo (($sindent % $tabsize) != 0 || 38919f5af480SJoe Perches ($sindent < $indent) || 3892f6950a73SJoe Perches ($sindent == $indent && 3893f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 3894713a09deSAntonio Borneo ($sindent > $indent + $tabsize))) { 3895000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3896000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 38974d001e4dSAndy Whitcroft } 38984d001e4dSAndy Whitcroft } 38994d001e4dSAndy Whitcroft 39006c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 39016c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 39021f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 39031f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 39046c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3905c2fdda0dSAndy Whitcroft if ($dbg_values) { 3906c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3907cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3908cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 39091f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3910c2fdda0dSAndy Whitcroft } 39116c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 39126c72ffaaSAndy Whitcroft 391300df344fSAndy Whitcroft#ignore lines not being added 39143705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 391500df344fSAndy Whitcroft 391699ca38c2SJoe Perches# check for self assignments used to avoid compiler warnings 391799ca38c2SJoe Perches# e.g.: int foo = foo, *bar = NULL; 391899ca38c2SJoe Perches# struct foo bar = *(&(bar)); 391999ca38c2SJoe Perches if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) { 392099ca38c2SJoe Perches my $var = $1; 392199ca38c2SJoe Perches if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) { 392299ca38c2SJoe Perches WARN("SELF_ASSIGNMENT", 392399ca38c2SJoe Perches "Do not use self-assignments to avoid compiler warnings\n" . $herecurr); 392499ca38c2SJoe Perches } 392599ca38c2SJoe Perches } 392699ca38c2SJoe Perches 392711ca40a0SJoe Perches# check for dereferences that span multiple lines 392811ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 392911ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 393011ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 393111ca40a0SJoe Perches my $ref = $1; 393211ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 393311ca40a0SJoe Perches $ref .= $1; 393411ca40a0SJoe Perches $ref =~ s/\s//g; 393511ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 393611ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 393711ca40a0SJoe Perches } 393811ca40a0SJoe Perches 3939a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3940c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3941a1ce18e4SJoe Perches my $type = $1; 3942a1ce18e4SJoe Perches my $var = $2; 3943207a8e84SJoe Perches $var = "" if (!defined $var); 3944207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3945a1ce18e4SJoe Perches my $sign = $1; 3946a1ce18e4SJoe Perches my $pointer = $2; 3947a1ce18e4SJoe Perches 3948a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3949a1ce18e4SJoe Perches 3950a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3951a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3952a1ce18e4SJoe Perches $fix) { 3953a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3954207a8e84SJoe Perches my $comp_pointer = $pointer; 3955207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 3956207a8e84SJoe Perches $decl .= $comp_pointer; 3957207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 3958207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 3959a1ce18e4SJoe Perches } 3960a1ce18e4SJoe Perches } 3961a1ce18e4SJoe Perches } 3962a1ce18e4SJoe Perches 3963653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 39647429c690SAndy Whitcroft if ($dbg_type) { 39657429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3966000d1cc1SJoe Perches ERROR("TEST_TYPE", 3967000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 39687429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3969000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3970000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 39717429c690SAndy Whitcroft } 3972653d4876SAndy Whitcroft next; 3973653d4876SAndy Whitcroft } 3974a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3975a1ef277eSAndy Whitcroft if ($dbg_attr) { 39769360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3977000d1cc1SJoe Perches ERROR("TEST_ATTR", 3978000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 39799360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3980000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3981000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3982a1ef277eSAndy Whitcroft } 3983a1ef277eSAndy Whitcroft next; 3984a1ef277eSAndy Whitcroft } 3985653d4876SAndy Whitcroft 3986f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 398799423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 398899423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3989d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3990d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3991f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3992f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3993f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3994d752fcc8SJoe Perches my $fixedline = $prevrawline; 3995d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3996f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3997d752fcc8SJoe Perches $fixedline = $line; 39988d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 3999f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 4000d752fcc8SJoe Perches } 4001f0a594c1SAndy Whitcroft } 4002f0a594c1SAndy Whitcroft 400300df344fSAndy Whitcroft# 400400df344fSAndy Whitcroft# Checks which are anchored on the added line. 400500df344fSAndy Whitcroft# 400600df344fSAndy Whitcroft 4007653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 4008c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 4009653d4876SAndy Whitcroft my $path = $1; 4010653d4876SAndy Whitcroft if ($path =~ m{//}) { 4011000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 4012495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 4013495e9d84SJoe Perches } 4014495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 4015495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 4016495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 4017653d4876SAndy Whitcroft } 4018653d4876SAndy Whitcroft } 4019653d4876SAndy Whitcroft 402000df344fSAndy Whitcroft# no C99 // comments 402100df344fSAndy Whitcroft if ($line =~ m{//}) { 40223705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 40233705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 40243705ce5bSJoe Perches $fix) { 4025194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 40263705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 40273705ce5bSJoe Perches my $comment = trim($1); 4028194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 40293705ce5bSJoe Perches } 40303705ce5bSJoe Perches } 403100df344fSAndy Whitcroft } 403200df344fSAndy Whitcroft # Remove C99 comments. 40330a920b5bSAndy Whitcroft $line =~ s@//.*@@; 40346c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 40350a920b5bSAndy Whitcroft 40362b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 40372b474a1aSAndy Whitcroft# the whole statement. 40382b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 40392b474a1aSAndy Whitcroft if (defined $realline_next && 40402b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 40412b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 40422b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 40432b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 40443cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 40453cbf62dfSAndy Whitcroft # a prefix: 40463cbf62dfSAndy Whitcroft # XXX(foo); 40473cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 4048653d4876SAndy Whitcroft my $name = $1; 404987a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 40503cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 40513cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 40523cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 40533cbf62dfSAndy Whitcroft 40543cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 40552b474a1aSAndy Whitcroft \n.}\s*$| 405648012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 405748012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 405848012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 40592b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 40602b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 406148012058SAndy Whitcroft )/x) { 40622b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 40632b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 40642b474a1aSAndy Whitcroft } else { 40652b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 40660a920b5bSAndy Whitcroft } 40670a920b5bSAndy Whitcroft } 40682b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 40692b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 40702b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 40712b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 40722b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 40732b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 40742b474a1aSAndy Whitcroft } 40752b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 40762b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 4077000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 4078000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 40792b474a1aSAndy Whitcroft } 40800a920b5bSAndy Whitcroft 40815150bda4SJoe Eloff# check for global initialisers. 40826d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 4083d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 40846d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 4085d5e616fcSJoe Perches $fix) { 40866d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 4087d5e616fcSJoe Perches } 4088f0a594c1SAndy Whitcroft } 40890a920b5bSAndy Whitcroft# check for static initialisers. 40906d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 4091d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 40926d32f7a3SJoe Perches "do not initialise statics to $1\n" . 4093d5e616fcSJoe Perches $herecurr) && 4094d5e616fcSJoe Perches $fix) { 40956d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 4096d5e616fcSJoe Perches } 40970a920b5bSAndy Whitcroft } 40980a920b5bSAndy Whitcroft 40991813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 41001813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 41011813087dSJoe Perches my $tmp = trim($1); 41021813087dSJoe Perches WARN("MISORDERED_TYPE", 41031813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 41041813087dSJoe Perches } 41051813087dSJoe Perches 4106809e082eSJoe Perches# check for unnecessary <signed> int declarations of short/long/long long 4107809e082eSJoe Perches while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) { 4108809e082eSJoe Perches my $type = trim($1); 4109809e082eSJoe Perches next if ($type !~ /\bint\b/); 4110809e082eSJoe Perches next if ($type !~ /\b(?:short|long\s+long|long)\b/); 4111809e082eSJoe Perches my $new_type = $type; 4112809e082eSJoe Perches $new_type =~ s/\b\s*int\s*\b/ /; 4113809e082eSJoe Perches $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /; 4114809e082eSJoe Perches $new_type =~ s/^const\s+//; 4115809e082eSJoe Perches $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/); 4116809e082eSJoe Perches $new_type = "const $new_type" if ($type =~ /^const\b/); 4117809e082eSJoe Perches $new_type =~ s/\s+/ /g; 4118809e082eSJoe Perches $new_type = trim($new_type); 4119809e082eSJoe Perches if (WARN("UNNECESSARY_INT", 4120809e082eSJoe Perches "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) && 4121809e082eSJoe Perches $fix) { 4122809e082eSJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/; 4123809e082eSJoe Perches } 4124809e082eSJoe Perches } 4125809e082eSJoe Perches 4126cb710ecaSJoe Perches# check for static const char * arrays. 4127cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 4128000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4129000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 4130cb710ecaSJoe Perches $herecurr); 4131cb710ecaSJoe Perches } 4132cb710ecaSJoe Perches 413377b8c0a8SJoe Perches# check for initialized const char arrays that should be static const 413477b8c0a8SJoe Perches if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) { 413577b8c0a8SJoe Perches if (WARN("STATIC_CONST_CHAR_ARRAY", 413677b8c0a8SJoe Perches "const array should probably be static const\n" . $herecurr) && 413777b8c0a8SJoe Perches $fix) { 413877b8c0a8SJoe Perches $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/; 413977b8c0a8SJoe Perches } 414077b8c0a8SJoe Perches } 414177b8c0a8SJoe Perches 4142cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 4143cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 4144000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4145000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 4146cb710ecaSJoe Perches $herecurr); 4147cb710ecaSJoe Perches } 4148cb710ecaSJoe Perches 4149ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 4150ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 4151ab7e23f3SJoe Perches my $found = $1; 4152ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 4153ab7e23f3SJoe Perches WARN("CONST_CONST", 4154ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 4155ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 4156ab7e23f3SJoe Perches WARN("CONST_CONST", 4157ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 4158ab7e23f3SJoe Perches } 4159ab7e23f3SJoe Perches } 4160ab7e23f3SJoe Perches 41619b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 41629b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 41639b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 41649b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 41659b0fa60dSJoe Perches $herecurr); 41669b0fa60dSJoe Perches } 41679b0fa60dSJoe Perches 4168b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 4169b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 4170b598b670SJoe Perches my $array = $1; 4171b598b670SJoe 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*\))@) { 4172b598b670SJoe Perches my $array_div = $1; 4173b598b670SJoe Perches if (WARN("ARRAY_SIZE", 4174b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 4175b598b670SJoe Perches $fix) { 4176b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 4177b598b670SJoe Perches } 4178b598b670SJoe Perches } 4179b598b670SJoe Perches } 4180b598b670SJoe Perches 4181b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 418216b7f3c8SJoe Perches if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) { 4183b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 4184b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 4185b36190c5SJoe Perches $fix) { 4186194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 4187b36190c5SJoe Perches } 4188b36190c5SJoe Perches } 4189b36190c5SJoe Perches 4190653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 4191653d4876SAndy Whitcroft# make sense. 4192653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 41938054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 4194c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 41958ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 419646d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 4197000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 4198000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 41990a920b5bSAndy Whitcroft } 42000a920b5bSAndy Whitcroft 42010a920b5bSAndy Whitcroft# * goes on variable not on type 420265863862SAndy Whitcroft # (char*[ const]) 4203bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 4204bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 42053705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 4206d8aaf121SAndy Whitcroft 420765863862SAndy Whitcroft # Should start with a space. 420865863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 420965863862SAndy Whitcroft # Should not end with a space. 421065863862SAndy Whitcroft $to =~ s/\s+$//; 421165863862SAndy Whitcroft # '*'s should not have spaces between. 4212f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 421365863862SAndy Whitcroft } 4214d8aaf121SAndy Whitcroft 42153705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 421665863862SAndy Whitcroft if ($from ne $to) { 42173705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 42183705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 42193705ce5bSJoe Perches $fix) { 42203705ce5bSJoe Perches my $sub_from = $ident; 42213705ce5bSJoe Perches my $sub_to = $ident; 42223705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4223194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42243705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 42253705ce5bSJoe Perches } 422665863862SAndy Whitcroft } 4227bfcb2cc7SAndy Whitcroft } 4228bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 4229bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 42303705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 4231d8aaf121SAndy Whitcroft 423265863862SAndy Whitcroft # Should start with a space. 423365863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 423465863862SAndy Whitcroft # Should not end with a space. 423565863862SAndy Whitcroft $to =~ s/\s+$//; 423665863862SAndy Whitcroft # '*'s should not have spaces between. 4237f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 423865863862SAndy Whitcroft } 423965863862SAndy Whitcroft # Modifiers should have spaces. 424065863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 424165863862SAndy Whitcroft 42423705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 4243667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 42443705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 42453705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 42463705ce5bSJoe Perches $fix) { 42473705ce5bSJoe Perches 42483705ce5bSJoe Perches my $sub_from = $match; 42493705ce5bSJoe Perches my $sub_to = $match; 42503705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4251194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42523705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 42533705ce5bSJoe Perches } 425465863862SAndy Whitcroft } 42550a920b5bSAndy Whitcroft } 42560a920b5bSAndy Whitcroft 42579d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 42589d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 42590675a8fbSJean Delvare my $msg_level = \&WARN; 42600675a8fbSJean Delvare $msg_level = \&CHK if ($file); 42610675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 42629d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 42639d3e3c70SJoe Perches } 42640a920b5bSAndy Whitcroft 42659d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 42668905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 4267000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 4268000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 42698905a67cSAndy Whitcroft } 42708905a67cSAndy Whitcroft 427117441227SJoe Perches# check for uses of printk_ratelimit 427217441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 4273000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 4274000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 427517441227SJoe Perches } 427617441227SJoe Perches 4277eeef5733SJoe Perches# printk should use KERN_* levels 4278eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 4279000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 4280eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 428100df344fSAndy Whitcroft } 42820a920b5bSAndy Whitcroft 4283243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 4284243f3803SJoe Perches my $orig = $1; 4285243f3803SJoe Perches my $level = lc($orig); 4286243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 42878f26b837SJoe Perches my $level2 = $level; 42888f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 4289243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 4290daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 4291243f3803SJoe Perches } 4292243f3803SJoe Perches 4293dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 4294dc139313SJoe Perches my $orig = $1; 4295dc139313SJoe Perches my $level = lc($orig); 4296dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 4297dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 4298dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 4299dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 4300dc139313SJoe Perches } 4301dc139313SJoe Perches 43028020b253SNicolas Boichat# trace_printk should not be used in production code. 43038020b253SNicolas Boichat if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) { 43048020b253SNicolas Boichat WARN("TRACE_PRINTK", 43058020b253SNicolas Boichat "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr); 43068020b253SNicolas Boichat } 43078020b253SNicolas Boichat 430891c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 430991c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 431091c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 431191c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 431291c9afafSAndy Lutomirski WARN("ENOSYS", 431391c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 431491c9afafSAndy Lutomirski } 431591c9afafSAndy Lutomirski 43166b9ea5ffSJakub Kicinski# ENOTSUPP is not a standard error code and should be avoided in new patches. 43176b9ea5ffSJakub Kicinski# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP. 43186b9ea5ffSJakub Kicinski# Similarly to ENOSYS warning a small number of false positives is expected. 43196b9ea5ffSJakub Kicinski if (!$file && $line =~ /\bENOTSUPP\b/) { 43206b9ea5ffSJakub Kicinski if (WARN("ENOTSUPP", 43216b9ea5ffSJakub Kicinski "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) && 43226b9ea5ffSJakub Kicinski $fix) { 43236b9ea5ffSJakub Kicinski $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/; 43246b9ea5ffSJakub Kicinski } 43256b9ea5ffSJakub Kicinski } 43266b9ea5ffSJakub Kicinski 4327653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 4328653d4876SAndy Whitcroft# or if closed on same line 43295b57980dSJoe Perches if ($perl_version_ok && 43302d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 43312d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 43322d453e3bSJoe Perches $sline !~ /}/) { 43338d182478SJoe Perches if (ERROR("OPEN_BRACE", 43342d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 43358d182478SJoe Perches $fix) { 43368d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 43378d182478SJoe Perches my $fixed_line = $rawline; 43388d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 43398d182478SJoe Perches my $line1 = $1; 43408d182478SJoe Perches my $line2 = $2; 43418d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 43428d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 43438d182478SJoe Perches if ($line2 !~ /^\s*$/) { 43448d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 43458d182478SJoe Perches } 43468d182478SJoe Perches } 43470a920b5bSAndy Whitcroft } 4348653d4876SAndy Whitcroft 43498905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 43508905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 43518905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 43528d182478SJoe Perches if (ERROR("OPEN_BRACE", 43538d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 43548d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 43558d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 43568d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 43578d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 43588d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 43598d182478SJoe Perches $fixedline = $rawline; 43608d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 43618d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 43628d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 43638d182478SJoe Perches } 43648d182478SJoe Perches } 43658905a67cSAndy Whitcroft } 43668905a67cSAndy Whitcroft 43670c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 43683705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 43693705ce5bSJoe Perches if (WARN("SPACING", 43703705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 43713705ce5bSJoe Perches $fix) { 4372194f66fcSJoe Perches $fixed[$fixlinenr] =~ 43733705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 43743705ce5bSJoe Perches } 43750c73b4ebSAndy Whitcroft } 43760c73b4ebSAndy Whitcroft 437731070b5dSJoe Perches# Function pointer declarations 437831070b5dSJoe Perches# check spacing between type, funcptr, and args 437931070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 438091f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 438131070b5dSJoe Perches my $declare = $1; 438231070b5dSJoe Perches my $pre_pointer_space = $2; 438331070b5dSJoe Perches my $post_pointer_space = $3; 438431070b5dSJoe Perches my $funcname = $4; 438531070b5dSJoe Perches my $post_funcname_space = $5; 438631070b5dSJoe Perches my $pre_args_space = $6; 438731070b5dSJoe Perches 438891f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 438991f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 439091f72e9cSJoe Perches# don't need a space so don't warn for those. 439191f72e9cSJoe Perches my $post_declare_space = ""; 439291f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 439391f72e9cSJoe Perches $post_declare_space = $1; 439491f72e9cSJoe Perches $declare = rtrim($declare); 439591f72e9cSJoe Perches } 439691f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 439731070b5dSJoe Perches WARN("SPACING", 439831070b5dSJoe Perches "missing space after return type\n" . $herecurr); 439991f72e9cSJoe Perches $post_declare_space = " "; 440031070b5dSJoe Perches } 440131070b5dSJoe Perches 440231070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 440391f72e9cSJoe Perches# This test is not currently implemented because these declarations are 440491f72e9cSJoe Perches# equivalent to 440591f72e9cSJoe Perches# int foo(int bar, ...) 440691f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 440791f72e9cSJoe Perches# 440891f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 440991f72e9cSJoe Perches# WARN("SPACING", 441091f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 441191f72e9cSJoe Perches# } 441231070b5dSJoe Perches 441331070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 441431070b5dSJoe Perches if (defined $pre_pointer_space && 441531070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 441631070b5dSJoe Perches WARN("SPACING", 441731070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 441831070b5dSJoe Perches } 441931070b5dSJoe Perches 442031070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 442131070b5dSJoe Perches if (defined $post_pointer_space && 442231070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 442331070b5dSJoe Perches WARN("SPACING", 442431070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 442531070b5dSJoe Perches } 442631070b5dSJoe Perches 442731070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 442831070b5dSJoe Perches if (defined $post_funcname_space && 442931070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 443031070b5dSJoe Perches WARN("SPACING", 443131070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 443231070b5dSJoe Perches } 443331070b5dSJoe Perches 443431070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 443531070b5dSJoe Perches if (defined $pre_args_space && 443631070b5dSJoe Perches $pre_args_space =~ /^\s/) { 443731070b5dSJoe Perches WARN("SPACING", 443831070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 443931070b5dSJoe Perches } 444031070b5dSJoe Perches 444131070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4442194f66fcSJoe Perches $fixed[$fixlinenr] =~ 444391f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 444431070b5dSJoe Perches } 444531070b5dSJoe Perches } 444631070b5dSJoe Perches 44478d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 44488d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4449fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4450fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 44518d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 44528d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 44538d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4454fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 445538dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 44563705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 44573705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 44583705ce5bSJoe Perches $fix) { 4459194f66fcSJoe Perches $fixed[$fixlinenr] =~ 44603705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 44613705ce5bSJoe Perches } 44628d31cfceSAndy Whitcroft } 44638d31cfceSAndy Whitcroft } 44648d31cfceSAndy Whitcroft 4465f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 44666c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4467c2fdda0dSAndy Whitcroft my $name = $1; 4468773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4469773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4470c2fdda0dSAndy Whitcroft 4471c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4472773647a0SAndy Whitcroft if ($name =~ /^(?: 4473773647a0SAndy Whitcroft if|for|while|switch|return|case| 4474773647a0SAndy Whitcroft volatile|__volatile__| 4475773647a0SAndy Whitcroft __attribute__|format|__extension__| 4476773647a0SAndy Whitcroft asm|__asm__)$/x) 4477773647a0SAndy Whitcroft { 4478c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4479c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4480c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4481c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4482773647a0SAndy Whitcroft 4483773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4484c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4485c2fdda0dSAndy Whitcroft 4486c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4487c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4488773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4489c2fdda0dSAndy Whitcroft 4490c2fdda0dSAndy Whitcroft } else { 44913705ce5bSJoe Perches if (WARN("SPACING", 44923705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 44933705ce5bSJoe Perches $fix) { 4494194f66fcSJoe Perches $fixed[$fixlinenr] =~ 44953705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 44963705ce5bSJoe Perches } 4497f0a594c1SAndy Whitcroft } 44986c72ffaaSAndy Whitcroft } 44999a4cad4eSEric Nelson 4500653d4876SAndy Whitcroft# Check operator spacing. 45010a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 45023705ce5bSJoe Perches my $fixed_line = ""; 45033705ce5bSJoe Perches my $line_fixed = 0; 45043705ce5bSJoe Perches 45059c0ca6f9SAndy Whitcroft my $ops = qr{ 45069c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 45079c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 45089c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 45091f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 451084731623SJoe Perches \?:|\?|: 45119c0ca6f9SAndy Whitcroft }x; 4512cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 45133705ce5bSJoe Perches 45143705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 45153705ce5bSJoe Perches## foreach my $el (@elements) { 45163705ce5bSJoe Perches## print("el: <$el>\n"); 45173705ce5bSJoe Perches## } 45183705ce5bSJoe Perches 45193705ce5bSJoe Perches my @fix_elements = (); 452000df344fSAndy Whitcroft my $off = 0; 45216c72ffaaSAndy Whitcroft 45223705ce5bSJoe Perches foreach my $el (@elements) { 45233705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 45243705ce5bSJoe Perches $off += length($el); 45253705ce5bSJoe Perches } 45263705ce5bSJoe Perches 45273705ce5bSJoe Perches $off = 0; 45283705ce5bSJoe Perches 45296c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4530b34c648bSJoe Perches my $last_after = -1; 45316c72ffaaSAndy Whitcroft 45320a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 45333705ce5bSJoe Perches 45343705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 45353705ce5bSJoe Perches 45363705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 45373705ce5bSJoe Perches 45384a0df2efSAndy Whitcroft $off += length($elements[$n]); 45394a0df2efSAndy Whitcroft 454025985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4541773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4542773647a0SAndy Whitcroft my $cc = ''; 4543773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4544773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4545773647a0SAndy Whitcroft } 4546773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4547773647a0SAndy Whitcroft 45484a0df2efSAndy Whitcroft my $a = ''; 45494a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 45504a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4551cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 45524a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 45534a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 4554773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 45554a0df2efSAndy Whitcroft 45560a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 45574a0df2efSAndy Whitcroft 45584a0df2efSAndy Whitcroft my $c = ''; 45590a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 45604a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 45614a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4562cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 45634a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 45644a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 45658b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 45664a0df2efSAndy Whitcroft } else { 45674a0df2efSAndy Whitcroft $c = 'E'; 45680a920b5bSAndy Whitcroft } 45690a920b5bSAndy Whitcroft 45704a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 45714a0df2efSAndy Whitcroft 45724a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 45734a0df2efSAndy Whitcroft 45746c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 4575de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 45760a920b5bSAndy Whitcroft 457774048ed8SAndy Whitcroft # Pull out the value of this operator. 45786c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 45790a920b5bSAndy Whitcroft 45801f65f947SAndy Whitcroft # Get the full operator variant. 45811f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 45821f65f947SAndy Whitcroft 458313214adfSAndy Whitcroft # Ignore operators passed as parameters. 458413214adfSAndy Whitcroft if ($op_type ne 'V' && 4585d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 458613214adfSAndy Whitcroft 4587cf655043SAndy Whitcroft# # Ignore comments 4588cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 458913214adfSAndy Whitcroft 4590d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 459113214adfSAndy Whitcroft } elsif ($op eq ';') { 4592cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 4593cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 45943705ce5bSJoe Perches if (ERROR("SPACING", 45953705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 4596b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 45973705ce5bSJoe Perches $line_fixed = 1; 45983705ce5bSJoe Perches } 4599d8aaf121SAndy Whitcroft } 4600d8aaf121SAndy Whitcroft 4601d8aaf121SAndy Whitcroft # // is a comment 4602d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 46030a920b5bSAndy Whitcroft 4604b00e4814SJoe Perches # : when part of a bitfield 4605b00e4814SJoe Perches } elsif ($opv eq ':B') { 4606b00e4814SJoe Perches # skip the bitfield test for now 4607b00e4814SJoe Perches 46081f65f947SAndy Whitcroft # No spaces for: 46091f65f947SAndy Whitcroft # -> 4610b00e4814SJoe Perches } elsif ($op eq '->') { 46114a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 46123705ce5bSJoe Perches if (ERROR("SPACING", 46133705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4614b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 46153705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 46163705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 46173705ce5bSJoe Perches } 4618b34c648bSJoe Perches $line_fixed = 1; 46193705ce5bSJoe Perches } 46200a920b5bSAndy Whitcroft } 46210a920b5bSAndy Whitcroft 46222381097bSJoe Perches # , must not have a space before and must have a space on the right. 46230a920b5bSAndy Whitcroft } elsif ($op eq ',') { 46242381097bSJoe Perches my $rtrim_before = 0; 46252381097bSJoe Perches my $space_after = 0; 46262381097bSJoe Perches if ($ctx =~ /Wx./) { 46272381097bSJoe Perches if (ERROR("SPACING", 46282381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 46292381097bSJoe Perches $line_fixed = 1; 46302381097bSJoe Perches $rtrim_before = 1; 46312381097bSJoe Perches } 46322381097bSJoe Perches } 4633cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 46343705ce5bSJoe Perches if (ERROR("SPACING", 46353705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 46363705ce5bSJoe Perches $line_fixed = 1; 4637b34c648bSJoe Perches $last_after = $n; 46382381097bSJoe Perches $space_after = 1; 46392381097bSJoe Perches } 46402381097bSJoe Perches } 46412381097bSJoe Perches if ($rtrim_before || $space_after) { 46422381097bSJoe Perches if ($rtrim_before) { 46432381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 46442381097bSJoe Perches } else { 46452381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 46462381097bSJoe Perches } 46472381097bSJoe Perches if ($space_after) { 46482381097bSJoe Perches $good .= " "; 46493705ce5bSJoe Perches } 46500a920b5bSAndy Whitcroft } 46510a920b5bSAndy Whitcroft 46529c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 465374048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 46549c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 46559c0ca6f9SAndy Whitcroft 46569c0ca6f9SAndy Whitcroft # unary operators should have a space before and 46579c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 46589c0ca6f9SAndy Whitcroft # unary operator, or a cast 46599c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 466074048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 46610d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4662cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 46633705ce5bSJoe Perches if (ERROR("SPACING", 46643705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4665b34c648bSJoe Perches if ($n != $last_after + 2) { 4666b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 46673705ce5bSJoe Perches $line_fixed = 1; 46683705ce5bSJoe Perches } 46690a920b5bSAndy Whitcroft } 4670b34c648bSJoe Perches } 4671a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4672171ae1a4SAndy Whitcroft # A unary '*' may be const 4673171ae1a4SAndy Whitcroft 4674171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 46753705ce5bSJoe Perches if (ERROR("SPACING", 46763705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4677b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 46783705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 46793705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 46803705ce5bSJoe Perches } 4681b34c648bSJoe Perches $line_fixed = 1; 46823705ce5bSJoe Perches } 46830a920b5bSAndy Whitcroft } 46840a920b5bSAndy Whitcroft 46850a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 46860a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4687773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 46883705ce5bSJoe Perches if (ERROR("SPACING", 46893705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4690b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 46913705ce5bSJoe Perches $line_fixed = 1; 46923705ce5bSJoe Perches } 46930a920b5bSAndy Whitcroft } 4694773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4695773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 46963705ce5bSJoe Perches if (ERROR("SPACING", 46973705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4698b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 46993705ce5bSJoe Perches $line_fixed = 1; 47003705ce5bSJoe Perches } 4701653d4876SAndy Whitcroft } 4702773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 47033705ce5bSJoe Perches if (ERROR("SPACING", 47043705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4705b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 47063705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 47073705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4708773647a0SAndy Whitcroft } 4709b34c648bSJoe Perches $line_fixed = 1; 47103705ce5bSJoe Perches } 47113705ce5bSJoe Perches } 47120a920b5bSAndy Whitcroft 47130a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 47149c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 47159c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 47169c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4717c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4718c2fdda0dSAndy Whitcroft $op eq '%') 47190a920b5bSAndy Whitcroft { 4720d2e025f3SJoe Perches if ($check) { 4721d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4722d2e025f3SJoe Perches if (CHK("SPACING", 4723d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4724d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4725d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4726d2e025f3SJoe Perches $line_fixed = 1; 4727d2e025f3SJoe Perches } 4728d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4729d2e025f3SJoe Perches if (CHK("SPACING", 4730d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4731d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4732d2e025f3SJoe Perches $line_fixed = 1; 4733d2e025f3SJoe Perches } 4734d2e025f3SJoe Perches } 4735d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 47363705ce5bSJoe Perches if (ERROR("SPACING", 47373705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4738b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4739b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4740b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4741b34c648bSJoe Perches } 47423705ce5bSJoe Perches $line_fixed = 1; 47433705ce5bSJoe Perches } 47440a920b5bSAndy Whitcroft } 47450a920b5bSAndy Whitcroft 47461f65f947SAndy Whitcroft # A colon needs no spaces before when it is 47471f65f947SAndy Whitcroft # terminating a case value or a label. 47481f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 47491f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 47503705ce5bSJoe Perches if (ERROR("SPACING", 47513705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4752b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 47533705ce5bSJoe Perches $line_fixed = 1; 47543705ce5bSJoe Perches } 47551f65f947SAndy Whitcroft } 47561f65f947SAndy Whitcroft 47570a920b5bSAndy Whitcroft # All the others need spaces both sides. 4758cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 47591f65f947SAndy Whitcroft my $ok = 0; 47601f65f947SAndy Whitcroft 476122f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 47621f65f947SAndy Whitcroft if (($op eq '<' && 47631f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 47641f65f947SAndy Whitcroft ($op eq '>' && 47651f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 47661f65f947SAndy Whitcroft { 47671f65f947SAndy Whitcroft $ok = 1; 47681f65f947SAndy Whitcroft } 47691f65f947SAndy Whitcroft 4770e0df7e1fSJoe Perches # for asm volatile statements 4771e0df7e1fSJoe Perches # ignore a colon with another 4772e0df7e1fSJoe Perches # colon immediately before or after 4773e0df7e1fSJoe Perches if (($op eq ':') && 4774e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4775e0df7e1fSJoe Perches $ok = 1; 4776e0df7e1fSJoe Perches } 4777e0df7e1fSJoe Perches 477884731623SJoe Perches # messages are ERROR, but ?: are CHK 47791f65f947SAndy Whitcroft if ($ok == 0) { 47800675a8fbSJean Delvare my $msg_level = \&ERROR; 47810675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 478284731623SJoe Perches 47830675a8fbSJean Delvare if (&{$msg_level}("SPACING", 47843705ce5bSJoe Perches "spaces required around that '$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 } 479222f2a2efSAndy Whitcroft } 47934a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 47943705ce5bSJoe Perches 47953705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 47963705ce5bSJoe Perches 47973705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 47980a920b5bSAndy Whitcroft } 47993705ce5bSJoe Perches 48003705ce5bSJoe Perches if (($#elements % 2) == 0) { 48013705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 48023705ce5bSJoe Perches } 48033705ce5bSJoe Perches 4804194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4805194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 48063705ce5bSJoe Perches } 48073705ce5bSJoe Perches 48083705ce5bSJoe Perches 48090a920b5bSAndy Whitcroft } 48100a920b5bSAndy Whitcroft 4811786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4812d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4813786b6326SJoe Perches if (WARN("SPACING", 4814786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4815786b6326SJoe Perches $fix) { 4816194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4817786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4818786b6326SJoe Perches } 4819786b6326SJoe Perches } 4820786b6326SJoe Perches 4821f0a594c1SAndy Whitcroft# check for multiple assignments 4822f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4823000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4824000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4825f0a594c1SAndy Whitcroft } 4826f0a594c1SAndy Whitcroft 482722f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 482822f2a2efSAndy Whitcroft## # continuation. 482922f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 483022f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 483122f2a2efSAndy Whitcroft## 483222f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 483322f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 483422f2a2efSAndy Whitcroft## my $ln = $line; 483522f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 483622f2a2efSAndy Whitcroft## } 483722f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4838000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4839000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 484022f2a2efSAndy Whitcroft## } 484122f2a2efSAndy Whitcroft## } 4842f0a594c1SAndy Whitcroft 48430a920b5bSAndy Whitcroft#need space before brace following if, while, etc 48446b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 48456ad724e2SMichal Zylowski $line =~ /\b(?:else|do)\{/) { 48463705ce5bSJoe Perches if (ERROR("SPACING", 48473705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 48483705ce5bSJoe Perches $fix) { 48496ad724e2SMichal Zylowski $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/; 48503705ce5bSJoe Perches } 4851de7d4f0eSAndy Whitcroft } 4852de7d4f0eSAndy Whitcroft 4853c4a62ef9SJoe Perches## # check for blank lines before declarations 4854c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4855c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4856c4a62ef9SJoe Perches## WARN("SPACING", 4857c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4858c4a62ef9SJoe Perches## } 4859c4a62ef9SJoe Perches## 4860c4a62ef9SJoe Perches 4861de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4862de7d4f0eSAndy Whitcroft# on the line 486394fb9845SJoe Perches if ($line =~ /}(?!(?:,|;|\)|\}))\S/) { 4864d5e616fcSJoe Perches if (ERROR("SPACING", 4865d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4866d5e616fcSJoe Perches $fix) { 4867194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4868d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4869d5e616fcSJoe Perches } 48700a920b5bSAndy Whitcroft } 48710a920b5bSAndy Whitcroft 487222f2a2efSAndy Whitcroft# check spacing on square brackets 487322f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 48743705ce5bSJoe Perches if (ERROR("SPACING", 48753705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 48763705ce5bSJoe Perches $fix) { 4877194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48783705ce5bSJoe Perches s/\[\s+/\[/; 48793705ce5bSJoe Perches } 488022f2a2efSAndy Whitcroft } 488122f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 48823705ce5bSJoe Perches if (ERROR("SPACING", 48833705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 48843705ce5bSJoe Perches $fix) { 4885194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48863705ce5bSJoe Perches s/\s+\]/\]/; 48873705ce5bSJoe Perches } 488822f2a2efSAndy Whitcroft } 488922f2a2efSAndy Whitcroft 4890c45dcabdSAndy Whitcroft# check spacing on parentheses 48919c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 48929c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 48933705ce5bSJoe Perches if (ERROR("SPACING", 48943705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 48953705ce5bSJoe Perches $fix) { 4896194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48973705ce5bSJoe Perches s/\(\s+/\(/; 48983705ce5bSJoe Perches } 489922f2a2efSAndy Whitcroft } 490013214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4901c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4902c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 49033705ce5bSJoe Perches if (ERROR("SPACING", 49043705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 49053705ce5bSJoe Perches $fix) { 4906194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49073705ce5bSJoe Perches s/\s+\)/\)/; 49083705ce5bSJoe Perches } 490922f2a2efSAndy Whitcroft } 491022f2a2efSAndy Whitcroft 4911e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4912e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4913e2826fd0SJoe Perches 4914e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4915ea4acbb1SJoe Perches my $var = $1; 4916ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4917ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4918ea4acbb1SJoe Perches $fix) { 4919ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4920ea4acbb1SJoe Perches } 4921ea4acbb1SJoe Perches } 4922ea4acbb1SJoe Perches 4923ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4924ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4925ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4926ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4927ea4acbb1SJoe Perches my $var = $2; 4928ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4929ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4930ea4acbb1SJoe Perches $fix) { 4931ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4932ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4933ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4934ea4acbb1SJoe Perches } 4935e2826fd0SJoe Perches } 4936e2826fd0SJoe Perches 493763b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 4938a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 4939a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 49405b57980dSJoe Perches $perl_version_ok && defined($stat) && 494163b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 494263b7c73eSJoe Perches my $if_stat = $1; 494363b7c73eSJoe Perches my $test = substr($2, 1, -1); 494463b7c73eSJoe Perches my $herectx; 494563b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 494663b7c73eSJoe Perches my $match = $1; 494763b7c73eSJoe Perches # avoid parentheses around potential macro args 494863b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 494963b7c73eSJoe Perches if (!defined($herectx)) { 495063b7c73eSJoe Perches $herectx = $here . "\n"; 495163b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 495263b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 495363b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 495463b7c73eSJoe Perches $herectx .= $rl . "\n"; 495563b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 495663b7c73eSJoe Perches } 495763b7c73eSJoe Perches } 495863b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 495963b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 496063b7c73eSJoe Perches } 496163b7c73eSJoe Perches } 496263b7c73eSJoe Perches 49630a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 49644a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 49650a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 49663705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 49673705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 49683705ce5bSJoe Perches $fix) { 4969194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49703705ce5bSJoe Perches s/^(.)\s+/$1/; 49713705ce5bSJoe Perches } 49720a920b5bSAndy Whitcroft } 49730a920b5bSAndy Whitcroft 497440873abaSJoe Perches# check if a statement with a comma should be two statements like: 497540873abaSJoe Perches# foo = bar(), /* comma should be semicolon */ 497640873abaSJoe Perches# bar = baz(); 497740873abaSJoe Perches if (defined($stat) && 497840873abaSJoe Perches $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) { 497940873abaSJoe Perches my $cnt = statement_rawlines($stat); 498040873abaSJoe Perches my $herectx = get_stat_here($linenr, $cnt, $here); 498140873abaSJoe Perches WARN("SUSPECT_COMMA_SEMICOLON", 498240873abaSJoe Perches "Possible comma where semicolon could be used\n" . $herectx); 498340873abaSJoe Perches } 498440873abaSJoe Perches 49855b9553abSJoe Perches# return is not a function 4986507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4987c45dcabdSAndy Whitcroft my $spacing = $1; 49885b57980dSJoe Perches if ($perl_version_ok && 49895b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 49905b9553abSJoe Perches my $value = $1; 49915b9553abSJoe Perches $value = deparenthesize($value); 49925b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4993000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4994000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 49955b9553abSJoe Perches } 4996c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4997000d1cc1SJoe Perches ERROR("SPACING", 4998000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4999c45dcabdSAndy Whitcroft } 5000c45dcabdSAndy Whitcroft } 5001507e5141SJoe Perches 5002b43ae21bSJoe Perches# unnecessary return in a void function 5003b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 5004b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 5005b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 5006b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 5007b43ae21bSJoe Perches $linenr >= 3 && 5008b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 5009b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 50109819cf25SJoe Perches WARN("RETURN_VOID", 5011b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 50129819cf25SJoe Perches } 50139819cf25SJoe Perches 5014189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 50155b57980dSJoe Perches if ($perl_version_ok && 5016189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 5017189248d8SJoe Perches my $openparens = $1; 5018189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 5019189248d8SJoe Perches my $msg = ""; 5020189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 5021189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 5022189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 5023189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 5024189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 5025189248d8SJoe Perches } 5026189248d8SJoe Perches } 5027189248d8SJoe Perches 5028c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 5029c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 5030c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 5031c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 50325b57980dSJoe Perches if ($perl_version_ok && 5033c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 5034c5595fa2SJoe Perches my $lead = $1; 5035c5595fa2SJoe Perches my $const = $2; 5036c5595fa2SJoe Perches my $comp = $3; 5037c5595fa2SJoe Perches my $to = $4; 5038c5595fa2SJoe Perches my $newcomp = $comp; 5039f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 5040c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 5041c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 5042c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 5043c5595fa2SJoe Perches $fix) { 5044c5595fa2SJoe Perches if ($comp eq "<") { 5045c5595fa2SJoe Perches $newcomp = ">"; 5046c5595fa2SJoe Perches } elsif ($comp eq "<=") { 5047c5595fa2SJoe Perches $newcomp = ">="; 5048c5595fa2SJoe Perches } elsif ($comp eq ">") { 5049c5595fa2SJoe Perches $newcomp = "<"; 5050c5595fa2SJoe Perches } elsif ($comp eq ">=") { 5051c5595fa2SJoe Perches $newcomp = "<="; 5052c5595fa2SJoe Perches } 5053c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 5054c5595fa2SJoe Perches } 5055c5595fa2SJoe Perches } 5056c5595fa2SJoe Perches 5057f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 5058f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 505953a3c448SAndy Whitcroft my $name = $1; 506053a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 5061000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 5062f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 506353a3c448SAndy Whitcroft } 506453a3c448SAndy Whitcroft } 5065c45dcabdSAndy Whitcroft 50660a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 50674a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 50683705ce5bSJoe Perches if (ERROR("SPACING", 50693705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 50703705ce5bSJoe Perches $fix) { 5071194f66fcSJoe Perches $fixed[$fixlinenr] =~ 50723705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 50733705ce5bSJoe Perches } 50740a920b5bSAndy Whitcroft } 50750a920b5bSAndy Whitcroft 5076f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 5077f5fe35ddSAndy Whitcroft# statements after the conditional. 5078170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 50793e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 50803e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 50813e469cdcSAndy Whitcroft if (!defined $stat); 5082170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 5083170d3a22SAndy Whitcroft $remain_next, $off_next); 5084170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 5085170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 5086170d3a22SAndy Whitcroft 5087170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 5088170d3a22SAndy Whitcroft # If the statement carries leading newlines, 5089170d3a22SAndy Whitcroft # then count those as offsets. 5090170d3a22SAndy Whitcroft my ($whitespace) = 5091170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 5092170d3a22SAndy Whitcroft my $offset = 5093170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 5094170d3a22SAndy Whitcroft 5095170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 5096170d3a22SAndy Whitcroft $offset} = 1; 5097170d3a22SAndy Whitcroft } 5098170d3a22SAndy Whitcroft } 5099170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 5100c11230f4SJoe Perches defined($stat) && defined($cond) && 5101170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 5102171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 51038905a67cSAndy Whitcroft 5104b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 510565b64b3bSJoe Perches if (ERROR("ASSIGN_IN_IF", 510665b64b3bSJoe Perches "do not use assignment in if condition\n" . $herecurr) && 510765b64b3bSJoe Perches $fix && $perl_version_ok) { 510865b64b3bSJoe Perches if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) { 510965b64b3bSJoe Perches my $space = $1; 511065b64b3bSJoe Perches my $not = $2; 511165b64b3bSJoe Perches my $statement = $3; 511265b64b3bSJoe Perches my $assigned = $4; 511365b64b3bSJoe Perches my $test = $8; 511465b64b3bSJoe Perches my $against = $9; 511565b64b3bSJoe Perches my $brace = $15; 511665b64b3bSJoe Perches fix_delete_line($fixlinenr, $rawline); 511765b64b3bSJoe Perches fix_insert_line($fixlinenr, "$space$statement;"); 511865b64b3bSJoe Perches my $newline = "${space}if ("; 511965b64b3bSJoe Perches $newline .= '!' if defined($not); 512065b64b3bSJoe Perches $newline .= '(' if (defined $not && defined($test) && defined($against)); 512165b64b3bSJoe Perches $newline .= "$assigned"; 512265b64b3bSJoe Perches $newline .= " $test $against" if (defined($test) && defined($against)); 512365b64b3bSJoe Perches $newline .= ')' if (defined $not && defined($test) && defined($against)); 512465b64b3bSJoe Perches $newline .= ')'; 512565b64b3bSJoe Perches $newline .= " {" if (defined($brace)); 512665b64b3bSJoe Perches fix_insert_line($fixlinenr + 1, $newline); 512765b64b3bSJoe Perches } 512865b64b3bSJoe Perches } 51298905a67cSAndy Whitcroft } 51308905a67cSAndy Whitcroft 51318905a67cSAndy Whitcroft # Find out what is on the end of the line after the 51328905a67cSAndy Whitcroft # conditional. 5133773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 51348905a67cSAndy Whitcroft $s =~ s/\n.*//g; 513513214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 513653210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 513753210168SAndy Whitcroft $c !~ /}\s*while\s*/) 5138773647a0SAndy Whitcroft { 5139bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 5140bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 5141bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 514242bdf74cSHidetoshi Seto my $stat_real = ''; 5143bb44ad39SAndy Whitcroft 514442bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 514542bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 5146bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 5147bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 5148bb44ad39SAndy Whitcroft } 5149bb44ad39SAndy Whitcroft 5150000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5151000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 51528905a67cSAndy Whitcroft } 51538905a67cSAndy Whitcroft } 51548905a67cSAndy Whitcroft 515513214adfSAndy Whitcroft# Check for bitwise tests written as boolean 515613214adfSAndy Whitcroft if ($line =~ / 515713214adfSAndy Whitcroft (?: 515813214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 515913214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 516013214adfSAndy Whitcroft (?:\&\&|\|\|) 516113214adfSAndy Whitcroft | 516213214adfSAndy Whitcroft (?:\&\&|\|\|) 516313214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 516413214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 516513214adfSAndy Whitcroft )/x) 516613214adfSAndy Whitcroft { 5167000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 5168000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 516913214adfSAndy Whitcroft } 517013214adfSAndy Whitcroft 51718905a67cSAndy Whitcroft# if and else should not have general statements after it 517213214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 517313214adfSAndy Whitcroft my $s = $1; 517413214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 517513214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 5176000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5177000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 51780a920b5bSAndy Whitcroft } 517913214adfSAndy Whitcroft } 518039667782SAndy Whitcroft# if should not continue a brace 518139667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 5182000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5183048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 518439667782SAndy Whitcroft $herecurr); 518539667782SAndy Whitcroft } 5186a1080bf8SAndy Whitcroft# case and default should not have general statements after them 5187a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 5188a1080bf8SAndy Whitcroft $line !~ /\G(?: 51893fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 5190a1080bf8SAndy Whitcroft \s*return\s+ 5191a1080bf8SAndy Whitcroft )/xg) 5192a1080bf8SAndy Whitcroft { 5193000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5194000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 5195a1080bf8SAndy Whitcroft } 51960a920b5bSAndy Whitcroft 51970a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 51980a920b5bSAndy Whitcroft # indent level to be relevant to each other. 51998b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 52000a920b5bSAndy Whitcroft $previndent == $indent) { 52018b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 52028b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 52038b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 52048b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 52058b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 52068b8856f4SJoe Perches my $fixedline = $prevrawline; 52078b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 52088b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 52098b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 52108b8856f4SJoe Perches } 52118b8856f4SJoe Perches $fixedline = $rawline; 52128b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 52138b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 52148b8856f4SJoe Perches } 52150a920b5bSAndy Whitcroft } 52160a920b5bSAndy Whitcroft 52178b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 5218c2fdda0dSAndy Whitcroft $previndent == $indent) { 5219c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 5220c2fdda0dSAndy Whitcroft 5221c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 5222c2fdda0dSAndy Whitcroft # conditional. 5223773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 5224c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 5225c2fdda0dSAndy Whitcroft 5226c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 52278b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 52288b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 52298b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 52308b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 52318b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 52328b8856f4SJoe Perches my $fixedline = $prevrawline; 52338b8856f4SJoe Perches my $trailing = $rawline; 52348b8856f4SJoe Perches $trailing =~ s/^\+//; 52358b8856f4SJoe Perches $trailing = trim($trailing); 52368b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 52378b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 52388b8856f4SJoe Perches } 5239c2fdda0dSAndy Whitcroft } 5240c2fdda0dSAndy Whitcroft } 5241c2fdda0dSAndy Whitcroft 524295e2c602SJoe Perches#Specific variable tests 5243323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 5244323c1260SJoe Perches my $var = $1; 524595e2c602SJoe Perches 524695e2c602SJoe Perches#CamelCase 5247807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 5248be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 524922735ce8SJoe Perches#Ignore Page<foo> variants 5250807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 5251d439e6a5SJoe Perches#Ignore SI style variants like nS, mV and dB 5252d439e6a5SJoe Perches#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE) 5253d439e6a5SJoe Perches $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ && 5254f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 5255f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 52567e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 52577e781f67SJoe Perches my $word = $1; 52587e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 5259d8b07710SJoe Perches if ($check) { 5260d8b07710SJoe Perches seed_camelcase_includes(); 5261d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 5262d8b07710SJoe Perches seed_camelcase_file($realfile); 5263d8b07710SJoe Perches $camelcase_file_seeded = 1; 5264d8b07710SJoe Perches } 5265d8b07710SJoe Perches } 52667e781f67SJoe Perches if (!defined $camelcase{$word}) { 52677e781f67SJoe Perches $camelcase{$word} = 1; 5268be79794bSJoe Perches CHK("CAMELCASE", 52697e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 52707e781f67SJoe Perches } 5271323c1260SJoe Perches } 5272323c1260SJoe Perches } 52733445686aSJoe Perches } 52740a920b5bSAndy Whitcroft 52750a920b5bSAndy Whitcroft#no spaces allowed after \ in define 5276d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 5277d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 5278d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 5279d5e616fcSJoe Perches $fix) { 5280194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 5281d5e616fcSJoe Perches } 52820a920b5bSAndy Whitcroft } 52830a920b5bSAndy Whitcroft 52840e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 52850e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 5286c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 5287e09dec48SAndy Whitcroft my $file = "$1.h"; 5288e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 5289e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 5290e09dec48SAndy Whitcroft $realfile ne $checkfile && 52917840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 5292c45dcabdSAndy Whitcroft { 52930e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 52940e212e0aSFabian Frederick if ($asminclude > 0) { 5295e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 5296000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 5297000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5298e09dec48SAndy Whitcroft } else { 5299000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 5300000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5301e09dec48SAndy Whitcroft } 53020a920b5bSAndy Whitcroft } 53030a920b5bSAndy Whitcroft } 53040e212e0aSFabian Frederick } 53050a920b5bSAndy Whitcroft 5306653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 5307653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 5308cf655043SAndy Whitcroft# in a known good container 5309b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 5310b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 5311d8aaf121SAndy Whitcroft my $ln = $linenr; 5312d8aaf121SAndy Whitcroft my $cnt = $realcnt; 5313c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 5314c45dcabdSAndy Whitcroft my $ctx = ''; 531508a2843eSJoe Perches my $has_flow_statement = 0; 531608a2843eSJoe Perches my $has_arg_concat = 0; 5317c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 5318f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 5319f74bd194SAndy Whitcroft $ctx = $dstat; 5320c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 5321a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 5322c45dcabdSAndy Whitcroft 532308a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 532462e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 532508a2843eSJoe Perches 5326f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 5327f59b64bfSJoe Perches my $define_args = $1; 5328f59b64bfSJoe Perches my $define_stmt = $dstat; 5329f59b64bfSJoe Perches my @def_args = (); 5330f59b64bfSJoe Perches 5331f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 5332f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 5333f59b64bfSJoe Perches $define_args =~ s/\s*//g; 53348c8c45cfSJoe Perches $define_args =~ s/\\\+?//g; 5335f59b64bfSJoe Perches @def_args = split(",", $define_args); 5336f59b64bfSJoe Perches } 5337f59b64bfSJoe Perches 5338292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 5339c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 5340c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 5341c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 5342c45dcabdSAndy Whitcroft 5343c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 5344bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 5345bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 53466b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 5347bf30d6edSAndy Whitcroft { 5348c45dcabdSAndy Whitcroft } 5349c45dcabdSAndy Whitcroft 5350342d3d2fSAntonio Borneo # Flatten any obvious string concatenation. 535133acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 535233acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 5353e45bab8eSAndy Whitcroft { 5354e45bab8eSAndy Whitcroft } 5355e45bab8eSAndy Whitcroft 535642e15293SJoe Perches # Make asm volatile uses seem like a generic function 535742e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 535842e15293SJoe Perches 5359c45dcabdSAndy Whitcroft my $exceptions = qr{ 5360c45dcabdSAndy Whitcroft $Declare| 5361c45dcabdSAndy Whitcroft module_param_named| 5362a0a0a7a9SKees Cook MODULE_PARM_DESC| 5363c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 5364c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 5365383099fdSAndy Whitcroft __typeof__\(| 536622fd2d3eSStefani Seibold union| 536722fd2d3eSStefani Seibold struct| 5368ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 53696b10df42SVladimir Zapolskiy ^\"|\"$| 53706b10df42SVladimir Zapolskiy ^\[ 5371c45dcabdSAndy Whitcroft }x; 53725eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 5373f59b64bfSJoe Perches 5374f59b64bfSJoe Perches $ctx =~ s/\n*$//; 5375f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 5376e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 5377f59b64bfSJoe Perches 5378f74bd194SAndy Whitcroft if ($dstat ne '' && 5379f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 5380f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 53813cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 5382356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5383f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 5384f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5385e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 538672f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 5387f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5388f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5389f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 53904e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5391f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5392c45dcabdSAndy Whitcroft { 5393e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5394e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5395e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5396e795556aSJoe Perches } elsif ($dstat =~ /;/) { 5397f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5398f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5399f74bd194SAndy Whitcroft } else { 5400000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 5401388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5402d8aaf121SAndy Whitcroft } 5403f59b64bfSJoe Perches 5404f59b64bfSJoe Perches } 54055207649bSJoe Perches 54065207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 54075207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 54085207649bSJoe Perches my $first = 1; 54095207649bSJoe Perches $define_stmt = ""; 54105207649bSJoe Perches foreach my $l (@stmt_array) { 54115207649bSJoe Perches $l =~ s/\\$//; 54125207649bSJoe Perches if ($first) { 54135207649bSJoe Perches $define_stmt = $l; 54145207649bSJoe Perches $first = 0; 54155207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 54165207649bSJoe Perches $define_stmt .= substr($l, 1); 54175207649bSJoe Perches } 54185207649bSJoe Perches } 54195207649bSJoe Perches $define_stmt =~ s/$;//g; 54205207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 54215207649bSJoe Perches $define_stmt = trim($define_stmt); 54225207649bSJoe Perches 5423f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5424f59b64bfSJoe Perches foreach my $arg (@def_args) { 5425f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 54269192d41aSJoe Perches next if ($arg =~ /^type$/i); 54277fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 54286dba824eSBrendan Jackman $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 54297fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 54307fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 5431d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 5432f59b64bfSJoe Perches if ($use_cnt > 1) { 5433f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5434f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5435f59b64bfSJoe Perches } 54369192d41aSJoe Perches# check if any macro arguments may have other precedence issues 54377fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 54389192d41aSJoe Perches ((defined($1) && $1 ne ',') || 54399192d41aSJoe Perches (defined($2) && $2 ne ','))) { 54409192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 54419192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 54429192d41aSJoe Perches } 54430a920b5bSAndy Whitcroft } 54445023d347SJoe Perches 544508a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 544608a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 544708a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 544808a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 5449e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 545008a2843eSJoe Perches 545108a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 545208a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 545308a2843eSJoe Perches } 545408a2843eSJoe Perches 5455481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 54565023d347SJoe Perches 54575023d347SJoe Perches } else { 54585023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5459481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5460481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 54615023d347SJoe Perches $line =~ /^\+.*\\$/) { 54625023d347SJoe Perches WARN("LINE_CONTINUATIONS", 54635023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 54645023d347SJoe Perches } 5465653d4876SAndy Whitcroft } 54660a920b5bSAndy Whitcroft 5467b13edf7fSJoe Perches# do {} while (0) macro tests: 5468b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5469b13edf7fSJoe Perches# macro should not end with a semicolon 54705b57980dSJoe Perches if ($perl_version_ok && 5471b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5472b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5473b13edf7fSJoe Perches my $ln = $linenr; 5474b13edf7fSJoe Perches my $cnt = $realcnt; 5475b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5476b13edf7fSJoe Perches my $ctx = ''; 5477b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5478b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5479b13edf7fSJoe Perches $ctx = $dstat; 5480b13edf7fSJoe Perches 5481b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 54821b36b201SJoe Perches $dstat =~ s/$;/ /g; 5483b13edf7fSJoe Perches 5484b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5485b13edf7fSJoe Perches my $stmts = $2; 5486b13edf7fSJoe Perches my $semis = $3; 5487b13edf7fSJoe Perches 5488b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5489b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5490e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5491b13edf7fSJoe Perches 5492ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5493ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5494b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5495b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5496b13edf7fSJoe Perches } 5497b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5498b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5499b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5500b13edf7fSJoe Perches } 5501f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5502f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5503f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5504e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5505f5ef95b1SJoe Perches 5506f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5507f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5508b13edf7fSJoe Perches } 5509b13edf7fSJoe Perches } 5510b13edf7fSJoe Perches 5511f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 551213214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 551313214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5514cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 551513214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5516cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5517cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5518aad4f614SJoe Perches my @allowed = (); 5519aad4f614SJoe Perches my $allow = 0; 552013214adfSAndy Whitcroft my $seen = 0; 5521773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5522cf655043SAndy Whitcroft my $ln = $linenr - 1; 552313214adfSAndy Whitcroft for my $chunk (@chunks) { 552413214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 552513214adfSAndy Whitcroft 5526773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5527773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5528773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 5529773647a0SAndy Whitcroft 5530aad4f614SJoe Perches $allowed[$allow] = 0; 5531773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5532773647a0SAndy Whitcroft 5533773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 5534773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 5535773647a0SAndy Whitcroft 5536773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5537cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 5538cf655043SAndy Whitcroft 5539773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 554013214adfSAndy Whitcroft 554113214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 554213214adfSAndy Whitcroft 5543aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5544cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5545cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5546aad4f614SJoe Perches $allowed[$allow] = 1; 554713214adfSAndy Whitcroft } 554813214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5549cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5550aad4f614SJoe Perches $allowed[$allow] = 1; 555113214adfSAndy Whitcroft } 5552cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5553cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5554aad4f614SJoe Perches $allowed[$allow] = 1; 555513214adfSAndy Whitcroft } 5556aad4f614SJoe Perches $allow++; 555713214adfSAndy Whitcroft } 5558aad4f614SJoe Perches if ($seen) { 5559aad4f614SJoe Perches my $sum_allowed = 0; 5560aad4f614SJoe Perches foreach (@allowed) { 5561aad4f614SJoe Perches $sum_allowed += $_; 5562aad4f614SJoe Perches } 5563aad4f614SJoe Perches if ($sum_allowed == 0) { 5564000d1cc1SJoe Perches WARN("BRACES", 5565000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 5566aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 5567aad4f614SJoe Perches $seen != $allow) { 5568aad4f614SJoe Perches CHK("BRACES", 5569aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 5570aad4f614SJoe Perches } 557113214adfSAndy Whitcroft } 557213214adfSAndy Whitcroft } 557313214adfSAndy Whitcroft } 5574773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 557513214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 5576cf655043SAndy Whitcroft my $allowed = 0; 5577f0a594c1SAndy Whitcroft 5578cf655043SAndy Whitcroft # Check the pre-context. 5579cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 5580cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 5581cf655043SAndy Whitcroft $allowed = 1; 5582f0a594c1SAndy Whitcroft } 5583773647a0SAndy Whitcroft 5584773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 5585773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 5586773647a0SAndy Whitcroft 5587cf655043SAndy Whitcroft # Check the condition. 5588cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 5589773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 5590cf655043SAndy Whitcroft if (defined $cond) { 5591773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5592cf655043SAndy Whitcroft } 5593cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5594cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5595cf655043SAndy Whitcroft $allowed = 1; 5596cf655043SAndy Whitcroft } 5597cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5598cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5599cf655043SAndy Whitcroft $allowed = 1; 5600cf655043SAndy Whitcroft } 5601cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5602cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5603cf655043SAndy Whitcroft $allowed = 1; 5604cf655043SAndy Whitcroft } 5605cf655043SAndy Whitcroft # Check the post-context. 5606cf655043SAndy Whitcroft if (defined $chunks[1]) { 5607cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 5608cf655043SAndy Whitcroft if (defined $cond) { 5609773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5610cf655043SAndy Whitcroft } 5611cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 5612cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5613cf655043SAndy Whitcroft $allowed = 1; 5614cf655043SAndy Whitcroft } 5615cf655043SAndy Whitcroft } 5616cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 5617f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 5618e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5619cf655043SAndy Whitcroft 5620000d1cc1SJoe Perches WARN("BRACES", 5621000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 5622f0a594c1SAndy Whitcroft } 5623f0a594c1SAndy Whitcroft } 5624f0a594c1SAndy Whitcroft 5625e4c5babdSJoe Perches# check for single line unbalanced braces 562695330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 562795330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 5628e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 5629e4c5babdSJoe Perches } 5630e4c5babdSJoe Perches 56310979ae66SJoe Perches# check for unnecessary blank lines around braces 563277b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5633f8e58219SJoe Perches if (CHK("BRACES", 5634f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5635f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 5636f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5637f8e58219SJoe Perches } 56380979ae66SJoe Perches } 563977b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5640f8e58219SJoe Perches if (CHK("BRACES", 5641f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5642f8e58219SJoe Perches $fix) { 5643f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 5644f8e58219SJoe Perches } 56450979ae66SJoe Perches } 56460979ae66SJoe Perches 56474a0df2efSAndy Whitcroft# no volatiles please 56486c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 56496c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5650000d1cc1SJoe Perches WARN("VOLATILE", 56518c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 56524a0df2efSAndy Whitcroft } 56534a0df2efSAndy Whitcroft 56545e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 56555e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 56565e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 56575e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 565833acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 56595e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 56605e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 56615e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 56625e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 56635e4f6ba5SJoe Perches $fix && 56645e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 56655e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 56665e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 56675e4f6ba5SJoe Perches my $comma_close = ""; 56685e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 56695e4f6ba5SJoe Perches $comma_close = $1; 56705e4f6ba5SJoe Perches } 56715e4f6ba5SJoe Perches 56725e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 56735e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 56745e4f6ba5SJoe Perches my $fixedline = $prevrawline; 56755e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 56765e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 56775e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 56785e4f6ba5SJoe Perches $fixedline = $rawline; 56795e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 56805e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 56815e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 56825e4f6ba5SJoe Perches } 56835e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 56845e4f6ba5SJoe Perches } 56855e4f6ba5SJoe Perches } 56865e4f6ba5SJoe Perches 56875e4f6ba5SJoe Perches# check for missing a space in a string concatenation 56885e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 56895e4f6ba5SJoe Perches WARN('MISSING_SPACE', 56905e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 56915e4f6ba5SJoe Perches } 56925e4f6ba5SJoe Perches 569377cb8546SJoe Perches# check for an embedded function name in a string when the function is known 5694e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 5695e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 5696e4b7d309SJoe Perches# function declarations 569777cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 569877cb8546SJoe Perches defined($context_function) && 5699e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 5700e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 570177cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 5702e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 570377cb8546SJoe Perches } 570477cb8546SJoe Perches 57055e4f6ba5SJoe Perches# check for spaces before a quoted newline 57065e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 57075e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 57085e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 57095e4f6ba5SJoe Perches $fix) { 57105e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 57115e4f6ba5SJoe Perches } 57125e4f6ba5SJoe Perches 57135e4f6ba5SJoe Perches } 57145e4f6ba5SJoe Perches 5715f17dba4fSJoe Perches# concatenated string without spaces between elements 571679682c0cSJoe Perches if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) { 571779682c0cSJoe Perches if (CHK("CONCATENATED_STRING", 571879682c0cSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr) && 571979682c0cSJoe Perches $fix) { 572079682c0cSJoe Perches while ($line =~ /($String)/g) { 572179682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 572279682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/; 572379682c0cSJoe Perches $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/; 572479682c0cSJoe Perches } 572579682c0cSJoe Perches } 5726f17dba4fSJoe Perches } 5727f17dba4fSJoe Perches 572890ad30e5SJoe Perches# uncoalesced string fragments 572933acb54aSJoe Perches if ($line =~ /$String\s*"/) { 573079682c0cSJoe Perches if (WARN("STRING_FRAGMENTS", 573179682c0cSJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr) && 573279682c0cSJoe Perches $fix) { 573379682c0cSJoe Perches while ($line =~ /($String)(?=\s*")/g) { 573479682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 573579682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e; 573679682c0cSJoe Perches } 573779682c0cSJoe Perches } 573890ad30e5SJoe Perches } 573990ad30e5SJoe Perches 5740522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 5741522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 5742522b837cSAlexey Dobriyan my $show_Z = 1; 57435e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 5744522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 57455e4f6ba5SJoe Perches $string =~ s/%%/__/g; 5746522b837cSAlexey Dobriyan # check for %L 5747522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 57485e4f6ba5SJoe Perches WARN("PRINTF_L", 5749522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 5750522b837cSAlexey Dobriyan $show_L = 0; 57515e4f6ba5SJoe Perches } 5752522b837cSAlexey Dobriyan # check for %Z 5753522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 5754522b837cSAlexey Dobriyan WARN("PRINTF_Z", 5755522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 5756522b837cSAlexey Dobriyan $show_Z = 0; 5757522b837cSAlexey Dobriyan } 5758522b837cSAlexey Dobriyan # check for 0x<decimal> 5759522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 5760522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 57616e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 57626e300757SJoe Perches } 57635e4f6ba5SJoe Perches } 57645e4f6ba5SJoe Perches 57655e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 57663f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 57675e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 57685e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 57695e4f6ba5SJoe Perches } 57705e4f6ba5SJoe Perches 577100df344fSAndy Whitcroft# warn about #if 0 5772c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 577360f89010SPrakruthi Deepak Heragu WARN("IF_0", 577460f89010SPrakruthi Deepak Heragu "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr); 577560f89010SPrakruthi Deepak Heragu } 577660f89010SPrakruthi Deepak Heragu 577760f89010SPrakruthi Deepak Heragu# warn about #if 1 577860f89010SPrakruthi Deepak Heragu if ($line =~ /^.\s*\#\s*if\s+1\b/) { 577960f89010SPrakruthi Deepak Heragu WARN("IF_1", 578060f89010SPrakruthi Deepak Heragu "Consider removing the #if 1 and its #endif\n" . $herecurr); 57814a0df2efSAndy Whitcroft } 57824a0df2efSAndy Whitcroft 578303df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 578403df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5785100425deSJoe Perches my $tested = quotemeta($1); 5786100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5787100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5788100425deSJoe Perches my $func = $1; 5789100425deSJoe Perches if (WARN('NEEDLESS_IF', 5790100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5791100425deSJoe Perches $fix) { 5792100425deSJoe Perches my $do_fix = 1; 5793100425deSJoe Perches my $leading_tabs = ""; 5794100425deSJoe Perches my $new_leading_tabs = ""; 5795100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5796100425deSJoe Perches $leading_tabs = $1; 5797100425deSJoe Perches } else { 5798100425deSJoe Perches $do_fix = 0; 5799100425deSJoe Perches } 5800100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5801100425deSJoe Perches $new_leading_tabs = $1; 5802100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5803100425deSJoe Perches $do_fix = 0; 5804100425deSJoe Perches } 5805100425deSJoe Perches } else { 5806100425deSJoe Perches $do_fix = 0; 5807100425deSJoe Perches } 5808100425deSJoe Perches if ($do_fix) { 5809100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5810100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5811100425deSJoe Perches } 5812100425deSJoe Perches } 58134c432a8fSGreg Kroah-Hartman } 58144c432a8fSGreg Kroah-Hartman } 5815f0a594c1SAndy Whitcroft 5816ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5817ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5818ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5819ebfdc409SJoe Perches (defined $1 || defined $3) && 5820ebfdc409SJoe Perches $linenr > 3) { 5821ebfdc409SJoe Perches my $testval = $2; 5822ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5823ebfdc409SJoe Perches 5824ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5825ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5826ebfdc409SJoe Perches 5827e29a70f1SJoe Perches if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ && 5828e29a70f1SJoe Perches $s !~ /\b__GFP_NOWARN\b/ ) { 5829ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5830ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5831ebfdc409SJoe Perches } 5832ebfdc409SJoe Perches } 5833ebfdc409SJoe Perches 5834f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5835dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5836f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5837f78d98f6SJoe Perches my $level = $1; 5838f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5839f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5840f78d98f6SJoe Perches $fix) { 5841f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5842f78d98f6SJoe Perches } 5843f78d98f6SJoe Perches } 5844f78d98f6SJoe Perches 584545c55e92SJoe Perches# check for logging continuations 584645c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 584745c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 584845c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 584945c55e92SJoe Perches } 585045c55e92SJoe Perches 5851abb08a53SJoe Perches# check for mask then right shift without a parentheses 58525b57980dSJoe Perches if ($perl_version_ok && 5853abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5854abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5855abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5856abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5857abb08a53SJoe Perches } 5858abb08a53SJoe Perches 5859b75ac618SJoe Perches# check for pointer comparisons to NULL 58605b57980dSJoe Perches if ($perl_version_ok) { 5861b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5862b75ac618SJoe Perches my $val = $1; 5863b75ac618SJoe Perches my $equal = "!"; 5864b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5865b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5866b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5867b75ac618SJoe Perches $fix) { 5868b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5869b75ac618SJoe Perches } 5870b75ac618SJoe Perches } 5871b75ac618SJoe Perches } 5872b75ac618SJoe Perches 58738716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 58748716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 58758716de38SJoe Perches my $attr = $1; 58768716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 58778716de38SJoe Perches my $ptr = $1; 58788716de38SJoe Perches my $var = $2; 58798716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 58808716de38SJoe Perches ERROR("MISPLACED_INIT", 58818716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 58828716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 58838716de38SJoe Perches WARN("MISPLACED_INIT", 58848716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 58858716de38SJoe Perches $fix) { 5886194f66fcSJoe 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; 58878716de38SJoe Perches } 58888716de38SJoe Perches } 58898716de38SJoe Perches } 58908716de38SJoe Perches 5891e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5892e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5893e970b884SJoe Perches my $attr = $1; 5894e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5895e970b884SJoe Perches my $attr_prefix = $1; 5896e970b884SJoe Perches my $attr_type = $2; 5897e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5898e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5899e970b884SJoe Perches $fix) { 5900194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5901e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5902e970b884SJoe Perches } 5903e970b884SJoe Perches } 5904e970b884SJoe Perches 5905e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5906e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5907e970b884SJoe Perches my $attr = $1; 5908e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5909e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5910e970b884SJoe Perches $fix) { 5911194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5912e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5913e970b884SJoe Perches $lead = rtrim($1); 5914e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5915e970b884SJoe Perches $lead = "${lead}const "; 5916194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5917e970b884SJoe Perches } 5918e970b884SJoe Perches } 5919e970b884SJoe Perches 5920c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5921c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5922c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5923c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5924c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5925c17893c7SJoe Perches $fix) { 5926c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5927c17893c7SJoe Perches } 5928c17893c7SJoe Perches } 5929c17893c7SJoe Perches 5930fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5931fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5932fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5933fbdb8138SJoe Perches my $constant_func = $1; 5934fbdb8138SJoe Perches my $func = $constant_func; 5935fbdb8138SJoe Perches $func =~ s/^__constant_//; 5936fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5937fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5938fbdb8138SJoe Perches $fix) { 5939194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5940fbdb8138SJoe Perches } 5941fbdb8138SJoe Perches } 5942fbdb8138SJoe Perches 59431a15a250SPatrick Pannuto# prefer usleep_range over udelay 594437581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 594543c1d77cSJoe Perches my $delay = $1; 59461a15a250SPatrick Pannuto # ignore udelay's < 10, however 594743c1d77cSJoe Perches if (! ($delay < 10) ) { 5948000d1cc1SJoe Perches CHK("USLEEP_RANGE", 5949458f69efSMauro Carvalho Chehab "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr); 595043c1d77cSJoe Perches } 595143c1d77cSJoe Perches if ($delay > 2000) { 595243c1d77cSJoe Perches WARN("LONG_UDELAY", 595343c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 59541a15a250SPatrick Pannuto } 59551a15a250SPatrick Pannuto } 59561a15a250SPatrick Pannuto 595709ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 595809ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 595909ef8725SPatrick Pannuto if ($1 < 20) { 5960000d1cc1SJoe Perches WARN("MSLEEP", 5961458f69efSMauro Carvalho Chehab "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr); 596209ef8725SPatrick Pannuto } 596309ef8725SPatrick Pannuto } 596409ef8725SPatrick Pannuto 596536ec1939SJoe Perches# check for comparisons of jiffies 596636ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 596736ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 596836ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 596936ec1939SJoe Perches } 597036ec1939SJoe Perches 59719d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 59729d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 59739d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 59749d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 59759d7a34a5SJoe Perches } 59769d7a34a5SJoe Perches 597700df344fSAndy Whitcroft# warn about #ifdefs in C files 5978c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 597900df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 598000df344fSAndy Whitcroft# print "$herecurr"; 598100df344fSAndy Whitcroft# $clean = 0; 598200df344fSAndy Whitcroft# } 598300df344fSAndy Whitcroft 598422f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5985c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 59863705ce5bSJoe Perches if (ERROR("SPACING", 59873705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 59883705ce5bSJoe Perches $fix) { 5989194f66fcSJoe Perches $fixed[$fixlinenr] =~ 59903705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 59913705ce5bSJoe Perches } 59923705ce5bSJoe Perches 599322f2a2efSAndy Whitcroft } 599422f2a2efSAndy Whitcroft 59954a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5996171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5997171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 59984a0df2efSAndy Whitcroft my $which = $1; 59994a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 6000000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 6001000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 60024a0df2efSAndy Whitcroft } 60034a0df2efSAndy Whitcroft } 60044a0df2efSAndy Whitcroft# check for memory barriers without a comment. 6005402c2553SMichael S. Tsirkin 6006402c2553SMichael S. Tsirkin my $barriers = qr{ 6007402c2553SMichael S. Tsirkin mb| 6008402c2553SMichael S. Tsirkin rmb| 6009ad83ec6cSWill Deacon wmb 6010402c2553SMichael S. Tsirkin }x; 6011402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 6012402c2553SMichael S. Tsirkin mb__before_atomic| 6013402c2553SMichael S. Tsirkin mb__after_atomic| 6014402c2553SMichael S. Tsirkin store_release| 6015402c2553SMichael S. Tsirkin load_acquire| 6016402c2553SMichael S. Tsirkin store_mb| 6017402c2553SMichael S. Tsirkin (?:$barriers) 6018402c2553SMichael S. Tsirkin }x; 6019402c2553SMichael S. Tsirkin my $all_barriers = qr{ 6020402c2553SMichael S. Tsirkin (?:$barriers)| 602143e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 602243e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 6023402c2553SMichael S. Tsirkin }x; 6024402c2553SMichael S. Tsirkin 6025402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 60264a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 6027c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 6028000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 60294a0df2efSAndy Whitcroft } 60304a0df2efSAndy Whitcroft } 60313ad81779SPaul E. McKenney 6032f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 6033f4073b0fSMichael S. Tsirkin 6034f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 6035f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 6036f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 6037f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 6038f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 6039f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 6040f4073b0fSMichael S. Tsirkin } 6041f4073b0fSMichael S. Tsirkin 6042cb426e99SJoe Perches# check for waitqueue_active without a comment. 6043cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 6044cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 6045cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 6046cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 6047cb426e99SJoe Perches } 6048cb426e99SJoe Perches } 60493ad81779SPaul E. McKenney 60505099a722SMarco Elver# check for data_race without a comment. 60515099a722SMarco Elver if ($line =~ /\bdata_race\s*\(/) { 60525099a722SMarco Elver if (!ctx_has_comment($first_line, $linenr)) { 60535099a722SMarco Elver WARN("DATA_RACE", 60545099a722SMarco Elver "data_race without comment\n" . $herecurr); 60555099a722SMarco Elver } 60565099a722SMarco Elver } 60575099a722SMarco Elver 60584a0df2efSAndy Whitcroft# check of hardware specific defines 6059c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 6060000d1cc1SJoe Perches CHK("ARCH_DEFINES", 6061000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 60620a920b5bSAndy Whitcroft } 6063653d4876SAndy Whitcroft 6064596ed45bSJoe Perches# check that the storage class is not after a type 6065596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 6066000d1cc1SJoe Perches WARN("STORAGE_CLASS", 6067596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 6068596ed45bSJoe Perches } 6069596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 6070596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 6071596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 6072596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 6073596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 6074596ed45bSJoe Perches WARN("STORAGE_CLASS", 6075596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 6076d4977c78STobias Klauser } 6077d4977c78STobias Klauser 6078de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 6079de7d4f0eSAndy Whitcroft# storage class and type. 60809c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 60819c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 6082000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 6083000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 6084de7d4f0eSAndy Whitcroft } 6085de7d4f0eSAndy Whitcroft 60868905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 60872b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 60882b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 6089d5e616fcSJoe Perches if (WARN("INLINE", 6090d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 6091d5e616fcSJoe Perches $fix) { 6092194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 6093d5e616fcSJoe Perches 6094d5e616fcSJoe Perches } 60958905a67cSAndy Whitcroft } 60968905a67cSAndy Whitcroft 60973d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 60982b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 60992b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 6100000d1cc1SJoe Perches WARN("PREFER_PACKED", 6101000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 61023d130fd0SJoe Perches } 61033d130fd0SJoe Perches 610439b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 61052b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 61062b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 6107000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 6108000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 610939b7e287SJoe Perches } 611039b7e287SJoe Perches 6111462811d9SJoe Perches# Check for __attribute__ section, prefer __section 6112462811d9SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 6113462811d9SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) { 6114462811d9SJoe Perches my $old = substr($rawline, $-[1], $+[1] - $-[1]); 6115462811d9SJoe Perches my $new = substr($old, 1, -1); 6116462811d9SJoe Perches if (WARN("PREFER_SECTION", 6117462811d9SJoe Perches "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) && 6118462811d9SJoe Perches $fix) { 6119462811d9SJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/; 6120462811d9SJoe Perches } 6121462811d9SJoe Perches } 6122462811d9SJoe Perches 61235f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 61242b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 61252b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 6126d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 6127d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 6128d5e616fcSJoe Perches $fix) { 6129194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 6130d5e616fcSJoe Perches 6131d5e616fcSJoe Perches } 61325f14d3bdSJoe Perches } 61335f14d3bdSJoe Perches 61346061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 61352b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 61362b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 6137d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 6138d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 6139d5e616fcSJoe Perches $fix) { 6140194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 6141d5e616fcSJoe Perches } 61426061d949SJoe Perches } 61436061d949SJoe Perches 6144619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 61455b57980dSJoe Perches if ($perl_version_ok && 6146619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 6147619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 6148619a908aSJoe Perches $line =~ /\b__weak\b/)) { 6149619a908aSJoe Perches ERROR("WEAK_DECLARATION", 6150619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 6151619a908aSJoe Perches } 6152619a908aSJoe Perches 6153fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 6154e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 6155fd39f904STomas Winkler $realfile !~ m@\btools/@ && 6156e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 6157e6176fa4SJoe Perches my $type = $1; 6158e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 6159e6176fa4SJoe Perches $type = $1; 6160e6176fa4SJoe Perches my $kernel_type = 'u'; 6161e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 6162e6176fa4SJoe Perches $type =~ /(\d+)/; 6163e6176fa4SJoe Perches $kernel_type .= $1; 6164e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 6165e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 6166e6176fa4SJoe Perches $fix) { 6167e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 6168e6176fa4SJoe Perches } 6169e6176fa4SJoe Perches } 6170e6176fa4SJoe Perches } 6171e6176fa4SJoe Perches 6172938224b5SJoe Perches# check for cast of C90 native int or longer types constants 6173938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 6174938224b5SJoe Perches my $cast = $1; 6175938224b5SJoe Perches my $const = $2; 6176938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 6177938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 6178938224b5SJoe Perches $fix) { 6179938224b5SJoe Perches my $suffix = ""; 6180938224b5SJoe Perches my $newconst = $const; 6181938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 6182938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 6183938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 6184938224b5SJoe Perches $suffix .= 'LL'; 6185938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 6186938224b5SJoe Perches $suffix .= 'L'; 6187938224b5SJoe Perches } 6188938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 6189938224b5SJoe Perches } 6190938224b5SJoe Perches } 6191938224b5SJoe Perches 61928f53a9b8SJoe Perches# check for sizeof(&) 61938f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 6194000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 6195000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 61968f53a9b8SJoe Perches } 61978f53a9b8SJoe Perches 619866c80b60SJoe Perches# check for sizeof without parenthesis 619966c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 6200d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 6201d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 6202d5e616fcSJoe Perches $fix) { 6203194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 6204d5e616fcSJoe Perches } 620566c80b60SJoe Perches } 620666c80b60SJoe Perches 620788982feaSJoe Perches# check for struct spinlock declarations 620888982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 620988982feaSJoe Perches WARN("USE_SPINLOCK_T", 621088982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 621188982feaSJoe Perches } 621288982feaSJoe Perches 6213a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 621406668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 6215a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 6216caac1d5fSHeba Aamer $fmt =~ s/%%//g; 6217caac1d5fSHeba Aamer if ($fmt !~ /%/) { 6218d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 6219d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 6220d5e616fcSJoe Perches $fix) { 6221194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 6222d5e616fcSJoe Perches } 6223a6962d72SJoe Perches } 6224a6962d72SJoe Perches } 6225a6962d72SJoe Perches 62260b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 62275b57980dSJoe Perches if ($perl_version_ok && 62280b523769SJoe Perches defined $stat && 62290b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 62300b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 6231e3c6bc95STobin C. Harding my $stat_real; 6232e3c6bc95STobin C. Harding 62330b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 62340b523769SJoe Perches $lc = $lc + $linenr; 62350b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 6236ffe07513SJoe Perches my $specifier; 6237ffe07513SJoe Perches my $extension; 62383bd32d6aSSakari Ailus my $qualifier; 6239ffe07513SJoe Perches my $bad_specifier = ""; 62400b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 62410b523769SJoe Perches $fmt =~ s/%%//g; 6242e3c6bc95STobin C. Harding 62433bd32d6aSSakari Ailus while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) { 6244e3c6bc95STobin C. Harding $specifier = $1; 6245e3c6bc95STobin C. Harding $extension = $2; 62463bd32d6aSSakari Ailus $qualifier = $3; 6247361b0d28SLinus Torvalds if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ || 62483bd32d6aSSakari Ailus ($extension eq "f" && 62493bd32d6aSSakari Ailus defined $qualifier && $qualifier !~ /^w/)) { 6250e3c6bc95STobin C. Harding $bad_specifier = $specifier; 62510b523769SJoe Perches last; 62520b523769SJoe Perches } 6253e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 6254e3c6bc95STobin C. Harding if (!defined($stat_real)) { 6255e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 62560b523769SJoe Perches } 6257e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 6258e3c6bc95STobin 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"); 6259e3c6bc95STobin C. Harding } 6260e3c6bc95STobin C. Harding } 6261e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 62622a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 62631df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 62641df7338aSSergey Senozhatsky my $use = ""; 6265e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 62661df7338aSSergey Senozhatsky $use = " - use %pS instead"; 6267e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 62681df7338aSSergey Senozhatsky } 62692a9f9d85STobin C. Harding 62700b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 6271e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 6272e3c6bc95STobin C. Harding } 62730b523769SJoe Perches } 62740b523769SJoe Perches } 62750b523769SJoe Perches 6276554e165cSAndy Whitcroft# Check for misused memsets 62775b57980dSJoe Perches if ($perl_version_ok && 6278d1fe9c09SJoe Perches defined $stat && 62799e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 6280554e165cSAndy Whitcroft 6281d7c76ba7SJoe Perches my $ms_addr = $2; 6282d1fe9c09SJoe Perches my $ms_val = $7; 6283d1fe9c09SJoe Perches my $ms_size = $12; 6284d7c76ba7SJoe Perches 6285554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 6286554e165cSAndy Whitcroft ERROR("MEMSET", 6287d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 6288554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 6289554e165cSAndy Whitcroft WARN("MEMSET", 6290d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 6291d7c76ba7SJoe Perches } 6292d7c76ba7SJoe Perches } 6293d7c76ba7SJoe Perches 629498a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 62955b57980dSJoe Perches# if ($perl_version_ok && 6296f333195dSJoe Perches# defined $stat && 6297f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6298f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 6299f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 6300f333195dSJoe Perches# $fix) { 6301f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 6302f333195dSJoe Perches# } 6303f333195dSJoe Perches# } 630498a9bba5SJoe Perches 6305b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 63065b57980dSJoe Perches# if ($perl_version_ok && 6307f333195dSJoe Perches# defined $stat && 6308f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6309f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 6310f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 6311f333195dSJoe Perches# } 6312b6117d17SMateusz Kulikowski 63138617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 63148617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 63155b57980dSJoe Perches# if ($perl_version_ok && 6316f333195dSJoe Perches# defined $stat && 6317f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6318f333195dSJoe Perches# 6319f333195dSJoe Perches# my $ms_val = $7; 6320f333195dSJoe Perches# 6321f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 6322f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 6323f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 6324f333195dSJoe Perches# $fix) { 6325f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 6326f333195dSJoe Perches# } 6327f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 6328f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 6329f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 6330f333195dSJoe Perches# $fix) { 6331f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 6332f333195dSJoe Perches# } 6333f333195dSJoe Perches# } 6334f333195dSJoe Perches# } 63358617cd09SMateusz Kulikowski 6336d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 63375b57980dSJoe Perches if ($perl_version_ok && 6338d1fe9c09SJoe Perches defined $stat && 6339d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 6340d1fe9c09SJoe Perches if (defined $2 || defined $7) { 6341d7c76ba7SJoe Perches my $call = $1; 6342d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 6343d7c76ba7SJoe Perches my $arg1 = $3; 6344d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 6345d1fe9c09SJoe Perches my $arg2 = $8; 6346d7c76ba7SJoe Perches my $cast; 6347d7c76ba7SJoe Perches 6348d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 6349d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 6350d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 6351d7c76ba7SJoe Perches $cast = $cast1; 6352d7c76ba7SJoe Perches } else { 6353d7c76ba7SJoe Perches $cast = $cast2; 6354d7c76ba7SJoe Perches } 6355d7c76ba7SJoe Perches WARN("MINMAX", 6356d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 6357554e165cSAndy Whitcroft } 6358554e165cSAndy Whitcroft } 6359554e165cSAndy Whitcroft 63604a273195SJoe Perches# check usleep_range arguments 63615b57980dSJoe Perches if ($perl_version_ok && 63624a273195SJoe Perches defined $stat && 63634a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 63644a273195SJoe Perches my $min = $1; 63654a273195SJoe Perches my $max = $7; 63664a273195SJoe Perches if ($min eq $max) { 63674a273195SJoe Perches WARN("USLEEP_RANGE", 6368458f69efSMauro Carvalho Chehab "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 63694a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 63704a273195SJoe Perches $min > $max) { 63714a273195SJoe Perches WARN("USLEEP_RANGE", 6372458f69efSMauro Carvalho Chehab "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 63734a273195SJoe Perches } 63744a273195SJoe Perches } 63754a273195SJoe Perches 6376823b794cSJoe Perches# check for naked sscanf 63775b57980dSJoe Perches if ($perl_version_ok && 6378823b794cSJoe Perches defined $stat && 63796c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 6380823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 6381823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 6382823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 6383823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 6384823b794cSJoe Perches $lc = $lc + $linenr; 63852a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6386823b794cSJoe Perches WARN("NAKED_SSCANF", 6387823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 6388823b794cSJoe Perches } 6389823b794cSJoe Perches 6390afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 63915b57980dSJoe Perches if ($perl_version_ok && 6392afc819abSJoe Perches defined $stat && 6393afc819abSJoe Perches $line =~ /\bsscanf\b/) { 6394afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 6395afc819abSJoe Perches $lc = $lc + $linenr; 63962a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6397afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 6398afc819abSJoe Perches my $format = $6; 6399afc819abSJoe Perches my $count = $format =~ tr@%@%@; 6400afc819abSJoe Perches if ($count == 1 && 6401afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 6402afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 6403afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 6404afc819abSJoe Perches } 6405afc819abSJoe Perches } 6406afc819abSJoe Perches } 6407afc819abSJoe Perches 640870dc8a48SJoe Perches# check for new externs in .h files. 640970dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 641070dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 6411d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 641270dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 641370dc8a48SJoe Perches $fix) { 6414194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 641570dc8a48SJoe Perches } 641670dc8a48SJoe Perches } 641770dc8a48SJoe Perches 6418de7d4f0eSAndy Whitcroft# check for new externs in .c files. 6419171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 6420c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 6421171ae1a4SAndy Whitcroft { 6422c45dcabdSAndy Whitcroft my $function_name = $1; 6423c45dcabdSAndy Whitcroft my $paren_space = $2; 6424171ae1a4SAndy Whitcroft 6425171ae1a4SAndy Whitcroft my $s = $stat; 6426171ae1a4SAndy Whitcroft if (defined $cond) { 6427171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 6428171ae1a4SAndy Whitcroft } 6429d8b44b58SKees Cook if ($s =~ /^\s*;/) 6430c45dcabdSAndy Whitcroft { 6431000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6432000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6433de7d4f0eSAndy Whitcroft } 6434de7d4f0eSAndy Whitcroft 6435171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 6436000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 6437000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 6438171ae1a4SAndy Whitcroft } 64399c9ba34eSAndy Whitcroft 64409c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 64419c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 64429c9ba34eSAndy Whitcroft { 6443000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6444000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6445171ae1a4SAndy Whitcroft } 6446171ae1a4SAndy Whitcroft 6447a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 6448a0ad7596SJoe Perches if (defined $stat && 6449d8b44b58SKees Cook $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 6450d8b44b58SKees Cook $1 ne "void") { 6451d8b44b58SKees Cook my $args = trim($1); 6452ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6453ca0d8929SJoe Perches my $arg = trim($1); 6454d8b44b58SKees Cook if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 6455ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 6456ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6457ca0d8929SJoe Perches } 6458ca0d8929SJoe Perches } 6459ca0d8929SJoe Perches } 6460ca0d8929SJoe Perches 6461a0ad7596SJoe Perches# check for function definitions 64625b57980dSJoe Perches if ($perl_version_ok && 6463a0ad7596SJoe Perches defined $stat && 6464a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6465a0ad7596SJoe Perches $context_function = $1; 6466a0ad7596SJoe Perches 6467a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 6468a0ad7596SJoe Perches my $ok = 0; 6469a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 6470a0ad7596SJoe Perches my $herectx = $here . "\n"; 6471a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6472a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 6473a0ad7596SJoe Perches $herectx .= $rl . "\n"; 6474a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 6475a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 6476a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 6477a0ad7596SJoe Perches } 6478a0ad7596SJoe Perches if (!$ok) { 6479a0ad7596SJoe Perches ERROR("OPEN_BRACE", 6480a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 6481a0ad7596SJoe Perches } 6482a0ad7596SJoe Perches } 6483a0ad7596SJoe Perches 6484de7d4f0eSAndy Whitcroft# checks for new __setup's 6485de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 6486de7d4f0eSAndy Whitcroft my $name = $1; 6487de7d4f0eSAndy Whitcroft 6488de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 6489000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 64902581ac7cSTim Froidcoeur "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr); 6491de7d4f0eSAndy Whitcroft } 6492653d4876SAndy Whitcroft } 64939c0ca6f9SAndy Whitcroft 6494e29a70f1SJoe Perches# check for pointless casting of alloc functions 6495e29a70f1SJoe Perches if ($line =~ /\*\s*\)\s*$allocFunctions\b/) { 6496000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 6497000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 64989c0ca6f9SAndy Whitcroft } 649913214adfSAndy Whitcroft 6500a640d25cSJoe Perches# alloc style 6501a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 65025b57980dSJoe Perches if ($perl_version_ok && 6503e29a70f1SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 6504a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 6505a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 6506a640d25cSJoe Perches } 6507a640d25cSJoe Perches 650860a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 65095b57980dSJoe Perches if ($perl_version_ok && 65101b4a2ed4SJoe Perches defined $stat && 65111b4a2ed4SJoe Perches $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 651260a55369SJoe Perches my $oldfunc = $3; 651360a55369SJoe Perches my $a1 = $4; 651460a55369SJoe Perches my $a2 = $10; 651560a55369SJoe Perches my $newfunc = "kmalloc_array"; 651660a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 651760a55369SJoe Perches my $r1 = $a1; 651860a55369SJoe Perches my $r2 = $a2; 651960a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 652060a55369SJoe Perches $r1 = $a2; 652160a55369SJoe Perches $r2 = $a1; 652260a55369SJoe Perches } 6523e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 6524e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 65251b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 6526e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6527e3d95a2aSTobin C. Harding 6528e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 65291b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 65301b4a2ed4SJoe Perches $cnt == 1 && 6531e367455aSJoe Perches $fix) { 6532194f66fcSJoe 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; 653360a55369SJoe Perches } 653460a55369SJoe Perches } 653560a55369SJoe Perches } 653660a55369SJoe Perches 6537972fdea2SJoe Perches# check for krealloc arg reuse 65385b57980dSJoe Perches if ($perl_version_ok && 65394cab63ceSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ && 65404cab63ceSJoe Perches $1 eq $3) { 6541972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 6542972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 6543972fdea2SJoe Perches } 6544972fdea2SJoe Perches 65455ce59ae0SJoe Perches# check for alloc argument mismatch 65465ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 65475ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 65485ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 65495ce59ae0SJoe Perches } 65505ce59ae0SJoe Perches 6551caf2a54fSJoe Perches# check for multiple semicolons 6552caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 6553d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 6554d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 6555d5e616fcSJoe Perches $fix) { 6556194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 6557d5e616fcSJoe Perches } 6558d1e2ad07SJoe Perches } 6559d1e2ad07SJoe Perches 6560cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 6561cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 6562cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 65630ab90191SJoe Perches my $ull = ""; 65640ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 65650ab90191SJoe Perches if (CHK("BIT_MACRO", 65660ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 65670ab90191SJoe Perches $fix) { 65680ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 65690ab90191SJoe Perches } 65700ab90191SJoe Perches } 65710ab90191SJoe Perches 657250161266SJoe Perches# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too) 65733e89ad85SJerome Forissier if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) { 657450161266SJoe Perches WARN("IS_ENABLED_CONFIG", 65753e89ad85SJerome Forissier "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr); 657650161266SJoe Perches } 657750161266SJoe Perches 65782d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 65793e89ad85SJerome 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*$/) { 65802d632745SJoe Perches my $config = $1; 65812d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 65823e89ad85SJerome Forissier "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) && 65832d632745SJoe Perches $fix) { 65842d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 65852d632745SJoe Perches } 65862d632745SJoe Perches } 65872d632745SJoe Perches 6588f36d3eb8SJoe Perches# check for /* fallthrough */ like comment, prefer fallthrough; 6589f36d3eb8SJoe Perches my @fallthroughs = ( 6590f36d3eb8SJoe Perches 'fallthrough', 6591f36d3eb8SJoe Perches '@fallthrough@', 6592f36d3eb8SJoe Perches 'lint -fallthrough[ \t]*', 6593f36d3eb8SJoe Perches 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)', 6594f36d3eb8SJoe Perches '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?', 6595f36d3eb8SJoe Perches 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 6596f36d3eb8SJoe Perches 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 6597f36d3eb8SJoe Perches ); 6598f36d3eb8SJoe Perches if ($raw_comment ne '') { 6599f36d3eb8SJoe Perches foreach my $ft (@fallthroughs) { 6600f36d3eb8SJoe Perches if ($raw_comment =~ /$ft/) { 6601f36d3eb8SJoe Perches my $msg_level = \&WARN; 6602f36d3eb8SJoe Perches $msg_level = \&CHK if ($file); 6603f36d3eb8SJoe Perches &{$msg_level}("PREFER_FALLTHROUGH", 6604f36d3eb8SJoe Perches "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr); 6605f36d3eb8SJoe Perches last; 6606f36d3eb8SJoe Perches } 6607f36d3eb8SJoe Perches } 6608f36d3eb8SJoe Perches } 6609f36d3eb8SJoe Perches 6610d1e2ad07SJoe Perches# check for switch/default statements without a break; 66115b57980dSJoe Perches if ($perl_version_ok && 6612d1e2ad07SJoe Perches defined $stat && 6613d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 6614d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 6615e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6616e3d95a2aSTobin C. Harding 6617d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 6618d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 6619caf2a54fSJoe Perches } 6620caf2a54fSJoe Perches 662113214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 6622d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 6623d5e616fcSJoe Perches if (WARN("USE_FUNC", 6624d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 6625d5e616fcSJoe Perches $fix) { 6626194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 6627d5e616fcSJoe Perches } 662813214adfSAndy Whitcroft } 6629773647a0SAndy Whitcroft 663062ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 663162ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 663262ec818fSJoe Perches ERROR("DATE_TIME", 663362ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 663462ec818fSJoe Perches } 663562ec818fSJoe Perches 66362c92488aSJoe Perches# check for use of yield() 66372c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 66382c92488aSJoe Perches WARN("YIELD", 66392c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 66402c92488aSJoe Perches } 66412c92488aSJoe Perches 6642179f8f40SJoe Perches# check for comparisons against true and false 6643179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 6644179f8f40SJoe Perches my $lead = $1; 6645179f8f40SJoe Perches my $arg = $2; 6646179f8f40SJoe Perches my $test = $3; 6647179f8f40SJoe Perches my $otype = $4; 6648179f8f40SJoe Perches my $trail = $5; 6649179f8f40SJoe Perches my $op = "!"; 6650179f8f40SJoe Perches 6651179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 6652179f8f40SJoe Perches 6653179f8f40SJoe Perches my $type = lc($otype); 6654179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 6655179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 6656179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 6657179f8f40SJoe Perches $op = ""; 6658179f8f40SJoe Perches } 6659179f8f40SJoe Perches 6660179f8f40SJoe Perches CHK("BOOL_COMPARISON", 6661179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 6662179f8f40SJoe Perches 6663179f8f40SJoe Perches## maybe suggesting a correct construct would better 6664179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 6665179f8f40SJoe Perches 6666179f8f40SJoe Perches } 6667179f8f40SJoe Perches } 6668179f8f40SJoe Perches 66694882720bSThomas Gleixner# check for semaphores initialized locked 66704882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 6671000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 6672000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 6673773647a0SAndy Whitcroft } 66746712d858SJoe Perches 667567d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 667667d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 6677000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 667867d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 6679773647a0SAndy Whitcroft } 66806712d858SJoe Perches 6681ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 6682f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 6683000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 6684ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 6685f3db6639SMichael Ellerman } 66866712d858SJoe Perches 66873d709ab5SPaul E. McKenney# check for spin_is_locked(), suggest lockdep instead 66883d709ab5SPaul E. McKenney if ($line =~ /\bspin_is_locked\(/) { 66893d709ab5SPaul E. McKenney WARN("USE_LOCKDEP", 66903d709ab5SPaul E. McKenney "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr); 66913d709ab5SPaul E. McKenney } 66923d709ab5SPaul E. McKenney 66939189c7e7SJoe Perches# check for deprecated apis 66949189c7e7SJoe Perches if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) { 66959189c7e7SJoe Perches my $deprecated_api = $1; 66969189c7e7SJoe Perches my $new_api = $deprecated_apis{$deprecated_api}; 66979189c7e7SJoe Perches WARN("DEPRECATED_API", 66989189c7e7SJoe Perches "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr); 66999189c7e7SJoe Perches } 67009189c7e7SJoe Perches 67010f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 6702d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 6703ced69da1SQuentin Monnet if (defined($const_structs) && 6704ced69da1SQuentin Monnet $line !~ /\bconst\b/ && 6705d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 6706000d1cc1SJoe Perches WARN("CONST_STRUCT", 6707d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 67082b6db5cbSAndy Whitcroft } 6709773647a0SAndy Whitcroft 6710773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 6711773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 6712773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 6713c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 6714c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 6715171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 6716171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 6717171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 6718773647a0SAndy Whitcroft { 6719000d1cc1SJoe Perches WARN("NR_CPUS", 6720000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 6721773647a0SAndy Whitcroft } 67229c9ba34eSAndy Whitcroft 672352ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 672452ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 672552ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 672652ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 672752ea8506SJoe Perches } 672852ea8506SJoe Perches 6729acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 67305b57980dSJoe Perches if ($perl_version_ok && 6731acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 6732acd9362cSJoe Perches WARN("LIKELY_MISUSE", 6733acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 6734acd9362cSJoe Perches } 6735acd9362cSJoe Perches 6736de3f186fSDenis Efremov# nested likely/unlikely calls 6737de3f186fSDenis Efremov if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) { 6738de3f186fSDenis Efremov WARN("LIKELY_MISUSE", 6739de3f186fSDenis Efremov "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr); 6740de3f186fSDenis Efremov } 6741de3f186fSDenis Efremov 6742691d77b6SAndy Whitcroft# whine mightly about in_atomic 6743691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 6744691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 6745000d1cc1SJoe Perches ERROR("IN_ATOMIC", 6746000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 6747f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 6748000d1cc1SJoe Perches WARN("IN_ATOMIC", 6749000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 6750691d77b6SAndy Whitcroft } 6751691d77b6SAndy Whitcroft } 67521704f47bSPeter Zijlstra 67530f5225b0SPeter Zijlstra# check for mutex_trylock_recursive usage 67540f5225b0SPeter Zijlstra if ($line =~ /mutex_trylock_recursive/) { 67550f5225b0SPeter Zijlstra ERROR("LOCKING", 67560f5225b0SPeter Zijlstra "recursive locking is bad, do not use this ever.\n" . $herecurr); 67570f5225b0SPeter Zijlstra } 67580f5225b0SPeter Zijlstra 67591704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 67601704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 67611704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 67621704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 67631704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 67641704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 6765000d1cc1SJoe Perches ERROR("LOCKDEP", 6766000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 67671704f47bSPeter Zijlstra } 67681704f47bSPeter Zijlstra } 676988f8831cSDave Jones 6770b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 6771b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 6772000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 6773000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 677488f8831cSDave Jones } 67752435880fSJoe Perches 677600180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 677700180468SJoe Perches# and whether or not function naming is typical and if 677800180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 67795b57980dSJoe Perches if ($perl_version_ok && 678000180468SJoe Perches defined $stat && 678100180468SJoe 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*\)/) { 678200180468SJoe Perches my $var = $1; 678300180468SJoe Perches my $perms = $2; 678400180468SJoe Perches my $show = $3; 678500180468SJoe Perches my $store = $4; 678600180468SJoe Perches my $octal_perms = perms_to_octal($perms); 678700180468SJoe Perches if ($show =~ /^${var}_show$/ && 678800180468SJoe Perches $store =~ /^${var}_store$/ && 678900180468SJoe Perches $octal_perms eq "0644") { 679000180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 679100180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 679200180468SJoe Perches $fix) { 679300180468SJoe 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})/; 679400180468SJoe Perches } 679500180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 679600180468SJoe Perches $store =~ /^NULL$/ && 679700180468SJoe Perches $octal_perms eq "0444") { 679800180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 679900180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 680000180468SJoe Perches $fix) { 680100180468SJoe 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})/; 680200180468SJoe Perches } 680300180468SJoe Perches } elsif ($show =~ /^NULL$/ && 680400180468SJoe Perches $store =~ /^${var}_store$/ && 680500180468SJoe Perches $octal_perms eq "0200") { 680600180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 680700180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 680800180468SJoe Perches $fix) { 680900180468SJoe 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})/; 681000180468SJoe Perches } 681100180468SJoe Perches } elsif ($octal_perms eq "0644" || 681200180468SJoe Perches $octal_perms eq "0444" || 681300180468SJoe Perches $octal_perms eq "0200") { 681400180468SJoe Perches my $newshow = "$show"; 681500180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 681600180468SJoe Perches my $newstore = $store; 681700180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 681800180468SJoe Perches my $rename = ""; 681900180468SJoe Perches if ($show ne $newshow) { 682000180468SJoe Perches $rename .= " '$show' to '$newshow'"; 682100180468SJoe Perches } 682200180468SJoe Perches if ($store ne $newstore) { 682300180468SJoe Perches $rename .= " '$store' to '$newstore'"; 682400180468SJoe Perches } 682500180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 682600180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 682700180468SJoe Perches } else { 682800180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 682900180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 683000180468SJoe Perches } 683100180468SJoe Perches } 683200180468SJoe Perches 6833515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 6834515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 683573121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 683673121534SJoe Perches# specific definition of not visible in sysfs. 683773121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 683873121534SJoe Perches# use the default permissions 68395b57980dSJoe Perches if ($perl_version_ok && 6840459cf0aeSJoe Perches defined $stat && 6841515a235eSJoe Perches $line =~ /$mode_perms_search/) { 68422435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 68432435880fSJoe Perches my $func = $entry->[0]; 68442435880fSJoe Perches my $arg_pos = $entry->[1]; 68452435880fSJoe Perches 6846459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 6847459cf0aeSJoe Perches $lc = $lc + $linenr; 68482a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6849459cf0aeSJoe Perches 68502435880fSJoe Perches my $skip_args = ""; 68512435880fSJoe Perches if ($arg_pos > 1) { 68522435880fSJoe Perches $arg_pos--; 68532435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 68542435880fSJoe Perches } 6855f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 6856459cf0aeSJoe Perches if ($stat =~ /$test/) { 68572435880fSJoe Perches my $val = $1; 68582435880fSJoe Perches $val = $6 if ($skip_args ne ""); 685973121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 686073121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 686173121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 68622435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 6863459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 6864f90774e1SJoe Perches } 6865f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6866c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6867459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 68682435880fSJoe Perches } 6869459cf0aeSJoe Perches } 6870459cf0aeSJoe Perches } 6871459cf0aeSJoe Perches } 6872459cf0aeSJoe Perches 6873459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 6874bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 687500180468SJoe Perches my $oval = $1; 687600180468SJoe Perches my $octal = perms_to_octal($oval); 6877f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 6878459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 6879f90774e1SJoe Perches $fix) { 688000180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 68812435880fSJoe Perches } 688213214adfSAndy Whitcroft } 68835a6d20ceSBjorn Andersson 68845a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 68855a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 68865a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 68875a6d20ceSBjorn Andersson my $valid_licenses = qr{ 68885a6d20ceSBjorn Andersson GPL| 68895a6d20ceSBjorn Andersson GPL\ v2| 68905a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 68915a6d20ceSBjorn Andersson Dual\ BSD/GPL| 68925a6d20ceSBjorn Andersson Dual\ MIT/GPL| 68935a6d20ceSBjorn Andersson Dual\ MPL/GPL| 68945a6d20ceSBjorn Andersson Proprietary 68955a6d20ceSBjorn Andersson }x; 68965a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 68975a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 68985a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 68995a6d20ceSBjorn Andersson } 69005a6d20ceSBjorn Andersson } 69016a8d76cbSMatteo Croce 69026a8d76cbSMatteo Croce# check for sysctl duplicate constants 69036a8d76cbSMatteo Croce if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) { 69046a8d76cbSMatteo Croce WARN("DUPLICATED_SYSCTL_CONST", 69056a8d76cbSMatteo Croce "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr); 69066a8d76cbSMatteo Croce } 6907515a235eSJoe Perches } 690813214adfSAndy Whitcroft 690913214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 691013214adfSAndy Whitcroft # so just keep quiet. 691113214adfSAndy Whitcroft if ($#rawlines == -1) { 691213214adfSAndy Whitcroft exit(0); 69130a920b5bSAndy Whitcroft } 69140a920b5bSAndy Whitcroft 69158905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 69168905a67cSAndy Whitcroft # things that appear to be patches. 69178905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 69188905a67cSAndy Whitcroft exit(0); 69198905a67cSAndy Whitcroft } 69208905a67cSAndy Whitcroft 69218905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 69228905a67cSAndy Whitcroft # just keep quiet. 69238905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 69248905a67cSAndy Whitcroft exit(0); 69258905a67cSAndy Whitcroft } 69268905a67cSAndy Whitcroft 6927a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 6928000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6929000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 69300a920b5bSAndy Whitcroft } 6931cd261496SGeert Uytterhoeven if ($is_patch && $has_commit_log && $chk_signoff) { 6932cd261496SGeert Uytterhoeven if ($signoff == 0) { 6933000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6934000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 6935cd261496SGeert Uytterhoeven } elsif (!$authorsignoff) { 6936cd261496SGeert Uytterhoeven WARN("NO_AUTHOR_SIGN_OFF", 6937cd261496SGeert Uytterhoeven "Missing Signed-off-by: line by nominal patch author '$author'\n"); 6938cd261496SGeert Uytterhoeven } 69390a920b5bSAndy Whitcroft } 69400a920b5bSAndy Whitcroft 6941f0a594c1SAndy Whitcroft print report_dump(); 694213214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 694313214adfSAndy Whitcroft print "$filename " if ($summary_file); 69446c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 69456c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 69466c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 69476c72ffaaSAndy Whitcroft } 69488905a67cSAndy Whitcroft 6949d2c0a235SAndy Whitcroft if ($quiet == 0) { 6950ef212196SJoe Perches # If there were any defects found and not already fixing them 6951ef212196SJoe Perches if (!$clean and !$fix) { 6952ef212196SJoe Perches print << "EOM" 6953ef212196SJoe Perches 6954ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 6955ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 6956ef212196SJoe PerchesEOM 6957ef212196SJoe Perches } 6958d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 6959d2c0a235SAndy Whitcroft # then suggest that. 6960d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 6961b0781216SMike Frysinger $rpt_cleaners = 0; 6962d8469f16SJoe Perches print << "EOM" 6963d8469f16SJoe Perches 6964d8469f16SJoe PerchesNOTE: Whitespace errors detected. 6965d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 6966d8469f16SJoe PerchesEOM 6967d2c0a235SAndy Whitcroft } 6968d2c0a235SAndy Whitcroft } 6969d2c0a235SAndy Whitcroft 6970d752fcc8SJoe Perches if ($clean == 0 && $fix && 6971d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 6972d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 69739624b8d6SJoe Perches my $newfile = $filename; 69749624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 69753705ce5bSJoe Perches my $linecount = 0; 69763705ce5bSJoe Perches my $f; 69773705ce5bSJoe Perches 6978d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 6979d752fcc8SJoe Perches 69803705ce5bSJoe Perches open($f, '>', $newfile) 69813705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 69823705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 69833705ce5bSJoe Perches $linecount++; 69843705ce5bSJoe Perches if ($file) { 69853705ce5bSJoe Perches if ($linecount > 3) { 69863705ce5bSJoe Perches $fixed_line =~ s/^\+//; 69873705ce5bSJoe Perches print $f $fixed_line . "\n"; 69883705ce5bSJoe Perches } 69893705ce5bSJoe Perches } else { 69903705ce5bSJoe Perches print $f $fixed_line . "\n"; 69913705ce5bSJoe Perches } 69923705ce5bSJoe Perches } 69933705ce5bSJoe Perches close($f); 69943705ce5bSJoe Perches 69953705ce5bSJoe Perches if (!$quiet) { 69963705ce5bSJoe Perches print << "EOM"; 6997d8469f16SJoe Perches 69983705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 69993705ce5bSJoe Perches 70003705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 70013705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 70023705ce5bSJoe Perches 70033705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 70043705ce5bSJoe PerchesNo warranties, expressed or implied... 70053705ce5bSJoe PerchesEOM 70063705ce5bSJoe Perches } 70073705ce5bSJoe Perches } 70083705ce5bSJoe Perches 7009d8469f16SJoe Perches if ($quiet == 0) { 7010d8469f16SJoe Perches print "\n"; 7011d8469f16SJoe Perches if ($clean == 1) { 7012d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 7013d8469f16SJoe Perches } else { 7014d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 70150a920b5bSAndy Whitcroft } 70160a920b5bSAndy Whitcroft } 70170a920b5bSAndy Whitcroft return $clean; 70180a920b5bSAndy Whitcroft} 7019