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"; 546cd7f386SJoe Perchesmy $max_line_length = 80; 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"; 64dadf680dSJoe Perchesmy $allow_c99_comments = 1; 6577f5b10aSHannes Eder 6677f5b10aSHannes Edersub help { 6777f5b10aSHannes Eder my ($exitcode) = @_; 6877f5b10aSHannes Eder 6977f5b10aSHannes Eder print << "EOM"; 7077f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 7177f5b10aSHannes EderVersion: $V 7277f5b10aSHannes Eder 7377f5b10aSHannes EderOptions: 7477f5b10aSHannes Eder -q, --quiet quiet 7577f5b10aSHannes Eder --no-tree run without a kernel tree 7677f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 7777f5b10aSHannes Eder --patch treat FILE as patchfile (default) 7877f5b10aSHannes Eder --emacs emacs compile window format 7977f5b10aSHannes Eder --terse one line per report 8034d8815fSJoe Perches --showfile emit diffed file position, not input file position 814a593c34SDu, Changbin -g, --git treat FILE as a single commit or git revision range 824a593c34SDu, Changbin single git commit with: 834a593c34SDu, Changbin <rev> 844a593c34SDu, Changbin <rev>^ 854a593c34SDu, Changbin <rev>~n 864a593c34SDu, Changbin multiple git commits with: 874a593c34SDu, Changbin <rev1>..<rev2> 884a593c34SDu, Changbin <rev1>...<rev2> 894a593c34SDu, Changbin <rev>-<count> 904a593c34SDu, Changbin git merges are ignored 9177f5b10aSHannes Eder -f, --file treat FILE as regular source file 9277f5b10aSHannes Eder --subjective, --strict enable more subjective tests 933beb42ecSJoe Perches --list-types list the possible message types 9491bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 95000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 963beb42ecSJoe Perches --show-types show the specific message type in the output 976cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 9856193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 9977f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 10077f5b10aSHannes Eder --no-summary suppress the per-file summary 10177f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 10277f5b10aSHannes Eder --summary-file include the filename in summary 10377f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 10477f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 10577f5b10aSHannes Eder is all off) 10677f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 10777f5b10aSHannes Eder literally 1083705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 1093705ce5bSJoe Perches If correctable single-line errors exist, create 1103705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 1113705ce5bSJoe Perches with potential errors corrected to the preferred 1123705ce5bSJoe Perches checkpatch style 1139624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 1149624b8d6SJoe Perches Is the same as --fix, but overwrites the input 1159624b8d6SJoe Perches file. It's your fault if there's no backup or git 116d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 117d62a201fSDave Hansen runtime errors. 118ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 119f1a63678SMaxim Uvarov (default:/usr/share/codespell/dictionary.txt) 120ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 12175ad8c57SJerome Forissier --typedefsfile Read additional types from this file 122737c0767SJohn Brooks --color[=WHEN] Use colors 'always', 'never', or only when output 123737c0767SJohn Brooks is a terminal ('auto'). Default is 'auto'. 12477f5b10aSHannes Eder -h, --help, --version display this help and exit 12577f5b10aSHannes Eder 12677f5b10aSHannes EderWhen FILE is - read standard input. 12777f5b10aSHannes EderEOM 12877f5b10aSHannes Eder 12977f5b10aSHannes Eder exit($exitcode); 13077f5b10aSHannes Eder} 13177f5b10aSHannes Eder 1323beb42ecSJoe Perchessub uniq { 1333beb42ecSJoe Perches my %seen; 1343beb42ecSJoe Perches return grep { !$seen{$_}++ } @_; 1353beb42ecSJoe Perches} 1363beb42ecSJoe Perches 1373beb42ecSJoe Perchessub list_types { 1383beb42ecSJoe Perches my ($exitcode) = @_; 1393beb42ecSJoe Perches 1403beb42ecSJoe Perches my $count = 0; 1413beb42ecSJoe Perches 1423beb42ecSJoe Perches local $/ = undef; 1433beb42ecSJoe Perches 1443beb42ecSJoe Perches open(my $script, '<', abs_path($P)) or 1453beb42ecSJoe Perches die "$P: Can't read '$P' $!\n"; 1463beb42ecSJoe Perches 1473beb42ecSJoe Perches my $text = <$script>; 1483beb42ecSJoe Perches close($script); 1493beb42ecSJoe Perches 1503beb42ecSJoe Perches my @types = (); 1510547fa58SJean Delvare # Also catch when type or level is passed through a variable 1520547fa58SJean Delvare for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) { 1533beb42ecSJoe Perches push (@types, $_); 1543beb42ecSJoe Perches } 1553beb42ecSJoe Perches @types = sort(uniq(@types)); 1563beb42ecSJoe Perches print("#\tMessage type\n\n"); 1573beb42ecSJoe Perches foreach my $type (@types) { 1583beb42ecSJoe Perches print(++$count . "\t" . $type . "\n"); 1593beb42ecSJoe Perches } 1603beb42ecSJoe Perches 1613beb42ecSJoe Perches exit($exitcode); 1623beb42ecSJoe Perches} 1633beb42ecSJoe Perches 164000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 165000d1cc1SJoe Perchesif (-f $conf) { 166000d1cc1SJoe Perches my @conf_args; 167000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 168000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 169000d1cc1SJoe Perches 170000d1cc1SJoe Perches while (<$conffile>) { 171000d1cc1SJoe Perches my $line = $_; 172000d1cc1SJoe Perches 173000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 174000d1cc1SJoe Perches $line =~ s/^\s*//g; 175000d1cc1SJoe Perches $line =~ s/\s+/ /g; 176000d1cc1SJoe Perches 177000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 178000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 179000d1cc1SJoe Perches 180000d1cc1SJoe Perches my @words = split(" ", $line); 181000d1cc1SJoe Perches foreach my $word (@words) { 182000d1cc1SJoe Perches last if ($word =~ m/^#/); 183000d1cc1SJoe Perches push (@conf_args, $word); 184000d1cc1SJoe Perches } 185000d1cc1SJoe Perches } 186000d1cc1SJoe Perches close($conffile); 187000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 188000d1cc1SJoe Perches} 189000d1cc1SJoe Perches 190737c0767SJohn Brooks# Perl's Getopt::Long allows options to take optional arguments after a space. 191737c0767SJohn Brooks# Prevent --color by itself from consuming other arguments 192737c0767SJohn Brooksforeach (@ARGV) { 193737c0767SJohn Brooks if ($_ eq "--color" || $_ eq "-color") { 194737c0767SJohn Brooks $_ = "--color=$color"; 195737c0767SJohn Brooks } 196737c0767SJohn Brooks} 197737c0767SJohn Brooks 1980a920b5bSAndy WhitcroftGetOptions( 1996c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 2000a920b5bSAndy Whitcroft 'tree!' => \$tree, 2010a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 2020a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 2036c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 2048905a67cSAndy Whitcroft 'terse!' => \$terse, 20534d8815fSJoe Perches 'showfile!' => \$showfile, 20677f5b10aSHannes Eder 'f|file!' => \$file, 2074a593c34SDu, Changbin 'g|git!' => \$git, 2086c72ffaaSAndy Whitcroft 'subjective!' => \$check, 2096c72ffaaSAndy Whitcroft 'strict!' => \$check, 210000d1cc1SJoe Perches 'ignore=s' => \@ignore, 21191bfe484SJoe Perches 'types=s' => \@use, 212000d1cc1SJoe Perches 'show-types!' => \$show_types, 2133beb42ecSJoe Perches 'list-types!' => \$list_types, 2146cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 21556193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 2166c72ffaaSAndy Whitcroft 'root=s' => \$root, 2178905a67cSAndy Whitcroft 'summary!' => \$summary, 2188905a67cSAndy Whitcroft 'mailback!' => \$mailback, 21913214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 2203705ce5bSJoe Perches 'fix!' => \$fix, 2219624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 222d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 223c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 224773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 225ebfd7d62SJoe Perches 'codespell!' => \$codespell, 226ebfd7d62SJoe Perches 'codespellfile=s' => \$codespellfile, 22775ad8c57SJerome Forissier 'typedefsfile=s' => \$typedefsfile, 228737c0767SJohn Brooks 'color=s' => \$color, 229737c0767SJohn Brooks 'no-color' => \$color, #keep old behaviors of -nocolor 230737c0767SJohn Brooks 'nocolor' => \$color, #keep old behaviors of -nocolor 23177f5b10aSHannes Eder 'h|help' => \$help, 23277f5b10aSHannes Eder 'version' => \$help 23377f5b10aSHannes Eder) or help(1); 23477f5b10aSHannes Eder 23577f5b10aSHannes Ederhelp(0) if ($help); 2360a920b5bSAndy Whitcroft 2373beb42ecSJoe Percheslist_types(0) if ($list_types); 2383beb42ecSJoe Perches 2399624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 2402ac73b4fSJoe Perches$check_orig = $check; 2419624b8d6SJoe Perches 2420a920b5bSAndy Whitcroftmy $exit = 0; 2430a920b5bSAndy Whitcroft 2445b57980dSJoe Perchesmy $perl_version_ok = 1; 245d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 2465b57980dSJoe Perches $perl_version_ok = 0; 247d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 2485b57980dSJoe Perches exit(1) if (!$ignore_perl_version); 249d62a201fSDave Hansen} 250d62a201fSDave Hansen 25145107ff6SAllen Hubbe#if no filenames are given, push '-' to read patch from stdin 2520a920b5bSAndy Whitcroftif ($#ARGV < 0) { 25345107ff6SAllen Hubbe push(@ARGV, '-'); 2540a920b5bSAndy Whitcroft} 2550a920b5bSAndy Whitcroft 256737c0767SJohn Brooksif ($color =~ /^[01]$/) { 257737c0767SJohn Brooks $color = !$color; 258737c0767SJohn Brooks} elsif ($color =~ /^always$/i) { 259737c0767SJohn Brooks $color = 1; 260737c0767SJohn Brooks} elsif ($color =~ /^never$/i) { 261737c0767SJohn Brooks $color = 0; 262737c0767SJohn Brooks} elsif ($color =~ /^auto$/i) { 263737c0767SJohn Brooks $color = (-t STDOUT); 264737c0767SJohn Brooks} else { 265737c0767SJohn Brooks die "Invalid color mode: $color\n"; 266737c0767SJohn Brooks} 267737c0767SJohn Brooks 26891bfe484SJoe Perchessub hash_save_array_words { 26991bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 27091bfe484SJoe Perches 27191bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 27291bfe484SJoe Perches foreach my $word (@array) { 273000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 274000d1cc1SJoe Perches $word =~ s/^\s*//g; 275000d1cc1SJoe Perches $word =~ s/\s+/ /g; 276000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 277000d1cc1SJoe Perches 278000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 279000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 280000d1cc1SJoe Perches 28191bfe484SJoe Perches $hashRef->{$word}++; 282000d1cc1SJoe Perches } 28391bfe484SJoe Perches} 28491bfe484SJoe Perches 28591bfe484SJoe Perchessub hash_show_words { 28691bfe484SJoe Perches my ($hashRef, $prefix) = @_; 28791bfe484SJoe Perches 2883c816e49SJoe Perches if (keys %$hashRef) { 289d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 29058cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 29191bfe484SJoe Perches print " $word"; 29291bfe484SJoe Perches } 293d8469f16SJoe Perches print "\n"; 29491bfe484SJoe Perches } 29591bfe484SJoe Perches} 29691bfe484SJoe Perches 29791bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 29891bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 299000d1cc1SJoe Perches 300c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 301c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 3027429c690SAndy Whitcroftmy $dbg_type = 0; 303a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 304c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 30521caa13cSAndy Whitcroft ## no critic 30621caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 30721caa13cSAndy Whitcroft die "$@" if ($@); 308c2fdda0dSAndy Whitcroft} 309c2fdda0dSAndy Whitcroft 310d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 311d2c0a235SAndy Whitcroft 3128905a67cSAndy Whitcroftif ($terse) { 3138905a67cSAndy Whitcroft $emacs = 1; 3148905a67cSAndy Whitcroft $quiet++; 3158905a67cSAndy Whitcroft} 3168905a67cSAndy Whitcroft 3176c72ffaaSAndy Whitcroftif ($tree) { 3186c72ffaaSAndy Whitcroft if (defined $root) { 3196c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 3206c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 3216c72ffaaSAndy Whitcroft } 3226c72ffaaSAndy Whitcroft } else { 3236c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 3246c72ffaaSAndy Whitcroft $root = '.'; 3256c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 3266c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 3276c72ffaaSAndy Whitcroft $root = $1; 3286c72ffaaSAndy Whitcroft } 3296c72ffaaSAndy Whitcroft } 3306c72ffaaSAndy Whitcroft 3316c72ffaaSAndy Whitcroft if (!defined $root) { 3320a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 3330a920b5bSAndy Whitcroft exit(2); 3340a920b5bSAndy Whitcroft } 3356c72ffaaSAndy Whitcroft} 3366c72ffaaSAndy Whitcroft 3376c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 3386c72ffaaSAndy Whitcroft 3392ceb532bSAndy Whitcroftour $Ident = qr{ 3402ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 3412ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 3422ceb532bSAndy Whitcroft }x; 3436c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 3446c72ffaaSAndy Whitcroftour $Sparse = qr{ 3456c72ffaaSAndy Whitcroft __user| 3466c72ffaaSAndy Whitcroft __kernel| 3476c72ffaaSAndy Whitcroft __force| 3486c72ffaaSAndy Whitcroft __iomem| 3496c72ffaaSAndy Whitcroft __must_check| 350417495edSAndy Whitcroft __kprobes| 351165e72a6SSven Eckelmann __ref| 35233aa4597SGeert Uytterhoeven __refconst| 35333aa4597SGeert Uytterhoeven __refdata| 354ad315455SBoqun Feng __rcu| 355ad315455SBoqun Feng __private 3566c72ffaaSAndy Whitcroft }x; 357e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 358e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 359e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 360e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 361e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 3628716de38SJoe Perches 36352131292SWolfram Sang# Notes to $Attribute: 36452131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 3656c72ffaaSAndy Whitcroftour $Attribute = qr{ 3666c72ffaaSAndy Whitcroft const| 36703f1df7dSJoe Perches __percpu| 36803f1df7dSJoe Perches __nocast| 36903f1df7dSJoe Perches __safe| 37046d832f5SMichael S. Tsirkin __bitwise| 37103f1df7dSJoe Perches __packed__| 37203f1df7dSJoe Perches __packed2__| 37303f1df7dSJoe Perches __naked| 37403f1df7dSJoe Perches __maybe_unused| 37503f1df7dSJoe Perches __always_unused| 37603f1df7dSJoe Perches __noreturn| 37703f1df7dSJoe Perches __used| 37803f1df7dSJoe Perches __cold| 379e23ef1f3SJoe Perches __pure| 38003f1df7dSJoe Perches __noclone| 38103f1df7dSJoe Perches __deprecated| 3826c72ffaaSAndy Whitcroft __read_mostly| 383c5967e98SJoe Perches __ro_after_init| 3846c72ffaaSAndy Whitcroft __kprobes| 3858716de38SJoe Perches $InitAttribute| 38624e1d81aSAndy Whitcroft ____cacheline_aligned| 38724e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 3885fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 3895fe3af11SAndy Whitcroft __weak 3906c72ffaaSAndy Whitcroft }x; 391c45dcabdSAndy Whitcroftour $Modifier; 39291cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 3936c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 3946c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 3956c72ffaaSAndy Whitcroft 39695e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 39795e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 39895e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 39995e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 4002435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 401c0a5c898SJoe Perchesour $String = qr{"[X\t]*"}; 402326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 403326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 404326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 40574349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 4062435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 407326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 408447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 40923f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 4106c72ffaaSAndy Whitcroftour $Operators = qr{ 4116c72ffaaSAndy Whitcroft <=|>=|==|!=| 4126c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 41323f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 4146c72ffaaSAndy Whitcroft }x; 4156c72ffaaSAndy Whitcroft 41691cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 41791cb5195SJoe Perches 418ab7e23f3SJoe Perchesour $BasicType; 4198905a67cSAndy Whitcroftour $NonptrType; 4201813087dSJoe Perchesour $NonptrTypeMisordered; 4218716de38SJoe Perchesour $NonptrTypeWithAttr; 4228905a67cSAndy Whitcroftour $Type; 4231813087dSJoe Perchesour $TypeMisordered; 4248905a67cSAndy Whitcroftour $Declare; 4251813087dSJoe Perchesour $DeclareMisordered; 4268905a67cSAndy Whitcroft 42715662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 42815662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 429171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 430171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 431171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 432171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 433171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 434171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 435171ae1a4SAndy Whitcroft}x; 436171ae1a4SAndy Whitcroft 43715662b3eSJoe Perchesour $UTF8 = qr{ 43815662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 43915662b3eSJoe Perches | $NON_ASCII_UTF8 44015662b3eSJoe Perches}x; 44115662b3eSJoe Perches 442e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 443021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 444021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 445021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 446021158b4SJoe Perches)}; 447e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 448fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 4498ed22cadSAndy Whitcroft atomic_t 4508ed22cadSAndy Whitcroft)}; 451e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 452e6176fa4SJoe Perches $typeC99Typedefs\b| 453e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 454e6176fa4SJoe Perches $typeKernelTypedefs\b 455e6176fa4SJoe Perches)}; 4568ed22cadSAndy Whitcroft 4576d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 4586d32f7a3SJoe Perches 459691e669bSJoe Perchesour $logFunctions = qr{(?x: 460758d7aadSMiles Chen printk(?:_ratelimited|_once|_deferred_once|_deferred|)| 4617d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 46287bd499aSJoe Perches TP_printk| 4636e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 464b0531722SJoe Perches panic| 46506668727SJoe Perches MODULE_[A-Z_]+| 46606668727SJoe Perches seq_vprintf|seq_printf|seq_puts 467691e669bSJoe Perches)}; 468691e669bSJoe Perches 46920112475SJoe Perchesour $signature_tags = qr{(?xi: 47020112475SJoe Perches Signed-off-by:| 47120112475SJoe Perches Acked-by:| 47220112475SJoe Perches Tested-by:| 47320112475SJoe Perches Reviewed-by:| 47420112475SJoe Perches Reported-by:| 4758543ae12SMugunthan V N Suggested-by:| 47620112475SJoe Perches To:| 47720112475SJoe Perches Cc: 47820112475SJoe Perches)}; 47920112475SJoe Perches 4801813087dSJoe Perchesour @typeListMisordered = ( 4811813087dSJoe Perches qr{char\s+(?:un)?signed}, 4821813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 4831813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 4841813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 4851813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 4861813087dSJoe Perches qr{short\s+(?:un)?signed}, 4871813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 4881813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 4891813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 4901813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 4911813087dSJoe Perches qr{int\s+(?:un)?signed}, 4921813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 4931813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 4941813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 4951813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 4961813087dSJoe Perches qr{long\s+(?:un)?signed}, 4971813087dSJoe Perches); 4981813087dSJoe Perches 4998905a67cSAndy Whitcroftour @typeList = ( 5008905a67cSAndy Whitcroft qr{void}, 5010c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 5020c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 5030c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 5040c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 5050c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 5060c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 5070c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 5080c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 5090c773d9dSJoe Perches qr{(?:un)?signed}, 5108905a67cSAndy Whitcroft qr{float}, 5118905a67cSAndy Whitcroft qr{double}, 5128905a67cSAndy Whitcroft qr{bool}, 5138905a67cSAndy Whitcroft qr{struct\s+$Ident}, 5148905a67cSAndy Whitcroft qr{union\s+$Ident}, 5158905a67cSAndy Whitcroft qr{enum\s+$Ident}, 5168905a67cSAndy Whitcroft qr{${Ident}_t}, 5178905a67cSAndy Whitcroft qr{${Ident}_handler}, 5188905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 5191813087dSJoe Perches @typeListMisordered, 5208905a67cSAndy Whitcroft); 521938224b5SJoe Perches 522938224b5SJoe Perchesour $C90_int_types = qr{(?x: 523938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 524938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 525938224b5SJoe Perches long\s+long\s+(?:un)?signed| 526938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 527938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 528938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 529938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 530938224b5SJoe Perches 531938224b5SJoe Perches long\s+int\s+(?:un)?signed| 532938224b5SJoe Perches long\s+(?:un)?signed\s+int| 533938224b5SJoe Perches long\s+(?:un)?signed| 534938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 535938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 536938224b5SJoe Perches int\s+long\s+(?:un)?signed| 537938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 538938224b5SJoe Perches 539938224b5SJoe Perches int\s+(?:un)?signed| 540938224b5SJoe Perches (?:(?:un)?signed\s+)?int 541938224b5SJoe Perches)}; 542938224b5SJoe Perches 543485ff23eSAlex Dowadour @typeListFile = (); 5448716de38SJoe Perchesour @typeListWithAttr = ( 5458716de38SJoe Perches @typeList, 5468716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 5478716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 5488716de38SJoe Perches); 5498716de38SJoe Perches 550c45dcabdSAndy Whitcroftour @modifierList = ( 551c45dcabdSAndy Whitcroft qr{fastcall}, 552c45dcabdSAndy Whitcroft); 553485ff23eSAlex Dowadour @modifierListFile = (); 5548905a67cSAndy Whitcroft 5552435880fSJoe Perchesour @mode_permission_funcs = ( 5562435880fSJoe Perches ["module_param", 3], 5572435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 5582435880fSJoe Perches ["module_param_array_named", 5], 5592435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 5602435880fSJoe Perches ["proc_create(?:_data|)", 2], 561459cf0aeSJoe Perches ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2], 562459cf0aeSJoe Perches ["IIO_DEV_ATTR_[A-Z_]+", 1], 563459cf0aeSJoe Perches ["SENSOR_(?:DEVICE_|)ATTR_2", 2], 564459cf0aeSJoe Perches ["SENSOR_TEMPLATE(?:_2|)", 3], 565459cf0aeSJoe Perches ["__ATTR", 2], 5662435880fSJoe Perches); 5672435880fSJoe Perches 568515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 569515a235eSJoe Perchesour $mode_perms_search = ""; 570515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 571515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 572515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 573515a235eSJoe Perches} 57400180468SJoe Perches$mode_perms_search = "(?:${mode_perms_search})"; 575515a235eSJoe Perches 5769189c7e7SJoe Perchesour %deprecated_apis = ( 5779189c7e7SJoe Perches "synchronize_rcu_bh" => "synchronize_rcu", 5789189c7e7SJoe Perches "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited", 5799189c7e7SJoe Perches "call_rcu_bh" => "call_rcu", 5809189c7e7SJoe Perches "rcu_barrier_bh" => "rcu_barrier", 5819189c7e7SJoe Perches "synchronize_sched" => "synchronize_rcu", 5829189c7e7SJoe Perches "synchronize_sched_expedited" => "synchronize_rcu_expedited", 5839189c7e7SJoe Perches "call_rcu_sched" => "call_rcu", 5849189c7e7SJoe Perches "rcu_barrier_sched" => "rcu_barrier", 5859189c7e7SJoe Perches "get_state_synchronize_sched" => "get_state_synchronize_rcu", 5869189c7e7SJoe Perches "cond_synchronize_sched" => "cond_synchronize_rcu", 5879189c7e7SJoe Perches); 5889189c7e7SJoe Perches 5899189c7e7SJoe Perches#Create a search pattern for all these strings to speed up a loop below 5909189c7e7SJoe Perchesour $deprecated_apis_search = ""; 5919189c7e7SJoe Perchesforeach my $entry (keys %deprecated_apis) { 5929189c7e7SJoe Perches $deprecated_apis_search .= '|' if ($deprecated_apis_search ne ""); 5939189c7e7SJoe Perches $deprecated_apis_search .= $entry; 5949189c7e7SJoe Perches} 5959189c7e7SJoe Perches$deprecated_apis_search = "(?:${deprecated_apis_search})"; 5969189c7e7SJoe Perches 597b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 598b392c64fSJoe Perches S_IWUGO | 599b392c64fSJoe Perches S_IWOTH | 600b392c64fSJoe Perches S_IRWXUGO | 601b392c64fSJoe Perches S_IALLUGO | 602b392c64fSJoe Perches 0[0-7][0-7][2367] 603b392c64fSJoe Perches}x; 604b392c64fSJoe Perches 605f90774e1SJoe Perchesour %mode_permission_string_types = ( 606f90774e1SJoe Perches "S_IRWXU" => 0700, 607f90774e1SJoe Perches "S_IRUSR" => 0400, 608f90774e1SJoe Perches "S_IWUSR" => 0200, 609f90774e1SJoe Perches "S_IXUSR" => 0100, 610f90774e1SJoe Perches "S_IRWXG" => 0070, 611f90774e1SJoe Perches "S_IRGRP" => 0040, 612f90774e1SJoe Perches "S_IWGRP" => 0020, 613f90774e1SJoe Perches "S_IXGRP" => 0010, 614f90774e1SJoe Perches "S_IRWXO" => 0007, 615f90774e1SJoe Perches "S_IROTH" => 0004, 616f90774e1SJoe Perches "S_IWOTH" => 0002, 617f90774e1SJoe Perches "S_IXOTH" => 0001, 618f90774e1SJoe Perches "S_IRWXUGO" => 0777, 619f90774e1SJoe Perches "S_IRUGO" => 0444, 620f90774e1SJoe Perches "S_IWUGO" => 0222, 621f90774e1SJoe Perches "S_IXUGO" => 0111, 622f90774e1SJoe Perches); 623f90774e1SJoe Perches 624f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below 625f90774e1SJoe Perchesour $mode_perms_string_search = ""; 626f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) { 627f90774e1SJoe Perches $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); 628f90774e1SJoe Perches $mode_perms_string_search .= $entry; 629f90774e1SJoe Perches} 63000180468SJoe Perchesour $single_mode_perms_string_search = "(?:${mode_perms_string_search})"; 63100180468SJoe Perchesour $multi_mode_perms_string_search = qr{ 63200180468SJoe Perches ${single_mode_perms_string_search} 63300180468SJoe Perches (?:\s*\|\s*${single_mode_perms_string_search})* 63400180468SJoe Perches}x; 63500180468SJoe Perches 63600180468SJoe Perchessub perms_to_octal { 63700180468SJoe Perches my ($string) = @_; 63800180468SJoe Perches 63900180468SJoe Perches return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/); 64000180468SJoe Perches 64100180468SJoe Perches my $val = ""; 64200180468SJoe Perches my $oval = ""; 64300180468SJoe Perches my $to = 0; 64400180468SJoe Perches my $curpos = 0; 64500180468SJoe Perches my $lastpos = 0; 64600180468SJoe Perches while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) { 64700180468SJoe Perches $curpos = pos($string); 64800180468SJoe Perches my $match = $2; 64900180468SJoe Perches my $omatch = $1; 65000180468SJoe Perches last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos)); 65100180468SJoe Perches $lastpos = $curpos; 65200180468SJoe Perches $to |= $mode_permission_string_types{$match}; 65300180468SJoe Perches $val .= '\s*\|\s*' if ($val ne ""); 65400180468SJoe Perches $val .= $match; 65500180468SJoe Perches $oval .= $omatch; 65600180468SJoe Perches } 65700180468SJoe Perches $oval =~ s/^\s*\|\s*//; 65800180468SJoe Perches $oval =~ s/\s*\|\s*$//; 65900180468SJoe Perches return sprintf("%04o", $to); 66000180468SJoe Perches} 661f90774e1SJoe Perches 6627840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 6637840a94cSWolfram Sang irq| 664cdcee686SSergey Ryazanov memory| 665cdcee686SSergey Ryazanov time| 666cdcee686SSergey Ryazanov reboot 6677840a94cSWolfram Sang)}; 6687840a94cSWolfram Sang# memory.h: ARM has a custom one 6697840a94cSWolfram Sang 67066b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 67166b47b4aSKees Cookmy $misspellings; 67266b47b4aSKees Cookmy %spelling_fix; 67336061e38SJoe Perches 67436061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 67566b47b4aSKees Cook while (<$spelling>) { 67666b47b4aSKees Cook my $line = $_; 67766b47b4aSKees Cook 67866b47b4aSKees Cook $line =~ s/\s*\n?$//g; 67966b47b4aSKees Cook $line =~ s/^\s*//g; 68066b47b4aSKees Cook 68166b47b4aSKees Cook next if ($line =~ m/^\s*#/); 68266b47b4aSKees Cook next if ($line =~ m/^\s*$/); 68366b47b4aSKees Cook 68466b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 68566b47b4aSKees Cook 68666b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 68766b47b4aSKees Cook } 68866b47b4aSKees Cook close($spelling); 68936061e38SJoe Perches} else { 69036061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 69136061e38SJoe Perches} 69266b47b4aSKees Cook 693ebfd7d62SJoe Perchesif ($codespell) { 694ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 695ebfd7d62SJoe Perches while (<$spelling>) { 696ebfd7d62SJoe Perches my $line = $_; 697ebfd7d62SJoe Perches 698ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 699ebfd7d62SJoe Perches $line =~ s/^\s*//g; 700ebfd7d62SJoe Perches 701ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 702ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 703ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 704ebfd7d62SJoe Perches 705ebfd7d62SJoe Perches $line =~ s/,.*$//; 706ebfd7d62SJoe Perches 707ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 708ebfd7d62SJoe Perches 709ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 710ebfd7d62SJoe Perches } 711ebfd7d62SJoe Perches close($spelling); 712ebfd7d62SJoe Perches } else { 713ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 714ebfd7d62SJoe Perches } 715ebfd7d62SJoe Perches} 716ebfd7d62SJoe Perches 717ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 718ebfd7d62SJoe Perches 71975ad8c57SJerome Forissiersub read_words { 72075ad8c57SJerome Forissier my ($wordsRef, $file) = @_; 72175ad8c57SJerome Forissier 72275ad8c57SJerome Forissier if (open(my $words, '<', $file)) { 72375ad8c57SJerome Forissier while (<$words>) { 724bf1fa1daSJoe Perches my $line = $_; 725bf1fa1daSJoe Perches 726bf1fa1daSJoe Perches $line =~ s/\s*\n?$//g; 727bf1fa1daSJoe Perches $line =~ s/^\s*//g; 728bf1fa1daSJoe Perches 729bf1fa1daSJoe Perches next if ($line =~ m/^\s*#/); 730bf1fa1daSJoe Perches next if ($line =~ m/^\s*$/); 731bf1fa1daSJoe Perches if ($line =~ /\s/) { 73275ad8c57SJerome Forissier print("$file: '$line' invalid - ignored\n"); 733bf1fa1daSJoe Perches next; 734bf1fa1daSJoe Perches } 735bf1fa1daSJoe Perches 73675ad8c57SJerome Forissier $$wordsRef .= '|' if ($$wordsRef ne ""); 73775ad8c57SJerome Forissier $$wordsRef .= $line; 738bf1fa1daSJoe Perches } 73975ad8c57SJerome Forissier close($file); 74075ad8c57SJerome Forissier return 1; 741bf1fa1daSJoe Perches } 742bf1fa1daSJoe Perches 74375ad8c57SJerome Forissier return 0; 74475ad8c57SJerome Forissier} 74575ad8c57SJerome Forissier 74675ad8c57SJerome Forissiermy $const_structs = ""; 74775ad8c57SJerome Forissierread_words(\$const_structs, $conststructsfile) 74875ad8c57SJerome Forissier or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 74975ad8c57SJerome Forissier 75075ad8c57SJerome Forissiermy $typeOtherTypedefs = ""; 75175ad8c57SJerome Forissierif (length($typedefsfile)) { 75275ad8c57SJerome Forissier read_words(\$typeOtherTypedefs, $typedefsfile) 75375ad8c57SJerome Forissier or warn "No additional types will be considered - file '$typedefsfile': $!\n"; 75475ad8c57SJerome Forissier} 75575ad8c57SJerome Forissier$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne ""); 75675ad8c57SJerome Forissier 7578905a67cSAndy Whitcroftsub build_types { 758485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 759485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 7601813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 7618716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 762c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 763ab7e23f3SJoe Perches $BasicType = qr{ 764ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 765ab7e23f3SJoe Perches (?:${all}\b) 766ab7e23f3SJoe Perches }x; 7678905a67cSAndy Whitcroft $NonptrType = qr{ 768d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 769cf655043SAndy Whitcroft (?: 7706b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 7718ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 772c45dcabdSAndy Whitcroft (?:${all}\b) 773cf655043SAndy Whitcroft ) 774c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 7758905a67cSAndy Whitcroft }x; 7761813087dSJoe Perches $NonptrTypeMisordered = qr{ 7771813087dSJoe Perches (?:$Modifier\s+|const\s+)* 7781813087dSJoe Perches (?: 7791813087dSJoe Perches (?:${Misordered}\b) 7801813087dSJoe Perches ) 7811813087dSJoe Perches (?:\s+$Modifier|\s+const)* 7821813087dSJoe Perches }x; 7838716de38SJoe Perches $NonptrTypeWithAttr = qr{ 7848716de38SJoe Perches (?:$Modifier\s+|const\s+)* 7858716de38SJoe Perches (?: 7868716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 7878716de38SJoe Perches (?:$typeTypedefs\b)| 7888716de38SJoe Perches (?:${allWithAttr}\b) 7898716de38SJoe Perches ) 7908716de38SJoe Perches (?:\s+$Modifier|\s+const)* 7918716de38SJoe Perches }x; 7928905a67cSAndy Whitcroft $Type = qr{ 793c45dcabdSAndy Whitcroft $NonptrType 7941574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 795c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 7968905a67cSAndy Whitcroft }x; 7971813087dSJoe Perches $TypeMisordered = qr{ 7981813087dSJoe Perches $NonptrTypeMisordered 7991813087dSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 8001813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 8011813087dSJoe Perches }x; 80291cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 8031813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 8048905a67cSAndy Whitcroft} 8058905a67cSAndy Whitcroftbuild_types(); 8066c72ffaaSAndy Whitcroft 8077d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 808d1fe9c09SJoe Perches 809d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 810d1fe9c09SJoe Perches# requires at least perl version v5.10.0 811d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 812d1fe9c09SJoe Perches 813d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 8142435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 815c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 8167d2367afSJoe Perches 817f8422308SJoe Perchesour $declaration_macros = qr{(?x: 8183e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 819fe658f94SSteffen Maier (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(| 8203d102fc0SGilad Ben-Yossef (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(| 8213d102fc0SGilad Ben-Yossef (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\( 822f8422308SJoe Perches)}; 823f8422308SJoe Perches 8247d2367afSJoe Perchessub deparenthesize { 8257d2367afSJoe Perches my ($string) = @_; 8267d2367afSJoe Perches return "" if (!defined($string)); 8275b9553abSJoe Perches 8285b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 8295b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 8305b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 8315b9553abSJoe Perches } 8325b9553abSJoe Perches 8337d2367afSJoe Perches $string =~ s@\s+@ @g; 8345b9553abSJoe Perches 8357d2367afSJoe Perches return $string; 8367d2367afSJoe Perches} 8377d2367afSJoe Perches 8383445686aSJoe Perchessub seed_camelcase_file { 8393445686aSJoe Perches my ($file) = @_; 8403445686aSJoe Perches 8413445686aSJoe Perches return if (!(-f $file)); 8423445686aSJoe Perches 8433445686aSJoe Perches local $/; 8443445686aSJoe Perches 8453445686aSJoe Perches open(my $include_file, '<', "$file") 8463445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 8473445686aSJoe Perches my $text = <$include_file>; 8483445686aSJoe Perches close($include_file); 8493445686aSJoe Perches 8503445686aSJoe Perches my @lines = split('\n', $text); 8513445686aSJoe Perches 8523445686aSJoe Perches foreach my $line (@lines) { 8533445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 8543445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 8553445686aSJoe Perches $camelcase{$1} = 1; 85611ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 85711ea516aSJoe Perches $camelcase{$1} = 1; 85811ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 8593445686aSJoe Perches $camelcase{$1} = 1; 8603445686aSJoe Perches } 8613445686aSJoe Perches } 8623445686aSJoe Perches} 8633445686aSJoe Perches 86485b0ee18SJoe Perchessub is_maintained_obsolete { 86585b0ee18SJoe Perches my ($filename) = @_; 86685b0ee18SJoe Perches 867f2c19c2fSJerome Forissier return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 86885b0ee18SJoe Perches 8690616efa4SJoe Perches my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 87085b0ee18SJoe Perches 87185b0ee18SJoe Perches return $status =~ /obsolete/i; 87285b0ee18SJoe Perches} 87385b0ee18SJoe Perches 8743b6e8ac9SJoe Perchessub is_SPDX_License_valid { 8753b6e8ac9SJoe Perches my ($license) = @_; 8763b6e8ac9SJoe Perches 87756294112SJoe Perches return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git")); 8783b6e8ac9SJoe Perches 87956294112SJoe Perches my $root_path = abs_path($root); 88056294112SJoe Perches my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`; 8813b6e8ac9SJoe Perches return 0 if ($status ne ""); 8823b6e8ac9SJoe Perches return 1; 8833b6e8ac9SJoe Perches} 8843b6e8ac9SJoe Perches 8853445686aSJoe Perchesmy $camelcase_seeded = 0; 8863445686aSJoe Perchessub seed_camelcase_includes { 8873445686aSJoe Perches return if ($camelcase_seeded); 8883445686aSJoe Perches 8893445686aSJoe Perches my $files; 890c707a81dSJoe Perches my $camelcase_cache = ""; 891c707a81dSJoe Perches my @include_files = (); 892c707a81dSJoe Perches 893c707a81dSJoe Perches $camelcase_seeded = 1; 894351b2a1fSJoe Perches 8953645e328SRichard Genoud if (-e ".git") { 896351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 897351b2a1fSJoe Perches chomp $git_last_include_commit; 898c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 899c707a81dSJoe Perches } else { 900c707a81dSJoe Perches my $last_mod_date = 0; 901c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 902c707a81dSJoe Perches @include_files = split('\n', $files); 903c707a81dSJoe Perches foreach my $file (@include_files) { 904c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 905c707a81dSJoe Perches localtime((stat $file)[9])); 906c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 907c707a81dSJoe Perches } 908c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 909c707a81dSJoe Perches } 910c707a81dSJoe Perches 911c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 912c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 913c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 914351b2a1fSJoe Perches while (<$camelcase_file>) { 915351b2a1fSJoe Perches chomp; 916351b2a1fSJoe Perches $camelcase{$_} = 1; 917351b2a1fSJoe Perches } 918351b2a1fSJoe Perches close($camelcase_file); 919351b2a1fSJoe Perches 920351b2a1fSJoe Perches return; 921351b2a1fSJoe Perches } 922c707a81dSJoe Perches 9233645e328SRichard Genoud if (-e ".git") { 924c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 925c707a81dSJoe Perches @include_files = split('\n', $files); 9263445686aSJoe Perches } 927c707a81dSJoe Perches 9283445686aSJoe Perches foreach my $file (@include_files) { 9293445686aSJoe Perches seed_camelcase_file($file); 9303445686aSJoe Perches } 931351b2a1fSJoe Perches 932c707a81dSJoe Perches if ($camelcase_cache ne "") { 933351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 934c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 935c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 936351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 937351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 938351b2a1fSJoe Perches } 939351b2a1fSJoe Perches close($camelcase_file); 940351b2a1fSJoe Perches } 9413445686aSJoe Perches} 9423445686aSJoe Perches 943d311cd44SJoe Perchessub git_commit_info { 944d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 945d311cd44SJoe Perches 946d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 947d311cd44SJoe Perches 948d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 949d311cd44SJoe Perches $output =~ s/^\s*//gm; 950d311cd44SJoe Perches my @lines = split("\n", $output); 951d311cd44SJoe Perches 9520d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 9530d7835fcSJoe Perches 954d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 955d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 956d311cd44SJoe Perches# all matching commit ids, but it's very slow... 957d311cd44SJoe Perches# 958d311cd44SJoe Perches# echo "checking commits $1..." 959d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 960d311cd44SJoe Perches# while read line ; do 961d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 962d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 963d311cd44SJoe Perches# done 964d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 965948b133aSHeinrich Schuchardt $id = undef; 966d311cd44SJoe Perches } else { 967d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 968d311cd44SJoe Perches $desc = substr($lines[0], 41); 969d311cd44SJoe Perches } 970d311cd44SJoe Perches 971d311cd44SJoe Perches return ($id, $desc); 972d311cd44SJoe Perches} 973d311cd44SJoe Perches 9746c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 9750a920b5bSAndy Whitcroft 97600df344fSAndy Whitcroftmy @rawlines = (); 977c2fdda0dSAndy Whitcroftmy @lines = (); 9783705ce5bSJoe Perchesmy @fixed = (); 979d752fcc8SJoe Perchesmy @fixed_inserted = (); 980d752fcc8SJoe Perchesmy @fixed_deleted = (); 981194f66fcSJoe Perchesmy $fixlinenr = -1; 982194f66fcSJoe Perches 9834a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 9844a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 9854a593c34SDu, Changbindie "$P: No git repository found\n" if ($git && !-e ".git"); 9864a593c34SDu, Changbin 9874a593c34SDu, Changbinif ($git) { 9884a593c34SDu, Changbin my @commits = (); 9890dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 9904a593c34SDu, Changbin my $git_range; 99128898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 99228898fd1SJoe Perches $git_range = "-$2 $1"; 9934a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 9944a593c34SDu, Changbin $git_range = "$commit_expr"; 9954a593c34SDu, Changbin } else { 9960dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 9970dea9f1eSJoe Perches } 9980dea9f1eSJoe Perches my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 9990dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 100028898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 100128898fd1SJoe Perches next if (!defined($1) || !defined($2)); 10020dea9f1eSJoe Perches my $sha1 = $1; 10030dea9f1eSJoe Perches my $subject = $2; 10040dea9f1eSJoe Perches unshift(@commits, $sha1); 10050dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 10064a593c34SDu, Changbin } 10074a593c34SDu, Changbin } 10084a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 10094a593c34SDu, Changbin @ARGV = @commits; 10104a593c34SDu, Changbin} 10114a593c34SDu, Changbin 1012c2fdda0dSAndy Whitcroftmy $vname; 10136c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 101421caa13cSAndy Whitcroft my $FILE; 10154a593c34SDu, Changbin if ($git) { 10164a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 10174a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 10184a593c34SDu, Changbin } elsif ($file) { 101921caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 10206c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 102121caa13cSAndy Whitcroft } elsif ($filename eq '-') { 102221caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 10236c72ffaaSAndy Whitcroft } else { 102421caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 10256c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 10266c72ffaaSAndy Whitcroft } 1027c2fdda0dSAndy Whitcroft if ($filename eq '-') { 1028c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 10294a593c34SDu, Changbin } elsif ($git) { 10300dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 1031c2fdda0dSAndy Whitcroft } else { 1032c2fdda0dSAndy Whitcroft $vname = $filename; 1033c2fdda0dSAndy Whitcroft } 103421caa13cSAndy Whitcroft while (<$FILE>) { 10350a920b5bSAndy Whitcroft chomp; 103600df344fSAndy Whitcroft push(@rawlines, $_); 10376c72ffaaSAndy Whitcroft } 103821caa13cSAndy Whitcroft close($FILE); 1039d8469f16SJoe Perches 1040d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 1041d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1042d8469f16SJoe Perches print "$vname\n"; 1043d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1044d8469f16SJoe Perches } 1045d8469f16SJoe Perches 1046c2fdda0dSAndy Whitcroft if (!process($filename)) { 10470a920b5bSAndy Whitcroft $exit = 1; 10480a920b5bSAndy Whitcroft } 104900df344fSAndy Whitcroft @rawlines = (); 105013214adfSAndy Whitcroft @lines = (); 10513705ce5bSJoe Perches @fixed = (); 1052d752fcc8SJoe Perches @fixed_inserted = (); 1053d752fcc8SJoe Perches @fixed_deleted = (); 1054194f66fcSJoe Perches $fixlinenr = -1; 1055485ff23eSAlex Dowad @modifierListFile = (); 1056485ff23eSAlex Dowad @typeListFile = (); 1057485ff23eSAlex Dowad build_types(); 10580a920b5bSAndy Whitcroft} 10590a920b5bSAndy Whitcroft 1060d8469f16SJoe Perchesif (!$quiet) { 10613c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 10623c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 10633c816e49SJoe Perches 10645b57980dSJoe Perches if (!$perl_version_ok) { 1065d8469f16SJoe Perches print << "EOM" 1066d8469f16SJoe Perches 1067d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 10685b57980dSJoe Perches An upgrade to at least perl $minimum_perl_version is suggested. 1069d8469f16SJoe PerchesEOM 1070d8469f16SJoe Perches } 1071d8469f16SJoe Perches if ($exit) { 1072d8469f16SJoe Perches print << "EOM" 1073d8469f16SJoe Perches 1074d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 1075d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 1076d8469f16SJoe PerchesEOM 1077d8469f16SJoe Perches } 1078d8469f16SJoe Perches} 1079d8469f16SJoe Perches 10800a920b5bSAndy Whitcroftexit($exit); 10810a920b5bSAndy Whitcroft 10820a920b5bSAndy Whitcroftsub top_of_kernel_tree { 10836c72ffaaSAndy Whitcroft my ($root) = @_; 10846c72ffaaSAndy Whitcroft 10856c72ffaaSAndy Whitcroft my @tree_check = ( 10866c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 10876c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 10886c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 10896c72ffaaSAndy Whitcroft ); 10906c72ffaaSAndy Whitcroft 10916c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 10926c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 10930a920b5bSAndy Whitcroft return 0; 10940a920b5bSAndy Whitcroft } 10956c72ffaaSAndy Whitcroft } 10966c72ffaaSAndy Whitcroft return 1; 10976c72ffaaSAndy Whitcroft} 10980a920b5bSAndy Whitcroft 109920112475SJoe Perchessub parse_email { 110020112475SJoe Perches my ($formatted_email) = @_; 110120112475SJoe Perches 110220112475SJoe Perches my $name = ""; 110320112475SJoe Perches my $address = ""; 110420112475SJoe Perches my $comment = ""; 110520112475SJoe Perches 110620112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 110720112475SJoe Perches $name = $1; 110820112475SJoe Perches $address = $2; 110920112475SJoe Perches $comment = $3 if defined $3; 111020112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 111120112475SJoe Perches $address = $1; 111220112475SJoe Perches $comment = $2 if defined $2; 111320112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 111420112475SJoe Perches $address = $1; 111520112475SJoe Perches $comment = $2 if defined $2; 111685e12066SJoe Perches $formatted_email =~ s/\Q$address\E.*$//; 111720112475SJoe Perches $name = $formatted_email; 11183705ce5bSJoe Perches $name = trim($name); 111920112475SJoe Perches $name =~ s/^\"|\"$//g; 112020112475SJoe Perches # If there's a name left after stripping spaces and 112120112475SJoe Perches # leading quotes, and the address doesn't have both 112220112475SJoe Perches # leading and trailing angle brackets, the address 112320112475SJoe Perches # is invalid. ie: 112420112475SJoe Perches # "joe smith [email protected]" bad 112520112475SJoe Perches # "joe smith <[email protected]" bad 112620112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 112720112475SJoe Perches $name = ""; 112820112475SJoe Perches $address = ""; 112920112475SJoe Perches $comment = ""; 113020112475SJoe Perches } 113120112475SJoe Perches } 113220112475SJoe Perches 11333705ce5bSJoe Perches $name = trim($name); 113420112475SJoe Perches $name =~ s/^\"|\"$//g; 11353705ce5bSJoe Perches $address = trim($address); 113620112475SJoe Perches $address =~ s/^\<|\>$//g; 113720112475SJoe Perches 113820112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 113920112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 114020112475SJoe Perches $name = "\"$name\""; 114120112475SJoe Perches } 114220112475SJoe Perches 114320112475SJoe Perches return ($name, $address, $comment); 114420112475SJoe Perches} 114520112475SJoe Perches 114620112475SJoe Perchessub format_email { 114720112475SJoe Perches my ($name, $address) = @_; 114820112475SJoe Perches 114920112475SJoe Perches my $formatted_email; 115020112475SJoe Perches 11513705ce5bSJoe Perches $name = trim($name); 115220112475SJoe Perches $name =~ s/^\"|\"$//g; 11533705ce5bSJoe Perches $address = trim($address); 115420112475SJoe Perches 115520112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 115620112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 115720112475SJoe Perches $name = "\"$name\""; 115820112475SJoe Perches } 115920112475SJoe Perches 116020112475SJoe Perches if ("$name" eq "") { 116120112475SJoe Perches $formatted_email = "$address"; 116220112475SJoe Perches } else { 116320112475SJoe Perches $formatted_email = "$name <$address>"; 116420112475SJoe Perches } 116520112475SJoe Perches 116620112475SJoe Perches return $formatted_email; 116720112475SJoe Perches} 116820112475SJoe Perches 1169d311cd44SJoe Perchessub which { 1170d311cd44SJoe Perches my ($bin) = @_; 1171d311cd44SJoe Perches 1172d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1173d311cd44SJoe Perches if (-e "$path/$bin") { 1174d311cd44SJoe Perches return "$path/$bin"; 1175d311cd44SJoe Perches } 1176d311cd44SJoe Perches } 1177d311cd44SJoe Perches 1178d311cd44SJoe Perches return ""; 1179d311cd44SJoe Perches} 1180d311cd44SJoe Perches 1181000d1cc1SJoe Perchessub which_conf { 1182000d1cc1SJoe Perches my ($conf) = @_; 1183000d1cc1SJoe Perches 1184000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1185000d1cc1SJoe Perches if (-e "$path/$conf") { 1186000d1cc1SJoe Perches return "$path/$conf"; 1187000d1cc1SJoe Perches } 1188000d1cc1SJoe Perches } 1189000d1cc1SJoe Perches 1190000d1cc1SJoe Perches return ""; 1191000d1cc1SJoe Perches} 1192000d1cc1SJoe Perches 11930a920b5bSAndy Whitcroftsub expand_tabs { 11940a920b5bSAndy Whitcroft my ($str) = @_; 11950a920b5bSAndy Whitcroft 11960a920b5bSAndy Whitcroft my $res = ''; 11970a920b5bSAndy Whitcroft my $n = 0; 11980a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 11990a920b5bSAndy Whitcroft if ($c eq "\t") { 12000a920b5bSAndy Whitcroft $res .= ' '; 12010a920b5bSAndy Whitcroft $n++; 12020a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 12030a920b5bSAndy Whitcroft $res .= ' '; 12040a920b5bSAndy Whitcroft } 12050a920b5bSAndy Whitcroft next; 12060a920b5bSAndy Whitcroft } 12070a920b5bSAndy Whitcroft $res .= $c; 12080a920b5bSAndy Whitcroft $n++; 12090a920b5bSAndy Whitcroft } 12100a920b5bSAndy Whitcroft 12110a920b5bSAndy Whitcroft return $res; 12120a920b5bSAndy Whitcroft} 12136c72ffaaSAndy Whitcroftsub copy_spacing { 1214773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 12156c72ffaaSAndy Whitcroft return $res; 12166c72ffaaSAndy Whitcroft} 12170a920b5bSAndy Whitcroft 12184a0df2efSAndy Whitcroftsub line_stats { 12194a0df2efSAndy Whitcroft my ($line) = @_; 12204a0df2efSAndy Whitcroft 12214a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 12224a0df2efSAndy Whitcroft $line =~ s/^.//; 12234a0df2efSAndy Whitcroft $line = expand_tabs($line); 12244a0df2efSAndy Whitcroft 12254a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 12264a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 12274a0df2efSAndy Whitcroft 12284a0df2efSAndy Whitcroft return (length($line), length($white)); 12294a0df2efSAndy Whitcroft} 12304a0df2efSAndy Whitcroft 1231773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1232773647a0SAndy Whitcroft 1233773647a0SAndy Whitcroftsub sanitise_line_reset { 1234773647a0SAndy Whitcroft my ($in_comment) = @_; 1235773647a0SAndy Whitcroft 1236773647a0SAndy Whitcroft if ($in_comment) { 1237773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1238773647a0SAndy Whitcroft } else { 1239773647a0SAndy Whitcroft $sanitise_quote = ''; 1240773647a0SAndy Whitcroft } 1241773647a0SAndy Whitcroft} 124200df344fSAndy Whitcroftsub sanitise_line { 124300df344fSAndy Whitcroft my ($line) = @_; 124400df344fSAndy Whitcroft 124500df344fSAndy Whitcroft my $res = ''; 124600df344fSAndy Whitcroft my $l = ''; 124700df344fSAndy Whitcroft 1248c2fdda0dSAndy Whitcroft my $qlen = 0; 1249773647a0SAndy Whitcroft my $off = 0; 1250773647a0SAndy Whitcroft my $c; 125100df344fSAndy Whitcroft 1252773647a0SAndy Whitcroft # Always copy over the diff marker. 1253773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1254773647a0SAndy Whitcroft 1255773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1256773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1257773647a0SAndy Whitcroft 12588d2e11b2SClaudio Fontana # Comments we are whacking completely including the begin 1259773647a0SAndy Whitcroft # and end, all to $;. 1260773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1261773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1262773647a0SAndy Whitcroft 1263773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1264773647a0SAndy Whitcroft $off++; 126500df344fSAndy Whitcroft next; 1266773647a0SAndy Whitcroft } 126781bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1268773647a0SAndy Whitcroft $sanitise_quote = ''; 1269773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1270773647a0SAndy Whitcroft $off++; 1271773647a0SAndy Whitcroft next; 1272773647a0SAndy Whitcroft } 1273113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1274113f04a8SDaniel Walker $sanitise_quote = '//'; 1275113f04a8SDaniel Walker 1276113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1277113f04a8SDaniel Walker $off++; 1278113f04a8SDaniel Walker next; 1279113f04a8SDaniel Walker } 1280773647a0SAndy Whitcroft 1281773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1282773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1283773647a0SAndy Whitcroft $c eq "\\") { 1284773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1285773647a0SAndy Whitcroft $off++; 1286773647a0SAndy Whitcroft next; 1287773647a0SAndy Whitcroft } 1288773647a0SAndy Whitcroft # Regular quotes. 1289773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1290773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1291773647a0SAndy Whitcroft $sanitise_quote = $c; 1292773647a0SAndy Whitcroft 1293773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1294773647a0SAndy Whitcroft next; 1295773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1296773647a0SAndy Whitcroft $sanitise_quote = ''; 129700df344fSAndy Whitcroft } 129800df344fSAndy Whitcroft } 1299773647a0SAndy Whitcroft 1300fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1301773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1302773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1303113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1304113f04a8SDaniel Walker substr($res, $off, 1, $;); 1305773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1306773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 130700df344fSAndy Whitcroft } else { 1308773647a0SAndy Whitcroft substr($res, $off, 1, $c); 130900df344fSAndy Whitcroft } 1310c2fdda0dSAndy Whitcroft } 1311c2fdda0dSAndy Whitcroft 1312113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1313113f04a8SDaniel Walker $sanitise_quote = ''; 1314113f04a8SDaniel Walker } 1315113f04a8SDaniel Walker 1316c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1317c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1318c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1319c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1320c2fdda0dSAndy Whitcroft 1321c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1322c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1323c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1324c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1325c2fdda0dSAndy Whitcroft } 1326c2fdda0dSAndy Whitcroft 1327dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1328dadf680dSJoe Perches my $match = $1; 1329dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1330dadf680dSJoe Perches } 1331dadf680dSJoe Perches 133200df344fSAndy Whitcroft return $res; 133300df344fSAndy Whitcroft} 133400df344fSAndy Whitcroft 1335a6962d72SJoe Perchessub get_quoted_string { 1336a6962d72SJoe Perches my ($line, $rawline) = @_; 1337a6962d72SJoe Perches 1338478b1799SJoe Perches return "" if (!defined($line) || !defined($rawline)); 133933acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1340a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1341a6962d72SJoe Perches} 1342a6962d72SJoe Perches 13438905a67cSAndy Whitcroftsub ctx_statement_block { 13448905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 13458905a67cSAndy Whitcroft my $line = $linenr - 1; 13468905a67cSAndy Whitcroft my $blk = ''; 13478905a67cSAndy Whitcroft my $soff = $off; 13488905a67cSAndy Whitcroft my $coff = $off - 1; 1349773647a0SAndy Whitcroft my $coff_set = 0; 13508905a67cSAndy Whitcroft 135113214adfSAndy Whitcroft my $loff = 0; 135213214adfSAndy Whitcroft 13538905a67cSAndy Whitcroft my $type = ''; 13548905a67cSAndy Whitcroft my $level = 0; 1355a2750645SAndy Whitcroft my @stack = (); 1356cf655043SAndy Whitcroft my $p; 13578905a67cSAndy Whitcroft my $c; 13588905a67cSAndy Whitcroft my $len = 0; 135913214adfSAndy Whitcroft 136013214adfSAndy Whitcroft my $remainder; 13618905a67cSAndy Whitcroft while (1) { 1362a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1363a2750645SAndy Whitcroft 1364773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 13658905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 13668905a67cSAndy Whitcroft # context. 13678905a67cSAndy Whitcroft if ($off >= $len) { 13688905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1369dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1370c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 13718905a67cSAndy Whitcroft $remain--; 137213214adfSAndy Whitcroft $loff = $len; 1373c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 13748905a67cSAndy Whitcroft $len = length($blk); 13758905a67cSAndy Whitcroft $line++; 13768905a67cSAndy Whitcroft last; 13778905a67cSAndy Whitcroft } 13788905a67cSAndy Whitcroft # Bail if there is no further context. 13798905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 138013214adfSAndy Whitcroft if ($off >= $len) { 13818905a67cSAndy Whitcroft last; 13828905a67cSAndy Whitcroft } 1383f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1384f74bd194SAndy Whitcroft $level++; 1385f74bd194SAndy Whitcroft $type = '#'; 1386f74bd194SAndy Whitcroft } 13878905a67cSAndy Whitcroft } 1388cf655043SAndy Whitcroft $p = $c; 13898905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 139013214adfSAndy Whitcroft $remainder = substr($blk, $off); 13918905a67cSAndy Whitcroft 1392773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 13934635f4fbSAndy Whitcroft 13944635f4fbSAndy Whitcroft # Handle nested #if/#else. 13954635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 13964635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 13974635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 13984635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 13994635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 14004635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 14014635f4fbSAndy Whitcroft } 14024635f4fbSAndy Whitcroft 14038905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 14048905a67cSAndy Whitcroft # outermost level. 14058905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 14068905a67cSAndy Whitcroft last; 14078905a67cSAndy Whitcroft } 14088905a67cSAndy Whitcroft 140913214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1410773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1411773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1412773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1413773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1414773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1415773647a0SAndy Whitcroft $coff_set = 1; 1416773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1417773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 141813214adfSAndy Whitcroft } 141913214adfSAndy Whitcroft 14208905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 14218905a67cSAndy Whitcroft $level++; 14228905a67cSAndy Whitcroft $type = '('; 14238905a67cSAndy Whitcroft } 14248905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 14258905a67cSAndy Whitcroft $level--; 14268905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 14278905a67cSAndy Whitcroft 14288905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 14298905a67cSAndy Whitcroft $coff = $off; 1430773647a0SAndy Whitcroft $coff_set = 1; 1431773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 14328905a67cSAndy Whitcroft } 14338905a67cSAndy Whitcroft } 14348905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 14358905a67cSAndy Whitcroft $level++; 14368905a67cSAndy Whitcroft $type = '{'; 14378905a67cSAndy Whitcroft } 14388905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 14398905a67cSAndy Whitcroft $level--; 14408905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 14418905a67cSAndy Whitcroft 14428905a67cSAndy Whitcroft if ($level == 0) { 1443b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1444b998e001SPatrick Pannuto $off++; 1445b998e001SPatrick Pannuto } 14468905a67cSAndy Whitcroft last; 14478905a67cSAndy Whitcroft } 14488905a67cSAndy Whitcroft } 1449f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1450f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1451f74bd194SAndy Whitcroft $level--; 1452f74bd194SAndy Whitcroft $type = ''; 1453f74bd194SAndy Whitcroft $off++; 1454f74bd194SAndy Whitcroft last; 1455f74bd194SAndy Whitcroft } 14568905a67cSAndy Whitcroft $off++; 14578905a67cSAndy Whitcroft } 1458a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 145913214adfSAndy Whitcroft if ($off == $len) { 1460a3bb97a7SAndy Whitcroft $loff = $len + 1; 146113214adfSAndy Whitcroft $line++; 146213214adfSAndy Whitcroft $remain--; 146313214adfSAndy Whitcroft } 14648905a67cSAndy Whitcroft 14658905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 14668905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 14678905a67cSAndy Whitcroft 14688905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 14698905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 14708905a67cSAndy Whitcroft 1471773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 147213214adfSAndy Whitcroft 147313214adfSAndy Whitcroft return ($statement, $condition, 147413214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 147513214adfSAndy Whitcroft} 147613214adfSAndy Whitcroft 1477cf655043SAndy Whitcroftsub statement_lines { 1478cf655043SAndy Whitcroft my ($stmt) = @_; 1479cf655043SAndy Whitcroft 1480cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1481cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1482cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1483cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1484cf655043SAndy Whitcroft 1485cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1486cf655043SAndy Whitcroft 1487cf655043SAndy Whitcroft return $#stmt_lines + 2; 1488cf655043SAndy Whitcroft} 1489cf655043SAndy Whitcroft 1490cf655043SAndy Whitcroftsub statement_rawlines { 1491cf655043SAndy Whitcroft my ($stmt) = @_; 1492cf655043SAndy Whitcroft 1493cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1494cf655043SAndy Whitcroft 1495cf655043SAndy Whitcroft return $#stmt_lines + 2; 1496cf655043SAndy Whitcroft} 1497cf655043SAndy Whitcroft 1498cf655043SAndy Whitcroftsub statement_block_size { 1499cf655043SAndy Whitcroft my ($stmt) = @_; 1500cf655043SAndy Whitcroft 1501cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1502cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1503cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1504cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1505cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1506cf655043SAndy Whitcroft 1507cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1508cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1509cf655043SAndy Whitcroft 1510cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1511cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1512cf655043SAndy Whitcroft 1513cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1514cf655043SAndy Whitcroft return $stmt_lines; 1515cf655043SAndy Whitcroft } else { 1516cf655043SAndy Whitcroft return $stmt_statements; 1517cf655043SAndy Whitcroft } 1518cf655043SAndy Whitcroft} 1519cf655043SAndy Whitcroft 152013214adfSAndy Whitcroftsub ctx_statement_full { 152113214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 152213214adfSAndy Whitcroft my ($statement, $condition, $level); 152313214adfSAndy Whitcroft 152413214adfSAndy Whitcroft my (@chunks); 152513214adfSAndy Whitcroft 1526cf655043SAndy Whitcroft # Grab the first conditional/block pair. 152713214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 152813214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1529773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 153013214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1531cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1532cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1533cf655043SAndy Whitcroft } 1534cf655043SAndy Whitcroft 1535cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1536cf655043SAndy Whitcroft # could continue the statement. 1537cf655043SAndy Whitcroft for (;;) { 153813214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 153913214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1540cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1541773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1542cf655043SAndy Whitcroft #print "C: push\n"; 1543cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 154413214adfSAndy Whitcroft } 154513214adfSAndy Whitcroft 154613214adfSAndy Whitcroft return ($level, $linenr, @chunks); 15478905a67cSAndy Whitcroft} 15488905a67cSAndy Whitcroft 15494a0df2efSAndy Whitcroftsub ctx_block_get { 1550f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 15514a0df2efSAndy Whitcroft my $line; 15524a0df2efSAndy Whitcroft my $start = $linenr - 1; 15534a0df2efSAndy Whitcroft my $blk = ''; 15544a0df2efSAndy Whitcroft my @o; 15554a0df2efSAndy Whitcroft my @c; 15564a0df2efSAndy Whitcroft my @res = (); 15574a0df2efSAndy Whitcroft 1558f0a594c1SAndy Whitcroft my $level = 0; 15594635f4fbSAndy Whitcroft my @stack = ($level); 156000df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 156100df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 156200df344fSAndy Whitcroft $remain--; 156300df344fSAndy Whitcroft 156400df344fSAndy Whitcroft $blk .= $rawlines[$line]; 15654635f4fbSAndy Whitcroft 15664635f4fbSAndy Whitcroft # Handle nested #if/#else. 156701464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 15684635f4fbSAndy Whitcroft push(@stack, $level); 156901464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 15704635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 157101464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 15724635f4fbSAndy Whitcroft $level = pop(@stack); 15734635f4fbSAndy Whitcroft } 15744635f4fbSAndy Whitcroft 157501464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1576f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1577f0a594c1SAndy Whitcroft if ($off > 0) { 1578f0a594c1SAndy Whitcroft $off--; 1579f0a594c1SAndy Whitcroft next; 1580f0a594c1SAndy Whitcroft } 15814a0df2efSAndy Whitcroft 1582f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1583f0a594c1SAndy Whitcroft $level--; 1584f0a594c1SAndy Whitcroft last if ($level == 0); 1585f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1586f0a594c1SAndy Whitcroft $level++; 1587f0a594c1SAndy Whitcroft } 1588f0a594c1SAndy Whitcroft } 15894a0df2efSAndy Whitcroft 1590f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 159100df344fSAndy Whitcroft push(@res, $rawlines[$line]); 15924a0df2efSAndy Whitcroft } 15934a0df2efSAndy Whitcroft 1594f0a594c1SAndy Whitcroft last if ($level == 0); 15954a0df2efSAndy Whitcroft } 15964a0df2efSAndy Whitcroft 1597f0a594c1SAndy Whitcroft return ($level, @res); 15984a0df2efSAndy Whitcroft} 15994a0df2efSAndy Whitcroftsub ctx_block_outer { 16004a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 16014a0df2efSAndy Whitcroft 1602f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1603f0a594c1SAndy Whitcroft return @r; 16044a0df2efSAndy Whitcroft} 16054a0df2efSAndy Whitcroftsub ctx_block { 16064a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 16074a0df2efSAndy Whitcroft 1608f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1609f0a594c1SAndy Whitcroft return @r; 1610653d4876SAndy Whitcroft} 1611653d4876SAndy Whitcroftsub ctx_statement { 1612f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1613f0a594c1SAndy Whitcroft 1614f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1615f0a594c1SAndy Whitcroft return @r; 1616f0a594c1SAndy Whitcroft} 1617f0a594c1SAndy Whitcroftsub ctx_block_level { 1618653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1619653d4876SAndy Whitcroft 1620f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 16214a0df2efSAndy Whitcroft} 16229c0ca6f9SAndy Whitcroftsub ctx_statement_level { 16239c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 16249c0ca6f9SAndy Whitcroft 16259c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 16269c0ca6f9SAndy Whitcroft} 16274a0df2efSAndy Whitcroft 16284a0df2efSAndy Whitcroftsub ctx_locate_comment { 16294a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 16304a0df2efSAndy Whitcroft 16314a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1632beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 16334a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 16344a0df2efSAndy Whitcroft 16354a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 16364a0df2efSAndy Whitcroft # comment. 16374a0df2efSAndy Whitcroft my $in_comment = 0; 16384a0df2efSAndy Whitcroft $current_comment = ''; 16394a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 164000df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 164100df344fSAndy Whitcroft #warn " $line\n"; 16424a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 16434a0df2efSAndy Whitcroft $in_comment = 1; 16444a0df2efSAndy Whitcroft } 16454a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 16464a0df2efSAndy Whitcroft $in_comment = 1; 16474a0df2efSAndy Whitcroft } 16484a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 16494a0df2efSAndy Whitcroft $current_comment = ''; 16504a0df2efSAndy Whitcroft } 16514a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 16524a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 16534a0df2efSAndy Whitcroft $in_comment = 0; 16544a0df2efSAndy Whitcroft } 16554a0df2efSAndy Whitcroft } 16564a0df2efSAndy Whitcroft 16574a0df2efSAndy Whitcroft chomp($current_comment); 16584a0df2efSAndy Whitcroft return($current_comment); 16594a0df2efSAndy Whitcroft} 16604a0df2efSAndy Whitcroftsub ctx_has_comment { 16614a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 16624a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 16634a0df2efSAndy Whitcroft 166400df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 16654a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 16664a0df2efSAndy Whitcroft 16674a0df2efSAndy Whitcroft return ($cmt ne ''); 16684a0df2efSAndy Whitcroft} 16694a0df2efSAndy Whitcroft 16704d001e4dSAndy Whitcroftsub raw_line { 16714d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 16724d001e4dSAndy Whitcroft 16734d001e4dSAndy Whitcroft my $offset = $linenr - 1; 16744d001e4dSAndy Whitcroft $cnt++; 16754d001e4dSAndy Whitcroft 16764d001e4dSAndy Whitcroft my $line; 16774d001e4dSAndy Whitcroft while ($cnt) { 16784d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 16794d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 16804d001e4dSAndy Whitcroft $cnt--; 16814d001e4dSAndy Whitcroft } 16824d001e4dSAndy Whitcroft 16834d001e4dSAndy Whitcroft return $line; 16844d001e4dSAndy Whitcroft} 16854d001e4dSAndy Whitcroft 16862a9f9d85STobin C. Hardingsub get_stat_real { 16872a9f9d85STobin C. Harding my ($linenr, $lc) = @_; 16882a9f9d85STobin C. Harding 16892a9f9d85STobin C. Harding my $stat_real = raw_line($linenr, 0); 16902a9f9d85STobin C. Harding for (my $count = $linenr + 1; $count <= $lc; $count++) { 16912a9f9d85STobin C. Harding $stat_real = $stat_real . "\n" . raw_line($count, 0); 16922a9f9d85STobin C. Harding } 16932a9f9d85STobin C. Harding 16942a9f9d85STobin C. Harding return $stat_real; 16952a9f9d85STobin C. Harding} 16962a9f9d85STobin C. Harding 1697e3d95a2aSTobin C. Hardingsub get_stat_here { 1698e3d95a2aSTobin C. Harding my ($linenr, $cnt, $here) = @_; 1699e3d95a2aSTobin C. Harding 1700e3d95a2aSTobin C. Harding my $herectx = $here . "\n"; 1701e3d95a2aSTobin C. Harding for (my $n = 0; $n < $cnt; $n++) { 1702e3d95a2aSTobin C. Harding $herectx .= raw_line($linenr, $n) . "\n"; 1703e3d95a2aSTobin C. Harding } 1704e3d95a2aSTobin C. Harding 1705e3d95a2aSTobin C. Harding return $herectx; 1706e3d95a2aSTobin C. Harding} 1707e3d95a2aSTobin C. Harding 17080a920b5bSAndy Whitcroftsub cat_vet { 17090a920b5bSAndy Whitcroft my ($vet) = @_; 17109c0ca6f9SAndy Whitcroft my ($res, $coded); 17110a920b5bSAndy Whitcroft 17129c0ca6f9SAndy Whitcroft $res = ''; 17136c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 17146c72ffaaSAndy Whitcroft $res .= $1; 17156c72ffaaSAndy Whitcroft if ($2 ne '') { 17169c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 17176c72ffaaSAndy Whitcroft $res .= $coded; 17186c72ffaaSAndy Whitcroft } 17199c0ca6f9SAndy Whitcroft } 17209c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 17210a920b5bSAndy Whitcroft 17229c0ca6f9SAndy Whitcroft return $res; 17230a920b5bSAndy Whitcroft} 17240a920b5bSAndy Whitcroft 1725c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1726cf655043SAndy Whitcroftmy $av_pending; 1727c2fdda0dSAndy Whitcroftmy @av_paren_type; 17281f65f947SAndy Whitcroftmy $av_pend_colon; 1729c2fdda0dSAndy Whitcroft 1730c2fdda0dSAndy Whitcroftsub annotate_reset { 1731c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1732cf655043SAndy Whitcroft $av_pending = '_'; 1733cf655043SAndy Whitcroft @av_paren_type = ('E'); 17341f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1735c2fdda0dSAndy Whitcroft} 1736c2fdda0dSAndy Whitcroft 17376c72ffaaSAndy Whitcroftsub annotate_values { 17386c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 17396c72ffaaSAndy Whitcroft 17406c72ffaaSAndy Whitcroft my $res; 17411f65f947SAndy Whitcroft my $var = '_' x length($stream); 17426c72ffaaSAndy Whitcroft my $cur = $stream; 17436c72ffaaSAndy Whitcroft 1744c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 17456c72ffaaSAndy Whitcroft 17466c72ffaaSAndy Whitcroft while (length($cur)) { 1747773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1748cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1749171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 17506c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1751c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1752c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1753cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1754c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 17556c72ffaaSAndy Whitcroft } 17566c72ffaaSAndy Whitcroft 1757c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 17589446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 17599446ef56SAndy Whitcroft push(@av_paren_type, $type); 1760addcdceaSAndy Whitcroft $type = 'c'; 17619446ef56SAndy Whitcroft 1762e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1763c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 17646c72ffaaSAndy Whitcroft $type = 'T'; 17656c72ffaaSAndy Whitcroft 1766389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1767389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1768389a2fe5SAndy Whitcroft $type = 'T'; 1769389a2fe5SAndy Whitcroft 1770c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1771171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1772c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1773171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1774171ae1a4SAndy Whitcroft if ($2 ne '') { 1775cf655043SAndy Whitcroft $av_pending = 'N'; 1776171ae1a4SAndy Whitcroft } 1777171ae1a4SAndy Whitcroft $type = 'E'; 1778171ae1a4SAndy Whitcroft 1779c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1780171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1781171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1782171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 17836c72ffaaSAndy Whitcroft 1784c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1785cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1786c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1787cf655043SAndy Whitcroft 1788cf655043SAndy Whitcroft push(@av_paren_type, $type); 1789cf655043SAndy Whitcroft push(@av_paren_type, $type); 1790171ae1a4SAndy Whitcroft $type = 'E'; 1791cf655043SAndy Whitcroft 1792c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1793cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1794cf655043SAndy Whitcroft $av_preprocessor = 1; 1795cf655043SAndy Whitcroft 1796cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1797cf655043SAndy Whitcroft 1798171ae1a4SAndy Whitcroft $type = 'E'; 1799cf655043SAndy Whitcroft 1800c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1801cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1802cf655043SAndy Whitcroft 1803cf655043SAndy Whitcroft $av_preprocessor = 1; 1804cf655043SAndy Whitcroft 1805cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1806cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1807cf655043SAndy Whitcroft pop(@av_paren_type); 1808cf655043SAndy Whitcroft push(@av_paren_type, $type); 1809171ae1a4SAndy Whitcroft $type = 'E'; 18106c72ffaaSAndy Whitcroft 18116c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1812c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 18136c72ffaaSAndy Whitcroft 1814171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1815171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1816171ae1a4SAndy Whitcroft $av_pending = $type; 1817171ae1a4SAndy Whitcroft $type = 'N'; 1818171ae1a4SAndy Whitcroft 18196c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1820c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 18216c72ffaaSAndy Whitcroft if (defined $2) { 1822cf655043SAndy Whitcroft $av_pending = 'V'; 18236c72ffaaSAndy Whitcroft } 18246c72ffaaSAndy Whitcroft $type = 'N'; 18256c72ffaaSAndy Whitcroft 182614b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1827c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 182814b111c1SAndy Whitcroft $av_pending = 'E'; 18296c72ffaaSAndy Whitcroft $type = 'N'; 18306c72ffaaSAndy Whitcroft 18311f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 18321f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 18331f65f947SAndy Whitcroft $av_pend_colon = 'C'; 18341f65f947SAndy Whitcroft $type = 'N'; 18351f65f947SAndy Whitcroft 183614b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1837c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 18386c72ffaaSAndy Whitcroft $type = 'N'; 18396c72ffaaSAndy Whitcroft 18406c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1841c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1842cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1843cf655043SAndy Whitcroft $av_pending = '_'; 18446c72ffaaSAndy Whitcroft $type = 'N'; 18456c72ffaaSAndy Whitcroft 18466c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1847cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1848cf655043SAndy Whitcroft if ($new_type ne '_') { 1849cf655043SAndy Whitcroft $type = $new_type; 1850c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1851c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 18526c72ffaaSAndy Whitcroft } else { 1853c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 18546c72ffaaSAndy Whitcroft } 18556c72ffaaSAndy Whitcroft 1856c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1857c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1858c8cb2ca3SAndy Whitcroft $type = 'V'; 1859cf655043SAndy Whitcroft $av_pending = 'V'; 18606c72ffaaSAndy Whitcroft 18618e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 18628e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 18631f65f947SAndy Whitcroft $av_pend_colon = 'B'; 18648e761b04SAndy Whitcroft } elsif ($type eq 'E') { 18658e761b04SAndy Whitcroft $av_pend_colon = 'L'; 18661f65f947SAndy Whitcroft } 18671f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 18681f65f947SAndy Whitcroft $type = 'V'; 18691f65f947SAndy Whitcroft 18706c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1871c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 18726c72ffaaSAndy Whitcroft $type = 'V'; 18736c72ffaaSAndy Whitcroft 18746c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1875c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 18766c72ffaaSAndy Whitcroft $type = 'N'; 18776c72ffaaSAndy Whitcroft 1878cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1879c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 188013214adfSAndy Whitcroft $type = 'E'; 18811f65f947SAndy Whitcroft $av_pend_colon = 'O'; 188213214adfSAndy Whitcroft 18838e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 18848e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 18858e761b04SAndy Whitcroft $type = 'C'; 18868e761b04SAndy Whitcroft 18871f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 18881f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 18891f65f947SAndy Whitcroft $type = 'N'; 18901f65f947SAndy Whitcroft 18911f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 18921f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 18931f65f947SAndy Whitcroft 18941f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 18951f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 18961f65f947SAndy Whitcroft $type = 'E'; 18971f65f947SAndy Whitcroft } else { 18981f65f947SAndy Whitcroft $type = 'N'; 18991f65f947SAndy Whitcroft } 19001f65f947SAndy Whitcroft $av_pend_colon = 'O'; 19011f65f947SAndy Whitcroft 19028e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 190313214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 19046c72ffaaSAndy Whitcroft $type = 'N'; 19056c72ffaaSAndy Whitcroft 19060d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 190774048ed8SAndy Whitcroft my $variant; 190874048ed8SAndy Whitcroft 190974048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 191074048ed8SAndy Whitcroft if ($type eq 'V') { 191174048ed8SAndy Whitcroft $variant = 'B'; 191274048ed8SAndy Whitcroft } else { 191374048ed8SAndy Whitcroft $variant = 'U'; 191474048ed8SAndy Whitcroft } 191574048ed8SAndy Whitcroft 191674048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 191774048ed8SAndy Whitcroft $type = 'N'; 191874048ed8SAndy Whitcroft 19196c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1920c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 19216c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 19226c72ffaaSAndy Whitcroft $type = 'N'; 19236c72ffaaSAndy Whitcroft } 19246c72ffaaSAndy Whitcroft 19256c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1926c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 19276c72ffaaSAndy Whitcroft } 19286c72ffaaSAndy Whitcroft if (defined $1) { 19296c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 19306c72ffaaSAndy Whitcroft $res .= $type x length($1); 19316c72ffaaSAndy Whitcroft } 19326c72ffaaSAndy Whitcroft } 19336c72ffaaSAndy Whitcroft 19341f65f947SAndy Whitcroft return ($res, $var); 19356c72ffaaSAndy Whitcroft} 19366c72ffaaSAndy Whitcroft 19378905a67cSAndy Whitcroftsub possible { 193813214adfSAndy Whitcroft my ($possible, $line) = @_; 19399a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 19400776e594SAndy Whitcroft ^(?: 19410776e594SAndy Whitcroft $Modifier| 19420776e594SAndy Whitcroft $Storage| 19430776e594SAndy Whitcroft $Type| 19449a974fdbSAndy Whitcroft DEFINE_\S+ 19459a974fdbSAndy Whitcroft )$| 19469a974fdbSAndy Whitcroft ^(?: 19470776e594SAndy Whitcroft goto| 19480776e594SAndy Whitcroft return| 19490776e594SAndy Whitcroft case| 19500776e594SAndy Whitcroft else| 19510776e594SAndy Whitcroft asm|__asm__| 195289a88353SAndy Whitcroft do| 195389a88353SAndy Whitcroft \#| 195489a88353SAndy Whitcroft \#\#| 19559a974fdbSAndy Whitcroft )(?:\s|$)| 19560776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 19579a974fdbSAndy Whitcroft )}x; 19589a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 19599a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1960c45dcabdSAndy Whitcroft # Check for modifiers. 1961c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1962c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1963c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1964c45dcabdSAndy Whitcroft 1965c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1966c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1967d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 19689a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1969d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1970485ff23eSAlex Dowad push(@modifierListFile, $modifier); 1971d2506586SAndy Whitcroft } 19729a974fdbSAndy Whitcroft } 1973c45dcabdSAndy Whitcroft 1974c45dcabdSAndy Whitcroft } else { 197513214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 1976485ff23eSAlex Dowad push(@typeListFile, $possible); 1977c45dcabdSAndy Whitcroft } 19788905a67cSAndy Whitcroft build_types(); 19790776e594SAndy Whitcroft } else { 19800776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 19818905a67cSAndy Whitcroft } 19828905a67cSAndy Whitcroft} 19838905a67cSAndy Whitcroft 19846c72ffaaSAndy Whitcroftmy $prefix = ''; 19856c72ffaaSAndy Whitcroft 1986000d1cc1SJoe Perchessub show_type { 1987cbec18afSJoe Perches my ($type) = @_; 198891bfe484SJoe Perches 1989522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 1990522b837cSAlexey Dobriyan 1991cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1992cbec18afSJoe Perches 1993cbec18afSJoe Perches return !defined $ignore_type{$type}; 1994000d1cc1SJoe Perches} 1995000d1cc1SJoe Perches 1996f0a594c1SAndy Whitcroftsub report { 1997cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1998cbec18afSJoe Perches 1999cbec18afSJoe Perches if (!show_type($type) || 2000cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 2001773647a0SAndy Whitcroft return 0; 2002773647a0SAndy Whitcroft } 200357230297SJoe Perches my $output = ''; 2004737c0767SJohn Brooks if ($color) { 200557230297SJoe Perches if ($level eq 'ERROR') { 200657230297SJoe Perches $output .= RED; 200757230297SJoe Perches } elsif ($level eq 'WARNING') { 200857230297SJoe Perches $output .= YELLOW; 2009000d1cc1SJoe Perches } else { 201057230297SJoe Perches $output .= GREEN; 2011000d1cc1SJoe Perches } 201257230297SJoe Perches } 201357230297SJoe Perches $output .= $prefix . $level . ':'; 201457230297SJoe Perches if ($show_types) { 2015737c0767SJohn Brooks $output .= BLUE if ($color); 201657230297SJoe Perches $output .= "$type:"; 201757230297SJoe Perches } 2018737c0767SJohn Brooks $output .= RESET if ($color); 201957230297SJoe Perches $output .= ' ' . $msg . "\n"; 202034d8815fSJoe Perches 202134d8815fSJoe Perches if ($showfile) { 202234d8815fSJoe Perches my @lines = split("\n", $output, -1); 202334d8815fSJoe Perches splice(@lines, 1, 1); 202434d8815fSJoe Perches $output = join("\n", @lines); 202534d8815fSJoe Perches } 202657230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 20278905a67cSAndy Whitcroft 202857230297SJoe Perches push(our @report, $output); 2029773647a0SAndy Whitcroft 2030773647a0SAndy Whitcroft return 1; 2031f0a594c1SAndy Whitcroft} 2032cbec18afSJoe Perches 2033f0a594c1SAndy Whitcroftsub report_dump { 203413214adfSAndy Whitcroft our @report; 2035f0a594c1SAndy Whitcroft} 2036000d1cc1SJoe Perches 2037d752fcc8SJoe Perchessub fixup_current_range { 2038d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 2039d752fcc8SJoe Perches 2040d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 2041d752fcc8SJoe Perches my $o = $1; 2042d752fcc8SJoe Perches my $l = $2; 2043d752fcc8SJoe Perches my $no = $o + $offset; 2044d752fcc8SJoe Perches my $nl = $l + $length; 2045d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 2046d752fcc8SJoe Perches } 2047d752fcc8SJoe Perches} 2048d752fcc8SJoe Perches 2049d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 2050d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 2051d752fcc8SJoe Perches 2052d752fcc8SJoe Perches my $range_last_linenr = 0; 2053d752fcc8SJoe Perches my $delta_offset = 0; 2054d752fcc8SJoe Perches 2055d752fcc8SJoe Perches my $old_linenr = 0; 2056d752fcc8SJoe Perches my $new_linenr = 0; 2057d752fcc8SJoe Perches 2058d752fcc8SJoe Perches my $next_insert = 0; 2059d752fcc8SJoe Perches my $next_delete = 0; 2060d752fcc8SJoe Perches 2061d752fcc8SJoe Perches my @lines = (); 2062d752fcc8SJoe Perches 2063d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 2064d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 2065d752fcc8SJoe Perches 2066d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 2067d752fcc8SJoe Perches my $save_line = 1; 2068d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 2069323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2070d752fcc8SJoe Perches $delta_offset = 0; 2071d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2072d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 2073d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 2074d752fcc8SJoe Perches } 2075d752fcc8SJoe Perches 2076d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2077d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 2078d752fcc8SJoe Perches $save_line = 0; 2079d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2080d752fcc8SJoe Perches } 2081d752fcc8SJoe Perches 2082d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2083d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 2084d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 2085d752fcc8SJoe Perches $new_linenr++; 2086d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2087d752fcc8SJoe Perches } 2088d752fcc8SJoe Perches 2089d752fcc8SJoe Perches if ($save_line) { 2090d752fcc8SJoe Perches push(@lines, $line); 2091d752fcc8SJoe Perches $new_linenr++; 2092d752fcc8SJoe Perches } 2093d752fcc8SJoe Perches 2094d752fcc8SJoe Perches $old_linenr++; 2095d752fcc8SJoe Perches } 2096d752fcc8SJoe Perches 2097d752fcc8SJoe Perches return @lines; 2098d752fcc8SJoe Perches} 2099d752fcc8SJoe Perches 2100f2d7e4d4SJoe Perchessub fix_insert_line { 2101f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2102f2d7e4d4SJoe Perches 2103f2d7e4d4SJoe Perches my $inserted = { 2104f2d7e4d4SJoe Perches LINENR => $linenr, 2105f2d7e4d4SJoe Perches LINE => $line, 2106f2d7e4d4SJoe Perches }; 2107f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2108f2d7e4d4SJoe Perches} 2109f2d7e4d4SJoe Perches 2110f2d7e4d4SJoe Perchessub fix_delete_line { 2111f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2112f2d7e4d4SJoe Perches 2113f2d7e4d4SJoe Perches my $deleted = { 2114f2d7e4d4SJoe Perches LINENR => $linenr, 2115f2d7e4d4SJoe Perches LINE => $line, 2116f2d7e4d4SJoe Perches }; 2117f2d7e4d4SJoe Perches 2118f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2119f2d7e4d4SJoe Perches} 2120f2d7e4d4SJoe Perches 2121de7d4f0eSAndy Whitcroftsub ERROR { 2122cbec18afSJoe Perches my ($type, $msg) = @_; 2123cbec18afSJoe Perches 2124cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2125de7d4f0eSAndy Whitcroft our $clean = 0; 21266c72ffaaSAndy Whitcroft our $cnt_error++; 21273705ce5bSJoe Perches return 1; 2128de7d4f0eSAndy Whitcroft } 21293705ce5bSJoe Perches return 0; 2130773647a0SAndy Whitcroft} 2131de7d4f0eSAndy Whitcroftsub WARN { 2132cbec18afSJoe Perches my ($type, $msg) = @_; 2133cbec18afSJoe Perches 2134cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2135de7d4f0eSAndy Whitcroft our $clean = 0; 21366c72ffaaSAndy Whitcroft our $cnt_warn++; 21373705ce5bSJoe Perches return 1; 2138de7d4f0eSAndy Whitcroft } 21393705ce5bSJoe Perches return 0; 2140773647a0SAndy Whitcroft} 2141de7d4f0eSAndy Whitcroftsub CHK { 2142cbec18afSJoe Perches my ($type, $msg) = @_; 2143cbec18afSJoe Perches 2144cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2145de7d4f0eSAndy Whitcroft our $clean = 0; 21466c72ffaaSAndy Whitcroft our $cnt_chk++; 21473705ce5bSJoe Perches return 1; 21486c72ffaaSAndy Whitcroft } 21493705ce5bSJoe Perches return 0; 2150de7d4f0eSAndy Whitcroft} 2151de7d4f0eSAndy Whitcroft 21526ecd9674SAndy Whitcroftsub check_absolute_file { 21536ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 21546ecd9674SAndy Whitcroft my $file = $absolute; 21556ecd9674SAndy Whitcroft 21566ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 21576ecd9674SAndy Whitcroft 21586ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 21596ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 21606ecd9674SAndy Whitcroft if (-f "$root/$file") { 21616ecd9674SAndy Whitcroft ##print "file<$file>\n"; 21626ecd9674SAndy Whitcroft last; 21636ecd9674SAndy Whitcroft } 21646ecd9674SAndy Whitcroft } 21656ecd9674SAndy Whitcroft if (! -f _) { 21666ecd9674SAndy Whitcroft return 0; 21676ecd9674SAndy Whitcroft } 21686ecd9674SAndy Whitcroft 21696ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 21706ecd9674SAndy Whitcroft my $prefix = $absolute; 21716ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 21726ecd9674SAndy Whitcroft 21736ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 21746ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2175000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2176000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 21776ecd9674SAndy Whitcroft } 21786ecd9674SAndy Whitcroft} 21796ecd9674SAndy Whitcroft 21803705ce5bSJoe Perchessub trim { 21813705ce5bSJoe Perches my ($string) = @_; 21823705ce5bSJoe Perches 2183b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2184b34c648bSJoe Perches 2185b34c648bSJoe Perches return $string; 2186b34c648bSJoe Perches} 2187b34c648bSJoe Perches 2188b34c648bSJoe Perchessub ltrim { 2189b34c648bSJoe Perches my ($string) = @_; 2190b34c648bSJoe Perches 2191b34c648bSJoe Perches $string =~ s/^\s+//; 2192b34c648bSJoe Perches 2193b34c648bSJoe Perches return $string; 2194b34c648bSJoe Perches} 2195b34c648bSJoe Perches 2196b34c648bSJoe Perchessub rtrim { 2197b34c648bSJoe Perches my ($string) = @_; 2198b34c648bSJoe Perches 2199b34c648bSJoe Perches $string =~ s/\s+$//; 22003705ce5bSJoe Perches 22013705ce5bSJoe Perches return $string; 22023705ce5bSJoe Perches} 22033705ce5bSJoe Perches 220452ea8506SJoe Perchessub string_find_replace { 220552ea8506SJoe Perches my ($string, $find, $replace) = @_; 220652ea8506SJoe Perches 220752ea8506SJoe Perches $string =~ s/$find/$replace/g; 220852ea8506SJoe Perches 220952ea8506SJoe Perches return $string; 221052ea8506SJoe Perches} 221152ea8506SJoe Perches 22123705ce5bSJoe Perchessub tabify { 22133705ce5bSJoe Perches my ($leading) = @_; 22143705ce5bSJoe Perches 22153705ce5bSJoe Perches my $source_indent = 8; 22163705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 22173705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 22183705ce5bSJoe Perches 22193705ce5bSJoe Perches #convert leading spaces to tabs 22203705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 22213705ce5bSJoe Perches #Remove spaces before a tab 22223705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 22233705ce5bSJoe Perches 22243705ce5bSJoe Perches return "$leading"; 22253705ce5bSJoe Perches} 22263705ce5bSJoe Perches 2227d1fe9c09SJoe Perchessub pos_last_openparen { 2228d1fe9c09SJoe Perches my ($line) = @_; 2229d1fe9c09SJoe Perches 2230d1fe9c09SJoe Perches my $pos = 0; 2231d1fe9c09SJoe Perches 2232d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2233d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2234d1fe9c09SJoe Perches 2235d1fe9c09SJoe Perches my $last_openparen = 0; 2236d1fe9c09SJoe Perches 2237d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2238d1fe9c09SJoe Perches return -1; 2239d1fe9c09SJoe Perches } 2240d1fe9c09SJoe Perches 2241d1fe9c09SJoe Perches my $len = length($line); 2242d1fe9c09SJoe Perches 2243d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2244d1fe9c09SJoe Perches my $string = substr($line, $pos); 2245d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2246d1fe9c09SJoe Perches $pos += length($1) - 1; 2247d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2248d1fe9c09SJoe Perches $last_openparen = $pos; 2249d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2250d1fe9c09SJoe Perches last; 2251d1fe9c09SJoe Perches } 2252d1fe9c09SJoe Perches } 2253d1fe9c09SJoe Perches 225491cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2255d1fe9c09SJoe Perches} 2256d1fe9c09SJoe Perches 22570a920b5bSAndy Whitcroftsub process { 22580a920b5bSAndy Whitcroft my $filename = shift; 22590a920b5bSAndy Whitcroft 22600a920b5bSAndy Whitcroft my $linenr=0; 22610a920b5bSAndy Whitcroft my $prevline=""; 2262c2fdda0dSAndy Whitcroft my $prevrawline=""; 22630a920b5bSAndy Whitcroft my $stashline=""; 2264c2fdda0dSAndy Whitcroft my $stashrawline=""; 22650a920b5bSAndy Whitcroft 22664a0df2efSAndy Whitcroft my $length; 22670a920b5bSAndy Whitcroft my $indent; 22680a920b5bSAndy Whitcroft my $previndent=0; 22690a920b5bSAndy Whitcroft my $stashindent=0; 22700a920b5bSAndy Whitcroft 2271de7d4f0eSAndy Whitcroft our $clean = 1; 22720a920b5bSAndy Whitcroft my $signoff = 0; 2273cd261496SGeert Uytterhoeven my $author = ''; 2274cd261496SGeert Uytterhoeven my $authorsignoff = 0; 22750a920b5bSAndy Whitcroft my $is_patch = 0; 2276133712a2SRob Herring my $is_binding_patch = -1; 227729ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 227815662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 2279ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2280490b292cSJoe Perches my $commit_log_lines = 0; #Number of commit log lines 2281bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 22822a076f40SJoe Perches my $commit_log_long_line = 0; 2283e518e9a5SJoe Perches my $commit_log_has_diff = 0; 228413f1937eSJoe Perches my $reported_maintainer_file = 0; 2285fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2286fa64205dSPasi Savanainen 2287365dd4eaSJoe Perches my $last_blank_line = 0; 22885e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2289365dd4eaSJoe Perches 229013214adfSAndy Whitcroft our @report = (); 22916c72ffaaSAndy Whitcroft our $cnt_lines = 0; 22926c72ffaaSAndy Whitcroft our $cnt_error = 0; 22936c72ffaaSAndy Whitcroft our $cnt_warn = 0; 22946c72ffaaSAndy Whitcroft our $cnt_chk = 0; 22956c72ffaaSAndy Whitcroft 22960a920b5bSAndy Whitcroft # Trace the real file/line as we go. 22970a920b5bSAndy Whitcroft my $realfile = ''; 22980a920b5bSAndy Whitcroft my $realline = 0; 22990a920b5bSAndy Whitcroft my $realcnt = 0; 23000a920b5bSAndy Whitcroft my $here = ''; 230177cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 23020a920b5bSAndy Whitcroft my $in_comment = 0; 2303c2fdda0dSAndy Whitcroft my $comment_edge = 0; 23040a920b5bSAndy Whitcroft my $first_line = 0; 23051e855726SWolfram Sang my $p1_prefix = ''; 23060a920b5bSAndy Whitcroft 230713214adfSAndy Whitcroft my $prev_values = 'E'; 230813214adfSAndy Whitcroft 230913214adfSAndy Whitcroft # suppression flags 2310773647a0SAndy Whitcroft my %suppress_ifbraces; 2311170d3a22SAndy Whitcroft my %suppress_whiletrailers; 23122b474a1aSAndy Whitcroft my %suppress_export; 23133e469cdcSAndy Whitcroft my $suppress_statement = 0; 2314653d4876SAndy Whitcroft 23157e51f197SJoe Perches my %signatures = (); 2316323c1260SJoe Perches 2317c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2318de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2319c2fdda0dSAndy Whitcroft # 2320de7d4f0eSAndy Whitcroft my @setup_docs = (); 2321de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2322773647a0SAndy Whitcroft 2323d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2324d8b07710SJoe Perches 23259f3a8992SRob Herring my $checklicenseline = 1; 23269f3a8992SRob Herring 2327773647a0SAndy Whitcroft sanitise_line_reset(); 2328c2fdda0dSAndy Whitcroft my $line; 2329c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2330773647a0SAndy Whitcroft $linenr++; 2331773647a0SAndy Whitcroft $line = $rawline; 2332c2fdda0dSAndy Whitcroft 23333705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 23343705ce5bSJoe Perches 2335773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2336de7d4f0eSAndy Whitcroft $setup_docs = 0; 23378c27ceffSMauro Carvalho Chehab if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) { 2338de7d4f0eSAndy Whitcroft $setup_docs = 1; 2339de7d4f0eSAndy Whitcroft } 2340773647a0SAndy Whitcroft #next; 2341de7d4f0eSAndy Whitcroft } 234274fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2343773647a0SAndy Whitcroft $realline=$1-1; 2344773647a0SAndy Whitcroft if (defined $2) { 2345773647a0SAndy Whitcroft $realcnt=$3+1; 2346773647a0SAndy Whitcroft } else { 2347773647a0SAndy Whitcroft $realcnt=1+1; 2348773647a0SAndy Whitcroft } 2349c45dcabdSAndy Whitcroft $in_comment = 0; 2350773647a0SAndy Whitcroft 2351773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2352773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2353773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2354773647a0SAndy Whitcroft # at context start. 2355773647a0SAndy Whitcroft my $edge; 235601fa9147SAndy Whitcroft my $cnt = $realcnt; 235701fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 235801fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 235901fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 236001fa9147SAndy Whitcroft $cnt--; 236101fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2362721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2363fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2364fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2365fae17daeSAndy Whitcroft ($edge) = $1; 2366fae17daeSAndy Whitcroft last; 2367fae17daeSAndy Whitcroft } 2368773647a0SAndy Whitcroft } 2369773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2370773647a0SAndy Whitcroft $in_comment = 1; 2371773647a0SAndy Whitcroft } 2372773647a0SAndy Whitcroft 2373773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2374773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2375773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2376773647a0SAndy Whitcroft if (!defined $edge && 237783242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2378773647a0SAndy Whitcroft { 2379773647a0SAndy Whitcroft $in_comment = 1; 2380773647a0SAndy Whitcroft } 2381773647a0SAndy Whitcroft 2382773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2383773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2384773647a0SAndy Whitcroft 2385171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2386773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2387171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2388773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2389773647a0SAndy Whitcroft } 2390773647a0SAndy Whitcroft push(@lines, $line); 2391773647a0SAndy Whitcroft 2392773647a0SAndy Whitcroft if ($realcnt > 1) { 2393773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2394773647a0SAndy Whitcroft } else { 2395773647a0SAndy Whitcroft $realcnt = 0; 2396773647a0SAndy Whitcroft } 2397773647a0SAndy Whitcroft 2398773647a0SAndy Whitcroft #print "==>$rawline\n"; 2399773647a0SAndy Whitcroft #print "-->$line\n"; 2400de7d4f0eSAndy Whitcroft 2401de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2402de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2403de7d4f0eSAndy Whitcroft } 2404de7d4f0eSAndy Whitcroft } 2405de7d4f0eSAndy Whitcroft 24066c72ffaaSAndy Whitcroft $prefix = ''; 24076c72ffaaSAndy Whitcroft 2408773647a0SAndy Whitcroft $realcnt = 0; 2409773647a0SAndy Whitcroft $linenr = 0; 2410194f66fcSJoe Perches $fixlinenr = -1; 24110a920b5bSAndy Whitcroft foreach my $line (@lines) { 24120a920b5bSAndy Whitcroft $linenr++; 2413194f66fcSJoe Perches $fixlinenr++; 24141b5539b1SJoe Perches my $sline = $line; #copy of $line 24151b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 24160a920b5bSAndy Whitcroft 2417c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 24186c72ffaaSAndy Whitcroft 241912c253abSJoe Perches# check if it's a mode change, rename or start of a patch 242012c253abSJoe Perches if (!$in_commit_log && 242112c253abSJoe Perches ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 242212c253abSJoe Perches ($line =~ /^rename (?:from|to) \S+\s*$/ || 242312c253abSJoe Perches $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 242412c253abSJoe Perches $is_patch = 1; 242512c253abSJoe Perches } 242612c253abSJoe Perches 24270a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2428e518e9a5SJoe Perches if (!$in_commit_log && 242974fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 243074fd4f34SJoe Perches my $context = $4; 24310a920b5bSAndy Whitcroft $is_patch = 1; 24324a0df2efSAndy Whitcroft $first_line = $linenr + 1; 24330a920b5bSAndy Whitcroft $realline=$1-1; 24340a920b5bSAndy Whitcroft if (defined $2) { 24350a920b5bSAndy Whitcroft $realcnt=$3+1; 24360a920b5bSAndy Whitcroft } else { 24370a920b5bSAndy Whitcroft $realcnt=1+1; 24380a920b5bSAndy Whitcroft } 2439c2fdda0dSAndy Whitcroft annotate_reset(); 244013214adfSAndy Whitcroft $prev_values = 'E'; 244113214adfSAndy Whitcroft 2442773647a0SAndy Whitcroft %suppress_ifbraces = (); 2443170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 24442b474a1aSAndy Whitcroft %suppress_export = (); 24453e469cdcSAndy Whitcroft $suppress_statement = 0; 244674fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 244774fd4f34SJoe Perches $context_function = $1; 244874fd4f34SJoe Perches } else { 244974fd4f34SJoe Perches undef $context_function; 245074fd4f34SJoe Perches } 24510a920b5bSAndy Whitcroft next; 24520a920b5bSAndy Whitcroft 24534a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 24544a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 24554a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2456773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 24570a920b5bSAndy Whitcroft $realline++; 2458d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 24590a920b5bSAndy Whitcroft 24604a0df2efSAndy Whitcroft # Measure the line length and indent. 2461c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 24620a920b5bSAndy Whitcroft 24630a920b5bSAndy Whitcroft # Track the previous line. 24640a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 24650a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2466c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2467c2fdda0dSAndy Whitcroft 2468773647a0SAndy Whitcroft #warn "line<$line>\n"; 24696c72ffaaSAndy Whitcroft 2470d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2471d8aaf121SAndy Whitcroft $realcnt--; 24720a920b5bSAndy Whitcroft } 24730a920b5bSAndy Whitcroft 2474cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2475cc77cdcaSAndy Whitcroft 24766c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 24776c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2478773647a0SAndy Whitcroft 24792ac73b4fSJoe Perches my $found_file = 0; 2480773647a0SAndy Whitcroft # extract the filename as it passes 24813bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 24823bf9a009SRabin Vincent $realfile = $1; 24832b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2484270c49a0SJoe Perches $in_commit_log = 0; 24852ac73b4fSJoe Perches $found_file = 1; 24863bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2487773647a0SAndy Whitcroft $realfile = $1; 24882b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2489270c49a0SJoe Perches $in_commit_log = 0; 24901e855726SWolfram Sang 24911e855726SWolfram Sang $p1_prefix = $1; 2492e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2493e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2494000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2495000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 24961e855726SWolfram Sang } 2497773647a0SAndy Whitcroft 2498c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2499000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2500000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2501773647a0SAndy Whitcroft } 25022ac73b4fSJoe Perches $found_file = 1; 25032ac73b4fSJoe Perches } 25042ac73b4fSJoe Perches 250534d8815fSJoe Perches#make up the handle for any error we report on this line 250634d8815fSJoe Perches if ($showfile) { 250734d8815fSJoe Perches $prefix = "$realfile:$realline: " 250834d8815fSJoe Perches } elsif ($emacs) { 25097d3a9f67SJoe Perches if ($file) { 25107d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 25117d3a9f67SJoe Perches } else { 251234d8815fSJoe Perches $prefix = "$filename:$linenr: "; 251334d8815fSJoe Perches } 25147d3a9f67SJoe Perches } 251534d8815fSJoe Perches 25162ac73b4fSJoe Perches if ($found_file) { 251785b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 251885b0ee18SJoe Perches WARN("OBSOLETE", 251985b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 252085b0ee18SJoe Perches } 25217bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 25222ac73b4fSJoe Perches $check = 1; 25232ac73b4fSJoe Perches } else { 25242ac73b4fSJoe Perches $check = $check_orig; 25252ac73b4fSJoe Perches } 25269f3a8992SRob Herring $checklicenseline = 1; 2527133712a2SRob Herring 2528133712a2SRob Herring if ($realfile !~ /^MAINTAINERS/) { 2529133712a2SRob Herring my $last_binding_patch = $is_binding_patch; 2530133712a2SRob Herring 2531133712a2SRob Herring $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@; 2532133712a2SRob Herring 2533133712a2SRob Herring if (($last_binding_patch != -1) && 2534133712a2SRob Herring ($last_binding_patch ^ $is_binding_patch)) { 2535133712a2SRob Herring WARN("DT_SPLIT_BINDING_PATCH", 2536133712a2SRob Herring "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n"); 2537133712a2SRob Herring } 2538133712a2SRob Herring } 2539133712a2SRob Herring 2540773647a0SAndy Whitcroft next; 2541773647a0SAndy Whitcroft } 2542773647a0SAndy Whitcroft 2543389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 25440a920b5bSAndy Whitcroft 2545c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2546c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2547c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 25480a920b5bSAndy Whitcroft 25496c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 25506c72ffaaSAndy Whitcroft 2551490b292cSJoe Perches# Verify the existence of a commit log if appropriate 2552490b292cSJoe Perches# 2 is used because a $signature is counted in $commit_log_lines 2553490b292cSJoe Perches if ($in_commit_log) { 2554490b292cSJoe Perches if ($line !~ /^\s*$/) { 2555490b292cSJoe Perches $commit_log_lines++; #could be a $signature 2556490b292cSJoe Perches } 2557490b292cSJoe Perches } elsif ($has_commit_log && $commit_log_lines < 2) { 2558490b292cSJoe Perches WARN("COMMIT_MESSAGE", 2559490b292cSJoe Perches "Missing commit description - Add an appropriate one\n"); 2560490b292cSJoe Perches $commit_log_lines = 2; #warn only once 2561490b292cSJoe Perches } 2562490b292cSJoe Perches 2563e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2564e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2565e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2566e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2567e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2568e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2569e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2570e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2571e518e9a5SJoe Perches $commit_log_has_diff = 1; 2572e518e9a5SJoe Perches } 2573e518e9a5SJoe Perches 25743bf9a009SRabin Vincent# Check for incorrect file permissions 25753bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 25763bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 257704db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 257804db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2579000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2580000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 25813bf9a009SRabin Vincent } 25823bf9a009SRabin Vincent } 25833bf9a009SRabin Vincent 2584cd261496SGeert Uytterhoeven# Check the patch for a From: 2585cd261496SGeert Uytterhoeven if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { 2586cd261496SGeert Uytterhoeven $author = $1; 2587cd261496SGeert Uytterhoeven $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); 2588cd261496SGeert Uytterhoeven $author =~ s/"//g; 2589cd261496SGeert Uytterhoeven } 2590cd261496SGeert Uytterhoeven 259120112475SJoe Perches# Check the patch for a signoff: 2592d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 25934a0df2efSAndy Whitcroft $signoff++; 259415662b3eSJoe Perches $in_commit_log = 0; 2595cd261496SGeert Uytterhoeven if ($author ne '') { 2596cd261496SGeert Uytterhoeven my $l = $line; 2597cd261496SGeert Uytterhoeven $l =~ s/"//g; 2598cd261496SGeert Uytterhoeven if ($l =~ /^\s*signed-off-by:\s*\Q$author\E/i) { 2599cd261496SGeert Uytterhoeven $authorsignoff = 1; 2600cd261496SGeert Uytterhoeven } 2601cd261496SGeert Uytterhoeven } 26020a920b5bSAndy Whitcroft } 260320112475SJoe Perches 2604e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2605e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2606e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2607e0d975b1SJoe Perches $reported_maintainer_file = 1; 2608e0d975b1SJoe Perches } 2609e0d975b1SJoe Perches 261020112475SJoe Perches# Check signature styles 2611270c49a0SJoe Perches if (!$in_header_lines && 2612ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 261320112475SJoe Perches my $space_before = $1; 261420112475SJoe Perches my $sign_off = $2; 261520112475SJoe Perches my $space_after = $3; 261620112475SJoe Perches my $email = $4; 261720112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 261820112475SJoe Perches 2619ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2620ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2621ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2622ce0338dfSJoe Perches } 262320112475SJoe Perches if (defined $space_before && $space_before ne "") { 26243705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 26253705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 26263705ce5bSJoe Perches $fix) { 2627194f66fcSJoe Perches $fixed[$fixlinenr] = 26283705ce5bSJoe Perches "$ucfirst_sign_off $email"; 26293705ce5bSJoe Perches } 263020112475SJoe Perches } 263120112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 26323705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 26333705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 26343705ce5bSJoe Perches $fix) { 2635194f66fcSJoe Perches $fixed[$fixlinenr] = 26363705ce5bSJoe Perches "$ucfirst_sign_off $email"; 26373705ce5bSJoe Perches } 26383705ce5bSJoe Perches 263920112475SJoe Perches } 264020112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 26413705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 26423705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 26433705ce5bSJoe Perches $fix) { 2644194f66fcSJoe Perches $fixed[$fixlinenr] = 26453705ce5bSJoe Perches "$ucfirst_sign_off $email"; 26463705ce5bSJoe Perches } 264720112475SJoe Perches } 264820112475SJoe Perches 264920112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 265020112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 265120112475SJoe Perches if ($suggested_email eq "") { 2652000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2653000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 265420112475SJoe Perches } else { 265520112475SJoe Perches my $dequoted = $suggested_email; 265620112475SJoe Perches $dequoted =~ s/^"//; 265720112475SJoe Perches $dequoted =~ s/" </ </; 265820112475SJoe Perches # Don't force email to have quotes 265920112475SJoe Perches # Allow just an angle bracketed address 266020112475SJoe Perches if ("$dequoted$comment" ne $email && 266120112475SJoe Perches "<$email_address>$comment" ne $email && 266220112475SJoe Perches "$suggested_email$comment" ne $email) { 2663000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2664000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 266520112475SJoe Perches } 26660a920b5bSAndy Whitcroft } 26677e51f197SJoe Perches 26687e51f197SJoe Perches# Check for duplicate signatures 26697e51f197SJoe Perches my $sig_nospace = $line; 26707e51f197SJoe Perches $sig_nospace =~ s/\s//g; 26717e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 26727e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 26737e51f197SJoe Perches WARN("BAD_SIGN_OFF", 26747e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 26757e51f197SJoe Perches } else { 26767e51f197SJoe Perches $signatures{$sig_nospace} = 1; 26777e51f197SJoe Perches } 26780a920b5bSAndy Whitcroft } 26790a920b5bSAndy Whitcroft 2680a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2681a2fe16b9SJoe Perches if ($in_header_lines && 2682a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2683a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2684a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2685a2fe16b9SJoe Perches } 2686a2fe16b9SJoe Perches 26877ebd05efSChristopher Covington# Check for unwanted Gerrit info 26887ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 26897ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 26907ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 26917ebd05efSChristopher Covington } 26927ebd05efSChristopher Covington 2693369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2694369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2695369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2696369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2697369c8dd3SJoe Perches # timestamp 2698369c8dd3SJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) { 2699369c8dd3SJoe Perches # stack dump address 2700369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2701369c8dd3SJoe Perches } 2702369c8dd3SJoe Perches 27032a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 27042a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2705bf4daf12SJoe Perches length($line) > 75 && 2706bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2707bf4daf12SJoe Perches # file delta changes 2708bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2709bf4daf12SJoe Perches # filename then : 2710bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2711bf4daf12SJoe Perches # A Fixes: or Link: line 2712bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 27132a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 27142a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 27152a076f40SJoe Perches $commit_log_long_line = 1; 27162a076f40SJoe Perches } 27172a076f40SJoe Perches 2718bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2719bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2720bf4daf12SJoe Perches $line =~ /^\s*$/) { 2721bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2722bf4daf12SJoe Perches } 2723bf4daf12SJoe Perches 27240d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2725369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2726aab38f51SJoe Perches $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i && 2727e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 2728fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2729aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2730369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2731bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2732fe043ea1SJoe Perches my $init_char = "c"; 2733fe043ea1SJoe Perches my $orig_commit = ""; 27340d7835fcSJoe Perches my $short = 1; 27350d7835fcSJoe Perches my $long = 0; 27360d7835fcSJoe Perches my $case = 1; 27370d7835fcSJoe Perches my $space = 1; 27380d7835fcSJoe Perches my $hasdesc = 0; 273919c146a6SJoe Perches my $hasparens = 0; 27400d7835fcSJoe Perches my $id = '0123456789ab'; 27410d7835fcSJoe Perches my $orig_desc = "commit description"; 27420d7835fcSJoe Perches my $description = ""; 27430d7835fcSJoe Perches 2744fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2745fe043ea1SJoe Perches $init_char = $1; 2746fe043ea1SJoe Perches $orig_commit = lc($2); 2747fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2748fe043ea1SJoe Perches $orig_commit = lc($1); 2749fe043ea1SJoe Perches } 2750fe043ea1SJoe Perches 27510d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 27520d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 27530d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 27540d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 27550d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 27560d7835fcSJoe Perches $orig_desc = $1; 275719c146a6SJoe Perches $hasparens = 1; 27580d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 27590d7835fcSJoe Perches defined $rawlines[$linenr] && 27600d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 27610d7835fcSJoe Perches $orig_desc = $1; 276219c146a6SJoe Perches $hasparens = 1; 2763b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2764b671fde0SJoe Perches defined $rawlines[$linenr] && 2765b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2766b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2767b671fde0SJoe Perches $orig_desc = $1; 2768b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2769b671fde0SJoe Perches $orig_desc .= " " . $1; 277019c146a6SJoe Perches $hasparens = 1; 27710d7835fcSJoe Perches } 27720d7835fcSJoe Perches 27730d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 27740d7835fcSJoe Perches $id, $orig_desc); 27750d7835fcSJoe Perches 2776948b133aSHeinrich Schuchardt if (defined($id) && 2777948b133aSHeinrich Schuchardt ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { 2778d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 27790d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 27800d7835fcSJoe Perches } 2781d311cd44SJoe Perches } 2782d311cd44SJoe Perches 278313f1937eSJoe Perches# Check for added, moved or deleted files 278413f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 278513f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 278613f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 278713f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 278813f1937eSJoe Perches (defined($1) || defined($2))))) { 2789a82603a8SAndrew Jeffery $is_patch = 1; 279013f1937eSJoe Perches $reported_maintainer_file = 1; 279113f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 279213f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 279313f1937eSJoe Perches } 279413f1937eSJoe Perches 279500df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 27968905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2797000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2798000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 27996c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2800de7d4f0eSAndy Whitcroft } 2801de7d4f0eSAndy Whitcroft 2802de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2803de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2804171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2805171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2806171ae1a4SAndy Whitcroft 2807171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2808171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2809171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2810171ae1a4SAndy Whitcroft 281134d99219SJoe Perches CHK("INVALID_UTF8", 2812000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 281300df344fSAndy Whitcroft } 28140a920b5bSAndy Whitcroft 281515662b3eSJoe Perches# Check if it's the start of a commit log 281615662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 281715662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 2818eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 2819eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 282015662b3eSJoe Perches $in_header_lines = 0; 282115662b3eSJoe Perches $in_commit_log = 1; 2822ed43c4e5SAllen Hubbe $has_commit_log = 1; 282315662b3eSJoe Perches } 282415662b3eSJoe Perches 2825fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2826fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2827fa64205dSPasi Savanainen if ($in_header_lines && 2828fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2829fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2830fa64205dSPasi Savanainen $non_utf8_charset = 1; 2831fa64205dSPasi Savanainen } 2832fa64205dSPasi Savanainen 2833fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 283415662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2835fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 283615662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 283715662b3eSJoe Perches } 283815662b3eSJoe Perches 2839d6430f71SJoe Perches# Check for absolute kernel paths in commit message 2840d6430f71SJoe Perches if ($tree && $in_commit_log) { 2841d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 2842d6430f71SJoe Perches my $file = $1; 2843d6430f71SJoe Perches 2844d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 2845d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 2846d6430f71SJoe Perches # 2847d6430f71SJoe Perches } else { 2848d6430f71SJoe Perches check_absolute_file($file, $herecurr); 2849d6430f71SJoe Perches } 2850d6430f71SJoe Perches } 2851d6430f71SJoe Perches } 2852d6430f71SJoe Perches 285366b47b4aSKees Cook# Check for various typo / spelling mistakes 285466d7a382SJoe Perches if (defined($misspellings) && 285566d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2856ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 285766b47b4aSKees Cook my $typo = $1; 285866b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 285966b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 286066b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 28610675a8fbSJean Delvare my $msg_level = \&WARN; 28620675a8fbSJean Delvare $msg_level = \&CHK if ($file); 28630675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 286466b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 286566b47b4aSKees Cook $fix) { 286666b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 286766b47b4aSKees Cook } 286866b47b4aSKees Cook } 286966b47b4aSKees Cook } 287066b47b4aSKees Cook 287130670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 287230670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 287300df344fSAndy Whitcroft 28740a920b5bSAndy Whitcroft#trailing whitespace 28759c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2876c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2877d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2878d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2879d5e616fcSJoe Perches $fix) { 2880194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2881d5e616fcSJoe Perches } 2882c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2883c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28843705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 28853705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 28863705ce5bSJoe Perches $fix) { 2887194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 28883705ce5bSJoe Perches } 28893705ce5bSJoe Perches 2890d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 28910a920b5bSAndy Whitcroft } 28925368df20SAndy Whitcroft 28934783f894SJosh Triplett# Check for FSF mailing addresses. 2894109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 28951bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 28963e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 28973e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 28984783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28990675a8fbSJean Delvare my $msg_level = \&ERROR; 29000675a8fbSJean Delvare $msg_level = \&CHK if ($file); 29010675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 29024783f894SJosh 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) 29034783f894SJosh Triplett } 29044783f894SJosh Triplett 29053354957aSAndi Kleen# check for Kconfig help text having a real description 29069fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 29079fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 29083354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 2909678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 2910678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 2911678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 2912678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 29133354957aSAndi Kleen my $length = 0; 29149fe287d7SAndy Whitcroft my $cnt = $realcnt; 29159fe287d7SAndy Whitcroft my $ln = $linenr + 1; 29169fe287d7SAndy Whitcroft my $f; 2917a1385803SAndy Whitcroft my $is_start = 0; 29189fe287d7SAndy Whitcroft my $is_end = 0; 2919a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 29209fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 29219fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 29229fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 29239fe287d7SAndy Whitcroft 29249fe287d7SAndy Whitcroft next if ($f =~ /^-/); 29258d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2926a1385803SAndy Whitcroft 292786adf1a0SUlf Magnusson if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 2928a1385803SAndy Whitcroft $is_start = 1; 292984af7a61SUlf Magnusson } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) { 293084af7a61SUlf Magnusson if ($lines[$ln - 1] =~ "---help---") { 293184af7a61SUlf Magnusson WARN("CONFIG_DESCRIPTION", 293284af7a61SUlf Magnusson "prefer 'help' over '---help---' for new help texts\n" . $herecurr); 293384af7a61SUlf Magnusson } 2934a1385803SAndy Whitcroft $length = -1; 2935a1385803SAndy Whitcroft } 2936a1385803SAndy Whitcroft 29379fe287d7SAndy Whitcroft $f =~ s/^.//; 29383354957aSAndi Kleen $f =~ s/#.*//; 29393354957aSAndi Kleen $f =~ s/^\s+//; 29403354957aSAndi Kleen next if ($f =~ /^$/); 2941678ae162SUlf Magnusson 2942678ae162SUlf Magnusson # This only checks context lines in the patch 2943678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 2944678ae162SUlf Magnusson # positives, even though some of these are 2945678ae162SUlf Magnusson # common words in help texts 2946678ae162SUlf Magnusson if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| 2947678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 29489fe287d7SAndy Whitcroft $is_end = 1; 29499fe287d7SAndy Whitcroft last; 29509fe287d7SAndy Whitcroft } 29513354957aSAndi Kleen $length++; 29523354957aSAndi Kleen } 295356193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2954000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 295556193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 295656193274SVadim Bendebury } 2957a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 29583354957aSAndi Kleen } 29593354957aSAndi Kleen 2960628f91a2SJoe Perches# check for MAINTAINERS entries that don't have the right form 2961628f91a2SJoe Perches if ($realfile =~ /^MAINTAINERS$/ && 2962628f91a2SJoe Perches $rawline =~ /^\+[A-Z]:/ && 2963628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 2964628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 2965628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 2966628f91a2SJoe Perches $fix) { 2967628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 2968628f91a2SJoe Perches } 2969628f91a2SJoe Perches } 2970628f91a2SJoe Perches 2971327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2972327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2973327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2974327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2975327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2976327953e9SChristoph Jaeger } 2977327953e9SChristoph Jaeger 2978c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2979c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2980c68e5878SArnaud Lacombe my $flag = $1; 2981c68e5878SArnaud Lacombe my $replacement = { 2982c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2983c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2984c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2985c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2986c68e5878SArnaud Lacombe }; 2987c68e5878SArnaud Lacombe 2988c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2989c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2990c68e5878SArnaud Lacombe } 2991c68e5878SArnaud Lacombe 2992bff5da43SRob Herring# check for DT compatible documentation 29937dd05b38SFlorian Vaussard if (defined $root && 29947dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 29957dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 29967dd05b38SFlorian Vaussard 2997bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2998bff5da43SRob Herring 2999cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 3000cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 3001cc93319bSFlorian Vaussard 3002bff5da43SRob Herring foreach my $compat (@compats) { 3003bff5da43SRob Herring my $compat2 = $compat; 3004185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 3005185d566bSRob Herring my $compat3 = $compat; 3006185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 3007185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 3008bff5da43SRob Herring if ( $? >> 8 ) { 3009bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3010bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 3011bff5da43SRob Herring } 3012bff5da43SRob Herring 30134fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 30144fbf32a6SFlorian Vaussard my $vendor = $1; 3015cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 3016bff5da43SRob Herring if ( $? >> 8 ) { 3017bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3018cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 3019bff5da43SRob Herring } 3020bff5da43SRob Herring } 3021bff5da43SRob Herring } 3022bff5da43SRob Herring 30239f3a8992SRob Herring# check for using SPDX license tag at beginning of files 30249f3a8992SRob Herring if ($realline == $checklicenseline) { 30259f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 30269f3a8992SRob Herring $checklicenseline = 2; 30279f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 30289f3a8992SRob Herring my $comment = ""; 30299f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 30309f3a8992SRob Herring $comment = '/*'; 30319f3a8992SRob Herring } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 30329f3a8992SRob Herring $comment = '//'; 30339f3a8992SRob Herring } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) { 30349f3a8992SRob Herring $comment = '#'; 30359f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 30369f3a8992SRob Herring $comment = '..'; 30379f3a8992SRob Herring } 30389f3a8992SRob Herring 30399f3a8992SRob Herring if ($comment !~ /^$/ && 30409f3a8992SRob Herring $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) { 30419f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 30429f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 30433b6e8ac9SJoe Perches } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) { 30443b6e8ac9SJoe Perches my $spdx_license = $1; 30453b6e8ac9SJoe Perches if (!is_SPDX_License_valid($spdx_license)) { 30463b6e8ac9SJoe Perches WARN("SPDX_LICENSE_TAG", 30473b6e8ac9SJoe Perches "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr); 30483b6e8ac9SJoe Perches } 30499f3a8992SRob Herring } 30509f3a8992SRob Herring } 30519f3a8992SRob Herring } 30529f3a8992SRob Herring 30535368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 3054d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 30555368df20SAndy Whitcroft 305647e0c88bSJoe Perches# line length limit (with some exclusions) 305747e0c88bSJoe Perches# 305847e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 305947e0c88bSJoe Perches# logging functions like pr_info that end in a string 306047e0c88bSJoe Perches# lines with a single string 306147e0c88bSJoe Perches# #defines that are a single string 30622e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 306347e0c88bSJoe Perches# 306447e0c88bSJoe Perches# There are 3 different line length message types: 3065ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 306647e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 306747e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 306847e0c88bSJoe Perches# 306947e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 307047e0c88bSJoe Perches# 307147e0c88bSJoe Perches 3072b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 307347e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 307447e0c88bSJoe Perches 307547e0c88bSJoe Perches # Check the allowed long line types first 307647e0c88bSJoe Perches 307747e0c88bSJoe Perches # logging functions that end in a string that starts 307847e0c88bSJoe Perches # before $max_line_length 307947e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 308047e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 308147e0c88bSJoe Perches $msg_type = ""; 308247e0c88bSJoe Perches 308347e0c88bSJoe Perches # lines with only strings (w/ possible termination) 308447e0c88bSJoe Perches # #defines with only strings 308547e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 308647e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 308747e0c88bSJoe Perches $msg_type = ""; 308847e0c88bSJoe Perches 3089cc147506SJoe Perches # More special cases 3090cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3091cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3092d560a5f8SJoe Perches $msg_type = ""; 3093d560a5f8SJoe Perches 30942e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 30952e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 30962e4bbbc5SAndreas Brauchli $msg_type = ""; 30972e4bbbc5SAndreas Brauchli 309847e0c88bSJoe Perches # Otherwise set the alternate message types 309947e0c88bSJoe Perches 310047e0c88bSJoe Perches # a comment starts before $max_line_length 310147e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 310247e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 310347e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 310447e0c88bSJoe Perches 310547e0c88bSJoe Perches # a quoted string starts before $max_line_length 310647e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 310747e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 310847e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 310947e0c88bSJoe Perches } 311047e0c88bSJoe Perches 311147e0c88bSJoe Perches if ($msg_type ne "" && 311247e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 311347e0c88bSJoe Perches WARN($msg_type, 31146cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 31150a920b5bSAndy Whitcroft } 311647e0c88bSJoe Perches } 31170a920b5bSAndy Whitcroft 31188905a67cSAndy Whitcroft# check for adding lines without a newline. 31198905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 3120000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 3121000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 31228905a67cSAndy Whitcroft } 31238905a67cSAndy Whitcroft 3124b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3125de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 31260a920b5bSAndy Whitcroft 31270a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 31280a920b5bSAndy Whitcroft# more than 8 must use tabs. 3129c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3130c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3131c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3132d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 31333705ce5bSJoe Perches if (ERROR("CODE_INDENT", 31343705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 31353705ce5bSJoe Perches $fix) { 3136194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 31373705ce5bSJoe Perches } 31380a920b5bSAndy Whitcroft } 31390a920b5bSAndy Whitcroft 314008e44365SAlberto Panizzo# check for space before tabs. 314108e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 314208e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 31433705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 31443705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 31453705ce5bSJoe Perches $fix) { 3146194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3147d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 3148194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3149c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 31503705ce5bSJoe Perches } 315108e44365SAlberto Panizzo } 315208e44365SAlberto Panizzo 31536a487211SJoe Perches# check for assignments on the start of a line 31546a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 31556a487211SJoe Perches CHK("ASSIGNMENT_CONTINUATIONS", 31566a487211SJoe Perches "Assignment operator '$1' should be on the previous line\n" . $hereprev); 31576a487211SJoe Perches } 31586a487211SJoe Perches 3159d1fe9c09SJoe Perches# check for && or || at the start of a line 3160d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 3161d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 3162d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 3163d1fe9c09SJoe Perches } 3164d1fe9c09SJoe Perches 3165a91e8994SJoe Perches# check indentation starts on a tab stop 31665b57980dSJoe Perches if ($perl_version_ok && 3167bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3168a91e8994SJoe Perches my $indent = length($1); 3169a91e8994SJoe Perches if ($indent % 8) { 3170a91e8994SJoe Perches if (WARN("TABSTOP", 3171a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3172a91e8994SJoe Perches $fix) { 3173a91e8994SJoe Perches $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; 3174a91e8994SJoe Perches } 3175a91e8994SJoe Perches } 3176a91e8994SJoe Perches } 3177a91e8994SJoe Perches 3178d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 31795b57980dSJoe Perches if ($perl_version_ok && 3180fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3181d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3182d1fe9c09SJoe Perches my $oldindent = $1; 3183d1fe9c09SJoe Perches my $rest = $2; 3184d1fe9c09SJoe Perches 3185d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3186d1fe9c09SJoe Perches if ($pos >= 0) { 3187b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3188b34a26f3SJoe Perches my $newindent = $2; 3189d1fe9c09SJoe Perches 3190d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3191d1fe9c09SJoe Perches "\t" x ($pos / 8) . 3192d1fe9c09SJoe Perches " " x ($pos % 8); 3193d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3194d1fe9c09SJoe Perches 3195d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3196d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 31973705ce5bSJoe Perches 31983705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 31993705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 32003705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3201194f66fcSJoe Perches $fixed[$fixlinenr] =~ 32023705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 32033705ce5bSJoe Perches } 3204d1fe9c09SJoe Perches } 3205d1fe9c09SJoe Perches } 3206d1fe9c09SJoe Perches } 3207d1fe9c09SJoe Perches 32086ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 32096ab3a970SJoe Perches# avoid checking a few false positives: 32106ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 32116ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 32126ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 32136ab3a970SJoe Perches# multiline macros that define functions 32146ab3a970SJoe Perches# known attributes or the __attribute__ keyword 32156ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 32166ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 32173705ce5bSJoe Perches if (CHK("SPACING", 3218f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 32193705ce5bSJoe Perches $fix) { 3220194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3221f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 32223705ce5bSJoe Perches } 3223aad4f614SJoe Perches } 3224aad4f614SJoe Perches 322586406b1cSJoe Perches# Block comment styles 322686406b1cSJoe Perches# Networking with an initial /* 322705880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3228fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 322985ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 323085ad978cSJoe Perches $realline > 2) { 323105880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 323205880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 323305880600SJoe Perches } 323405880600SJoe Perches 323586406b1cSJoe Perches# Block comments use * on subsequent lines 323686406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 323786406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3238a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 323961135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3240a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 324186406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 324286406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3243a605e32eSJoe Perches } 3244a605e32eSJoe Perches 324586406b1cSJoe Perches# Block comments use */ on trailing lines 324686406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3247c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3248c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3249c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 325086406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 325186406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 325205880600SJoe Perches } 325305880600SJoe Perches 325408eb9b80SJoe Perches# Block comment * alignment 325508eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3256af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3257af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3258af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 325908eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3260af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3261af207524SJoe Perches my $oldindent; 326208eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3263af207524SJoe Perches if (defined($1)) { 3264af207524SJoe Perches $oldindent = expand_tabs($1); 3265af207524SJoe Perches } else { 3266af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3267af207524SJoe Perches $oldindent = expand_tabs($1); 3268af207524SJoe Perches } 326908eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 327008eb9b80SJoe Perches my $newindent = $1; 327108eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3272af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 327308eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 327408eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 327508eb9b80SJoe Perches } 327608eb9b80SJoe Perches } 327708eb9b80SJoe Perches 32787f619191SJoe Perches# check for missing blank lines after struct/union declarations 32797f619191SJoe Perches# with exceptions for various attributes and macros 32807f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 32817f619191SJoe Perches $line =~ /^\+/ && 32827f619191SJoe Perches !($line =~ /^\+\s*$/ || 32837f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 32847f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 32857f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 32867f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 32877f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 32887f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 32890bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 32907f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3291d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3292d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3293d752fcc8SJoe Perches $fix) { 3294f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3295d752fcc8SJoe Perches } 32967f619191SJoe Perches } 32977f619191SJoe Perches 3298365dd4eaSJoe Perches# check for multiple consecutive blank lines 3299365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3300365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3301365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3302d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3303d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3304d752fcc8SJoe Perches $fix) { 3305f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3306d752fcc8SJoe Perches } 3307d752fcc8SJoe Perches 3308365dd4eaSJoe Perches $last_blank_line = $linenr; 3309365dd4eaSJoe Perches } 3310365dd4eaSJoe Perches 33113b617e3bSJoe Perches# check for missing blank lines after declarations 33123f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 33133f7bac03SJoe Perches # actual declarations 33143f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 33155a4e1fd3SJoe Perches # function pointer declarations 33165a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 33173f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 33183f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 33193f7bac03SJoe Perches # known declaration macros 33203f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 33213f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 33223f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 33233f7bac03SJoe Perches # other possible extensions of declaration lines 33243f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 33253f7bac03SJoe Perches # not starting a section or a macro "\" extended line 33263f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 33273f7bac03SJoe Perches # looks like a declaration 33283f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 33295a4e1fd3SJoe Perches # function pointer declarations 33305a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 33313f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 33323f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 33333f7bac03SJoe Perches # known declaration macros 33343f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 33353f7bac03SJoe Perches # start of struct or union or enum 3336328b5f41SJoe Perches $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ || 33373f7bac03SJoe Perches # start or end of block or continuation of declaration 33383f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 33393f7bac03SJoe Perches # bitfield continuation 33403f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 33413f7bac03SJoe Perches # other possible extensions of declaration lines 33423f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 33433f7bac03SJoe Perches # indentation of previous and current line are the same 33443f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3345d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3346d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3347d752fcc8SJoe Perches $fix) { 3348f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3349d752fcc8SJoe Perches } 33503b617e3bSJoe Perches } 33513b617e3bSJoe Perches 33525f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 33536b4c5bebSAndy Whitcroft# Exceptions: 33546b4c5bebSAndy Whitcroft# 1) within comments 33556b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 33566b4c5bebSAndy Whitcroft# 3) hanging labels 33573705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 33585f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 33593705ce5bSJoe Perches if (WARN("LEADING_SPACE", 33603705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 33613705ce5bSJoe Perches $fix) { 3362194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 33633705ce5bSJoe Perches } 33645f7ddae6SRaffaele Recalcati } 33655f7ddae6SRaffaele Recalcati 3366b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3367b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3368b9ea10d6SAndy Whitcroft 33695751a24eSJoe Perches# check for unusual line ending [ or ( 33705751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 33715751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 33725751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 33735751a24eSJoe Perches } 33745751a24eSJoe Perches 33754dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 33764dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 33774dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 33784dbed76fSJoe Perches $context_function = $1; 33794dbed76fSJoe Perches } 33804dbed76fSJoe Perches 33814dbed76fSJoe Perches# check if this appears to be the end of function declaration 33824dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 33834dbed76fSJoe Perches undef $context_function; 33844dbed76fSJoe Perches } 33854dbed76fSJoe Perches 3386032a4c0fSJoe Perches# check indentation of any line with a bare else 3387840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3388032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3389032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3390032a4c0fSJoe Perches my $tabs = length($1) + 1; 3391840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3392840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3393840080a0SJoe Perches defined $lines[$linenr] && 3394840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3395032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3396032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3397032a4c0fSJoe Perches } 3398032a4c0fSJoe Perches } 3399032a4c0fSJoe Perches 3400c00df19aSJoe Perches# check indentation of a line with a break; 3401c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3402c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3403c00df19aSJoe Perches my $tabs = $1; 3404c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3405c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3406c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3407c00df19aSJoe Perches } 3408c00df19aSJoe Perches } 3409c00df19aSJoe Perches 3410c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3411cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3412000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3413000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3414c2fdda0dSAndy Whitcroft } 341522f2a2efSAndy Whitcroft 341656e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 341756e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 341856e77d70SJoe Perches WARN("HOTPLUG_SECTION", 341956e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 342056e77d70SJoe Perches } 342156e77d70SJoe Perches 34229c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 34232b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 34242b474a1aSAndy Whitcroft $realline_next); 34253e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 3426ca819864SJoe Perches if ($linenr > $suppress_statement && 34271b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3428170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3429f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3430171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3431171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3432171ae1a4SAndy Whitcroft 34333e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 34343e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 34353e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 34363e469cdcSAndy Whitcroft # until we hit end of it. 34373e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 34383e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 34393e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 34403e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 34413e469cdcSAndy Whitcroft } 3442f74bd194SAndy Whitcroft 34432b474a1aSAndy Whitcroft # Find the real next line. 34442b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 34452b474a1aSAndy Whitcroft if (defined $realline_next && 34462b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 34472b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 34482b474a1aSAndy Whitcroft $realline_next++; 34492b474a1aSAndy Whitcroft } 34502b474a1aSAndy Whitcroft 3451171ae1a4SAndy Whitcroft my $s = $stat; 3452171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3453cf655043SAndy Whitcroft 3454c2fdda0dSAndy Whitcroft # Ignore goto labels. 3455171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3456c2fdda0dSAndy Whitcroft 3457c2fdda0dSAndy Whitcroft # Ignore functions being called 3458171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3459c2fdda0dSAndy Whitcroft 3460463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3461463f2864SAndy Whitcroft 3462c45dcabdSAndy Whitcroft # declarations always start with types 3463d2506586SAndy 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) { 3464c45dcabdSAndy Whitcroft my $type = $1; 3465c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3466c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3467c45dcabdSAndy Whitcroft 34686c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3469a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3470c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3471c2fdda0dSAndy Whitcroft } 34728905a67cSAndy Whitcroft 34736c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 347465863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3475c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 34769c0ca6f9SAndy Whitcroft } 34778905a67cSAndy Whitcroft 34788905a67cSAndy Whitcroft # Check for any sort of function declaration. 34798905a67cSAndy Whitcroft # int foo(something bar, other baz); 34808905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3481171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 34828905a67cSAndy Whitcroft my ($name_len) = length($1); 34838905a67cSAndy Whitcroft 3484cf655043SAndy Whitcroft my $ctx = $s; 3485773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 34868905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3487cf655043SAndy Whitcroft 34888905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3489c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 34908905a67cSAndy Whitcroft 3491c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 34928905a67cSAndy Whitcroft } 34938905a67cSAndy Whitcroft } 34948905a67cSAndy Whitcroft } 34958905a67cSAndy Whitcroft 34969c0ca6f9SAndy Whitcroft } 34979c0ca6f9SAndy Whitcroft 349800df344fSAndy Whitcroft# 349900df344fSAndy Whitcroft# Checks which may be anchored in the context. 350000df344fSAndy Whitcroft# 350100df344fSAndy Whitcroft 350200df344fSAndy Whitcroft# Check for switch () and associated case and default 350300df344fSAndy Whitcroft# statements should be at the same indent. 350400df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 350500df344fSAndy Whitcroft my $err = ''; 350600df344fSAndy Whitcroft my $sep = ''; 350700df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 350800df344fSAndy Whitcroft shift(@ctx); 350900df344fSAndy Whitcroft for my $ctx (@ctx) { 351000df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 351100df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 351200df344fSAndy Whitcroft $indent != $cindent) { 351300df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 351400df344fSAndy Whitcroft $sep = ''; 351500df344fSAndy Whitcroft } else { 351600df344fSAndy Whitcroft $sep = "[...]\n"; 351700df344fSAndy Whitcroft } 351800df344fSAndy Whitcroft } 351900df344fSAndy Whitcroft if ($err ne '') { 3520000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3521000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3522de7d4f0eSAndy Whitcroft } 3523de7d4f0eSAndy Whitcroft } 3524de7d4f0eSAndy Whitcroft 3525de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3526de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 35270fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3528773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3529773647a0SAndy Whitcroft 35309c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 35318eef05ddSJoe Perches 35328eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 35338eef05ddSJoe Perches WARN("DEEP_INDENTATION", 35348eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 35358eef05ddSJoe Perches } 35368eef05ddSJoe Perches 3537de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3538de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3539de7d4f0eSAndy Whitcroft 3540548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3541548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3542de7d4f0eSAndy Whitcroft 3543548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3544548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3545548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3546548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3547548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3548773647a0SAndy Whitcroft $ctx_ln++; 3549773647a0SAndy Whitcroft } 3550548596d5SAndy Whitcroft 355153210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 355253210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3553773647a0SAndy Whitcroft 3554773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3555000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3556000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 355701464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 355800df344fSAndy Whitcroft } 3559773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3560773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3561773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3562773647a0SAndy Whitcroft { 35639c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 35649c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3565000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3566000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 356701464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 35689c0ca6f9SAndy Whitcroft } 35699c0ca6f9SAndy Whitcroft } 357000df344fSAndy Whitcroft } 357100df344fSAndy Whitcroft 35724d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 3573f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 35743e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 35753e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 35763e469cdcSAndy Whitcroft if (!defined $stat); 35774d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 35784d001e4dSAndy Whitcroft 35794d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 35804d001e4dSAndy Whitcroft 35819f5af480SJoe Perches # remove inline comments 35829f5af480SJoe Perches $s =~ s/$;/ /g; 35839f5af480SJoe Perches $c =~ s/$;/ /g; 35844d001e4dSAndy Whitcroft 35854d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 35866f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 35876f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 35884d001e4dSAndy Whitcroft 35899f5af480SJoe Perches # Make sure we remove the line prefixes as we have 35909f5af480SJoe Perches # none on the first line, and are going to readd them 35919f5af480SJoe Perches # where necessary. 35929f5af480SJoe Perches $s =~ s/\n./\n/gs; 35939f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 35949f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 35959f5af480SJoe Perches } 35969f5af480SJoe Perches 35974d001e4dSAndy Whitcroft # We want to check the first line inside the block 35984d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 35994d001e4dSAndy Whitcroft # 1) any blank line termination 36004d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 36014d001e4dSAndy Whitcroft # 3) any do (...) { 36024d001e4dSAndy Whitcroft my $continuation = 0; 36034d001e4dSAndy Whitcroft my $check = 0; 36044d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 36054d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 36064d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 36074d001e4dSAndy Whitcroft $continuation = 1; 36084d001e4dSAndy Whitcroft } 36099bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 36104d001e4dSAndy Whitcroft $check = 1; 36114d001e4dSAndy Whitcroft $cond_lines++; 36124d001e4dSAndy Whitcroft } 36134d001e4dSAndy Whitcroft 36144d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 36154d001e4dSAndy Whitcroft # preprocessor statement. 36164d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 36174d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 36184d001e4dSAndy Whitcroft $check = 0; 36194d001e4dSAndy Whitcroft } 36204d001e4dSAndy Whitcroft 36219bd49efeSAndy Whitcroft my $cond_ptr = -1; 3622740504c6SAndy Whitcroft $continuation = 0; 36239bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 36249bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 36254d001e4dSAndy Whitcroft 3626f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3627f16fa28fSAndy Whitcroft # is not linear. 3628f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3629f16fa28fSAndy Whitcroft $check = 0; 3630f16fa28fSAndy Whitcroft } 3631f16fa28fSAndy Whitcroft 36329bd49efeSAndy Whitcroft # Ignore: 36339bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 36349bd49efeSAndy Whitcroft # 2) preprocessor lines, and 36359bd49efeSAndy Whitcroft # 3) labels. 3636740504c6SAndy Whitcroft if ($continuation || 3637740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 36389bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 36399bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3640740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 364130dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 36429bd49efeSAndy Whitcroft $cond_lines++; 36439bd49efeSAndy Whitcroft } 36444d001e4dSAndy Whitcroft } 364530dad6ebSAndy Whitcroft } 36464d001e4dSAndy Whitcroft 36474d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 36484d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 36494d001e4dSAndy Whitcroft 36504d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 36514d001e4dSAndy Whitcroft # this is not this patch's fault. 36524d001e4dSAndy Whitcroft if (!defined($stat_real) || 36534d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 36544d001e4dSAndy Whitcroft $check = 0; 36554d001e4dSAndy Whitcroft } 36564d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 36574d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 36584d001e4dSAndy Whitcroft } 36594d001e4dSAndy Whitcroft 36609bd49efeSAndy 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"; 36614d001e4dSAndy Whitcroft 36629f5af480SJoe Perches if ($check && $s ne '' && 36639f5af480SJoe Perches (($sindent % 8) != 0 || 36649f5af480SJoe Perches ($sindent < $indent) || 3665f6950a73SJoe Perches ($sindent == $indent && 3666f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 36679f5af480SJoe Perches ($sindent > $indent + 8))) { 3668000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3669000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 36704d001e4dSAndy Whitcroft } 36714d001e4dSAndy Whitcroft } 36724d001e4dSAndy Whitcroft 36736c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 36746c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 36751f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 36761f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 36776c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3678c2fdda0dSAndy Whitcroft if ($dbg_values) { 3679c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3680cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3681cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 36821f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3683c2fdda0dSAndy Whitcroft } 36846c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 36856c72ffaaSAndy Whitcroft 368600df344fSAndy Whitcroft#ignore lines not being added 36873705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 368800df344fSAndy Whitcroft 368911ca40a0SJoe Perches# check for dereferences that span multiple lines 369011ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 369111ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 369211ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 369311ca40a0SJoe Perches my $ref = $1; 369411ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 369511ca40a0SJoe Perches $ref .= $1; 369611ca40a0SJoe Perches $ref =~ s/\s//g; 369711ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 369811ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 369911ca40a0SJoe Perches } 370011ca40a0SJoe Perches 3701a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3702c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3703a1ce18e4SJoe Perches my $type = $1; 3704a1ce18e4SJoe Perches my $var = $2; 3705207a8e84SJoe Perches $var = "" if (!defined $var); 3706207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3707a1ce18e4SJoe Perches my $sign = $1; 3708a1ce18e4SJoe Perches my $pointer = $2; 3709a1ce18e4SJoe Perches 3710a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3711a1ce18e4SJoe Perches 3712a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3713a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3714a1ce18e4SJoe Perches $fix) { 3715a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3716207a8e84SJoe Perches my $comp_pointer = $pointer; 3717207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 3718207a8e84SJoe Perches $decl .= $comp_pointer; 3719207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 3720207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 3721a1ce18e4SJoe Perches } 3722a1ce18e4SJoe Perches } 3723a1ce18e4SJoe Perches } 3724a1ce18e4SJoe Perches 3725653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 37267429c690SAndy Whitcroft if ($dbg_type) { 37277429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3728000d1cc1SJoe Perches ERROR("TEST_TYPE", 3729000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 37307429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3731000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3732000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 37337429c690SAndy Whitcroft } 3734653d4876SAndy Whitcroft next; 3735653d4876SAndy Whitcroft } 3736a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3737a1ef277eSAndy Whitcroft if ($dbg_attr) { 37389360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3739000d1cc1SJoe Perches ERROR("TEST_ATTR", 3740000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 37419360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3742000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3743000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3744a1ef277eSAndy Whitcroft } 3745a1ef277eSAndy Whitcroft next; 3746a1ef277eSAndy Whitcroft } 3747653d4876SAndy Whitcroft 3748f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 374999423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 375099423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3751d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3752d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3753f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3754f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3755f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3756d752fcc8SJoe Perches my $fixedline = $prevrawline; 3757d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3758f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3759d752fcc8SJoe Perches $fixedline = $line; 37608d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 3761f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3762d752fcc8SJoe Perches } 3763f0a594c1SAndy Whitcroft } 3764f0a594c1SAndy Whitcroft 376500df344fSAndy Whitcroft# 376600df344fSAndy Whitcroft# Checks which are anchored on the added line. 376700df344fSAndy Whitcroft# 376800df344fSAndy Whitcroft 3769653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3770c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3771653d4876SAndy Whitcroft my $path = $1; 3772653d4876SAndy Whitcroft if ($path =~ m{//}) { 3773000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3774495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3775495e9d84SJoe Perches } 3776495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3777495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3778495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3779653d4876SAndy Whitcroft } 3780653d4876SAndy Whitcroft } 3781653d4876SAndy Whitcroft 378200df344fSAndy Whitcroft# no C99 // comments 378300df344fSAndy Whitcroft if ($line =~ m{//}) { 37843705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 37853705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 37863705ce5bSJoe Perches $fix) { 3787194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 37883705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 37893705ce5bSJoe Perches my $comment = trim($1); 3790194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 37913705ce5bSJoe Perches } 37923705ce5bSJoe Perches } 379300df344fSAndy Whitcroft } 379400df344fSAndy Whitcroft # Remove C99 comments. 37950a920b5bSAndy Whitcroft $line =~ s@//.*@@; 37966c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 37970a920b5bSAndy Whitcroft 37982b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 37992b474a1aSAndy Whitcroft# the whole statement. 38002b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 38012b474a1aSAndy Whitcroft if (defined $realline_next && 38022b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 38032b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 38042b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 38052b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 38063cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 38073cbf62dfSAndy Whitcroft # a prefix: 38083cbf62dfSAndy Whitcroft # XXX(foo); 38093cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3810653d4876SAndy Whitcroft my $name = $1; 381187a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 38123cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 38133cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 38143cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 38153cbf62dfSAndy Whitcroft 38163cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 38172b474a1aSAndy Whitcroft \n.}\s*$| 381848012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 381948012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 382048012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 38212b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 38222b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 382348012058SAndy Whitcroft )/x) { 38242b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 38252b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 38262b474a1aSAndy Whitcroft } else { 38272b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 38280a920b5bSAndy Whitcroft } 38290a920b5bSAndy Whitcroft } 38302b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 38312b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 38322b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 38332b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 38342b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 38352b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 38362b474a1aSAndy Whitcroft } 38372b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 38382b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3839000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3840000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 38412b474a1aSAndy Whitcroft } 38420a920b5bSAndy Whitcroft 38435150bda4SJoe Eloff# check for global initialisers. 38446d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 3845d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 38466d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 3847d5e616fcSJoe Perches $fix) { 38486d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 3849d5e616fcSJoe Perches } 3850f0a594c1SAndy Whitcroft } 38510a920b5bSAndy Whitcroft# check for static initialisers. 38526d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 3853d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 38546d32f7a3SJoe Perches "do not initialise statics to $1\n" . 3855d5e616fcSJoe Perches $herecurr) && 3856d5e616fcSJoe Perches $fix) { 38576d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 3858d5e616fcSJoe Perches } 38590a920b5bSAndy Whitcroft } 38600a920b5bSAndy Whitcroft 38611813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 38621813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 38631813087dSJoe Perches my $tmp = trim($1); 38641813087dSJoe Perches WARN("MISORDERED_TYPE", 38651813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 38661813087dSJoe Perches } 38671813087dSJoe Perches 3868809e082eSJoe Perches# check for unnecessary <signed> int declarations of short/long/long long 3869809e082eSJoe Perches while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) { 3870809e082eSJoe Perches my $type = trim($1); 3871809e082eSJoe Perches next if ($type !~ /\bint\b/); 3872809e082eSJoe Perches next if ($type !~ /\b(?:short|long\s+long|long)\b/); 3873809e082eSJoe Perches my $new_type = $type; 3874809e082eSJoe Perches $new_type =~ s/\b\s*int\s*\b/ /; 3875809e082eSJoe Perches $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /; 3876809e082eSJoe Perches $new_type =~ s/^const\s+//; 3877809e082eSJoe Perches $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/); 3878809e082eSJoe Perches $new_type = "const $new_type" if ($type =~ /^const\b/); 3879809e082eSJoe Perches $new_type =~ s/\s+/ /g; 3880809e082eSJoe Perches $new_type = trim($new_type); 3881809e082eSJoe Perches if (WARN("UNNECESSARY_INT", 3882809e082eSJoe Perches "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) && 3883809e082eSJoe Perches $fix) { 3884809e082eSJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/; 3885809e082eSJoe Perches } 3886809e082eSJoe Perches } 3887809e082eSJoe Perches 3888cb710ecaSJoe Perches# check for static const char * arrays. 3889cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3890000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3891000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3892cb710ecaSJoe Perches $herecurr); 3893cb710ecaSJoe Perches } 3894cb710ecaSJoe Perches 3895cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3896cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3897000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3898000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3899cb710ecaSJoe Perches $herecurr); 3900cb710ecaSJoe Perches } 3901cb710ecaSJoe Perches 3902ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3903ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3904ab7e23f3SJoe Perches my $found = $1; 3905ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3906ab7e23f3SJoe Perches WARN("CONST_CONST", 3907ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3908ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3909ab7e23f3SJoe Perches WARN("CONST_CONST", 3910ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3911ab7e23f3SJoe Perches } 3912ab7e23f3SJoe Perches } 3913ab7e23f3SJoe Perches 39149b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 39159b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 39169b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 39179b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 39189b0fa60dSJoe Perches $herecurr); 39199b0fa60dSJoe Perches } 39209b0fa60dSJoe Perches 3921b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3922b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3923b598b670SJoe Perches my $array = $1; 3924b598b670SJoe 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*\))@) { 3925b598b670SJoe Perches my $array_div = $1; 3926b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3927b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3928b598b670SJoe Perches $fix) { 3929b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3930b598b670SJoe Perches } 3931b598b670SJoe Perches } 3932b598b670SJoe Perches } 3933b598b670SJoe Perches 3934b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3935b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3936b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3937b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3938b36190c5SJoe Perches $fix) { 3939194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3940b36190c5SJoe Perches } 3941b36190c5SJoe Perches } 3942b36190c5SJoe Perches 3943653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3944653d4876SAndy Whitcroft# make sense. 3945653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 39468054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3947c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 39488ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 394946d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 3950000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3951000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 39520a920b5bSAndy Whitcroft } 39530a920b5bSAndy Whitcroft 39540a920b5bSAndy Whitcroft# * goes on variable not on type 395565863862SAndy Whitcroft # (char*[ const]) 3956bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3957bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 39583705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3959d8aaf121SAndy Whitcroft 396065863862SAndy Whitcroft # Should start with a space. 396165863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 396265863862SAndy Whitcroft # Should not end with a space. 396365863862SAndy Whitcroft $to =~ s/\s+$//; 396465863862SAndy Whitcroft # '*'s should not have spaces between. 3965f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 396665863862SAndy Whitcroft } 3967d8aaf121SAndy Whitcroft 39683705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 396965863862SAndy Whitcroft if ($from ne $to) { 39703705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 39713705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 39723705ce5bSJoe Perches $fix) { 39733705ce5bSJoe Perches my $sub_from = $ident; 39743705ce5bSJoe Perches my $sub_to = $ident; 39753705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3976194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39773705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 39783705ce5bSJoe Perches } 397965863862SAndy Whitcroft } 3980bfcb2cc7SAndy Whitcroft } 3981bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3982bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 39833705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3984d8aaf121SAndy Whitcroft 398565863862SAndy Whitcroft # Should start with a space. 398665863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 398765863862SAndy Whitcroft # Should not end with a space. 398865863862SAndy Whitcroft $to =~ s/\s+$//; 398965863862SAndy Whitcroft # '*'s should not have spaces between. 3990f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 399165863862SAndy Whitcroft } 399265863862SAndy Whitcroft # Modifiers should have spaces. 399365863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 399465863862SAndy Whitcroft 39953705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3996667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 39973705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 39983705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 39993705ce5bSJoe Perches $fix) { 40003705ce5bSJoe Perches 40013705ce5bSJoe Perches my $sub_from = $match; 40023705ce5bSJoe Perches my $sub_to = $match; 40033705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4004194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40053705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 40063705ce5bSJoe Perches } 400765863862SAndy Whitcroft } 40080a920b5bSAndy Whitcroft } 40090a920b5bSAndy Whitcroft 40109d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 40119d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 40120675a8fbSJean Delvare my $msg_level = \&WARN; 40130675a8fbSJean Delvare $msg_level = \&CHK if ($file); 40140675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 40159d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 40169d3e3c70SJoe Perches } 40170a920b5bSAndy Whitcroft 40189d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 40198905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 4020000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 4021000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 40228905a67cSAndy Whitcroft } 40238905a67cSAndy Whitcroft 402417441227SJoe Perches# check for uses of printk_ratelimit 402517441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 4026000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 4027000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 402817441227SJoe Perches } 402917441227SJoe Perches 4030eeef5733SJoe Perches# printk should use KERN_* levels 4031eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 4032000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 4033eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 403400df344fSAndy Whitcroft } 40350a920b5bSAndy Whitcroft 4036243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 4037243f3803SJoe Perches my $orig = $1; 4038243f3803SJoe Perches my $level = lc($orig); 4039243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 40408f26b837SJoe Perches my $level2 = $level; 40418f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 4042243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 4043daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 4044243f3803SJoe Perches } 4045243f3803SJoe Perches 4046243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 4047d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 4048d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 4049d5e616fcSJoe Perches $fix) { 4050194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4051d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 4052d5e616fcSJoe Perches } 4053243f3803SJoe Perches } 4054243f3803SJoe Perches 4055dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 4056dc139313SJoe Perches my $orig = $1; 4057dc139313SJoe Perches my $level = lc($orig); 4058dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 4059dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 4060dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 4061dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 4062dc139313SJoe Perches } 4063dc139313SJoe Perches 406491c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 406591c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 406691c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 406791c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 406891c9afafSAndy Lutomirski WARN("ENOSYS", 406991c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 407091c9afafSAndy Lutomirski } 407191c9afafSAndy Lutomirski 4072653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 4073653d4876SAndy Whitcroft# or if closed on same line 40745b57980dSJoe Perches if ($perl_version_ok && 40752d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 40762d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 40772d453e3bSJoe Perches $sline !~ /}/) { 40788d182478SJoe Perches if (ERROR("OPEN_BRACE", 40792d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 40808d182478SJoe Perches $fix) { 40818d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 40828d182478SJoe Perches my $fixed_line = $rawline; 40838d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 40848d182478SJoe Perches my $line1 = $1; 40858d182478SJoe Perches my $line2 = $2; 40868d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 40878d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 40888d182478SJoe Perches if ($line2 !~ /^\s*$/) { 40898d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 40908d182478SJoe Perches } 40918d182478SJoe Perches } 40920a920b5bSAndy Whitcroft } 4093653d4876SAndy Whitcroft 40948905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 40958905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 40968905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 40978d182478SJoe Perches if (ERROR("OPEN_BRACE", 40988d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 40998d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 41008d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 41018d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 41028d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 41038d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 41048d182478SJoe Perches $fixedline = $rawline; 41058d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 41068d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 41078d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 41088d182478SJoe Perches } 41098d182478SJoe Perches } 41108905a67cSAndy Whitcroft } 41118905a67cSAndy Whitcroft 41120c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 41133705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 41143705ce5bSJoe Perches if (WARN("SPACING", 41153705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 41163705ce5bSJoe Perches $fix) { 4117194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41183705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 41193705ce5bSJoe Perches } 41200c73b4ebSAndy Whitcroft } 41210c73b4ebSAndy Whitcroft 412231070b5dSJoe Perches# Function pointer declarations 412331070b5dSJoe Perches# check spacing between type, funcptr, and args 412431070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 412591f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 412631070b5dSJoe Perches my $declare = $1; 412731070b5dSJoe Perches my $pre_pointer_space = $2; 412831070b5dSJoe Perches my $post_pointer_space = $3; 412931070b5dSJoe Perches my $funcname = $4; 413031070b5dSJoe Perches my $post_funcname_space = $5; 413131070b5dSJoe Perches my $pre_args_space = $6; 413231070b5dSJoe Perches 413391f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 413491f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 413591f72e9cSJoe Perches# don't need a space so don't warn for those. 413691f72e9cSJoe Perches my $post_declare_space = ""; 413791f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 413891f72e9cSJoe Perches $post_declare_space = $1; 413991f72e9cSJoe Perches $declare = rtrim($declare); 414091f72e9cSJoe Perches } 414191f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 414231070b5dSJoe Perches WARN("SPACING", 414331070b5dSJoe Perches "missing space after return type\n" . $herecurr); 414491f72e9cSJoe Perches $post_declare_space = " "; 414531070b5dSJoe Perches } 414631070b5dSJoe Perches 414731070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 414891f72e9cSJoe Perches# This test is not currently implemented because these declarations are 414991f72e9cSJoe Perches# equivalent to 415091f72e9cSJoe Perches# int foo(int bar, ...) 415191f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 415291f72e9cSJoe Perches# 415391f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 415491f72e9cSJoe Perches# WARN("SPACING", 415591f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 415691f72e9cSJoe Perches# } 415731070b5dSJoe Perches 415831070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 415931070b5dSJoe Perches if (defined $pre_pointer_space && 416031070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 416131070b5dSJoe Perches WARN("SPACING", 416231070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 416331070b5dSJoe Perches } 416431070b5dSJoe Perches 416531070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 416631070b5dSJoe Perches if (defined $post_pointer_space && 416731070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 416831070b5dSJoe Perches WARN("SPACING", 416931070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 417031070b5dSJoe Perches } 417131070b5dSJoe Perches 417231070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 417331070b5dSJoe Perches if (defined $post_funcname_space && 417431070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 417531070b5dSJoe Perches WARN("SPACING", 417631070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 417731070b5dSJoe Perches } 417831070b5dSJoe Perches 417931070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 418031070b5dSJoe Perches if (defined $pre_args_space && 418131070b5dSJoe Perches $pre_args_space =~ /^\s/) { 418231070b5dSJoe Perches WARN("SPACING", 418331070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 418431070b5dSJoe Perches } 418531070b5dSJoe Perches 418631070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4187194f66fcSJoe Perches $fixed[$fixlinenr] =~ 418891f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 418931070b5dSJoe Perches } 419031070b5dSJoe Perches } 419131070b5dSJoe Perches 41928d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 41938d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4194fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4195fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 41968d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 41978d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 41988d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4199fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 420038dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 42013705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 42023705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 42033705ce5bSJoe Perches $fix) { 4204194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42053705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 42063705ce5bSJoe Perches } 42078d31cfceSAndy Whitcroft } 42088d31cfceSAndy Whitcroft } 42098d31cfceSAndy Whitcroft 4210f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 42116c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4212c2fdda0dSAndy Whitcroft my $name = $1; 4213773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4214773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4215c2fdda0dSAndy Whitcroft 4216c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4217773647a0SAndy Whitcroft if ($name =~ /^(?: 4218773647a0SAndy Whitcroft if|for|while|switch|return|case| 4219773647a0SAndy Whitcroft volatile|__volatile__| 4220773647a0SAndy Whitcroft __attribute__|format|__extension__| 4221773647a0SAndy Whitcroft asm|__asm__)$/x) 4222773647a0SAndy Whitcroft { 4223c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4224c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4225c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4226c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4227773647a0SAndy Whitcroft 4228773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4229c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4230c2fdda0dSAndy Whitcroft 4231c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4232c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4233773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4234c2fdda0dSAndy Whitcroft 4235c2fdda0dSAndy Whitcroft } else { 42363705ce5bSJoe Perches if (WARN("SPACING", 42373705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 42383705ce5bSJoe Perches $fix) { 4239194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42403705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 42413705ce5bSJoe Perches } 4242f0a594c1SAndy Whitcroft } 42436c72ffaaSAndy Whitcroft } 42449a4cad4eSEric Nelson 4245653d4876SAndy Whitcroft# Check operator spacing. 42460a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 42473705ce5bSJoe Perches my $fixed_line = ""; 42483705ce5bSJoe Perches my $line_fixed = 0; 42493705ce5bSJoe Perches 42509c0ca6f9SAndy Whitcroft my $ops = qr{ 42519c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 42529c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 42539c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 42541f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 425584731623SJoe Perches \?:|\?|: 42569c0ca6f9SAndy Whitcroft }x; 4257cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 42583705ce5bSJoe Perches 42593705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 42603705ce5bSJoe Perches## foreach my $el (@elements) { 42613705ce5bSJoe Perches## print("el: <$el>\n"); 42623705ce5bSJoe Perches## } 42633705ce5bSJoe Perches 42643705ce5bSJoe Perches my @fix_elements = (); 426500df344fSAndy Whitcroft my $off = 0; 42666c72ffaaSAndy Whitcroft 42673705ce5bSJoe Perches foreach my $el (@elements) { 42683705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 42693705ce5bSJoe Perches $off += length($el); 42703705ce5bSJoe Perches } 42713705ce5bSJoe Perches 42723705ce5bSJoe Perches $off = 0; 42733705ce5bSJoe Perches 42746c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4275b34c648bSJoe Perches my $last_after = -1; 42766c72ffaaSAndy Whitcroft 42770a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 42783705ce5bSJoe Perches 42793705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 42803705ce5bSJoe Perches 42813705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 42823705ce5bSJoe Perches 42834a0df2efSAndy Whitcroft $off += length($elements[$n]); 42844a0df2efSAndy Whitcroft 428525985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4286773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4287773647a0SAndy Whitcroft my $cc = ''; 4288773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4289773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4290773647a0SAndy Whitcroft } 4291773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4292773647a0SAndy Whitcroft 42934a0df2efSAndy Whitcroft my $a = ''; 42944a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 42954a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4296cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 42974a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 42984a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 4299773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 43004a0df2efSAndy Whitcroft 43010a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 43024a0df2efSAndy Whitcroft 43034a0df2efSAndy Whitcroft my $c = ''; 43040a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 43054a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 43064a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4307cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 43084a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 43094a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 43108b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 43114a0df2efSAndy Whitcroft } else { 43124a0df2efSAndy Whitcroft $c = 'E'; 43130a920b5bSAndy Whitcroft } 43140a920b5bSAndy Whitcroft 43154a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 43164a0df2efSAndy Whitcroft 43174a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 43184a0df2efSAndy Whitcroft 43196c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 4320de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 43210a920b5bSAndy Whitcroft 432274048ed8SAndy Whitcroft # Pull out the value of this operator. 43236c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 43240a920b5bSAndy Whitcroft 43251f65f947SAndy Whitcroft # Get the full operator variant. 43261f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 43271f65f947SAndy Whitcroft 432813214adfSAndy Whitcroft # Ignore operators passed as parameters. 432913214adfSAndy Whitcroft if ($op_type ne 'V' && 4330d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 433113214adfSAndy Whitcroft 4332cf655043SAndy Whitcroft# # Ignore comments 4333cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 433413214adfSAndy Whitcroft 4335d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 433613214adfSAndy Whitcroft } elsif ($op eq ';') { 4337cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 4338cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 43393705ce5bSJoe Perches if (ERROR("SPACING", 43403705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 4341b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 43423705ce5bSJoe Perches $line_fixed = 1; 43433705ce5bSJoe Perches } 4344d8aaf121SAndy Whitcroft } 4345d8aaf121SAndy Whitcroft 4346d8aaf121SAndy Whitcroft # // is a comment 4347d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 43480a920b5bSAndy Whitcroft 4349b00e4814SJoe Perches # : when part of a bitfield 4350b00e4814SJoe Perches } elsif ($opv eq ':B') { 4351b00e4814SJoe Perches # skip the bitfield test for now 4352b00e4814SJoe Perches 43531f65f947SAndy Whitcroft # No spaces for: 43541f65f947SAndy Whitcroft # -> 4355b00e4814SJoe Perches } elsif ($op eq '->') { 43564a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 43573705ce5bSJoe Perches if (ERROR("SPACING", 43583705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4359b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43603705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 43613705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 43623705ce5bSJoe Perches } 4363b34c648bSJoe Perches $line_fixed = 1; 43643705ce5bSJoe Perches } 43650a920b5bSAndy Whitcroft } 43660a920b5bSAndy Whitcroft 43672381097bSJoe Perches # , must not have a space before and must have a space on the right. 43680a920b5bSAndy Whitcroft } elsif ($op eq ',') { 43692381097bSJoe Perches my $rtrim_before = 0; 43702381097bSJoe Perches my $space_after = 0; 43712381097bSJoe Perches if ($ctx =~ /Wx./) { 43722381097bSJoe Perches if (ERROR("SPACING", 43732381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 43742381097bSJoe Perches $line_fixed = 1; 43752381097bSJoe Perches $rtrim_before = 1; 43762381097bSJoe Perches } 43772381097bSJoe Perches } 4378cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 43793705ce5bSJoe Perches if (ERROR("SPACING", 43803705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 43813705ce5bSJoe Perches $line_fixed = 1; 4382b34c648bSJoe Perches $last_after = $n; 43832381097bSJoe Perches $space_after = 1; 43842381097bSJoe Perches } 43852381097bSJoe Perches } 43862381097bSJoe Perches if ($rtrim_before || $space_after) { 43872381097bSJoe Perches if ($rtrim_before) { 43882381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43892381097bSJoe Perches } else { 43902381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 43912381097bSJoe Perches } 43922381097bSJoe Perches if ($space_after) { 43932381097bSJoe Perches $good .= " "; 43943705ce5bSJoe Perches } 43950a920b5bSAndy Whitcroft } 43960a920b5bSAndy Whitcroft 43979c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 439874048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 43999c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 44009c0ca6f9SAndy Whitcroft 44019c0ca6f9SAndy Whitcroft # unary operators should have a space before and 44029c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 44039c0ca6f9SAndy Whitcroft # unary operator, or a cast 44049c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 440574048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 44060d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4407cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 44083705ce5bSJoe Perches if (ERROR("SPACING", 44093705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4410b34c648bSJoe Perches if ($n != $last_after + 2) { 4411b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 44123705ce5bSJoe Perches $line_fixed = 1; 44133705ce5bSJoe Perches } 44140a920b5bSAndy Whitcroft } 4415b34c648bSJoe Perches } 4416a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4417171ae1a4SAndy Whitcroft # A unary '*' may be const 4418171ae1a4SAndy Whitcroft 4419171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 44203705ce5bSJoe Perches if (ERROR("SPACING", 44213705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4422b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 44233705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 44243705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 44253705ce5bSJoe Perches } 4426b34c648bSJoe Perches $line_fixed = 1; 44273705ce5bSJoe Perches } 44280a920b5bSAndy Whitcroft } 44290a920b5bSAndy Whitcroft 44300a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 44310a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4432773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 44333705ce5bSJoe Perches if (ERROR("SPACING", 44343705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4435b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 44363705ce5bSJoe Perches $line_fixed = 1; 44373705ce5bSJoe Perches } 44380a920b5bSAndy Whitcroft } 4439773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4440773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 44413705ce5bSJoe Perches if (ERROR("SPACING", 44423705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4443b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 44443705ce5bSJoe Perches $line_fixed = 1; 44453705ce5bSJoe Perches } 4446653d4876SAndy Whitcroft } 4447773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 44483705ce5bSJoe Perches if (ERROR("SPACING", 44493705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4450b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 44513705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 44523705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4453773647a0SAndy Whitcroft } 4454b34c648bSJoe Perches $line_fixed = 1; 44553705ce5bSJoe Perches } 44563705ce5bSJoe Perches } 44570a920b5bSAndy Whitcroft 44580a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 44599c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 44609c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 44619c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4462c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4463c2fdda0dSAndy Whitcroft $op eq '%') 44640a920b5bSAndy Whitcroft { 4465d2e025f3SJoe Perches if ($check) { 4466d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4467d2e025f3SJoe Perches if (CHK("SPACING", 4468d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4469d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4470d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4471d2e025f3SJoe Perches $line_fixed = 1; 4472d2e025f3SJoe Perches } 4473d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4474d2e025f3SJoe Perches if (CHK("SPACING", 4475d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4476d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4477d2e025f3SJoe Perches $line_fixed = 1; 4478d2e025f3SJoe Perches } 4479d2e025f3SJoe Perches } 4480d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 44813705ce5bSJoe Perches if (ERROR("SPACING", 44823705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4483b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4484b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4485b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4486b34c648bSJoe Perches } 44873705ce5bSJoe Perches $line_fixed = 1; 44883705ce5bSJoe Perches } 44890a920b5bSAndy Whitcroft } 44900a920b5bSAndy Whitcroft 44911f65f947SAndy Whitcroft # A colon needs no spaces before when it is 44921f65f947SAndy Whitcroft # terminating a case value or a label. 44931f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 44941f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 44953705ce5bSJoe Perches if (ERROR("SPACING", 44963705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4497b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 44983705ce5bSJoe Perches $line_fixed = 1; 44993705ce5bSJoe Perches } 45001f65f947SAndy Whitcroft } 45011f65f947SAndy Whitcroft 45020a920b5bSAndy Whitcroft # All the others need spaces both sides. 4503cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 45041f65f947SAndy Whitcroft my $ok = 0; 45051f65f947SAndy Whitcroft 450622f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 45071f65f947SAndy Whitcroft if (($op eq '<' && 45081f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 45091f65f947SAndy Whitcroft ($op eq '>' && 45101f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 45111f65f947SAndy Whitcroft { 45121f65f947SAndy Whitcroft $ok = 1; 45131f65f947SAndy Whitcroft } 45141f65f947SAndy Whitcroft 4515e0df7e1fSJoe Perches # for asm volatile statements 4516e0df7e1fSJoe Perches # ignore a colon with another 4517e0df7e1fSJoe Perches # colon immediately before or after 4518e0df7e1fSJoe Perches if (($op eq ':') && 4519e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4520e0df7e1fSJoe Perches $ok = 1; 4521e0df7e1fSJoe Perches } 4522e0df7e1fSJoe Perches 452384731623SJoe Perches # messages are ERROR, but ?: are CHK 45241f65f947SAndy Whitcroft if ($ok == 0) { 45250675a8fbSJean Delvare my $msg_level = \&ERROR; 45260675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 452784731623SJoe Perches 45280675a8fbSJean Delvare if (&{$msg_level}("SPACING", 45293705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4530b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4531b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4532b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4533b34c648bSJoe Perches } 45343705ce5bSJoe Perches $line_fixed = 1; 45353705ce5bSJoe Perches } 45360a920b5bSAndy Whitcroft } 453722f2a2efSAndy Whitcroft } 45384a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 45393705ce5bSJoe Perches 45403705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 45413705ce5bSJoe Perches 45423705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 45430a920b5bSAndy Whitcroft } 45443705ce5bSJoe Perches 45453705ce5bSJoe Perches if (($#elements % 2) == 0) { 45463705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 45473705ce5bSJoe Perches } 45483705ce5bSJoe Perches 4549194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4550194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 45513705ce5bSJoe Perches } 45523705ce5bSJoe Perches 45533705ce5bSJoe Perches 45540a920b5bSAndy Whitcroft } 45550a920b5bSAndy Whitcroft 4556786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4557d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4558786b6326SJoe Perches if (WARN("SPACING", 4559786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4560786b6326SJoe Perches $fix) { 4561194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4562786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4563786b6326SJoe Perches } 4564786b6326SJoe Perches } 4565786b6326SJoe Perches 4566f0a594c1SAndy Whitcroft# check for multiple assignments 4567f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4568000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4569000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4570f0a594c1SAndy Whitcroft } 4571f0a594c1SAndy Whitcroft 457222f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 457322f2a2efSAndy Whitcroft## # continuation. 457422f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 457522f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 457622f2a2efSAndy Whitcroft## 457722f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 457822f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 457922f2a2efSAndy Whitcroft## my $ln = $line; 458022f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 458122f2a2efSAndy Whitcroft## } 458222f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4583000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4584000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 458522f2a2efSAndy Whitcroft## } 458622f2a2efSAndy Whitcroft## } 4587f0a594c1SAndy Whitcroft 45880a920b5bSAndy Whitcroft#need space before brace following if, while, etc 45896b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 45906ad724e2SMichal Zylowski $line =~ /\b(?:else|do)\{/) { 45913705ce5bSJoe Perches if (ERROR("SPACING", 45923705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 45933705ce5bSJoe Perches $fix) { 45946ad724e2SMichal Zylowski $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/; 45953705ce5bSJoe Perches } 4596de7d4f0eSAndy Whitcroft } 4597de7d4f0eSAndy Whitcroft 4598c4a62ef9SJoe Perches## # check for blank lines before declarations 4599c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4600c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4601c4a62ef9SJoe Perches## WARN("SPACING", 4602c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4603c4a62ef9SJoe Perches## } 4604c4a62ef9SJoe Perches## 4605c4a62ef9SJoe Perches 4606de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4607de7d4f0eSAndy Whitcroft# on the line 4608de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4609d5e616fcSJoe Perches if (ERROR("SPACING", 4610d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4611d5e616fcSJoe Perches $fix) { 4612194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4613d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4614d5e616fcSJoe Perches } 46150a920b5bSAndy Whitcroft } 46160a920b5bSAndy Whitcroft 461722f2a2efSAndy Whitcroft# check spacing on square brackets 461822f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 46193705ce5bSJoe Perches if (ERROR("SPACING", 46203705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 46213705ce5bSJoe Perches $fix) { 4622194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46233705ce5bSJoe Perches s/\[\s+/\[/; 46243705ce5bSJoe Perches } 462522f2a2efSAndy Whitcroft } 462622f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 46273705ce5bSJoe Perches if (ERROR("SPACING", 46283705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 46293705ce5bSJoe Perches $fix) { 4630194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46313705ce5bSJoe Perches s/\s+\]/\]/; 46323705ce5bSJoe Perches } 463322f2a2efSAndy Whitcroft } 463422f2a2efSAndy Whitcroft 4635c45dcabdSAndy Whitcroft# check spacing on parentheses 46369c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 46379c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 46383705ce5bSJoe Perches if (ERROR("SPACING", 46393705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 46403705ce5bSJoe Perches $fix) { 4641194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46423705ce5bSJoe Perches s/\(\s+/\(/; 46433705ce5bSJoe Perches } 464422f2a2efSAndy Whitcroft } 464513214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4646c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4647c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 46483705ce5bSJoe Perches if (ERROR("SPACING", 46493705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 46503705ce5bSJoe Perches $fix) { 4651194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46523705ce5bSJoe Perches s/\s+\)/\)/; 46533705ce5bSJoe Perches } 465422f2a2efSAndy Whitcroft } 465522f2a2efSAndy Whitcroft 4656e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4657e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4658e2826fd0SJoe Perches 4659e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4660ea4acbb1SJoe Perches my $var = $1; 4661ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4662ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4663ea4acbb1SJoe Perches $fix) { 4664ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4665ea4acbb1SJoe Perches } 4666ea4acbb1SJoe Perches } 4667ea4acbb1SJoe Perches 4668ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4669ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4670ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4671ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4672ea4acbb1SJoe Perches my $var = $2; 4673ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4674ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4675ea4acbb1SJoe Perches $fix) { 4676ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4677ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4678ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4679ea4acbb1SJoe Perches } 4680e2826fd0SJoe Perches } 4681e2826fd0SJoe Perches 468263b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 4683a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 4684a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 46855b57980dSJoe Perches $perl_version_ok && defined($stat) && 468663b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 468763b7c73eSJoe Perches my $if_stat = $1; 468863b7c73eSJoe Perches my $test = substr($2, 1, -1); 468963b7c73eSJoe Perches my $herectx; 469063b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 469163b7c73eSJoe Perches my $match = $1; 469263b7c73eSJoe Perches # avoid parentheses around potential macro args 469363b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 469463b7c73eSJoe Perches if (!defined($herectx)) { 469563b7c73eSJoe Perches $herectx = $here . "\n"; 469663b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 469763b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 469863b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 469963b7c73eSJoe Perches $herectx .= $rl . "\n"; 470063b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 470163b7c73eSJoe Perches } 470263b7c73eSJoe Perches } 470363b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 470463b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 470563b7c73eSJoe Perches } 470663b7c73eSJoe Perches } 470763b7c73eSJoe Perches 47080a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 47094a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 47100a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 47113705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 47123705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 47133705ce5bSJoe Perches $fix) { 4714194f66fcSJoe Perches $fixed[$fixlinenr] =~ 47153705ce5bSJoe Perches s/^(.)\s+/$1/; 47163705ce5bSJoe Perches } 47170a920b5bSAndy Whitcroft } 47180a920b5bSAndy Whitcroft 47195b9553abSJoe Perches# return is not a function 4720507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4721c45dcabdSAndy Whitcroft my $spacing = $1; 47225b57980dSJoe Perches if ($perl_version_ok && 47235b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 47245b9553abSJoe Perches my $value = $1; 47255b9553abSJoe Perches $value = deparenthesize($value); 47265b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4727000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4728000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 47295b9553abSJoe Perches } 4730c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4731000d1cc1SJoe Perches ERROR("SPACING", 4732000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4733c45dcabdSAndy Whitcroft } 4734c45dcabdSAndy Whitcroft } 4735507e5141SJoe Perches 4736b43ae21bSJoe Perches# unnecessary return in a void function 4737b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4738b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4739b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4740b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4741b43ae21bSJoe Perches $linenr >= 3 && 4742b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4743b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 47449819cf25SJoe Perches WARN("RETURN_VOID", 4745b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 47469819cf25SJoe Perches } 47479819cf25SJoe Perches 4748189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 47495b57980dSJoe Perches if ($perl_version_ok && 4750189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4751189248d8SJoe Perches my $openparens = $1; 4752189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4753189248d8SJoe Perches my $msg = ""; 4754189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4755189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4756189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4757189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4758189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4759189248d8SJoe Perches } 4760189248d8SJoe Perches } 4761189248d8SJoe Perches 4762c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4763c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4764c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4765c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 47665b57980dSJoe Perches if ($perl_version_ok && 4767c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4768c5595fa2SJoe Perches my $lead = $1; 4769c5595fa2SJoe Perches my $const = $2; 4770c5595fa2SJoe Perches my $comp = $3; 4771c5595fa2SJoe Perches my $to = $4; 4772c5595fa2SJoe Perches my $newcomp = $comp; 4773f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 4774c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4775c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4776c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4777c5595fa2SJoe Perches $fix) { 4778c5595fa2SJoe Perches if ($comp eq "<") { 4779c5595fa2SJoe Perches $newcomp = ">"; 4780c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4781c5595fa2SJoe Perches $newcomp = ">="; 4782c5595fa2SJoe Perches } elsif ($comp eq ">") { 4783c5595fa2SJoe Perches $newcomp = "<"; 4784c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4785c5595fa2SJoe Perches $newcomp = "<="; 4786c5595fa2SJoe Perches } 4787c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4788c5595fa2SJoe Perches } 4789c5595fa2SJoe Perches } 4790c5595fa2SJoe Perches 4791f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4792f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 479353a3c448SAndy Whitcroft my $name = $1; 479453a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4795000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4796f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 479753a3c448SAndy Whitcroft } 479853a3c448SAndy Whitcroft } 4799c45dcabdSAndy Whitcroft 48000a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 48014a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 48023705ce5bSJoe Perches if (ERROR("SPACING", 48033705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 48043705ce5bSJoe Perches $fix) { 4805194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48063705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 48073705ce5bSJoe Perches } 48080a920b5bSAndy Whitcroft } 48090a920b5bSAndy Whitcroft 4810f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4811f5fe35ddSAndy Whitcroft# statements after the conditional. 4812170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 48133e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 48143e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 48153e469cdcSAndy Whitcroft if (!defined $stat); 4816170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4817170d3a22SAndy Whitcroft $remain_next, $off_next); 4818170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4819170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4820170d3a22SAndy Whitcroft 4821170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4822170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4823170d3a22SAndy Whitcroft # then count those as offsets. 4824170d3a22SAndy Whitcroft my ($whitespace) = 4825170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4826170d3a22SAndy Whitcroft my $offset = 4827170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4828170d3a22SAndy Whitcroft 4829170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4830170d3a22SAndy Whitcroft $offset} = 1; 4831170d3a22SAndy Whitcroft } 4832170d3a22SAndy Whitcroft } 4833170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4834c11230f4SJoe Perches defined($stat) && defined($cond) && 4835170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4836171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 48378905a67cSAndy Whitcroft 4838b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4839000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4840000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 48418905a67cSAndy Whitcroft } 48428905a67cSAndy Whitcroft 48438905a67cSAndy Whitcroft # Find out what is on the end of the line after the 48448905a67cSAndy Whitcroft # conditional. 4845773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 48468905a67cSAndy Whitcroft $s =~ s/\n.*//g; 484713214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 484853210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 484953210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4850773647a0SAndy Whitcroft { 4851bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4852bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4853bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 485442bdf74cSHidetoshi Seto my $stat_real = ''; 4855bb44ad39SAndy Whitcroft 485642bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 485742bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4858bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4859bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4860bb44ad39SAndy Whitcroft } 4861bb44ad39SAndy Whitcroft 4862000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4863000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 48648905a67cSAndy Whitcroft } 48658905a67cSAndy Whitcroft } 48668905a67cSAndy Whitcroft 486713214adfSAndy Whitcroft# Check for bitwise tests written as boolean 486813214adfSAndy Whitcroft if ($line =~ / 486913214adfSAndy Whitcroft (?: 487013214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 487113214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 487213214adfSAndy Whitcroft (?:\&\&|\|\|) 487313214adfSAndy Whitcroft | 487413214adfSAndy Whitcroft (?:\&\&|\|\|) 487513214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 487613214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 487713214adfSAndy Whitcroft )/x) 487813214adfSAndy Whitcroft { 4879000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4880000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 488113214adfSAndy Whitcroft } 488213214adfSAndy Whitcroft 48838905a67cSAndy Whitcroft# if and else should not have general statements after it 488413214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 488513214adfSAndy Whitcroft my $s = $1; 488613214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 488713214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4888000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4889000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 48900a920b5bSAndy Whitcroft } 489113214adfSAndy Whitcroft } 489239667782SAndy Whitcroft# if should not continue a brace 489339667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4894000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4895048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 489639667782SAndy Whitcroft $herecurr); 489739667782SAndy Whitcroft } 4898a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4899a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4900a1080bf8SAndy Whitcroft $line !~ /\G(?: 49013fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4902a1080bf8SAndy Whitcroft \s*return\s+ 4903a1080bf8SAndy Whitcroft )/xg) 4904a1080bf8SAndy Whitcroft { 4905000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4906000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4907a1080bf8SAndy Whitcroft } 49080a920b5bSAndy Whitcroft 49090a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 49100a920b5bSAndy Whitcroft # indent level to be relevant to each other. 49118b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 49120a920b5bSAndy Whitcroft $previndent == $indent) { 49138b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 49148b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 49158b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 49168b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 49178b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 49188b8856f4SJoe Perches my $fixedline = $prevrawline; 49198b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 49208b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 49218b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 49228b8856f4SJoe Perches } 49238b8856f4SJoe Perches $fixedline = $rawline; 49248b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 49258b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 49268b8856f4SJoe Perches } 49270a920b5bSAndy Whitcroft } 49280a920b5bSAndy Whitcroft 49298b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4930c2fdda0dSAndy Whitcroft $previndent == $indent) { 4931c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4932c2fdda0dSAndy Whitcroft 4933c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4934c2fdda0dSAndy Whitcroft # conditional. 4935773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4936c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4937c2fdda0dSAndy Whitcroft 4938c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 49398b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 49408b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 49418b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 49428b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 49438b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 49448b8856f4SJoe Perches my $fixedline = $prevrawline; 49458b8856f4SJoe Perches my $trailing = $rawline; 49468b8856f4SJoe Perches $trailing =~ s/^\+//; 49478b8856f4SJoe Perches $trailing = trim($trailing); 49488b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 49498b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 49508b8856f4SJoe Perches } 4951c2fdda0dSAndy Whitcroft } 4952c2fdda0dSAndy Whitcroft } 4953c2fdda0dSAndy Whitcroft 495495e2c602SJoe Perches#Specific variable tests 4955323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4956323c1260SJoe Perches my $var = $1; 495795e2c602SJoe Perches 495895e2c602SJoe Perches#CamelCase 4959807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4960be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 496122735ce8SJoe Perches#Ignore Page<foo> variants 4962807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 496322735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4964f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4965f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4966f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 49677e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 49687e781f67SJoe Perches my $word = $1; 49697e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4970d8b07710SJoe Perches if ($check) { 4971d8b07710SJoe Perches seed_camelcase_includes(); 4972d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4973d8b07710SJoe Perches seed_camelcase_file($realfile); 4974d8b07710SJoe Perches $camelcase_file_seeded = 1; 4975d8b07710SJoe Perches } 4976d8b07710SJoe Perches } 49777e781f67SJoe Perches if (!defined $camelcase{$word}) { 49787e781f67SJoe Perches $camelcase{$word} = 1; 4979be79794bSJoe Perches CHK("CAMELCASE", 49807e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 49817e781f67SJoe Perches } 4982323c1260SJoe Perches } 4983323c1260SJoe Perches } 49843445686aSJoe Perches } 49850a920b5bSAndy Whitcroft 49860a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4987d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4988d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4989d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4990d5e616fcSJoe Perches $fix) { 4991194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4992d5e616fcSJoe Perches } 49930a920b5bSAndy Whitcroft } 49940a920b5bSAndy Whitcroft 49950e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 49960e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4997c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4998e09dec48SAndy Whitcroft my $file = "$1.h"; 4999e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 5000e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 5001e09dec48SAndy Whitcroft $realfile ne $checkfile && 50027840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 5003c45dcabdSAndy Whitcroft { 50040e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 50050e212e0aSFabian Frederick if ($asminclude > 0) { 5006e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 5007000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 5008000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5009e09dec48SAndy Whitcroft } else { 5010000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 5011000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5012e09dec48SAndy Whitcroft } 50130a920b5bSAndy Whitcroft } 50140a920b5bSAndy Whitcroft } 50150e212e0aSFabian Frederick } 50160a920b5bSAndy Whitcroft 5017653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 5018653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 5019cf655043SAndy Whitcroft# in a known good container 5020b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 5021b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 5022d8aaf121SAndy Whitcroft my $ln = $linenr; 5023d8aaf121SAndy Whitcroft my $cnt = $realcnt; 5024c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 5025c45dcabdSAndy Whitcroft my $ctx = ''; 502608a2843eSJoe Perches my $has_flow_statement = 0; 502708a2843eSJoe Perches my $has_arg_concat = 0; 5028c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 5029f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 5030f74bd194SAndy Whitcroft $ctx = $dstat; 5031c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 5032a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 5033c45dcabdSAndy Whitcroft 503408a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 503562e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 503608a2843eSJoe Perches 5037f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 5038f59b64bfSJoe Perches my $define_args = $1; 5039f59b64bfSJoe Perches my $define_stmt = $dstat; 5040f59b64bfSJoe Perches my @def_args = (); 5041f59b64bfSJoe Perches 5042f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 5043f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 5044f59b64bfSJoe Perches $define_args =~ s/\s*//g; 50458c8c45cfSJoe Perches $define_args =~ s/\\\+?//g; 5046f59b64bfSJoe Perches @def_args = split(",", $define_args); 5047f59b64bfSJoe Perches } 5048f59b64bfSJoe Perches 5049292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 5050c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 5051c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 5052c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 5053c45dcabdSAndy Whitcroft 5054c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 5055bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 5056bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 50576b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 5058bf30d6edSAndy Whitcroft { 5059c45dcabdSAndy Whitcroft } 5060c45dcabdSAndy Whitcroft 5061e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 506233acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 506333acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 5064e45bab8eSAndy Whitcroft { 5065e45bab8eSAndy Whitcroft } 5066e45bab8eSAndy Whitcroft 506742e15293SJoe Perches # Make asm volatile uses seem like a generic function 506842e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 506942e15293SJoe Perches 5070c45dcabdSAndy Whitcroft my $exceptions = qr{ 5071c45dcabdSAndy Whitcroft $Declare| 5072c45dcabdSAndy Whitcroft module_param_named| 5073a0a0a7a9SKees Cook MODULE_PARM_DESC| 5074c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 5075c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 5076383099fdSAndy Whitcroft __typeof__\(| 507722fd2d3eSStefani Seibold union| 507822fd2d3eSStefani Seibold struct| 5079ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 50806b10df42SVladimir Zapolskiy ^\"|\"$| 50816b10df42SVladimir Zapolskiy ^\[ 5082c45dcabdSAndy Whitcroft }x; 50835eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 5084f59b64bfSJoe Perches 5085f59b64bfSJoe Perches $ctx =~ s/\n*$//; 5086f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 5087e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 5088f59b64bfSJoe Perches 5089f74bd194SAndy Whitcroft if ($dstat ne '' && 5090f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 5091f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 50923cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 5093356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5094f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 5095f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5096e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 509772f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 5098f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5099f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5100f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 51014e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5102f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5103c45dcabdSAndy Whitcroft { 5104e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5105e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5106e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5107e795556aSJoe Perches } elsif ($dstat =~ /;/) { 5108f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5109f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5110f74bd194SAndy Whitcroft } else { 5111000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 5112388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5113d8aaf121SAndy Whitcroft } 5114f59b64bfSJoe Perches 5115f59b64bfSJoe Perches } 51165207649bSJoe Perches 51175207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 51185207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 51195207649bSJoe Perches my $first = 1; 51205207649bSJoe Perches $define_stmt = ""; 51215207649bSJoe Perches foreach my $l (@stmt_array) { 51225207649bSJoe Perches $l =~ s/\\$//; 51235207649bSJoe Perches if ($first) { 51245207649bSJoe Perches $define_stmt = $l; 51255207649bSJoe Perches $first = 0; 51265207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 51275207649bSJoe Perches $define_stmt .= substr($l, 1); 51285207649bSJoe Perches } 51295207649bSJoe Perches } 51305207649bSJoe Perches $define_stmt =~ s/$;//g; 51315207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 51325207649bSJoe Perches $define_stmt = trim($define_stmt); 51335207649bSJoe Perches 5134f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5135f59b64bfSJoe Perches foreach my $arg (@def_args) { 5136f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 51379192d41aSJoe Perches next if ($arg =~ /^type$/i); 51387fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 51397fe528a2SJoe Perches $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 51407fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 51417fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 5142d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 5143f59b64bfSJoe Perches if ($use_cnt > 1) { 5144f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5145f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5146f59b64bfSJoe Perches } 51479192d41aSJoe Perches# check if any macro arguments may have other precedence issues 51487fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 51499192d41aSJoe Perches ((defined($1) && $1 ne ',') || 51509192d41aSJoe Perches (defined($2) && $2 ne ','))) { 51519192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 51529192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 51539192d41aSJoe Perches } 51540a920b5bSAndy Whitcroft } 51555023d347SJoe Perches 515608a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 515708a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 515808a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 515908a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 5160e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 516108a2843eSJoe Perches 516208a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 516308a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 516408a2843eSJoe Perches } 516508a2843eSJoe Perches 5166481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 51675023d347SJoe Perches 51685023d347SJoe Perches } else { 51695023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5170481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5171481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 51725023d347SJoe Perches $line =~ /^\+.*\\$/) { 51735023d347SJoe Perches WARN("LINE_CONTINUATIONS", 51745023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 51755023d347SJoe Perches } 5176653d4876SAndy Whitcroft } 51770a920b5bSAndy Whitcroft 5178b13edf7fSJoe Perches# do {} while (0) macro tests: 5179b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5180b13edf7fSJoe Perches# macro should not end with a semicolon 51815b57980dSJoe Perches if ($perl_version_ok && 5182b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5183b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5184b13edf7fSJoe Perches my $ln = $linenr; 5185b13edf7fSJoe Perches my $cnt = $realcnt; 5186b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5187b13edf7fSJoe Perches my $ctx = ''; 5188b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5189b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5190b13edf7fSJoe Perches $ctx = $dstat; 5191b13edf7fSJoe Perches 5192b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 51931b36b201SJoe Perches $dstat =~ s/$;/ /g; 5194b13edf7fSJoe Perches 5195b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5196b13edf7fSJoe Perches my $stmts = $2; 5197b13edf7fSJoe Perches my $semis = $3; 5198b13edf7fSJoe Perches 5199b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5200b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5201e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5202b13edf7fSJoe Perches 5203ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5204ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5205b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5206b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5207b13edf7fSJoe Perches } 5208b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5209b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5210b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5211b13edf7fSJoe Perches } 5212f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5213f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5214f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5215e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5216f5ef95b1SJoe Perches 5217f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5218f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5219b13edf7fSJoe Perches } 5220b13edf7fSJoe Perches } 5221b13edf7fSJoe Perches 5222f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 522313214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 522413214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5225cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 522613214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5227cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5228cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5229aad4f614SJoe Perches my @allowed = (); 5230aad4f614SJoe Perches my $allow = 0; 523113214adfSAndy Whitcroft my $seen = 0; 5232773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5233cf655043SAndy Whitcroft my $ln = $linenr - 1; 523413214adfSAndy Whitcroft for my $chunk (@chunks) { 523513214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 523613214adfSAndy Whitcroft 5237773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5238773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5239773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 5240773647a0SAndy Whitcroft 5241aad4f614SJoe Perches $allowed[$allow] = 0; 5242773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5243773647a0SAndy Whitcroft 5244773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 5245773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 5246773647a0SAndy Whitcroft 5247773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5248cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 5249cf655043SAndy Whitcroft 5250773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 525113214adfSAndy Whitcroft 525213214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 525313214adfSAndy Whitcroft 5254aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5255cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5256cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5257aad4f614SJoe Perches $allowed[$allow] = 1; 525813214adfSAndy Whitcroft } 525913214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5260cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5261aad4f614SJoe Perches $allowed[$allow] = 1; 526213214adfSAndy Whitcroft } 5263cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5264cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5265aad4f614SJoe Perches $allowed[$allow] = 1; 526613214adfSAndy Whitcroft } 5267aad4f614SJoe Perches $allow++; 526813214adfSAndy Whitcroft } 5269aad4f614SJoe Perches if ($seen) { 5270aad4f614SJoe Perches my $sum_allowed = 0; 5271aad4f614SJoe Perches foreach (@allowed) { 5272aad4f614SJoe Perches $sum_allowed += $_; 5273aad4f614SJoe Perches } 5274aad4f614SJoe Perches if ($sum_allowed == 0) { 5275000d1cc1SJoe Perches WARN("BRACES", 5276000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 5277aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 5278aad4f614SJoe Perches $seen != $allow) { 5279aad4f614SJoe Perches CHK("BRACES", 5280aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 5281aad4f614SJoe Perches } 528213214adfSAndy Whitcroft } 528313214adfSAndy Whitcroft } 528413214adfSAndy Whitcroft } 5285773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 528613214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 5287cf655043SAndy Whitcroft my $allowed = 0; 5288f0a594c1SAndy Whitcroft 5289cf655043SAndy Whitcroft # Check the pre-context. 5290cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 5291cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 5292cf655043SAndy Whitcroft $allowed = 1; 5293f0a594c1SAndy Whitcroft } 5294773647a0SAndy Whitcroft 5295773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 5296773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 5297773647a0SAndy Whitcroft 5298cf655043SAndy Whitcroft # Check the condition. 5299cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 5300773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 5301cf655043SAndy Whitcroft if (defined $cond) { 5302773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5303cf655043SAndy Whitcroft } 5304cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5305cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5306cf655043SAndy Whitcroft $allowed = 1; 5307cf655043SAndy Whitcroft } 5308cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5309cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5310cf655043SAndy Whitcroft $allowed = 1; 5311cf655043SAndy Whitcroft } 5312cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5313cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5314cf655043SAndy Whitcroft $allowed = 1; 5315cf655043SAndy Whitcroft } 5316cf655043SAndy Whitcroft # Check the post-context. 5317cf655043SAndy Whitcroft if (defined $chunks[1]) { 5318cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 5319cf655043SAndy Whitcroft if (defined $cond) { 5320773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5321cf655043SAndy Whitcroft } 5322cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 5323cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5324cf655043SAndy Whitcroft $allowed = 1; 5325cf655043SAndy Whitcroft } 5326cf655043SAndy Whitcroft } 5327cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 5328f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 5329e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5330cf655043SAndy Whitcroft 5331000d1cc1SJoe Perches WARN("BRACES", 5332000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 5333f0a594c1SAndy Whitcroft } 5334f0a594c1SAndy Whitcroft } 5335f0a594c1SAndy Whitcroft 5336e4c5babdSJoe Perches# check for single line unbalanced braces 533795330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 533895330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 5339e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 5340e4c5babdSJoe Perches } 5341e4c5babdSJoe Perches 53420979ae66SJoe Perches# check for unnecessary blank lines around braces 534377b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5344f8e58219SJoe Perches if (CHK("BRACES", 5345f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5346f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 5347f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5348f8e58219SJoe Perches } 53490979ae66SJoe Perches } 535077b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5351f8e58219SJoe Perches if (CHK("BRACES", 5352f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5353f8e58219SJoe Perches $fix) { 5354f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 5355f8e58219SJoe Perches } 53560979ae66SJoe Perches } 53570979ae66SJoe Perches 53584a0df2efSAndy Whitcroft# no volatiles please 53596c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 53606c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5361000d1cc1SJoe Perches WARN("VOLATILE", 53628c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 53634a0df2efSAndy Whitcroft } 53644a0df2efSAndy Whitcroft 53655e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 53665e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 53675e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 53685e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 536933acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 53705e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 53715e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 53725e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 53735e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 53745e4f6ba5SJoe Perches $fix && 53755e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 53765e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 53775e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 53785e4f6ba5SJoe Perches my $comma_close = ""; 53795e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 53805e4f6ba5SJoe Perches $comma_close = $1; 53815e4f6ba5SJoe Perches } 53825e4f6ba5SJoe Perches 53835e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 53845e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 53855e4f6ba5SJoe Perches my $fixedline = $prevrawline; 53865e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 53875e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 53885e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 53895e4f6ba5SJoe Perches $fixedline = $rawline; 53905e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 53915e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 53925e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 53935e4f6ba5SJoe Perches } 53945e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 53955e4f6ba5SJoe Perches } 53965e4f6ba5SJoe Perches } 53975e4f6ba5SJoe Perches 53985e4f6ba5SJoe Perches# check for missing a space in a string concatenation 53995e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 54005e4f6ba5SJoe Perches WARN('MISSING_SPACE', 54015e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 54025e4f6ba5SJoe Perches } 54035e4f6ba5SJoe Perches 540477cb8546SJoe Perches# check for an embedded function name in a string when the function is known 5405e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 5406e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 5407e4b7d309SJoe Perches# function declarations 540877cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 540977cb8546SJoe Perches defined($context_function) && 5410e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 5411e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 541277cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 5413e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 541477cb8546SJoe Perches } 541577cb8546SJoe Perches 54165e4f6ba5SJoe Perches# check for spaces before a quoted newline 54175e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 54185e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 54195e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 54205e4f6ba5SJoe Perches $fix) { 54215e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 54225e4f6ba5SJoe Perches } 54235e4f6ba5SJoe Perches 54245e4f6ba5SJoe Perches } 54255e4f6ba5SJoe Perches 5426f17dba4fSJoe Perches# concatenated string without spaces between elements 542779682c0cSJoe Perches if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) { 542879682c0cSJoe Perches if (CHK("CONCATENATED_STRING", 542979682c0cSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr) && 543079682c0cSJoe Perches $fix) { 543179682c0cSJoe Perches while ($line =~ /($String)/g) { 543279682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 543379682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/; 543479682c0cSJoe Perches $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/; 543579682c0cSJoe Perches } 543679682c0cSJoe Perches } 5437f17dba4fSJoe Perches } 5438f17dba4fSJoe Perches 543990ad30e5SJoe Perches# uncoalesced string fragments 544033acb54aSJoe Perches if ($line =~ /$String\s*"/) { 544179682c0cSJoe Perches if (WARN("STRING_FRAGMENTS", 544279682c0cSJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr) && 544379682c0cSJoe Perches $fix) { 544479682c0cSJoe Perches while ($line =~ /($String)(?=\s*")/g) { 544579682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 544679682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e; 544779682c0cSJoe Perches } 544879682c0cSJoe Perches } 544990ad30e5SJoe Perches } 545090ad30e5SJoe Perches 5451522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 5452522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 5453522b837cSAlexey Dobriyan my $show_Z = 1; 54545e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 5455522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 54565e4f6ba5SJoe Perches $string =~ s/%%/__/g; 5457522b837cSAlexey Dobriyan # check for %L 5458522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 54595e4f6ba5SJoe Perches WARN("PRINTF_L", 5460522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 5461522b837cSAlexey Dobriyan $show_L = 0; 54625e4f6ba5SJoe Perches } 5463522b837cSAlexey Dobriyan # check for %Z 5464522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 5465522b837cSAlexey Dobriyan WARN("PRINTF_Z", 5466522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 5467522b837cSAlexey Dobriyan $show_Z = 0; 5468522b837cSAlexey Dobriyan } 5469522b837cSAlexey Dobriyan # check for 0x<decimal> 5470522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 5471522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 54726e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 54736e300757SJoe Perches } 54745e4f6ba5SJoe Perches } 54755e4f6ba5SJoe Perches 54765e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 54773f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 54785e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 54795e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 54805e4f6ba5SJoe Perches } 54815e4f6ba5SJoe Perches 548200df344fSAndy Whitcroft# warn about #if 0 5483c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 548460f89010SPrakruthi Deepak Heragu WARN("IF_0", 548560f89010SPrakruthi Deepak Heragu "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr); 548660f89010SPrakruthi Deepak Heragu } 548760f89010SPrakruthi Deepak Heragu 548860f89010SPrakruthi Deepak Heragu# warn about #if 1 548960f89010SPrakruthi Deepak Heragu if ($line =~ /^.\s*\#\s*if\s+1\b/) { 549060f89010SPrakruthi Deepak Heragu WARN("IF_1", 549160f89010SPrakruthi Deepak Heragu "Consider removing the #if 1 and its #endif\n" . $herecurr); 54924a0df2efSAndy Whitcroft } 54934a0df2efSAndy Whitcroft 549403df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 549503df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5496100425deSJoe Perches my $tested = quotemeta($1); 5497100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5498100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5499100425deSJoe Perches my $func = $1; 5500100425deSJoe Perches if (WARN('NEEDLESS_IF', 5501100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5502100425deSJoe Perches $fix) { 5503100425deSJoe Perches my $do_fix = 1; 5504100425deSJoe Perches my $leading_tabs = ""; 5505100425deSJoe Perches my $new_leading_tabs = ""; 5506100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5507100425deSJoe Perches $leading_tabs = $1; 5508100425deSJoe Perches } else { 5509100425deSJoe Perches $do_fix = 0; 5510100425deSJoe Perches } 5511100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5512100425deSJoe Perches $new_leading_tabs = $1; 5513100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5514100425deSJoe Perches $do_fix = 0; 5515100425deSJoe Perches } 5516100425deSJoe Perches } else { 5517100425deSJoe Perches $do_fix = 0; 5518100425deSJoe Perches } 5519100425deSJoe Perches if ($do_fix) { 5520100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5521100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5522100425deSJoe Perches } 5523100425deSJoe Perches } 55244c432a8fSGreg Kroah-Hartman } 55254c432a8fSGreg Kroah-Hartman } 5526f0a594c1SAndy Whitcroft 5527ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5528ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5529ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5530ebfdc409SJoe Perches (defined $1 || defined $3) && 5531ebfdc409SJoe Perches $linenr > 3) { 5532ebfdc409SJoe Perches my $testval = $2; 5533ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5534ebfdc409SJoe Perches 5535ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5536ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5537ebfdc409SJoe Perches 5538fb0d0e08SJoe Perches if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|kmemdup|(?:dev_)?alloc_skb)/) { 5539ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5540ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5541ebfdc409SJoe Perches } 5542ebfdc409SJoe Perches } 5543ebfdc409SJoe Perches 5544f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5545dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5546f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5547f78d98f6SJoe Perches my $level = $1; 5548f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5549f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5550f78d98f6SJoe Perches $fix) { 5551f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5552f78d98f6SJoe Perches } 5553f78d98f6SJoe Perches } 5554f78d98f6SJoe Perches 555545c55e92SJoe Perches# check for logging continuations 555645c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 555745c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 555845c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 555945c55e92SJoe Perches } 556045c55e92SJoe Perches 5561abb08a53SJoe Perches# check for mask then right shift without a parentheses 55625b57980dSJoe Perches if ($perl_version_ok && 5563abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5564abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5565abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5566abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5567abb08a53SJoe Perches } 5568abb08a53SJoe Perches 5569b75ac618SJoe Perches# check for pointer comparisons to NULL 55705b57980dSJoe Perches if ($perl_version_ok) { 5571b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5572b75ac618SJoe Perches my $val = $1; 5573b75ac618SJoe Perches my $equal = "!"; 5574b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5575b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5576b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5577b75ac618SJoe Perches $fix) { 5578b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5579b75ac618SJoe Perches } 5580b75ac618SJoe Perches } 5581b75ac618SJoe Perches } 5582b75ac618SJoe Perches 55838716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 55848716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 55858716de38SJoe Perches my $attr = $1; 55868716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 55878716de38SJoe Perches my $ptr = $1; 55888716de38SJoe Perches my $var = $2; 55898716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 55908716de38SJoe Perches ERROR("MISPLACED_INIT", 55918716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 55928716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 55938716de38SJoe Perches WARN("MISPLACED_INIT", 55948716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 55958716de38SJoe Perches $fix) { 5596194f66fcSJoe 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; 55978716de38SJoe Perches } 55988716de38SJoe Perches } 55998716de38SJoe Perches } 56008716de38SJoe Perches 5601e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5602e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5603e970b884SJoe Perches my $attr = $1; 5604e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5605e970b884SJoe Perches my $attr_prefix = $1; 5606e970b884SJoe Perches my $attr_type = $2; 5607e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5608e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5609e970b884SJoe Perches $fix) { 5610194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5611e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5612e970b884SJoe Perches } 5613e970b884SJoe Perches } 5614e970b884SJoe Perches 5615e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5616e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5617e970b884SJoe Perches my $attr = $1; 5618e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5619e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5620e970b884SJoe Perches $fix) { 5621194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5622e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5623e970b884SJoe Perches $lead = rtrim($1); 5624e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5625e970b884SJoe Perches $lead = "${lead}const "; 5626194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5627e970b884SJoe Perches } 5628e970b884SJoe Perches } 5629e970b884SJoe Perches 5630c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5631c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5632c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5633c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5634c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5635c17893c7SJoe Perches $fix) { 5636c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5637c17893c7SJoe Perches } 5638c17893c7SJoe Perches } 5639c17893c7SJoe Perches 5640fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5641fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5642fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5643fbdb8138SJoe Perches my $constant_func = $1; 5644fbdb8138SJoe Perches my $func = $constant_func; 5645fbdb8138SJoe Perches $func =~ s/^__constant_//; 5646fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5647fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5648fbdb8138SJoe Perches $fix) { 5649194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5650fbdb8138SJoe Perches } 5651fbdb8138SJoe Perches } 5652fbdb8138SJoe Perches 56531a15a250SPatrick Pannuto# prefer usleep_range over udelay 565437581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 565543c1d77cSJoe Perches my $delay = $1; 56561a15a250SPatrick Pannuto # ignore udelay's < 10, however 565743c1d77cSJoe Perches if (! ($delay < 10) ) { 5658000d1cc1SJoe Perches CHK("USLEEP_RANGE", 565943c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 566043c1d77cSJoe Perches } 566143c1d77cSJoe Perches if ($delay > 2000) { 566243c1d77cSJoe Perches WARN("LONG_UDELAY", 566343c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 56641a15a250SPatrick Pannuto } 56651a15a250SPatrick Pannuto } 56661a15a250SPatrick Pannuto 566709ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 566809ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 566909ef8725SPatrick Pannuto if ($1 < 20) { 5670000d1cc1SJoe Perches WARN("MSLEEP", 567143c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 567209ef8725SPatrick Pannuto } 567309ef8725SPatrick Pannuto } 567409ef8725SPatrick Pannuto 567536ec1939SJoe Perches# check for comparisons of jiffies 567636ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 567736ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 567836ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 567936ec1939SJoe Perches } 568036ec1939SJoe Perches 56819d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 56829d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 56839d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 56849d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 56859d7a34a5SJoe Perches } 56869d7a34a5SJoe Perches 568700df344fSAndy Whitcroft# warn about #ifdefs in C files 5688c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 568900df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 569000df344fSAndy Whitcroft# print "$herecurr"; 569100df344fSAndy Whitcroft# $clean = 0; 569200df344fSAndy Whitcroft# } 569300df344fSAndy Whitcroft 569422f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5695c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 56963705ce5bSJoe Perches if (ERROR("SPACING", 56973705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 56983705ce5bSJoe Perches $fix) { 5699194f66fcSJoe Perches $fixed[$fixlinenr] =~ 57003705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 57013705ce5bSJoe Perches } 57023705ce5bSJoe Perches 570322f2a2efSAndy Whitcroft } 570422f2a2efSAndy Whitcroft 57054a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5706171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5707171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 57084a0df2efSAndy Whitcroft my $which = $1; 57094a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5710000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5711000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 57124a0df2efSAndy Whitcroft } 57134a0df2efSAndy Whitcroft } 57144a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5715402c2553SMichael S. Tsirkin 5716402c2553SMichael S. Tsirkin my $barriers = qr{ 5717402c2553SMichael S. Tsirkin mb| 5718402c2553SMichael S. Tsirkin rmb| 5719402c2553SMichael S. Tsirkin wmb| 5720402c2553SMichael S. Tsirkin read_barrier_depends 5721402c2553SMichael S. Tsirkin }x; 5722402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5723402c2553SMichael S. Tsirkin mb__before_atomic| 5724402c2553SMichael S. Tsirkin mb__after_atomic| 5725402c2553SMichael S. Tsirkin store_release| 5726402c2553SMichael S. Tsirkin load_acquire| 5727402c2553SMichael S. Tsirkin store_mb| 5728402c2553SMichael S. Tsirkin (?:$barriers) 5729402c2553SMichael S. Tsirkin }x; 5730402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5731402c2553SMichael S. Tsirkin (?:$barriers)| 573243e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 573343e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5734402c2553SMichael S. Tsirkin }x; 5735402c2553SMichael S. Tsirkin 5736402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 57374a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5738c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5739000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 57404a0df2efSAndy Whitcroft } 57414a0df2efSAndy Whitcroft } 57423ad81779SPaul E. McKenney 5743f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5744f4073b0fSMichael S. Tsirkin 5745f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5746f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5747f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5748f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5749f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5750f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5751f4073b0fSMichael S. Tsirkin } 5752f4073b0fSMichael S. Tsirkin 5753cb426e99SJoe Perches# check for waitqueue_active without a comment. 5754cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5755cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5756cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5757cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5758cb426e99SJoe Perches } 5759cb426e99SJoe Perches } 57603ad81779SPaul E. McKenney 576191db2592SPaul E. McKenney# check for smp_read_barrier_depends and read_barrier_depends 576291db2592SPaul E. McKenney if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) { 576391db2592SPaul E. McKenney WARN("READ_BARRIER_DEPENDS", 576491db2592SPaul E. McKenney "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr); 576591db2592SPaul E. McKenney } 576691db2592SPaul E. McKenney 57674a0df2efSAndy Whitcroft# check of hardware specific defines 5768c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5769000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5770000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 57710a920b5bSAndy Whitcroft } 5772653d4876SAndy Whitcroft 5773596ed45bSJoe Perches# check that the storage class is not after a type 5774596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 5775000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5776596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 5777596ed45bSJoe Perches } 5778596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 5779596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 5780596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 5781596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 5782596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 5783596ed45bSJoe Perches WARN("STORAGE_CLASS", 5784596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 5785d4977c78STobias Klauser } 5786d4977c78STobias Klauser 5787de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5788de7d4f0eSAndy Whitcroft# storage class and type. 57899c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 57909c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5791000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5792000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5793de7d4f0eSAndy Whitcroft } 5794de7d4f0eSAndy Whitcroft 57958905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 57962b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57972b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5798d5e616fcSJoe Perches if (WARN("INLINE", 5799d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5800d5e616fcSJoe Perches $fix) { 5801194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5802d5e616fcSJoe Perches 5803d5e616fcSJoe Perches } 58048905a67cSAndy Whitcroft } 58058905a67cSAndy Whitcroft 58063d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 58072b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 58082b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5809000d1cc1SJoe Perches WARN("PREFER_PACKED", 5810000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 58113d130fd0SJoe Perches } 58123d130fd0SJoe Perches 581339b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 58142b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 58152b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5816000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5817000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 581839b7e287SJoe Perches } 581939b7e287SJoe Perches 58205f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 58212b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 58222b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5823d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5824d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5825d5e616fcSJoe Perches $fix) { 5826194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5827d5e616fcSJoe Perches 5828d5e616fcSJoe Perches } 58295f14d3bdSJoe Perches } 58305f14d3bdSJoe Perches 58316061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 58322b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 58332b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5834d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5835d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5836d5e616fcSJoe Perches $fix) { 5837194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5838d5e616fcSJoe Perches } 58396061d949SJoe Perches } 58406061d949SJoe Perches 5841619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 58425b57980dSJoe Perches if ($perl_version_ok && 5843619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5844619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5845619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5846619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5847619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5848619a908aSJoe Perches } 5849619a908aSJoe Perches 5850fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 5851e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5852fd39f904STomas Winkler $realfile !~ m@\btools/@ && 5853e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5854e6176fa4SJoe Perches my $type = $1; 5855e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5856e6176fa4SJoe Perches $type = $1; 5857e6176fa4SJoe Perches my $kernel_type = 'u'; 5858e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5859e6176fa4SJoe Perches $type =~ /(\d+)/; 5860e6176fa4SJoe Perches $kernel_type .= $1; 5861e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5862e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5863e6176fa4SJoe Perches $fix) { 5864e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5865e6176fa4SJoe Perches } 5866e6176fa4SJoe Perches } 5867e6176fa4SJoe Perches } 5868e6176fa4SJoe Perches 5869938224b5SJoe Perches# check for cast of C90 native int or longer types constants 5870938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 5871938224b5SJoe Perches my $cast = $1; 5872938224b5SJoe Perches my $const = $2; 5873938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 5874938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 5875938224b5SJoe Perches $fix) { 5876938224b5SJoe Perches my $suffix = ""; 5877938224b5SJoe Perches my $newconst = $const; 5878938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 5879938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 5880938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 5881938224b5SJoe Perches $suffix .= 'LL'; 5882938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 5883938224b5SJoe Perches $suffix .= 'L'; 5884938224b5SJoe Perches } 5885938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 5886938224b5SJoe Perches } 5887938224b5SJoe Perches } 5888938224b5SJoe Perches 58898f53a9b8SJoe Perches# check for sizeof(&) 58908f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5891000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5892000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 58938f53a9b8SJoe Perches } 58948f53a9b8SJoe Perches 589566c80b60SJoe Perches# check for sizeof without parenthesis 589666c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5897d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5898d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5899d5e616fcSJoe Perches $fix) { 5900194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5901d5e616fcSJoe Perches } 590266c80b60SJoe Perches } 590366c80b60SJoe Perches 590488982feaSJoe Perches# check for struct spinlock declarations 590588982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 590688982feaSJoe Perches WARN("USE_SPINLOCK_T", 590788982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 590888982feaSJoe Perches } 590988982feaSJoe Perches 5910a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 591106668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5912a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5913caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5914caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5915d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5916d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5917d5e616fcSJoe Perches $fix) { 5918194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5919d5e616fcSJoe Perches } 5920a6962d72SJoe Perches } 5921a6962d72SJoe Perches } 5922a6962d72SJoe Perches 59230b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 59245b57980dSJoe Perches if ($perl_version_ok && 59250b523769SJoe Perches defined $stat && 59260b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 59270b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 5928e3c6bc95STobin C. Harding my $stat_real; 5929e3c6bc95STobin C. Harding 59300b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 59310b523769SJoe Perches $lc = $lc + $linenr; 59320b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 5933ffe07513SJoe Perches my $specifier; 5934ffe07513SJoe Perches my $extension; 5935ffe07513SJoe Perches my $bad_specifier = ""; 59360b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 59370b523769SJoe Perches $fmt =~ s/%%//g; 5938e3c6bc95STobin C. Harding 5939e3c6bc95STobin C. Harding while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) { 5940e3c6bc95STobin C. Harding $specifier = $1; 5941e3c6bc95STobin C. Harding $extension = $2; 5942e3c6bc95STobin C. Harding if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOx]/) { 5943e3c6bc95STobin C. Harding $bad_specifier = $specifier; 59440b523769SJoe Perches last; 59450b523769SJoe Perches } 5946e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 5947e3c6bc95STobin C. Harding if (!defined($stat_real)) { 5948e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 59490b523769SJoe Perches } 5950e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 5951e3c6bc95STobin 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"); 5952e3c6bc95STobin C. Harding } 5953e3c6bc95STobin C. Harding } 5954e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 59552a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 59561df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 59571df7338aSSergey Senozhatsky my $use = ""; 5958e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 59591df7338aSSergey Senozhatsky $ext_type = "Deprecated"; 59601df7338aSSergey Senozhatsky $use = " - use %pS instead"; 5961e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 59621df7338aSSergey Senozhatsky } 59632a9f9d85STobin C. Harding 59640b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 5965e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 5966e3c6bc95STobin C. Harding } 59670b523769SJoe Perches } 59680b523769SJoe Perches } 59690b523769SJoe Perches 5970554e165cSAndy Whitcroft# Check for misused memsets 59715b57980dSJoe Perches if ($perl_version_ok && 5972d1fe9c09SJoe Perches defined $stat && 59739e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5974554e165cSAndy Whitcroft 5975d7c76ba7SJoe Perches my $ms_addr = $2; 5976d1fe9c09SJoe Perches my $ms_val = $7; 5977d1fe9c09SJoe Perches my $ms_size = $12; 5978d7c76ba7SJoe Perches 5979554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5980554e165cSAndy Whitcroft ERROR("MEMSET", 5981d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5982554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5983554e165cSAndy Whitcroft WARN("MEMSET", 5984d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5985d7c76ba7SJoe Perches } 5986d7c76ba7SJoe Perches } 5987d7c76ba7SJoe Perches 598898a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 59895b57980dSJoe Perches# if ($perl_version_ok && 5990f333195dSJoe Perches# defined $stat && 5991f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5992f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 5993f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 5994f333195dSJoe Perches# $fix) { 5995f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 5996f333195dSJoe Perches# } 5997f333195dSJoe Perches# } 599898a9bba5SJoe Perches 5999b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 60005b57980dSJoe Perches# if ($perl_version_ok && 6001f333195dSJoe Perches# defined $stat && 6002f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6003f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 6004f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 6005f333195dSJoe Perches# } 6006b6117d17SMateusz Kulikowski 60078617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 60088617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 60095b57980dSJoe Perches# if ($perl_version_ok && 6010f333195dSJoe Perches# defined $stat && 6011f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6012f333195dSJoe Perches# 6013f333195dSJoe Perches# my $ms_val = $7; 6014f333195dSJoe Perches# 6015f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 6016f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 6017f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 6018f333195dSJoe Perches# $fix) { 6019f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 6020f333195dSJoe Perches# } 6021f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 6022f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 6023f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 6024f333195dSJoe Perches# $fix) { 6025f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 6026f333195dSJoe Perches# } 6027f333195dSJoe Perches# } 6028f333195dSJoe Perches# } 60298617cd09SMateusz Kulikowski 6030d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 60315b57980dSJoe Perches if ($perl_version_ok && 6032d1fe9c09SJoe Perches defined $stat && 6033d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 6034d1fe9c09SJoe Perches if (defined $2 || defined $7) { 6035d7c76ba7SJoe Perches my $call = $1; 6036d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 6037d7c76ba7SJoe Perches my $arg1 = $3; 6038d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 6039d1fe9c09SJoe Perches my $arg2 = $8; 6040d7c76ba7SJoe Perches my $cast; 6041d7c76ba7SJoe Perches 6042d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 6043d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 6044d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 6045d7c76ba7SJoe Perches $cast = $cast1; 6046d7c76ba7SJoe Perches } else { 6047d7c76ba7SJoe Perches $cast = $cast2; 6048d7c76ba7SJoe Perches } 6049d7c76ba7SJoe Perches WARN("MINMAX", 6050d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 6051554e165cSAndy Whitcroft } 6052554e165cSAndy Whitcroft } 6053554e165cSAndy Whitcroft 60544a273195SJoe Perches# check usleep_range arguments 60555b57980dSJoe Perches if ($perl_version_ok && 60564a273195SJoe Perches defined $stat && 60574a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 60584a273195SJoe Perches my $min = $1; 60594a273195SJoe Perches my $max = $7; 60604a273195SJoe Perches if ($min eq $max) { 60614a273195SJoe Perches WARN("USLEEP_RANGE", 60624a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 60634a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 60644a273195SJoe Perches $min > $max) { 60654a273195SJoe Perches WARN("USLEEP_RANGE", 60664a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 60674a273195SJoe Perches } 60684a273195SJoe Perches } 60694a273195SJoe Perches 6070823b794cSJoe Perches# check for naked sscanf 60715b57980dSJoe Perches if ($perl_version_ok && 6072823b794cSJoe Perches defined $stat && 60736c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 6074823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 6075823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 6076823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 6077823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 6078823b794cSJoe Perches $lc = $lc + $linenr; 60792a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6080823b794cSJoe Perches WARN("NAKED_SSCANF", 6081823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 6082823b794cSJoe Perches } 6083823b794cSJoe Perches 6084afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 60855b57980dSJoe Perches if ($perl_version_ok && 6086afc819abSJoe Perches defined $stat && 6087afc819abSJoe Perches $line =~ /\bsscanf\b/) { 6088afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 6089afc819abSJoe Perches $lc = $lc + $linenr; 60902a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6091afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 6092afc819abSJoe Perches my $format = $6; 6093afc819abSJoe Perches my $count = $format =~ tr@%@%@; 6094afc819abSJoe Perches if ($count == 1 && 6095afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 6096afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 6097afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 6098afc819abSJoe Perches } 6099afc819abSJoe Perches } 6100afc819abSJoe Perches } 6101afc819abSJoe Perches 610270dc8a48SJoe Perches# check for new externs in .h files. 610370dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 610470dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 6105d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 610670dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 610770dc8a48SJoe Perches $fix) { 6108194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 610970dc8a48SJoe Perches } 611070dc8a48SJoe Perches } 611170dc8a48SJoe Perches 6112de7d4f0eSAndy Whitcroft# check for new externs in .c files. 6113171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 6114c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 6115171ae1a4SAndy Whitcroft { 6116c45dcabdSAndy Whitcroft my $function_name = $1; 6117c45dcabdSAndy Whitcroft my $paren_space = $2; 6118171ae1a4SAndy Whitcroft 6119171ae1a4SAndy Whitcroft my $s = $stat; 6120171ae1a4SAndy Whitcroft if (defined $cond) { 6121171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 6122171ae1a4SAndy Whitcroft } 6123c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 6124c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 6125c45dcabdSAndy Whitcroft { 6126000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6127000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6128de7d4f0eSAndy Whitcroft } 6129de7d4f0eSAndy Whitcroft 6130171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 6131000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 6132000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 6133171ae1a4SAndy Whitcroft } 61349c9ba34eSAndy Whitcroft 61359c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 61369c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 61379c9ba34eSAndy Whitcroft { 6138000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6139000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6140171ae1a4SAndy Whitcroft } 6141171ae1a4SAndy Whitcroft 6142a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 6143a0ad7596SJoe Perches if (defined $stat && 614425bdda2bSMiles Chen $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 6145ca0d8929SJoe Perches $1 ne "void") { 6146ca0d8929SJoe Perches my $args = trim($1); 6147ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6148ca0d8929SJoe Perches my $arg = trim($1); 6149ca0d8929SJoe Perches if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 6150ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 6151ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6152ca0d8929SJoe Perches } 6153ca0d8929SJoe Perches } 6154ca0d8929SJoe Perches } 6155ca0d8929SJoe Perches 6156a0ad7596SJoe Perches# check for function definitions 61575b57980dSJoe Perches if ($perl_version_ok && 6158a0ad7596SJoe Perches defined $stat && 6159a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6160a0ad7596SJoe Perches $context_function = $1; 6161a0ad7596SJoe Perches 6162a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 6163a0ad7596SJoe Perches my $ok = 0; 6164a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 6165a0ad7596SJoe Perches my $herectx = $here . "\n"; 6166a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6167a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 6168a0ad7596SJoe Perches $herectx .= $rl . "\n"; 6169a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 6170a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 6171a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 6172a0ad7596SJoe Perches } 6173a0ad7596SJoe Perches if (!$ok) { 6174a0ad7596SJoe Perches ERROR("OPEN_BRACE", 6175a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 6176a0ad7596SJoe Perches } 6177a0ad7596SJoe Perches } 6178a0ad7596SJoe Perches 6179de7d4f0eSAndy Whitcroft# checks for new __setup's 6180de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 6181de7d4f0eSAndy Whitcroft my $name = $1; 6182de7d4f0eSAndy Whitcroft 6183de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 6184000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 61858c27ceffSMauro Carvalho Chehab "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr); 6186de7d4f0eSAndy Whitcroft } 6187653d4876SAndy Whitcroft } 61889c0ca6f9SAndy Whitcroft 61899c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 6190caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 6191000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 6192000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 61939c0ca6f9SAndy Whitcroft } 619413214adfSAndy Whitcroft 6195a640d25cSJoe Perches# alloc style 6196a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 61975b57980dSJoe Perches if ($perl_version_ok && 6198a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 6199a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 6200a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 6201a640d25cSJoe Perches } 6202a640d25cSJoe Perches 620360a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 62045b57980dSJoe Perches if ($perl_version_ok && 62051b4a2ed4SJoe Perches defined $stat && 62061b4a2ed4SJoe Perches $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 620760a55369SJoe Perches my $oldfunc = $3; 620860a55369SJoe Perches my $a1 = $4; 620960a55369SJoe Perches my $a2 = $10; 621060a55369SJoe Perches my $newfunc = "kmalloc_array"; 621160a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 621260a55369SJoe Perches my $r1 = $a1; 621360a55369SJoe Perches my $r2 = $a2; 621460a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 621560a55369SJoe Perches $r1 = $a2; 621660a55369SJoe Perches $r2 = $a1; 621760a55369SJoe Perches } 6218e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 6219e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 62201b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 6221e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6222e3d95a2aSTobin C. Harding 6223e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 62241b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 62251b4a2ed4SJoe Perches $cnt == 1 && 6226e367455aSJoe Perches $fix) { 6227194f66fcSJoe 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; 622860a55369SJoe Perches } 622960a55369SJoe Perches } 623060a55369SJoe Perches } 623160a55369SJoe Perches 6232972fdea2SJoe Perches# check for krealloc arg reuse 62335b57980dSJoe Perches if ($perl_version_ok && 62344cab63ceSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ && 62354cab63ceSJoe Perches $1 eq $3) { 6236972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 6237972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 6238972fdea2SJoe Perches } 6239972fdea2SJoe Perches 62405ce59ae0SJoe Perches# check for alloc argument mismatch 62415ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 62425ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 62435ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 62445ce59ae0SJoe Perches } 62455ce59ae0SJoe Perches 6246caf2a54fSJoe Perches# check for multiple semicolons 6247caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 6248d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 6249d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 6250d5e616fcSJoe Perches $fix) { 6251194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 6252d5e616fcSJoe Perches } 6253d1e2ad07SJoe Perches } 6254d1e2ad07SJoe Perches 6255cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 6256cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 6257cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 62580ab90191SJoe Perches my $ull = ""; 62590ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 62600ab90191SJoe Perches if (CHK("BIT_MACRO", 62610ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 62620ab90191SJoe Perches $fix) { 62630ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 62640ab90191SJoe Perches } 62650ab90191SJoe Perches } 62660ab90191SJoe Perches 62672d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 62682d632745SJoe 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*$/) { 62692d632745SJoe Perches my $config = $1; 62702d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 62712d632745SJoe Perches "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) && 62722d632745SJoe Perches $fix) { 62732d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 62742d632745SJoe Perches } 62752d632745SJoe Perches } 62762d632745SJoe Perches 6277e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 6278c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 6279c34c09a8SJoe Perches my $has_break = 0; 6280c34c09a8SJoe Perches my $has_statement = 0; 6281c34c09a8SJoe Perches my $count = 0; 6282c34c09a8SJoe Perches my $prevline = $linenr; 6283e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 6284c34c09a8SJoe Perches $prevline--; 6285c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 6286c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 6287c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 6288c34c09a8SJoe Perches next if ($fline =~ /^\-/); 6289c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 6290c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 6291c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 6292c34c09a8SJoe Perches $has_statement = 1; 6293c34c09a8SJoe Perches $count++; 6294258f79d5SHeinrich Schuchardt $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/); 6295c34c09a8SJoe Perches } 6296c34c09a8SJoe Perches if (!$has_break && $has_statement) { 6297c34c09a8SJoe Perches WARN("MISSING_BREAK", 6298224236d9SAndrew Morton "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr); 6299c34c09a8SJoe Perches } 6300c34c09a8SJoe Perches } 6301c34c09a8SJoe Perches 6302d1e2ad07SJoe Perches# check for switch/default statements without a break; 63035b57980dSJoe Perches if ($perl_version_ok && 6304d1e2ad07SJoe Perches defined $stat && 6305d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 6306d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 6307e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6308e3d95a2aSTobin C. Harding 6309d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 6310d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 6311caf2a54fSJoe Perches } 6312caf2a54fSJoe Perches 631313214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 6314d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 6315d5e616fcSJoe Perches if (WARN("USE_FUNC", 6316d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 6317d5e616fcSJoe Perches $fix) { 6318194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 6319d5e616fcSJoe Perches } 632013214adfSAndy Whitcroft } 6321773647a0SAndy Whitcroft 632262ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 632362ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 632462ec818fSJoe Perches ERROR("DATE_TIME", 632562ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 632662ec818fSJoe Perches } 632762ec818fSJoe Perches 63282c92488aSJoe Perches# check for use of yield() 63292c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 63302c92488aSJoe Perches WARN("YIELD", 63312c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 63322c92488aSJoe Perches } 63332c92488aSJoe Perches 6334179f8f40SJoe Perches# check for comparisons against true and false 6335179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 6336179f8f40SJoe Perches my $lead = $1; 6337179f8f40SJoe Perches my $arg = $2; 6338179f8f40SJoe Perches my $test = $3; 6339179f8f40SJoe Perches my $otype = $4; 6340179f8f40SJoe Perches my $trail = $5; 6341179f8f40SJoe Perches my $op = "!"; 6342179f8f40SJoe Perches 6343179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 6344179f8f40SJoe Perches 6345179f8f40SJoe Perches my $type = lc($otype); 6346179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 6347179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 6348179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 6349179f8f40SJoe Perches $op = ""; 6350179f8f40SJoe Perches } 6351179f8f40SJoe Perches 6352179f8f40SJoe Perches CHK("BOOL_COMPARISON", 6353179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 6354179f8f40SJoe Perches 6355179f8f40SJoe Perches## maybe suggesting a correct construct would better 6356179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 6357179f8f40SJoe Perches 6358179f8f40SJoe Perches } 6359179f8f40SJoe Perches } 6360179f8f40SJoe Perches 63615d430902SJoe Perches# check for bool bitfields 63625d430902SJoe Perches if ($sline =~ /^.\s+bool\s*$Ident\s*:\s*\d+\s*;/) { 63635d430902SJoe Perches WARN("BOOL_BITFIELD", 63645d430902SJoe Perches "Avoid using bool as bitfield. Prefer bool bitfields as unsigned int or u<8|16|32>\n" . $herecurr); 63655d430902SJoe Perches } 63665d430902SJoe Perches 6367d729593eSJoe Perches# check for bool use in .h files 6368d729593eSJoe Perches if ($realfile =~ /\.h$/ && 6369d729593eSJoe Perches $sline =~ /^.\s+bool\s*$Ident\s*(?::\s*d+\s*)?;/) { 6370d729593eSJoe Perches CHK("BOOL_MEMBER", 6371d729593eSJoe Perches "Avoid using bool structure members because of possible alignment issues - see: https://lkml.org/lkml/2017/11/21/384\n" . $herecurr); 6372d729593eSJoe Perches } 6373d729593eSJoe Perches 63744882720bSThomas Gleixner# check for semaphores initialized locked 63754882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 6376000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 6377000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 6378773647a0SAndy Whitcroft } 63796712d858SJoe Perches 638067d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 638167d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 6382000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 638367d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 6384773647a0SAndy Whitcroft } 63856712d858SJoe Perches 6386ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 6387f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 6388000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 6389ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 6390f3db6639SMichael Ellerman } 63916712d858SJoe Perches 6392*3d709ab5SPaul E. McKenney# check for spin_is_locked(), suggest lockdep instead 6393*3d709ab5SPaul E. McKenney if ($line =~ /\bspin_is_locked\(/) { 6394*3d709ab5SPaul E. McKenney WARN("USE_LOCKDEP", 6395*3d709ab5SPaul E. McKenney "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr); 6396*3d709ab5SPaul E. McKenney } 6397*3d709ab5SPaul E. McKenney 63989189c7e7SJoe Perches# check for deprecated apis 63999189c7e7SJoe Perches if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) { 64009189c7e7SJoe Perches my $deprecated_api = $1; 64019189c7e7SJoe Perches my $new_api = $deprecated_apis{$deprecated_api}; 64029189c7e7SJoe Perches WARN("DEPRECATED_API", 64039189c7e7SJoe Perches "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr); 64049189c7e7SJoe Perches } 64059189c7e7SJoe Perches 64060f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 6407d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 64086903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 6409d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 6410000d1cc1SJoe Perches WARN("CONST_STRUCT", 6411d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 64122b6db5cbSAndy Whitcroft } 6413773647a0SAndy Whitcroft 6414773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 6415773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 6416773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 6417c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 6418c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 6419171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 6420171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 6421171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 6422773647a0SAndy Whitcroft { 6423000d1cc1SJoe Perches WARN("NR_CPUS", 6424000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 6425773647a0SAndy Whitcroft } 64269c9ba34eSAndy Whitcroft 642752ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 642852ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 642952ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 643052ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 643152ea8506SJoe Perches } 643252ea8506SJoe Perches 6433acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 64345b57980dSJoe Perches if ($perl_version_ok && 6435acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 6436acd9362cSJoe Perches WARN("LIKELY_MISUSE", 6437acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 6438acd9362cSJoe Perches } 6439acd9362cSJoe Perches 6440691d77b6SAndy Whitcroft# whine mightly about in_atomic 6441691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 6442691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 6443000d1cc1SJoe Perches ERROR("IN_ATOMIC", 6444000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 6445f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 6446000d1cc1SJoe Perches WARN("IN_ATOMIC", 6447000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 6448691d77b6SAndy Whitcroft } 6449691d77b6SAndy Whitcroft } 64501704f47bSPeter Zijlstra 64510f5225b0SPeter Zijlstra# check for mutex_trylock_recursive usage 64520f5225b0SPeter Zijlstra if ($line =~ /mutex_trylock_recursive/) { 64530f5225b0SPeter Zijlstra ERROR("LOCKING", 64540f5225b0SPeter Zijlstra "recursive locking is bad, do not use this ever.\n" . $herecurr); 64550f5225b0SPeter Zijlstra } 64560f5225b0SPeter Zijlstra 64571704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 64581704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 64591704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 64601704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 64611704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 64621704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 6463000d1cc1SJoe Perches ERROR("LOCKDEP", 6464000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 64651704f47bSPeter Zijlstra } 64661704f47bSPeter Zijlstra } 646788f8831cSDave Jones 6468b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 6469b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 6470000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 6471000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 647288f8831cSDave Jones } 64732435880fSJoe Perches 647400180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 647500180468SJoe Perches# and whether or not function naming is typical and if 647600180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 64775b57980dSJoe Perches if ($perl_version_ok && 647800180468SJoe Perches defined $stat && 647900180468SJoe 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*\)/) { 648000180468SJoe Perches my $var = $1; 648100180468SJoe Perches my $perms = $2; 648200180468SJoe Perches my $show = $3; 648300180468SJoe Perches my $store = $4; 648400180468SJoe Perches my $octal_perms = perms_to_octal($perms); 648500180468SJoe Perches if ($show =~ /^${var}_show$/ && 648600180468SJoe Perches $store =~ /^${var}_store$/ && 648700180468SJoe Perches $octal_perms eq "0644") { 648800180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 648900180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 649000180468SJoe Perches $fix) { 649100180468SJoe 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})/; 649200180468SJoe Perches } 649300180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 649400180468SJoe Perches $store =~ /^NULL$/ && 649500180468SJoe Perches $octal_perms eq "0444") { 649600180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 649700180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 649800180468SJoe Perches $fix) { 649900180468SJoe 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})/; 650000180468SJoe Perches } 650100180468SJoe Perches } elsif ($show =~ /^NULL$/ && 650200180468SJoe Perches $store =~ /^${var}_store$/ && 650300180468SJoe Perches $octal_perms eq "0200") { 650400180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 650500180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 650600180468SJoe Perches $fix) { 650700180468SJoe 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})/; 650800180468SJoe Perches } 650900180468SJoe Perches } elsif ($octal_perms eq "0644" || 651000180468SJoe Perches $octal_perms eq "0444" || 651100180468SJoe Perches $octal_perms eq "0200") { 651200180468SJoe Perches my $newshow = "$show"; 651300180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 651400180468SJoe Perches my $newstore = $store; 651500180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 651600180468SJoe Perches my $rename = ""; 651700180468SJoe Perches if ($show ne $newshow) { 651800180468SJoe Perches $rename .= " '$show' to '$newshow'"; 651900180468SJoe Perches } 652000180468SJoe Perches if ($store ne $newstore) { 652100180468SJoe Perches $rename .= " '$store' to '$newstore'"; 652200180468SJoe Perches } 652300180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 652400180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 652500180468SJoe Perches } else { 652600180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 652700180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 652800180468SJoe Perches } 652900180468SJoe Perches } 653000180468SJoe Perches 6531515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 6532515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 653373121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 653473121534SJoe Perches# specific definition of not visible in sysfs. 653573121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 653673121534SJoe Perches# use the default permissions 65375b57980dSJoe Perches if ($perl_version_ok && 6538459cf0aeSJoe Perches defined $stat && 6539515a235eSJoe Perches $line =~ /$mode_perms_search/) { 65402435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 65412435880fSJoe Perches my $func = $entry->[0]; 65422435880fSJoe Perches my $arg_pos = $entry->[1]; 65432435880fSJoe Perches 6544459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 6545459cf0aeSJoe Perches $lc = $lc + $linenr; 65462a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6547459cf0aeSJoe Perches 65482435880fSJoe Perches my $skip_args = ""; 65492435880fSJoe Perches if ($arg_pos > 1) { 65502435880fSJoe Perches $arg_pos--; 65512435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 65522435880fSJoe Perches } 6553f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 6554459cf0aeSJoe Perches if ($stat =~ /$test/) { 65552435880fSJoe Perches my $val = $1; 65562435880fSJoe Perches $val = $6 if ($skip_args ne ""); 655773121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 655873121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 655973121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 65602435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 6561459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 6562f90774e1SJoe Perches } 6563f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6564c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6565459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 65662435880fSJoe Perches } 6567459cf0aeSJoe Perches } 6568459cf0aeSJoe Perches } 6569459cf0aeSJoe Perches } 6570459cf0aeSJoe Perches 6571459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 6572bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 657300180468SJoe Perches my $oval = $1; 657400180468SJoe Perches my $octal = perms_to_octal($oval); 6575f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 6576459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 6577f90774e1SJoe Perches $fix) { 657800180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 65792435880fSJoe Perches } 658013214adfSAndy Whitcroft } 65815a6d20ceSBjorn Andersson 65825a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 65835a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 65845a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 65855a6d20ceSBjorn Andersson my $valid_licenses = qr{ 65865a6d20ceSBjorn Andersson GPL| 65875a6d20ceSBjorn Andersson GPL\ v2| 65885a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 65895a6d20ceSBjorn Andersson Dual\ BSD/GPL| 65905a6d20ceSBjorn Andersson Dual\ MIT/GPL| 65915a6d20ceSBjorn Andersson Dual\ MPL/GPL| 65925a6d20ceSBjorn Andersson Proprietary 65935a6d20ceSBjorn Andersson }x; 65945a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 65955a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 65965a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 65975a6d20ceSBjorn Andersson } 65985a6d20ceSBjorn Andersson } 6599515a235eSJoe Perches } 660013214adfSAndy Whitcroft 660113214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 660213214adfSAndy Whitcroft # so just keep quiet. 660313214adfSAndy Whitcroft if ($#rawlines == -1) { 660413214adfSAndy Whitcroft exit(0); 66050a920b5bSAndy Whitcroft } 66060a920b5bSAndy Whitcroft 66078905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 66088905a67cSAndy Whitcroft # things that appear to be patches. 66098905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 66108905a67cSAndy Whitcroft exit(0); 66118905a67cSAndy Whitcroft } 66128905a67cSAndy Whitcroft 66138905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 66148905a67cSAndy Whitcroft # just keep quiet. 66158905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 66168905a67cSAndy Whitcroft exit(0); 66178905a67cSAndy Whitcroft } 66188905a67cSAndy Whitcroft 6619a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 6620000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6621000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 66220a920b5bSAndy Whitcroft } 6623cd261496SGeert Uytterhoeven if ($is_patch && $has_commit_log && $chk_signoff) { 6624cd261496SGeert Uytterhoeven if ($signoff == 0) { 6625000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6626000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 6627cd261496SGeert Uytterhoeven } elsif (!$authorsignoff) { 6628cd261496SGeert Uytterhoeven WARN("NO_AUTHOR_SIGN_OFF", 6629cd261496SGeert Uytterhoeven "Missing Signed-off-by: line by nominal patch author '$author'\n"); 6630cd261496SGeert Uytterhoeven } 66310a920b5bSAndy Whitcroft } 66320a920b5bSAndy Whitcroft 6633f0a594c1SAndy Whitcroft print report_dump(); 663413214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 663513214adfSAndy Whitcroft print "$filename " if ($summary_file); 66366c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 66376c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 66386c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 66396c72ffaaSAndy Whitcroft } 66408905a67cSAndy Whitcroft 6641d2c0a235SAndy Whitcroft if ($quiet == 0) { 6642ef212196SJoe Perches # If there were any defects found and not already fixing them 6643ef212196SJoe Perches if (!$clean and !$fix) { 6644ef212196SJoe Perches print << "EOM" 6645ef212196SJoe Perches 6646ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 6647ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 6648ef212196SJoe PerchesEOM 6649ef212196SJoe Perches } 6650d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 6651d2c0a235SAndy Whitcroft # then suggest that. 6652d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 6653b0781216SMike Frysinger $rpt_cleaners = 0; 6654d8469f16SJoe Perches print << "EOM" 6655d8469f16SJoe Perches 6656d8469f16SJoe PerchesNOTE: Whitespace errors detected. 6657d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 6658d8469f16SJoe PerchesEOM 6659d2c0a235SAndy Whitcroft } 6660d2c0a235SAndy Whitcroft } 6661d2c0a235SAndy Whitcroft 6662d752fcc8SJoe Perches if ($clean == 0 && $fix && 6663d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 6664d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 66659624b8d6SJoe Perches my $newfile = $filename; 66669624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 66673705ce5bSJoe Perches my $linecount = 0; 66683705ce5bSJoe Perches my $f; 66693705ce5bSJoe Perches 6670d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 6671d752fcc8SJoe Perches 66723705ce5bSJoe Perches open($f, '>', $newfile) 66733705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 66743705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 66753705ce5bSJoe Perches $linecount++; 66763705ce5bSJoe Perches if ($file) { 66773705ce5bSJoe Perches if ($linecount > 3) { 66783705ce5bSJoe Perches $fixed_line =~ s/^\+//; 66793705ce5bSJoe Perches print $f $fixed_line . "\n"; 66803705ce5bSJoe Perches } 66813705ce5bSJoe Perches } else { 66823705ce5bSJoe Perches print $f $fixed_line . "\n"; 66833705ce5bSJoe Perches } 66843705ce5bSJoe Perches } 66853705ce5bSJoe Perches close($f); 66863705ce5bSJoe Perches 66873705ce5bSJoe Perches if (!$quiet) { 66883705ce5bSJoe Perches print << "EOM"; 6689d8469f16SJoe Perches 66903705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 66913705ce5bSJoe Perches 66923705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 66933705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 66943705ce5bSJoe Perches 66953705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 66963705ce5bSJoe PerchesNo warranties, expressed or implied... 66973705ce5bSJoe PerchesEOM 66983705ce5bSJoe Perches } 66993705ce5bSJoe Perches } 67003705ce5bSJoe Perches 6701d8469f16SJoe Perches if ($quiet == 0) { 6702d8469f16SJoe Perches print "\n"; 6703d8469f16SJoe Perches if ($clean == 1) { 6704d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 6705d8469f16SJoe Perches } else { 6706d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 67070a920b5bSAndy Whitcroft } 67080a920b5bSAndy Whitcroft } 67090a920b5bSAndy Whitcroft return $clean; 67100a920b5bSAndy Whitcroft} 6711