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| 3836c72ffaaSAndy Whitcroft __kprobes| 3848716de38SJoe Perches $InitAttribute| 38524e1d81aSAndy Whitcroft ____cacheline_aligned| 38624e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 3875fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 3885fe3af11SAndy Whitcroft __weak 3896c72ffaaSAndy Whitcroft }x; 390c45dcabdSAndy Whitcroftour $Modifier; 39191cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 3926c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 3936c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 3946c72ffaaSAndy Whitcroft 39595e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 39695e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 39795e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 39895e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 3992435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 400c0a5c898SJoe Perchesour $String = qr{"[X\t]*"}; 401326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 402326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 403326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 40474349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 4052435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 406326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 407447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 40823f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 4096c72ffaaSAndy Whitcroftour $Operators = qr{ 4106c72ffaaSAndy Whitcroft <=|>=|==|!=| 4116c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 41223f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 4136c72ffaaSAndy Whitcroft }x; 4146c72ffaaSAndy Whitcroft 41591cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 41691cb5195SJoe Perches 417ab7e23f3SJoe Perchesour $BasicType; 4188905a67cSAndy Whitcroftour $NonptrType; 4191813087dSJoe Perchesour $NonptrTypeMisordered; 4208716de38SJoe Perchesour $NonptrTypeWithAttr; 4218905a67cSAndy Whitcroftour $Type; 4221813087dSJoe Perchesour $TypeMisordered; 4238905a67cSAndy Whitcroftour $Declare; 4241813087dSJoe Perchesour $DeclareMisordered; 4258905a67cSAndy Whitcroft 42615662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 42715662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 428171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 429171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 430171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 431171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 432171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 433171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 434171ae1a4SAndy Whitcroft}x; 435171ae1a4SAndy Whitcroft 43615662b3eSJoe Perchesour $UTF8 = qr{ 43715662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 43815662b3eSJoe Perches | $NON_ASCII_UTF8 43915662b3eSJoe Perches}x; 44015662b3eSJoe Perches 441e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 442021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 443021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 444021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 445021158b4SJoe Perches)}; 446e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 447fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 4488ed22cadSAndy Whitcroft atomic_t 4498ed22cadSAndy Whitcroft)}; 450e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 451e6176fa4SJoe Perches $typeC99Typedefs\b| 452e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 453e6176fa4SJoe Perches $typeKernelTypedefs\b 454e6176fa4SJoe Perches)}; 4558ed22cadSAndy Whitcroft 4566d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 4576d32f7a3SJoe Perches 458691e669bSJoe Perchesour $logFunctions = qr{(?x: 459758d7aadSMiles Chen printk(?:_ratelimited|_once|_deferred_once|_deferred|)| 4607d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 46187bd499aSJoe Perches TP_printk| 4626e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 463b0531722SJoe Perches panic| 46406668727SJoe Perches MODULE_[A-Z_]+| 46506668727SJoe Perches seq_vprintf|seq_printf|seq_puts 466691e669bSJoe Perches)}; 467691e669bSJoe Perches 46820112475SJoe Perchesour $signature_tags = qr{(?xi: 46920112475SJoe Perches Signed-off-by:| 47020112475SJoe Perches Acked-by:| 47120112475SJoe Perches Tested-by:| 47220112475SJoe Perches Reviewed-by:| 47320112475SJoe Perches Reported-by:| 4748543ae12SMugunthan V N Suggested-by:| 47520112475SJoe Perches To:| 47620112475SJoe Perches Cc: 47720112475SJoe Perches)}; 47820112475SJoe Perches 4791813087dSJoe Perchesour @typeListMisordered = ( 4801813087dSJoe Perches qr{char\s+(?:un)?signed}, 4811813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 4821813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 4831813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 4841813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 4851813087dSJoe Perches qr{short\s+(?:un)?signed}, 4861813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 4871813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 4881813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 4891813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 4901813087dSJoe Perches qr{int\s+(?:un)?signed}, 4911813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 4921813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 4931813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 4941813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 4951813087dSJoe Perches qr{long\s+(?:un)?signed}, 4961813087dSJoe Perches); 4971813087dSJoe Perches 4988905a67cSAndy Whitcroftour @typeList = ( 4998905a67cSAndy Whitcroft qr{void}, 5000c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 5010c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 5020c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 5030c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 5040c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 5050c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 5060c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 5070c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 5080c773d9dSJoe Perches qr{(?:un)?signed}, 5098905a67cSAndy Whitcroft qr{float}, 5108905a67cSAndy Whitcroft qr{double}, 5118905a67cSAndy Whitcroft qr{bool}, 5128905a67cSAndy Whitcroft qr{struct\s+$Ident}, 5138905a67cSAndy Whitcroft qr{union\s+$Ident}, 5148905a67cSAndy Whitcroft qr{enum\s+$Ident}, 5158905a67cSAndy Whitcroft qr{${Ident}_t}, 5168905a67cSAndy Whitcroft qr{${Ident}_handler}, 5178905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 5181813087dSJoe Perches @typeListMisordered, 5198905a67cSAndy Whitcroft); 520938224b5SJoe Perches 521938224b5SJoe Perchesour $C90_int_types = qr{(?x: 522938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 523938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 524938224b5SJoe Perches long\s+long\s+(?:un)?signed| 525938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 526938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 527938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 528938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 529938224b5SJoe Perches 530938224b5SJoe Perches long\s+int\s+(?:un)?signed| 531938224b5SJoe Perches long\s+(?:un)?signed\s+int| 532938224b5SJoe Perches long\s+(?:un)?signed| 533938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 534938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 535938224b5SJoe Perches int\s+long\s+(?:un)?signed| 536938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 537938224b5SJoe Perches 538938224b5SJoe Perches int\s+(?:un)?signed| 539938224b5SJoe Perches (?:(?:un)?signed\s+)?int 540938224b5SJoe Perches)}; 541938224b5SJoe Perches 542485ff23eSAlex Dowadour @typeListFile = (); 5438716de38SJoe Perchesour @typeListWithAttr = ( 5448716de38SJoe Perches @typeList, 5458716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 5468716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 5478716de38SJoe Perches); 5488716de38SJoe Perches 549c45dcabdSAndy Whitcroftour @modifierList = ( 550c45dcabdSAndy Whitcroft qr{fastcall}, 551c45dcabdSAndy Whitcroft); 552485ff23eSAlex Dowadour @modifierListFile = (); 5538905a67cSAndy Whitcroft 5542435880fSJoe Perchesour @mode_permission_funcs = ( 5552435880fSJoe Perches ["module_param", 3], 5562435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 5572435880fSJoe Perches ["module_param_array_named", 5], 5582435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 5592435880fSJoe Perches ["proc_create(?:_data|)", 2], 560459cf0aeSJoe Perches ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2], 561459cf0aeSJoe Perches ["IIO_DEV_ATTR_[A-Z_]+", 1], 562459cf0aeSJoe Perches ["SENSOR_(?:DEVICE_|)ATTR_2", 2], 563459cf0aeSJoe Perches ["SENSOR_TEMPLATE(?:_2|)", 3], 564459cf0aeSJoe Perches ["__ATTR", 2], 5652435880fSJoe Perches); 5662435880fSJoe Perches 567515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 568515a235eSJoe Perchesour $mode_perms_search = ""; 569515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 570515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 571515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 572515a235eSJoe Perches} 57300180468SJoe Perches$mode_perms_search = "(?:${mode_perms_search})"; 574515a235eSJoe Perches 575b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 576b392c64fSJoe Perches S_IWUGO | 577b392c64fSJoe Perches S_IWOTH | 578b392c64fSJoe Perches S_IRWXUGO | 579b392c64fSJoe Perches S_IALLUGO | 580b392c64fSJoe Perches 0[0-7][0-7][2367] 581b392c64fSJoe Perches}x; 582b392c64fSJoe Perches 583f90774e1SJoe Perchesour %mode_permission_string_types = ( 584f90774e1SJoe Perches "S_IRWXU" => 0700, 585f90774e1SJoe Perches "S_IRUSR" => 0400, 586f90774e1SJoe Perches "S_IWUSR" => 0200, 587f90774e1SJoe Perches "S_IXUSR" => 0100, 588f90774e1SJoe Perches "S_IRWXG" => 0070, 589f90774e1SJoe Perches "S_IRGRP" => 0040, 590f90774e1SJoe Perches "S_IWGRP" => 0020, 591f90774e1SJoe Perches "S_IXGRP" => 0010, 592f90774e1SJoe Perches "S_IRWXO" => 0007, 593f90774e1SJoe Perches "S_IROTH" => 0004, 594f90774e1SJoe Perches "S_IWOTH" => 0002, 595f90774e1SJoe Perches "S_IXOTH" => 0001, 596f90774e1SJoe Perches "S_IRWXUGO" => 0777, 597f90774e1SJoe Perches "S_IRUGO" => 0444, 598f90774e1SJoe Perches "S_IWUGO" => 0222, 599f90774e1SJoe Perches "S_IXUGO" => 0111, 600f90774e1SJoe Perches); 601f90774e1SJoe Perches 602f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below 603f90774e1SJoe Perchesour $mode_perms_string_search = ""; 604f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) { 605f90774e1SJoe Perches $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); 606f90774e1SJoe Perches $mode_perms_string_search .= $entry; 607f90774e1SJoe Perches} 60800180468SJoe Perchesour $single_mode_perms_string_search = "(?:${mode_perms_string_search})"; 60900180468SJoe Perchesour $multi_mode_perms_string_search = qr{ 61000180468SJoe Perches ${single_mode_perms_string_search} 61100180468SJoe Perches (?:\s*\|\s*${single_mode_perms_string_search})* 61200180468SJoe Perches}x; 61300180468SJoe Perches 61400180468SJoe Perchessub perms_to_octal { 61500180468SJoe Perches my ($string) = @_; 61600180468SJoe Perches 61700180468SJoe Perches return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/); 61800180468SJoe Perches 61900180468SJoe Perches my $val = ""; 62000180468SJoe Perches my $oval = ""; 62100180468SJoe Perches my $to = 0; 62200180468SJoe Perches my $curpos = 0; 62300180468SJoe Perches my $lastpos = 0; 62400180468SJoe Perches while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) { 62500180468SJoe Perches $curpos = pos($string); 62600180468SJoe Perches my $match = $2; 62700180468SJoe Perches my $omatch = $1; 62800180468SJoe Perches last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos)); 62900180468SJoe Perches $lastpos = $curpos; 63000180468SJoe Perches $to |= $mode_permission_string_types{$match}; 63100180468SJoe Perches $val .= '\s*\|\s*' if ($val ne ""); 63200180468SJoe Perches $val .= $match; 63300180468SJoe Perches $oval .= $omatch; 63400180468SJoe Perches } 63500180468SJoe Perches $oval =~ s/^\s*\|\s*//; 63600180468SJoe Perches $oval =~ s/\s*\|\s*$//; 63700180468SJoe Perches return sprintf("%04o", $to); 63800180468SJoe Perches} 639f90774e1SJoe Perches 6407840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 6417840a94cSWolfram Sang irq| 642cdcee686SSergey Ryazanov memory| 643cdcee686SSergey Ryazanov time| 644cdcee686SSergey Ryazanov reboot 6457840a94cSWolfram Sang)}; 6467840a94cSWolfram Sang# memory.h: ARM has a custom one 6477840a94cSWolfram Sang 64866b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 64966b47b4aSKees Cookmy $misspellings; 65066b47b4aSKees Cookmy %spelling_fix; 65136061e38SJoe Perches 65236061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 65366b47b4aSKees Cook while (<$spelling>) { 65466b47b4aSKees Cook my $line = $_; 65566b47b4aSKees Cook 65666b47b4aSKees Cook $line =~ s/\s*\n?$//g; 65766b47b4aSKees Cook $line =~ s/^\s*//g; 65866b47b4aSKees Cook 65966b47b4aSKees Cook next if ($line =~ m/^\s*#/); 66066b47b4aSKees Cook next if ($line =~ m/^\s*$/); 66166b47b4aSKees Cook 66266b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 66366b47b4aSKees Cook 66466b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 66566b47b4aSKees Cook } 66666b47b4aSKees Cook close($spelling); 66736061e38SJoe Perches} else { 66836061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 66936061e38SJoe Perches} 67066b47b4aSKees Cook 671ebfd7d62SJoe Perchesif ($codespell) { 672ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 673ebfd7d62SJoe Perches while (<$spelling>) { 674ebfd7d62SJoe Perches my $line = $_; 675ebfd7d62SJoe Perches 676ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 677ebfd7d62SJoe Perches $line =~ s/^\s*//g; 678ebfd7d62SJoe Perches 679ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 680ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 681ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 682ebfd7d62SJoe Perches 683ebfd7d62SJoe Perches $line =~ s/,.*$//; 684ebfd7d62SJoe Perches 685ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 686ebfd7d62SJoe Perches 687ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 688ebfd7d62SJoe Perches } 689ebfd7d62SJoe Perches close($spelling); 690ebfd7d62SJoe Perches } else { 691ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 692ebfd7d62SJoe Perches } 693ebfd7d62SJoe Perches} 694ebfd7d62SJoe Perches 695ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 696ebfd7d62SJoe Perches 69775ad8c57SJerome Forissiersub read_words { 69875ad8c57SJerome Forissier my ($wordsRef, $file) = @_; 69975ad8c57SJerome Forissier 70075ad8c57SJerome Forissier if (open(my $words, '<', $file)) { 70175ad8c57SJerome Forissier while (<$words>) { 702bf1fa1daSJoe Perches my $line = $_; 703bf1fa1daSJoe Perches 704bf1fa1daSJoe Perches $line =~ s/\s*\n?$//g; 705bf1fa1daSJoe Perches $line =~ s/^\s*//g; 706bf1fa1daSJoe Perches 707bf1fa1daSJoe Perches next if ($line =~ m/^\s*#/); 708bf1fa1daSJoe Perches next if ($line =~ m/^\s*$/); 709bf1fa1daSJoe Perches if ($line =~ /\s/) { 71075ad8c57SJerome Forissier print("$file: '$line' invalid - ignored\n"); 711bf1fa1daSJoe Perches next; 712bf1fa1daSJoe Perches } 713bf1fa1daSJoe Perches 71475ad8c57SJerome Forissier $$wordsRef .= '|' if ($$wordsRef ne ""); 71575ad8c57SJerome Forissier $$wordsRef .= $line; 716bf1fa1daSJoe Perches } 71775ad8c57SJerome Forissier close($file); 71875ad8c57SJerome Forissier return 1; 719bf1fa1daSJoe Perches } 720bf1fa1daSJoe Perches 72175ad8c57SJerome Forissier return 0; 72275ad8c57SJerome Forissier} 72375ad8c57SJerome Forissier 72475ad8c57SJerome Forissiermy $const_structs = ""; 72575ad8c57SJerome Forissierread_words(\$const_structs, $conststructsfile) 72675ad8c57SJerome Forissier or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 72775ad8c57SJerome Forissier 72875ad8c57SJerome Forissiermy $typeOtherTypedefs = ""; 72975ad8c57SJerome Forissierif (length($typedefsfile)) { 73075ad8c57SJerome Forissier read_words(\$typeOtherTypedefs, $typedefsfile) 73175ad8c57SJerome Forissier or warn "No additional types will be considered - file '$typedefsfile': $!\n"; 73275ad8c57SJerome Forissier} 73375ad8c57SJerome Forissier$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne ""); 73475ad8c57SJerome Forissier 7358905a67cSAndy Whitcroftsub build_types { 736485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 737485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 7381813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 7398716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 740c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 741ab7e23f3SJoe Perches $BasicType = qr{ 742ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 743ab7e23f3SJoe Perches (?:${all}\b) 744ab7e23f3SJoe Perches }x; 7458905a67cSAndy Whitcroft $NonptrType = qr{ 746d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 747cf655043SAndy Whitcroft (?: 7486b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 7498ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 750c45dcabdSAndy Whitcroft (?:${all}\b) 751cf655043SAndy Whitcroft ) 752c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 7538905a67cSAndy Whitcroft }x; 7541813087dSJoe Perches $NonptrTypeMisordered = qr{ 7551813087dSJoe Perches (?:$Modifier\s+|const\s+)* 7561813087dSJoe Perches (?: 7571813087dSJoe Perches (?:${Misordered}\b) 7581813087dSJoe Perches ) 7591813087dSJoe Perches (?:\s+$Modifier|\s+const)* 7601813087dSJoe Perches }x; 7618716de38SJoe Perches $NonptrTypeWithAttr = qr{ 7628716de38SJoe Perches (?:$Modifier\s+|const\s+)* 7638716de38SJoe Perches (?: 7648716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 7658716de38SJoe Perches (?:$typeTypedefs\b)| 7668716de38SJoe Perches (?:${allWithAttr}\b) 7678716de38SJoe Perches ) 7688716de38SJoe Perches (?:\s+$Modifier|\s+const)* 7698716de38SJoe Perches }x; 7708905a67cSAndy Whitcroft $Type = qr{ 771c45dcabdSAndy Whitcroft $NonptrType 7721574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 773c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 7748905a67cSAndy Whitcroft }x; 7751813087dSJoe Perches $TypeMisordered = qr{ 7761813087dSJoe Perches $NonptrTypeMisordered 7771813087dSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 7781813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 7791813087dSJoe Perches }x; 78091cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 7811813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 7828905a67cSAndy Whitcroft} 7838905a67cSAndy Whitcroftbuild_types(); 7846c72ffaaSAndy Whitcroft 7857d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 786d1fe9c09SJoe Perches 787d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 788d1fe9c09SJoe Perches# requires at least perl version v5.10.0 789d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 790d1fe9c09SJoe Perches 791d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 7922435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 793c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 7947d2367afSJoe Perches 795f8422308SJoe Perchesour $declaration_macros = qr{(?x: 7963e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 797fe658f94SSteffen Maier (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(| 7983d102fc0SGilad Ben-Yossef (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(| 7993d102fc0SGilad Ben-Yossef (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\( 800f8422308SJoe Perches)}; 801f8422308SJoe Perches 8027d2367afSJoe Perchessub deparenthesize { 8037d2367afSJoe Perches my ($string) = @_; 8047d2367afSJoe Perches return "" if (!defined($string)); 8055b9553abSJoe Perches 8065b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 8075b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 8085b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 8095b9553abSJoe Perches } 8105b9553abSJoe Perches 8117d2367afSJoe Perches $string =~ s@\s+@ @g; 8125b9553abSJoe Perches 8137d2367afSJoe Perches return $string; 8147d2367afSJoe Perches} 8157d2367afSJoe Perches 8163445686aSJoe Perchessub seed_camelcase_file { 8173445686aSJoe Perches my ($file) = @_; 8183445686aSJoe Perches 8193445686aSJoe Perches return if (!(-f $file)); 8203445686aSJoe Perches 8213445686aSJoe Perches local $/; 8223445686aSJoe Perches 8233445686aSJoe Perches open(my $include_file, '<', "$file") 8243445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 8253445686aSJoe Perches my $text = <$include_file>; 8263445686aSJoe Perches close($include_file); 8273445686aSJoe Perches 8283445686aSJoe Perches my @lines = split('\n', $text); 8293445686aSJoe Perches 8303445686aSJoe Perches foreach my $line (@lines) { 8313445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 8323445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 8333445686aSJoe Perches $camelcase{$1} = 1; 83411ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 83511ea516aSJoe Perches $camelcase{$1} = 1; 83611ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 8373445686aSJoe Perches $camelcase{$1} = 1; 8383445686aSJoe Perches } 8393445686aSJoe Perches } 8403445686aSJoe Perches} 8413445686aSJoe Perches 84285b0ee18SJoe Perchessub is_maintained_obsolete { 84385b0ee18SJoe Perches my ($filename) = @_; 84485b0ee18SJoe Perches 845f2c19c2fSJerome Forissier return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 84685b0ee18SJoe Perches 8470616efa4SJoe Perches my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 84885b0ee18SJoe Perches 84985b0ee18SJoe Perches return $status =~ /obsolete/i; 85085b0ee18SJoe Perches} 85185b0ee18SJoe Perches 8523b6e8ac9SJoe Perchessub is_SPDX_License_valid { 8533b6e8ac9SJoe Perches my ($license) = @_; 8543b6e8ac9SJoe Perches 85556294112SJoe Perches return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git")); 8563b6e8ac9SJoe Perches 85756294112SJoe Perches my $root_path = abs_path($root); 85856294112SJoe Perches my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`; 8593b6e8ac9SJoe Perches return 0 if ($status ne ""); 8603b6e8ac9SJoe Perches return 1; 8613b6e8ac9SJoe Perches} 8623b6e8ac9SJoe Perches 8633445686aSJoe Perchesmy $camelcase_seeded = 0; 8643445686aSJoe Perchessub seed_camelcase_includes { 8653445686aSJoe Perches return if ($camelcase_seeded); 8663445686aSJoe Perches 8673445686aSJoe Perches my $files; 868c707a81dSJoe Perches my $camelcase_cache = ""; 869c707a81dSJoe Perches my @include_files = (); 870c707a81dSJoe Perches 871c707a81dSJoe Perches $camelcase_seeded = 1; 872351b2a1fSJoe Perches 8733645e328SRichard Genoud if (-e ".git") { 874351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 875351b2a1fSJoe Perches chomp $git_last_include_commit; 876c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 877c707a81dSJoe Perches } else { 878c707a81dSJoe Perches my $last_mod_date = 0; 879c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 880c707a81dSJoe Perches @include_files = split('\n', $files); 881c707a81dSJoe Perches foreach my $file (@include_files) { 882c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 883c707a81dSJoe Perches localtime((stat $file)[9])); 884c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 885c707a81dSJoe Perches } 886c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 887c707a81dSJoe Perches } 888c707a81dSJoe Perches 889c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 890c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 891c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 892351b2a1fSJoe Perches while (<$camelcase_file>) { 893351b2a1fSJoe Perches chomp; 894351b2a1fSJoe Perches $camelcase{$_} = 1; 895351b2a1fSJoe Perches } 896351b2a1fSJoe Perches close($camelcase_file); 897351b2a1fSJoe Perches 898351b2a1fSJoe Perches return; 899351b2a1fSJoe Perches } 900c707a81dSJoe Perches 9013645e328SRichard Genoud if (-e ".git") { 902c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 903c707a81dSJoe Perches @include_files = split('\n', $files); 9043445686aSJoe Perches } 905c707a81dSJoe Perches 9063445686aSJoe Perches foreach my $file (@include_files) { 9073445686aSJoe Perches seed_camelcase_file($file); 9083445686aSJoe Perches } 909351b2a1fSJoe Perches 910c707a81dSJoe Perches if ($camelcase_cache ne "") { 911351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 912c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 913c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 914351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 915351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 916351b2a1fSJoe Perches } 917351b2a1fSJoe Perches close($camelcase_file); 918351b2a1fSJoe Perches } 9193445686aSJoe Perches} 9203445686aSJoe Perches 921d311cd44SJoe Perchessub git_commit_info { 922d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 923d311cd44SJoe Perches 924d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 925d311cd44SJoe Perches 926d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 927d311cd44SJoe Perches $output =~ s/^\s*//gm; 928d311cd44SJoe Perches my @lines = split("\n", $output); 929d311cd44SJoe Perches 9300d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 9310d7835fcSJoe Perches 932d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 933d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 934d311cd44SJoe Perches# all matching commit ids, but it's very slow... 935d311cd44SJoe Perches# 936d311cd44SJoe Perches# echo "checking commits $1..." 937d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 938d311cd44SJoe Perches# while read line ; do 939d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 940d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 941d311cd44SJoe Perches# done 942d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 943948b133aSHeinrich Schuchardt $id = undef; 944d311cd44SJoe Perches } else { 945d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 946d311cd44SJoe Perches $desc = substr($lines[0], 41); 947d311cd44SJoe Perches } 948d311cd44SJoe Perches 949d311cd44SJoe Perches return ($id, $desc); 950d311cd44SJoe Perches} 951d311cd44SJoe Perches 9526c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 9530a920b5bSAndy Whitcroft 95400df344fSAndy Whitcroftmy @rawlines = (); 955c2fdda0dSAndy Whitcroftmy @lines = (); 9563705ce5bSJoe Perchesmy @fixed = (); 957d752fcc8SJoe Perchesmy @fixed_inserted = (); 958d752fcc8SJoe Perchesmy @fixed_deleted = (); 959194f66fcSJoe Perchesmy $fixlinenr = -1; 960194f66fcSJoe Perches 9614a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 9624a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 9634a593c34SDu, Changbindie "$P: No git repository found\n" if ($git && !-e ".git"); 9644a593c34SDu, Changbin 9654a593c34SDu, Changbinif ($git) { 9664a593c34SDu, Changbin my @commits = (); 9670dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 9684a593c34SDu, Changbin my $git_range; 96928898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 97028898fd1SJoe Perches $git_range = "-$2 $1"; 9714a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 9724a593c34SDu, Changbin $git_range = "$commit_expr"; 9734a593c34SDu, Changbin } else { 9740dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 9750dea9f1eSJoe Perches } 9760dea9f1eSJoe Perches my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 9770dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 97828898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 97928898fd1SJoe Perches next if (!defined($1) || !defined($2)); 9800dea9f1eSJoe Perches my $sha1 = $1; 9810dea9f1eSJoe Perches my $subject = $2; 9820dea9f1eSJoe Perches unshift(@commits, $sha1); 9830dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 9844a593c34SDu, Changbin } 9854a593c34SDu, Changbin } 9864a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 9874a593c34SDu, Changbin @ARGV = @commits; 9884a593c34SDu, Changbin} 9894a593c34SDu, Changbin 990c2fdda0dSAndy Whitcroftmy $vname; 9916c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 99221caa13cSAndy Whitcroft my $FILE; 9934a593c34SDu, Changbin if ($git) { 9944a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 9954a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 9964a593c34SDu, Changbin } elsif ($file) { 99721caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 9986c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 99921caa13cSAndy Whitcroft } elsif ($filename eq '-') { 100021caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 10016c72ffaaSAndy Whitcroft } else { 100221caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 10036c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 10046c72ffaaSAndy Whitcroft } 1005c2fdda0dSAndy Whitcroft if ($filename eq '-') { 1006c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 10074a593c34SDu, Changbin } elsif ($git) { 10080dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 1009c2fdda0dSAndy Whitcroft } else { 1010c2fdda0dSAndy Whitcroft $vname = $filename; 1011c2fdda0dSAndy Whitcroft } 101221caa13cSAndy Whitcroft while (<$FILE>) { 10130a920b5bSAndy Whitcroft chomp; 101400df344fSAndy Whitcroft push(@rawlines, $_); 10156c72ffaaSAndy Whitcroft } 101621caa13cSAndy Whitcroft close($FILE); 1017d8469f16SJoe Perches 1018d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 1019d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1020d8469f16SJoe Perches print "$vname\n"; 1021d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1022d8469f16SJoe Perches } 1023d8469f16SJoe Perches 1024c2fdda0dSAndy Whitcroft if (!process($filename)) { 10250a920b5bSAndy Whitcroft $exit = 1; 10260a920b5bSAndy Whitcroft } 102700df344fSAndy Whitcroft @rawlines = (); 102813214adfSAndy Whitcroft @lines = (); 10293705ce5bSJoe Perches @fixed = (); 1030d752fcc8SJoe Perches @fixed_inserted = (); 1031d752fcc8SJoe Perches @fixed_deleted = (); 1032194f66fcSJoe Perches $fixlinenr = -1; 1033485ff23eSAlex Dowad @modifierListFile = (); 1034485ff23eSAlex Dowad @typeListFile = (); 1035485ff23eSAlex Dowad build_types(); 10360a920b5bSAndy Whitcroft} 10370a920b5bSAndy Whitcroft 1038d8469f16SJoe Perchesif (!$quiet) { 10393c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 10403c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 10413c816e49SJoe Perches 10425b57980dSJoe Perches if (!$perl_version_ok) { 1043d8469f16SJoe Perches print << "EOM" 1044d8469f16SJoe Perches 1045d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 10465b57980dSJoe Perches An upgrade to at least perl $minimum_perl_version is suggested. 1047d8469f16SJoe PerchesEOM 1048d8469f16SJoe Perches } 1049d8469f16SJoe Perches if ($exit) { 1050d8469f16SJoe Perches print << "EOM" 1051d8469f16SJoe Perches 1052d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 1053d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 1054d8469f16SJoe PerchesEOM 1055d8469f16SJoe Perches } 1056d8469f16SJoe Perches} 1057d8469f16SJoe Perches 10580a920b5bSAndy Whitcroftexit($exit); 10590a920b5bSAndy Whitcroft 10600a920b5bSAndy Whitcroftsub top_of_kernel_tree { 10616c72ffaaSAndy Whitcroft my ($root) = @_; 10626c72ffaaSAndy Whitcroft 10636c72ffaaSAndy Whitcroft my @tree_check = ( 10646c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 10656c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 10666c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 10676c72ffaaSAndy Whitcroft ); 10686c72ffaaSAndy Whitcroft 10696c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 10706c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 10710a920b5bSAndy Whitcroft return 0; 10720a920b5bSAndy Whitcroft } 10736c72ffaaSAndy Whitcroft } 10746c72ffaaSAndy Whitcroft return 1; 10756c72ffaaSAndy Whitcroft} 10760a920b5bSAndy Whitcroft 107720112475SJoe Perchessub parse_email { 107820112475SJoe Perches my ($formatted_email) = @_; 107920112475SJoe Perches 108020112475SJoe Perches my $name = ""; 108120112475SJoe Perches my $address = ""; 108220112475SJoe Perches my $comment = ""; 108320112475SJoe Perches 108420112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 108520112475SJoe Perches $name = $1; 108620112475SJoe Perches $address = $2; 108720112475SJoe Perches $comment = $3 if defined $3; 108820112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 108920112475SJoe Perches $address = $1; 109020112475SJoe Perches $comment = $2 if defined $2; 109120112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 109220112475SJoe Perches $address = $1; 109320112475SJoe Perches $comment = $2 if defined $2; 109485e12066SJoe Perches $formatted_email =~ s/\Q$address\E.*$//; 109520112475SJoe Perches $name = $formatted_email; 10963705ce5bSJoe Perches $name = trim($name); 109720112475SJoe Perches $name =~ s/^\"|\"$//g; 109820112475SJoe Perches # If there's a name left after stripping spaces and 109920112475SJoe Perches # leading quotes, and the address doesn't have both 110020112475SJoe Perches # leading and trailing angle brackets, the address 110120112475SJoe Perches # is invalid. ie: 110220112475SJoe Perches # "joe smith [email protected]" bad 110320112475SJoe Perches # "joe smith <[email protected]" bad 110420112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 110520112475SJoe Perches $name = ""; 110620112475SJoe Perches $address = ""; 110720112475SJoe Perches $comment = ""; 110820112475SJoe Perches } 110920112475SJoe Perches } 111020112475SJoe Perches 11113705ce5bSJoe Perches $name = trim($name); 111220112475SJoe Perches $name =~ s/^\"|\"$//g; 11133705ce5bSJoe Perches $address = trim($address); 111420112475SJoe Perches $address =~ s/^\<|\>$//g; 111520112475SJoe Perches 111620112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 111720112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 111820112475SJoe Perches $name = "\"$name\""; 111920112475SJoe Perches } 112020112475SJoe Perches 112120112475SJoe Perches return ($name, $address, $comment); 112220112475SJoe Perches} 112320112475SJoe Perches 112420112475SJoe Perchessub format_email { 112520112475SJoe Perches my ($name, $address) = @_; 112620112475SJoe Perches 112720112475SJoe Perches my $formatted_email; 112820112475SJoe Perches 11293705ce5bSJoe Perches $name = trim($name); 113020112475SJoe Perches $name =~ s/^\"|\"$//g; 11313705ce5bSJoe Perches $address = trim($address); 113220112475SJoe Perches 113320112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 113420112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 113520112475SJoe Perches $name = "\"$name\""; 113620112475SJoe Perches } 113720112475SJoe Perches 113820112475SJoe Perches if ("$name" eq "") { 113920112475SJoe Perches $formatted_email = "$address"; 114020112475SJoe Perches } else { 114120112475SJoe Perches $formatted_email = "$name <$address>"; 114220112475SJoe Perches } 114320112475SJoe Perches 114420112475SJoe Perches return $formatted_email; 114520112475SJoe Perches} 114620112475SJoe Perches 1147d311cd44SJoe Perchessub which { 1148d311cd44SJoe Perches my ($bin) = @_; 1149d311cd44SJoe Perches 1150d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1151d311cd44SJoe Perches if (-e "$path/$bin") { 1152d311cd44SJoe Perches return "$path/$bin"; 1153d311cd44SJoe Perches } 1154d311cd44SJoe Perches } 1155d311cd44SJoe Perches 1156d311cd44SJoe Perches return ""; 1157d311cd44SJoe Perches} 1158d311cd44SJoe Perches 1159000d1cc1SJoe Perchessub which_conf { 1160000d1cc1SJoe Perches my ($conf) = @_; 1161000d1cc1SJoe Perches 1162000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1163000d1cc1SJoe Perches if (-e "$path/$conf") { 1164000d1cc1SJoe Perches return "$path/$conf"; 1165000d1cc1SJoe Perches } 1166000d1cc1SJoe Perches } 1167000d1cc1SJoe Perches 1168000d1cc1SJoe Perches return ""; 1169000d1cc1SJoe Perches} 1170000d1cc1SJoe Perches 11710a920b5bSAndy Whitcroftsub expand_tabs { 11720a920b5bSAndy Whitcroft my ($str) = @_; 11730a920b5bSAndy Whitcroft 11740a920b5bSAndy Whitcroft my $res = ''; 11750a920b5bSAndy Whitcroft my $n = 0; 11760a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 11770a920b5bSAndy Whitcroft if ($c eq "\t") { 11780a920b5bSAndy Whitcroft $res .= ' '; 11790a920b5bSAndy Whitcroft $n++; 11800a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 11810a920b5bSAndy Whitcroft $res .= ' '; 11820a920b5bSAndy Whitcroft } 11830a920b5bSAndy Whitcroft next; 11840a920b5bSAndy Whitcroft } 11850a920b5bSAndy Whitcroft $res .= $c; 11860a920b5bSAndy Whitcroft $n++; 11870a920b5bSAndy Whitcroft } 11880a920b5bSAndy Whitcroft 11890a920b5bSAndy Whitcroft return $res; 11900a920b5bSAndy Whitcroft} 11916c72ffaaSAndy Whitcroftsub copy_spacing { 1192773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 11936c72ffaaSAndy Whitcroft return $res; 11946c72ffaaSAndy Whitcroft} 11950a920b5bSAndy Whitcroft 11964a0df2efSAndy Whitcroftsub line_stats { 11974a0df2efSAndy Whitcroft my ($line) = @_; 11984a0df2efSAndy Whitcroft 11994a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 12004a0df2efSAndy Whitcroft $line =~ s/^.//; 12014a0df2efSAndy Whitcroft $line = expand_tabs($line); 12024a0df2efSAndy Whitcroft 12034a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 12044a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 12054a0df2efSAndy Whitcroft 12064a0df2efSAndy Whitcroft return (length($line), length($white)); 12074a0df2efSAndy Whitcroft} 12084a0df2efSAndy Whitcroft 1209773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1210773647a0SAndy Whitcroft 1211773647a0SAndy Whitcroftsub sanitise_line_reset { 1212773647a0SAndy Whitcroft my ($in_comment) = @_; 1213773647a0SAndy Whitcroft 1214773647a0SAndy Whitcroft if ($in_comment) { 1215773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1216773647a0SAndy Whitcroft } else { 1217773647a0SAndy Whitcroft $sanitise_quote = ''; 1218773647a0SAndy Whitcroft } 1219773647a0SAndy Whitcroft} 122000df344fSAndy Whitcroftsub sanitise_line { 122100df344fSAndy Whitcroft my ($line) = @_; 122200df344fSAndy Whitcroft 122300df344fSAndy Whitcroft my $res = ''; 122400df344fSAndy Whitcroft my $l = ''; 122500df344fSAndy Whitcroft 1226c2fdda0dSAndy Whitcroft my $qlen = 0; 1227773647a0SAndy Whitcroft my $off = 0; 1228773647a0SAndy Whitcroft my $c; 122900df344fSAndy Whitcroft 1230773647a0SAndy Whitcroft # Always copy over the diff marker. 1231773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1232773647a0SAndy Whitcroft 1233773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1234773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1235773647a0SAndy Whitcroft 12368d2e11b2SClaudio Fontana # Comments we are whacking completely including the begin 1237773647a0SAndy Whitcroft # and end, all to $;. 1238773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1239773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1240773647a0SAndy Whitcroft 1241773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1242773647a0SAndy Whitcroft $off++; 124300df344fSAndy Whitcroft next; 1244773647a0SAndy Whitcroft } 124581bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1246773647a0SAndy Whitcroft $sanitise_quote = ''; 1247773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1248773647a0SAndy Whitcroft $off++; 1249773647a0SAndy Whitcroft next; 1250773647a0SAndy Whitcroft } 1251113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1252113f04a8SDaniel Walker $sanitise_quote = '//'; 1253113f04a8SDaniel Walker 1254113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1255113f04a8SDaniel Walker $off++; 1256113f04a8SDaniel Walker next; 1257113f04a8SDaniel Walker } 1258773647a0SAndy Whitcroft 1259773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1260773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1261773647a0SAndy Whitcroft $c eq "\\") { 1262773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1263773647a0SAndy Whitcroft $off++; 1264773647a0SAndy Whitcroft next; 1265773647a0SAndy Whitcroft } 1266773647a0SAndy Whitcroft # Regular quotes. 1267773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1268773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1269773647a0SAndy Whitcroft $sanitise_quote = $c; 1270773647a0SAndy Whitcroft 1271773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1272773647a0SAndy Whitcroft next; 1273773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1274773647a0SAndy Whitcroft $sanitise_quote = ''; 127500df344fSAndy Whitcroft } 127600df344fSAndy Whitcroft } 1277773647a0SAndy Whitcroft 1278fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1279773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1280773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1281113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1282113f04a8SDaniel Walker substr($res, $off, 1, $;); 1283773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1284773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 128500df344fSAndy Whitcroft } else { 1286773647a0SAndy Whitcroft substr($res, $off, 1, $c); 128700df344fSAndy Whitcroft } 1288c2fdda0dSAndy Whitcroft } 1289c2fdda0dSAndy Whitcroft 1290113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1291113f04a8SDaniel Walker $sanitise_quote = ''; 1292113f04a8SDaniel Walker } 1293113f04a8SDaniel Walker 1294c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1295c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1296c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1297c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1298c2fdda0dSAndy Whitcroft 1299c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1300c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1301c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1302c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1303c2fdda0dSAndy Whitcroft } 1304c2fdda0dSAndy Whitcroft 1305dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1306dadf680dSJoe Perches my $match = $1; 1307dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1308dadf680dSJoe Perches } 1309dadf680dSJoe Perches 131000df344fSAndy Whitcroft return $res; 131100df344fSAndy Whitcroft} 131200df344fSAndy Whitcroft 1313a6962d72SJoe Perchessub get_quoted_string { 1314a6962d72SJoe Perches my ($line, $rawline) = @_; 1315a6962d72SJoe Perches 1316478b1799SJoe Perches return "" if (!defined($line) || !defined($rawline)); 131733acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1318a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1319a6962d72SJoe Perches} 1320a6962d72SJoe Perches 13218905a67cSAndy Whitcroftsub ctx_statement_block { 13228905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 13238905a67cSAndy Whitcroft my $line = $linenr - 1; 13248905a67cSAndy Whitcroft my $blk = ''; 13258905a67cSAndy Whitcroft my $soff = $off; 13268905a67cSAndy Whitcroft my $coff = $off - 1; 1327773647a0SAndy Whitcroft my $coff_set = 0; 13288905a67cSAndy Whitcroft 132913214adfSAndy Whitcroft my $loff = 0; 133013214adfSAndy Whitcroft 13318905a67cSAndy Whitcroft my $type = ''; 13328905a67cSAndy Whitcroft my $level = 0; 1333a2750645SAndy Whitcroft my @stack = (); 1334cf655043SAndy Whitcroft my $p; 13358905a67cSAndy Whitcroft my $c; 13368905a67cSAndy Whitcroft my $len = 0; 133713214adfSAndy Whitcroft 133813214adfSAndy Whitcroft my $remainder; 13398905a67cSAndy Whitcroft while (1) { 1340a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1341a2750645SAndy Whitcroft 1342773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 13438905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 13448905a67cSAndy Whitcroft # context. 13458905a67cSAndy Whitcroft if ($off >= $len) { 13468905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1347dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1348c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 13498905a67cSAndy Whitcroft $remain--; 135013214adfSAndy Whitcroft $loff = $len; 1351c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 13528905a67cSAndy Whitcroft $len = length($blk); 13538905a67cSAndy Whitcroft $line++; 13548905a67cSAndy Whitcroft last; 13558905a67cSAndy Whitcroft } 13568905a67cSAndy Whitcroft # Bail if there is no further context. 13578905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 135813214adfSAndy Whitcroft if ($off >= $len) { 13598905a67cSAndy Whitcroft last; 13608905a67cSAndy Whitcroft } 1361f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1362f74bd194SAndy Whitcroft $level++; 1363f74bd194SAndy Whitcroft $type = '#'; 1364f74bd194SAndy Whitcroft } 13658905a67cSAndy Whitcroft } 1366cf655043SAndy Whitcroft $p = $c; 13678905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 136813214adfSAndy Whitcroft $remainder = substr($blk, $off); 13698905a67cSAndy Whitcroft 1370773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 13714635f4fbSAndy Whitcroft 13724635f4fbSAndy Whitcroft # Handle nested #if/#else. 13734635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 13744635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 13754635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 13764635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 13774635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 13784635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 13794635f4fbSAndy Whitcroft } 13804635f4fbSAndy Whitcroft 13818905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 13828905a67cSAndy Whitcroft # outermost level. 13838905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 13848905a67cSAndy Whitcroft last; 13858905a67cSAndy Whitcroft } 13868905a67cSAndy Whitcroft 138713214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1388773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1389773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1390773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1391773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1392773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1393773647a0SAndy Whitcroft $coff_set = 1; 1394773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1395773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 139613214adfSAndy Whitcroft } 139713214adfSAndy Whitcroft 13988905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 13998905a67cSAndy Whitcroft $level++; 14008905a67cSAndy Whitcroft $type = '('; 14018905a67cSAndy Whitcroft } 14028905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 14038905a67cSAndy Whitcroft $level--; 14048905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 14058905a67cSAndy Whitcroft 14068905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 14078905a67cSAndy Whitcroft $coff = $off; 1408773647a0SAndy Whitcroft $coff_set = 1; 1409773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 14108905a67cSAndy Whitcroft } 14118905a67cSAndy Whitcroft } 14128905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 14138905a67cSAndy Whitcroft $level++; 14148905a67cSAndy Whitcroft $type = '{'; 14158905a67cSAndy Whitcroft } 14168905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 14178905a67cSAndy Whitcroft $level--; 14188905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 14198905a67cSAndy Whitcroft 14208905a67cSAndy Whitcroft if ($level == 0) { 1421b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1422b998e001SPatrick Pannuto $off++; 1423b998e001SPatrick Pannuto } 14248905a67cSAndy Whitcroft last; 14258905a67cSAndy Whitcroft } 14268905a67cSAndy Whitcroft } 1427f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1428f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1429f74bd194SAndy Whitcroft $level--; 1430f74bd194SAndy Whitcroft $type = ''; 1431f74bd194SAndy Whitcroft $off++; 1432f74bd194SAndy Whitcroft last; 1433f74bd194SAndy Whitcroft } 14348905a67cSAndy Whitcroft $off++; 14358905a67cSAndy Whitcroft } 1436a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 143713214adfSAndy Whitcroft if ($off == $len) { 1438a3bb97a7SAndy Whitcroft $loff = $len + 1; 143913214adfSAndy Whitcroft $line++; 144013214adfSAndy Whitcroft $remain--; 144113214adfSAndy Whitcroft } 14428905a67cSAndy Whitcroft 14438905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 14448905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 14458905a67cSAndy Whitcroft 14468905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 14478905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 14488905a67cSAndy Whitcroft 1449773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 145013214adfSAndy Whitcroft 145113214adfSAndy Whitcroft return ($statement, $condition, 145213214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 145313214adfSAndy Whitcroft} 145413214adfSAndy Whitcroft 1455cf655043SAndy Whitcroftsub statement_lines { 1456cf655043SAndy Whitcroft my ($stmt) = @_; 1457cf655043SAndy Whitcroft 1458cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1459cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1460cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1461cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1462cf655043SAndy Whitcroft 1463cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1464cf655043SAndy Whitcroft 1465cf655043SAndy Whitcroft return $#stmt_lines + 2; 1466cf655043SAndy Whitcroft} 1467cf655043SAndy Whitcroft 1468cf655043SAndy Whitcroftsub statement_rawlines { 1469cf655043SAndy Whitcroft my ($stmt) = @_; 1470cf655043SAndy Whitcroft 1471cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1472cf655043SAndy Whitcroft 1473cf655043SAndy Whitcroft return $#stmt_lines + 2; 1474cf655043SAndy Whitcroft} 1475cf655043SAndy Whitcroft 1476cf655043SAndy Whitcroftsub statement_block_size { 1477cf655043SAndy Whitcroft my ($stmt) = @_; 1478cf655043SAndy Whitcroft 1479cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1480cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1481cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1482cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1483cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1484cf655043SAndy Whitcroft 1485cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1486cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1487cf655043SAndy Whitcroft 1488cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1489cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1490cf655043SAndy Whitcroft 1491cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1492cf655043SAndy Whitcroft return $stmt_lines; 1493cf655043SAndy Whitcroft } else { 1494cf655043SAndy Whitcroft return $stmt_statements; 1495cf655043SAndy Whitcroft } 1496cf655043SAndy Whitcroft} 1497cf655043SAndy Whitcroft 149813214adfSAndy Whitcroftsub ctx_statement_full { 149913214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 150013214adfSAndy Whitcroft my ($statement, $condition, $level); 150113214adfSAndy Whitcroft 150213214adfSAndy Whitcroft my (@chunks); 150313214adfSAndy Whitcroft 1504cf655043SAndy Whitcroft # Grab the first conditional/block pair. 150513214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 150613214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1507773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 150813214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1509cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1510cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1511cf655043SAndy Whitcroft } 1512cf655043SAndy Whitcroft 1513cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1514cf655043SAndy Whitcroft # could continue the statement. 1515cf655043SAndy Whitcroft for (;;) { 151613214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 151713214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1518cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1519773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1520cf655043SAndy Whitcroft #print "C: push\n"; 1521cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 152213214adfSAndy Whitcroft } 152313214adfSAndy Whitcroft 152413214adfSAndy Whitcroft return ($level, $linenr, @chunks); 15258905a67cSAndy Whitcroft} 15268905a67cSAndy Whitcroft 15274a0df2efSAndy Whitcroftsub ctx_block_get { 1528f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 15294a0df2efSAndy Whitcroft my $line; 15304a0df2efSAndy Whitcroft my $start = $linenr - 1; 15314a0df2efSAndy Whitcroft my $blk = ''; 15324a0df2efSAndy Whitcroft my @o; 15334a0df2efSAndy Whitcroft my @c; 15344a0df2efSAndy Whitcroft my @res = (); 15354a0df2efSAndy Whitcroft 1536f0a594c1SAndy Whitcroft my $level = 0; 15374635f4fbSAndy Whitcroft my @stack = ($level); 153800df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 153900df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 154000df344fSAndy Whitcroft $remain--; 154100df344fSAndy Whitcroft 154200df344fSAndy Whitcroft $blk .= $rawlines[$line]; 15434635f4fbSAndy Whitcroft 15444635f4fbSAndy Whitcroft # Handle nested #if/#else. 154501464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 15464635f4fbSAndy Whitcroft push(@stack, $level); 154701464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 15484635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 154901464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 15504635f4fbSAndy Whitcroft $level = pop(@stack); 15514635f4fbSAndy Whitcroft } 15524635f4fbSAndy Whitcroft 155301464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1554f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1555f0a594c1SAndy Whitcroft if ($off > 0) { 1556f0a594c1SAndy Whitcroft $off--; 1557f0a594c1SAndy Whitcroft next; 1558f0a594c1SAndy Whitcroft } 15594a0df2efSAndy Whitcroft 1560f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1561f0a594c1SAndy Whitcroft $level--; 1562f0a594c1SAndy Whitcroft last if ($level == 0); 1563f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1564f0a594c1SAndy Whitcroft $level++; 1565f0a594c1SAndy Whitcroft } 1566f0a594c1SAndy Whitcroft } 15674a0df2efSAndy Whitcroft 1568f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 156900df344fSAndy Whitcroft push(@res, $rawlines[$line]); 15704a0df2efSAndy Whitcroft } 15714a0df2efSAndy Whitcroft 1572f0a594c1SAndy Whitcroft last if ($level == 0); 15734a0df2efSAndy Whitcroft } 15744a0df2efSAndy Whitcroft 1575f0a594c1SAndy Whitcroft return ($level, @res); 15764a0df2efSAndy Whitcroft} 15774a0df2efSAndy Whitcroftsub ctx_block_outer { 15784a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 15794a0df2efSAndy Whitcroft 1580f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1581f0a594c1SAndy Whitcroft return @r; 15824a0df2efSAndy Whitcroft} 15834a0df2efSAndy Whitcroftsub ctx_block { 15844a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 15854a0df2efSAndy Whitcroft 1586f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1587f0a594c1SAndy Whitcroft return @r; 1588653d4876SAndy Whitcroft} 1589653d4876SAndy Whitcroftsub ctx_statement { 1590f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1591f0a594c1SAndy Whitcroft 1592f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1593f0a594c1SAndy Whitcroft return @r; 1594f0a594c1SAndy Whitcroft} 1595f0a594c1SAndy Whitcroftsub ctx_block_level { 1596653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1597653d4876SAndy Whitcroft 1598f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 15994a0df2efSAndy Whitcroft} 16009c0ca6f9SAndy Whitcroftsub ctx_statement_level { 16019c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 16029c0ca6f9SAndy Whitcroft 16039c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 16049c0ca6f9SAndy Whitcroft} 16054a0df2efSAndy Whitcroft 16064a0df2efSAndy Whitcroftsub ctx_locate_comment { 16074a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 16084a0df2efSAndy Whitcroft 16094a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1610beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 16114a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 16124a0df2efSAndy Whitcroft 16134a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 16144a0df2efSAndy Whitcroft # comment. 16154a0df2efSAndy Whitcroft my $in_comment = 0; 16164a0df2efSAndy Whitcroft $current_comment = ''; 16174a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 161800df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 161900df344fSAndy Whitcroft #warn " $line\n"; 16204a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 16214a0df2efSAndy Whitcroft $in_comment = 1; 16224a0df2efSAndy Whitcroft } 16234a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 16244a0df2efSAndy Whitcroft $in_comment = 1; 16254a0df2efSAndy Whitcroft } 16264a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 16274a0df2efSAndy Whitcroft $current_comment = ''; 16284a0df2efSAndy Whitcroft } 16294a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 16304a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 16314a0df2efSAndy Whitcroft $in_comment = 0; 16324a0df2efSAndy Whitcroft } 16334a0df2efSAndy Whitcroft } 16344a0df2efSAndy Whitcroft 16354a0df2efSAndy Whitcroft chomp($current_comment); 16364a0df2efSAndy Whitcroft return($current_comment); 16374a0df2efSAndy Whitcroft} 16384a0df2efSAndy Whitcroftsub ctx_has_comment { 16394a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 16404a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 16414a0df2efSAndy Whitcroft 164200df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 16434a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 16444a0df2efSAndy Whitcroft 16454a0df2efSAndy Whitcroft return ($cmt ne ''); 16464a0df2efSAndy Whitcroft} 16474a0df2efSAndy Whitcroft 16484d001e4dSAndy Whitcroftsub raw_line { 16494d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 16504d001e4dSAndy Whitcroft 16514d001e4dSAndy Whitcroft my $offset = $linenr - 1; 16524d001e4dSAndy Whitcroft $cnt++; 16534d001e4dSAndy Whitcroft 16544d001e4dSAndy Whitcroft my $line; 16554d001e4dSAndy Whitcroft while ($cnt) { 16564d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 16574d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 16584d001e4dSAndy Whitcroft $cnt--; 16594d001e4dSAndy Whitcroft } 16604d001e4dSAndy Whitcroft 16614d001e4dSAndy Whitcroft return $line; 16624d001e4dSAndy Whitcroft} 16634d001e4dSAndy Whitcroft 16642a9f9d85STobin C. Hardingsub get_stat_real { 16652a9f9d85STobin C. Harding my ($linenr, $lc) = @_; 16662a9f9d85STobin C. Harding 16672a9f9d85STobin C. Harding my $stat_real = raw_line($linenr, 0); 16682a9f9d85STobin C. Harding for (my $count = $linenr + 1; $count <= $lc; $count++) { 16692a9f9d85STobin C. Harding $stat_real = $stat_real . "\n" . raw_line($count, 0); 16702a9f9d85STobin C. Harding } 16712a9f9d85STobin C. Harding 16722a9f9d85STobin C. Harding return $stat_real; 16732a9f9d85STobin C. Harding} 16742a9f9d85STobin C. Harding 1675e3d95a2aSTobin C. Hardingsub get_stat_here { 1676e3d95a2aSTobin C. Harding my ($linenr, $cnt, $here) = @_; 1677e3d95a2aSTobin C. Harding 1678e3d95a2aSTobin C. Harding my $herectx = $here . "\n"; 1679e3d95a2aSTobin C. Harding for (my $n = 0; $n < $cnt; $n++) { 1680e3d95a2aSTobin C. Harding $herectx .= raw_line($linenr, $n) . "\n"; 1681e3d95a2aSTobin C. Harding } 1682e3d95a2aSTobin C. Harding 1683e3d95a2aSTobin C. Harding return $herectx; 1684e3d95a2aSTobin C. Harding} 1685e3d95a2aSTobin C. Harding 16860a920b5bSAndy Whitcroftsub cat_vet { 16870a920b5bSAndy Whitcroft my ($vet) = @_; 16889c0ca6f9SAndy Whitcroft my ($res, $coded); 16890a920b5bSAndy Whitcroft 16909c0ca6f9SAndy Whitcroft $res = ''; 16916c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 16926c72ffaaSAndy Whitcroft $res .= $1; 16936c72ffaaSAndy Whitcroft if ($2 ne '') { 16949c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 16956c72ffaaSAndy Whitcroft $res .= $coded; 16966c72ffaaSAndy Whitcroft } 16979c0ca6f9SAndy Whitcroft } 16989c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 16990a920b5bSAndy Whitcroft 17009c0ca6f9SAndy Whitcroft return $res; 17010a920b5bSAndy Whitcroft} 17020a920b5bSAndy Whitcroft 1703c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1704cf655043SAndy Whitcroftmy $av_pending; 1705c2fdda0dSAndy Whitcroftmy @av_paren_type; 17061f65f947SAndy Whitcroftmy $av_pend_colon; 1707c2fdda0dSAndy Whitcroft 1708c2fdda0dSAndy Whitcroftsub annotate_reset { 1709c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1710cf655043SAndy Whitcroft $av_pending = '_'; 1711cf655043SAndy Whitcroft @av_paren_type = ('E'); 17121f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1713c2fdda0dSAndy Whitcroft} 1714c2fdda0dSAndy Whitcroft 17156c72ffaaSAndy Whitcroftsub annotate_values { 17166c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 17176c72ffaaSAndy Whitcroft 17186c72ffaaSAndy Whitcroft my $res; 17191f65f947SAndy Whitcroft my $var = '_' x length($stream); 17206c72ffaaSAndy Whitcroft my $cur = $stream; 17216c72ffaaSAndy Whitcroft 1722c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 17236c72ffaaSAndy Whitcroft 17246c72ffaaSAndy Whitcroft while (length($cur)) { 1725773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1726cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1727171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 17286c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1729c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1730c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1731cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1732c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 17336c72ffaaSAndy Whitcroft } 17346c72ffaaSAndy Whitcroft 1735c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 17369446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 17379446ef56SAndy Whitcroft push(@av_paren_type, $type); 1738addcdceaSAndy Whitcroft $type = 'c'; 17399446ef56SAndy Whitcroft 1740e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1741c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 17426c72ffaaSAndy Whitcroft $type = 'T'; 17436c72ffaaSAndy Whitcroft 1744389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1745389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1746389a2fe5SAndy Whitcroft $type = 'T'; 1747389a2fe5SAndy Whitcroft 1748c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1749171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1750c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1751171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1752171ae1a4SAndy Whitcroft if ($2 ne '') { 1753cf655043SAndy Whitcroft $av_pending = 'N'; 1754171ae1a4SAndy Whitcroft } 1755171ae1a4SAndy Whitcroft $type = 'E'; 1756171ae1a4SAndy Whitcroft 1757c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1758171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1759171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1760171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 17616c72ffaaSAndy Whitcroft 1762c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1763cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1764c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1765cf655043SAndy Whitcroft 1766cf655043SAndy Whitcroft push(@av_paren_type, $type); 1767cf655043SAndy Whitcroft push(@av_paren_type, $type); 1768171ae1a4SAndy Whitcroft $type = 'E'; 1769cf655043SAndy Whitcroft 1770c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1771cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1772cf655043SAndy Whitcroft $av_preprocessor = 1; 1773cf655043SAndy Whitcroft 1774cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1775cf655043SAndy Whitcroft 1776171ae1a4SAndy Whitcroft $type = 'E'; 1777cf655043SAndy Whitcroft 1778c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1779cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1780cf655043SAndy Whitcroft 1781cf655043SAndy Whitcroft $av_preprocessor = 1; 1782cf655043SAndy Whitcroft 1783cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1784cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1785cf655043SAndy Whitcroft pop(@av_paren_type); 1786cf655043SAndy Whitcroft push(@av_paren_type, $type); 1787171ae1a4SAndy Whitcroft $type = 'E'; 17886c72ffaaSAndy Whitcroft 17896c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1790c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 17916c72ffaaSAndy Whitcroft 1792171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1793171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1794171ae1a4SAndy Whitcroft $av_pending = $type; 1795171ae1a4SAndy Whitcroft $type = 'N'; 1796171ae1a4SAndy Whitcroft 17976c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1798c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 17996c72ffaaSAndy Whitcroft if (defined $2) { 1800cf655043SAndy Whitcroft $av_pending = 'V'; 18016c72ffaaSAndy Whitcroft } 18026c72ffaaSAndy Whitcroft $type = 'N'; 18036c72ffaaSAndy Whitcroft 180414b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1805c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 180614b111c1SAndy Whitcroft $av_pending = 'E'; 18076c72ffaaSAndy Whitcroft $type = 'N'; 18086c72ffaaSAndy Whitcroft 18091f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 18101f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 18111f65f947SAndy Whitcroft $av_pend_colon = 'C'; 18121f65f947SAndy Whitcroft $type = 'N'; 18131f65f947SAndy Whitcroft 181414b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1815c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 18166c72ffaaSAndy Whitcroft $type = 'N'; 18176c72ffaaSAndy Whitcroft 18186c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1819c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1820cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1821cf655043SAndy Whitcroft $av_pending = '_'; 18226c72ffaaSAndy Whitcroft $type = 'N'; 18236c72ffaaSAndy Whitcroft 18246c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1825cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1826cf655043SAndy Whitcroft if ($new_type ne '_') { 1827cf655043SAndy Whitcroft $type = $new_type; 1828c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1829c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 18306c72ffaaSAndy Whitcroft } else { 1831c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 18326c72ffaaSAndy Whitcroft } 18336c72ffaaSAndy Whitcroft 1834c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1835c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1836c8cb2ca3SAndy Whitcroft $type = 'V'; 1837cf655043SAndy Whitcroft $av_pending = 'V'; 18386c72ffaaSAndy Whitcroft 18398e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 18408e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 18411f65f947SAndy Whitcroft $av_pend_colon = 'B'; 18428e761b04SAndy Whitcroft } elsif ($type eq 'E') { 18438e761b04SAndy Whitcroft $av_pend_colon = 'L'; 18441f65f947SAndy Whitcroft } 18451f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 18461f65f947SAndy Whitcroft $type = 'V'; 18471f65f947SAndy Whitcroft 18486c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1849c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 18506c72ffaaSAndy Whitcroft $type = 'V'; 18516c72ffaaSAndy Whitcroft 18526c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1853c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 18546c72ffaaSAndy Whitcroft $type = 'N'; 18556c72ffaaSAndy Whitcroft 1856cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1857c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 185813214adfSAndy Whitcroft $type = 'E'; 18591f65f947SAndy Whitcroft $av_pend_colon = 'O'; 186013214adfSAndy Whitcroft 18618e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 18628e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 18638e761b04SAndy Whitcroft $type = 'C'; 18648e761b04SAndy Whitcroft 18651f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 18661f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 18671f65f947SAndy Whitcroft $type = 'N'; 18681f65f947SAndy Whitcroft 18691f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 18701f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 18711f65f947SAndy Whitcroft 18721f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 18731f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 18741f65f947SAndy Whitcroft $type = 'E'; 18751f65f947SAndy Whitcroft } else { 18761f65f947SAndy Whitcroft $type = 'N'; 18771f65f947SAndy Whitcroft } 18781f65f947SAndy Whitcroft $av_pend_colon = 'O'; 18791f65f947SAndy Whitcroft 18808e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 188113214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 18826c72ffaaSAndy Whitcroft $type = 'N'; 18836c72ffaaSAndy Whitcroft 18840d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 188574048ed8SAndy Whitcroft my $variant; 188674048ed8SAndy Whitcroft 188774048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 188874048ed8SAndy Whitcroft if ($type eq 'V') { 188974048ed8SAndy Whitcroft $variant = 'B'; 189074048ed8SAndy Whitcroft } else { 189174048ed8SAndy Whitcroft $variant = 'U'; 189274048ed8SAndy Whitcroft } 189374048ed8SAndy Whitcroft 189474048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 189574048ed8SAndy Whitcroft $type = 'N'; 189674048ed8SAndy Whitcroft 18976c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1898c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 18996c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 19006c72ffaaSAndy Whitcroft $type = 'N'; 19016c72ffaaSAndy Whitcroft } 19026c72ffaaSAndy Whitcroft 19036c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1904c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 19056c72ffaaSAndy Whitcroft } 19066c72ffaaSAndy Whitcroft if (defined $1) { 19076c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 19086c72ffaaSAndy Whitcroft $res .= $type x length($1); 19096c72ffaaSAndy Whitcroft } 19106c72ffaaSAndy Whitcroft } 19116c72ffaaSAndy Whitcroft 19121f65f947SAndy Whitcroft return ($res, $var); 19136c72ffaaSAndy Whitcroft} 19146c72ffaaSAndy Whitcroft 19158905a67cSAndy Whitcroftsub possible { 191613214adfSAndy Whitcroft my ($possible, $line) = @_; 19179a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 19180776e594SAndy Whitcroft ^(?: 19190776e594SAndy Whitcroft $Modifier| 19200776e594SAndy Whitcroft $Storage| 19210776e594SAndy Whitcroft $Type| 19229a974fdbSAndy Whitcroft DEFINE_\S+ 19239a974fdbSAndy Whitcroft )$| 19249a974fdbSAndy Whitcroft ^(?: 19250776e594SAndy Whitcroft goto| 19260776e594SAndy Whitcroft return| 19270776e594SAndy Whitcroft case| 19280776e594SAndy Whitcroft else| 19290776e594SAndy Whitcroft asm|__asm__| 193089a88353SAndy Whitcroft do| 193189a88353SAndy Whitcroft \#| 193289a88353SAndy Whitcroft \#\#| 19339a974fdbSAndy Whitcroft )(?:\s|$)| 19340776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 19359a974fdbSAndy Whitcroft )}x; 19369a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 19379a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1938c45dcabdSAndy Whitcroft # Check for modifiers. 1939c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1940c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1941c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1942c45dcabdSAndy Whitcroft 1943c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1944c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1945d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 19469a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1947d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1948485ff23eSAlex Dowad push(@modifierListFile, $modifier); 1949d2506586SAndy Whitcroft } 19509a974fdbSAndy Whitcroft } 1951c45dcabdSAndy Whitcroft 1952c45dcabdSAndy Whitcroft } else { 195313214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 1954485ff23eSAlex Dowad push(@typeListFile, $possible); 1955c45dcabdSAndy Whitcroft } 19568905a67cSAndy Whitcroft build_types(); 19570776e594SAndy Whitcroft } else { 19580776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 19598905a67cSAndy Whitcroft } 19608905a67cSAndy Whitcroft} 19618905a67cSAndy Whitcroft 19626c72ffaaSAndy Whitcroftmy $prefix = ''; 19636c72ffaaSAndy Whitcroft 1964000d1cc1SJoe Perchessub show_type { 1965cbec18afSJoe Perches my ($type) = @_; 196691bfe484SJoe Perches 1967522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 1968522b837cSAlexey Dobriyan 1969cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1970cbec18afSJoe Perches 1971cbec18afSJoe Perches return !defined $ignore_type{$type}; 1972000d1cc1SJoe Perches} 1973000d1cc1SJoe Perches 1974f0a594c1SAndy Whitcroftsub report { 1975cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1976cbec18afSJoe Perches 1977cbec18afSJoe Perches if (!show_type($type) || 1978cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1979773647a0SAndy Whitcroft return 0; 1980773647a0SAndy Whitcroft } 198157230297SJoe Perches my $output = ''; 1982737c0767SJohn Brooks if ($color) { 198357230297SJoe Perches if ($level eq 'ERROR') { 198457230297SJoe Perches $output .= RED; 198557230297SJoe Perches } elsif ($level eq 'WARNING') { 198657230297SJoe Perches $output .= YELLOW; 1987000d1cc1SJoe Perches } else { 198857230297SJoe Perches $output .= GREEN; 1989000d1cc1SJoe Perches } 199057230297SJoe Perches } 199157230297SJoe Perches $output .= $prefix . $level . ':'; 199257230297SJoe Perches if ($show_types) { 1993737c0767SJohn Brooks $output .= BLUE if ($color); 199457230297SJoe Perches $output .= "$type:"; 199557230297SJoe Perches } 1996737c0767SJohn Brooks $output .= RESET if ($color); 199757230297SJoe Perches $output .= ' ' . $msg . "\n"; 199834d8815fSJoe Perches 199934d8815fSJoe Perches if ($showfile) { 200034d8815fSJoe Perches my @lines = split("\n", $output, -1); 200134d8815fSJoe Perches splice(@lines, 1, 1); 200234d8815fSJoe Perches $output = join("\n", @lines); 200334d8815fSJoe Perches } 200457230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 20058905a67cSAndy Whitcroft 200657230297SJoe Perches push(our @report, $output); 2007773647a0SAndy Whitcroft 2008773647a0SAndy Whitcroft return 1; 2009f0a594c1SAndy Whitcroft} 2010cbec18afSJoe Perches 2011f0a594c1SAndy Whitcroftsub report_dump { 201213214adfSAndy Whitcroft our @report; 2013f0a594c1SAndy Whitcroft} 2014000d1cc1SJoe Perches 2015d752fcc8SJoe Perchessub fixup_current_range { 2016d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 2017d752fcc8SJoe Perches 2018d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 2019d752fcc8SJoe Perches my $o = $1; 2020d752fcc8SJoe Perches my $l = $2; 2021d752fcc8SJoe Perches my $no = $o + $offset; 2022d752fcc8SJoe Perches my $nl = $l + $length; 2023d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 2024d752fcc8SJoe Perches } 2025d752fcc8SJoe Perches} 2026d752fcc8SJoe Perches 2027d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 2028d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 2029d752fcc8SJoe Perches 2030d752fcc8SJoe Perches my $range_last_linenr = 0; 2031d752fcc8SJoe Perches my $delta_offset = 0; 2032d752fcc8SJoe Perches 2033d752fcc8SJoe Perches my $old_linenr = 0; 2034d752fcc8SJoe Perches my $new_linenr = 0; 2035d752fcc8SJoe Perches 2036d752fcc8SJoe Perches my $next_insert = 0; 2037d752fcc8SJoe Perches my $next_delete = 0; 2038d752fcc8SJoe Perches 2039d752fcc8SJoe Perches my @lines = (); 2040d752fcc8SJoe Perches 2041d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 2042d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 2043d752fcc8SJoe Perches 2044d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 2045d752fcc8SJoe Perches my $save_line = 1; 2046d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 2047323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2048d752fcc8SJoe Perches $delta_offset = 0; 2049d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2050d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 2051d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 2052d752fcc8SJoe Perches } 2053d752fcc8SJoe Perches 2054d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2055d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 2056d752fcc8SJoe Perches $save_line = 0; 2057d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2058d752fcc8SJoe Perches } 2059d752fcc8SJoe Perches 2060d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2061d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 2062d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 2063d752fcc8SJoe Perches $new_linenr++; 2064d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2065d752fcc8SJoe Perches } 2066d752fcc8SJoe Perches 2067d752fcc8SJoe Perches if ($save_line) { 2068d752fcc8SJoe Perches push(@lines, $line); 2069d752fcc8SJoe Perches $new_linenr++; 2070d752fcc8SJoe Perches } 2071d752fcc8SJoe Perches 2072d752fcc8SJoe Perches $old_linenr++; 2073d752fcc8SJoe Perches } 2074d752fcc8SJoe Perches 2075d752fcc8SJoe Perches return @lines; 2076d752fcc8SJoe Perches} 2077d752fcc8SJoe Perches 2078f2d7e4d4SJoe Perchessub fix_insert_line { 2079f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2080f2d7e4d4SJoe Perches 2081f2d7e4d4SJoe Perches my $inserted = { 2082f2d7e4d4SJoe Perches LINENR => $linenr, 2083f2d7e4d4SJoe Perches LINE => $line, 2084f2d7e4d4SJoe Perches }; 2085f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2086f2d7e4d4SJoe Perches} 2087f2d7e4d4SJoe Perches 2088f2d7e4d4SJoe Perchessub fix_delete_line { 2089f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2090f2d7e4d4SJoe Perches 2091f2d7e4d4SJoe Perches my $deleted = { 2092f2d7e4d4SJoe Perches LINENR => $linenr, 2093f2d7e4d4SJoe Perches LINE => $line, 2094f2d7e4d4SJoe Perches }; 2095f2d7e4d4SJoe Perches 2096f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2097f2d7e4d4SJoe Perches} 2098f2d7e4d4SJoe Perches 2099de7d4f0eSAndy Whitcroftsub ERROR { 2100cbec18afSJoe Perches my ($type, $msg) = @_; 2101cbec18afSJoe Perches 2102cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2103de7d4f0eSAndy Whitcroft our $clean = 0; 21046c72ffaaSAndy Whitcroft our $cnt_error++; 21053705ce5bSJoe Perches return 1; 2106de7d4f0eSAndy Whitcroft } 21073705ce5bSJoe Perches return 0; 2108773647a0SAndy Whitcroft} 2109de7d4f0eSAndy Whitcroftsub WARN { 2110cbec18afSJoe Perches my ($type, $msg) = @_; 2111cbec18afSJoe Perches 2112cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2113de7d4f0eSAndy Whitcroft our $clean = 0; 21146c72ffaaSAndy Whitcroft our $cnt_warn++; 21153705ce5bSJoe Perches return 1; 2116de7d4f0eSAndy Whitcroft } 21173705ce5bSJoe Perches return 0; 2118773647a0SAndy Whitcroft} 2119de7d4f0eSAndy Whitcroftsub CHK { 2120cbec18afSJoe Perches my ($type, $msg) = @_; 2121cbec18afSJoe Perches 2122cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2123de7d4f0eSAndy Whitcroft our $clean = 0; 21246c72ffaaSAndy Whitcroft our $cnt_chk++; 21253705ce5bSJoe Perches return 1; 21266c72ffaaSAndy Whitcroft } 21273705ce5bSJoe Perches return 0; 2128de7d4f0eSAndy Whitcroft} 2129de7d4f0eSAndy Whitcroft 21306ecd9674SAndy Whitcroftsub check_absolute_file { 21316ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 21326ecd9674SAndy Whitcroft my $file = $absolute; 21336ecd9674SAndy Whitcroft 21346ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 21356ecd9674SAndy Whitcroft 21366ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 21376ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 21386ecd9674SAndy Whitcroft if (-f "$root/$file") { 21396ecd9674SAndy Whitcroft ##print "file<$file>\n"; 21406ecd9674SAndy Whitcroft last; 21416ecd9674SAndy Whitcroft } 21426ecd9674SAndy Whitcroft } 21436ecd9674SAndy Whitcroft if (! -f _) { 21446ecd9674SAndy Whitcroft return 0; 21456ecd9674SAndy Whitcroft } 21466ecd9674SAndy Whitcroft 21476ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 21486ecd9674SAndy Whitcroft my $prefix = $absolute; 21496ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 21506ecd9674SAndy Whitcroft 21516ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 21526ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2153000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2154000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 21556ecd9674SAndy Whitcroft } 21566ecd9674SAndy Whitcroft} 21576ecd9674SAndy Whitcroft 21583705ce5bSJoe Perchessub trim { 21593705ce5bSJoe Perches my ($string) = @_; 21603705ce5bSJoe Perches 2161b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2162b34c648bSJoe Perches 2163b34c648bSJoe Perches return $string; 2164b34c648bSJoe Perches} 2165b34c648bSJoe Perches 2166b34c648bSJoe Perchessub ltrim { 2167b34c648bSJoe Perches my ($string) = @_; 2168b34c648bSJoe Perches 2169b34c648bSJoe Perches $string =~ s/^\s+//; 2170b34c648bSJoe Perches 2171b34c648bSJoe Perches return $string; 2172b34c648bSJoe Perches} 2173b34c648bSJoe Perches 2174b34c648bSJoe Perchessub rtrim { 2175b34c648bSJoe Perches my ($string) = @_; 2176b34c648bSJoe Perches 2177b34c648bSJoe Perches $string =~ s/\s+$//; 21783705ce5bSJoe Perches 21793705ce5bSJoe Perches return $string; 21803705ce5bSJoe Perches} 21813705ce5bSJoe Perches 218252ea8506SJoe Perchessub string_find_replace { 218352ea8506SJoe Perches my ($string, $find, $replace) = @_; 218452ea8506SJoe Perches 218552ea8506SJoe Perches $string =~ s/$find/$replace/g; 218652ea8506SJoe Perches 218752ea8506SJoe Perches return $string; 218852ea8506SJoe Perches} 218952ea8506SJoe Perches 21903705ce5bSJoe Perchessub tabify { 21913705ce5bSJoe Perches my ($leading) = @_; 21923705ce5bSJoe Perches 21933705ce5bSJoe Perches my $source_indent = 8; 21943705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 21953705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 21963705ce5bSJoe Perches 21973705ce5bSJoe Perches #convert leading spaces to tabs 21983705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 21993705ce5bSJoe Perches #Remove spaces before a tab 22003705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 22013705ce5bSJoe Perches 22023705ce5bSJoe Perches return "$leading"; 22033705ce5bSJoe Perches} 22043705ce5bSJoe Perches 2205d1fe9c09SJoe Perchessub pos_last_openparen { 2206d1fe9c09SJoe Perches my ($line) = @_; 2207d1fe9c09SJoe Perches 2208d1fe9c09SJoe Perches my $pos = 0; 2209d1fe9c09SJoe Perches 2210d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2211d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2212d1fe9c09SJoe Perches 2213d1fe9c09SJoe Perches my $last_openparen = 0; 2214d1fe9c09SJoe Perches 2215d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2216d1fe9c09SJoe Perches return -1; 2217d1fe9c09SJoe Perches } 2218d1fe9c09SJoe Perches 2219d1fe9c09SJoe Perches my $len = length($line); 2220d1fe9c09SJoe Perches 2221d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2222d1fe9c09SJoe Perches my $string = substr($line, $pos); 2223d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2224d1fe9c09SJoe Perches $pos += length($1) - 1; 2225d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2226d1fe9c09SJoe Perches $last_openparen = $pos; 2227d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2228d1fe9c09SJoe Perches last; 2229d1fe9c09SJoe Perches } 2230d1fe9c09SJoe Perches } 2231d1fe9c09SJoe Perches 223291cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2233d1fe9c09SJoe Perches} 2234d1fe9c09SJoe Perches 22350a920b5bSAndy Whitcroftsub process { 22360a920b5bSAndy Whitcroft my $filename = shift; 22370a920b5bSAndy Whitcroft 22380a920b5bSAndy Whitcroft my $linenr=0; 22390a920b5bSAndy Whitcroft my $prevline=""; 2240c2fdda0dSAndy Whitcroft my $prevrawline=""; 22410a920b5bSAndy Whitcroft my $stashline=""; 2242c2fdda0dSAndy Whitcroft my $stashrawline=""; 22430a920b5bSAndy Whitcroft 22444a0df2efSAndy Whitcroft my $length; 22450a920b5bSAndy Whitcroft my $indent; 22460a920b5bSAndy Whitcroft my $previndent=0; 22470a920b5bSAndy Whitcroft my $stashindent=0; 22480a920b5bSAndy Whitcroft 2249de7d4f0eSAndy Whitcroft our $clean = 1; 22500a920b5bSAndy Whitcroft my $signoff = 0; 2251cd261496SGeert Uytterhoeven my $author = ''; 2252cd261496SGeert Uytterhoeven my $authorsignoff = 0; 22530a920b5bSAndy Whitcroft my $is_patch = 0; 225429ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 225515662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 2256ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2257490b292cSJoe Perches my $commit_log_lines = 0; #Number of commit log lines 2258bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 22592a076f40SJoe Perches my $commit_log_long_line = 0; 2260e518e9a5SJoe Perches my $commit_log_has_diff = 0; 226113f1937eSJoe Perches my $reported_maintainer_file = 0; 2262fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2263fa64205dSPasi Savanainen 2264365dd4eaSJoe Perches my $last_blank_line = 0; 22655e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2266365dd4eaSJoe Perches 226713214adfSAndy Whitcroft our @report = (); 22686c72ffaaSAndy Whitcroft our $cnt_lines = 0; 22696c72ffaaSAndy Whitcroft our $cnt_error = 0; 22706c72ffaaSAndy Whitcroft our $cnt_warn = 0; 22716c72ffaaSAndy Whitcroft our $cnt_chk = 0; 22726c72ffaaSAndy Whitcroft 22730a920b5bSAndy Whitcroft # Trace the real file/line as we go. 22740a920b5bSAndy Whitcroft my $realfile = ''; 22750a920b5bSAndy Whitcroft my $realline = 0; 22760a920b5bSAndy Whitcroft my $realcnt = 0; 22770a920b5bSAndy Whitcroft my $here = ''; 227877cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 22790a920b5bSAndy Whitcroft my $in_comment = 0; 2280c2fdda0dSAndy Whitcroft my $comment_edge = 0; 22810a920b5bSAndy Whitcroft my $first_line = 0; 22821e855726SWolfram Sang my $p1_prefix = ''; 22830a920b5bSAndy Whitcroft 228413214adfSAndy Whitcroft my $prev_values = 'E'; 228513214adfSAndy Whitcroft 228613214adfSAndy Whitcroft # suppression flags 2287773647a0SAndy Whitcroft my %suppress_ifbraces; 2288170d3a22SAndy Whitcroft my %suppress_whiletrailers; 22892b474a1aSAndy Whitcroft my %suppress_export; 22903e469cdcSAndy Whitcroft my $suppress_statement = 0; 2291653d4876SAndy Whitcroft 22927e51f197SJoe Perches my %signatures = (); 2293323c1260SJoe Perches 2294c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2295de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2296c2fdda0dSAndy Whitcroft # 2297de7d4f0eSAndy Whitcroft my @setup_docs = (); 2298de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2299773647a0SAndy Whitcroft 2300d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2301d8b07710SJoe Perches 23029f3a8992SRob Herring my $checklicenseline = 1; 23039f3a8992SRob Herring 2304773647a0SAndy Whitcroft sanitise_line_reset(); 2305c2fdda0dSAndy Whitcroft my $line; 2306c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2307773647a0SAndy Whitcroft $linenr++; 2308773647a0SAndy Whitcroft $line = $rawline; 2309c2fdda0dSAndy Whitcroft 23103705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 23113705ce5bSJoe Perches 2312773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2313de7d4f0eSAndy Whitcroft $setup_docs = 0; 23148c27ceffSMauro Carvalho Chehab if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) { 2315de7d4f0eSAndy Whitcroft $setup_docs = 1; 2316de7d4f0eSAndy Whitcroft } 2317773647a0SAndy Whitcroft #next; 2318de7d4f0eSAndy Whitcroft } 231974fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2320773647a0SAndy Whitcroft $realline=$1-1; 2321773647a0SAndy Whitcroft if (defined $2) { 2322773647a0SAndy Whitcroft $realcnt=$3+1; 2323773647a0SAndy Whitcroft } else { 2324773647a0SAndy Whitcroft $realcnt=1+1; 2325773647a0SAndy Whitcroft } 2326c45dcabdSAndy Whitcroft $in_comment = 0; 2327773647a0SAndy Whitcroft 2328773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2329773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2330773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2331773647a0SAndy Whitcroft # at context start. 2332773647a0SAndy Whitcroft my $edge; 233301fa9147SAndy Whitcroft my $cnt = $realcnt; 233401fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 233501fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 233601fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 233701fa9147SAndy Whitcroft $cnt--; 233801fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2339721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2340fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2341fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2342fae17daeSAndy Whitcroft ($edge) = $1; 2343fae17daeSAndy Whitcroft last; 2344fae17daeSAndy Whitcroft } 2345773647a0SAndy Whitcroft } 2346773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2347773647a0SAndy Whitcroft $in_comment = 1; 2348773647a0SAndy Whitcroft } 2349773647a0SAndy Whitcroft 2350773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2351773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2352773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2353773647a0SAndy Whitcroft if (!defined $edge && 235483242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2355773647a0SAndy Whitcroft { 2356773647a0SAndy Whitcroft $in_comment = 1; 2357773647a0SAndy Whitcroft } 2358773647a0SAndy Whitcroft 2359773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2360773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2361773647a0SAndy Whitcroft 2362171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2363773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2364171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2365773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2366773647a0SAndy Whitcroft } 2367773647a0SAndy Whitcroft push(@lines, $line); 2368773647a0SAndy Whitcroft 2369773647a0SAndy Whitcroft if ($realcnt > 1) { 2370773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2371773647a0SAndy Whitcroft } else { 2372773647a0SAndy Whitcroft $realcnt = 0; 2373773647a0SAndy Whitcroft } 2374773647a0SAndy Whitcroft 2375773647a0SAndy Whitcroft #print "==>$rawline\n"; 2376773647a0SAndy Whitcroft #print "-->$line\n"; 2377de7d4f0eSAndy Whitcroft 2378de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2379de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2380de7d4f0eSAndy Whitcroft } 2381de7d4f0eSAndy Whitcroft } 2382de7d4f0eSAndy Whitcroft 23836c72ffaaSAndy Whitcroft $prefix = ''; 23846c72ffaaSAndy Whitcroft 2385773647a0SAndy Whitcroft $realcnt = 0; 2386773647a0SAndy Whitcroft $linenr = 0; 2387194f66fcSJoe Perches $fixlinenr = -1; 23880a920b5bSAndy Whitcroft foreach my $line (@lines) { 23890a920b5bSAndy Whitcroft $linenr++; 2390194f66fcSJoe Perches $fixlinenr++; 23911b5539b1SJoe Perches my $sline = $line; #copy of $line 23921b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 23930a920b5bSAndy Whitcroft 2394c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 23956c72ffaaSAndy Whitcroft 239612c253abSJoe Perches# check if it's a mode change, rename or start of a patch 239712c253abSJoe Perches if (!$in_commit_log && 239812c253abSJoe Perches ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 239912c253abSJoe Perches ($line =~ /^rename (?:from|to) \S+\s*$/ || 240012c253abSJoe Perches $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 240112c253abSJoe Perches $is_patch = 1; 240212c253abSJoe Perches } 240312c253abSJoe Perches 24040a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2405e518e9a5SJoe Perches if (!$in_commit_log && 240674fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 240774fd4f34SJoe Perches my $context = $4; 24080a920b5bSAndy Whitcroft $is_patch = 1; 24094a0df2efSAndy Whitcroft $first_line = $linenr + 1; 24100a920b5bSAndy Whitcroft $realline=$1-1; 24110a920b5bSAndy Whitcroft if (defined $2) { 24120a920b5bSAndy Whitcroft $realcnt=$3+1; 24130a920b5bSAndy Whitcroft } else { 24140a920b5bSAndy Whitcroft $realcnt=1+1; 24150a920b5bSAndy Whitcroft } 2416c2fdda0dSAndy Whitcroft annotate_reset(); 241713214adfSAndy Whitcroft $prev_values = 'E'; 241813214adfSAndy Whitcroft 2419773647a0SAndy Whitcroft %suppress_ifbraces = (); 2420170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 24212b474a1aSAndy Whitcroft %suppress_export = (); 24223e469cdcSAndy Whitcroft $suppress_statement = 0; 242374fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 242474fd4f34SJoe Perches $context_function = $1; 242574fd4f34SJoe Perches } else { 242674fd4f34SJoe Perches undef $context_function; 242774fd4f34SJoe Perches } 24280a920b5bSAndy Whitcroft next; 24290a920b5bSAndy Whitcroft 24304a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 24314a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 24324a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2433773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 24340a920b5bSAndy Whitcroft $realline++; 2435d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 24360a920b5bSAndy Whitcroft 24374a0df2efSAndy Whitcroft # Measure the line length and indent. 2438c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 24390a920b5bSAndy Whitcroft 24400a920b5bSAndy Whitcroft # Track the previous line. 24410a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 24420a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2443c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2444c2fdda0dSAndy Whitcroft 2445773647a0SAndy Whitcroft #warn "line<$line>\n"; 24466c72ffaaSAndy Whitcroft 2447d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2448d8aaf121SAndy Whitcroft $realcnt--; 24490a920b5bSAndy Whitcroft } 24500a920b5bSAndy Whitcroft 2451cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2452cc77cdcaSAndy Whitcroft 24536c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 24546c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2455773647a0SAndy Whitcroft 24562ac73b4fSJoe Perches my $found_file = 0; 2457773647a0SAndy Whitcroft # extract the filename as it passes 24583bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 24593bf9a009SRabin Vincent $realfile = $1; 24602b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2461270c49a0SJoe Perches $in_commit_log = 0; 24622ac73b4fSJoe Perches $found_file = 1; 24633bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2464773647a0SAndy Whitcroft $realfile = $1; 24652b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2466270c49a0SJoe Perches $in_commit_log = 0; 24671e855726SWolfram Sang 24681e855726SWolfram Sang $p1_prefix = $1; 2469e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2470e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2471000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2472000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 24731e855726SWolfram Sang } 2474773647a0SAndy Whitcroft 2475c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2476000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2477000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2478773647a0SAndy Whitcroft } 24792ac73b4fSJoe Perches $found_file = 1; 24802ac73b4fSJoe Perches } 24812ac73b4fSJoe Perches 248234d8815fSJoe Perches#make up the handle for any error we report on this line 248334d8815fSJoe Perches if ($showfile) { 248434d8815fSJoe Perches $prefix = "$realfile:$realline: " 248534d8815fSJoe Perches } elsif ($emacs) { 24867d3a9f67SJoe Perches if ($file) { 24877d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 24887d3a9f67SJoe Perches } else { 248934d8815fSJoe Perches $prefix = "$filename:$linenr: "; 249034d8815fSJoe Perches } 24917d3a9f67SJoe Perches } 249234d8815fSJoe Perches 24932ac73b4fSJoe Perches if ($found_file) { 249485b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 249585b0ee18SJoe Perches WARN("OBSOLETE", 249685b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 249785b0ee18SJoe Perches } 24987bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 24992ac73b4fSJoe Perches $check = 1; 25002ac73b4fSJoe Perches } else { 25012ac73b4fSJoe Perches $check = $check_orig; 25022ac73b4fSJoe Perches } 25039f3a8992SRob Herring $checklicenseline = 1; 2504773647a0SAndy Whitcroft next; 2505773647a0SAndy Whitcroft } 2506773647a0SAndy Whitcroft 2507389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 25080a920b5bSAndy Whitcroft 2509c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2510c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2511c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 25120a920b5bSAndy Whitcroft 25136c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 25146c72ffaaSAndy Whitcroft 2515490b292cSJoe Perches# Verify the existence of a commit log if appropriate 2516490b292cSJoe Perches# 2 is used because a $signature is counted in $commit_log_lines 2517490b292cSJoe Perches if ($in_commit_log) { 2518490b292cSJoe Perches if ($line !~ /^\s*$/) { 2519490b292cSJoe Perches $commit_log_lines++; #could be a $signature 2520490b292cSJoe Perches } 2521490b292cSJoe Perches } elsif ($has_commit_log && $commit_log_lines < 2) { 2522490b292cSJoe Perches WARN("COMMIT_MESSAGE", 2523490b292cSJoe Perches "Missing commit description - Add an appropriate one\n"); 2524490b292cSJoe Perches $commit_log_lines = 2; #warn only once 2525490b292cSJoe Perches } 2526490b292cSJoe Perches 2527e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2528e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2529e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2530e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2531e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2532e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2533e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2534e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2535e518e9a5SJoe Perches $commit_log_has_diff = 1; 2536e518e9a5SJoe Perches } 2537e518e9a5SJoe Perches 25383bf9a009SRabin Vincent# Check for incorrect file permissions 25393bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 25403bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 254104db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 254204db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2543000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2544000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 25453bf9a009SRabin Vincent } 25463bf9a009SRabin Vincent } 25473bf9a009SRabin Vincent 2548cd261496SGeert Uytterhoeven# Check the patch for a From: 2549cd261496SGeert Uytterhoeven if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { 2550cd261496SGeert Uytterhoeven $author = $1; 2551cd261496SGeert Uytterhoeven $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); 2552cd261496SGeert Uytterhoeven $author =~ s/"//g; 2553cd261496SGeert Uytterhoeven } 2554cd261496SGeert Uytterhoeven 255520112475SJoe Perches# Check the patch for a signoff: 2556d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 25574a0df2efSAndy Whitcroft $signoff++; 255815662b3eSJoe Perches $in_commit_log = 0; 2559cd261496SGeert Uytterhoeven if ($author ne '') { 2560cd261496SGeert Uytterhoeven my $l = $line; 2561cd261496SGeert Uytterhoeven $l =~ s/"//g; 2562cd261496SGeert Uytterhoeven if ($l =~ /^\s*signed-off-by:\s*\Q$author\E/i) { 2563cd261496SGeert Uytterhoeven $authorsignoff = 1; 2564cd261496SGeert Uytterhoeven } 2565cd261496SGeert Uytterhoeven } 25660a920b5bSAndy Whitcroft } 256720112475SJoe Perches 2568e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2569e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2570e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2571e0d975b1SJoe Perches $reported_maintainer_file = 1; 2572e0d975b1SJoe Perches } 2573e0d975b1SJoe Perches 257420112475SJoe Perches# Check signature styles 2575270c49a0SJoe Perches if (!$in_header_lines && 2576ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 257720112475SJoe Perches my $space_before = $1; 257820112475SJoe Perches my $sign_off = $2; 257920112475SJoe Perches my $space_after = $3; 258020112475SJoe Perches my $email = $4; 258120112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 258220112475SJoe Perches 2583ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2584ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2585ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2586ce0338dfSJoe Perches } 258720112475SJoe Perches if (defined $space_before && $space_before ne "") { 25883705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 25893705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 25903705ce5bSJoe Perches $fix) { 2591194f66fcSJoe Perches $fixed[$fixlinenr] = 25923705ce5bSJoe Perches "$ucfirst_sign_off $email"; 25933705ce5bSJoe Perches } 259420112475SJoe Perches } 259520112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 25963705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 25973705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 25983705ce5bSJoe Perches $fix) { 2599194f66fcSJoe Perches $fixed[$fixlinenr] = 26003705ce5bSJoe Perches "$ucfirst_sign_off $email"; 26013705ce5bSJoe Perches } 26023705ce5bSJoe Perches 260320112475SJoe Perches } 260420112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 26053705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 26063705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 26073705ce5bSJoe Perches $fix) { 2608194f66fcSJoe Perches $fixed[$fixlinenr] = 26093705ce5bSJoe Perches "$ucfirst_sign_off $email"; 26103705ce5bSJoe Perches } 261120112475SJoe Perches } 261220112475SJoe Perches 261320112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 261420112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 261520112475SJoe Perches if ($suggested_email eq "") { 2616000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2617000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 261820112475SJoe Perches } else { 261920112475SJoe Perches my $dequoted = $suggested_email; 262020112475SJoe Perches $dequoted =~ s/^"//; 262120112475SJoe Perches $dequoted =~ s/" </ </; 262220112475SJoe Perches # Don't force email to have quotes 262320112475SJoe Perches # Allow just an angle bracketed address 262420112475SJoe Perches if ("$dequoted$comment" ne $email && 262520112475SJoe Perches "<$email_address>$comment" ne $email && 262620112475SJoe Perches "$suggested_email$comment" ne $email) { 2627000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2628000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 262920112475SJoe Perches } 26300a920b5bSAndy Whitcroft } 26317e51f197SJoe Perches 26327e51f197SJoe Perches# Check for duplicate signatures 26337e51f197SJoe Perches my $sig_nospace = $line; 26347e51f197SJoe Perches $sig_nospace =~ s/\s//g; 26357e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 26367e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 26377e51f197SJoe Perches WARN("BAD_SIGN_OFF", 26387e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 26397e51f197SJoe Perches } else { 26407e51f197SJoe Perches $signatures{$sig_nospace} = 1; 26417e51f197SJoe Perches } 26420a920b5bSAndy Whitcroft } 26430a920b5bSAndy Whitcroft 2644a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2645a2fe16b9SJoe Perches if ($in_header_lines && 2646a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2647a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2648a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2649a2fe16b9SJoe Perches } 2650a2fe16b9SJoe Perches 26517ebd05efSChristopher Covington# Check for unwanted Gerrit info 26527ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 26537ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 26547ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 26557ebd05efSChristopher Covington } 26567ebd05efSChristopher Covington 2657369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2658369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2659369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2660369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2661369c8dd3SJoe Perches # timestamp 2662369c8dd3SJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) { 2663369c8dd3SJoe Perches # stack dump address 2664369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2665369c8dd3SJoe Perches } 2666369c8dd3SJoe Perches 26672a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 26682a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2669bf4daf12SJoe Perches length($line) > 75 && 2670bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2671bf4daf12SJoe Perches # file delta changes 2672bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2673bf4daf12SJoe Perches # filename then : 2674bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2675bf4daf12SJoe Perches # A Fixes: or Link: line 2676bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 26772a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 26782a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 26792a076f40SJoe Perches $commit_log_long_line = 1; 26802a076f40SJoe Perches } 26812a076f40SJoe Perches 2682bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2683bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2684bf4daf12SJoe Perches $line =~ /^\s*$/) { 2685bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2686bf4daf12SJoe Perches } 2687bf4daf12SJoe Perches 26880d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2689369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2690aab38f51SJoe Perches $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i && 2691e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 2692fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2693aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2694369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2695bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2696fe043ea1SJoe Perches my $init_char = "c"; 2697fe043ea1SJoe Perches my $orig_commit = ""; 26980d7835fcSJoe Perches my $short = 1; 26990d7835fcSJoe Perches my $long = 0; 27000d7835fcSJoe Perches my $case = 1; 27010d7835fcSJoe Perches my $space = 1; 27020d7835fcSJoe Perches my $hasdesc = 0; 270319c146a6SJoe Perches my $hasparens = 0; 27040d7835fcSJoe Perches my $id = '0123456789ab'; 27050d7835fcSJoe Perches my $orig_desc = "commit description"; 27060d7835fcSJoe Perches my $description = ""; 27070d7835fcSJoe Perches 2708fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2709fe043ea1SJoe Perches $init_char = $1; 2710fe043ea1SJoe Perches $orig_commit = lc($2); 2711fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2712fe043ea1SJoe Perches $orig_commit = lc($1); 2713fe043ea1SJoe Perches } 2714fe043ea1SJoe Perches 27150d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 27160d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 27170d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 27180d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 27190d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 27200d7835fcSJoe Perches $orig_desc = $1; 272119c146a6SJoe Perches $hasparens = 1; 27220d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 27230d7835fcSJoe Perches defined $rawlines[$linenr] && 27240d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 27250d7835fcSJoe Perches $orig_desc = $1; 272619c146a6SJoe Perches $hasparens = 1; 2727b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2728b671fde0SJoe Perches defined $rawlines[$linenr] && 2729b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2730b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2731b671fde0SJoe Perches $orig_desc = $1; 2732b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2733b671fde0SJoe Perches $orig_desc .= " " . $1; 273419c146a6SJoe Perches $hasparens = 1; 27350d7835fcSJoe Perches } 27360d7835fcSJoe Perches 27370d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 27380d7835fcSJoe Perches $id, $orig_desc); 27390d7835fcSJoe Perches 2740948b133aSHeinrich Schuchardt if (defined($id) && 2741948b133aSHeinrich Schuchardt ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { 2742d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 27430d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 27440d7835fcSJoe Perches } 2745d311cd44SJoe Perches } 2746d311cd44SJoe Perches 274713f1937eSJoe Perches# Check for added, moved or deleted files 274813f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 274913f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 275013f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 275113f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 275213f1937eSJoe Perches (defined($1) || defined($2))))) { 2753a82603a8SAndrew Jeffery $is_patch = 1; 275413f1937eSJoe Perches $reported_maintainer_file = 1; 275513f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 275613f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 275713f1937eSJoe Perches } 275813f1937eSJoe Perches 275900df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 27608905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2761000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2762000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 27636c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2764de7d4f0eSAndy Whitcroft } 2765de7d4f0eSAndy Whitcroft 2766de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2767de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2768171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2769171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2770171ae1a4SAndy Whitcroft 2771171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2772171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2773171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2774171ae1a4SAndy Whitcroft 277534d99219SJoe Perches CHK("INVALID_UTF8", 2776000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 277700df344fSAndy Whitcroft } 27780a920b5bSAndy Whitcroft 277915662b3eSJoe Perches# Check if it's the start of a commit log 278015662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 278115662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 2782eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 2783eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 278415662b3eSJoe Perches $in_header_lines = 0; 278515662b3eSJoe Perches $in_commit_log = 1; 2786ed43c4e5SAllen Hubbe $has_commit_log = 1; 278715662b3eSJoe Perches } 278815662b3eSJoe Perches 2789fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2790fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2791fa64205dSPasi Savanainen if ($in_header_lines && 2792fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2793fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2794fa64205dSPasi Savanainen $non_utf8_charset = 1; 2795fa64205dSPasi Savanainen } 2796fa64205dSPasi Savanainen 2797fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 279815662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2799fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 280015662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 280115662b3eSJoe Perches } 280215662b3eSJoe Perches 2803d6430f71SJoe Perches# Check for absolute kernel paths in commit message 2804d6430f71SJoe Perches if ($tree && $in_commit_log) { 2805d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 2806d6430f71SJoe Perches my $file = $1; 2807d6430f71SJoe Perches 2808d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 2809d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 2810d6430f71SJoe Perches # 2811d6430f71SJoe Perches } else { 2812d6430f71SJoe Perches check_absolute_file($file, $herecurr); 2813d6430f71SJoe Perches } 2814d6430f71SJoe Perches } 2815d6430f71SJoe Perches } 2816d6430f71SJoe Perches 281766b47b4aSKees Cook# Check for various typo / spelling mistakes 281866d7a382SJoe Perches if (defined($misspellings) && 281966d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2820ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 282166b47b4aSKees Cook my $typo = $1; 282266b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 282366b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 282466b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 28250675a8fbSJean Delvare my $msg_level = \&WARN; 28260675a8fbSJean Delvare $msg_level = \&CHK if ($file); 28270675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 282866b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 282966b47b4aSKees Cook $fix) { 283066b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 283166b47b4aSKees Cook } 283266b47b4aSKees Cook } 283366b47b4aSKees Cook } 283466b47b4aSKees Cook 283530670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 283630670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 283700df344fSAndy Whitcroft 28380a920b5bSAndy Whitcroft#trailing whitespace 28399c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2840c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2841d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2842d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2843d5e616fcSJoe Perches $fix) { 2844194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2845d5e616fcSJoe Perches } 2846c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2847c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28483705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 28493705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 28503705ce5bSJoe Perches $fix) { 2851194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 28523705ce5bSJoe Perches } 28533705ce5bSJoe Perches 2854d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 28550a920b5bSAndy Whitcroft } 28565368df20SAndy Whitcroft 28574783f894SJosh Triplett# Check for FSF mailing addresses. 2858109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 28591bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 28603e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 28613e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 28624783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28630675a8fbSJean Delvare my $msg_level = \&ERROR; 28640675a8fbSJean Delvare $msg_level = \&CHK if ($file); 28650675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 28664783f894SJosh 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) 28674783f894SJosh Triplett } 28684783f894SJosh Triplett 28693354957aSAndi Kleen# check for Kconfig help text having a real description 28709fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 28719fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 28723354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 2873678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 2874678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 2875678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 2876678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 28773354957aSAndi Kleen my $length = 0; 28789fe287d7SAndy Whitcroft my $cnt = $realcnt; 28799fe287d7SAndy Whitcroft my $ln = $linenr + 1; 28809fe287d7SAndy Whitcroft my $f; 2881a1385803SAndy Whitcroft my $is_start = 0; 28829fe287d7SAndy Whitcroft my $is_end = 0; 2883a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 28849fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 28859fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 28869fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 28879fe287d7SAndy Whitcroft 28889fe287d7SAndy Whitcroft next if ($f =~ /^-/); 28898d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2890a1385803SAndy Whitcroft 289186adf1a0SUlf Magnusson if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 2892a1385803SAndy Whitcroft $is_start = 1; 289384af7a61SUlf Magnusson } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) { 289484af7a61SUlf Magnusson if ($lines[$ln - 1] =~ "---help---") { 289584af7a61SUlf Magnusson WARN("CONFIG_DESCRIPTION", 289684af7a61SUlf Magnusson "prefer 'help' over '---help---' for new help texts\n" . $herecurr); 289784af7a61SUlf Magnusson } 2898a1385803SAndy Whitcroft $length = -1; 2899a1385803SAndy Whitcroft } 2900a1385803SAndy Whitcroft 29019fe287d7SAndy Whitcroft $f =~ s/^.//; 29023354957aSAndi Kleen $f =~ s/#.*//; 29033354957aSAndi Kleen $f =~ s/^\s+//; 29043354957aSAndi Kleen next if ($f =~ /^$/); 2905678ae162SUlf Magnusson 2906678ae162SUlf Magnusson # This only checks context lines in the patch 2907678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 2908678ae162SUlf Magnusson # positives, even though some of these are 2909678ae162SUlf Magnusson # common words in help texts 2910678ae162SUlf Magnusson if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| 2911678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 29129fe287d7SAndy Whitcroft $is_end = 1; 29139fe287d7SAndy Whitcroft last; 29149fe287d7SAndy Whitcroft } 29153354957aSAndi Kleen $length++; 29163354957aSAndi Kleen } 291756193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2918000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 291956193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 292056193274SVadim Bendebury } 2921a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 29223354957aSAndi Kleen } 29233354957aSAndi Kleen 2924628f91a2SJoe Perches# check for MAINTAINERS entries that don't have the right form 2925628f91a2SJoe Perches if ($realfile =~ /^MAINTAINERS$/ && 2926628f91a2SJoe Perches $rawline =~ /^\+[A-Z]:/ && 2927628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 2928628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 2929628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 2930628f91a2SJoe Perches $fix) { 2931628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 2932628f91a2SJoe Perches } 2933628f91a2SJoe Perches } 2934628f91a2SJoe Perches 2935327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2936327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2937327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2938327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2939327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2940327953e9SChristoph Jaeger } 2941327953e9SChristoph Jaeger 2942c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2943c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2944c68e5878SArnaud Lacombe my $flag = $1; 2945c68e5878SArnaud Lacombe my $replacement = { 2946c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2947c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2948c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2949c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2950c68e5878SArnaud Lacombe }; 2951c68e5878SArnaud Lacombe 2952c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2953c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2954c68e5878SArnaud Lacombe } 2955c68e5878SArnaud Lacombe 2956bff5da43SRob Herring# check for DT compatible documentation 29577dd05b38SFlorian Vaussard if (defined $root && 29587dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 29597dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 29607dd05b38SFlorian Vaussard 2961bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2962bff5da43SRob Herring 2963cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2964cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2965cc93319bSFlorian Vaussard 2966bff5da43SRob Herring foreach my $compat (@compats) { 2967bff5da43SRob Herring my $compat2 = $compat; 2968185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2969185d566bSRob Herring my $compat3 = $compat; 2970185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2971185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2972bff5da43SRob Herring if ( $? >> 8 ) { 2973bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2974bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2975bff5da43SRob Herring } 2976bff5da43SRob Herring 29774fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 29784fbf32a6SFlorian Vaussard my $vendor = $1; 2979cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2980bff5da43SRob Herring if ( $? >> 8 ) { 2981bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2982cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2983bff5da43SRob Herring } 2984bff5da43SRob Herring } 2985bff5da43SRob Herring } 2986bff5da43SRob Herring 29879f3a8992SRob Herring# check for using SPDX license tag at beginning of files 29889f3a8992SRob Herring if ($realline == $checklicenseline) { 29899f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 29909f3a8992SRob Herring $checklicenseline = 2; 29919f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 29929f3a8992SRob Herring my $comment = ""; 29939f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 29949f3a8992SRob Herring $comment = '/*'; 29959f3a8992SRob Herring } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 29969f3a8992SRob Herring $comment = '//'; 29979f3a8992SRob Herring } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) { 29989f3a8992SRob Herring $comment = '#'; 29999f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 30009f3a8992SRob Herring $comment = '..'; 30019f3a8992SRob Herring } 30029f3a8992SRob Herring 30039f3a8992SRob Herring if ($comment !~ /^$/ && 30049f3a8992SRob Herring $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) { 30059f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 30069f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 30073b6e8ac9SJoe Perches } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) { 30083b6e8ac9SJoe Perches my $spdx_license = $1; 30093b6e8ac9SJoe Perches if (!is_SPDX_License_valid($spdx_license)) { 30103b6e8ac9SJoe Perches WARN("SPDX_LICENSE_TAG", 30113b6e8ac9SJoe Perches "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr); 30123b6e8ac9SJoe Perches } 30139f3a8992SRob Herring } 30149f3a8992SRob Herring } 30159f3a8992SRob Herring } 30169f3a8992SRob Herring 30175368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 3018d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 30195368df20SAndy Whitcroft 302047e0c88bSJoe Perches# line length limit (with some exclusions) 302147e0c88bSJoe Perches# 302247e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 302347e0c88bSJoe Perches# logging functions like pr_info that end in a string 302447e0c88bSJoe Perches# lines with a single string 302547e0c88bSJoe Perches# #defines that are a single string 30262e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 302747e0c88bSJoe Perches# 302847e0c88bSJoe Perches# There are 3 different line length message types: 3029ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 303047e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 303147e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 303247e0c88bSJoe Perches# 303347e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 303447e0c88bSJoe Perches# 303547e0c88bSJoe Perches 3036b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 303747e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 303847e0c88bSJoe Perches 303947e0c88bSJoe Perches # Check the allowed long line types first 304047e0c88bSJoe Perches 304147e0c88bSJoe Perches # logging functions that end in a string that starts 304247e0c88bSJoe Perches # before $max_line_length 304347e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 304447e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 304547e0c88bSJoe Perches $msg_type = ""; 304647e0c88bSJoe Perches 304747e0c88bSJoe Perches # lines with only strings (w/ possible termination) 304847e0c88bSJoe Perches # #defines with only strings 304947e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 305047e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 305147e0c88bSJoe Perches $msg_type = ""; 305247e0c88bSJoe Perches 3053cc147506SJoe Perches # More special cases 3054cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3055cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3056d560a5f8SJoe Perches $msg_type = ""; 3057d560a5f8SJoe Perches 30582e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 30592e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 30602e4bbbc5SAndreas Brauchli $msg_type = ""; 30612e4bbbc5SAndreas Brauchli 306247e0c88bSJoe Perches # Otherwise set the alternate message types 306347e0c88bSJoe Perches 306447e0c88bSJoe Perches # a comment starts before $max_line_length 306547e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 306647e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 306747e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 306847e0c88bSJoe Perches 306947e0c88bSJoe Perches # a quoted string starts before $max_line_length 307047e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 307147e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 307247e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 307347e0c88bSJoe Perches } 307447e0c88bSJoe Perches 307547e0c88bSJoe Perches if ($msg_type ne "" && 307647e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 307747e0c88bSJoe Perches WARN($msg_type, 30786cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 30790a920b5bSAndy Whitcroft } 308047e0c88bSJoe Perches } 30810a920b5bSAndy Whitcroft 30828905a67cSAndy Whitcroft# check for adding lines without a newline. 30838905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 3084000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 3085000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 30868905a67cSAndy Whitcroft } 30878905a67cSAndy Whitcroft 3088b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3089de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 30900a920b5bSAndy Whitcroft 30910a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 30920a920b5bSAndy Whitcroft# more than 8 must use tabs. 3093c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3094c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3095c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3096d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 30973705ce5bSJoe Perches if (ERROR("CODE_INDENT", 30983705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 30993705ce5bSJoe Perches $fix) { 3100194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 31013705ce5bSJoe Perches } 31020a920b5bSAndy Whitcroft } 31030a920b5bSAndy Whitcroft 310408e44365SAlberto Panizzo# check for space before tabs. 310508e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 310608e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 31073705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 31083705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 31093705ce5bSJoe Perches $fix) { 3110194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3111d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 3112194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3113c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 31143705ce5bSJoe Perches } 311508e44365SAlberto Panizzo } 311608e44365SAlberto Panizzo 31176a487211SJoe Perches# check for assignments on the start of a line 31186a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 31196a487211SJoe Perches CHK("ASSIGNMENT_CONTINUATIONS", 31206a487211SJoe Perches "Assignment operator '$1' should be on the previous line\n" . $hereprev); 31216a487211SJoe Perches } 31226a487211SJoe Perches 3123d1fe9c09SJoe Perches# check for && or || at the start of a line 3124d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 3125d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 3126d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 3127d1fe9c09SJoe Perches } 3128d1fe9c09SJoe Perches 3129a91e8994SJoe Perches# check indentation starts on a tab stop 31305b57980dSJoe Perches if ($perl_version_ok && 3131bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3132a91e8994SJoe Perches my $indent = length($1); 3133a91e8994SJoe Perches if ($indent % 8) { 3134a91e8994SJoe Perches if (WARN("TABSTOP", 3135a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3136a91e8994SJoe Perches $fix) { 3137a91e8994SJoe Perches $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; 3138a91e8994SJoe Perches } 3139a91e8994SJoe Perches } 3140a91e8994SJoe Perches } 3141a91e8994SJoe Perches 3142d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 31435b57980dSJoe Perches if ($perl_version_ok && 3144fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3145d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3146d1fe9c09SJoe Perches my $oldindent = $1; 3147d1fe9c09SJoe Perches my $rest = $2; 3148d1fe9c09SJoe Perches 3149d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3150d1fe9c09SJoe Perches if ($pos >= 0) { 3151b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3152b34a26f3SJoe Perches my $newindent = $2; 3153d1fe9c09SJoe Perches 3154d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3155d1fe9c09SJoe Perches "\t" x ($pos / 8) . 3156d1fe9c09SJoe Perches " " x ($pos % 8); 3157d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3158d1fe9c09SJoe Perches 3159d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3160d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 31613705ce5bSJoe Perches 31623705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 31633705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 31643705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3165194f66fcSJoe Perches $fixed[$fixlinenr] =~ 31663705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 31673705ce5bSJoe Perches } 3168d1fe9c09SJoe Perches } 3169d1fe9c09SJoe Perches } 3170d1fe9c09SJoe Perches } 3171d1fe9c09SJoe Perches 31726ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 31736ab3a970SJoe Perches# avoid checking a few false positives: 31746ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 31756ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 31766ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 31776ab3a970SJoe Perches# multiline macros that define functions 31786ab3a970SJoe Perches# known attributes or the __attribute__ keyword 31796ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 31806ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 31813705ce5bSJoe Perches if (CHK("SPACING", 3182f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 31833705ce5bSJoe Perches $fix) { 3184194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3185f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 31863705ce5bSJoe Perches } 3187aad4f614SJoe Perches } 3188aad4f614SJoe Perches 318986406b1cSJoe Perches# Block comment styles 319086406b1cSJoe Perches# Networking with an initial /* 319105880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3192fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 319385ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 319485ad978cSJoe Perches $realline > 2) { 319505880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 319605880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 319705880600SJoe Perches } 319805880600SJoe Perches 319986406b1cSJoe Perches# Block comments use * on subsequent lines 320086406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 320186406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3202a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 320361135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3204a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 320586406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 320686406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3207a605e32eSJoe Perches } 3208a605e32eSJoe Perches 320986406b1cSJoe Perches# Block comments use */ on trailing lines 321086406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3211c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3212c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3213c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 321486406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 321586406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 321605880600SJoe Perches } 321705880600SJoe Perches 321808eb9b80SJoe Perches# Block comment * alignment 321908eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3220af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3221af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3222af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 322308eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3224af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3225af207524SJoe Perches my $oldindent; 322608eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3227af207524SJoe Perches if (defined($1)) { 3228af207524SJoe Perches $oldindent = expand_tabs($1); 3229af207524SJoe Perches } else { 3230af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3231af207524SJoe Perches $oldindent = expand_tabs($1); 3232af207524SJoe Perches } 323308eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 323408eb9b80SJoe Perches my $newindent = $1; 323508eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3236af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 323708eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 323808eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 323908eb9b80SJoe Perches } 324008eb9b80SJoe Perches } 324108eb9b80SJoe Perches 32427f619191SJoe Perches# check for missing blank lines after struct/union declarations 32437f619191SJoe Perches# with exceptions for various attributes and macros 32447f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 32457f619191SJoe Perches $line =~ /^\+/ && 32467f619191SJoe Perches !($line =~ /^\+\s*$/ || 32477f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 32487f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 32497f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 32507f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 32517f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 32527f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 32530bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 32547f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3255d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3256d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3257d752fcc8SJoe Perches $fix) { 3258f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3259d752fcc8SJoe Perches } 32607f619191SJoe Perches } 32617f619191SJoe Perches 3262365dd4eaSJoe Perches# check for multiple consecutive blank lines 3263365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3264365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3265365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3266d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3267d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3268d752fcc8SJoe Perches $fix) { 3269f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3270d752fcc8SJoe Perches } 3271d752fcc8SJoe Perches 3272365dd4eaSJoe Perches $last_blank_line = $linenr; 3273365dd4eaSJoe Perches } 3274365dd4eaSJoe Perches 32753b617e3bSJoe Perches# check for missing blank lines after declarations 32763f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 32773f7bac03SJoe Perches # actual declarations 32783f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 32795a4e1fd3SJoe Perches # function pointer declarations 32805a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 32813f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 32823f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 32833f7bac03SJoe Perches # known declaration macros 32843f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 32853f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 32863f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 32873f7bac03SJoe Perches # other possible extensions of declaration lines 32883f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 32893f7bac03SJoe Perches # not starting a section or a macro "\" extended line 32903f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 32913f7bac03SJoe Perches # looks like a declaration 32923f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 32935a4e1fd3SJoe Perches # function pointer declarations 32945a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 32953f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 32963f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 32973f7bac03SJoe Perches # known declaration macros 32983f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 32993f7bac03SJoe Perches # start of struct or union or enum 33003b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 33013f7bac03SJoe Perches # start or end of block or continuation of declaration 33023f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 33033f7bac03SJoe Perches # bitfield continuation 33043f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 33053f7bac03SJoe Perches # other possible extensions of declaration lines 33063f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 33073f7bac03SJoe Perches # indentation of previous and current line are the same 33083f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3309d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3310d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3311d752fcc8SJoe Perches $fix) { 3312f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3313d752fcc8SJoe Perches } 33143b617e3bSJoe Perches } 33153b617e3bSJoe Perches 33165f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 33176b4c5bebSAndy Whitcroft# Exceptions: 33186b4c5bebSAndy Whitcroft# 1) within comments 33196b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 33206b4c5bebSAndy Whitcroft# 3) hanging labels 33213705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 33225f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 33233705ce5bSJoe Perches if (WARN("LEADING_SPACE", 33243705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 33253705ce5bSJoe Perches $fix) { 3326194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 33273705ce5bSJoe Perches } 33285f7ddae6SRaffaele Recalcati } 33295f7ddae6SRaffaele Recalcati 3330b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3331b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3332b9ea10d6SAndy Whitcroft 33335751a24eSJoe Perches# check for unusual line ending [ or ( 33345751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 33355751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 33365751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 33375751a24eSJoe Perches } 33385751a24eSJoe Perches 33394dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 33404dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 33414dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 33424dbed76fSJoe Perches $context_function = $1; 33434dbed76fSJoe Perches } 33444dbed76fSJoe Perches 33454dbed76fSJoe Perches# check if this appears to be the end of function declaration 33464dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 33474dbed76fSJoe Perches undef $context_function; 33484dbed76fSJoe Perches } 33494dbed76fSJoe Perches 3350032a4c0fSJoe Perches# check indentation of any line with a bare else 3351840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3352032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3353032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3354032a4c0fSJoe Perches my $tabs = length($1) + 1; 3355840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3356840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3357840080a0SJoe Perches defined $lines[$linenr] && 3358840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3359032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3360032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3361032a4c0fSJoe Perches } 3362032a4c0fSJoe Perches } 3363032a4c0fSJoe Perches 3364c00df19aSJoe Perches# check indentation of a line with a break; 3365c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3366c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3367c00df19aSJoe Perches my $tabs = $1; 3368c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3369c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3370c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3371c00df19aSJoe Perches } 3372c00df19aSJoe Perches } 3373c00df19aSJoe Perches 3374c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3375cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3376000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3377000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3378c2fdda0dSAndy Whitcroft } 337922f2a2efSAndy Whitcroft 338056e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 338156e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 338256e77d70SJoe Perches WARN("HOTPLUG_SECTION", 338356e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 338456e77d70SJoe Perches } 338556e77d70SJoe Perches 33869c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 33872b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 33882b474a1aSAndy Whitcroft $realline_next); 33893e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 3390ca819864SJoe Perches if ($linenr > $suppress_statement && 33911b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3392170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3393f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3394171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3395171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3396171ae1a4SAndy Whitcroft 33973e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 33983e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 33993e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 34003e469cdcSAndy Whitcroft # until we hit end of it. 34013e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 34023e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 34033e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 34043e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 34053e469cdcSAndy Whitcroft } 3406f74bd194SAndy Whitcroft 34072b474a1aSAndy Whitcroft # Find the real next line. 34082b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 34092b474a1aSAndy Whitcroft if (defined $realline_next && 34102b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 34112b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 34122b474a1aSAndy Whitcroft $realline_next++; 34132b474a1aSAndy Whitcroft } 34142b474a1aSAndy Whitcroft 3415171ae1a4SAndy Whitcroft my $s = $stat; 3416171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3417cf655043SAndy Whitcroft 3418c2fdda0dSAndy Whitcroft # Ignore goto labels. 3419171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3420c2fdda0dSAndy Whitcroft 3421c2fdda0dSAndy Whitcroft # Ignore functions being called 3422171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3423c2fdda0dSAndy Whitcroft 3424463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3425463f2864SAndy Whitcroft 3426c45dcabdSAndy Whitcroft # declarations always start with types 3427d2506586SAndy 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) { 3428c45dcabdSAndy Whitcroft my $type = $1; 3429c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3430c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3431c45dcabdSAndy Whitcroft 34326c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3433a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3434c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3435c2fdda0dSAndy Whitcroft } 34368905a67cSAndy Whitcroft 34376c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 343865863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3439c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 34409c0ca6f9SAndy Whitcroft } 34418905a67cSAndy Whitcroft 34428905a67cSAndy Whitcroft # Check for any sort of function declaration. 34438905a67cSAndy Whitcroft # int foo(something bar, other baz); 34448905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3445171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 34468905a67cSAndy Whitcroft my ($name_len) = length($1); 34478905a67cSAndy Whitcroft 3448cf655043SAndy Whitcroft my $ctx = $s; 3449773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 34508905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3451cf655043SAndy Whitcroft 34528905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3453c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 34548905a67cSAndy Whitcroft 3455c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 34568905a67cSAndy Whitcroft } 34578905a67cSAndy Whitcroft } 34588905a67cSAndy Whitcroft } 34598905a67cSAndy Whitcroft 34609c0ca6f9SAndy Whitcroft } 34619c0ca6f9SAndy Whitcroft 346200df344fSAndy Whitcroft# 346300df344fSAndy Whitcroft# Checks which may be anchored in the context. 346400df344fSAndy Whitcroft# 346500df344fSAndy Whitcroft 346600df344fSAndy Whitcroft# Check for switch () and associated case and default 346700df344fSAndy Whitcroft# statements should be at the same indent. 346800df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 346900df344fSAndy Whitcroft my $err = ''; 347000df344fSAndy Whitcroft my $sep = ''; 347100df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 347200df344fSAndy Whitcroft shift(@ctx); 347300df344fSAndy Whitcroft for my $ctx (@ctx) { 347400df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 347500df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 347600df344fSAndy Whitcroft $indent != $cindent) { 347700df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 347800df344fSAndy Whitcroft $sep = ''; 347900df344fSAndy Whitcroft } else { 348000df344fSAndy Whitcroft $sep = "[...]\n"; 348100df344fSAndy Whitcroft } 348200df344fSAndy Whitcroft } 348300df344fSAndy Whitcroft if ($err ne '') { 3484000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3485000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3486de7d4f0eSAndy Whitcroft } 3487de7d4f0eSAndy Whitcroft } 3488de7d4f0eSAndy Whitcroft 3489de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3490de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 34910fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3492773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3493773647a0SAndy Whitcroft 34949c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 34958eef05ddSJoe Perches 34968eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 34978eef05ddSJoe Perches WARN("DEEP_INDENTATION", 34988eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 34998eef05ddSJoe Perches } 35008eef05ddSJoe Perches 3501de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3502de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3503de7d4f0eSAndy Whitcroft 3504548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3505548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3506de7d4f0eSAndy Whitcroft 3507548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3508548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3509548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3510548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3511548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3512773647a0SAndy Whitcroft $ctx_ln++; 3513773647a0SAndy Whitcroft } 3514548596d5SAndy Whitcroft 351553210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 351653210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3517773647a0SAndy Whitcroft 3518773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3519000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3520000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 352101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 352200df344fSAndy Whitcroft } 3523773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3524773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3525773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3526773647a0SAndy Whitcroft { 35279c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 35289c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3529000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3530000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 353101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 35329c0ca6f9SAndy Whitcroft } 35339c0ca6f9SAndy Whitcroft } 353400df344fSAndy Whitcroft } 353500df344fSAndy Whitcroft 35364d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 3537f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 35383e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 35393e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 35403e469cdcSAndy Whitcroft if (!defined $stat); 35414d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 35424d001e4dSAndy Whitcroft 35434d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 35444d001e4dSAndy Whitcroft 35459f5af480SJoe Perches # remove inline comments 35469f5af480SJoe Perches $s =~ s/$;/ /g; 35479f5af480SJoe Perches $c =~ s/$;/ /g; 35484d001e4dSAndy Whitcroft 35494d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 35506f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 35516f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 35524d001e4dSAndy Whitcroft 35539f5af480SJoe Perches # Make sure we remove the line prefixes as we have 35549f5af480SJoe Perches # none on the first line, and are going to readd them 35559f5af480SJoe Perches # where necessary. 35569f5af480SJoe Perches $s =~ s/\n./\n/gs; 35579f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 35589f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 35599f5af480SJoe Perches } 35609f5af480SJoe Perches 35614d001e4dSAndy Whitcroft # We want to check the first line inside the block 35624d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 35634d001e4dSAndy Whitcroft # 1) any blank line termination 35644d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 35654d001e4dSAndy Whitcroft # 3) any do (...) { 35664d001e4dSAndy Whitcroft my $continuation = 0; 35674d001e4dSAndy Whitcroft my $check = 0; 35684d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 35694d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 35704d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 35714d001e4dSAndy Whitcroft $continuation = 1; 35724d001e4dSAndy Whitcroft } 35739bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 35744d001e4dSAndy Whitcroft $check = 1; 35754d001e4dSAndy Whitcroft $cond_lines++; 35764d001e4dSAndy Whitcroft } 35774d001e4dSAndy Whitcroft 35784d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 35794d001e4dSAndy Whitcroft # preprocessor statement. 35804d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 35814d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 35824d001e4dSAndy Whitcroft $check = 0; 35834d001e4dSAndy Whitcroft } 35844d001e4dSAndy Whitcroft 35859bd49efeSAndy Whitcroft my $cond_ptr = -1; 3586740504c6SAndy Whitcroft $continuation = 0; 35879bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 35889bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 35894d001e4dSAndy Whitcroft 3590f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3591f16fa28fSAndy Whitcroft # is not linear. 3592f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3593f16fa28fSAndy Whitcroft $check = 0; 3594f16fa28fSAndy Whitcroft } 3595f16fa28fSAndy Whitcroft 35969bd49efeSAndy Whitcroft # Ignore: 35979bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 35989bd49efeSAndy Whitcroft # 2) preprocessor lines, and 35999bd49efeSAndy Whitcroft # 3) labels. 3600740504c6SAndy Whitcroft if ($continuation || 3601740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 36029bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 36039bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3604740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 360530dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 36069bd49efeSAndy Whitcroft $cond_lines++; 36079bd49efeSAndy Whitcroft } 36084d001e4dSAndy Whitcroft } 360930dad6ebSAndy Whitcroft } 36104d001e4dSAndy Whitcroft 36114d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 36124d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 36134d001e4dSAndy Whitcroft 36144d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 36154d001e4dSAndy Whitcroft # this is not this patch's fault. 36164d001e4dSAndy Whitcroft if (!defined($stat_real) || 36174d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 36184d001e4dSAndy Whitcroft $check = 0; 36194d001e4dSAndy Whitcroft } 36204d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 36214d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 36224d001e4dSAndy Whitcroft } 36234d001e4dSAndy Whitcroft 36249bd49efeSAndy 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"; 36254d001e4dSAndy Whitcroft 36269f5af480SJoe Perches if ($check && $s ne '' && 36279f5af480SJoe Perches (($sindent % 8) != 0 || 36289f5af480SJoe Perches ($sindent < $indent) || 3629f6950a73SJoe Perches ($sindent == $indent && 3630f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 36319f5af480SJoe Perches ($sindent > $indent + 8))) { 3632000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3633000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 36344d001e4dSAndy Whitcroft } 36354d001e4dSAndy Whitcroft } 36364d001e4dSAndy Whitcroft 36376c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 36386c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 36391f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 36401f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 36416c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3642c2fdda0dSAndy Whitcroft if ($dbg_values) { 3643c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3644cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3645cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 36461f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3647c2fdda0dSAndy Whitcroft } 36486c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 36496c72ffaaSAndy Whitcroft 365000df344fSAndy Whitcroft#ignore lines not being added 36513705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 365200df344fSAndy Whitcroft 365311ca40a0SJoe Perches# check for dereferences that span multiple lines 365411ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 365511ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 365611ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 365711ca40a0SJoe Perches my $ref = $1; 365811ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 365911ca40a0SJoe Perches $ref .= $1; 366011ca40a0SJoe Perches $ref =~ s/\s//g; 366111ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 366211ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 366311ca40a0SJoe Perches } 366411ca40a0SJoe Perches 3665a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3666c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3667a1ce18e4SJoe Perches my $type = $1; 3668a1ce18e4SJoe Perches my $var = $2; 3669207a8e84SJoe Perches $var = "" if (!defined $var); 3670207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3671a1ce18e4SJoe Perches my $sign = $1; 3672a1ce18e4SJoe Perches my $pointer = $2; 3673a1ce18e4SJoe Perches 3674a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3675a1ce18e4SJoe Perches 3676a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3677a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3678a1ce18e4SJoe Perches $fix) { 3679a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3680207a8e84SJoe Perches my $comp_pointer = $pointer; 3681207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 3682207a8e84SJoe Perches $decl .= $comp_pointer; 3683207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 3684207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 3685a1ce18e4SJoe Perches } 3686a1ce18e4SJoe Perches } 3687a1ce18e4SJoe Perches } 3688a1ce18e4SJoe Perches 3689653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 36907429c690SAndy Whitcroft if ($dbg_type) { 36917429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3692000d1cc1SJoe Perches ERROR("TEST_TYPE", 3693000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 36947429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3695000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3696000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 36977429c690SAndy Whitcroft } 3698653d4876SAndy Whitcroft next; 3699653d4876SAndy Whitcroft } 3700a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3701a1ef277eSAndy Whitcroft if ($dbg_attr) { 37029360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3703000d1cc1SJoe Perches ERROR("TEST_ATTR", 3704000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 37059360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3706000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3707000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3708a1ef277eSAndy Whitcroft } 3709a1ef277eSAndy Whitcroft next; 3710a1ef277eSAndy Whitcroft } 3711653d4876SAndy Whitcroft 3712f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 371399423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 371499423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3715d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3716d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3717f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3718f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3719f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3720d752fcc8SJoe Perches my $fixedline = $prevrawline; 3721d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3722f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3723d752fcc8SJoe Perches $fixedline = $line; 37248d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 3725f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3726d752fcc8SJoe Perches } 3727f0a594c1SAndy Whitcroft } 3728f0a594c1SAndy Whitcroft 372900df344fSAndy Whitcroft# 373000df344fSAndy Whitcroft# Checks which are anchored on the added line. 373100df344fSAndy Whitcroft# 373200df344fSAndy Whitcroft 3733653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3734c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3735653d4876SAndy Whitcroft my $path = $1; 3736653d4876SAndy Whitcroft if ($path =~ m{//}) { 3737000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3738495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3739495e9d84SJoe Perches } 3740495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3741495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3742495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3743653d4876SAndy Whitcroft } 3744653d4876SAndy Whitcroft } 3745653d4876SAndy Whitcroft 374600df344fSAndy Whitcroft# no C99 // comments 374700df344fSAndy Whitcroft if ($line =~ m{//}) { 37483705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 37493705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 37503705ce5bSJoe Perches $fix) { 3751194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 37523705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 37533705ce5bSJoe Perches my $comment = trim($1); 3754194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 37553705ce5bSJoe Perches } 37563705ce5bSJoe Perches } 375700df344fSAndy Whitcroft } 375800df344fSAndy Whitcroft # Remove C99 comments. 37590a920b5bSAndy Whitcroft $line =~ s@//.*@@; 37606c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 37610a920b5bSAndy Whitcroft 37622b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 37632b474a1aSAndy Whitcroft# the whole statement. 37642b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 37652b474a1aSAndy Whitcroft if (defined $realline_next && 37662b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 37672b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 37682b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 37692b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 37703cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 37713cbf62dfSAndy Whitcroft # a prefix: 37723cbf62dfSAndy Whitcroft # XXX(foo); 37733cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3774653d4876SAndy Whitcroft my $name = $1; 377587a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 37763cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 37773cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 37783cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 37793cbf62dfSAndy Whitcroft 37803cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 37812b474a1aSAndy Whitcroft \n.}\s*$| 378248012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 378348012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 378448012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 37852b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 37862b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 378748012058SAndy Whitcroft )/x) { 37882b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 37892b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 37902b474a1aSAndy Whitcroft } else { 37912b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 37920a920b5bSAndy Whitcroft } 37930a920b5bSAndy Whitcroft } 37942b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 37952b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 37962b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 37972b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 37982b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 37992b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 38002b474a1aSAndy Whitcroft } 38012b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 38022b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3803000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3804000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 38052b474a1aSAndy Whitcroft } 38060a920b5bSAndy Whitcroft 38075150bda4SJoe Eloff# check for global initialisers. 38086d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 3809d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 38106d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 3811d5e616fcSJoe Perches $fix) { 38126d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 3813d5e616fcSJoe Perches } 3814f0a594c1SAndy Whitcroft } 38150a920b5bSAndy Whitcroft# check for static initialisers. 38166d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 3817d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 38186d32f7a3SJoe Perches "do not initialise statics to $1\n" . 3819d5e616fcSJoe Perches $herecurr) && 3820d5e616fcSJoe Perches $fix) { 38216d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 3822d5e616fcSJoe Perches } 38230a920b5bSAndy Whitcroft } 38240a920b5bSAndy Whitcroft 38251813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 38261813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 38271813087dSJoe Perches my $tmp = trim($1); 38281813087dSJoe Perches WARN("MISORDERED_TYPE", 38291813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 38301813087dSJoe Perches } 38311813087dSJoe Perches 3832*809e082eSJoe Perches# check for unnecessary <signed> int declarations of short/long/long long 3833*809e082eSJoe Perches while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) { 3834*809e082eSJoe Perches my $type = trim($1); 3835*809e082eSJoe Perches next if ($type !~ /\bint\b/); 3836*809e082eSJoe Perches next if ($type !~ /\b(?:short|long\s+long|long)\b/); 3837*809e082eSJoe Perches my $new_type = $type; 3838*809e082eSJoe Perches $new_type =~ s/\b\s*int\s*\b/ /; 3839*809e082eSJoe Perches $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /; 3840*809e082eSJoe Perches $new_type =~ s/^const\s+//; 3841*809e082eSJoe Perches $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/); 3842*809e082eSJoe Perches $new_type = "const $new_type" if ($type =~ /^const\b/); 3843*809e082eSJoe Perches $new_type =~ s/\s+/ /g; 3844*809e082eSJoe Perches $new_type = trim($new_type); 3845*809e082eSJoe Perches if (WARN("UNNECESSARY_INT", 3846*809e082eSJoe Perches "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) && 3847*809e082eSJoe Perches $fix) { 3848*809e082eSJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/; 3849*809e082eSJoe Perches } 3850*809e082eSJoe Perches } 3851*809e082eSJoe Perches 3852cb710ecaSJoe Perches# check for static const char * arrays. 3853cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3854000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3855000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3856cb710ecaSJoe Perches $herecurr); 3857cb710ecaSJoe Perches } 3858cb710ecaSJoe Perches 3859cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3860cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3861000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3862000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3863cb710ecaSJoe Perches $herecurr); 3864cb710ecaSJoe Perches } 3865cb710ecaSJoe Perches 3866ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3867ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3868ab7e23f3SJoe Perches my $found = $1; 3869ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3870ab7e23f3SJoe Perches WARN("CONST_CONST", 3871ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3872ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3873ab7e23f3SJoe Perches WARN("CONST_CONST", 3874ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3875ab7e23f3SJoe Perches } 3876ab7e23f3SJoe Perches } 3877ab7e23f3SJoe Perches 38789b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 38799b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 38809b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 38819b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 38829b0fa60dSJoe Perches $herecurr); 38839b0fa60dSJoe Perches } 38849b0fa60dSJoe Perches 3885b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3886b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3887b598b670SJoe Perches my $array = $1; 3888b598b670SJoe 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*\))@) { 3889b598b670SJoe Perches my $array_div = $1; 3890b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3891b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3892b598b670SJoe Perches $fix) { 3893b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3894b598b670SJoe Perches } 3895b598b670SJoe Perches } 3896b598b670SJoe Perches } 3897b598b670SJoe Perches 3898b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3899b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3900b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3901b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3902b36190c5SJoe Perches $fix) { 3903194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3904b36190c5SJoe Perches } 3905b36190c5SJoe Perches } 3906b36190c5SJoe Perches 3907653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3908653d4876SAndy Whitcroft# make sense. 3909653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 39108054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3911c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 39128ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 391346d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 3914000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3915000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 39160a920b5bSAndy Whitcroft } 39170a920b5bSAndy Whitcroft 39180a920b5bSAndy Whitcroft# * goes on variable not on type 391965863862SAndy Whitcroft # (char*[ const]) 3920bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3921bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 39223705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3923d8aaf121SAndy Whitcroft 392465863862SAndy Whitcroft # Should start with a space. 392565863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 392665863862SAndy Whitcroft # Should not end with a space. 392765863862SAndy Whitcroft $to =~ s/\s+$//; 392865863862SAndy Whitcroft # '*'s should not have spaces between. 3929f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 393065863862SAndy Whitcroft } 3931d8aaf121SAndy Whitcroft 39323705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 393365863862SAndy Whitcroft if ($from ne $to) { 39343705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 39353705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 39363705ce5bSJoe Perches $fix) { 39373705ce5bSJoe Perches my $sub_from = $ident; 39383705ce5bSJoe Perches my $sub_to = $ident; 39393705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3940194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39413705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 39423705ce5bSJoe Perches } 394365863862SAndy Whitcroft } 3944bfcb2cc7SAndy Whitcroft } 3945bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3946bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 39473705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3948d8aaf121SAndy Whitcroft 394965863862SAndy Whitcroft # Should start with a space. 395065863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 395165863862SAndy Whitcroft # Should not end with a space. 395265863862SAndy Whitcroft $to =~ s/\s+$//; 395365863862SAndy Whitcroft # '*'s should not have spaces between. 3954f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 395565863862SAndy Whitcroft } 395665863862SAndy Whitcroft # Modifiers should have spaces. 395765863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 395865863862SAndy Whitcroft 39593705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3960667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 39613705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 39623705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 39633705ce5bSJoe Perches $fix) { 39643705ce5bSJoe Perches 39653705ce5bSJoe Perches my $sub_from = $match; 39663705ce5bSJoe Perches my $sub_to = $match; 39673705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3968194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39693705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 39703705ce5bSJoe Perches } 397165863862SAndy Whitcroft } 39720a920b5bSAndy Whitcroft } 39730a920b5bSAndy Whitcroft 39749d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 39759d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 39760675a8fbSJean Delvare my $msg_level = \&WARN; 39770675a8fbSJean Delvare $msg_level = \&CHK if ($file); 39780675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 39799d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 39809d3e3c70SJoe Perches } 39810a920b5bSAndy Whitcroft 39829d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 39838905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3984000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3985000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 39868905a67cSAndy Whitcroft } 39878905a67cSAndy Whitcroft 398817441227SJoe Perches# check for uses of printk_ratelimit 398917441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3990000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3991000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 399217441227SJoe Perches } 399317441227SJoe Perches 3994eeef5733SJoe Perches# printk should use KERN_* levels 3995eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 3996000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3997eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 399800df344fSAndy Whitcroft } 39990a920b5bSAndy Whitcroft 4000243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 4001243f3803SJoe Perches my $orig = $1; 4002243f3803SJoe Perches my $level = lc($orig); 4003243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 40048f26b837SJoe Perches my $level2 = $level; 40058f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 4006243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 4007daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 4008243f3803SJoe Perches } 4009243f3803SJoe Perches 4010243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 4011d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 4012d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 4013d5e616fcSJoe Perches $fix) { 4014194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4015d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 4016d5e616fcSJoe Perches } 4017243f3803SJoe Perches } 4018243f3803SJoe Perches 4019dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 4020dc139313SJoe Perches my $orig = $1; 4021dc139313SJoe Perches my $level = lc($orig); 4022dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 4023dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 4024dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 4025dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 4026dc139313SJoe Perches } 4027dc139313SJoe Perches 402891c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 402991c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 403091c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 403191c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 403291c9afafSAndy Lutomirski WARN("ENOSYS", 403391c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 403491c9afafSAndy Lutomirski } 403591c9afafSAndy Lutomirski 4036653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 4037653d4876SAndy Whitcroft# or if closed on same line 40385b57980dSJoe Perches if ($perl_version_ok && 40392d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 40402d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 40412d453e3bSJoe Perches $sline !~ /}/) { 40428d182478SJoe Perches if (ERROR("OPEN_BRACE", 40432d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 40448d182478SJoe Perches $fix) { 40458d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 40468d182478SJoe Perches my $fixed_line = $rawline; 40478d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 40488d182478SJoe Perches my $line1 = $1; 40498d182478SJoe Perches my $line2 = $2; 40508d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 40518d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 40528d182478SJoe Perches if ($line2 !~ /^\s*$/) { 40538d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 40548d182478SJoe Perches } 40558d182478SJoe Perches } 40560a920b5bSAndy Whitcroft } 4057653d4876SAndy Whitcroft 40588905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 40598905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 40608905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 40618d182478SJoe Perches if (ERROR("OPEN_BRACE", 40628d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 40638d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 40648d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 40658d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 40668d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 40678d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 40688d182478SJoe Perches $fixedline = $rawline; 40698d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 40708d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 40718d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 40728d182478SJoe Perches } 40738d182478SJoe Perches } 40748905a67cSAndy Whitcroft } 40758905a67cSAndy Whitcroft 40760c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 40773705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 40783705ce5bSJoe Perches if (WARN("SPACING", 40793705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 40803705ce5bSJoe Perches $fix) { 4081194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40823705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 40833705ce5bSJoe Perches } 40840c73b4ebSAndy Whitcroft } 40850c73b4ebSAndy Whitcroft 408631070b5dSJoe Perches# Function pointer declarations 408731070b5dSJoe Perches# check spacing between type, funcptr, and args 408831070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 408991f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 409031070b5dSJoe Perches my $declare = $1; 409131070b5dSJoe Perches my $pre_pointer_space = $2; 409231070b5dSJoe Perches my $post_pointer_space = $3; 409331070b5dSJoe Perches my $funcname = $4; 409431070b5dSJoe Perches my $post_funcname_space = $5; 409531070b5dSJoe Perches my $pre_args_space = $6; 409631070b5dSJoe Perches 409791f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 409891f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 409991f72e9cSJoe Perches# don't need a space so don't warn for those. 410091f72e9cSJoe Perches my $post_declare_space = ""; 410191f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 410291f72e9cSJoe Perches $post_declare_space = $1; 410391f72e9cSJoe Perches $declare = rtrim($declare); 410491f72e9cSJoe Perches } 410591f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 410631070b5dSJoe Perches WARN("SPACING", 410731070b5dSJoe Perches "missing space after return type\n" . $herecurr); 410891f72e9cSJoe Perches $post_declare_space = " "; 410931070b5dSJoe Perches } 411031070b5dSJoe Perches 411131070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 411291f72e9cSJoe Perches# This test is not currently implemented because these declarations are 411391f72e9cSJoe Perches# equivalent to 411491f72e9cSJoe Perches# int foo(int bar, ...) 411591f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 411691f72e9cSJoe Perches# 411791f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 411891f72e9cSJoe Perches# WARN("SPACING", 411991f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 412091f72e9cSJoe Perches# } 412131070b5dSJoe Perches 412231070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 412331070b5dSJoe Perches if (defined $pre_pointer_space && 412431070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 412531070b5dSJoe Perches WARN("SPACING", 412631070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 412731070b5dSJoe Perches } 412831070b5dSJoe Perches 412931070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 413031070b5dSJoe Perches if (defined $post_pointer_space && 413131070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 413231070b5dSJoe Perches WARN("SPACING", 413331070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 413431070b5dSJoe Perches } 413531070b5dSJoe Perches 413631070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 413731070b5dSJoe Perches if (defined $post_funcname_space && 413831070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 413931070b5dSJoe Perches WARN("SPACING", 414031070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 414131070b5dSJoe Perches } 414231070b5dSJoe Perches 414331070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 414431070b5dSJoe Perches if (defined $pre_args_space && 414531070b5dSJoe Perches $pre_args_space =~ /^\s/) { 414631070b5dSJoe Perches WARN("SPACING", 414731070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 414831070b5dSJoe Perches } 414931070b5dSJoe Perches 415031070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4151194f66fcSJoe Perches $fixed[$fixlinenr] =~ 415291f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 415331070b5dSJoe Perches } 415431070b5dSJoe Perches } 415531070b5dSJoe Perches 41568d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 41578d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4158fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4159fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 41608d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 41618d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 41628d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4163fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 416438dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 41653705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 41663705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 41673705ce5bSJoe Perches $fix) { 4168194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41693705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 41703705ce5bSJoe Perches } 41718d31cfceSAndy Whitcroft } 41728d31cfceSAndy Whitcroft } 41738d31cfceSAndy Whitcroft 4174f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 41756c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4176c2fdda0dSAndy Whitcroft my $name = $1; 4177773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4178773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4179c2fdda0dSAndy Whitcroft 4180c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4181773647a0SAndy Whitcroft if ($name =~ /^(?: 4182773647a0SAndy Whitcroft if|for|while|switch|return|case| 4183773647a0SAndy Whitcroft volatile|__volatile__| 4184773647a0SAndy Whitcroft __attribute__|format|__extension__| 4185773647a0SAndy Whitcroft asm|__asm__)$/x) 4186773647a0SAndy Whitcroft { 4187c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4188c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4189c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4190c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4191773647a0SAndy Whitcroft 4192773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4193c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4194c2fdda0dSAndy Whitcroft 4195c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4196c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4197773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4198c2fdda0dSAndy Whitcroft 4199c2fdda0dSAndy Whitcroft } else { 42003705ce5bSJoe Perches if (WARN("SPACING", 42013705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 42023705ce5bSJoe Perches $fix) { 4203194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42043705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 42053705ce5bSJoe Perches } 4206f0a594c1SAndy Whitcroft } 42076c72ffaaSAndy Whitcroft } 42089a4cad4eSEric Nelson 4209653d4876SAndy Whitcroft# Check operator spacing. 42100a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 42113705ce5bSJoe Perches my $fixed_line = ""; 42123705ce5bSJoe Perches my $line_fixed = 0; 42133705ce5bSJoe Perches 42149c0ca6f9SAndy Whitcroft my $ops = qr{ 42159c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 42169c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 42179c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 42181f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 421984731623SJoe Perches \?:|\?|: 42209c0ca6f9SAndy Whitcroft }x; 4221cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 42223705ce5bSJoe Perches 42233705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 42243705ce5bSJoe Perches## foreach my $el (@elements) { 42253705ce5bSJoe Perches## print("el: <$el>\n"); 42263705ce5bSJoe Perches## } 42273705ce5bSJoe Perches 42283705ce5bSJoe Perches my @fix_elements = (); 422900df344fSAndy Whitcroft my $off = 0; 42306c72ffaaSAndy Whitcroft 42313705ce5bSJoe Perches foreach my $el (@elements) { 42323705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 42333705ce5bSJoe Perches $off += length($el); 42343705ce5bSJoe Perches } 42353705ce5bSJoe Perches 42363705ce5bSJoe Perches $off = 0; 42373705ce5bSJoe Perches 42386c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4239b34c648bSJoe Perches my $last_after = -1; 42406c72ffaaSAndy Whitcroft 42410a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 42423705ce5bSJoe Perches 42433705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 42443705ce5bSJoe Perches 42453705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 42463705ce5bSJoe Perches 42474a0df2efSAndy Whitcroft $off += length($elements[$n]); 42484a0df2efSAndy Whitcroft 424925985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4250773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4251773647a0SAndy Whitcroft my $cc = ''; 4252773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4253773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4254773647a0SAndy Whitcroft } 4255773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4256773647a0SAndy Whitcroft 42574a0df2efSAndy Whitcroft my $a = ''; 42584a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 42594a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4260cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 42614a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 42624a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 4263773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 42644a0df2efSAndy Whitcroft 42650a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 42664a0df2efSAndy Whitcroft 42674a0df2efSAndy Whitcroft my $c = ''; 42680a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 42694a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 42704a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4271cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 42724a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 42734a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 42748b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 42754a0df2efSAndy Whitcroft } else { 42764a0df2efSAndy Whitcroft $c = 'E'; 42770a920b5bSAndy Whitcroft } 42780a920b5bSAndy Whitcroft 42794a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 42804a0df2efSAndy Whitcroft 42814a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 42824a0df2efSAndy Whitcroft 42836c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 4284de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 42850a920b5bSAndy Whitcroft 428674048ed8SAndy Whitcroft # Pull out the value of this operator. 42876c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 42880a920b5bSAndy Whitcroft 42891f65f947SAndy Whitcroft # Get the full operator variant. 42901f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 42911f65f947SAndy Whitcroft 429213214adfSAndy Whitcroft # Ignore operators passed as parameters. 429313214adfSAndy Whitcroft if ($op_type ne 'V' && 4294d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 429513214adfSAndy Whitcroft 4296cf655043SAndy Whitcroft# # Ignore comments 4297cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 429813214adfSAndy Whitcroft 4299d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 430013214adfSAndy Whitcroft } elsif ($op eq ';') { 4301cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 4302cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 43033705ce5bSJoe Perches if (ERROR("SPACING", 43043705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 4305b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 43063705ce5bSJoe Perches $line_fixed = 1; 43073705ce5bSJoe Perches } 4308d8aaf121SAndy Whitcroft } 4309d8aaf121SAndy Whitcroft 4310d8aaf121SAndy Whitcroft # // is a comment 4311d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 43120a920b5bSAndy Whitcroft 4313b00e4814SJoe Perches # : when part of a bitfield 4314b00e4814SJoe Perches } elsif ($opv eq ':B') { 4315b00e4814SJoe Perches # skip the bitfield test for now 4316b00e4814SJoe Perches 43171f65f947SAndy Whitcroft # No spaces for: 43181f65f947SAndy Whitcroft # -> 4319b00e4814SJoe Perches } elsif ($op eq '->') { 43204a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 43213705ce5bSJoe Perches if (ERROR("SPACING", 43223705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4323b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43243705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 43253705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 43263705ce5bSJoe Perches } 4327b34c648bSJoe Perches $line_fixed = 1; 43283705ce5bSJoe Perches } 43290a920b5bSAndy Whitcroft } 43300a920b5bSAndy Whitcroft 43312381097bSJoe Perches # , must not have a space before and must have a space on the right. 43320a920b5bSAndy Whitcroft } elsif ($op eq ',') { 43332381097bSJoe Perches my $rtrim_before = 0; 43342381097bSJoe Perches my $space_after = 0; 43352381097bSJoe Perches if ($ctx =~ /Wx./) { 43362381097bSJoe Perches if (ERROR("SPACING", 43372381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 43382381097bSJoe Perches $line_fixed = 1; 43392381097bSJoe Perches $rtrim_before = 1; 43402381097bSJoe Perches } 43412381097bSJoe Perches } 4342cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 43433705ce5bSJoe Perches if (ERROR("SPACING", 43443705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 43453705ce5bSJoe Perches $line_fixed = 1; 4346b34c648bSJoe Perches $last_after = $n; 43472381097bSJoe Perches $space_after = 1; 43482381097bSJoe Perches } 43492381097bSJoe Perches } 43502381097bSJoe Perches if ($rtrim_before || $space_after) { 43512381097bSJoe Perches if ($rtrim_before) { 43522381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43532381097bSJoe Perches } else { 43542381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 43552381097bSJoe Perches } 43562381097bSJoe Perches if ($space_after) { 43572381097bSJoe Perches $good .= " "; 43583705ce5bSJoe Perches } 43590a920b5bSAndy Whitcroft } 43600a920b5bSAndy Whitcroft 43619c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 436274048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 43639c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 43649c0ca6f9SAndy Whitcroft 43659c0ca6f9SAndy Whitcroft # unary operators should have a space before and 43669c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 43679c0ca6f9SAndy Whitcroft # unary operator, or a cast 43689c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 436974048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 43700d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4371cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 43723705ce5bSJoe Perches if (ERROR("SPACING", 43733705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4374b34c648bSJoe Perches if ($n != $last_after + 2) { 4375b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 43763705ce5bSJoe Perches $line_fixed = 1; 43773705ce5bSJoe Perches } 43780a920b5bSAndy Whitcroft } 4379b34c648bSJoe Perches } 4380a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4381171ae1a4SAndy Whitcroft # A unary '*' may be const 4382171ae1a4SAndy Whitcroft 4383171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 43843705ce5bSJoe Perches if (ERROR("SPACING", 43853705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4386b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 43873705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 43883705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 43893705ce5bSJoe Perches } 4390b34c648bSJoe Perches $line_fixed = 1; 43913705ce5bSJoe Perches } 43920a920b5bSAndy Whitcroft } 43930a920b5bSAndy Whitcroft 43940a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 43950a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4396773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 43973705ce5bSJoe Perches if (ERROR("SPACING", 43983705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4399b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 44003705ce5bSJoe Perches $line_fixed = 1; 44013705ce5bSJoe Perches } 44020a920b5bSAndy Whitcroft } 4403773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4404773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 44053705ce5bSJoe Perches if (ERROR("SPACING", 44063705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4407b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 44083705ce5bSJoe Perches $line_fixed = 1; 44093705ce5bSJoe Perches } 4410653d4876SAndy Whitcroft } 4411773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 44123705ce5bSJoe Perches if (ERROR("SPACING", 44133705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4414b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 44153705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 44163705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4417773647a0SAndy Whitcroft } 4418b34c648bSJoe Perches $line_fixed = 1; 44193705ce5bSJoe Perches } 44203705ce5bSJoe Perches } 44210a920b5bSAndy Whitcroft 44220a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 44239c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 44249c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 44259c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4426c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4427c2fdda0dSAndy Whitcroft $op eq '%') 44280a920b5bSAndy Whitcroft { 4429d2e025f3SJoe Perches if ($check) { 4430d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4431d2e025f3SJoe Perches if (CHK("SPACING", 4432d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4433d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4434d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4435d2e025f3SJoe Perches $line_fixed = 1; 4436d2e025f3SJoe Perches } 4437d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4438d2e025f3SJoe Perches if (CHK("SPACING", 4439d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4440d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4441d2e025f3SJoe Perches $line_fixed = 1; 4442d2e025f3SJoe Perches } 4443d2e025f3SJoe Perches } 4444d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 44453705ce5bSJoe Perches if (ERROR("SPACING", 44463705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4447b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4448b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4449b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4450b34c648bSJoe Perches } 44513705ce5bSJoe Perches $line_fixed = 1; 44523705ce5bSJoe Perches } 44530a920b5bSAndy Whitcroft } 44540a920b5bSAndy Whitcroft 44551f65f947SAndy Whitcroft # A colon needs no spaces before when it is 44561f65f947SAndy Whitcroft # terminating a case value or a label. 44571f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 44581f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 44593705ce5bSJoe Perches if (ERROR("SPACING", 44603705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4461b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 44623705ce5bSJoe Perches $line_fixed = 1; 44633705ce5bSJoe Perches } 44641f65f947SAndy Whitcroft } 44651f65f947SAndy Whitcroft 44660a920b5bSAndy Whitcroft # All the others need spaces both sides. 4467cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 44681f65f947SAndy Whitcroft my $ok = 0; 44691f65f947SAndy Whitcroft 447022f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 44711f65f947SAndy Whitcroft if (($op eq '<' && 44721f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 44731f65f947SAndy Whitcroft ($op eq '>' && 44741f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 44751f65f947SAndy Whitcroft { 44761f65f947SAndy Whitcroft $ok = 1; 44771f65f947SAndy Whitcroft } 44781f65f947SAndy Whitcroft 4479e0df7e1fSJoe Perches # for asm volatile statements 4480e0df7e1fSJoe Perches # ignore a colon with another 4481e0df7e1fSJoe Perches # colon immediately before or after 4482e0df7e1fSJoe Perches if (($op eq ':') && 4483e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4484e0df7e1fSJoe Perches $ok = 1; 4485e0df7e1fSJoe Perches } 4486e0df7e1fSJoe Perches 448784731623SJoe Perches # messages are ERROR, but ?: are CHK 44881f65f947SAndy Whitcroft if ($ok == 0) { 44890675a8fbSJean Delvare my $msg_level = \&ERROR; 44900675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 449184731623SJoe Perches 44920675a8fbSJean Delvare if (&{$msg_level}("SPACING", 44933705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4494b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4495b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4496b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4497b34c648bSJoe Perches } 44983705ce5bSJoe Perches $line_fixed = 1; 44993705ce5bSJoe Perches } 45000a920b5bSAndy Whitcroft } 450122f2a2efSAndy Whitcroft } 45024a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 45033705ce5bSJoe Perches 45043705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 45053705ce5bSJoe Perches 45063705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 45070a920b5bSAndy Whitcroft } 45083705ce5bSJoe Perches 45093705ce5bSJoe Perches if (($#elements % 2) == 0) { 45103705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 45113705ce5bSJoe Perches } 45123705ce5bSJoe Perches 4513194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4514194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 45153705ce5bSJoe Perches } 45163705ce5bSJoe Perches 45173705ce5bSJoe Perches 45180a920b5bSAndy Whitcroft } 45190a920b5bSAndy Whitcroft 4520786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4521d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4522786b6326SJoe Perches if (WARN("SPACING", 4523786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4524786b6326SJoe Perches $fix) { 4525194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4526786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4527786b6326SJoe Perches } 4528786b6326SJoe Perches } 4529786b6326SJoe Perches 4530f0a594c1SAndy Whitcroft# check for multiple assignments 4531f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4532000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4533000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4534f0a594c1SAndy Whitcroft } 4535f0a594c1SAndy Whitcroft 453622f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 453722f2a2efSAndy Whitcroft## # continuation. 453822f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 453922f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 454022f2a2efSAndy Whitcroft## 454122f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 454222f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 454322f2a2efSAndy Whitcroft## my $ln = $line; 454422f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 454522f2a2efSAndy Whitcroft## } 454622f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4547000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4548000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 454922f2a2efSAndy Whitcroft## } 455022f2a2efSAndy Whitcroft## } 4551f0a594c1SAndy Whitcroft 45520a920b5bSAndy Whitcroft#need space before brace following if, while, etc 45536b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 45546ad724e2SMichal Zylowski $line =~ /\b(?:else|do)\{/) { 45553705ce5bSJoe Perches if (ERROR("SPACING", 45563705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 45573705ce5bSJoe Perches $fix) { 45586ad724e2SMichal Zylowski $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/; 45593705ce5bSJoe Perches } 4560de7d4f0eSAndy Whitcroft } 4561de7d4f0eSAndy Whitcroft 4562c4a62ef9SJoe Perches## # check for blank lines before declarations 4563c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4564c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4565c4a62ef9SJoe Perches## WARN("SPACING", 4566c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4567c4a62ef9SJoe Perches## } 4568c4a62ef9SJoe Perches## 4569c4a62ef9SJoe Perches 4570de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4571de7d4f0eSAndy Whitcroft# on the line 4572de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4573d5e616fcSJoe Perches if (ERROR("SPACING", 4574d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4575d5e616fcSJoe Perches $fix) { 4576194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4577d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4578d5e616fcSJoe Perches } 45790a920b5bSAndy Whitcroft } 45800a920b5bSAndy Whitcroft 458122f2a2efSAndy Whitcroft# check spacing on square brackets 458222f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 45833705ce5bSJoe Perches if (ERROR("SPACING", 45843705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 45853705ce5bSJoe Perches $fix) { 4586194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45873705ce5bSJoe Perches s/\[\s+/\[/; 45883705ce5bSJoe Perches } 458922f2a2efSAndy Whitcroft } 459022f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 45913705ce5bSJoe Perches if (ERROR("SPACING", 45923705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 45933705ce5bSJoe Perches $fix) { 4594194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45953705ce5bSJoe Perches s/\s+\]/\]/; 45963705ce5bSJoe Perches } 459722f2a2efSAndy Whitcroft } 459822f2a2efSAndy Whitcroft 4599c45dcabdSAndy Whitcroft# check spacing on parentheses 46009c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 46019c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 46023705ce5bSJoe Perches if (ERROR("SPACING", 46033705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 46043705ce5bSJoe Perches $fix) { 4605194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46063705ce5bSJoe Perches s/\(\s+/\(/; 46073705ce5bSJoe Perches } 460822f2a2efSAndy Whitcroft } 460913214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4610c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4611c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 46123705ce5bSJoe Perches if (ERROR("SPACING", 46133705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 46143705ce5bSJoe Perches $fix) { 4615194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46163705ce5bSJoe Perches s/\s+\)/\)/; 46173705ce5bSJoe Perches } 461822f2a2efSAndy Whitcroft } 461922f2a2efSAndy Whitcroft 4620e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4621e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4622e2826fd0SJoe Perches 4623e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4624ea4acbb1SJoe Perches my $var = $1; 4625ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4626ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4627ea4acbb1SJoe Perches $fix) { 4628ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4629ea4acbb1SJoe Perches } 4630ea4acbb1SJoe Perches } 4631ea4acbb1SJoe Perches 4632ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4633ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4634ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4635ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4636ea4acbb1SJoe Perches my $var = $2; 4637ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4638ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4639ea4acbb1SJoe Perches $fix) { 4640ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4641ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4642ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4643ea4acbb1SJoe Perches } 4644e2826fd0SJoe Perches } 4645e2826fd0SJoe Perches 464663b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 4647a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 4648a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 46495b57980dSJoe Perches $perl_version_ok && defined($stat) && 465063b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 465163b7c73eSJoe Perches my $if_stat = $1; 465263b7c73eSJoe Perches my $test = substr($2, 1, -1); 465363b7c73eSJoe Perches my $herectx; 465463b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 465563b7c73eSJoe Perches my $match = $1; 465663b7c73eSJoe Perches # avoid parentheses around potential macro args 465763b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 465863b7c73eSJoe Perches if (!defined($herectx)) { 465963b7c73eSJoe Perches $herectx = $here . "\n"; 466063b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 466163b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 466263b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 466363b7c73eSJoe Perches $herectx .= $rl . "\n"; 466463b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 466563b7c73eSJoe Perches } 466663b7c73eSJoe Perches } 466763b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 466863b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 466963b7c73eSJoe Perches } 467063b7c73eSJoe Perches } 467163b7c73eSJoe Perches 46720a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 46734a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 46740a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 46753705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 46763705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 46773705ce5bSJoe Perches $fix) { 4678194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46793705ce5bSJoe Perches s/^(.)\s+/$1/; 46803705ce5bSJoe Perches } 46810a920b5bSAndy Whitcroft } 46820a920b5bSAndy Whitcroft 46835b9553abSJoe Perches# return is not a function 4684507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4685c45dcabdSAndy Whitcroft my $spacing = $1; 46865b57980dSJoe Perches if ($perl_version_ok && 46875b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 46885b9553abSJoe Perches my $value = $1; 46895b9553abSJoe Perches $value = deparenthesize($value); 46905b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4691000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4692000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 46935b9553abSJoe Perches } 4694c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4695000d1cc1SJoe Perches ERROR("SPACING", 4696000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4697c45dcabdSAndy Whitcroft } 4698c45dcabdSAndy Whitcroft } 4699507e5141SJoe Perches 4700b43ae21bSJoe Perches# unnecessary return in a void function 4701b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4702b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4703b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4704b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4705b43ae21bSJoe Perches $linenr >= 3 && 4706b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4707b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 47089819cf25SJoe Perches WARN("RETURN_VOID", 4709b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 47109819cf25SJoe Perches } 47119819cf25SJoe Perches 4712189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 47135b57980dSJoe Perches if ($perl_version_ok && 4714189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4715189248d8SJoe Perches my $openparens = $1; 4716189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4717189248d8SJoe Perches my $msg = ""; 4718189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4719189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4720189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4721189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4722189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4723189248d8SJoe Perches } 4724189248d8SJoe Perches } 4725189248d8SJoe Perches 4726c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4727c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4728c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4729c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 47305b57980dSJoe Perches if ($perl_version_ok && 4731c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4732c5595fa2SJoe Perches my $lead = $1; 4733c5595fa2SJoe Perches my $const = $2; 4734c5595fa2SJoe Perches my $comp = $3; 4735c5595fa2SJoe Perches my $to = $4; 4736c5595fa2SJoe Perches my $newcomp = $comp; 4737f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 4738c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4739c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4740c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4741c5595fa2SJoe Perches $fix) { 4742c5595fa2SJoe Perches if ($comp eq "<") { 4743c5595fa2SJoe Perches $newcomp = ">"; 4744c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4745c5595fa2SJoe Perches $newcomp = ">="; 4746c5595fa2SJoe Perches } elsif ($comp eq ">") { 4747c5595fa2SJoe Perches $newcomp = "<"; 4748c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4749c5595fa2SJoe Perches $newcomp = "<="; 4750c5595fa2SJoe Perches } 4751c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4752c5595fa2SJoe Perches } 4753c5595fa2SJoe Perches } 4754c5595fa2SJoe Perches 4755f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4756f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 475753a3c448SAndy Whitcroft my $name = $1; 475853a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4759000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4760f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 476153a3c448SAndy Whitcroft } 476253a3c448SAndy Whitcroft } 4763c45dcabdSAndy Whitcroft 47640a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 47654a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 47663705ce5bSJoe Perches if (ERROR("SPACING", 47673705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 47683705ce5bSJoe Perches $fix) { 4769194f66fcSJoe Perches $fixed[$fixlinenr] =~ 47703705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 47713705ce5bSJoe Perches } 47720a920b5bSAndy Whitcroft } 47730a920b5bSAndy Whitcroft 4774f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4775f5fe35ddSAndy Whitcroft# statements after the conditional. 4776170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 47773e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 47783e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 47793e469cdcSAndy Whitcroft if (!defined $stat); 4780170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4781170d3a22SAndy Whitcroft $remain_next, $off_next); 4782170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4783170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4784170d3a22SAndy Whitcroft 4785170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4786170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4787170d3a22SAndy Whitcroft # then count those as offsets. 4788170d3a22SAndy Whitcroft my ($whitespace) = 4789170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4790170d3a22SAndy Whitcroft my $offset = 4791170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4792170d3a22SAndy Whitcroft 4793170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4794170d3a22SAndy Whitcroft $offset} = 1; 4795170d3a22SAndy Whitcroft } 4796170d3a22SAndy Whitcroft } 4797170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4798c11230f4SJoe Perches defined($stat) && defined($cond) && 4799170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4800171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 48018905a67cSAndy Whitcroft 4802b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4803000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4804000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 48058905a67cSAndy Whitcroft } 48068905a67cSAndy Whitcroft 48078905a67cSAndy Whitcroft # Find out what is on the end of the line after the 48088905a67cSAndy Whitcroft # conditional. 4809773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 48108905a67cSAndy Whitcroft $s =~ s/\n.*//g; 481113214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 481253210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 481353210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4814773647a0SAndy Whitcroft { 4815bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4816bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4817bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 481842bdf74cSHidetoshi Seto my $stat_real = ''; 4819bb44ad39SAndy Whitcroft 482042bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 482142bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4822bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4823bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4824bb44ad39SAndy Whitcroft } 4825bb44ad39SAndy Whitcroft 4826000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4827000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 48288905a67cSAndy Whitcroft } 48298905a67cSAndy Whitcroft } 48308905a67cSAndy Whitcroft 483113214adfSAndy Whitcroft# Check for bitwise tests written as boolean 483213214adfSAndy Whitcroft if ($line =~ / 483313214adfSAndy Whitcroft (?: 483413214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 483513214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 483613214adfSAndy Whitcroft (?:\&\&|\|\|) 483713214adfSAndy Whitcroft | 483813214adfSAndy Whitcroft (?:\&\&|\|\|) 483913214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 484013214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 484113214adfSAndy Whitcroft )/x) 484213214adfSAndy Whitcroft { 4843000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4844000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 484513214adfSAndy Whitcroft } 484613214adfSAndy Whitcroft 48478905a67cSAndy Whitcroft# if and else should not have general statements after it 484813214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 484913214adfSAndy Whitcroft my $s = $1; 485013214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 485113214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4852000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4853000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 48540a920b5bSAndy Whitcroft } 485513214adfSAndy Whitcroft } 485639667782SAndy Whitcroft# if should not continue a brace 485739667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4858000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4859048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 486039667782SAndy Whitcroft $herecurr); 486139667782SAndy Whitcroft } 4862a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4863a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4864a1080bf8SAndy Whitcroft $line !~ /\G(?: 48653fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4866a1080bf8SAndy Whitcroft \s*return\s+ 4867a1080bf8SAndy Whitcroft )/xg) 4868a1080bf8SAndy Whitcroft { 4869000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4870000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4871a1080bf8SAndy Whitcroft } 48720a920b5bSAndy Whitcroft 48730a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 48740a920b5bSAndy Whitcroft # indent level to be relevant to each other. 48758b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 48760a920b5bSAndy Whitcroft $previndent == $indent) { 48778b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 48788b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 48798b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 48808b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48818b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 48828b8856f4SJoe Perches my $fixedline = $prevrawline; 48838b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 48848b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 48858b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48868b8856f4SJoe Perches } 48878b8856f4SJoe Perches $fixedline = $rawline; 48888b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 48898b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48908b8856f4SJoe Perches } 48910a920b5bSAndy Whitcroft } 48920a920b5bSAndy Whitcroft 48938b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4894c2fdda0dSAndy Whitcroft $previndent == $indent) { 4895c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4896c2fdda0dSAndy Whitcroft 4897c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4898c2fdda0dSAndy Whitcroft # conditional. 4899773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4900c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4901c2fdda0dSAndy Whitcroft 4902c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 49038b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 49048b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 49058b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 49068b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 49078b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 49088b8856f4SJoe Perches my $fixedline = $prevrawline; 49098b8856f4SJoe Perches my $trailing = $rawline; 49108b8856f4SJoe Perches $trailing =~ s/^\+//; 49118b8856f4SJoe Perches $trailing = trim($trailing); 49128b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 49138b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 49148b8856f4SJoe Perches } 4915c2fdda0dSAndy Whitcroft } 4916c2fdda0dSAndy Whitcroft } 4917c2fdda0dSAndy Whitcroft 491895e2c602SJoe Perches#Specific variable tests 4919323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4920323c1260SJoe Perches my $var = $1; 492195e2c602SJoe Perches 492295e2c602SJoe Perches#gcc binary extension 492395e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4924d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4925d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4926d5e616fcSJoe Perches $fix) { 4927d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4928194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4929d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4930d5e616fcSJoe Perches } 493195e2c602SJoe Perches } 493295e2c602SJoe Perches 493395e2c602SJoe Perches#CamelCase 4934807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4935be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 493622735ce8SJoe Perches#Ignore Page<foo> variants 4937807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 493822735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4939f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4940f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4941f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 49427e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 49437e781f67SJoe Perches my $word = $1; 49447e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4945d8b07710SJoe Perches if ($check) { 4946d8b07710SJoe Perches seed_camelcase_includes(); 4947d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4948d8b07710SJoe Perches seed_camelcase_file($realfile); 4949d8b07710SJoe Perches $camelcase_file_seeded = 1; 4950d8b07710SJoe Perches } 4951d8b07710SJoe Perches } 49527e781f67SJoe Perches if (!defined $camelcase{$word}) { 49537e781f67SJoe Perches $camelcase{$word} = 1; 4954be79794bSJoe Perches CHK("CAMELCASE", 49557e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 49567e781f67SJoe Perches } 4957323c1260SJoe Perches } 4958323c1260SJoe Perches } 49593445686aSJoe Perches } 49600a920b5bSAndy Whitcroft 49610a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4962d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4963d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4964d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4965d5e616fcSJoe Perches $fix) { 4966194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4967d5e616fcSJoe Perches } 49680a920b5bSAndy Whitcroft } 49690a920b5bSAndy Whitcroft 49700e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 49710e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4972c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4973e09dec48SAndy Whitcroft my $file = "$1.h"; 4974e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4975e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4976e09dec48SAndy Whitcroft $realfile ne $checkfile && 49777840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4978c45dcabdSAndy Whitcroft { 49790e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 49800e212e0aSFabian Frederick if ($asminclude > 0) { 4981e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4982000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4983000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4984e09dec48SAndy Whitcroft } else { 4985000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4986000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4987e09dec48SAndy Whitcroft } 49880a920b5bSAndy Whitcroft } 49890a920b5bSAndy Whitcroft } 49900e212e0aSFabian Frederick } 49910a920b5bSAndy Whitcroft 4992653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4993653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4994cf655043SAndy Whitcroft# in a known good container 4995b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4996b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4997d8aaf121SAndy Whitcroft my $ln = $linenr; 4998d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4999c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 5000c45dcabdSAndy Whitcroft my $ctx = ''; 500108a2843eSJoe Perches my $has_flow_statement = 0; 500208a2843eSJoe Perches my $has_arg_concat = 0; 5003c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 5004f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 5005f74bd194SAndy Whitcroft $ctx = $dstat; 5006c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 5007a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 5008c45dcabdSAndy Whitcroft 500908a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 501062e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 501108a2843eSJoe Perches 5012f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 5013f59b64bfSJoe Perches my $define_args = $1; 5014f59b64bfSJoe Perches my $define_stmt = $dstat; 5015f59b64bfSJoe Perches my @def_args = (); 5016f59b64bfSJoe Perches 5017f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 5018f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 5019f59b64bfSJoe Perches $define_args =~ s/\s*//g; 50208c8c45cfSJoe Perches $define_args =~ s/\\\+?//g; 5021f59b64bfSJoe Perches @def_args = split(",", $define_args); 5022f59b64bfSJoe Perches } 5023f59b64bfSJoe Perches 5024292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 5025c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 5026c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 5027c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 5028c45dcabdSAndy Whitcroft 5029c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 5030bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 5031bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 50326b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 5033bf30d6edSAndy Whitcroft { 5034c45dcabdSAndy Whitcroft } 5035c45dcabdSAndy Whitcroft 5036e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 503733acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 503833acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 5039e45bab8eSAndy Whitcroft { 5040e45bab8eSAndy Whitcroft } 5041e45bab8eSAndy Whitcroft 504242e15293SJoe Perches # Make asm volatile uses seem like a generic function 504342e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 504442e15293SJoe Perches 5045c45dcabdSAndy Whitcroft my $exceptions = qr{ 5046c45dcabdSAndy Whitcroft $Declare| 5047c45dcabdSAndy Whitcroft module_param_named| 5048a0a0a7a9SKees Cook MODULE_PARM_DESC| 5049c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 5050c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 5051383099fdSAndy Whitcroft __typeof__\(| 505222fd2d3eSStefani Seibold union| 505322fd2d3eSStefani Seibold struct| 5054ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 50556b10df42SVladimir Zapolskiy ^\"|\"$| 50566b10df42SVladimir Zapolskiy ^\[ 5057c45dcabdSAndy Whitcroft }x; 50585eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 5059f59b64bfSJoe Perches 5060f59b64bfSJoe Perches $ctx =~ s/\n*$//; 5061f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 5062e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 5063f59b64bfSJoe Perches 5064f74bd194SAndy Whitcroft if ($dstat ne '' && 5065f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 5066f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 50673cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 5068356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5069f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 5070f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5071e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 507272f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 5073f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5074f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5075f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 50764e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5077f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5078c45dcabdSAndy Whitcroft { 5079e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5080e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5081e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5082e795556aSJoe Perches } elsif ($dstat =~ /;/) { 5083f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5084f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5085f74bd194SAndy Whitcroft } else { 5086000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 5087388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5088d8aaf121SAndy Whitcroft } 5089f59b64bfSJoe Perches 5090f59b64bfSJoe Perches } 50915207649bSJoe Perches 50925207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 50935207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 50945207649bSJoe Perches my $first = 1; 50955207649bSJoe Perches $define_stmt = ""; 50965207649bSJoe Perches foreach my $l (@stmt_array) { 50975207649bSJoe Perches $l =~ s/\\$//; 50985207649bSJoe Perches if ($first) { 50995207649bSJoe Perches $define_stmt = $l; 51005207649bSJoe Perches $first = 0; 51015207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 51025207649bSJoe Perches $define_stmt .= substr($l, 1); 51035207649bSJoe Perches } 51045207649bSJoe Perches } 51055207649bSJoe Perches $define_stmt =~ s/$;//g; 51065207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 51075207649bSJoe Perches $define_stmt = trim($define_stmt); 51085207649bSJoe Perches 5109f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5110f59b64bfSJoe Perches foreach my $arg (@def_args) { 5111f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 51129192d41aSJoe Perches next if ($arg =~ /^type$/i); 51137fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 51147fe528a2SJoe Perches $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 51157fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 51167fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 5117d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 5118f59b64bfSJoe Perches if ($use_cnt > 1) { 5119f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5120f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5121f59b64bfSJoe Perches } 51229192d41aSJoe Perches# check if any macro arguments may have other precedence issues 51237fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 51249192d41aSJoe Perches ((defined($1) && $1 ne ',') || 51259192d41aSJoe Perches (defined($2) && $2 ne ','))) { 51269192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 51279192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 51289192d41aSJoe Perches } 51290a920b5bSAndy Whitcroft } 51305023d347SJoe Perches 513108a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 513208a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 513308a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 513408a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 5135e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 513608a2843eSJoe Perches 513708a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 513808a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 513908a2843eSJoe Perches } 514008a2843eSJoe Perches 5141481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 51425023d347SJoe Perches 51435023d347SJoe Perches } else { 51445023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5145481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5146481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 51475023d347SJoe Perches $line =~ /^\+.*\\$/) { 51485023d347SJoe Perches WARN("LINE_CONTINUATIONS", 51495023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 51505023d347SJoe Perches } 5151653d4876SAndy Whitcroft } 51520a920b5bSAndy Whitcroft 5153b13edf7fSJoe Perches# do {} while (0) macro tests: 5154b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5155b13edf7fSJoe Perches# macro should not end with a semicolon 51565b57980dSJoe Perches if ($perl_version_ok && 5157b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5158b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5159b13edf7fSJoe Perches my $ln = $linenr; 5160b13edf7fSJoe Perches my $cnt = $realcnt; 5161b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5162b13edf7fSJoe Perches my $ctx = ''; 5163b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5164b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5165b13edf7fSJoe Perches $ctx = $dstat; 5166b13edf7fSJoe Perches 5167b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 51681b36b201SJoe Perches $dstat =~ s/$;/ /g; 5169b13edf7fSJoe Perches 5170b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5171b13edf7fSJoe Perches my $stmts = $2; 5172b13edf7fSJoe Perches my $semis = $3; 5173b13edf7fSJoe Perches 5174b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5175b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5176e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5177b13edf7fSJoe Perches 5178ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5179ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5180b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5181b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5182b13edf7fSJoe Perches } 5183b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5184b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5185b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5186b13edf7fSJoe Perches } 5187f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5188f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5189f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5190e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5191f5ef95b1SJoe Perches 5192f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5193f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5194b13edf7fSJoe Perches } 5195b13edf7fSJoe Perches } 5196b13edf7fSJoe Perches 5197f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 519813214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 519913214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5200cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 520113214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5202cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5203cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5204aad4f614SJoe Perches my @allowed = (); 5205aad4f614SJoe Perches my $allow = 0; 520613214adfSAndy Whitcroft my $seen = 0; 5207773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5208cf655043SAndy Whitcroft my $ln = $linenr - 1; 520913214adfSAndy Whitcroft for my $chunk (@chunks) { 521013214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 521113214adfSAndy Whitcroft 5212773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5213773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5214773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 5215773647a0SAndy Whitcroft 5216aad4f614SJoe Perches $allowed[$allow] = 0; 5217773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5218773647a0SAndy Whitcroft 5219773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 5220773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 5221773647a0SAndy Whitcroft 5222773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5223cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 5224cf655043SAndy Whitcroft 5225773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 522613214adfSAndy Whitcroft 522713214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 522813214adfSAndy Whitcroft 5229aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5230cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5231cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5232aad4f614SJoe Perches $allowed[$allow] = 1; 523313214adfSAndy Whitcroft } 523413214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5235cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5236aad4f614SJoe Perches $allowed[$allow] = 1; 523713214adfSAndy Whitcroft } 5238cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5239cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5240aad4f614SJoe Perches $allowed[$allow] = 1; 524113214adfSAndy Whitcroft } 5242aad4f614SJoe Perches $allow++; 524313214adfSAndy Whitcroft } 5244aad4f614SJoe Perches if ($seen) { 5245aad4f614SJoe Perches my $sum_allowed = 0; 5246aad4f614SJoe Perches foreach (@allowed) { 5247aad4f614SJoe Perches $sum_allowed += $_; 5248aad4f614SJoe Perches } 5249aad4f614SJoe Perches if ($sum_allowed == 0) { 5250000d1cc1SJoe Perches WARN("BRACES", 5251000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 5252aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 5253aad4f614SJoe Perches $seen != $allow) { 5254aad4f614SJoe Perches CHK("BRACES", 5255aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 5256aad4f614SJoe Perches } 525713214adfSAndy Whitcroft } 525813214adfSAndy Whitcroft } 525913214adfSAndy Whitcroft } 5260773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 526113214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 5262cf655043SAndy Whitcroft my $allowed = 0; 5263f0a594c1SAndy Whitcroft 5264cf655043SAndy Whitcroft # Check the pre-context. 5265cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 5266cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 5267cf655043SAndy Whitcroft $allowed = 1; 5268f0a594c1SAndy Whitcroft } 5269773647a0SAndy Whitcroft 5270773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 5271773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 5272773647a0SAndy Whitcroft 5273cf655043SAndy Whitcroft # Check the condition. 5274cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 5275773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 5276cf655043SAndy Whitcroft if (defined $cond) { 5277773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5278cf655043SAndy Whitcroft } 5279cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5280cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5281cf655043SAndy Whitcroft $allowed = 1; 5282cf655043SAndy Whitcroft } 5283cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5284cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5285cf655043SAndy Whitcroft $allowed = 1; 5286cf655043SAndy Whitcroft } 5287cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5288cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5289cf655043SAndy Whitcroft $allowed = 1; 5290cf655043SAndy Whitcroft } 5291cf655043SAndy Whitcroft # Check the post-context. 5292cf655043SAndy Whitcroft if (defined $chunks[1]) { 5293cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 5294cf655043SAndy Whitcroft if (defined $cond) { 5295773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5296cf655043SAndy Whitcroft } 5297cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 5298cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5299cf655043SAndy Whitcroft $allowed = 1; 5300cf655043SAndy Whitcroft } 5301cf655043SAndy Whitcroft } 5302cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 5303f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 5304e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5305cf655043SAndy Whitcroft 5306000d1cc1SJoe Perches WARN("BRACES", 5307000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 5308f0a594c1SAndy Whitcroft } 5309f0a594c1SAndy Whitcroft } 5310f0a594c1SAndy Whitcroft 5311e4c5babdSJoe Perches# check for single line unbalanced braces 531295330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 531395330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 5314e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 5315e4c5babdSJoe Perches } 5316e4c5babdSJoe Perches 53170979ae66SJoe Perches# check for unnecessary blank lines around braces 531877b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5319f8e58219SJoe Perches if (CHK("BRACES", 5320f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5321f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 5322f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5323f8e58219SJoe Perches } 53240979ae66SJoe Perches } 532577b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5326f8e58219SJoe Perches if (CHK("BRACES", 5327f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5328f8e58219SJoe Perches $fix) { 5329f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 5330f8e58219SJoe Perches } 53310979ae66SJoe Perches } 53320979ae66SJoe Perches 53334a0df2efSAndy Whitcroft# no volatiles please 53346c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 53356c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5336000d1cc1SJoe Perches WARN("VOLATILE", 53378c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 53384a0df2efSAndy Whitcroft } 53394a0df2efSAndy Whitcroft 53405e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 53415e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 53425e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 53435e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 534433acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 53455e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 53465e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 53475e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 53485e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 53495e4f6ba5SJoe Perches $fix && 53505e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 53515e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 53525e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 53535e4f6ba5SJoe Perches my $comma_close = ""; 53545e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 53555e4f6ba5SJoe Perches $comma_close = $1; 53565e4f6ba5SJoe Perches } 53575e4f6ba5SJoe Perches 53585e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 53595e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 53605e4f6ba5SJoe Perches my $fixedline = $prevrawline; 53615e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 53625e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 53635e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 53645e4f6ba5SJoe Perches $fixedline = $rawline; 53655e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 53665e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 53675e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 53685e4f6ba5SJoe Perches } 53695e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 53705e4f6ba5SJoe Perches } 53715e4f6ba5SJoe Perches } 53725e4f6ba5SJoe Perches 53735e4f6ba5SJoe Perches# check for missing a space in a string concatenation 53745e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 53755e4f6ba5SJoe Perches WARN('MISSING_SPACE', 53765e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 53775e4f6ba5SJoe Perches } 53785e4f6ba5SJoe Perches 537977cb8546SJoe Perches# check for an embedded function name in a string when the function is known 5380e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 5381e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 5382e4b7d309SJoe Perches# function declarations 538377cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 538477cb8546SJoe Perches defined($context_function) && 5385e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 5386e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 538777cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 5388e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 538977cb8546SJoe Perches } 539077cb8546SJoe Perches 53915e4f6ba5SJoe Perches# check for spaces before a quoted newline 53925e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 53935e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 53945e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 53955e4f6ba5SJoe Perches $fix) { 53965e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 53975e4f6ba5SJoe Perches } 53985e4f6ba5SJoe Perches 53995e4f6ba5SJoe Perches } 54005e4f6ba5SJoe Perches 5401f17dba4fSJoe Perches# concatenated string without spaces between elements 540279682c0cSJoe Perches if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) { 540379682c0cSJoe Perches if (CHK("CONCATENATED_STRING", 540479682c0cSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr) && 540579682c0cSJoe Perches $fix) { 540679682c0cSJoe Perches while ($line =~ /($String)/g) { 540779682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 540879682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/; 540979682c0cSJoe Perches $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/; 541079682c0cSJoe Perches } 541179682c0cSJoe Perches } 5412f17dba4fSJoe Perches } 5413f17dba4fSJoe Perches 541490ad30e5SJoe Perches# uncoalesced string fragments 541533acb54aSJoe Perches if ($line =~ /$String\s*"/) { 541679682c0cSJoe Perches if (WARN("STRING_FRAGMENTS", 541779682c0cSJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr) && 541879682c0cSJoe Perches $fix) { 541979682c0cSJoe Perches while ($line =~ /($String)(?=\s*")/g) { 542079682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 542179682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e; 542279682c0cSJoe Perches } 542379682c0cSJoe Perches } 542490ad30e5SJoe Perches } 542590ad30e5SJoe Perches 5426522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 5427522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 5428522b837cSAlexey Dobriyan my $show_Z = 1; 54295e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 5430522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 54315e4f6ba5SJoe Perches $string =~ s/%%/__/g; 5432522b837cSAlexey Dobriyan # check for %L 5433522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 54345e4f6ba5SJoe Perches WARN("PRINTF_L", 5435522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 5436522b837cSAlexey Dobriyan $show_L = 0; 54375e4f6ba5SJoe Perches } 5438522b837cSAlexey Dobriyan # check for %Z 5439522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 5440522b837cSAlexey Dobriyan WARN("PRINTF_Z", 5441522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 5442522b837cSAlexey Dobriyan $show_Z = 0; 5443522b837cSAlexey Dobriyan } 5444522b837cSAlexey Dobriyan # check for 0x<decimal> 5445522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 5446522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 54476e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 54486e300757SJoe Perches } 54495e4f6ba5SJoe Perches } 54505e4f6ba5SJoe Perches 54515e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 54523f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 54535e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 54545e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 54555e4f6ba5SJoe Perches } 54565e4f6ba5SJoe Perches 545700df344fSAndy Whitcroft# warn about #if 0 5458c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 545960f89010SPrakruthi Deepak Heragu WARN("IF_0", 546060f89010SPrakruthi Deepak Heragu "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr); 546160f89010SPrakruthi Deepak Heragu } 546260f89010SPrakruthi Deepak Heragu 546360f89010SPrakruthi Deepak Heragu# warn about #if 1 546460f89010SPrakruthi Deepak Heragu if ($line =~ /^.\s*\#\s*if\s+1\b/) { 546560f89010SPrakruthi Deepak Heragu WARN("IF_1", 546660f89010SPrakruthi Deepak Heragu "Consider removing the #if 1 and its #endif\n" . $herecurr); 54674a0df2efSAndy Whitcroft } 54684a0df2efSAndy Whitcroft 546903df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 547003df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5471100425deSJoe Perches my $tested = quotemeta($1); 5472100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5473100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5474100425deSJoe Perches my $func = $1; 5475100425deSJoe Perches if (WARN('NEEDLESS_IF', 5476100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5477100425deSJoe Perches $fix) { 5478100425deSJoe Perches my $do_fix = 1; 5479100425deSJoe Perches my $leading_tabs = ""; 5480100425deSJoe Perches my $new_leading_tabs = ""; 5481100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5482100425deSJoe Perches $leading_tabs = $1; 5483100425deSJoe Perches } else { 5484100425deSJoe Perches $do_fix = 0; 5485100425deSJoe Perches } 5486100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5487100425deSJoe Perches $new_leading_tabs = $1; 5488100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5489100425deSJoe Perches $do_fix = 0; 5490100425deSJoe Perches } 5491100425deSJoe Perches } else { 5492100425deSJoe Perches $do_fix = 0; 5493100425deSJoe Perches } 5494100425deSJoe Perches if ($do_fix) { 5495100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5496100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5497100425deSJoe Perches } 5498100425deSJoe Perches } 54994c432a8fSGreg Kroah-Hartman } 55004c432a8fSGreg Kroah-Hartman } 5501f0a594c1SAndy Whitcroft 5502ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5503ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5504ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5505ebfdc409SJoe Perches (defined $1 || defined $3) && 5506ebfdc409SJoe Perches $linenr > 3) { 5507ebfdc409SJoe Perches my $testval = $2; 5508ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5509ebfdc409SJoe Perches 5510ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5511ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5512ebfdc409SJoe Perches 5513fb0d0e08SJoe 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)/) { 5514ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5515ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5516ebfdc409SJoe Perches } 5517ebfdc409SJoe Perches } 5518ebfdc409SJoe Perches 5519f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5520dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5521f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5522f78d98f6SJoe Perches my $level = $1; 5523f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5524f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5525f78d98f6SJoe Perches $fix) { 5526f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5527f78d98f6SJoe Perches } 5528f78d98f6SJoe Perches } 5529f78d98f6SJoe Perches 553045c55e92SJoe Perches# check for logging continuations 553145c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 553245c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 553345c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 553445c55e92SJoe Perches } 553545c55e92SJoe Perches 5536abb08a53SJoe Perches# check for mask then right shift without a parentheses 55375b57980dSJoe Perches if ($perl_version_ok && 5538abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5539abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5540abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5541abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5542abb08a53SJoe Perches } 5543abb08a53SJoe Perches 5544b75ac618SJoe Perches# check for pointer comparisons to NULL 55455b57980dSJoe Perches if ($perl_version_ok) { 5546b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5547b75ac618SJoe Perches my $val = $1; 5548b75ac618SJoe Perches my $equal = "!"; 5549b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5550b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5551b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5552b75ac618SJoe Perches $fix) { 5553b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5554b75ac618SJoe Perches } 5555b75ac618SJoe Perches } 5556b75ac618SJoe Perches } 5557b75ac618SJoe Perches 55588716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 55598716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 55608716de38SJoe Perches my $attr = $1; 55618716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 55628716de38SJoe Perches my $ptr = $1; 55638716de38SJoe Perches my $var = $2; 55648716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 55658716de38SJoe Perches ERROR("MISPLACED_INIT", 55668716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 55678716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 55688716de38SJoe Perches WARN("MISPLACED_INIT", 55698716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 55708716de38SJoe Perches $fix) { 5571194f66fcSJoe 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; 55728716de38SJoe Perches } 55738716de38SJoe Perches } 55748716de38SJoe Perches } 55758716de38SJoe Perches 5576e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5577e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5578e970b884SJoe Perches my $attr = $1; 5579e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5580e970b884SJoe Perches my $attr_prefix = $1; 5581e970b884SJoe Perches my $attr_type = $2; 5582e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5583e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5584e970b884SJoe Perches $fix) { 5585194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5586e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5587e970b884SJoe Perches } 5588e970b884SJoe Perches } 5589e970b884SJoe Perches 5590e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5591e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5592e970b884SJoe Perches my $attr = $1; 5593e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5594e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5595e970b884SJoe Perches $fix) { 5596194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5597e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5598e970b884SJoe Perches $lead = rtrim($1); 5599e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5600e970b884SJoe Perches $lead = "${lead}const "; 5601194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5602e970b884SJoe Perches } 5603e970b884SJoe Perches } 5604e970b884SJoe Perches 5605c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5606c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5607c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5608c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5609c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5610c17893c7SJoe Perches $fix) { 5611c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5612c17893c7SJoe Perches } 5613c17893c7SJoe Perches } 5614c17893c7SJoe Perches 5615fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5616fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5617fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5618fbdb8138SJoe Perches my $constant_func = $1; 5619fbdb8138SJoe Perches my $func = $constant_func; 5620fbdb8138SJoe Perches $func =~ s/^__constant_//; 5621fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5622fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5623fbdb8138SJoe Perches $fix) { 5624194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5625fbdb8138SJoe Perches } 5626fbdb8138SJoe Perches } 5627fbdb8138SJoe Perches 56281a15a250SPatrick Pannuto# prefer usleep_range over udelay 562937581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 563043c1d77cSJoe Perches my $delay = $1; 56311a15a250SPatrick Pannuto # ignore udelay's < 10, however 563243c1d77cSJoe Perches if (! ($delay < 10) ) { 5633000d1cc1SJoe Perches CHK("USLEEP_RANGE", 563443c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 563543c1d77cSJoe Perches } 563643c1d77cSJoe Perches if ($delay > 2000) { 563743c1d77cSJoe Perches WARN("LONG_UDELAY", 563843c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 56391a15a250SPatrick Pannuto } 56401a15a250SPatrick Pannuto } 56411a15a250SPatrick Pannuto 564209ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 564309ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 564409ef8725SPatrick Pannuto if ($1 < 20) { 5645000d1cc1SJoe Perches WARN("MSLEEP", 564643c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 564709ef8725SPatrick Pannuto } 564809ef8725SPatrick Pannuto } 564909ef8725SPatrick Pannuto 565036ec1939SJoe Perches# check for comparisons of jiffies 565136ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 565236ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 565336ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 565436ec1939SJoe Perches } 565536ec1939SJoe Perches 56569d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 56579d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 56589d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 56599d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 56609d7a34a5SJoe Perches } 56619d7a34a5SJoe Perches 566200df344fSAndy Whitcroft# warn about #ifdefs in C files 5663c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 566400df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 566500df344fSAndy Whitcroft# print "$herecurr"; 566600df344fSAndy Whitcroft# $clean = 0; 566700df344fSAndy Whitcroft# } 566800df344fSAndy Whitcroft 566922f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5670c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 56713705ce5bSJoe Perches if (ERROR("SPACING", 56723705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 56733705ce5bSJoe Perches $fix) { 5674194f66fcSJoe Perches $fixed[$fixlinenr] =~ 56753705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 56763705ce5bSJoe Perches } 56773705ce5bSJoe Perches 567822f2a2efSAndy Whitcroft } 567922f2a2efSAndy Whitcroft 56804a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5681171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5682171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 56834a0df2efSAndy Whitcroft my $which = $1; 56844a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5685000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5686000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 56874a0df2efSAndy Whitcroft } 56884a0df2efSAndy Whitcroft } 56894a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5690402c2553SMichael S. Tsirkin 5691402c2553SMichael S. Tsirkin my $barriers = qr{ 5692402c2553SMichael S. Tsirkin mb| 5693402c2553SMichael S. Tsirkin rmb| 5694402c2553SMichael S. Tsirkin wmb| 5695402c2553SMichael S. Tsirkin read_barrier_depends 5696402c2553SMichael S. Tsirkin }x; 5697402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5698402c2553SMichael S. Tsirkin mb__before_atomic| 5699402c2553SMichael S. Tsirkin mb__after_atomic| 5700402c2553SMichael S. Tsirkin store_release| 5701402c2553SMichael S. Tsirkin load_acquire| 5702402c2553SMichael S. Tsirkin store_mb| 5703402c2553SMichael S. Tsirkin (?:$barriers) 5704402c2553SMichael S. Tsirkin }x; 5705402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5706402c2553SMichael S. Tsirkin (?:$barriers)| 570743e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 570843e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5709402c2553SMichael S. Tsirkin }x; 5710402c2553SMichael S. Tsirkin 5711402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 57124a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5713c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5714000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 57154a0df2efSAndy Whitcroft } 57164a0df2efSAndy Whitcroft } 57173ad81779SPaul E. McKenney 5718f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5719f4073b0fSMichael S. Tsirkin 5720f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5721f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5722f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5723f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5724f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5725f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5726f4073b0fSMichael S. Tsirkin } 5727f4073b0fSMichael S. Tsirkin 5728cb426e99SJoe Perches# check for waitqueue_active without a comment. 5729cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5730cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5731cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5732cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5733cb426e99SJoe Perches } 5734cb426e99SJoe Perches } 57353ad81779SPaul E. McKenney 573691db2592SPaul E. McKenney# check for smp_read_barrier_depends and read_barrier_depends 573791db2592SPaul E. McKenney if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) { 573891db2592SPaul E. McKenney WARN("READ_BARRIER_DEPENDS", 573991db2592SPaul E. McKenney "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr); 574091db2592SPaul E. McKenney } 574191db2592SPaul E. McKenney 57424a0df2efSAndy Whitcroft# check of hardware specific defines 5743c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5744000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5745000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 57460a920b5bSAndy Whitcroft } 5747653d4876SAndy Whitcroft 5748596ed45bSJoe Perches# check that the storage class is not after a type 5749596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 5750000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5751596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 5752596ed45bSJoe Perches } 5753596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 5754596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 5755596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 5756596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 5757596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 5758596ed45bSJoe Perches WARN("STORAGE_CLASS", 5759596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 5760d4977c78STobias Klauser } 5761d4977c78STobias Klauser 5762de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5763de7d4f0eSAndy Whitcroft# storage class and type. 57649c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 57659c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5766000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5767000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5768de7d4f0eSAndy Whitcroft } 5769de7d4f0eSAndy Whitcroft 57708905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 57712b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57722b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5773d5e616fcSJoe Perches if (WARN("INLINE", 5774d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5775d5e616fcSJoe Perches $fix) { 5776194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5777d5e616fcSJoe Perches 5778d5e616fcSJoe Perches } 57798905a67cSAndy Whitcroft } 57808905a67cSAndy Whitcroft 57813d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 57822b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57832b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5784000d1cc1SJoe Perches WARN("PREFER_PACKED", 5785000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 57863d130fd0SJoe Perches } 57873d130fd0SJoe Perches 578839b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 57892b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57902b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5791000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5792000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 579339b7e287SJoe Perches } 579439b7e287SJoe Perches 57955f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 57962b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57972b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5798d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5799d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5800d5e616fcSJoe Perches $fix) { 5801194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5802d5e616fcSJoe Perches 5803d5e616fcSJoe Perches } 58045f14d3bdSJoe Perches } 58055f14d3bdSJoe Perches 58066061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 58072b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 58082b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5809d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5810d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5811d5e616fcSJoe Perches $fix) { 5812194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5813d5e616fcSJoe Perches } 58146061d949SJoe Perches } 58156061d949SJoe Perches 5816619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 58175b57980dSJoe Perches if ($perl_version_ok && 5818619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5819619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5820619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5821619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5822619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5823619a908aSJoe Perches } 5824619a908aSJoe Perches 5825fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 5826e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5827fd39f904STomas Winkler $realfile !~ m@\btools/@ && 5828e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5829e6176fa4SJoe Perches my $type = $1; 5830e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5831e6176fa4SJoe Perches $type = $1; 5832e6176fa4SJoe Perches my $kernel_type = 'u'; 5833e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5834e6176fa4SJoe Perches $type =~ /(\d+)/; 5835e6176fa4SJoe Perches $kernel_type .= $1; 5836e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5837e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5838e6176fa4SJoe Perches $fix) { 5839e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5840e6176fa4SJoe Perches } 5841e6176fa4SJoe Perches } 5842e6176fa4SJoe Perches } 5843e6176fa4SJoe Perches 5844938224b5SJoe Perches# check for cast of C90 native int or longer types constants 5845938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 5846938224b5SJoe Perches my $cast = $1; 5847938224b5SJoe Perches my $const = $2; 5848938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 5849938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 5850938224b5SJoe Perches $fix) { 5851938224b5SJoe Perches my $suffix = ""; 5852938224b5SJoe Perches my $newconst = $const; 5853938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 5854938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 5855938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 5856938224b5SJoe Perches $suffix .= 'LL'; 5857938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 5858938224b5SJoe Perches $suffix .= 'L'; 5859938224b5SJoe Perches } 5860938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 5861938224b5SJoe Perches } 5862938224b5SJoe Perches } 5863938224b5SJoe Perches 58648f53a9b8SJoe Perches# check for sizeof(&) 58658f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5866000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5867000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 58688f53a9b8SJoe Perches } 58698f53a9b8SJoe Perches 587066c80b60SJoe Perches# check for sizeof without parenthesis 587166c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5872d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5873d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5874d5e616fcSJoe Perches $fix) { 5875194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5876d5e616fcSJoe Perches } 587766c80b60SJoe Perches } 587866c80b60SJoe Perches 587988982feaSJoe Perches# check for struct spinlock declarations 588088982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 588188982feaSJoe Perches WARN("USE_SPINLOCK_T", 588288982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 588388982feaSJoe Perches } 588488982feaSJoe Perches 5885a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 588606668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5887a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5888caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5889caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5890d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5891d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5892d5e616fcSJoe Perches $fix) { 5893194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5894d5e616fcSJoe Perches } 5895a6962d72SJoe Perches } 5896a6962d72SJoe Perches } 5897a6962d72SJoe Perches 58980b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 58995b57980dSJoe Perches if ($perl_version_ok && 59000b523769SJoe Perches defined $stat && 59010b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 59020b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 5903e3c6bc95STobin C. Harding my $stat_real; 5904e3c6bc95STobin C. Harding 59050b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 59060b523769SJoe Perches $lc = $lc + $linenr; 59070b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 5908ffe07513SJoe Perches my $specifier; 5909ffe07513SJoe Perches my $extension; 5910ffe07513SJoe Perches my $bad_specifier = ""; 59110b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 59120b523769SJoe Perches $fmt =~ s/%%//g; 5913e3c6bc95STobin C. Harding 5914e3c6bc95STobin C. Harding while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) { 5915e3c6bc95STobin C. Harding $specifier = $1; 5916e3c6bc95STobin C. Harding $extension = $2; 5917e3c6bc95STobin C. Harding if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOx]/) { 5918e3c6bc95STobin C. Harding $bad_specifier = $specifier; 59190b523769SJoe Perches last; 59200b523769SJoe Perches } 5921e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 5922e3c6bc95STobin C. Harding if (!defined($stat_real)) { 5923e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 59240b523769SJoe Perches } 5925e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 5926e3c6bc95STobin 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"); 5927e3c6bc95STobin C. Harding } 5928e3c6bc95STobin C. Harding } 5929e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 59302a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 59311df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 59321df7338aSSergey Senozhatsky my $use = ""; 5933e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 59341df7338aSSergey Senozhatsky $ext_type = "Deprecated"; 59351df7338aSSergey Senozhatsky $use = " - use %pS instead"; 5936e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 59371df7338aSSergey Senozhatsky } 59382a9f9d85STobin C. Harding 59390b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 5940e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 5941e3c6bc95STobin C. Harding } 59420b523769SJoe Perches } 59430b523769SJoe Perches } 59440b523769SJoe Perches 5945554e165cSAndy Whitcroft# Check for misused memsets 59465b57980dSJoe Perches if ($perl_version_ok && 5947d1fe9c09SJoe Perches defined $stat && 59489e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5949554e165cSAndy Whitcroft 5950d7c76ba7SJoe Perches my $ms_addr = $2; 5951d1fe9c09SJoe Perches my $ms_val = $7; 5952d1fe9c09SJoe Perches my $ms_size = $12; 5953d7c76ba7SJoe Perches 5954554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5955554e165cSAndy Whitcroft ERROR("MEMSET", 5956d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5957554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5958554e165cSAndy Whitcroft WARN("MEMSET", 5959d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5960d7c76ba7SJoe Perches } 5961d7c76ba7SJoe Perches } 5962d7c76ba7SJoe Perches 596398a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 59645b57980dSJoe Perches# if ($perl_version_ok && 5965f333195dSJoe Perches# defined $stat && 5966f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5967f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 5968f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 5969f333195dSJoe Perches# $fix) { 5970f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 5971f333195dSJoe Perches# } 5972f333195dSJoe Perches# } 597398a9bba5SJoe Perches 5974b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 59755b57980dSJoe Perches# if ($perl_version_ok && 5976f333195dSJoe Perches# defined $stat && 5977f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5978f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 5979f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5980f333195dSJoe Perches# } 5981b6117d17SMateusz Kulikowski 59828617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 59838617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 59845b57980dSJoe Perches# if ($perl_version_ok && 5985f333195dSJoe Perches# defined $stat && 5986f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5987f333195dSJoe Perches# 5988f333195dSJoe Perches# my $ms_val = $7; 5989f333195dSJoe Perches# 5990f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 5991f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 5992f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 5993f333195dSJoe Perches# $fix) { 5994f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 5995f333195dSJoe Perches# } 5996f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 5997f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 5998f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 5999f333195dSJoe Perches# $fix) { 6000f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 6001f333195dSJoe Perches# } 6002f333195dSJoe Perches# } 6003f333195dSJoe Perches# } 60048617cd09SMateusz Kulikowski 6005d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 60065b57980dSJoe Perches if ($perl_version_ok && 6007d1fe9c09SJoe Perches defined $stat && 6008d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 6009d1fe9c09SJoe Perches if (defined $2 || defined $7) { 6010d7c76ba7SJoe Perches my $call = $1; 6011d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 6012d7c76ba7SJoe Perches my $arg1 = $3; 6013d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 6014d1fe9c09SJoe Perches my $arg2 = $8; 6015d7c76ba7SJoe Perches my $cast; 6016d7c76ba7SJoe Perches 6017d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 6018d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 6019d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 6020d7c76ba7SJoe Perches $cast = $cast1; 6021d7c76ba7SJoe Perches } else { 6022d7c76ba7SJoe Perches $cast = $cast2; 6023d7c76ba7SJoe Perches } 6024d7c76ba7SJoe Perches WARN("MINMAX", 6025d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 6026554e165cSAndy Whitcroft } 6027554e165cSAndy Whitcroft } 6028554e165cSAndy Whitcroft 60294a273195SJoe Perches# check usleep_range arguments 60305b57980dSJoe Perches if ($perl_version_ok && 60314a273195SJoe Perches defined $stat && 60324a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 60334a273195SJoe Perches my $min = $1; 60344a273195SJoe Perches my $max = $7; 60354a273195SJoe Perches if ($min eq $max) { 60364a273195SJoe Perches WARN("USLEEP_RANGE", 60374a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 60384a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 60394a273195SJoe Perches $min > $max) { 60404a273195SJoe Perches WARN("USLEEP_RANGE", 60414a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 60424a273195SJoe Perches } 60434a273195SJoe Perches } 60444a273195SJoe Perches 6045823b794cSJoe Perches# check for naked sscanf 60465b57980dSJoe Perches if ($perl_version_ok && 6047823b794cSJoe Perches defined $stat && 60486c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 6049823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 6050823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 6051823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 6052823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 6053823b794cSJoe Perches $lc = $lc + $linenr; 60542a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6055823b794cSJoe Perches WARN("NAKED_SSCANF", 6056823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 6057823b794cSJoe Perches } 6058823b794cSJoe Perches 6059afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 60605b57980dSJoe Perches if ($perl_version_ok && 6061afc819abSJoe Perches defined $stat && 6062afc819abSJoe Perches $line =~ /\bsscanf\b/) { 6063afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 6064afc819abSJoe Perches $lc = $lc + $linenr; 60652a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6066afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 6067afc819abSJoe Perches my $format = $6; 6068afc819abSJoe Perches my $count = $format =~ tr@%@%@; 6069afc819abSJoe Perches if ($count == 1 && 6070afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 6071afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 6072afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 6073afc819abSJoe Perches } 6074afc819abSJoe Perches } 6075afc819abSJoe Perches } 6076afc819abSJoe Perches 607770dc8a48SJoe Perches# check for new externs in .h files. 607870dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 607970dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 6080d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 608170dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 608270dc8a48SJoe Perches $fix) { 6083194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 608470dc8a48SJoe Perches } 608570dc8a48SJoe Perches } 608670dc8a48SJoe Perches 6087de7d4f0eSAndy Whitcroft# check for new externs in .c files. 6088171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 6089c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 6090171ae1a4SAndy Whitcroft { 6091c45dcabdSAndy Whitcroft my $function_name = $1; 6092c45dcabdSAndy Whitcroft my $paren_space = $2; 6093171ae1a4SAndy Whitcroft 6094171ae1a4SAndy Whitcroft my $s = $stat; 6095171ae1a4SAndy Whitcroft if (defined $cond) { 6096171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 6097171ae1a4SAndy Whitcroft } 6098c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 6099c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 6100c45dcabdSAndy Whitcroft { 6101000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6102000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6103de7d4f0eSAndy Whitcroft } 6104de7d4f0eSAndy Whitcroft 6105171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 6106000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 6107000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 6108171ae1a4SAndy Whitcroft } 61099c9ba34eSAndy Whitcroft 61109c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 61119c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 61129c9ba34eSAndy Whitcroft { 6113000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6114000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6115171ae1a4SAndy Whitcroft } 6116171ae1a4SAndy Whitcroft 6117a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 6118a0ad7596SJoe Perches if (defined $stat && 611925bdda2bSMiles Chen $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 6120ca0d8929SJoe Perches $1 ne "void") { 6121ca0d8929SJoe Perches my $args = trim($1); 6122ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6123ca0d8929SJoe Perches my $arg = trim($1); 6124ca0d8929SJoe Perches if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 6125ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 6126ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6127ca0d8929SJoe Perches } 6128ca0d8929SJoe Perches } 6129ca0d8929SJoe Perches } 6130ca0d8929SJoe Perches 6131a0ad7596SJoe Perches# check for function definitions 61325b57980dSJoe Perches if ($perl_version_ok && 6133a0ad7596SJoe Perches defined $stat && 6134a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6135a0ad7596SJoe Perches $context_function = $1; 6136a0ad7596SJoe Perches 6137a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 6138a0ad7596SJoe Perches my $ok = 0; 6139a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 6140a0ad7596SJoe Perches my $herectx = $here . "\n"; 6141a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6142a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 6143a0ad7596SJoe Perches $herectx .= $rl . "\n"; 6144a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 6145a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 6146a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 6147a0ad7596SJoe Perches } 6148a0ad7596SJoe Perches if (!$ok) { 6149a0ad7596SJoe Perches ERROR("OPEN_BRACE", 6150a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 6151a0ad7596SJoe Perches } 6152a0ad7596SJoe Perches } 6153a0ad7596SJoe Perches 6154de7d4f0eSAndy Whitcroft# checks for new __setup's 6155de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 6156de7d4f0eSAndy Whitcroft my $name = $1; 6157de7d4f0eSAndy Whitcroft 6158de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 6159000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 61608c27ceffSMauro Carvalho Chehab "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr); 6161de7d4f0eSAndy Whitcroft } 6162653d4876SAndy Whitcroft } 61639c0ca6f9SAndy Whitcroft 61649c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 6165caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 6166000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 6167000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 61689c0ca6f9SAndy Whitcroft } 616913214adfSAndy Whitcroft 6170a640d25cSJoe Perches# alloc style 6171a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 61725b57980dSJoe Perches if ($perl_version_ok && 6173a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 6174a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 6175a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 6176a640d25cSJoe Perches } 6177a640d25cSJoe Perches 617860a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 61795b57980dSJoe Perches if ($perl_version_ok && 61801b4a2ed4SJoe Perches defined $stat && 61811b4a2ed4SJoe Perches $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 618260a55369SJoe Perches my $oldfunc = $3; 618360a55369SJoe Perches my $a1 = $4; 618460a55369SJoe Perches my $a2 = $10; 618560a55369SJoe Perches my $newfunc = "kmalloc_array"; 618660a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 618760a55369SJoe Perches my $r1 = $a1; 618860a55369SJoe Perches my $r2 = $a2; 618960a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 619060a55369SJoe Perches $r1 = $a2; 619160a55369SJoe Perches $r2 = $a1; 619260a55369SJoe Perches } 6193e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 6194e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 61951b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 6196e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6197e3d95a2aSTobin C. Harding 6198e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 61991b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 62001b4a2ed4SJoe Perches $cnt == 1 && 6201e367455aSJoe Perches $fix) { 6202194f66fcSJoe 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; 620360a55369SJoe Perches } 620460a55369SJoe Perches } 620560a55369SJoe Perches } 620660a55369SJoe Perches 6207972fdea2SJoe Perches# check for krealloc arg reuse 62085b57980dSJoe Perches if ($perl_version_ok && 62094cab63ceSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ && 62104cab63ceSJoe Perches $1 eq $3) { 6211972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 6212972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 6213972fdea2SJoe Perches } 6214972fdea2SJoe Perches 62155ce59ae0SJoe Perches# check for alloc argument mismatch 62165ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 62175ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 62185ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 62195ce59ae0SJoe Perches } 62205ce59ae0SJoe Perches 6221caf2a54fSJoe Perches# check for multiple semicolons 6222caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 6223d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 6224d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 6225d5e616fcSJoe Perches $fix) { 6226194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 6227d5e616fcSJoe Perches } 6228d1e2ad07SJoe Perches } 6229d1e2ad07SJoe Perches 6230cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 6231cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 6232cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 62330ab90191SJoe Perches my $ull = ""; 62340ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 62350ab90191SJoe Perches if (CHK("BIT_MACRO", 62360ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 62370ab90191SJoe Perches $fix) { 62380ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 62390ab90191SJoe Perches } 62400ab90191SJoe Perches } 62410ab90191SJoe Perches 62422d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 62432d632745SJoe 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*$/) { 62442d632745SJoe Perches my $config = $1; 62452d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 62462d632745SJoe Perches "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) && 62472d632745SJoe Perches $fix) { 62482d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 62492d632745SJoe Perches } 62502d632745SJoe Perches } 62512d632745SJoe Perches 6252e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 6253c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 6254c34c09a8SJoe Perches my $has_break = 0; 6255c34c09a8SJoe Perches my $has_statement = 0; 6256c34c09a8SJoe Perches my $count = 0; 6257c34c09a8SJoe Perches my $prevline = $linenr; 6258e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 6259c34c09a8SJoe Perches $prevline--; 6260c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 6261c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 6262c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 6263c34c09a8SJoe Perches next if ($fline =~ /^\-/); 6264c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 6265c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 6266c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 6267c34c09a8SJoe Perches $has_statement = 1; 6268c34c09a8SJoe Perches $count++; 6269258f79d5SHeinrich Schuchardt $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/); 6270c34c09a8SJoe Perches } 6271c34c09a8SJoe Perches if (!$has_break && $has_statement) { 6272c34c09a8SJoe Perches WARN("MISSING_BREAK", 6273224236d9SAndrew Morton "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr); 6274c34c09a8SJoe Perches } 6275c34c09a8SJoe Perches } 6276c34c09a8SJoe Perches 6277d1e2ad07SJoe Perches# check for switch/default statements without a break; 62785b57980dSJoe Perches if ($perl_version_ok && 6279d1e2ad07SJoe Perches defined $stat && 6280d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 6281d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 6282e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6283e3d95a2aSTobin C. Harding 6284d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 6285d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 6286caf2a54fSJoe Perches } 6287caf2a54fSJoe Perches 628813214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 6289d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 6290d5e616fcSJoe Perches if (WARN("USE_FUNC", 6291d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 6292d5e616fcSJoe Perches $fix) { 6293194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 6294d5e616fcSJoe Perches } 629513214adfSAndy Whitcroft } 6296773647a0SAndy Whitcroft 629762ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 629862ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 629962ec818fSJoe Perches ERROR("DATE_TIME", 630062ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 630162ec818fSJoe Perches } 630262ec818fSJoe Perches 63032c92488aSJoe Perches# check for use of yield() 63042c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 63052c92488aSJoe Perches WARN("YIELD", 63062c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 63072c92488aSJoe Perches } 63082c92488aSJoe Perches 6309179f8f40SJoe Perches# check for comparisons against true and false 6310179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 6311179f8f40SJoe Perches my $lead = $1; 6312179f8f40SJoe Perches my $arg = $2; 6313179f8f40SJoe Perches my $test = $3; 6314179f8f40SJoe Perches my $otype = $4; 6315179f8f40SJoe Perches my $trail = $5; 6316179f8f40SJoe Perches my $op = "!"; 6317179f8f40SJoe Perches 6318179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 6319179f8f40SJoe Perches 6320179f8f40SJoe Perches my $type = lc($otype); 6321179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 6322179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 6323179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 6324179f8f40SJoe Perches $op = ""; 6325179f8f40SJoe Perches } 6326179f8f40SJoe Perches 6327179f8f40SJoe Perches CHK("BOOL_COMPARISON", 6328179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 6329179f8f40SJoe Perches 6330179f8f40SJoe Perches## maybe suggesting a correct construct would better 6331179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 6332179f8f40SJoe Perches 6333179f8f40SJoe Perches } 6334179f8f40SJoe Perches } 6335179f8f40SJoe Perches 63365d430902SJoe Perches# check for bool bitfields 63375d430902SJoe Perches if ($sline =~ /^.\s+bool\s*$Ident\s*:\s*\d+\s*;/) { 63385d430902SJoe Perches WARN("BOOL_BITFIELD", 63395d430902SJoe Perches "Avoid using bool as bitfield. Prefer bool bitfields as unsigned int or u<8|16|32>\n" . $herecurr); 63405d430902SJoe Perches } 63415d430902SJoe Perches 6342d729593eSJoe Perches# check for bool use in .h files 6343d729593eSJoe Perches if ($realfile =~ /\.h$/ && 6344d729593eSJoe Perches $sline =~ /^.\s+bool\s*$Ident\s*(?::\s*d+\s*)?;/) { 6345d729593eSJoe Perches CHK("BOOL_MEMBER", 6346d729593eSJoe Perches "Avoid using bool structure members because of possible alignment issues - see: https://lkml.org/lkml/2017/11/21/384\n" . $herecurr); 6347d729593eSJoe Perches } 6348d729593eSJoe Perches 63494882720bSThomas Gleixner# check for semaphores initialized locked 63504882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 6351000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 6352000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 6353773647a0SAndy Whitcroft } 63546712d858SJoe Perches 635567d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 635667d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 6357000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 635867d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 6359773647a0SAndy Whitcroft } 63606712d858SJoe Perches 6361ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 6362f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 6363000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 6364ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 6365f3db6639SMichael Ellerman } 63666712d858SJoe Perches 63670f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 6368d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 63696903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 6370d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 6371000d1cc1SJoe Perches WARN("CONST_STRUCT", 6372d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 63732b6db5cbSAndy Whitcroft } 6374773647a0SAndy Whitcroft 6375773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 6376773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 6377773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 6378c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 6379c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 6380171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 6381171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 6382171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 6383773647a0SAndy Whitcroft { 6384000d1cc1SJoe Perches WARN("NR_CPUS", 6385000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 6386773647a0SAndy Whitcroft } 63879c9ba34eSAndy Whitcroft 638852ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 638952ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 639052ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 639152ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 639252ea8506SJoe Perches } 639352ea8506SJoe Perches 6394acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 63955b57980dSJoe Perches if ($perl_version_ok && 6396acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 6397acd9362cSJoe Perches WARN("LIKELY_MISUSE", 6398acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 6399acd9362cSJoe Perches } 6400acd9362cSJoe Perches 6401691d77b6SAndy Whitcroft# whine mightly about in_atomic 6402691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 6403691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 6404000d1cc1SJoe Perches ERROR("IN_ATOMIC", 6405000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 6406f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 6407000d1cc1SJoe Perches WARN("IN_ATOMIC", 6408000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 6409691d77b6SAndy Whitcroft } 6410691d77b6SAndy Whitcroft } 64111704f47bSPeter Zijlstra 64120f5225b0SPeter Zijlstra# check for mutex_trylock_recursive usage 64130f5225b0SPeter Zijlstra if ($line =~ /mutex_trylock_recursive/) { 64140f5225b0SPeter Zijlstra ERROR("LOCKING", 64150f5225b0SPeter Zijlstra "recursive locking is bad, do not use this ever.\n" . $herecurr); 64160f5225b0SPeter Zijlstra } 64170f5225b0SPeter Zijlstra 64181704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 64191704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 64201704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 64211704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 64221704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 64231704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 6424000d1cc1SJoe Perches ERROR("LOCKDEP", 6425000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 64261704f47bSPeter Zijlstra } 64271704f47bSPeter Zijlstra } 642888f8831cSDave Jones 6429b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 6430b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 6431000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 6432000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 643388f8831cSDave Jones } 64342435880fSJoe Perches 643500180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 643600180468SJoe Perches# and whether or not function naming is typical and if 643700180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 64385b57980dSJoe Perches if ($perl_version_ok && 643900180468SJoe Perches defined $stat && 644000180468SJoe 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*\)/) { 644100180468SJoe Perches my $var = $1; 644200180468SJoe Perches my $perms = $2; 644300180468SJoe Perches my $show = $3; 644400180468SJoe Perches my $store = $4; 644500180468SJoe Perches my $octal_perms = perms_to_octal($perms); 644600180468SJoe Perches if ($show =~ /^${var}_show$/ && 644700180468SJoe Perches $store =~ /^${var}_store$/ && 644800180468SJoe Perches $octal_perms eq "0644") { 644900180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 645000180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 645100180468SJoe Perches $fix) { 645200180468SJoe 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})/; 645300180468SJoe Perches } 645400180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 645500180468SJoe Perches $store =~ /^NULL$/ && 645600180468SJoe Perches $octal_perms eq "0444") { 645700180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 645800180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 645900180468SJoe Perches $fix) { 646000180468SJoe 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})/; 646100180468SJoe Perches } 646200180468SJoe Perches } elsif ($show =~ /^NULL$/ && 646300180468SJoe Perches $store =~ /^${var}_store$/ && 646400180468SJoe Perches $octal_perms eq "0200") { 646500180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 646600180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 646700180468SJoe Perches $fix) { 646800180468SJoe 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})/; 646900180468SJoe Perches } 647000180468SJoe Perches } elsif ($octal_perms eq "0644" || 647100180468SJoe Perches $octal_perms eq "0444" || 647200180468SJoe Perches $octal_perms eq "0200") { 647300180468SJoe Perches my $newshow = "$show"; 647400180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 647500180468SJoe Perches my $newstore = $store; 647600180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 647700180468SJoe Perches my $rename = ""; 647800180468SJoe Perches if ($show ne $newshow) { 647900180468SJoe Perches $rename .= " '$show' to '$newshow'"; 648000180468SJoe Perches } 648100180468SJoe Perches if ($store ne $newstore) { 648200180468SJoe Perches $rename .= " '$store' to '$newstore'"; 648300180468SJoe Perches } 648400180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 648500180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 648600180468SJoe Perches } else { 648700180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 648800180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 648900180468SJoe Perches } 649000180468SJoe Perches } 649100180468SJoe Perches 6492515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 6493515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 649473121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 649573121534SJoe Perches# specific definition of not visible in sysfs. 649673121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 649773121534SJoe Perches# use the default permissions 64985b57980dSJoe Perches if ($perl_version_ok && 6499459cf0aeSJoe Perches defined $stat && 6500515a235eSJoe Perches $line =~ /$mode_perms_search/) { 65012435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 65022435880fSJoe Perches my $func = $entry->[0]; 65032435880fSJoe Perches my $arg_pos = $entry->[1]; 65042435880fSJoe Perches 6505459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 6506459cf0aeSJoe Perches $lc = $lc + $linenr; 65072a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6508459cf0aeSJoe Perches 65092435880fSJoe Perches my $skip_args = ""; 65102435880fSJoe Perches if ($arg_pos > 1) { 65112435880fSJoe Perches $arg_pos--; 65122435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 65132435880fSJoe Perches } 6514f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 6515459cf0aeSJoe Perches if ($stat =~ /$test/) { 65162435880fSJoe Perches my $val = $1; 65172435880fSJoe Perches $val = $6 if ($skip_args ne ""); 651873121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 651973121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 652073121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 65212435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 6522459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 6523f90774e1SJoe Perches } 6524f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6525c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6526459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 65272435880fSJoe Perches } 6528459cf0aeSJoe Perches } 6529459cf0aeSJoe Perches } 6530459cf0aeSJoe Perches } 6531459cf0aeSJoe Perches 6532459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 6533bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 653400180468SJoe Perches my $oval = $1; 653500180468SJoe Perches my $octal = perms_to_octal($oval); 6536f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 6537459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 6538f90774e1SJoe Perches $fix) { 653900180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 65402435880fSJoe Perches } 654113214adfSAndy Whitcroft } 65425a6d20ceSBjorn Andersson 65435a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 65445a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 65455a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 65465a6d20ceSBjorn Andersson my $valid_licenses = qr{ 65475a6d20ceSBjorn Andersson GPL| 65485a6d20ceSBjorn Andersson GPL\ v2| 65495a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 65505a6d20ceSBjorn Andersson Dual\ BSD/GPL| 65515a6d20ceSBjorn Andersson Dual\ MIT/GPL| 65525a6d20ceSBjorn Andersson Dual\ MPL/GPL| 65535a6d20ceSBjorn Andersson Proprietary 65545a6d20ceSBjorn Andersson }x; 65555a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 65565a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 65575a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 65585a6d20ceSBjorn Andersson } 65595a6d20ceSBjorn Andersson } 6560515a235eSJoe Perches } 656113214adfSAndy Whitcroft 656213214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 656313214adfSAndy Whitcroft # so just keep quiet. 656413214adfSAndy Whitcroft if ($#rawlines == -1) { 656513214adfSAndy Whitcroft exit(0); 65660a920b5bSAndy Whitcroft } 65670a920b5bSAndy Whitcroft 65688905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 65698905a67cSAndy Whitcroft # things that appear to be patches. 65708905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 65718905a67cSAndy Whitcroft exit(0); 65728905a67cSAndy Whitcroft } 65738905a67cSAndy Whitcroft 65748905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 65758905a67cSAndy Whitcroft # just keep quiet. 65768905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 65778905a67cSAndy Whitcroft exit(0); 65788905a67cSAndy Whitcroft } 65798905a67cSAndy Whitcroft 6580a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 6581000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6582000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 65830a920b5bSAndy Whitcroft } 6584cd261496SGeert Uytterhoeven if ($is_patch && $has_commit_log && $chk_signoff) { 6585cd261496SGeert Uytterhoeven if ($signoff == 0) { 6586000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6587000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 6588cd261496SGeert Uytterhoeven } elsif (!$authorsignoff) { 6589cd261496SGeert Uytterhoeven WARN("NO_AUTHOR_SIGN_OFF", 6590cd261496SGeert Uytterhoeven "Missing Signed-off-by: line by nominal patch author '$author'\n"); 6591cd261496SGeert Uytterhoeven } 65920a920b5bSAndy Whitcroft } 65930a920b5bSAndy Whitcroft 6594f0a594c1SAndy Whitcroft print report_dump(); 659513214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 659613214adfSAndy Whitcroft print "$filename " if ($summary_file); 65976c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 65986c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 65996c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 66006c72ffaaSAndy Whitcroft } 66018905a67cSAndy Whitcroft 6602d2c0a235SAndy Whitcroft if ($quiet == 0) { 6603ef212196SJoe Perches # If there were any defects found and not already fixing them 6604ef212196SJoe Perches if (!$clean and !$fix) { 6605ef212196SJoe Perches print << "EOM" 6606ef212196SJoe Perches 6607ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 6608ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 6609ef212196SJoe PerchesEOM 6610ef212196SJoe Perches } 6611d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 6612d2c0a235SAndy Whitcroft # then suggest that. 6613d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 6614b0781216SMike Frysinger $rpt_cleaners = 0; 6615d8469f16SJoe Perches print << "EOM" 6616d8469f16SJoe Perches 6617d8469f16SJoe PerchesNOTE: Whitespace errors detected. 6618d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 6619d8469f16SJoe PerchesEOM 6620d2c0a235SAndy Whitcroft } 6621d2c0a235SAndy Whitcroft } 6622d2c0a235SAndy Whitcroft 6623d752fcc8SJoe Perches if ($clean == 0 && $fix && 6624d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 6625d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 66269624b8d6SJoe Perches my $newfile = $filename; 66279624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 66283705ce5bSJoe Perches my $linecount = 0; 66293705ce5bSJoe Perches my $f; 66303705ce5bSJoe Perches 6631d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 6632d752fcc8SJoe Perches 66333705ce5bSJoe Perches open($f, '>', $newfile) 66343705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 66353705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 66363705ce5bSJoe Perches $linecount++; 66373705ce5bSJoe Perches if ($file) { 66383705ce5bSJoe Perches if ($linecount > 3) { 66393705ce5bSJoe Perches $fixed_line =~ s/^\+//; 66403705ce5bSJoe Perches print $f $fixed_line . "\n"; 66413705ce5bSJoe Perches } 66423705ce5bSJoe Perches } else { 66433705ce5bSJoe Perches print $f $fixed_line . "\n"; 66443705ce5bSJoe Perches } 66453705ce5bSJoe Perches } 66463705ce5bSJoe Perches close($f); 66473705ce5bSJoe Perches 66483705ce5bSJoe Perches if (!$quiet) { 66493705ce5bSJoe Perches print << "EOM"; 6650d8469f16SJoe Perches 66513705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 66523705ce5bSJoe Perches 66533705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 66543705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 66553705ce5bSJoe Perches 66563705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 66573705ce5bSJoe PerchesNo warranties, expressed or implied... 66583705ce5bSJoe PerchesEOM 66593705ce5bSJoe Perches } 66603705ce5bSJoe Perches } 66613705ce5bSJoe Perches 6662d8469f16SJoe Perches if ($quiet == 0) { 6663d8469f16SJoe Perches print "\n"; 6664d8469f16SJoe Perches if ($clean == 1) { 6665d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 6666d8469f16SJoe Perches } else { 6667d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 66680a920b5bSAndy Whitcroft } 66690a920b5bSAndy Whitcroft } 66700a920b5bSAndy Whitcroft return $clean; 66710a920b5bSAndy Whitcroft} 6672