1cb77f0d6SKamil Rytarowski#!/usr/bin/env perl 2882ea1d6SJoe Perches# SPDX-License-Identifier: GPL-2.0 3882ea1d6SJoe Perches# 4dbf004d7SDave Jones# (c) 2001, Dave Jones. (the file handling bit) 500df344fSAndy Whitcroft# (c) 2005, Joel Schopp <[email protected]> (the ugly bit) 62a5a2c25SAndy Whitcroft# (c) 2007,2008, Andy Whitcroft <[email protected]> (new conditions, test suite) 7015830beSAndy Whitcroft# (c) 2008-2010 Andy Whitcroft <[email protected]> 8882ea1d6SJoe Perches# (c) 2010-2018 Joe Perches <[email protected]> 90a920b5bSAndy Whitcroft 100a920b5bSAndy Whitcroftuse strict; 11cb77f0d6SKamil Rytarowskiuse warnings; 12c707a81dSJoe Perchesuse POSIX; 1336061e38SJoe Perchesuse File::Basename; 1436061e38SJoe Perchesuse Cwd 'abs_path'; 1557230297SJoe Perchesuse Term::ANSIColor qw(:constants); 16cd261496SGeert Uytterhoevenuse Encode qw(decode encode); 170a920b5bSAndy Whitcroft 180a920b5bSAndy Whitcroftmy $P = $0; 1936061e38SJoe Perchesmy $D = dirname(abs_path($P)); 200a920b5bSAndy Whitcroft 21000d1cc1SJoe Perchesmy $V = '0.32'; 220a920b5bSAndy Whitcroft 230a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 240a920b5bSAndy Whitcroft 250a920b5bSAndy Whitcroftmy $quiet = 0; 260a920b5bSAndy Whitcroftmy $tree = 1; 270a920b5bSAndy Whitcroftmy $chk_signoff = 1; 280a920b5bSAndy Whitcroftmy $chk_patch = 1; 29773647a0SAndy Whitcroftmy $tst_only; 306c72ffaaSAndy Whitcroftmy $emacs = 0; 318905a67cSAndy Whitcroftmy $terse = 0; 3234d8815fSJoe Perchesmy $showfile = 0; 336c72ffaaSAndy Whitcroftmy $file = 0; 344a593c34SDu, Changbinmy $git = 0; 350dea9f1eSJoe Perchesmy %git_commits = (); 366c72ffaaSAndy Whitcroftmy $check = 0; 372ac73b4fSJoe Perchesmy $check_orig = 0; 388905a67cSAndy Whitcroftmy $summary = 1; 398905a67cSAndy Whitcroftmy $mailback = 0; 4013214adfSAndy Whitcroftmy $summary_file = 0; 41000d1cc1SJoe Perchesmy $show_types = 0; 423beb42ecSJoe Perchesmy $list_types = 0; 433705ce5bSJoe Perchesmy $fix = 0; 449624b8d6SJoe Perchesmy $fix_inplace = 0; 456c72ffaaSAndy Whitcroftmy $root; 46c2fdda0dSAndy Whitcroftmy %debug; 473445686aSJoe Perchesmy %camelcase = (); 4891bfe484SJoe Perchesmy %use_type = (); 4991bfe484SJoe Perchesmy @use = (); 5091bfe484SJoe Perchesmy %ignore_type = (); 51000d1cc1SJoe Perchesmy @ignore = (); 5277f5b10aSHannes Edermy $help = 0; 53000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 54bdc48fa1SJoe Perchesmy $max_line_length = 100; 55d62a201fSDave Hansenmy $ignore_perl_version = 0; 56d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 5756193274SVadim Bendeburymy $min_conf_desc_length = 4; 5866b47b4aSKees Cookmy $spelling_file = "$D/spelling.txt"; 59ebfd7d62SJoe Perchesmy $codespell = 0; 60f1a63678SMaxim Uvarovmy $codespellfile = "/usr/share/codespell/dictionary.txt"; 61bf1fa1daSJoe Perchesmy $conststructsfile = "$D/const_structs.checkpatch"; 6275ad8c57SJerome Forissiermy $typedefsfile = ""; 63737c0767SJohn Brooksmy $color = "auto"; 6498005e8cSVadim Bendeburymy $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE 65dbbf869dSJoe Perches# git output parsing needs US English output, so first set backtick child process LANGUAGE 66dbbf869dSJoe Perchesmy $git_command ='export LANGUAGE=en_US.UTF-8; git'; 67713a09deSAntonio Borneomy $tabsize = 8; 6877f5b10aSHannes Eder 6977f5b10aSHannes Edersub help { 7077f5b10aSHannes Eder my ($exitcode) = @_; 7177f5b10aSHannes Eder 7277f5b10aSHannes Eder print << "EOM"; 7377f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 7477f5b10aSHannes EderVersion: $V 7577f5b10aSHannes Eder 7677f5b10aSHannes EderOptions: 7777f5b10aSHannes Eder -q, --quiet quiet 7877f5b10aSHannes Eder --no-tree run without a kernel tree 7977f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 8077f5b10aSHannes Eder --patch treat FILE as patchfile (default) 8177f5b10aSHannes Eder --emacs emacs compile window format 8277f5b10aSHannes Eder --terse one line per report 8334d8815fSJoe Perches --showfile emit diffed file position, not input file position 844a593c34SDu, Changbin -g, --git treat FILE as a single commit or git revision range 854a593c34SDu, Changbin single git commit with: 864a593c34SDu, Changbin <rev> 874a593c34SDu, Changbin <rev>^ 884a593c34SDu, Changbin <rev>~n 894a593c34SDu, Changbin multiple git commits with: 904a593c34SDu, Changbin <rev1>..<rev2> 914a593c34SDu, Changbin <rev1>...<rev2> 924a593c34SDu, Changbin <rev>-<count> 934a593c34SDu, Changbin git merges are ignored 9477f5b10aSHannes Eder -f, --file treat FILE as regular source file 9577f5b10aSHannes Eder --subjective, --strict enable more subjective tests 963beb42ecSJoe Perches --list-types list the possible message types 9791bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 98000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 993beb42ecSJoe Perches --show-types show the specific message type in the output 100bdc48fa1SJoe Perches --max-line-length=n set the maximum line length, (default $max_line_length) 101bdc48fa1SJoe Perches if exceeded, warn on patches 102bdc48fa1SJoe Perches requires --strict for use with --file 10356193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 104bdc48fa1SJoe Perches --tab-size=n set the number of spaces for tab (default $tabsize) 10577f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 10677f5b10aSHannes Eder --no-summary suppress the per-file summary 10777f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 10877f5b10aSHannes Eder --summary-file include the filename in summary 10977f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 11077f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 11177f5b10aSHannes Eder is all off) 11277f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 11377f5b10aSHannes Eder literally 1143705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 1153705ce5bSJoe Perches If correctable single-line errors exist, create 1163705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 1173705ce5bSJoe Perches with potential errors corrected to the preferred 1183705ce5bSJoe Perches checkpatch style 1199624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 1209624b8d6SJoe Perches Is the same as --fix, but overwrites the input 1219624b8d6SJoe Perches file. It's your fault if there's no backup or git 122d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 123d62a201fSDave Hansen runtime errors. 124ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 125f1a63678SMaxim Uvarov (default:/usr/share/codespell/dictionary.txt) 126ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 12775ad8c57SJerome Forissier --typedefsfile Read additional types from this file 128737c0767SJohn Brooks --color[=WHEN] Use colors 'always', 'never', or only when output 129737c0767SJohn Brooks is a terminal ('auto'). Default is 'auto'. 13077f5b10aSHannes Eder -h, --help, --version display this help and exit 13177f5b10aSHannes Eder 13277f5b10aSHannes EderWhen FILE is - read standard input. 13377f5b10aSHannes EderEOM 13477f5b10aSHannes Eder 13577f5b10aSHannes Eder exit($exitcode); 13677f5b10aSHannes Eder} 13777f5b10aSHannes Eder 1383beb42ecSJoe Perchessub uniq { 1393beb42ecSJoe Perches my %seen; 1403beb42ecSJoe Perches return grep { !$seen{$_}++ } @_; 1413beb42ecSJoe Perches} 1423beb42ecSJoe Perches 1433beb42ecSJoe Perchessub list_types { 1443beb42ecSJoe Perches my ($exitcode) = @_; 1453beb42ecSJoe Perches 1463beb42ecSJoe Perches my $count = 0; 1473beb42ecSJoe Perches 1483beb42ecSJoe Perches local $/ = undef; 1493beb42ecSJoe Perches 1503beb42ecSJoe Perches open(my $script, '<', abs_path($P)) or 1513beb42ecSJoe Perches die "$P: Can't read '$P' $!\n"; 1523beb42ecSJoe Perches 1533beb42ecSJoe Perches my $text = <$script>; 1543beb42ecSJoe Perches close($script); 1553beb42ecSJoe Perches 1563beb42ecSJoe Perches my @types = (); 1570547fa58SJean Delvare # Also catch when type or level is passed through a variable 1580547fa58SJean Delvare for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) { 1593beb42ecSJoe Perches push (@types, $_); 1603beb42ecSJoe Perches } 1613beb42ecSJoe Perches @types = sort(uniq(@types)); 1623beb42ecSJoe Perches print("#\tMessage type\n\n"); 1633beb42ecSJoe Perches foreach my $type (@types) { 1643beb42ecSJoe Perches print(++$count . "\t" . $type . "\n"); 1653beb42ecSJoe Perches } 1663beb42ecSJoe Perches 1673beb42ecSJoe Perches exit($exitcode); 1683beb42ecSJoe Perches} 1693beb42ecSJoe Perches 170000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 171000d1cc1SJoe Perchesif (-f $conf) { 172000d1cc1SJoe Perches my @conf_args; 173000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 174000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 175000d1cc1SJoe Perches 176000d1cc1SJoe Perches while (<$conffile>) { 177000d1cc1SJoe Perches my $line = $_; 178000d1cc1SJoe Perches 179000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 180000d1cc1SJoe Perches $line =~ s/^\s*//g; 181000d1cc1SJoe Perches $line =~ s/\s+/ /g; 182000d1cc1SJoe Perches 183000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 184000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 185000d1cc1SJoe Perches 186000d1cc1SJoe Perches my @words = split(" ", $line); 187000d1cc1SJoe Perches foreach my $word (@words) { 188000d1cc1SJoe Perches last if ($word =~ m/^#/); 189000d1cc1SJoe Perches push (@conf_args, $word); 190000d1cc1SJoe Perches } 191000d1cc1SJoe Perches } 192000d1cc1SJoe Perches close($conffile); 193000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 194000d1cc1SJoe Perches} 195000d1cc1SJoe Perches 196737c0767SJohn Brooks# Perl's Getopt::Long allows options to take optional arguments after a space. 197737c0767SJohn Brooks# Prevent --color by itself from consuming other arguments 198737c0767SJohn Brooksforeach (@ARGV) { 199737c0767SJohn Brooks if ($_ eq "--color" || $_ eq "-color") { 200737c0767SJohn Brooks $_ = "--color=$color"; 201737c0767SJohn Brooks } 202737c0767SJohn Brooks} 203737c0767SJohn Brooks 2040a920b5bSAndy WhitcroftGetOptions( 2056c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 2060a920b5bSAndy Whitcroft 'tree!' => \$tree, 2070a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 2080a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 2096c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 2108905a67cSAndy Whitcroft 'terse!' => \$terse, 21134d8815fSJoe Perches 'showfile!' => \$showfile, 21277f5b10aSHannes Eder 'f|file!' => \$file, 2134a593c34SDu, Changbin 'g|git!' => \$git, 2146c72ffaaSAndy Whitcroft 'subjective!' => \$check, 2156c72ffaaSAndy Whitcroft 'strict!' => \$check, 216000d1cc1SJoe Perches 'ignore=s' => \@ignore, 21791bfe484SJoe Perches 'types=s' => \@use, 218000d1cc1SJoe Perches 'show-types!' => \$show_types, 2193beb42ecSJoe Perches 'list-types!' => \$list_types, 2206cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 22156193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 222713a09deSAntonio Borneo 'tab-size=i' => \$tabsize, 2236c72ffaaSAndy Whitcroft 'root=s' => \$root, 2248905a67cSAndy Whitcroft 'summary!' => \$summary, 2258905a67cSAndy Whitcroft 'mailback!' => \$mailback, 22613214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 2273705ce5bSJoe Perches 'fix!' => \$fix, 2289624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 229d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 230c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 231773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 232ebfd7d62SJoe Perches 'codespell!' => \$codespell, 233ebfd7d62SJoe Perches 'codespellfile=s' => \$codespellfile, 23475ad8c57SJerome Forissier 'typedefsfile=s' => \$typedefsfile, 235737c0767SJohn Brooks 'color=s' => \$color, 236737c0767SJohn Brooks 'no-color' => \$color, #keep old behaviors of -nocolor 237737c0767SJohn Brooks 'nocolor' => \$color, #keep old behaviors of -nocolor 23877f5b10aSHannes Eder 'h|help' => \$help, 23977f5b10aSHannes Eder 'version' => \$help 24077f5b10aSHannes Eder) or help(1); 24177f5b10aSHannes Eder 24277f5b10aSHannes Ederhelp(0) if ($help); 2430a920b5bSAndy Whitcroft 2443beb42ecSJoe Percheslist_types(0) if ($list_types); 2453beb42ecSJoe Perches 2469624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 2472ac73b4fSJoe Perches$check_orig = $check; 2489624b8d6SJoe Perches 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 75975ad8c57SJerome Forissier $$wordsRef .= '|' if ($$wordsRef ne ""); 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 76975ad8c57SJerome Forissiermy $const_structs = ""; 77075ad8c57SJerome Forissierread_words(\$const_structs, $conststructsfile) 77175ad8c57SJerome Forissier or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 77275ad8c57SJerome Forissier 77375ad8c57SJerome Forissiermy $typeOtherTypedefs = ""; 77475ad8c57SJerome Forissierif (length($typedefsfile)) { 77575ad8c57SJerome Forissier read_words(\$typeOtherTypedefs, $typedefsfile) 77675ad8c57SJerome Forissier or warn "No additional types will be considered - file '$typedefsfile': $!\n"; 77775ad8c57SJerome Forissier} 77875ad8c57SJerome Forissier$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne ""); 77975ad8c57SJerome Forissier 7808905a67cSAndy Whitcroftsub build_types { 781485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 782485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 7831813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 7848716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 785c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 786ab7e23f3SJoe Perches $BasicType = qr{ 787ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 788ab7e23f3SJoe Perches (?:${all}\b) 789ab7e23f3SJoe Perches }x; 7908905a67cSAndy Whitcroft $NonptrType = qr{ 791d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 792cf655043SAndy Whitcroft (?: 7936b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 7948ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 795c45dcabdSAndy Whitcroft (?:${all}\b) 796cf655043SAndy Whitcroft ) 797c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 7988905a67cSAndy Whitcroft }x; 7991813087dSJoe Perches $NonptrTypeMisordered = qr{ 8001813087dSJoe Perches (?:$Modifier\s+|const\s+)* 8011813087dSJoe Perches (?: 8021813087dSJoe Perches (?:${Misordered}\b) 8031813087dSJoe Perches ) 8041813087dSJoe Perches (?:\s+$Modifier|\s+const)* 8051813087dSJoe Perches }x; 8068716de38SJoe Perches $NonptrTypeWithAttr = qr{ 8078716de38SJoe Perches (?:$Modifier\s+|const\s+)* 8088716de38SJoe Perches (?: 8098716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 8108716de38SJoe Perches (?:$typeTypedefs\b)| 8118716de38SJoe Perches (?:${allWithAttr}\b) 8128716de38SJoe Perches ) 8138716de38SJoe Perches (?:\s+$Modifier|\s+const)* 8148716de38SJoe Perches }x; 8158905a67cSAndy Whitcroft $Type = qr{ 816c45dcabdSAndy Whitcroft $NonptrType 8177b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 818c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 8198905a67cSAndy Whitcroft }x; 8201813087dSJoe Perches $TypeMisordered = qr{ 8211813087dSJoe Perches $NonptrTypeMisordered 8227b18496cSAntonio Borneo (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 8231813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 8241813087dSJoe Perches }x; 82591cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 8261813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 8278905a67cSAndy Whitcroft} 8288905a67cSAndy Whitcroftbuild_types(); 8296c72ffaaSAndy Whitcroft 8307d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 831d1fe9c09SJoe Perches 832d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 833d1fe9c09SJoe Perches# requires at least perl version v5.10.0 834d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 835d1fe9c09SJoe Perches 836d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 8372435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 838c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 8397d2367afSJoe Perches 840f8422308SJoe Perchesour $declaration_macros = qr{(?x: 8413e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 842fe658f94SSteffen Maier (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(| 8433d102fc0SGilad Ben-Yossef (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(| 8443d102fc0SGilad Ben-Yossef (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\( 845f8422308SJoe Perches)}; 846f8422308SJoe Perches 8477d2367afSJoe Perchessub deparenthesize { 8487d2367afSJoe Perches my ($string) = @_; 8497d2367afSJoe Perches return "" if (!defined($string)); 8505b9553abSJoe Perches 8515b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 8525b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 8535b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 8545b9553abSJoe Perches } 8555b9553abSJoe Perches 8567d2367afSJoe Perches $string =~ s@\s+@ @g; 8575b9553abSJoe Perches 8587d2367afSJoe Perches return $string; 8597d2367afSJoe Perches} 8607d2367afSJoe Perches 8613445686aSJoe Perchessub seed_camelcase_file { 8623445686aSJoe Perches my ($file) = @_; 8633445686aSJoe Perches 8643445686aSJoe Perches return if (!(-f $file)); 8653445686aSJoe Perches 8663445686aSJoe Perches local $/; 8673445686aSJoe Perches 8683445686aSJoe Perches open(my $include_file, '<', "$file") 8693445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 8703445686aSJoe Perches my $text = <$include_file>; 8713445686aSJoe Perches close($include_file); 8723445686aSJoe Perches 8733445686aSJoe Perches my @lines = split('\n', $text); 8743445686aSJoe Perches 8753445686aSJoe Perches foreach my $line (@lines) { 8763445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 8773445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 8783445686aSJoe Perches $camelcase{$1} = 1; 87911ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 88011ea516aSJoe Perches $camelcase{$1} = 1; 88111ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 8823445686aSJoe Perches $camelcase{$1} = 1; 8833445686aSJoe Perches } 8843445686aSJoe Perches } 8853445686aSJoe Perches} 8863445686aSJoe Perches 887cd28b119SJoe Perchesour %maintained_status = (); 888cd28b119SJoe Perches 88985b0ee18SJoe Perchessub is_maintained_obsolete { 89085b0ee18SJoe Perches my ($filename) = @_; 89185b0ee18SJoe Perches 892f2c19c2fSJerome Forissier return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 89385b0ee18SJoe Perches 894cd28b119SJoe Perches if (!exists($maintained_status{$filename})) { 895cd28b119SJoe Perches $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 896cd28b119SJoe Perches } 89785b0ee18SJoe Perches 898cd28b119SJoe Perches return $maintained_status{$filename} =~ /obsolete/i; 89985b0ee18SJoe Perches} 90085b0ee18SJoe Perches 9013b6e8ac9SJoe Perchessub is_SPDX_License_valid { 9023b6e8ac9SJoe Perches my ($license) = @_; 9033b6e8ac9SJoe Perches 90456294112SJoe Perches return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git")); 9053b6e8ac9SJoe Perches 90656294112SJoe Perches my $root_path = abs_path($root); 90756294112SJoe Perches my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`; 9083b6e8ac9SJoe Perches return 0 if ($status ne ""); 9093b6e8ac9SJoe Perches return 1; 9103b6e8ac9SJoe Perches} 9113b6e8ac9SJoe Perches 9123445686aSJoe Perchesmy $camelcase_seeded = 0; 9133445686aSJoe Perchessub seed_camelcase_includes { 9143445686aSJoe Perches return if ($camelcase_seeded); 9153445686aSJoe Perches 9163445686aSJoe Perches my $files; 917c707a81dSJoe Perches my $camelcase_cache = ""; 918c707a81dSJoe Perches my @include_files = (); 919c707a81dSJoe Perches 920c707a81dSJoe Perches $camelcase_seeded = 1; 921351b2a1fSJoe Perches 9223645e328SRichard Genoud if (-e ".git") { 923dbbf869dSJoe Perches my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`; 924351b2a1fSJoe Perches chomp $git_last_include_commit; 925c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 926c707a81dSJoe Perches } else { 927c707a81dSJoe Perches my $last_mod_date = 0; 928c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 929c707a81dSJoe Perches @include_files = split('\n', $files); 930c707a81dSJoe Perches foreach my $file (@include_files) { 931c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 932c707a81dSJoe Perches localtime((stat $file)[9])); 933c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 934c707a81dSJoe Perches } 935c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 936c707a81dSJoe Perches } 937c707a81dSJoe Perches 938c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 939c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 940c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 941351b2a1fSJoe Perches while (<$camelcase_file>) { 942351b2a1fSJoe Perches chomp; 943351b2a1fSJoe Perches $camelcase{$_} = 1; 944351b2a1fSJoe Perches } 945351b2a1fSJoe Perches close($camelcase_file); 946351b2a1fSJoe Perches 947351b2a1fSJoe Perches return; 948351b2a1fSJoe Perches } 949c707a81dSJoe Perches 9503645e328SRichard Genoud if (-e ".git") { 951dbbf869dSJoe Perches $files = `${git_command} ls-files "include/*.h"`; 952c707a81dSJoe Perches @include_files = split('\n', $files); 9533445686aSJoe Perches } 954c707a81dSJoe Perches 9553445686aSJoe Perches foreach my $file (@include_files) { 9563445686aSJoe Perches seed_camelcase_file($file); 9573445686aSJoe Perches } 958351b2a1fSJoe Perches 959c707a81dSJoe Perches if ($camelcase_cache ne "") { 960351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 961c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 962c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 963351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 964351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 965351b2a1fSJoe Perches } 966351b2a1fSJoe Perches close($camelcase_file); 967351b2a1fSJoe Perches } 9683445686aSJoe Perches} 9693445686aSJoe Perches 970d311cd44SJoe Perchessub git_commit_info { 971d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 972d311cd44SJoe Perches 973d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 974d311cd44SJoe Perches 975dbbf869dSJoe Perches my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`; 976d311cd44SJoe Perches $output =~ s/^\s*//gm; 977d311cd44SJoe Perches my @lines = split("\n", $output); 978d311cd44SJoe Perches 9790d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 9800d7835fcSJoe Perches 9815a7f4455SSean Christopherson if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) { 982d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 983d311cd44SJoe Perches# all matching commit ids, but it's very slow... 984d311cd44SJoe Perches# 985d311cd44SJoe Perches# echo "checking commits $1..." 986d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 987d311cd44SJoe Perches# while read line ; do 988d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 989d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 990d311cd44SJoe Perches# done 991d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 992948b133aSHeinrich Schuchardt $id = undef; 993d311cd44SJoe Perches } else { 994d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 995d311cd44SJoe Perches $desc = substr($lines[0], 41); 996d311cd44SJoe Perches } 997d311cd44SJoe Perches 998d311cd44SJoe Perches return ($id, $desc); 999d311cd44SJoe Perches} 1000d311cd44SJoe Perches 10016c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 10020a920b5bSAndy Whitcroft 100300df344fSAndy Whitcroftmy @rawlines = (); 1004c2fdda0dSAndy Whitcroftmy @lines = (); 10053705ce5bSJoe Perchesmy @fixed = (); 1006d752fcc8SJoe Perchesmy @fixed_inserted = (); 1007d752fcc8SJoe Perchesmy @fixed_deleted = (); 1008194f66fcSJoe Perchesmy $fixlinenr = -1; 1009194f66fcSJoe Perches 10104a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 10114a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 10124a593c34SDu, Changbindie "$P: No git repository found\n" if ($git && !-e ".git"); 10134a593c34SDu, Changbin 10144a593c34SDu, Changbinif ($git) { 10154a593c34SDu, Changbin my @commits = (); 10160dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 10174a593c34SDu, Changbin my $git_range; 101828898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 101928898fd1SJoe Perches $git_range = "-$2 $1"; 10204a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 10214a593c34SDu, Changbin $git_range = "$commit_expr"; 10224a593c34SDu, Changbin } else { 10230dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 10240dea9f1eSJoe Perches } 1025dbbf869dSJoe Perches my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 10260dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 102728898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 102828898fd1SJoe Perches next if (!defined($1) || !defined($2)); 10290dea9f1eSJoe Perches my $sha1 = $1; 10300dea9f1eSJoe Perches my $subject = $2; 10310dea9f1eSJoe Perches unshift(@commits, $sha1); 10320dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 10334a593c34SDu, Changbin } 10344a593c34SDu, Changbin } 10354a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 10364a593c34SDu, Changbin @ARGV = @commits; 10374a593c34SDu, Changbin} 10384a593c34SDu, Changbin 1039c2fdda0dSAndy Whitcroftmy $vname; 104098005e8cSVadim Bendebury$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"}; 10416c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 104221caa13cSAndy Whitcroft my $FILE; 10434a593c34SDu, Changbin if ($git) { 10444a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 10454a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 10464a593c34SDu, Changbin } elsif ($file) { 104721caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 10486c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 104921caa13cSAndy Whitcroft } elsif ($filename eq '-') { 105021caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 10516c72ffaaSAndy Whitcroft } else { 105221caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 10536c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 10546c72ffaaSAndy Whitcroft } 1055c2fdda0dSAndy Whitcroft if ($filename eq '-') { 1056c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 10574a593c34SDu, Changbin } elsif ($git) { 10580dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 1059c2fdda0dSAndy Whitcroft } else { 1060c2fdda0dSAndy Whitcroft $vname = $filename; 1061c2fdda0dSAndy Whitcroft } 106221caa13cSAndy Whitcroft while (<$FILE>) { 10630a920b5bSAndy Whitcroft chomp; 106400df344fSAndy Whitcroft push(@rawlines, $_); 1065c7f574d0SGeert Uytterhoeven $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i); 10666c72ffaaSAndy Whitcroft } 106721caa13cSAndy Whitcroft close($FILE); 1068d8469f16SJoe Perches 1069d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 1070d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1071d8469f16SJoe Perches print "$vname\n"; 1072d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1073d8469f16SJoe Perches } 1074d8469f16SJoe Perches 1075c2fdda0dSAndy Whitcroft if (!process($filename)) { 10760a920b5bSAndy Whitcroft $exit = 1; 10770a920b5bSAndy Whitcroft } 107800df344fSAndy Whitcroft @rawlines = (); 107913214adfSAndy Whitcroft @lines = (); 10803705ce5bSJoe Perches @fixed = (); 1081d752fcc8SJoe Perches @fixed_inserted = (); 1082d752fcc8SJoe Perches @fixed_deleted = (); 1083194f66fcSJoe Perches $fixlinenr = -1; 1084485ff23eSAlex Dowad @modifierListFile = (); 1085485ff23eSAlex Dowad @typeListFile = (); 1086485ff23eSAlex Dowad build_types(); 10870a920b5bSAndy Whitcroft} 10880a920b5bSAndy Whitcroft 1089d8469f16SJoe Perchesif (!$quiet) { 10903c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 10913c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 10923c816e49SJoe Perches 10935b57980dSJoe Perches if (!$perl_version_ok) { 1094d8469f16SJoe Perches print << "EOM" 1095d8469f16SJoe Perches 1096d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 10975b57980dSJoe Perches An upgrade to at least perl $minimum_perl_version is suggested. 1098d8469f16SJoe PerchesEOM 1099d8469f16SJoe Perches } 1100d8469f16SJoe Perches if ($exit) { 1101d8469f16SJoe Perches print << "EOM" 1102d8469f16SJoe Perches 1103d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 1104d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 1105d8469f16SJoe PerchesEOM 1106d8469f16SJoe Perches } 1107d8469f16SJoe Perches} 1108d8469f16SJoe Perches 11090a920b5bSAndy Whitcroftexit($exit); 11100a920b5bSAndy Whitcroft 11110a920b5bSAndy Whitcroftsub top_of_kernel_tree { 11126c72ffaaSAndy Whitcroft my ($root) = @_; 11136c72ffaaSAndy Whitcroft 11146c72ffaaSAndy Whitcroft my @tree_check = ( 11156c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 11166c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 11176c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 11186c72ffaaSAndy Whitcroft ); 11196c72ffaaSAndy Whitcroft 11206c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 11216c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 11220a920b5bSAndy Whitcroft return 0; 11230a920b5bSAndy Whitcroft } 11246c72ffaaSAndy Whitcroft } 11256c72ffaaSAndy Whitcroft return 1; 11266c72ffaaSAndy Whitcroft} 11270a920b5bSAndy Whitcroft 112820112475SJoe Perchessub parse_email { 112920112475SJoe Perches my ($formatted_email) = @_; 113020112475SJoe Perches 113120112475SJoe Perches my $name = ""; 1132dfa05c28SJoe Perches my $name_comment = ""; 113320112475SJoe Perches my $address = ""; 113420112475SJoe Perches my $comment = ""; 113520112475SJoe Perches 113620112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 113720112475SJoe Perches $name = $1; 113820112475SJoe Perches $address = $2; 113920112475SJoe Perches $comment = $3 if defined $3; 114020112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 114120112475SJoe Perches $address = $1; 114220112475SJoe Perches $comment = $2 if defined $2; 114320112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 114420112475SJoe Perches $address = $1; 114520112475SJoe Perches $comment = $2 if defined $2; 114685e12066SJoe Perches $formatted_email =~ s/\Q$address\E.*$//; 114720112475SJoe Perches $name = $formatted_email; 11483705ce5bSJoe Perches $name = trim($name); 114920112475SJoe Perches $name =~ s/^\"|\"$//g; 115020112475SJoe Perches # If there's a name left after stripping spaces and 115120112475SJoe Perches # leading quotes, and the address doesn't have both 115220112475SJoe Perches # leading and trailing angle brackets, the address 115320112475SJoe Perches # is invalid. ie: 115420112475SJoe Perches # "joe smith [email protected]" bad 115520112475SJoe Perches # "joe smith <[email protected]" bad 115620112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 115720112475SJoe Perches $name = ""; 115820112475SJoe Perches $address = ""; 115920112475SJoe Perches $comment = ""; 116020112475SJoe Perches } 116120112475SJoe Perches } 116220112475SJoe Perches 11633705ce5bSJoe Perches $name = trim($name); 116420112475SJoe Perches $name =~ s/^\"|\"$//g; 1165dfa05c28SJoe Perches $name =~ s/(\s*\([^\)]+\))\s*//; 1166dfa05c28SJoe Perches if (defined($1)) { 1167dfa05c28SJoe Perches $name_comment = trim($1); 1168dfa05c28SJoe Perches } 11693705ce5bSJoe Perches $address = trim($address); 117020112475SJoe Perches $address =~ s/^\<|\>$//g; 117120112475SJoe Perches 117220112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 117320112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 117420112475SJoe Perches $name = "\"$name\""; 117520112475SJoe Perches } 117620112475SJoe Perches 1177dfa05c28SJoe Perches return ($name, $name_comment, $address, $comment); 117820112475SJoe Perches} 117920112475SJoe Perches 118020112475SJoe Perchessub format_email { 118120112475SJoe Perches my ($name, $address) = @_; 118220112475SJoe Perches 118320112475SJoe Perches my $formatted_email; 118420112475SJoe Perches 11853705ce5bSJoe Perches $name = trim($name); 118620112475SJoe Perches $name =~ s/^\"|\"$//g; 11873705ce5bSJoe Perches $address = trim($address); 118820112475SJoe Perches 118920112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 119020112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 119120112475SJoe Perches $name = "\"$name\""; 119220112475SJoe Perches } 119320112475SJoe Perches 119420112475SJoe Perches if ("$name" eq "") { 119520112475SJoe Perches $formatted_email = "$address"; 119620112475SJoe Perches } else { 119720112475SJoe Perches $formatted_email = "$name <$address>"; 119820112475SJoe Perches } 119920112475SJoe Perches 120020112475SJoe Perches return $formatted_email; 120120112475SJoe Perches} 120220112475SJoe Perches 1203dfa05c28SJoe Perchessub reformat_email { 1204dfa05c28SJoe Perches my ($email) = @_; 1205dfa05c28SJoe Perches 1206dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 1207dfa05c28SJoe Perches return format_email($email_name, $email_address); 1208dfa05c28SJoe Perches} 1209dfa05c28SJoe Perches 1210dfa05c28SJoe Perchessub same_email_addresses { 1211dfa05c28SJoe Perches my ($email1, $email2) = @_; 1212dfa05c28SJoe Perches 1213dfa05c28SJoe Perches my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1); 1214dfa05c28SJoe Perches my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2); 1215dfa05c28SJoe Perches 1216dfa05c28SJoe Perches return $email1_name eq $email2_name && 1217dfa05c28SJoe Perches $email1_address eq $email2_address; 1218dfa05c28SJoe Perches} 1219dfa05c28SJoe Perches 1220d311cd44SJoe Perchessub which { 1221d311cd44SJoe Perches my ($bin) = @_; 1222d311cd44SJoe Perches 1223d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1224d311cd44SJoe Perches if (-e "$path/$bin") { 1225d311cd44SJoe Perches return "$path/$bin"; 1226d311cd44SJoe Perches } 1227d311cd44SJoe Perches } 1228d311cd44SJoe Perches 1229d311cd44SJoe Perches return ""; 1230d311cd44SJoe Perches} 1231d311cd44SJoe Perches 1232000d1cc1SJoe Perchessub which_conf { 1233000d1cc1SJoe Perches my ($conf) = @_; 1234000d1cc1SJoe Perches 1235000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1236000d1cc1SJoe Perches if (-e "$path/$conf") { 1237000d1cc1SJoe Perches return "$path/$conf"; 1238000d1cc1SJoe Perches } 1239000d1cc1SJoe Perches } 1240000d1cc1SJoe Perches 1241000d1cc1SJoe Perches return ""; 1242000d1cc1SJoe Perches} 1243000d1cc1SJoe Perches 12440a920b5bSAndy Whitcroftsub expand_tabs { 12450a920b5bSAndy Whitcroft my ($str) = @_; 12460a920b5bSAndy Whitcroft 12470a920b5bSAndy Whitcroft my $res = ''; 12480a920b5bSAndy Whitcroft my $n = 0; 12490a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 12500a920b5bSAndy Whitcroft if ($c eq "\t") { 12510a920b5bSAndy Whitcroft $res .= ' '; 12520a920b5bSAndy Whitcroft $n++; 1253713a09deSAntonio Borneo for (; ($n % $tabsize) != 0; $n++) { 12540a920b5bSAndy Whitcroft $res .= ' '; 12550a920b5bSAndy Whitcroft } 12560a920b5bSAndy Whitcroft next; 12570a920b5bSAndy Whitcroft } 12580a920b5bSAndy Whitcroft $res .= $c; 12590a920b5bSAndy Whitcroft $n++; 12600a920b5bSAndy Whitcroft } 12610a920b5bSAndy Whitcroft 12620a920b5bSAndy Whitcroft return $res; 12630a920b5bSAndy Whitcroft} 12646c72ffaaSAndy Whitcroftsub copy_spacing { 1265773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 12666c72ffaaSAndy Whitcroft return $res; 12676c72ffaaSAndy Whitcroft} 12680a920b5bSAndy Whitcroft 12694a0df2efSAndy Whitcroftsub line_stats { 12704a0df2efSAndy Whitcroft my ($line) = @_; 12714a0df2efSAndy Whitcroft 12724a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 12734a0df2efSAndy Whitcroft $line =~ s/^.//; 12744a0df2efSAndy Whitcroft $line = expand_tabs($line); 12754a0df2efSAndy Whitcroft 12764a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 12774a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 12784a0df2efSAndy Whitcroft 12794a0df2efSAndy Whitcroft return (length($line), length($white)); 12804a0df2efSAndy Whitcroft} 12814a0df2efSAndy Whitcroft 1282773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1283773647a0SAndy Whitcroft 1284773647a0SAndy Whitcroftsub sanitise_line_reset { 1285773647a0SAndy Whitcroft my ($in_comment) = @_; 1286773647a0SAndy Whitcroft 1287773647a0SAndy Whitcroft if ($in_comment) { 1288773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1289773647a0SAndy Whitcroft } else { 1290773647a0SAndy Whitcroft $sanitise_quote = ''; 1291773647a0SAndy Whitcroft } 1292773647a0SAndy Whitcroft} 129300df344fSAndy Whitcroftsub sanitise_line { 129400df344fSAndy Whitcroft my ($line) = @_; 129500df344fSAndy Whitcroft 129600df344fSAndy Whitcroft my $res = ''; 129700df344fSAndy Whitcroft my $l = ''; 129800df344fSAndy Whitcroft 1299c2fdda0dSAndy Whitcroft my $qlen = 0; 1300773647a0SAndy Whitcroft my $off = 0; 1301773647a0SAndy Whitcroft my $c; 130200df344fSAndy Whitcroft 1303773647a0SAndy Whitcroft # Always copy over the diff marker. 1304773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1305773647a0SAndy Whitcroft 1306773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1307773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1308773647a0SAndy Whitcroft 13098d2e11b2SClaudio Fontana # Comments we are whacking completely including the begin 1310773647a0SAndy Whitcroft # and end, all to $;. 1311773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1312773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1313773647a0SAndy Whitcroft 1314773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1315773647a0SAndy Whitcroft $off++; 131600df344fSAndy Whitcroft next; 1317773647a0SAndy Whitcroft } 131881bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1319773647a0SAndy Whitcroft $sanitise_quote = ''; 1320773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1321773647a0SAndy Whitcroft $off++; 1322773647a0SAndy Whitcroft next; 1323773647a0SAndy Whitcroft } 1324113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1325113f04a8SDaniel Walker $sanitise_quote = '//'; 1326113f04a8SDaniel Walker 1327113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1328113f04a8SDaniel Walker $off++; 1329113f04a8SDaniel Walker next; 1330113f04a8SDaniel Walker } 1331773647a0SAndy Whitcroft 1332773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1333773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1334773647a0SAndy Whitcroft $c eq "\\") { 1335773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1336773647a0SAndy Whitcroft $off++; 1337773647a0SAndy Whitcroft next; 1338773647a0SAndy Whitcroft } 1339773647a0SAndy Whitcroft # Regular quotes. 1340773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1341773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1342773647a0SAndy Whitcroft $sanitise_quote = $c; 1343773647a0SAndy Whitcroft 1344773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1345773647a0SAndy Whitcroft next; 1346773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1347773647a0SAndy Whitcroft $sanitise_quote = ''; 134800df344fSAndy Whitcroft } 134900df344fSAndy Whitcroft } 1350773647a0SAndy Whitcroft 1351fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1352773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1353773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1354113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1355113f04a8SDaniel Walker substr($res, $off, 1, $;); 1356773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1357773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 135800df344fSAndy Whitcroft } else { 1359773647a0SAndy Whitcroft substr($res, $off, 1, $c); 136000df344fSAndy Whitcroft } 1361c2fdda0dSAndy Whitcroft } 1362c2fdda0dSAndy Whitcroft 1363113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1364113f04a8SDaniel Walker $sanitise_quote = ''; 1365113f04a8SDaniel Walker } 1366113f04a8SDaniel Walker 1367c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1368c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1369c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1370c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1371c2fdda0dSAndy Whitcroft 1372c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1373c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1374c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1375c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1376c2fdda0dSAndy Whitcroft } 1377c2fdda0dSAndy Whitcroft 1378dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1379dadf680dSJoe Perches my $match = $1; 1380dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1381dadf680dSJoe Perches } 1382dadf680dSJoe Perches 138300df344fSAndy Whitcroft return $res; 138400df344fSAndy Whitcroft} 138500df344fSAndy Whitcroft 1386a6962d72SJoe Perchessub get_quoted_string { 1387a6962d72SJoe Perches my ($line, $rawline) = @_; 1388a6962d72SJoe Perches 1389478b1799SJoe Perches return "" if (!defined($line) || !defined($rawline)); 139033acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1391a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1392a6962d72SJoe Perches} 1393a6962d72SJoe Perches 13948905a67cSAndy Whitcroftsub ctx_statement_block { 13958905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 13968905a67cSAndy Whitcroft my $line = $linenr - 1; 13978905a67cSAndy Whitcroft my $blk = ''; 13988905a67cSAndy Whitcroft my $soff = $off; 13998905a67cSAndy Whitcroft my $coff = $off - 1; 1400773647a0SAndy Whitcroft my $coff_set = 0; 14018905a67cSAndy Whitcroft 140213214adfSAndy Whitcroft my $loff = 0; 140313214adfSAndy Whitcroft 14048905a67cSAndy Whitcroft my $type = ''; 14058905a67cSAndy Whitcroft my $level = 0; 1406a2750645SAndy Whitcroft my @stack = (); 1407cf655043SAndy Whitcroft my $p; 14088905a67cSAndy Whitcroft my $c; 14098905a67cSAndy Whitcroft my $len = 0; 141013214adfSAndy Whitcroft 141113214adfSAndy Whitcroft my $remainder; 14128905a67cSAndy Whitcroft while (1) { 1413a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1414a2750645SAndy Whitcroft 1415773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 14168905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 14178905a67cSAndy Whitcroft # context. 14188905a67cSAndy Whitcroft if ($off >= $len) { 14198905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1420dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1421c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 14228905a67cSAndy Whitcroft $remain--; 142313214adfSAndy Whitcroft $loff = $len; 1424c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 14258905a67cSAndy Whitcroft $len = length($blk); 14268905a67cSAndy Whitcroft $line++; 14278905a67cSAndy Whitcroft last; 14288905a67cSAndy Whitcroft } 14298905a67cSAndy Whitcroft # Bail if there is no further context. 14308905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 143113214adfSAndy Whitcroft if ($off >= $len) { 14328905a67cSAndy Whitcroft last; 14338905a67cSAndy Whitcroft } 1434f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1435f74bd194SAndy Whitcroft $level++; 1436f74bd194SAndy Whitcroft $type = '#'; 1437f74bd194SAndy Whitcroft } 14388905a67cSAndy Whitcroft } 1439cf655043SAndy Whitcroft $p = $c; 14408905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 144113214adfSAndy Whitcroft $remainder = substr($blk, $off); 14428905a67cSAndy Whitcroft 1443773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 14444635f4fbSAndy Whitcroft 14454635f4fbSAndy Whitcroft # Handle nested #if/#else. 14464635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 14474635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 14484635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 14494635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 14504635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 14514635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 14524635f4fbSAndy Whitcroft } 14534635f4fbSAndy Whitcroft 14548905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 14558905a67cSAndy Whitcroft # outermost level. 14568905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 14578905a67cSAndy Whitcroft last; 14588905a67cSAndy Whitcroft } 14598905a67cSAndy Whitcroft 146013214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1461773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1462773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1463773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1464773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1465773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1466773647a0SAndy Whitcroft $coff_set = 1; 1467773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1468773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 146913214adfSAndy Whitcroft } 147013214adfSAndy Whitcroft 14718905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 14728905a67cSAndy Whitcroft $level++; 14738905a67cSAndy Whitcroft $type = '('; 14748905a67cSAndy Whitcroft } 14758905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 14768905a67cSAndy Whitcroft $level--; 14778905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 14788905a67cSAndy Whitcroft 14798905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 14808905a67cSAndy Whitcroft $coff = $off; 1481773647a0SAndy Whitcroft $coff_set = 1; 1482773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 14838905a67cSAndy Whitcroft } 14848905a67cSAndy Whitcroft } 14858905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 14868905a67cSAndy Whitcroft $level++; 14878905a67cSAndy Whitcroft $type = '{'; 14888905a67cSAndy Whitcroft } 14898905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 14908905a67cSAndy Whitcroft $level--; 14918905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 14928905a67cSAndy Whitcroft 14938905a67cSAndy Whitcroft if ($level == 0) { 1494b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1495b998e001SPatrick Pannuto $off++; 1496b998e001SPatrick Pannuto } 14978905a67cSAndy Whitcroft last; 14988905a67cSAndy Whitcroft } 14998905a67cSAndy Whitcroft } 1500f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1501f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1502f74bd194SAndy Whitcroft $level--; 1503f74bd194SAndy Whitcroft $type = ''; 1504f74bd194SAndy Whitcroft $off++; 1505f74bd194SAndy Whitcroft last; 1506f74bd194SAndy Whitcroft } 15078905a67cSAndy Whitcroft $off++; 15088905a67cSAndy Whitcroft } 1509a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 151013214adfSAndy Whitcroft if ($off == $len) { 1511a3bb97a7SAndy Whitcroft $loff = $len + 1; 151213214adfSAndy Whitcroft $line++; 151313214adfSAndy Whitcroft $remain--; 151413214adfSAndy Whitcroft } 15158905a67cSAndy Whitcroft 15168905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 15178905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 15188905a67cSAndy Whitcroft 15198905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 15208905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 15218905a67cSAndy Whitcroft 1522773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 152313214adfSAndy Whitcroft 152413214adfSAndy Whitcroft return ($statement, $condition, 152513214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 152613214adfSAndy Whitcroft} 152713214adfSAndy Whitcroft 1528cf655043SAndy Whitcroftsub statement_lines { 1529cf655043SAndy Whitcroft my ($stmt) = @_; 1530cf655043SAndy Whitcroft 1531cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1532cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1533cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1534cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1535cf655043SAndy Whitcroft 1536cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1537cf655043SAndy Whitcroft 1538cf655043SAndy Whitcroft return $#stmt_lines + 2; 1539cf655043SAndy Whitcroft} 1540cf655043SAndy Whitcroft 1541cf655043SAndy Whitcroftsub statement_rawlines { 1542cf655043SAndy Whitcroft my ($stmt) = @_; 1543cf655043SAndy Whitcroft 1544cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1545cf655043SAndy Whitcroft 1546cf655043SAndy Whitcroft return $#stmt_lines + 2; 1547cf655043SAndy Whitcroft} 1548cf655043SAndy Whitcroft 1549cf655043SAndy Whitcroftsub statement_block_size { 1550cf655043SAndy Whitcroft my ($stmt) = @_; 1551cf655043SAndy Whitcroft 1552cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1553cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1554cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1555cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1556cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1557cf655043SAndy Whitcroft 1558cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1559cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1560cf655043SAndy Whitcroft 1561cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1562cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1563cf655043SAndy Whitcroft 1564cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1565cf655043SAndy Whitcroft return $stmt_lines; 1566cf655043SAndy Whitcroft } else { 1567cf655043SAndy Whitcroft return $stmt_statements; 1568cf655043SAndy Whitcroft } 1569cf655043SAndy Whitcroft} 1570cf655043SAndy Whitcroft 157113214adfSAndy Whitcroftsub ctx_statement_full { 157213214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 157313214adfSAndy Whitcroft my ($statement, $condition, $level); 157413214adfSAndy Whitcroft 157513214adfSAndy Whitcroft my (@chunks); 157613214adfSAndy Whitcroft 1577cf655043SAndy Whitcroft # Grab the first conditional/block pair. 157813214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 157913214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1580773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 158113214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1582cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1583cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1584cf655043SAndy Whitcroft } 1585cf655043SAndy Whitcroft 1586cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1587cf655043SAndy Whitcroft # could continue the statement. 1588cf655043SAndy Whitcroft for (;;) { 158913214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 159013214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1591cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1592773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1593cf655043SAndy Whitcroft #print "C: push\n"; 1594cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 159513214adfSAndy Whitcroft } 159613214adfSAndy Whitcroft 159713214adfSAndy Whitcroft return ($level, $linenr, @chunks); 15988905a67cSAndy Whitcroft} 15998905a67cSAndy Whitcroft 16004a0df2efSAndy Whitcroftsub ctx_block_get { 1601f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 16024a0df2efSAndy Whitcroft my $line; 16034a0df2efSAndy Whitcroft my $start = $linenr - 1; 16044a0df2efSAndy Whitcroft my $blk = ''; 16054a0df2efSAndy Whitcroft my @o; 16064a0df2efSAndy Whitcroft my @c; 16074a0df2efSAndy Whitcroft my @res = (); 16084a0df2efSAndy Whitcroft 1609f0a594c1SAndy Whitcroft my $level = 0; 16104635f4fbSAndy Whitcroft my @stack = ($level); 161100df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 161200df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 161300df344fSAndy Whitcroft $remain--; 161400df344fSAndy Whitcroft 161500df344fSAndy Whitcroft $blk .= $rawlines[$line]; 16164635f4fbSAndy Whitcroft 16174635f4fbSAndy Whitcroft # Handle nested #if/#else. 161801464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 16194635f4fbSAndy Whitcroft push(@stack, $level); 162001464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 16214635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 162201464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 16234635f4fbSAndy Whitcroft $level = pop(@stack); 16244635f4fbSAndy Whitcroft } 16254635f4fbSAndy Whitcroft 162601464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1627f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1628f0a594c1SAndy Whitcroft if ($off > 0) { 1629f0a594c1SAndy Whitcroft $off--; 1630f0a594c1SAndy Whitcroft next; 1631f0a594c1SAndy Whitcroft } 16324a0df2efSAndy Whitcroft 1633f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1634f0a594c1SAndy Whitcroft $level--; 1635f0a594c1SAndy Whitcroft last if ($level == 0); 1636f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1637f0a594c1SAndy Whitcroft $level++; 1638f0a594c1SAndy Whitcroft } 1639f0a594c1SAndy Whitcroft } 16404a0df2efSAndy Whitcroft 1641f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 164200df344fSAndy Whitcroft push(@res, $rawlines[$line]); 16434a0df2efSAndy Whitcroft } 16444a0df2efSAndy Whitcroft 1645f0a594c1SAndy Whitcroft last if ($level == 0); 16464a0df2efSAndy Whitcroft } 16474a0df2efSAndy Whitcroft 1648f0a594c1SAndy Whitcroft return ($level, @res); 16494a0df2efSAndy Whitcroft} 16504a0df2efSAndy Whitcroftsub ctx_block_outer { 16514a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 16524a0df2efSAndy Whitcroft 1653f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1654f0a594c1SAndy Whitcroft return @r; 16554a0df2efSAndy Whitcroft} 16564a0df2efSAndy Whitcroftsub ctx_block { 16574a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 16584a0df2efSAndy Whitcroft 1659f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1660f0a594c1SAndy Whitcroft return @r; 1661653d4876SAndy Whitcroft} 1662653d4876SAndy Whitcroftsub ctx_statement { 1663f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1664f0a594c1SAndy Whitcroft 1665f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1666f0a594c1SAndy Whitcroft return @r; 1667f0a594c1SAndy Whitcroft} 1668f0a594c1SAndy Whitcroftsub ctx_block_level { 1669653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1670653d4876SAndy Whitcroft 1671f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 16724a0df2efSAndy Whitcroft} 16739c0ca6f9SAndy Whitcroftsub ctx_statement_level { 16749c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 16759c0ca6f9SAndy Whitcroft 16769c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 16779c0ca6f9SAndy Whitcroft} 16784a0df2efSAndy Whitcroft 16794a0df2efSAndy Whitcroftsub ctx_locate_comment { 16804a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 16814a0df2efSAndy Whitcroft 1682a55ee0ccSJoe Perches # If c99 comment on the current line, or the line before or after 1683a55ee0ccSJoe Perches my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@); 1684a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1685a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@); 1686a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1687a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@); 1688a55ee0ccSJoe Perches return $current_comment if (defined $current_comment); 1689a55ee0ccSJoe Perches 16904a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1691a55ee0ccSJoe Perches ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 16924a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 16934a0df2efSAndy Whitcroft 16944a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 16954a0df2efSAndy Whitcroft # comment. 16964a0df2efSAndy Whitcroft my $in_comment = 0; 16974a0df2efSAndy Whitcroft $current_comment = ''; 16984a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 169900df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 170000df344fSAndy Whitcroft #warn " $line\n"; 17014a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 17024a0df2efSAndy Whitcroft $in_comment = 1; 17034a0df2efSAndy Whitcroft } 17044a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 17054a0df2efSAndy Whitcroft $in_comment = 1; 17064a0df2efSAndy Whitcroft } 17074a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 17084a0df2efSAndy Whitcroft $current_comment = ''; 17094a0df2efSAndy Whitcroft } 17104a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 17114a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 17124a0df2efSAndy Whitcroft $in_comment = 0; 17134a0df2efSAndy Whitcroft } 17144a0df2efSAndy Whitcroft } 17154a0df2efSAndy Whitcroft 17164a0df2efSAndy Whitcroft chomp($current_comment); 17174a0df2efSAndy Whitcroft return($current_comment); 17184a0df2efSAndy Whitcroft} 17194a0df2efSAndy Whitcroftsub ctx_has_comment { 17204a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 17214a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 17224a0df2efSAndy Whitcroft 172300df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 17244a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 17254a0df2efSAndy Whitcroft 17264a0df2efSAndy Whitcroft return ($cmt ne ''); 17274a0df2efSAndy Whitcroft} 17284a0df2efSAndy Whitcroft 17294d001e4dSAndy Whitcroftsub raw_line { 17304d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 17314d001e4dSAndy Whitcroft 17324d001e4dSAndy Whitcroft my $offset = $linenr - 1; 17334d001e4dSAndy Whitcroft $cnt++; 17344d001e4dSAndy Whitcroft 17354d001e4dSAndy Whitcroft my $line; 17364d001e4dSAndy Whitcroft while ($cnt) { 17374d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 17384d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 17394d001e4dSAndy Whitcroft $cnt--; 17404d001e4dSAndy Whitcroft } 17414d001e4dSAndy Whitcroft 17424d001e4dSAndy Whitcroft return $line; 17434d001e4dSAndy Whitcroft} 17444d001e4dSAndy Whitcroft 17452a9f9d85STobin C. Hardingsub get_stat_real { 17462a9f9d85STobin C. Harding my ($linenr, $lc) = @_; 17472a9f9d85STobin C. Harding 17482a9f9d85STobin C. Harding my $stat_real = raw_line($linenr, 0); 17492a9f9d85STobin C. Harding for (my $count = $linenr + 1; $count <= $lc; $count++) { 17502a9f9d85STobin C. Harding $stat_real = $stat_real . "\n" . raw_line($count, 0); 17512a9f9d85STobin C. Harding } 17522a9f9d85STobin C. Harding 17532a9f9d85STobin C. Harding return $stat_real; 17542a9f9d85STobin C. Harding} 17552a9f9d85STobin C. Harding 1756e3d95a2aSTobin C. Hardingsub get_stat_here { 1757e3d95a2aSTobin C. Harding my ($linenr, $cnt, $here) = @_; 1758e3d95a2aSTobin C. Harding 1759e3d95a2aSTobin C. Harding my $herectx = $here . "\n"; 1760e3d95a2aSTobin C. Harding for (my $n = 0; $n < $cnt; $n++) { 1761e3d95a2aSTobin C. Harding $herectx .= raw_line($linenr, $n) . "\n"; 1762e3d95a2aSTobin C. Harding } 1763e3d95a2aSTobin C. Harding 1764e3d95a2aSTobin C. Harding return $herectx; 1765e3d95a2aSTobin C. Harding} 1766e3d95a2aSTobin C. Harding 17670a920b5bSAndy Whitcroftsub cat_vet { 17680a920b5bSAndy Whitcroft my ($vet) = @_; 17699c0ca6f9SAndy Whitcroft my ($res, $coded); 17700a920b5bSAndy Whitcroft 17719c0ca6f9SAndy Whitcroft $res = ''; 17726c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 17736c72ffaaSAndy Whitcroft $res .= $1; 17746c72ffaaSAndy Whitcroft if ($2 ne '') { 17759c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 17766c72ffaaSAndy Whitcroft $res .= $coded; 17776c72ffaaSAndy Whitcroft } 17789c0ca6f9SAndy Whitcroft } 17799c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 17800a920b5bSAndy Whitcroft 17819c0ca6f9SAndy Whitcroft return $res; 17820a920b5bSAndy Whitcroft} 17830a920b5bSAndy Whitcroft 1784c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1785cf655043SAndy Whitcroftmy $av_pending; 1786c2fdda0dSAndy Whitcroftmy @av_paren_type; 17871f65f947SAndy Whitcroftmy $av_pend_colon; 1788c2fdda0dSAndy Whitcroft 1789c2fdda0dSAndy Whitcroftsub annotate_reset { 1790c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1791cf655043SAndy Whitcroft $av_pending = '_'; 1792cf655043SAndy Whitcroft @av_paren_type = ('E'); 17931f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1794c2fdda0dSAndy Whitcroft} 1795c2fdda0dSAndy Whitcroft 17966c72ffaaSAndy Whitcroftsub annotate_values { 17976c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 17986c72ffaaSAndy Whitcroft 17996c72ffaaSAndy Whitcroft my $res; 18001f65f947SAndy Whitcroft my $var = '_' x length($stream); 18016c72ffaaSAndy Whitcroft my $cur = $stream; 18026c72ffaaSAndy Whitcroft 1803c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 18046c72ffaaSAndy Whitcroft 18056c72ffaaSAndy Whitcroft while (length($cur)) { 1806773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1807cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1808171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 18096c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1810c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1811c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1812cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1813c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 18146c72ffaaSAndy Whitcroft } 18156c72ffaaSAndy Whitcroft 1816c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 18179446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 18189446ef56SAndy Whitcroft push(@av_paren_type, $type); 1819addcdceaSAndy Whitcroft $type = 'c'; 18209446ef56SAndy Whitcroft 1821e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1822c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 18236c72ffaaSAndy Whitcroft $type = 'T'; 18246c72ffaaSAndy Whitcroft 1825389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1826389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1827389a2fe5SAndy Whitcroft $type = 'T'; 1828389a2fe5SAndy Whitcroft 1829c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1830171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1831c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1832171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1833171ae1a4SAndy Whitcroft if ($2 ne '') { 1834cf655043SAndy Whitcroft $av_pending = 'N'; 1835171ae1a4SAndy Whitcroft } 1836171ae1a4SAndy Whitcroft $type = 'E'; 1837171ae1a4SAndy Whitcroft 1838c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1839171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1840171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1841171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 18426c72ffaaSAndy Whitcroft 1843c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1844cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1845c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1846cf655043SAndy Whitcroft 1847cf655043SAndy Whitcroft push(@av_paren_type, $type); 1848cf655043SAndy Whitcroft push(@av_paren_type, $type); 1849171ae1a4SAndy Whitcroft $type = 'E'; 1850cf655043SAndy Whitcroft 1851c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1852cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1853cf655043SAndy Whitcroft $av_preprocessor = 1; 1854cf655043SAndy Whitcroft 1855cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1856cf655043SAndy Whitcroft 1857171ae1a4SAndy Whitcroft $type = 'E'; 1858cf655043SAndy Whitcroft 1859c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1860cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1861cf655043SAndy Whitcroft 1862cf655043SAndy Whitcroft $av_preprocessor = 1; 1863cf655043SAndy Whitcroft 1864cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1865cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1866cf655043SAndy Whitcroft pop(@av_paren_type); 1867cf655043SAndy Whitcroft push(@av_paren_type, $type); 1868171ae1a4SAndy Whitcroft $type = 'E'; 18696c72ffaaSAndy Whitcroft 18706c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1871c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 18726c72ffaaSAndy Whitcroft 1873171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1874171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1875171ae1a4SAndy Whitcroft $av_pending = $type; 1876171ae1a4SAndy Whitcroft $type = 'N'; 1877171ae1a4SAndy Whitcroft 18786c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1879c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 18806c72ffaaSAndy Whitcroft if (defined $2) { 1881cf655043SAndy Whitcroft $av_pending = 'V'; 18826c72ffaaSAndy Whitcroft } 18836c72ffaaSAndy Whitcroft $type = 'N'; 18846c72ffaaSAndy Whitcroft 188514b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1886c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 188714b111c1SAndy Whitcroft $av_pending = 'E'; 18886c72ffaaSAndy Whitcroft $type = 'N'; 18896c72ffaaSAndy Whitcroft 18901f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 18911f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 18921f65f947SAndy Whitcroft $av_pend_colon = 'C'; 18931f65f947SAndy Whitcroft $type = 'N'; 18941f65f947SAndy Whitcroft 189514b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1896c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 18976c72ffaaSAndy Whitcroft $type = 'N'; 18986c72ffaaSAndy Whitcroft 18996c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1900c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1901cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1902cf655043SAndy Whitcroft $av_pending = '_'; 19036c72ffaaSAndy Whitcroft $type = 'N'; 19046c72ffaaSAndy Whitcroft 19056c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1906cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1907cf655043SAndy Whitcroft if ($new_type ne '_') { 1908cf655043SAndy Whitcroft $type = $new_type; 1909c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1910c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 19116c72ffaaSAndy Whitcroft } else { 1912c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 19136c72ffaaSAndy Whitcroft } 19146c72ffaaSAndy Whitcroft 1915c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1916c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1917c8cb2ca3SAndy Whitcroft $type = 'V'; 1918cf655043SAndy Whitcroft $av_pending = 'V'; 19196c72ffaaSAndy Whitcroft 19208e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 19218e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 19221f65f947SAndy Whitcroft $av_pend_colon = 'B'; 19238e761b04SAndy Whitcroft } elsif ($type eq 'E') { 19248e761b04SAndy Whitcroft $av_pend_colon = 'L'; 19251f65f947SAndy Whitcroft } 19261f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 19271f65f947SAndy Whitcroft $type = 'V'; 19281f65f947SAndy Whitcroft 19296c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1930c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 19316c72ffaaSAndy Whitcroft $type = 'V'; 19326c72ffaaSAndy Whitcroft 19336c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1934c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 19356c72ffaaSAndy Whitcroft $type = 'N'; 19366c72ffaaSAndy Whitcroft 1937cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1938c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 193913214adfSAndy Whitcroft $type = 'E'; 19401f65f947SAndy Whitcroft $av_pend_colon = 'O'; 194113214adfSAndy Whitcroft 19428e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 19438e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 19448e761b04SAndy Whitcroft $type = 'C'; 19458e761b04SAndy Whitcroft 19461f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 19471f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 19481f65f947SAndy Whitcroft $type = 'N'; 19491f65f947SAndy Whitcroft 19501f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 19511f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 19521f65f947SAndy Whitcroft 19531f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 19541f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 19551f65f947SAndy Whitcroft $type = 'E'; 19561f65f947SAndy Whitcroft } else { 19571f65f947SAndy Whitcroft $type = 'N'; 19581f65f947SAndy Whitcroft } 19591f65f947SAndy Whitcroft $av_pend_colon = 'O'; 19601f65f947SAndy Whitcroft 19618e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 196213214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 19636c72ffaaSAndy Whitcroft $type = 'N'; 19646c72ffaaSAndy Whitcroft 19650d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 196674048ed8SAndy Whitcroft my $variant; 196774048ed8SAndy Whitcroft 196874048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 196974048ed8SAndy Whitcroft if ($type eq 'V') { 197074048ed8SAndy Whitcroft $variant = 'B'; 197174048ed8SAndy Whitcroft } else { 197274048ed8SAndy Whitcroft $variant = 'U'; 197374048ed8SAndy Whitcroft } 197474048ed8SAndy Whitcroft 197574048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 197674048ed8SAndy Whitcroft $type = 'N'; 197774048ed8SAndy Whitcroft 19786c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1979c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 19806c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 19816c72ffaaSAndy Whitcroft $type = 'N'; 19826c72ffaaSAndy Whitcroft } 19836c72ffaaSAndy Whitcroft 19846c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1985c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 19866c72ffaaSAndy Whitcroft } 19876c72ffaaSAndy Whitcroft if (defined $1) { 19886c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 19896c72ffaaSAndy Whitcroft $res .= $type x length($1); 19906c72ffaaSAndy Whitcroft } 19916c72ffaaSAndy Whitcroft } 19926c72ffaaSAndy Whitcroft 19931f65f947SAndy Whitcroft return ($res, $var); 19946c72ffaaSAndy Whitcroft} 19956c72ffaaSAndy Whitcroft 19968905a67cSAndy Whitcroftsub possible { 199713214adfSAndy Whitcroft my ($possible, $line) = @_; 19989a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 19990776e594SAndy Whitcroft ^(?: 20000776e594SAndy Whitcroft $Modifier| 20010776e594SAndy Whitcroft $Storage| 20020776e594SAndy Whitcroft $Type| 20039a974fdbSAndy Whitcroft DEFINE_\S+ 20049a974fdbSAndy Whitcroft )$| 20059a974fdbSAndy Whitcroft ^(?: 20060776e594SAndy Whitcroft goto| 20070776e594SAndy Whitcroft return| 20080776e594SAndy Whitcroft case| 20090776e594SAndy Whitcroft else| 20100776e594SAndy Whitcroft asm|__asm__| 201189a88353SAndy Whitcroft do| 201289a88353SAndy Whitcroft \#| 201389a88353SAndy Whitcroft \#\#| 20149a974fdbSAndy Whitcroft )(?:\s|$)| 20150776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 20169a974fdbSAndy Whitcroft )}x; 20179a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 20189a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 2019c45dcabdSAndy Whitcroft # Check for modifiers. 2020c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 2021c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 2022c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 2023c45dcabdSAndy Whitcroft 2024c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 2025c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 2026d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 20279a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 2028d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 2029485ff23eSAlex Dowad push(@modifierListFile, $modifier); 2030d2506586SAndy Whitcroft } 20319a974fdbSAndy Whitcroft } 2032c45dcabdSAndy Whitcroft 2033c45dcabdSAndy Whitcroft } else { 203413214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 2035485ff23eSAlex Dowad push(@typeListFile, $possible); 2036c45dcabdSAndy Whitcroft } 20378905a67cSAndy Whitcroft build_types(); 20380776e594SAndy Whitcroft } else { 20390776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 20408905a67cSAndy Whitcroft } 20418905a67cSAndy Whitcroft} 20428905a67cSAndy Whitcroft 20436c72ffaaSAndy Whitcroftmy $prefix = ''; 20446c72ffaaSAndy Whitcroft 2045000d1cc1SJoe Perchessub show_type { 2046cbec18afSJoe Perches my ($type) = @_; 204791bfe484SJoe Perches 2048522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 2049522b837cSAlexey Dobriyan 2050cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 2051cbec18afSJoe Perches 2052cbec18afSJoe Perches return !defined $ignore_type{$type}; 2053000d1cc1SJoe Perches} 2054000d1cc1SJoe Perches 2055f0a594c1SAndy Whitcroftsub report { 2056cbec18afSJoe Perches my ($level, $type, $msg) = @_; 2057cbec18afSJoe Perches 2058cbec18afSJoe Perches if (!show_type($type) || 2059cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 2060773647a0SAndy Whitcroft return 0; 2061773647a0SAndy Whitcroft } 206257230297SJoe Perches my $output = ''; 2063737c0767SJohn Brooks if ($color) { 206457230297SJoe Perches if ($level eq 'ERROR') { 206557230297SJoe Perches $output .= RED; 206657230297SJoe Perches } elsif ($level eq 'WARNING') { 206757230297SJoe Perches $output .= YELLOW; 2068000d1cc1SJoe Perches } else { 206957230297SJoe Perches $output .= GREEN; 2070000d1cc1SJoe Perches } 207157230297SJoe Perches } 207257230297SJoe Perches $output .= $prefix . $level . ':'; 207357230297SJoe Perches if ($show_types) { 2074737c0767SJohn Brooks $output .= BLUE if ($color); 207557230297SJoe Perches $output .= "$type:"; 207657230297SJoe Perches } 2077737c0767SJohn Brooks $output .= RESET if ($color); 207857230297SJoe Perches $output .= ' ' . $msg . "\n"; 207934d8815fSJoe Perches 208034d8815fSJoe Perches if ($showfile) { 208134d8815fSJoe Perches my @lines = split("\n", $output, -1); 208234d8815fSJoe Perches splice(@lines, 1, 1); 208334d8815fSJoe Perches $output = join("\n", @lines); 208434d8815fSJoe Perches } 208557230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 20868905a67cSAndy Whitcroft 208757230297SJoe Perches push(our @report, $output); 2088773647a0SAndy Whitcroft 2089773647a0SAndy Whitcroft return 1; 2090f0a594c1SAndy Whitcroft} 2091cbec18afSJoe Perches 2092f0a594c1SAndy Whitcroftsub report_dump { 209313214adfSAndy Whitcroft our @report; 2094f0a594c1SAndy Whitcroft} 2095000d1cc1SJoe Perches 2096d752fcc8SJoe Perchessub fixup_current_range { 2097d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 2098d752fcc8SJoe Perches 2099d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 2100d752fcc8SJoe Perches my $o = $1; 2101d752fcc8SJoe Perches my $l = $2; 2102d752fcc8SJoe Perches my $no = $o + $offset; 2103d752fcc8SJoe Perches my $nl = $l + $length; 2104d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 2105d752fcc8SJoe Perches } 2106d752fcc8SJoe Perches} 2107d752fcc8SJoe Perches 2108d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 2109d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 2110d752fcc8SJoe Perches 2111d752fcc8SJoe Perches my $range_last_linenr = 0; 2112d752fcc8SJoe Perches my $delta_offset = 0; 2113d752fcc8SJoe Perches 2114d752fcc8SJoe Perches my $old_linenr = 0; 2115d752fcc8SJoe Perches my $new_linenr = 0; 2116d752fcc8SJoe Perches 2117d752fcc8SJoe Perches my $next_insert = 0; 2118d752fcc8SJoe Perches my $next_delete = 0; 2119d752fcc8SJoe Perches 2120d752fcc8SJoe Perches my @lines = (); 2121d752fcc8SJoe Perches 2122d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 2123d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 2124d752fcc8SJoe Perches 2125d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 2126d752fcc8SJoe Perches my $save_line = 1; 2127d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 2128323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2129d752fcc8SJoe Perches $delta_offset = 0; 2130d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2131d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 2132d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 2133d752fcc8SJoe Perches } 2134d752fcc8SJoe Perches 2135d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2136d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 2137d752fcc8SJoe Perches $save_line = 0; 2138d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2139d752fcc8SJoe Perches } 2140d752fcc8SJoe Perches 2141d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2142d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 2143d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 2144d752fcc8SJoe Perches $new_linenr++; 2145d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2146d752fcc8SJoe Perches } 2147d752fcc8SJoe Perches 2148d752fcc8SJoe Perches if ($save_line) { 2149d752fcc8SJoe Perches push(@lines, $line); 2150d752fcc8SJoe Perches $new_linenr++; 2151d752fcc8SJoe Perches } 2152d752fcc8SJoe Perches 2153d752fcc8SJoe Perches $old_linenr++; 2154d752fcc8SJoe Perches } 2155d752fcc8SJoe Perches 2156d752fcc8SJoe Perches return @lines; 2157d752fcc8SJoe Perches} 2158d752fcc8SJoe Perches 2159f2d7e4d4SJoe Perchessub fix_insert_line { 2160f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2161f2d7e4d4SJoe Perches 2162f2d7e4d4SJoe Perches my $inserted = { 2163f2d7e4d4SJoe Perches LINENR => $linenr, 2164f2d7e4d4SJoe Perches LINE => $line, 2165f2d7e4d4SJoe Perches }; 2166f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2167f2d7e4d4SJoe Perches} 2168f2d7e4d4SJoe Perches 2169f2d7e4d4SJoe Perchessub fix_delete_line { 2170f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2171f2d7e4d4SJoe Perches 2172f2d7e4d4SJoe Perches my $deleted = { 2173f2d7e4d4SJoe Perches LINENR => $linenr, 2174f2d7e4d4SJoe Perches LINE => $line, 2175f2d7e4d4SJoe Perches }; 2176f2d7e4d4SJoe Perches 2177f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2178f2d7e4d4SJoe Perches} 2179f2d7e4d4SJoe Perches 2180de7d4f0eSAndy Whitcroftsub ERROR { 2181cbec18afSJoe Perches my ($type, $msg) = @_; 2182cbec18afSJoe Perches 2183cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2184de7d4f0eSAndy Whitcroft our $clean = 0; 21856c72ffaaSAndy Whitcroft our $cnt_error++; 21863705ce5bSJoe Perches return 1; 2187de7d4f0eSAndy Whitcroft } 21883705ce5bSJoe Perches return 0; 2189773647a0SAndy Whitcroft} 2190de7d4f0eSAndy Whitcroftsub WARN { 2191cbec18afSJoe Perches my ($type, $msg) = @_; 2192cbec18afSJoe Perches 2193cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2194de7d4f0eSAndy Whitcroft our $clean = 0; 21956c72ffaaSAndy Whitcroft our $cnt_warn++; 21963705ce5bSJoe Perches return 1; 2197de7d4f0eSAndy Whitcroft } 21983705ce5bSJoe Perches return 0; 2199773647a0SAndy Whitcroft} 2200de7d4f0eSAndy Whitcroftsub CHK { 2201cbec18afSJoe Perches my ($type, $msg) = @_; 2202cbec18afSJoe Perches 2203cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2204de7d4f0eSAndy Whitcroft our $clean = 0; 22056c72ffaaSAndy Whitcroft our $cnt_chk++; 22063705ce5bSJoe Perches return 1; 22076c72ffaaSAndy Whitcroft } 22083705ce5bSJoe Perches return 0; 2209de7d4f0eSAndy Whitcroft} 2210de7d4f0eSAndy Whitcroft 22116ecd9674SAndy Whitcroftsub check_absolute_file { 22126ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 22136ecd9674SAndy Whitcroft my $file = $absolute; 22146ecd9674SAndy Whitcroft 22156ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 22166ecd9674SAndy Whitcroft 22176ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 22186ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 22196ecd9674SAndy Whitcroft if (-f "$root/$file") { 22206ecd9674SAndy Whitcroft ##print "file<$file>\n"; 22216ecd9674SAndy Whitcroft last; 22226ecd9674SAndy Whitcroft } 22236ecd9674SAndy Whitcroft } 22246ecd9674SAndy Whitcroft if (! -f _) { 22256ecd9674SAndy Whitcroft return 0; 22266ecd9674SAndy Whitcroft } 22276ecd9674SAndy Whitcroft 22286ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 22296ecd9674SAndy Whitcroft my $prefix = $absolute; 22306ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 22316ecd9674SAndy Whitcroft 22326ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 22336ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2234000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2235000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 22366ecd9674SAndy Whitcroft } 22376ecd9674SAndy Whitcroft} 22386ecd9674SAndy Whitcroft 22393705ce5bSJoe Perchessub trim { 22403705ce5bSJoe Perches my ($string) = @_; 22413705ce5bSJoe Perches 2242b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2243b34c648bSJoe Perches 2244b34c648bSJoe Perches return $string; 2245b34c648bSJoe Perches} 2246b34c648bSJoe Perches 2247b34c648bSJoe Perchessub ltrim { 2248b34c648bSJoe Perches my ($string) = @_; 2249b34c648bSJoe Perches 2250b34c648bSJoe Perches $string =~ s/^\s+//; 2251b34c648bSJoe Perches 2252b34c648bSJoe Perches return $string; 2253b34c648bSJoe Perches} 2254b34c648bSJoe Perches 2255b34c648bSJoe Perchessub rtrim { 2256b34c648bSJoe Perches my ($string) = @_; 2257b34c648bSJoe Perches 2258b34c648bSJoe Perches $string =~ s/\s+$//; 22593705ce5bSJoe Perches 22603705ce5bSJoe Perches return $string; 22613705ce5bSJoe Perches} 22623705ce5bSJoe Perches 226352ea8506SJoe Perchessub string_find_replace { 226452ea8506SJoe Perches my ($string, $find, $replace) = @_; 226552ea8506SJoe Perches 226652ea8506SJoe Perches $string =~ s/$find/$replace/g; 226752ea8506SJoe Perches 226852ea8506SJoe Perches return $string; 226952ea8506SJoe Perches} 227052ea8506SJoe Perches 22713705ce5bSJoe Perchessub tabify { 22723705ce5bSJoe Perches my ($leading) = @_; 22733705ce5bSJoe Perches 2274713a09deSAntonio Borneo my $source_indent = $tabsize; 22753705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 22763705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 22773705ce5bSJoe Perches 22783705ce5bSJoe Perches #convert leading spaces to tabs 22793705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 22803705ce5bSJoe Perches #Remove spaces before a tab 22813705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 22823705ce5bSJoe Perches 22833705ce5bSJoe Perches return "$leading"; 22843705ce5bSJoe Perches} 22853705ce5bSJoe Perches 2286d1fe9c09SJoe Perchessub pos_last_openparen { 2287d1fe9c09SJoe Perches my ($line) = @_; 2288d1fe9c09SJoe Perches 2289d1fe9c09SJoe Perches my $pos = 0; 2290d1fe9c09SJoe Perches 2291d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2292d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2293d1fe9c09SJoe Perches 2294d1fe9c09SJoe Perches my $last_openparen = 0; 2295d1fe9c09SJoe Perches 2296d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2297d1fe9c09SJoe Perches return -1; 2298d1fe9c09SJoe Perches } 2299d1fe9c09SJoe Perches 2300d1fe9c09SJoe Perches my $len = length($line); 2301d1fe9c09SJoe Perches 2302d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2303d1fe9c09SJoe Perches my $string = substr($line, $pos); 2304d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2305d1fe9c09SJoe Perches $pos += length($1) - 1; 2306d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2307d1fe9c09SJoe Perches $last_openparen = $pos; 2308d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2309d1fe9c09SJoe Perches last; 2310d1fe9c09SJoe Perches } 2311d1fe9c09SJoe Perches } 2312d1fe9c09SJoe Perches 231391cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2314d1fe9c09SJoe Perches} 2315d1fe9c09SJoe Perches 2316f36d3eb8SJoe Perchessub get_raw_comment { 2317f36d3eb8SJoe Perches my ($line, $rawline) = @_; 2318f36d3eb8SJoe Perches my $comment = ''; 2319f36d3eb8SJoe Perches 2320f36d3eb8SJoe Perches for my $i (0 .. (length($line) - 1)) { 2321f36d3eb8SJoe Perches if (substr($line, $i, 1) eq "$;") { 2322f36d3eb8SJoe Perches $comment .= substr($rawline, $i, 1); 2323f36d3eb8SJoe Perches } 2324f36d3eb8SJoe Perches } 2325f36d3eb8SJoe Perches 2326f36d3eb8SJoe Perches return $comment; 2327f36d3eb8SJoe Perches} 2328f36d3eb8SJoe Perches 23290a920b5bSAndy Whitcroftsub process { 23300a920b5bSAndy Whitcroft my $filename = shift; 23310a920b5bSAndy Whitcroft 23320a920b5bSAndy Whitcroft my $linenr=0; 23330a920b5bSAndy Whitcroft my $prevline=""; 2334c2fdda0dSAndy Whitcroft my $prevrawline=""; 23350a920b5bSAndy Whitcroft my $stashline=""; 2336c2fdda0dSAndy Whitcroft my $stashrawline=""; 23370a920b5bSAndy Whitcroft 23384a0df2efSAndy Whitcroft my $length; 23390a920b5bSAndy Whitcroft my $indent; 23400a920b5bSAndy Whitcroft my $previndent=0; 23410a920b5bSAndy Whitcroft my $stashindent=0; 23420a920b5bSAndy Whitcroft 2343de7d4f0eSAndy Whitcroft our $clean = 1; 23440a920b5bSAndy Whitcroft my $signoff = 0; 2345cd261496SGeert Uytterhoeven my $author = ''; 2346cd261496SGeert Uytterhoeven my $authorsignoff = 0; 23470a920b5bSAndy Whitcroft my $is_patch = 0; 2348133712a2SRob Herring my $is_binding_patch = -1; 234929ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 235015662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 235144d303ebSJoe Perches my $has_patch_separator = 0; #Found a --- line 2352ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2353490b292cSJoe Perches my $commit_log_lines = 0; #Number of commit log lines 2354bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 23552a076f40SJoe Perches my $commit_log_long_line = 0; 2356e518e9a5SJoe Perches my $commit_log_has_diff = 0; 235713f1937eSJoe Perches my $reported_maintainer_file = 0; 2358fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2359fa64205dSPasi Savanainen 2360365dd4eaSJoe Perches my $last_blank_line = 0; 23615e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2362365dd4eaSJoe Perches 236313214adfSAndy Whitcroft our @report = (); 23646c72ffaaSAndy Whitcroft our $cnt_lines = 0; 23656c72ffaaSAndy Whitcroft our $cnt_error = 0; 23666c72ffaaSAndy Whitcroft our $cnt_warn = 0; 23676c72ffaaSAndy Whitcroft our $cnt_chk = 0; 23686c72ffaaSAndy Whitcroft 23690a920b5bSAndy Whitcroft # Trace the real file/line as we go. 23700a920b5bSAndy Whitcroft my $realfile = ''; 23710a920b5bSAndy Whitcroft my $realline = 0; 23720a920b5bSAndy Whitcroft my $realcnt = 0; 23730a920b5bSAndy Whitcroft my $here = ''; 237477cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 23750a920b5bSAndy Whitcroft my $in_comment = 0; 2376c2fdda0dSAndy Whitcroft my $comment_edge = 0; 23770a920b5bSAndy Whitcroft my $first_line = 0; 23781e855726SWolfram Sang my $p1_prefix = ''; 23790a920b5bSAndy Whitcroft 238013214adfSAndy Whitcroft my $prev_values = 'E'; 238113214adfSAndy Whitcroft 238213214adfSAndy Whitcroft # suppression flags 2383773647a0SAndy Whitcroft my %suppress_ifbraces; 2384170d3a22SAndy Whitcroft my %suppress_whiletrailers; 23852b474a1aSAndy Whitcroft my %suppress_export; 23863e469cdcSAndy Whitcroft my $suppress_statement = 0; 2387653d4876SAndy Whitcroft 23887e51f197SJoe Perches my %signatures = (); 2389323c1260SJoe Perches 2390c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2391de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2392c2fdda0dSAndy Whitcroft # 2393de7d4f0eSAndy Whitcroft my @setup_docs = (); 2394de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2395773647a0SAndy Whitcroft 2396d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2397d8b07710SJoe Perches 23989f3a8992SRob Herring my $checklicenseline = 1; 23999f3a8992SRob Herring 2400773647a0SAndy Whitcroft sanitise_line_reset(); 2401c2fdda0dSAndy Whitcroft my $line; 2402c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2403773647a0SAndy Whitcroft $linenr++; 2404773647a0SAndy Whitcroft $line = $rawline; 2405c2fdda0dSAndy Whitcroft 24063705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 24073705ce5bSJoe Perches 2408773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2409de7d4f0eSAndy Whitcroft $setup_docs = 0; 24102581ac7cSTim Froidcoeur if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) { 2411de7d4f0eSAndy Whitcroft $setup_docs = 1; 2412de7d4f0eSAndy Whitcroft } 2413773647a0SAndy Whitcroft #next; 2414de7d4f0eSAndy Whitcroft } 241574fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2416773647a0SAndy Whitcroft $realline=$1-1; 2417773647a0SAndy Whitcroft if (defined $2) { 2418773647a0SAndy Whitcroft $realcnt=$3+1; 2419773647a0SAndy Whitcroft } else { 2420773647a0SAndy Whitcroft $realcnt=1+1; 2421773647a0SAndy Whitcroft } 2422c45dcabdSAndy Whitcroft $in_comment = 0; 2423773647a0SAndy Whitcroft 2424773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2425773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2426773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2427773647a0SAndy Whitcroft # at context start. 2428773647a0SAndy Whitcroft my $edge; 242901fa9147SAndy Whitcroft my $cnt = $realcnt; 243001fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 243101fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 243201fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 243301fa9147SAndy Whitcroft $cnt--; 243401fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2435721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2436fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2437fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2438fae17daeSAndy Whitcroft ($edge) = $1; 2439fae17daeSAndy Whitcroft last; 2440fae17daeSAndy Whitcroft } 2441773647a0SAndy Whitcroft } 2442773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2443773647a0SAndy Whitcroft $in_comment = 1; 2444773647a0SAndy Whitcroft } 2445773647a0SAndy Whitcroft 2446773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2447773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2448773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2449773647a0SAndy Whitcroft if (!defined $edge && 245083242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2451773647a0SAndy Whitcroft { 2452773647a0SAndy Whitcroft $in_comment = 1; 2453773647a0SAndy Whitcroft } 2454773647a0SAndy Whitcroft 2455773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2456773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2457773647a0SAndy Whitcroft 2458171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2459773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2460171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2461773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2462773647a0SAndy Whitcroft } 2463773647a0SAndy Whitcroft push(@lines, $line); 2464773647a0SAndy Whitcroft 2465773647a0SAndy Whitcroft if ($realcnt > 1) { 2466773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2467773647a0SAndy Whitcroft } else { 2468773647a0SAndy Whitcroft $realcnt = 0; 2469773647a0SAndy Whitcroft } 2470773647a0SAndy Whitcroft 2471773647a0SAndy Whitcroft #print "==>$rawline\n"; 2472773647a0SAndy Whitcroft #print "-->$line\n"; 2473de7d4f0eSAndy Whitcroft 2474de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2475de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2476de7d4f0eSAndy Whitcroft } 2477de7d4f0eSAndy Whitcroft } 2478de7d4f0eSAndy Whitcroft 24796c72ffaaSAndy Whitcroft $prefix = ''; 24806c72ffaaSAndy Whitcroft 2481773647a0SAndy Whitcroft $realcnt = 0; 2482773647a0SAndy Whitcroft $linenr = 0; 2483194f66fcSJoe Perches $fixlinenr = -1; 24840a920b5bSAndy Whitcroft foreach my $line (@lines) { 24850a920b5bSAndy Whitcroft $linenr++; 2486194f66fcSJoe Perches $fixlinenr++; 24871b5539b1SJoe Perches my $sline = $line; #copy of $line 24881b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 24890a920b5bSAndy Whitcroft 2490c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 2491f36d3eb8SJoe Perches my $raw_comment = get_raw_comment($line, $rawline); 24926c72ffaaSAndy Whitcroft 249312c253abSJoe Perches# check if it's a mode change, rename or start of a patch 249412c253abSJoe Perches if (!$in_commit_log && 249512c253abSJoe Perches ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 249612c253abSJoe Perches ($line =~ /^rename (?:from|to) \S+\s*$/ || 249712c253abSJoe Perches $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 249812c253abSJoe Perches $is_patch = 1; 249912c253abSJoe Perches } 250012c253abSJoe Perches 25010a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2502e518e9a5SJoe Perches if (!$in_commit_log && 250374fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 250474fd4f34SJoe Perches my $context = $4; 25050a920b5bSAndy Whitcroft $is_patch = 1; 25064a0df2efSAndy Whitcroft $first_line = $linenr + 1; 25070a920b5bSAndy Whitcroft $realline=$1-1; 25080a920b5bSAndy Whitcroft if (defined $2) { 25090a920b5bSAndy Whitcroft $realcnt=$3+1; 25100a920b5bSAndy Whitcroft } else { 25110a920b5bSAndy Whitcroft $realcnt=1+1; 25120a920b5bSAndy Whitcroft } 2513c2fdda0dSAndy Whitcroft annotate_reset(); 251413214adfSAndy Whitcroft $prev_values = 'E'; 251513214adfSAndy Whitcroft 2516773647a0SAndy Whitcroft %suppress_ifbraces = (); 2517170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 25182b474a1aSAndy Whitcroft %suppress_export = (); 25193e469cdcSAndy Whitcroft $suppress_statement = 0; 252074fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 252174fd4f34SJoe Perches $context_function = $1; 252274fd4f34SJoe Perches } else { 252374fd4f34SJoe Perches undef $context_function; 252474fd4f34SJoe Perches } 25250a920b5bSAndy Whitcroft next; 25260a920b5bSAndy Whitcroft 25274a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 25284a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 25294a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2530773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 25310a920b5bSAndy Whitcroft $realline++; 2532d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 25330a920b5bSAndy Whitcroft 25344a0df2efSAndy Whitcroft # Measure the line length and indent. 2535c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 25360a920b5bSAndy Whitcroft 25370a920b5bSAndy Whitcroft # Track the previous line. 25380a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 25390a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2540c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2541c2fdda0dSAndy Whitcroft 2542773647a0SAndy Whitcroft #warn "line<$line>\n"; 25436c72ffaaSAndy Whitcroft 2544d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2545d8aaf121SAndy Whitcroft $realcnt--; 25460a920b5bSAndy Whitcroft } 25470a920b5bSAndy Whitcroft 2548cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2549cc77cdcaSAndy Whitcroft 25506c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 25516c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2552773647a0SAndy Whitcroft 25532ac73b4fSJoe Perches my $found_file = 0; 2554773647a0SAndy Whitcroft # extract the filename as it passes 25553bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 25563bf9a009SRabin Vincent $realfile = $1; 25572b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2558270c49a0SJoe Perches $in_commit_log = 0; 25592ac73b4fSJoe Perches $found_file = 1; 25603bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2561773647a0SAndy Whitcroft $realfile = $1; 25622b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2563270c49a0SJoe Perches $in_commit_log = 0; 25641e855726SWolfram Sang 25651e855726SWolfram Sang $p1_prefix = $1; 2566e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2567e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2568000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2569000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 25701e855726SWolfram Sang } 2571773647a0SAndy Whitcroft 2572c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2573000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2574000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2575773647a0SAndy Whitcroft } 25762ac73b4fSJoe Perches $found_file = 1; 25772ac73b4fSJoe Perches } 25782ac73b4fSJoe Perches 257934d8815fSJoe Perches#make up the handle for any error we report on this line 258034d8815fSJoe Perches if ($showfile) { 258134d8815fSJoe Perches $prefix = "$realfile:$realline: " 258234d8815fSJoe Perches } elsif ($emacs) { 25837d3a9f67SJoe Perches if ($file) { 25847d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 25857d3a9f67SJoe Perches } else { 258634d8815fSJoe Perches $prefix = "$filename:$linenr: "; 258734d8815fSJoe Perches } 25887d3a9f67SJoe Perches } 258934d8815fSJoe Perches 25902ac73b4fSJoe Perches if ($found_file) { 259185b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 259285b0ee18SJoe Perches WARN("OBSOLETE", 259385b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 259485b0ee18SJoe Perches } 25957bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 25962ac73b4fSJoe Perches $check = 1; 25972ac73b4fSJoe Perches } else { 25982ac73b4fSJoe Perches $check = $check_orig; 25992ac73b4fSJoe Perches } 26009f3a8992SRob Herring $checklicenseline = 1; 2601133712a2SRob Herring 2602133712a2SRob Herring if ($realfile !~ /^MAINTAINERS/) { 2603133712a2SRob Herring my $last_binding_patch = $is_binding_patch; 2604133712a2SRob Herring 2605133712a2SRob Herring $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@; 2606133712a2SRob Herring 2607133712a2SRob Herring if (($last_binding_patch != -1) && 2608133712a2SRob Herring ($last_binding_patch ^ $is_binding_patch)) { 2609133712a2SRob Herring WARN("DT_SPLIT_BINDING_PATCH", 2610858e6845SMauro Carvalho Chehab "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n"); 2611133712a2SRob Herring } 2612133712a2SRob Herring } 2613133712a2SRob Herring 2614773647a0SAndy Whitcroft next; 2615773647a0SAndy Whitcroft } 2616773647a0SAndy Whitcroft 2617389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 26180a920b5bSAndy Whitcroft 2619c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2620c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2621c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 26220a920b5bSAndy Whitcroft 26236c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 26246c72ffaaSAndy Whitcroft 2625490b292cSJoe Perches# Verify the existence of a commit log if appropriate 2626490b292cSJoe Perches# 2 is used because a $signature is counted in $commit_log_lines 2627490b292cSJoe Perches if ($in_commit_log) { 2628490b292cSJoe Perches if ($line !~ /^\s*$/) { 2629490b292cSJoe Perches $commit_log_lines++; #could be a $signature 2630490b292cSJoe Perches } 2631490b292cSJoe Perches } elsif ($has_commit_log && $commit_log_lines < 2) { 2632490b292cSJoe Perches WARN("COMMIT_MESSAGE", 2633490b292cSJoe Perches "Missing commit description - Add an appropriate one\n"); 2634490b292cSJoe Perches $commit_log_lines = 2; #warn only once 2635490b292cSJoe Perches } 2636490b292cSJoe Perches 2637e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2638e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2639e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2640e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2641e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2642e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2643e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2644e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2645e518e9a5SJoe Perches $commit_log_has_diff = 1; 2646e518e9a5SJoe Perches } 2647e518e9a5SJoe Perches 26483bf9a009SRabin Vincent# Check for incorrect file permissions 26493bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 26503bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 265104db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 265204db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2653000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2654000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 26553bf9a009SRabin Vincent } 26563bf9a009SRabin Vincent } 26573bf9a009SRabin Vincent 2658cd261496SGeert Uytterhoeven# Check the patch for a From: 2659cd261496SGeert Uytterhoeven if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { 2660cd261496SGeert Uytterhoeven $author = $1; 2661cd261496SGeert Uytterhoeven $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); 2662cd261496SGeert Uytterhoeven $author =~ s/"//g; 2663dfa05c28SJoe Perches $author = reformat_email($author); 2664cd261496SGeert Uytterhoeven } 2665cd261496SGeert Uytterhoeven 266620112475SJoe Perches# Check the patch for a signoff: 2667dfa05c28SJoe Perches if ($line =~ /^\s*signed-off-by:\s*(.*)/i) { 26684a0df2efSAndy Whitcroft $signoff++; 266915662b3eSJoe Perches $in_commit_log = 0; 2670cd261496SGeert Uytterhoeven if ($author ne '') { 2671dfa05c28SJoe Perches if (same_email_addresses($1, $author)) { 2672cd261496SGeert Uytterhoeven $authorsignoff = 1; 2673cd261496SGeert Uytterhoeven } 2674cd261496SGeert Uytterhoeven } 26750a920b5bSAndy Whitcroft } 267620112475SJoe Perches 267744d303ebSJoe Perches# Check for patch separator 267844d303ebSJoe Perches if ($line =~ /^---$/) { 267944d303ebSJoe Perches $has_patch_separator = 1; 268044d303ebSJoe Perches $in_commit_log = 0; 268144d303ebSJoe Perches } 268244d303ebSJoe Perches 2683e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2684e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2685e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2686e0d975b1SJoe Perches $reported_maintainer_file = 1; 2687e0d975b1SJoe Perches } 2688e0d975b1SJoe Perches 268920112475SJoe Perches# Check signature styles 2690270c49a0SJoe Perches if (!$in_header_lines && 2691ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 269220112475SJoe Perches my $space_before = $1; 269320112475SJoe Perches my $sign_off = $2; 269420112475SJoe Perches my $space_after = $3; 269520112475SJoe Perches my $email = $4; 269620112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 269720112475SJoe Perches 2698ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2699ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2700ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2701ce0338dfSJoe Perches } 270220112475SJoe Perches if (defined $space_before && $space_before ne "") { 27033705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 27043705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 27053705ce5bSJoe Perches $fix) { 2706194f66fcSJoe Perches $fixed[$fixlinenr] = 27073705ce5bSJoe Perches "$ucfirst_sign_off $email"; 27083705ce5bSJoe Perches } 270920112475SJoe Perches } 271020112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 27113705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 27123705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 27133705ce5bSJoe Perches $fix) { 2714194f66fcSJoe Perches $fixed[$fixlinenr] = 27153705ce5bSJoe Perches "$ucfirst_sign_off $email"; 27163705ce5bSJoe Perches } 27173705ce5bSJoe Perches 271820112475SJoe Perches } 271920112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 27203705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 27213705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 27223705ce5bSJoe Perches $fix) { 2723194f66fcSJoe Perches $fixed[$fixlinenr] = 27243705ce5bSJoe Perches "$ucfirst_sign_off $email"; 27253705ce5bSJoe Perches } 272620112475SJoe Perches } 272720112475SJoe Perches 2728dfa05c28SJoe Perches my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 272920112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 273020112475SJoe Perches if ($suggested_email eq "") { 2731000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2732000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 273320112475SJoe Perches } else { 273420112475SJoe Perches my $dequoted = $suggested_email; 273520112475SJoe Perches $dequoted =~ s/^"//; 273620112475SJoe Perches $dequoted =~ s/" </ </; 273720112475SJoe Perches # Don't force email to have quotes 273820112475SJoe Perches # Allow just an angle bracketed address 2739dfa05c28SJoe Perches if (!same_email_addresses($email, $suggested_email)) { 2740000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2741000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 274220112475SJoe Perches } 27430a920b5bSAndy Whitcroft } 27447e51f197SJoe Perches 27457e51f197SJoe Perches# Check for duplicate signatures 27467e51f197SJoe Perches my $sig_nospace = $line; 27477e51f197SJoe Perches $sig_nospace =~ s/\s//g; 27487e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 27497e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 27507e51f197SJoe Perches WARN("BAD_SIGN_OFF", 27517e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 27527e51f197SJoe Perches } else { 27537e51f197SJoe Perches $signatures{$sig_nospace} = 1; 27547e51f197SJoe Perches } 27556c5d24eeSSean Christopherson 27566c5d24eeSSean Christopherson# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email 27576c5d24eeSSean Christopherson if ($sign_off =~ /^co-developed-by:$/i) { 27586c5d24eeSSean Christopherson if ($email eq $author) { 27596c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 27606c5d24eeSSean Christopherson "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline); 27616c5d24eeSSean Christopherson } 27626c5d24eeSSean Christopherson if (!defined $lines[$linenr]) { 27636c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 27646c5d24eeSSean Christopherson "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline); 27656c5d24eeSSean Christopherson } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) { 27666c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 27676c5d24eeSSean Christopherson "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 27686c5d24eeSSean Christopherson } elsif ($1 ne $email) { 27696c5d24eeSSean Christopherson WARN("BAD_SIGN_OFF", 27706c5d24eeSSean Christopherson "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 27716c5d24eeSSean Christopherson } 27726c5d24eeSSean Christopherson } 27730a920b5bSAndy Whitcroft } 27740a920b5bSAndy Whitcroft 2775a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2776a2fe16b9SJoe Perches if ($in_header_lines && 2777a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2778a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2779a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2780a2fe16b9SJoe Perches } 2781a2fe16b9SJoe Perches 278244d303ebSJoe Perches# Check for Gerrit Change-Ids not in any patch context 278344d303ebSJoe Perches if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) { 27847ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 278544d303ebSJoe Perches "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr); 27867ebd05efSChristopher Covington } 27877ebd05efSChristopher Covington 2788369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2789369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2790369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2791369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2792369c8dd3SJoe Perches # timestamp 2793634cffccSJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) || 2794634cffccSJoe Perches $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ || 2795634cffccSJoe Perches $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) { 2796634cffccSJoe Perches # stack dump address styles 2797369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2798369c8dd3SJoe Perches } 2799369c8dd3SJoe Perches 28002a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 28012a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2802bf4daf12SJoe Perches length($line) > 75 && 2803bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2804bf4daf12SJoe Perches # file delta changes 2805bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2806bf4daf12SJoe Perches # filename then : 2807bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2808bf4daf12SJoe Perches # A Fixes: or Link: line 2809bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 28102a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 28112a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 28122a076f40SJoe Perches $commit_log_long_line = 1; 28132a076f40SJoe Perches } 28142a076f40SJoe Perches 2815bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2816bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2817bf4daf12SJoe Perches $line =~ /^\s*$/) { 2818bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2819bf4daf12SJoe Perches } 2820bf4daf12SJoe Perches 28210d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2822369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2823a8972573SJohn Hubbard $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i && 2824e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 2825fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2826aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2827369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2828bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2829fe043ea1SJoe Perches my $init_char = "c"; 2830fe043ea1SJoe Perches my $orig_commit = ""; 28310d7835fcSJoe Perches my $short = 1; 28320d7835fcSJoe Perches my $long = 0; 28330d7835fcSJoe Perches my $case = 1; 28340d7835fcSJoe Perches my $space = 1; 28350d7835fcSJoe Perches my $hasdesc = 0; 283619c146a6SJoe Perches my $hasparens = 0; 28370d7835fcSJoe Perches my $id = '0123456789ab'; 28380d7835fcSJoe Perches my $orig_desc = "commit description"; 28390d7835fcSJoe Perches my $description = ""; 28400d7835fcSJoe Perches 2841fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2842fe043ea1SJoe Perches $init_char = $1; 2843fe043ea1SJoe Perches $orig_commit = lc($2); 2844fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2845fe043ea1SJoe Perches $orig_commit = lc($1); 2846fe043ea1SJoe Perches } 2847fe043ea1SJoe Perches 28480d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 28490d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 28500d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 28510d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 28520d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 28530d7835fcSJoe Perches $orig_desc = $1; 285419c146a6SJoe Perches $hasparens = 1; 28550d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 28560d7835fcSJoe Perches defined $rawlines[$linenr] && 28570d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 28580d7835fcSJoe Perches $orig_desc = $1; 285919c146a6SJoe Perches $hasparens = 1; 2860b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2861b671fde0SJoe Perches defined $rawlines[$linenr] && 2862b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2863b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2864b671fde0SJoe Perches $orig_desc = $1; 2865b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2866b671fde0SJoe Perches $orig_desc .= " " . $1; 286719c146a6SJoe Perches $hasparens = 1; 28680d7835fcSJoe Perches } 28690d7835fcSJoe Perches 28700d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 28710d7835fcSJoe Perches $id, $orig_desc); 28720d7835fcSJoe Perches 2873948b133aSHeinrich Schuchardt if (defined($id) && 2874948b133aSHeinrich Schuchardt ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { 2875d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 28760d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 28770d7835fcSJoe Perches } 2878d311cd44SJoe Perches } 2879d311cd44SJoe Perches 288013f1937eSJoe Perches# Check for added, moved or deleted files 288113f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 288213f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 288313f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 288413f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 288513f1937eSJoe Perches (defined($1) || defined($2))))) { 2886a82603a8SAndrew Jeffery $is_patch = 1; 288713f1937eSJoe Perches $reported_maintainer_file = 1; 288813f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 288913f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 289013f1937eSJoe Perches } 289113f1937eSJoe Perches 2892e400edb1SRob Herring# Check for adding new DT bindings not in schema format 2893e400edb1SRob Herring if (!$in_commit_log && 2894e400edb1SRob Herring ($line =~ /^new file mode\s*\d+\s*$/) && 2895e400edb1SRob Herring ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) { 2896e400edb1SRob Herring WARN("DT_SCHEMA_BINDING_PATCH", 2897e400edb1SRob Herring "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n"); 2898e400edb1SRob Herring } 2899e400edb1SRob Herring 290000df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 29018905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2902000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2903000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 29046c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2905de7d4f0eSAndy Whitcroft } 2906de7d4f0eSAndy Whitcroft 2907de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2908de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2909171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2910171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2911171ae1a4SAndy Whitcroft 2912171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2913171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2914171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2915171ae1a4SAndy Whitcroft 291634d99219SJoe Perches CHK("INVALID_UTF8", 2917000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 291800df344fSAndy Whitcroft } 29190a920b5bSAndy Whitcroft 292015662b3eSJoe Perches# Check if it's the start of a commit log 292115662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 292215662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 2923eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 2924eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 292515662b3eSJoe Perches $in_header_lines = 0; 292615662b3eSJoe Perches $in_commit_log = 1; 2927ed43c4e5SAllen Hubbe $has_commit_log = 1; 292815662b3eSJoe Perches } 292915662b3eSJoe Perches 2930fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2931fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2932fa64205dSPasi Savanainen if ($in_header_lines && 2933fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2934fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2935fa64205dSPasi Savanainen $non_utf8_charset = 1; 2936fa64205dSPasi Savanainen } 2937fa64205dSPasi Savanainen 2938fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 293915662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2940fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 294115662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 294215662b3eSJoe Perches } 294315662b3eSJoe Perches 2944d6430f71SJoe Perches# Check for absolute kernel paths in commit message 2945d6430f71SJoe Perches if ($tree && $in_commit_log) { 2946d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 2947d6430f71SJoe Perches my $file = $1; 2948d6430f71SJoe Perches 2949d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 2950d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 2951d6430f71SJoe Perches # 2952d6430f71SJoe Perches } else { 2953d6430f71SJoe Perches check_absolute_file($file, $herecurr); 2954d6430f71SJoe Perches } 2955d6430f71SJoe Perches } 2956d6430f71SJoe Perches } 2957d6430f71SJoe Perches 295866b47b4aSKees Cook# Check for various typo / spelling mistakes 295966d7a382SJoe Perches if (defined($misspellings) && 296066d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2961ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 296266b47b4aSKees Cook my $typo = $1; 296366b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 296466b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 296566b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 29660675a8fbSJean Delvare my $msg_level = \&WARN; 29670675a8fbSJean Delvare $msg_level = \&CHK if ($file); 29680675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 296966b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 297066b47b4aSKees Cook $fix) { 297166b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 297266b47b4aSKees Cook } 297366b47b4aSKees Cook } 297466b47b4aSKees Cook } 297566b47b4aSKees Cook 2976a8dd86bfSMatteo Croce# check for invalid commit id 2977a8dd86bfSMatteo Croce if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) { 2978a8dd86bfSMatteo Croce my $id; 2979a8dd86bfSMatteo Croce my $description; 2980a8dd86bfSMatteo Croce ($id, $description) = git_commit_info($2, undef, undef); 2981a8dd86bfSMatteo Croce if (!defined($id)) { 2982a8dd86bfSMatteo Croce WARN("UNKNOWN_COMMIT_ID", 2983a8dd86bfSMatteo Croce "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr); 2984a8dd86bfSMatteo Croce } 2985a8dd86bfSMatteo Croce } 2986a8dd86bfSMatteo Croce 298730670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 298830670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 298900df344fSAndy Whitcroft 29900a920b5bSAndy Whitcroft#trailing whitespace 29919c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2992c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2993d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2994d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2995d5e616fcSJoe Perches $fix) { 2996194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2997d5e616fcSJoe Perches } 2998c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2999c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 30003705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 30013705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 30023705ce5bSJoe Perches $fix) { 3003194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 30043705ce5bSJoe Perches } 30053705ce5bSJoe Perches 3006d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 30070a920b5bSAndy Whitcroft } 30085368df20SAndy Whitcroft 30094783f894SJosh Triplett# Check for FSF mailing addresses. 3010109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 30111bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 30123e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 30133e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 30144783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 30150675a8fbSJean Delvare my $msg_level = \&ERROR; 30160675a8fbSJean Delvare $msg_level = \&CHK if ($file); 30170675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 30184783f894SJosh 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) 30194783f894SJosh Triplett } 30204783f894SJosh Triplett 30213354957aSAndi Kleen# check for Kconfig help text having a real description 30229fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 30239fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 30243354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 3025678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 3026678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 3027678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 3028678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 30293354957aSAndi Kleen my $length = 0; 30309fe287d7SAndy Whitcroft my $cnt = $realcnt; 30319fe287d7SAndy Whitcroft my $ln = $linenr + 1; 30329fe287d7SAndy Whitcroft my $f; 3033a1385803SAndy Whitcroft my $is_start = 0; 30349fe287d7SAndy Whitcroft my $is_end = 0; 3035a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 30369fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 30379fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 30389fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 30399fe287d7SAndy Whitcroft 30409fe287d7SAndy Whitcroft next if ($f =~ /^-/); 30418d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 3042a1385803SAndy Whitcroft 304386adf1a0SUlf Magnusson if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 3044a1385803SAndy Whitcroft $is_start = 1; 3045*22a4ac02SMasahiro Yamada } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 3046a1385803SAndy Whitcroft $length = -1; 3047a1385803SAndy Whitcroft } 3048a1385803SAndy Whitcroft 30499fe287d7SAndy Whitcroft $f =~ s/^.//; 30503354957aSAndi Kleen $f =~ s/#.*//; 30513354957aSAndi Kleen $f =~ s/^\s+//; 30523354957aSAndi Kleen next if ($f =~ /^$/); 3053678ae162SUlf Magnusson 3054678ae162SUlf Magnusson # This only checks context lines in the patch 3055678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 3056678ae162SUlf Magnusson # positives, even though some of these are 3057678ae162SUlf Magnusson # common words in help texts 3058678ae162SUlf Magnusson if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| 3059678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 30609fe287d7SAndy Whitcroft $is_end = 1; 30619fe287d7SAndy Whitcroft last; 30629fe287d7SAndy Whitcroft } 30633354957aSAndi Kleen $length++; 30643354957aSAndi Kleen } 306556193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 3066000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 306756193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 306856193274SVadim Bendebury } 3069a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 30703354957aSAndi Kleen } 30713354957aSAndi Kleen 30727ccf41a8SJoe Perches# check MAINTAINERS entries 30737ccf41a8SJoe Perches if ($realfile =~ /^MAINTAINERS$/) { 30747ccf41a8SJoe Perches# check MAINTAINERS entries for the right form 30757ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 3076628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 3077628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 3078628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 3079628f91a2SJoe Perches $fix) { 3080628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 3081628f91a2SJoe Perches } 3082628f91a2SJoe Perches } 30837ccf41a8SJoe Perches# check MAINTAINERS entries for the right ordering too 30847ccf41a8SJoe Perches my $preferred_order = 'MRLSWQBCPTFXNK'; 30857ccf41a8SJoe Perches if ($rawline =~ /^\+[A-Z]:/ && 30867ccf41a8SJoe Perches $prevrawline =~ /^[\+ ][A-Z]:/) { 30877ccf41a8SJoe Perches $rawline =~ /^\+([A-Z]):\s*(.*)/; 30887ccf41a8SJoe Perches my $cur = $1; 30897ccf41a8SJoe Perches my $curval = $2; 30907ccf41a8SJoe Perches $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/; 30917ccf41a8SJoe Perches my $prev = $1; 30927ccf41a8SJoe Perches my $prevval = $2; 30937ccf41a8SJoe Perches my $curindex = index($preferred_order, $cur); 30947ccf41a8SJoe Perches my $previndex = index($preferred_order, $prev); 30957ccf41a8SJoe Perches if ($curindex < 0) { 30967ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 30977ccf41a8SJoe Perches "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr); 30987ccf41a8SJoe Perches } else { 30997ccf41a8SJoe Perches if ($previndex >= 0 && $curindex < $previndex) { 31007ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 31017ccf41a8SJoe Perches "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev); 31027ccf41a8SJoe Perches } elsif ((($prev eq 'F' && $cur eq 'F') || 31037ccf41a8SJoe Perches ($prev eq 'X' && $cur eq 'X')) && 31047ccf41a8SJoe Perches ($prevval cmp $curval) > 0) { 31057ccf41a8SJoe Perches WARN("MAINTAINERS_STYLE", 31067ccf41a8SJoe Perches "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev); 31077ccf41a8SJoe Perches } 31087ccf41a8SJoe Perches } 31097ccf41a8SJoe Perches } 31107ccf41a8SJoe Perches } 3111628f91a2SJoe Perches 3112327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 3113327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 3114327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 3115327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 3116327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 3117327953e9SChristoph Jaeger } 3118327953e9SChristoph Jaeger 3119c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 3120c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 3121c68e5878SArnaud Lacombe my $flag = $1; 3122c68e5878SArnaud Lacombe my $replacement = { 3123c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 3124c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 3125c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 3126c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 3127c68e5878SArnaud Lacombe }; 3128c68e5878SArnaud Lacombe 3129c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 3130c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 3131c68e5878SArnaud Lacombe } 3132c68e5878SArnaud Lacombe 3133bff5da43SRob Herring# check for DT compatible documentation 31347dd05b38SFlorian Vaussard if (defined $root && 31357dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 31367dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 31377dd05b38SFlorian Vaussard 3138bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 3139bff5da43SRob Herring 3140cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 3141852d095dSRob Herring my $vp_file = $dt_path . "vendor-prefixes.yaml"; 3142cc93319bSFlorian Vaussard 3143bff5da43SRob Herring foreach my $compat (@compats) { 3144bff5da43SRob Herring my $compat2 = $compat; 3145185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 3146185d566bSRob Herring my $compat3 = $compat; 3147185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 3148185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 3149bff5da43SRob Herring if ( $? >> 8 ) { 3150bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3151bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 3152bff5da43SRob Herring } 3153bff5da43SRob Herring 31544fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 31554fbf32a6SFlorian Vaussard my $vendor = $1; 3156852d095dSRob Herring `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`; 3157bff5da43SRob Herring if ( $? >> 8 ) { 3158bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3159cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 3160bff5da43SRob Herring } 3161bff5da43SRob Herring } 3162bff5da43SRob Herring } 3163bff5da43SRob Herring 31649f3a8992SRob Herring# check for using SPDX license tag at beginning of files 31659f3a8992SRob Herring if ($realline == $checklicenseline) { 31669f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 31679f3a8992SRob Herring $checklicenseline = 2; 31689f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 31699f3a8992SRob Herring my $comment = ""; 31709f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 31719f3a8992SRob Herring $comment = '/*'; 31729f3a8992SRob Herring } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 31739f3a8992SRob Herring $comment = '//'; 3174c8df0ab6SLubomir Rintel } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) { 31759f3a8992SRob Herring $comment = '#'; 31769f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 31779f3a8992SRob Herring $comment = '..'; 31789f3a8992SRob Herring } 31799f3a8992SRob Herring 3180fdf13693SJoe Perches# check SPDX comment style for .[chsS] files 3181fdf13693SJoe Perches if ($realfile =~ /\.[chsS]$/ && 3182fdf13693SJoe Perches $rawline =~ /SPDX-License-Identifier:/ && 3183ffbce897SJoe Perches $rawline !~ m@^\+\s*\Q$comment\E\s*@) { 3184fdf13693SJoe Perches WARN("SPDX_LICENSE_TAG", 3185fdf13693SJoe Perches "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr); 3186fdf13693SJoe Perches } 3187fdf13693SJoe Perches 31889f3a8992SRob Herring if ($comment !~ /^$/ && 3189ffbce897SJoe Perches $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) { 31909f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 31919f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 31923b6e8ac9SJoe Perches } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) { 31933b6e8ac9SJoe Perches my $spdx_license = $1; 31943b6e8ac9SJoe Perches if (!is_SPDX_License_valid($spdx_license)) { 31953b6e8ac9SJoe Perches WARN("SPDX_LICENSE_TAG", 31963b6e8ac9SJoe Perches "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr); 31973b6e8ac9SJoe Perches } 319850c92900SLubomir Rintel if ($realfile =~ m@^Documentation/devicetree/bindings/@ && 319950c92900SLubomir Rintel not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) { 320050c92900SLubomir Rintel my $msg_level = \&WARN; 320150c92900SLubomir Rintel $msg_level = \&CHK if ($file); 320250c92900SLubomir Rintel if (&{$msg_level}("SPDX_LICENSE_TAG", 320350c92900SLubomir Rintel 320450c92900SLubomir Rintel "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) && 320550c92900SLubomir Rintel $fix) { 320650c92900SLubomir Rintel $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/; 320750c92900SLubomir Rintel } 320850c92900SLubomir Rintel } 32099f3a8992SRob Herring } 32109f3a8992SRob Herring } 32119f3a8992SRob Herring } 32129f3a8992SRob Herring 32135368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 3214d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 32155368df20SAndy Whitcroft 3216a8da38a9SJoe Perches# check for using SPDX-License-Identifier on the wrong line number 3217a8da38a9SJoe Perches if ($realline != $checklicenseline && 3218a8da38a9SJoe Perches $rawline =~ /\bSPDX-License-Identifier:/ && 3219a8da38a9SJoe Perches substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) { 3220a8da38a9SJoe Perches WARN("SPDX_LICENSE_TAG", 3221a8da38a9SJoe Perches "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr); 3222a8da38a9SJoe Perches } 3223a8da38a9SJoe Perches 322447e0c88bSJoe Perches# line length limit (with some exclusions) 322547e0c88bSJoe Perches# 322647e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 322747e0c88bSJoe Perches# logging functions like pr_info that end in a string 322847e0c88bSJoe Perches# lines with a single string 322947e0c88bSJoe Perches# #defines that are a single string 32302e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 323147e0c88bSJoe Perches# 323247e0c88bSJoe Perches# There are 3 different line length message types: 3233ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 323447e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 323547e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 323647e0c88bSJoe Perches# 323747e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 323847e0c88bSJoe Perches# 323947e0c88bSJoe Perches 3240b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 324147e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 324247e0c88bSJoe Perches 324347e0c88bSJoe Perches # Check the allowed long line types first 324447e0c88bSJoe Perches 324547e0c88bSJoe Perches # logging functions that end in a string that starts 324647e0c88bSJoe Perches # before $max_line_length 324747e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 324847e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 324947e0c88bSJoe Perches $msg_type = ""; 325047e0c88bSJoe Perches 325147e0c88bSJoe Perches # lines with only strings (w/ possible termination) 325247e0c88bSJoe Perches # #defines with only strings 325347e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 325447e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 325547e0c88bSJoe Perches $msg_type = ""; 325647e0c88bSJoe Perches 3257cc147506SJoe Perches # More special cases 3258cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3259cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3260d560a5f8SJoe Perches $msg_type = ""; 3261d560a5f8SJoe Perches 32622e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 32632e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 32642e4bbbc5SAndreas Brauchli $msg_type = ""; 32652e4bbbc5SAndreas Brauchli 326647e0c88bSJoe Perches # Otherwise set the alternate message types 326747e0c88bSJoe Perches 326847e0c88bSJoe Perches # a comment starts before $max_line_length 326947e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 327047e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 327147e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 327247e0c88bSJoe Perches 327347e0c88bSJoe Perches # a quoted string starts before $max_line_length 327447e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 327547e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 327647e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 327747e0c88bSJoe Perches } 327847e0c88bSJoe Perches 327947e0c88bSJoe Perches if ($msg_type ne "" && 328047e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 3281bdc48fa1SJoe Perches my $msg_level = \&WARN; 3282bdc48fa1SJoe Perches $msg_level = \&CHK if ($file); 3283bdc48fa1SJoe Perches &{$msg_level}($msg_type, 3284bdc48fa1SJoe Perches "line length of $length exceeds $max_line_length columns\n" . $herecurr); 32850a920b5bSAndy Whitcroft } 328647e0c88bSJoe Perches } 32870a920b5bSAndy Whitcroft 32888905a67cSAndy Whitcroft# check for adding lines without a newline. 32898905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 3290000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 3291000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 32928905a67cSAndy Whitcroft } 32938905a67cSAndy Whitcroft 3294b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3295de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 32960a920b5bSAndy Whitcroft 32970a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 3298713a09deSAntonio Borneo# more than $tabsize must use tabs. 3299c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3300c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3301c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3302d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 33033705ce5bSJoe Perches if (ERROR("CODE_INDENT", 33043705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 33053705ce5bSJoe Perches $fix) { 3306194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 33073705ce5bSJoe Perches } 33080a920b5bSAndy Whitcroft } 33090a920b5bSAndy Whitcroft 331008e44365SAlberto Panizzo# check for space before tabs. 331108e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 331208e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 33133705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 33143705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 33153705ce5bSJoe Perches $fix) { 3316194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3317713a09deSAntonio Borneo s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} 3318194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3319c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 33203705ce5bSJoe Perches } 332108e44365SAlberto Panizzo } 332208e44365SAlberto Panizzo 33236a487211SJoe Perches# check for assignments on the start of a line 33246a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 33256a487211SJoe Perches CHK("ASSIGNMENT_CONTINUATIONS", 33266a487211SJoe Perches "Assignment operator '$1' should be on the previous line\n" . $hereprev); 33276a487211SJoe Perches } 33286a487211SJoe Perches 3329d1fe9c09SJoe Perches# check for && or || at the start of a line 3330d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 3331d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 3332d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 3333d1fe9c09SJoe Perches } 3334d1fe9c09SJoe Perches 3335a91e8994SJoe Perches# check indentation starts on a tab stop 33365b57980dSJoe Perches if ($perl_version_ok && 3337bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3338a91e8994SJoe Perches my $indent = length($1); 3339713a09deSAntonio Borneo if ($indent % $tabsize) { 3340a91e8994SJoe Perches if (WARN("TABSTOP", 3341a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3342a91e8994SJoe Perches $fix) { 3343713a09deSAntonio Borneo $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; 3344a91e8994SJoe Perches } 3345a91e8994SJoe Perches } 3346a91e8994SJoe Perches } 3347a91e8994SJoe Perches 3348d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 33495b57980dSJoe Perches if ($perl_version_ok && 3350fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3351d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3352d1fe9c09SJoe Perches my $oldindent = $1; 3353d1fe9c09SJoe Perches my $rest = $2; 3354d1fe9c09SJoe Perches 3355d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3356d1fe9c09SJoe Perches if ($pos >= 0) { 3357b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3358b34a26f3SJoe Perches my $newindent = $2; 3359d1fe9c09SJoe Perches 3360d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3361713a09deSAntonio Borneo "\t" x ($pos / $tabsize) . 3362713a09deSAntonio Borneo " " x ($pos % $tabsize); 3363d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3364d1fe9c09SJoe Perches 3365d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3366d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 33673705ce5bSJoe Perches 33683705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 33693705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 33703705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3371194f66fcSJoe Perches $fixed[$fixlinenr] =~ 33723705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 33733705ce5bSJoe Perches } 3374d1fe9c09SJoe Perches } 3375d1fe9c09SJoe Perches } 3376d1fe9c09SJoe Perches } 3377d1fe9c09SJoe Perches 33786ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 33796ab3a970SJoe Perches# avoid checking a few false positives: 33806ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 33816ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 33826ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 33836ab3a970SJoe Perches# multiline macros that define functions 33846ab3a970SJoe Perches# known attributes or the __attribute__ keyword 33856ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 33866ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 33873705ce5bSJoe Perches if (CHK("SPACING", 3388f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 33893705ce5bSJoe Perches $fix) { 3390194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3391f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 33923705ce5bSJoe Perches } 3393aad4f614SJoe Perches } 3394aad4f614SJoe Perches 339586406b1cSJoe Perches# Block comment styles 339686406b1cSJoe Perches# Networking with an initial /* 339705880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3398fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 339985ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 340085ad978cSJoe Perches $realline > 2) { 340105880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 340205880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 340305880600SJoe Perches } 340405880600SJoe Perches 340586406b1cSJoe Perches# Block comments use * on subsequent lines 340686406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 340786406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3408a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 340961135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3410a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 341186406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 341286406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3413a605e32eSJoe Perches } 3414a605e32eSJoe Perches 341586406b1cSJoe Perches# Block comments use */ on trailing lines 341686406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3417c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3418c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3419c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 342086406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 342186406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 342205880600SJoe Perches } 342305880600SJoe Perches 342408eb9b80SJoe Perches# Block comment * alignment 342508eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3426af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3427af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3428af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 342908eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3430af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3431af207524SJoe Perches my $oldindent; 343208eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3433af207524SJoe Perches if (defined($1)) { 3434af207524SJoe Perches $oldindent = expand_tabs($1); 3435af207524SJoe Perches } else { 3436af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3437af207524SJoe Perches $oldindent = expand_tabs($1); 3438af207524SJoe Perches } 343908eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 344008eb9b80SJoe Perches my $newindent = $1; 344108eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3442af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 344308eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 344408eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 344508eb9b80SJoe Perches } 344608eb9b80SJoe Perches } 344708eb9b80SJoe Perches 34487f619191SJoe Perches# check for missing blank lines after struct/union declarations 34497f619191SJoe Perches# with exceptions for various attributes and macros 34507f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 34517f619191SJoe Perches $line =~ /^\+/ && 34527f619191SJoe Perches !($line =~ /^\+\s*$/ || 34537f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 34547f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 34557f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 34567f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 34577f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 34587f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 34590bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 34607f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3461d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3462d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3463d752fcc8SJoe Perches $fix) { 3464f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3465d752fcc8SJoe Perches } 34667f619191SJoe Perches } 34677f619191SJoe Perches 3468365dd4eaSJoe Perches# check for multiple consecutive blank lines 3469365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3470365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3471365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3472d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3473d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3474d752fcc8SJoe Perches $fix) { 3475f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3476d752fcc8SJoe Perches } 3477d752fcc8SJoe Perches 3478365dd4eaSJoe Perches $last_blank_line = $linenr; 3479365dd4eaSJoe Perches } 3480365dd4eaSJoe Perches 34813b617e3bSJoe Perches# check for missing blank lines after declarations 34823f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 34833f7bac03SJoe Perches # actual declarations 34843f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 34855a4e1fd3SJoe Perches # function pointer declarations 34865a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 34873f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 34883f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 34893f7bac03SJoe Perches # known declaration macros 34903f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 34913f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 34923f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 34933f7bac03SJoe Perches # other possible extensions of declaration lines 34943f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 34953f7bac03SJoe Perches # not starting a section or a macro "\" extended line 34963f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 34973f7bac03SJoe Perches # looks like a declaration 34983f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 34995a4e1fd3SJoe Perches # function pointer declarations 35005a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 35013f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 35023f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 35033f7bac03SJoe Perches # known declaration macros 35043f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 35053f7bac03SJoe Perches # start of struct or union or enum 3506328b5f41SJoe Perches $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ || 35073f7bac03SJoe Perches # start or end of block or continuation of declaration 35083f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 35093f7bac03SJoe Perches # bitfield continuation 35103f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 35113f7bac03SJoe Perches # other possible extensions of declaration lines 35123f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 35133f7bac03SJoe Perches # indentation of previous and current line are the same 35143f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3515d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3516d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3517d752fcc8SJoe Perches $fix) { 3518f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3519d752fcc8SJoe Perches } 35203b617e3bSJoe Perches } 35213b617e3bSJoe Perches 35225f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 35236b4c5bebSAndy Whitcroft# Exceptions: 35246b4c5bebSAndy Whitcroft# 1) within comments 35256b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 35266b4c5bebSAndy Whitcroft# 3) hanging labels 35273705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 35285f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 35293705ce5bSJoe Perches if (WARN("LEADING_SPACE", 35303705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 35313705ce5bSJoe Perches $fix) { 3532194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 35333705ce5bSJoe Perches } 35345f7ddae6SRaffaele Recalcati } 35355f7ddae6SRaffaele Recalcati 3536b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3537b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3538b9ea10d6SAndy Whitcroft 35395751a24eSJoe Perches# check for unusual line ending [ or ( 35405751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 35415751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 35425751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 35435751a24eSJoe Perches } 35445751a24eSJoe Perches 35454dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 35464dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 35474dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 35484dbed76fSJoe Perches $context_function = $1; 35494dbed76fSJoe Perches } 35504dbed76fSJoe Perches 35514dbed76fSJoe Perches# check if this appears to be the end of function declaration 35524dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 35534dbed76fSJoe Perches undef $context_function; 35544dbed76fSJoe Perches } 35554dbed76fSJoe Perches 3556032a4c0fSJoe Perches# check indentation of any line with a bare else 3557840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3558032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3559032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3560032a4c0fSJoe Perches my $tabs = length($1) + 1; 3561840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3562840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3563840080a0SJoe Perches defined $lines[$linenr] && 3564840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3565032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3566032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3567032a4c0fSJoe Perches } 3568032a4c0fSJoe Perches } 3569032a4c0fSJoe Perches 3570c00df19aSJoe Perches# check indentation of a line with a break; 3571c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3572c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3573c00df19aSJoe Perches my $tabs = $1; 3574c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3575c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3576c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3577c00df19aSJoe Perches } 3578c00df19aSJoe Perches } 3579c00df19aSJoe Perches 3580c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3581cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3582000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3583000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3584c2fdda0dSAndy Whitcroft } 358522f2a2efSAndy Whitcroft 358656e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 358756e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 358856e77d70SJoe Perches WARN("HOTPLUG_SECTION", 358956e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 359056e77d70SJoe Perches } 359156e77d70SJoe Perches 35929c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 35932b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 35942b474a1aSAndy Whitcroft $realline_next); 35953e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 3596ca819864SJoe Perches if ($linenr > $suppress_statement && 35971b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3598170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3599f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3600171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3601171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3602171ae1a4SAndy Whitcroft 36033e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 36043e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 36053e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 36063e469cdcSAndy Whitcroft # until we hit end of it. 36073e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 36083e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 36093e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 36103e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 36113e469cdcSAndy Whitcroft } 3612f74bd194SAndy Whitcroft 36132b474a1aSAndy Whitcroft # Find the real next line. 36142b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 36152b474a1aSAndy Whitcroft if (defined $realline_next && 36162b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 36172b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 36182b474a1aSAndy Whitcroft $realline_next++; 36192b474a1aSAndy Whitcroft } 36202b474a1aSAndy Whitcroft 3621171ae1a4SAndy Whitcroft my $s = $stat; 3622171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3623cf655043SAndy Whitcroft 3624c2fdda0dSAndy Whitcroft # Ignore goto labels. 3625171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3626c2fdda0dSAndy Whitcroft 3627c2fdda0dSAndy Whitcroft # Ignore functions being called 3628171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3629c2fdda0dSAndy Whitcroft 3630463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3631463f2864SAndy Whitcroft 3632c45dcabdSAndy Whitcroft # declarations always start with types 3633d2506586SAndy 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) { 3634c45dcabdSAndy Whitcroft my $type = $1; 3635c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3636c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3637c45dcabdSAndy Whitcroft 36386c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3639a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3640c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3641c2fdda0dSAndy Whitcroft } 36428905a67cSAndy Whitcroft 36436c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 364465863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3645c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 36469c0ca6f9SAndy Whitcroft } 36478905a67cSAndy Whitcroft 36488905a67cSAndy Whitcroft # Check for any sort of function declaration. 36498905a67cSAndy Whitcroft # int foo(something bar, other baz); 36508905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3651171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 36528905a67cSAndy Whitcroft my ($name_len) = length($1); 36538905a67cSAndy Whitcroft 3654cf655043SAndy Whitcroft my $ctx = $s; 3655773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 36568905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3657cf655043SAndy Whitcroft 36588905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3659c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 36608905a67cSAndy Whitcroft 3661c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 36628905a67cSAndy Whitcroft } 36638905a67cSAndy Whitcroft } 36648905a67cSAndy Whitcroft } 36658905a67cSAndy Whitcroft 36669c0ca6f9SAndy Whitcroft } 36679c0ca6f9SAndy Whitcroft 366800df344fSAndy Whitcroft# 366900df344fSAndy Whitcroft# Checks which may be anchored in the context. 367000df344fSAndy Whitcroft# 367100df344fSAndy Whitcroft 367200df344fSAndy Whitcroft# Check for switch () and associated case and default 367300df344fSAndy Whitcroft# statements should be at the same indent. 367400df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 367500df344fSAndy Whitcroft my $err = ''; 367600df344fSAndy Whitcroft my $sep = ''; 367700df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 367800df344fSAndy Whitcroft shift(@ctx); 367900df344fSAndy Whitcroft for my $ctx (@ctx) { 368000df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 368100df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 368200df344fSAndy Whitcroft $indent != $cindent) { 368300df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 368400df344fSAndy Whitcroft $sep = ''; 368500df344fSAndy Whitcroft } else { 368600df344fSAndy Whitcroft $sep = "[...]\n"; 368700df344fSAndy Whitcroft } 368800df344fSAndy Whitcroft } 368900df344fSAndy Whitcroft if ($err ne '') { 3690000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3691000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3692de7d4f0eSAndy Whitcroft } 3693de7d4f0eSAndy Whitcroft } 3694de7d4f0eSAndy Whitcroft 3695de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3696de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 36970fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3698773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3699773647a0SAndy Whitcroft 37009c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 37018eef05ddSJoe Perches 37028eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 37038eef05ddSJoe Perches WARN("DEEP_INDENTATION", 37048eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 37058eef05ddSJoe Perches } 37068eef05ddSJoe Perches 3707de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3708de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3709de7d4f0eSAndy Whitcroft 3710548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3711548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3712de7d4f0eSAndy Whitcroft 3713548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3714548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3715548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3716548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3717548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3718773647a0SAndy Whitcroft $ctx_ln++; 3719773647a0SAndy Whitcroft } 3720548596d5SAndy Whitcroft 372153210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 372253210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3723773647a0SAndy Whitcroft 3724773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3725000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3726000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 372701464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 372800df344fSAndy Whitcroft } 3729773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3730773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3731773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3732773647a0SAndy Whitcroft { 37339c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 37349c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3735000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3736000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 373701464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 37389c0ca6f9SAndy Whitcroft } 37399c0ca6f9SAndy Whitcroft } 374000df344fSAndy Whitcroft } 374100df344fSAndy Whitcroft 37424d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 3743f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 37443e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 37453e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 37463e469cdcSAndy Whitcroft if (!defined $stat); 37474d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 37484d001e4dSAndy Whitcroft 37494d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 37504d001e4dSAndy Whitcroft 37519f5af480SJoe Perches # remove inline comments 37529f5af480SJoe Perches $s =~ s/$;/ /g; 37539f5af480SJoe Perches $c =~ s/$;/ /g; 37544d001e4dSAndy Whitcroft 37554d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 37566f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 37576f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 37584d001e4dSAndy Whitcroft 37599f5af480SJoe Perches # Make sure we remove the line prefixes as we have 37609f5af480SJoe Perches # none on the first line, and are going to readd them 37619f5af480SJoe Perches # where necessary. 37629f5af480SJoe Perches $s =~ s/\n./\n/gs; 37639f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 37649f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 37659f5af480SJoe Perches } 37669f5af480SJoe Perches 37674d001e4dSAndy Whitcroft # We want to check the first line inside the block 37684d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 37694d001e4dSAndy Whitcroft # 1) any blank line termination 37704d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 37714d001e4dSAndy Whitcroft # 3) any do (...) { 37724d001e4dSAndy Whitcroft my $continuation = 0; 37734d001e4dSAndy Whitcroft my $check = 0; 37744d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 37754d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 37764d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 37774d001e4dSAndy Whitcroft $continuation = 1; 37784d001e4dSAndy Whitcroft } 37799bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 37804d001e4dSAndy Whitcroft $check = 1; 37814d001e4dSAndy Whitcroft $cond_lines++; 37824d001e4dSAndy Whitcroft } 37834d001e4dSAndy Whitcroft 37844d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 37854d001e4dSAndy Whitcroft # preprocessor statement. 37864d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 37874d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 37884d001e4dSAndy Whitcroft $check = 0; 37894d001e4dSAndy Whitcroft } 37904d001e4dSAndy Whitcroft 37919bd49efeSAndy Whitcroft my $cond_ptr = -1; 3792740504c6SAndy Whitcroft $continuation = 0; 37939bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 37949bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 37954d001e4dSAndy Whitcroft 3796f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3797f16fa28fSAndy Whitcroft # is not linear. 3798f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3799f16fa28fSAndy Whitcroft $check = 0; 3800f16fa28fSAndy Whitcroft } 3801f16fa28fSAndy Whitcroft 38029bd49efeSAndy Whitcroft # Ignore: 38039bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 38049bd49efeSAndy Whitcroft # 2) preprocessor lines, and 38059bd49efeSAndy Whitcroft # 3) labels. 3806740504c6SAndy Whitcroft if ($continuation || 3807740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 38089bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 38099bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3810740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 381130dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 38129bd49efeSAndy Whitcroft $cond_lines++; 38139bd49efeSAndy Whitcroft } 38144d001e4dSAndy Whitcroft } 381530dad6ebSAndy Whitcroft } 38164d001e4dSAndy Whitcroft 38174d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 38184d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 38194d001e4dSAndy Whitcroft 38204d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 38214d001e4dSAndy Whitcroft # this is not this patch's fault. 38224d001e4dSAndy Whitcroft if (!defined($stat_real) || 38234d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 38244d001e4dSAndy Whitcroft $check = 0; 38254d001e4dSAndy Whitcroft } 38264d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 38274d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 38284d001e4dSAndy Whitcroft } 38294d001e4dSAndy Whitcroft 38309bd49efeSAndy 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"; 38314d001e4dSAndy Whitcroft 38329f5af480SJoe Perches if ($check && $s ne '' && 3833713a09deSAntonio Borneo (($sindent % $tabsize) != 0 || 38349f5af480SJoe Perches ($sindent < $indent) || 3835f6950a73SJoe Perches ($sindent == $indent && 3836f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 3837713a09deSAntonio Borneo ($sindent > $indent + $tabsize))) { 3838000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3839000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 38404d001e4dSAndy Whitcroft } 38414d001e4dSAndy Whitcroft } 38424d001e4dSAndy Whitcroft 38436c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 38446c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 38451f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 38461f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 38476c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3848c2fdda0dSAndy Whitcroft if ($dbg_values) { 3849c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3850cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3851cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 38521f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3853c2fdda0dSAndy Whitcroft } 38546c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 38556c72ffaaSAndy Whitcroft 385600df344fSAndy Whitcroft#ignore lines not being added 38573705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 385800df344fSAndy Whitcroft 385911ca40a0SJoe Perches# check for dereferences that span multiple lines 386011ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 386111ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 386211ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 386311ca40a0SJoe Perches my $ref = $1; 386411ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 386511ca40a0SJoe Perches $ref .= $1; 386611ca40a0SJoe Perches $ref =~ s/\s//g; 386711ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 386811ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 386911ca40a0SJoe Perches } 387011ca40a0SJoe Perches 3871a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3872c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3873a1ce18e4SJoe Perches my $type = $1; 3874a1ce18e4SJoe Perches my $var = $2; 3875207a8e84SJoe Perches $var = "" if (!defined $var); 3876207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3877a1ce18e4SJoe Perches my $sign = $1; 3878a1ce18e4SJoe Perches my $pointer = $2; 3879a1ce18e4SJoe Perches 3880a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3881a1ce18e4SJoe Perches 3882a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3883a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3884a1ce18e4SJoe Perches $fix) { 3885a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3886207a8e84SJoe Perches my $comp_pointer = $pointer; 3887207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 3888207a8e84SJoe Perches $decl .= $comp_pointer; 3889207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 3890207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 3891a1ce18e4SJoe Perches } 3892a1ce18e4SJoe Perches } 3893a1ce18e4SJoe Perches } 3894a1ce18e4SJoe Perches 3895653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 38967429c690SAndy Whitcroft if ($dbg_type) { 38977429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3898000d1cc1SJoe Perches ERROR("TEST_TYPE", 3899000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 39007429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3901000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3902000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 39037429c690SAndy Whitcroft } 3904653d4876SAndy Whitcroft next; 3905653d4876SAndy Whitcroft } 3906a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3907a1ef277eSAndy Whitcroft if ($dbg_attr) { 39089360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3909000d1cc1SJoe Perches ERROR("TEST_ATTR", 3910000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 39119360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3912000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3913000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3914a1ef277eSAndy Whitcroft } 3915a1ef277eSAndy Whitcroft next; 3916a1ef277eSAndy Whitcroft } 3917653d4876SAndy Whitcroft 3918f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 391999423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 392099423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3921d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3922d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3923f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3924f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3925f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3926d752fcc8SJoe Perches my $fixedline = $prevrawline; 3927d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3928f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3929d752fcc8SJoe Perches $fixedline = $line; 39308d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 3931f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3932d752fcc8SJoe Perches } 3933f0a594c1SAndy Whitcroft } 3934f0a594c1SAndy Whitcroft 393500df344fSAndy Whitcroft# 393600df344fSAndy Whitcroft# Checks which are anchored on the added line. 393700df344fSAndy Whitcroft# 393800df344fSAndy Whitcroft 3939653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3940c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3941653d4876SAndy Whitcroft my $path = $1; 3942653d4876SAndy Whitcroft if ($path =~ m{//}) { 3943000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3944495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3945495e9d84SJoe Perches } 3946495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3947495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3948495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3949653d4876SAndy Whitcroft } 3950653d4876SAndy Whitcroft } 3951653d4876SAndy Whitcroft 395200df344fSAndy Whitcroft# no C99 // comments 395300df344fSAndy Whitcroft if ($line =~ m{//}) { 39543705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 39553705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 39563705ce5bSJoe Perches $fix) { 3957194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 39583705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 39593705ce5bSJoe Perches my $comment = trim($1); 3960194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 39613705ce5bSJoe Perches } 39623705ce5bSJoe Perches } 396300df344fSAndy Whitcroft } 396400df344fSAndy Whitcroft # Remove C99 comments. 39650a920b5bSAndy Whitcroft $line =~ s@//.*@@; 39666c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 39670a920b5bSAndy Whitcroft 39682b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 39692b474a1aSAndy Whitcroft# the whole statement. 39702b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 39712b474a1aSAndy Whitcroft if (defined $realline_next && 39722b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 39732b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 39742b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 39752b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 39763cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 39773cbf62dfSAndy Whitcroft # a prefix: 39783cbf62dfSAndy Whitcroft # XXX(foo); 39793cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3980653d4876SAndy Whitcroft my $name = $1; 398187a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 39823cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 39833cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 39843cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 39853cbf62dfSAndy Whitcroft 39863cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 39872b474a1aSAndy Whitcroft \n.}\s*$| 398848012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 398948012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 399048012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 39912b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 39922b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 399348012058SAndy Whitcroft )/x) { 39942b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 39952b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 39962b474a1aSAndy Whitcroft } else { 39972b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 39980a920b5bSAndy Whitcroft } 39990a920b5bSAndy Whitcroft } 40002b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 40012b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 40022b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 40032b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 40042b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 40052b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 40062b474a1aSAndy Whitcroft } 40072b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 40082b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 4009000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 4010000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 40112b474a1aSAndy Whitcroft } 40120a920b5bSAndy Whitcroft 40135150bda4SJoe Eloff# check for global initialisers. 40146d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 4015d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 40166d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 4017d5e616fcSJoe Perches $fix) { 40186d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 4019d5e616fcSJoe Perches } 4020f0a594c1SAndy Whitcroft } 40210a920b5bSAndy Whitcroft# check for static initialisers. 40226d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 4023d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 40246d32f7a3SJoe Perches "do not initialise statics to $1\n" . 4025d5e616fcSJoe Perches $herecurr) && 4026d5e616fcSJoe Perches $fix) { 40276d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 4028d5e616fcSJoe Perches } 40290a920b5bSAndy Whitcroft } 40300a920b5bSAndy Whitcroft 40311813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 40321813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 40331813087dSJoe Perches my $tmp = trim($1); 40341813087dSJoe Perches WARN("MISORDERED_TYPE", 40351813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 40361813087dSJoe Perches } 40371813087dSJoe Perches 4038809e082eSJoe Perches# check for unnecessary <signed> int declarations of short/long/long long 4039809e082eSJoe Perches while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) { 4040809e082eSJoe Perches my $type = trim($1); 4041809e082eSJoe Perches next if ($type !~ /\bint\b/); 4042809e082eSJoe Perches next if ($type !~ /\b(?:short|long\s+long|long)\b/); 4043809e082eSJoe Perches my $new_type = $type; 4044809e082eSJoe Perches $new_type =~ s/\b\s*int\s*\b/ /; 4045809e082eSJoe Perches $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /; 4046809e082eSJoe Perches $new_type =~ s/^const\s+//; 4047809e082eSJoe Perches $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/); 4048809e082eSJoe Perches $new_type = "const $new_type" if ($type =~ /^const\b/); 4049809e082eSJoe Perches $new_type =~ s/\s+/ /g; 4050809e082eSJoe Perches $new_type = trim($new_type); 4051809e082eSJoe Perches if (WARN("UNNECESSARY_INT", 4052809e082eSJoe Perches "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) && 4053809e082eSJoe Perches $fix) { 4054809e082eSJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/; 4055809e082eSJoe Perches } 4056809e082eSJoe Perches } 4057809e082eSJoe Perches 4058cb710ecaSJoe Perches# check for static const char * arrays. 4059cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 4060000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4061000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 4062cb710ecaSJoe Perches $herecurr); 4063cb710ecaSJoe Perches } 4064cb710ecaSJoe Perches 406577b8c0a8SJoe Perches# check for initialized const char arrays that should be static const 406677b8c0a8SJoe Perches if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) { 406777b8c0a8SJoe Perches if (WARN("STATIC_CONST_CHAR_ARRAY", 406877b8c0a8SJoe Perches "const array should probably be static const\n" . $herecurr) && 406977b8c0a8SJoe Perches $fix) { 407077b8c0a8SJoe Perches $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/; 407177b8c0a8SJoe Perches } 407277b8c0a8SJoe Perches } 407377b8c0a8SJoe Perches 4074cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 4075cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 4076000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 4077000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 4078cb710ecaSJoe Perches $herecurr); 4079cb710ecaSJoe Perches } 4080cb710ecaSJoe Perches 4081ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 4082ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 4083ab7e23f3SJoe Perches my $found = $1; 4084ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 4085ab7e23f3SJoe Perches WARN("CONST_CONST", 4086ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 4087ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 4088ab7e23f3SJoe Perches WARN("CONST_CONST", 4089ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 4090ab7e23f3SJoe Perches } 4091ab7e23f3SJoe Perches } 4092ab7e23f3SJoe Perches 40939b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 40949b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 40959b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 40969b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 40979b0fa60dSJoe Perches $herecurr); 40989b0fa60dSJoe Perches } 40999b0fa60dSJoe Perches 4100b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 4101b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 4102b598b670SJoe Perches my $array = $1; 4103b598b670SJoe 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*\))@) { 4104b598b670SJoe Perches my $array_div = $1; 4105b598b670SJoe Perches if (WARN("ARRAY_SIZE", 4106b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 4107b598b670SJoe Perches $fix) { 4108b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 4109b598b670SJoe Perches } 4110b598b670SJoe Perches } 4111b598b670SJoe Perches } 4112b598b670SJoe Perches 4113b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 411416b7f3c8SJoe Perches if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) { 4115b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 4116b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 4117b36190c5SJoe Perches $fix) { 4118194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 4119b36190c5SJoe Perches } 4120b36190c5SJoe Perches } 4121b36190c5SJoe Perches 4122653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 4123653d4876SAndy Whitcroft# make sense. 4124653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 41258054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 4126c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 41278ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 412846d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 4129000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 4130000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 41310a920b5bSAndy Whitcroft } 41320a920b5bSAndy Whitcroft 41330a920b5bSAndy Whitcroft# * goes on variable not on type 413465863862SAndy Whitcroft # (char*[ const]) 4135bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 4136bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 41373705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 4138d8aaf121SAndy Whitcroft 413965863862SAndy Whitcroft # Should start with a space. 414065863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 414165863862SAndy Whitcroft # Should not end with a space. 414265863862SAndy Whitcroft $to =~ s/\s+$//; 414365863862SAndy Whitcroft # '*'s should not have spaces between. 4144f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 414565863862SAndy Whitcroft } 4146d8aaf121SAndy Whitcroft 41473705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 414865863862SAndy Whitcroft if ($from ne $to) { 41493705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 41503705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 41513705ce5bSJoe Perches $fix) { 41523705ce5bSJoe Perches my $sub_from = $ident; 41533705ce5bSJoe Perches my $sub_to = $ident; 41543705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4155194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41563705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 41573705ce5bSJoe Perches } 415865863862SAndy Whitcroft } 4159bfcb2cc7SAndy Whitcroft } 4160bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 4161bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 41623705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 4163d8aaf121SAndy Whitcroft 416465863862SAndy Whitcroft # Should start with a space. 416565863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 416665863862SAndy Whitcroft # Should not end with a space. 416765863862SAndy Whitcroft $to =~ s/\s+$//; 416865863862SAndy Whitcroft # '*'s should not have spaces between. 4169f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 417065863862SAndy Whitcroft } 417165863862SAndy Whitcroft # Modifiers should have spaces. 417265863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 417365863862SAndy Whitcroft 41743705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 4175667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 41763705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 41773705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 41783705ce5bSJoe Perches $fix) { 41793705ce5bSJoe Perches 41803705ce5bSJoe Perches my $sub_from = $match; 41813705ce5bSJoe Perches my $sub_to = $match; 41823705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4183194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41843705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 41853705ce5bSJoe Perches } 418665863862SAndy Whitcroft } 41870a920b5bSAndy Whitcroft } 41880a920b5bSAndy Whitcroft 41899d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 41909d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 41910675a8fbSJean Delvare my $msg_level = \&WARN; 41920675a8fbSJean Delvare $msg_level = \&CHK if ($file); 41930675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 41949d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 41959d3e3c70SJoe Perches } 41960a920b5bSAndy Whitcroft 41979d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 41988905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 4199000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 4200000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 42018905a67cSAndy Whitcroft } 42028905a67cSAndy Whitcroft 420317441227SJoe Perches# check for uses of printk_ratelimit 420417441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 4205000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 4206000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 420717441227SJoe Perches } 420817441227SJoe Perches 4209eeef5733SJoe Perches# printk should use KERN_* levels 4210eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 4211000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 4212eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 421300df344fSAndy Whitcroft } 42140a920b5bSAndy Whitcroft 4215243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 4216243f3803SJoe Perches my $orig = $1; 4217243f3803SJoe Perches my $level = lc($orig); 4218243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 42198f26b837SJoe Perches my $level2 = $level; 42208f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 4221243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 4222daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 4223243f3803SJoe Perches } 4224243f3803SJoe Perches 4225dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 4226dc139313SJoe Perches my $orig = $1; 4227dc139313SJoe Perches my $level = lc($orig); 4228dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 4229dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 4230dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 4231dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 4232dc139313SJoe Perches } 4233dc139313SJoe Perches 423491c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 423591c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 423691c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 423791c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 423891c9afafSAndy Lutomirski WARN("ENOSYS", 423991c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 424091c9afafSAndy Lutomirski } 424191c9afafSAndy Lutomirski 42426b9ea5ffSJakub Kicinski# ENOTSUPP is not a standard error code and should be avoided in new patches. 42436b9ea5ffSJakub Kicinski# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP. 42446b9ea5ffSJakub Kicinski# Similarly to ENOSYS warning a small number of false positives is expected. 42456b9ea5ffSJakub Kicinski if (!$file && $line =~ /\bENOTSUPP\b/) { 42466b9ea5ffSJakub Kicinski if (WARN("ENOTSUPP", 42476b9ea5ffSJakub Kicinski "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) && 42486b9ea5ffSJakub Kicinski $fix) { 42496b9ea5ffSJakub Kicinski $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/; 42506b9ea5ffSJakub Kicinski } 42516b9ea5ffSJakub Kicinski } 42526b9ea5ffSJakub Kicinski 4253653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 4254653d4876SAndy Whitcroft# or if closed on same line 42555b57980dSJoe Perches if ($perl_version_ok && 42562d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 42572d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 42582d453e3bSJoe Perches $sline !~ /}/) { 42598d182478SJoe Perches if (ERROR("OPEN_BRACE", 42602d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 42618d182478SJoe Perches $fix) { 42628d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 42638d182478SJoe Perches my $fixed_line = $rawline; 42648d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 42658d182478SJoe Perches my $line1 = $1; 42668d182478SJoe Perches my $line2 = $2; 42678d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 42688d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 42698d182478SJoe Perches if ($line2 !~ /^\s*$/) { 42708d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 42718d182478SJoe Perches } 42728d182478SJoe Perches } 42730a920b5bSAndy Whitcroft } 4274653d4876SAndy Whitcroft 42758905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 42768905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 42778905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 42788d182478SJoe Perches if (ERROR("OPEN_BRACE", 42798d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 42808d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 42818d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 42828d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 42838d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 42848d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 42858d182478SJoe Perches $fixedline = $rawline; 42868d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 42878d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 42888d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 42898d182478SJoe Perches } 42908d182478SJoe Perches } 42918905a67cSAndy Whitcroft } 42928905a67cSAndy Whitcroft 42930c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 42943705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 42953705ce5bSJoe Perches if (WARN("SPACING", 42963705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 42973705ce5bSJoe Perches $fix) { 4298194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42993705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 43003705ce5bSJoe Perches } 43010c73b4ebSAndy Whitcroft } 43020c73b4ebSAndy Whitcroft 430331070b5dSJoe Perches# Function pointer declarations 430431070b5dSJoe Perches# check spacing between type, funcptr, and args 430531070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 430691f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 430731070b5dSJoe Perches my $declare = $1; 430831070b5dSJoe Perches my $pre_pointer_space = $2; 430931070b5dSJoe Perches my $post_pointer_space = $3; 431031070b5dSJoe Perches my $funcname = $4; 431131070b5dSJoe Perches my $post_funcname_space = $5; 431231070b5dSJoe Perches my $pre_args_space = $6; 431331070b5dSJoe Perches 431491f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 431591f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 431691f72e9cSJoe Perches# don't need a space so don't warn for those. 431791f72e9cSJoe Perches my $post_declare_space = ""; 431891f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 431991f72e9cSJoe Perches $post_declare_space = $1; 432091f72e9cSJoe Perches $declare = rtrim($declare); 432191f72e9cSJoe Perches } 432291f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 432331070b5dSJoe Perches WARN("SPACING", 432431070b5dSJoe Perches "missing space after return type\n" . $herecurr); 432591f72e9cSJoe Perches $post_declare_space = " "; 432631070b5dSJoe Perches } 432731070b5dSJoe Perches 432831070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 432991f72e9cSJoe Perches# This test is not currently implemented because these declarations are 433091f72e9cSJoe Perches# equivalent to 433191f72e9cSJoe Perches# int foo(int bar, ...) 433291f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 433391f72e9cSJoe Perches# 433491f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 433591f72e9cSJoe Perches# WARN("SPACING", 433691f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 433791f72e9cSJoe Perches# } 433831070b5dSJoe Perches 433931070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 434031070b5dSJoe Perches if (defined $pre_pointer_space && 434131070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 434231070b5dSJoe Perches WARN("SPACING", 434331070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 434431070b5dSJoe Perches } 434531070b5dSJoe Perches 434631070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 434731070b5dSJoe Perches if (defined $post_pointer_space && 434831070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 434931070b5dSJoe Perches WARN("SPACING", 435031070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 435131070b5dSJoe Perches } 435231070b5dSJoe Perches 435331070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 435431070b5dSJoe Perches if (defined $post_funcname_space && 435531070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 435631070b5dSJoe Perches WARN("SPACING", 435731070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 435831070b5dSJoe Perches } 435931070b5dSJoe Perches 436031070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 436131070b5dSJoe Perches if (defined $pre_args_space && 436231070b5dSJoe Perches $pre_args_space =~ /^\s/) { 436331070b5dSJoe Perches WARN("SPACING", 436431070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 436531070b5dSJoe Perches } 436631070b5dSJoe Perches 436731070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4368194f66fcSJoe Perches $fixed[$fixlinenr] =~ 436991f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 437031070b5dSJoe Perches } 437131070b5dSJoe Perches } 437231070b5dSJoe Perches 43738d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 43748d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4375fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4376fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 43778d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 43788d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 43798d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4380fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 438138dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 43823705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 43833705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 43843705ce5bSJoe Perches $fix) { 4385194f66fcSJoe Perches $fixed[$fixlinenr] =~ 43863705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 43873705ce5bSJoe Perches } 43888d31cfceSAndy Whitcroft } 43898d31cfceSAndy Whitcroft } 43908d31cfceSAndy Whitcroft 4391f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 43926c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4393c2fdda0dSAndy Whitcroft my $name = $1; 4394773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4395773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4396c2fdda0dSAndy Whitcroft 4397c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4398773647a0SAndy Whitcroft if ($name =~ /^(?: 4399773647a0SAndy Whitcroft if|for|while|switch|return|case| 4400773647a0SAndy Whitcroft volatile|__volatile__| 4401773647a0SAndy Whitcroft __attribute__|format|__extension__| 4402773647a0SAndy Whitcroft asm|__asm__)$/x) 4403773647a0SAndy Whitcroft { 4404c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4405c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4406c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4407c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4408773647a0SAndy Whitcroft 4409773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4410c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4411c2fdda0dSAndy Whitcroft 4412c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4413c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4414773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4415c2fdda0dSAndy Whitcroft 4416c2fdda0dSAndy Whitcroft } else { 44173705ce5bSJoe Perches if (WARN("SPACING", 44183705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 44193705ce5bSJoe Perches $fix) { 4420194f66fcSJoe Perches $fixed[$fixlinenr] =~ 44213705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 44223705ce5bSJoe Perches } 4423f0a594c1SAndy Whitcroft } 44246c72ffaaSAndy Whitcroft } 44259a4cad4eSEric Nelson 4426653d4876SAndy Whitcroft# Check operator spacing. 44270a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 44283705ce5bSJoe Perches my $fixed_line = ""; 44293705ce5bSJoe Perches my $line_fixed = 0; 44303705ce5bSJoe Perches 44319c0ca6f9SAndy Whitcroft my $ops = qr{ 44329c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 44339c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 44349c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 44351f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 443684731623SJoe Perches \?:|\?|: 44379c0ca6f9SAndy Whitcroft }x; 4438cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 44393705ce5bSJoe Perches 44403705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 44413705ce5bSJoe Perches## foreach my $el (@elements) { 44423705ce5bSJoe Perches## print("el: <$el>\n"); 44433705ce5bSJoe Perches## } 44443705ce5bSJoe Perches 44453705ce5bSJoe Perches my @fix_elements = (); 444600df344fSAndy Whitcroft my $off = 0; 44476c72ffaaSAndy Whitcroft 44483705ce5bSJoe Perches foreach my $el (@elements) { 44493705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 44503705ce5bSJoe Perches $off += length($el); 44513705ce5bSJoe Perches } 44523705ce5bSJoe Perches 44533705ce5bSJoe Perches $off = 0; 44543705ce5bSJoe Perches 44556c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4456b34c648bSJoe Perches my $last_after = -1; 44576c72ffaaSAndy Whitcroft 44580a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 44593705ce5bSJoe Perches 44603705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 44613705ce5bSJoe Perches 44623705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 44633705ce5bSJoe Perches 44644a0df2efSAndy Whitcroft $off += length($elements[$n]); 44654a0df2efSAndy Whitcroft 446625985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4467773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4468773647a0SAndy Whitcroft my $cc = ''; 4469773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4470773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4471773647a0SAndy Whitcroft } 4472773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4473773647a0SAndy Whitcroft 44744a0df2efSAndy Whitcroft my $a = ''; 44754a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 44764a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4477cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 44784a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 44794a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 4480773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 44814a0df2efSAndy Whitcroft 44820a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 44834a0df2efSAndy Whitcroft 44844a0df2efSAndy Whitcroft my $c = ''; 44850a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 44864a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 44874a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4488cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 44894a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 44904a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 44918b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 44924a0df2efSAndy Whitcroft } else { 44934a0df2efSAndy Whitcroft $c = 'E'; 44940a920b5bSAndy Whitcroft } 44950a920b5bSAndy Whitcroft 44964a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 44974a0df2efSAndy Whitcroft 44984a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 44994a0df2efSAndy Whitcroft 45006c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 4501de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 45020a920b5bSAndy Whitcroft 450374048ed8SAndy Whitcroft # Pull out the value of this operator. 45046c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 45050a920b5bSAndy Whitcroft 45061f65f947SAndy Whitcroft # Get the full operator variant. 45071f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 45081f65f947SAndy Whitcroft 450913214adfSAndy Whitcroft # Ignore operators passed as parameters. 451013214adfSAndy Whitcroft if ($op_type ne 'V' && 4511d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 451213214adfSAndy Whitcroft 4513cf655043SAndy Whitcroft# # Ignore comments 4514cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 451513214adfSAndy Whitcroft 4516d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 451713214adfSAndy Whitcroft } elsif ($op eq ';') { 4518cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 4519cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 45203705ce5bSJoe Perches if (ERROR("SPACING", 45213705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 4522b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 45233705ce5bSJoe Perches $line_fixed = 1; 45243705ce5bSJoe Perches } 4525d8aaf121SAndy Whitcroft } 4526d8aaf121SAndy Whitcroft 4527d8aaf121SAndy Whitcroft # // is a comment 4528d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 45290a920b5bSAndy Whitcroft 4530b00e4814SJoe Perches # : when part of a bitfield 4531b00e4814SJoe Perches } elsif ($opv eq ':B') { 4532b00e4814SJoe Perches # skip the bitfield test for now 4533b00e4814SJoe Perches 45341f65f947SAndy Whitcroft # No spaces for: 45351f65f947SAndy Whitcroft # -> 4536b00e4814SJoe Perches } elsif ($op eq '->') { 45374a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 45383705ce5bSJoe Perches if (ERROR("SPACING", 45393705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4540b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 45413705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 45423705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 45433705ce5bSJoe Perches } 4544b34c648bSJoe Perches $line_fixed = 1; 45453705ce5bSJoe Perches } 45460a920b5bSAndy Whitcroft } 45470a920b5bSAndy Whitcroft 45482381097bSJoe Perches # , must not have a space before and must have a space on the right. 45490a920b5bSAndy Whitcroft } elsif ($op eq ',') { 45502381097bSJoe Perches my $rtrim_before = 0; 45512381097bSJoe Perches my $space_after = 0; 45522381097bSJoe Perches if ($ctx =~ /Wx./) { 45532381097bSJoe Perches if (ERROR("SPACING", 45542381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 45552381097bSJoe Perches $line_fixed = 1; 45562381097bSJoe Perches $rtrim_before = 1; 45572381097bSJoe Perches } 45582381097bSJoe Perches } 4559cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 45603705ce5bSJoe Perches if (ERROR("SPACING", 45613705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 45623705ce5bSJoe Perches $line_fixed = 1; 4563b34c648bSJoe Perches $last_after = $n; 45642381097bSJoe Perches $space_after = 1; 45652381097bSJoe Perches } 45662381097bSJoe Perches } 45672381097bSJoe Perches if ($rtrim_before || $space_after) { 45682381097bSJoe Perches if ($rtrim_before) { 45692381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 45702381097bSJoe Perches } else { 45712381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 45722381097bSJoe Perches } 45732381097bSJoe Perches if ($space_after) { 45742381097bSJoe Perches $good .= " "; 45753705ce5bSJoe Perches } 45760a920b5bSAndy Whitcroft } 45770a920b5bSAndy Whitcroft 45789c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 457974048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 45809c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 45819c0ca6f9SAndy Whitcroft 45829c0ca6f9SAndy Whitcroft # unary operators should have a space before and 45839c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 45849c0ca6f9SAndy Whitcroft # unary operator, or a cast 45859c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 458674048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 45870d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4588cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 45893705ce5bSJoe Perches if (ERROR("SPACING", 45903705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4591b34c648bSJoe Perches if ($n != $last_after + 2) { 4592b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 45933705ce5bSJoe Perches $line_fixed = 1; 45943705ce5bSJoe Perches } 45950a920b5bSAndy Whitcroft } 4596b34c648bSJoe Perches } 4597a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4598171ae1a4SAndy Whitcroft # A unary '*' may be const 4599171ae1a4SAndy Whitcroft 4600171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 46013705ce5bSJoe Perches if (ERROR("SPACING", 46023705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4603b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 46043705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 46053705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 46063705ce5bSJoe Perches } 4607b34c648bSJoe Perches $line_fixed = 1; 46083705ce5bSJoe Perches } 46090a920b5bSAndy Whitcroft } 46100a920b5bSAndy Whitcroft 46110a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 46120a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4613773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 46143705ce5bSJoe Perches if (ERROR("SPACING", 46153705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4616b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 46173705ce5bSJoe Perches $line_fixed = 1; 46183705ce5bSJoe Perches } 46190a920b5bSAndy Whitcroft } 4620773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4621773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 46223705ce5bSJoe Perches if (ERROR("SPACING", 46233705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4624b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 46253705ce5bSJoe Perches $line_fixed = 1; 46263705ce5bSJoe Perches } 4627653d4876SAndy Whitcroft } 4628773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 46293705ce5bSJoe Perches if (ERROR("SPACING", 46303705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4631b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 46323705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 46333705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4634773647a0SAndy Whitcroft } 4635b34c648bSJoe Perches $line_fixed = 1; 46363705ce5bSJoe Perches } 46373705ce5bSJoe Perches } 46380a920b5bSAndy Whitcroft 46390a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 46409c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 46419c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 46429c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4643c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4644c2fdda0dSAndy Whitcroft $op eq '%') 46450a920b5bSAndy Whitcroft { 4646d2e025f3SJoe Perches if ($check) { 4647d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4648d2e025f3SJoe Perches if (CHK("SPACING", 4649d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4650d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4651d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4652d2e025f3SJoe Perches $line_fixed = 1; 4653d2e025f3SJoe Perches } 4654d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4655d2e025f3SJoe Perches if (CHK("SPACING", 4656d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4657d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4658d2e025f3SJoe Perches $line_fixed = 1; 4659d2e025f3SJoe Perches } 4660d2e025f3SJoe Perches } 4661d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 46623705ce5bSJoe Perches if (ERROR("SPACING", 46633705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4664b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4665b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4666b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4667b34c648bSJoe Perches } 46683705ce5bSJoe Perches $line_fixed = 1; 46693705ce5bSJoe Perches } 46700a920b5bSAndy Whitcroft } 46710a920b5bSAndy Whitcroft 46721f65f947SAndy Whitcroft # A colon needs no spaces before when it is 46731f65f947SAndy Whitcroft # terminating a case value or a label. 46741f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 46751f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 46763705ce5bSJoe Perches if (ERROR("SPACING", 46773705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4678b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 46793705ce5bSJoe Perches $line_fixed = 1; 46803705ce5bSJoe Perches } 46811f65f947SAndy Whitcroft } 46821f65f947SAndy Whitcroft 46830a920b5bSAndy Whitcroft # All the others need spaces both sides. 4684cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 46851f65f947SAndy Whitcroft my $ok = 0; 46861f65f947SAndy Whitcroft 468722f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 46881f65f947SAndy Whitcroft if (($op eq '<' && 46891f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 46901f65f947SAndy Whitcroft ($op eq '>' && 46911f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 46921f65f947SAndy Whitcroft { 46931f65f947SAndy Whitcroft $ok = 1; 46941f65f947SAndy Whitcroft } 46951f65f947SAndy Whitcroft 4696e0df7e1fSJoe Perches # for asm volatile statements 4697e0df7e1fSJoe Perches # ignore a colon with another 4698e0df7e1fSJoe Perches # colon immediately before or after 4699e0df7e1fSJoe Perches if (($op eq ':') && 4700e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4701e0df7e1fSJoe Perches $ok = 1; 4702e0df7e1fSJoe Perches } 4703e0df7e1fSJoe Perches 470484731623SJoe Perches # messages are ERROR, but ?: are CHK 47051f65f947SAndy Whitcroft if ($ok == 0) { 47060675a8fbSJean Delvare my $msg_level = \&ERROR; 47070675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 470884731623SJoe Perches 47090675a8fbSJean Delvare if (&{$msg_level}("SPACING", 47103705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4711b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4712b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4713b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4714b34c648bSJoe Perches } 47153705ce5bSJoe Perches $line_fixed = 1; 47163705ce5bSJoe Perches } 47170a920b5bSAndy Whitcroft } 471822f2a2efSAndy Whitcroft } 47194a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 47203705ce5bSJoe Perches 47213705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 47223705ce5bSJoe Perches 47233705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 47240a920b5bSAndy Whitcroft } 47253705ce5bSJoe Perches 47263705ce5bSJoe Perches if (($#elements % 2) == 0) { 47273705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 47283705ce5bSJoe Perches } 47293705ce5bSJoe Perches 4730194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4731194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 47323705ce5bSJoe Perches } 47333705ce5bSJoe Perches 47343705ce5bSJoe Perches 47350a920b5bSAndy Whitcroft } 47360a920b5bSAndy Whitcroft 4737786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4738d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4739786b6326SJoe Perches if (WARN("SPACING", 4740786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4741786b6326SJoe Perches $fix) { 4742194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4743786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4744786b6326SJoe Perches } 4745786b6326SJoe Perches } 4746786b6326SJoe Perches 4747f0a594c1SAndy Whitcroft# check for multiple assignments 4748f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4749000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4750000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4751f0a594c1SAndy Whitcroft } 4752f0a594c1SAndy Whitcroft 475322f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 475422f2a2efSAndy Whitcroft## # continuation. 475522f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 475622f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 475722f2a2efSAndy Whitcroft## 475822f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 475922f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 476022f2a2efSAndy Whitcroft## my $ln = $line; 476122f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 476222f2a2efSAndy Whitcroft## } 476322f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4764000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4765000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 476622f2a2efSAndy Whitcroft## } 476722f2a2efSAndy Whitcroft## } 4768f0a594c1SAndy Whitcroft 47690a920b5bSAndy Whitcroft#need space before brace following if, while, etc 47706b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 47716ad724e2SMichal Zylowski $line =~ /\b(?:else|do)\{/) { 47723705ce5bSJoe Perches if (ERROR("SPACING", 47733705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 47743705ce5bSJoe Perches $fix) { 47756ad724e2SMichal Zylowski $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/; 47763705ce5bSJoe Perches } 4777de7d4f0eSAndy Whitcroft } 4778de7d4f0eSAndy Whitcroft 4779c4a62ef9SJoe Perches## # check for blank lines before declarations 4780c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4781c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4782c4a62ef9SJoe Perches## WARN("SPACING", 4783c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4784c4a62ef9SJoe Perches## } 4785c4a62ef9SJoe Perches## 4786c4a62ef9SJoe Perches 4787de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4788de7d4f0eSAndy Whitcroft# on the line 478994fb9845SJoe Perches if ($line =~ /}(?!(?:,|;|\)|\}))\S/) { 4790d5e616fcSJoe Perches if (ERROR("SPACING", 4791d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4792d5e616fcSJoe Perches $fix) { 4793194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4794d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4795d5e616fcSJoe Perches } 47960a920b5bSAndy Whitcroft } 47970a920b5bSAndy Whitcroft 479822f2a2efSAndy Whitcroft# check spacing on square brackets 479922f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 48003705ce5bSJoe Perches if (ERROR("SPACING", 48013705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 48023705ce5bSJoe Perches $fix) { 4803194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48043705ce5bSJoe Perches s/\[\s+/\[/; 48053705ce5bSJoe Perches } 480622f2a2efSAndy Whitcroft } 480722f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 48083705ce5bSJoe Perches if (ERROR("SPACING", 48093705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 48103705ce5bSJoe Perches $fix) { 4811194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48123705ce5bSJoe Perches s/\s+\]/\]/; 48133705ce5bSJoe Perches } 481422f2a2efSAndy Whitcroft } 481522f2a2efSAndy Whitcroft 4816c45dcabdSAndy Whitcroft# check spacing on parentheses 48179c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 48189c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 48193705ce5bSJoe Perches if (ERROR("SPACING", 48203705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 48213705ce5bSJoe Perches $fix) { 4822194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48233705ce5bSJoe Perches s/\(\s+/\(/; 48243705ce5bSJoe Perches } 482522f2a2efSAndy Whitcroft } 482613214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4827c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4828c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 48293705ce5bSJoe Perches if (ERROR("SPACING", 48303705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 48313705ce5bSJoe Perches $fix) { 4832194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48333705ce5bSJoe Perches s/\s+\)/\)/; 48343705ce5bSJoe Perches } 483522f2a2efSAndy Whitcroft } 483622f2a2efSAndy Whitcroft 4837e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4838e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4839e2826fd0SJoe Perches 4840e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4841ea4acbb1SJoe Perches my $var = $1; 4842ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4843ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4844ea4acbb1SJoe Perches $fix) { 4845ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4846ea4acbb1SJoe Perches } 4847ea4acbb1SJoe Perches } 4848ea4acbb1SJoe Perches 4849ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4850ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4851ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4852ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4853ea4acbb1SJoe Perches my $var = $2; 4854ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4855ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4856ea4acbb1SJoe Perches $fix) { 4857ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4858ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4859ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4860ea4acbb1SJoe Perches } 4861e2826fd0SJoe Perches } 4862e2826fd0SJoe Perches 486363b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 4864a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 4865a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 48665b57980dSJoe Perches $perl_version_ok && defined($stat) && 486763b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 486863b7c73eSJoe Perches my $if_stat = $1; 486963b7c73eSJoe Perches my $test = substr($2, 1, -1); 487063b7c73eSJoe Perches my $herectx; 487163b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 487263b7c73eSJoe Perches my $match = $1; 487363b7c73eSJoe Perches # avoid parentheses around potential macro args 487463b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 487563b7c73eSJoe Perches if (!defined($herectx)) { 487663b7c73eSJoe Perches $herectx = $here . "\n"; 487763b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 487863b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 487963b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 488063b7c73eSJoe Perches $herectx .= $rl . "\n"; 488163b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 488263b7c73eSJoe Perches } 488363b7c73eSJoe Perches } 488463b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 488563b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 488663b7c73eSJoe Perches } 488763b7c73eSJoe Perches } 488863b7c73eSJoe Perches 48890a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 48904a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 48910a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 48923705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 48933705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 48943705ce5bSJoe Perches $fix) { 4895194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48963705ce5bSJoe Perches s/^(.)\s+/$1/; 48973705ce5bSJoe Perches } 48980a920b5bSAndy Whitcroft } 48990a920b5bSAndy Whitcroft 49005b9553abSJoe Perches# return is not a function 4901507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4902c45dcabdSAndy Whitcroft my $spacing = $1; 49035b57980dSJoe Perches if ($perl_version_ok && 49045b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 49055b9553abSJoe Perches my $value = $1; 49065b9553abSJoe Perches $value = deparenthesize($value); 49075b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4908000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4909000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 49105b9553abSJoe Perches } 4911c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4912000d1cc1SJoe Perches ERROR("SPACING", 4913000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4914c45dcabdSAndy Whitcroft } 4915c45dcabdSAndy Whitcroft } 4916507e5141SJoe Perches 4917b43ae21bSJoe Perches# unnecessary return in a void function 4918b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4919b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4920b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4921b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4922b43ae21bSJoe Perches $linenr >= 3 && 4923b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4924b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 49259819cf25SJoe Perches WARN("RETURN_VOID", 4926b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 49279819cf25SJoe Perches } 49289819cf25SJoe Perches 4929189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 49305b57980dSJoe Perches if ($perl_version_ok && 4931189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4932189248d8SJoe Perches my $openparens = $1; 4933189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4934189248d8SJoe Perches my $msg = ""; 4935189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4936189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4937189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4938189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4939189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4940189248d8SJoe Perches } 4941189248d8SJoe Perches } 4942189248d8SJoe Perches 4943c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4944c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4945c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4946c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 49475b57980dSJoe Perches if ($perl_version_ok && 4948c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4949c5595fa2SJoe Perches my $lead = $1; 4950c5595fa2SJoe Perches my $const = $2; 4951c5595fa2SJoe Perches my $comp = $3; 4952c5595fa2SJoe Perches my $to = $4; 4953c5595fa2SJoe Perches my $newcomp = $comp; 4954f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 4955c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4956c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4957c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4958c5595fa2SJoe Perches $fix) { 4959c5595fa2SJoe Perches if ($comp eq "<") { 4960c5595fa2SJoe Perches $newcomp = ">"; 4961c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4962c5595fa2SJoe Perches $newcomp = ">="; 4963c5595fa2SJoe Perches } elsif ($comp eq ">") { 4964c5595fa2SJoe Perches $newcomp = "<"; 4965c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4966c5595fa2SJoe Perches $newcomp = "<="; 4967c5595fa2SJoe Perches } 4968c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4969c5595fa2SJoe Perches } 4970c5595fa2SJoe Perches } 4971c5595fa2SJoe Perches 4972f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4973f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 497453a3c448SAndy Whitcroft my $name = $1; 497553a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4976000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4977f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 497853a3c448SAndy Whitcroft } 497953a3c448SAndy Whitcroft } 4980c45dcabdSAndy Whitcroft 49810a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 49824a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 49833705ce5bSJoe Perches if (ERROR("SPACING", 49843705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 49853705ce5bSJoe Perches $fix) { 4986194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49873705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 49883705ce5bSJoe Perches } 49890a920b5bSAndy Whitcroft } 49900a920b5bSAndy Whitcroft 4991f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4992f5fe35ddSAndy Whitcroft# statements after the conditional. 4993170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 49943e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 49953e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 49963e469cdcSAndy Whitcroft if (!defined $stat); 4997170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4998170d3a22SAndy Whitcroft $remain_next, $off_next); 4999170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 5000170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 5001170d3a22SAndy Whitcroft 5002170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 5003170d3a22SAndy Whitcroft # If the statement carries leading newlines, 5004170d3a22SAndy Whitcroft # then count those as offsets. 5005170d3a22SAndy Whitcroft my ($whitespace) = 5006170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 5007170d3a22SAndy Whitcroft my $offset = 5008170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 5009170d3a22SAndy Whitcroft 5010170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 5011170d3a22SAndy Whitcroft $offset} = 1; 5012170d3a22SAndy Whitcroft } 5013170d3a22SAndy Whitcroft } 5014170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 5015c11230f4SJoe Perches defined($stat) && defined($cond) && 5016170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 5017171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 50188905a67cSAndy Whitcroft 5019b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 5020000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 5021000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 50228905a67cSAndy Whitcroft } 50238905a67cSAndy Whitcroft 50248905a67cSAndy Whitcroft # Find out what is on the end of the line after the 50258905a67cSAndy Whitcroft # conditional. 5026773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 50278905a67cSAndy Whitcroft $s =~ s/\n.*//g; 502813214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 502953210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 503053210168SAndy Whitcroft $c !~ /}\s*while\s*/) 5031773647a0SAndy Whitcroft { 5032bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 5033bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 5034bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 503542bdf74cSHidetoshi Seto my $stat_real = ''; 5036bb44ad39SAndy Whitcroft 503742bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 503842bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 5039bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 5040bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 5041bb44ad39SAndy Whitcroft } 5042bb44ad39SAndy Whitcroft 5043000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5044000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 50458905a67cSAndy Whitcroft } 50468905a67cSAndy Whitcroft } 50478905a67cSAndy Whitcroft 504813214adfSAndy Whitcroft# Check for bitwise tests written as boolean 504913214adfSAndy Whitcroft if ($line =~ / 505013214adfSAndy Whitcroft (?: 505113214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 505213214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 505313214adfSAndy Whitcroft (?:\&\&|\|\|) 505413214adfSAndy Whitcroft | 505513214adfSAndy Whitcroft (?:\&\&|\|\|) 505613214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 505713214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 505813214adfSAndy Whitcroft )/x) 505913214adfSAndy Whitcroft { 5060000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 5061000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 506213214adfSAndy Whitcroft } 506313214adfSAndy Whitcroft 50648905a67cSAndy Whitcroft# if and else should not have general statements after it 506513214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 506613214adfSAndy Whitcroft my $s = $1; 506713214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 506813214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 5069000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5070000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 50710a920b5bSAndy Whitcroft } 507213214adfSAndy Whitcroft } 507339667782SAndy Whitcroft# if should not continue a brace 507439667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 5075000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5076048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 507739667782SAndy Whitcroft $herecurr); 507839667782SAndy Whitcroft } 5079a1080bf8SAndy Whitcroft# case and default should not have general statements after them 5080a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 5081a1080bf8SAndy Whitcroft $line !~ /\G(?: 50823fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 5083a1080bf8SAndy Whitcroft \s*return\s+ 5084a1080bf8SAndy Whitcroft )/xg) 5085a1080bf8SAndy Whitcroft { 5086000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 5087000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 5088a1080bf8SAndy Whitcroft } 50890a920b5bSAndy Whitcroft 50900a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 50910a920b5bSAndy Whitcroft # indent level to be relevant to each other. 50928b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 50930a920b5bSAndy Whitcroft $previndent == $indent) { 50948b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 50958b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 50968b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 50978b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 50988b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 50998b8856f4SJoe Perches my $fixedline = $prevrawline; 51008b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 51018b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 51028b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 51038b8856f4SJoe Perches } 51048b8856f4SJoe Perches $fixedline = $rawline; 51058b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 51068b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 51078b8856f4SJoe Perches } 51080a920b5bSAndy Whitcroft } 51090a920b5bSAndy Whitcroft 51108b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 5111c2fdda0dSAndy Whitcroft $previndent == $indent) { 5112c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 5113c2fdda0dSAndy Whitcroft 5114c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 5115c2fdda0dSAndy Whitcroft # conditional. 5116773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 5117c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 5118c2fdda0dSAndy Whitcroft 5119c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 51208b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 51218b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 51228b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 51238b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 51248b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 51258b8856f4SJoe Perches my $fixedline = $prevrawline; 51268b8856f4SJoe Perches my $trailing = $rawline; 51278b8856f4SJoe Perches $trailing =~ s/^\+//; 51288b8856f4SJoe Perches $trailing = trim($trailing); 51298b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 51308b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 51318b8856f4SJoe Perches } 5132c2fdda0dSAndy Whitcroft } 5133c2fdda0dSAndy Whitcroft } 5134c2fdda0dSAndy Whitcroft 513595e2c602SJoe Perches#Specific variable tests 5136323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 5137323c1260SJoe Perches my $var = $1; 513895e2c602SJoe Perches 513995e2c602SJoe Perches#CamelCase 5140807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 5141be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 514222735ce8SJoe Perches#Ignore Page<foo> variants 5143807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 5144d439e6a5SJoe Perches#Ignore SI style variants like nS, mV and dB 5145d439e6a5SJoe Perches#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE) 5146d439e6a5SJoe Perches $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ && 5147f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 5148f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 51497e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 51507e781f67SJoe Perches my $word = $1; 51517e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 5152d8b07710SJoe Perches if ($check) { 5153d8b07710SJoe Perches seed_camelcase_includes(); 5154d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 5155d8b07710SJoe Perches seed_camelcase_file($realfile); 5156d8b07710SJoe Perches $camelcase_file_seeded = 1; 5157d8b07710SJoe Perches } 5158d8b07710SJoe Perches } 51597e781f67SJoe Perches if (!defined $camelcase{$word}) { 51607e781f67SJoe Perches $camelcase{$word} = 1; 5161be79794bSJoe Perches CHK("CAMELCASE", 51627e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 51637e781f67SJoe Perches } 5164323c1260SJoe Perches } 5165323c1260SJoe Perches } 51663445686aSJoe Perches } 51670a920b5bSAndy Whitcroft 51680a920b5bSAndy Whitcroft#no spaces allowed after \ in define 5169d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 5170d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 5171d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 5172d5e616fcSJoe Perches $fix) { 5173194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 5174d5e616fcSJoe Perches } 51750a920b5bSAndy Whitcroft } 51760a920b5bSAndy Whitcroft 51770e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 51780e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 5179c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 5180e09dec48SAndy Whitcroft my $file = "$1.h"; 5181e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 5182e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 5183e09dec48SAndy Whitcroft $realfile ne $checkfile && 51847840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 5185c45dcabdSAndy Whitcroft { 51860e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 51870e212e0aSFabian Frederick if ($asminclude > 0) { 5188e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 5189000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 5190000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5191e09dec48SAndy Whitcroft } else { 5192000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 5193000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5194e09dec48SAndy Whitcroft } 51950a920b5bSAndy Whitcroft } 51960a920b5bSAndy Whitcroft } 51970e212e0aSFabian Frederick } 51980a920b5bSAndy Whitcroft 5199653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 5200653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 5201cf655043SAndy Whitcroft# in a known good container 5202b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 5203b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 5204d8aaf121SAndy Whitcroft my $ln = $linenr; 5205d8aaf121SAndy Whitcroft my $cnt = $realcnt; 5206c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 5207c45dcabdSAndy Whitcroft my $ctx = ''; 520808a2843eSJoe Perches my $has_flow_statement = 0; 520908a2843eSJoe Perches my $has_arg_concat = 0; 5210c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 5211f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 5212f74bd194SAndy Whitcroft $ctx = $dstat; 5213c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 5214a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 5215c45dcabdSAndy Whitcroft 521608a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 521762e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 521808a2843eSJoe Perches 5219f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 5220f59b64bfSJoe Perches my $define_args = $1; 5221f59b64bfSJoe Perches my $define_stmt = $dstat; 5222f59b64bfSJoe Perches my @def_args = (); 5223f59b64bfSJoe Perches 5224f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 5225f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 5226f59b64bfSJoe Perches $define_args =~ s/\s*//g; 52278c8c45cfSJoe Perches $define_args =~ s/\\\+?//g; 5228f59b64bfSJoe Perches @def_args = split(",", $define_args); 5229f59b64bfSJoe Perches } 5230f59b64bfSJoe Perches 5231292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 5232c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 5233c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 5234c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 5235c45dcabdSAndy Whitcroft 5236c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 5237bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 5238bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 52396b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 5240bf30d6edSAndy Whitcroft { 5241c45dcabdSAndy Whitcroft } 5242c45dcabdSAndy Whitcroft 5243342d3d2fSAntonio Borneo # Flatten any obvious string concatenation. 524433acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 524533acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 5246e45bab8eSAndy Whitcroft { 5247e45bab8eSAndy Whitcroft } 5248e45bab8eSAndy Whitcroft 524942e15293SJoe Perches # Make asm volatile uses seem like a generic function 525042e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 525142e15293SJoe Perches 5252c45dcabdSAndy Whitcroft my $exceptions = qr{ 5253c45dcabdSAndy Whitcroft $Declare| 5254c45dcabdSAndy Whitcroft module_param_named| 5255a0a0a7a9SKees Cook MODULE_PARM_DESC| 5256c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 5257c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 5258383099fdSAndy Whitcroft __typeof__\(| 525922fd2d3eSStefani Seibold union| 526022fd2d3eSStefani Seibold struct| 5261ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 52626b10df42SVladimir Zapolskiy ^\"|\"$| 52636b10df42SVladimir Zapolskiy ^\[ 5264c45dcabdSAndy Whitcroft }x; 52655eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 5266f59b64bfSJoe Perches 5267f59b64bfSJoe Perches $ctx =~ s/\n*$//; 5268f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 5269e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 5270f59b64bfSJoe Perches 5271f74bd194SAndy Whitcroft if ($dstat ne '' && 5272f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 5273f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 52743cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 5275356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5276f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 5277f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5278e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 527972f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 5280f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5281f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5282f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 52834e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5284f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5285c45dcabdSAndy Whitcroft { 5286e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5287e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5288e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5289e795556aSJoe Perches } elsif ($dstat =~ /;/) { 5290f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5291f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5292f74bd194SAndy Whitcroft } else { 5293000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 5294388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5295d8aaf121SAndy Whitcroft } 5296f59b64bfSJoe Perches 5297f59b64bfSJoe Perches } 52985207649bSJoe Perches 52995207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 53005207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 53015207649bSJoe Perches my $first = 1; 53025207649bSJoe Perches $define_stmt = ""; 53035207649bSJoe Perches foreach my $l (@stmt_array) { 53045207649bSJoe Perches $l =~ s/\\$//; 53055207649bSJoe Perches if ($first) { 53065207649bSJoe Perches $define_stmt = $l; 53075207649bSJoe Perches $first = 0; 53085207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 53095207649bSJoe Perches $define_stmt .= substr($l, 1); 53105207649bSJoe Perches } 53115207649bSJoe Perches } 53125207649bSJoe Perches $define_stmt =~ s/$;//g; 53135207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 53145207649bSJoe Perches $define_stmt = trim($define_stmt); 53155207649bSJoe Perches 5316f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5317f59b64bfSJoe Perches foreach my $arg (@def_args) { 5318f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 53199192d41aSJoe Perches next if ($arg =~ /^type$/i); 53207fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 53216dba824eSBrendan Jackman $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 53227fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 53237fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 5324d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 5325f59b64bfSJoe Perches if ($use_cnt > 1) { 5326f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5327f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5328f59b64bfSJoe Perches } 53299192d41aSJoe Perches# check if any macro arguments may have other precedence issues 53307fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 53319192d41aSJoe Perches ((defined($1) && $1 ne ',') || 53329192d41aSJoe Perches (defined($2) && $2 ne ','))) { 53339192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 53349192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 53359192d41aSJoe Perches } 53360a920b5bSAndy Whitcroft } 53375023d347SJoe Perches 533808a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 533908a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 534008a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 534108a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 5342e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 534308a2843eSJoe Perches 534408a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 534508a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 534608a2843eSJoe Perches } 534708a2843eSJoe Perches 5348481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 53495023d347SJoe Perches 53505023d347SJoe Perches } else { 53515023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5352481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5353481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 53545023d347SJoe Perches $line =~ /^\+.*\\$/) { 53555023d347SJoe Perches WARN("LINE_CONTINUATIONS", 53565023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 53575023d347SJoe Perches } 5358653d4876SAndy Whitcroft } 53590a920b5bSAndy Whitcroft 5360b13edf7fSJoe Perches# do {} while (0) macro tests: 5361b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5362b13edf7fSJoe Perches# macro should not end with a semicolon 53635b57980dSJoe Perches if ($perl_version_ok && 5364b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5365b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5366b13edf7fSJoe Perches my $ln = $linenr; 5367b13edf7fSJoe Perches my $cnt = $realcnt; 5368b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5369b13edf7fSJoe Perches my $ctx = ''; 5370b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5371b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5372b13edf7fSJoe Perches $ctx = $dstat; 5373b13edf7fSJoe Perches 5374b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 53751b36b201SJoe Perches $dstat =~ s/$;/ /g; 5376b13edf7fSJoe Perches 5377b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5378b13edf7fSJoe Perches my $stmts = $2; 5379b13edf7fSJoe Perches my $semis = $3; 5380b13edf7fSJoe Perches 5381b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5382b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5383e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5384b13edf7fSJoe Perches 5385ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5386ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5387b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5388b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5389b13edf7fSJoe Perches } 5390b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5391b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5392b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5393b13edf7fSJoe Perches } 5394f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5395f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5396f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5397e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5398f5ef95b1SJoe Perches 5399f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5400f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5401b13edf7fSJoe Perches } 5402b13edf7fSJoe Perches } 5403b13edf7fSJoe Perches 5404f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 540513214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 540613214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5407cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 540813214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5409cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5410cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5411aad4f614SJoe Perches my @allowed = (); 5412aad4f614SJoe Perches my $allow = 0; 541313214adfSAndy Whitcroft my $seen = 0; 5414773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5415cf655043SAndy Whitcroft my $ln = $linenr - 1; 541613214adfSAndy Whitcroft for my $chunk (@chunks) { 541713214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 541813214adfSAndy Whitcroft 5419773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5420773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5421773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 5422773647a0SAndy Whitcroft 5423aad4f614SJoe Perches $allowed[$allow] = 0; 5424773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5425773647a0SAndy Whitcroft 5426773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 5427773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 5428773647a0SAndy Whitcroft 5429773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5430cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 5431cf655043SAndy Whitcroft 5432773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 543313214adfSAndy Whitcroft 543413214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 543513214adfSAndy Whitcroft 5436aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5437cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5438cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5439aad4f614SJoe Perches $allowed[$allow] = 1; 544013214adfSAndy Whitcroft } 544113214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5442cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5443aad4f614SJoe Perches $allowed[$allow] = 1; 544413214adfSAndy Whitcroft } 5445cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5446cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5447aad4f614SJoe Perches $allowed[$allow] = 1; 544813214adfSAndy Whitcroft } 5449aad4f614SJoe Perches $allow++; 545013214adfSAndy Whitcroft } 5451aad4f614SJoe Perches if ($seen) { 5452aad4f614SJoe Perches my $sum_allowed = 0; 5453aad4f614SJoe Perches foreach (@allowed) { 5454aad4f614SJoe Perches $sum_allowed += $_; 5455aad4f614SJoe Perches } 5456aad4f614SJoe Perches if ($sum_allowed == 0) { 5457000d1cc1SJoe Perches WARN("BRACES", 5458000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 5459aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 5460aad4f614SJoe Perches $seen != $allow) { 5461aad4f614SJoe Perches CHK("BRACES", 5462aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 5463aad4f614SJoe Perches } 546413214adfSAndy Whitcroft } 546513214adfSAndy Whitcroft } 546613214adfSAndy Whitcroft } 5467773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 546813214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 5469cf655043SAndy Whitcroft my $allowed = 0; 5470f0a594c1SAndy Whitcroft 5471cf655043SAndy Whitcroft # Check the pre-context. 5472cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 5473cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 5474cf655043SAndy Whitcroft $allowed = 1; 5475f0a594c1SAndy Whitcroft } 5476773647a0SAndy Whitcroft 5477773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 5478773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 5479773647a0SAndy Whitcroft 5480cf655043SAndy Whitcroft # Check the condition. 5481cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 5482773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 5483cf655043SAndy Whitcroft if (defined $cond) { 5484773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5485cf655043SAndy Whitcroft } 5486cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5487cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5488cf655043SAndy Whitcroft $allowed = 1; 5489cf655043SAndy Whitcroft } 5490cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5491cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5492cf655043SAndy Whitcroft $allowed = 1; 5493cf655043SAndy Whitcroft } 5494cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5495cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5496cf655043SAndy Whitcroft $allowed = 1; 5497cf655043SAndy Whitcroft } 5498cf655043SAndy Whitcroft # Check the post-context. 5499cf655043SAndy Whitcroft if (defined $chunks[1]) { 5500cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 5501cf655043SAndy Whitcroft if (defined $cond) { 5502773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5503cf655043SAndy Whitcroft } 5504cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 5505cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5506cf655043SAndy Whitcroft $allowed = 1; 5507cf655043SAndy Whitcroft } 5508cf655043SAndy Whitcroft } 5509cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 5510f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 5511e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5512cf655043SAndy Whitcroft 5513000d1cc1SJoe Perches WARN("BRACES", 5514000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 5515f0a594c1SAndy Whitcroft } 5516f0a594c1SAndy Whitcroft } 5517f0a594c1SAndy Whitcroft 5518e4c5babdSJoe Perches# check for single line unbalanced braces 551995330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 552095330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 5521e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 5522e4c5babdSJoe Perches } 5523e4c5babdSJoe Perches 55240979ae66SJoe Perches# check for unnecessary blank lines around braces 552577b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5526f8e58219SJoe Perches if (CHK("BRACES", 5527f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5528f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 5529f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5530f8e58219SJoe Perches } 55310979ae66SJoe Perches } 553277b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5533f8e58219SJoe Perches if (CHK("BRACES", 5534f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5535f8e58219SJoe Perches $fix) { 5536f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 5537f8e58219SJoe Perches } 55380979ae66SJoe Perches } 55390979ae66SJoe Perches 55404a0df2efSAndy Whitcroft# no volatiles please 55416c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 55426c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5543000d1cc1SJoe Perches WARN("VOLATILE", 55448c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 55454a0df2efSAndy Whitcroft } 55464a0df2efSAndy Whitcroft 55475e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 55485e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 55495e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 55505e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 555133acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 55525e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 55535e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 55545e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 55555e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 55565e4f6ba5SJoe Perches $fix && 55575e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 55585e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 55595e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 55605e4f6ba5SJoe Perches my $comma_close = ""; 55615e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 55625e4f6ba5SJoe Perches $comma_close = $1; 55635e4f6ba5SJoe Perches } 55645e4f6ba5SJoe Perches 55655e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 55665e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 55675e4f6ba5SJoe Perches my $fixedline = $prevrawline; 55685e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 55695e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 55705e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 55715e4f6ba5SJoe Perches $fixedline = $rawline; 55725e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 55735e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 55745e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 55755e4f6ba5SJoe Perches } 55765e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 55775e4f6ba5SJoe Perches } 55785e4f6ba5SJoe Perches } 55795e4f6ba5SJoe Perches 55805e4f6ba5SJoe Perches# check for missing a space in a string concatenation 55815e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 55825e4f6ba5SJoe Perches WARN('MISSING_SPACE', 55835e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 55845e4f6ba5SJoe Perches } 55855e4f6ba5SJoe Perches 558677cb8546SJoe Perches# check for an embedded function name in a string when the function is known 5587e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 5588e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 5589e4b7d309SJoe Perches# function declarations 559077cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 559177cb8546SJoe Perches defined($context_function) && 5592e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 5593e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 559477cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 5595e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 559677cb8546SJoe Perches } 559777cb8546SJoe Perches 55985e4f6ba5SJoe Perches# check for spaces before a quoted newline 55995e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 56005e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 56015e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 56025e4f6ba5SJoe Perches $fix) { 56035e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 56045e4f6ba5SJoe Perches } 56055e4f6ba5SJoe Perches 56065e4f6ba5SJoe Perches } 56075e4f6ba5SJoe Perches 5608f17dba4fSJoe Perches# concatenated string without spaces between elements 560979682c0cSJoe Perches if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) { 561079682c0cSJoe Perches if (CHK("CONCATENATED_STRING", 561179682c0cSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr) && 561279682c0cSJoe Perches $fix) { 561379682c0cSJoe Perches while ($line =~ /($String)/g) { 561479682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 561579682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/; 561679682c0cSJoe Perches $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/; 561779682c0cSJoe Perches } 561879682c0cSJoe Perches } 5619f17dba4fSJoe Perches } 5620f17dba4fSJoe Perches 562190ad30e5SJoe Perches# uncoalesced string fragments 562233acb54aSJoe Perches if ($line =~ /$String\s*"/) { 562379682c0cSJoe Perches if (WARN("STRING_FRAGMENTS", 562479682c0cSJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr) && 562579682c0cSJoe Perches $fix) { 562679682c0cSJoe Perches while ($line =~ /($String)(?=\s*")/g) { 562779682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 562879682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e; 562979682c0cSJoe Perches } 563079682c0cSJoe Perches } 563190ad30e5SJoe Perches } 563290ad30e5SJoe Perches 5633522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 5634522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 5635522b837cSAlexey Dobriyan my $show_Z = 1; 56365e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 5637522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 56385e4f6ba5SJoe Perches $string =~ s/%%/__/g; 5639522b837cSAlexey Dobriyan # check for %L 5640522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 56415e4f6ba5SJoe Perches WARN("PRINTF_L", 5642522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 5643522b837cSAlexey Dobriyan $show_L = 0; 56445e4f6ba5SJoe Perches } 5645522b837cSAlexey Dobriyan # check for %Z 5646522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 5647522b837cSAlexey Dobriyan WARN("PRINTF_Z", 5648522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 5649522b837cSAlexey Dobriyan $show_Z = 0; 5650522b837cSAlexey Dobriyan } 5651522b837cSAlexey Dobriyan # check for 0x<decimal> 5652522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 5653522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 56546e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 56556e300757SJoe Perches } 56565e4f6ba5SJoe Perches } 56575e4f6ba5SJoe Perches 56585e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 56593f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 56605e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 56615e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 56625e4f6ba5SJoe Perches } 56635e4f6ba5SJoe Perches 566400df344fSAndy Whitcroft# warn about #if 0 5665c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 566660f89010SPrakruthi Deepak Heragu WARN("IF_0", 566760f89010SPrakruthi Deepak Heragu "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr); 566860f89010SPrakruthi Deepak Heragu } 566960f89010SPrakruthi Deepak Heragu 567060f89010SPrakruthi Deepak Heragu# warn about #if 1 567160f89010SPrakruthi Deepak Heragu if ($line =~ /^.\s*\#\s*if\s+1\b/) { 567260f89010SPrakruthi Deepak Heragu WARN("IF_1", 567360f89010SPrakruthi Deepak Heragu "Consider removing the #if 1 and its #endif\n" . $herecurr); 56744a0df2efSAndy Whitcroft } 56754a0df2efSAndy Whitcroft 567603df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 567703df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5678100425deSJoe Perches my $tested = quotemeta($1); 5679100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5680100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5681100425deSJoe Perches my $func = $1; 5682100425deSJoe Perches if (WARN('NEEDLESS_IF', 5683100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5684100425deSJoe Perches $fix) { 5685100425deSJoe Perches my $do_fix = 1; 5686100425deSJoe Perches my $leading_tabs = ""; 5687100425deSJoe Perches my $new_leading_tabs = ""; 5688100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5689100425deSJoe Perches $leading_tabs = $1; 5690100425deSJoe Perches } else { 5691100425deSJoe Perches $do_fix = 0; 5692100425deSJoe Perches } 5693100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5694100425deSJoe Perches $new_leading_tabs = $1; 5695100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5696100425deSJoe Perches $do_fix = 0; 5697100425deSJoe Perches } 5698100425deSJoe Perches } else { 5699100425deSJoe Perches $do_fix = 0; 5700100425deSJoe Perches } 5701100425deSJoe Perches if ($do_fix) { 5702100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5703100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5704100425deSJoe Perches } 5705100425deSJoe Perches } 57064c432a8fSGreg Kroah-Hartman } 57074c432a8fSGreg Kroah-Hartman } 5708f0a594c1SAndy Whitcroft 5709ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5710ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5711ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5712ebfdc409SJoe Perches (defined $1 || defined $3) && 5713ebfdc409SJoe Perches $linenr > 3) { 5714ebfdc409SJoe Perches my $testval = $2; 5715ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5716ebfdc409SJoe Perches 5717ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5718ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5719ebfdc409SJoe Perches 5720e29a70f1SJoe Perches if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ && 5721e29a70f1SJoe Perches $s !~ /\b__GFP_NOWARN\b/ ) { 5722ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5723ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5724ebfdc409SJoe Perches } 5725ebfdc409SJoe Perches } 5726ebfdc409SJoe Perches 5727f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5728dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5729f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5730f78d98f6SJoe Perches my $level = $1; 5731f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5732f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5733f78d98f6SJoe Perches $fix) { 5734f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5735f78d98f6SJoe Perches } 5736f78d98f6SJoe Perches } 5737f78d98f6SJoe Perches 573845c55e92SJoe Perches# check for logging continuations 573945c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 574045c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 574145c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 574245c55e92SJoe Perches } 574345c55e92SJoe Perches 5744abb08a53SJoe Perches# check for mask then right shift without a parentheses 57455b57980dSJoe Perches if ($perl_version_ok && 5746abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5747abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5748abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5749abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5750abb08a53SJoe Perches } 5751abb08a53SJoe Perches 5752b75ac618SJoe Perches# check for pointer comparisons to NULL 57535b57980dSJoe Perches if ($perl_version_ok) { 5754b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5755b75ac618SJoe Perches my $val = $1; 5756b75ac618SJoe Perches my $equal = "!"; 5757b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5758b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5759b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5760b75ac618SJoe Perches $fix) { 5761b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5762b75ac618SJoe Perches } 5763b75ac618SJoe Perches } 5764b75ac618SJoe Perches } 5765b75ac618SJoe Perches 57668716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 57678716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 57688716de38SJoe Perches my $attr = $1; 57698716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 57708716de38SJoe Perches my $ptr = $1; 57718716de38SJoe Perches my $var = $2; 57728716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 57738716de38SJoe Perches ERROR("MISPLACED_INIT", 57748716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 57758716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 57768716de38SJoe Perches WARN("MISPLACED_INIT", 57778716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 57788716de38SJoe Perches $fix) { 5779194f66fcSJoe 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; 57808716de38SJoe Perches } 57818716de38SJoe Perches } 57828716de38SJoe Perches } 57838716de38SJoe Perches 5784e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5785e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5786e970b884SJoe Perches my $attr = $1; 5787e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5788e970b884SJoe Perches my $attr_prefix = $1; 5789e970b884SJoe Perches my $attr_type = $2; 5790e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5791e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5792e970b884SJoe Perches $fix) { 5793194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5794e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5795e970b884SJoe Perches } 5796e970b884SJoe Perches } 5797e970b884SJoe Perches 5798e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5799e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5800e970b884SJoe Perches my $attr = $1; 5801e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5802e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5803e970b884SJoe Perches $fix) { 5804194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5805e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5806e970b884SJoe Perches $lead = rtrim($1); 5807e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5808e970b884SJoe Perches $lead = "${lead}const "; 5809194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5810e970b884SJoe Perches } 5811e970b884SJoe Perches } 5812e970b884SJoe Perches 5813c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5814c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5815c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5816c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5817c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5818c17893c7SJoe Perches $fix) { 5819c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5820c17893c7SJoe Perches } 5821c17893c7SJoe Perches } 5822c17893c7SJoe Perches 5823fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5824fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5825fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5826fbdb8138SJoe Perches my $constant_func = $1; 5827fbdb8138SJoe Perches my $func = $constant_func; 5828fbdb8138SJoe Perches $func =~ s/^__constant_//; 5829fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5830fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5831fbdb8138SJoe Perches $fix) { 5832194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5833fbdb8138SJoe Perches } 5834fbdb8138SJoe Perches } 5835fbdb8138SJoe Perches 58361a15a250SPatrick Pannuto# prefer usleep_range over udelay 583737581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 583843c1d77cSJoe Perches my $delay = $1; 58391a15a250SPatrick Pannuto # ignore udelay's < 10, however 584043c1d77cSJoe Perches if (! ($delay < 10) ) { 5841000d1cc1SJoe Perches CHK("USLEEP_RANGE", 5842458f69efSMauro Carvalho Chehab "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr); 584343c1d77cSJoe Perches } 584443c1d77cSJoe Perches if ($delay > 2000) { 584543c1d77cSJoe Perches WARN("LONG_UDELAY", 584643c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 58471a15a250SPatrick Pannuto } 58481a15a250SPatrick Pannuto } 58491a15a250SPatrick Pannuto 585009ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 585109ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 585209ef8725SPatrick Pannuto if ($1 < 20) { 5853000d1cc1SJoe Perches WARN("MSLEEP", 5854458f69efSMauro Carvalho Chehab "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr); 585509ef8725SPatrick Pannuto } 585609ef8725SPatrick Pannuto } 585709ef8725SPatrick Pannuto 585836ec1939SJoe Perches# check for comparisons of jiffies 585936ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 586036ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 586136ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 586236ec1939SJoe Perches } 586336ec1939SJoe Perches 58649d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 58659d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 58669d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 58679d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 58689d7a34a5SJoe Perches } 58699d7a34a5SJoe Perches 587000df344fSAndy Whitcroft# warn about #ifdefs in C files 5871c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 587200df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 587300df344fSAndy Whitcroft# print "$herecurr"; 587400df344fSAndy Whitcroft# $clean = 0; 587500df344fSAndy Whitcroft# } 587600df344fSAndy Whitcroft 587722f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5878c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 58793705ce5bSJoe Perches if (ERROR("SPACING", 58803705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 58813705ce5bSJoe Perches $fix) { 5882194f66fcSJoe Perches $fixed[$fixlinenr] =~ 58833705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 58843705ce5bSJoe Perches } 58853705ce5bSJoe Perches 588622f2a2efSAndy Whitcroft } 588722f2a2efSAndy Whitcroft 58884a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5889171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5890171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 58914a0df2efSAndy Whitcroft my $which = $1; 58924a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5893000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5894000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 58954a0df2efSAndy Whitcroft } 58964a0df2efSAndy Whitcroft } 58974a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5898402c2553SMichael S. Tsirkin 5899402c2553SMichael S. Tsirkin my $barriers = qr{ 5900402c2553SMichael S. Tsirkin mb| 5901402c2553SMichael S. Tsirkin rmb| 5902402c2553SMichael S. Tsirkin wmb| 5903402c2553SMichael S. Tsirkin read_barrier_depends 5904402c2553SMichael S. Tsirkin }x; 5905402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5906402c2553SMichael S. Tsirkin mb__before_atomic| 5907402c2553SMichael S. Tsirkin mb__after_atomic| 5908402c2553SMichael S. Tsirkin store_release| 5909402c2553SMichael S. Tsirkin load_acquire| 5910402c2553SMichael S. Tsirkin store_mb| 5911402c2553SMichael S. Tsirkin (?:$barriers) 5912402c2553SMichael S. Tsirkin }x; 5913402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5914402c2553SMichael S. Tsirkin (?:$barriers)| 591543e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 591643e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5917402c2553SMichael S. Tsirkin }x; 5918402c2553SMichael S. Tsirkin 5919402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 59204a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5921c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5922000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 59234a0df2efSAndy Whitcroft } 59244a0df2efSAndy Whitcroft } 59253ad81779SPaul E. McKenney 5926f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5927f4073b0fSMichael S. Tsirkin 5928f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5929f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5930f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5931f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5932f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5933f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5934f4073b0fSMichael S. Tsirkin } 5935f4073b0fSMichael S. Tsirkin 5936cb426e99SJoe Perches# check for waitqueue_active without a comment. 5937cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5938cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5939cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5940cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5941cb426e99SJoe Perches } 5942cb426e99SJoe Perches } 59433ad81779SPaul E. McKenney 59445099a722SMarco Elver# check for data_race without a comment. 59455099a722SMarco Elver if ($line =~ /\bdata_race\s*\(/) { 59465099a722SMarco Elver if (!ctx_has_comment($first_line, $linenr)) { 59475099a722SMarco Elver WARN("DATA_RACE", 59485099a722SMarco Elver "data_race without comment\n" . $herecurr); 59495099a722SMarco Elver } 59505099a722SMarco Elver } 59515099a722SMarco Elver 595291db2592SPaul E. McKenney# check for smp_read_barrier_depends and read_barrier_depends 595391db2592SPaul E. McKenney if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) { 595491db2592SPaul E. McKenney WARN("READ_BARRIER_DEPENDS", 595591db2592SPaul E. McKenney "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr); 595691db2592SPaul E. McKenney } 595791db2592SPaul E. McKenney 59584a0df2efSAndy Whitcroft# check of hardware specific defines 5959c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5960000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5961000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 59620a920b5bSAndy Whitcroft } 5963653d4876SAndy Whitcroft 5964596ed45bSJoe Perches# check that the storage class is not after a type 5965596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 5966000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5967596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 5968596ed45bSJoe Perches } 5969596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 5970596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 5971596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 5972596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 5973596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 5974596ed45bSJoe Perches WARN("STORAGE_CLASS", 5975596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 5976d4977c78STobias Klauser } 5977d4977c78STobias Klauser 5978de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5979de7d4f0eSAndy Whitcroft# storage class and type. 59809c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 59819c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5982000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5983000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5984de7d4f0eSAndy Whitcroft } 5985de7d4f0eSAndy Whitcroft 59868905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 59872b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 59882b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5989d5e616fcSJoe Perches if (WARN("INLINE", 5990d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5991d5e616fcSJoe Perches $fix) { 5992194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5993d5e616fcSJoe Perches 5994d5e616fcSJoe Perches } 59958905a67cSAndy Whitcroft } 59968905a67cSAndy Whitcroft 59973d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 59982b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 59992b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 6000000d1cc1SJoe Perches WARN("PREFER_PACKED", 6001000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 60023d130fd0SJoe Perches } 60033d130fd0SJoe Perches 600439b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 60052b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 60062b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 6007000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 6008000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 600939b7e287SJoe Perches } 601039b7e287SJoe Perches 6011462811d9SJoe Perches# Check for __attribute__ section, prefer __section 6012462811d9SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 6013462811d9SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) { 6014462811d9SJoe Perches my $old = substr($rawline, $-[1], $+[1] - $-[1]); 6015462811d9SJoe Perches my $new = substr($old, 1, -1); 6016462811d9SJoe Perches if (WARN("PREFER_SECTION", 6017462811d9SJoe Perches "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) && 6018462811d9SJoe Perches $fix) { 6019462811d9SJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/; 6020462811d9SJoe Perches } 6021462811d9SJoe Perches } 6022462811d9SJoe Perches 60235f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 60242b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 60252b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 6026d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 6027d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 6028d5e616fcSJoe Perches $fix) { 6029194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 6030d5e616fcSJoe Perches 6031d5e616fcSJoe Perches } 60325f14d3bdSJoe Perches } 60335f14d3bdSJoe Perches 60346061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 60352b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 60362b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 6037d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 6038d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 6039d5e616fcSJoe Perches $fix) { 6040194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 6041d5e616fcSJoe Perches } 60426061d949SJoe Perches } 60436061d949SJoe Perches 6044619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 60455b57980dSJoe Perches if ($perl_version_ok && 6046619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 6047619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 6048619a908aSJoe Perches $line =~ /\b__weak\b/)) { 6049619a908aSJoe Perches ERROR("WEAK_DECLARATION", 6050619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 6051619a908aSJoe Perches } 6052619a908aSJoe Perches 6053fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 6054e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 6055fd39f904STomas Winkler $realfile !~ m@\btools/@ && 6056e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 6057e6176fa4SJoe Perches my $type = $1; 6058e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 6059e6176fa4SJoe Perches $type = $1; 6060e6176fa4SJoe Perches my $kernel_type = 'u'; 6061e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 6062e6176fa4SJoe Perches $type =~ /(\d+)/; 6063e6176fa4SJoe Perches $kernel_type .= $1; 6064e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 6065e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 6066e6176fa4SJoe Perches $fix) { 6067e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 6068e6176fa4SJoe Perches } 6069e6176fa4SJoe Perches } 6070e6176fa4SJoe Perches } 6071e6176fa4SJoe Perches 6072938224b5SJoe Perches# check for cast of C90 native int or longer types constants 6073938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 6074938224b5SJoe Perches my $cast = $1; 6075938224b5SJoe Perches my $const = $2; 6076938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 6077938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 6078938224b5SJoe Perches $fix) { 6079938224b5SJoe Perches my $suffix = ""; 6080938224b5SJoe Perches my $newconst = $const; 6081938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 6082938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 6083938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 6084938224b5SJoe Perches $suffix .= 'LL'; 6085938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 6086938224b5SJoe Perches $suffix .= 'L'; 6087938224b5SJoe Perches } 6088938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 6089938224b5SJoe Perches } 6090938224b5SJoe Perches } 6091938224b5SJoe Perches 60928f53a9b8SJoe Perches# check for sizeof(&) 60938f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 6094000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 6095000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 60968f53a9b8SJoe Perches } 60978f53a9b8SJoe Perches 609866c80b60SJoe Perches# check for sizeof without parenthesis 609966c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 6100d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 6101d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 6102d5e616fcSJoe Perches $fix) { 6103194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 6104d5e616fcSJoe Perches } 610566c80b60SJoe Perches } 610666c80b60SJoe Perches 610788982feaSJoe Perches# check for struct spinlock declarations 610888982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 610988982feaSJoe Perches WARN("USE_SPINLOCK_T", 611088982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 611188982feaSJoe Perches } 611288982feaSJoe Perches 6113a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 611406668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 6115a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 6116caac1d5fSHeba Aamer $fmt =~ s/%%//g; 6117caac1d5fSHeba Aamer if ($fmt !~ /%/) { 6118d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 6119d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 6120d5e616fcSJoe Perches $fix) { 6121194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 6122d5e616fcSJoe Perches } 6123a6962d72SJoe Perches } 6124a6962d72SJoe Perches } 6125a6962d72SJoe Perches 61260b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 61275b57980dSJoe Perches if ($perl_version_ok && 61280b523769SJoe Perches defined $stat && 61290b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 61300b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 6131e3c6bc95STobin C. Harding my $stat_real; 6132e3c6bc95STobin C. Harding 61330b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 61340b523769SJoe Perches $lc = $lc + $linenr; 61350b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 6136ffe07513SJoe Perches my $specifier; 6137ffe07513SJoe Perches my $extension; 61383bd32d6aSSakari Ailus my $qualifier; 6139ffe07513SJoe Perches my $bad_specifier = ""; 61400b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 61410b523769SJoe Perches $fmt =~ s/%%//g; 6142e3c6bc95STobin C. Harding 61433bd32d6aSSakari Ailus while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) { 6144e3c6bc95STobin C. Harding $specifier = $1; 6145e3c6bc95STobin C. Harding $extension = $2; 61463bd32d6aSSakari Ailus $qualifier = $3; 6147361b0d28SLinus Torvalds if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ || 61483bd32d6aSSakari Ailus ($extension eq "f" && 61493bd32d6aSSakari Ailus defined $qualifier && $qualifier !~ /^w/)) { 6150e3c6bc95STobin C. Harding $bad_specifier = $specifier; 61510b523769SJoe Perches last; 61520b523769SJoe Perches } 6153e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 6154e3c6bc95STobin C. Harding if (!defined($stat_real)) { 6155e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 61560b523769SJoe Perches } 6157e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 6158e3c6bc95STobin 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"); 6159e3c6bc95STobin C. Harding } 6160e3c6bc95STobin C. Harding } 6161e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 61622a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 61631df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 61641df7338aSSergey Senozhatsky my $use = ""; 6165e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 61661df7338aSSergey Senozhatsky $use = " - use %pS instead"; 6167e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 61681df7338aSSergey Senozhatsky } 61692a9f9d85STobin C. Harding 61700b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 6171e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 6172e3c6bc95STobin C. Harding } 61730b523769SJoe Perches } 61740b523769SJoe Perches } 61750b523769SJoe Perches 6176554e165cSAndy Whitcroft# Check for misused memsets 61775b57980dSJoe Perches if ($perl_version_ok && 6178d1fe9c09SJoe Perches defined $stat && 61799e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 6180554e165cSAndy Whitcroft 6181d7c76ba7SJoe Perches my $ms_addr = $2; 6182d1fe9c09SJoe Perches my $ms_val = $7; 6183d1fe9c09SJoe Perches my $ms_size = $12; 6184d7c76ba7SJoe Perches 6185554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 6186554e165cSAndy Whitcroft ERROR("MEMSET", 6187d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 6188554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 6189554e165cSAndy Whitcroft WARN("MEMSET", 6190d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 6191d7c76ba7SJoe Perches } 6192d7c76ba7SJoe Perches } 6193d7c76ba7SJoe Perches 619498a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 61955b57980dSJoe Perches# if ($perl_version_ok && 6196f333195dSJoe Perches# defined $stat && 6197f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6198f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 6199f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 6200f333195dSJoe Perches# $fix) { 6201f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 6202f333195dSJoe Perches# } 6203f333195dSJoe Perches# } 620498a9bba5SJoe Perches 6205b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 62065b57980dSJoe Perches# if ($perl_version_ok && 6207f333195dSJoe Perches# defined $stat && 6208f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6209f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 6210f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 6211f333195dSJoe Perches# } 6212b6117d17SMateusz Kulikowski 62138617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 62148617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 62155b57980dSJoe Perches# if ($perl_version_ok && 6216f333195dSJoe Perches# defined $stat && 6217f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6218f333195dSJoe Perches# 6219f333195dSJoe Perches# my $ms_val = $7; 6220f333195dSJoe Perches# 6221f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 6222f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 6223f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 6224f333195dSJoe Perches# $fix) { 6225f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 6226f333195dSJoe Perches# } 6227f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 6228f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 6229f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 6230f333195dSJoe Perches# $fix) { 6231f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 6232f333195dSJoe Perches# } 6233f333195dSJoe Perches# } 6234f333195dSJoe Perches# } 62358617cd09SMateusz Kulikowski 6236d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 62375b57980dSJoe Perches if ($perl_version_ok && 6238d1fe9c09SJoe Perches defined $stat && 6239d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 6240d1fe9c09SJoe Perches if (defined $2 || defined $7) { 6241d7c76ba7SJoe Perches my $call = $1; 6242d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 6243d7c76ba7SJoe Perches my $arg1 = $3; 6244d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 6245d1fe9c09SJoe Perches my $arg2 = $8; 6246d7c76ba7SJoe Perches my $cast; 6247d7c76ba7SJoe Perches 6248d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 6249d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 6250d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 6251d7c76ba7SJoe Perches $cast = $cast1; 6252d7c76ba7SJoe Perches } else { 6253d7c76ba7SJoe Perches $cast = $cast2; 6254d7c76ba7SJoe Perches } 6255d7c76ba7SJoe Perches WARN("MINMAX", 6256d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 6257554e165cSAndy Whitcroft } 6258554e165cSAndy Whitcroft } 6259554e165cSAndy Whitcroft 62604a273195SJoe Perches# check usleep_range arguments 62615b57980dSJoe Perches if ($perl_version_ok && 62624a273195SJoe Perches defined $stat && 62634a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 62644a273195SJoe Perches my $min = $1; 62654a273195SJoe Perches my $max = $7; 62664a273195SJoe Perches if ($min eq $max) { 62674a273195SJoe Perches WARN("USLEEP_RANGE", 6268458f69efSMauro Carvalho Chehab "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 62694a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 62704a273195SJoe Perches $min > $max) { 62714a273195SJoe Perches WARN("USLEEP_RANGE", 6272458f69efSMauro Carvalho Chehab "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 62734a273195SJoe Perches } 62744a273195SJoe Perches } 62754a273195SJoe Perches 6276823b794cSJoe Perches# check for naked sscanf 62775b57980dSJoe Perches if ($perl_version_ok && 6278823b794cSJoe Perches defined $stat && 62796c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 6280823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 6281823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 6282823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 6283823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 6284823b794cSJoe Perches $lc = $lc + $linenr; 62852a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6286823b794cSJoe Perches WARN("NAKED_SSCANF", 6287823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 6288823b794cSJoe Perches } 6289823b794cSJoe Perches 6290afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 62915b57980dSJoe Perches if ($perl_version_ok && 6292afc819abSJoe Perches defined $stat && 6293afc819abSJoe Perches $line =~ /\bsscanf\b/) { 6294afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 6295afc819abSJoe Perches $lc = $lc + $linenr; 62962a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6297afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 6298afc819abSJoe Perches my $format = $6; 6299afc819abSJoe Perches my $count = $format =~ tr@%@%@; 6300afc819abSJoe Perches if ($count == 1 && 6301afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 6302afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 6303afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 6304afc819abSJoe Perches } 6305afc819abSJoe Perches } 6306afc819abSJoe Perches } 6307afc819abSJoe Perches 630870dc8a48SJoe Perches# check for new externs in .h files. 630970dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 631070dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 6311d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 631270dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 631370dc8a48SJoe Perches $fix) { 6314194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 631570dc8a48SJoe Perches } 631670dc8a48SJoe Perches } 631770dc8a48SJoe Perches 6318de7d4f0eSAndy Whitcroft# check for new externs in .c files. 6319171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 6320c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 6321171ae1a4SAndy Whitcroft { 6322c45dcabdSAndy Whitcroft my $function_name = $1; 6323c45dcabdSAndy Whitcroft my $paren_space = $2; 6324171ae1a4SAndy Whitcroft 6325171ae1a4SAndy Whitcroft my $s = $stat; 6326171ae1a4SAndy Whitcroft if (defined $cond) { 6327171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 6328171ae1a4SAndy Whitcroft } 6329c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 6330c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 6331c45dcabdSAndy Whitcroft { 6332000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6333000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6334de7d4f0eSAndy Whitcroft } 6335de7d4f0eSAndy Whitcroft 6336171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 6337000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 6338000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 6339171ae1a4SAndy Whitcroft } 63409c9ba34eSAndy Whitcroft 63419c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 63429c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 63439c9ba34eSAndy Whitcroft { 6344000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6345000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6346171ae1a4SAndy Whitcroft } 6347171ae1a4SAndy Whitcroft 6348a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 634916b7f3c8SJoe Perches# while avoiding uninitialized_var(x) 6350a0ad7596SJoe Perches if (defined $stat && 635116b7f3c8SJoe Perches $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:($Ident)|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 635216b7f3c8SJoe Perches (!defined($1) || 635316b7f3c8SJoe Perches (defined($1) && $1 ne "uninitialized_var")) && 635416b7f3c8SJoe Perches $2 ne "void") { 635516b7f3c8SJoe Perches my $args = trim($2); 6356ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6357ca0d8929SJoe Perches my $arg = trim($1); 635816b7f3c8SJoe Perches if ($arg =~ /^$Type$/ && 635916b7f3c8SJoe Perches $arg !~ /enum\s+$Ident$/) { 6360ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 6361ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6362ca0d8929SJoe Perches } 6363ca0d8929SJoe Perches } 6364ca0d8929SJoe Perches } 6365ca0d8929SJoe Perches 6366a0ad7596SJoe Perches# check for function definitions 63675b57980dSJoe Perches if ($perl_version_ok && 6368a0ad7596SJoe Perches defined $stat && 6369a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6370a0ad7596SJoe Perches $context_function = $1; 6371a0ad7596SJoe Perches 6372a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 6373a0ad7596SJoe Perches my $ok = 0; 6374a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 6375a0ad7596SJoe Perches my $herectx = $here . "\n"; 6376a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6377a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 6378a0ad7596SJoe Perches $herectx .= $rl . "\n"; 6379a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 6380a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 6381a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 6382a0ad7596SJoe Perches } 6383a0ad7596SJoe Perches if (!$ok) { 6384a0ad7596SJoe Perches ERROR("OPEN_BRACE", 6385a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 6386a0ad7596SJoe Perches } 6387a0ad7596SJoe Perches } 6388a0ad7596SJoe Perches 6389de7d4f0eSAndy Whitcroft# checks for new __setup's 6390de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 6391de7d4f0eSAndy Whitcroft my $name = $1; 6392de7d4f0eSAndy Whitcroft 6393de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 6394000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 63952581ac7cSTim Froidcoeur "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr); 6396de7d4f0eSAndy Whitcroft } 6397653d4876SAndy Whitcroft } 63989c0ca6f9SAndy Whitcroft 6399e29a70f1SJoe Perches# check for pointless casting of alloc functions 6400e29a70f1SJoe Perches if ($line =~ /\*\s*\)\s*$allocFunctions\b/) { 6401000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 6402000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 64039c0ca6f9SAndy Whitcroft } 640413214adfSAndy Whitcroft 6405a640d25cSJoe Perches# alloc style 6406a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 64075b57980dSJoe Perches if ($perl_version_ok && 6408e29a70f1SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 6409a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 6410a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 6411a640d25cSJoe Perches } 6412a640d25cSJoe Perches 641360a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 64145b57980dSJoe Perches if ($perl_version_ok && 64151b4a2ed4SJoe Perches defined $stat && 64161b4a2ed4SJoe Perches $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 641760a55369SJoe Perches my $oldfunc = $3; 641860a55369SJoe Perches my $a1 = $4; 641960a55369SJoe Perches my $a2 = $10; 642060a55369SJoe Perches my $newfunc = "kmalloc_array"; 642160a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 642260a55369SJoe Perches my $r1 = $a1; 642360a55369SJoe Perches my $r2 = $a2; 642460a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 642560a55369SJoe Perches $r1 = $a2; 642660a55369SJoe Perches $r2 = $a1; 642760a55369SJoe Perches } 6428e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 6429e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 64301b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 6431e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6432e3d95a2aSTobin C. Harding 6433e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 64341b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 64351b4a2ed4SJoe Perches $cnt == 1 && 6436e367455aSJoe Perches $fix) { 6437194f66fcSJoe 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; 643860a55369SJoe Perches } 643960a55369SJoe Perches } 644060a55369SJoe Perches } 644160a55369SJoe Perches 6442972fdea2SJoe Perches# check for krealloc arg reuse 64435b57980dSJoe Perches if ($perl_version_ok && 64444cab63ceSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ && 64454cab63ceSJoe Perches $1 eq $3) { 6446972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 6447972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 6448972fdea2SJoe Perches } 6449972fdea2SJoe Perches 64505ce59ae0SJoe Perches# check for alloc argument mismatch 64515ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 64525ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 64535ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 64545ce59ae0SJoe Perches } 64555ce59ae0SJoe Perches 6456caf2a54fSJoe Perches# check for multiple semicolons 6457caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 6458d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 6459d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 6460d5e616fcSJoe Perches $fix) { 6461194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 6462d5e616fcSJoe Perches } 6463d1e2ad07SJoe Perches } 6464d1e2ad07SJoe Perches 6465cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 6466cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 6467cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 64680ab90191SJoe Perches my $ull = ""; 64690ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 64700ab90191SJoe Perches if (CHK("BIT_MACRO", 64710ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 64720ab90191SJoe Perches $fix) { 64730ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 64740ab90191SJoe Perches } 64750ab90191SJoe Perches } 64760ab90191SJoe Perches 64772d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 64782d632745SJoe 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*$/) { 64792d632745SJoe Perches my $config = $1; 64802d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 64812d632745SJoe Perches "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) && 64822d632745SJoe Perches $fix) { 64832d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 64842d632745SJoe Perches } 64852d632745SJoe Perches } 64862d632745SJoe Perches 6487e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 6488c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 6489c34c09a8SJoe Perches my $has_break = 0; 6490c34c09a8SJoe Perches my $has_statement = 0; 6491c34c09a8SJoe Perches my $count = 0; 6492c34c09a8SJoe Perches my $prevline = $linenr; 6493e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 6494c34c09a8SJoe Perches $prevline--; 6495c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 6496c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 6497c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 6498c34c09a8SJoe Perches next if ($fline =~ /^\-/); 6499c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 6500c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 6501c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 6502c34c09a8SJoe Perches $has_statement = 1; 6503c34c09a8SJoe Perches $count++; 6504258f79d5SHeinrich Schuchardt $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/); 6505c34c09a8SJoe Perches } 6506c34c09a8SJoe Perches if (!$has_break && $has_statement) { 6507c34c09a8SJoe Perches WARN("MISSING_BREAK", 6508224236d9SAndrew Morton "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr); 6509c34c09a8SJoe Perches } 6510c34c09a8SJoe Perches } 6511c34c09a8SJoe Perches 6512f36d3eb8SJoe Perches# check for /* fallthrough */ like comment, prefer fallthrough; 6513f36d3eb8SJoe Perches my @fallthroughs = ( 6514f36d3eb8SJoe Perches 'fallthrough', 6515f36d3eb8SJoe Perches '@fallthrough@', 6516f36d3eb8SJoe Perches 'lint -fallthrough[ \t]*', 6517f36d3eb8SJoe Perches 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)', 6518f36d3eb8SJoe Perches '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?', 6519f36d3eb8SJoe Perches 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 6520f36d3eb8SJoe Perches 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 6521f36d3eb8SJoe Perches ); 6522f36d3eb8SJoe Perches if ($raw_comment ne '') { 6523f36d3eb8SJoe Perches foreach my $ft (@fallthroughs) { 6524f36d3eb8SJoe Perches if ($raw_comment =~ /$ft/) { 6525f36d3eb8SJoe Perches my $msg_level = \&WARN; 6526f36d3eb8SJoe Perches $msg_level = \&CHK if ($file); 6527f36d3eb8SJoe Perches &{$msg_level}("PREFER_FALLTHROUGH", 6528f36d3eb8SJoe Perches "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr); 6529f36d3eb8SJoe Perches last; 6530f36d3eb8SJoe Perches } 6531f36d3eb8SJoe Perches } 6532f36d3eb8SJoe Perches } 6533f36d3eb8SJoe Perches 6534d1e2ad07SJoe Perches# check for switch/default statements without a break; 65355b57980dSJoe Perches if ($perl_version_ok && 6536d1e2ad07SJoe Perches defined $stat && 6537d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 6538d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 6539e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6540e3d95a2aSTobin C. Harding 6541d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 6542d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 6543caf2a54fSJoe Perches } 6544caf2a54fSJoe Perches 654513214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 6546d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 6547d5e616fcSJoe Perches if (WARN("USE_FUNC", 6548d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 6549d5e616fcSJoe Perches $fix) { 6550194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 6551d5e616fcSJoe Perches } 655213214adfSAndy Whitcroft } 6553773647a0SAndy Whitcroft 655462ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 655562ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 655662ec818fSJoe Perches ERROR("DATE_TIME", 655762ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 655862ec818fSJoe Perches } 655962ec818fSJoe Perches 65602c92488aSJoe Perches# check for use of yield() 65612c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 65622c92488aSJoe Perches WARN("YIELD", 65632c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 65642c92488aSJoe Perches } 65652c92488aSJoe Perches 6566179f8f40SJoe Perches# check for comparisons against true and false 6567179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 6568179f8f40SJoe Perches my $lead = $1; 6569179f8f40SJoe Perches my $arg = $2; 6570179f8f40SJoe Perches my $test = $3; 6571179f8f40SJoe Perches my $otype = $4; 6572179f8f40SJoe Perches my $trail = $5; 6573179f8f40SJoe Perches my $op = "!"; 6574179f8f40SJoe Perches 6575179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 6576179f8f40SJoe Perches 6577179f8f40SJoe Perches my $type = lc($otype); 6578179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 6579179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 6580179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 6581179f8f40SJoe Perches $op = ""; 6582179f8f40SJoe Perches } 6583179f8f40SJoe Perches 6584179f8f40SJoe Perches CHK("BOOL_COMPARISON", 6585179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 6586179f8f40SJoe Perches 6587179f8f40SJoe Perches## maybe suggesting a correct construct would better 6588179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 6589179f8f40SJoe Perches 6590179f8f40SJoe Perches } 6591179f8f40SJoe Perches } 6592179f8f40SJoe Perches 65934882720bSThomas Gleixner# check for semaphores initialized locked 65944882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 6595000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 6596000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 6597773647a0SAndy Whitcroft } 65986712d858SJoe Perches 659967d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 660067d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 6601000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 660267d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 6603773647a0SAndy Whitcroft } 66046712d858SJoe Perches 6605ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 6606f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 6607000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 6608ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 6609f3db6639SMichael Ellerman } 66106712d858SJoe Perches 66113d709ab5SPaul E. McKenney# check for spin_is_locked(), suggest lockdep instead 66123d709ab5SPaul E. McKenney if ($line =~ /\bspin_is_locked\(/) { 66133d709ab5SPaul E. McKenney WARN("USE_LOCKDEP", 66143d709ab5SPaul E. McKenney "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr); 66153d709ab5SPaul E. McKenney } 66163d709ab5SPaul E. McKenney 66179189c7e7SJoe Perches# check for deprecated apis 66189189c7e7SJoe Perches if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) { 66199189c7e7SJoe Perches my $deprecated_api = $1; 66209189c7e7SJoe Perches my $new_api = $deprecated_apis{$deprecated_api}; 66219189c7e7SJoe Perches WARN("DEPRECATED_API", 66229189c7e7SJoe Perches "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr); 66239189c7e7SJoe Perches } 66249189c7e7SJoe Perches 66250f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 6626d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 66276903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 6628d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 6629000d1cc1SJoe Perches WARN("CONST_STRUCT", 6630d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 66312b6db5cbSAndy Whitcroft } 6632773647a0SAndy Whitcroft 6633773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 6634773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 6635773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 6636c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 6637c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 6638171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 6639171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 6640171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 6641773647a0SAndy Whitcroft { 6642000d1cc1SJoe Perches WARN("NR_CPUS", 6643000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 6644773647a0SAndy Whitcroft } 66459c9ba34eSAndy Whitcroft 664652ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 664752ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 664852ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 664952ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 665052ea8506SJoe Perches } 665152ea8506SJoe Perches 6652acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 66535b57980dSJoe Perches if ($perl_version_ok && 6654acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 6655acd9362cSJoe Perches WARN("LIKELY_MISUSE", 6656acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 6657acd9362cSJoe Perches } 6658acd9362cSJoe Perches 6659de3f186fSDenis Efremov# nested likely/unlikely calls 6660de3f186fSDenis Efremov if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) { 6661de3f186fSDenis Efremov WARN("LIKELY_MISUSE", 6662de3f186fSDenis Efremov "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr); 6663de3f186fSDenis Efremov } 6664de3f186fSDenis Efremov 6665691d77b6SAndy Whitcroft# whine mightly about in_atomic 6666691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 6667691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 6668000d1cc1SJoe Perches ERROR("IN_ATOMIC", 6669000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 6670f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 6671000d1cc1SJoe Perches WARN("IN_ATOMIC", 6672000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 6673691d77b6SAndy Whitcroft } 6674691d77b6SAndy Whitcroft } 66751704f47bSPeter Zijlstra 66760f5225b0SPeter Zijlstra# check for mutex_trylock_recursive usage 66770f5225b0SPeter Zijlstra if ($line =~ /mutex_trylock_recursive/) { 66780f5225b0SPeter Zijlstra ERROR("LOCKING", 66790f5225b0SPeter Zijlstra "recursive locking is bad, do not use this ever.\n" . $herecurr); 66800f5225b0SPeter Zijlstra } 66810f5225b0SPeter Zijlstra 66821704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 66831704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 66841704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 66851704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 66861704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 66871704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 6688000d1cc1SJoe Perches ERROR("LOCKDEP", 6689000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 66901704f47bSPeter Zijlstra } 66911704f47bSPeter Zijlstra } 669288f8831cSDave Jones 6693b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 6694b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 6695000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 6696000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 669788f8831cSDave Jones } 66982435880fSJoe Perches 669900180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 670000180468SJoe Perches# and whether or not function naming is typical and if 670100180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 67025b57980dSJoe Perches if ($perl_version_ok && 670300180468SJoe Perches defined $stat && 670400180468SJoe 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*\)/) { 670500180468SJoe Perches my $var = $1; 670600180468SJoe Perches my $perms = $2; 670700180468SJoe Perches my $show = $3; 670800180468SJoe Perches my $store = $4; 670900180468SJoe Perches my $octal_perms = perms_to_octal($perms); 671000180468SJoe Perches if ($show =~ /^${var}_show$/ && 671100180468SJoe Perches $store =~ /^${var}_store$/ && 671200180468SJoe Perches $octal_perms eq "0644") { 671300180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 671400180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 671500180468SJoe Perches $fix) { 671600180468SJoe 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})/; 671700180468SJoe Perches } 671800180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 671900180468SJoe Perches $store =~ /^NULL$/ && 672000180468SJoe Perches $octal_perms eq "0444") { 672100180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 672200180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 672300180468SJoe Perches $fix) { 672400180468SJoe 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})/; 672500180468SJoe Perches } 672600180468SJoe Perches } elsif ($show =~ /^NULL$/ && 672700180468SJoe Perches $store =~ /^${var}_store$/ && 672800180468SJoe Perches $octal_perms eq "0200") { 672900180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 673000180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 673100180468SJoe Perches $fix) { 673200180468SJoe 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})/; 673300180468SJoe Perches } 673400180468SJoe Perches } elsif ($octal_perms eq "0644" || 673500180468SJoe Perches $octal_perms eq "0444" || 673600180468SJoe Perches $octal_perms eq "0200") { 673700180468SJoe Perches my $newshow = "$show"; 673800180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 673900180468SJoe Perches my $newstore = $store; 674000180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 674100180468SJoe Perches my $rename = ""; 674200180468SJoe Perches if ($show ne $newshow) { 674300180468SJoe Perches $rename .= " '$show' to '$newshow'"; 674400180468SJoe Perches } 674500180468SJoe Perches if ($store ne $newstore) { 674600180468SJoe Perches $rename .= " '$store' to '$newstore'"; 674700180468SJoe Perches } 674800180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 674900180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 675000180468SJoe Perches } else { 675100180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 675200180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 675300180468SJoe Perches } 675400180468SJoe Perches } 675500180468SJoe Perches 6756515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 6757515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 675873121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 675973121534SJoe Perches# specific definition of not visible in sysfs. 676073121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 676173121534SJoe Perches# use the default permissions 67625b57980dSJoe Perches if ($perl_version_ok && 6763459cf0aeSJoe Perches defined $stat && 6764515a235eSJoe Perches $line =~ /$mode_perms_search/) { 67652435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 67662435880fSJoe Perches my $func = $entry->[0]; 67672435880fSJoe Perches my $arg_pos = $entry->[1]; 67682435880fSJoe Perches 6769459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 6770459cf0aeSJoe Perches $lc = $lc + $linenr; 67712a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6772459cf0aeSJoe Perches 67732435880fSJoe Perches my $skip_args = ""; 67742435880fSJoe Perches if ($arg_pos > 1) { 67752435880fSJoe Perches $arg_pos--; 67762435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 67772435880fSJoe Perches } 6778f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 6779459cf0aeSJoe Perches if ($stat =~ /$test/) { 67802435880fSJoe Perches my $val = $1; 67812435880fSJoe Perches $val = $6 if ($skip_args ne ""); 678273121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 678373121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 678473121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 67852435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 6786459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 6787f90774e1SJoe Perches } 6788f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6789c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6790459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 67912435880fSJoe Perches } 6792459cf0aeSJoe Perches } 6793459cf0aeSJoe Perches } 6794459cf0aeSJoe Perches } 6795459cf0aeSJoe Perches 6796459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 6797bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 679800180468SJoe Perches my $oval = $1; 679900180468SJoe Perches my $octal = perms_to_octal($oval); 6800f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 6801459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 6802f90774e1SJoe Perches $fix) { 680300180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 68042435880fSJoe Perches } 680513214adfSAndy Whitcroft } 68065a6d20ceSBjorn Andersson 68075a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 68085a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 68095a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 68105a6d20ceSBjorn Andersson my $valid_licenses = qr{ 68115a6d20ceSBjorn Andersson GPL| 68125a6d20ceSBjorn Andersson GPL\ v2| 68135a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 68145a6d20ceSBjorn Andersson Dual\ BSD/GPL| 68155a6d20ceSBjorn Andersson Dual\ MIT/GPL| 68165a6d20ceSBjorn Andersson Dual\ MPL/GPL| 68175a6d20ceSBjorn Andersson Proprietary 68185a6d20ceSBjorn Andersson }x; 68195a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 68205a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 68215a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 68225a6d20ceSBjorn Andersson } 68235a6d20ceSBjorn Andersson } 68246a8d76cbSMatteo Croce 68256a8d76cbSMatteo Croce# check for sysctl duplicate constants 68266a8d76cbSMatteo Croce if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) { 68276a8d76cbSMatteo Croce WARN("DUPLICATED_SYSCTL_CONST", 68286a8d76cbSMatteo Croce "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr); 68296a8d76cbSMatteo Croce } 6830515a235eSJoe Perches } 683113214adfSAndy Whitcroft 683213214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 683313214adfSAndy Whitcroft # so just keep quiet. 683413214adfSAndy Whitcroft if ($#rawlines == -1) { 683513214adfSAndy Whitcroft exit(0); 68360a920b5bSAndy Whitcroft } 68370a920b5bSAndy Whitcroft 68388905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 68398905a67cSAndy Whitcroft # things that appear to be patches. 68408905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 68418905a67cSAndy Whitcroft exit(0); 68428905a67cSAndy Whitcroft } 68438905a67cSAndy Whitcroft 68448905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 68458905a67cSAndy Whitcroft # just keep quiet. 68468905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 68478905a67cSAndy Whitcroft exit(0); 68488905a67cSAndy Whitcroft } 68498905a67cSAndy Whitcroft 6850a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 6851000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6852000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 68530a920b5bSAndy Whitcroft } 6854cd261496SGeert Uytterhoeven if ($is_patch && $has_commit_log && $chk_signoff) { 6855cd261496SGeert Uytterhoeven if ($signoff == 0) { 6856000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6857000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 6858cd261496SGeert Uytterhoeven } elsif (!$authorsignoff) { 6859cd261496SGeert Uytterhoeven WARN("NO_AUTHOR_SIGN_OFF", 6860cd261496SGeert Uytterhoeven "Missing Signed-off-by: line by nominal patch author '$author'\n"); 6861cd261496SGeert Uytterhoeven } 68620a920b5bSAndy Whitcroft } 68630a920b5bSAndy Whitcroft 6864f0a594c1SAndy Whitcroft print report_dump(); 686513214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 686613214adfSAndy Whitcroft print "$filename " if ($summary_file); 68676c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 68686c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 68696c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 68706c72ffaaSAndy Whitcroft } 68718905a67cSAndy Whitcroft 6872d2c0a235SAndy Whitcroft if ($quiet == 0) { 6873ef212196SJoe Perches # If there were any defects found and not already fixing them 6874ef212196SJoe Perches if (!$clean and !$fix) { 6875ef212196SJoe Perches print << "EOM" 6876ef212196SJoe Perches 6877ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 6878ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 6879ef212196SJoe PerchesEOM 6880ef212196SJoe Perches } 6881d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 6882d2c0a235SAndy Whitcroft # then suggest that. 6883d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 6884b0781216SMike Frysinger $rpt_cleaners = 0; 6885d8469f16SJoe Perches print << "EOM" 6886d8469f16SJoe Perches 6887d8469f16SJoe PerchesNOTE: Whitespace errors detected. 6888d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 6889d8469f16SJoe PerchesEOM 6890d2c0a235SAndy Whitcroft } 6891d2c0a235SAndy Whitcroft } 6892d2c0a235SAndy Whitcroft 6893d752fcc8SJoe Perches if ($clean == 0 && $fix && 6894d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 6895d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 68969624b8d6SJoe Perches my $newfile = $filename; 68979624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 68983705ce5bSJoe Perches my $linecount = 0; 68993705ce5bSJoe Perches my $f; 69003705ce5bSJoe Perches 6901d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 6902d752fcc8SJoe Perches 69033705ce5bSJoe Perches open($f, '>', $newfile) 69043705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 69053705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 69063705ce5bSJoe Perches $linecount++; 69073705ce5bSJoe Perches if ($file) { 69083705ce5bSJoe Perches if ($linecount > 3) { 69093705ce5bSJoe Perches $fixed_line =~ s/^\+//; 69103705ce5bSJoe Perches print $f $fixed_line . "\n"; 69113705ce5bSJoe Perches } 69123705ce5bSJoe Perches } else { 69133705ce5bSJoe Perches print $f $fixed_line . "\n"; 69143705ce5bSJoe Perches } 69153705ce5bSJoe Perches } 69163705ce5bSJoe Perches close($f); 69173705ce5bSJoe Perches 69183705ce5bSJoe Perches if (!$quiet) { 69193705ce5bSJoe Perches print << "EOM"; 6920d8469f16SJoe Perches 69213705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 69223705ce5bSJoe Perches 69233705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 69243705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 69253705ce5bSJoe Perches 69263705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 69273705ce5bSJoe PerchesNo warranties, expressed or implied... 69283705ce5bSJoe PerchesEOM 69293705ce5bSJoe Perches } 69303705ce5bSJoe Perches } 69313705ce5bSJoe Perches 6932d8469f16SJoe Perches if ($quiet == 0) { 6933d8469f16SJoe Perches print "\n"; 6934d8469f16SJoe Perches if ($clean == 1) { 6935d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 6936d8469f16SJoe Perches } else { 6937d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 69380a920b5bSAndy Whitcroft } 69390a920b5bSAndy Whitcroft } 69400a920b5bSAndy Whitcroft return $clean; 69410a920b5bSAndy Whitcroft} 6942