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"; 6275ad8c57SJerome Forissiermy $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; 6877f5b10aSHannes Eder 6977f5b10aSHannes Edersub help { 7077f5b10aSHannes Eder my ($exitcode) = @_; 7177f5b10aSHannes Eder 7277f5b10aSHannes Eder print << "EOM"; 7377f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 7477f5b10aSHannes EderVersion: $V 7577f5b10aSHannes Eder 7677f5b10aSHannes EderOptions: 7777f5b10aSHannes Eder -q, --quiet quiet 7877f5b10aSHannes Eder --no-tree run without a kernel tree 7977f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 8077f5b10aSHannes Eder --patch treat FILE as patchfile (default) 8177f5b10aSHannes Eder --emacs emacs compile window format 8277f5b10aSHannes Eder --terse one line per report 8334d8815fSJoe Perches --showfile emit diffed file position, not input file position 844a593c34SDu, Changbin -g, --git treat FILE as a single commit or git revision range 854a593c34SDu, Changbin single git commit with: 864a593c34SDu, Changbin <rev> 874a593c34SDu, Changbin <rev>^ 884a593c34SDu, Changbin <rev>~n 894a593c34SDu, Changbin multiple git commits with: 904a593c34SDu, Changbin <rev1>..<rev2> 914a593c34SDu, Changbin <rev1>...<rev2> 924a593c34SDu, Changbin <rev>-<count> 934a593c34SDu, Changbin git merges are ignored 9477f5b10aSHannes Eder -f, --file treat FILE as regular source file 9577f5b10aSHannes Eder --subjective, --strict enable more subjective tests 963beb42ecSJoe Perches --list-types list the possible message types 9791bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 98000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 993beb42ecSJoe Perches --show-types show the specific message type in the output 100bdc48fa1SJoe Perches --max-line-length=n set the maximum line length, (default $max_line_length) 101bdc48fa1SJoe Perches if exceeded, warn on patches 102bdc48fa1SJoe Perches requires --strict for use with --file 10356193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 104bdc48fa1SJoe Perches --tab-size=n set the number of spaces for tab (default $tabsize) 10577f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 10677f5b10aSHannes Eder --no-summary suppress the per-file summary 10777f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 10877f5b10aSHannes Eder --summary-file include the filename in summary 10977f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 11077f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 11177f5b10aSHannes Eder is all off) 11277f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 11377f5b10aSHannes Eder literally 1143705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 1153705ce5bSJoe Perches If correctable single-line errors exist, create 1163705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 1173705ce5bSJoe Perches with potential errors corrected to the preferred 1183705ce5bSJoe Perches checkpatch style 1199624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 1209624b8d6SJoe Perches Is the same as --fix, but overwrites the input 1219624b8d6SJoe Perches file. It's your fault if there's no backup or git 122d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 123d62a201fSDave Hansen runtime errors. 124ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 125f1a63678SMaxim Uvarov (default:/usr/share/codespell/dictionary.txt) 126ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 12775ad8c57SJerome Forissier --typedefsfile Read additional types from this file 128737c0767SJohn Brooks --color[=WHEN] Use colors 'always', 'never', or only when output 129737c0767SJohn Brooks is a terminal ('auto'). Default is 'auto'. 13077f5b10aSHannes Eder -h, --help, --version display this help and exit 13177f5b10aSHannes Eder 13277f5b10aSHannes EderWhen FILE is - read standard input. 13377f5b10aSHannes EderEOM 13477f5b10aSHannes Eder 13577f5b10aSHannes Eder exit($exitcode); 13677f5b10aSHannes Eder} 13777f5b10aSHannes Eder 1383beb42ecSJoe Perchessub uniq { 1393beb42ecSJoe Perches my %seen; 1403beb42ecSJoe Perches return grep { !$seen{$_}++ } @_; 1413beb42ecSJoe Perches} 1423beb42ecSJoe Perches 1433beb42ecSJoe Perchessub list_types { 1443beb42ecSJoe Perches my ($exitcode) = @_; 1453beb42ecSJoe Perches 1463beb42ecSJoe Perches my $count = 0; 1473beb42ecSJoe Perches 1483beb42ecSJoe Perches local $/ = undef; 1493beb42ecSJoe Perches 1503beb42ecSJoe Perches open(my $script, '<', abs_path($P)) or 1513beb42ecSJoe Perches die "$P: Can't read '$P' $!\n"; 1523beb42ecSJoe Perches 1533beb42ecSJoe Perches my $text = <$script>; 1543beb42ecSJoe Perches close($script); 1553beb42ecSJoe Perches 1563beb42ecSJoe Perches my @types = (); 1570547fa58SJean Delvare # Also catch when type or level is passed through a variable 1580547fa58SJean Delvare for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) { 1593beb42ecSJoe Perches push (@types, $_); 1603beb42ecSJoe Perches } 1613beb42ecSJoe Perches @types = sort(uniq(@types)); 1623beb42ecSJoe Perches print("#\tMessage type\n\n"); 1633beb42ecSJoe Perches foreach my $type (@types) { 1643beb42ecSJoe Perches print(++$count . "\t" . $type . "\n"); 1653beb42ecSJoe Perches } 1663beb42ecSJoe Perches 1673beb42ecSJoe Perches exit($exitcode); 1683beb42ecSJoe Perches} 1693beb42ecSJoe Perches 170000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 171000d1cc1SJoe Perchesif (-f $conf) { 172000d1cc1SJoe Perches my @conf_args; 173000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 174000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 175000d1cc1SJoe Perches 176000d1cc1SJoe Perches while (<$conffile>) { 177000d1cc1SJoe Perches my $line = $_; 178000d1cc1SJoe Perches 179000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 180000d1cc1SJoe Perches $line =~ s/^\s*//g; 181000d1cc1SJoe Perches $line =~ s/\s+/ /g; 182000d1cc1SJoe Perches 183000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 184000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 185000d1cc1SJoe Perches 186000d1cc1SJoe Perches my @words = split(" ", $line); 187000d1cc1SJoe Perches foreach my $word (@words) { 188000d1cc1SJoe Perches last if ($word =~ m/^#/); 189000d1cc1SJoe Perches push (@conf_args, $word); 190000d1cc1SJoe Perches } 191000d1cc1SJoe Perches } 192000d1cc1SJoe Perches close($conffile); 193000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 194000d1cc1SJoe Perches} 195000d1cc1SJoe Perches 196737c0767SJohn Brooks# Perl's Getopt::Long allows options to take optional arguments after a space. 197737c0767SJohn Brooks# Prevent --color by itself from consuming other arguments 198737c0767SJohn Brooksforeach (@ARGV) { 199737c0767SJohn Brooks if ($_ eq "--color" || $_ eq "-color") { 200737c0767SJohn Brooks $_ = "--color=$color"; 201737c0767SJohn Brooks } 202737c0767SJohn Brooks} 203737c0767SJohn Brooks 2040a920b5bSAndy WhitcroftGetOptions( 2056c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 2060a920b5bSAndy Whitcroft 'tree!' => \$tree, 2070a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 2080a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 2096c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 2108905a67cSAndy Whitcroft 'terse!' => \$terse, 21134d8815fSJoe Perches 'showfile!' => \$showfile, 21277f5b10aSHannes Eder 'f|file!' => \$file, 2134a593c34SDu, Changbin 'g|git!' => \$git, 2146c72ffaaSAndy Whitcroft 'subjective!' => \$check, 2156c72ffaaSAndy Whitcroft 'strict!' => \$check, 216000d1cc1SJoe Perches 'ignore=s' => \@ignore, 21791bfe484SJoe Perches 'types=s' => \@use, 218000d1cc1SJoe Perches 'show-types!' => \$show_types, 2193beb42ecSJoe Perches 'list-types!' => \$list_types, 2206cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 22156193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 222713a09deSAntonio Borneo 'tab-size=i' => \$tabsize, 2236c72ffaaSAndy Whitcroft 'root=s' => \$root, 2248905a67cSAndy Whitcroft 'summary!' => \$summary, 2258905a67cSAndy Whitcroft 'mailback!' => \$mailback, 22613214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 2273705ce5bSJoe Perches 'fix!' => \$fix, 2289624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 229d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 230c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 231773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 232ebfd7d62SJoe Perches 'codespell!' => \$codespell, 233ebfd7d62SJoe Perches 'codespellfile=s' => \$codespellfile, 23475ad8c57SJerome Forissier 'typedefsfile=s' => \$typedefsfile, 235737c0767SJohn Brooks 'color=s' => \$color, 236737c0767SJohn Brooks 'no-color' => \$color, #keep old behaviors of -nocolor 237737c0767SJohn Brooks 'nocolor' => \$color, #keep old behaviors of -nocolor 23877f5b10aSHannes Eder 'h|help' => \$help, 23977f5b10aSHannes Eder 'version' => \$help 24077f5b10aSHannes Eder) or help(1); 24177f5b10aSHannes Eder 24277f5b10aSHannes Ederhelp(0) if ($help); 2430a920b5bSAndy Whitcroft 2443beb42ecSJoe Percheslist_types(0) if ($list_types); 2453beb42ecSJoe Perches 2469624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 2472ac73b4fSJoe Perches$check_orig = $check; 2489624b8d6SJoe Perches 2490a920b5bSAndy Whitcroftmy $exit = 0; 2500a920b5bSAndy Whitcroft 2515b57980dSJoe Perchesmy $perl_version_ok = 1; 252d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 2535b57980dSJoe Perches $perl_version_ok = 0; 254d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 2555b57980dSJoe Perches exit(1) if (!$ignore_perl_version); 256d62a201fSDave Hansen} 257d62a201fSDave Hansen 25845107ff6SAllen Hubbe#if no filenames are given, push '-' to read patch from stdin 2590a920b5bSAndy Whitcroftif ($#ARGV < 0) { 26045107ff6SAllen Hubbe push(@ARGV, '-'); 2610a920b5bSAndy Whitcroft} 2620a920b5bSAndy Whitcroft 263737c0767SJohn Brooksif ($color =~ /^[01]$/) { 264737c0767SJohn Brooks $color = !$color; 265737c0767SJohn Brooks} elsif ($color =~ /^always$/i) { 266737c0767SJohn Brooks $color = 1; 267737c0767SJohn Brooks} elsif ($color =~ /^never$/i) { 268737c0767SJohn Brooks $color = 0; 269737c0767SJohn Brooks} elsif ($color =~ /^auto$/i) { 270737c0767SJohn Brooks $color = (-t STDOUT); 271737c0767SJohn Brooks} else { 272737c0767SJohn Brooks die "Invalid color mode: $color\n"; 273737c0767SJohn Brooks} 274737c0767SJohn Brooks 275713a09deSAntonio Borneo# skip TAB size 1 to avoid additional checks on $tabsize - 1 276713a09deSAntonio Borneodie "Invalid TAB size: $tabsize\n" if ($tabsize < 2); 277713a09deSAntonio Borneo 27891bfe484SJoe Perchessub hash_save_array_words { 27991bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 28091bfe484SJoe Perches 28191bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 28291bfe484SJoe Perches foreach my $word (@array) { 283000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 284000d1cc1SJoe Perches $word =~ s/^\s*//g; 285000d1cc1SJoe Perches $word =~ s/\s+/ /g; 286000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 287000d1cc1SJoe Perches 288000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 289000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 290000d1cc1SJoe Perches 29191bfe484SJoe Perches $hashRef->{$word}++; 292000d1cc1SJoe Perches } 29391bfe484SJoe Perches} 29491bfe484SJoe Perches 29591bfe484SJoe Perchessub hash_show_words { 29691bfe484SJoe Perches my ($hashRef, $prefix) = @_; 29791bfe484SJoe Perches 2983c816e49SJoe Perches if (keys %$hashRef) { 299d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 30058cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 30191bfe484SJoe Perches print " $word"; 30291bfe484SJoe Perches } 303d8469f16SJoe Perches print "\n"; 30491bfe484SJoe Perches } 30591bfe484SJoe Perches} 30691bfe484SJoe Perches 30791bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 30891bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 309000d1cc1SJoe Perches 310c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 311c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 3127429c690SAndy Whitcroftmy $dbg_type = 0; 313a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 314c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 31521caa13cSAndy Whitcroft ## no critic 31621caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 31721caa13cSAndy Whitcroft die "$@" if ($@); 318c2fdda0dSAndy Whitcroft} 319c2fdda0dSAndy Whitcroft 320d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 321d2c0a235SAndy Whitcroft 3228905a67cSAndy Whitcroftif ($terse) { 3238905a67cSAndy Whitcroft $emacs = 1; 3248905a67cSAndy Whitcroft $quiet++; 3258905a67cSAndy Whitcroft} 3268905a67cSAndy Whitcroft 3276c72ffaaSAndy Whitcroftif ($tree) { 3286c72ffaaSAndy Whitcroft if (defined $root) { 3296c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 3306c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 3316c72ffaaSAndy Whitcroft } 3326c72ffaaSAndy Whitcroft } else { 3336c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 3346c72ffaaSAndy Whitcroft $root = '.'; 3356c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 3366c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 3376c72ffaaSAndy Whitcroft $root = $1; 3386c72ffaaSAndy Whitcroft } 3396c72ffaaSAndy Whitcroft } 3406c72ffaaSAndy Whitcroft 3416c72ffaaSAndy Whitcroft if (!defined $root) { 3420a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 3430a920b5bSAndy Whitcroft exit(2); 3440a920b5bSAndy Whitcroft } 3456c72ffaaSAndy Whitcroft} 3466c72ffaaSAndy Whitcroft 3476c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 3486c72ffaaSAndy Whitcroft 3492ceb532bSAndy Whitcroftour $Ident = qr{ 3502ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 3512ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 3522ceb532bSAndy Whitcroft }x; 3536c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 3546c72ffaaSAndy Whitcroftour $Sparse = qr{ 3556c72ffaaSAndy Whitcroft __user| 3566c72ffaaSAndy Whitcroft __kernel| 3576c72ffaaSAndy Whitcroft __force| 3586c72ffaaSAndy Whitcroft __iomem| 3596c72ffaaSAndy Whitcroft __must_check| 360417495edSAndy Whitcroft __kprobes| 361165e72a6SSven Eckelmann __ref| 36233aa4597SGeert Uytterhoeven __refconst| 36333aa4597SGeert Uytterhoeven __refdata| 364ad315455SBoqun Feng __rcu| 365ad315455SBoqun Feng __private 3666c72ffaaSAndy Whitcroft }x; 367e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 368e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 369e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 370e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 371e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 3728716de38SJoe Perches 37352131292SWolfram Sang# Notes to $Attribute: 37452131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 3756c72ffaaSAndy Whitcroftour $Attribute = qr{ 3766c72ffaaSAndy Whitcroft const| 37703f1df7dSJoe Perches __percpu| 37803f1df7dSJoe Perches __nocast| 37903f1df7dSJoe Perches __safe| 38046d832f5SMichael S. Tsirkin __bitwise| 38103f1df7dSJoe Perches __packed__| 38203f1df7dSJoe Perches __packed2__| 38303f1df7dSJoe Perches __naked| 38403f1df7dSJoe Perches __maybe_unused| 38503f1df7dSJoe Perches __always_unused| 38603f1df7dSJoe Perches __noreturn| 38703f1df7dSJoe Perches __used| 38803f1df7dSJoe Perches __cold| 389e23ef1f3SJoe Perches __pure| 39003f1df7dSJoe Perches __noclone| 39103f1df7dSJoe Perches __deprecated| 3926c72ffaaSAndy Whitcroft __read_mostly| 393c5967e98SJoe Perches __ro_after_init| 3946c72ffaaSAndy Whitcroft __kprobes| 3958716de38SJoe Perches $InitAttribute| 39624e1d81aSAndy Whitcroft ____cacheline_aligned| 39724e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 3985fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 3995fe3af11SAndy Whitcroft __weak 4006c72ffaaSAndy Whitcroft }x; 401c45dcabdSAndy Whitcroftour $Modifier; 40291cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 4036c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 4046c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 4056c72ffaaSAndy Whitcroft 40695e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 40795e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 40895e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 40995e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 4102435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 411c0a5c898SJoe Perchesour $String = qr{"[X\t]*"}; 412326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 413326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 414326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 41574349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 4162435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 417326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 418447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 41923f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 4206c72ffaaSAndy Whitcroftour $Operators = qr{ 4216c72ffaaSAndy Whitcroft <=|>=|==|!=| 4226c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 42323f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 4246c72ffaaSAndy Whitcroft }x; 4256c72ffaaSAndy Whitcroft 42691cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 42791cb5195SJoe Perches 428ab7e23f3SJoe Perchesour $BasicType; 4298905a67cSAndy Whitcroftour $NonptrType; 4301813087dSJoe Perchesour $NonptrTypeMisordered; 4318716de38SJoe Perchesour $NonptrTypeWithAttr; 4328905a67cSAndy Whitcroftour $Type; 4331813087dSJoe Perchesour $TypeMisordered; 4348905a67cSAndy Whitcroftour $Declare; 4351813087dSJoe Perchesour $DeclareMisordered; 4368905a67cSAndy Whitcroft 43715662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 43815662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 439171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 440171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 441171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 442171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 443171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 444171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 445171ae1a4SAndy Whitcroft}x; 446171ae1a4SAndy Whitcroft 44715662b3eSJoe Perchesour $UTF8 = qr{ 44815662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 44915662b3eSJoe Perches | $NON_ASCII_UTF8 45015662b3eSJoe Perches}x; 45115662b3eSJoe Perches 452e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 453021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 454021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 455021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 456021158b4SJoe Perches)}; 457e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 458fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 4598ed22cadSAndy Whitcroft atomic_t 4608ed22cadSAndy Whitcroft)}; 461e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 462e6176fa4SJoe Perches $typeC99Typedefs\b| 463e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 464e6176fa4SJoe Perches $typeKernelTypedefs\b 465e6176fa4SJoe Perches)}; 4668ed22cadSAndy Whitcroft 4676d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 4686d32f7a3SJoe Perches 469691e669bSJoe Perchesour $logFunctions = qr{(?x: 470758d7aadSMiles Chen printk(?:_ratelimited|_once|_deferred_once|_deferred|)| 4717d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 47287bd499aSJoe Perches TP_printk| 4736e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 474b0531722SJoe Perches panic| 47506668727SJoe Perches MODULE_[A-Z_]+| 47606668727SJoe Perches seq_vprintf|seq_printf|seq_puts 477691e669bSJoe Perches)}; 478691e669bSJoe Perches 479e29a70f1SJoe Perchesour $allocFunctions = qr{(?x: 480e29a70f1SJoe Perches (?:(?:devm_)? 481e29a70f1SJoe Perches (?:kv|k|v)[czm]alloc(?:_node|_array)? | 482e29a70f1SJoe Perches kstrdup(?:_const)? | 483e29a70f1SJoe Perches kmemdup(?:_nul)?) | 484461e1565SChristophe JAILLET (?:\w+)?alloc_skb(?:_ip_align)? | 485e29a70f1SJoe Perches # dev_alloc_skb/netdev_alloc_skb, et al 486e29a70f1SJoe Perches dma_alloc_coherent 487e29a70f1SJoe Perches)}; 488e29a70f1SJoe Perches 48920112475SJoe Perchesour $signature_tags = qr{(?xi: 49020112475SJoe Perches Signed-off-by:| 491d499480cSJorge Ramirez-Ortiz Co-developed-by:| 49220112475SJoe Perches Acked-by:| 49320112475SJoe Perches Tested-by:| 49420112475SJoe Perches Reviewed-by:| 49520112475SJoe Perches Reported-by:| 4968543ae12SMugunthan V N Suggested-by:| 49720112475SJoe Perches To:| 49820112475SJoe Perches Cc: 49920112475SJoe Perches)}; 50020112475SJoe Perches 5011813087dSJoe Perchesour @typeListMisordered = ( 5021813087dSJoe Perches qr{char\s+(?:un)?signed}, 5031813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 5041813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 5051813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 5061813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 5071813087dSJoe Perches qr{short\s+(?:un)?signed}, 5081813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 5091813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 5101813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 5111813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 5121813087dSJoe Perches qr{int\s+(?:un)?signed}, 5131813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 5141813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 5151813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 5161813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 5171813087dSJoe Perches qr{long\s+(?:un)?signed}, 5181813087dSJoe Perches); 5191813087dSJoe Perches 5208905a67cSAndy Whitcroftour @typeList = ( 5218905a67cSAndy Whitcroft qr{void}, 5220c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 5230c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 5240c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 5250c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 5260c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 5270c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 5280c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 5290c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 5300c773d9dSJoe Perches qr{(?:un)?signed}, 5318905a67cSAndy Whitcroft qr{float}, 5328905a67cSAndy Whitcroft qr{double}, 5338905a67cSAndy Whitcroft qr{bool}, 5348905a67cSAndy Whitcroft qr{struct\s+$Ident}, 5358905a67cSAndy Whitcroft qr{union\s+$Ident}, 5368905a67cSAndy Whitcroft qr{enum\s+$Ident}, 5378905a67cSAndy Whitcroft qr{${Ident}_t}, 5388905a67cSAndy Whitcroft qr{${Ident}_handler}, 5398905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 5401813087dSJoe Perches @typeListMisordered, 5418905a67cSAndy Whitcroft); 542938224b5SJoe Perches 543938224b5SJoe Perchesour $C90_int_types = qr{(?x: 544938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 545938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 546938224b5SJoe Perches long\s+long\s+(?:un)?signed| 547938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 548938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 549938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 550938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 551938224b5SJoe Perches 552938224b5SJoe Perches long\s+int\s+(?:un)?signed| 553938224b5SJoe Perches long\s+(?:un)?signed\s+int| 554938224b5SJoe Perches long\s+(?:un)?signed| 555938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 556938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 557938224b5SJoe Perches int\s+long\s+(?:un)?signed| 558938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 559938224b5SJoe Perches 560938224b5SJoe Perches int\s+(?:un)?signed| 561938224b5SJoe Perches (?:(?:un)?signed\s+)?int 562938224b5SJoe Perches)}; 563938224b5SJoe Perches 564485ff23eSAlex Dowadour @typeListFile = (); 5658716de38SJoe Perchesour @typeListWithAttr = ( 5668716de38SJoe Perches @typeList, 5678716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 5688716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 5698716de38SJoe Perches); 5708716de38SJoe Perches 571c45dcabdSAndy Whitcroftour @modifierList = ( 572c45dcabdSAndy Whitcroft qr{fastcall}, 573c45dcabdSAndy Whitcroft); 574485ff23eSAlex Dowadour @modifierListFile = (); 5758905a67cSAndy Whitcroft 5762435880fSJoe Perchesour @mode_permission_funcs = ( 5772435880fSJoe Perches ["module_param", 3], 5782435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 5792435880fSJoe Perches ["module_param_array_named", 5], 5802435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 5812435880fSJoe Perches ["proc_create(?:_data|)", 2], 582459cf0aeSJoe Perches ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2], 583459cf0aeSJoe Perches ["IIO_DEV_ATTR_[A-Z_]+", 1], 584459cf0aeSJoe Perches ["SENSOR_(?:DEVICE_|)ATTR_2", 2], 585459cf0aeSJoe Perches ["SENSOR_TEMPLATE(?:_2|)", 3], 586459cf0aeSJoe Perches ["__ATTR", 2], 5872435880fSJoe Perches); 5882435880fSJoe Perches 589515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 590515a235eSJoe Perchesour $mode_perms_search = ""; 591515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 592515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 593515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 594515a235eSJoe Perches} 59500180468SJoe Perches$mode_perms_search = "(?:${mode_perms_search})"; 596515a235eSJoe Perches 5979189c7e7SJoe Perchesour %deprecated_apis = ( 5989189c7e7SJoe Perches "synchronize_rcu_bh" => "synchronize_rcu", 5999189c7e7SJoe Perches "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited", 6009189c7e7SJoe Perches "call_rcu_bh" => "call_rcu", 6019189c7e7SJoe Perches "rcu_barrier_bh" => "rcu_barrier", 6029189c7e7SJoe Perches "synchronize_sched" => "synchronize_rcu", 6039189c7e7SJoe Perches "synchronize_sched_expedited" => "synchronize_rcu_expedited", 6049189c7e7SJoe Perches "call_rcu_sched" => "call_rcu", 6059189c7e7SJoe Perches "rcu_barrier_sched" => "rcu_barrier", 6069189c7e7SJoe Perches "get_state_synchronize_sched" => "get_state_synchronize_rcu", 6079189c7e7SJoe Perches "cond_synchronize_sched" => "cond_synchronize_rcu", 6089189c7e7SJoe Perches); 6099189c7e7SJoe Perches 6109189c7e7SJoe Perches#Create a search pattern for all these strings to speed up a loop below 6119189c7e7SJoe Perchesour $deprecated_apis_search = ""; 6129189c7e7SJoe Perchesforeach my $entry (keys %deprecated_apis) { 6139189c7e7SJoe Perches $deprecated_apis_search .= '|' if ($deprecated_apis_search ne ""); 6149189c7e7SJoe Perches $deprecated_apis_search .= $entry; 6159189c7e7SJoe Perches} 6169189c7e7SJoe Perches$deprecated_apis_search = "(?:${deprecated_apis_search})"; 6179189c7e7SJoe Perches 618b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 619b392c64fSJoe Perches S_IWUGO | 620b392c64fSJoe Perches S_IWOTH | 621b392c64fSJoe Perches S_IRWXUGO | 622b392c64fSJoe Perches S_IALLUGO | 623b392c64fSJoe Perches 0[0-7][0-7][2367] 624b392c64fSJoe Perches}x; 625b392c64fSJoe Perches 626f90774e1SJoe Perchesour %mode_permission_string_types = ( 627f90774e1SJoe Perches "S_IRWXU" => 0700, 628f90774e1SJoe Perches "S_IRUSR" => 0400, 629f90774e1SJoe Perches "S_IWUSR" => 0200, 630f90774e1SJoe Perches "S_IXUSR" => 0100, 631f90774e1SJoe Perches "S_IRWXG" => 0070, 632f90774e1SJoe Perches "S_IRGRP" => 0040, 633f90774e1SJoe Perches "S_IWGRP" => 0020, 634f90774e1SJoe Perches "S_IXGRP" => 0010, 635f90774e1SJoe Perches "S_IRWXO" => 0007, 636f90774e1SJoe Perches "S_IROTH" => 0004, 637f90774e1SJoe Perches "S_IWOTH" => 0002, 638f90774e1SJoe Perches "S_IXOTH" => 0001, 639f90774e1SJoe Perches "S_IRWXUGO" => 0777, 640f90774e1SJoe Perches "S_IRUGO" => 0444, 641f90774e1SJoe Perches "S_IWUGO" => 0222, 642f90774e1SJoe Perches "S_IXUGO" => 0111, 643f90774e1SJoe Perches); 644f90774e1SJoe Perches 645f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below 646f90774e1SJoe Perchesour $mode_perms_string_search = ""; 647f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) { 648f90774e1SJoe Perches $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); 649f90774e1SJoe Perches $mode_perms_string_search .= $entry; 650f90774e1SJoe Perches} 65100180468SJoe Perchesour $single_mode_perms_string_search = "(?:${mode_perms_string_search})"; 65200180468SJoe Perchesour $multi_mode_perms_string_search = qr{ 65300180468SJoe Perches ${single_mode_perms_string_search} 65400180468SJoe Perches (?:\s*\|\s*${single_mode_perms_string_search})* 65500180468SJoe Perches}x; 65600180468SJoe Perches 65700180468SJoe Perchessub perms_to_octal { 65800180468SJoe Perches my ($string) = @_; 65900180468SJoe Perches 66000180468SJoe Perches return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/); 66100180468SJoe Perches 66200180468SJoe Perches my $val = ""; 66300180468SJoe Perches my $oval = ""; 66400180468SJoe Perches my $to = 0; 66500180468SJoe Perches my $curpos = 0; 66600180468SJoe Perches my $lastpos = 0; 66700180468SJoe Perches while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) { 66800180468SJoe Perches $curpos = pos($string); 66900180468SJoe Perches my $match = $2; 67000180468SJoe Perches my $omatch = $1; 67100180468SJoe Perches last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos)); 67200180468SJoe Perches $lastpos = $curpos; 67300180468SJoe Perches $to |= $mode_permission_string_types{$match}; 67400180468SJoe Perches $val .= '\s*\|\s*' if ($val ne ""); 67500180468SJoe Perches $val .= $match; 67600180468SJoe Perches $oval .= $omatch; 67700180468SJoe Perches } 67800180468SJoe Perches $oval =~ s/^\s*\|\s*//; 67900180468SJoe Perches $oval =~ s/\s*\|\s*$//; 68000180468SJoe Perches return sprintf("%04o", $to); 68100180468SJoe Perches} 682f90774e1SJoe Perches 6837840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 6847840a94cSWolfram Sang irq| 685cdcee686SSergey Ryazanov memory| 686cdcee686SSergey Ryazanov time| 687cdcee686SSergey Ryazanov reboot 6887840a94cSWolfram Sang)}; 6897840a94cSWolfram Sang# memory.h: ARM has a custom one 6907840a94cSWolfram Sang 69166b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 69266b47b4aSKees Cookmy $misspellings; 69366b47b4aSKees Cookmy %spelling_fix; 69436061e38SJoe Perches 69536061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 69666b47b4aSKees Cook while (<$spelling>) { 69766b47b4aSKees Cook my $line = $_; 69866b47b4aSKees Cook 69966b47b4aSKees Cook $line =~ s/\s*\n?$//g; 70066b47b4aSKees Cook $line =~ s/^\s*//g; 70166b47b4aSKees Cook 70266b47b4aSKees Cook next if ($line =~ m/^\s*#/); 70366b47b4aSKees Cook next if ($line =~ m/^\s*$/); 70466b47b4aSKees Cook 70566b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 70666b47b4aSKees Cook 70766b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 70866b47b4aSKees Cook } 70966b47b4aSKees Cook close($spelling); 71036061e38SJoe Perches} else { 71136061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 71236061e38SJoe Perches} 71366b47b4aSKees Cook 714ebfd7d62SJoe Perchesif ($codespell) { 715ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 716ebfd7d62SJoe Perches while (<$spelling>) { 717ebfd7d62SJoe Perches my $line = $_; 718ebfd7d62SJoe Perches 719ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 720ebfd7d62SJoe Perches $line =~ s/^\s*//g; 721ebfd7d62SJoe Perches 722ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 723ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 724ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 725ebfd7d62SJoe Perches 726ebfd7d62SJoe Perches $line =~ s/,.*$//; 727ebfd7d62SJoe Perches 728ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 729ebfd7d62SJoe Perches 730ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 731ebfd7d62SJoe Perches } 732ebfd7d62SJoe Perches close($spelling); 733ebfd7d62SJoe Perches } else { 734ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 735ebfd7d62SJoe Perches } 736ebfd7d62SJoe Perches} 737ebfd7d62SJoe Perches 738ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 739ebfd7d62SJoe Perches 74075ad8c57SJerome Forissiersub read_words { 74175ad8c57SJerome Forissier my ($wordsRef, $file) = @_; 74275ad8c57SJerome Forissier 74375ad8c57SJerome Forissier if (open(my $words, '<', $file)) { 74475ad8c57SJerome Forissier while (<$words>) { 745bf1fa1daSJoe Perches my $line = $_; 746bf1fa1daSJoe Perches 747bf1fa1daSJoe Perches $line =~ s/\s*\n?$//g; 748bf1fa1daSJoe Perches $line =~ s/^\s*//g; 749bf1fa1daSJoe Perches 750bf1fa1daSJoe Perches next if ($line =~ m/^\s*#/); 751bf1fa1daSJoe Perches next if ($line =~ m/^\s*$/); 752bf1fa1daSJoe Perches if ($line =~ /\s/) { 75375ad8c57SJerome Forissier print("$file: '$line' invalid - ignored\n"); 754bf1fa1daSJoe Perches next; 755bf1fa1daSJoe Perches } 756bf1fa1daSJoe Perches 75775ad8c57SJerome Forissier $$wordsRef .= '|' if ($$wordsRef ne ""); 75875ad8c57SJerome Forissier $$wordsRef .= $line; 759bf1fa1daSJoe Perches } 76075ad8c57SJerome Forissier close($file); 76175ad8c57SJerome Forissier return 1; 762bf1fa1daSJoe Perches } 763bf1fa1daSJoe Perches 76475ad8c57SJerome Forissier return 0; 76575ad8c57SJerome Forissier} 76675ad8c57SJerome Forissier 76775ad8c57SJerome Forissiermy $const_structs = ""; 76875ad8c57SJerome Forissierread_words(\$const_structs, $conststructsfile) 76975ad8c57SJerome Forissier or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 77075ad8c57SJerome Forissier 77175ad8c57SJerome Forissiermy $typeOtherTypedefs = ""; 77275ad8c57SJerome Forissierif (length($typedefsfile)) { 77375ad8c57SJerome Forissier read_words(\$typeOtherTypedefs, $typedefsfile) 77475ad8c57SJerome Forissier or warn "No additional types will be considered - file '$typedefsfile': $!\n"; 77575ad8c57SJerome Forissier} 77675ad8c57SJerome Forissier$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne ""); 77775ad8c57SJerome Forissier 7788905a67cSAndy Whitcroftsub build_types { 779485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 780485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 7811813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 7828716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 783c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 784ab7e23f3SJoe Perches $BasicType = qr{ 785ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 786ab7e23f3SJoe Perches (?:${all}\b) 787ab7e23f3SJoe Perches }x; 7888905a67cSAndy Whitcroft $NonptrType = qr{ 789d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 790cf655043SAndy Whitcroft (?: 7916b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 7928ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 793c45dcabdSAndy Whitcroft (?:${all}\b) 794cf655043SAndy Whitcroft ) 795c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 7968905a67cSAndy Whitcroft }x; 7971813087dSJoe Perches $NonptrTypeMisordered = qr{ 7981813087dSJoe Perches (?:$Modifier\s+|const\s+)* 7991813087dSJoe Perches (?: 8001813087dSJoe Perches (?:${Misordered}\b) 8011813087dSJoe Perches ) 8021813087dSJoe Perches (?:\s+$Modifier|\s+const)* 8031813087dSJoe Perches }x; 8048716de38SJoe Perches $NonptrTypeWithAttr = qr{ 8058716de38SJoe Perches (?:$Modifier\s+|const\s+)* 8068716de38SJoe Perches (?: 8078716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 8088716de38SJoe Perches (?:$typeTypedefs\b)| 8098716de38SJoe Perches (?:${allWithAttr}\b) 8108716de38SJoe Perches ) 8118716de38SJoe Perches (?:\s+$Modifier|\s+const)* 8128716de38SJoe Perches }x; 8138905a67cSAndy Whitcroft $Type = qr{ 814c45dcabdSAndy Whitcroft $NonptrType 8157b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 816c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 8178905a67cSAndy Whitcroft }x; 8181813087dSJoe Perches $TypeMisordered = qr{ 8191813087dSJoe Perches $NonptrTypeMisordered 8207b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 8211813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 8221813087dSJoe Perches }x; 82391cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 8241813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 8258905a67cSAndy Whitcroft} 8268905a67cSAndy Whitcroftbuild_types(); 8276c72ffaaSAndy Whitcroft 8287d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 829d1fe9c09SJoe Perches 830d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 831d1fe9c09SJoe Perches# requires at least perl version v5.10.0 832d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 833d1fe9c09SJoe Perches 834d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 8352435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 836c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 8377d2367afSJoe Perches 838f8422308SJoe Perchesour $declaration_macros = qr{(?x: 8393e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 840fe658f94SSteffen Maier (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(| 8413d102fc0SGilad Ben-Yossef (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(| 8423d102fc0SGilad Ben-Yossef (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\( 843f8422308SJoe Perches)}; 844f8422308SJoe Perches 8457d2367afSJoe Perchessub deparenthesize { 8467d2367afSJoe Perches my ($string) = @_; 8477d2367afSJoe Perches return "" if (!defined($string)); 8485b9553abSJoe Perches 8495b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 8505b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 8515b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 8525b9553abSJoe Perches } 8535b9553abSJoe Perches 8547d2367afSJoe Perches $string =~ s@\s+@ @g; 8555b9553abSJoe Perches 8567d2367afSJoe Perches return $string; 8577d2367afSJoe Perches} 8587d2367afSJoe Perches 8593445686aSJoe Perchessub seed_camelcase_file { 8603445686aSJoe Perches my ($file) = @_; 8613445686aSJoe Perches 8623445686aSJoe Perches return if (!(-f $file)); 8633445686aSJoe Perches 8643445686aSJoe Perches local $/; 8653445686aSJoe Perches 8663445686aSJoe Perches open(my $include_file, '<', "$file") 8673445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 8683445686aSJoe Perches my $text = <$include_file>; 8693445686aSJoe Perches close($include_file); 8703445686aSJoe Perches 8713445686aSJoe Perches my @lines = split('\n', $text); 8723445686aSJoe Perches 8733445686aSJoe Perches foreach my $line (@lines) { 8743445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 8753445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 8763445686aSJoe Perches $camelcase{$1} = 1; 87711ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 87811ea516aSJoe Perches $camelcase{$1} = 1; 87911ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 8803445686aSJoe Perches $camelcase{$1} = 1; 8813445686aSJoe Perches } 8823445686aSJoe Perches } 8833445686aSJoe Perches} 8843445686aSJoe Perches 885cd28b119SJoe Perchesour %maintained_status = (); 886cd28b119SJoe Perches 88785b0ee18SJoe Perchessub is_maintained_obsolete { 88885b0ee18SJoe Perches my ($filename) = @_; 88985b0ee18SJoe Perches 890f2c19c2fSJerome Forissier return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 89185b0ee18SJoe Perches 892cd28b119SJoe Perches if (!exists($maintained_status{$filename})) { 893cd28b119SJoe Perches $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 894cd28b119SJoe Perches } 89585b0ee18SJoe Perches 896cd28b119SJoe Perches return $maintained_status{$filename} =~ /obsolete/i; 89785b0ee18SJoe Perches} 89885b0ee18SJoe Perches 8993b6e8ac9SJoe Perchessub is_SPDX_License_valid { 9003b6e8ac9SJoe Perches my ($license) = @_; 9013b6e8ac9SJoe Perches 90256294112SJoe Perches return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git")); 9033b6e8ac9SJoe Perches 90456294112SJoe Perches my $root_path = abs_path($root); 90556294112SJoe Perches my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`; 9063b6e8ac9SJoe Perches return 0 if ($status ne ""); 9073b6e8ac9SJoe Perches return 1; 9083b6e8ac9SJoe Perches} 9093b6e8ac9SJoe Perches 9103445686aSJoe Perchesmy $camelcase_seeded = 0; 9113445686aSJoe Perchessub seed_camelcase_includes { 9123445686aSJoe Perches return if ($camelcase_seeded); 9133445686aSJoe Perches 9143445686aSJoe Perches my $files; 915c707a81dSJoe Perches my $camelcase_cache = ""; 916c707a81dSJoe Perches my @include_files = (); 917c707a81dSJoe Perches 918c707a81dSJoe Perches $camelcase_seeded = 1; 919351b2a1fSJoe Perches 9203645e328SRichard Genoud if (-e ".git") { 921dbbf869dSJoe Perches my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`; 922351b2a1fSJoe Perches chomp $git_last_include_commit; 923c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 924c707a81dSJoe Perches } else { 925c707a81dSJoe Perches my $last_mod_date = 0; 926c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 927c707a81dSJoe Perches @include_files = split('\n', $files); 928c707a81dSJoe Perches foreach my $file (@include_files) { 929c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 930c707a81dSJoe Perches localtime((stat $file)[9])); 931c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 932c707a81dSJoe Perches } 933c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 934c707a81dSJoe Perches } 935c707a81dSJoe Perches 936c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 937c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 938c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 939351b2a1fSJoe Perches while (<$camelcase_file>) { 940351b2a1fSJoe Perches chomp; 941351b2a1fSJoe Perches $camelcase{$_} = 1; 942351b2a1fSJoe Perches } 943351b2a1fSJoe Perches close($camelcase_file); 944351b2a1fSJoe Perches 945351b2a1fSJoe Perches return; 946351b2a1fSJoe Perches } 947c707a81dSJoe Perches 9483645e328SRichard Genoud if (-e ".git") { 949dbbf869dSJoe Perches $files = `${git_command} ls-files "include/*.h"`; 950c707a81dSJoe Perches @include_files = split('\n', $files); 9513445686aSJoe Perches } 952c707a81dSJoe Perches 9533445686aSJoe Perches foreach my $file (@include_files) { 9543445686aSJoe Perches seed_camelcase_file($file); 9553445686aSJoe Perches } 956351b2a1fSJoe Perches 957c707a81dSJoe Perches if ($camelcase_cache ne "") { 958351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 959c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 960c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 961351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 962351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 963351b2a1fSJoe Perches } 964351b2a1fSJoe Perches close($camelcase_file); 965351b2a1fSJoe Perches } 9663445686aSJoe Perches} 9673445686aSJoe Perches 968d311cd44SJoe Perchessub git_commit_info { 969d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 970d311cd44SJoe Perches 971d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 972d311cd44SJoe Perches 973dbbf869dSJoe Perches my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`; 974d311cd44SJoe Perches $output =~ s/^\s*//gm; 975d311cd44SJoe Perches my @lines = split("\n", $output); 976d311cd44SJoe Perches 9770d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 9780d7835fcSJoe Perches 9795a7f4455SSean Christopherson if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) { 980d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 981d311cd44SJoe Perches# all matching commit ids, but it's very slow... 982d311cd44SJoe Perches# 983d311cd44SJoe Perches# echo "checking commits $1..." 984d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 985d311cd44SJoe Perches# while read line ; do 986d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 987d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 988d311cd44SJoe Perches# done 989d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 990948b133aSHeinrich Schuchardt $id = undef; 991d311cd44SJoe Perches } else { 992d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 993d311cd44SJoe Perches $desc = substr($lines[0], 41); 994d311cd44SJoe Perches } 995d311cd44SJoe Perches 996d311cd44SJoe Perches return ($id, $desc); 997d311cd44SJoe Perches} 998d311cd44SJoe Perches 9996c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 10000a920b5bSAndy Whitcroft 100100df344fSAndy Whitcroftmy @rawlines = (); 1002c2fdda0dSAndy Whitcroftmy @lines = (); 10033705ce5bSJoe Perchesmy @fixed = (); 1004d752fcc8SJoe Perchesmy @fixed_inserted = (); 1005d752fcc8SJoe Perchesmy @fixed_deleted = (); 1006194f66fcSJoe Perchesmy $fixlinenr = -1; 1007194f66fcSJoe Perches 10084a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 10094a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 10104a593c34SDu, Changbindie "$P: No git repository found\n" if ($git && !-e ".git"); 10114a593c34SDu, Changbin 10124a593c34SDu, Changbinif ($git) { 10134a593c34SDu, Changbin my @commits = (); 10140dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 10154a593c34SDu, Changbin my $git_range; 101628898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 101728898fd1SJoe Perches $git_range = "-$2 $1"; 10184a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 10194a593c34SDu, Changbin $git_range = "$commit_expr"; 10204a593c34SDu, Changbin } else { 10210dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 10220dea9f1eSJoe Perches } 1023dbbf869dSJoe Perches my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 10240dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 102528898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 102628898fd1SJoe Perches next if (!defined($1) || !defined($2)); 10270dea9f1eSJoe Perches my $sha1 = $1; 10280dea9f1eSJoe Perches my $subject = $2; 10290dea9f1eSJoe Perches unshift(@commits, $sha1); 10300dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 10314a593c34SDu, Changbin } 10324a593c34SDu, Changbin } 10334a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 10344a593c34SDu, Changbin @ARGV = @commits; 10354a593c34SDu, Changbin} 10364a593c34SDu, Changbin 1037c2fdda0dSAndy Whitcroftmy $vname; 103898005e8cSVadim Bendebury$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"}; 10396c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 104021caa13cSAndy Whitcroft my $FILE; 10414a593c34SDu, Changbin if ($git) { 10424a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 10434a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 10444a593c34SDu, Changbin } elsif ($file) { 104521caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 10466c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 104721caa13cSAndy Whitcroft } elsif ($filename eq '-') { 104821caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 10496c72ffaaSAndy Whitcroft } else { 105021caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 10516c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 10526c72ffaaSAndy Whitcroft } 1053c2fdda0dSAndy Whitcroft if ($filename eq '-') { 1054c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 10554a593c34SDu, Changbin } elsif ($git) { 10560dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 1057c2fdda0dSAndy Whitcroft } else { 1058c2fdda0dSAndy Whitcroft $vname = $filename; 1059c2fdda0dSAndy Whitcroft } 106021caa13cSAndy Whitcroft while (<$FILE>) { 10610a920b5bSAndy Whitcroft chomp; 106200df344fSAndy Whitcroft push(@rawlines, $_); 10636c72ffaaSAndy Whitcroft } 106421caa13cSAndy Whitcroft close($FILE); 1065d8469f16SJoe Perches 1066d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 1067d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1068d8469f16SJoe Perches print "$vname\n"; 1069d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1070d8469f16SJoe Perches } 1071d8469f16SJoe Perches 1072c2fdda0dSAndy Whitcroft if (!process($filename)) { 10730a920b5bSAndy Whitcroft $exit = 1; 10740a920b5bSAndy Whitcroft } 107500df344fSAndy Whitcroft @rawlines = (); 107613214adfSAndy Whitcroft @lines = (); 10773705ce5bSJoe Perches @fixed = (); 1078d752fcc8SJoe Perches @fixed_inserted = (); 1079d752fcc8SJoe Perches @fixed_deleted = (); 1080194f66fcSJoe Perches $fixlinenr = -1; 1081485ff23eSAlex Dowad @modifierListFile = (); 1082485ff23eSAlex Dowad @typeListFile = (); 1083485ff23eSAlex Dowad build_types(); 10840a920b5bSAndy Whitcroft} 10850a920b5bSAndy Whitcroft 1086d8469f16SJoe Perchesif (!$quiet) { 10873c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 10883c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 10893c816e49SJoe Perches 10905b57980dSJoe Perches if (!$perl_version_ok) { 1091d8469f16SJoe Perches print << "EOM" 1092d8469f16SJoe Perches 1093d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 10945b57980dSJoe Perches An upgrade to at least perl $minimum_perl_version is suggested. 1095d8469f16SJoe PerchesEOM 1096d8469f16SJoe Perches } 1097d8469f16SJoe Perches if ($exit) { 1098d8469f16SJoe Perches print << "EOM" 1099d8469f16SJoe Perches 1100d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 1101d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 1102d8469f16SJoe PerchesEOM 1103d8469f16SJoe Perches } 1104d8469f16SJoe Perches} 1105d8469f16SJoe Perches 11060a920b5bSAndy Whitcroftexit($exit); 11070a920b5bSAndy Whitcroft 11080a920b5bSAndy Whitcroftsub top_of_kernel_tree { 11096c72ffaaSAndy Whitcroft my ($root) = @_; 11106c72ffaaSAndy Whitcroft 11116c72ffaaSAndy Whitcroft my @tree_check = ( 11126c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 11136c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 11146c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 11156c72ffaaSAndy Whitcroft ); 11166c72ffaaSAndy Whitcroft 11176c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 11186c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 11190a920b5bSAndy Whitcroft return 0; 11200a920b5bSAndy Whitcroft } 11216c72ffaaSAndy Whitcroft } 11226c72ffaaSAndy Whitcroft return 1; 11236c72ffaaSAndy Whitcroft} 11240a920b5bSAndy Whitcroft 112520112475SJoe Perchessub parse_email { 112620112475SJoe Perches my ($formatted_email) = @_; 112720112475SJoe Perches 112820112475SJoe Perches my $name = ""; 1129dfa05c28SJoe Perches my $name_comment = ""; 113020112475SJoe Perches my $address = ""; 113120112475SJoe Perches my $comment = ""; 113220112475SJoe Perches 113320112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 113420112475SJoe Perches $name = $1; 113520112475SJoe Perches $address = $2; 113620112475SJoe Perches $comment = $3 if defined $3; 113720112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 113820112475SJoe Perches $address = $1; 113920112475SJoe Perches $comment = $2 if defined $2; 114020112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 114120112475SJoe Perches $address = $1; 114220112475SJoe Perches $comment = $2 if defined $2; 114385e12066SJoe Perches $formatted_email =~ s/\Q$address\E.*$//; 114420112475SJoe Perches $name = $formatted_email; 11453705ce5bSJoe Perches $name = trim($name); 114620112475SJoe Perches $name =~ s/^\"|\"$//g; 114720112475SJoe Perches # If there's a name left after stripping spaces and 114820112475SJoe Perches # leading quotes, and the address doesn't have both 114920112475SJoe Perches # leading and trailing angle brackets, the address 115020112475SJoe Perches # is invalid. ie: 115120112475SJoe Perches # "joe smith [email protected]" bad 115220112475SJoe Perches # "joe smith <[email protected]" bad 115320112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 115420112475SJoe Perches $name = ""; 115520112475SJoe Perches $address = ""; 115620112475SJoe Perches $comment = ""; 115720112475SJoe Perches } 115820112475SJoe Perches } 115920112475SJoe Perches 11603705ce5bSJoe Perches $name = trim($name); 116120112475SJoe Perches $name =~ s/^\"|\"$//g; 1162dfa05c28SJoe Perches $name =~ s/(\s*\([^\)]+\))\s*//; 1163dfa05c28SJoe Perches if (defined($1)) { 1164dfa05c28SJoe Perches $name_comment = trim($1); 1165dfa05c28SJoe Perches } 11663705ce5bSJoe Perches $address = trim($address); 116720112475SJoe Perches $address =~ s/^\<|\>$//g; 116820112475SJoe Perches 116920112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 117020112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 117120112475SJoe Perches $name = "\"$name\""; 117220112475SJoe Perches } 117320112475SJoe Perches 1174dfa05c28SJoe Perches return ($name, $name_comment, $address, $comment); 117520112475SJoe Perches} 117620112475SJoe Perches 117720112475SJoe Perchessub format_email { 117820112475SJoe Perches my ($name, $address) = @_; 117920112475SJoe Perches 118020112475SJoe Perches my $formatted_email; 118120112475SJoe Perches 11823705ce5bSJoe Perches $name = trim($name); 118320112475SJoe Perches $name =~ s/^\"|\"$//g; 11843705ce5bSJoe Perches $address = trim($address); 118520112475SJoe Perches 118620112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 118720112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 118820112475SJoe Perches $name = "\"$name\""; 118920112475SJoe Perches } 119020112475SJoe Perches 119120112475SJoe Perches if ("$name" eq "") { 119220112475SJoe Perches $formatted_email = "$address"; 119320112475SJoe Perches } else { 119420112475SJoe Perches $formatted_email = "$name <$address>"; 119520112475SJoe Perches } 119620112475SJoe Perches 119720112475SJoe Perches return $formatted_email; 119820112475SJoe Perches} 119920112475SJoe Perches 1200dfa05c28SJoe Perchessub reformat_email { 1201dfa05c28SJoe Perches my ($email) = @_; 1202dfa05c28SJoe Perches 1203dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 1204dfa05c28SJoe Perches return format_email($email_name, $email_address); 1205dfa05c28SJoe Perches} 1206dfa05c28SJoe Perches 1207dfa05c28SJoe Perchessub same_email_addresses { 1208dfa05c28SJoe Perches my ($email1, $email2) = @_; 1209dfa05c28SJoe Perches 1210dfa05c28SJoe Perches my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1); 1211dfa05c28SJoe Perches my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2); 1212dfa05c28SJoe Perches 1213dfa05c28SJoe Perches return $email1_name eq $email2_name && 1214dfa05c28SJoe Perches $email1_address eq $email2_address; 1215dfa05c28SJoe Perches} 1216dfa05c28SJoe Perches 1217d311cd44SJoe Perchessub which { 1218d311cd44SJoe Perches my ($bin) = @_; 1219d311cd44SJoe Perches 1220d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1221d311cd44SJoe Perches if (-e "$path/$bin") { 1222d311cd44SJoe Perches return "$path/$bin"; 1223d311cd44SJoe Perches } 1224d311cd44SJoe Perches } 1225d311cd44SJoe Perches 1226d311cd44SJoe Perches return ""; 1227d311cd44SJoe Perches} 1228d311cd44SJoe Perches 1229000d1cc1SJoe Perchessub which_conf { 1230000d1cc1SJoe Perches my ($conf) = @_; 1231000d1cc1SJoe Perches 1232000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1233000d1cc1SJoe Perches if (-e "$path/$conf") { 1234000d1cc1SJoe Perches return "$path/$conf"; 1235000d1cc1SJoe Perches } 1236000d1cc1SJoe Perches } 1237000d1cc1SJoe Perches 1238000d1cc1SJoe Perches return ""; 1239000d1cc1SJoe Perches} 1240000d1cc1SJoe Perches 12410a920b5bSAndy Whitcroftsub expand_tabs { 12420a920b5bSAndy Whitcroft my ($str) = @_; 12430a920b5bSAndy Whitcroft 12440a920b5bSAndy Whitcroft my $res = ''; 12450a920b5bSAndy Whitcroft my $n = 0; 12460a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 12470a920b5bSAndy Whitcroft if ($c eq "\t") { 12480a920b5bSAndy Whitcroft $res .= ' '; 12490a920b5bSAndy Whitcroft $n++; 1250713a09deSAntonio Borneo for (; ($n % $tabsize) != 0; $n++) { 12510a920b5bSAndy Whitcroft $res .= ' '; 12520a920b5bSAndy Whitcroft } 12530a920b5bSAndy Whitcroft next; 12540a920b5bSAndy Whitcroft } 12550a920b5bSAndy Whitcroft $res .= $c; 12560a920b5bSAndy Whitcroft $n++; 12570a920b5bSAndy Whitcroft } 12580a920b5bSAndy Whitcroft 12590a920b5bSAndy Whitcroft return $res; 12600a920b5bSAndy Whitcroft} 12616c72ffaaSAndy Whitcroftsub copy_spacing { 1262773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 12636c72ffaaSAndy Whitcroft return $res; 12646c72ffaaSAndy Whitcroft} 12650a920b5bSAndy Whitcroft 12664a0df2efSAndy Whitcroftsub line_stats { 12674a0df2efSAndy Whitcroft my ($line) = @_; 12684a0df2efSAndy Whitcroft 12694a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 12704a0df2efSAndy Whitcroft $line =~ s/^.//; 12714a0df2efSAndy Whitcroft $line = expand_tabs($line); 12724a0df2efSAndy Whitcroft 12734a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 12744a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 12754a0df2efSAndy Whitcroft 12764a0df2efSAndy Whitcroft return (length($line), length($white)); 12774a0df2efSAndy Whitcroft} 12784a0df2efSAndy Whitcroft 1279773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1280773647a0SAndy Whitcroft 1281773647a0SAndy Whitcroftsub sanitise_line_reset { 1282773647a0SAndy Whitcroft my ($in_comment) = @_; 1283773647a0SAndy Whitcroft 1284773647a0SAndy Whitcroft if ($in_comment) { 1285773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1286773647a0SAndy Whitcroft } else { 1287773647a0SAndy Whitcroft $sanitise_quote = ''; 1288773647a0SAndy Whitcroft } 1289773647a0SAndy Whitcroft} 129000df344fSAndy Whitcroftsub sanitise_line { 129100df344fSAndy Whitcroft my ($line) = @_; 129200df344fSAndy Whitcroft 129300df344fSAndy Whitcroft my $res = ''; 129400df344fSAndy Whitcroft my $l = ''; 129500df344fSAndy Whitcroft 1296c2fdda0dSAndy Whitcroft my $qlen = 0; 1297773647a0SAndy Whitcroft my $off = 0; 1298773647a0SAndy Whitcroft my $c; 129900df344fSAndy Whitcroft 1300773647a0SAndy Whitcroft # Always copy over the diff marker. 1301773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1302773647a0SAndy Whitcroft 1303773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1304773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1305773647a0SAndy Whitcroft 13068d2e11b2SClaudio Fontana # Comments we are whacking completely including the begin 1307773647a0SAndy Whitcroft # and end, all to $;. 1308773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1309773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1310773647a0SAndy Whitcroft 1311773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1312773647a0SAndy Whitcroft $off++; 131300df344fSAndy Whitcroft next; 1314773647a0SAndy Whitcroft } 131581bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1316773647a0SAndy Whitcroft $sanitise_quote = ''; 1317773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1318773647a0SAndy Whitcroft $off++; 1319773647a0SAndy Whitcroft next; 1320773647a0SAndy Whitcroft } 1321113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1322113f04a8SDaniel Walker $sanitise_quote = '//'; 1323113f04a8SDaniel Walker 1324113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1325113f04a8SDaniel Walker $off++; 1326113f04a8SDaniel Walker next; 1327113f04a8SDaniel Walker } 1328773647a0SAndy Whitcroft 1329773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1330773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1331773647a0SAndy Whitcroft $c eq "\\") { 1332773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1333773647a0SAndy Whitcroft $off++; 1334773647a0SAndy Whitcroft next; 1335773647a0SAndy Whitcroft } 1336773647a0SAndy Whitcroft # Regular quotes. 1337773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1338773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1339773647a0SAndy Whitcroft $sanitise_quote = $c; 1340773647a0SAndy Whitcroft 1341773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1342773647a0SAndy Whitcroft next; 1343773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1344773647a0SAndy Whitcroft $sanitise_quote = ''; 134500df344fSAndy Whitcroft } 134600df344fSAndy Whitcroft } 1347773647a0SAndy Whitcroft 1348fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1349773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1350773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1351113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1352113f04a8SDaniel Walker substr($res, $off, 1, $;); 1353773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1354773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 135500df344fSAndy Whitcroft } else { 1356773647a0SAndy Whitcroft substr($res, $off, 1, $c); 135700df344fSAndy Whitcroft } 1358c2fdda0dSAndy Whitcroft } 1359c2fdda0dSAndy Whitcroft 1360113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1361113f04a8SDaniel Walker $sanitise_quote = ''; 1362113f04a8SDaniel Walker } 1363113f04a8SDaniel Walker 1364c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1365c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1366c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1367c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1368c2fdda0dSAndy Whitcroft 1369c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1370c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1371c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1372c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1373c2fdda0dSAndy Whitcroft } 1374c2fdda0dSAndy Whitcroft 1375dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1376dadf680dSJoe Perches my $match = $1; 1377dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1378dadf680dSJoe Perches } 1379dadf680dSJoe Perches 138000df344fSAndy Whitcroft return $res; 138100df344fSAndy Whitcroft} 138200df344fSAndy Whitcroft 1383a6962d72SJoe Perchessub get_quoted_string { 1384a6962d72SJoe Perches my ($line, $rawline) = @_; 1385a6962d72SJoe Perches 1386478b1799SJoe Perches return "" if (!defined($line) || !defined($rawline)); 138733acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1388a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1389a6962d72SJoe Perches} 1390a6962d72SJoe Perches 13918905a67cSAndy Whitcroftsub ctx_statement_block { 13928905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 13938905a67cSAndy Whitcroft my $line = $linenr - 1; 13948905a67cSAndy Whitcroft my $blk = ''; 13958905a67cSAndy Whitcroft my $soff = $off; 13968905a67cSAndy Whitcroft my $coff = $off - 1; 1397773647a0SAndy Whitcroft my $coff_set = 0; 13988905a67cSAndy Whitcroft 139913214adfSAndy Whitcroft my $loff = 0; 140013214adfSAndy Whitcroft 14018905a67cSAndy Whitcroft my $type = ''; 14028905a67cSAndy Whitcroft my $level = 0; 1403a2750645SAndy Whitcroft my @stack = (); 1404cf655043SAndy Whitcroft my $p; 14058905a67cSAndy Whitcroft my $c; 14068905a67cSAndy Whitcroft my $len = 0; 140713214adfSAndy Whitcroft 140813214adfSAndy Whitcroft my $remainder; 14098905a67cSAndy Whitcroft while (1) { 1410a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1411a2750645SAndy Whitcroft 1412773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 14138905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 14148905a67cSAndy Whitcroft # context. 14158905a67cSAndy Whitcroft if ($off >= $len) { 14168905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1417dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1418c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 14198905a67cSAndy Whitcroft $remain--; 142013214adfSAndy Whitcroft $loff = $len; 1421c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 14228905a67cSAndy Whitcroft $len = length($blk); 14238905a67cSAndy Whitcroft $line++; 14248905a67cSAndy Whitcroft last; 14258905a67cSAndy Whitcroft } 14268905a67cSAndy Whitcroft # Bail if there is no further context. 14278905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 142813214adfSAndy Whitcroft if ($off >= $len) { 14298905a67cSAndy Whitcroft last; 14308905a67cSAndy Whitcroft } 1431f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1432f74bd194SAndy Whitcroft $level++; 1433f74bd194SAndy Whitcroft $type = '#'; 1434f74bd194SAndy Whitcroft } 14358905a67cSAndy Whitcroft } 1436cf655043SAndy Whitcroft $p = $c; 14378905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 143813214adfSAndy Whitcroft $remainder = substr($blk, $off); 14398905a67cSAndy Whitcroft 1440773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 14414635f4fbSAndy Whitcroft 14424635f4fbSAndy Whitcroft # Handle nested #if/#else. 14434635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 14444635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 14454635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 14464635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 14474635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 14484635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 14494635f4fbSAndy Whitcroft } 14504635f4fbSAndy Whitcroft 14518905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 14528905a67cSAndy Whitcroft # outermost level. 14538905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 14548905a67cSAndy Whitcroft last; 14558905a67cSAndy Whitcroft } 14568905a67cSAndy Whitcroft 145713214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1458773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1459773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1460773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1461773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1462773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1463773647a0SAndy Whitcroft $coff_set = 1; 1464773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1465773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 146613214adfSAndy Whitcroft } 146713214adfSAndy Whitcroft 14688905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 14698905a67cSAndy Whitcroft $level++; 14708905a67cSAndy Whitcroft $type = '('; 14718905a67cSAndy Whitcroft } 14728905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 14738905a67cSAndy Whitcroft $level--; 14748905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 14758905a67cSAndy Whitcroft 14768905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 14778905a67cSAndy Whitcroft $coff = $off; 1478773647a0SAndy Whitcroft $coff_set = 1; 1479773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 14808905a67cSAndy Whitcroft } 14818905a67cSAndy Whitcroft } 14828905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 14838905a67cSAndy Whitcroft $level++; 14848905a67cSAndy Whitcroft $type = '{'; 14858905a67cSAndy Whitcroft } 14868905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 14878905a67cSAndy Whitcroft $level--; 14888905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 14898905a67cSAndy Whitcroft 14908905a67cSAndy Whitcroft if ($level == 0) { 1491b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1492b998e001SPatrick Pannuto $off++; 1493b998e001SPatrick Pannuto } 14948905a67cSAndy Whitcroft last; 14958905a67cSAndy Whitcroft } 14968905a67cSAndy Whitcroft } 1497f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1498f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1499f74bd194SAndy Whitcroft $level--; 1500f74bd194SAndy Whitcroft $type = ''; 1501f74bd194SAndy Whitcroft $off++; 1502f74bd194SAndy Whitcroft last; 1503f74bd194SAndy Whitcroft } 15048905a67cSAndy Whitcroft $off++; 15058905a67cSAndy Whitcroft } 1506a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 150713214adfSAndy Whitcroft if ($off == $len) { 1508a3bb97a7SAndy Whitcroft $loff = $len + 1; 150913214adfSAndy Whitcroft $line++; 151013214adfSAndy Whitcroft $remain--; 151113214adfSAndy Whitcroft } 15128905a67cSAndy Whitcroft 15138905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 15148905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 15158905a67cSAndy Whitcroft 15168905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 15178905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 15188905a67cSAndy Whitcroft 1519773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 152013214adfSAndy Whitcroft 152113214adfSAndy Whitcroft return ($statement, $condition, 152213214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 152313214adfSAndy Whitcroft} 152413214adfSAndy Whitcroft 1525cf655043SAndy Whitcroftsub statement_lines { 1526cf655043SAndy Whitcroft my ($stmt) = @_; 1527cf655043SAndy Whitcroft 1528cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1529cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1530cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1531cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1532cf655043SAndy Whitcroft 1533cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1534cf655043SAndy Whitcroft 1535cf655043SAndy Whitcroft return $#stmt_lines + 2; 1536cf655043SAndy Whitcroft} 1537cf655043SAndy Whitcroft 1538cf655043SAndy Whitcroftsub statement_rawlines { 1539cf655043SAndy Whitcroft my ($stmt) = @_; 1540cf655043SAndy Whitcroft 1541cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1542cf655043SAndy Whitcroft 1543cf655043SAndy Whitcroft return $#stmt_lines + 2; 1544cf655043SAndy Whitcroft} 1545cf655043SAndy Whitcroft 1546cf655043SAndy Whitcroftsub statement_block_size { 1547cf655043SAndy Whitcroft my ($stmt) = @_; 1548cf655043SAndy Whitcroft 1549cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1550cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1551cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1552cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1553cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1554cf655043SAndy Whitcroft 1555cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1556cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1557cf655043SAndy Whitcroft 1558cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1559cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1560cf655043SAndy Whitcroft 1561cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1562cf655043SAndy Whitcroft return $stmt_lines; 1563cf655043SAndy Whitcroft } else { 1564cf655043SAndy Whitcroft return $stmt_statements; 1565cf655043SAndy Whitcroft } 1566cf655043SAndy Whitcroft} 1567cf655043SAndy Whitcroft 156813214adfSAndy Whitcroftsub ctx_statement_full { 156913214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 157013214adfSAndy Whitcroft my ($statement, $condition, $level); 157113214adfSAndy Whitcroft 157213214adfSAndy Whitcroft my (@chunks); 157313214adfSAndy Whitcroft 1574cf655043SAndy Whitcroft # Grab the first conditional/block pair. 157513214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 157613214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1577773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 157813214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1579cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1580cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1581cf655043SAndy Whitcroft } 1582cf655043SAndy Whitcroft 1583cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1584cf655043SAndy Whitcroft # could continue the statement. 1585cf655043SAndy Whitcroft for (;;) { 158613214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 158713214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1588cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1589773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1590cf655043SAndy Whitcroft #print "C: push\n"; 1591cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 159213214adfSAndy Whitcroft } 159313214adfSAndy Whitcroft 159413214adfSAndy Whitcroft return ($level, $linenr, @chunks); 15958905a67cSAndy Whitcroft} 15968905a67cSAndy Whitcroft 15974a0df2efSAndy Whitcroftsub ctx_block_get { 1598f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 15994a0df2efSAndy Whitcroft my $line; 16004a0df2efSAndy Whitcroft my $start = $linenr - 1; 16014a0df2efSAndy Whitcroft my $blk = ''; 16024a0df2efSAndy Whitcroft my @o; 16034a0df2efSAndy Whitcroft my @c; 16044a0df2efSAndy Whitcroft my @res = (); 16054a0df2efSAndy Whitcroft 1606f0a594c1SAndy Whitcroft my $level = 0; 16074635f4fbSAndy Whitcroft my @stack = ($level); 160800df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 160900df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 161000df344fSAndy Whitcroft $remain--; 161100df344fSAndy Whitcroft 161200df344fSAndy Whitcroft $blk .= $rawlines[$line]; 16134635f4fbSAndy Whitcroft 16144635f4fbSAndy Whitcroft # Handle nested #if/#else. 161501464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 16164635f4fbSAndy Whitcroft push(@stack, $level); 161701464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 16184635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 161901464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 16204635f4fbSAndy Whitcroft $level = pop(@stack); 16214635f4fbSAndy Whitcroft } 16224635f4fbSAndy Whitcroft 162301464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1624f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1625f0a594c1SAndy Whitcroft if ($off > 0) { 1626f0a594c1SAndy Whitcroft $off--; 1627f0a594c1SAndy Whitcroft next; 1628f0a594c1SAndy Whitcroft } 16294a0df2efSAndy Whitcroft 1630f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1631f0a594c1SAndy Whitcroft $level--; 1632f0a594c1SAndy Whitcroft last if ($level == 0); 1633f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1634f0a594c1SAndy Whitcroft $level++; 1635f0a594c1SAndy Whitcroft } 1636f0a594c1SAndy Whitcroft } 16374a0df2efSAndy Whitcroft 1638f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 163900df344fSAndy Whitcroft push(@res, $rawlines[$line]); 16404a0df2efSAndy Whitcroft } 16414a0df2efSAndy Whitcroft 1642f0a594c1SAndy Whitcroft last if ($level == 0); 16434a0df2efSAndy Whitcroft } 16444a0df2efSAndy Whitcroft 1645f0a594c1SAndy Whitcroft return ($level, @res); 16464a0df2efSAndy Whitcroft} 16474a0df2efSAndy Whitcroftsub ctx_block_outer { 16484a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 16494a0df2efSAndy Whitcroft 1650f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1651f0a594c1SAndy Whitcroft return @r; 16524a0df2efSAndy Whitcroft} 16534a0df2efSAndy Whitcroftsub ctx_block { 16544a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 16554a0df2efSAndy Whitcroft 1656f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1657f0a594c1SAndy Whitcroft return @r; 1658653d4876SAndy Whitcroft} 1659653d4876SAndy Whitcroftsub ctx_statement { 1660f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1661f0a594c1SAndy Whitcroft 1662f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1663f0a594c1SAndy Whitcroft return @r; 1664f0a594c1SAndy Whitcroft} 1665f0a594c1SAndy Whitcroftsub ctx_block_level { 1666653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1667653d4876SAndy Whitcroft 1668f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 16694a0df2efSAndy Whitcroft} 16709c0ca6f9SAndy Whitcroftsub ctx_statement_level { 16719c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 16729c0ca6f9SAndy Whitcroft 16739c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 16749c0ca6f9SAndy Whitcroft} 16754a0df2efSAndy Whitcroft 16764a0df2efSAndy Whitcroftsub ctx_locate_comment { 16774a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 16784a0df2efSAndy Whitcroft 1679*a55ee0ccSJoe Perches # If c99 comment on the current line, or the line before or after 1680*a55ee0ccSJoe Perches my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@); 1681*a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1682*a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@); 1683*a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1684*a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@); 1685*a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1686*a55ee0ccSJoe Perches 16874a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1688*a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 16894a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 16904a0df2efSAndy Whitcroft 16914a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 16924a0df2efSAndy Whitcroft # comment. 16934a0df2efSAndy Whitcroft my $in_comment = 0; 16944a0df2efSAndy Whitcroft $current_comment = ''; 16954a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 169600df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 169700df344fSAndy Whitcroft #warn " $line\n"; 16984a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 16994a0df2efSAndy Whitcroft $in_comment = 1; 17004a0df2efSAndy Whitcroft } 17014a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 17024a0df2efSAndy Whitcroft $in_comment = 1; 17034a0df2efSAndy Whitcroft } 17044a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 17054a0df2efSAndy Whitcroft $current_comment = ''; 17064a0df2efSAndy Whitcroft } 17074a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 17084a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 17094a0df2efSAndy Whitcroft $in_comment = 0; 17104a0df2efSAndy Whitcroft } 17114a0df2efSAndy Whitcroft } 17124a0df2efSAndy Whitcroft 17134a0df2efSAndy Whitcroft chomp($current_comment); 17144a0df2efSAndy Whitcroft return($current_comment); 17154a0df2efSAndy Whitcroft} 17164a0df2efSAndy Whitcroftsub ctx_has_comment { 17174a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 17184a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 17194a0df2efSAndy Whitcroft 172000df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 17214a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 17224a0df2efSAndy Whitcroft 17234a0df2efSAndy Whitcroft return ($cmt ne ''); 17244a0df2efSAndy Whitcroft} 17254a0df2efSAndy Whitcroft 17264d001e4dSAndy Whitcroftsub raw_line { 17274d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 17284d001e4dSAndy Whitcroft 17294d001e4dSAndy Whitcroft my $offset = $linenr - 1; 17304d001e4dSAndy Whitcroft $cnt++; 17314d001e4dSAndy Whitcroft 17324d001e4dSAndy Whitcroft my $line; 17334d001e4dSAndy Whitcroft while ($cnt) { 17344d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 17354d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 17364d001e4dSAndy Whitcroft $cnt--; 17374d001e4dSAndy Whitcroft } 17384d001e4dSAndy Whitcroft 17394d001e4dSAndy Whitcroft return $line; 17404d001e4dSAndy Whitcroft} 17414d001e4dSAndy Whitcroft 17422a9f9d85STobin C. Hardingsub get_stat_real { 17432a9f9d85STobin C. Harding my ($linenr, $lc) = @_; 17442a9f9d85STobin C. Harding 17452a9f9d85STobin C. Harding my $stat_real = raw_line($linenr, 0); 17462a9f9d85STobin C. Harding for (my $count = $linenr + 1; $count <= $lc; $count++) { 17472a9f9d85STobin C. Harding $stat_real = $stat_real . "\n" . raw_line($count, 0); 17482a9f9d85STobin C. Harding } 17492a9f9d85STobin C. Harding 17502a9f9d85STobin C. Harding return $stat_real; 17512a9f9d85STobin C. Harding} 17522a9f9d85STobin C. Harding 1753e3d95a2aSTobin C. Hardingsub get_stat_here { 1754e3d95a2aSTobin C. Harding my ($linenr, $cnt, $here) = @_; 1755e3d95a2aSTobin C. Harding 1756e3d95a2aSTobin C. Harding my $herectx = $here . "\n"; 1757e3d95a2aSTobin C. Harding for (my $n = 0; $n < $cnt; $n++) { 1758e3d95a2aSTobin C. Harding $herectx .= raw_line($linenr, $n) . "\n"; 1759e3d95a2aSTobin C. Harding } 1760e3d95a2aSTobin C. Harding 1761e3d95a2aSTobin C. Harding return $herectx; 1762e3d95a2aSTobin C. Harding} 1763e3d95a2aSTobin C. Harding 17640a920b5bSAndy Whitcroftsub cat_vet { 17650a920b5bSAndy Whitcroft my ($vet) = @_; 17669c0ca6f9SAndy Whitcroft my ($res, $coded); 17670a920b5bSAndy Whitcroft 17689c0ca6f9SAndy Whitcroft $res = ''; 17696c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 17706c72ffaaSAndy Whitcroft $res .= $1; 17716c72ffaaSAndy Whitcroft if ($2 ne '') { 17729c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 17736c72ffaaSAndy Whitcroft $res .= $coded; 17746c72ffaaSAndy Whitcroft } 17759c0ca6f9SAndy Whitcroft } 17769c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 17770a920b5bSAndy Whitcroft 17789c0ca6f9SAndy Whitcroft return $res; 17790a920b5bSAndy Whitcroft} 17800a920b5bSAndy Whitcroft 1781c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1782cf655043SAndy Whitcroftmy $av_pending; 1783c2fdda0dSAndy Whitcroftmy @av_paren_type; 17841f65f947SAndy Whitcroftmy $av_pend_colon; 1785c2fdda0dSAndy Whitcroft 1786c2fdda0dSAndy Whitcroftsub annotate_reset { 1787c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1788cf655043SAndy Whitcroft $av_pending = '_'; 1789cf655043SAndy Whitcroft @av_paren_type = ('E'); 17901f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1791c2fdda0dSAndy Whitcroft} 1792c2fdda0dSAndy Whitcroft 17936c72ffaaSAndy Whitcroftsub annotate_values { 17946c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 17956c72ffaaSAndy Whitcroft 17966c72ffaaSAndy Whitcroft my $res; 17971f65f947SAndy Whitcroft my $var = '_' x length($stream); 17986c72ffaaSAndy Whitcroft my $cur = $stream; 17996c72ffaaSAndy Whitcroft 1800c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 18016c72ffaaSAndy Whitcroft 18026c72ffaaSAndy Whitcroft while (length($cur)) { 1803773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1804cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1805171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 18066c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1807c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1808c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1809cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1810c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 18116c72ffaaSAndy Whitcroft } 18126c72ffaaSAndy Whitcroft 1813c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 18149446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 18159446ef56SAndy Whitcroft push(@av_paren_type, $type); 1816addcdceaSAndy Whitcroft $type = 'c'; 18179446ef56SAndy Whitcroft 1818e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1819c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 18206c72ffaaSAndy Whitcroft $type = 'T'; 18216c72ffaaSAndy Whitcroft 1822389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1823389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1824389a2fe5SAndy Whitcroft $type = 'T'; 1825389a2fe5SAndy Whitcroft 1826c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1827171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1828c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1829171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1830171ae1a4SAndy Whitcroft if ($2 ne '') { 1831cf655043SAndy Whitcroft $av_pending = 'N'; 1832171ae1a4SAndy Whitcroft } 1833171ae1a4SAndy Whitcroft $type = 'E'; 1834171ae1a4SAndy Whitcroft 1835c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1836171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1837171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1838171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 18396c72ffaaSAndy Whitcroft 1840c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1841cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1842c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1843cf655043SAndy Whitcroft 1844cf655043SAndy Whitcroft push(@av_paren_type, $type); 1845cf655043SAndy Whitcroft push(@av_paren_type, $type); 1846171ae1a4SAndy Whitcroft $type = 'E'; 1847cf655043SAndy Whitcroft 1848c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1849cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1850cf655043SAndy Whitcroft $av_preprocessor = 1; 1851cf655043SAndy Whitcroft 1852cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1853cf655043SAndy Whitcroft 1854171ae1a4SAndy Whitcroft $type = 'E'; 1855cf655043SAndy Whitcroft 1856c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1857cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1858cf655043SAndy Whitcroft 1859cf655043SAndy Whitcroft $av_preprocessor = 1; 1860cf655043SAndy Whitcroft 1861cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1862cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1863cf655043SAndy Whitcroft pop(@av_paren_type); 1864cf655043SAndy Whitcroft push(@av_paren_type, $type); 1865171ae1a4SAndy Whitcroft $type = 'E'; 18666c72ffaaSAndy Whitcroft 18676c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1868c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 18696c72ffaaSAndy Whitcroft 1870171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1871171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1872171ae1a4SAndy Whitcroft $av_pending = $type; 1873171ae1a4SAndy Whitcroft $type = 'N'; 1874171ae1a4SAndy Whitcroft 18756c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1876c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 18776c72ffaaSAndy Whitcroft if (defined $2) { 1878cf655043SAndy Whitcroft $av_pending = 'V'; 18796c72ffaaSAndy Whitcroft } 18806c72ffaaSAndy Whitcroft $type = 'N'; 18816c72ffaaSAndy Whitcroft 188214b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1883c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 188414b111c1SAndy Whitcroft $av_pending = 'E'; 18856c72ffaaSAndy Whitcroft $type = 'N'; 18866c72ffaaSAndy Whitcroft 18871f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 18881f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 18891f65f947SAndy Whitcroft $av_pend_colon = 'C'; 18901f65f947SAndy Whitcroft $type = 'N'; 18911f65f947SAndy Whitcroft 189214b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1893c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 18946c72ffaaSAndy Whitcroft $type = 'N'; 18956c72ffaaSAndy Whitcroft 18966c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1897c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1898cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1899cf655043SAndy Whitcroft $av_pending = '_'; 19006c72ffaaSAndy Whitcroft $type = 'N'; 19016c72ffaaSAndy Whitcroft 19026c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1903cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1904cf655043SAndy Whitcroft if ($new_type ne '_') { 1905cf655043SAndy Whitcroft $type = $new_type; 1906c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1907c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 19086c72ffaaSAndy Whitcroft } else { 1909c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 19106c72ffaaSAndy Whitcroft } 19116c72ffaaSAndy Whitcroft 1912c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1913c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1914c8cb2ca3SAndy Whitcroft $type = 'V'; 1915cf655043SAndy Whitcroft $av_pending = 'V'; 19166c72ffaaSAndy Whitcroft 19178e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 19188e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 19191f65f947SAndy Whitcroft $av_pend_colon = 'B'; 19208e761b04SAndy Whitcroft } elsif ($type eq 'E') { 19218e761b04SAndy Whitcroft $av_pend_colon = 'L'; 19221f65f947SAndy Whitcroft } 19231f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 19241f65f947SAndy Whitcroft $type = 'V'; 19251f65f947SAndy Whitcroft 19266c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1927c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 19286c72ffaaSAndy Whitcroft $type = 'V'; 19296c72ffaaSAndy Whitcroft 19306c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1931c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 19326c72ffaaSAndy Whitcroft $type = 'N'; 19336c72ffaaSAndy Whitcroft 1934cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1935c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 193613214adfSAndy Whitcroft $type = 'E'; 19371f65f947SAndy Whitcroft $av_pend_colon = 'O'; 193813214adfSAndy Whitcroft 19398e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 19408e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 19418e761b04SAndy Whitcroft $type = 'C'; 19428e761b04SAndy Whitcroft 19431f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 19441f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 19451f65f947SAndy Whitcroft $type = 'N'; 19461f65f947SAndy Whitcroft 19471f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 19481f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 19491f65f947SAndy Whitcroft 19501f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 19511f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 19521f65f947SAndy Whitcroft $type = 'E'; 19531f65f947SAndy Whitcroft } else { 19541f65f947SAndy Whitcroft $type = 'N'; 19551f65f947SAndy Whitcroft } 19561f65f947SAndy Whitcroft $av_pend_colon = 'O'; 19571f65f947SAndy Whitcroft 19588e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 195913214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 19606c72ffaaSAndy Whitcroft $type = 'N'; 19616c72ffaaSAndy Whitcroft 19620d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 196374048ed8SAndy Whitcroft my $variant; 196474048ed8SAndy Whitcroft 196574048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 196674048ed8SAndy Whitcroft if ($type eq 'V') { 196774048ed8SAndy Whitcroft $variant = 'B'; 196874048ed8SAndy Whitcroft } else { 196974048ed8SAndy Whitcroft $variant = 'U'; 197074048ed8SAndy Whitcroft } 197174048ed8SAndy Whitcroft 197274048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 197374048ed8SAndy Whitcroft $type = 'N'; 197474048ed8SAndy Whitcroft 19756c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1976c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 19776c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 19786c72ffaaSAndy Whitcroft $type = 'N'; 19796c72ffaaSAndy Whitcroft } 19806c72ffaaSAndy Whitcroft 19816c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1982c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 19836c72ffaaSAndy Whitcroft } 19846c72ffaaSAndy Whitcroft if (defined $1) { 19856c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 19866c72ffaaSAndy Whitcroft $res .= $type x length($1); 19876c72ffaaSAndy Whitcroft } 19886c72ffaaSAndy Whitcroft } 19896c72ffaaSAndy Whitcroft 19901f65f947SAndy Whitcroft return ($res, $var); 19916c72ffaaSAndy Whitcroft} 19926c72ffaaSAndy Whitcroft 19938905a67cSAndy Whitcroftsub possible { 199413214adfSAndy Whitcroft my ($possible, $line) = @_; 19959a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 19960776e594SAndy Whitcroft ^(?: 19970776e594SAndy Whitcroft $Modifier| 19980776e594SAndy Whitcroft $Storage| 19990776e594SAndy Whitcroft $Type| 20009a974fdbSAndy Whitcroft DEFINE_\S+ 20019a974fdbSAndy Whitcroft )$| 20029a974fdbSAndy Whitcroft ^(?: 20030776e594SAndy Whitcroft goto| 20040776e594SAndy Whitcroft return| 20050776e594SAndy Whitcroft case| 20060776e594SAndy Whitcroft else| 20070776e594SAndy Whitcroft asm|__asm__| 200889a88353SAndy Whitcroft do| 200989a88353SAndy Whitcroft \#| 201089a88353SAndy Whitcroft \#\#| 20119a974fdbSAndy Whitcroft )(?:\s|$)| 20120776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 20139a974fdbSAndy Whitcroft )}x; 20149a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 20159a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 2016c45dcabdSAndy Whitcroft # Check for modifiers. 2017c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 2018c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 2019c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 2020c45dcabdSAndy Whitcroft 2021c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 2022c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 2023d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 20249a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 2025d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 2026485ff23eSAlex Dowad push(@modifierListFile, $modifier); 2027d2506586SAndy Whitcroft } 20289a974fdbSAndy Whitcroft } 2029c45dcabdSAndy Whitcroft 2030c45dcabdSAndy Whitcroft } else { 203113214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 2032485ff23eSAlex Dowad push(@typeListFile, $possible); 2033c45dcabdSAndy Whitcroft } 20348905a67cSAndy Whitcroft build_types(); 20350776e594SAndy Whitcroft } else { 20360776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 20378905a67cSAndy Whitcroft } 20388905a67cSAndy Whitcroft} 20398905a67cSAndy Whitcroft 20406c72ffaaSAndy Whitcroftmy $prefix = ''; 20416c72ffaaSAndy Whitcroft 2042000d1cc1SJoe Perchessub show_type { 2043cbec18afSJoe Perches my ($type) = @_; 204491bfe484SJoe Perches 2045522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 2046522b837cSAlexey Dobriyan 2047cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 2048cbec18afSJoe Perches 2049cbec18afSJoe Perches return !defined $ignore_type{$type}; 2050000d1cc1SJoe Perches} 2051000d1cc1SJoe Perches 2052f0a594c1SAndy Whitcroftsub report { 2053cbec18afSJoe Perches my ($level, $type, $msg) = @_; 2054cbec18afSJoe Perches 2055cbec18afSJoe Perches if (!show_type($type) || 2056cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 2057773647a0SAndy Whitcroft return 0; 2058773647a0SAndy Whitcroft } 205957230297SJoe Perches my $output = ''; 2060737c0767SJohn Brooks if ($color) { 206157230297SJoe Perches if ($level eq 'ERROR') { 206257230297SJoe Perches $output .= RED; 206357230297SJoe Perches } elsif ($level eq 'WARNING') { 206457230297SJoe Perches $output .= YELLOW; 2065000d1cc1SJoe Perches } else { 206657230297SJoe Perches $output .= GREEN; 2067000d1cc1SJoe Perches } 206857230297SJoe Perches } 206957230297SJoe Perches $output .= $prefix . $level . ':'; 207057230297SJoe Perches if ($show_types) { 2071737c0767SJohn Brooks $output .= BLUE if ($color); 207257230297SJoe Perches $output .= "$type:"; 207357230297SJoe Perches } 2074737c0767SJohn Brooks $output .= RESET if ($color); 207557230297SJoe Perches $output .= ' ' . $msg . "\n"; 207634d8815fSJoe Perches 207734d8815fSJoe Perches if ($showfile) { 207834d8815fSJoe Perches my @lines = split("\n", $output, -1); 207934d8815fSJoe Perches splice(@lines, 1, 1); 208034d8815fSJoe Perches $output = join("\n", @lines); 208134d8815fSJoe Perches } 208257230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 20838905a67cSAndy Whitcroft 208457230297SJoe Perches push(our @report, $output); 2085773647a0SAndy Whitcroft 2086773647a0SAndy Whitcroft return 1; 2087f0a594c1SAndy Whitcroft} 2088cbec18afSJoe Perches 2089f0a594c1SAndy Whitcroftsub report_dump { 209013214adfSAndy Whitcroft our @report; 2091f0a594c1SAndy Whitcroft} 2092000d1cc1SJoe Perches 2093d752fcc8SJoe Perchessub fixup_current_range { 2094d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 2095d752fcc8SJoe Perches 2096d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 2097d752fcc8SJoe Perches my $o = $1; 2098d752fcc8SJoe Perches my $l = $2; 2099d752fcc8SJoe Perches my $no = $o + $offset; 2100d752fcc8SJoe Perches my $nl = $l + $length; 2101d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 2102d752fcc8SJoe Perches } 2103d752fcc8SJoe Perches} 2104d752fcc8SJoe Perches 2105d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 2106d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 2107d752fcc8SJoe Perches 2108d752fcc8SJoe Perches my $range_last_linenr = 0; 2109d752fcc8SJoe Perches my $delta_offset = 0; 2110d752fcc8SJoe Perches 2111d752fcc8SJoe Perches my $old_linenr = 0; 2112d752fcc8SJoe Perches my $new_linenr = 0; 2113d752fcc8SJoe Perches 2114d752fcc8SJoe Perches my $next_insert = 0; 2115d752fcc8SJoe Perches my $next_delete = 0; 2116d752fcc8SJoe Perches 2117d752fcc8SJoe Perches my @lines = (); 2118d752fcc8SJoe Perches 2119d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 2120d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 2121d752fcc8SJoe Perches 2122d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 2123d752fcc8SJoe Perches my $save_line = 1; 2124d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 2125323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2126d752fcc8SJoe Perches $delta_offset = 0; 2127d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2128d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 2129d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 2130d752fcc8SJoe Perches } 2131d752fcc8SJoe Perches 2132d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2133d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 2134d752fcc8SJoe Perches $save_line = 0; 2135d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2136d752fcc8SJoe Perches } 2137d752fcc8SJoe Perches 2138d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2139d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 2140d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 2141d752fcc8SJoe Perches $new_linenr++; 2142d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2143d752fcc8SJoe Perches } 2144d752fcc8SJoe Perches 2145d752fcc8SJoe Perches if ($save_line) { 2146d752fcc8SJoe Perches push(@lines, $line); 2147d752fcc8SJoe Perches $new_linenr++; 2148d752fcc8SJoe Perches } 2149d752fcc8SJoe Perches 2150d752fcc8SJoe Perches $old_linenr++; 2151d752fcc8SJoe Perches } 2152d752fcc8SJoe Perches 2153d752fcc8SJoe Perches return @lines; 2154d752fcc8SJoe Perches} 2155d752fcc8SJoe Perches 2156f2d7e4d4SJoe Perchessub fix_insert_line { 2157f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2158f2d7e4d4SJoe Perches 2159f2d7e4d4SJoe Perches my $inserted = { 2160f2d7e4d4SJoe Perches LINENR => $linenr, 2161f2d7e4d4SJoe Perches LINE => $line, 2162f2d7e4d4SJoe Perches }; 2163f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2164f2d7e4d4SJoe Perches} 2165f2d7e4d4SJoe Perches 2166f2d7e4d4SJoe Perchessub fix_delete_line { 2167f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2168f2d7e4d4SJoe Perches 2169f2d7e4d4SJoe Perches my $deleted = { 2170f2d7e4d4SJoe Perches LINENR => $linenr, 2171f2d7e4d4SJoe Perches LINE => $line, 2172f2d7e4d4SJoe Perches }; 2173f2d7e4d4SJoe Perches 2174f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2175f2d7e4d4SJoe Perches} 2176f2d7e4d4SJoe Perches 2177de7d4f0eSAndy Whitcroftsub ERROR { 2178cbec18afSJoe Perches my ($type, $msg) = @_; 2179cbec18afSJoe Perches 2180cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2181de7d4f0eSAndy Whitcroft our $clean = 0; 21826c72ffaaSAndy Whitcroft our $cnt_error++; 21833705ce5bSJoe Perches return 1; 2184de7d4f0eSAndy Whitcroft } 21853705ce5bSJoe Perches return 0; 2186773647a0SAndy Whitcroft} 2187de7d4f0eSAndy Whitcroftsub WARN { 2188cbec18afSJoe Perches my ($type, $msg) = @_; 2189cbec18afSJoe Perches 2190cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2191de7d4f0eSAndy Whitcroft our $clean = 0; 21926c72ffaaSAndy Whitcroft our $cnt_warn++; 21933705ce5bSJoe Perches return 1; 2194de7d4f0eSAndy Whitcroft } 21953705ce5bSJoe Perches return 0; 2196773647a0SAndy Whitcroft} 2197de7d4f0eSAndy Whitcroftsub CHK { 2198cbec18afSJoe Perches my ($type, $msg) = @_; 2199cbec18afSJoe Perches 2200cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2201de7d4f0eSAndy Whitcroft our $clean = 0; 22026c72ffaaSAndy Whitcroft our $cnt_chk++; 22033705ce5bSJoe Perches return 1; 22046c72ffaaSAndy Whitcroft } 22053705ce5bSJoe Perches return 0; 2206de7d4f0eSAndy Whitcroft} 2207de7d4f0eSAndy Whitcroft 22086ecd9674SAndy Whitcroftsub check_absolute_file { 22096ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 22106ecd9674SAndy Whitcroft my $file = $absolute; 22116ecd9674SAndy Whitcroft 22126ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 22136ecd9674SAndy Whitcroft 22146ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 22156ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 22166ecd9674SAndy Whitcroft if (-f "$root/$file") { 22176ecd9674SAndy Whitcroft ##print "file<$file>\n"; 22186ecd9674SAndy Whitcroft last; 22196ecd9674SAndy Whitcroft } 22206ecd9674SAndy Whitcroft } 22216ecd9674SAndy Whitcroft if (! -f _) { 22226ecd9674SAndy Whitcroft return 0; 22236ecd9674SAndy Whitcroft } 22246ecd9674SAndy Whitcroft 22256ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 22266ecd9674SAndy Whitcroft my $prefix = $absolute; 22276ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 22286ecd9674SAndy Whitcroft 22296ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 22306ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2231000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2232000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 22336ecd9674SAndy Whitcroft } 22346ecd9674SAndy Whitcroft} 22356ecd9674SAndy Whitcroft 22363705ce5bSJoe Perchessub trim { 22373705ce5bSJoe Perches my ($string) = @_; 22383705ce5bSJoe Perches 2239b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2240b34c648bSJoe Perches 2241b34c648bSJoe Perches return $string; 2242b34c648bSJoe Perches} 2243b34c648bSJoe Perches 2244b34c648bSJoe Perchessub ltrim { 2245b34c648bSJoe Perches my ($string) = @_; 2246b34c648bSJoe Perches 2247b34c648bSJoe Perches $string =~ s/^\s+//; 2248b34c648bSJoe Perches 2249b34c648bSJoe Perches return $string; 2250b34c648bSJoe Perches} 2251b34c648bSJoe Perches 2252b34c648bSJoe Perchessub rtrim { 2253b34c648bSJoe Perches my ($string) = @_; 2254b34c648bSJoe Perches 2255b34c648bSJoe Perches $string =~ s/\s+$//; 22563705ce5bSJoe Perches 22573705ce5bSJoe Perches return $string; 22583705ce5bSJoe Perches} 22593705ce5bSJoe Perches 226052ea8506SJoe Perchessub string_find_replace { 226152ea8506SJoe Perches my ($string, $find, $replace) = @_; 226252ea8506SJoe Perches 226352ea8506SJoe Perches $string =~ s/$find/$replace/g; 226452ea8506SJoe Perches 226552ea8506SJoe Perches return $string; 226652ea8506SJoe Perches} 226752ea8506SJoe Perches 22683705ce5bSJoe Perchessub tabify { 22693705ce5bSJoe Perches my ($leading) = @_; 22703705ce5bSJoe Perches 2271713a09deSAntonio Borneo my $source_indent = $tabsize; 22723705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 22733705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 22743705ce5bSJoe Perches 22753705ce5bSJoe Perches #convert leading spaces to tabs 22763705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 22773705ce5bSJoe Perches #Remove spaces before a tab 22783705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 22793705ce5bSJoe Perches 22803705ce5bSJoe Perches return "$leading"; 22813705ce5bSJoe Perches} 22823705ce5bSJoe Perches 2283d1fe9c09SJoe Perchessub pos_last_openparen { 2284d1fe9c09SJoe Perches my ($line) = @_; 2285d1fe9c09SJoe Perches 2286d1fe9c09SJoe Perches my $pos = 0; 2287d1fe9c09SJoe Perches 2288d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2289d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2290d1fe9c09SJoe Perches 2291d1fe9c09SJoe Perches my $last_openparen = 0; 2292d1fe9c09SJoe Perches 2293d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2294d1fe9c09SJoe Perches return -1; 2295d1fe9c09SJoe Perches } 2296d1fe9c09SJoe Perches 2297d1fe9c09SJoe Perches my $len = length($line); 2298d1fe9c09SJoe Perches 2299d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2300d1fe9c09SJoe Perches my $string = substr($line, $pos); 2301d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2302d1fe9c09SJoe Perches $pos += length($1) - 1; 2303d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2304d1fe9c09SJoe Perches $last_openparen = $pos; 2305d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2306d1fe9c09SJoe Perches last; 2307d1fe9c09SJoe Perches } 2308d1fe9c09SJoe Perches } 2309d1fe9c09SJoe Perches 231091cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2311d1fe9c09SJoe Perches} 2312d1fe9c09SJoe Perches 2313f36d3eb8SJoe Perchessub get_raw_comment { 2314f36d3eb8SJoe Perches my ($line, $rawline) = @_; 2315f36d3eb8SJoe Perches my $comment = ''; 2316f36d3eb8SJoe Perches 2317f36d3eb8SJoe Perches for my $i (0 .. (length($line) - 1)) { 2318f36d3eb8SJoe Perches if (substr($line, $i, 1) eq "$;") { 2319f36d3eb8SJoe Perches $comment .= substr($rawline, $i, 1); 2320f36d3eb8SJoe Perches } 2321f36d3eb8SJoe Perches } 2322f36d3eb8SJoe Perches 2323f36d3eb8SJoe Perches return $comment; 2324f36d3eb8SJoe Perches} 2325f36d3eb8SJoe Perches 23260a920b5bSAndy Whitcroftsub process { 23270a920b5bSAndy Whitcroft my $filename = shift; 23280a920b5bSAndy Whitcroft 23290a920b5bSAndy Whitcroft my $linenr=0; 23300a920b5bSAndy Whitcroft my $prevline=""; 2331c2fdda0dSAndy Whitcroft my $prevrawline=""; 23320a920b5bSAndy Whitcroft my $stashline=""; 2333c2fdda0dSAndy Whitcroft my $stashrawline=""; 23340a920b5bSAndy Whitcroft 23354a0df2efSAndy Whitcroft my $length; 23360a920b5bSAndy Whitcroft my $indent; 23370a920b5bSAndy Whitcroft my $previndent=0; 23380a920b5bSAndy Whitcroft my $stashindent=0; 23390a920b5bSAndy Whitcroft 2340de7d4f0eSAndy Whitcroft our $clean = 1; 23410a920b5bSAndy Whitcroft my $signoff = 0; 2342cd261496SGeert Uytterhoeven my $author = ''; 2343cd261496SGeert Uytterhoeven my $authorsignoff = 0; 23440a920b5bSAndy Whitcroft my $is_patch = 0; 2345133712a2SRob Herring my $is_binding_patch = -1; 234629ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 234715662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 234844d303ebSJoe Perches my $has_patch_separator = 0; #Found a --- line 2349ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2350490b292cSJoe Perches my $commit_log_lines = 0; #Number of commit log lines 2351bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 23522a076f40SJoe Perches my $commit_log_long_line = 0; 2353e518e9a5SJoe Perches my $commit_log_has_diff = 0; 235413f1937eSJoe Perches my $reported_maintainer_file = 0; 2355fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2356fa64205dSPasi Savanainen 2357365dd4eaSJoe Perches my $last_blank_line = 0; 23585e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2359365dd4eaSJoe Perches 236013214adfSAndy Whitcroft our @report = (); 23616c72ffaaSAndy Whitcroft our $cnt_lines = 0; 23626c72ffaaSAndy Whitcroft our $cnt_error = 0; 23636c72ffaaSAndy Whitcroft our $cnt_warn = 0; 23646c72ffaaSAndy Whitcroft our $cnt_chk = 0; 23656c72ffaaSAndy Whitcroft 23660a920b5bSAndy Whitcroft # Trace the real file/line as we go. 23670a920b5bSAndy Whitcroft my $realfile = ''; 23680a920b5bSAndy Whitcroft my $realline = 0; 23690a920b5bSAndy Whitcroft my $realcnt = 0; 23700a920b5bSAndy Whitcroft my $here = ''; 237177cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 23720a920b5bSAndy Whitcroft my $in_comment = 0; 2373c2fdda0dSAndy Whitcroft my $comment_edge = 0; 23740a920b5bSAndy Whitcroft my $first_line = 0; 23751e855726SWolfram Sang my $p1_prefix = ''; 23760a920b5bSAndy Whitcroft 237713214adfSAndy Whitcroft my $prev_values = 'E'; 237813214adfSAndy Whitcroft 237913214adfSAndy Whitcroft # suppression flags 2380773647a0SAndy Whitcroft my %suppress_ifbraces; 2381170d3a22SAndy Whitcroft my %suppress_whiletrailers; 23822b474a1aSAndy Whitcroft my %suppress_export; 23833e469cdcSAndy Whitcroft my $suppress_statement = 0; 2384653d4876SAndy Whitcroft 23857e51f197SJoe Perches my %signatures = (); 2386323c1260SJoe Perches 2387c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2388de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2389c2fdda0dSAndy Whitcroft # 2390de7d4f0eSAndy Whitcroft my @setup_docs = (); 2391de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2392773647a0SAndy Whitcroft 2393d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2394d8b07710SJoe Perches 23959f3a8992SRob Herring my $checklicenseline = 1; 23969f3a8992SRob Herring 2397773647a0SAndy Whitcroft sanitise_line_reset(); 2398c2fdda0dSAndy Whitcroft my $line; 2399c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2400773647a0SAndy Whitcroft $linenr++; 2401773647a0SAndy Whitcroft $line = $rawline; 2402c2fdda0dSAndy Whitcroft 24033705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 24043705ce5bSJoe Perches 2405773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2406de7d4f0eSAndy Whitcroft $setup_docs = 0; 24078c27ceffSMauro Carvalho Chehab if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) { 2408de7d4f0eSAndy Whitcroft $setup_docs = 1; 2409de7d4f0eSAndy Whitcroft } 2410773647a0SAndy Whitcroft #next; 2411de7d4f0eSAndy Whitcroft } 241274fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2413773647a0SAndy Whitcroft $realline=$1-1; 2414773647a0SAndy Whitcroft if (defined $2) { 2415773647a0SAndy Whitcroft $realcnt=$3+1; 2416773647a0SAndy Whitcroft } else { 2417773647a0SAndy Whitcroft $realcnt=1+1; 2418773647a0SAndy Whitcroft } 2419c45dcabdSAndy Whitcroft $in_comment = 0; 2420773647a0SAndy Whitcroft 2421773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2422773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2423773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2424773647a0SAndy Whitcroft # at context start. 2425773647a0SAndy Whitcroft my $edge; 242601fa9147SAndy Whitcroft my $cnt = $realcnt; 242701fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 242801fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 242901fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 243001fa9147SAndy Whitcroft $cnt--; 243101fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2432721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2433fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2434fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2435fae17daeSAndy Whitcroft ($edge) = $1; 2436fae17daeSAndy Whitcroft last; 2437fae17daeSAndy Whitcroft } 2438773647a0SAndy Whitcroft } 2439773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2440773647a0SAndy Whitcroft $in_comment = 1; 2441773647a0SAndy Whitcroft } 2442773647a0SAndy Whitcroft 2443773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2444773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2445773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2446773647a0SAndy Whitcroft if (!defined $edge && 244783242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2448773647a0SAndy Whitcroft { 2449773647a0SAndy Whitcroft $in_comment = 1; 2450773647a0SAndy Whitcroft } 2451773647a0SAndy Whitcroft 2452773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2453773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2454773647a0SAndy Whitcroft 2455171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2456773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2457171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2458773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2459773647a0SAndy Whitcroft } 2460773647a0SAndy Whitcroft push(@lines, $line); 2461773647a0SAndy Whitcroft 2462773647a0SAndy Whitcroft if ($realcnt > 1) { 2463773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2464773647a0SAndy Whitcroft } else { 2465773647a0SAndy Whitcroft $realcnt = 0; 2466773647a0SAndy Whitcroft } 2467773647a0SAndy Whitcroft 2468773647a0SAndy Whitcroft #print "==>$rawline\n"; 2469773647a0SAndy Whitcroft #print "-->$line\n"; 2470de7d4f0eSAndy Whitcroft 2471de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2472de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2473de7d4f0eSAndy Whitcroft } 2474de7d4f0eSAndy Whitcroft } 2475de7d4f0eSAndy Whitcroft 24766c72ffaaSAndy Whitcroft $prefix = ''; 24776c72ffaaSAndy Whitcroft 2478773647a0SAndy Whitcroft $realcnt = 0; 2479773647a0SAndy Whitcroft $linenr = 0; 2480194f66fcSJoe Perches $fixlinenr = -1; 24810a920b5bSAndy Whitcroft foreach my $line (@lines) { 24820a920b5bSAndy Whitcroft $linenr++; 2483194f66fcSJoe Perches $fixlinenr++; 24841b5539b1SJoe Perches my $sline = $line; #copy of $line 24851b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 24860a920b5bSAndy Whitcroft 2487c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 2488f36d3eb8SJoe Perches my $raw_comment = get_raw_comment($line, $rawline); 24896c72ffaaSAndy Whitcroft 249012c253abSJoe Perches# check if it's a mode change, rename or start of a patch 249112c253abSJoe Perches if (!$in_commit_log && 249212c253abSJoe Perches ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 249312c253abSJoe Perches ($line =~ /^rename (?:from|to) \S+\s*$/ || 249412c253abSJoe Perches $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 249512c253abSJoe Perches $is_patch = 1; 249612c253abSJoe Perches } 249712c253abSJoe Perches 24980a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2499e518e9a5SJoe Perches if (!$in_commit_log && 250074fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 250174fd4f34SJoe Perches my $context = $4; 25020a920b5bSAndy Whitcroft $is_patch = 1; 25034a0df2efSAndy Whitcroft $first_line = $linenr + 1; 25040a920b5bSAndy Whitcroft $realline=$1-1; 25050a920b5bSAndy Whitcroft if (defined $2) { 25060a920b5bSAndy Whitcroft $realcnt=$3+1; 25070a920b5bSAndy Whitcroft } else { 25080a920b5bSAndy Whitcroft $realcnt=1+1; 25090a920b5bSAndy Whitcroft } 2510c2fdda0dSAndy Whitcroft annotate_reset(); 251113214adfSAndy Whitcroft $prev_values = 'E'; 251213214adfSAndy Whitcroft 2513773647a0SAndy Whitcroft %suppress_ifbraces = (); 2514170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 25152b474a1aSAndy Whitcroft %suppress_export = (); 25163e469cdcSAndy Whitcroft $suppress_statement = 0; 251774fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 251874fd4f34SJoe Perches $context_function = $1; 251974fd4f34SJoe Perches } else { 252074fd4f34SJoe Perches undef $context_function; 252174fd4f34SJoe Perches } 25220a920b5bSAndy Whitcroft next; 25230a920b5bSAndy Whitcroft 25244a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 25254a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 25264a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2527773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 25280a920b5bSAndy Whitcroft $realline++; 2529d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 25300a920b5bSAndy Whitcroft 25314a0df2efSAndy Whitcroft # Measure the line length and indent. 2532c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 25330a920b5bSAndy Whitcroft 25340a920b5bSAndy Whitcroft # Track the previous line. 25350a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 25360a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2537c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2538c2fdda0dSAndy Whitcroft 2539773647a0SAndy Whitcroft #warn "line<$line>\n"; 25406c72ffaaSAndy Whitcroft 2541d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2542d8aaf121SAndy Whitcroft $realcnt--; 25430a920b5bSAndy Whitcroft } 25440a920b5bSAndy Whitcroft 2545cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2546cc77cdcaSAndy Whitcroft 25476c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 25486c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2549773647a0SAndy Whitcroft 25502ac73b4fSJoe Perches my $found_file = 0; 2551773647a0SAndy Whitcroft # extract the filename as it passes 25523bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 25533bf9a009SRabin Vincent $realfile = $1; 25542b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2555270c49a0SJoe Perches $in_commit_log = 0; 25562ac73b4fSJoe Perches $found_file = 1; 25573bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2558773647a0SAndy Whitcroft $realfile = $1; 25592b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2560270c49a0SJoe Perches $in_commit_log = 0; 25611e855726SWolfram Sang 25621e855726SWolfram Sang $p1_prefix = $1; 2563e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2564e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2565000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2566000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 25671e855726SWolfram Sang } 2568773647a0SAndy Whitcroft 2569c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2570000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2571000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2572773647a0SAndy Whitcroft } 25732ac73b4fSJoe Perches $found_file = 1; 25742ac73b4fSJoe Perches } 25752ac73b4fSJoe Perches 257634d8815fSJoe Perches#make up the handle for any error we report on this line 257734d8815fSJoe Perches if ($showfile) { 257834d8815fSJoe Perches $prefix = "$realfile:$realline: " 257934d8815fSJoe Perches } elsif ($emacs) { 25807d3a9f67SJoe Perches if ($file) { 25817d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 25827d3a9f67SJoe Perches } else { 258334d8815fSJoe Perches $prefix = "$filename:$linenr: "; 258434d8815fSJoe Perches } 25857d3a9f67SJoe Perches } 258634d8815fSJoe Perches 25872ac73b4fSJoe Perches if ($found_file) { 258885b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 258985b0ee18SJoe Perches WARN("OBSOLETE", 259085b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 259185b0ee18SJoe Perches } 25927bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 25932ac73b4fSJoe Perches $check = 1; 25942ac73b4fSJoe Perches } else { 25952ac73b4fSJoe Perches $check = $check_orig; 25962ac73b4fSJoe Perches } 25979f3a8992SRob Herring $checklicenseline = 1; 2598133712a2SRob Herring 2599133712a2SRob Herring if ($realfile !~ /^MAINTAINERS/) { 2600133712a2SRob Herring my $last_binding_patch = $is_binding_patch; 2601133712a2SRob Herring 2602133712a2SRob Herring $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@; 2603133712a2SRob Herring 2604133712a2SRob Herring if (($last_binding_patch != -1) && 2605133712a2SRob Herring ($last_binding_patch ^ $is_binding_patch)) { 2606133712a2SRob Herring WARN("DT_SPLIT_BINDING_PATCH", 2607133712a2SRob Herring "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n"); 2608133712a2SRob Herring } 2609133712a2SRob Herring } 2610133712a2SRob Herring 2611773647a0SAndy Whitcroft next; 2612773647a0SAndy Whitcroft } 2613773647a0SAndy Whitcroft 2614389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 26150a920b5bSAndy Whitcroft 2616c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2617c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2618c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 26190a920b5bSAndy Whitcroft 26206c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 26216c72ffaaSAndy Whitcroft 2622490b292cSJoe Perches# Verify the existence of a commit log if appropriate 2623490b292cSJoe Perches# 2 is used because a $signature is counted in $commit_log_lines 2624490b292cSJoe Perches if ($in_commit_log) { 2625490b292cSJoe Perches if ($line !~ /^\s*$/) { 2626490b292cSJoe Perches $commit_log_lines++; #could be a $signature 2627490b292cSJoe Perches } 2628490b292cSJoe Perches } elsif ($has_commit_log && $commit_log_lines < 2) { 2629490b292cSJoe Perches WARN("COMMIT_MESSAGE", 2630490b292cSJoe Perches "Missing commit description - Add an appropriate one\n"); 2631490b292cSJoe Perches $commit_log_lines = 2; #warn only once 2632490b292cSJoe Perches } 2633490b292cSJoe Perches 2634e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2635e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2636e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2637e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2638e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2639e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2640e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2641e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2642e518e9a5SJoe Perches $commit_log_has_diff = 1; 2643e518e9a5SJoe Perches } 2644e518e9a5SJoe Perches 26453bf9a009SRabin Vincent# Check for incorrect file permissions 26463bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 26473bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 264804db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 264904db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2650000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2651000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 26523bf9a009SRabin Vincent } 26533bf9a009SRabin Vincent } 26543bf9a009SRabin Vincent 2655cd261496SGeert Uytterhoeven# Check the patch for a From: 2656cd261496SGeert Uytterhoeven if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { 2657cd261496SGeert Uytterhoeven $author = $1; 2658cd261496SGeert Uytterhoeven $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); 2659cd261496SGeert Uytterhoeven $author =~ s/"//g; 2660dfa05c28SJoe Perches $author = reformat_email($author); 2661cd261496SGeert Uytterhoeven } 2662cd261496SGeert Uytterhoeven 266320112475SJoe Perches# Check the patch for a signoff: 2664dfa05c28SJoe Perches if ($line =~ /^\s*signed-off-by:\s*(.*)/i) { 26654a0df2efSAndy Whitcroft $signoff++; 266615662b3eSJoe Perches $in_commit_log = 0; 2667cd261496SGeert Uytterhoeven if ($author ne '') { 2668dfa05c28SJoe Perches if (same_email_addresses($1, $author)) { 2669cd261496SGeert Uytterhoeven $authorsignoff = 1; 2670cd261496SGeert Uytterhoeven } 2671cd261496SGeert Uytterhoeven } 26720a920b5bSAndy Whitcroft } 267320112475SJoe Perches 267444d303ebSJoe Perches# Check for patch separator 267544d303ebSJoe Perches if ($line =~ /^---$/) { 267644d303ebSJoe Perches $has_patch_separator = 1; 267744d303ebSJoe Perches $in_commit_log = 0; 267844d303ebSJoe Perches } 267944d303ebSJoe Perches 2680e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2681e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2682e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2683e0d975b1SJoe Perches $reported_maintainer_file = 1; 2684e0d975b1SJoe Perches } 2685e0d975b1SJoe Perches 268620112475SJoe Perches# Check signature styles 2687270c49a0SJoe Perches if (!$in_header_lines && 2688ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 268920112475SJoe Perches my $space_before = $1; 269020112475SJoe Perches my $sign_off = $2; 269120112475SJoe Perches my $space_after = $3; 269220112475SJoe Perches my $email = $4; 269320112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 269420112475SJoe Perches 2695ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2696ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2697ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2698ce0338dfSJoe Perches } 269920112475SJoe Perches if (defined $space_before && $space_before ne "") { 27003705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 27013705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 27023705ce5bSJoe Perches $fix) { 2703194f66fcSJoe Perches $fixed[$fixlinenr] = 27043705ce5bSJoe Perches "$ucfirst_sign_off $email"; 27053705ce5bSJoe Perches } 270620112475SJoe Perches } 270720112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 27083705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 27093705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 27103705ce5bSJoe Perches $fix) { 2711194f66fcSJoe Perches $fixed[$fixlinenr] = 27123705ce5bSJoe Perches "$ucfirst_sign_off $email"; 27133705ce5bSJoe Perches } 27143705ce5bSJoe Perches 271520112475SJoe Perches } 271620112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 27173705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 27183705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 27193705ce5bSJoe Perches $fix) { 2720194f66fcSJoe Perches $fixed[$fixlinenr] = 27213705ce5bSJoe Perches "$ucfirst_sign_off $email"; 27223705ce5bSJoe Perches } 272320112475SJoe Perches } 272420112475SJoe Perches 2725dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 272620112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 272720112475SJoe Perches if ($suggested_email eq "") { 2728000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2729000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 273020112475SJoe Perches } else { 273120112475SJoe Perches my $dequoted = $suggested_email; 273220112475SJoe Perches $dequoted =~ s/^"//; 273320112475SJoe Perches $dequoted =~ s/" </ </; 273420112475SJoe Perches # Don't force email to have quotes 273520112475SJoe Perches # Allow just an angle bracketed address 2736dfa05c28SJoe Perches if (!same_email_addresses($email, $suggested_email)) { 2737000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2738000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 273920112475SJoe Perches } 27400a920b5bSAndy Whitcroft } 27417e51f197SJoe Perches 27427e51f197SJoe Perches# Check for duplicate signatures 27437e51f197SJoe Perches my $sig_nospace = $line; 27447e51f197SJoe Perches $sig_nospace =~ s/\s//g; 27457e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 27467e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 27477e51f197SJoe Perches WARN("BAD_SIGN_OFF", 27487e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 27497e51f197SJoe Perches } else { 27507e51f197SJoe Perches $signatures{$sig_nospace} = 1; 27517e51f197SJoe Perches } 27526c5d24eeSSean Christopherson 27536c5d24eeSSean Christopherson# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email 27546c5d24eeSSean Christopherson if ($sign_off =~ /^co-developed-by:$/i) { 27556c5d24eeSSean Christopherson if ($email eq $author) { 27566c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 27576c5d24eeSSean Christopherson "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline); 27586c5d24eeSSean Christopherson } 27596c5d24eeSSean Christopherson if (!defined $lines[$linenr]) { 27606c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 27616c5d24eeSSean Christopherson "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline); 27626c5d24eeSSean Christopherson } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) { 27636c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 27646c5d24eeSSean Christopherson "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 27656c5d24eeSSean Christopherson } elsif ($1 ne $email) { 27666c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 27676c5d24eeSSean Christopherson "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 27686c5d24eeSSean Christopherson } 27696c5d24eeSSean Christopherson } 27700a920b5bSAndy Whitcroft } 27710a920b5bSAndy Whitcroft 2772a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2773a2fe16b9SJoe Perches if ($in_header_lines && 2774a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2775a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2776a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2777a2fe16b9SJoe Perches } 2778a2fe16b9SJoe Perches 277944d303ebSJoe Perches# Check for Gerrit Change-Ids not in any patch context 278044d303ebSJoe Perches if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) { 27817ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 278244d303ebSJoe Perches "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr); 27837ebd05efSChristopher Covington } 27847ebd05efSChristopher Covington 2785369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2786369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2787369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2788369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2789369c8dd3SJoe Perches # timestamp 2790634cffccSJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) || 2791634cffccSJoe Perches $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ || 2792634cffccSJoe Perches $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) { 2793634cffccSJoe Perches # stack dump address styles 2794369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2795369c8dd3SJoe Perches } 2796369c8dd3SJoe Perches 27972a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 27982a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2799bf4daf12SJoe Perches length($line) > 75 && 2800bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2801bf4daf12SJoe Perches # file delta changes 2802bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2803bf4daf12SJoe Perches # filename then : 2804bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2805bf4daf12SJoe Perches # A Fixes: or Link: line 2806bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 28072a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 28082a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 28092a076f40SJoe Perches $commit_log_long_line = 1; 28102a076f40SJoe Perches } 28112a076f40SJoe Perches 2812bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2813bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2814bf4daf12SJoe Perches $line =~ /^\s*$/) { 2815bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2816bf4daf12SJoe Perches } 2817bf4daf12SJoe Perches 28180d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2819369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2820a8972573SJohn Hubbard $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i && 2821e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 2822fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2823aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2824369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2825bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2826fe043ea1SJoe Perches my $init_char = "c"; 2827fe043ea1SJoe Perches my $orig_commit = ""; 28280d7835fcSJoe Perches my $short = 1; 28290d7835fcSJoe Perches my $long = 0; 28300d7835fcSJoe Perches my $case = 1; 28310d7835fcSJoe Perches my $space = 1; 28320d7835fcSJoe Perches my $hasdesc = 0; 283319c146a6SJoe Perches my $hasparens = 0; 28340d7835fcSJoe Perches my $id = '0123456789ab'; 28350d7835fcSJoe Perches my $orig_desc = "commit description"; 28360d7835fcSJoe Perches my $description = ""; 28370d7835fcSJoe Perches 2838fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2839fe043ea1SJoe Perches $init_char = $1; 2840fe043ea1SJoe Perches $orig_commit = lc($2); 2841fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2842fe043ea1SJoe Perches $orig_commit = lc($1); 2843fe043ea1SJoe Perches } 2844fe043ea1SJoe Perches 28450d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 28460d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 28470d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 28480d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 28490d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 28500d7835fcSJoe Perches $orig_desc = $1; 285119c146a6SJoe Perches $hasparens = 1; 28520d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 28530d7835fcSJoe Perches defined $rawlines[$linenr] && 28540d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 28550d7835fcSJoe Perches $orig_desc = $1; 285619c146a6SJoe Perches $hasparens = 1; 2857b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2858b671fde0SJoe Perches defined $rawlines[$linenr] && 2859b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2860b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2861b671fde0SJoe Perches $orig_desc = $1; 2862b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2863b671fde0SJoe Perches $orig_desc .= " " . $1; 286419c146a6SJoe Perches $hasparens = 1; 28650d7835fcSJoe Perches } 28660d7835fcSJoe Perches 28670d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 28680d7835fcSJoe Perches $id, $orig_desc); 28690d7835fcSJoe Perches 2870948b133aSHeinrich Schuchardt if (defined($id) && 2871948b133aSHeinrich Schuchardt ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { 2872d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 28730d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 28740d7835fcSJoe Perches } 2875d311cd44SJoe Perches } 2876d311cd44SJoe Perches 287713f1937eSJoe Perches# Check for added, moved or deleted files 287813f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 287913f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 288013f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 288113f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 288213f1937eSJoe Perches (defined($1) || defined($2))))) { 2883a82603a8SAndrew Jeffery $is_patch = 1; 288413f1937eSJoe Perches $reported_maintainer_file = 1; 288513f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 288613f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 288713f1937eSJoe Perches } 288813f1937eSJoe Perches 2889e400edb1SRob Herring# Check for adding new DT bindings not in schema format 2890e400edb1SRob Herring if (!$in_commit_log && 2891e400edb1SRob Herring ($line =~ /^new file mode\s*\d+\s*$/) && 2892e400edb1SRob Herring ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) { 2893e400edb1SRob Herring WARN("DT_SCHEMA_BINDING_PATCH", 2894e400edb1SRob Herring "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n"); 2895e400edb1SRob Herring } 2896e400edb1SRob Herring 289700df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 28988905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2899000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2900000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 29016c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2902de7d4f0eSAndy Whitcroft } 2903de7d4f0eSAndy Whitcroft 2904de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2905de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2906171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2907171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2908171ae1a4SAndy Whitcroft 2909171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2910171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2911171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2912171ae1a4SAndy Whitcroft 291334d99219SJoe Perches CHK("INVALID_UTF8", 2914000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 291500df344fSAndy Whitcroft } 29160a920b5bSAndy Whitcroft 291715662b3eSJoe Perches# Check if it's the start of a commit log 291815662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 291915662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 2920eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 2921eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 292215662b3eSJoe Perches $in_header_lines = 0; 292315662b3eSJoe Perches $in_commit_log = 1; 2924ed43c4e5SAllen Hubbe $has_commit_log = 1; 292515662b3eSJoe Perches } 292615662b3eSJoe Perches 2927fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2928fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2929fa64205dSPasi Savanainen if ($in_header_lines && 2930fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2931fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2932fa64205dSPasi Savanainen $non_utf8_charset = 1; 2933fa64205dSPasi Savanainen } 2934fa64205dSPasi Savanainen 2935fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 293615662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2937fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 293815662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 293915662b3eSJoe Perches } 294015662b3eSJoe Perches 2941d6430f71SJoe Perches# Check for absolute kernel paths in commit message 2942d6430f71SJoe Perches if ($tree && $in_commit_log) { 2943d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 2944d6430f71SJoe Perches my $file = $1; 2945d6430f71SJoe Perches 2946d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 2947d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 2948d6430f71SJoe Perches # 2949d6430f71SJoe Perches } else { 2950d6430f71SJoe Perches check_absolute_file($file, $herecurr); 2951d6430f71SJoe Perches } 2952d6430f71SJoe Perches } 2953d6430f71SJoe Perches } 2954d6430f71SJoe Perches 295566b47b4aSKees Cook# Check for various typo / spelling mistakes 295666d7a382SJoe Perches if (defined($misspellings) && 295766d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2958ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 295966b47b4aSKees Cook my $typo = $1; 296066b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 296166b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 296266b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 29630675a8fbSJean Delvare my $msg_level = \&WARN; 29640675a8fbSJean Delvare $msg_level = \&CHK if ($file); 29650675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 296666b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 296766b47b4aSKees Cook $fix) { 296866b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 296966b47b4aSKees Cook } 297066b47b4aSKees Cook } 297166b47b4aSKees Cook } 297266b47b4aSKees Cook 2973a8dd86bfSMatteo Croce# check for invalid commit id 2974a8dd86bfSMatteo Croce if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) { 2975a8dd86bfSMatteo Croce my $id; 2976a8dd86bfSMatteo Croce my $description; 2977a8dd86bfSMatteo Croce ($id, $description) = git_commit_info($2, undef, undef); 2978a8dd86bfSMatteo Croce if (!defined($id)) { 2979a8dd86bfSMatteo Croce WARN("UNKNOWN_COMMIT_ID", 2980a8dd86bfSMatteo Croce "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr); 2981a8dd86bfSMatteo Croce } 2982a8dd86bfSMatteo Croce } 2983a8dd86bfSMatteo Croce 298430670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 298530670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 298600df344fSAndy Whitcroft 29870a920b5bSAndy Whitcroft#trailing whitespace 29889c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2989c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2990d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2991d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2992d5e616fcSJoe Perches $fix) { 2993194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2994d5e616fcSJoe Perches } 2995c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2996c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 29973705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 29983705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 29993705ce5bSJoe Perches $fix) { 3000194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 30013705ce5bSJoe Perches } 30023705ce5bSJoe Perches 3003d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 30040a920b5bSAndy Whitcroft } 30055368df20SAndy Whitcroft 30064783f894SJosh Triplett# Check for FSF mailing addresses. 3007109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 30081bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 30093e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 30103e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 30114783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 30120675a8fbSJean Delvare my $msg_level = \&ERROR; 30130675a8fbSJean Delvare $msg_level = \&CHK if ($file); 30140675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 30154783f894SJosh 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) 30164783f894SJosh Triplett } 30174783f894SJosh Triplett 30183354957aSAndi Kleen# check for Kconfig help text having a real description 30199fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 30209fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 30213354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 3022678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 3023678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 3024678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 3025678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 30263354957aSAndi Kleen my $length = 0; 30279fe287d7SAndy Whitcroft my $cnt = $realcnt; 30289fe287d7SAndy Whitcroft my $ln = $linenr + 1; 30299fe287d7SAndy Whitcroft my $f; 3030a1385803SAndy Whitcroft my $is_start = 0; 30319fe287d7SAndy Whitcroft my $is_end = 0; 3032a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 30339fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 30349fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 30359fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 30369fe287d7SAndy Whitcroft 30379fe287d7SAndy Whitcroft next if ($f =~ /^-/); 30388d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 3039a1385803SAndy Whitcroft 304086adf1a0SUlf Magnusson if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 3041a1385803SAndy Whitcroft $is_start = 1; 304284af7a61SUlf Magnusson } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) { 304384af7a61SUlf Magnusson if ($lines[$ln - 1] =~ "---help---") { 304484af7a61SUlf Magnusson WARN("CONFIG_DESCRIPTION", 304584af7a61SUlf Magnusson "prefer 'help' over '---help---' for new help texts\n" . $herecurr); 304684af7a61SUlf Magnusson } 3047a1385803SAndy Whitcroft $length = -1; 3048a1385803SAndy Whitcroft } 3049a1385803SAndy Whitcroft 30509fe287d7SAndy Whitcroft $f =~ s/^.//; 30513354957aSAndi Kleen $f =~ s/#.*//; 30523354957aSAndi Kleen $f =~ s/^\s+//; 30533354957aSAndi Kleen next if ($f =~ /^$/); 3054678ae162SUlf Magnusson 3055678ae162SUlf Magnusson # This only checks context lines in the patch 3056678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 3057678ae162SUlf Magnusson # positives, even though some of these are 3058678ae162SUlf Magnusson # common words in help texts 3059678ae162SUlf Magnusson if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| 3060678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 30619fe287d7SAndy Whitcroft $is_end = 1; 30629fe287d7SAndy Whitcroft last; 30639fe287d7SAndy Whitcroft } 30643354957aSAndi Kleen $length++; 30653354957aSAndi Kleen } 306656193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 3067000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 306856193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 306956193274SVadim Bendebury } 3070a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 30713354957aSAndi Kleen } 30723354957aSAndi Kleen 30737ccf41a8SJoe Perches# check MAINTAINERS entries 30747ccf41a8SJoe Perches if ($realfile =~ /^MAINTAINERS$/) { 30757ccf41a8SJoe Perches# check MAINTAINERS entries for the right form 30767ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 3077628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 3078628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 3079628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 3080628f91a2SJoe Perches $fix) { 3081628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 3082628f91a2SJoe Perches } 3083628f91a2SJoe Perches } 30847ccf41a8SJoe Perches# check MAINTAINERS entries for the right ordering too 30857ccf41a8SJoe Perches my $preferred_order = 'MRLSWQBCPTFXNK'; 30867ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 30877ccf41a8SJoe Perches $prevrawline =~ /^[\+ ][A-Z]:/) { 30887ccf41a8SJoe Perches $rawline =~ /^\+([A-Z]):\s*(.*)/; 30897ccf41a8SJoe Perches my $cur = $1; 30907ccf41a8SJoe Perches my $curval = $2; 30917ccf41a8SJoe Perches $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/; 30927ccf41a8SJoe Perches my $prev = $1; 30937ccf41a8SJoe Perches my $prevval = $2; 30947ccf41a8SJoe Perches my $curindex = index($preferred_order, $cur); 30957ccf41a8SJoe Perches my $previndex = index($preferred_order, $prev); 30967ccf41a8SJoe Perches if ($curindex < 0) { 30977ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 30987ccf41a8SJoe Perches "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr); 30997ccf41a8SJoe Perches } else { 31007ccf41a8SJoe Perches if ($previndex >= 0 && $curindex < $previndex) { 31017ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 31027ccf41a8SJoe Perches "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev); 31037ccf41a8SJoe Perches } elsif ((($prev eq 'F' && $cur eq 'F') || 31047ccf41a8SJoe Perches ($prev eq 'X' && $cur eq 'X')) && 31057ccf41a8SJoe Perches ($prevval cmp $curval) > 0) { 31067ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 31077ccf41a8SJoe Perches "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev); 31087ccf41a8SJoe Perches } 31097ccf41a8SJoe Perches } 31107ccf41a8SJoe Perches } 31117ccf41a8SJoe Perches } 3112628f91a2SJoe Perches 3113327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 3114327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 3115327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 3116327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 3117327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 3118327953e9SChristoph Jaeger } 3119327953e9SChristoph Jaeger 3120c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 3121c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 3122c68e5878SArnaud Lacombe my $flag = $1; 3123c68e5878SArnaud Lacombe my $replacement = { 3124c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 3125c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 3126c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 3127c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 3128c68e5878SArnaud Lacombe }; 3129c68e5878SArnaud Lacombe 3130c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 3131c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 3132c68e5878SArnaud Lacombe } 3133c68e5878SArnaud Lacombe 3134bff5da43SRob Herring# check for DT compatible documentation 31357dd05b38SFlorian Vaussard if (defined $root && 31367dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 31377dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 31387dd05b38SFlorian Vaussard 3139bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 3140bff5da43SRob Herring 3141cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 3142852d095dSRob Herring my $vp_file = $dt_path . "vendor-prefixes.yaml"; 3143cc93319bSFlorian Vaussard 3144bff5da43SRob Herring foreach my $compat (@compats) { 3145bff5da43SRob Herring my $compat2 = $compat; 3146185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 3147185d566bSRob Herring my $compat3 = $compat; 3148185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 3149185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 3150bff5da43SRob Herring if ( $? >> 8 ) { 3151bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3152bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 3153bff5da43SRob Herring } 3154bff5da43SRob Herring 31554fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 31564fbf32a6SFlorian Vaussard my $vendor = $1; 3157852d095dSRob Herring `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`; 3158bff5da43SRob Herring if ( $? >> 8 ) { 3159bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3160cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 3161bff5da43SRob Herring } 3162bff5da43SRob Herring } 3163bff5da43SRob Herring } 3164bff5da43SRob Herring 31659f3a8992SRob Herring# check for using SPDX license tag at beginning of files 31669f3a8992SRob Herring if ($realline == $checklicenseline) { 31679f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 31689f3a8992SRob Herring $checklicenseline = 2; 31699f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 31709f3a8992SRob Herring my $comment = ""; 31719f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 31729f3a8992SRob Herring $comment = '/*'; 31739f3a8992SRob Herring } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 31749f3a8992SRob Herring $comment = '//'; 3175c8df0ab6SLubomir Rintel } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) { 31769f3a8992SRob Herring $comment = '#'; 31779f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 31789f3a8992SRob Herring $comment = '..'; 31799f3a8992SRob Herring } 31809f3a8992SRob Herring 3181fdf13693SJoe Perches# check SPDX comment style for .[chsS] files 3182fdf13693SJoe Perches if ($realfile =~ /\.[chsS]$/ && 3183fdf13693SJoe Perches $rawline =~ /SPDX-License-Identifier:/ && 3184ffbce897SJoe Perches $rawline !~ m@^\+\s*\Q$comment\E\s*@) { 3185fdf13693SJoe Perches WARN("SPDX_LICENSE_TAG", 3186fdf13693SJoe Perches "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr); 3187fdf13693SJoe Perches } 3188fdf13693SJoe Perches 31899f3a8992SRob Herring if ($comment !~ /^$/ && 3190ffbce897SJoe Perches $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) { 31919f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 31929f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 31933b6e8ac9SJoe Perches } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) { 31943b6e8ac9SJoe Perches my $spdx_license = $1; 31953b6e8ac9SJoe Perches if (!is_SPDX_License_valid($spdx_license)) { 31963b6e8ac9SJoe Perches WARN("SPDX_LICENSE_TAG", 31973b6e8ac9SJoe Perches "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr); 31983b6e8ac9SJoe Perches } 319950c92900SLubomir Rintel if ($realfile =~ m@^Documentation/devicetree/bindings/@ && 320050c92900SLubomir Rintel not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) { 320150c92900SLubomir Rintel my $msg_level = \&WARN; 320250c92900SLubomir Rintel $msg_level = \&CHK if ($file); 320350c92900SLubomir Rintel if (&{$msg_level}("SPDX_LICENSE_TAG", 320450c92900SLubomir Rintel 320550c92900SLubomir Rintel "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) && 320650c92900SLubomir Rintel $fix) { 320750c92900SLubomir Rintel $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/; 320850c92900SLubomir Rintel } 320950c92900SLubomir Rintel } 32109f3a8992SRob Herring } 32119f3a8992SRob Herring } 32129f3a8992SRob Herring } 32139f3a8992SRob Herring 32145368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 3215d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 32165368df20SAndy Whitcroft 3217a8da38a9SJoe Perches# check for using SPDX-License-Identifier on the wrong line number 3218a8da38a9SJoe Perches if ($realline != $checklicenseline && 3219a8da38a9SJoe Perches $rawline =~ /\bSPDX-License-Identifier:/ && 3220a8da38a9SJoe Perches substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) { 3221a8da38a9SJoe Perches WARN("SPDX_LICENSE_TAG", 3222a8da38a9SJoe Perches "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr); 3223a8da38a9SJoe Perches } 3224a8da38a9SJoe Perches 322547e0c88bSJoe Perches# line length limit (with some exclusions) 322647e0c88bSJoe Perches# 322747e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 322847e0c88bSJoe Perches# logging functions like pr_info that end in a string 322947e0c88bSJoe Perches# lines with a single string 323047e0c88bSJoe Perches# #defines that are a single string 32312e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 323247e0c88bSJoe Perches# 323347e0c88bSJoe Perches# There are 3 different line length message types: 3234ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 323547e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 323647e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 323747e0c88bSJoe Perches# 323847e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 323947e0c88bSJoe Perches# 324047e0c88bSJoe Perches 3241b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 324247e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 324347e0c88bSJoe Perches 324447e0c88bSJoe Perches # Check the allowed long line types first 324547e0c88bSJoe Perches 324647e0c88bSJoe Perches # logging functions that end in a string that starts 324747e0c88bSJoe Perches # before $max_line_length 324847e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 324947e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 325047e0c88bSJoe Perches $msg_type = ""; 325147e0c88bSJoe Perches 325247e0c88bSJoe Perches # lines with only strings (w/ possible termination) 325347e0c88bSJoe Perches # #defines with only strings 325447e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 325547e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 325647e0c88bSJoe Perches $msg_type = ""; 325747e0c88bSJoe Perches 3258cc147506SJoe Perches # More special cases 3259cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3260cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3261d560a5f8SJoe Perches $msg_type = ""; 3262d560a5f8SJoe Perches 32632e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 32642e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 32652e4bbbc5SAndreas Brauchli $msg_type = ""; 32662e4bbbc5SAndreas Brauchli 326747e0c88bSJoe Perches # Otherwise set the alternate message types 326847e0c88bSJoe Perches 326947e0c88bSJoe Perches # a comment starts before $max_line_length 327047e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 327147e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 327247e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 327347e0c88bSJoe Perches 327447e0c88bSJoe Perches # a quoted string starts before $max_line_length 327547e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 327647e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 327747e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 327847e0c88bSJoe Perches } 327947e0c88bSJoe Perches 328047e0c88bSJoe Perches if ($msg_type ne "" && 328147e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 3282bdc48fa1SJoe Perches my $msg_level = \&WARN; 3283bdc48fa1SJoe Perches $msg_level = \&CHK if ($file); 3284bdc48fa1SJoe Perches &{$msg_level}($msg_type, 3285bdc48fa1SJoe Perches "line length of $length exceeds $max_line_length columns\n" . $herecurr); 32860a920b5bSAndy Whitcroft } 328747e0c88bSJoe Perches } 32880a920b5bSAndy Whitcroft 32898905a67cSAndy Whitcroft# check for adding lines without a newline. 32908905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 3291000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 3292000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 32938905a67cSAndy Whitcroft } 32948905a67cSAndy Whitcroft 3295b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3296de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 32970a920b5bSAndy Whitcroft 32980a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 3299713a09deSAntonio Borneo# more than $tabsize must use tabs. 3300c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3301c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3302c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3303d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 33043705ce5bSJoe Perches if (ERROR("CODE_INDENT", 33053705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 33063705ce5bSJoe Perches $fix) { 3307194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 33083705ce5bSJoe Perches } 33090a920b5bSAndy Whitcroft } 33100a920b5bSAndy Whitcroft 331108e44365SAlberto Panizzo# check for space before tabs. 331208e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 331308e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 33143705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 33153705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 33163705ce5bSJoe Perches $fix) { 3317194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3318713a09deSAntonio Borneo s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} 3319194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3320c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 33213705ce5bSJoe Perches } 332208e44365SAlberto Panizzo } 332308e44365SAlberto Panizzo 33246a487211SJoe Perches# check for assignments on the start of a line 33256a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 33266a487211SJoe Perches CHK("ASSIGNMENT_CONTINUATIONS", 33276a487211SJoe Perches "Assignment operator '$1' should be on the previous line\n" . $hereprev); 33286a487211SJoe Perches } 33296a487211SJoe Perches 3330d1fe9c09SJoe Perches# check for && or || at the start of a line 3331d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 3332d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 3333d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 3334d1fe9c09SJoe Perches } 3335d1fe9c09SJoe Perches 3336a91e8994SJoe Perches# check indentation starts on a tab stop 33375b57980dSJoe Perches if ($perl_version_ok && 3338bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3339a91e8994SJoe Perches my $indent = length($1); 3340713a09deSAntonio Borneo if ($indent % $tabsize) { 3341a91e8994SJoe Perches if (WARN("TABSTOP", 3342a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3343a91e8994SJoe Perches $fix) { 3344713a09deSAntonio Borneo $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; 3345a91e8994SJoe Perches } 3346a91e8994SJoe Perches } 3347a91e8994SJoe Perches } 3348a91e8994SJoe Perches 3349d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 33505b57980dSJoe Perches if ($perl_version_ok && 3351fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3352d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3353d1fe9c09SJoe Perches my $oldindent = $1; 3354d1fe9c09SJoe Perches my $rest = $2; 3355d1fe9c09SJoe Perches 3356d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3357d1fe9c09SJoe Perches if ($pos >= 0) { 3358b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3359b34a26f3SJoe Perches my $newindent = $2; 3360d1fe9c09SJoe Perches 3361d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3362713a09deSAntonio Borneo "\t" x ($pos / $tabsize) . 3363713a09deSAntonio Borneo " " x ($pos % $tabsize); 3364d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3365d1fe9c09SJoe Perches 3366d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3367d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 33683705ce5bSJoe Perches 33693705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 33703705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 33713705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3372194f66fcSJoe Perches $fixed[$fixlinenr] =~ 33733705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 33743705ce5bSJoe Perches } 3375d1fe9c09SJoe Perches } 3376d1fe9c09SJoe Perches } 3377d1fe9c09SJoe Perches } 3378d1fe9c09SJoe Perches 33796ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 33806ab3a970SJoe Perches# avoid checking a few false positives: 33816ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 33826ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 33836ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 33846ab3a970SJoe Perches# multiline macros that define functions 33856ab3a970SJoe Perches# known attributes or the __attribute__ keyword 33866ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 33876ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 33883705ce5bSJoe Perches if (CHK("SPACING", 3389f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 33903705ce5bSJoe Perches $fix) { 3391194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3392f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 33933705ce5bSJoe Perches } 3394aad4f614SJoe Perches } 3395aad4f614SJoe Perches 339686406b1cSJoe Perches# Block comment styles 339786406b1cSJoe Perches# Networking with an initial /* 339805880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3399fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 340085ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 340185ad978cSJoe Perches $realline > 2) { 340205880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 340305880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 340405880600SJoe Perches } 340505880600SJoe Perches 340686406b1cSJoe Perches# Block comments use * on subsequent lines 340786406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 340886406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3409a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 341061135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3411a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 341286406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 341386406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3414a605e32eSJoe Perches } 3415a605e32eSJoe Perches 341686406b1cSJoe Perches# Block comments use */ on trailing lines 341786406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3418c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3419c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3420c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 342186406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 342286406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 342305880600SJoe Perches } 342405880600SJoe Perches 342508eb9b80SJoe Perches# Block comment * alignment 342608eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3427af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3428af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3429af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 343008eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3431af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3432af207524SJoe Perches my $oldindent; 343308eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3434af207524SJoe Perches if (defined($1)) { 3435af207524SJoe Perches $oldindent = expand_tabs($1); 3436af207524SJoe Perches } else { 3437af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3438af207524SJoe Perches $oldindent = expand_tabs($1); 3439af207524SJoe Perches } 344008eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 344108eb9b80SJoe Perches my $newindent = $1; 344208eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3443af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 344408eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 344508eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 344608eb9b80SJoe Perches } 344708eb9b80SJoe Perches } 344808eb9b80SJoe Perches 34497f619191SJoe Perches# check for missing blank lines after struct/union declarations 34507f619191SJoe Perches# with exceptions for various attributes and macros 34517f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 34527f619191SJoe Perches $line =~ /^\+/ && 34537f619191SJoe Perches !($line =~ /^\+\s*$/ || 34547f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 34557f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 34567f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 34577f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 34587f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 34597f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 34600bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 34617f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3462d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3463d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3464d752fcc8SJoe Perches $fix) { 3465f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3466d752fcc8SJoe Perches } 34677f619191SJoe Perches } 34687f619191SJoe Perches 3469365dd4eaSJoe Perches# check for multiple consecutive blank lines 3470365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3471365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3472365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3473d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3474d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3475d752fcc8SJoe Perches $fix) { 3476f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3477d752fcc8SJoe Perches } 3478d752fcc8SJoe Perches 3479365dd4eaSJoe Perches $last_blank_line = $linenr; 3480365dd4eaSJoe Perches } 3481365dd4eaSJoe Perches 34823b617e3bSJoe Perches# check for missing blank lines after declarations 34833f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 34843f7bac03SJoe Perches # actual declarations 34853f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 34865a4e1fd3SJoe Perches # function pointer declarations 34875a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 34883f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 34893f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 34903f7bac03SJoe Perches # known declaration macros 34913f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 34923f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 34933f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 34943f7bac03SJoe Perches # other possible extensions of declaration lines 34953f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 34963f7bac03SJoe Perches # not starting a section or a macro "\" extended line 34973f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 34983f7bac03SJoe Perches # looks like a declaration 34993f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 35005a4e1fd3SJoe Perches # function pointer declarations 35015a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 35023f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 35033f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 35043f7bac03SJoe Perches # known declaration macros 35053f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 35063f7bac03SJoe Perches # start of struct or union or enum 3507328b5f41SJoe Perches $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ || 35083f7bac03SJoe Perches # start or end of block or continuation of declaration 35093f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 35103f7bac03SJoe Perches # bitfield continuation 35113f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 35123f7bac03SJoe Perches # other possible extensions of declaration lines 35133f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 35143f7bac03SJoe Perches # indentation of previous and current line are the same 35153f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3516d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3517d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3518d752fcc8SJoe Perches $fix) { 3519f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3520d752fcc8SJoe Perches } 35213b617e3bSJoe Perches } 35223b617e3bSJoe Perches 35235f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 35246b4c5bebSAndy Whitcroft# Exceptions: 35256b4c5bebSAndy Whitcroft# 1) within comments 35266b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 35276b4c5bebSAndy Whitcroft# 3) hanging labels 35283705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 35295f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 35303705ce5bSJoe Perches if (WARN("LEADING_SPACE", 35313705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 35323705ce5bSJoe Perches $fix) { 3533194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 35343705ce5bSJoe Perches } 35355f7ddae6SRaffaele Recalcati } 35365f7ddae6SRaffaele Recalcati 3537b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3538b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3539b9ea10d6SAndy Whitcroft 35405751a24eSJoe Perches# check for unusual line ending [ or ( 35415751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 35425751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 35435751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 35445751a24eSJoe Perches } 35455751a24eSJoe Perches 35464dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 35474dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 35484dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 35494dbed76fSJoe Perches $context_function = $1; 35504dbed76fSJoe Perches } 35514dbed76fSJoe Perches 35524dbed76fSJoe Perches# check if this appears to be the end of function declaration 35534dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 35544dbed76fSJoe Perches undef $context_function; 35554dbed76fSJoe Perches } 35564dbed76fSJoe Perches 3557032a4c0fSJoe Perches# check indentation of any line with a bare else 3558840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3559032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3560032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3561032a4c0fSJoe Perches my $tabs = length($1) + 1; 3562840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3563840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3564840080a0SJoe Perches defined $lines[$linenr] && 3565840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3566032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3567032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3568032a4c0fSJoe Perches } 3569032a4c0fSJoe Perches } 3570032a4c0fSJoe Perches 3571c00df19aSJoe Perches# check indentation of a line with a break; 3572c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3573c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3574c00df19aSJoe Perches my $tabs = $1; 3575c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3576c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3577c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3578c00df19aSJoe Perches } 3579c00df19aSJoe Perches } 3580c00df19aSJoe Perches 3581c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3582cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3583000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3584000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3585c2fdda0dSAndy Whitcroft } 358622f2a2efSAndy Whitcroft 358756e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 358856e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 358956e77d70SJoe Perches WARN("HOTPLUG_SECTION", 359056e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 359156e77d70SJoe Perches } 359256e77d70SJoe Perches 35939c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 35942b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 35952b474a1aSAndy Whitcroft $realline_next); 35963e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 3597ca819864SJoe Perches if ($linenr > $suppress_statement && 35981b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3599170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3600f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3601171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3602171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3603171ae1a4SAndy Whitcroft 36043e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 36053e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 36063e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 36073e469cdcSAndy Whitcroft # until we hit end of it. 36083e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 36093e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 36103e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 36113e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 36123e469cdcSAndy Whitcroft } 3613f74bd194SAndy Whitcroft 36142b474a1aSAndy Whitcroft # Find the real next line. 36152b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 36162b474a1aSAndy Whitcroft if (defined $realline_next && 36172b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 36182b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 36192b474a1aSAndy Whitcroft $realline_next++; 36202b474a1aSAndy Whitcroft } 36212b474a1aSAndy Whitcroft 3622171ae1a4SAndy Whitcroft my $s = $stat; 3623171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3624cf655043SAndy Whitcroft 3625c2fdda0dSAndy Whitcroft # Ignore goto labels. 3626171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3627c2fdda0dSAndy Whitcroft 3628c2fdda0dSAndy Whitcroft # Ignore functions being called 3629171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3630c2fdda0dSAndy Whitcroft 3631463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3632463f2864SAndy Whitcroft 3633c45dcabdSAndy Whitcroft # declarations always start with types 3634d2506586SAndy 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) { 3635c45dcabdSAndy Whitcroft my $type = $1; 3636c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3637c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3638c45dcabdSAndy Whitcroft 36396c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3640a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3641c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3642c2fdda0dSAndy Whitcroft } 36438905a67cSAndy Whitcroft 36446c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 364565863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3646c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 36479c0ca6f9SAndy Whitcroft } 36488905a67cSAndy Whitcroft 36498905a67cSAndy Whitcroft # Check for any sort of function declaration. 36508905a67cSAndy Whitcroft # int foo(something bar, other baz); 36518905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3652171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 36538905a67cSAndy Whitcroft my ($name_len) = length($1); 36548905a67cSAndy Whitcroft 3655cf655043SAndy Whitcroft my $ctx = $s; 3656773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 36578905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3658cf655043SAndy Whitcroft 36598905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3660c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 36618905a67cSAndy Whitcroft 3662c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 36638905a67cSAndy Whitcroft } 36648905a67cSAndy Whitcroft } 36658905a67cSAndy Whitcroft } 36668905a67cSAndy Whitcroft 36679c0ca6f9SAndy Whitcroft } 36689c0ca6f9SAndy Whitcroft 366900df344fSAndy Whitcroft# 367000df344fSAndy Whitcroft# Checks which may be anchored in the context. 367100df344fSAndy Whitcroft# 367200df344fSAndy Whitcroft 367300df344fSAndy Whitcroft# Check for switch () and associated case and default 367400df344fSAndy Whitcroft# statements should be at the same indent. 367500df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 367600df344fSAndy Whitcroft my $err = ''; 367700df344fSAndy Whitcroft my $sep = ''; 367800df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 367900df344fSAndy Whitcroft shift(@ctx); 368000df344fSAndy Whitcroft for my $ctx (@ctx) { 368100df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 368200df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 368300df344fSAndy Whitcroft $indent != $cindent) { 368400df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 368500df344fSAndy Whitcroft $sep = ''; 368600df344fSAndy Whitcroft } else { 368700df344fSAndy Whitcroft $sep = "[...]\n"; 368800df344fSAndy Whitcroft } 368900df344fSAndy Whitcroft } 369000df344fSAndy Whitcroft if ($err ne '') { 3691000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3692000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3693de7d4f0eSAndy Whitcroft } 3694de7d4f0eSAndy Whitcroft } 3695de7d4f0eSAndy Whitcroft 3696de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3697de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 36980fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3699773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3700773647a0SAndy Whitcroft 37019c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 37028eef05ddSJoe Perches 37038eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 37048eef05ddSJoe Perches WARN("DEEP_INDENTATION", 37058eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 37068eef05ddSJoe Perches } 37078eef05ddSJoe Perches 3708de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3709de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3710de7d4f0eSAndy Whitcroft 3711548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3712548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3713de7d4f0eSAndy Whitcroft 3714548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3715548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3716548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3717548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3718548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3719773647a0SAndy Whitcroft $ctx_ln++; 3720773647a0SAndy Whitcroft } 3721548596d5SAndy Whitcroft 372253210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 372353210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3724773647a0SAndy Whitcroft 3725773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3726000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3727000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 372801464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 372900df344fSAndy Whitcroft } 3730773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3731773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3732773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3733773647a0SAndy Whitcroft { 37349c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 37359c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3736000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3737000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 373801464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 37399c0ca6f9SAndy Whitcroft } 37409c0ca6f9SAndy Whitcroft } 374100df344fSAndy Whitcroft } 374200df344fSAndy Whitcroft 37434d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 3744f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 37453e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 37463e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 37473e469cdcSAndy Whitcroft if (!defined $stat); 37484d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 37494d001e4dSAndy Whitcroft 37504d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 37514d001e4dSAndy Whitcroft 37529f5af480SJoe Perches # remove inline comments 37539f5af480SJoe Perches $s =~ s/$;/ /g; 37549f5af480SJoe Perches $c =~ s/$;/ /g; 37554d001e4dSAndy Whitcroft 37564d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 37576f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 37586f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 37594d001e4dSAndy Whitcroft 37609f5af480SJoe Perches # Make sure we remove the line prefixes as we have 37619f5af480SJoe Perches # none on the first line, and are going to readd them 37629f5af480SJoe Perches # where necessary. 37639f5af480SJoe Perches $s =~ s/\n./\n/gs; 37649f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 37659f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 37669f5af480SJoe Perches } 37679f5af480SJoe Perches 37684d001e4dSAndy Whitcroft # We want to check the first line inside the block 37694d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 37704d001e4dSAndy Whitcroft # 1) any blank line termination 37714d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 37724d001e4dSAndy Whitcroft # 3) any do (...) { 37734d001e4dSAndy Whitcroft my $continuation = 0; 37744d001e4dSAndy Whitcroft my $check = 0; 37754d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 37764d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 37774d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 37784d001e4dSAndy Whitcroft $continuation = 1; 37794d001e4dSAndy Whitcroft } 37809bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 37814d001e4dSAndy Whitcroft $check = 1; 37824d001e4dSAndy Whitcroft $cond_lines++; 37834d001e4dSAndy Whitcroft } 37844d001e4dSAndy Whitcroft 37854d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 37864d001e4dSAndy Whitcroft # preprocessor statement. 37874d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 37884d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 37894d001e4dSAndy Whitcroft $check = 0; 37904d001e4dSAndy Whitcroft } 37914d001e4dSAndy Whitcroft 37929bd49efeSAndy Whitcroft my $cond_ptr = -1; 3793740504c6SAndy Whitcroft $continuation = 0; 37949bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 37959bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 37964d001e4dSAndy Whitcroft 3797f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3798f16fa28fSAndy Whitcroft # is not linear. 3799f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3800f16fa28fSAndy Whitcroft $check = 0; 3801f16fa28fSAndy Whitcroft } 3802f16fa28fSAndy Whitcroft 38039bd49efeSAndy Whitcroft # Ignore: 38049bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 38059bd49efeSAndy Whitcroft # 2) preprocessor lines, and 38069bd49efeSAndy Whitcroft # 3) labels. 3807740504c6SAndy Whitcroft if ($continuation || 3808740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 38099bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 38109bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3811740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 381230dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 38139bd49efeSAndy Whitcroft $cond_lines++; 38149bd49efeSAndy Whitcroft } 38154d001e4dSAndy Whitcroft } 381630dad6ebSAndy Whitcroft } 38174d001e4dSAndy Whitcroft 38184d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 38194d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 38204d001e4dSAndy Whitcroft 38214d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 38224d001e4dSAndy Whitcroft # this is not this patch's fault. 38234d001e4dSAndy Whitcroft if (!defined($stat_real) || 38244d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 38254d001e4dSAndy Whitcroft $check = 0; 38264d001e4dSAndy Whitcroft } 38274d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 38284d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 38294d001e4dSAndy Whitcroft } 38304d001e4dSAndy Whitcroft 38319bd49efeSAndy 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"; 38324d001e4dSAndy Whitcroft 38339f5af480SJoe Perches if ($check && $s ne '' && 3834713a09deSAntonio Borneo (($sindent % $tabsize) != 0 || 38359f5af480SJoe Perches ($sindent < $indent) || 3836f6950a73SJoe Perches ($sindent == $indent && 3837f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 3838713a09deSAntonio Borneo ($sindent > $indent + $tabsize))) { 3839000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3840000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 38414d001e4dSAndy Whitcroft } 38424d001e4dSAndy Whitcroft } 38434d001e4dSAndy Whitcroft 38446c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 38456c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 38461f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 38471f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 38486c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3849c2fdda0dSAndy Whitcroft if ($dbg_values) { 3850c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3851cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3852cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 38531f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3854c2fdda0dSAndy Whitcroft } 38556c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 38566c72ffaaSAndy Whitcroft 385700df344fSAndy Whitcroft#ignore lines not being added 38583705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 385900df344fSAndy Whitcroft 386011ca40a0SJoe Perches# check for dereferences that span multiple lines 386111ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 386211ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 386311ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 386411ca40a0SJoe Perches my $ref = $1; 386511ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 386611ca40a0SJoe Perches $ref .= $1; 386711ca40a0SJoe Perches $ref =~ s/\s//g; 386811ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 386911ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 387011ca40a0SJoe Perches } 387111ca40a0SJoe Perches 3872a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3873c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3874a1ce18e4SJoe Perches my $type = $1; 3875a1ce18e4SJoe Perches my $var = $2; 3876207a8e84SJoe Perches $var = "" if (!defined $var); 3877207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3878a1ce18e4SJoe Perches my $sign = $1; 3879a1ce18e4SJoe Perches my $pointer = $2; 3880a1ce18e4SJoe Perches 3881a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3882a1ce18e4SJoe Perches 3883a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3884a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3885a1ce18e4SJoe Perches $fix) { 3886a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3887207a8e84SJoe Perches my $comp_pointer = $pointer; 3888207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 3889207a8e84SJoe Perches $decl .= $comp_pointer; 3890207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 3891207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 3892a1ce18e4SJoe Perches } 3893a1ce18e4SJoe Perches } 3894a1ce18e4SJoe Perches } 3895a1ce18e4SJoe Perches 3896653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 38977429c690SAndy Whitcroft if ($dbg_type) { 38987429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3899000d1cc1SJoe Perches ERROR("TEST_TYPE", 3900000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 39017429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3902000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3903000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 39047429c690SAndy Whitcroft } 3905653d4876SAndy Whitcroft next; 3906653d4876SAndy Whitcroft } 3907a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3908a1ef277eSAndy Whitcroft if ($dbg_attr) { 39099360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3910000d1cc1SJoe Perches ERROR("TEST_ATTR", 3911000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 39129360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3913000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3914000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3915a1ef277eSAndy Whitcroft } 3916a1ef277eSAndy Whitcroft next; 3917a1ef277eSAndy Whitcroft } 3918653d4876SAndy Whitcroft 3919f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 392099423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 392199423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3922d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3923d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3924f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3925f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3926f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3927d752fcc8SJoe Perches my $fixedline = $prevrawline; 3928d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3929f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3930d752fcc8SJoe Perches $fixedline = $line; 39318d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 3932f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3933d752fcc8SJoe Perches } 3934f0a594c1SAndy Whitcroft } 3935f0a594c1SAndy Whitcroft 393600df344fSAndy Whitcroft# 393700df344fSAndy Whitcroft# Checks which are anchored on the added line. 393800df344fSAndy Whitcroft# 393900df344fSAndy Whitcroft 3940653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3941c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3942653d4876SAndy Whitcroft my $path = $1; 3943653d4876SAndy Whitcroft if ($path =~ m{//}) { 3944000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3945495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3946495e9d84SJoe Perches } 3947495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3948495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3949495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3950653d4876SAndy Whitcroft } 3951653d4876SAndy Whitcroft } 3952653d4876SAndy Whitcroft 395300df344fSAndy Whitcroft# no C99 // comments 395400df344fSAndy Whitcroft if ($line =~ m{//}) { 39553705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 39563705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 39573705ce5bSJoe Perches $fix) { 3958194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 39593705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 39603705ce5bSJoe Perches my $comment = trim($1); 3961194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 39623705ce5bSJoe Perches } 39633705ce5bSJoe Perches } 396400df344fSAndy Whitcroft } 396500df344fSAndy Whitcroft # Remove C99 comments. 39660a920b5bSAndy Whitcroft $line =~ s@//.*@@; 39676c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 39680a920b5bSAndy Whitcroft 39692b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 39702b474a1aSAndy Whitcroft# the whole statement. 39712b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 39722b474a1aSAndy Whitcroft if (defined $realline_next && 39732b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 39742b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 39752b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 39762b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 39773cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 39783cbf62dfSAndy Whitcroft # a prefix: 39793cbf62dfSAndy Whitcroft # XXX(foo); 39803cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3981653d4876SAndy Whitcroft my $name = $1; 398287a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 39833cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 39843cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 39853cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 39863cbf62dfSAndy Whitcroft 39873cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 39882b474a1aSAndy Whitcroft \n.}\s*$| 398948012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 399048012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 399148012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 39922b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 39932b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 399448012058SAndy Whitcroft )/x) { 39952b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 39962b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 39972b474a1aSAndy Whitcroft } else { 39982b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 39990a920b5bSAndy Whitcroft } 40000a920b5bSAndy Whitcroft } 40012b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 40022b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 40032b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 40042b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 40052b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 40062b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 40072b474a1aSAndy Whitcroft } 40082b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 40092b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 4010000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 4011000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 40122b474a1aSAndy Whitcroft } 40130a920b5bSAndy Whitcroft 40145150bda4SJoe Eloff# check for global initialisers. 40156d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 4016d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 40176d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 4018d5e616fcSJoe Perches $fix) { 40196d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 4020d5e616fcSJoe Perches } 4021f0a594c1SAndy Whitcroft } 40220a920b5bSAndy Whitcroft# check for static initialisers. 40236d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 4024d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 40256d32f7a3SJoe Perches "do not initialise statics to $1\n" . 4026d5e616fcSJoe Perches $herecurr) && 4027d5e616fcSJoe Perches $fix) { 40286d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 4029d5e616fcSJoe Perches } 40300a920b5bSAndy Whitcroft } 40310a920b5bSAndy Whitcroft 40321813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 40331813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 40341813087dSJoe Perches my $tmp = trim($1); 40351813087dSJoe Perches WARN("MISORDERED_TYPE", 40361813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 40371813087dSJoe Perches } 40381813087dSJoe Perches 4039809e082eSJoe Perches# check for unnecessary <signed> int declarations of short/long/long long 4040809e082eSJoe Perches while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) { 4041809e082eSJoe Perches my $type = trim($1); 4042809e082eSJoe Perches next if ($type !~ /\bint\b/); 4043809e082eSJoe Perches next if ($type !~ /\b(?:short|long\s+long|long)\b/); 4044809e082eSJoe Perches my $new_type = $type; 4045809e082eSJoe Perches $new_type =~ s/\b\s*int\s*\b/ /; 4046809e082eSJoe Perches $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /; 4047809e082eSJoe Perches $new_type =~ s/^const\s+//; 4048809e082eSJoe Perches $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/); 4049809e082eSJoe Perches $new_type = "const $new_type" if ($type =~ /^const\b/); 4050809e082eSJoe Perches $new_type =~ s/\s+/ /g; 4051809e082eSJoe Perches $new_type = trim($new_type); 4052809e082eSJoe Perches if (WARN("UNNECESSARY_INT", 4053809e082eSJoe Perches "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) && 4054809e082eSJoe Perches $fix) { 4055809e082eSJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/; 4056809e082eSJoe Perches } 4057809e082eSJoe Perches } 4058809e082eSJoe Perches 4059cb710ecaSJoe Perches# check for static const char * arrays. 4060cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 4061000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4062000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 4063cb710ecaSJoe Perches $herecurr); 4064cb710ecaSJoe Perches } 4065cb710ecaSJoe Perches 406677b8c0a8SJoe Perches# check for initialized const char arrays that should be static const 406777b8c0a8SJoe Perches if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) { 406877b8c0a8SJoe Perches if (WARN("STATIC_CONST_CHAR_ARRAY", 406977b8c0a8SJoe Perches "const array should probably be static const\n" . $herecurr) && 407077b8c0a8SJoe Perches $fix) { 407177b8c0a8SJoe Perches $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/; 407277b8c0a8SJoe Perches } 407377b8c0a8SJoe Perches } 407477b8c0a8SJoe Perches 4075cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 4076cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 4077000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4078000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 4079cb710ecaSJoe Perches $herecurr); 4080cb710ecaSJoe Perches } 4081cb710ecaSJoe Perches 4082ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 4083ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 4084ab7e23f3SJoe Perches my $found = $1; 4085ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 4086ab7e23f3SJoe Perches WARN("CONST_CONST", 4087ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 4088ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 4089ab7e23f3SJoe Perches WARN("CONST_CONST", 4090ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 4091ab7e23f3SJoe Perches } 4092ab7e23f3SJoe Perches } 4093ab7e23f3SJoe Perches 40949b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 40959b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 40969b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 40979b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 40989b0fa60dSJoe Perches $herecurr); 40999b0fa60dSJoe Perches } 41009b0fa60dSJoe Perches 4101b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 4102b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 4103b598b670SJoe Perches my $array = $1; 4104b598b670SJoe 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*\))@) { 4105b598b670SJoe Perches my $array_div = $1; 4106b598b670SJoe Perches if (WARN("ARRAY_SIZE", 4107b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 4108b598b670SJoe Perches $fix) { 4109b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 4110b598b670SJoe Perches } 4111b598b670SJoe Perches } 4112b598b670SJoe Perches } 4113b598b670SJoe Perches 4114b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 411516b7f3c8SJoe Perches if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) { 4116b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 4117b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 4118b36190c5SJoe Perches $fix) { 4119194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 4120b36190c5SJoe Perches } 4121b36190c5SJoe Perches } 4122b36190c5SJoe Perches 4123653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 4124653d4876SAndy Whitcroft# make sense. 4125653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 41268054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 4127c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 41288ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 412946d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 4130000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 4131000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 41320a920b5bSAndy Whitcroft } 41330a920b5bSAndy Whitcroft 41340a920b5bSAndy Whitcroft# * goes on variable not on type 413565863862SAndy Whitcroft # (char*[ const]) 4136bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 4137bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 41383705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 4139d8aaf121SAndy Whitcroft 414065863862SAndy Whitcroft # Should start with a space. 414165863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 414265863862SAndy Whitcroft # Should not end with a space. 414365863862SAndy Whitcroft $to =~ s/\s+$//; 414465863862SAndy Whitcroft # '*'s should not have spaces between. 4145f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 414665863862SAndy Whitcroft } 4147d8aaf121SAndy Whitcroft 41483705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 414965863862SAndy Whitcroft if ($from ne $to) { 41503705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 41513705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 41523705ce5bSJoe Perches $fix) { 41533705ce5bSJoe Perches my $sub_from = $ident; 41543705ce5bSJoe Perches my $sub_to = $ident; 41553705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4156194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41573705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 41583705ce5bSJoe Perches } 415965863862SAndy Whitcroft } 4160bfcb2cc7SAndy Whitcroft } 4161bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 4162bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 41633705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 4164d8aaf121SAndy Whitcroft 416565863862SAndy Whitcroft # Should start with a space. 416665863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 416765863862SAndy Whitcroft # Should not end with a space. 416865863862SAndy Whitcroft $to =~ s/\s+$//; 416965863862SAndy Whitcroft # '*'s should not have spaces between. 4170f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 417165863862SAndy Whitcroft } 417265863862SAndy Whitcroft # Modifiers should have spaces. 417365863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 417465863862SAndy Whitcroft 41753705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 4176667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 41773705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 41783705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 41793705ce5bSJoe Perches $fix) { 41803705ce5bSJoe Perches 41813705ce5bSJoe Perches my $sub_from = $match; 41823705ce5bSJoe Perches my $sub_to = $match; 41833705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4184194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41853705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 41863705ce5bSJoe Perches } 418765863862SAndy Whitcroft } 41880a920b5bSAndy Whitcroft } 41890a920b5bSAndy Whitcroft 41909d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 41919d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 41920675a8fbSJean Delvare my $msg_level = \&WARN; 41930675a8fbSJean Delvare $msg_level = \&CHK if ($file); 41940675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 41959d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 41969d3e3c70SJoe Perches } 41970a920b5bSAndy Whitcroft 41989d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 41998905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 4200000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 4201000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 42028905a67cSAndy Whitcroft } 42038905a67cSAndy Whitcroft 420417441227SJoe Perches# check for uses of printk_ratelimit 420517441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 4206000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 4207000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 420817441227SJoe Perches } 420917441227SJoe Perches 4210eeef5733SJoe Perches# printk should use KERN_* levels 4211eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 4212000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 4213eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 421400df344fSAndy Whitcroft } 42150a920b5bSAndy Whitcroft 4216243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 4217243f3803SJoe Perches my $orig = $1; 4218243f3803SJoe Perches my $level = lc($orig); 4219243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 42208f26b837SJoe Perches my $level2 = $level; 42218f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 4222243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 4223daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 4224243f3803SJoe Perches } 4225243f3803SJoe Perches 4226dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 4227dc139313SJoe Perches my $orig = $1; 4228dc139313SJoe Perches my $level = lc($orig); 4229dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 4230dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 4231dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 4232dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 4233dc139313SJoe Perches } 4234dc139313SJoe Perches 423591c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 423691c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 423791c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 423891c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 423991c9afafSAndy Lutomirski WARN("ENOSYS", 424091c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 424191c9afafSAndy Lutomirski } 424291c9afafSAndy Lutomirski 42436b9ea5ffSJakub Kicinski# ENOTSUPP is not a standard error code and should be avoided in new patches. 42446b9ea5ffSJakub Kicinski# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP. 42456b9ea5ffSJakub Kicinski# Similarly to ENOSYS warning a small number of false positives is expected. 42466b9ea5ffSJakub Kicinski if (!$file && $line =~ /\bENOTSUPP\b/) { 42476b9ea5ffSJakub Kicinski if (WARN("ENOTSUPP", 42486b9ea5ffSJakub Kicinski "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) && 42496b9ea5ffSJakub Kicinski $fix) { 42506b9ea5ffSJakub Kicinski $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/; 42516b9ea5ffSJakub Kicinski } 42526b9ea5ffSJakub Kicinski } 42536b9ea5ffSJakub Kicinski 4254653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 4255653d4876SAndy Whitcroft# or if closed on same line 42565b57980dSJoe Perches if ($perl_version_ok && 42572d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 42582d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 42592d453e3bSJoe Perches $sline !~ /}/) { 42608d182478SJoe Perches if (ERROR("OPEN_BRACE", 42612d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 42628d182478SJoe Perches $fix) { 42638d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 42648d182478SJoe Perches my $fixed_line = $rawline; 42658d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 42668d182478SJoe Perches my $line1 = $1; 42678d182478SJoe Perches my $line2 = $2; 42688d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 42698d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 42708d182478SJoe Perches if ($line2 !~ /^\s*$/) { 42718d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 42728d182478SJoe Perches } 42738d182478SJoe Perches } 42740a920b5bSAndy Whitcroft } 4275653d4876SAndy Whitcroft 42768905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 42778905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 42788905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 42798d182478SJoe Perches if (ERROR("OPEN_BRACE", 42808d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 42818d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 42828d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 42838d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 42848d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 42858d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 42868d182478SJoe Perches $fixedline = $rawline; 42878d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 42888d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 42898d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 42908d182478SJoe Perches } 42918d182478SJoe Perches } 42928905a67cSAndy Whitcroft } 42938905a67cSAndy Whitcroft 42940c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 42953705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 42963705ce5bSJoe Perches if (WARN("SPACING", 42973705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 42983705ce5bSJoe Perches $fix) { 4299194f66fcSJoe Perches $fixed[$fixlinenr] =~ 43003705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 43013705ce5bSJoe Perches } 43020c73b4ebSAndy Whitcroft } 43030c73b4ebSAndy Whitcroft 430431070b5dSJoe Perches# Function pointer declarations 430531070b5dSJoe Perches# check spacing between type, funcptr, and args 430631070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 430791f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 430831070b5dSJoe Perches my $declare = $1; 430931070b5dSJoe Perches my $pre_pointer_space = $2; 431031070b5dSJoe Perches my $post_pointer_space = $3; 431131070b5dSJoe Perches my $funcname = $4; 431231070b5dSJoe Perches my $post_funcname_space = $5; 431331070b5dSJoe Perches my $pre_args_space = $6; 431431070b5dSJoe Perches 431591f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 431691f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 431791f72e9cSJoe Perches# don't need a space so don't warn for those. 431891f72e9cSJoe Perches my $post_declare_space = ""; 431991f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 432091f72e9cSJoe Perches $post_declare_space = $1; 432191f72e9cSJoe Perches $declare = rtrim($declare); 432291f72e9cSJoe Perches } 432391f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 432431070b5dSJoe Perches WARN("SPACING", 432531070b5dSJoe Perches "missing space after return type\n" . $herecurr); 432691f72e9cSJoe Perches $post_declare_space = " "; 432731070b5dSJoe Perches } 432831070b5dSJoe Perches 432931070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 433091f72e9cSJoe Perches# This test is not currently implemented because these declarations are 433191f72e9cSJoe Perches# equivalent to 433291f72e9cSJoe Perches# int foo(int bar, ...) 433391f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 433491f72e9cSJoe Perches# 433591f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 433691f72e9cSJoe Perches# WARN("SPACING", 433791f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 433891f72e9cSJoe Perches# } 433931070b5dSJoe Perches 434031070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 434131070b5dSJoe Perches if (defined $pre_pointer_space && 434231070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 434331070b5dSJoe Perches WARN("SPACING", 434431070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 434531070b5dSJoe Perches } 434631070b5dSJoe Perches 434731070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 434831070b5dSJoe Perches if (defined $post_pointer_space && 434931070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 435031070b5dSJoe Perches WARN("SPACING", 435131070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 435231070b5dSJoe Perches } 435331070b5dSJoe Perches 435431070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 435531070b5dSJoe Perches if (defined $post_funcname_space && 435631070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 435731070b5dSJoe Perches WARN("SPACING", 435831070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 435931070b5dSJoe Perches } 436031070b5dSJoe Perches 436131070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 436231070b5dSJoe Perches if (defined $pre_args_space && 436331070b5dSJoe Perches $pre_args_space =~ /^\s/) { 436431070b5dSJoe Perches WARN("SPACING", 436531070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 436631070b5dSJoe Perches } 436731070b5dSJoe Perches 436831070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4369194f66fcSJoe Perches $fixed[$fixlinenr] =~ 437091f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 437131070b5dSJoe Perches } 437231070b5dSJoe Perches } 437331070b5dSJoe Perches 43748d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 43758d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4376fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4377fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 43788d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 43798d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 43808d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4381fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 438238dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 43833705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 43843705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 43853705ce5bSJoe Perches $fix) { 4386194f66fcSJoe Perches $fixed[$fixlinenr] =~ 43873705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 43883705ce5bSJoe Perches } 43898d31cfceSAndy Whitcroft } 43908d31cfceSAndy Whitcroft } 43918d31cfceSAndy Whitcroft 4392f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 43936c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4394c2fdda0dSAndy Whitcroft my $name = $1; 4395773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4396773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4397c2fdda0dSAndy Whitcroft 4398c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4399773647a0SAndy Whitcroft if ($name =~ /^(?: 4400773647a0SAndy Whitcroft if|for|while|switch|return|case| 4401773647a0SAndy Whitcroft volatile|__volatile__| 4402773647a0SAndy Whitcroft __attribute__|format|__extension__| 4403773647a0SAndy Whitcroft asm|__asm__)$/x) 4404773647a0SAndy Whitcroft { 4405c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4406c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4407c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4408c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4409773647a0SAndy Whitcroft 4410773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4411c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4412c2fdda0dSAndy Whitcroft 4413c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4414c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4415773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4416c2fdda0dSAndy Whitcroft 4417c2fdda0dSAndy Whitcroft } else { 44183705ce5bSJoe Perches if (WARN("SPACING", 44193705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 44203705ce5bSJoe Perches $fix) { 4421194f66fcSJoe Perches $fixed[$fixlinenr] =~ 44223705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 44233705ce5bSJoe Perches } 4424f0a594c1SAndy Whitcroft } 44256c72ffaaSAndy Whitcroft } 44269a4cad4eSEric Nelson 4427653d4876SAndy Whitcroft# Check operator spacing. 44280a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 44293705ce5bSJoe Perches my $fixed_line = ""; 44303705ce5bSJoe Perches my $line_fixed = 0; 44313705ce5bSJoe Perches 44329c0ca6f9SAndy Whitcroft my $ops = qr{ 44339c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 44349c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 44359c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 44361f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 443784731623SJoe Perches \?:|\?|: 44389c0ca6f9SAndy Whitcroft }x; 4439cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 44403705ce5bSJoe Perches 44413705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 44423705ce5bSJoe Perches## foreach my $el (@elements) { 44433705ce5bSJoe Perches## print("el: <$el>\n"); 44443705ce5bSJoe Perches## } 44453705ce5bSJoe Perches 44463705ce5bSJoe Perches my @fix_elements = (); 444700df344fSAndy Whitcroft my $off = 0; 44486c72ffaaSAndy Whitcroft 44493705ce5bSJoe Perches foreach my $el (@elements) { 44503705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 44513705ce5bSJoe Perches $off += length($el); 44523705ce5bSJoe Perches } 44533705ce5bSJoe Perches 44543705ce5bSJoe Perches $off = 0; 44553705ce5bSJoe Perches 44566c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4457b34c648bSJoe Perches my $last_after = -1; 44586c72ffaaSAndy Whitcroft 44590a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 44603705ce5bSJoe Perches 44613705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 44623705ce5bSJoe Perches 44633705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 44643705ce5bSJoe Perches 44654a0df2efSAndy Whitcroft $off += length($elements[$n]); 44664a0df2efSAndy Whitcroft 446725985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4468773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4469773647a0SAndy Whitcroft my $cc = ''; 4470773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4471773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4472773647a0SAndy Whitcroft } 4473773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4474773647a0SAndy Whitcroft 44754a0df2efSAndy Whitcroft my $a = ''; 44764a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 44774a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4478cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 44794a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 44804a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 4481773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 44824a0df2efSAndy Whitcroft 44830a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 44844a0df2efSAndy Whitcroft 44854a0df2efSAndy Whitcroft my $c = ''; 44860a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 44874a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 44884a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4489cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 44904a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 44914a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 44928b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 44934a0df2efSAndy Whitcroft } else { 44944a0df2efSAndy Whitcroft $c = 'E'; 44950a920b5bSAndy Whitcroft } 44960a920b5bSAndy Whitcroft 44974a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 44984a0df2efSAndy Whitcroft 44994a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 45004a0df2efSAndy Whitcroft 45016c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 4502de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 45030a920b5bSAndy Whitcroft 450474048ed8SAndy Whitcroft # Pull out the value of this operator. 45056c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 45060a920b5bSAndy Whitcroft 45071f65f947SAndy Whitcroft # Get the full operator variant. 45081f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 45091f65f947SAndy Whitcroft 451013214adfSAndy Whitcroft # Ignore operators passed as parameters. 451113214adfSAndy Whitcroft if ($op_type ne 'V' && 4512d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 451313214adfSAndy Whitcroft 4514cf655043SAndy Whitcroft# # Ignore comments 4515cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 451613214adfSAndy Whitcroft 4517d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 451813214adfSAndy Whitcroft } elsif ($op eq ';') { 4519cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 4520cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 45213705ce5bSJoe Perches if (ERROR("SPACING", 45223705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 4523b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 45243705ce5bSJoe Perches $line_fixed = 1; 45253705ce5bSJoe Perches } 4526d8aaf121SAndy Whitcroft } 4527d8aaf121SAndy Whitcroft 4528d8aaf121SAndy Whitcroft # // is a comment 4529d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 45300a920b5bSAndy Whitcroft 4531b00e4814SJoe Perches # : when part of a bitfield 4532b00e4814SJoe Perches } elsif ($opv eq ':B') { 4533b00e4814SJoe Perches # skip the bitfield test for now 4534b00e4814SJoe Perches 45351f65f947SAndy Whitcroft # No spaces for: 45361f65f947SAndy Whitcroft # -> 4537b00e4814SJoe Perches } elsif ($op eq '->') { 45384a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 45393705ce5bSJoe Perches if (ERROR("SPACING", 45403705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4541b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 45423705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 45433705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 45443705ce5bSJoe Perches } 4545b34c648bSJoe Perches $line_fixed = 1; 45463705ce5bSJoe Perches } 45470a920b5bSAndy Whitcroft } 45480a920b5bSAndy Whitcroft 45492381097bSJoe Perches # , must not have a space before and must have a space on the right. 45500a920b5bSAndy Whitcroft } elsif ($op eq ',') { 45512381097bSJoe Perches my $rtrim_before = 0; 45522381097bSJoe Perches my $space_after = 0; 45532381097bSJoe Perches if ($ctx =~ /Wx./) { 45542381097bSJoe Perches if (ERROR("SPACING", 45552381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 45562381097bSJoe Perches $line_fixed = 1; 45572381097bSJoe Perches $rtrim_before = 1; 45582381097bSJoe Perches } 45592381097bSJoe Perches } 4560cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 45613705ce5bSJoe Perches if (ERROR("SPACING", 45623705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 45633705ce5bSJoe Perches $line_fixed = 1; 4564b34c648bSJoe Perches $last_after = $n; 45652381097bSJoe Perches $space_after = 1; 45662381097bSJoe Perches } 45672381097bSJoe Perches } 45682381097bSJoe Perches if ($rtrim_before || $space_after) { 45692381097bSJoe Perches if ($rtrim_before) { 45702381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 45712381097bSJoe Perches } else { 45722381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 45732381097bSJoe Perches } 45742381097bSJoe Perches if ($space_after) { 45752381097bSJoe Perches $good .= " "; 45763705ce5bSJoe Perches } 45770a920b5bSAndy Whitcroft } 45780a920b5bSAndy Whitcroft 45799c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 458074048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 45819c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 45829c0ca6f9SAndy Whitcroft 45839c0ca6f9SAndy Whitcroft # unary operators should have a space before and 45849c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 45859c0ca6f9SAndy Whitcroft # unary operator, or a cast 45869c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 458774048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 45880d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4589cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 45903705ce5bSJoe Perches if (ERROR("SPACING", 45913705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4592b34c648bSJoe Perches if ($n != $last_after + 2) { 4593b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 45943705ce5bSJoe Perches $line_fixed = 1; 45953705ce5bSJoe Perches } 45960a920b5bSAndy Whitcroft } 4597b34c648bSJoe Perches } 4598a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4599171ae1a4SAndy Whitcroft # A unary '*' may be const 4600171ae1a4SAndy Whitcroft 4601171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 46023705ce5bSJoe Perches if (ERROR("SPACING", 46033705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4604b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 46053705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 46063705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 46073705ce5bSJoe Perches } 4608b34c648bSJoe Perches $line_fixed = 1; 46093705ce5bSJoe Perches } 46100a920b5bSAndy Whitcroft } 46110a920b5bSAndy Whitcroft 46120a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 46130a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4614773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 46153705ce5bSJoe Perches if (ERROR("SPACING", 46163705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4617b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 46183705ce5bSJoe Perches $line_fixed = 1; 46193705ce5bSJoe Perches } 46200a920b5bSAndy Whitcroft } 4621773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4622773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 46233705ce5bSJoe Perches if (ERROR("SPACING", 46243705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4625b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 46263705ce5bSJoe Perches $line_fixed = 1; 46273705ce5bSJoe Perches } 4628653d4876SAndy Whitcroft } 4629773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 46303705ce5bSJoe Perches if (ERROR("SPACING", 46313705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4632b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 46333705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 46343705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4635773647a0SAndy Whitcroft } 4636b34c648bSJoe Perches $line_fixed = 1; 46373705ce5bSJoe Perches } 46383705ce5bSJoe Perches } 46390a920b5bSAndy Whitcroft 46400a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 46419c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 46429c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 46439c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4644c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4645c2fdda0dSAndy Whitcroft $op eq '%') 46460a920b5bSAndy Whitcroft { 4647d2e025f3SJoe Perches if ($check) { 4648d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4649d2e025f3SJoe Perches if (CHK("SPACING", 4650d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4651d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4652d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4653d2e025f3SJoe Perches $line_fixed = 1; 4654d2e025f3SJoe Perches } 4655d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4656d2e025f3SJoe Perches if (CHK("SPACING", 4657d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4658d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4659d2e025f3SJoe Perches $line_fixed = 1; 4660d2e025f3SJoe Perches } 4661d2e025f3SJoe Perches } 4662d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 46633705ce5bSJoe Perches if (ERROR("SPACING", 46643705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4665b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4666b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4667b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4668b34c648bSJoe Perches } 46693705ce5bSJoe Perches $line_fixed = 1; 46703705ce5bSJoe Perches } 46710a920b5bSAndy Whitcroft } 46720a920b5bSAndy Whitcroft 46731f65f947SAndy Whitcroft # A colon needs no spaces before when it is 46741f65f947SAndy Whitcroft # terminating a case value or a label. 46751f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 46761f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 46773705ce5bSJoe Perches if (ERROR("SPACING", 46783705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4679b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 46803705ce5bSJoe Perches $line_fixed = 1; 46813705ce5bSJoe Perches } 46821f65f947SAndy Whitcroft } 46831f65f947SAndy Whitcroft 46840a920b5bSAndy Whitcroft # All the others need spaces both sides. 4685cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 46861f65f947SAndy Whitcroft my $ok = 0; 46871f65f947SAndy Whitcroft 468822f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 46891f65f947SAndy Whitcroft if (($op eq '<' && 46901f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 46911f65f947SAndy Whitcroft ($op eq '>' && 46921f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 46931f65f947SAndy Whitcroft { 46941f65f947SAndy Whitcroft $ok = 1; 46951f65f947SAndy Whitcroft } 46961f65f947SAndy Whitcroft 4697e0df7e1fSJoe Perches # for asm volatile statements 4698e0df7e1fSJoe Perches # ignore a colon with another 4699e0df7e1fSJoe Perches # colon immediately before or after 4700e0df7e1fSJoe Perches if (($op eq ':') && 4701e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4702e0df7e1fSJoe Perches $ok = 1; 4703e0df7e1fSJoe Perches } 4704e0df7e1fSJoe Perches 470584731623SJoe Perches # messages are ERROR, but ?: are CHK 47061f65f947SAndy Whitcroft if ($ok == 0) { 47070675a8fbSJean Delvare my $msg_level = \&ERROR; 47080675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 470984731623SJoe Perches 47100675a8fbSJean Delvare if (&{$msg_level}("SPACING", 47113705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4712b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4713b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4714b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4715b34c648bSJoe Perches } 47163705ce5bSJoe Perches $line_fixed = 1; 47173705ce5bSJoe Perches } 47180a920b5bSAndy Whitcroft } 471922f2a2efSAndy Whitcroft } 47204a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 47213705ce5bSJoe Perches 47223705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 47233705ce5bSJoe Perches 47243705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 47250a920b5bSAndy Whitcroft } 47263705ce5bSJoe Perches 47273705ce5bSJoe Perches if (($#elements % 2) == 0) { 47283705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 47293705ce5bSJoe Perches } 47303705ce5bSJoe Perches 4731194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4732194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 47333705ce5bSJoe Perches } 47343705ce5bSJoe Perches 47353705ce5bSJoe Perches 47360a920b5bSAndy Whitcroft } 47370a920b5bSAndy Whitcroft 4738786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4739d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4740786b6326SJoe Perches if (WARN("SPACING", 4741786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4742786b6326SJoe Perches $fix) { 4743194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4744786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4745786b6326SJoe Perches } 4746786b6326SJoe Perches } 4747786b6326SJoe Perches 4748f0a594c1SAndy Whitcroft# check for multiple assignments 4749f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4750000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4751000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4752f0a594c1SAndy Whitcroft } 4753f0a594c1SAndy Whitcroft 475422f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 475522f2a2efSAndy Whitcroft## # continuation. 475622f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 475722f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 475822f2a2efSAndy Whitcroft## 475922f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 476022f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 476122f2a2efSAndy Whitcroft## my $ln = $line; 476222f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 476322f2a2efSAndy Whitcroft## } 476422f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4765000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4766000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 476722f2a2efSAndy Whitcroft## } 476822f2a2efSAndy Whitcroft## } 4769f0a594c1SAndy Whitcroft 47700a920b5bSAndy Whitcroft#need space before brace following if, while, etc 47716b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 47726ad724e2SMichal Zylowski $line =~ /\b(?:else|do)\{/) { 47733705ce5bSJoe Perches if (ERROR("SPACING", 47743705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 47753705ce5bSJoe Perches $fix) { 47766ad724e2SMichal Zylowski $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/; 47773705ce5bSJoe Perches } 4778de7d4f0eSAndy Whitcroft } 4779de7d4f0eSAndy Whitcroft 4780c4a62ef9SJoe Perches## # check for blank lines before declarations 4781c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4782c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4783c4a62ef9SJoe Perches## WARN("SPACING", 4784c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4785c4a62ef9SJoe Perches## } 4786c4a62ef9SJoe Perches## 4787c4a62ef9SJoe Perches 4788de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4789de7d4f0eSAndy Whitcroft# on the line 479094fb9845SJoe Perches if ($line =~ /}(?!(?:,|;|\)|\}))\S/) { 4791d5e616fcSJoe Perches if (ERROR("SPACING", 4792d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4793d5e616fcSJoe Perches $fix) { 4794194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4795d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4796d5e616fcSJoe Perches } 47970a920b5bSAndy Whitcroft } 47980a920b5bSAndy Whitcroft 479922f2a2efSAndy Whitcroft# check spacing on square brackets 480022f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 48013705ce5bSJoe Perches if (ERROR("SPACING", 48023705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 48033705ce5bSJoe Perches $fix) { 4804194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48053705ce5bSJoe Perches s/\[\s+/\[/; 48063705ce5bSJoe Perches } 480722f2a2efSAndy Whitcroft } 480822f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 48093705ce5bSJoe Perches if (ERROR("SPACING", 48103705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 48113705ce5bSJoe Perches $fix) { 4812194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48133705ce5bSJoe Perches s/\s+\]/\]/; 48143705ce5bSJoe Perches } 481522f2a2efSAndy Whitcroft } 481622f2a2efSAndy Whitcroft 4817c45dcabdSAndy Whitcroft# check spacing on parentheses 48189c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 48199c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 48203705ce5bSJoe Perches if (ERROR("SPACING", 48213705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 48223705ce5bSJoe Perches $fix) { 4823194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48243705ce5bSJoe Perches s/\(\s+/\(/; 48253705ce5bSJoe Perches } 482622f2a2efSAndy Whitcroft } 482713214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4828c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4829c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 48303705ce5bSJoe Perches if (ERROR("SPACING", 48313705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 48323705ce5bSJoe Perches $fix) { 4833194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48343705ce5bSJoe Perches s/\s+\)/\)/; 48353705ce5bSJoe Perches } 483622f2a2efSAndy Whitcroft } 483722f2a2efSAndy Whitcroft 4838e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4839e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4840e2826fd0SJoe Perches 4841e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4842ea4acbb1SJoe Perches my $var = $1; 4843ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4844ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4845ea4acbb1SJoe Perches $fix) { 4846ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4847ea4acbb1SJoe Perches } 4848ea4acbb1SJoe Perches } 4849ea4acbb1SJoe Perches 4850ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4851ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4852ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4853ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4854ea4acbb1SJoe Perches my $var = $2; 4855ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4856ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4857ea4acbb1SJoe Perches $fix) { 4858ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4859ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4860ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4861ea4acbb1SJoe Perches } 4862e2826fd0SJoe Perches } 4863e2826fd0SJoe Perches 486463b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 4865a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 4866a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 48675b57980dSJoe Perches $perl_version_ok && defined($stat) && 486863b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 486963b7c73eSJoe Perches my $if_stat = $1; 487063b7c73eSJoe Perches my $test = substr($2, 1, -1); 487163b7c73eSJoe Perches my $herectx; 487263b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 487363b7c73eSJoe Perches my $match = $1; 487463b7c73eSJoe Perches # avoid parentheses around potential macro args 487563b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 487663b7c73eSJoe Perches if (!defined($herectx)) { 487763b7c73eSJoe Perches $herectx = $here . "\n"; 487863b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 487963b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 488063b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 488163b7c73eSJoe Perches $herectx .= $rl . "\n"; 488263b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 488363b7c73eSJoe Perches } 488463b7c73eSJoe Perches } 488563b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 488663b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 488763b7c73eSJoe Perches } 488863b7c73eSJoe Perches } 488963b7c73eSJoe Perches 48900a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 48914a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 48920a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 48933705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 48943705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 48953705ce5bSJoe Perches $fix) { 4896194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48973705ce5bSJoe Perches s/^(.)\s+/$1/; 48983705ce5bSJoe Perches } 48990a920b5bSAndy Whitcroft } 49000a920b5bSAndy Whitcroft 49015b9553abSJoe Perches# return is not a function 4902507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4903c45dcabdSAndy Whitcroft my $spacing = $1; 49045b57980dSJoe Perches if ($perl_version_ok && 49055b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 49065b9553abSJoe Perches my $value = $1; 49075b9553abSJoe Perches $value = deparenthesize($value); 49085b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4909000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4910000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 49115b9553abSJoe Perches } 4912c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4913000d1cc1SJoe Perches ERROR("SPACING", 4914000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4915c45dcabdSAndy Whitcroft } 4916c45dcabdSAndy Whitcroft } 4917507e5141SJoe Perches 4918b43ae21bSJoe Perches# unnecessary return in a void function 4919b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4920b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4921b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4922b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4923b43ae21bSJoe Perches $linenr >= 3 && 4924b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4925b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 49269819cf25SJoe Perches WARN("RETURN_VOID", 4927b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 49289819cf25SJoe Perches } 49299819cf25SJoe Perches 4930189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 49315b57980dSJoe Perches if ($perl_version_ok && 4932189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4933189248d8SJoe Perches my $openparens = $1; 4934189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4935189248d8SJoe Perches my $msg = ""; 4936189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4937189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4938189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4939189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4940189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4941189248d8SJoe Perches } 4942189248d8SJoe Perches } 4943189248d8SJoe Perches 4944c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4945c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4946c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4947c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 49485b57980dSJoe Perches if ($perl_version_ok && 4949c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4950c5595fa2SJoe Perches my $lead = $1; 4951c5595fa2SJoe Perches my $const = $2; 4952c5595fa2SJoe Perches my $comp = $3; 4953c5595fa2SJoe Perches my $to = $4; 4954c5595fa2SJoe Perches my $newcomp = $comp; 4955f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 4956c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4957c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4958c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4959c5595fa2SJoe Perches $fix) { 4960c5595fa2SJoe Perches if ($comp eq "<") { 4961c5595fa2SJoe Perches $newcomp = ">"; 4962c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4963c5595fa2SJoe Perches $newcomp = ">="; 4964c5595fa2SJoe Perches } elsif ($comp eq ">") { 4965c5595fa2SJoe Perches $newcomp = "<"; 4966c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4967c5595fa2SJoe Perches $newcomp = "<="; 4968c5595fa2SJoe Perches } 4969c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4970c5595fa2SJoe Perches } 4971c5595fa2SJoe Perches } 4972c5595fa2SJoe Perches 4973f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4974f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 497553a3c448SAndy Whitcroft my $name = $1; 497653a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4977000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4978f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 497953a3c448SAndy Whitcroft } 498053a3c448SAndy Whitcroft } 4981c45dcabdSAndy Whitcroft 49820a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 49834a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 49843705ce5bSJoe Perches if (ERROR("SPACING", 49853705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 49863705ce5bSJoe Perches $fix) { 4987194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49883705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 49893705ce5bSJoe Perches } 49900a920b5bSAndy Whitcroft } 49910a920b5bSAndy Whitcroft 4992f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4993f5fe35ddSAndy Whitcroft# statements after the conditional. 4994170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 49953e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 49963e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 49973e469cdcSAndy Whitcroft if (!defined $stat); 4998170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4999170d3a22SAndy Whitcroft $remain_next, $off_next); 5000170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 5001170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 5002170d3a22SAndy Whitcroft 5003170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 5004170d3a22SAndy Whitcroft # If the statement carries leading newlines, 5005170d3a22SAndy Whitcroft # then count those as offsets. 5006170d3a22SAndy Whitcroft my ($whitespace) = 5007170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 5008170d3a22SAndy Whitcroft my $offset = 5009170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 5010170d3a22SAndy Whitcroft 5011170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 5012170d3a22SAndy Whitcroft $offset} = 1; 5013170d3a22SAndy Whitcroft } 5014170d3a22SAndy Whitcroft } 5015170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 5016c11230f4SJoe Perches defined($stat) && defined($cond) && 5017170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 5018171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 50198905a67cSAndy Whitcroft 5020b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 5021000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 5022000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 50238905a67cSAndy Whitcroft } 50248905a67cSAndy Whitcroft 50258905a67cSAndy Whitcroft # Find out what is on the end of the line after the 50268905a67cSAndy Whitcroft # conditional. 5027773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 50288905a67cSAndy Whitcroft $s =~ s/\n.*//g; 502913214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 503053210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 503153210168SAndy Whitcroft $c !~ /}\s*while\s*/) 5032773647a0SAndy Whitcroft { 5033bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 5034bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 5035bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 503642bdf74cSHidetoshi Seto my $stat_real = ''; 5037bb44ad39SAndy Whitcroft 503842bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 503942bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 5040bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 5041bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 5042bb44ad39SAndy Whitcroft } 5043bb44ad39SAndy Whitcroft 5044000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5045000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 50468905a67cSAndy Whitcroft } 50478905a67cSAndy Whitcroft } 50488905a67cSAndy Whitcroft 504913214adfSAndy Whitcroft# Check for bitwise tests written as boolean 505013214adfSAndy Whitcroft if ($line =~ / 505113214adfSAndy Whitcroft (?: 505213214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 505313214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 505413214adfSAndy Whitcroft (?:\&\&|\|\|) 505513214adfSAndy Whitcroft | 505613214adfSAndy Whitcroft (?:\&\&|\|\|) 505713214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 505813214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 505913214adfSAndy Whitcroft )/x) 506013214adfSAndy Whitcroft { 5061000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 5062000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 506313214adfSAndy Whitcroft } 506413214adfSAndy Whitcroft 50658905a67cSAndy Whitcroft# if and else should not have general statements after it 506613214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 506713214adfSAndy Whitcroft my $s = $1; 506813214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 506913214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 5070000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5071000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 50720a920b5bSAndy Whitcroft } 507313214adfSAndy Whitcroft } 507439667782SAndy Whitcroft# if should not continue a brace 507539667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 5076000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5077048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 507839667782SAndy Whitcroft $herecurr); 507939667782SAndy Whitcroft } 5080a1080bf8SAndy Whitcroft# case and default should not have general statements after them 5081a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 5082a1080bf8SAndy Whitcroft $line !~ /\G(?: 50833fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 5084a1080bf8SAndy Whitcroft \s*return\s+ 5085a1080bf8SAndy Whitcroft )/xg) 5086a1080bf8SAndy Whitcroft { 5087000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5088000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 5089a1080bf8SAndy Whitcroft } 50900a920b5bSAndy Whitcroft 50910a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 50920a920b5bSAndy Whitcroft # indent level to be relevant to each other. 50938b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 50940a920b5bSAndy Whitcroft $previndent == $indent) { 50958b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 50968b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 50978b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 50988b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 50998b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 51008b8856f4SJoe Perches my $fixedline = $prevrawline; 51018b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 51028b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 51038b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 51048b8856f4SJoe Perches } 51058b8856f4SJoe Perches $fixedline = $rawline; 51068b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 51078b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 51088b8856f4SJoe Perches } 51090a920b5bSAndy Whitcroft } 51100a920b5bSAndy Whitcroft 51118b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 5112c2fdda0dSAndy Whitcroft $previndent == $indent) { 5113c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 5114c2fdda0dSAndy Whitcroft 5115c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 5116c2fdda0dSAndy Whitcroft # conditional. 5117773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 5118c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 5119c2fdda0dSAndy Whitcroft 5120c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 51218b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 51228b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 51238b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 51248b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 51258b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 51268b8856f4SJoe Perches my $fixedline = $prevrawline; 51278b8856f4SJoe Perches my $trailing = $rawline; 51288b8856f4SJoe Perches $trailing =~ s/^\+//; 51298b8856f4SJoe Perches $trailing = trim($trailing); 51308b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 51318b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 51328b8856f4SJoe Perches } 5133c2fdda0dSAndy Whitcroft } 5134c2fdda0dSAndy Whitcroft } 5135c2fdda0dSAndy Whitcroft 513695e2c602SJoe Perches#Specific variable tests 5137323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 5138323c1260SJoe Perches my $var = $1; 513995e2c602SJoe Perches 514095e2c602SJoe Perches#CamelCase 5141807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 5142be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 514322735ce8SJoe Perches#Ignore Page<foo> variants 5144807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 5145d439e6a5SJoe Perches#Ignore SI style variants like nS, mV and dB 5146d439e6a5SJoe Perches#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE) 5147d439e6a5SJoe Perches $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ && 5148f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 5149f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 51507e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 51517e781f67SJoe Perches my $word = $1; 51527e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 5153d8b07710SJoe Perches if ($check) { 5154d8b07710SJoe Perches seed_camelcase_includes(); 5155d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 5156d8b07710SJoe Perches seed_camelcase_file($realfile); 5157d8b07710SJoe Perches $camelcase_file_seeded = 1; 5158d8b07710SJoe Perches } 5159d8b07710SJoe Perches } 51607e781f67SJoe Perches if (!defined $camelcase{$word}) { 51617e781f67SJoe Perches $camelcase{$word} = 1; 5162be79794bSJoe Perches CHK("CAMELCASE", 51637e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 51647e781f67SJoe Perches } 5165323c1260SJoe Perches } 5166323c1260SJoe Perches } 51673445686aSJoe Perches } 51680a920b5bSAndy Whitcroft 51690a920b5bSAndy Whitcroft#no spaces allowed after \ in define 5170d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 5171d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 5172d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 5173d5e616fcSJoe Perches $fix) { 5174194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 5175d5e616fcSJoe Perches } 51760a920b5bSAndy Whitcroft } 51770a920b5bSAndy Whitcroft 51780e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 51790e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 5180c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 5181e09dec48SAndy Whitcroft my $file = "$1.h"; 5182e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 5183e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 5184e09dec48SAndy Whitcroft $realfile ne $checkfile && 51857840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 5186c45dcabdSAndy Whitcroft { 51870e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 51880e212e0aSFabian Frederick if ($asminclude > 0) { 5189e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 5190000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 5191000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5192e09dec48SAndy Whitcroft } else { 5193000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 5194000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5195e09dec48SAndy Whitcroft } 51960a920b5bSAndy Whitcroft } 51970a920b5bSAndy Whitcroft } 51980e212e0aSFabian Frederick } 51990a920b5bSAndy Whitcroft 5200653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 5201653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 5202cf655043SAndy Whitcroft# in a known good container 5203b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 5204b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 5205d8aaf121SAndy Whitcroft my $ln = $linenr; 5206d8aaf121SAndy Whitcroft my $cnt = $realcnt; 5207c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 5208c45dcabdSAndy Whitcroft my $ctx = ''; 520908a2843eSJoe Perches my $has_flow_statement = 0; 521008a2843eSJoe Perches my $has_arg_concat = 0; 5211c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 5212f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 5213f74bd194SAndy Whitcroft $ctx = $dstat; 5214c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 5215a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 5216c45dcabdSAndy Whitcroft 521708a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 521862e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 521908a2843eSJoe Perches 5220f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 5221f59b64bfSJoe Perches my $define_args = $1; 5222f59b64bfSJoe Perches my $define_stmt = $dstat; 5223f59b64bfSJoe Perches my @def_args = (); 5224f59b64bfSJoe Perches 5225f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 5226f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 5227f59b64bfSJoe Perches $define_args =~ s/\s*//g; 52288c8c45cfSJoe Perches $define_args =~ s/\\\+?//g; 5229f59b64bfSJoe Perches @def_args = split(",", $define_args); 5230f59b64bfSJoe Perches } 5231f59b64bfSJoe Perches 5232292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 5233c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 5234c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 5235c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 5236c45dcabdSAndy Whitcroft 5237c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 5238bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 5239bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 52406b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 5241bf30d6edSAndy Whitcroft { 5242c45dcabdSAndy Whitcroft } 5243c45dcabdSAndy Whitcroft 5244342d3d2fSAntonio Borneo # Flatten any obvious string concatenation. 524533acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 524633acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 5247e45bab8eSAndy Whitcroft { 5248e45bab8eSAndy Whitcroft } 5249e45bab8eSAndy Whitcroft 525042e15293SJoe Perches # Make asm volatile uses seem like a generic function 525142e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 525242e15293SJoe Perches 5253c45dcabdSAndy Whitcroft my $exceptions = qr{ 5254c45dcabdSAndy Whitcroft $Declare| 5255c45dcabdSAndy Whitcroft module_param_named| 5256a0a0a7a9SKees Cook MODULE_PARM_DESC| 5257c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 5258c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 5259383099fdSAndy Whitcroft __typeof__\(| 526022fd2d3eSStefani Seibold union| 526122fd2d3eSStefani Seibold struct| 5262ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 52636b10df42SVladimir Zapolskiy ^\"|\"$| 52646b10df42SVladimir Zapolskiy ^\[ 5265c45dcabdSAndy Whitcroft }x; 52665eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 5267f59b64bfSJoe Perches 5268f59b64bfSJoe Perches $ctx =~ s/\n*$//; 5269f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 5270e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 5271f59b64bfSJoe Perches 5272f74bd194SAndy Whitcroft if ($dstat ne '' && 5273f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 5274f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 52753cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 5276356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5277f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 5278f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5279e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 528072f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 5281f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5282f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5283f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 52844e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5285f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5286c45dcabdSAndy Whitcroft { 5287e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5288e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5289e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5290e795556aSJoe Perches } elsif ($dstat =~ /;/) { 5291f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5292f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5293f74bd194SAndy Whitcroft } else { 5294000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 5295388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5296d8aaf121SAndy Whitcroft } 5297f59b64bfSJoe Perches 5298f59b64bfSJoe Perches } 52995207649bSJoe Perches 53005207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 53015207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 53025207649bSJoe Perches my $first = 1; 53035207649bSJoe Perches $define_stmt = ""; 53045207649bSJoe Perches foreach my $l (@stmt_array) { 53055207649bSJoe Perches $l =~ s/\\$//; 53065207649bSJoe Perches if ($first) { 53075207649bSJoe Perches $define_stmt = $l; 53085207649bSJoe Perches $first = 0; 53095207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 53105207649bSJoe Perches $define_stmt .= substr($l, 1); 53115207649bSJoe Perches } 53125207649bSJoe Perches } 53135207649bSJoe Perches $define_stmt =~ s/$;//g; 53145207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 53155207649bSJoe Perches $define_stmt = trim($define_stmt); 53165207649bSJoe Perches 5317f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5318f59b64bfSJoe Perches foreach my $arg (@def_args) { 5319f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 53209192d41aSJoe Perches next if ($arg =~ /^type$/i); 53217fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 53226dba824eSBrendan Jackman $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 53237fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 53247fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 5325d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 5326f59b64bfSJoe Perches if ($use_cnt > 1) { 5327f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5328f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5329f59b64bfSJoe Perches } 53309192d41aSJoe Perches# check if any macro arguments may have other precedence issues 53317fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 53329192d41aSJoe Perches ((defined($1) && $1 ne ',') || 53339192d41aSJoe Perches (defined($2) && $2 ne ','))) { 53349192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 53359192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 53369192d41aSJoe Perches } 53370a920b5bSAndy Whitcroft } 53385023d347SJoe Perches 533908a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 534008a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 534108a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 534208a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 5343e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 534408a2843eSJoe Perches 534508a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 534608a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 534708a2843eSJoe Perches } 534808a2843eSJoe Perches 5349481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 53505023d347SJoe Perches 53515023d347SJoe Perches } else { 53525023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5353481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5354481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 53555023d347SJoe Perches $line =~ /^\+.*\\$/) { 53565023d347SJoe Perches WARN("LINE_CONTINUATIONS", 53575023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 53585023d347SJoe Perches } 5359653d4876SAndy Whitcroft } 53600a920b5bSAndy Whitcroft 5361b13edf7fSJoe Perches# do {} while (0) macro tests: 5362b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5363b13edf7fSJoe Perches# macro should not end with a semicolon 53645b57980dSJoe Perches if ($perl_version_ok && 5365b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5366b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5367b13edf7fSJoe Perches my $ln = $linenr; 5368b13edf7fSJoe Perches my $cnt = $realcnt; 5369b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5370b13edf7fSJoe Perches my $ctx = ''; 5371b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5372b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5373b13edf7fSJoe Perches $ctx = $dstat; 5374b13edf7fSJoe Perches 5375b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 53761b36b201SJoe Perches $dstat =~ s/$;/ /g; 5377b13edf7fSJoe Perches 5378b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5379b13edf7fSJoe Perches my $stmts = $2; 5380b13edf7fSJoe Perches my $semis = $3; 5381b13edf7fSJoe Perches 5382b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5383b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5384e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5385b13edf7fSJoe Perches 5386ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5387ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5388b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5389b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5390b13edf7fSJoe Perches } 5391b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5392b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5393b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5394b13edf7fSJoe Perches } 5395f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5396f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5397f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5398e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5399f5ef95b1SJoe Perches 5400f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5401f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5402b13edf7fSJoe Perches } 5403b13edf7fSJoe Perches } 5404b13edf7fSJoe Perches 5405f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 540613214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 540713214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5408cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 540913214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5410cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5411cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5412aad4f614SJoe Perches my @allowed = (); 5413aad4f614SJoe Perches my $allow = 0; 541413214adfSAndy Whitcroft my $seen = 0; 5415773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5416cf655043SAndy Whitcroft my $ln = $linenr - 1; 541713214adfSAndy Whitcroft for my $chunk (@chunks) { 541813214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 541913214adfSAndy Whitcroft 5420773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5421773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5422773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 5423773647a0SAndy Whitcroft 5424aad4f614SJoe Perches $allowed[$allow] = 0; 5425773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5426773647a0SAndy Whitcroft 5427773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 5428773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 5429773647a0SAndy Whitcroft 5430773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5431cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 5432cf655043SAndy Whitcroft 5433773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 543413214adfSAndy Whitcroft 543513214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 543613214adfSAndy Whitcroft 5437aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5438cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5439cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5440aad4f614SJoe Perches $allowed[$allow] = 1; 544113214adfSAndy Whitcroft } 544213214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5443cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5444aad4f614SJoe Perches $allowed[$allow] = 1; 544513214adfSAndy Whitcroft } 5446cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5447cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5448aad4f614SJoe Perches $allowed[$allow] = 1; 544913214adfSAndy Whitcroft } 5450aad4f614SJoe Perches $allow++; 545113214adfSAndy Whitcroft } 5452aad4f614SJoe Perches if ($seen) { 5453aad4f614SJoe Perches my $sum_allowed = 0; 5454aad4f614SJoe Perches foreach (@allowed) { 5455aad4f614SJoe Perches $sum_allowed += $_; 5456aad4f614SJoe Perches } 5457aad4f614SJoe Perches if ($sum_allowed == 0) { 5458000d1cc1SJoe Perches WARN("BRACES", 5459000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 5460aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 5461aad4f614SJoe Perches $seen != $allow) { 5462aad4f614SJoe Perches CHK("BRACES", 5463aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 5464aad4f614SJoe Perches } 546513214adfSAndy Whitcroft } 546613214adfSAndy Whitcroft } 546713214adfSAndy Whitcroft } 5468773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 546913214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 5470cf655043SAndy Whitcroft my $allowed = 0; 5471f0a594c1SAndy Whitcroft 5472cf655043SAndy Whitcroft # Check the pre-context. 5473cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 5474cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 5475cf655043SAndy Whitcroft $allowed = 1; 5476f0a594c1SAndy Whitcroft } 5477773647a0SAndy Whitcroft 5478773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 5479773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 5480773647a0SAndy Whitcroft 5481cf655043SAndy Whitcroft # Check the condition. 5482cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 5483773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 5484cf655043SAndy Whitcroft if (defined $cond) { 5485773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5486cf655043SAndy Whitcroft } 5487cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5488cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5489cf655043SAndy Whitcroft $allowed = 1; 5490cf655043SAndy Whitcroft } 5491cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5492cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5493cf655043SAndy Whitcroft $allowed = 1; 5494cf655043SAndy Whitcroft } 5495cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5496cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5497cf655043SAndy Whitcroft $allowed = 1; 5498cf655043SAndy Whitcroft } 5499cf655043SAndy Whitcroft # Check the post-context. 5500cf655043SAndy Whitcroft if (defined $chunks[1]) { 5501cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 5502cf655043SAndy Whitcroft if (defined $cond) { 5503773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5504cf655043SAndy Whitcroft } 5505cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 5506cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5507cf655043SAndy Whitcroft $allowed = 1; 5508cf655043SAndy Whitcroft } 5509cf655043SAndy Whitcroft } 5510cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 5511f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 5512e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5513cf655043SAndy Whitcroft 5514000d1cc1SJoe Perches WARN("BRACES", 5515000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 5516f0a594c1SAndy Whitcroft } 5517f0a594c1SAndy Whitcroft } 5518f0a594c1SAndy Whitcroft 5519e4c5babdSJoe Perches# check for single line unbalanced braces 552095330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 552195330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 5522e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 5523e4c5babdSJoe Perches } 5524e4c5babdSJoe Perches 55250979ae66SJoe Perches# check for unnecessary blank lines around braces 552677b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5527f8e58219SJoe Perches if (CHK("BRACES", 5528f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5529f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 5530f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5531f8e58219SJoe Perches } 55320979ae66SJoe Perches } 553377b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5534f8e58219SJoe Perches if (CHK("BRACES", 5535f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5536f8e58219SJoe Perches $fix) { 5537f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 5538f8e58219SJoe Perches } 55390979ae66SJoe Perches } 55400979ae66SJoe Perches 55414a0df2efSAndy Whitcroft# no volatiles please 55426c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 55436c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5544000d1cc1SJoe Perches WARN("VOLATILE", 55458c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 55464a0df2efSAndy Whitcroft } 55474a0df2efSAndy Whitcroft 55485e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 55495e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 55505e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 55515e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 555233acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 55535e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 55545e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 55555e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 55565e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 55575e4f6ba5SJoe Perches $fix && 55585e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 55595e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 55605e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 55615e4f6ba5SJoe Perches my $comma_close = ""; 55625e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 55635e4f6ba5SJoe Perches $comma_close = $1; 55645e4f6ba5SJoe Perches } 55655e4f6ba5SJoe Perches 55665e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 55675e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 55685e4f6ba5SJoe Perches my $fixedline = $prevrawline; 55695e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 55705e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 55715e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 55725e4f6ba5SJoe Perches $fixedline = $rawline; 55735e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 55745e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 55755e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 55765e4f6ba5SJoe Perches } 55775e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 55785e4f6ba5SJoe Perches } 55795e4f6ba5SJoe Perches } 55805e4f6ba5SJoe Perches 55815e4f6ba5SJoe Perches# check for missing a space in a string concatenation 55825e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 55835e4f6ba5SJoe Perches WARN('MISSING_SPACE', 55845e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 55855e4f6ba5SJoe Perches } 55865e4f6ba5SJoe Perches 558777cb8546SJoe Perches# check for an embedded function name in a string when the function is known 5588e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 5589e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 5590e4b7d309SJoe Perches# function declarations 559177cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 559277cb8546SJoe Perches defined($context_function) && 5593e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 5594e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 559577cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 5596e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 559777cb8546SJoe Perches } 559877cb8546SJoe Perches 55995e4f6ba5SJoe Perches# check for spaces before a quoted newline 56005e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 56015e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 56025e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 56035e4f6ba5SJoe Perches $fix) { 56045e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 56055e4f6ba5SJoe Perches } 56065e4f6ba5SJoe Perches 56075e4f6ba5SJoe Perches } 56085e4f6ba5SJoe Perches 5609f17dba4fSJoe Perches# concatenated string without spaces between elements 561079682c0cSJoe Perches if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) { 561179682c0cSJoe Perches if (CHK("CONCATENATED_STRING", 561279682c0cSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr) && 561379682c0cSJoe Perches $fix) { 561479682c0cSJoe Perches while ($line =~ /($String)/g) { 561579682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 561679682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/; 561779682c0cSJoe Perches $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/; 561879682c0cSJoe Perches } 561979682c0cSJoe Perches } 5620f17dba4fSJoe Perches } 5621f17dba4fSJoe Perches 562290ad30e5SJoe Perches# uncoalesced string fragments 562333acb54aSJoe Perches if ($line =~ /$String\s*"/) { 562479682c0cSJoe Perches if (WARN("STRING_FRAGMENTS", 562579682c0cSJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr) && 562679682c0cSJoe Perches $fix) { 562779682c0cSJoe Perches while ($line =~ /($String)(?=\s*")/g) { 562879682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 562979682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e; 563079682c0cSJoe Perches } 563179682c0cSJoe Perches } 563290ad30e5SJoe Perches } 563390ad30e5SJoe Perches 5634522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 5635522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 5636522b837cSAlexey Dobriyan my $show_Z = 1; 56375e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 5638522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 56395e4f6ba5SJoe Perches $string =~ s/%%/__/g; 5640522b837cSAlexey Dobriyan # check for %L 5641522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 56425e4f6ba5SJoe Perches WARN("PRINTF_L", 5643522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 5644522b837cSAlexey Dobriyan $show_L = 0; 56455e4f6ba5SJoe Perches } 5646522b837cSAlexey Dobriyan # check for %Z 5647522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 5648522b837cSAlexey Dobriyan WARN("PRINTF_Z", 5649522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 5650522b837cSAlexey Dobriyan $show_Z = 0; 5651522b837cSAlexey Dobriyan } 5652522b837cSAlexey Dobriyan # check for 0x<decimal> 5653522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 5654522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 56556e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 56566e300757SJoe Perches } 56575e4f6ba5SJoe Perches } 56585e4f6ba5SJoe Perches 56595e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 56603f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 56615e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 56625e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 56635e4f6ba5SJoe Perches } 56645e4f6ba5SJoe Perches 566500df344fSAndy Whitcroft# warn about #if 0 5666c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 566760f89010SPrakruthi Deepak Heragu WARN("IF_0", 566860f89010SPrakruthi Deepak Heragu "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr); 566960f89010SPrakruthi Deepak Heragu } 567060f89010SPrakruthi Deepak Heragu 567160f89010SPrakruthi Deepak Heragu# warn about #if 1 567260f89010SPrakruthi Deepak Heragu if ($line =~ /^.\s*\#\s*if\s+1\b/) { 567360f89010SPrakruthi Deepak Heragu WARN("IF_1", 567460f89010SPrakruthi Deepak Heragu "Consider removing the #if 1 and its #endif\n" . $herecurr); 56754a0df2efSAndy Whitcroft } 56764a0df2efSAndy Whitcroft 567703df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 567803df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5679100425deSJoe Perches my $tested = quotemeta($1); 5680100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5681100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5682100425deSJoe Perches my $func = $1; 5683100425deSJoe Perches if (WARN('NEEDLESS_IF', 5684100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5685100425deSJoe Perches $fix) { 5686100425deSJoe Perches my $do_fix = 1; 5687100425deSJoe Perches my $leading_tabs = ""; 5688100425deSJoe Perches my $new_leading_tabs = ""; 5689100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5690100425deSJoe Perches $leading_tabs = $1; 5691100425deSJoe Perches } else { 5692100425deSJoe Perches $do_fix = 0; 5693100425deSJoe Perches } 5694100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5695100425deSJoe Perches $new_leading_tabs = $1; 5696100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5697100425deSJoe Perches $do_fix = 0; 5698100425deSJoe Perches } 5699100425deSJoe Perches } else { 5700100425deSJoe Perches $do_fix = 0; 5701100425deSJoe Perches } 5702100425deSJoe Perches if ($do_fix) { 5703100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5704100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5705100425deSJoe Perches } 5706100425deSJoe Perches } 57074c432a8fSGreg Kroah-Hartman } 57084c432a8fSGreg Kroah-Hartman } 5709f0a594c1SAndy Whitcroft 5710ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5711ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5712ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5713ebfdc409SJoe Perches (defined $1 || defined $3) && 5714ebfdc409SJoe Perches $linenr > 3) { 5715ebfdc409SJoe Perches my $testval = $2; 5716ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5717ebfdc409SJoe Perches 5718ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5719ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5720ebfdc409SJoe Perches 5721e29a70f1SJoe Perches if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ && 5722e29a70f1SJoe Perches $s !~ /\b__GFP_NOWARN\b/ ) { 5723ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5724ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5725ebfdc409SJoe Perches } 5726ebfdc409SJoe Perches } 5727ebfdc409SJoe Perches 5728f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5729dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5730f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5731f78d98f6SJoe Perches my $level = $1; 5732f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5733f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5734f78d98f6SJoe Perches $fix) { 5735f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5736f78d98f6SJoe Perches } 5737f78d98f6SJoe Perches } 5738f78d98f6SJoe Perches 573945c55e92SJoe Perches# check for logging continuations 574045c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 574145c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 574245c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 574345c55e92SJoe Perches } 574445c55e92SJoe Perches 5745abb08a53SJoe Perches# check for mask then right shift without a parentheses 57465b57980dSJoe Perches if ($perl_version_ok && 5747abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5748abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5749abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5750abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5751abb08a53SJoe Perches } 5752abb08a53SJoe Perches 5753b75ac618SJoe Perches# check for pointer comparisons to NULL 57545b57980dSJoe Perches if ($perl_version_ok) { 5755b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5756b75ac618SJoe Perches my $val = $1; 5757b75ac618SJoe Perches my $equal = "!"; 5758b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5759b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5760b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5761b75ac618SJoe Perches $fix) { 5762b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5763b75ac618SJoe Perches } 5764b75ac618SJoe Perches } 5765b75ac618SJoe Perches } 5766b75ac618SJoe Perches 57678716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 57688716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 57698716de38SJoe Perches my $attr = $1; 57708716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 57718716de38SJoe Perches my $ptr = $1; 57728716de38SJoe Perches my $var = $2; 57738716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 57748716de38SJoe Perches ERROR("MISPLACED_INIT", 57758716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 57768716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 57778716de38SJoe Perches WARN("MISPLACED_INIT", 57788716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 57798716de38SJoe Perches $fix) { 5780194f66fcSJoe 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; 57818716de38SJoe Perches } 57828716de38SJoe Perches } 57838716de38SJoe Perches } 57848716de38SJoe Perches 5785e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5786e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5787e970b884SJoe Perches my $attr = $1; 5788e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5789e970b884SJoe Perches my $attr_prefix = $1; 5790e970b884SJoe Perches my $attr_type = $2; 5791e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5792e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5793e970b884SJoe Perches $fix) { 5794194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5795e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5796e970b884SJoe Perches } 5797e970b884SJoe Perches } 5798e970b884SJoe Perches 5799e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5800e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5801e970b884SJoe Perches my $attr = $1; 5802e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5803e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5804e970b884SJoe Perches $fix) { 5805194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5806e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5807e970b884SJoe Perches $lead = rtrim($1); 5808e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5809e970b884SJoe Perches $lead = "${lead}const "; 5810194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5811e970b884SJoe Perches } 5812e970b884SJoe Perches } 5813e970b884SJoe Perches 5814c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5815c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5816c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5817c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5818c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5819c17893c7SJoe Perches $fix) { 5820c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5821c17893c7SJoe Perches } 5822c17893c7SJoe Perches } 5823c17893c7SJoe Perches 5824fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5825fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5826fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5827fbdb8138SJoe Perches my $constant_func = $1; 5828fbdb8138SJoe Perches my $func = $constant_func; 5829fbdb8138SJoe Perches $func =~ s/^__constant_//; 5830fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5831fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5832fbdb8138SJoe Perches $fix) { 5833194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5834fbdb8138SJoe Perches } 5835fbdb8138SJoe Perches } 5836fbdb8138SJoe Perches 58371a15a250SPatrick Pannuto# prefer usleep_range over udelay 583837581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 583943c1d77cSJoe Perches my $delay = $1; 58401a15a250SPatrick Pannuto # ignore udelay's < 10, however 584143c1d77cSJoe Perches if (! ($delay < 10) ) { 5842000d1cc1SJoe Perches CHK("USLEEP_RANGE", 5843458f69efSMauro Carvalho Chehab "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr); 584443c1d77cSJoe Perches } 584543c1d77cSJoe Perches if ($delay > 2000) { 584643c1d77cSJoe Perches WARN("LONG_UDELAY", 584743c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 58481a15a250SPatrick Pannuto } 58491a15a250SPatrick Pannuto } 58501a15a250SPatrick Pannuto 585109ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 585209ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 585309ef8725SPatrick Pannuto if ($1 < 20) { 5854000d1cc1SJoe Perches WARN("MSLEEP", 5855458f69efSMauro Carvalho Chehab "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr); 585609ef8725SPatrick Pannuto } 585709ef8725SPatrick Pannuto } 585809ef8725SPatrick Pannuto 585936ec1939SJoe Perches# check for comparisons of jiffies 586036ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 586136ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 586236ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 586336ec1939SJoe Perches } 586436ec1939SJoe Perches 58659d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 58669d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 58679d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 58689d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 58699d7a34a5SJoe Perches } 58709d7a34a5SJoe Perches 587100df344fSAndy Whitcroft# warn about #ifdefs in C files 5872c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 587300df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 587400df344fSAndy Whitcroft# print "$herecurr"; 587500df344fSAndy Whitcroft# $clean = 0; 587600df344fSAndy Whitcroft# } 587700df344fSAndy Whitcroft 587822f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5879c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 58803705ce5bSJoe Perches if (ERROR("SPACING", 58813705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 58823705ce5bSJoe Perches $fix) { 5883194f66fcSJoe Perches $fixed[$fixlinenr] =~ 58843705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 58853705ce5bSJoe Perches } 58863705ce5bSJoe Perches 588722f2a2efSAndy Whitcroft } 588822f2a2efSAndy Whitcroft 58894a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5890171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5891171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 58924a0df2efSAndy Whitcroft my $which = $1; 58934a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5894000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5895000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 58964a0df2efSAndy Whitcroft } 58974a0df2efSAndy Whitcroft } 58984a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5899402c2553SMichael S. Tsirkin 5900402c2553SMichael S. Tsirkin my $barriers = qr{ 5901402c2553SMichael S. Tsirkin mb| 5902402c2553SMichael S. Tsirkin rmb| 5903402c2553SMichael S. Tsirkin wmb| 5904402c2553SMichael S. Tsirkin read_barrier_depends 5905402c2553SMichael S. Tsirkin }x; 5906402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5907402c2553SMichael S. Tsirkin mb__before_atomic| 5908402c2553SMichael S. Tsirkin mb__after_atomic| 5909402c2553SMichael S. Tsirkin store_release| 5910402c2553SMichael S. Tsirkin load_acquire| 5911402c2553SMichael S. Tsirkin store_mb| 5912402c2553SMichael S. Tsirkin (?:$barriers) 5913402c2553SMichael S. Tsirkin }x; 5914402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5915402c2553SMichael S. Tsirkin (?:$barriers)| 591643e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 591743e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5918402c2553SMichael S. Tsirkin }x; 5919402c2553SMichael S. Tsirkin 5920402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 59214a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5922c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5923000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 59244a0df2efSAndy Whitcroft } 59254a0df2efSAndy Whitcroft } 59263ad81779SPaul E. McKenney 5927f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5928f4073b0fSMichael S. Tsirkin 5929f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5930f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5931f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5932f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5933f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5934f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5935f4073b0fSMichael S. Tsirkin } 5936f4073b0fSMichael S. Tsirkin 5937cb426e99SJoe Perches# check for waitqueue_active without a comment. 5938cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5939cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5940cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5941cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5942cb426e99SJoe Perches } 5943cb426e99SJoe Perches } 59443ad81779SPaul E. McKenney 594591db2592SPaul E. McKenney# check for smp_read_barrier_depends and read_barrier_depends 594691db2592SPaul E. McKenney if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) { 594791db2592SPaul E. McKenney WARN("READ_BARRIER_DEPENDS", 594891db2592SPaul E. McKenney "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr); 594991db2592SPaul E. McKenney } 595091db2592SPaul E. McKenney 59514a0df2efSAndy Whitcroft# check of hardware specific defines 5952c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5953000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5954000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 59550a920b5bSAndy Whitcroft } 5956653d4876SAndy Whitcroft 5957596ed45bSJoe Perches# check that the storage class is not after a type 5958596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 5959000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5960596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 5961596ed45bSJoe Perches } 5962596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 5963596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 5964596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 5965596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 5966596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 5967596ed45bSJoe Perches WARN("STORAGE_CLASS", 5968596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 5969d4977c78STobias Klauser } 5970d4977c78STobias Klauser 5971de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5972de7d4f0eSAndy Whitcroft# storage class and type. 59739c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 59749c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5975000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5976000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5977de7d4f0eSAndy Whitcroft } 5978de7d4f0eSAndy Whitcroft 59798905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 59802b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 59812b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5982d5e616fcSJoe Perches if (WARN("INLINE", 5983d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5984d5e616fcSJoe Perches $fix) { 5985194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5986d5e616fcSJoe Perches 5987d5e616fcSJoe Perches } 59888905a67cSAndy Whitcroft } 59898905a67cSAndy Whitcroft 59903d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 59912b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 59922b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5993000d1cc1SJoe Perches WARN("PREFER_PACKED", 5994000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 59953d130fd0SJoe Perches } 59963d130fd0SJoe Perches 599739b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 59982b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 59992b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 6000000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 6001000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 600239b7e287SJoe Perches } 600339b7e287SJoe Perches 6004462811d9SJoe Perches# Check for __attribute__ section, prefer __section 6005462811d9SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 6006462811d9SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) { 6007462811d9SJoe Perches my $old = substr($rawline, $-[1], $+[1] - $-[1]); 6008462811d9SJoe Perches my $new = substr($old, 1, -1); 6009462811d9SJoe Perches if (WARN("PREFER_SECTION", 6010462811d9SJoe Perches "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) && 6011462811d9SJoe Perches $fix) { 6012462811d9SJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/; 6013462811d9SJoe Perches } 6014462811d9SJoe Perches } 6015462811d9SJoe Perches 60165f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 60172b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 60182b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 6019d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 6020d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 6021d5e616fcSJoe Perches $fix) { 6022194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 6023d5e616fcSJoe Perches 6024d5e616fcSJoe Perches } 60255f14d3bdSJoe Perches } 60265f14d3bdSJoe Perches 60276061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 60282b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 60292b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 6030d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 6031d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 6032d5e616fcSJoe Perches $fix) { 6033194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 6034d5e616fcSJoe Perches } 60356061d949SJoe Perches } 60366061d949SJoe Perches 6037619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 60385b57980dSJoe Perches if ($perl_version_ok && 6039619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 6040619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 6041619a908aSJoe Perches $line =~ /\b__weak\b/)) { 6042619a908aSJoe Perches ERROR("WEAK_DECLARATION", 6043619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 6044619a908aSJoe Perches } 6045619a908aSJoe Perches 6046fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 6047e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 6048fd39f904STomas Winkler $realfile !~ m@\btools/@ && 6049e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 6050e6176fa4SJoe Perches my $type = $1; 6051e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 6052e6176fa4SJoe Perches $type = $1; 6053e6176fa4SJoe Perches my $kernel_type = 'u'; 6054e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 6055e6176fa4SJoe Perches $type =~ /(\d+)/; 6056e6176fa4SJoe Perches $kernel_type .= $1; 6057e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 6058e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 6059e6176fa4SJoe Perches $fix) { 6060e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 6061e6176fa4SJoe Perches } 6062e6176fa4SJoe Perches } 6063e6176fa4SJoe Perches } 6064e6176fa4SJoe Perches 6065938224b5SJoe Perches# check for cast of C90 native int or longer types constants 6066938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 6067938224b5SJoe Perches my $cast = $1; 6068938224b5SJoe Perches my $const = $2; 6069938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 6070938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 6071938224b5SJoe Perches $fix) { 6072938224b5SJoe Perches my $suffix = ""; 6073938224b5SJoe Perches my $newconst = $const; 6074938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 6075938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 6076938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 6077938224b5SJoe Perches $suffix .= 'LL'; 6078938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 6079938224b5SJoe Perches $suffix .= 'L'; 6080938224b5SJoe Perches } 6081938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 6082938224b5SJoe Perches } 6083938224b5SJoe Perches } 6084938224b5SJoe Perches 60858f53a9b8SJoe Perches# check for sizeof(&) 60868f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 6087000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 6088000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 60898f53a9b8SJoe Perches } 60908f53a9b8SJoe Perches 609166c80b60SJoe Perches# check for sizeof without parenthesis 609266c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 6093d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 6094d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 6095d5e616fcSJoe Perches $fix) { 6096194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 6097d5e616fcSJoe Perches } 609866c80b60SJoe Perches } 609966c80b60SJoe Perches 610088982feaSJoe Perches# check for struct spinlock declarations 610188982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 610288982feaSJoe Perches WARN("USE_SPINLOCK_T", 610388982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 610488982feaSJoe Perches } 610588982feaSJoe Perches 6106a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 610706668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 6108a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 6109caac1d5fSHeba Aamer $fmt =~ s/%%//g; 6110caac1d5fSHeba Aamer if ($fmt !~ /%/) { 6111d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 6112d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 6113d5e616fcSJoe Perches $fix) { 6114194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 6115d5e616fcSJoe Perches } 6116a6962d72SJoe Perches } 6117a6962d72SJoe Perches } 6118a6962d72SJoe Perches 61190b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 61205b57980dSJoe Perches if ($perl_version_ok && 61210b523769SJoe Perches defined $stat && 61220b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 61230b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 6124e3c6bc95STobin C. Harding my $stat_real; 6125e3c6bc95STobin C. Harding 61260b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 61270b523769SJoe Perches $lc = $lc + $linenr; 61280b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 6129ffe07513SJoe Perches my $specifier; 6130ffe07513SJoe Perches my $extension; 61313bd32d6aSSakari Ailus my $qualifier; 6132ffe07513SJoe Perches my $bad_specifier = ""; 61330b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 61340b523769SJoe Perches $fmt =~ s/%%//g; 6135e3c6bc95STobin C. Harding 61363bd32d6aSSakari Ailus while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) { 6137e3c6bc95STobin C. Harding $specifier = $1; 6138e3c6bc95STobin C. Harding $extension = $2; 61393bd32d6aSSakari Ailus $qualifier = $3; 6140361b0d28SLinus Torvalds if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ || 61413bd32d6aSSakari Ailus ($extension eq "f" && 61423bd32d6aSSakari Ailus defined $qualifier && $qualifier !~ /^w/)) { 6143e3c6bc95STobin C. Harding $bad_specifier = $specifier; 61440b523769SJoe Perches last; 61450b523769SJoe Perches } 6146e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 6147e3c6bc95STobin C. Harding if (!defined($stat_real)) { 6148e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 61490b523769SJoe Perches } 6150e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 6151e3c6bc95STobin 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"); 6152e3c6bc95STobin C. Harding } 6153e3c6bc95STobin C. Harding } 6154e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 61552a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 61561df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 61571df7338aSSergey Senozhatsky my $use = ""; 6158e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 61591df7338aSSergey Senozhatsky $use = " - use %pS instead"; 6160e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 61611df7338aSSergey Senozhatsky } 61622a9f9d85STobin C. Harding 61630b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 6164e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 6165e3c6bc95STobin C. Harding } 61660b523769SJoe Perches } 61670b523769SJoe Perches } 61680b523769SJoe Perches 6169554e165cSAndy Whitcroft# Check for misused memsets 61705b57980dSJoe Perches if ($perl_version_ok && 6171d1fe9c09SJoe Perches defined $stat && 61729e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 6173554e165cSAndy Whitcroft 6174d7c76ba7SJoe Perches my $ms_addr = $2; 6175d1fe9c09SJoe Perches my $ms_val = $7; 6176d1fe9c09SJoe Perches my $ms_size = $12; 6177d7c76ba7SJoe Perches 6178554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 6179554e165cSAndy Whitcroft ERROR("MEMSET", 6180d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 6181554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 6182554e165cSAndy Whitcroft WARN("MEMSET", 6183d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 6184d7c76ba7SJoe Perches } 6185d7c76ba7SJoe Perches } 6186d7c76ba7SJoe Perches 618798a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 61885b57980dSJoe Perches# if ($perl_version_ok && 6189f333195dSJoe Perches# defined $stat && 6190f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6191f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 6192f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 6193f333195dSJoe Perches# $fix) { 6194f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 6195f333195dSJoe Perches# } 6196f333195dSJoe Perches# } 619798a9bba5SJoe Perches 6198b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 61995b57980dSJoe Perches# if ($perl_version_ok && 6200f333195dSJoe Perches# defined $stat && 6201f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6202f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 6203f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 6204f333195dSJoe Perches# } 6205b6117d17SMateusz Kulikowski 62068617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 62078617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 62085b57980dSJoe Perches# if ($perl_version_ok && 6209f333195dSJoe Perches# defined $stat && 6210f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6211f333195dSJoe Perches# 6212f333195dSJoe Perches# my $ms_val = $7; 6213f333195dSJoe Perches# 6214f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 6215f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 6216f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 6217f333195dSJoe Perches# $fix) { 6218f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 6219f333195dSJoe Perches# } 6220f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 6221f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 6222f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 6223f333195dSJoe Perches# $fix) { 6224f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 6225f333195dSJoe Perches# } 6226f333195dSJoe Perches# } 6227f333195dSJoe Perches# } 62288617cd09SMateusz Kulikowski 6229d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 62305b57980dSJoe Perches if ($perl_version_ok && 6231d1fe9c09SJoe Perches defined $stat && 6232d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 6233d1fe9c09SJoe Perches if (defined $2 || defined $7) { 6234d7c76ba7SJoe Perches my $call = $1; 6235d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 6236d7c76ba7SJoe Perches my $arg1 = $3; 6237d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 6238d1fe9c09SJoe Perches my $arg2 = $8; 6239d7c76ba7SJoe Perches my $cast; 6240d7c76ba7SJoe Perches 6241d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 6242d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 6243d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 6244d7c76ba7SJoe Perches $cast = $cast1; 6245d7c76ba7SJoe Perches } else { 6246d7c76ba7SJoe Perches $cast = $cast2; 6247d7c76ba7SJoe Perches } 6248d7c76ba7SJoe Perches WARN("MINMAX", 6249d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 6250554e165cSAndy Whitcroft } 6251554e165cSAndy Whitcroft } 6252554e165cSAndy Whitcroft 62534a273195SJoe Perches# check usleep_range arguments 62545b57980dSJoe Perches if ($perl_version_ok && 62554a273195SJoe Perches defined $stat && 62564a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 62574a273195SJoe Perches my $min = $1; 62584a273195SJoe Perches my $max = $7; 62594a273195SJoe Perches if ($min eq $max) { 62604a273195SJoe Perches WARN("USLEEP_RANGE", 6261458f69efSMauro Carvalho Chehab "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 62624a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 62634a273195SJoe Perches $min > $max) { 62644a273195SJoe Perches WARN("USLEEP_RANGE", 6265458f69efSMauro Carvalho Chehab "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 62664a273195SJoe Perches } 62674a273195SJoe Perches } 62684a273195SJoe Perches 6269823b794cSJoe Perches# check for naked sscanf 62705b57980dSJoe Perches if ($perl_version_ok && 6271823b794cSJoe Perches defined $stat && 62726c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 6273823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 6274823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 6275823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 6276823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 6277823b794cSJoe Perches $lc = $lc + $linenr; 62782a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6279823b794cSJoe Perches WARN("NAKED_SSCANF", 6280823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 6281823b794cSJoe Perches } 6282823b794cSJoe Perches 6283afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 62845b57980dSJoe Perches if ($perl_version_ok && 6285afc819abSJoe Perches defined $stat && 6286afc819abSJoe Perches $line =~ /\bsscanf\b/) { 6287afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 6288afc819abSJoe Perches $lc = $lc + $linenr; 62892a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6290afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 6291afc819abSJoe Perches my $format = $6; 6292afc819abSJoe Perches my $count = $format =~ tr@%@%@; 6293afc819abSJoe Perches if ($count == 1 && 6294afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 6295afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 6296afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 6297afc819abSJoe Perches } 6298afc819abSJoe Perches } 6299afc819abSJoe Perches } 6300afc819abSJoe Perches 630170dc8a48SJoe Perches# check for new externs in .h files. 630270dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 630370dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 6304d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 630570dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 630670dc8a48SJoe Perches $fix) { 6307194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 630870dc8a48SJoe Perches } 630970dc8a48SJoe Perches } 631070dc8a48SJoe Perches 6311de7d4f0eSAndy Whitcroft# check for new externs in .c files. 6312171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 6313c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 6314171ae1a4SAndy Whitcroft { 6315c45dcabdSAndy Whitcroft my $function_name = $1; 6316c45dcabdSAndy Whitcroft my $paren_space = $2; 6317171ae1a4SAndy Whitcroft 6318171ae1a4SAndy Whitcroft my $s = $stat; 6319171ae1a4SAndy Whitcroft if (defined $cond) { 6320171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 6321171ae1a4SAndy Whitcroft } 6322c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 6323c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 6324c45dcabdSAndy Whitcroft { 6325000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6326000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6327de7d4f0eSAndy Whitcroft } 6328de7d4f0eSAndy Whitcroft 6329171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 6330000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 6331000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 6332171ae1a4SAndy Whitcroft } 63339c9ba34eSAndy Whitcroft 63349c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 63359c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 63369c9ba34eSAndy Whitcroft { 6337000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6338000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6339171ae1a4SAndy Whitcroft } 6340171ae1a4SAndy Whitcroft 6341a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 634216b7f3c8SJoe Perches# while avoiding uninitialized_var(x) 6343a0ad7596SJoe Perches if (defined $stat && 634416b7f3c8SJoe Perches $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:($Ident)|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 634516b7f3c8SJoe Perches (!defined($1) || 634616b7f3c8SJoe Perches (defined($1) && $1 ne "uninitialized_var")) && 634716b7f3c8SJoe Perches $2 ne "void") { 634816b7f3c8SJoe Perches my $args = trim($2); 6349ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6350ca0d8929SJoe Perches my $arg = trim($1); 635116b7f3c8SJoe Perches if ($arg =~ /^$Type$/ && 635216b7f3c8SJoe Perches $arg !~ /enum\s+$Ident$/) { 6353ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 6354ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6355ca0d8929SJoe Perches } 6356ca0d8929SJoe Perches } 6357ca0d8929SJoe Perches } 6358ca0d8929SJoe Perches 6359a0ad7596SJoe Perches# check for function definitions 63605b57980dSJoe Perches if ($perl_version_ok && 6361a0ad7596SJoe Perches defined $stat && 6362a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6363a0ad7596SJoe Perches $context_function = $1; 6364a0ad7596SJoe Perches 6365a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 6366a0ad7596SJoe Perches my $ok = 0; 6367a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 6368a0ad7596SJoe Perches my $herectx = $here . "\n"; 6369a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6370a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 6371a0ad7596SJoe Perches $herectx .= $rl . "\n"; 6372a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 6373a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 6374a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 6375a0ad7596SJoe Perches } 6376a0ad7596SJoe Perches if (!$ok) { 6377a0ad7596SJoe Perches ERROR("OPEN_BRACE", 6378a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 6379a0ad7596SJoe Perches } 6380a0ad7596SJoe Perches } 6381a0ad7596SJoe Perches 6382de7d4f0eSAndy Whitcroft# checks for new __setup's 6383de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 6384de7d4f0eSAndy Whitcroft my $name = $1; 6385de7d4f0eSAndy Whitcroft 6386de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 6387000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 63888c27ceffSMauro Carvalho Chehab "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr); 6389de7d4f0eSAndy Whitcroft } 6390653d4876SAndy Whitcroft } 63919c0ca6f9SAndy Whitcroft 6392e29a70f1SJoe Perches# check for pointless casting of alloc functions 6393e29a70f1SJoe Perches if ($line =~ /\*\s*\)\s*$allocFunctions\b/) { 6394000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 6395000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 63969c0ca6f9SAndy Whitcroft } 639713214adfSAndy Whitcroft 6398a640d25cSJoe Perches# alloc style 6399a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 64005b57980dSJoe Perches if ($perl_version_ok && 6401e29a70f1SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 6402a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 6403a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 6404a640d25cSJoe Perches } 6405a640d25cSJoe Perches 640660a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 64075b57980dSJoe Perches if ($perl_version_ok && 64081b4a2ed4SJoe Perches defined $stat && 64091b4a2ed4SJoe Perches $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 641060a55369SJoe Perches my $oldfunc = $3; 641160a55369SJoe Perches my $a1 = $4; 641260a55369SJoe Perches my $a2 = $10; 641360a55369SJoe Perches my $newfunc = "kmalloc_array"; 641460a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 641560a55369SJoe Perches my $r1 = $a1; 641660a55369SJoe Perches my $r2 = $a2; 641760a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 641860a55369SJoe Perches $r1 = $a2; 641960a55369SJoe Perches $r2 = $a1; 642060a55369SJoe Perches } 6421e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 6422e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 64231b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 6424e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6425e3d95a2aSTobin C. Harding 6426e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 64271b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 64281b4a2ed4SJoe Perches $cnt == 1 && 6429e367455aSJoe Perches $fix) { 6430194f66fcSJoe 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; 643160a55369SJoe Perches } 643260a55369SJoe Perches } 643360a55369SJoe Perches } 643460a55369SJoe Perches 6435972fdea2SJoe Perches# check for krealloc arg reuse 64365b57980dSJoe Perches if ($perl_version_ok && 64374cab63ceSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ && 64384cab63ceSJoe Perches $1 eq $3) { 6439972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 6440972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 6441972fdea2SJoe Perches } 6442972fdea2SJoe Perches 64435ce59ae0SJoe Perches# check for alloc argument mismatch 64445ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 64455ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 64465ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 64475ce59ae0SJoe Perches } 64485ce59ae0SJoe Perches 6449caf2a54fSJoe Perches# check for multiple semicolons 6450caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 6451d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 6452d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 6453d5e616fcSJoe Perches $fix) { 6454194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 6455d5e616fcSJoe Perches } 6456d1e2ad07SJoe Perches } 6457d1e2ad07SJoe Perches 6458cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 6459cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 6460cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 64610ab90191SJoe Perches my $ull = ""; 64620ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 64630ab90191SJoe Perches if (CHK("BIT_MACRO", 64640ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 64650ab90191SJoe Perches $fix) { 64660ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 64670ab90191SJoe Perches } 64680ab90191SJoe Perches } 64690ab90191SJoe Perches 64702d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 64712d632745SJoe Perches if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) { 64722d632745SJoe Perches my $config = $1; 64732d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 64742d632745SJoe Perches "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) && 64752d632745SJoe Perches $fix) { 64762d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 64772d632745SJoe Perches } 64782d632745SJoe Perches } 64792d632745SJoe Perches 6480e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 6481c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 6482c34c09a8SJoe Perches my $has_break = 0; 6483c34c09a8SJoe Perches my $has_statement = 0; 6484c34c09a8SJoe Perches my $count = 0; 6485c34c09a8SJoe Perches my $prevline = $linenr; 6486e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 6487c34c09a8SJoe Perches $prevline--; 6488c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 6489c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 6490c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 6491c34c09a8SJoe Perches next if ($fline =~ /^\-/); 6492c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 6493c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 6494c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 6495c34c09a8SJoe Perches $has_statement = 1; 6496c34c09a8SJoe Perches $count++; 6497258f79d5SHeinrich Schuchardt $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/); 6498c34c09a8SJoe Perches } 6499c34c09a8SJoe Perches if (!$has_break && $has_statement) { 6500c34c09a8SJoe Perches WARN("MISSING_BREAK", 6501224236d9SAndrew Morton "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr); 6502c34c09a8SJoe Perches } 6503c34c09a8SJoe Perches } 6504c34c09a8SJoe Perches 6505f36d3eb8SJoe Perches# check for /* fallthrough */ like comment, prefer fallthrough; 6506f36d3eb8SJoe Perches my @fallthroughs = ( 6507f36d3eb8SJoe Perches 'fallthrough', 6508f36d3eb8SJoe Perches '@fallthrough@', 6509f36d3eb8SJoe Perches 'lint -fallthrough[ \t]*', 6510f36d3eb8SJoe Perches 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)', 6511f36d3eb8SJoe Perches '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?', 6512f36d3eb8SJoe Perches 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 6513f36d3eb8SJoe Perches 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 6514f36d3eb8SJoe Perches ); 6515f36d3eb8SJoe Perches if ($raw_comment ne '') { 6516f36d3eb8SJoe Perches foreach my $ft (@fallthroughs) { 6517f36d3eb8SJoe Perches if ($raw_comment =~ /$ft/) { 6518f36d3eb8SJoe Perches my $msg_level = \&WARN; 6519f36d3eb8SJoe Perches $msg_level = \&CHK if ($file); 6520f36d3eb8SJoe Perches &{$msg_level}("PREFER_FALLTHROUGH", 6521f36d3eb8SJoe Perches "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr); 6522f36d3eb8SJoe Perches last; 6523f36d3eb8SJoe Perches } 6524f36d3eb8SJoe Perches } 6525f36d3eb8SJoe Perches } 6526f36d3eb8SJoe Perches 6527d1e2ad07SJoe Perches# check for switch/default statements without a break; 65285b57980dSJoe Perches if ($perl_version_ok && 6529d1e2ad07SJoe Perches defined $stat && 6530d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 6531d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 6532e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6533e3d95a2aSTobin C. Harding 6534d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 6535d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 6536caf2a54fSJoe Perches } 6537caf2a54fSJoe Perches 653813214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 6539d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 6540d5e616fcSJoe Perches if (WARN("USE_FUNC", 6541d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 6542d5e616fcSJoe Perches $fix) { 6543194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 6544d5e616fcSJoe Perches } 654513214adfSAndy Whitcroft } 6546773647a0SAndy Whitcroft 654762ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 654862ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 654962ec818fSJoe Perches ERROR("DATE_TIME", 655062ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 655162ec818fSJoe Perches } 655262ec818fSJoe Perches 65532c92488aSJoe Perches# check for use of yield() 65542c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 65552c92488aSJoe Perches WARN("YIELD", 65562c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 65572c92488aSJoe Perches } 65582c92488aSJoe Perches 6559179f8f40SJoe Perches# check for comparisons against true and false 6560179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 6561179f8f40SJoe Perches my $lead = $1; 6562179f8f40SJoe Perches my $arg = $2; 6563179f8f40SJoe Perches my $test = $3; 6564179f8f40SJoe Perches my $otype = $4; 6565179f8f40SJoe Perches my $trail = $5; 6566179f8f40SJoe Perches my $op = "!"; 6567179f8f40SJoe Perches 6568179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 6569179f8f40SJoe Perches 6570179f8f40SJoe Perches my $type = lc($otype); 6571179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 6572179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 6573179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 6574179f8f40SJoe Perches $op = ""; 6575179f8f40SJoe Perches } 6576179f8f40SJoe Perches 6577179f8f40SJoe Perches CHK("BOOL_COMPARISON", 6578179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 6579179f8f40SJoe Perches 6580179f8f40SJoe Perches## maybe suggesting a correct construct would better 6581179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 6582179f8f40SJoe Perches 6583179f8f40SJoe Perches } 6584179f8f40SJoe Perches } 6585179f8f40SJoe Perches 65864882720bSThomas Gleixner# check for semaphores initialized locked 65874882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 6588000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 6589000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 6590773647a0SAndy Whitcroft } 65916712d858SJoe Perches 659267d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 659367d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 6594000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 659567d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 6596773647a0SAndy Whitcroft } 65976712d858SJoe Perches 6598ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 6599f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 6600000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 6601ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 6602f3db6639SMichael Ellerman } 66036712d858SJoe Perches 66043d709ab5SPaul E. McKenney# check for spin_is_locked(), suggest lockdep instead 66053d709ab5SPaul E. McKenney if ($line =~ /\bspin_is_locked\(/) { 66063d709ab5SPaul E. McKenney WARN("USE_LOCKDEP", 66073d709ab5SPaul E. McKenney "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr); 66083d709ab5SPaul E. McKenney } 66093d709ab5SPaul E. McKenney 66109189c7e7SJoe Perches# check for deprecated apis 66119189c7e7SJoe Perches if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) { 66129189c7e7SJoe Perches my $deprecated_api = $1; 66139189c7e7SJoe Perches my $new_api = $deprecated_apis{$deprecated_api}; 66149189c7e7SJoe Perches WARN("DEPRECATED_API", 66159189c7e7SJoe Perches "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr); 66169189c7e7SJoe Perches } 66179189c7e7SJoe Perches 66180f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 6619d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 66206903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 6621d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 6622000d1cc1SJoe Perches WARN("CONST_STRUCT", 6623d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 66242b6db5cbSAndy Whitcroft } 6625773647a0SAndy Whitcroft 6626773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 6627773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 6628773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 6629c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 6630c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 6631171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 6632171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 6633171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 6634773647a0SAndy Whitcroft { 6635000d1cc1SJoe Perches WARN("NR_CPUS", 6636000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 6637773647a0SAndy Whitcroft } 66389c9ba34eSAndy Whitcroft 663952ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 664052ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 664152ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 664252ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 664352ea8506SJoe Perches } 664452ea8506SJoe Perches 6645acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 66465b57980dSJoe Perches if ($perl_version_ok && 6647acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 6648acd9362cSJoe Perches WARN("LIKELY_MISUSE", 6649acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 6650acd9362cSJoe Perches } 6651acd9362cSJoe Perches 6652de3f186fSDenis Efremov# nested likely/unlikely calls 6653de3f186fSDenis Efremov if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) { 6654de3f186fSDenis Efremov WARN("LIKELY_MISUSE", 6655de3f186fSDenis Efremov "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr); 6656de3f186fSDenis Efremov } 6657de3f186fSDenis Efremov 6658691d77b6SAndy Whitcroft# whine mightly about in_atomic 6659691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 6660691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 6661000d1cc1SJoe Perches ERROR("IN_ATOMIC", 6662000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 6663f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 6664000d1cc1SJoe Perches WARN("IN_ATOMIC", 6665000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 6666691d77b6SAndy Whitcroft } 6667691d77b6SAndy Whitcroft } 66681704f47bSPeter Zijlstra 66690f5225b0SPeter Zijlstra# check for mutex_trylock_recursive usage 66700f5225b0SPeter Zijlstra if ($line =~ /mutex_trylock_recursive/) { 66710f5225b0SPeter Zijlstra ERROR("LOCKING", 66720f5225b0SPeter Zijlstra "recursive locking is bad, do not use this ever.\n" . $herecurr); 66730f5225b0SPeter Zijlstra } 66740f5225b0SPeter Zijlstra 66751704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 66761704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 66771704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 66781704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 66791704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 66801704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 6681000d1cc1SJoe Perches ERROR("LOCKDEP", 6682000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 66831704f47bSPeter Zijlstra } 66841704f47bSPeter Zijlstra } 668588f8831cSDave Jones 6686b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 6687b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 6688000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 6689000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 669088f8831cSDave Jones } 66912435880fSJoe Perches 669200180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 669300180468SJoe Perches# and whether or not function naming is typical and if 669400180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 66955b57980dSJoe Perches if ($perl_version_ok && 669600180468SJoe Perches defined $stat && 669700180468SJoe 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*\)/) { 669800180468SJoe Perches my $var = $1; 669900180468SJoe Perches my $perms = $2; 670000180468SJoe Perches my $show = $3; 670100180468SJoe Perches my $store = $4; 670200180468SJoe Perches my $octal_perms = perms_to_octal($perms); 670300180468SJoe Perches if ($show =~ /^${var}_show$/ && 670400180468SJoe Perches $store =~ /^${var}_store$/ && 670500180468SJoe Perches $octal_perms eq "0644") { 670600180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 670700180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 670800180468SJoe Perches $fix) { 670900180468SJoe 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})/; 671000180468SJoe Perches } 671100180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 671200180468SJoe Perches $store =~ /^NULL$/ && 671300180468SJoe Perches $octal_perms eq "0444") { 671400180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 671500180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 671600180468SJoe Perches $fix) { 671700180468SJoe 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})/; 671800180468SJoe Perches } 671900180468SJoe Perches } elsif ($show =~ /^NULL$/ && 672000180468SJoe Perches $store =~ /^${var}_store$/ && 672100180468SJoe Perches $octal_perms eq "0200") { 672200180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 672300180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 672400180468SJoe Perches $fix) { 672500180468SJoe 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})/; 672600180468SJoe Perches } 672700180468SJoe Perches } elsif ($octal_perms eq "0644" || 672800180468SJoe Perches $octal_perms eq "0444" || 672900180468SJoe Perches $octal_perms eq "0200") { 673000180468SJoe Perches my $newshow = "$show"; 673100180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 673200180468SJoe Perches my $newstore = $store; 673300180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 673400180468SJoe Perches my $rename = ""; 673500180468SJoe Perches if ($show ne $newshow) { 673600180468SJoe Perches $rename .= " '$show' to '$newshow'"; 673700180468SJoe Perches } 673800180468SJoe Perches if ($store ne $newstore) { 673900180468SJoe Perches $rename .= " '$store' to '$newstore'"; 674000180468SJoe Perches } 674100180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 674200180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 674300180468SJoe Perches } else { 674400180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 674500180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 674600180468SJoe Perches } 674700180468SJoe Perches } 674800180468SJoe Perches 6749515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 6750515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 675173121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 675273121534SJoe Perches# specific definition of not visible in sysfs. 675373121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 675473121534SJoe Perches# use the default permissions 67555b57980dSJoe Perches if ($perl_version_ok && 6756459cf0aeSJoe Perches defined $stat && 6757515a235eSJoe Perches $line =~ /$mode_perms_search/) { 67582435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 67592435880fSJoe Perches my $func = $entry->[0]; 67602435880fSJoe Perches my $arg_pos = $entry->[1]; 67612435880fSJoe Perches 6762459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 6763459cf0aeSJoe Perches $lc = $lc + $linenr; 67642a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6765459cf0aeSJoe Perches 67662435880fSJoe Perches my $skip_args = ""; 67672435880fSJoe Perches if ($arg_pos > 1) { 67682435880fSJoe Perches $arg_pos--; 67692435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 67702435880fSJoe Perches } 6771f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 6772459cf0aeSJoe Perches if ($stat =~ /$test/) { 67732435880fSJoe Perches my $val = $1; 67742435880fSJoe Perches $val = $6 if ($skip_args ne ""); 677573121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 677673121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 677773121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 67782435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 6779459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 6780f90774e1SJoe Perches } 6781f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6782c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6783459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 67842435880fSJoe Perches } 6785459cf0aeSJoe Perches } 6786459cf0aeSJoe Perches } 6787459cf0aeSJoe Perches } 6788459cf0aeSJoe Perches 6789459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 6790bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 679100180468SJoe Perches my $oval = $1; 679200180468SJoe Perches my $octal = perms_to_octal($oval); 6793f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 6794459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 6795f90774e1SJoe Perches $fix) { 679600180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 67972435880fSJoe Perches } 679813214adfSAndy Whitcroft } 67995a6d20ceSBjorn Andersson 68005a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 68015a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 68025a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 68035a6d20ceSBjorn Andersson my $valid_licenses = qr{ 68045a6d20ceSBjorn Andersson GPL| 68055a6d20ceSBjorn Andersson GPL\ v2| 68065a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 68075a6d20ceSBjorn Andersson Dual\ BSD/GPL| 68085a6d20ceSBjorn Andersson Dual\ MIT/GPL| 68095a6d20ceSBjorn Andersson Dual\ MPL/GPL| 68105a6d20ceSBjorn Andersson Proprietary 68115a6d20ceSBjorn Andersson }x; 68125a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 68135a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 68145a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 68155a6d20ceSBjorn Andersson } 68165a6d20ceSBjorn Andersson } 68176a8d76cbSMatteo Croce 68186a8d76cbSMatteo Croce# check for sysctl duplicate constants 68196a8d76cbSMatteo Croce if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) { 68206a8d76cbSMatteo Croce WARN("DUPLICATED_SYSCTL_CONST", 68216a8d76cbSMatteo Croce "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr); 68226a8d76cbSMatteo Croce } 6823515a235eSJoe Perches } 682413214adfSAndy Whitcroft 682513214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 682613214adfSAndy Whitcroft # so just keep quiet. 682713214adfSAndy Whitcroft if ($#rawlines == -1) { 682813214adfSAndy Whitcroft exit(0); 68290a920b5bSAndy Whitcroft } 68300a920b5bSAndy Whitcroft 68318905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 68328905a67cSAndy Whitcroft # things that appear to be patches. 68338905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 68348905a67cSAndy Whitcroft exit(0); 68358905a67cSAndy Whitcroft } 68368905a67cSAndy Whitcroft 68378905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 68388905a67cSAndy Whitcroft # just keep quiet. 68398905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 68408905a67cSAndy Whitcroft exit(0); 68418905a67cSAndy Whitcroft } 68428905a67cSAndy Whitcroft 6843a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 6844000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6845000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 68460a920b5bSAndy Whitcroft } 6847cd261496SGeert Uytterhoeven if ($is_patch && $has_commit_log && $chk_signoff) { 6848cd261496SGeert Uytterhoeven if ($signoff == 0) { 6849000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6850000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 6851cd261496SGeert Uytterhoeven } elsif (!$authorsignoff) { 6852cd261496SGeert Uytterhoeven WARN("NO_AUTHOR_SIGN_OFF", 6853cd261496SGeert Uytterhoeven "Missing Signed-off-by: line by nominal patch author '$author'\n"); 6854cd261496SGeert Uytterhoeven } 68550a920b5bSAndy Whitcroft } 68560a920b5bSAndy Whitcroft 6857f0a594c1SAndy Whitcroft print report_dump(); 685813214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 685913214adfSAndy Whitcroft print "$filename " if ($summary_file); 68606c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 68616c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 68626c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 68636c72ffaaSAndy Whitcroft } 68648905a67cSAndy Whitcroft 6865d2c0a235SAndy Whitcroft if ($quiet == 0) { 6866ef212196SJoe Perches # If there were any defects found and not already fixing them 6867ef212196SJoe Perches if (!$clean and !$fix) { 6868ef212196SJoe Perches print << "EOM" 6869ef212196SJoe Perches 6870ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 6871ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 6872ef212196SJoe PerchesEOM 6873ef212196SJoe Perches } 6874d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 6875d2c0a235SAndy Whitcroft # then suggest that. 6876d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 6877b0781216SMike Frysinger $rpt_cleaners = 0; 6878d8469f16SJoe Perches print << "EOM" 6879d8469f16SJoe Perches 6880d8469f16SJoe PerchesNOTE: Whitespace errors detected. 6881d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 6882d8469f16SJoe PerchesEOM 6883d2c0a235SAndy Whitcroft } 6884d2c0a235SAndy Whitcroft } 6885d2c0a235SAndy Whitcroft 6886d752fcc8SJoe Perches if ($clean == 0 && $fix && 6887d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 6888d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 68899624b8d6SJoe Perches my $newfile = $filename; 68909624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 68913705ce5bSJoe Perches my $linecount = 0; 68923705ce5bSJoe Perches my $f; 68933705ce5bSJoe Perches 6894d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 6895d752fcc8SJoe Perches 68963705ce5bSJoe Perches open($f, '>', $newfile) 68973705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 68983705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 68993705ce5bSJoe Perches $linecount++; 69003705ce5bSJoe Perches if ($file) { 69013705ce5bSJoe Perches if ($linecount > 3) { 69023705ce5bSJoe Perches $fixed_line =~ s/^\+//; 69033705ce5bSJoe Perches print $f $fixed_line . "\n"; 69043705ce5bSJoe Perches } 69053705ce5bSJoe Perches } else { 69063705ce5bSJoe Perches print $f $fixed_line . "\n"; 69073705ce5bSJoe Perches } 69083705ce5bSJoe Perches } 69093705ce5bSJoe Perches close($f); 69103705ce5bSJoe Perches 69113705ce5bSJoe Perches if (!$quiet) { 69123705ce5bSJoe Perches print << "EOM"; 6913d8469f16SJoe Perches 69143705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 69153705ce5bSJoe Perches 69163705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 69173705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 69183705ce5bSJoe Perches 69193705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 69203705ce5bSJoe PerchesNo warranties, expressed or implied... 69213705ce5bSJoe PerchesEOM 69223705ce5bSJoe Perches } 69233705ce5bSJoe Perches } 69243705ce5bSJoe Perches 6925d8469f16SJoe Perches if ($quiet == 0) { 6926d8469f16SJoe Perches print "\n"; 6927d8469f16SJoe Perches if ($clean == 1) { 6928d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 6929d8469f16SJoe Perches } else { 6930d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 69310a920b5bSAndy Whitcroft } 69320a920b5bSAndy Whitcroft } 69330a920b5bSAndy Whitcroft return $clean; 69340a920b5bSAndy Whitcroft} 6935