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"; 62*ced69da1SQuentin Monnetmy $typedefsfile; 63737c0767SJohn Brooksmy $color = "auto"; 6498005e8cSVadim Bendeburymy $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE 65dbbf869dSJoe Perches# git output parsing needs US English output, so first set backtick child process LANGUAGE 66dbbf869dSJoe Perchesmy $git_command ='export LANGUAGE=en_US.UTF-8; git'; 67713a09deSAntonio Borneomy $tabsize = 8; 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 24932f30ca9SJoe Perchesdie "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix)); 25032f30ca9SJoe Perches 2510a920b5bSAndy Whitcroftmy $exit = 0; 2520a920b5bSAndy Whitcroft 2535b57980dSJoe Perchesmy $perl_version_ok = 1; 254d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 2555b57980dSJoe Perches $perl_version_ok = 0; 256d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 2575b57980dSJoe Perches exit(1) if (!$ignore_perl_version); 258d62a201fSDave Hansen} 259d62a201fSDave Hansen 26045107ff6SAllen Hubbe#if no filenames are given, push '-' to read patch from stdin 2610a920b5bSAndy Whitcroftif ($#ARGV < 0) { 26245107ff6SAllen Hubbe push(@ARGV, '-'); 2630a920b5bSAndy Whitcroft} 2640a920b5bSAndy Whitcroft 265737c0767SJohn Brooksif ($color =~ /^[01]$/) { 266737c0767SJohn Brooks $color = !$color; 267737c0767SJohn Brooks} elsif ($color =~ /^always$/i) { 268737c0767SJohn Brooks $color = 1; 269737c0767SJohn Brooks} elsif ($color =~ /^never$/i) { 270737c0767SJohn Brooks $color = 0; 271737c0767SJohn Brooks} elsif ($color =~ /^auto$/i) { 272737c0767SJohn Brooks $color = (-t STDOUT); 273737c0767SJohn Brooks} else { 27432f30ca9SJoe Perches die "$P: Invalid color mode: $color\n"; 275737c0767SJohn Brooks} 276737c0767SJohn Brooks 277713a09deSAntonio Borneo# skip TAB size 1 to avoid additional checks on $tabsize - 1 27832f30ca9SJoe Perchesdie "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2); 279713a09deSAntonio Borneo 28091bfe484SJoe Perchessub hash_save_array_words { 28191bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 28291bfe484SJoe Perches 28391bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 28491bfe484SJoe Perches foreach my $word (@array) { 285000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 286000d1cc1SJoe Perches $word =~ s/^\s*//g; 287000d1cc1SJoe Perches $word =~ s/\s+/ /g; 288000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 289000d1cc1SJoe Perches 290000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 291000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 292000d1cc1SJoe Perches 29391bfe484SJoe Perches $hashRef->{$word}++; 294000d1cc1SJoe Perches } 29591bfe484SJoe Perches} 29691bfe484SJoe Perches 29791bfe484SJoe Perchessub hash_show_words { 29891bfe484SJoe Perches my ($hashRef, $prefix) = @_; 29991bfe484SJoe Perches 3003c816e49SJoe Perches if (keys %$hashRef) { 301d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 30258cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 30391bfe484SJoe Perches print " $word"; 30491bfe484SJoe Perches } 305d8469f16SJoe Perches print "\n"; 30691bfe484SJoe Perches } 30791bfe484SJoe Perches} 30891bfe484SJoe Perches 30991bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 31091bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 311000d1cc1SJoe Perches 312c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 313c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 3147429c690SAndy Whitcroftmy $dbg_type = 0; 315a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 316c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 31721caa13cSAndy Whitcroft ## no critic 31821caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 31921caa13cSAndy Whitcroft die "$@" if ($@); 320c2fdda0dSAndy Whitcroft} 321c2fdda0dSAndy Whitcroft 322d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 323d2c0a235SAndy Whitcroft 3248905a67cSAndy Whitcroftif ($terse) { 3258905a67cSAndy Whitcroft $emacs = 1; 3268905a67cSAndy Whitcroft $quiet++; 3278905a67cSAndy Whitcroft} 3288905a67cSAndy Whitcroft 3296c72ffaaSAndy Whitcroftif ($tree) { 3306c72ffaaSAndy Whitcroft if (defined $root) { 3316c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 3326c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 3336c72ffaaSAndy Whitcroft } 3346c72ffaaSAndy Whitcroft } else { 3356c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 3366c72ffaaSAndy Whitcroft $root = '.'; 3376c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 3386c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 3396c72ffaaSAndy Whitcroft $root = $1; 3406c72ffaaSAndy Whitcroft } 3416c72ffaaSAndy Whitcroft } 3426c72ffaaSAndy Whitcroft 3436c72ffaaSAndy Whitcroft if (!defined $root) { 3440a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 3450a920b5bSAndy Whitcroft exit(2); 3460a920b5bSAndy Whitcroft } 3476c72ffaaSAndy Whitcroft} 3486c72ffaaSAndy Whitcroft 3496c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 3506c72ffaaSAndy Whitcroft 3512ceb532bSAndy Whitcroftour $Ident = qr{ 3522ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 3532ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 3542ceb532bSAndy Whitcroft }x; 3556c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 3566c72ffaaSAndy Whitcroftour $Sparse = qr{ 3576c72ffaaSAndy Whitcroft __user| 3586c72ffaaSAndy Whitcroft __kernel| 3596c72ffaaSAndy Whitcroft __force| 3606c72ffaaSAndy Whitcroft __iomem| 3616c72ffaaSAndy Whitcroft __must_check| 362417495edSAndy Whitcroft __kprobes| 363165e72a6SSven Eckelmann __ref| 36433aa4597SGeert Uytterhoeven __refconst| 36533aa4597SGeert Uytterhoeven __refdata| 366ad315455SBoqun Feng __rcu| 367ad315455SBoqun Feng __private 3686c72ffaaSAndy Whitcroft }x; 369e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 370e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 371e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 372e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 373e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 3748716de38SJoe Perches 37552131292SWolfram Sang# Notes to $Attribute: 37652131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 3776c72ffaaSAndy Whitcroftour $Attribute = qr{ 3786c72ffaaSAndy Whitcroft const| 37903f1df7dSJoe Perches __percpu| 38003f1df7dSJoe Perches __nocast| 38103f1df7dSJoe Perches __safe| 38246d832f5SMichael S. Tsirkin __bitwise| 38303f1df7dSJoe Perches __packed__| 38403f1df7dSJoe Perches __packed2__| 38503f1df7dSJoe Perches __naked| 38603f1df7dSJoe Perches __maybe_unused| 38703f1df7dSJoe Perches __always_unused| 38803f1df7dSJoe Perches __noreturn| 38903f1df7dSJoe Perches __used| 39003f1df7dSJoe Perches __cold| 391e23ef1f3SJoe Perches __pure| 39203f1df7dSJoe Perches __noclone| 39303f1df7dSJoe Perches __deprecated| 3946c72ffaaSAndy Whitcroft __read_mostly| 395c5967e98SJoe Perches __ro_after_init| 3966c72ffaaSAndy Whitcroft __kprobes| 3978716de38SJoe Perches $InitAttribute| 39824e1d81aSAndy Whitcroft ____cacheline_aligned| 39924e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 4005fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 4015fe3af11SAndy Whitcroft __weak 4026c72ffaaSAndy Whitcroft }x; 403c45dcabdSAndy Whitcroftour $Modifier; 40491cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 4056c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 4066c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 4076c72ffaaSAndy Whitcroft 40895e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 40995e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 41095e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 41195e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 4122435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 413c0a5c898SJoe Perchesour $String = qr{"[X\t]*"}; 414326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 415326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 416326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 41774349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 4182435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 419326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 420447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 42123f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 4226c72ffaaSAndy Whitcroftour $Operators = qr{ 4236c72ffaaSAndy Whitcroft <=|>=|==|!=| 4246c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 42523f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 4266c72ffaaSAndy Whitcroft }x; 4276c72ffaaSAndy Whitcroft 42891cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 42991cb5195SJoe Perches 430ab7e23f3SJoe Perchesour $BasicType; 4318905a67cSAndy Whitcroftour $NonptrType; 4321813087dSJoe Perchesour $NonptrTypeMisordered; 4338716de38SJoe Perchesour $NonptrTypeWithAttr; 4348905a67cSAndy Whitcroftour $Type; 4351813087dSJoe Perchesour $TypeMisordered; 4368905a67cSAndy Whitcroftour $Declare; 4371813087dSJoe Perchesour $DeclareMisordered; 4388905a67cSAndy Whitcroft 43915662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 44015662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 441171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 442171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 443171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 444171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 445171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 446171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 447171ae1a4SAndy Whitcroft}x; 448171ae1a4SAndy Whitcroft 44915662b3eSJoe Perchesour $UTF8 = qr{ 45015662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 45115662b3eSJoe Perches | $NON_ASCII_UTF8 45215662b3eSJoe Perches}x; 45315662b3eSJoe Perches 454e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 455021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 456021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 457021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 458021158b4SJoe Perches)}; 459e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 460fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 4618ed22cadSAndy Whitcroft atomic_t 4628ed22cadSAndy Whitcroft)}; 463e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 464e6176fa4SJoe Perches $typeC99Typedefs\b| 465e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 466e6176fa4SJoe Perches $typeKernelTypedefs\b 467e6176fa4SJoe Perches)}; 4688ed22cadSAndy Whitcroft 4696d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 4706d32f7a3SJoe Perches 471691e669bSJoe Perchesour $logFunctions = qr{(?x: 472758d7aadSMiles Chen printk(?:_ratelimited|_once|_deferred_once|_deferred|)| 4737d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 47487bd499aSJoe Perches TP_printk| 4756e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 476b0531722SJoe Perches panic| 47706668727SJoe Perches MODULE_[A-Z_]+| 47806668727SJoe Perches seq_vprintf|seq_printf|seq_puts 479691e669bSJoe Perches)}; 480691e669bSJoe Perches 481e29a70f1SJoe Perchesour $allocFunctions = qr{(?x: 482e29a70f1SJoe Perches (?:(?:devm_)? 483e29a70f1SJoe Perches (?:kv|k|v)[czm]alloc(?:_node|_array)? | 484e29a70f1SJoe Perches kstrdup(?:_const)? | 485e29a70f1SJoe Perches kmemdup(?:_nul)?) | 486461e1565SChristophe JAILLET (?:\w+)?alloc_skb(?:_ip_align)? | 487e29a70f1SJoe Perches # dev_alloc_skb/netdev_alloc_skb, et al 488e29a70f1SJoe Perches dma_alloc_coherent 489e29a70f1SJoe Perches)}; 490e29a70f1SJoe Perches 49120112475SJoe Perchesour $signature_tags = qr{(?xi: 49220112475SJoe Perches Signed-off-by:| 493d499480cSJorge Ramirez-Ortiz Co-developed-by:| 49420112475SJoe Perches Acked-by:| 49520112475SJoe Perches Tested-by:| 49620112475SJoe Perches Reviewed-by:| 49720112475SJoe Perches Reported-by:| 4988543ae12SMugunthan V N Suggested-by:| 49920112475SJoe Perches To:| 50020112475SJoe Perches Cc: 50120112475SJoe Perches)}; 50220112475SJoe Perches 5031813087dSJoe Perchesour @typeListMisordered = ( 5041813087dSJoe Perches qr{char\s+(?:un)?signed}, 5051813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 5061813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 5071813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 5081813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 5091813087dSJoe Perches qr{short\s+(?:un)?signed}, 5101813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 5111813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 5121813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 5131813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 5141813087dSJoe Perches qr{int\s+(?:un)?signed}, 5151813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 5161813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 5171813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 5181813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 5191813087dSJoe Perches qr{long\s+(?:un)?signed}, 5201813087dSJoe Perches); 5211813087dSJoe Perches 5228905a67cSAndy Whitcroftour @typeList = ( 5238905a67cSAndy Whitcroft qr{void}, 5240c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 5250c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 5260c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 5270c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 5280c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 5290c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 5300c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 5310c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 5320c773d9dSJoe Perches qr{(?:un)?signed}, 5338905a67cSAndy Whitcroft qr{float}, 5348905a67cSAndy Whitcroft qr{double}, 5358905a67cSAndy Whitcroft qr{bool}, 5368905a67cSAndy Whitcroft qr{struct\s+$Ident}, 5378905a67cSAndy Whitcroft qr{union\s+$Ident}, 5388905a67cSAndy Whitcroft qr{enum\s+$Ident}, 5398905a67cSAndy Whitcroft qr{${Ident}_t}, 5408905a67cSAndy Whitcroft qr{${Ident}_handler}, 5418905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 5421813087dSJoe Perches @typeListMisordered, 5438905a67cSAndy Whitcroft); 544938224b5SJoe Perches 545938224b5SJoe Perchesour $C90_int_types = qr{(?x: 546938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 547938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 548938224b5SJoe Perches long\s+long\s+(?:un)?signed| 549938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 550938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 551938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 552938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 553938224b5SJoe Perches 554938224b5SJoe Perches long\s+int\s+(?:un)?signed| 555938224b5SJoe Perches long\s+(?:un)?signed\s+int| 556938224b5SJoe Perches long\s+(?:un)?signed| 557938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 558938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 559938224b5SJoe Perches int\s+long\s+(?:un)?signed| 560938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 561938224b5SJoe Perches 562938224b5SJoe Perches int\s+(?:un)?signed| 563938224b5SJoe Perches (?:(?:un)?signed\s+)?int 564938224b5SJoe Perches)}; 565938224b5SJoe Perches 566485ff23eSAlex Dowadour @typeListFile = (); 5678716de38SJoe Perchesour @typeListWithAttr = ( 5688716de38SJoe Perches @typeList, 5698716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 5708716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 5718716de38SJoe Perches); 5728716de38SJoe Perches 573c45dcabdSAndy Whitcroftour @modifierList = ( 574c45dcabdSAndy Whitcroft qr{fastcall}, 575c45dcabdSAndy Whitcroft); 576485ff23eSAlex Dowadour @modifierListFile = (); 5778905a67cSAndy Whitcroft 5782435880fSJoe Perchesour @mode_permission_funcs = ( 5792435880fSJoe Perches ["module_param", 3], 5802435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 5812435880fSJoe Perches ["module_param_array_named", 5], 5822435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 5832435880fSJoe Perches ["proc_create(?:_data|)", 2], 584459cf0aeSJoe Perches ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2], 585459cf0aeSJoe Perches ["IIO_DEV_ATTR_[A-Z_]+", 1], 586459cf0aeSJoe Perches ["SENSOR_(?:DEVICE_|)ATTR_2", 2], 587459cf0aeSJoe Perches ["SENSOR_TEMPLATE(?:_2|)", 3], 588459cf0aeSJoe Perches ["__ATTR", 2], 5892435880fSJoe Perches); 5902435880fSJoe Perches 591515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 592515a235eSJoe Perchesour $mode_perms_search = ""; 593515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 594515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 595515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 596515a235eSJoe Perches} 59700180468SJoe Perches$mode_perms_search = "(?:${mode_perms_search})"; 598515a235eSJoe Perches 5999189c7e7SJoe Perchesour %deprecated_apis = ( 6009189c7e7SJoe Perches "synchronize_rcu_bh" => "synchronize_rcu", 6019189c7e7SJoe Perches "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited", 6029189c7e7SJoe Perches "call_rcu_bh" => "call_rcu", 6039189c7e7SJoe Perches "rcu_barrier_bh" => "rcu_barrier", 6049189c7e7SJoe Perches "synchronize_sched" => "synchronize_rcu", 6059189c7e7SJoe Perches "synchronize_sched_expedited" => "synchronize_rcu_expedited", 6069189c7e7SJoe Perches "call_rcu_sched" => "call_rcu", 6079189c7e7SJoe Perches "rcu_barrier_sched" => "rcu_barrier", 6089189c7e7SJoe Perches "get_state_synchronize_sched" => "get_state_synchronize_rcu", 6099189c7e7SJoe Perches "cond_synchronize_sched" => "cond_synchronize_rcu", 6109189c7e7SJoe Perches); 6119189c7e7SJoe Perches 6129189c7e7SJoe Perches#Create a search pattern for all these strings to speed up a loop below 6139189c7e7SJoe Perchesour $deprecated_apis_search = ""; 6149189c7e7SJoe Perchesforeach my $entry (keys %deprecated_apis) { 6159189c7e7SJoe Perches $deprecated_apis_search .= '|' if ($deprecated_apis_search ne ""); 6169189c7e7SJoe Perches $deprecated_apis_search .= $entry; 6179189c7e7SJoe Perches} 6189189c7e7SJoe Perches$deprecated_apis_search = "(?:${deprecated_apis_search})"; 6199189c7e7SJoe Perches 620b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 621b392c64fSJoe Perches S_IWUGO | 622b392c64fSJoe Perches S_IWOTH | 623b392c64fSJoe Perches S_IRWXUGO | 624b392c64fSJoe Perches S_IALLUGO | 625b392c64fSJoe Perches 0[0-7][0-7][2367] 626b392c64fSJoe Perches}x; 627b392c64fSJoe Perches 628f90774e1SJoe Perchesour %mode_permission_string_types = ( 629f90774e1SJoe Perches "S_IRWXU" => 0700, 630f90774e1SJoe Perches "S_IRUSR" => 0400, 631f90774e1SJoe Perches "S_IWUSR" => 0200, 632f90774e1SJoe Perches "S_IXUSR" => 0100, 633f90774e1SJoe Perches "S_IRWXG" => 0070, 634f90774e1SJoe Perches "S_IRGRP" => 0040, 635f90774e1SJoe Perches "S_IWGRP" => 0020, 636f90774e1SJoe Perches "S_IXGRP" => 0010, 637f90774e1SJoe Perches "S_IRWXO" => 0007, 638f90774e1SJoe Perches "S_IROTH" => 0004, 639f90774e1SJoe Perches "S_IWOTH" => 0002, 640f90774e1SJoe Perches "S_IXOTH" => 0001, 641f90774e1SJoe Perches "S_IRWXUGO" => 0777, 642f90774e1SJoe Perches "S_IRUGO" => 0444, 643f90774e1SJoe Perches "S_IWUGO" => 0222, 644f90774e1SJoe Perches "S_IXUGO" => 0111, 645f90774e1SJoe Perches); 646f90774e1SJoe Perches 647f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below 648f90774e1SJoe Perchesour $mode_perms_string_search = ""; 649f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) { 650f90774e1SJoe Perches $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); 651f90774e1SJoe Perches $mode_perms_string_search .= $entry; 652f90774e1SJoe Perches} 65300180468SJoe Perchesour $single_mode_perms_string_search = "(?:${mode_perms_string_search})"; 65400180468SJoe Perchesour $multi_mode_perms_string_search = qr{ 65500180468SJoe Perches ${single_mode_perms_string_search} 65600180468SJoe Perches (?:\s*\|\s*${single_mode_perms_string_search})* 65700180468SJoe Perches}x; 65800180468SJoe Perches 65900180468SJoe Perchessub perms_to_octal { 66000180468SJoe Perches my ($string) = @_; 66100180468SJoe Perches 66200180468SJoe Perches return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/); 66300180468SJoe Perches 66400180468SJoe Perches my $val = ""; 66500180468SJoe Perches my $oval = ""; 66600180468SJoe Perches my $to = 0; 66700180468SJoe Perches my $curpos = 0; 66800180468SJoe Perches my $lastpos = 0; 66900180468SJoe Perches while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) { 67000180468SJoe Perches $curpos = pos($string); 67100180468SJoe Perches my $match = $2; 67200180468SJoe Perches my $omatch = $1; 67300180468SJoe Perches last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos)); 67400180468SJoe Perches $lastpos = $curpos; 67500180468SJoe Perches $to |= $mode_permission_string_types{$match}; 67600180468SJoe Perches $val .= '\s*\|\s*' if ($val ne ""); 67700180468SJoe Perches $val .= $match; 67800180468SJoe Perches $oval .= $omatch; 67900180468SJoe Perches } 68000180468SJoe Perches $oval =~ s/^\s*\|\s*//; 68100180468SJoe Perches $oval =~ s/\s*\|\s*$//; 68200180468SJoe Perches return sprintf("%04o", $to); 68300180468SJoe Perches} 684f90774e1SJoe Perches 6857840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 6867840a94cSWolfram Sang irq| 687cdcee686SSergey Ryazanov memory| 688cdcee686SSergey Ryazanov time| 689cdcee686SSergey Ryazanov reboot 6907840a94cSWolfram Sang)}; 6917840a94cSWolfram Sang# memory.h: ARM has a custom one 6927840a94cSWolfram Sang 69366b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 69466b47b4aSKees Cookmy $misspellings; 69566b47b4aSKees Cookmy %spelling_fix; 69636061e38SJoe Perches 69736061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 69866b47b4aSKees Cook while (<$spelling>) { 69966b47b4aSKees Cook my $line = $_; 70066b47b4aSKees Cook 70166b47b4aSKees Cook $line =~ s/\s*\n?$//g; 70266b47b4aSKees Cook $line =~ s/^\s*//g; 70366b47b4aSKees Cook 70466b47b4aSKees Cook next if ($line =~ m/^\s*#/); 70566b47b4aSKees Cook next if ($line =~ m/^\s*$/); 70666b47b4aSKees Cook 70766b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 70866b47b4aSKees Cook 70966b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 71066b47b4aSKees Cook } 71166b47b4aSKees Cook close($spelling); 71236061e38SJoe Perches} else { 71336061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 71436061e38SJoe Perches} 71566b47b4aSKees Cook 716ebfd7d62SJoe Perchesif ($codespell) { 717ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 718ebfd7d62SJoe Perches while (<$spelling>) { 719ebfd7d62SJoe Perches my $line = $_; 720ebfd7d62SJoe Perches 721ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 722ebfd7d62SJoe Perches $line =~ s/^\s*//g; 723ebfd7d62SJoe Perches 724ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 725ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 726ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 727ebfd7d62SJoe Perches 728ebfd7d62SJoe Perches $line =~ s/,.*$//; 729ebfd7d62SJoe Perches 730ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 731ebfd7d62SJoe Perches 732ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 733ebfd7d62SJoe Perches } 734ebfd7d62SJoe Perches close($spelling); 735ebfd7d62SJoe Perches } else { 736ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 737ebfd7d62SJoe Perches } 738ebfd7d62SJoe Perches} 739ebfd7d62SJoe Perches 740ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 741ebfd7d62SJoe Perches 74275ad8c57SJerome Forissiersub read_words { 74375ad8c57SJerome Forissier my ($wordsRef, $file) = @_; 74475ad8c57SJerome Forissier 74575ad8c57SJerome Forissier if (open(my $words, '<', $file)) { 74675ad8c57SJerome Forissier while (<$words>) { 747bf1fa1daSJoe Perches my $line = $_; 748bf1fa1daSJoe Perches 749bf1fa1daSJoe Perches $line =~ s/\s*\n?$//g; 750bf1fa1daSJoe Perches $line =~ s/^\s*//g; 751bf1fa1daSJoe Perches 752bf1fa1daSJoe Perches next if ($line =~ m/^\s*#/); 753bf1fa1daSJoe Perches next if ($line =~ m/^\s*$/); 754bf1fa1daSJoe Perches if ($line =~ /\s/) { 75575ad8c57SJerome Forissier print("$file: '$line' invalid - ignored\n"); 756bf1fa1daSJoe Perches next; 757bf1fa1daSJoe Perches } 758bf1fa1daSJoe Perches 759*ced69da1SQuentin Monnet $$wordsRef .= '|' if (defined $$wordsRef); 76075ad8c57SJerome Forissier $$wordsRef .= $line; 761bf1fa1daSJoe Perches } 76275ad8c57SJerome Forissier close($file); 76375ad8c57SJerome Forissier return 1; 764bf1fa1daSJoe Perches } 765bf1fa1daSJoe Perches 76675ad8c57SJerome Forissier return 0; 76775ad8c57SJerome Forissier} 76875ad8c57SJerome Forissier 769*ced69da1SQuentin Monnetmy $const_structs; 770*ced69da1SQuentin Monnetif (show_type("CONST_STRUCT")) { 77175ad8c57SJerome Forissier read_words(\$const_structs, $conststructsfile) 77275ad8c57SJerome Forissier or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 773*ced69da1SQuentin Monnet} 77475ad8c57SJerome Forissier 775*ced69da1SQuentin Monnetif (defined($typedefsfile)) { 776*ced69da1SQuentin Monnet my $typeOtherTypedefs; 77775ad8c57SJerome Forissier read_words(\$typeOtherTypedefs, $typedefsfile) 77875ad8c57SJerome Forissier or warn "No additional types will be considered - file '$typedefsfile': $!\n"; 779*ced69da1SQuentin Monnet $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs); 78075ad8c57SJerome Forissier} 78175ad8c57SJerome Forissier 7828905a67cSAndy Whitcroftsub build_types { 783485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 784485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 7851813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 7868716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 787c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 788ab7e23f3SJoe Perches $BasicType = qr{ 789ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 790ab7e23f3SJoe Perches (?:${all}\b) 791ab7e23f3SJoe Perches }x; 7928905a67cSAndy Whitcroft $NonptrType = qr{ 793d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 794cf655043SAndy Whitcroft (?: 7956b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 7968ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 797c45dcabdSAndy Whitcroft (?:${all}\b) 798cf655043SAndy Whitcroft ) 799c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 8008905a67cSAndy Whitcroft }x; 8011813087dSJoe Perches $NonptrTypeMisordered = qr{ 8021813087dSJoe Perches (?:$Modifier\s+|const\s+)* 8031813087dSJoe Perches (?: 8041813087dSJoe Perches (?:${Misordered}\b) 8051813087dSJoe Perches ) 8061813087dSJoe Perches (?:\s+$Modifier|\s+const)* 8071813087dSJoe Perches }x; 8088716de38SJoe Perches $NonptrTypeWithAttr = qr{ 8098716de38SJoe Perches (?:$Modifier\s+|const\s+)* 8108716de38SJoe Perches (?: 8118716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 8128716de38SJoe Perches (?:$typeTypedefs\b)| 8138716de38SJoe Perches (?:${allWithAttr}\b) 8148716de38SJoe Perches ) 8158716de38SJoe Perches (?:\s+$Modifier|\s+const)* 8168716de38SJoe Perches }x; 8178905a67cSAndy Whitcroft $Type = qr{ 818c45dcabdSAndy Whitcroft $NonptrType 8197b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 820c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 8218905a67cSAndy Whitcroft }x; 8221813087dSJoe Perches $TypeMisordered = qr{ 8231813087dSJoe Perches $NonptrTypeMisordered 8247b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 8251813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 8261813087dSJoe Perches }x; 82791cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 8281813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 8298905a67cSAndy Whitcroft} 8308905a67cSAndy Whitcroftbuild_types(); 8316c72ffaaSAndy Whitcroft 8327d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 833d1fe9c09SJoe Perches 834d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 835d1fe9c09SJoe Perches# requires at least perl version v5.10.0 836d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 837d1fe9c09SJoe Perches 838d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 8392435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 840c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 8417d2367afSJoe Perches 842f8422308SJoe Perchesour $declaration_macros = qr{(?x: 8433e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 844fe658f94SSteffen Maier (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(| 8453d102fc0SGilad Ben-Yossef (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\( 846f8422308SJoe Perches)}; 847f8422308SJoe Perches 8487d2367afSJoe Perchessub deparenthesize { 8497d2367afSJoe Perches my ($string) = @_; 8507d2367afSJoe Perches return "" if (!defined($string)); 8515b9553abSJoe Perches 8525b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 8535b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 8545b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 8555b9553abSJoe Perches } 8565b9553abSJoe Perches 8577d2367afSJoe Perches $string =~ s@\s+@ @g; 8585b9553abSJoe Perches 8597d2367afSJoe Perches return $string; 8607d2367afSJoe Perches} 8617d2367afSJoe Perches 8623445686aSJoe Perchessub seed_camelcase_file { 8633445686aSJoe Perches my ($file) = @_; 8643445686aSJoe Perches 8653445686aSJoe Perches return if (!(-f $file)); 8663445686aSJoe Perches 8673445686aSJoe Perches local $/; 8683445686aSJoe Perches 8693445686aSJoe Perches open(my $include_file, '<', "$file") 8703445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 8713445686aSJoe Perches my $text = <$include_file>; 8723445686aSJoe Perches close($include_file); 8733445686aSJoe Perches 8743445686aSJoe Perches my @lines = split('\n', $text); 8753445686aSJoe Perches 8763445686aSJoe Perches foreach my $line (@lines) { 8773445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 8783445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 8793445686aSJoe Perches $camelcase{$1} = 1; 88011ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 88111ea516aSJoe Perches $camelcase{$1} = 1; 88211ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 8833445686aSJoe Perches $camelcase{$1} = 1; 8843445686aSJoe Perches } 8853445686aSJoe Perches } 8863445686aSJoe Perches} 8873445686aSJoe Perches 888cd28b119SJoe Perchesour %maintained_status = (); 889cd28b119SJoe Perches 89085b0ee18SJoe Perchessub is_maintained_obsolete { 89185b0ee18SJoe Perches my ($filename) = @_; 89285b0ee18SJoe Perches 893f2c19c2fSJerome Forissier return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 89485b0ee18SJoe Perches 895cd28b119SJoe Perches if (!exists($maintained_status{$filename})) { 896cd28b119SJoe Perches $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 897cd28b119SJoe Perches } 89885b0ee18SJoe Perches 899cd28b119SJoe Perches return $maintained_status{$filename} =~ /obsolete/i; 90085b0ee18SJoe Perches} 90185b0ee18SJoe Perches 9023b6e8ac9SJoe Perchessub is_SPDX_License_valid { 9033b6e8ac9SJoe Perches my ($license) = @_; 9043b6e8ac9SJoe Perches 90556294112SJoe Perches return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git")); 9063b6e8ac9SJoe Perches 90756294112SJoe Perches my $root_path = abs_path($root); 90856294112SJoe Perches my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`; 9093b6e8ac9SJoe Perches return 0 if ($status ne ""); 9103b6e8ac9SJoe Perches return 1; 9113b6e8ac9SJoe Perches} 9123b6e8ac9SJoe Perches 9133445686aSJoe Perchesmy $camelcase_seeded = 0; 9143445686aSJoe Perchessub seed_camelcase_includes { 9153445686aSJoe Perches return if ($camelcase_seeded); 9163445686aSJoe Perches 9173445686aSJoe Perches my $files; 918c707a81dSJoe Perches my $camelcase_cache = ""; 919c707a81dSJoe Perches my @include_files = (); 920c707a81dSJoe Perches 921c707a81dSJoe Perches $camelcase_seeded = 1; 922351b2a1fSJoe Perches 9233645e328SRichard Genoud if (-e ".git") { 924dbbf869dSJoe Perches my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`; 925351b2a1fSJoe Perches chomp $git_last_include_commit; 926c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 927c707a81dSJoe Perches } else { 928c707a81dSJoe Perches my $last_mod_date = 0; 929c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 930c707a81dSJoe Perches @include_files = split('\n', $files); 931c707a81dSJoe Perches foreach my $file (@include_files) { 932c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 933c707a81dSJoe Perches localtime((stat $file)[9])); 934c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 935c707a81dSJoe Perches } 936c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 937c707a81dSJoe Perches } 938c707a81dSJoe Perches 939c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 940c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 941c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 942351b2a1fSJoe Perches while (<$camelcase_file>) { 943351b2a1fSJoe Perches chomp; 944351b2a1fSJoe Perches $camelcase{$_} = 1; 945351b2a1fSJoe Perches } 946351b2a1fSJoe Perches close($camelcase_file); 947351b2a1fSJoe Perches 948351b2a1fSJoe Perches return; 949351b2a1fSJoe Perches } 950c707a81dSJoe Perches 9513645e328SRichard Genoud if (-e ".git") { 952dbbf869dSJoe Perches $files = `${git_command} ls-files "include/*.h"`; 953c707a81dSJoe Perches @include_files = split('\n', $files); 9543445686aSJoe Perches } 955c707a81dSJoe Perches 9563445686aSJoe Perches foreach my $file (@include_files) { 9573445686aSJoe Perches seed_camelcase_file($file); 9583445686aSJoe Perches } 959351b2a1fSJoe Perches 960c707a81dSJoe Perches if ($camelcase_cache ne "") { 961351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 962c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 963c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 964351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 965351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 966351b2a1fSJoe Perches } 967351b2a1fSJoe Perches close($camelcase_file); 968351b2a1fSJoe Perches } 9693445686aSJoe Perches} 9703445686aSJoe Perches 971d311cd44SJoe Perchessub git_commit_info { 972d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 973d311cd44SJoe Perches 974d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 975d311cd44SJoe Perches 976dbbf869dSJoe Perches my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`; 977d311cd44SJoe Perches $output =~ s/^\s*//gm; 978d311cd44SJoe Perches my @lines = split("\n", $output); 979d311cd44SJoe Perches 9800d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 9810d7835fcSJoe Perches 9825a7f4455SSean Christopherson if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) { 983d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 984d311cd44SJoe Perches# all matching commit ids, but it's very slow... 985d311cd44SJoe Perches# 986d311cd44SJoe Perches# echo "checking commits $1..." 987d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 988d311cd44SJoe Perches# while read line ; do 989d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 990d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 991d311cd44SJoe Perches# done 992d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 993948b133aSHeinrich Schuchardt $id = undef; 994d311cd44SJoe Perches } else { 995d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 996d311cd44SJoe Perches $desc = substr($lines[0], 41); 997d311cd44SJoe Perches } 998d311cd44SJoe Perches 999d311cd44SJoe Perches return ($id, $desc); 1000d311cd44SJoe Perches} 1001d311cd44SJoe Perches 10026c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 10030a920b5bSAndy Whitcroft 100400df344fSAndy Whitcroftmy @rawlines = (); 1005c2fdda0dSAndy Whitcroftmy @lines = (); 10063705ce5bSJoe Perchesmy @fixed = (); 1007d752fcc8SJoe Perchesmy @fixed_inserted = (); 1008d752fcc8SJoe Perchesmy @fixed_deleted = (); 1009194f66fcSJoe Perchesmy $fixlinenr = -1; 1010194f66fcSJoe Perches 10114a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 10124a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 10134a593c34SDu, Changbindie "$P: No git repository found\n" if ($git && !-e ".git"); 10144a593c34SDu, Changbin 10154a593c34SDu, Changbinif ($git) { 10164a593c34SDu, Changbin my @commits = (); 10170dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 10184a593c34SDu, Changbin my $git_range; 101928898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 102028898fd1SJoe Perches $git_range = "-$2 $1"; 10214a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 10224a593c34SDu, Changbin $git_range = "$commit_expr"; 10234a593c34SDu, Changbin } else { 10240dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 10250dea9f1eSJoe Perches } 1026dbbf869dSJoe Perches my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 10270dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 102828898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 102928898fd1SJoe Perches next if (!defined($1) || !defined($2)); 10300dea9f1eSJoe Perches my $sha1 = $1; 10310dea9f1eSJoe Perches my $subject = $2; 10320dea9f1eSJoe Perches unshift(@commits, $sha1); 10330dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 10344a593c34SDu, Changbin } 10354a593c34SDu, Changbin } 10364a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 10374a593c34SDu, Changbin @ARGV = @commits; 10384a593c34SDu, Changbin} 10394a593c34SDu, Changbin 1040c2fdda0dSAndy Whitcroftmy $vname; 104198005e8cSVadim Bendebury$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"}; 10426c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 104321caa13cSAndy Whitcroft my $FILE; 10444a593c34SDu, Changbin if ($git) { 10454a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 10464a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 10474a593c34SDu, Changbin } elsif ($file) { 104821caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 10496c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 105021caa13cSAndy Whitcroft } elsif ($filename eq '-') { 105121caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 10526c72ffaaSAndy Whitcroft } else { 105321caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 10546c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 10556c72ffaaSAndy Whitcroft } 1056c2fdda0dSAndy Whitcroft if ($filename eq '-') { 1057c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 10584a593c34SDu, Changbin } elsif ($git) { 10590dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 1060c2fdda0dSAndy Whitcroft } else { 1061c2fdda0dSAndy Whitcroft $vname = $filename; 1062c2fdda0dSAndy Whitcroft } 106321caa13cSAndy Whitcroft while (<$FILE>) { 10640a920b5bSAndy Whitcroft chomp; 106500df344fSAndy Whitcroft push(@rawlines, $_); 1066c7f574d0SGeert Uytterhoeven $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i); 10676c72ffaaSAndy Whitcroft } 106821caa13cSAndy Whitcroft close($FILE); 1069d8469f16SJoe Perches 1070d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 1071d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1072d8469f16SJoe Perches print "$vname\n"; 1073d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1074d8469f16SJoe Perches } 1075d8469f16SJoe Perches 1076c2fdda0dSAndy Whitcroft if (!process($filename)) { 10770a920b5bSAndy Whitcroft $exit = 1; 10780a920b5bSAndy Whitcroft } 107900df344fSAndy Whitcroft @rawlines = (); 108013214adfSAndy Whitcroft @lines = (); 10813705ce5bSJoe Perches @fixed = (); 1082d752fcc8SJoe Perches @fixed_inserted = (); 1083d752fcc8SJoe Perches @fixed_deleted = (); 1084194f66fcSJoe Perches $fixlinenr = -1; 1085485ff23eSAlex Dowad @modifierListFile = (); 1086485ff23eSAlex Dowad @typeListFile = (); 1087485ff23eSAlex Dowad build_types(); 10880a920b5bSAndy Whitcroft} 10890a920b5bSAndy Whitcroft 1090d8469f16SJoe Perchesif (!$quiet) { 10913c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 10923c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 10933c816e49SJoe Perches 10945b57980dSJoe Perches if (!$perl_version_ok) { 1095d8469f16SJoe Perches print << "EOM" 1096d8469f16SJoe Perches 1097d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 10985b57980dSJoe Perches An upgrade to at least perl $minimum_perl_version is suggested. 1099d8469f16SJoe PerchesEOM 1100d8469f16SJoe Perches } 1101d8469f16SJoe Perches if ($exit) { 1102d8469f16SJoe Perches print << "EOM" 1103d8469f16SJoe Perches 1104d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 1105d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 1106d8469f16SJoe PerchesEOM 1107d8469f16SJoe Perches } 1108d8469f16SJoe Perches} 1109d8469f16SJoe Perches 11100a920b5bSAndy Whitcroftexit($exit); 11110a920b5bSAndy Whitcroft 11120a920b5bSAndy Whitcroftsub top_of_kernel_tree { 11136c72ffaaSAndy Whitcroft my ($root) = @_; 11146c72ffaaSAndy Whitcroft 11156c72ffaaSAndy Whitcroft my @tree_check = ( 11166c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 11176c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 11186c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 11196c72ffaaSAndy Whitcroft ); 11206c72ffaaSAndy Whitcroft 11216c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 11226c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 11230a920b5bSAndy Whitcroft return 0; 11240a920b5bSAndy Whitcroft } 11256c72ffaaSAndy Whitcroft } 11266c72ffaaSAndy Whitcroft return 1; 11276c72ffaaSAndy Whitcroft} 11280a920b5bSAndy Whitcroft 112920112475SJoe Perchessub parse_email { 113020112475SJoe Perches my ($formatted_email) = @_; 113120112475SJoe Perches 113220112475SJoe Perches my $name = ""; 1133dfa05c28SJoe Perches my $name_comment = ""; 113420112475SJoe Perches my $address = ""; 113520112475SJoe Perches my $comment = ""; 113620112475SJoe Perches 113720112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 113820112475SJoe Perches $name = $1; 113920112475SJoe Perches $address = $2; 114020112475SJoe Perches $comment = $3 if defined $3; 114120112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 114220112475SJoe Perches $address = $1; 114320112475SJoe Perches $comment = $2 if defined $2; 114420112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 114520112475SJoe Perches $address = $1; 114620112475SJoe Perches $comment = $2 if defined $2; 114785e12066SJoe Perches $formatted_email =~ s/\Q$address\E.*$//; 114820112475SJoe Perches $name = $formatted_email; 11493705ce5bSJoe Perches $name = trim($name); 115020112475SJoe Perches $name =~ s/^\"|\"$//g; 115120112475SJoe Perches # If there's a name left after stripping spaces and 115220112475SJoe Perches # leading quotes, and the address doesn't have both 115320112475SJoe Perches # leading and trailing angle brackets, the address 115420112475SJoe Perches # is invalid. ie: 115520112475SJoe Perches # "joe smith [email protected]" bad 115620112475SJoe Perches # "joe smith <[email protected]" bad 115720112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 115820112475SJoe Perches $name = ""; 115920112475SJoe Perches $address = ""; 116020112475SJoe Perches $comment = ""; 116120112475SJoe Perches } 116220112475SJoe Perches } 116320112475SJoe Perches 11643705ce5bSJoe Perches $name = trim($name); 116520112475SJoe Perches $name =~ s/^\"|\"$//g; 1166dfa05c28SJoe Perches $name =~ s/(\s*\([^\)]+\))\s*//; 1167dfa05c28SJoe Perches if (defined($1)) { 1168dfa05c28SJoe Perches $name_comment = trim($1); 1169dfa05c28SJoe Perches } 11703705ce5bSJoe Perches $address = trim($address); 117120112475SJoe Perches $address =~ s/^\<|\>$//g; 117220112475SJoe Perches 117320112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 117420112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 117520112475SJoe Perches $name = "\"$name\""; 117620112475SJoe Perches } 117720112475SJoe Perches 1178dfa05c28SJoe Perches return ($name, $name_comment, $address, $comment); 117920112475SJoe Perches} 118020112475SJoe Perches 118120112475SJoe Perchessub format_email { 118220112475SJoe Perches my ($name, $address) = @_; 118320112475SJoe Perches 118420112475SJoe Perches my $formatted_email; 118520112475SJoe Perches 11863705ce5bSJoe Perches $name = trim($name); 118720112475SJoe Perches $name =~ s/^\"|\"$//g; 11883705ce5bSJoe Perches $address = trim($address); 118920112475SJoe Perches 119020112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 119120112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 119220112475SJoe Perches $name = "\"$name\""; 119320112475SJoe Perches } 119420112475SJoe Perches 119520112475SJoe Perches if ("$name" eq "") { 119620112475SJoe Perches $formatted_email = "$address"; 119720112475SJoe Perches } else { 119820112475SJoe Perches $formatted_email = "$name <$address>"; 119920112475SJoe Perches } 120020112475SJoe Perches 120120112475SJoe Perches return $formatted_email; 120220112475SJoe Perches} 120320112475SJoe Perches 1204dfa05c28SJoe Perchessub reformat_email { 1205dfa05c28SJoe Perches my ($email) = @_; 1206dfa05c28SJoe Perches 1207dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 1208dfa05c28SJoe Perches return format_email($email_name, $email_address); 1209dfa05c28SJoe Perches} 1210dfa05c28SJoe Perches 1211dfa05c28SJoe Perchessub same_email_addresses { 1212dfa05c28SJoe Perches my ($email1, $email2) = @_; 1213dfa05c28SJoe Perches 1214dfa05c28SJoe Perches my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1); 1215dfa05c28SJoe Perches my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2); 1216dfa05c28SJoe Perches 1217dfa05c28SJoe Perches return $email1_name eq $email2_name && 1218dfa05c28SJoe Perches $email1_address eq $email2_address; 1219dfa05c28SJoe Perches} 1220dfa05c28SJoe Perches 1221d311cd44SJoe Perchessub which { 1222d311cd44SJoe Perches my ($bin) = @_; 1223d311cd44SJoe Perches 1224d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1225d311cd44SJoe Perches if (-e "$path/$bin") { 1226d311cd44SJoe Perches return "$path/$bin"; 1227d311cd44SJoe Perches } 1228d311cd44SJoe Perches } 1229d311cd44SJoe Perches 1230d311cd44SJoe Perches return ""; 1231d311cd44SJoe Perches} 1232d311cd44SJoe Perches 1233000d1cc1SJoe Perchessub which_conf { 1234000d1cc1SJoe Perches my ($conf) = @_; 1235000d1cc1SJoe Perches 1236000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1237000d1cc1SJoe Perches if (-e "$path/$conf") { 1238000d1cc1SJoe Perches return "$path/$conf"; 1239000d1cc1SJoe Perches } 1240000d1cc1SJoe Perches } 1241000d1cc1SJoe Perches 1242000d1cc1SJoe Perches return ""; 1243000d1cc1SJoe Perches} 1244000d1cc1SJoe Perches 12450a920b5bSAndy Whitcroftsub expand_tabs { 12460a920b5bSAndy Whitcroft my ($str) = @_; 12470a920b5bSAndy Whitcroft 12480a920b5bSAndy Whitcroft my $res = ''; 12490a920b5bSAndy Whitcroft my $n = 0; 12500a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 12510a920b5bSAndy Whitcroft if ($c eq "\t") { 12520a920b5bSAndy Whitcroft $res .= ' '; 12530a920b5bSAndy Whitcroft $n++; 1254713a09deSAntonio Borneo for (; ($n % $tabsize) != 0; $n++) { 12550a920b5bSAndy Whitcroft $res .= ' '; 12560a920b5bSAndy Whitcroft } 12570a920b5bSAndy Whitcroft next; 12580a920b5bSAndy Whitcroft } 12590a920b5bSAndy Whitcroft $res .= $c; 12600a920b5bSAndy Whitcroft $n++; 12610a920b5bSAndy Whitcroft } 12620a920b5bSAndy Whitcroft 12630a920b5bSAndy Whitcroft return $res; 12640a920b5bSAndy Whitcroft} 12656c72ffaaSAndy Whitcroftsub copy_spacing { 1266773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 12676c72ffaaSAndy Whitcroft return $res; 12686c72ffaaSAndy Whitcroft} 12690a920b5bSAndy Whitcroft 12704a0df2efSAndy Whitcroftsub line_stats { 12714a0df2efSAndy Whitcroft my ($line) = @_; 12724a0df2efSAndy Whitcroft 12734a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 12744a0df2efSAndy Whitcroft $line =~ s/^.//; 12754a0df2efSAndy Whitcroft $line = expand_tabs($line); 12764a0df2efSAndy Whitcroft 12774a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 12784a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 12794a0df2efSAndy Whitcroft 12804a0df2efSAndy Whitcroft return (length($line), length($white)); 12814a0df2efSAndy Whitcroft} 12824a0df2efSAndy Whitcroft 1283773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1284773647a0SAndy Whitcroft 1285773647a0SAndy Whitcroftsub sanitise_line_reset { 1286773647a0SAndy Whitcroft my ($in_comment) = @_; 1287773647a0SAndy Whitcroft 1288773647a0SAndy Whitcroft if ($in_comment) { 1289773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1290773647a0SAndy Whitcroft } else { 1291773647a0SAndy Whitcroft $sanitise_quote = ''; 1292773647a0SAndy Whitcroft } 1293773647a0SAndy Whitcroft} 129400df344fSAndy Whitcroftsub sanitise_line { 129500df344fSAndy Whitcroft my ($line) = @_; 129600df344fSAndy Whitcroft 129700df344fSAndy Whitcroft my $res = ''; 129800df344fSAndy Whitcroft my $l = ''; 129900df344fSAndy Whitcroft 1300c2fdda0dSAndy Whitcroft my $qlen = 0; 1301773647a0SAndy Whitcroft my $off = 0; 1302773647a0SAndy Whitcroft my $c; 130300df344fSAndy Whitcroft 1304773647a0SAndy Whitcroft # Always copy over the diff marker. 1305773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1306773647a0SAndy Whitcroft 1307773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1308773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1309773647a0SAndy Whitcroft 13108d2e11b2SClaudio Fontana # Comments we are whacking completely including the begin 1311773647a0SAndy Whitcroft # and end, all to $;. 1312773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1313773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1314773647a0SAndy Whitcroft 1315773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1316773647a0SAndy Whitcroft $off++; 131700df344fSAndy Whitcroft next; 1318773647a0SAndy Whitcroft } 131981bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1320773647a0SAndy Whitcroft $sanitise_quote = ''; 1321773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1322773647a0SAndy Whitcroft $off++; 1323773647a0SAndy Whitcroft next; 1324773647a0SAndy Whitcroft } 1325113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1326113f04a8SDaniel Walker $sanitise_quote = '//'; 1327113f04a8SDaniel Walker 1328113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1329113f04a8SDaniel Walker $off++; 1330113f04a8SDaniel Walker next; 1331113f04a8SDaniel Walker } 1332773647a0SAndy Whitcroft 1333773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1334773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1335773647a0SAndy Whitcroft $c eq "\\") { 1336773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1337773647a0SAndy Whitcroft $off++; 1338773647a0SAndy Whitcroft next; 1339773647a0SAndy Whitcroft } 1340773647a0SAndy Whitcroft # Regular quotes. 1341773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1342773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1343773647a0SAndy Whitcroft $sanitise_quote = $c; 1344773647a0SAndy Whitcroft 1345773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1346773647a0SAndy Whitcroft next; 1347773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1348773647a0SAndy Whitcroft $sanitise_quote = ''; 134900df344fSAndy Whitcroft } 135000df344fSAndy Whitcroft } 1351773647a0SAndy Whitcroft 1352fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1353773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1354773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1355113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1356113f04a8SDaniel Walker substr($res, $off, 1, $;); 1357773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1358773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 135900df344fSAndy Whitcroft } else { 1360773647a0SAndy Whitcroft substr($res, $off, 1, $c); 136100df344fSAndy Whitcroft } 1362c2fdda0dSAndy Whitcroft } 1363c2fdda0dSAndy Whitcroft 1364113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1365113f04a8SDaniel Walker $sanitise_quote = ''; 1366113f04a8SDaniel Walker } 1367113f04a8SDaniel Walker 1368c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1369c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1370c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1371c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1372c2fdda0dSAndy Whitcroft 1373c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1374c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1375c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1376c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1377c2fdda0dSAndy Whitcroft } 1378c2fdda0dSAndy Whitcroft 1379dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1380dadf680dSJoe Perches my $match = $1; 1381dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1382dadf680dSJoe Perches } 1383dadf680dSJoe Perches 138400df344fSAndy Whitcroft return $res; 138500df344fSAndy Whitcroft} 138600df344fSAndy Whitcroft 1387a6962d72SJoe Perchessub get_quoted_string { 1388a6962d72SJoe Perches my ($line, $rawline) = @_; 1389a6962d72SJoe Perches 1390478b1799SJoe Perches return "" if (!defined($line) || !defined($rawline)); 139133acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1392a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1393a6962d72SJoe Perches} 1394a6962d72SJoe Perches 13958905a67cSAndy Whitcroftsub ctx_statement_block { 13968905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 13978905a67cSAndy Whitcroft my $line = $linenr - 1; 13988905a67cSAndy Whitcroft my $blk = ''; 13998905a67cSAndy Whitcroft my $soff = $off; 14008905a67cSAndy Whitcroft my $coff = $off - 1; 1401773647a0SAndy Whitcroft my $coff_set = 0; 14028905a67cSAndy Whitcroft 140313214adfSAndy Whitcroft my $loff = 0; 140413214adfSAndy Whitcroft 14058905a67cSAndy Whitcroft my $type = ''; 14068905a67cSAndy Whitcroft my $level = 0; 1407a2750645SAndy Whitcroft my @stack = (); 1408cf655043SAndy Whitcroft my $p; 14098905a67cSAndy Whitcroft my $c; 14108905a67cSAndy Whitcroft my $len = 0; 141113214adfSAndy Whitcroft 141213214adfSAndy Whitcroft my $remainder; 14138905a67cSAndy Whitcroft while (1) { 1414a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1415a2750645SAndy Whitcroft 1416773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 14178905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 14188905a67cSAndy Whitcroft # context. 14198905a67cSAndy Whitcroft if ($off >= $len) { 14208905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1421dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1422c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 14238905a67cSAndy Whitcroft $remain--; 142413214adfSAndy Whitcroft $loff = $len; 1425c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 14268905a67cSAndy Whitcroft $len = length($blk); 14278905a67cSAndy Whitcroft $line++; 14288905a67cSAndy Whitcroft last; 14298905a67cSAndy Whitcroft } 14308905a67cSAndy Whitcroft # Bail if there is no further context. 14318905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 143213214adfSAndy Whitcroft if ($off >= $len) { 14338905a67cSAndy Whitcroft last; 14348905a67cSAndy Whitcroft } 1435f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1436f74bd194SAndy Whitcroft $level++; 1437f74bd194SAndy Whitcroft $type = '#'; 1438f74bd194SAndy Whitcroft } 14398905a67cSAndy Whitcroft } 1440cf655043SAndy Whitcroft $p = $c; 14418905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 144213214adfSAndy Whitcroft $remainder = substr($blk, $off); 14438905a67cSAndy Whitcroft 1444773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 14454635f4fbSAndy Whitcroft 14464635f4fbSAndy Whitcroft # Handle nested #if/#else. 14474635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 14484635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 14494635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 14504635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 14514635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 14524635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 14534635f4fbSAndy Whitcroft } 14544635f4fbSAndy Whitcroft 14558905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 14568905a67cSAndy Whitcroft # outermost level. 14578905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 14588905a67cSAndy Whitcroft last; 14598905a67cSAndy Whitcroft } 14608905a67cSAndy Whitcroft 146113214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1462773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1463773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1464773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1465773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1466773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1467773647a0SAndy Whitcroft $coff_set = 1; 1468773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1469773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 147013214adfSAndy Whitcroft } 147113214adfSAndy Whitcroft 14728905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 14738905a67cSAndy Whitcroft $level++; 14748905a67cSAndy Whitcroft $type = '('; 14758905a67cSAndy Whitcroft } 14768905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 14778905a67cSAndy Whitcroft $level--; 14788905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 14798905a67cSAndy Whitcroft 14808905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 14818905a67cSAndy Whitcroft $coff = $off; 1482773647a0SAndy Whitcroft $coff_set = 1; 1483773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 14848905a67cSAndy Whitcroft } 14858905a67cSAndy Whitcroft } 14868905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 14878905a67cSAndy Whitcroft $level++; 14888905a67cSAndy Whitcroft $type = '{'; 14898905a67cSAndy Whitcroft } 14908905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 14918905a67cSAndy Whitcroft $level--; 14928905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 14938905a67cSAndy Whitcroft 14948905a67cSAndy Whitcroft if ($level == 0) { 1495b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1496b998e001SPatrick Pannuto $off++; 1497b998e001SPatrick Pannuto } 14988905a67cSAndy Whitcroft last; 14998905a67cSAndy Whitcroft } 15008905a67cSAndy Whitcroft } 1501f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1502f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1503f74bd194SAndy Whitcroft $level--; 1504f74bd194SAndy Whitcroft $type = ''; 1505f74bd194SAndy Whitcroft $off++; 1506f74bd194SAndy Whitcroft last; 1507f74bd194SAndy Whitcroft } 15088905a67cSAndy Whitcroft $off++; 15098905a67cSAndy Whitcroft } 1510a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 151113214adfSAndy Whitcroft if ($off == $len) { 1512a3bb97a7SAndy Whitcroft $loff = $len + 1; 151313214adfSAndy Whitcroft $line++; 151413214adfSAndy Whitcroft $remain--; 151513214adfSAndy Whitcroft } 15168905a67cSAndy Whitcroft 15178905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 15188905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 15198905a67cSAndy Whitcroft 15208905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 15218905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 15228905a67cSAndy Whitcroft 1523773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 152413214adfSAndy Whitcroft 152513214adfSAndy Whitcroft return ($statement, $condition, 152613214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 152713214adfSAndy Whitcroft} 152813214adfSAndy Whitcroft 1529cf655043SAndy Whitcroftsub statement_lines { 1530cf655043SAndy Whitcroft my ($stmt) = @_; 1531cf655043SAndy Whitcroft 1532cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1533cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1534cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1535cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1536cf655043SAndy Whitcroft 1537cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1538cf655043SAndy Whitcroft 1539cf655043SAndy Whitcroft return $#stmt_lines + 2; 1540cf655043SAndy Whitcroft} 1541cf655043SAndy Whitcroft 1542cf655043SAndy Whitcroftsub statement_rawlines { 1543cf655043SAndy Whitcroft my ($stmt) = @_; 1544cf655043SAndy Whitcroft 1545cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1546cf655043SAndy Whitcroft 1547cf655043SAndy Whitcroft return $#stmt_lines + 2; 1548cf655043SAndy Whitcroft} 1549cf655043SAndy Whitcroft 1550cf655043SAndy Whitcroftsub statement_block_size { 1551cf655043SAndy Whitcroft my ($stmt) = @_; 1552cf655043SAndy Whitcroft 1553cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1554cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1555cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1556cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1557cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1558cf655043SAndy Whitcroft 1559cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1560cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1561cf655043SAndy Whitcroft 1562cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1563cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1564cf655043SAndy Whitcroft 1565cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1566cf655043SAndy Whitcroft return $stmt_lines; 1567cf655043SAndy Whitcroft } else { 1568cf655043SAndy Whitcroft return $stmt_statements; 1569cf655043SAndy Whitcroft } 1570cf655043SAndy Whitcroft} 1571cf655043SAndy Whitcroft 157213214adfSAndy Whitcroftsub ctx_statement_full { 157313214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 157413214adfSAndy Whitcroft my ($statement, $condition, $level); 157513214adfSAndy Whitcroft 157613214adfSAndy Whitcroft my (@chunks); 157713214adfSAndy Whitcroft 1578cf655043SAndy Whitcroft # Grab the first conditional/block pair. 157913214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 158013214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1581773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 158213214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1583cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1584cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1585cf655043SAndy Whitcroft } 1586cf655043SAndy Whitcroft 1587cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1588cf655043SAndy Whitcroft # could continue the statement. 1589cf655043SAndy Whitcroft for (;;) { 159013214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 159113214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1592cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1593773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1594cf655043SAndy Whitcroft #print "C: push\n"; 1595cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 159613214adfSAndy Whitcroft } 159713214adfSAndy Whitcroft 159813214adfSAndy Whitcroft return ($level, $linenr, @chunks); 15998905a67cSAndy Whitcroft} 16008905a67cSAndy Whitcroft 16014a0df2efSAndy Whitcroftsub ctx_block_get { 1602f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 16034a0df2efSAndy Whitcroft my $line; 16044a0df2efSAndy Whitcroft my $start = $linenr - 1; 16054a0df2efSAndy Whitcroft my $blk = ''; 16064a0df2efSAndy Whitcroft my @o; 16074a0df2efSAndy Whitcroft my @c; 16084a0df2efSAndy Whitcroft my @res = (); 16094a0df2efSAndy Whitcroft 1610f0a594c1SAndy Whitcroft my $level = 0; 16114635f4fbSAndy Whitcroft my @stack = ($level); 161200df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 161300df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 161400df344fSAndy Whitcroft $remain--; 161500df344fSAndy Whitcroft 161600df344fSAndy Whitcroft $blk .= $rawlines[$line]; 16174635f4fbSAndy Whitcroft 16184635f4fbSAndy Whitcroft # Handle nested #if/#else. 161901464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 16204635f4fbSAndy Whitcroft push(@stack, $level); 162101464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 16224635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 162301464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 16244635f4fbSAndy Whitcroft $level = pop(@stack); 16254635f4fbSAndy Whitcroft } 16264635f4fbSAndy Whitcroft 162701464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1628f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1629f0a594c1SAndy Whitcroft if ($off > 0) { 1630f0a594c1SAndy Whitcroft $off--; 1631f0a594c1SAndy Whitcroft next; 1632f0a594c1SAndy Whitcroft } 16334a0df2efSAndy Whitcroft 1634f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1635f0a594c1SAndy Whitcroft $level--; 1636f0a594c1SAndy Whitcroft last if ($level == 0); 1637f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1638f0a594c1SAndy Whitcroft $level++; 1639f0a594c1SAndy Whitcroft } 1640f0a594c1SAndy Whitcroft } 16414a0df2efSAndy Whitcroft 1642f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 164300df344fSAndy Whitcroft push(@res, $rawlines[$line]); 16444a0df2efSAndy Whitcroft } 16454a0df2efSAndy Whitcroft 1646f0a594c1SAndy Whitcroft last if ($level == 0); 16474a0df2efSAndy Whitcroft } 16484a0df2efSAndy Whitcroft 1649f0a594c1SAndy Whitcroft return ($level, @res); 16504a0df2efSAndy Whitcroft} 16514a0df2efSAndy Whitcroftsub ctx_block_outer { 16524a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 16534a0df2efSAndy Whitcroft 1654f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1655f0a594c1SAndy Whitcroft return @r; 16564a0df2efSAndy Whitcroft} 16574a0df2efSAndy Whitcroftsub ctx_block { 16584a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 16594a0df2efSAndy Whitcroft 1660f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1661f0a594c1SAndy Whitcroft return @r; 1662653d4876SAndy Whitcroft} 1663653d4876SAndy Whitcroftsub ctx_statement { 1664f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1665f0a594c1SAndy Whitcroft 1666f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1667f0a594c1SAndy Whitcroft return @r; 1668f0a594c1SAndy Whitcroft} 1669f0a594c1SAndy Whitcroftsub ctx_block_level { 1670653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1671653d4876SAndy Whitcroft 1672f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 16734a0df2efSAndy Whitcroft} 16749c0ca6f9SAndy Whitcroftsub ctx_statement_level { 16759c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 16769c0ca6f9SAndy Whitcroft 16779c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 16789c0ca6f9SAndy Whitcroft} 16794a0df2efSAndy Whitcroft 16804a0df2efSAndy Whitcroftsub ctx_locate_comment { 16814a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 16824a0df2efSAndy Whitcroft 1683a55ee0ccSJoe Perches # If c99 comment on the current line, or the line before or after 1684a55ee0ccSJoe Perches my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@); 1685a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1686a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@); 1687a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1688a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@); 1689a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1690a55ee0ccSJoe Perches 16914a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1692a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 16934a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 16944a0df2efSAndy Whitcroft 16954a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 16964a0df2efSAndy Whitcroft # comment. 16974a0df2efSAndy Whitcroft my $in_comment = 0; 16984a0df2efSAndy Whitcroft $current_comment = ''; 16994a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 170000df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 170100df344fSAndy Whitcroft #warn " $line\n"; 17024a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 17034a0df2efSAndy Whitcroft $in_comment = 1; 17044a0df2efSAndy Whitcroft } 17054a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 17064a0df2efSAndy Whitcroft $in_comment = 1; 17074a0df2efSAndy Whitcroft } 17084a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 17094a0df2efSAndy Whitcroft $current_comment = ''; 17104a0df2efSAndy Whitcroft } 17114a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 17124a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 17134a0df2efSAndy Whitcroft $in_comment = 0; 17144a0df2efSAndy Whitcroft } 17154a0df2efSAndy Whitcroft } 17164a0df2efSAndy Whitcroft 17174a0df2efSAndy Whitcroft chomp($current_comment); 17184a0df2efSAndy Whitcroft return($current_comment); 17194a0df2efSAndy Whitcroft} 17204a0df2efSAndy Whitcroftsub ctx_has_comment { 17214a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 17224a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 17234a0df2efSAndy Whitcroft 172400df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 17254a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 17264a0df2efSAndy Whitcroft 17274a0df2efSAndy Whitcroft return ($cmt ne ''); 17284a0df2efSAndy Whitcroft} 17294a0df2efSAndy Whitcroft 17304d001e4dSAndy Whitcroftsub raw_line { 17314d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 17324d001e4dSAndy Whitcroft 17334d001e4dSAndy Whitcroft my $offset = $linenr - 1; 17344d001e4dSAndy Whitcroft $cnt++; 17354d001e4dSAndy Whitcroft 17364d001e4dSAndy Whitcroft my $line; 17374d001e4dSAndy Whitcroft while ($cnt) { 17384d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 17394d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 17404d001e4dSAndy Whitcroft $cnt--; 17414d001e4dSAndy Whitcroft } 17424d001e4dSAndy Whitcroft 17434d001e4dSAndy Whitcroft return $line; 17444d001e4dSAndy Whitcroft} 17454d001e4dSAndy Whitcroft 17462a9f9d85STobin C. Hardingsub get_stat_real { 17472a9f9d85STobin C. Harding my ($linenr, $lc) = @_; 17482a9f9d85STobin C. Harding 17492a9f9d85STobin C. Harding my $stat_real = raw_line($linenr, 0); 17502a9f9d85STobin C. Harding for (my $count = $linenr + 1; $count <= $lc; $count++) { 17512a9f9d85STobin C. Harding $stat_real = $stat_real . "\n" . raw_line($count, 0); 17522a9f9d85STobin C. Harding } 17532a9f9d85STobin C. Harding 17542a9f9d85STobin C. Harding return $stat_real; 17552a9f9d85STobin C. Harding} 17562a9f9d85STobin C. Harding 1757e3d95a2aSTobin C. Hardingsub get_stat_here { 1758e3d95a2aSTobin C. Harding my ($linenr, $cnt, $here) = @_; 1759e3d95a2aSTobin C. Harding 1760e3d95a2aSTobin C. Harding my $herectx = $here . "\n"; 1761e3d95a2aSTobin C. Harding for (my $n = 0; $n < $cnt; $n++) { 1762e3d95a2aSTobin C. Harding $herectx .= raw_line($linenr, $n) . "\n"; 1763e3d95a2aSTobin C. Harding } 1764e3d95a2aSTobin C. Harding 1765e3d95a2aSTobin C. Harding return $herectx; 1766e3d95a2aSTobin C. Harding} 1767e3d95a2aSTobin C. Harding 17680a920b5bSAndy Whitcroftsub cat_vet { 17690a920b5bSAndy Whitcroft my ($vet) = @_; 17709c0ca6f9SAndy Whitcroft my ($res, $coded); 17710a920b5bSAndy Whitcroft 17729c0ca6f9SAndy Whitcroft $res = ''; 17736c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 17746c72ffaaSAndy Whitcroft $res .= $1; 17756c72ffaaSAndy Whitcroft if ($2 ne '') { 17769c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 17776c72ffaaSAndy Whitcroft $res .= $coded; 17786c72ffaaSAndy Whitcroft } 17799c0ca6f9SAndy Whitcroft } 17809c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 17810a920b5bSAndy Whitcroft 17829c0ca6f9SAndy Whitcroft return $res; 17830a920b5bSAndy Whitcroft} 17840a920b5bSAndy Whitcroft 1785c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1786cf655043SAndy Whitcroftmy $av_pending; 1787c2fdda0dSAndy Whitcroftmy @av_paren_type; 17881f65f947SAndy Whitcroftmy $av_pend_colon; 1789c2fdda0dSAndy Whitcroft 1790c2fdda0dSAndy Whitcroftsub annotate_reset { 1791c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1792cf655043SAndy Whitcroft $av_pending = '_'; 1793cf655043SAndy Whitcroft @av_paren_type = ('E'); 17941f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1795c2fdda0dSAndy Whitcroft} 1796c2fdda0dSAndy Whitcroft 17976c72ffaaSAndy Whitcroftsub annotate_values { 17986c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 17996c72ffaaSAndy Whitcroft 18006c72ffaaSAndy Whitcroft my $res; 18011f65f947SAndy Whitcroft my $var = '_' x length($stream); 18026c72ffaaSAndy Whitcroft my $cur = $stream; 18036c72ffaaSAndy Whitcroft 1804c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 18056c72ffaaSAndy Whitcroft 18066c72ffaaSAndy Whitcroft while (length($cur)) { 1807773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1808cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1809171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 18106c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1811c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1812c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1813cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1814c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 18156c72ffaaSAndy Whitcroft } 18166c72ffaaSAndy Whitcroft 1817c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 18189446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 18199446ef56SAndy Whitcroft push(@av_paren_type, $type); 1820addcdceaSAndy Whitcroft $type = 'c'; 18219446ef56SAndy Whitcroft 1822e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1823c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 18246c72ffaaSAndy Whitcroft $type = 'T'; 18256c72ffaaSAndy Whitcroft 1826389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1827389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1828389a2fe5SAndy Whitcroft $type = 'T'; 1829389a2fe5SAndy Whitcroft 1830c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1831171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1832c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1833171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1834171ae1a4SAndy Whitcroft if ($2 ne '') { 1835cf655043SAndy Whitcroft $av_pending = 'N'; 1836171ae1a4SAndy Whitcroft } 1837171ae1a4SAndy Whitcroft $type = 'E'; 1838171ae1a4SAndy Whitcroft 1839c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1840171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1841171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1842171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 18436c72ffaaSAndy Whitcroft 1844c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1845cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1846c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1847cf655043SAndy Whitcroft 1848cf655043SAndy Whitcroft push(@av_paren_type, $type); 1849cf655043SAndy Whitcroft push(@av_paren_type, $type); 1850171ae1a4SAndy Whitcroft $type = 'E'; 1851cf655043SAndy Whitcroft 1852c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1853cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1854cf655043SAndy Whitcroft $av_preprocessor = 1; 1855cf655043SAndy Whitcroft 1856cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1857cf655043SAndy Whitcroft 1858171ae1a4SAndy Whitcroft $type = 'E'; 1859cf655043SAndy Whitcroft 1860c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1861cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1862cf655043SAndy Whitcroft 1863cf655043SAndy Whitcroft $av_preprocessor = 1; 1864cf655043SAndy Whitcroft 1865cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1866cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1867cf655043SAndy Whitcroft pop(@av_paren_type); 1868cf655043SAndy Whitcroft push(@av_paren_type, $type); 1869171ae1a4SAndy Whitcroft $type = 'E'; 18706c72ffaaSAndy Whitcroft 18716c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1872c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 18736c72ffaaSAndy Whitcroft 1874171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1875171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1876171ae1a4SAndy Whitcroft $av_pending = $type; 1877171ae1a4SAndy Whitcroft $type = 'N'; 1878171ae1a4SAndy Whitcroft 18796c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1880c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 18816c72ffaaSAndy Whitcroft if (defined $2) { 1882cf655043SAndy Whitcroft $av_pending = 'V'; 18836c72ffaaSAndy Whitcroft } 18846c72ffaaSAndy Whitcroft $type = 'N'; 18856c72ffaaSAndy Whitcroft 188614b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1887c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 188814b111c1SAndy Whitcroft $av_pending = 'E'; 18896c72ffaaSAndy Whitcroft $type = 'N'; 18906c72ffaaSAndy Whitcroft 18911f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 18921f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 18931f65f947SAndy Whitcroft $av_pend_colon = 'C'; 18941f65f947SAndy Whitcroft $type = 'N'; 18951f65f947SAndy Whitcroft 189614b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1897c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 18986c72ffaaSAndy Whitcroft $type = 'N'; 18996c72ffaaSAndy Whitcroft 19006c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1901c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1902cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1903cf655043SAndy Whitcroft $av_pending = '_'; 19046c72ffaaSAndy Whitcroft $type = 'N'; 19056c72ffaaSAndy Whitcroft 19066c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1907cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1908cf655043SAndy Whitcroft if ($new_type ne '_') { 1909cf655043SAndy Whitcroft $type = $new_type; 1910c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1911c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 19126c72ffaaSAndy Whitcroft } else { 1913c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 19146c72ffaaSAndy Whitcroft } 19156c72ffaaSAndy Whitcroft 1916c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1917c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1918c8cb2ca3SAndy Whitcroft $type = 'V'; 1919cf655043SAndy Whitcroft $av_pending = 'V'; 19206c72ffaaSAndy Whitcroft 19218e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 19228e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 19231f65f947SAndy Whitcroft $av_pend_colon = 'B'; 19248e761b04SAndy Whitcroft } elsif ($type eq 'E') { 19258e761b04SAndy Whitcroft $av_pend_colon = 'L'; 19261f65f947SAndy Whitcroft } 19271f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 19281f65f947SAndy Whitcroft $type = 'V'; 19291f65f947SAndy Whitcroft 19306c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1931c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 19326c72ffaaSAndy Whitcroft $type = 'V'; 19336c72ffaaSAndy Whitcroft 19346c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1935c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 19366c72ffaaSAndy Whitcroft $type = 'N'; 19376c72ffaaSAndy Whitcroft 1938cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1939c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 194013214adfSAndy Whitcroft $type = 'E'; 19411f65f947SAndy Whitcroft $av_pend_colon = 'O'; 194213214adfSAndy Whitcroft 19438e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 19448e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 19458e761b04SAndy Whitcroft $type = 'C'; 19468e761b04SAndy Whitcroft 19471f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 19481f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 19491f65f947SAndy Whitcroft $type = 'N'; 19501f65f947SAndy Whitcroft 19511f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 19521f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 19531f65f947SAndy Whitcroft 19541f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 19551f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 19561f65f947SAndy Whitcroft $type = 'E'; 19571f65f947SAndy Whitcroft } else { 19581f65f947SAndy Whitcroft $type = 'N'; 19591f65f947SAndy Whitcroft } 19601f65f947SAndy Whitcroft $av_pend_colon = 'O'; 19611f65f947SAndy Whitcroft 19628e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 196313214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 19646c72ffaaSAndy Whitcroft $type = 'N'; 19656c72ffaaSAndy Whitcroft 19660d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 196774048ed8SAndy Whitcroft my $variant; 196874048ed8SAndy Whitcroft 196974048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 197074048ed8SAndy Whitcroft if ($type eq 'V') { 197174048ed8SAndy Whitcroft $variant = 'B'; 197274048ed8SAndy Whitcroft } else { 197374048ed8SAndy Whitcroft $variant = 'U'; 197474048ed8SAndy Whitcroft } 197574048ed8SAndy Whitcroft 197674048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 197774048ed8SAndy Whitcroft $type = 'N'; 197874048ed8SAndy Whitcroft 19796c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1980c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 19816c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 19826c72ffaaSAndy Whitcroft $type = 'N'; 19836c72ffaaSAndy Whitcroft } 19846c72ffaaSAndy Whitcroft 19856c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1986c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 19876c72ffaaSAndy Whitcroft } 19886c72ffaaSAndy Whitcroft if (defined $1) { 19896c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 19906c72ffaaSAndy Whitcroft $res .= $type x length($1); 19916c72ffaaSAndy Whitcroft } 19926c72ffaaSAndy Whitcroft } 19936c72ffaaSAndy Whitcroft 19941f65f947SAndy Whitcroft return ($res, $var); 19956c72ffaaSAndy Whitcroft} 19966c72ffaaSAndy Whitcroft 19978905a67cSAndy Whitcroftsub possible { 199813214adfSAndy Whitcroft my ($possible, $line) = @_; 19999a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 20000776e594SAndy Whitcroft ^(?: 20010776e594SAndy Whitcroft $Modifier| 20020776e594SAndy Whitcroft $Storage| 20030776e594SAndy Whitcroft $Type| 20049a974fdbSAndy Whitcroft DEFINE_\S+ 20059a974fdbSAndy Whitcroft )$| 20069a974fdbSAndy Whitcroft ^(?: 20070776e594SAndy Whitcroft goto| 20080776e594SAndy Whitcroft return| 20090776e594SAndy Whitcroft case| 20100776e594SAndy Whitcroft else| 20110776e594SAndy Whitcroft asm|__asm__| 201289a88353SAndy Whitcroft do| 201389a88353SAndy Whitcroft \#| 201489a88353SAndy Whitcroft \#\#| 20159a974fdbSAndy Whitcroft )(?:\s|$)| 20160776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 20179a974fdbSAndy Whitcroft )}x; 20189a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 20199a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 2020c45dcabdSAndy Whitcroft # Check for modifiers. 2021c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 2022c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 2023c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 2024c45dcabdSAndy Whitcroft 2025c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 2026c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 2027d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 20289a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 2029d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 2030485ff23eSAlex Dowad push(@modifierListFile, $modifier); 2031d2506586SAndy Whitcroft } 20329a974fdbSAndy Whitcroft } 2033c45dcabdSAndy Whitcroft 2034c45dcabdSAndy Whitcroft } else { 203513214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 2036485ff23eSAlex Dowad push(@typeListFile, $possible); 2037c45dcabdSAndy Whitcroft } 20388905a67cSAndy Whitcroft build_types(); 20390776e594SAndy Whitcroft } else { 20400776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 20418905a67cSAndy Whitcroft } 20428905a67cSAndy Whitcroft} 20438905a67cSAndy Whitcroft 20446c72ffaaSAndy Whitcroftmy $prefix = ''; 20456c72ffaaSAndy Whitcroft 2046000d1cc1SJoe Perchessub show_type { 2047cbec18afSJoe Perches my ($type) = @_; 204891bfe484SJoe Perches 2049522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 2050522b837cSAlexey Dobriyan 2051cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 2052cbec18afSJoe Perches 2053cbec18afSJoe Perches return !defined $ignore_type{$type}; 2054000d1cc1SJoe Perches} 2055000d1cc1SJoe Perches 2056f0a594c1SAndy Whitcroftsub report { 2057cbec18afSJoe Perches my ($level, $type, $msg) = @_; 2058cbec18afSJoe Perches 2059cbec18afSJoe Perches if (!show_type($type) || 2060cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 2061773647a0SAndy Whitcroft return 0; 2062773647a0SAndy Whitcroft } 206357230297SJoe Perches my $output = ''; 2064737c0767SJohn Brooks if ($color) { 206557230297SJoe Perches if ($level eq 'ERROR') { 206657230297SJoe Perches $output .= RED; 206757230297SJoe Perches } elsif ($level eq 'WARNING') { 206857230297SJoe Perches $output .= YELLOW; 2069000d1cc1SJoe Perches } else { 207057230297SJoe Perches $output .= GREEN; 2071000d1cc1SJoe Perches } 207257230297SJoe Perches } 207357230297SJoe Perches $output .= $prefix . $level . ':'; 207457230297SJoe Perches if ($show_types) { 2075737c0767SJohn Brooks $output .= BLUE if ($color); 207657230297SJoe Perches $output .= "$type:"; 207757230297SJoe Perches } 2078737c0767SJohn Brooks $output .= RESET if ($color); 207957230297SJoe Perches $output .= ' ' . $msg . "\n"; 208034d8815fSJoe Perches 208134d8815fSJoe Perches if ($showfile) { 208234d8815fSJoe Perches my @lines = split("\n", $output, -1); 208334d8815fSJoe Perches splice(@lines, 1, 1); 208434d8815fSJoe Perches $output = join("\n", @lines); 208534d8815fSJoe Perches } 208657230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 20878905a67cSAndy Whitcroft 208857230297SJoe Perches push(our @report, $output); 2089773647a0SAndy Whitcroft 2090773647a0SAndy Whitcroft return 1; 2091f0a594c1SAndy Whitcroft} 2092cbec18afSJoe Perches 2093f0a594c1SAndy Whitcroftsub report_dump { 209413214adfSAndy Whitcroft our @report; 2095f0a594c1SAndy Whitcroft} 2096000d1cc1SJoe Perches 2097d752fcc8SJoe Perchessub fixup_current_range { 2098d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 2099d752fcc8SJoe Perches 2100d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 2101d752fcc8SJoe Perches my $o = $1; 2102d752fcc8SJoe Perches my $l = $2; 2103d752fcc8SJoe Perches my $no = $o + $offset; 2104d752fcc8SJoe Perches my $nl = $l + $length; 2105d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 2106d752fcc8SJoe Perches } 2107d752fcc8SJoe Perches} 2108d752fcc8SJoe Perches 2109d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 2110d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 2111d752fcc8SJoe Perches 2112d752fcc8SJoe Perches my $range_last_linenr = 0; 2113d752fcc8SJoe Perches my $delta_offset = 0; 2114d752fcc8SJoe Perches 2115d752fcc8SJoe Perches my $old_linenr = 0; 2116d752fcc8SJoe Perches my $new_linenr = 0; 2117d752fcc8SJoe Perches 2118d752fcc8SJoe Perches my $next_insert = 0; 2119d752fcc8SJoe Perches my $next_delete = 0; 2120d752fcc8SJoe Perches 2121d752fcc8SJoe Perches my @lines = (); 2122d752fcc8SJoe Perches 2123d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 2124d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 2125d752fcc8SJoe Perches 2126d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 2127d752fcc8SJoe Perches my $save_line = 1; 2128d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 2129323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2130d752fcc8SJoe Perches $delta_offset = 0; 2131d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2132d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 2133d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 2134d752fcc8SJoe Perches } 2135d752fcc8SJoe Perches 2136d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2137d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 2138d752fcc8SJoe Perches $save_line = 0; 2139d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2140d752fcc8SJoe Perches } 2141d752fcc8SJoe Perches 2142d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2143d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 2144d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 2145d752fcc8SJoe Perches $new_linenr++; 2146d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2147d752fcc8SJoe Perches } 2148d752fcc8SJoe Perches 2149d752fcc8SJoe Perches if ($save_line) { 2150d752fcc8SJoe Perches push(@lines, $line); 2151d752fcc8SJoe Perches $new_linenr++; 2152d752fcc8SJoe Perches } 2153d752fcc8SJoe Perches 2154d752fcc8SJoe Perches $old_linenr++; 2155d752fcc8SJoe Perches } 2156d752fcc8SJoe Perches 2157d752fcc8SJoe Perches return @lines; 2158d752fcc8SJoe Perches} 2159d752fcc8SJoe Perches 2160f2d7e4d4SJoe Perchessub fix_insert_line { 2161f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2162f2d7e4d4SJoe Perches 2163f2d7e4d4SJoe Perches my $inserted = { 2164f2d7e4d4SJoe Perches LINENR => $linenr, 2165f2d7e4d4SJoe Perches LINE => $line, 2166f2d7e4d4SJoe Perches }; 2167f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2168f2d7e4d4SJoe Perches} 2169f2d7e4d4SJoe Perches 2170f2d7e4d4SJoe Perchessub fix_delete_line { 2171f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2172f2d7e4d4SJoe Perches 2173f2d7e4d4SJoe Perches my $deleted = { 2174f2d7e4d4SJoe Perches LINENR => $linenr, 2175f2d7e4d4SJoe Perches LINE => $line, 2176f2d7e4d4SJoe Perches }; 2177f2d7e4d4SJoe Perches 2178f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2179f2d7e4d4SJoe Perches} 2180f2d7e4d4SJoe Perches 2181de7d4f0eSAndy Whitcroftsub ERROR { 2182cbec18afSJoe Perches my ($type, $msg) = @_; 2183cbec18afSJoe Perches 2184cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2185de7d4f0eSAndy Whitcroft our $clean = 0; 21866c72ffaaSAndy Whitcroft our $cnt_error++; 21873705ce5bSJoe Perches return 1; 2188de7d4f0eSAndy Whitcroft } 21893705ce5bSJoe Perches return 0; 2190773647a0SAndy Whitcroft} 2191de7d4f0eSAndy Whitcroftsub WARN { 2192cbec18afSJoe Perches my ($type, $msg) = @_; 2193cbec18afSJoe Perches 2194cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2195de7d4f0eSAndy Whitcroft our $clean = 0; 21966c72ffaaSAndy Whitcroft our $cnt_warn++; 21973705ce5bSJoe Perches return 1; 2198de7d4f0eSAndy Whitcroft } 21993705ce5bSJoe Perches return 0; 2200773647a0SAndy Whitcroft} 2201de7d4f0eSAndy Whitcroftsub CHK { 2202cbec18afSJoe Perches my ($type, $msg) = @_; 2203cbec18afSJoe Perches 2204cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2205de7d4f0eSAndy Whitcroft our $clean = 0; 22066c72ffaaSAndy Whitcroft our $cnt_chk++; 22073705ce5bSJoe Perches return 1; 22086c72ffaaSAndy Whitcroft } 22093705ce5bSJoe Perches return 0; 2210de7d4f0eSAndy Whitcroft} 2211de7d4f0eSAndy Whitcroft 22126ecd9674SAndy Whitcroftsub check_absolute_file { 22136ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 22146ecd9674SAndy Whitcroft my $file = $absolute; 22156ecd9674SAndy Whitcroft 22166ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 22176ecd9674SAndy Whitcroft 22186ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 22196ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 22206ecd9674SAndy Whitcroft if (-f "$root/$file") { 22216ecd9674SAndy Whitcroft ##print "file<$file>\n"; 22226ecd9674SAndy Whitcroft last; 22236ecd9674SAndy Whitcroft } 22246ecd9674SAndy Whitcroft } 22256ecd9674SAndy Whitcroft if (! -f _) { 22266ecd9674SAndy Whitcroft return 0; 22276ecd9674SAndy Whitcroft } 22286ecd9674SAndy Whitcroft 22296ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 22306ecd9674SAndy Whitcroft my $prefix = $absolute; 22316ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 22326ecd9674SAndy Whitcroft 22336ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 22346ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2235000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2236000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 22376ecd9674SAndy Whitcroft } 22386ecd9674SAndy Whitcroft} 22396ecd9674SAndy Whitcroft 22403705ce5bSJoe Perchessub trim { 22413705ce5bSJoe Perches my ($string) = @_; 22423705ce5bSJoe Perches 2243b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2244b34c648bSJoe Perches 2245b34c648bSJoe Perches return $string; 2246b34c648bSJoe Perches} 2247b34c648bSJoe Perches 2248b34c648bSJoe Perchessub ltrim { 2249b34c648bSJoe Perches my ($string) = @_; 2250b34c648bSJoe Perches 2251b34c648bSJoe Perches $string =~ s/^\s+//; 2252b34c648bSJoe Perches 2253b34c648bSJoe Perches return $string; 2254b34c648bSJoe Perches} 2255b34c648bSJoe Perches 2256b34c648bSJoe Perchessub rtrim { 2257b34c648bSJoe Perches my ($string) = @_; 2258b34c648bSJoe Perches 2259b34c648bSJoe Perches $string =~ s/\s+$//; 22603705ce5bSJoe Perches 22613705ce5bSJoe Perches return $string; 22623705ce5bSJoe Perches} 22633705ce5bSJoe Perches 226452ea8506SJoe Perchessub string_find_replace { 226552ea8506SJoe Perches my ($string, $find, $replace) = @_; 226652ea8506SJoe Perches 226752ea8506SJoe Perches $string =~ s/$find/$replace/g; 226852ea8506SJoe Perches 226952ea8506SJoe Perches return $string; 227052ea8506SJoe Perches} 227152ea8506SJoe Perches 22723705ce5bSJoe Perchessub tabify { 22733705ce5bSJoe Perches my ($leading) = @_; 22743705ce5bSJoe Perches 2275713a09deSAntonio Borneo my $source_indent = $tabsize; 22763705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 22773705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 22783705ce5bSJoe Perches 22793705ce5bSJoe Perches #convert leading spaces to tabs 22803705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 22813705ce5bSJoe Perches #Remove spaces before a tab 22823705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 22833705ce5bSJoe Perches 22843705ce5bSJoe Perches return "$leading"; 22853705ce5bSJoe Perches} 22863705ce5bSJoe Perches 2287d1fe9c09SJoe Perchessub pos_last_openparen { 2288d1fe9c09SJoe Perches my ($line) = @_; 2289d1fe9c09SJoe Perches 2290d1fe9c09SJoe Perches my $pos = 0; 2291d1fe9c09SJoe Perches 2292d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2293d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2294d1fe9c09SJoe Perches 2295d1fe9c09SJoe Perches my $last_openparen = 0; 2296d1fe9c09SJoe Perches 2297d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2298d1fe9c09SJoe Perches return -1; 2299d1fe9c09SJoe Perches } 2300d1fe9c09SJoe Perches 2301d1fe9c09SJoe Perches my $len = length($line); 2302d1fe9c09SJoe Perches 2303d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2304d1fe9c09SJoe Perches my $string = substr($line, $pos); 2305d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2306d1fe9c09SJoe Perches $pos += length($1) - 1; 2307d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2308d1fe9c09SJoe Perches $last_openparen = $pos; 2309d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2310d1fe9c09SJoe Perches last; 2311d1fe9c09SJoe Perches } 2312d1fe9c09SJoe Perches } 2313d1fe9c09SJoe Perches 231491cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2315d1fe9c09SJoe Perches} 2316d1fe9c09SJoe Perches 2317f36d3eb8SJoe Perchessub get_raw_comment { 2318f36d3eb8SJoe Perches my ($line, $rawline) = @_; 2319f36d3eb8SJoe Perches my $comment = ''; 2320f36d3eb8SJoe Perches 2321f36d3eb8SJoe Perches for my $i (0 .. (length($line) - 1)) { 2322f36d3eb8SJoe Perches if (substr($line, $i, 1) eq "$;") { 2323f36d3eb8SJoe Perches $comment .= substr($rawline, $i, 1); 2324f36d3eb8SJoe Perches } 2325f36d3eb8SJoe Perches } 2326f36d3eb8SJoe Perches 2327f36d3eb8SJoe Perches return $comment; 2328f36d3eb8SJoe Perches} 2329f36d3eb8SJoe Perches 23300a920b5bSAndy Whitcroftsub process { 23310a920b5bSAndy Whitcroft my $filename = shift; 23320a920b5bSAndy Whitcroft 23330a920b5bSAndy Whitcroft my $linenr=0; 23340a920b5bSAndy Whitcroft my $prevline=""; 2335c2fdda0dSAndy Whitcroft my $prevrawline=""; 23360a920b5bSAndy Whitcroft my $stashline=""; 2337c2fdda0dSAndy Whitcroft my $stashrawline=""; 23380a920b5bSAndy Whitcroft 23394a0df2efSAndy Whitcroft my $length; 23400a920b5bSAndy Whitcroft my $indent; 23410a920b5bSAndy Whitcroft my $previndent=0; 23420a920b5bSAndy Whitcroft my $stashindent=0; 23430a920b5bSAndy Whitcroft 2344de7d4f0eSAndy Whitcroft our $clean = 1; 23450a920b5bSAndy Whitcroft my $signoff = 0; 2346cd261496SGeert Uytterhoeven my $author = ''; 2347cd261496SGeert Uytterhoeven my $authorsignoff = 0; 23480a920b5bSAndy Whitcroft my $is_patch = 0; 2349133712a2SRob Herring my $is_binding_patch = -1; 235029ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 235115662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 235244d303ebSJoe Perches my $has_patch_separator = 0; #Found a --- line 2353ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2354490b292cSJoe Perches my $commit_log_lines = 0; #Number of commit log lines 2355bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 23562a076f40SJoe Perches my $commit_log_long_line = 0; 2357e518e9a5SJoe Perches my $commit_log_has_diff = 0; 235813f1937eSJoe Perches my $reported_maintainer_file = 0; 2359fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2360fa64205dSPasi Savanainen 2361365dd4eaSJoe Perches my $last_blank_line = 0; 23625e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2363365dd4eaSJoe Perches 236413214adfSAndy Whitcroft our @report = (); 23656c72ffaaSAndy Whitcroft our $cnt_lines = 0; 23666c72ffaaSAndy Whitcroft our $cnt_error = 0; 23676c72ffaaSAndy Whitcroft our $cnt_warn = 0; 23686c72ffaaSAndy Whitcroft our $cnt_chk = 0; 23696c72ffaaSAndy Whitcroft 23700a920b5bSAndy Whitcroft # Trace the real file/line as we go. 23710a920b5bSAndy Whitcroft my $realfile = ''; 23720a920b5bSAndy Whitcroft my $realline = 0; 23730a920b5bSAndy Whitcroft my $realcnt = 0; 23740a920b5bSAndy Whitcroft my $here = ''; 237577cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 23760a920b5bSAndy Whitcroft my $in_comment = 0; 2377c2fdda0dSAndy Whitcroft my $comment_edge = 0; 23780a920b5bSAndy Whitcroft my $first_line = 0; 23791e855726SWolfram Sang my $p1_prefix = ''; 23800a920b5bSAndy Whitcroft 238113214adfSAndy Whitcroft my $prev_values = 'E'; 238213214adfSAndy Whitcroft 238313214adfSAndy Whitcroft # suppression flags 2384773647a0SAndy Whitcroft my %suppress_ifbraces; 2385170d3a22SAndy Whitcroft my %suppress_whiletrailers; 23862b474a1aSAndy Whitcroft my %suppress_export; 23873e469cdcSAndy Whitcroft my $suppress_statement = 0; 2388653d4876SAndy Whitcroft 23897e51f197SJoe Perches my %signatures = (); 2390323c1260SJoe Perches 2391c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2392de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2393c2fdda0dSAndy Whitcroft # 2394de7d4f0eSAndy Whitcroft my @setup_docs = (); 2395de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2396773647a0SAndy Whitcroft 2397d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2398d8b07710SJoe Perches 23999f3a8992SRob Herring my $checklicenseline = 1; 24009f3a8992SRob Herring 2401773647a0SAndy Whitcroft sanitise_line_reset(); 2402c2fdda0dSAndy Whitcroft my $line; 2403c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2404773647a0SAndy Whitcroft $linenr++; 2405773647a0SAndy Whitcroft $line = $rawline; 2406c2fdda0dSAndy Whitcroft 24073705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 24083705ce5bSJoe Perches 2409773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2410de7d4f0eSAndy Whitcroft $setup_docs = 0; 24112581ac7cSTim Froidcoeur if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) { 2412de7d4f0eSAndy Whitcroft $setup_docs = 1; 2413de7d4f0eSAndy Whitcroft } 2414773647a0SAndy Whitcroft #next; 2415de7d4f0eSAndy Whitcroft } 241674fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2417773647a0SAndy Whitcroft $realline=$1-1; 2418773647a0SAndy Whitcroft if (defined $2) { 2419773647a0SAndy Whitcroft $realcnt=$3+1; 2420773647a0SAndy Whitcroft } else { 2421773647a0SAndy Whitcroft $realcnt=1+1; 2422773647a0SAndy Whitcroft } 2423c45dcabdSAndy Whitcroft $in_comment = 0; 2424773647a0SAndy Whitcroft 2425773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2426773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2427773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2428773647a0SAndy Whitcroft # at context start. 2429773647a0SAndy Whitcroft my $edge; 243001fa9147SAndy Whitcroft my $cnt = $realcnt; 243101fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 243201fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 243301fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 243401fa9147SAndy Whitcroft $cnt--; 243501fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2436721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2437fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2438fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2439fae17daeSAndy Whitcroft ($edge) = $1; 2440fae17daeSAndy Whitcroft last; 2441fae17daeSAndy Whitcroft } 2442773647a0SAndy Whitcroft } 2443773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2444773647a0SAndy Whitcroft $in_comment = 1; 2445773647a0SAndy Whitcroft } 2446773647a0SAndy Whitcroft 2447773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2448773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2449773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2450773647a0SAndy Whitcroft if (!defined $edge && 245183242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2452773647a0SAndy Whitcroft { 2453773647a0SAndy Whitcroft $in_comment = 1; 2454773647a0SAndy Whitcroft } 2455773647a0SAndy Whitcroft 2456773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2457773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2458773647a0SAndy Whitcroft 2459171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2460773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2461171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2462773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2463773647a0SAndy Whitcroft } 2464773647a0SAndy Whitcroft push(@lines, $line); 2465773647a0SAndy Whitcroft 2466773647a0SAndy Whitcroft if ($realcnt > 1) { 2467773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2468773647a0SAndy Whitcroft } else { 2469773647a0SAndy Whitcroft $realcnt = 0; 2470773647a0SAndy Whitcroft } 2471773647a0SAndy Whitcroft 2472773647a0SAndy Whitcroft #print "==>$rawline\n"; 2473773647a0SAndy Whitcroft #print "-->$line\n"; 2474de7d4f0eSAndy Whitcroft 2475de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2476de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2477de7d4f0eSAndy Whitcroft } 2478de7d4f0eSAndy Whitcroft } 2479de7d4f0eSAndy Whitcroft 24806c72ffaaSAndy Whitcroft $prefix = ''; 24816c72ffaaSAndy Whitcroft 2482773647a0SAndy Whitcroft $realcnt = 0; 2483773647a0SAndy Whitcroft $linenr = 0; 2484194f66fcSJoe Perches $fixlinenr = -1; 24850a920b5bSAndy Whitcroft foreach my $line (@lines) { 24860a920b5bSAndy Whitcroft $linenr++; 2487194f66fcSJoe Perches $fixlinenr++; 24881b5539b1SJoe Perches my $sline = $line; #copy of $line 24891b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 24900a920b5bSAndy Whitcroft 2491c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 2492f36d3eb8SJoe Perches my $raw_comment = get_raw_comment($line, $rawline); 24936c72ffaaSAndy Whitcroft 249412c253abSJoe Perches# check if it's a mode change, rename or start of a patch 249512c253abSJoe Perches if (!$in_commit_log && 249612c253abSJoe Perches ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 249712c253abSJoe Perches ($line =~ /^rename (?:from|to) \S+\s*$/ || 249812c253abSJoe Perches $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 249912c253abSJoe Perches $is_patch = 1; 250012c253abSJoe Perches } 250112c253abSJoe Perches 25020a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2503e518e9a5SJoe Perches if (!$in_commit_log && 250474fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 250574fd4f34SJoe Perches my $context = $4; 25060a920b5bSAndy Whitcroft $is_patch = 1; 25074a0df2efSAndy Whitcroft $first_line = $linenr + 1; 25080a920b5bSAndy Whitcroft $realline=$1-1; 25090a920b5bSAndy Whitcroft if (defined $2) { 25100a920b5bSAndy Whitcroft $realcnt=$3+1; 25110a920b5bSAndy Whitcroft } else { 25120a920b5bSAndy Whitcroft $realcnt=1+1; 25130a920b5bSAndy Whitcroft } 2514c2fdda0dSAndy Whitcroft annotate_reset(); 251513214adfSAndy Whitcroft $prev_values = 'E'; 251613214adfSAndy Whitcroft 2517773647a0SAndy Whitcroft %suppress_ifbraces = (); 2518170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 25192b474a1aSAndy Whitcroft %suppress_export = (); 25203e469cdcSAndy Whitcroft $suppress_statement = 0; 252174fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 252274fd4f34SJoe Perches $context_function = $1; 252374fd4f34SJoe Perches } else { 252474fd4f34SJoe Perches undef $context_function; 252574fd4f34SJoe Perches } 25260a920b5bSAndy Whitcroft next; 25270a920b5bSAndy Whitcroft 25284a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 25294a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 25304a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2531773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 25320a920b5bSAndy Whitcroft $realline++; 2533d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 25340a920b5bSAndy Whitcroft 25354a0df2efSAndy Whitcroft # Measure the line length and indent. 2536c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 25370a920b5bSAndy Whitcroft 25380a920b5bSAndy Whitcroft # Track the previous line. 25390a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 25400a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2541c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2542c2fdda0dSAndy Whitcroft 2543773647a0SAndy Whitcroft #warn "line<$line>\n"; 25446c72ffaaSAndy Whitcroft 2545d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2546d8aaf121SAndy Whitcroft $realcnt--; 25470a920b5bSAndy Whitcroft } 25480a920b5bSAndy Whitcroft 2549cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2550cc77cdcaSAndy Whitcroft 25516c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 25526c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2553773647a0SAndy Whitcroft 25542ac73b4fSJoe Perches my $found_file = 0; 2555773647a0SAndy Whitcroft # extract the filename as it passes 25563bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 25573bf9a009SRabin Vincent $realfile = $1; 25582b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2559270c49a0SJoe Perches $in_commit_log = 0; 25602ac73b4fSJoe Perches $found_file = 1; 25613bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2562773647a0SAndy Whitcroft $realfile = $1; 25632b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2564270c49a0SJoe Perches $in_commit_log = 0; 25651e855726SWolfram Sang 25661e855726SWolfram Sang $p1_prefix = $1; 2567e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2568e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2569000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2570000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 25711e855726SWolfram Sang } 2572773647a0SAndy Whitcroft 2573c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2574000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2575000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2576773647a0SAndy Whitcroft } 25772ac73b4fSJoe Perches $found_file = 1; 25782ac73b4fSJoe Perches } 25792ac73b4fSJoe Perches 258034d8815fSJoe Perches#make up the handle for any error we report on this line 258134d8815fSJoe Perches if ($showfile) { 258234d8815fSJoe Perches $prefix = "$realfile:$realline: " 258334d8815fSJoe Perches } elsif ($emacs) { 25847d3a9f67SJoe Perches if ($file) { 25857d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 25867d3a9f67SJoe Perches } else { 258734d8815fSJoe Perches $prefix = "$filename:$linenr: "; 258834d8815fSJoe Perches } 25897d3a9f67SJoe Perches } 259034d8815fSJoe Perches 25912ac73b4fSJoe Perches if ($found_file) { 259285b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 259385b0ee18SJoe Perches WARN("OBSOLETE", 259485b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 259585b0ee18SJoe Perches } 25967bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 25972ac73b4fSJoe Perches $check = 1; 25982ac73b4fSJoe Perches } else { 25992ac73b4fSJoe Perches $check = $check_orig; 26002ac73b4fSJoe Perches } 26019f3a8992SRob Herring $checklicenseline = 1; 2602133712a2SRob Herring 2603133712a2SRob Herring if ($realfile !~ /^MAINTAINERS/) { 2604133712a2SRob Herring my $last_binding_patch = $is_binding_patch; 2605133712a2SRob Herring 2606133712a2SRob Herring $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@; 2607133712a2SRob Herring 2608133712a2SRob Herring if (($last_binding_patch != -1) && 2609133712a2SRob Herring ($last_binding_patch ^ $is_binding_patch)) { 2610133712a2SRob Herring WARN("DT_SPLIT_BINDING_PATCH", 2611858e6845SMauro Carvalho Chehab "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n"); 2612133712a2SRob Herring } 2613133712a2SRob Herring } 2614133712a2SRob Herring 2615773647a0SAndy Whitcroft next; 2616773647a0SAndy Whitcroft } 2617773647a0SAndy Whitcroft 2618389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 26190a920b5bSAndy Whitcroft 2620c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2621c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2622c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 26230a920b5bSAndy Whitcroft 26246c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 26256c72ffaaSAndy Whitcroft 2626490b292cSJoe Perches# Verify the existence of a commit log if appropriate 2627490b292cSJoe Perches# 2 is used because a $signature is counted in $commit_log_lines 2628490b292cSJoe Perches if ($in_commit_log) { 2629490b292cSJoe Perches if ($line !~ /^\s*$/) { 2630490b292cSJoe Perches $commit_log_lines++; #could be a $signature 2631490b292cSJoe Perches } 2632490b292cSJoe Perches } elsif ($has_commit_log && $commit_log_lines < 2) { 2633490b292cSJoe Perches WARN("COMMIT_MESSAGE", 2634490b292cSJoe Perches "Missing commit description - Add an appropriate one\n"); 2635490b292cSJoe Perches $commit_log_lines = 2; #warn only once 2636490b292cSJoe Perches } 2637490b292cSJoe Perches 2638e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2639e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2640e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2641e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2642e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2643e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2644e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2645e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2646e518e9a5SJoe Perches $commit_log_has_diff = 1; 2647e518e9a5SJoe Perches } 2648e518e9a5SJoe Perches 26493bf9a009SRabin Vincent# Check for incorrect file permissions 26503bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 26513bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 265204db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 265304db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2654000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2655000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 26563bf9a009SRabin Vincent } 26573bf9a009SRabin Vincent } 26583bf9a009SRabin Vincent 2659cd261496SGeert Uytterhoeven# Check the patch for a From: 2660cd261496SGeert Uytterhoeven if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { 2661cd261496SGeert Uytterhoeven $author = $1; 2662cd261496SGeert Uytterhoeven $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); 2663cd261496SGeert Uytterhoeven $author =~ s/"//g; 2664dfa05c28SJoe Perches $author = reformat_email($author); 2665cd261496SGeert Uytterhoeven } 2666cd261496SGeert Uytterhoeven 266720112475SJoe Perches# Check the patch for a signoff: 2668dfa05c28SJoe Perches if ($line =~ /^\s*signed-off-by:\s*(.*)/i) { 26694a0df2efSAndy Whitcroft $signoff++; 267015662b3eSJoe Perches $in_commit_log = 0; 2671cd261496SGeert Uytterhoeven if ($author ne '') { 2672dfa05c28SJoe Perches if (same_email_addresses($1, $author)) { 2673cd261496SGeert Uytterhoeven $authorsignoff = 1; 2674cd261496SGeert Uytterhoeven } 2675cd261496SGeert Uytterhoeven } 26760a920b5bSAndy Whitcroft } 267720112475SJoe Perches 267844d303ebSJoe Perches# Check for patch separator 267944d303ebSJoe Perches if ($line =~ /^---$/) { 268044d303ebSJoe Perches $has_patch_separator = 1; 268144d303ebSJoe Perches $in_commit_log = 0; 268244d303ebSJoe Perches } 268344d303ebSJoe Perches 2684e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2685e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2686e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2687e0d975b1SJoe Perches $reported_maintainer_file = 1; 2688e0d975b1SJoe Perches } 2689e0d975b1SJoe Perches 269020112475SJoe Perches# Check signature styles 2691270c49a0SJoe Perches if (!$in_header_lines && 2692ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 269320112475SJoe Perches my $space_before = $1; 269420112475SJoe Perches my $sign_off = $2; 269520112475SJoe Perches my $space_after = $3; 269620112475SJoe Perches my $email = $4; 269720112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 269820112475SJoe Perches 2699ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2700ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2701ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2702ce0338dfSJoe Perches } 270320112475SJoe Perches if (defined $space_before && $space_before ne "") { 27043705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 27053705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 27063705ce5bSJoe Perches $fix) { 2707194f66fcSJoe Perches $fixed[$fixlinenr] = 27083705ce5bSJoe Perches "$ucfirst_sign_off $email"; 27093705ce5bSJoe Perches } 271020112475SJoe Perches } 271120112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 27123705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 27133705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 27143705ce5bSJoe Perches $fix) { 2715194f66fcSJoe Perches $fixed[$fixlinenr] = 27163705ce5bSJoe Perches "$ucfirst_sign_off $email"; 27173705ce5bSJoe Perches } 27183705ce5bSJoe Perches 271920112475SJoe Perches } 272020112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 27213705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 27223705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 27233705ce5bSJoe Perches $fix) { 2724194f66fcSJoe Perches $fixed[$fixlinenr] = 27253705ce5bSJoe Perches "$ucfirst_sign_off $email"; 27263705ce5bSJoe Perches } 272720112475SJoe Perches } 272820112475SJoe Perches 2729dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 273020112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 273120112475SJoe Perches if ($suggested_email eq "") { 2732000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2733000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 273420112475SJoe Perches } else { 273520112475SJoe Perches my $dequoted = $suggested_email; 273620112475SJoe Perches $dequoted =~ s/^"//; 273720112475SJoe Perches $dequoted =~ s/" </ </; 273820112475SJoe Perches # Don't force email to have quotes 273920112475SJoe Perches # Allow just an angle bracketed address 2740dfa05c28SJoe Perches if (!same_email_addresses($email, $suggested_email)) { 2741000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2742000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 274320112475SJoe Perches } 27440a920b5bSAndy Whitcroft } 27457e51f197SJoe Perches 27467e51f197SJoe Perches# Check for duplicate signatures 27477e51f197SJoe Perches my $sig_nospace = $line; 27487e51f197SJoe Perches $sig_nospace =~ s/\s//g; 27497e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 27507e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 27517e51f197SJoe Perches WARN("BAD_SIGN_OFF", 27527e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 27537e51f197SJoe Perches } else { 27547e51f197SJoe Perches $signatures{$sig_nospace} = 1; 27557e51f197SJoe Perches } 27566c5d24eeSSean Christopherson 27576c5d24eeSSean Christopherson# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email 27586c5d24eeSSean Christopherson if ($sign_off =~ /^co-developed-by:$/i) { 27596c5d24eeSSean Christopherson if ($email eq $author) { 27606c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 27616c5d24eeSSean Christopherson "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline); 27626c5d24eeSSean Christopherson } 27636c5d24eeSSean Christopherson if (!defined $lines[$linenr]) { 27646c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 27656c5d24eeSSean Christopherson "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline); 27666c5d24eeSSean Christopherson } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) { 27676c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 27686c5d24eeSSean Christopherson "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 27696c5d24eeSSean Christopherson } elsif ($1 ne $email) { 27706c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 27716c5d24eeSSean Christopherson "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 27726c5d24eeSSean Christopherson } 27736c5d24eeSSean Christopherson } 27740a920b5bSAndy Whitcroft } 27750a920b5bSAndy Whitcroft 2776a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2777a2fe16b9SJoe Perches if ($in_header_lines && 2778a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2779a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2780a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2781a2fe16b9SJoe Perches } 2782a2fe16b9SJoe Perches 278344d303ebSJoe Perches# Check for Gerrit Change-Ids not in any patch context 278444d303ebSJoe Perches if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) { 27857ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 278644d303ebSJoe Perches "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr); 27877ebd05efSChristopher Covington } 27887ebd05efSChristopher Covington 2789369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2790369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2791369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2792369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2793369c8dd3SJoe Perches # timestamp 2794634cffccSJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) || 2795634cffccSJoe Perches $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ || 2796634cffccSJoe Perches $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) { 2797634cffccSJoe Perches # stack dump address styles 2798369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2799369c8dd3SJoe Perches } 2800369c8dd3SJoe Perches 28012a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 28022a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2803bf4daf12SJoe Perches length($line) > 75 && 2804bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2805bf4daf12SJoe Perches # file delta changes 2806bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2807bf4daf12SJoe Perches # filename then : 2808bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2809bf4daf12SJoe Perches # A Fixes: or Link: line 2810bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 28112a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 28122a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 28132a076f40SJoe Perches $commit_log_long_line = 1; 28142a076f40SJoe Perches } 28152a076f40SJoe Perches 2816bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2817bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2818bf4daf12SJoe Perches $line =~ /^\s*$/) { 2819bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2820bf4daf12SJoe Perches } 2821bf4daf12SJoe Perches 28220d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2823369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2824a8972573SJohn Hubbard $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i && 2825e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 2826fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2827aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2828369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2829bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2830fe043ea1SJoe Perches my $init_char = "c"; 2831fe043ea1SJoe Perches my $orig_commit = ""; 28320d7835fcSJoe Perches my $short = 1; 28330d7835fcSJoe Perches my $long = 0; 28340d7835fcSJoe Perches my $case = 1; 28350d7835fcSJoe Perches my $space = 1; 28360d7835fcSJoe Perches my $hasdesc = 0; 283719c146a6SJoe Perches my $hasparens = 0; 28380d7835fcSJoe Perches my $id = '0123456789ab'; 28390d7835fcSJoe Perches my $orig_desc = "commit description"; 28400d7835fcSJoe Perches my $description = ""; 28410d7835fcSJoe Perches 2842fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2843fe043ea1SJoe Perches $init_char = $1; 2844fe043ea1SJoe Perches $orig_commit = lc($2); 2845fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2846fe043ea1SJoe Perches $orig_commit = lc($1); 2847fe043ea1SJoe Perches } 2848fe043ea1SJoe Perches 28490d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 28500d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 28510d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 28520d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 28530d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 28540d7835fcSJoe Perches $orig_desc = $1; 285519c146a6SJoe Perches $hasparens = 1; 28560d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 28570d7835fcSJoe Perches defined $rawlines[$linenr] && 28580d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 28590d7835fcSJoe Perches $orig_desc = $1; 286019c146a6SJoe Perches $hasparens = 1; 2861b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2862b671fde0SJoe Perches defined $rawlines[$linenr] && 2863b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2864b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2865b671fde0SJoe Perches $orig_desc = $1; 2866b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2867b671fde0SJoe Perches $orig_desc .= " " . $1; 286819c146a6SJoe Perches $hasparens = 1; 28690d7835fcSJoe Perches } 28700d7835fcSJoe Perches 28710d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 28720d7835fcSJoe Perches $id, $orig_desc); 28730d7835fcSJoe Perches 2874948b133aSHeinrich Schuchardt if (defined($id) && 2875948b133aSHeinrich Schuchardt ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { 2876d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 28770d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 28780d7835fcSJoe Perches } 2879d311cd44SJoe Perches } 2880d311cd44SJoe Perches 288113f1937eSJoe Perches# Check for added, moved or deleted files 288213f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 288313f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 288413f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 288513f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 288613f1937eSJoe Perches (defined($1) || defined($2))))) { 2887a82603a8SAndrew Jeffery $is_patch = 1; 288813f1937eSJoe Perches $reported_maintainer_file = 1; 288913f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 289013f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 289113f1937eSJoe Perches } 289213f1937eSJoe Perches 2893e400edb1SRob Herring# Check for adding new DT bindings not in schema format 2894e400edb1SRob Herring if (!$in_commit_log && 2895e400edb1SRob Herring ($line =~ /^new file mode\s*\d+\s*$/) && 2896e400edb1SRob Herring ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) { 2897e400edb1SRob Herring WARN("DT_SCHEMA_BINDING_PATCH", 2898e400edb1SRob Herring "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n"); 2899e400edb1SRob Herring } 2900e400edb1SRob Herring 290100df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 29028905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2903000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2904000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 29056c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2906de7d4f0eSAndy Whitcroft } 2907de7d4f0eSAndy Whitcroft 2908de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2909de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2910171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2911171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2912171ae1a4SAndy Whitcroft 2913171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2914171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2915171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2916171ae1a4SAndy Whitcroft 291734d99219SJoe Perches CHK("INVALID_UTF8", 2918000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 291900df344fSAndy Whitcroft } 29200a920b5bSAndy Whitcroft 292115662b3eSJoe Perches# Check if it's the start of a commit log 292215662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 292315662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 2924eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 2925eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 292615662b3eSJoe Perches $in_header_lines = 0; 292715662b3eSJoe Perches $in_commit_log = 1; 2928ed43c4e5SAllen Hubbe $has_commit_log = 1; 292915662b3eSJoe Perches } 293015662b3eSJoe Perches 2931fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2932fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2933fa64205dSPasi Savanainen if ($in_header_lines && 2934fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2935fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2936fa64205dSPasi Savanainen $non_utf8_charset = 1; 2937fa64205dSPasi Savanainen } 2938fa64205dSPasi Savanainen 2939fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 294015662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2941fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 294215662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 294315662b3eSJoe Perches } 294415662b3eSJoe Perches 2945d6430f71SJoe Perches# Check for absolute kernel paths in commit message 2946d6430f71SJoe Perches if ($tree && $in_commit_log) { 2947d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 2948d6430f71SJoe Perches my $file = $1; 2949d6430f71SJoe Perches 2950d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 2951d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 2952d6430f71SJoe Perches # 2953d6430f71SJoe Perches } else { 2954d6430f71SJoe Perches check_absolute_file($file, $herecurr); 2955d6430f71SJoe Perches } 2956d6430f71SJoe Perches } 2957d6430f71SJoe Perches } 2958d6430f71SJoe Perches 295966b47b4aSKees Cook# Check for various typo / spelling mistakes 296066d7a382SJoe Perches if (defined($misspellings) && 296166d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2962ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 296366b47b4aSKees Cook my $typo = $1; 296466b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 296566b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 296666b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 29670675a8fbSJean Delvare my $msg_level = \&WARN; 29680675a8fbSJean Delvare $msg_level = \&CHK if ($file); 29690675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 297066b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 297166b47b4aSKees Cook $fix) { 297266b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 297366b47b4aSKees Cook } 297466b47b4aSKees Cook } 297566b47b4aSKees Cook } 297666b47b4aSKees Cook 2977a8dd86bfSMatteo Croce# check for invalid commit id 2978a8dd86bfSMatteo Croce if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) { 2979a8dd86bfSMatteo Croce my $id; 2980a8dd86bfSMatteo Croce my $description; 2981a8dd86bfSMatteo Croce ($id, $description) = git_commit_info($2, undef, undef); 2982a8dd86bfSMatteo Croce if (!defined($id)) { 2983a8dd86bfSMatteo Croce WARN("UNKNOWN_COMMIT_ID", 2984a8dd86bfSMatteo Croce "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr); 2985a8dd86bfSMatteo Croce } 2986a8dd86bfSMatteo Croce } 2987a8dd86bfSMatteo Croce 298830670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 298930670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 299000df344fSAndy Whitcroft 29910a920b5bSAndy Whitcroft#trailing whitespace 29929c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2993c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2994d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2995d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2996d5e616fcSJoe Perches $fix) { 2997194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2998d5e616fcSJoe Perches } 2999c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 3000c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 30013705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 30023705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 30033705ce5bSJoe Perches $fix) { 3004194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 30053705ce5bSJoe Perches } 30063705ce5bSJoe Perches 3007d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 30080a920b5bSAndy Whitcroft } 30095368df20SAndy Whitcroft 30104783f894SJosh Triplett# Check for FSF mailing addresses. 3011109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 30121bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 30133e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 30143e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 30154783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 30160675a8fbSJean Delvare my $msg_level = \&ERROR; 30170675a8fbSJean Delvare $msg_level = \&CHK if ($file); 30180675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 30194783f894SJosh 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) 30204783f894SJosh Triplett } 30214783f894SJosh Triplett 30223354957aSAndi Kleen# check for Kconfig help text having a real description 30239fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 30249fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 30253354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 3026678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 3027678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 3028678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 3029678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 30303354957aSAndi Kleen my $length = 0; 30319fe287d7SAndy Whitcroft my $cnt = $realcnt; 30329fe287d7SAndy Whitcroft my $ln = $linenr + 1; 30339fe287d7SAndy Whitcroft my $f; 3034a1385803SAndy Whitcroft my $is_start = 0; 30359fe287d7SAndy Whitcroft my $is_end = 0; 3036a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 30379fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 30389fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 30399fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 30409fe287d7SAndy Whitcroft 30419fe287d7SAndy Whitcroft next if ($f =~ /^-/); 30428d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 3043a1385803SAndy Whitcroft 304486adf1a0SUlf Magnusson if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 3045a1385803SAndy Whitcroft $is_start = 1; 304684af7a61SUlf Magnusson } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) { 304784af7a61SUlf Magnusson if ($lines[$ln - 1] =~ "---help---") { 304884af7a61SUlf Magnusson WARN("CONFIG_DESCRIPTION", 304984af7a61SUlf Magnusson "prefer 'help' over '---help---' for new help texts\n" . $herecurr); 305084af7a61SUlf Magnusson } 3051a1385803SAndy Whitcroft $length = -1; 3052a1385803SAndy Whitcroft } 3053a1385803SAndy Whitcroft 30549fe287d7SAndy Whitcroft $f =~ s/^.//; 30553354957aSAndi Kleen $f =~ s/#.*//; 30563354957aSAndi Kleen $f =~ s/^\s+//; 30573354957aSAndi Kleen next if ($f =~ /^$/); 3058678ae162SUlf Magnusson 3059678ae162SUlf Magnusson # This only checks context lines in the patch 3060678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 3061678ae162SUlf Magnusson # positives, even though some of these are 3062678ae162SUlf Magnusson # common words in help texts 3063678ae162SUlf Magnusson if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| 3064678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 30659fe287d7SAndy Whitcroft $is_end = 1; 30669fe287d7SAndy Whitcroft last; 30679fe287d7SAndy Whitcroft } 30683354957aSAndi Kleen $length++; 30693354957aSAndi Kleen } 307056193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 3071000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 307256193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 307356193274SVadim Bendebury } 3074a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 30753354957aSAndi Kleen } 30763354957aSAndi Kleen 30777ccf41a8SJoe Perches# check MAINTAINERS entries 30787ccf41a8SJoe Perches if ($realfile =~ /^MAINTAINERS$/) { 30797ccf41a8SJoe Perches# check MAINTAINERS entries for the right form 30807ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 3081628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 3082628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 3083628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 3084628f91a2SJoe Perches $fix) { 3085628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 3086628f91a2SJoe Perches } 3087628f91a2SJoe Perches } 30887ccf41a8SJoe Perches# check MAINTAINERS entries for the right ordering too 30897ccf41a8SJoe Perches my $preferred_order = 'MRLSWQBCPTFXNK'; 30907ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 30917ccf41a8SJoe Perches $prevrawline =~ /^[\+ ][A-Z]:/) { 30927ccf41a8SJoe Perches $rawline =~ /^\+([A-Z]):\s*(.*)/; 30937ccf41a8SJoe Perches my $cur = $1; 30947ccf41a8SJoe Perches my $curval = $2; 30957ccf41a8SJoe Perches $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/; 30967ccf41a8SJoe Perches my $prev = $1; 30977ccf41a8SJoe Perches my $prevval = $2; 30987ccf41a8SJoe Perches my $curindex = index($preferred_order, $cur); 30997ccf41a8SJoe Perches my $previndex = index($preferred_order, $prev); 31007ccf41a8SJoe Perches if ($curindex < 0) { 31017ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 31027ccf41a8SJoe Perches "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr); 31037ccf41a8SJoe Perches } else { 31047ccf41a8SJoe Perches if ($previndex >= 0 && $curindex < $previndex) { 31057ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 31067ccf41a8SJoe Perches "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev); 31077ccf41a8SJoe Perches } elsif ((($prev eq 'F' && $cur eq 'F') || 31087ccf41a8SJoe Perches ($prev eq 'X' && $cur eq 'X')) && 31097ccf41a8SJoe Perches ($prevval cmp $curval) > 0) { 31107ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 31117ccf41a8SJoe Perches "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev); 31127ccf41a8SJoe Perches } 31137ccf41a8SJoe Perches } 31147ccf41a8SJoe Perches } 31157ccf41a8SJoe Perches } 3116628f91a2SJoe Perches 3117327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 3118327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 3119327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 3120327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 3121327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 3122327953e9SChristoph Jaeger } 3123327953e9SChristoph Jaeger 3124c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 3125c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 3126c68e5878SArnaud Lacombe my $flag = $1; 3127c68e5878SArnaud Lacombe my $replacement = { 3128c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 3129c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 3130c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 3131c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 3132c68e5878SArnaud Lacombe }; 3133c68e5878SArnaud Lacombe 3134c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 3135c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 3136c68e5878SArnaud Lacombe } 3137c68e5878SArnaud Lacombe 3138bff5da43SRob Herring# check for DT compatible documentation 31397dd05b38SFlorian Vaussard if (defined $root && 31407dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 31417dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 31427dd05b38SFlorian Vaussard 3143bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 3144bff5da43SRob Herring 3145cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 3146852d095dSRob Herring my $vp_file = $dt_path . "vendor-prefixes.yaml"; 3147cc93319bSFlorian Vaussard 3148bff5da43SRob Herring foreach my $compat (@compats) { 3149bff5da43SRob Herring my $compat2 = $compat; 3150185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 3151185d566bSRob Herring my $compat3 = $compat; 3152185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 3153185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 3154bff5da43SRob Herring if ( $? >> 8 ) { 3155bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3156bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 3157bff5da43SRob Herring } 3158bff5da43SRob Herring 31594fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 31604fbf32a6SFlorian Vaussard my $vendor = $1; 3161852d095dSRob Herring `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`; 3162bff5da43SRob Herring if ( $? >> 8 ) { 3163bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3164cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 3165bff5da43SRob Herring } 3166bff5da43SRob Herring } 3167bff5da43SRob Herring } 3168bff5da43SRob Herring 31699f3a8992SRob Herring# check for using SPDX license tag at beginning of files 31709f3a8992SRob Herring if ($realline == $checklicenseline) { 31719f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 31729f3a8992SRob Herring $checklicenseline = 2; 31739f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 31749f3a8992SRob Herring my $comment = ""; 31759f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 31769f3a8992SRob Herring $comment = '/*'; 31779f3a8992SRob Herring } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 31789f3a8992SRob Herring $comment = '//'; 3179c8df0ab6SLubomir Rintel } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) { 31809f3a8992SRob Herring $comment = '#'; 31819f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 31829f3a8992SRob Herring $comment = '..'; 31839f3a8992SRob Herring } 31849f3a8992SRob Herring 3185fdf13693SJoe Perches# check SPDX comment style for .[chsS] files 3186fdf13693SJoe Perches if ($realfile =~ /\.[chsS]$/ && 3187fdf13693SJoe Perches $rawline =~ /SPDX-License-Identifier:/ && 3188ffbce897SJoe Perches $rawline !~ m@^\+\s*\Q$comment\E\s*@) { 3189fdf13693SJoe Perches WARN("SPDX_LICENSE_TAG", 3190fdf13693SJoe Perches "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr); 3191fdf13693SJoe Perches } 3192fdf13693SJoe Perches 31939f3a8992SRob Herring if ($comment !~ /^$/ && 3194ffbce897SJoe Perches $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) { 31959f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 31969f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 31973b6e8ac9SJoe Perches } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) { 31983b6e8ac9SJoe Perches my $spdx_license = $1; 31993b6e8ac9SJoe Perches if (!is_SPDX_License_valid($spdx_license)) { 32003b6e8ac9SJoe Perches WARN("SPDX_LICENSE_TAG", 32013b6e8ac9SJoe Perches "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr); 32023b6e8ac9SJoe Perches } 320350c92900SLubomir Rintel if ($realfile =~ m@^Documentation/devicetree/bindings/@ && 320450c92900SLubomir Rintel not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) { 320550c92900SLubomir Rintel my $msg_level = \&WARN; 320650c92900SLubomir Rintel $msg_level = \&CHK if ($file); 320750c92900SLubomir Rintel if (&{$msg_level}("SPDX_LICENSE_TAG", 320850c92900SLubomir Rintel 320950c92900SLubomir Rintel "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) && 321050c92900SLubomir Rintel $fix) { 321150c92900SLubomir Rintel $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/; 321250c92900SLubomir Rintel } 321350c92900SLubomir Rintel } 32149f3a8992SRob Herring } 32159f3a8992SRob Herring } 32169f3a8992SRob Herring } 32179f3a8992SRob Herring 32185368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 3219d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 32205368df20SAndy Whitcroft 3221a8da38a9SJoe Perches# check for using SPDX-License-Identifier on the wrong line number 3222a8da38a9SJoe Perches if ($realline != $checklicenseline && 3223a8da38a9SJoe Perches $rawline =~ /\bSPDX-License-Identifier:/ && 3224a8da38a9SJoe Perches substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) { 3225a8da38a9SJoe Perches WARN("SPDX_LICENSE_TAG", 3226a8da38a9SJoe Perches "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr); 3227a8da38a9SJoe Perches } 3228a8da38a9SJoe Perches 322947e0c88bSJoe Perches# line length limit (with some exclusions) 323047e0c88bSJoe Perches# 323147e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 323247e0c88bSJoe Perches# logging functions like pr_info that end in a string 323347e0c88bSJoe Perches# lines with a single string 323447e0c88bSJoe Perches# #defines that are a single string 32352e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 323647e0c88bSJoe Perches# 323747e0c88bSJoe Perches# There are 3 different line length message types: 3238ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 323947e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 324047e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 324147e0c88bSJoe Perches# 324247e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 324347e0c88bSJoe Perches# 324447e0c88bSJoe Perches 3245b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 324647e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 324747e0c88bSJoe Perches 324847e0c88bSJoe Perches # Check the allowed long line types first 324947e0c88bSJoe Perches 325047e0c88bSJoe Perches # logging functions that end in a string that starts 325147e0c88bSJoe Perches # before $max_line_length 325247e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 325347e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 325447e0c88bSJoe Perches $msg_type = ""; 325547e0c88bSJoe Perches 325647e0c88bSJoe Perches # lines with only strings (w/ possible termination) 325747e0c88bSJoe Perches # #defines with only strings 325847e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 325947e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 326047e0c88bSJoe Perches $msg_type = ""; 326147e0c88bSJoe Perches 3262cc147506SJoe Perches # More special cases 3263cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3264cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3265d560a5f8SJoe Perches $msg_type = ""; 3266d560a5f8SJoe Perches 32672e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 32682e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 32692e4bbbc5SAndreas Brauchli $msg_type = ""; 32702e4bbbc5SAndreas Brauchli 327147e0c88bSJoe Perches # Otherwise set the alternate message types 327247e0c88bSJoe Perches 327347e0c88bSJoe Perches # a comment starts before $max_line_length 327447e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 327547e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 327647e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 327747e0c88bSJoe Perches 327847e0c88bSJoe Perches # a quoted string starts before $max_line_length 327947e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 328047e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 328147e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 328247e0c88bSJoe Perches } 328347e0c88bSJoe Perches 328447e0c88bSJoe Perches if ($msg_type ne "" && 328547e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 3286bdc48fa1SJoe Perches my $msg_level = \&WARN; 3287bdc48fa1SJoe Perches $msg_level = \&CHK if ($file); 3288bdc48fa1SJoe Perches &{$msg_level}($msg_type, 3289bdc48fa1SJoe Perches "line length of $length exceeds $max_line_length columns\n" . $herecurr); 32900a920b5bSAndy Whitcroft } 329147e0c88bSJoe Perches } 32920a920b5bSAndy Whitcroft 32938905a67cSAndy Whitcroft# check for adding lines without a newline. 32948905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 3295000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 3296000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 32978905a67cSAndy Whitcroft } 32988905a67cSAndy Whitcroft 3299b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3300de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 33010a920b5bSAndy Whitcroft 33020a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 3303713a09deSAntonio Borneo# more than $tabsize must use tabs. 3304c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3305c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3306c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3307d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 33083705ce5bSJoe Perches if (ERROR("CODE_INDENT", 33093705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 33103705ce5bSJoe Perches $fix) { 3311194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 33123705ce5bSJoe Perches } 33130a920b5bSAndy Whitcroft } 33140a920b5bSAndy Whitcroft 331508e44365SAlberto Panizzo# check for space before tabs. 331608e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 331708e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 33183705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 33193705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 33203705ce5bSJoe Perches $fix) { 3321194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3322713a09deSAntonio Borneo s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} 3323194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3324c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 33253705ce5bSJoe Perches } 332608e44365SAlberto Panizzo } 332708e44365SAlberto Panizzo 33286a487211SJoe Perches# check for assignments on the start of a line 33296a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 33306a487211SJoe Perches CHK("ASSIGNMENT_CONTINUATIONS", 33316a487211SJoe Perches "Assignment operator '$1' should be on the previous line\n" . $hereprev); 33326a487211SJoe Perches } 33336a487211SJoe Perches 3334d1fe9c09SJoe Perches# check for && or || at the start of a line 3335d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 3336d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 3337d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 3338d1fe9c09SJoe Perches } 3339d1fe9c09SJoe Perches 3340a91e8994SJoe Perches# check indentation starts on a tab stop 33415b57980dSJoe Perches if ($perl_version_ok && 3342bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3343a91e8994SJoe Perches my $indent = length($1); 3344713a09deSAntonio Borneo if ($indent % $tabsize) { 3345a91e8994SJoe Perches if (WARN("TABSTOP", 3346a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3347a91e8994SJoe Perches $fix) { 3348713a09deSAntonio Borneo $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; 3349a91e8994SJoe Perches } 3350a91e8994SJoe Perches } 3351a91e8994SJoe Perches } 3352a91e8994SJoe Perches 3353d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 33545b57980dSJoe Perches if ($perl_version_ok && 3355fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3356d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3357d1fe9c09SJoe Perches my $oldindent = $1; 3358d1fe9c09SJoe Perches my $rest = $2; 3359d1fe9c09SJoe Perches 3360d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3361d1fe9c09SJoe Perches if ($pos >= 0) { 3362b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3363b34a26f3SJoe Perches my $newindent = $2; 3364d1fe9c09SJoe Perches 3365d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3366713a09deSAntonio Borneo "\t" x ($pos / $tabsize) . 3367713a09deSAntonio Borneo " " x ($pos % $tabsize); 3368d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3369d1fe9c09SJoe Perches 3370d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3371d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 33723705ce5bSJoe Perches 33733705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 33743705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 33753705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3376194f66fcSJoe Perches $fixed[$fixlinenr] =~ 33773705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 33783705ce5bSJoe Perches } 3379d1fe9c09SJoe Perches } 3380d1fe9c09SJoe Perches } 3381d1fe9c09SJoe Perches } 3382d1fe9c09SJoe Perches 33836ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 33846ab3a970SJoe Perches# avoid checking a few false positives: 33856ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 33866ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 33876ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 33886ab3a970SJoe Perches# multiline macros that define functions 33896ab3a970SJoe Perches# known attributes or the __attribute__ keyword 33906ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 33916ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 33923705ce5bSJoe Perches if (CHK("SPACING", 3393f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 33943705ce5bSJoe Perches $fix) { 3395194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3396f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 33973705ce5bSJoe Perches } 3398aad4f614SJoe Perches } 3399aad4f614SJoe Perches 340086406b1cSJoe Perches# Block comment styles 340186406b1cSJoe Perches# Networking with an initial /* 340205880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3403fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 340485ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 340585ad978cSJoe Perches $realline > 2) { 340605880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 340705880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 340805880600SJoe Perches } 340905880600SJoe Perches 341086406b1cSJoe Perches# Block comments use * on subsequent lines 341186406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 341286406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3413a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 341461135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3415a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 341686406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 341786406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3418a605e32eSJoe Perches } 3419a605e32eSJoe Perches 342086406b1cSJoe Perches# Block comments use */ on trailing lines 342186406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3422c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3423c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3424c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 342586406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 342686406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 342705880600SJoe Perches } 342805880600SJoe Perches 342908eb9b80SJoe Perches# Block comment * alignment 343008eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3431af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3432af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3433af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 343408eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3435af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3436af207524SJoe Perches my $oldindent; 343708eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3438af207524SJoe Perches if (defined($1)) { 3439af207524SJoe Perches $oldindent = expand_tabs($1); 3440af207524SJoe Perches } else { 3441af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3442af207524SJoe Perches $oldindent = expand_tabs($1); 3443af207524SJoe Perches } 344408eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 344508eb9b80SJoe Perches my $newindent = $1; 344608eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3447af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 344808eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 344908eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 345008eb9b80SJoe Perches } 345108eb9b80SJoe Perches } 345208eb9b80SJoe Perches 34537f619191SJoe Perches# check for missing blank lines after struct/union declarations 34547f619191SJoe Perches# with exceptions for various attributes and macros 34557f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 34567f619191SJoe Perches $line =~ /^\+/ && 34577f619191SJoe Perches !($line =~ /^\+\s*$/ || 34587f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 34597f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 34607f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 34617f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 34627f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 34637f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 34640bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 34657f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3466d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3467d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3468d752fcc8SJoe Perches $fix) { 3469f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3470d752fcc8SJoe Perches } 34717f619191SJoe Perches } 34727f619191SJoe Perches 3473365dd4eaSJoe Perches# check for multiple consecutive blank lines 3474365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3475365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3476365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3477d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3478d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3479d752fcc8SJoe Perches $fix) { 3480f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3481d752fcc8SJoe Perches } 3482d752fcc8SJoe Perches 3483365dd4eaSJoe Perches $last_blank_line = $linenr; 3484365dd4eaSJoe Perches } 3485365dd4eaSJoe Perches 34863b617e3bSJoe Perches# check for missing blank lines after declarations 34873f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 34883f7bac03SJoe Perches # actual declarations 34893f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 34905a4e1fd3SJoe Perches # function pointer declarations 34915a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 34923f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 34933f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 34943f7bac03SJoe Perches # known declaration macros 34953f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 34963f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 34973f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 34983f7bac03SJoe Perches # other possible extensions of declaration lines 34993f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 35003f7bac03SJoe Perches # not starting a section or a macro "\" extended line 35013f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 35023f7bac03SJoe Perches # looks like a declaration 35033f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 35045a4e1fd3SJoe Perches # function pointer declarations 35055a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 35063f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 35073f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 35083f7bac03SJoe Perches # known declaration macros 35093f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 35103f7bac03SJoe Perches # start of struct or union or enum 3511328b5f41SJoe Perches $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ || 35123f7bac03SJoe Perches # start or end of block or continuation of declaration 35133f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 35143f7bac03SJoe Perches # bitfield continuation 35153f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 35163f7bac03SJoe Perches # other possible extensions of declaration lines 35173f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 35183f7bac03SJoe Perches # indentation of previous and current line are the same 35193f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3520d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3521d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3522d752fcc8SJoe Perches $fix) { 3523f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3524d752fcc8SJoe Perches } 35253b617e3bSJoe Perches } 35263b617e3bSJoe Perches 35275f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 35286b4c5bebSAndy Whitcroft# Exceptions: 35296b4c5bebSAndy Whitcroft# 1) within comments 35306b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 35316b4c5bebSAndy Whitcroft# 3) hanging labels 35323705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 35335f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 35343705ce5bSJoe Perches if (WARN("LEADING_SPACE", 35353705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 35363705ce5bSJoe Perches $fix) { 3537194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 35383705ce5bSJoe Perches } 35395f7ddae6SRaffaele Recalcati } 35405f7ddae6SRaffaele Recalcati 3541b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3542b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3543b9ea10d6SAndy Whitcroft 35445751a24eSJoe Perches# check for unusual line ending [ or ( 35455751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 35465751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 35475751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 35485751a24eSJoe Perches } 35495751a24eSJoe Perches 35504dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 35514dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 35524dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 35534dbed76fSJoe Perches $context_function = $1; 35544dbed76fSJoe Perches } 35554dbed76fSJoe Perches 35564dbed76fSJoe Perches# check if this appears to be the end of function declaration 35574dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 35584dbed76fSJoe Perches undef $context_function; 35594dbed76fSJoe Perches } 35604dbed76fSJoe Perches 3561032a4c0fSJoe Perches# check indentation of any line with a bare else 3562840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3563032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3564032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3565032a4c0fSJoe Perches my $tabs = length($1) + 1; 3566840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3567840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3568840080a0SJoe Perches defined $lines[$linenr] && 3569840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3570032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3571032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3572032a4c0fSJoe Perches } 3573032a4c0fSJoe Perches } 3574032a4c0fSJoe Perches 3575c00df19aSJoe Perches# check indentation of a line with a break; 3576c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3577c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3578c00df19aSJoe Perches my $tabs = $1; 3579c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3580c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3581c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3582c00df19aSJoe Perches } 3583c00df19aSJoe Perches } 3584c00df19aSJoe Perches 3585c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3586cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3587000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3588000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3589c2fdda0dSAndy Whitcroft } 359022f2a2efSAndy Whitcroft 359156e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 359256e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 359356e77d70SJoe Perches WARN("HOTPLUG_SECTION", 359456e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 359556e77d70SJoe Perches } 359656e77d70SJoe Perches 35979c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 35982b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 35992b474a1aSAndy Whitcroft $realline_next); 36003e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 3601ca819864SJoe Perches if ($linenr > $suppress_statement && 36021b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3603170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3604f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3605171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3606171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3607171ae1a4SAndy Whitcroft 36083e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 36093e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 36103e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 36113e469cdcSAndy Whitcroft # until we hit end of it. 36123e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 36133e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 36143e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 36153e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 36163e469cdcSAndy Whitcroft } 3617f74bd194SAndy Whitcroft 36182b474a1aSAndy Whitcroft # Find the real next line. 36192b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 36202b474a1aSAndy Whitcroft if (defined $realline_next && 36212b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 36222b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 36232b474a1aSAndy Whitcroft $realline_next++; 36242b474a1aSAndy Whitcroft } 36252b474a1aSAndy Whitcroft 3626171ae1a4SAndy Whitcroft my $s = $stat; 3627171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3628cf655043SAndy Whitcroft 3629c2fdda0dSAndy Whitcroft # Ignore goto labels. 3630171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3631c2fdda0dSAndy Whitcroft 3632c2fdda0dSAndy Whitcroft # Ignore functions being called 3633171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3634c2fdda0dSAndy Whitcroft 3635463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3636463f2864SAndy Whitcroft 3637c45dcabdSAndy Whitcroft # declarations always start with types 3638d2506586SAndy 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) { 3639c45dcabdSAndy Whitcroft my $type = $1; 3640c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3641c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3642c45dcabdSAndy Whitcroft 36436c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3644a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3645c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3646c2fdda0dSAndy Whitcroft } 36478905a67cSAndy Whitcroft 36486c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 364965863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3650c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 36519c0ca6f9SAndy Whitcroft } 36528905a67cSAndy Whitcroft 36538905a67cSAndy Whitcroft # Check for any sort of function declaration. 36548905a67cSAndy Whitcroft # int foo(something bar, other baz); 36558905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3656171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 36578905a67cSAndy Whitcroft my ($name_len) = length($1); 36588905a67cSAndy Whitcroft 3659cf655043SAndy Whitcroft my $ctx = $s; 3660773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 36618905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3662cf655043SAndy Whitcroft 36638905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3664c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 36658905a67cSAndy Whitcroft 3666c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 36678905a67cSAndy Whitcroft } 36688905a67cSAndy Whitcroft } 36698905a67cSAndy Whitcroft } 36708905a67cSAndy Whitcroft 36719c0ca6f9SAndy Whitcroft } 36729c0ca6f9SAndy Whitcroft 367300df344fSAndy Whitcroft# 367400df344fSAndy Whitcroft# Checks which may be anchored in the context. 367500df344fSAndy Whitcroft# 367600df344fSAndy Whitcroft 367700df344fSAndy Whitcroft# Check for switch () and associated case and default 367800df344fSAndy Whitcroft# statements should be at the same indent. 367900df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 368000df344fSAndy Whitcroft my $err = ''; 368100df344fSAndy Whitcroft my $sep = ''; 368200df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 368300df344fSAndy Whitcroft shift(@ctx); 368400df344fSAndy Whitcroft for my $ctx (@ctx) { 368500df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 368600df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 368700df344fSAndy Whitcroft $indent != $cindent) { 368800df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 368900df344fSAndy Whitcroft $sep = ''; 369000df344fSAndy Whitcroft } else { 369100df344fSAndy Whitcroft $sep = "[...]\n"; 369200df344fSAndy Whitcroft } 369300df344fSAndy Whitcroft } 369400df344fSAndy Whitcroft if ($err ne '') { 3695000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3696000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3697de7d4f0eSAndy Whitcroft } 3698de7d4f0eSAndy Whitcroft } 3699de7d4f0eSAndy Whitcroft 3700de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3701de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 37020fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3703773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3704773647a0SAndy Whitcroft 37059c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 37068eef05ddSJoe Perches 37078eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 37088eef05ddSJoe Perches WARN("DEEP_INDENTATION", 37098eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 37108eef05ddSJoe Perches } 37118eef05ddSJoe Perches 3712de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3713de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3714de7d4f0eSAndy Whitcroft 3715548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3716548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3717de7d4f0eSAndy Whitcroft 3718548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3719548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3720548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3721548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3722548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3723773647a0SAndy Whitcroft $ctx_ln++; 3724773647a0SAndy Whitcroft } 3725548596d5SAndy Whitcroft 372653210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 372753210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3728773647a0SAndy Whitcroft 3729773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3730000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3731000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 373201464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 373300df344fSAndy Whitcroft } 3734773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3735773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3736773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3737773647a0SAndy Whitcroft { 37389c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 37399c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3740000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3741000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 374201464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 37439c0ca6f9SAndy Whitcroft } 37449c0ca6f9SAndy Whitcroft } 374500df344fSAndy Whitcroft } 374600df344fSAndy Whitcroft 37474d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 3748f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 37493e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 37503e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 37513e469cdcSAndy Whitcroft if (!defined $stat); 37524d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 37534d001e4dSAndy Whitcroft 37544d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 37554d001e4dSAndy Whitcroft 37569f5af480SJoe Perches # remove inline comments 37579f5af480SJoe Perches $s =~ s/$;/ /g; 37589f5af480SJoe Perches $c =~ s/$;/ /g; 37594d001e4dSAndy Whitcroft 37604d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 37616f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 37626f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 37634d001e4dSAndy Whitcroft 37649f5af480SJoe Perches # Make sure we remove the line prefixes as we have 37659f5af480SJoe Perches # none on the first line, and are going to readd them 37669f5af480SJoe Perches # where necessary. 37679f5af480SJoe Perches $s =~ s/\n./\n/gs; 37689f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 37699f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 37709f5af480SJoe Perches } 37719f5af480SJoe Perches 37724d001e4dSAndy Whitcroft # We want to check the first line inside the block 37734d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 37744d001e4dSAndy Whitcroft # 1) any blank line termination 37754d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 37764d001e4dSAndy Whitcroft # 3) any do (...) { 37774d001e4dSAndy Whitcroft my $continuation = 0; 37784d001e4dSAndy Whitcroft my $check = 0; 37794d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 37804d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 37814d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 37824d001e4dSAndy Whitcroft $continuation = 1; 37834d001e4dSAndy Whitcroft } 37849bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 37854d001e4dSAndy Whitcroft $check = 1; 37864d001e4dSAndy Whitcroft $cond_lines++; 37874d001e4dSAndy Whitcroft } 37884d001e4dSAndy Whitcroft 37894d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 37904d001e4dSAndy Whitcroft # preprocessor statement. 37914d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 37924d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 37934d001e4dSAndy Whitcroft $check = 0; 37944d001e4dSAndy Whitcroft } 37954d001e4dSAndy Whitcroft 37969bd49efeSAndy Whitcroft my $cond_ptr = -1; 3797740504c6SAndy Whitcroft $continuation = 0; 37989bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 37999bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 38004d001e4dSAndy Whitcroft 3801f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3802f16fa28fSAndy Whitcroft # is not linear. 3803f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3804f16fa28fSAndy Whitcroft $check = 0; 3805f16fa28fSAndy Whitcroft } 3806f16fa28fSAndy Whitcroft 38079bd49efeSAndy Whitcroft # Ignore: 38089bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 38099bd49efeSAndy Whitcroft # 2) preprocessor lines, and 38109bd49efeSAndy Whitcroft # 3) labels. 3811740504c6SAndy Whitcroft if ($continuation || 3812740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 38139bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 38149bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3815740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 381630dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 38179bd49efeSAndy Whitcroft $cond_lines++; 38189bd49efeSAndy Whitcroft } 38194d001e4dSAndy Whitcroft } 382030dad6ebSAndy Whitcroft } 38214d001e4dSAndy Whitcroft 38224d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 38234d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 38244d001e4dSAndy Whitcroft 38254d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 38264d001e4dSAndy Whitcroft # this is not this patch's fault. 38274d001e4dSAndy Whitcroft if (!defined($stat_real) || 38284d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 38294d001e4dSAndy Whitcroft $check = 0; 38304d001e4dSAndy Whitcroft } 38314d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 38324d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 38334d001e4dSAndy Whitcroft } 38344d001e4dSAndy Whitcroft 38359bd49efeSAndy 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"; 38364d001e4dSAndy Whitcroft 38379f5af480SJoe Perches if ($check && $s ne '' && 3838713a09deSAntonio Borneo (($sindent % $tabsize) != 0 || 38399f5af480SJoe Perches ($sindent < $indent) || 3840f6950a73SJoe Perches ($sindent == $indent && 3841f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 3842713a09deSAntonio Borneo ($sindent > $indent + $tabsize))) { 3843000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3844000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 38454d001e4dSAndy Whitcroft } 38464d001e4dSAndy Whitcroft } 38474d001e4dSAndy Whitcroft 38486c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 38496c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 38501f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 38511f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 38526c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3853c2fdda0dSAndy Whitcroft if ($dbg_values) { 3854c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3855cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3856cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 38571f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3858c2fdda0dSAndy Whitcroft } 38596c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 38606c72ffaaSAndy Whitcroft 386100df344fSAndy Whitcroft#ignore lines not being added 38623705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 386300df344fSAndy Whitcroft 386411ca40a0SJoe Perches# check for dereferences that span multiple lines 386511ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 386611ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 386711ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 386811ca40a0SJoe Perches my $ref = $1; 386911ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 387011ca40a0SJoe Perches $ref .= $1; 387111ca40a0SJoe Perches $ref =~ s/\s//g; 387211ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 387311ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 387411ca40a0SJoe Perches } 387511ca40a0SJoe Perches 3876a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3877c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3878a1ce18e4SJoe Perches my $type = $1; 3879a1ce18e4SJoe Perches my $var = $2; 3880207a8e84SJoe Perches $var = "" if (!defined $var); 3881207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3882a1ce18e4SJoe Perches my $sign = $1; 3883a1ce18e4SJoe Perches my $pointer = $2; 3884a1ce18e4SJoe Perches 3885a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3886a1ce18e4SJoe Perches 3887a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3888a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3889a1ce18e4SJoe Perches $fix) { 3890a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3891207a8e84SJoe Perches my $comp_pointer = $pointer; 3892207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 3893207a8e84SJoe Perches $decl .= $comp_pointer; 3894207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 3895207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 3896a1ce18e4SJoe Perches } 3897a1ce18e4SJoe Perches } 3898a1ce18e4SJoe Perches } 3899a1ce18e4SJoe Perches 3900653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 39017429c690SAndy Whitcroft if ($dbg_type) { 39027429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3903000d1cc1SJoe Perches ERROR("TEST_TYPE", 3904000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 39057429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3906000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3907000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 39087429c690SAndy Whitcroft } 3909653d4876SAndy Whitcroft next; 3910653d4876SAndy Whitcroft } 3911a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3912a1ef277eSAndy Whitcroft if ($dbg_attr) { 39139360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3914000d1cc1SJoe Perches ERROR("TEST_ATTR", 3915000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 39169360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3917000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3918000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3919a1ef277eSAndy Whitcroft } 3920a1ef277eSAndy Whitcroft next; 3921a1ef277eSAndy Whitcroft } 3922653d4876SAndy Whitcroft 3923f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 392499423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 392599423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3926d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3927d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3928f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3929f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3930f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3931d752fcc8SJoe Perches my $fixedline = $prevrawline; 3932d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3933f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3934d752fcc8SJoe Perches $fixedline = $line; 39358d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 3936f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3937d752fcc8SJoe Perches } 3938f0a594c1SAndy Whitcroft } 3939f0a594c1SAndy Whitcroft 394000df344fSAndy Whitcroft# 394100df344fSAndy Whitcroft# Checks which are anchored on the added line. 394200df344fSAndy Whitcroft# 394300df344fSAndy Whitcroft 3944653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3945c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3946653d4876SAndy Whitcroft my $path = $1; 3947653d4876SAndy Whitcroft if ($path =~ m{//}) { 3948000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3949495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3950495e9d84SJoe Perches } 3951495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3952495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3953495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3954653d4876SAndy Whitcroft } 3955653d4876SAndy Whitcroft } 3956653d4876SAndy Whitcroft 395700df344fSAndy Whitcroft# no C99 // comments 395800df344fSAndy Whitcroft if ($line =~ m{//}) { 39593705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 39603705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 39613705ce5bSJoe Perches $fix) { 3962194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 39633705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 39643705ce5bSJoe Perches my $comment = trim($1); 3965194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 39663705ce5bSJoe Perches } 39673705ce5bSJoe Perches } 396800df344fSAndy Whitcroft } 396900df344fSAndy Whitcroft # Remove C99 comments. 39700a920b5bSAndy Whitcroft $line =~ s@//.*@@; 39716c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 39720a920b5bSAndy Whitcroft 39732b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 39742b474a1aSAndy Whitcroft# the whole statement. 39752b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 39762b474a1aSAndy Whitcroft if (defined $realline_next && 39772b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 39782b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 39792b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 39802b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 39813cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 39823cbf62dfSAndy Whitcroft # a prefix: 39833cbf62dfSAndy Whitcroft # XXX(foo); 39843cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3985653d4876SAndy Whitcroft my $name = $1; 398687a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 39873cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 39883cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 39893cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 39903cbf62dfSAndy Whitcroft 39913cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 39922b474a1aSAndy Whitcroft \n.}\s*$| 399348012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 399448012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 399548012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 39962b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 39972b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 399848012058SAndy Whitcroft )/x) { 39992b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 40002b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 40012b474a1aSAndy Whitcroft } else { 40022b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 40030a920b5bSAndy Whitcroft } 40040a920b5bSAndy Whitcroft } 40052b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 40062b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 40072b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 40082b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 40092b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 40102b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 40112b474a1aSAndy Whitcroft } 40122b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 40132b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 4014000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 4015000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 40162b474a1aSAndy Whitcroft } 40170a920b5bSAndy Whitcroft 40185150bda4SJoe Eloff# check for global initialisers. 40196d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 4020d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 40216d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 4022d5e616fcSJoe Perches $fix) { 40236d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 4024d5e616fcSJoe Perches } 4025f0a594c1SAndy Whitcroft } 40260a920b5bSAndy Whitcroft# check for static initialisers. 40276d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 4028d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 40296d32f7a3SJoe Perches "do not initialise statics to $1\n" . 4030d5e616fcSJoe Perches $herecurr) && 4031d5e616fcSJoe Perches $fix) { 40326d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 4033d5e616fcSJoe Perches } 40340a920b5bSAndy Whitcroft } 40350a920b5bSAndy Whitcroft 40361813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 40371813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 40381813087dSJoe Perches my $tmp = trim($1); 40391813087dSJoe Perches WARN("MISORDERED_TYPE", 40401813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 40411813087dSJoe Perches } 40421813087dSJoe Perches 4043809e082eSJoe Perches# check for unnecessary <signed> int declarations of short/long/long long 4044809e082eSJoe Perches while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) { 4045809e082eSJoe Perches my $type = trim($1); 4046809e082eSJoe Perches next if ($type !~ /\bint\b/); 4047809e082eSJoe Perches next if ($type !~ /\b(?:short|long\s+long|long)\b/); 4048809e082eSJoe Perches my $new_type = $type; 4049809e082eSJoe Perches $new_type =~ s/\b\s*int\s*\b/ /; 4050809e082eSJoe Perches $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /; 4051809e082eSJoe Perches $new_type =~ s/^const\s+//; 4052809e082eSJoe Perches $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/); 4053809e082eSJoe Perches $new_type = "const $new_type" if ($type =~ /^const\b/); 4054809e082eSJoe Perches $new_type =~ s/\s+/ /g; 4055809e082eSJoe Perches $new_type = trim($new_type); 4056809e082eSJoe Perches if (WARN("UNNECESSARY_INT", 4057809e082eSJoe Perches "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) && 4058809e082eSJoe Perches $fix) { 4059809e082eSJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/; 4060809e082eSJoe Perches } 4061809e082eSJoe Perches } 4062809e082eSJoe Perches 4063cb710ecaSJoe Perches# check for static const char * arrays. 4064cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 4065000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4066000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 4067cb710ecaSJoe Perches $herecurr); 4068cb710ecaSJoe Perches } 4069cb710ecaSJoe Perches 407077b8c0a8SJoe Perches# check for initialized const char arrays that should be static const 407177b8c0a8SJoe Perches if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) { 407277b8c0a8SJoe Perches if (WARN("STATIC_CONST_CHAR_ARRAY", 407377b8c0a8SJoe Perches "const array should probably be static const\n" . $herecurr) && 407477b8c0a8SJoe Perches $fix) { 407577b8c0a8SJoe Perches $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/; 407677b8c0a8SJoe Perches } 407777b8c0a8SJoe Perches } 407877b8c0a8SJoe Perches 4079cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 4080cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 4081000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4082000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 4083cb710ecaSJoe Perches $herecurr); 4084cb710ecaSJoe Perches } 4085cb710ecaSJoe Perches 4086ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 4087ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 4088ab7e23f3SJoe Perches my $found = $1; 4089ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 4090ab7e23f3SJoe Perches WARN("CONST_CONST", 4091ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 4092ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 4093ab7e23f3SJoe Perches WARN("CONST_CONST", 4094ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 4095ab7e23f3SJoe Perches } 4096ab7e23f3SJoe Perches } 4097ab7e23f3SJoe Perches 40989b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 40999b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 41009b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 41019b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 41029b0fa60dSJoe Perches $herecurr); 41039b0fa60dSJoe Perches } 41049b0fa60dSJoe Perches 4105b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 4106b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 4107b598b670SJoe Perches my $array = $1; 4108b598b670SJoe 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*\))@) { 4109b598b670SJoe Perches my $array_div = $1; 4110b598b670SJoe Perches if (WARN("ARRAY_SIZE", 4111b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 4112b598b670SJoe Perches $fix) { 4113b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 4114b598b670SJoe Perches } 4115b598b670SJoe Perches } 4116b598b670SJoe Perches } 4117b598b670SJoe Perches 4118b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 411916b7f3c8SJoe Perches if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) { 4120b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 4121b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 4122b36190c5SJoe Perches $fix) { 4123194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 4124b36190c5SJoe Perches } 4125b36190c5SJoe Perches } 4126b36190c5SJoe Perches 4127653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 4128653d4876SAndy Whitcroft# make sense. 4129653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 41308054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 4131c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 41328ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 413346d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 4134000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 4135000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 41360a920b5bSAndy Whitcroft } 41370a920b5bSAndy Whitcroft 41380a920b5bSAndy Whitcroft# * goes on variable not on type 413965863862SAndy Whitcroft # (char*[ const]) 4140bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 4141bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 41423705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 4143d8aaf121SAndy Whitcroft 414465863862SAndy Whitcroft # Should start with a space. 414565863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 414665863862SAndy Whitcroft # Should not end with a space. 414765863862SAndy Whitcroft $to =~ s/\s+$//; 414865863862SAndy Whitcroft # '*'s should not have spaces between. 4149f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 415065863862SAndy Whitcroft } 4151d8aaf121SAndy Whitcroft 41523705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 415365863862SAndy Whitcroft if ($from ne $to) { 41543705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 41553705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 41563705ce5bSJoe Perches $fix) { 41573705ce5bSJoe Perches my $sub_from = $ident; 41583705ce5bSJoe Perches my $sub_to = $ident; 41593705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4160194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41613705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 41623705ce5bSJoe Perches } 416365863862SAndy Whitcroft } 4164bfcb2cc7SAndy Whitcroft } 4165bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 4166bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 41673705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 4168d8aaf121SAndy Whitcroft 416965863862SAndy Whitcroft # Should start with a space. 417065863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 417165863862SAndy Whitcroft # Should not end with a space. 417265863862SAndy Whitcroft $to =~ s/\s+$//; 417365863862SAndy Whitcroft # '*'s should not have spaces between. 4174f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 417565863862SAndy Whitcroft } 417665863862SAndy Whitcroft # Modifiers should have spaces. 417765863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 417865863862SAndy Whitcroft 41793705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 4180667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 41813705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 41823705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 41833705ce5bSJoe Perches $fix) { 41843705ce5bSJoe Perches 41853705ce5bSJoe Perches my $sub_from = $match; 41863705ce5bSJoe Perches my $sub_to = $match; 41873705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4188194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41893705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 41903705ce5bSJoe Perches } 419165863862SAndy Whitcroft } 41920a920b5bSAndy Whitcroft } 41930a920b5bSAndy Whitcroft 41949d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 41959d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 41960675a8fbSJean Delvare my $msg_level = \&WARN; 41970675a8fbSJean Delvare $msg_level = \&CHK if ($file); 41980675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 41999d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 42009d3e3c70SJoe Perches } 42010a920b5bSAndy Whitcroft 42029d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 42038905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 4204000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 4205000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 42068905a67cSAndy Whitcroft } 42078905a67cSAndy Whitcroft 420817441227SJoe Perches# check for uses of printk_ratelimit 420917441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 4210000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 4211000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 421217441227SJoe Perches } 421317441227SJoe Perches 4214eeef5733SJoe Perches# printk should use KERN_* levels 4215eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 4216000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 4217eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 421800df344fSAndy Whitcroft } 42190a920b5bSAndy Whitcroft 4220243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 4221243f3803SJoe Perches my $orig = $1; 4222243f3803SJoe Perches my $level = lc($orig); 4223243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 42248f26b837SJoe Perches my $level2 = $level; 42258f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 4226243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 4227daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 4228243f3803SJoe Perches } 4229243f3803SJoe Perches 4230dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 4231dc139313SJoe Perches my $orig = $1; 4232dc139313SJoe Perches my $level = lc($orig); 4233dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 4234dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 4235dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 4236dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 4237dc139313SJoe Perches } 4238dc139313SJoe Perches 423991c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 424091c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 424191c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 424291c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 424391c9afafSAndy Lutomirski WARN("ENOSYS", 424491c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 424591c9afafSAndy Lutomirski } 424691c9afafSAndy Lutomirski 42476b9ea5ffSJakub Kicinski# ENOTSUPP is not a standard error code and should be avoided in new patches. 42486b9ea5ffSJakub Kicinski# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP. 42496b9ea5ffSJakub Kicinski# Similarly to ENOSYS warning a small number of false positives is expected. 42506b9ea5ffSJakub Kicinski if (!$file && $line =~ /\bENOTSUPP\b/) { 42516b9ea5ffSJakub Kicinski if (WARN("ENOTSUPP", 42526b9ea5ffSJakub Kicinski "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) && 42536b9ea5ffSJakub Kicinski $fix) { 42546b9ea5ffSJakub Kicinski $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/; 42556b9ea5ffSJakub Kicinski } 42566b9ea5ffSJakub Kicinski } 42576b9ea5ffSJakub Kicinski 4258653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 4259653d4876SAndy Whitcroft# or if closed on same line 42605b57980dSJoe Perches if ($perl_version_ok && 42612d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 42622d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 42632d453e3bSJoe Perches $sline !~ /}/) { 42648d182478SJoe Perches if (ERROR("OPEN_BRACE", 42652d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 42668d182478SJoe Perches $fix) { 42678d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 42688d182478SJoe Perches my $fixed_line = $rawline; 42698d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 42708d182478SJoe Perches my $line1 = $1; 42718d182478SJoe Perches my $line2 = $2; 42728d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 42738d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 42748d182478SJoe Perches if ($line2 !~ /^\s*$/) { 42758d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 42768d182478SJoe Perches } 42778d182478SJoe Perches } 42780a920b5bSAndy Whitcroft } 4279653d4876SAndy Whitcroft 42808905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 42818905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 42828905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 42838d182478SJoe Perches if (ERROR("OPEN_BRACE", 42848d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 42858d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 42868d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 42878d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 42888d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 42898d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 42908d182478SJoe Perches $fixedline = $rawline; 42918d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 42928d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 42938d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 42948d182478SJoe Perches } 42958d182478SJoe Perches } 42968905a67cSAndy Whitcroft } 42978905a67cSAndy Whitcroft 42980c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 42993705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 43003705ce5bSJoe Perches if (WARN("SPACING", 43013705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 43023705ce5bSJoe Perches $fix) { 4303194f66fcSJoe Perches $fixed[$fixlinenr] =~ 43043705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 43053705ce5bSJoe Perches } 43060c73b4ebSAndy Whitcroft } 43070c73b4ebSAndy Whitcroft 430831070b5dSJoe Perches# Function pointer declarations 430931070b5dSJoe Perches# check spacing between type, funcptr, and args 431031070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 431191f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 431231070b5dSJoe Perches my $declare = $1; 431331070b5dSJoe Perches my $pre_pointer_space = $2; 431431070b5dSJoe Perches my $post_pointer_space = $3; 431531070b5dSJoe Perches my $funcname = $4; 431631070b5dSJoe Perches my $post_funcname_space = $5; 431731070b5dSJoe Perches my $pre_args_space = $6; 431831070b5dSJoe Perches 431991f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 432091f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 432191f72e9cSJoe Perches# don't need a space so don't warn for those. 432291f72e9cSJoe Perches my $post_declare_space = ""; 432391f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 432491f72e9cSJoe Perches $post_declare_space = $1; 432591f72e9cSJoe Perches $declare = rtrim($declare); 432691f72e9cSJoe Perches } 432791f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 432831070b5dSJoe Perches WARN("SPACING", 432931070b5dSJoe Perches "missing space after return type\n" . $herecurr); 433091f72e9cSJoe Perches $post_declare_space = " "; 433131070b5dSJoe Perches } 433231070b5dSJoe Perches 433331070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 433491f72e9cSJoe Perches# This test is not currently implemented because these declarations are 433591f72e9cSJoe Perches# equivalent to 433691f72e9cSJoe Perches# int foo(int bar, ...) 433791f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 433891f72e9cSJoe Perches# 433991f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 434091f72e9cSJoe Perches# WARN("SPACING", 434191f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 434291f72e9cSJoe Perches# } 434331070b5dSJoe Perches 434431070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 434531070b5dSJoe Perches if (defined $pre_pointer_space && 434631070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 434731070b5dSJoe Perches WARN("SPACING", 434831070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 434931070b5dSJoe Perches } 435031070b5dSJoe Perches 435131070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 435231070b5dSJoe Perches if (defined $post_pointer_space && 435331070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 435431070b5dSJoe Perches WARN("SPACING", 435531070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 435631070b5dSJoe Perches } 435731070b5dSJoe Perches 435831070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 435931070b5dSJoe Perches if (defined $post_funcname_space && 436031070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 436131070b5dSJoe Perches WARN("SPACING", 436231070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 436331070b5dSJoe Perches } 436431070b5dSJoe Perches 436531070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 436631070b5dSJoe Perches if (defined $pre_args_space && 436731070b5dSJoe Perches $pre_args_space =~ /^\s/) { 436831070b5dSJoe Perches WARN("SPACING", 436931070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 437031070b5dSJoe Perches } 437131070b5dSJoe Perches 437231070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4373194f66fcSJoe Perches $fixed[$fixlinenr] =~ 437491f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 437531070b5dSJoe Perches } 437631070b5dSJoe Perches } 437731070b5dSJoe Perches 43788d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 43798d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4380fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4381fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 43828d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 43838d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 43848d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4385fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 438638dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 43873705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 43883705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 43893705ce5bSJoe Perches $fix) { 4390194f66fcSJoe Perches $fixed[$fixlinenr] =~ 43913705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 43923705ce5bSJoe Perches } 43938d31cfceSAndy Whitcroft } 43948d31cfceSAndy Whitcroft } 43958d31cfceSAndy Whitcroft 4396f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 43976c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4398c2fdda0dSAndy Whitcroft my $name = $1; 4399773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4400773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4401c2fdda0dSAndy Whitcroft 4402c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4403773647a0SAndy Whitcroft if ($name =~ /^(?: 4404773647a0SAndy Whitcroft if|for|while|switch|return|case| 4405773647a0SAndy Whitcroft volatile|__volatile__| 4406773647a0SAndy Whitcroft __attribute__|format|__extension__| 4407773647a0SAndy Whitcroft asm|__asm__)$/x) 4408773647a0SAndy Whitcroft { 4409c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4410c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4411c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4412c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4413773647a0SAndy Whitcroft 4414773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4415c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4416c2fdda0dSAndy Whitcroft 4417c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4418c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4419773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4420c2fdda0dSAndy Whitcroft 4421c2fdda0dSAndy Whitcroft } else { 44223705ce5bSJoe Perches if (WARN("SPACING", 44233705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 44243705ce5bSJoe Perches $fix) { 4425194f66fcSJoe Perches $fixed[$fixlinenr] =~ 44263705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 44273705ce5bSJoe Perches } 4428f0a594c1SAndy Whitcroft } 44296c72ffaaSAndy Whitcroft } 44309a4cad4eSEric Nelson 4431653d4876SAndy Whitcroft# Check operator spacing. 44320a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 44333705ce5bSJoe Perches my $fixed_line = ""; 44343705ce5bSJoe Perches my $line_fixed = 0; 44353705ce5bSJoe Perches 44369c0ca6f9SAndy Whitcroft my $ops = qr{ 44379c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 44389c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 44399c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 44401f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 444184731623SJoe Perches \?:|\?|: 44429c0ca6f9SAndy Whitcroft }x; 4443cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 44443705ce5bSJoe Perches 44453705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 44463705ce5bSJoe Perches## foreach my $el (@elements) { 44473705ce5bSJoe Perches## print("el: <$el>\n"); 44483705ce5bSJoe Perches## } 44493705ce5bSJoe Perches 44503705ce5bSJoe Perches my @fix_elements = (); 445100df344fSAndy Whitcroft my $off = 0; 44526c72ffaaSAndy Whitcroft 44533705ce5bSJoe Perches foreach my $el (@elements) { 44543705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 44553705ce5bSJoe Perches $off += length($el); 44563705ce5bSJoe Perches } 44573705ce5bSJoe Perches 44583705ce5bSJoe Perches $off = 0; 44593705ce5bSJoe Perches 44606c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4461b34c648bSJoe Perches my $last_after = -1; 44626c72ffaaSAndy Whitcroft 44630a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 44643705ce5bSJoe Perches 44653705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 44663705ce5bSJoe Perches 44673705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 44683705ce5bSJoe Perches 44694a0df2efSAndy Whitcroft $off += length($elements[$n]); 44704a0df2efSAndy Whitcroft 447125985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4472773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4473773647a0SAndy Whitcroft my $cc = ''; 4474773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4475773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4476773647a0SAndy Whitcroft } 4477773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4478773647a0SAndy Whitcroft 44794a0df2efSAndy Whitcroft my $a = ''; 44804a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 44814a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4482cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 44834a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 44844a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 4485773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 44864a0df2efSAndy Whitcroft 44870a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 44884a0df2efSAndy Whitcroft 44894a0df2efSAndy Whitcroft my $c = ''; 44900a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 44914a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 44924a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4493cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 44944a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 44954a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 44968b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 44974a0df2efSAndy Whitcroft } else { 44984a0df2efSAndy Whitcroft $c = 'E'; 44990a920b5bSAndy Whitcroft } 45000a920b5bSAndy Whitcroft 45014a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 45024a0df2efSAndy Whitcroft 45034a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 45044a0df2efSAndy Whitcroft 45056c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 4506de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 45070a920b5bSAndy Whitcroft 450874048ed8SAndy Whitcroft # Pull out the value of this operator. 45096c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 45100a920b5bSAndy Whitcroft 45111f65f947SAndy Whitcroft # Get the full operator variant. 45121f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 45131f65f947SAndy Whitcroft 451413214adfSAndy Whitcroft # Ignore operators passed as parameters. 451513214adfSAndy Whitcroft if ($op_type ne 'V' && 4516d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 451713214adfSAndy Whitcroft 4518cf655043SAndy Whitcroft# # Ignore comments 4519cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 452013214adfSAndy Whitcroft 4521d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 452213214adfSAndy Whitcroft } elsif ($op eq ';') { 4523cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 4524cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 45253705ce5bSJoe Perches if (ERROR("SPACING", 45263705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 4527b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 45283705ce5bSJoe Perches $line_fixed = 1; 45293705ce5bSJoe Perches } 4530d8aaf121SAndy Whitcroft } 4531d8aaf121SAndy Whitcroft 4532d8aaf121SAndy Whitcroft # // is a comment 4533d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 45340a920b5bSAndy Whitcroft 4535b00e4814SJoe Perches # : when part of a bitfield 4536b00e4814SJoe Perches } elsif ($opv eq ':B') { 4537b00e4814SJoe Perches # skip the bitfield test for now 4538b00e4814SJoe Perches 45391f65f947SAndy Whitcroft # No spaces for: 45401f65f947SAndy Whitcroft # -> 4541b00e4814SJoe Perches } elsif ($op eq '->') { 45424a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 45433705ce5bSJoe Perches if (ERROR("SPACING", 45443705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4545b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 45463705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 45473705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 45483705ce5bSJoe Perches } 4549b34c648bSJoe Perches $line_fixed = 1; 45503705ce5bSJoe Perches } 45510a920b5bSAndy Whitcroft } 45520a920b5bSAndy Whitcroft 45532381097bSJoe Perches # , must not have a space before and must have a space on the right. 45540a920b5bSAndy Whitcroft } elsif ($op eq ',') { 45552381097bSJoe Perches my $rtrim_before = 0; 45562381097bSJoe Perches my $space_after = 0; 45572381097bSJoe Perches if ($ctx =~ /Wx./) { 45582381097bSJoe Perches if (ERROR("SPACING", 45592381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 45602381097bSJoe Perches $line_fixed = 1; 45612381097bSJoe Perches $rtrim_before = 1; 45622381097bSJoe Perches } 45632381097bSJoe Perches } 4564cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 45653705ce5bSJoe Perches if (ERROR("SPACING", 45663705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 45673705ce5bSJoe Perches $line_fixed = 1; 4568b34c648bSJoe Perches $last_after = $n; 45692381097bSJoe Perches $space_after = 1; 45702381097bSJoe Perches } 45712381097bSJoe Perches } 45722381097bSJoe Perches if ($rtrim_before || $space_after) { 45732381097bSJoe Perches if ($rtrim_before) { 45742381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 45752381097bSJoe Perches } else { 45762381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 45772381097bSJoe Perches } 45782381097bSJoe Perches if ($space_after) { 45792381097bSJoe Perches $good .= " "; 45803705ce5bSJoe Perches } 45810a920b5bSAndy Whitcroft } 45820a920b5bSAndy Whitcroft 45839c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 458474048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 45859c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 45869c0ca6f9SAndy Whitcroft 45879c0ca6f9SAndy Whitcroft # unary operators should have a space before and 45889c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 45899c0ca6f9SAndy Whitcroft # unary operator, or a cast 45909c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 459174048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 45920d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4593cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 45943705ce5bSJoe Perches if (ERROR("SPACING", 45953705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4596b34c648bSJoe Perches if ($n != $last_after + 2) { 4597b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 45983705ce5bSJoe Perches $line_fixed = 1; 45993705ce5bSJoe Perches } 46000a920b5bSAndy Whitcroft } 4601b34c648bSJoe Perches } 4602a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4603171ae1a4SAndy Whitcroft # A unary '*' may be const 4604171ae1a4SAndy Whitcroft 4605171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 46063705ce5bSJoe Perches if (ERROR("SPACING", 46073705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4608b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 46093705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 46103705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 46113705ce5bSJoe Perches } 4612b34c648bSJoe Perches $line_fixed = 1; 46133705ce5bSJoe Perches } 46140a920b5bSAndy Whitcroft } 46150a920b5bSAndy Whitcroft 46160a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 46170a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4618773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 46193705ce5bSJoe Perches if (ERROR("SPACING", 46203705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4621b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 46223705ce5bSJoe Perches $line_fixed = 1; 46233705ce5bSJoe Perches } 46240a920b5bSAndy Whitcroft } 4625773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4626773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 46273705ce5bSJoe Perches if (ERROR("SPACING", 46283705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4629b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 46303705ce5bSJoe Perches $line_fixed = 1; 46313705ce5bSJoe Perches } 4632653d4876SAndy Whitcroft } 4633773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 46343705ce5bSJoe Perches if (ERROR("SPACING", 46353705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4636b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 46373705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 46383705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4639773647a0SAndy Whitcroft } 4640b34c648bSJoe Perches $line_fixed = 1; 46413705ce5bSJoe Perches } 46423705ce5bSJoe Perches } 46430a920b5bSAndy Whitcroft 46440a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 46459c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 46469c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 46479c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4648c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4649c2fdda0dSAndy Whitcroft $op eq '%') 46500a920b5bSAndy Whitcroft { 4651d2e025f3SJoe Perches if ($check) { 4652d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4653d2e025f3SJoe Perches if (CHK("SPACING", 4654d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4655d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4656d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4657d2e025f3SJoe Perches $line_fixed = 1; 4658d2e025f3SJoe Perches } 4659d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4660d2e025f3SJoe Perches if (CHK("SPACING", 4661d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4662d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4663d2e025f3SJoe Perches $line_fixed = 1; 4664d2e025f3SJoe Perches } 4665d2e025f3SJoe Perches } 4666d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 46673705ce5bSJoe Perches if (ERROR("SPACING", 46683705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4669b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4670b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4671b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4672b34c648bSJoe Perches } 46733705ce5bSJoe Perches $line_fixed = 1; 46743705ce5bSJoe Perches } 46750a920b5bSAndy Whitcroft } 46760a920b5bSAndy Whitcroft 46771f65f947SAndy Whitcroft # A colon needs no spaces before when it is 46781f65f947SAndy Whitcroft # terminating a case value or a label. 46791f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 46801f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 46813705ce5bSJoe Perches if (ERROR("SPACING", 46823705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4683b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 46843705ce5bSJoe Perches $line_fixed = 1; 46853705ce5bSJoe Perches } 46861f65f947SAndy Whitcroft } 46871f65f947SAndy Whitcroft 46880a920b5bSAndy Whitcroft # All the others need spaces both sides. 4689cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 46901f65f947SAndy Whitcroft my $ok = 0; 46911f65f947SAndy Whitcroft 469222f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 46931f65f947SAndy Whitcroft if (($op eq '<' && 46941f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 46951f65f947SAndy Whitcroft ($op eq '>' && 46961f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 46971f65f947SAndy Whitcroft { 46981f65f947SAndy Whitcroft $ok = 1; 46991f65f947SAndy Whitcroft } 47001f65f947SAndy Whitcroft 4701e0df7e1fSJoe Perches # for asm volatile statements 4702e0df7e1fSJoe Perches # ignore a colon with another 4703e0df7e1fSJoe Perches # colon immediately before or after 4704e0df7e1fSJoe Perches if (($op eq ':') && 4705e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4706e0df7e1fSJoe Perches $ok = 1; 4707e0df7e1fSJoe Perches } 4708e0df7e1fSJoe Perches 470984731623SJoe Perches # messages are ERROR, but ?: are CHK 47101f65f947SAndy Whitcroft if ($ok == 0) { 47110675a8fbSJean Delvare my $msg_level = \&ERROR; 47120675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 471384731623SJoe Perches 47140675a8fbSJean Delvare if (&{$msg_level}("SPACING", 47153705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4716b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4717b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4718b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4719b34c648bSJoe Perches } 47203705ce5bSJoe Perches $line_fixed = 1; 47213705ce5bSJoe Perches } 47220a920b5bSAndy Whitcroft } 472322f2a2efSAndy Whitcroft } 47244a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 47253705ce5bSJoe Perches 47263705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 47273705ce5bSJoe Perches 47283705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 47290a920b5bSAndy Whitcroft } 47303705ce5bSJoe Perches 47313705ce5bSJoe Perches if (($#elements % 2) == 0) { 47323705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 47333705ce5bSJoe Perches } 47343705ce5bSJoe Perches 4735194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4736194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 47373705ce5bSJoe Perches } 47383705ce5bSJoe Perches 47393705ce5bSJoe Perches 47400a920b5bSAndy Whitcroft } 47410a920b5bSAndy Whitcroft 4742786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4743d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4744786b6326SJoe Perches if (WARN("SPACING", 4745786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4746786b6326SJoe Perches $fix) { 4747194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4748786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4749786b6326SJoe Perches } 4750786b6326SJoe Perches } 4751786b6326SJoe Perches 4752f0a594c1SAndy Whitcroft# check for multiple assignments 4753f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4754000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4755000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4756f0a594c1SAndy Whitcroft } 4757f0a594c1SAndy Whitcroft 475822f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 475922f2a2efSAndy Whitcroft## # continuation. 476022f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 476122f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 476222f2a2efSAndy Whitcroft## 476322f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 476422f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 476522f2a2efSAndy Whitcroft## my $ln = $line; 476622f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 476722f2a2efSAndy Whitcroft## } 476822f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4769000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4770000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 477122f2a2efSAndy Whitcroft## } 477222f2a2efSAndy Whitcroft## } 4773f0a594c1SAndy Whitcroft 47740a920b5bSAndy Whitcroft#need space before brace following if, while, etc 47756b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 47766ad724e2SMichal Zylowski $line =~ /\b(?:else|do)\{/) { 47773705ce5bSJoe Perches if (ERROR("SPACING", 47783705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 47793705ce5bSJoe Perches $fix) { 47806ad724e2SMichal Zylowski $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/; 47813705ce5bSJoe Perches } 4782de7d4f0eSAndy Whitcroft } 4783de7d4f0eSAndy Whitcroft 4784c4a62ef9SJoe Perches## # check for blank lines before declarations 4785c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4786c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4787c4a62ef9SJoe Perches## WARN("SPACING", 4788c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4789c4a62ef9SJoe Perches## } 4790c4a62ef9SJoe Perches## 4791c4a62ef9SJoe Perches 4792de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4793de7d4f0eSAndy Whitcroft# on the line 479494fb9845SJoe Perches if ($line =~ /}(?!(?:,|;|\)|\}))\S/) { 4795d5e616fcSJoe Perches if (ERROR("SPACING", 4796d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4797d5e616fcSJoe Perches $fix) { 4798194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4799d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4800d5e616fcSJoe Perches } 48010a920b5bSAndy Whitcroft } 48020a920b5bSAndy Whitcroft 480322f2a2efSAndy Whitcroft# check spacing on square brackets 480422f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 48053705ce5bSJoe Perches if (ERROR("SPACING", 48063705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 48073705ce5bSJoe Perches $fix) { 4808194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48093705ce5bSJoe Perches s/\[\s+/\[/; 48103705ce5bSJoe Perches } 481122f2a2efSAndy Whitcroft } 481222f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 48133705ce5bSJoe Perches if (ERROR("SPACING", 48143705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 48153705ce5bSJoe Perches $fix) { 4816194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48173705ce5bSJoe Perches s/\s+\]/\]/; 48183705ce5bSJoe Perches } 481922f2a2efSAndy Whitcroft } 482022f2a2efSAndy Whitcroft 4821c45dcabdSAndy Whitcroft# check spacing on parentheses 48229c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 48239c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 48243705ce5bSJoe Perches if (ERROR("SPACING", 48253705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 48263705ce5bSJoe Perches $fix) { 4827194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48283705ce5bSJoe Perches s/\(\s+/\(/; 48293705ce5bSJoe Perches } 483022f2a2efSAndy Whitcroft } 483113214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4832c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4833c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 48343705ce5bSJoe Perches if (ERROR("SPACING", 48353705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 48363705ce5bSJoe Perches $fix) { 4837194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48383705ce5bSJoe Perches s/\s+\)/\)/; 48393705ce5bSJoe Perches } 484022f2a2efSAndy Whitcroft } 484122f2a2efSAndy Whitcroft 4842e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4843e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4844e2826fd0SJoe Perches 4845e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4846ea4acbb1SJoe Perches my $var = $1; 4847ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4848ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4849ea4acbb1SJoe Perches $fix) { 4850ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4851ea4acbb1SJoe Perches } 4852ea4acbb1SJoe Perches } 4853ea4acbb1SJoe Perches 4854ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4855ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4856ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4857ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4858ea4acbb1SJoe Perches my $var = $2; 4859ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4860ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4861ea4acbb1SJoe Perches $fix) { 4862ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4863ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4864ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4865ea4acbb1SJoe Perches } 4866e2826fd0SJoe Perches } 4867e2826fd0SJoe Perches 486863b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 4869a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 4870a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 48715b57980dSJoe Perches $perl_version_ok && defined($stat) && 487263b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 487363b7c73eSJoe Perches my $if_stat = $1; 487463b7c73eSJoe Perches my $test = substr($2, 1, -1); 487563b7c73eSJoe Perches my $herectx; 487663b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 487763b7c73eSJoe Perches my $match = $1; 487863b7c73eSJoe Perches # avoid parentheses around potential macro args 487963b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 488063b7c73eSJoe Perches if (!defined($herectx)) { 488163b7c73eSJoe Perches $herectx = $here . "\n"; 488263b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 488363b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 488463b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 488563b7c73eSJoe Perches $herectx .= $rl . "\n"; 488663b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 488763b7c73eSJoe Perches } 488863b7c73eSJoe Perches } 488963b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 489063b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 489163b7c73eSJoe Perches } 489263b7c73eSJoe Perches } 489363b7c73eSJoe Perches 48940a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 48954a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 48960a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 48973705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 48983705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 48993705ce5bSJoe Perches $fix) { 4900194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49013705ce5bSJoe Perches s/^(.)\s+/$1/; 49023705ce5bSJoe Perches } 49030a920b5bSAndy Whitcroft } 49040a920b5bSAndy Whitcroft 49055b9553abSJoe Perches# return is not a function 4906507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4907c45dcabdSAndy Whitcroft my $spacing = $1; 49085b57980dSJoe Perches if ($perl_version_ok && 49095b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 49105b9553abSJoe Perches my $value = $1; 49115b9553abSJoe Perches $value = deparenthesize($value); 49125b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4913000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4914000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 49155b9553abSJoe Perches } 4916c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4917000d1cc1SJoe Perches ERROR("SPACING", 4918000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4919c45dcabdSAndy Whitcroft } 4920c45dcabdSAndy Whitcroft } 4921507e5141SJoe Perches 4922b43ae21bSJoe Perches# unnecessary return in a void function 4923b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4924b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4925b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4926b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4927b43ae21bSJoe Perches $linenr >= 3 && 4928b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4929b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 49309819cf25SJoe Perches WARN("RETURN_VOID", 4931b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 49329819cf25SJoe Perches } 49339819cf25SJoe Perches 4934189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 49355b57980dSJoe Perches if ($perl_version_ok && 4936189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4937189248d8SJoe Perches my $openparens = $1; 4938189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4939189248d8SJoe Perches my $msg = ""; 4940189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4941189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4942189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4943189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4944189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4945189248d8SJoe Perches } 4946189248d8SJoe Perches } 4947189248d8SJoe Perches 4948c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4949c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4950c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4951c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 49525b57980dSJoe Perches if ($perl_version_ok && 4953c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4954c5595fa2SJoe Perches my $lead = $1; 4955c5595fa2SJoe Perches my $const = $2; 4956c5595fa2SJoe Perches my $comp = $3; 4957c5595fa2SJoe Perches my $to = $4; 4958c5595fa2SJoe Perches my $newcomp = $comp; 4959f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 4960c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4961c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4962c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4963c5595fa2SJoe Perches $fix) { 4964c5595fa2SJoe Perches if ($comp eq "<") { 4965c5595fa2SJoe Perches $newcomp = ">"; 4966c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4967c5595fa2SJoe Perches $newcomp = ">="; 4968c5595fa2SJoe Perches } elsif ($comp eq ">") { 4969c5595fa2SJoe Perches $newcomp = "<"; 4970c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4971c5595fa2SJoe Perches $newcomp = "<="; 4972c5595fa2SJoe Perches } 4973c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4974c5595fa2SJoe Perches } 4975c5595fa2SJoe Perches } 4976c5595fa2SJoe Perches 4977f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4978f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 497953a3c448SAndy Whitcroft my $name = $1; 498053a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4981000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4982f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 498353a3c448SAndy Whitcroft } 498453a3c448SAndy Whitcroft } 4985c45dcabdSAndy Whitcroft 49860a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 49874a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 49883705ce5bSJoe Perches if (ERROR("SPACING", 49893705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 49903705ce5bSJoe Perches $fix) { 4991194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49923705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 49933705ce5bSJoe Perches } 49940a920b5bSAndy Whitcroft } 49950a920b5bSAndy Whitcroft 4996f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4997f5fe35ddSAndy Whitcroft# statements after the conditional. 4998170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 49993e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 50003e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 50013e469cdcSAndy Whitcroft if (!defined $stat); 5002170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 5003170d3a22SAndy Whitcroft $remain_next, $off_next); 5004170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 5005170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 5006170d3a22SAndy Whitcroft 5007170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 5008170d3a22SAndy Whitcroft # If the statement carries leading newlines, 5009170d3a22SAndy Whitcroft # then count those as offsets. 5010170d3a22SAndy Whitcroft my ($whitespace) = 5011170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 5012170d3a22SAndy Whitcroft my $offset = 5013170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 5014170d3a22SAndy Whitcroft 5015170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 5016170d3a22SAndy Whitcroft $offset} = 1; 5017170d3a22SAndy Whitcroft } 5018170d3a22SAndy Whitcroft } 5019170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 5020c11230f4SJoe Perches defined($stat) && defined($cond) && 5021170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 5022171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 50238905a67cSAndy Whitcroft 5024b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 502565b64b3bSJoe Perches if (ERROR("ASSIGN_IN_IF", 502665b64b3bSJoe Perches "do not use assignment in if condition\n" . $herecurr) && 502765b64b3bSJoe Perches $fix && $perl_version_ok) { 502865b64b3bSJoe Perches if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) { 502965b64b3bSJoe Perches my $space = $1; 503065b64b3bSJoe Perches my $not = $2; 503165b64b3bSJoe Perches my $statement = $3; 503265b64b3bSJoe Perches my $assigned = $4; 503365b64b3bSJoe Perches my $test = $8; 503465b64b3bSJoe Perches my $against = $9; 503565b64b3bSJoe Perches my $brace = $15; 503665b64b3bSJoe Perches fix_delete_line($fixlinenr, $rawline); 503765b64b3bSJoe Perches fix_insert_line($fixlinenr, "$space$statement;"); 503865b64b3bSJoe Perches my $newline = "${space}if ("; 503965b64b3bSJoe Perches $newline .= '!' if defined($not); 504065b64b3bSJoe Perches $newline .= '(' if (defined $not && defined($test) && defined($against)); 504165b64b3bSJoe Perches $newline .= "$assigned"; 504265b64b3bSJoe Perches $newline .= " $test $against" if (defined($test) && defined($against)); 504365b64b3bSJoe Perches $newline .= ')' if (defined $not && defined($test) && defined($against)); 504465b64b3bSJoe Perches $newline .= ')'; 504565b64b3bSJoe Perches $newline .= " {" if (defined($brace)); 504665b64b3bSJoe Perches fix_insert_line($fixlinenr + 1, $newline); 504765b64b3bSJoe Perches } 504865b64b3bSJoe Perches } 50498905a67cSAndy Whitcroft } 50508905a67cSAndy Whitcroft 50518905a67cSAndy Whitcroft # Find out what is on the end of the line after the 50528905a67cSAndy Whitcroft # conditional. 5053773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 50548905a67cSAndy Whitcroft $s =~ s/\n.*//g; 505513214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 505653210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 505753210168SAndy Whitcroft $c !~ /}\s*while\s*/) 5058773647a0SAndy Whitcroft { 5059bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 5060bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 5061bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 506242bdf74cSHidetoshi Seto my $stat_real = ''; 5063bb44ad39SAndy Whitcroft 506442bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 506542bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 5066bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 5067bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 5068bb44ad39SAndy Whitcroft } 5069bb44ad39SAndy Whitcroft 5070000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5071000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 50728905a67cSAndy Whitcroft } 50738905a67cSAndy Whitcroft } 50748905a67cSAndy Whitcroft 507513214adfSAndy Whitcroft# Check for bitwise tests written as boolean 507613214adfSAndy Whitcroft if ($line =~ / 507713214adfSAndy Whitcroft (?: 507813214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 507913214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 508013214adfSAndy Whitcroft (?:\&\&|\|\|) 508113214adfSAndy Whitcroft | 508213214adfSAndy Whitcroft (?:\&\&|\|\|) 508313214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 508413214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 508513214adfSAndy Whitcroft )/x) 508613214adfSAndy Whitcroft { 5087000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 5088000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 508913214adfSAndy Whitcroft } 509013214adfSAndy Whitcroft 50918905a67cSAndy Whitcroft# if and else should not have general statements after it 509213214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 509313214adfSAndy Whitcroft my $s = $1; 509413214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 509513214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 5096000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5097000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 50980a920b5bSAndy Whitcroft } 509913214adfSAndy Whitcroft } 510039667782SAndy Whitcroft# if should not continue a brace 510139667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 5102000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5103048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 510439667782SAndy Whitcroft $herecurr); 510539667782SAndy Whitcroft } 5106a1080bf8SAndy Whitcroft# case and default should not have general statements after them 5107a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 5108a1080bf8SAndy Whitcroft $line !~ /\G(?: 51093fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 5110a1080bf8SAndy Whitcroft \s*return\s+ 5111a1080bf8SAndy Whitcroft )/xg) 5112a1080bf8SAndy Whitcroft { 5113000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5114000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 5115a1080bf8SAndy Whitcroft } 51160a920b5bSAndy Whitcroft 51170a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 51180a920b5bSAndy Whitcroft # indent level to be relevant to each other. 51198b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 51200a920b5bSAndy Whitcroft $previndent == $indent) { 51218b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 51228b8856f4SJoe Perches "else 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 $fixedline =~ s/}\s*$//; 51288b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 51298b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 51308b8856f4SJoe Perches } 51318b8856f4SJoe Perches $fixedline = $rawline; 51328b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 51338b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 51348b8856f4SJoe Perches } 51350a920b5bSAndy Whitcroft } 51360a920b5bSAndy Whitcroft 51378b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 5138c2fdda0dSAndy Whitcroft $previndent == $indent) { 5139c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 5140c2fdda0dSAndy Whitcroft 5141c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 5142c2fdda0dSAndy Whitcroft # conditional. 5143773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 5144c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 5145c2fdda0dSAndy Whitcroft 5146c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 51478b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 51488b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 51498b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 51508b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 51518b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 51528b8856f4SJoe Perches my $fixedline = $prevrawline; 51538b8856f4SJoe Perches my $trailing = $rawline; 51548b8856f4SJoe Perches $trailing =~ s/^\+//; 51558b8856f4SJoe Perches $trailing = trim($trailing); 51568b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 51578b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 51588b8856f4SJoe Perches } 5159c2fdda0dSAndy Whitcroft } 5160c2fdda0dSAndy Whitcroft } 5161c2fdda0dSAndy Whitcroft 516295e2c602SJoe Perches#Specific variable tests 5163323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 5164323c1260SJoe Perches my $var = $1; 516595e2c602SJoe Perches 516695e2c602SJoe Perches#CamelCase 5167807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 5168be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 516922735ce8SJoe Perches#Ignore Page<foo> variants 5170807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 5171d439e6a5SJoe Perches#Ignore SI style variants like nS, mV and dB 5172d439e6a5SJoe Perches#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE) 5173d439e6a5SJoe Perches $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ && 5174f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 5175f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 51767e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 51777e781f67SJoe Perches my $word = $1; 51787e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 5179d8b07710SJoe Perches if ($check) { 5180d8b07710SJoe Perches seed_camelcase_includes(); 5181d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 5182d8b07710SJoe Perches seed_camelcase_file($realfile); 5183d8b07710SJoe Perches $camelcase_file_seeded = 1; 5184d8b07710SJoe Perches } 5185d8b07710SJoe Perches } 51867e781f67SJoe Perches if (!defined $camelcase{$word}) { 51877e781f67SJoe Perches $camelcase{$word} = 1; 5188be79794bSJoe Perches CHK("CAMELCASE", 51897e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 51907e781f67SJoe Perches } 5191323c1260SJoe Perches } 5192323c1260SJoe Perches } 51933445686aSJoe Perches } 51940a920b5bSAndy Whitcroft 51950a920b5bSAndy Whitcroft#no spaces allowed after \ in define 5196d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 5197d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 5198d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 5199d5e616fcSJoe Perches $fix) { 5200194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 5201d5e616fcSJoe Perches } 52020a920b5bSAndy Whitcroft } 52030a920b5bSAndy Whitcroft 52040e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 52050e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 5206c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 5207e09dec48SAndy Whitcroft my $file = "$1.h"; 5208e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 5209e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 5210e09dec48SAndy Whitcroft $realfile ne $checkfile && 52117840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 5212c45dcabdSAndy Whitcroft { 52130e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 52140e212e0aSFabian Frederick if ($asminclude > 0) { 5215e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 5216000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 5217000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5218e09dec48SAndy Whitcroft } else { 5219000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 5220000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5221e09dec48SAndy Whitcroft } 52220a920b5bSAndy Whitcroft } 52230a920b5bSAndy Whitcroft } 52240e212e0aSFabian Frederick } 52250a920b5bSAndy Whitcroft 5226653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 5227653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 5228cf655043SAndy Whitcroft# in a known good container 5229b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 5230b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 5231d8aaf121SAndy Whitcroft my $ln = $linenr; 5232d8aaf121SAndy Whitcroft my $cnt = $realcnt; 5233c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 5234c45dcabdSAndy Whitcroft my $ctx = ''; 523508a2843eSJoe Perches my $has_flow_statement = 0; 523608a2843eSJoe Perches my $has_arg_concat = 0; 5237c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 5238f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 5239f74bd194SAndy Whitcroft $ctx = $dstat; 5240c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 5241a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 5242c45dcabdSAndy Whitcroft 524308a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 524462e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 524508a2843eSJoe Perches 5246f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 5247f59b64bfSJoe Perches my $define_args = $1; 5248f59b64bfSJoe Perches my $define_stmt = $dstat; 5249f59b64bfSJoe Perches my @def_args = (); 5250f59b64bfSJoe Perches 5251f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 5252f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 5253f59b64bfSJoe Perches $define_args =~ s/\s*//g; 52548c8c45cfSJoe Perches $define_args =~ s/\\\+?//g; 5255f59b64bfSJoe Perches @def_args = split(",", $define_args); 5256f59b64bfSJoe Perches } 5257f59b64bfSJoe Perches 5258292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 5259c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 5260c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 5261c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 5262c45dcabdSAndy Whitcroft 5263c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 5264bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 5265bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 52666b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 5267bf30d6edSAndy Whitcroft { 5268c45dcabdSAndy Whitcroft } 5269c45dcabdSAndy Whitcroft 5270342d3d2fSAntonio Borneo # Flatten any obvious string concatenation. 527133acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 527233acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 5273e45bab8eSAndy Whitcroft { 5274e45bab8eSAndy Whitcroft } 5275e45bab8eSAndy Whitcroft 527642e15293SJoe Perches # Make asm volatile uses seem like a generic function 527742e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 527842e15293SJoe Perches 5279c45dcabdSAndy Whitcroft my $exceptions = qr{ 5280c45dcabdSAndy Whitcroft $Declare| 5281c45dcabdSAndy Whitcroft module_param_named| 5282a0a0a7a9SKees Cook MODULE_PARM_DESC| 5283c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 5284c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 5285383099fdSAndy Whitcroft __typeof__\(| 528622fd2d3eSStefani Seibold union| 528722fd2d3eSStefani Seibold struct| 5288ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 52896b10df42SVladimir Zapolskiy ^\"|\"$| 52906b10df42SVladimir Zapolskiy ^\[ 5291c45dcabdSAndy Whitcroft }x; 52925eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 5293f59b64bfSJoe Perches 5294f59b64bfSJoe Perches $ctx =~ s/\n*$//; 5295f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 5296e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 5297f59b64bfSJoe Perches 5298f74bd194SAndy Whitcroft if ($dstat ne '' && 5299f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 5300f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 53013cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 5302356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5303f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 5304f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5305e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 530672f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 5307f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5308f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5309f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 53104e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5311f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5312c45dcabdSAndy Whitcroft { 5313e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5314e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5315e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5316e795556aSJoe Perches } elsif ($dstat =~ /;/) { 5317f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5318f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5319f74bd194SAndy Whitcroft } else { 5320000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 5321388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5322d8aaf121SAndy Whitcroft } 5323f59b64bfSJoe Perches 5324f59b64bfSJoe Perches } 53255207649bSJoe Perches 53265207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 53275207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 53285207649bSJoe Perches my $first = 1; 53295207649bSJoe Perches $define_stmt = ""; 53305207649bSJoe Perches foreach my $l (@stmt_array) { 53315207649bSJoe Perches $l =~ s/\\$//; 53325207649bSJoe Perches if ($first) { 53335207649bSJoe Perches $define_stmt = $l; 53345207649bSJoe Perches $first = 0; 53355207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 53365207649bSJoe Perches $define_stmt .= substr($l, 1); 53375207649bSJoe Perches } 53385207649bSJoe Perches } 53395207649bSJoe Perches $define_stmt =~ s/$;//g; 53405207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 53415207649bSJoe Perches $define_stmt = trim($define_stmt); 53425207649bSJoe Perches 5343f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5344f59b64bfSJoe Perches foreach my $arg (@def_args) { 5345f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 53469192d41aSJoe Perches next if ($arg =~ /^type$/i); 53477fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 53486dba824eSBrendan Jackman $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 53497fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 53507fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 5351d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 5352f59b64bfSJoe Perches if ($use_cnt > 1) { 5353f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5354f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5355f59b64bfSJoe Perches } 53569192d41aSJoe Perches# check if any macro arguments may have other precedence issues 53577fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 53589192d41aSJoe Perches ((defined($1) && $1 ne ',') || 53599192d41aSJoe Perches (defined($2) && $2 ne ','))) { 53609192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 53619192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 53629192d41aSJoe Perches } 53630a920b5bSAndy Whitcroft } 53645023d347SJoe Perches 536508a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 536608a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 536708a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 536808a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 5369e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 537008a2843eSJoe Perches 537108a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 537208a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 537308a2843eSJoe Perches } 537408a2843eSJoe Perches 5375481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 53765023d347SJoe Perches 53775023d347SJoe Perches } else { 53785023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5379481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5380481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 53815023d347SJoe Perches $line =~ /^\+.*\\$/) { 53825023d347SJoe Perches WARN("LINE_CONTINUATIONS", 53835023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 53845023d347SJoe Perches } 5385653d4876SAndy Whitcroft } 53860a920b5bSAndy Whitcroft 5387b13edf7fSJoe Perches# do {} while (0) macro tests: 5388b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5389b13edf7fSJoe Perches# macro should not end with a semicolon 53905b57980dSJoe Perches if ($perl_version_ok && 5391b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5392b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5393b13edf7fSJoe Perches my $ln = $linenr; 5394b13edf7fSJoe Perches my $cnt = $realcnt; 5395b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5396b13edf7fSJoe Perches my $ctx = ''; 5397b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5398b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5399b13edf7fSJoe Perches $ctx = $dstat; 5400b13edf7fSJoe Perches 5401b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 54021b36b201SJoe Perches $dstat =~ s/$;/ /g; 5403b13edf7fSJoe Perches 5404b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5405b13edf7fSJoe Perches my $stmts = $2; 5406b13edf7fSJoe Perches my $semis = $3; 5407b13edf7fSJoe Perches 5408b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5409b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5410e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5411b13edf7fSJoe Perches 5412ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5413ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5414b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5415b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5416b13edf7fSJoe Perches } 5417b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5418b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5419b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5420b13edf7fSJoe Perches } 5421f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5422f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5423f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5424e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5425f5ef95b1SJoe Perches 5426f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5427f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5428b13edf7fSJoe Perches } 5429b13edf7fSJoe Perches } 5430b13edf7fSJoe Perches 5431f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 543213214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 543313214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5434cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 543513214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5436cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5437cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5438aad4f614SJoe Perches my @allowed = (); 5439aad4f614SJoe Perches my $allow = 0; 544013214adfSAndy Whitcroft my $seen = 0; 5441773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5442cf655043SAndy Whitcroft my $ln = $linenr - 1; 544313214adfSAndy Whitcroft for my $chunk (@chunks) { 544413214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 544513214adfSAndy Whitcroft 5446773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5447773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5448773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 5449773647a0SAndy Whitcroft 5450aad4f614SJoe Perches $allowed[$allow] = 0; 5451773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5452773647a0SAndy Whitcroft 5453773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 5454773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 5455773647a0SAndy Whitcroft 5456773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5457cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 5458cf655043SAndy Whitcroft 5459773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 546013214adfSAndy Whitcroft 546113214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 546213214adfSAndy Whitcroft 5463aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5464cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5465cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5466aad4f614SJoe Perches $allowed[$allow] = 1; 546713214adfSAndy Whitcroft } 546813214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5469cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5470aad4f614SJoe Perches $allowed[$allow] = 1; 547113214adfSAndy Whitcroft } 5472cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5473cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5474aad4f614SJoe Perches $allowed[$allow] = 1; 547513214adfSAndy Whitcroft } 5476aad4f614SJoe Perches $allow++; 547713214adfSAndy Whitcroft } 5478aad4f614SJoe Perches if ($seen) { 5479aad4f614SJoe Perches my $sum_allowed = 0; 5480aad4f614SJoe Perches foreach (@allowed) { 5481aad4f614SJoe Perches $sum_allowed += $_; 5482aad4f614SJoe Perches } 5483aad4f614SJoe Perches if ($sum_allowed == 0) { 5484000d1cc1SJoe Perches WARN("BRACES", 5485000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 5486aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 5487aad4f614SJoe Perches $seen != $allow) { 5488aad4f614SJoe Perches CHK("BRACES", 5489aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 5490aad4f614SJoe Perches } 549113214adfSAndy Whitcroft } 549213214adfSAndy Whitcroft } 549313214adfSAndy Whitcroft } 5494773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 549513214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 5496cf655043SAndy Whitcroft my $allowed = 0; 5497f0a594c1SAndy Whitcroft 5498cf655043SAndy Whitcroft # Check the pre-context. 5499cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 5500cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 5501cf655043SAndy Whitcroft $allowed = 1; 5502f0a594c1SAndy Whitcroft } 5503773647a0SAndy Whitcroft 5504773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 5505773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 5506773647a0SAndy Whitcroft 5507cf655043SAndy Whitcroft # Check the condition. 5508cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 5509773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 5510cf655043SAndy Whitcroft if (defined $cond) { 5511773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5512cf655043SAndy Whitcroft } 5513cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5514cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5515cf655043SAndy Whitcroft $allowed = 1; 5516cf655043SAndy Whitcroft } 5517cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5518cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5519cf655043SAndy Whitcroft $allowed = 1; 5520cf655043SAndy Whitcroft } 5521cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5522cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5523cf655043SAndy Whitcroft $allowed = 1; 5524cf655043SAndy Whitcroft } 5525cf655043SAndy Whitcroft # Check the post-context. 5526cf655043SAndy Whitcroft if (defined $chunks[1]) { 5527cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 5528cf655043SAndy Whitcroft if (defined $cond) { 5529773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5530cf655043SAndy Whitcroft } 5531cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 5532cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5533cf655043SAndy Whitcroft $allowed = 1; 5534cf655043SAndy Whitcroft } 5535cf655043SAndy Whitcroft } 5536cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 5537f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 5538e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5539cf655043SAndy Whitcroft 5540000d1cc1SJoe Perches WARN("BRACES", 5541000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 5542f0a594c1SAndy Whitcroft } 5543f0a594c1SAndy Whitcroft } 5544f0a594c1SAndy Whitcroft 5545e4c5babdSJoe Perches# check for single line unbalanced braces 554695330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 554795330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 5548e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 5549e4c5babdSJoe Perches } 5550e4c5babdSJoe Perches 55510979ae66SJoe Perches# check for unnecessary blank lines around braces 555277b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5553f8e58219SJoe Perches if (CHK("BRACES", 5554f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5555f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 5556f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5557f8e58219SJoe Perches } 55580979ae66SJoe Perches } 555977b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5560f8e58219SJoe Perches if (CHK("BRACES", 5561f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5562f8e58219SJoe Perches $fix) { 5563f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 5564f8e58219SJoe Perches } 55650979ae66SJoe Perches } 55660979ae66SJoe Perches 55674a0df2efSAndy Whitcroft# no volatiles please 55686c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 55696c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5570000d1cc1SJoe Perches WARN("VOLATILE", 55718c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 55724a0df2efSAndy Whitcroft } 55734a0df2efSAndy Whitcroft 55745e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 55755e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 55765e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 55775e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 557833acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 55795e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 55805e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 55815e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 55825e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 55835e4f6ba5SJoe Perches $fix && 55845e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 55855e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 55865e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 55875e4f6ba5SJoe Perches my $comma_close = ""; 55885e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 55895e4f6ba5SJoe Perches $comma_close = $1; 55905e4f6ba5SJoe Perches } 55915e4f6ba5SJoe Perches 55925e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 55935e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 55945e4f6ba5SJoe Perches my $fixedline = $prevrawline; 55955e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 55965e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 55975e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 55985e4f6ba5SJoe Perches $fixedline = $rawline; 55995e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 56005e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 56015e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 56025e4f6ba5SJoe Perches } 56035e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 56045e4f6ba5SJoe Perches } 56055e4f6ba5SJoe Perches } 56065e4f6ba5SJoe Perches 56075e4f6ba5SJoe Perches# check for missing a space in a string concatenation 56085e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 56095e4f6ba5SJoe Perches WARN('MISSING_SPACE', 56105e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 56115e4f6ba5SJoe Perches } 56125e4f6ba5SJoe Perches 561377cb8546SJoe Perches# check for an embedded function name in a string when the function is known 5614e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 5615e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 5616e4b7d309SJoe Perches# function declarations 561777cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 561877cb8546SJoe Perches defined($context_function) && 5619e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 5620e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 562177cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 5622e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 562377cb8546SJoe Perches } 562477cb8546SJoe Perches 56255e4f6ba5SJoe Perches# check for spaces before a quoted newline 56265e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 56275e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 56285e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 56295e4f6ba5SJoe Perches $fix) { 56305e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 56315e4f6ba5SJoe Perches } 56325e4f6ba5SJoe Perches 56335e4f6ba5SJoe Perches } 56345e4f6ba5SJoe Perches 5635f17dba4fSJoe Perches# concatenated string without spaces between elements 563679682c0cSJoe Perches if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) { 563779682c0cSJoe Perches if (CHK("CONCATENATED_STRING", 563879682c0cSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr) && 563979682c0cSJoe Perches $fix) { 564079682c0cSJoe Perches while ($line =~ /($String)/g) { 564179682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 564279682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/; 564379682c0cSJoe Perches $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/; 564479682c0cSJoe Perches } 564579682c0cSJoe Perches } 5646f17dba4fSJoe Perches } 5647f17dba4fSJoe Perches 564890ad30e5SJoe Perches# uncoalesced string fragments 564933acb54aSJoe Perches if ($line =~ /$String\s*"/) { 565079682c0cSJoe Perches if (WARN("STRING_FRAGMENTS", 565179682c0cSJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr) && 565279682c0cSJoe Perches $fix) { 565379682c0cSJoe Perches while ($line =~ /($String)(?=\s*")/g) { 565479682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 565579682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e; 565679682c0cSJoe Perches } 565779682c0cSJoe Perches } 565890ad30e5SJoe Perches } 565990ad30e5SJoe Perches 5660522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 5661522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 5662522b837cSAlexey Dobriyan my $show_Z = 1; 56635e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 5664522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 56655e4f6ba5SJoe Perches $string =~ s/%%/__/g; 5666522b837cSAlexey Dobriyan # check for %L 5667522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 56685e4f6ba5SJoe Perches WARN("PRINTF_L", 5669522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 5670522b837cSAlexey Dobriyan $show_L = 0; 56715e4f6ba5SJoe Perches } 5672522b837cSAlexey Dobriyan # check for %Z 5673522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 5674522b837cSAlexey Dobriyan WARN("PRINTF_Z", 5675522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 5676522b837cSAlexey Dobriyan $show_Z = 0; 5677522b837cSAlexey Dobriyan } 5678522b837cSAlexey Dobriyan # check for 0x<decimal> 5679522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 5680522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 56816e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 56826e300757SJoe Perches } 56835e4f6ba5SJoe Perches } 56845e4f6ba5SJoe Perches 56855e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 56863f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 56875e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 56885e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 56895e4f6ba5SJoe Perches } 56905e4f6ba5SJoe Perches 569100df344fSAndy Whitcroft# warn about #if 0 5692c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 569360f89010SPrakruthi Deepak Heragu WARN("IF_0", 569460f89010SPrakruthi Deepak Heragu "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr); 569560f89010SPrakruthi Deepak Heragu } 569660f89010SPrakruthi Deepak Heragu 569760f89010SPrakruthi Deepak Heragu# warn about #if 1 569860f89010SPrakruthi Deepak Heragu if ($line =~ /^.\s*\#\s*if\s+1\b/) { 569960f89010SPrakruthi Deepak Heragu WARN("IF_1", 570060f89010SPrakruthi Deepak Heragu "Consider removing the #if 1 and its #endif\n" . $herecurr); 57014a0df2efSAndy Whitcroft } 57024a0df2efSAndy Whitcroft 570303df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 570403df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5705100425deSJoe Perches my $tested = quotemeta($1); 5706100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5707100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5708100425deSJoe Perches my $func = $1; 5709100425deSJoe Perches if (WARN('NEEDLESS_IF', 5710100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5711100425deSJoe Perches $fix) { 5712100425deSJoe Perches my $do_fix = 1; 5713100425deSJoe Perches my $leading_tabs = ""; 5714100425deSJoe Perches my $new_leading_tabs = ""; 5715100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5716100425deSJoe Perches $leading_tabs = $1; 5717100425deSJoe Perches } else { 5718100425deSJoe Perches $do_fix = 0; 5719100425deSJoe Perches } 5720100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5721100425deSJoe Perches $new_leading_tabs = $1; 5722100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5723100425deSJoe Perches $do_fix = 0; 5724100425deSJoe Perches } 5725100425deSJoe Perches } else { 5726100425deSJoe Perches $do_fix = 0; 5727100425deSJoe Perches } 5728100425deSJoe Perches if ($do_fix) { 5729100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5730100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5731100425deSJoe Perches } 5732100425deSJoe Perches } 57334c432a8fSGreg Kroah-Hartman } 57344c432a8fSGreg Kroah-Hartman } 5735f0a594c1SAndy Whitcroft 5736ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5737ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5738ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5739ebfdc409SJoe Perches (defined $1 || defined $3) && 5740ebfdc409SJoe Perches $linenr > 3) { 5741ebfdc409SJoe Perches my $testval = $2; 5742ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5743ebfdc409SJoe Perches 5744ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5745ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5746ebfdc409SJoe Perches 5747e29a70f1SJoe Perches if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ && 5748e29a70f1SJoe Perches $s !~ /\b__GFP_NOWARN\b/ ) { 5749ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5750ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5751ebfdc409SJoe Perches } 5752ebfdc409SJoe Perches } 5753ebfdc409SJoe Perches 5754f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5755dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5756f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5757f78d98f6SJoe Perches my $level = $1; 5758f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5759f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5760f78d98f6SJoe Perches $fix) { 5761f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5762f78d98f6SJoe Perches } 5763f78d98f6SJoe Perches } 5764f78d98f6SJoe Perches 576545c55e92SJoe Perches# check for logging continuations 576645c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 576745c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 576845c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 576945c55e92SJoe Perches } 577045c55e92SJoe Perches 5771abb08a53SJoe Perches# check for mask then right shift without a parentheses 57725b57980dSJoe Perches if ($perl_version_ok && 5773abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5774abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5775abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5776abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5777abb08a53SJoe Perches } 5778abb08a53SJoe Perches 5779b75ac618SJoe Perches# check for pointer comparisons to NULL 57805b57980dSJoe Perches if ($perl_version_ok) { 5781b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5782b75ac618SJoe Perches my $val = $1; 5783b75ac618SJoe Perches my $equal = "!"; 5784b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5785b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5786b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5787b75ac618SJoe Perches $fix) { 5788b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5789b75ac618SJoe Perches } 5790b75ac618SJoe Perches } 5791b75ac618SJoe Perches } 5792b75ac618SJoe Perches 57938716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 57948716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 57958716de38SJoe Perches my $attr = $1; 57968716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 57978716de38SJoe Perches my $ptr = $1; 57988716de38SJoe Perches my $var = $2; 57998716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 58008716de38SJoe Perches ERROR("MISPLACED_INIT", 58018716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 58028716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 58038716de38SJoe Perches WARN("MISPLACED_INIT", 58048716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 58058716de38SJoe Perches $fix) { 5806194f66fcSJoe 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; 58078716de38SJoe Perches } 58088716de38SJoe Perches } 58098716de38SJoe Perches } 58108716de38SJoe Perches 5811e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5812e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5813e970b884SJoe Perches my $attr = $1; 5814e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5815e970b884SJoe Perches my $attr_prefix = $1; 5816e970b884SJoe Perches my $attr_type = $2; 5817e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5818e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5819e970b884SJoe Perches $fix) { 5820194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5821e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5822e970b884SJoe Perches } 5823e970b884SJoe Perches } 5824e970b884SJoe Perches 5825e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5826e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5827e970b884SJoe Perches my $attr = $1; 5828e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5829e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5830e970b884SJoe Perches $fix) { 5831194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5832e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5833e970b884SJoe Perches $lead = rtrim($1); 5834e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5835e970b884SJoe Perches $lead = "${lead}const "; 5836194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5837e970b884SJoe Perches } 5838e970b884SJoe Perches } 5839e970b884SJoe Perches 5840c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5841c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5842c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5843c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5844c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5845c17893c7SJoe Perches $fix) { 5846c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5847c17893c7SJoe Perches } 5848c17893c7SJoe Perches } 5849c17893c7SJoe Perches 5850fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5851fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5852fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5853fbdb8138SJoe Perches my $constant_func = $1; 5854fbdb8138SJoe Perches my $func = $constant_func; 5855fbdb8138SJoe Perches $func =~ s/^__constant_//; 5856fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5857fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5858fbdb8138SJoe Perches $fix) { 5859194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5860fbdb8138SJoe Perches } 5861fbdb8138SJoe Perches } 5862fbdb8138SJoe Perches 58631a15a250SPatrick Pannuto# prefer usleep_range over udelay 586437581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 586543c1d77cSJoe Perches my $delay = $1; 58661a15a250SPatrick Pannuto # ignore udelay's < 10, however 586743c1d77cSJoe Perches if (! ($delay < 10) ) { 5868000d1cc1SJoe Perches CHK("USLEEP_RANGE", 5869458f69efSMauro Carvalho Chehab "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr); 587043c1d77cSJoe Perches } 587143c1d77cSJoe Perches if ($delay > 2000) { 587243c1d77cSJoe Perches WARN("LONG_UDELAY", 587343c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 58741a15a250SPatrick Pannuto } 58751a15a250SPatrick Pannuto } 58761a15a250SPatrick Pannuto 587709ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 587809ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 587909ef8725SPatrick Pannuto if ($1 < 20) { 5880000d1cc1SJoe Perches WARN("MSLEEP", 5881458f69efSMauro Carvalho Chehab "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr); 588209ef8725SPatrick Pannuto } 588309ef8725SPatrick Pannuto } 588409ef8725SPatrick Pannuto 588536ec1939SJoe Perches# check for comparisons of jiffies 588636ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 588736ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 588836ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 588936ec1939SJoe Perches } 589036ec1939SJoe Perches 58919d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 58929d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 58939d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 58949d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 58959d7a34a5SJoe Perches } 58969d7a34a5SJoe Perches 589700df344fSAndy Whitcroft# warn about #ifdefs in C files 5898c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 589900df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 590000df344fSAndy Whitcroft# print "$herecurr"; 590100df344fSAndy Whitcroft# $clean = 0; 590200df344fSAndy Whitcroft# } 590300df344fSAndy Whitcroft 590422f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5905c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 59063705ce5bSJoe Perches if (ERROR("SPACING", 59073705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 59083705ce5bSJoe Perches $fix) { 5909194f66fcSJoe Perches $fixed[$fixlinenr] =~ 59103705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 59113705ce5bSJoe Perches } 59123705ce5bSJoe Perches 591322f2a2efSAndy Whitcroft } 591422f2a2efSAndy Whitcroft 59154a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5916171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5917171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 59184a0df2efSAndy Whitcroft my $which = $1; 59194a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5920000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5921000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 59224a0df2efSAndy Whitcroft } 59234a0df2efSAndy Whitcroft } 59244a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5925402c2553SMichael S. Tsirkin 5926402c2553SMichael S. Tsirkin my $barriers = qr{ 5927402c2553SMichael S. Tsirkin mb| 5928402c2553SMichael S. Tsirkin rmb| 5929ad83ec6cSWill Deacon wmb 5930402c2553SMichael S. Tsirkin }x; 5931402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5932402c2553SMichael S. Tsirkin mb__before_atomic| 5933402c2553SMichael S. Tsirkin mb__after_atomic| 5934402c2553SMichael S. Tsirkin store_release| 5935402c2553SMichael S. Tsirkin load_acquire| 5936402c2553SMichael S. Tsirkin store_mb| 5937402c2553SMichael S. Tsirkin (?:$barriers) 5938402c2553SMichael S. Tsirkin }x; 5939402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5940402c2553SMichael S. Tsirkin (?:$barriers)| 594143e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 594243e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5943402c2553SMichael S. Tsirkin }x; 5944402c2553SMichael S. Tsirkin 5945402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 59464a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5947c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5948000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 59494a0df2efSAndy Whitcroft } 59504a0df2efSAndy Whitcroft } 59513ad81779SPaul E. McKenney 5952f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5953f4073b0fSMichael S. Tsirkin 5954f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5955f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5956f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5957f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5958f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5959f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5960f4073b0fSMichael S. Tsirkin } 5961f4073b0fSMichael S. Tsirkin 5962cb426e99SJoe Perches# check for waitqueue_active without a comment. 5963cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5964cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5965cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5966cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5967cb426e99SJoe Perches } 5968cb426e99SJoe Perches } 59693ad81779SPaul E. McKenney 59705099a722SMarco Elver# check for data_race without a comment. 59715099a722SMarco Elver if ($line =~ /\bdata_race\s*\(/) { 59725099a722SMarco Elver if (!ctx_has_comment($first_line, $linenr)) { 59735099a722SMarco Elver WARN("DATA_RACE", 59745099a722SMarco Elver "data_race without comment\n" . $herecurr); 59755099a722SMarco Elver } 59765099a722SMarco Elver } 59775099a722SMarco Elver 59784a0df2efSAndy Whitcroft# check of hardware specific defines 5979c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5980000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5981000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 59820a920b5bSAndy Whitcroft } 5983653d4876SAndy Whitcroft 5984596ed45bSJoe Perches# check that the storage class is not after a type 5985596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 5986000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5987596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 5988596ed45bSJoe Perches } 5989596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 5990596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 5991596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 5992596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 5993596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 5994596ed45bSJoe Perches WARN("STORAGE_CLASS", 5995596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 5996d4977c78STobias Klauser } 5997d4977c78STobias Klauser 5998de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5999de7d4f0eSAndy Whitcroft# storage class and type. 60009c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 60019c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 6002000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 6003000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 6004de7d4f0eSAndy Whitcroft } 6005de7d4f0eSAndy Whitcroft 60068905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 60072b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 60082b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 6009d5e616fcSJoe Perches if (WARN("INLINE", 6010d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 6011d5e616fcSJoe Perches $fix) { 6012194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 6013d5e616fcSJoe Perches 6014d5e616fcSJoe Perches } 60158905a67cSAndy Whitcroft } 60168905a67cSAndy Whitcroft 60173d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 60182b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 60192b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 6020000d1cc1SJoe Perches WARN("PREFER_PACKED", 6021000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 60223d130fd0SJoe Perches } 60233d130fd0SJoe Perches 602439b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 60252b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 60262b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 6027000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 6028000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 602939b7e287SJoe Perches } 603039b7e287SJoe Perches 6031462811d9SJoe Perches# Check for __attribute__ section, prefer __section 6032462811d9SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 6033462811d9SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) { 6034462811d9SJoe Perches my $old = substr($rawline, $-[1], $+[1] - $-[1]); 6035462811d9SJoe Perches my $new = substr($old, 1, -1); 6036462811d9SJoe Perches if (WARN("PREFER_SECTION", 6037462811d9SJoe Perches "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) && 6038462811d9SJoe Perches $fix) { 6039462811d9SJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/; 6040462811d9SJoe Perches } 6041462811d9SJoe Perches } 6042462811d9SJoe Perches 60435f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 60442b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 60452b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 6046d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 6047d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 6048d5e616fcSJoe Perches $fix) { 6049194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 6050d5e616fcSJoe Perches 6051d5e616fcSJoe Perches } 60525f14d3bdSJoe Perches } 60535f14d3bdSJoe Perches 60546061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 60552b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 60562b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 6057d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 6058d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 6059d5e616fcSJoe Perches $fix) { 6060194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 6061d5e616fcSJoe Perches } 60626061d949SJoe Perches } 60636061d949SJoe Perches 6064619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 60655b57980dSJoe Perches if ($perl_version_ok && 6066619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 6067619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 6068619a908aSJoe Perches $line =~ /\b__weak\b/)) { 6069619a908aSJoe Perches ERROR("WEAK_DECLARATION", 6070619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 6071619a908aSJoe Perches } 6072619a908aSJoe Perches 6073fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 6074e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 6075fd39f904STomas Winkler $realfile !~ m@\btools/@ && 6076e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 6077e6176fa4SJoe Perches my $type = $1; 6078e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 6079e6176fa4SJoe Perches $type = $1; 6080e6176fa4SJoe Perches my $kernel_type = 'u'; 6081e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 6082e6176fa4SJoe Perches $type =~ /(\d+)/; 6083e6176fa4SJoe Perches $kernel_type .= $1; 6084e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 6085e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 6086e6176fa4SJoe Perches $fix) { 6087e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 6088e6176fa4SJoe Perches } 6089e6176fa4SJoe Perches } 6090e6176fa4SJoe Perches } 6091e6176fa4SJoe Perches 6092938224b5SJoe Perches# check for cast of C90 native int or longer types constants 6093938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 6094938224b5SJoe Perches my $cast = $1; 6095938224b5SJoe Perches my $const = $2; 6096938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 6097938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 6098938224b5SJoe Perches $fix) { 6099938224b5SJoe Perches my $suffix = ""; 6100938224b5SJoe Perches my $newconst = $const; 6101938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 6102938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 6103938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 6104938224b5SJoe Perches $suffix .= 'LL'; 6105938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 6106938224b5SJoe Perches $suffix .= 'L'; 6107938224b5SJoe Perches } 6108938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 6109938224b5SJoe Perches } 6110938224b5SJoe Perches } 6111938224b5SJoe Perches 61128f53a9b8SJoe Perches# check for sizeof(&) 61138f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 6114000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 6115000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 61168f53a9b8SJoe Perches } 61178f53a9b8SJoe Perches 611866c80b60SJoe Perches# check for sizeof without parenthesis 611966c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 6120d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 6121d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 6122d5e616fcSJoe Perches $fix) { 6123194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 6124d5e616fcSJoe Perches } 612566c80b60SJoe Perches } 612666c80b60SJoe Perches 612788982feaSJoe Perches# check for struct spinlock declarations 612888982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 612988982feaSJoe Perches WARN("USE_SPINLOCK_T", 613088982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 613188982feaSJoe Perches } 613288982feaSJoe Perches 6133a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 613406668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 6135a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 6136caac1d5fSHeba Aamer $fmt =~ s/%%//g; 6137caac1d5fSHeba Aamer if ($fmt !~ /%/) { 6138d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 6139d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 6140d5e616fcSJoe Perches $fix) { 6141194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 6142d5e616fcSJoe Perches } 6143a6962d72SJoe Perches } 6144a6962d72SJoe Perches } 6145a6962d72SJoe Perches 61460b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 61475b57980dSJoe Perches if ($perl_version_ok && 61480b523769SJoe Perches defined $stat && 61490b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 61500b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 6151e3c6bc95STobin C. Harding my $stat_real; 6152e3c6bc95STobin C. Harding 61530b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 61540b523769SJoe Perches $lc = $lc + $linenr; 61550b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 6156ffe07513SJoe Perches my $specifier; 6157ffe07513SJoe Perches my $extension; 61583bd32d6aSSakari Ailus my $qualifier; 6159ffe07513SJoe Perches my $bad_specifier = ""; 61600b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 61610b523769SJoe Perches $fmt =~ s/%%//g; 6162e3c6bc95STobin C. Harding 61633bd32d6aSSakari Ailus while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) { 6164e3c6bc95STobin C. Harding $specifier = $1; 6165e3c6bc95STobin C. Harding $extension = $2; 61663bd32d6aSSakari Ailus $qualifier = $3; 6167361b0d28SLinus Torvalds if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ || 61683bd32d6aSSakari Ailus ($extension eq "f" && 61693bd32d6aSSakari Ailus defined $qualifier && $qualifier !~ /^w/)) { 6170e3c6bc95STobin C. Harding $bad_specifier = $specifier; 61710b523769SJoe Perches last; 61720b523769SJoe Perches } 6173e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 6174e3c6bc95STobin C. Harding if (!defined($stat_real)) { 6175e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 61760b523769SJoe Perches } 6177e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 6178e3c6bc95STobin 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"); 6179e3c6bc95STobin C. Harding } 6180e3c6bc95STobin C. Harding } 6181e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 61822a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 61831df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 61841df7338aSSergey Senozhatsky my $use = ""; 6185e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 61861df7338aSSergey Senozhatsky $use = " - use %pS instead"; 6187e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 61881df7338aSSergey Senozhatsky } 61892a9f9d85STobin C. Harding 61900b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 6191e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 6192e3c6bc95STobin C. Harding } 61930b523769SJoe Perches } 61940b523769SJoe Perches } 61950b523769SJoe Perches 6196554e165cSAndy Whitcroft# Check for misused memsets 61975b57980dSJoe Perches if ($perl_version_ok && 6198d1fe9c09SJoe Perches defined $stat && 61999e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 6200554e165cSAndy Whitcroft 6201d7c76ba7SJoe Perches my $ms_addr = $2; 6202d1fe9c09SJoe Perches my $ms_val = $7; 6203d1fe9c09SJoe Perches my $ms_size = $12; 6204d7c76ba7SJoe Perches 6205554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 6206554e165cSAndy Whitcroft ERROR("MEMSET", 6207d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 6208554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 6209554e165cSAndy Whitcroft WARN("MEMSET", 6210d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 6211d7c76ba7SJoe Perches } 6212d7c76ba7SJoe Perches } 6213d7c76ba7SJoe Perches 621498a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 62155b57980dSJoe Perches# if ($perl_version_ok && 6216f333195dSJoe Perches# defined $stat && 6217f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6218f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 6219f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 6220f333195dSJoe Perches# $fix) { 6221f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 6222f333195dSJoe Perches# } 6223f333195dSJoe Perches# } 622498a9bba5SJoe Perches 6225b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 62265b57980dSJoe Perches# if ($perl_version_ok && 6227f333195dSJoe Perches# defined $stat && 6228f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6229f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 6230f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 6231f333195dSJoe Perches# } 6232b6117d17SMateusz Kulikowski 62338617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 62348617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 62355b57980dSJoe Perches# if ($perl_version_ok && 6236f333195dSJoe Perches# defined $stat && 6237f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6238f333195dSJoe Perches# 6239f333195dSJoe Perches# my $ms_val = $7; 6240f333195dSJoe Perches# 6241f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 6242f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 6243f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 6244f333195dSJoe Perches# $fix) { 6245f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 6246f333195dSJoe Perches# } 6247f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 6248f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 6249f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 6250f333195dSJoe Perches# $fix) { 6251f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 6252f333195dSJoe Perches# } 6253f333195dSJoe Perches# } 6254f333195dSJoe Perches# } 62558617cd09SMateusz Kulikowski 6256d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 62575b57980dSJoe Perches if ($perl_version_ok && 6258d1fe9c09SJoe Perches defined $stat && 6259d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 6260d1fe9c09SJoe Perches if (defined $2 || defined $7) { 6261d7c76ba7SJoe Perches my $call = $1; 6262d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 6263d7c76ba7SJoe Perches my $arg1 = $3; 6264d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 6265d1fe9c09SJoe Perches my $arg2 = $8; 6266d7c76ba7SJoe Perches my $cast; 6267d7c76ba7SJoe Perches 6268d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 6269d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 6270d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 6271d7c76ba7SJoe Perches $cast = $cast1; 6272d7c76ba7SJoe Perches } else { 6273d7c76ba7SJoe Perches $cast = $cast2; 6274d7c76ba7SJoe Perches } 6275d7c76ba7SJoe Perches WARN("MINMAX", 6276d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 6277554e165cSAndy Whitcroft } 6278554e165cSAndy Whitcroft } 6279554e165cSAndy Whitcroft 62804a273195SJoe Perches# check usleep_range arguments 62815b57980dSJoe Perches if ($perl_version_ok && 62824a273195SJoe Perches defined $stat && 62834a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 62844a273195SJoe Perches my $min = $1; 62854a273195SJoe Perches my $max = $7; 62864a273195SJoe Perches if ($min eq $max) { 62874a273195SJoe Perches WARN("USLEEP_RANGE", 6288458f69efSMauro Carvalho Chehab "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 62894a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 62904a273195SJoe Perches $min > $max) { 62914a273195SJoe Perches WARN("USLEEP_RANGE", 6292458f69efSMauro Carvalho Chehab "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 62934a273195SJoe Perches } 62944a273195SJoe Perches } 62954a273195SJoe Perches 6296823b794cSJoe Perches# check for naked sscanf 62975b57980dSJoe Perches if ($perl_version_ok && 6298823b794cSJoe Perches defined $stat && 62996c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 6300823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 6301823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 6302823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 6303823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 6304823b794cSJoe Perches $lc = $lc + $linenr; 63052a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6306823b794cSJoe Perches WARN("NAKED_SSCANF", 6307823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 6308823b794cSJoe Perches } 6309823b794cSJoe Perches 6310afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 63115b57980dSJoe Perches if ($perl_version_ok && 6312afc819abSJoe Perches defined $stat && 6313afc819abSJoe Perches $line =~ /\bsscanf\b/) { 6314afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 6315afc819abSJoe Perches $lc = $lc + $linenr; 63162a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6317afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 6318afc819abSJoe Perches my $format = $6; 6319afc819abSJoe Perches my $count = $format =~ tr@%@%@; 6320afc819abSJoe Perches if ($count == 1 && 6321afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 6322afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 6323afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 6324afc819abSJoe Perches } 6325afc819abSJoe Perches } 6326afc819abSJoe Perches } 6327afc819abSJoe Perches 632870dc8a48SJoe Perches# check for new externs in .h files. 632970dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 633070dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 6331d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 633270dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 633370dc8a48SJoe Perches $fix) { 6334194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 633570dc8a48SJoe Perches } 633670dc8a48SJoe Perches } 633770dc8a48SJoe Perches 6338de7d4f0eSAndy Whitcroft# check for new externs in .c files. 6339171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 6340c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 6341171ae1a4SAndy Whitcroft { 6342c45dcabdSAndy Whitcroft my $function_name = $1; 6343c45dcabdSAndy Whitcroft my $paren_space = $2; 6344171ae1a4SAndy Whitcroft 6345171ae1a4SAndy Whitcroft my $s = $stat; 6346171ae1a4SAndy Whitcroft if (defined $cond) { 6347171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 6348171ae1a4SAndy Whitcroft } 6349d8b44b58SKees Cook if ($s =~ /^\s*;/) 6350c45dcabdSAndy Whitcroft { 6351000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6352000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6353de7d4f0eSAndy Whitcroft } 6354de7d4f0eSAndy Whitcroft 6355171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 6356000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 6357000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 6358171ae1a4SAndy Whitcroft } 63599c9ba34eSAndy Whitcroft 63609c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 63619c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 63629c9ba34eSAndy Whitcroft { 6363000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6364000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6365171ae1a4SAndy Whitcroft } 6366171ae1a4SAndy Whitcroft 6367a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 6368a0ad7596SJoe Perches if (defined $stat && 6369d8b44b58SKees Cook $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 6370d8b44b58SKees Cook $1 ne "void") { 6371d8b44b58SKees Cook my $args = trim($1); 6372ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6373ca0d8929SJoe Perches my $arg = trim($1); 6374d8b44b58SKees Cook if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 6375ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 6376ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6377ca0d8929SJoe Perches } 6378ca0d8929SJoe Perches } 6379ca0d8929SJoe Perches } 6380ca0d8929SJoe Perches 6381a0ad7596SJoe Perches# check for function definitions 63825b57980dSJoe Perches if ($perl_version_ok && 6383a0ad7596SJoe Perches defined $stat && 6384a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6385a0ad7596SJoe Perches $context_function = $1; 6386a0ad7596SJoe Perches 6387a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 6388a0ad7596SJoe Perches my $ok = 0; 6389a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 6390a0ad7596SJoe Perches my $herectx = $here . "\n"; 6391a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6392a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 6393a0ad7596SJoe Perches $herectx .= $rl . "\n"; 6394a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 6395a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 6396a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 6397a0ad7596SJoe Perches } 6398a0ad7596SJoe Perches if (!$ok) { 6399a0ad7596SJoe Perches ERROR("OPEN_BRACE", 6400a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 6401a0ad7596SJoe Perches } 6402a0ad7596SJoe Perches } 6403a0ad7596SJoe Perches 6404de7d4f0eSAndy Whitcroft# checks for new __setup's 6405de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 6406de7d4f0eSAndy Whitcroft my $name = $1; 6407de7d4f0eSAndy Whitcroft 6408de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 6409000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 64102581ac7cSTim Froidcoeur "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr); 6411de7d4f0eSAndy Whitcroft } 6412653d4876SAndy Whitcroft } 64139c0ca6f9SAndy Whitcroft 6414e29a70f1SJoe Perches# check for pointless casting of alloc functions 6415e29a70f1SJoe Perches if ($line =~ /\*\s*\)\s*$allocFunctions\b/) { 6416000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 6417000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 64189c0ca6f9SAndy Whitcroft } 641913214adfSAndy Whitcroft 6420a640d25cSJoe Perches# alloc style 6421a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 64225b57980dSJoe Perches if ($perl_version_ok && 6423e29a70f1SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 6424a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 6425a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 6426a640d25cSJoe Perches } 6427a640d25cSJoe Perches 642860a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 64295b57980dSJoe Perches if ($perl_version_ok && 64301b4a2ed4SJoe Perches defined $stat && 64311b4a2ed4SJoe Perches $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 643260a55369SJoe Perches my $oldfunc = $3; 643360a55369SJoe Perches my $a1 = $4; 643460a55369SJoe Perches my $a2 = $10; 643560a55369SJoe Perches my $newfunc = "kmalloc_array"; 643660a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 643760a55369SJoe Perches my $r1 = $a1; 643860a55369SJoe Perches my $r2 = $a2; 643960a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 644060a55369SJoe Perches $r1 = $a2; 644160a55369SJoe Perches $r2 = $a1; 644260a55369SJoe Perches } 6443e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 6444e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 64451b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 6446e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6447e3d95a2aSTobin C. Harding 6448e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 64491b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 64501b4a2ed4SJoe Perches $cnt == 1 && 6451e367455aSJoe Perches $fix) { 6452194f66fcSJoe 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; 645360a55369SJoe Perches } 645460a55369SJoe Perches } 645560a55369SJoe Perches } 645660a55369SJoe Perches 6457972fdea2SJoe Perches# check for krealloc arg reuse 64585b57980dSJoe Perches if ($perl_version_ok && 64594cab63ceSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ && 64604cab63ceSJoe Perches $1 eq $3) { 6461972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 6462972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 6463972fdea2SJoe Perches } 6464972fdea2SJoe Perches 64655ce59ae0SJoe Perches# check for alloc argument mismatch 64665ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 64675ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 64685ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 64695ce59ae0SJoe Perches } 64705ce59ae0SJoe Perches 6471caf2a54fSJoe Perches# check for multiple semicolons 6472caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 6473d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 6474d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 6475d5e616fcSJoe Perches $fix) { 6476194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 6477d5e616fcSJoe Perches } 6478d1e2ad07SJoe Perches } 6479d1e2ad07SJoe Perches 6480cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 6481cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 6482cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 64830ab90191SJoe Perches my $ull = ""; 64840ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 64850ab90191SJoe Perches if (CHK("BIT_MACRO", 64860ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 64870ab90191SJoe Perches $fix) { 64880ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 64890ab90191SJoe Perches } 64900ab90191SJoe Perches } 64910ab90191SJoe Perches 649250161266SJoe Perches# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too) 649350161266SJoe Perches if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^CONFIG_/) { 649450161266SJoe Perches WARN("IS_ENABLED_CONFIG", 649550161266SJoe Perches "IS_ENABLED($1) is normally used as IS_ENABLED(CONFIG_$1)\n" . $herecurr); 649650161266SJoe Perches } 649750161266SJoe Perches 64982d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 64992d632745SJoe 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*$/) { 65002d632745SJoe Perches my $config = $1; 65012d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 65022d632745SJoe Perches "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) && 65032d632745SJoe Perches $fix) { 65042d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 65052d632745SJoe Perches } 65062d632745SJoe Perches } 65072d632745SJoe Perches 6508e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 6509c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 6510c34c09a8SJoe Perches my $has_break = 0; 6511c34c09a8SJoe Perches my $has_statement = 0; 6512c34c09a8SJoe Perches my $count = 0; 6513c34c09a8SJoe Perches my $prevline = $linenr; 6514e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 6515c34c09a8SJoe Perches $prevline--; 6516c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 6517c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 6518c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 6519c34c09a8SJoe Perches next if ($fline =~ /^\-/); 6520c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 6521c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 6522c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 6523c34c09a8SJoe Perches $has_statement = 1; 6524c34c09a8SJoe Perches $count++; 6525258f79d5SHeinrich Schuchardt $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/); 6526c34c09a8SJoe Perches } 6527c34c09a8SJoe Perches if (!$has_break && $has_statement) { 6528c34c09a8SJoe Perches WARN("MISSING_BREAK", 6529224236d9SAndrew Morton "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr); 6530c34c09a8SJoe Perches } 6531c34c09a8SJoe Perches } 6532c34c09a8SJoe Perches 6533f36d3eb8SJoe Perches# check for /* fallthrough */ like comment, prefer fallthrough; 6534f36d3eb8SJoe Perches my @fallthroughs = ( 6535f36d3eb8SJoe Perches 'fallthrough', 6536f36d3eb8SJoe Perches '@fallthrough@', 6537f36d3eb8SJoe Perches 'lint -fallthrough[ \t]*', 6538f36d3eb8SJoe Perches 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)', 6539f36d3eb8SJoe Perches '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?', 6540f36d3eb8SJoe Perches 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 6541f36d3eb8SJoe Perches 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 6542f36d3eb8SJoe Perches ); 6543f36d3eb8SJoe Perches if ($raw_comment ne '') { 6544f36d3eb8SJoe Perches foreach my $ft (@fallthroughs) { 6545f36d3eb8SJoe Perches if ($raw_comment =~ /$ft/) { 6546f36d3eb8SJoe Perches my $msg_level = \&WARN; 6547f36d3eb8SJoe Perches $msg_level = \&CHK if ($file); 6548f36d3eb8SJoe Perches &{$msg_level}("PREFER_FALLTHROUGH", 6549f36d3eb8SJoe Perches "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr); 6550f36d3eb8SJoe Perches last; 6551f36d3eb8SJoe Perches } 6552f36d3eb8SJoe Perches } 6553f36d3eb8SJoe Perches } 6554f36d3eb8SJoe Perches 6555d1e2ad07SJoe Perches# check for switch/default statements without a break; 65565b57980dSJoe Perches if ($perl_version_ok && 6557d1e2ad07SJoe Perches defined $stat && 6558d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 6559d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 6560e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6561e3d95a2aSTobin C. Harding 6562d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 6563d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 6564caf2a54fSJoe Perches } 6565caf2a54fSJoe Perches 656613214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 6567d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 6568d5e616fcSJoe Perches if (WARN("USE_FUNC", 6569d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 6570d5e616fcSJoe Perches $fix) { 6571194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 6572d5e616fcSJoe Perches } 657313214adfSAndy Whitcroft } 6574773647a0SAndy Whitcroft 657562ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 657662ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 657762ec818fSJoe Perches ERROR("DATE_TIME", 657862ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 657962ec818fSJoe Perches } 658062ec818fSJoe Perches 65812c92488aSJoe Perches# check for use of yield() 65822c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 65832c92488aSJoe Perches WARN("YIELD", 65842c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 65852c92488aSJoe Perches } 65862c92488aSJoe Perches 6587179f8f40SJoe Perches# check for comparisons against true and false 6588179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 6589179f8f40SJoe Perches my $lead = $1; 6590179f8f40SJoe Perches my $arg = $2; 6591179f8f40SJoe Perches my $test = $3; 6592179f8f40SJoe Perches my $otype = $4; 6593179f8f40SJoe Perches my $trail = $5; 6594179f8f40SJoe Perches my $op = "!"; 6595179f8f40SJoe Perches 6596179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 6597179f8f40SJoe Perches 6598179f8f40SJoe Perches my $type = lc($otype); 6599179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 6600179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 6601179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 6602179f8f40SJoe Perches $op = ""; 6603179f8f40SJoe Perches } 6604179f8f40SJoe Perches 6605179f8f40SJoe Perches CHK("BOOL_COMPARISON", 6606179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 6607179f8f40SJoe Perches 6608179f8f40SJoe Perches## maybe suggesting a correct construct would better 6609179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 6610179f8f40SJoe Perches 6611179f8f40SJoe Perches } 6612179f8f40SJoe Perches } 6613179f8f40SJoe Perches 66144882720bSThomas Gleixner# check for semaphores initialized locked 66154882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 6616000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 6617000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 6618773647a0SAndy Whitcroft } 66196712d858SJoe Perches 662067d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 662167d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 6622000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 662367d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 6624773647a0SAndy Whitcroft } 66256712d858SJoe Perches 6626ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 6627f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 6628000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 6629ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 6630f3db6639SMichael Ellerman } 66316712d858SJoe Perches 66323d709ab5SPaul E. McKenney# check for spin_is_locked(), suggest lockdep instead 66333d709ab5SPaul E. McKenney if ($line =~ /\bspin_is_locked\(/) { 66343d709ab5SPaul E. McKenney WARN("USE_LOCKDEP", 66353d709ab5SPaul E. McKenney "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr); 66363d709ab5SPaul E. McKenney } 66373d709ab5SPaul E. McKenney 66389189c7e7SJoe Perches# check for deprecated apis 66399189c7e7SJoe Perches if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) { 66409189c7e7SJoe Perches my $deprecated_api = $1; 66419189c7e7SJoe Perches my $new_api = $deprecated_apis{$deprecated_api}; 66429189c7e7SJoe Perches WARN("DEPRECATED_API", 66439189c7e7SJoe Perches "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr); 66449189c7e7SJoe Perches } 66459189c7e7SJoe Perches 66460f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 6647d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 6648*ced69da1SQuentin Monnet if (defined($const_structs) && 6649*ced69da1SQuentin Monnet $line !~ /\bconst\b/ && 6650d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 6651000d1cc1SJoe Perches WARN("CONST_STRUCT", 6652d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 66532b6db5cbSAndy Whitcroft } 6654773647a0SAndy Whitcroft 6655773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 6656773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 6657773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 6658c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 6659c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 6660171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 6661171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 6662171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 6663773647a0SAndy Whitcroft { 6664000d1cc1SJoe Perches WARN("NR_CPUS", 6665000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 6666773647a0SAndy Whitcroft } 66679c9ba34eSAndy Whitcroft 666852ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 666952ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 667052ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 667152ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 667252ea8506SJoe Perches } 667352ea8506SJoe Perches 6674acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 66755b57980dSJoe Perches if ($perl_version_ok && 6676acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 6677acd9362cSJoe Perches WARN("LIKELY_MISUSE", 6678acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 6679acd9362cSJoe Perches } 6680acd9362cSJoe Perches 6681de3f186fSDenis Efremov# nested likely/unlikely calls 6682de3f186fSDenis Efremov if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) { 6683de3f186fSDenis Efremov WARN("LIKELY_MISUSE", 6684de3f186fSDenis Efremov "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr); 6685de3f186fSDenis Efremov } 6686de3f186fSDenis Efremov 6687691d77b6SAndy Whitcroft# whine mightly about in_atomic 6688691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 6689691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 6690000d1cc1SJoe Perches ERROR("IN_ATOMIC", 6691000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 6692f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 6693000d1cc1SJoe Perches WARN("IN_ATOMIC", 6694000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 6695691d77b6SAndy Whitcroft } 6696691d77b6SAndy Whitcroft } 66971704f47bSPeter Zijlstra 66980f5225b0SPeter Zijlstra# check for mutex_trylock_recursive usage 66990f5225b0SPeter Zijlstra if ($line =~ /mutex_trylock_recursive/) { 67000f5225b0SPeter Zijlstra ERROR("LOCKING", 67010f5225b0SPeter Zijlstra "recursive locking is bad, do not use this ever.\n" . $herecurr); 67020f5225b0SPeter Zijlstra } 67030f5225b0SPeter Zijlstra 67041704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 67051704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 67061704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 67071704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 67081704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 67091704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 6710000d1cc1SJoe Perches ERROR("LOCKDEP", 6711000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 67121704f47bSPeter Zijlstra } 67131704f47bSPeter Zijlstra } 671488f8831cSDave Jones 6715b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 6716b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 6717000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 6718000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 671988f8831cSDave Jones } 67202435880fSJoe Perches 672100180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 672200180468SJoe Perches# and whether or not function naming is typical and if 672300180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 67245b57980dSJoe Perches if ($perl_version_ok && 672500180468SJoe Perches defined $stat && 672600180468SJoe 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*\)/) { 672700180468SJoe Perches my $var = $1; 672800180468SJoe Perches my $perms = $2; 672900180468SJoe Perches my $show = $3; 673000180468SJoe Perches my $store = $4; 673100180468SJoe Perches my $octal_perms = perms_to_octal($perms); 673200180468SJoe Perches if ($show =~ /^${var}_show$/ && 673300180468SJoe Perches $store =~ /^${var}_store$/ && 673400180468SJoe Perches $octal_perms eq "0644") { 673500180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 673600180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 673700180468SJoe Perches $fix) { 673800180468SJoe 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})/; 673900180468SJoe Perches } 674000180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 674100180468SJoe Perches $store =~ /^NULL$/ && 674200180468SJoe Perches $octal_perms eq "0444") { 674300180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 674400180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 674500180468SJoe Perches $fix) { 674600180468SJoe 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})/; 674700180468SJoe Perches } 674800180468SJoe Perches } elsif ($show =~ /^NULL$/ && 674900180468SJoe Perches $store =~ /^${var}_store$/ && 675000180468SJoe Perches $octal_perms eq "0200") { 675100180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 675200180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 675300180468SJoe Perches $fix) { 675400180468SJoe 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})/; 675500180468SJoe Perches } 675600180468SJoe Perches } elsif ($octal_perms eq "0644" || 675700180468SJoe Perches $octal_perms eq "0444" || 675800180468SJoe Perches $octal_perms eq "0200") { 675900180468SJoe Perches my $newshow = "$show"; 676000180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 676100180468SJoe Perches my $newstore = $store; 676200180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 676300180468SJoe Perches my $rename = ""; 676400180468SJoe Perches if ($show ne $newshow) { 676500180468SJoe Perches $rename .= " '$show' to '$newshow'"; 676600180468SJoe Perches } 676700180468SJoe Perches if ($store ne $newstore) { 676800180468SJoe Perches $rename .= " '$store' to '$newstore'"; 676900180468SJoe Perches } 677000180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 677100180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 677200180468SJoe Perches } else { 677300180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 677400180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 677500180468SJoe Perches } 677600180468SJoe Perches } 677700180468SJoe Perches 6778515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 6779515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 678073121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 678173121534SJoe Perches# specific definition of not visible in sysfs. 678273121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 678373121534SJoe Perches# use the default permissions 67845b57980dSJoe Perches if ($perl_version_ok && 6785459cf0aeSJoe Perches defined $stat && 6786515a235eSJoe Perches $line =~ /$mode_perms_search/) { 67872435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 67882435880fSJoe Perches my $func = $entry->[0]; 67892435880fSJoe Perches my $arg_pos = $entry->[1]; 67902435880fSJoe Perches 6791459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 6792459cf0aeSJoe Perches $lc = $lc + $linenr; 67932a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6794459cf0aeSJoe Perches 67952435880fSJoe Perches my $skip_args = ""; 67962435880fSJoe Perches if ($arg_pos > 1) { 67972435880fSJoe Perches $arg_pos--; 67982435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 67992435880fSJoe Perches } 6800f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 6801459cf0aeSJoe Perches if ($stat =~ /$test/) { 68022435880fSJoe Perches my $val = $1; 68032435880fSJoe Perches $val = $6 if ($skip_args ne ""); 680473121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 680573121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 680673121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 68072435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 6808459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 6809f90774e1SJoe Perches } 6810f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6811c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6812459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 68132435880fSJoe Perches } 6814459cf0aeSJoe Perches } 6815459cf0aeSJoe Perches } 6816459cf0aeSJoe Perches } 6817459cf0aeSJoe Perches 6818459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 6819bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 682000180468SJoe Perches my $oval = $1; 682100180468SJoe Perches my $octal = perms_to_octal($oval); 6822f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 6823459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 6824f90774e1SJoe Perches $fix) { 682500180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 68262435880fSJoe Perches } 682713214adfSAndy Whitcroft } 68285a6d20ceSBjorn Andersson 68295a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 68305a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 68315a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 68325a6d20ceSBjorn Andersson my $valid_licenses = qr{ 68335a6d20ceSBjorn Andersson GPL| 68345a6d20ceSBjorn Andersson GPL\ v2| 68355a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 68365a6d20ceSBjorn Andersson Dual\ BSD/GPL| 68375a6d20ceSBjorn Andersson Dual\ MIT/GPL| 68385a6d20ceSBjorn Andersson Dual\ MPL/GPL| 68395a6d20ceSBjorn Andersson Proprietary 68405a6d20ceSBjorn Andersson }x; 68415a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 68425a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 68435a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 68445a6d20ceSBjorn Andersson } 68455a6d20ceSBjorn Andersson } 68466a8d76cbSMatteo Croce 68476a8d76cbSMatteo Croce# check for sysctl duplicate constants 68486a8d76cbSMatteo Croce if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) { 68496a8d76cbSMatteo Croce WARN("DUPLICATED_SYSCTL_CONST", 68506a8d76cbSMatteo Croce "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr); 68516a8d76cbSMatteo Croce } 6852515a235eSJoe Perches } 685313214adfSAndy Whitcroft 685413214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 685513214adfSAndy Whitcroft # so just keep quiet. 685613214adfSAndy Whitcroft if ($#rawlines == -1) { 685713214adfSAndy Whitcroft exit(0); 68580a920b5bSAndy Whitcroft } 68590a920b5bSAndy Whitcroft 68608905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 68618905a67cSAndy Whitcroft # things that appear to be patches. 68628905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 68638905a67cSAndy Whitcroft exit(0); 68648905a67cSAndy Whitcroft } 68658905a67cSAndy Whitcroft 68668905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 68678905a67cSAndy Whitcroft # just keep quiet. 68688905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 68698905a67cSAndy Whitcroft exit(0); 68708905a67cSAndy Whitcroft } 68718905a67cSAndy Whitcroft 6872a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 6873000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6874000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 68750a920b5bSAndy Whitcroft } 6876cd261496SGeert Uytterhoeven if ($is_patch && $has_commit_log && $chk_signoff) { 6877cd261496SGeert Uytterhoeven if ($signoff == 0) { 6878000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6879000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 6880cd261496SGeert Uytterhoeven } elsif (!$authorsignoff) { 6881cd261496SGeert Uytterhoeven WARN("NO_AUTHOR_SIGN_OFF", 6882cd261496SGeert Uytterhoeven "Missing Signed-off-by: line by nominal patch author '$author'\n"); 6883cd261496SGeert Uytterhoeven } 68840a920b5bSAndy Whitcroft } 68850a920b5bSAndy Whitcroft 6886f0a594c1SAndy Whitcroft print report_dump(); 688713214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 688813214adfSAndy Whitcroft print "$filename " if ($summary_file); 68896c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 68906c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 68916c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 68926c72ffaaSAndy Whitcroft } 68938905a67cSAndy Whitcroft 6894d2c0a235SAndy Whitcroft if ($quiet == 0) { 6895ef212196SJoe Perches # If there were any defects found and not already fixing them 6896ef212196SJoe Perches if (!$clean and !$fix) { 6897ef212196SJoe Perches print << "EOM" 6898ef212196SJoe Perches 6899ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 6900ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 6901ef212196SJoe PerchesEOM 6902ef212196SJoe Perches } 6903d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 6904d2c0a235SAndy Whitcroft # then suggest that. 6905d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 6906b0781216SMike Frysinger $rpt_cleaners = 0; 6907d8469f16SJoe Perches print << "EOM" 6908d8469f16SJoe Perches 6909d8469f16SJoe PerchesNOTE: Whitespace errors detected. 6910d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 6911d8469f16SJoe PerchesEOM 6912d2c0a235SAndy Whitcroft } 6913d2c0a235SAndy Whitcroft } 6914d2c0a235SAndy Whitcroft 6915d752fcc8SJoe Perches if ($clean == 0 && $fix && 6916d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 6917d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 69189624b8d6SJoe Perches my $newfile = $filename; 69199624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 69203705ce5bSJoe Perches my $linecount = 0; 69213705ce5bSJoe Perches my $f; 69223705ce5bSJoe Perches 6923d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 6924d752fcc8SJoe Perches 69253705ce5bSJoe Perches open($f, '>', $newfile) 69263705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 69273705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 69283705ce5bSJoe Perches $linecount++; 69293705ce5bSJoe Perches if ($file) { 69303705ce5bSJoe Perches if ($linecount > 3) { 69313705ce5bSJoe Perches $fixed_line =~ s/^\+//; 69323705ce5bSJoe Perches print $f $fixed_line . "\n"; 69333705ce5bSJoe Perches } 69343705ce5bSJoe Perches } else { 69353705ce5bSJoe Perches print $f $fixed_line . "\n"; 69363705ce5bSJoe Perches } 69373705ce5bSJoe Perches } 69383705ce5bSJoe Perches close($f); 69393705ce5bSJoe Perches 69403705ce5bSJoe Perches if (!$quiet) { 69413705ce5bSJoe Perches print << "EOM"; 6942d8469f16SJoe Perches 69433705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 69443705ce5bSJoe Perches 69453705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 69463705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 69473705ce5bSJoe Perches 69483705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 69493705ce5bSJoe PerchesNo warranties, expressed or implied... 69503705ce5bSJoe PerchesEOM 69513705ce5bSJoe Perches } 69523705ce5bSJoe Perches } 69533705ce5bSJoe Perches 6954d8469f16SJoe Perches if ($quiet == 0) { 6955d8469f16SJoe Perches print "\n"; 6956d8469f16SJoe Perches if ($clean == 1) { 6957d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 6958d8469f16SJoe Perches } else { 6959d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 69600a920b5bSAndy Whitcroft } 69610a920b5bSAndy Whitcroft } 69620a920b5bSAndy Whitcroft return $clean; 69630a920b5bSAndy Whitcroft} 6964