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; 2254133712a2SRob Herring my $is_binding_patch = -1; 225529ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 225615662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 2257ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2258490b292cSJoe Perches my $commit_log_lines = 0; #Number of commit log lines 2259bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 22602a076f40SJoe Perches my $commit_log_long_line = 0; 2261e518e9a5SJoe Perches my $commit_log_has_diff = 0; 226213f1937eSJoe Perches my $reported_maintainer_file = 0; 2263fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2264fa64205dSPasi Savanainen 2265365dd4eaSJoe Perches my $last_blank_line = 0; 22665e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2267365dd4eaSJoe Perches 226813214adfSAndy Whitcroft our @report = (); 22696c72ffaaSAndy Whitcroft our $cnt_lines = 0; 22706c72ffaaSAndy Whitcroft our $cnt_error = 0; 22716c72ffaaSAndy Whitcroft our $cnt_warn = 0; 22726c72ffaaSAndy Whitcroft our $cnt_chk = 0; 22736c72ffaaSAndy Whitcroft 22740a920b5bSAndy Whitcroft # Trace the real file/line as we go. 22750a920b5bSAndy Whitcroft my $realfile = ''; 22760a920b5bSAndy Whitcroft my $realline = 0; 22770a920b5bSAndy Whitcroft my $realcnt = 0; 22780a920b5bSAndy Whitcroft my $here = ''; 227977cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 22800a920b5bSAndy Whitcroft my $in_comment = 0; 2281c2fdda0dSAndy Whitcroft my $comment_edge = 0; 22820a920b5bSAndy Whitcroft my $first_line = 0; 22831e855726SWolfram Sang my $p1_prefix = ''; 22840a920b5bSAndy Whitcroft 228513214adfSAndy Whitcroft my $prev_values = 'E'; 228613214adfSAndy Whitcroft 228713214adfSAndy Whitcroft # suppression flags 2288773647a0SAndy Whitcroft my %suppress_ifbraces; 2289170d3a22SAndy Whitcroft my %suppress_whiletrailers; 22902b474a1aSAndy Whitcroft my %suppress_export; 22913e469cdcSAndy Whitcroft my $suppress_statement = 0; 2292653d4876SAndy Whitcroft 22937e51f197SJoe Perches my %signatures = (); 2294323c1260SJoe Perches 2295c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2296de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2297c2fdda0dSAndy Whitcroft # 2298de7d4f0eSAndy Whitcroft my @setup_docs = (); 2299de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2300773647a0SAndy Whitcroft 2301d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2302d8b07710SJoe Perches 23039f3a8992SRob Herring my $checklicenseline = 1; 23049f3a8992SRob Herring 2305773647a0SAndy Whitcroft sanitise_line_reset(); 2306c2fdda0dSAndy Whitcroft my $line; 2307c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2308773647a0SAndy Whitcroft $linenr++; 2309773647a0SAndy Whitcroft $line = $rawline; 2310c2fdda0dSAndy Whitcroft 23113705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 23123705ce5bSJoe Perches 2313773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2314de7d4f0eSAndy Whitcroft $setup_docs = 0; 23158c27ceffSMauro Carvalho Chehab if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) { 2316de7d4f0eSAndy Whitcroft $setup_docs = 1; 2317de7d4f0eSAndy Whitcroft } 2318773647a0SAndy Whitcroft #next; 2319de7d4f0eSAndy Whitcroft } 232074fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2321773647a0SAndy Whitcroft $realline=$1-1; 2322773647a0SAndy Whitcroft if (defined $2) { 2323773647a0SAndy Whitcroft $realcnt=$3+1; 2324773647a0SAndy Whitcroft } else { 2325773647a0SAndy Whitcroft $realcnt=1+1; 2326773647a0SAndy Whitcroft } 2327c45dcabdSAndy Whitcroft $in_comment = 0; 2328773647a0SAndy Whitcroft 2329773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2330773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2331773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2332773647a0SAndy Whitcroft # at context start. 2333773647a0SAndy Whitcroft my $edge; 233401fa9147SAndy Whitcroft my $cnt = $realcnt; 233501fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 233601fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 233701fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 233801fa9147SAndy Whitcroft $cnt--; 233901fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2340721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2341fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2342fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2343fae17daeSAndy Whitcroft ($edge) = $1; 2344fae17daeSAndy Whitcroft last; 2345fae17daeSAndy Whitcroft } 2346773647a0SAndy Whitcroft } 2347773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2348773647a0SAndy Whitcroft $in_comment = 1; 2349773647a0SAndy Whitcroft } 2350773647a0SAndy Whitcroft 2351773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2352773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2353773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2354773647a0SAndy Whitcroft if (!defined $edge && 235583242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2356773647a0SAndy Whitcroft { 2357773647a0SAndy Whitcroft $in_comment = 1; 2358773647a0SAndy Whitcroft } 2359773647a0SAndy Whitcroft 2360773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2361773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2362773647a0SAndy Whitcroft 2363171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2364773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2365171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2366773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2367773647a0SAndy Whitcroft } 2368773647a0SAndy Whitcroft push(@lines, $line); 2369773647a0SAndy Whitcroft 2370773647a0SAndy Whitcroft if ($realcnt > 1) { 2371773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2372773647a0SAndy Whitcroft } else { 2373773647a0SAndy Whitcroft $realcnt = 0; 2374773647a0SAndy Whitcroft } 2375773647a0SAndy Whitcroft 2376773647a0SAndy Whitcroft #print "==>$rawline\n"; 2377773647a0SAndy Whitcroft #print "-->$line\n"; 2378de7d4f0eSAndy Whitcroft 2379de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2380de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2381de7d4f0eSAndy Whitcroft } 2382de7d4f0eSAndy Whitcroft } 2383de7d4f0eSAndy Whitcroft 23846c72ffaaSAndy Whitcroft $prefix = ''; 23856c72ffaaSAndy Whitcroft 2386773647a0SAndy Whitcroft $realcnt = 0; 2387773647a0SAndy Whitcroft $linenr = 0; 2388194f66fcSJoe Perches $fixlinenr = -1; 23890a920b5bSAndy Whitcroft foreach my $line (@lines) { 23900a920b5bSAndy Whitcroft $linenr++; 2391194f66fcSJoe Perches $fixlinenr++; 23921b5539b1SJoe Perches my $sline = $line; #copy of $line 23931b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 23940a920b5bSAndy Whitcroft 2395c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 23966c72ffaaSAndy Whitcroft 239712c253abSJoe Perches# check if it's a mode change, rename or start of a patch 239812c253abSJoe Perches if (!$in_commit_log && 239912c253abSJoe Perches ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 240012c253abSJoe Perches ($line =~ /^rename (?:from|to) \S+\s*$/ || 240112c253abSJoe Perches $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 240212c253abSJoe Perches $is_patch = 1; 240312c253abSJoe Perches } 240412c253abSJoe Perches 24050a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2406e518e9a5SJoe Perches if (!$in_commit_log && 240774fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 240874fd4f34SJoe Perches my $context = $4; 24090a920b5bSAndy Whitcroft $is_patch = 1; 24104a0df2efSAndy Whitcroft $first_line = $linenr + 1; 24110a920b5bSAndy Whitcroft $realline=$1-1; 24120a920b5bSAndy Whitcroft if (defined $2) { 24130a920b5bSAndy Whitcroft $realcnt=$3+1; 24140a920b5bSAndy Whitcroft } else { 24150a920b5bSAndy Whitcroft $realcnt=1+1; 24160a920b5bSAndy Whitcroft } 2417c2fdda0dSAndy Whitcroft annotate_reset(); 241813214adfSAndy Whitcroft $prev_values = 'E'; 241913214adfSAndy Whitcroft 2420773647a0SAndy Whitcroft %suppress_ifbraces = (); 2421170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 24222b474a1aSAndy Whitcroft %suppress_export = (); 24233e469cdcSAndy Whitcroft $suppress_statement = 0; 242474fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 242574fd4f34SJoe Perches $context_function = $1; 242674fd4f34SJoe Perches } else { 242774fd4f34SJoe Perches undef $context_function; 242874fd4f34SJoe Perches } 24290a920b5bSAndy Whitcroft next; 24300a920b5bSAndy Whitcroft 24314a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 24324a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 24334a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2434773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 24350a920b5bSAndy Whitcroft $realline++; 2436d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 24370a920b5bSAndy Whitcroft 24384a0df2efSAndy Whitcroft # Measure the line length and indent. 2439c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 24400a920b5bSAndy Whitcroft 24410a920b5bSAndy Whitcroft # Track the previous line. 24420a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 24430a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2444c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2445c2fdda0dSAndy Whitcroft 2446773647a0SAndy Whitcroft #warn "line<$line>\n"; 24476c72ffaaSAndy Whitcroft 2448d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2449d8aaf121SAndy Whitcroft $realcnt--; 24500a920b5bSAndy Whitcroft } 24510a920b5bSAndy Whitcroft 2452cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2453cc77cdcaSAndy Whitcroft 24546c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 24556c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2456773647a0SAndy Whitcroft 24572ac73b4fSJoe Perches my $found_file = 0; 2458773647a0SAndy Whitcroft # extract the filename as it passes 24593bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 24603bf9a009SRabin Vincent $realfile = $1; 24612b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2462270c49a0SJoe Perches $in_commit_log = 0; 24632ac73b4fSJoe Perches $found_file = 1; 24643bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2465773647a0SAndy Whitcroft $realfile = $1; 24662b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2467270c49a0SJoe Perches $in_commit_log = 0; 24681e855726SWolfram Sang 24691e855726SWolfram Sang $p1_prefix = $1; 2470e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2471e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2472000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2473000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 24741e855726SWolfram Sang } 2475773647a0SAndy Whitcroft 2476c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2477000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2478000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2479773647a0SAndy Whitcroft } 24802ac73b4fSJoe Perches $found_file = 1; 24812ac73b4fSJoe Perches } 24822ac73b4fSJoe Perches 248334d8815fSJoe Perches#make up the handle for any error we report on this line 248434d8815fSJoe Perches if ($showfile) { 248534d8815fSJoe Perches $prefix = "$realfile:$realline: " 248634d8815fSJoe Perches } elsif ($emacs) { 24877d3a9f67SJoe Perches if ($file) { 24887d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 24897d3a9f67SJoe Perches } else { 249034d8815fSJoe Perches $prefix = "$filename:$linenr: "; 249134d8815fSJoe Perches } 24927d3a9f67SJoe Perches } 249334d8815fSJoe Perches 24942ac73b4fSJoe Perches if ($found_file) { 249585b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 249685b0ee18SJoe Perches WARN("OBSOLETE", 249785b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 249885b0ee18SJoe Perches } 24997bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 25002ac73b4fSJoe Perches $check = 1; 25012ac73b4fSJoe Perches } else { 25022ac73b4fSJoe Perches $check = $check_orig; 25032ac73b4fSJoe Perches } 25049f3a8992SRob Herring $checklicenseline = 1; 2505133712a2SRob Herring 2506133712a2SRob Herring if ($realfile !~ /^MAINTAINERS/) { 2507133712a2SRob Herring my $last_binding_patch = $is_binding_patch; 2508133712a2SRob Herring 2509133712a2SRob Herring $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@; 2510133712a2SRob Herring 2511133712a2SRob Herring if (($last_binding_patch != -1) && 2512133712a2SRob Herring ($last_binding_patch ^ $is_binding_patch)) { 2513133712a2SRob Herring WARN("DT_SPLIT_BINDING_PATCH", 2514133712a2SRob Herring "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n"); 2515133712a2SRob Herring } 2516133712a2SRob Herring } 2517133712a2SRob Herring 2518773647a0SAndy Whitcroft next; 2519773647a0SAndy Whitcroft } 2520773647a0SAndy Whitcroft 2521389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 25220a920b5bSAndy Whitcroft 2523c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2524c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2525c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 25260a920b5bSAndy Whitcroft 25276c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 25286c72ffaaSAndy Whitcroft 2529490b292cSJoe Perches# Verify the existence of a commit log if appropriate 2530490b292cSJoe Perches# 2 is used because a $signature is counted in $commit_log_lines 2531490b292cSJoe Perches if ($in_commit_log) { 2532490b292cSJoe Perches if ($line !~ /^\s*$/) { 2533490b292cSJoe Perches $commit_log_lines++; #could be a $signature 2534490b292cSJoe Perches } 2535490b292cSJoe Perches } elsif ($has_commit_log && $commit_log_lines < 2) { 2536490b292cSJoe Perches WARN("COMMIT_MESSAGE", 2537490b292cSJoe Perches "Missing commit description - Add an appropriate one\n"); 2538490b292cSJoe Perches $commit_log_lines = 2; #warn only once 2539490b292cSJoe Perches } 2540490b292cSJoe Perches 2541e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2542e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2543e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2544e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2545e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2546e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2547e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2548e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2549e518e9a5SJoe Perches $commit_log_has_diff = 1; 2550e518e9a5SJoe Perches } 2551e518e9a5SJoe Perches 25523bf9a009SRabin Vincent# Check for incorrect file permissions 25533bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 25543bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 255504db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 255604db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2557000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2558000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 25593bf9a009SRabin Vincent } 25603bf9a009SRabin Vincent } 25613bf9a009SRabin Vincent 2562cd261496SGeert Uytterhoeven# Check the patch for a From: 2563cd261496SGeert Uytterhoeven if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { 2564cd261496SGeert Uytterhoeven $author = $1; 2565cd261496SGeert Uytterhoeven $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); 2566cd261496SGeert Uytterhoeven $author =~ s/"//g; 2567cd261496SGeert Uytterhoeven } 2568cd261496SGeert Uytterhoeven 256920112475SJoe Perches# Check the patch for a signoff: 2570d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 25714a0df2efSAndy Whitcroft $signoff++; 257215662b3eSJoe Perches $in_commit_log = 0; 2573cd261496SGeert Uytterhoeven if ($author ne '') { 2574cd261496SGeert Uytterhoeven my $l = $line; 2575cd261496SGeert Uytterhoeven $l =~ s/"//g; 2576cd261496SGeert Uytterhoeven if ($l =~ /^\s*signed-off-by:\s*\Q$author\E/i) { 2577cd261496SGeert Uytterhoeven $authorsignoff = 1; 2578cd261496SGeert Uytterhoeven } 2579cd261496SGeert Uytterhoeven } 25800a920b5bSAndy Whitcroft } 258120112475SJoe Perches 2582e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2583e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2584e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2585e0d975b1SJoe Perches $reported_maintainer_file = 1; 2586e0d975b1SJoe Perches } 2587e0d975b1SJoe Perches 258820112475SJoe Perches# Check signature styles 2589270c49a0SJoe Perches if (!$in_header_lines && 2590ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 259120112475SJoe Perches my $space_before = $1; 259220112475SJoe Perches my $sign_off = $2; 259320112475SJoe Perches my $space_after = $3; 259420112475SJoe Perches my $email = $4; 259520112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 259620112475SJoe Perches 2597ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2598ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2599ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2600ce0338dfSJoe Perches } 260120112475SJoe Perches if (defined $space_before && $space_before ne "") { 26023705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 26033705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 26043705ce5bSJoe Perches $fix) { 2605194f66fcSJoe Perches $fixed[$fixlinenr] = 26063705ce5bSJoe Perches "$ucfirst_sign_off $email"; 26073705ce5bSJoe Perches } 260820112475SJoe Perches } 260920112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 26103705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 26113705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 26123705ce5bSJoe Perches $fix) { 2613194f66fcSJoe Perches $fixed[$fixlinenr] = 26143705ce5bSJoe Perches "$ucfirst_sign_off $email"; 26153705ce5bSJoe Perches } 26163705ce5bSJoe Perches 261720112475SJoe Perches } 261820112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 26193705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 26203705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 26213705ce5bSJoe Perches $fix) { 2622194f66fcSJoe Perches $fixed[$fixlinenr] = 26233705ce5bSJoe Perches "$ucfirst_sign_off $email"; 26243705ce5bSJoe Perches } 262520112475SJoe Perches } 262620112475SJoe Perches 262720112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 262820112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 262920112475SJoe Perches if ($suggested_email eq "") { 2630000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2631000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 263220112475SJoe Perches } else { 263320112475SJoe Perches my $dequoted = $suggested_email; 263420112475SJoe Perches $dequoted =~ s/^"//; 263520112475SJoe Perches $dequoted =~ s/" </ </; 263620112475SJoe Perches # Don't force email to have quotes 263720112475SJoe Perches # Allow just an angle bracketed address 263820112475SJoe Perches if ("$dequoted$comment" ne $email && 263920112475SJoe Perches "<$email_address>$comment" ne $email && 264020112475SJoe Perches "$suggested_email$comment" ne $email) { 2641000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2642000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 264320112475SJoe Perches } 26440a920b5bSAndy Whitcroft } 26457e51f197SJoe Perches 26467e51f197SJoe Perches# Check for duplicate signatures 26477e51f197SJoe Perches my $sig_nospace = $line; 26487e51f197SJoe Perches $sig_nospace =~ s/\s//g; 26497e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 26507e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 26517e51f197SJoe Perches WARN("BAD_SIGN_OFF", 26527e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 26537e51f197SJoe Perches } else { 26547e51f197SJoe Perches $signatures{$sig_nospace} = 1; 26557e51f197SJoe Perches } 26560a920b5bSAndy Whitcroft } 26570a920b5bSAndy Whitcroft 2658a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2659a2fe16b9SJoe Perches if ($in_header_lines && 2660a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2661a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2662a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2663a2fe16b9SJoe Perches } 2664a2fe16b9SJoe Perches 26657ebd05efSChristopher Covington# Check for unwanted Gerrit info 26667ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 26677ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 26687ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 26697ebd05efSChristopher Covington } 26707ebd05efSChristopher Covington 2671369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2672369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2673369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2674369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2675369c8dd3SJoe Perches # timestamp 2676369c8dd3SJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) { 2677369c8dd3SJoe Perches # stack dump address 2678369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2679369c8dd3SJoe Perches } 2680369c8dd3SJoe Perches 26812a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 26822a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2683bf4daf12SJoe Perches length($line) > 75 && 2684bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2685bf4daf12SJoe Perches # file delta changes 2686bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2687bf4daf12SJoe Perches # filename then : 2688bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2689bf4daf12SJoe Perches # A Fixes: or Link: line 2690bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 26912a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 26922a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 26932a076f40SJoe Perches $commit_log_long_line = 1; 26942a076f40SJoe Perches } 26952a076f40SJoe Perches 2696bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2697bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2698bf4daf12SJoe Perches $line =~ /^\s*$/) { 2699bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2700bf4daf12SJoe Perches } 2701bf4daf12SJoe Perches 27020d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2703369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2704aab38f51SJoe Perches $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i && 2705e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 2706fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2707aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2708369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2709bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2710fe043ea1SJoe Perches my $init_char = "c"; 2711fe043ea1SJoe Perches my $orig_commit = ""; 27120d7835fcSJoe Perches my $short = 1; 27130d7835fcSJoe Perches my $long = 0; 27140d7835fcSJoe Perches my $case = 1; 27150d7835fcSJoe Perches my $space = 1; 27160d7835fcSJoe Perches my $hasdesc = 0; 271719c146a6SJoe Perches my $hasparens = 0; 27180d7835fcSJoe Perches my $id = '0123456789ab'; 27190d7835fcSJoe Perches my $orig_desc = "commit description"; 27200d7835fcSJoe Perches my $description = ""; 27210d7835fcSJoe Perches 2722fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2723fe043ea1SJoe Perches $init_char = $1; 2724fe043ea1SJoe Perches $orig_commit = lc($2); 2725fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2726fe043ea1SJoe Perches $orig_commit = lc($1); 2727fe043ea1SJoe Perches } 2728fe043ea1SJoe Perches 27290d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 27300d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 27310d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 27320d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 27330d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 27340d7835fcSJoe Perches $orig_desc = $1; 273519c146a6SJoe Perches $hasparens = 1; 27360d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 27370d7835fcSJoe Perches defined $rawlines[$linenr] && 27380d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 27390d7835fcSJoe Perches $orig_desc = $1; 274019c146a6SJoe Perches $hasparens = 1; 2741b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2742b671fde0SJoe Perches defined $rawlines[$linenr] && 2743b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2744b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2745b671fde0SJoe Perches $orig_desc = $1; 2746b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2747b671fde0SJoe Perches $orig_desc .= " " . $1; 274819c146a6SJoe Perches $hasparens = 1; 27490d7835fcSJoe Perches } 27500d7835fcSJoe Perches 27510d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 27520d7835fcSJoe Perches $id, $orig_desc); 27530d7835fcSJoe Perches 2754948b133aSHeinrich Schuchardt if (defined($id) && 2755948b133aSHeinrich Schuchardt ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { 2756d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 27570d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 27580d7835fcSJoe Perches } 2759d311cd44SJoe Perches } 2760d311cd44SJoe Perches 276113f1937eSJoe Perches# Check for added, moved or deleted files 276213f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 276313f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 276413f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 276513f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 276613f1937eSJoe Perches (defined($1) || defined($2))))) { 2767a82603a8SAndrew Jeffery $is_patch = 1; 276813f1937eSJoe Perches $reported_maintainer_file = 1; 276913f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 277013f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 277113f1937eSJoe Perches } 277213f1937eSJoe Perches 277300df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 27748905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2775000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2776000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 27776c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2778de7d4f0eSAndy Whitcroft } 2779de7d4f0eSAndy Whitcroft 2780de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2781de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2782171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2783171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2784171ae1a4SAndy Whitcroft 2785171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2786171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2787171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2788171ae1a4SAndy Whitcroft 278934d99219SJoe Perches CHK("INVALID_UTF8", 2790000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 279100df344fSAndy Whitcroft } 27920a920b5bSAndy Whitcroft 279315662b3eSJoe Perches# Check if it's the start of a commit log 279415662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 279515662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 2796eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 2797eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 279815662b3eSJoe Perches $in_header_lines = 0; 279915662b3eSJoe Perches $in_commit_log = 1; 2800ed43c4e5SAllen Hubbe $has_commit_log = 1; 280115662b3eSJoe Perches } 280215662b3eSJoe Perches 2803fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2804fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2805fa64205dSPasi Savanainen if ($in_header_lines && 2806fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2807fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2808fa64205dSPasi Savanainen $non_utf8_charset = 1; 2809fa64205dSPasi Savanainen } 2810fa64205dSPasi Savanainen 2811fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 281215662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2813fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 281415662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 281515662b3eSJoe Perches } 281615662b3eSJoe Perches 2817d6430f71SJoe Perches# Check for absolute kernel paths in commit message 2818d6430f71SJoe Perches if ($tree && $in_commit_log) { 2819d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 2820d6430f71SJoe Perches my $file = $1; 2821d6430f71SJoe Perches 2822d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 2823d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 2824d6430f71SJoe Perches # 2825d6430f71SJoe Perches } else { 2826d6430f71SJoe Perches check_absolute_file($file, $herecurr); 2827d6430f71SJoe Perches } 2828d6430f71SJoe Perches } 2829d6430f71SJoe Perches } 2830d6430f71SJoe Perches 283166b47b4aSKees Cook# Check for various typo / spelling mistakes 283266d7a382SJoe Perches if (defined($misspellings) && 283366d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2834ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 283566b47b4aSKees Cook my $typo = $1; 283666b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 283766b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 283866b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 28390675a8fbSJean Delvare my $msg_level = \&WARN; 28400675a8fbSJean Delvare $msg_level = \&CHK if ($file); 28410675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 284266b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 284366b47b4aSKees Cook $fix) { 284466b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 284566b47b4aSKees Cook } 284666b47b4aSKees Cook } 284766b47b4aSKees Cook } 284866b47b4aSKees Cook 284930670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 285030670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 285100df344fSAndy Whitcroft 28520a920b5bSAndy Whitcroft#trailing whitespace 28539c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2854c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2855d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2856d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2857d5e616fcSJoe Perches $fix) { 2858194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2859d5e616fcSJoe Perches } 2860c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2861c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28623705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 28633705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 28643705ce5bSJoe Perches $fix) { 2865194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 28663705ce5bSJoe Perches } 28673705ce5bSJoe Perches 2868d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 28690a920b5bSAndy Whitcroft } 28705368df20SAndy Whitcroft 28714783f894SJosh Triplett# Check for FSF mailing addresses. 2872109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 28731bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 28743e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 28753e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 28764783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28770675a8fbSJean Delvare my $msg_level = \&ERROR; 28780675a8fbSJean Delvare $msg_level = \&CHK if ($file); 28790675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 28804783f894SJosh 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) 28814783f894SJosh Triplett } 28824783f894SJosh Triplett 28833354957aSAndi Kleen# check for Kconfig help text having a real description 28849fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 28859fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 28863354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 2887678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 2888678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 2889678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 2890678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 28913354957aSAndi Kleen my $length = 0; 28929fe287d7SAndy Whitcroft my $cnt = $realcnt; 28939fe287d7SAndy Whitcroft my $ln = $linenr + 1; 28949fe287d7SAndy Whitcroft my $f; 2895a1385803SAndy Whitcroft my $is_start = 0; 28969fe287d7SAndy Whitcroft my $is_end = 0; 2897a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 28989fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 28999fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 29009fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 29019fe287d7SAndy Whitcroft 29029fe287d7SAndy Whitcroft next if ($f =~ /^-/); 29038d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2904a1385803SAndy Whitcroft 290586adf1a0SUlf Magnusson if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 2906a1385803SAndy Whitcroft $is_start = 1; 290784af7a61SUlf Magnusson } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) { 290884af7a61SUlf Magnusson if ($lines[$ln - 1] =~ "---help---") { 290984af7a61SUlf Magnusson WARN("CONFIG_DESCRIPTION", 291084af7a61SUlf Magnusson "prefer 'help' over '---help---' for new help texts\n" . $herecurr); 291184af7a61SUlf Magnusson } 2912a1385803SAndy Whitcroft $length = -1; 2913a1385803SAndy Whitcroft } 2914a1385803SAndy Whitcroft 29159fe287d7SAndy Whitcroft $f =~ s/^.//; 29163354957aSAndi Kleen $f =~ s/#.*//; 29173354957aSAndi Kleen $f =~ s/^\s+//; 29183354957aSAndi Kleen next if ($f =~ /^$/); 2919678ae162SUlf Magnusson 2920678ae162SUlf Magnusson # This only checks context lines in the patch 2921678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 2922678ae162SUlf Magnusson # positives, even though some of these are 2923678ae162SUlf Magnusson # common words in help texts 2924678ae162SUlf Magnusson if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| 2925678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 29269fe287d7SAndy Whitcroft $is_end = 1; 29279fe287d7SAndy Whitcroft last; 29289fe287d7SAndy Whitcroft } 29293354957aSAndi Kleen $length++; 29303354957aSAndi Kleen } 293156193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2932000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 293356193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 293456193274SVadim Bendebury } 2935a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 29363354957aSAndi Kleen } 29373354957aSAndi Kleen 2938628f91a2SJoe Perches# check for MAINTAINERS entries that don't have the right form 2939628f91a2SJoe Perches if ($realfile =~ /^MAINTAINERS$/ && 2940628f91a2SJoe Perches $rawline =~ /^\+[A-Z]:/ && 2941628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 2942628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 2943628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 2944628f91a2SJoe Perches $fix) { 2945628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 2946628f91a2SJoe Perches } 2947628f91a2SJoe Perches } 2948628f91a2SJoe Perches 2949327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2950327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2951327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2952327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2953327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2954327953e9SChristoph Jaeger } 2955327953e9SChristoph Jaeger 2956c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2957c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2958c68e5878SArnaud Lacombe my $flag = $1; 2959c68e5878SArnaud Lacombe my $replacement = { 2960c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2961c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2962c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2963c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2964c68e5878SArnaud Lacombe }; 2965c68e5878SArnaud Lacombe 2966c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2967c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2968c68e5878SArnaud Lacombe } 2969c68e5878SArnaud Lacombe 2970bff5da43SRob Herring# check for DT compatible documentation 29717dd05b38SFlorian Vaussard if (defined $root && 29727dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 29737dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 29747dd05b38SFlorian Vaussard 2975bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2976bff5da43SRob Herring 2977cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2978cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2979cc93319bSFlorian Vaussard 2980bff5da43SRob Herring foreach my $compat (@compats) { 2981bff5da43SRob Herring my $compat2 = $compat; 2982185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2983185d566bSRob Herring my $compat3 = $compat; 2984185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2985185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2986bff5da43SRob Herring if ( $? >> 8 ) { 2987bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2988bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2989bff5da43SRob Herring } 2990bff5da43SRob Herring 29914fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 29924fbf32a6SFlorian Vaussard my $vendor = $1; 2993cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2994bff5da43SRob Herring if ( $? >> 8 ) { 2995bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2996cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2997bff5da43SRob Herring } 2998bff5da43SRob Herring } 2999bff5da43SRob Herring } 3000bff5da43SRob Herring 30019f3a8992SRob Herring# check for using SPDX license tag at beginning of files 30029f3a8992SRob Herring if ($realline == $checklicenseline) { 30039f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 30049f3a8992SRob Herring $checklicenseline = 2; 30059f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 30069f3a8992SRob Herring my $comment = ""; 30079f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 30089f3a8992SRob Herring $comment = '/*'; 30099f3a8992SRob Herring } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 30109f3a8992SRob Herring $comment = '//'; 30119f3a8992SRob Herring } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) { 30129f3a8992SRob Herring $comment = '#'; 30139f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 30149f3a8992SRob Herring $comment = '..'; 30159f3a8992SRob Herring } 30169f3a8992SRob Herring 30179f3a8992SRob Herring if ($comment !~ /^$/ && 30189f3a8992SRob Herring $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) { 30199f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 30209f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 30213b6e8ac9SJoe Perches } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) { 30223b6e8ac9SJoe Perches my $spdx_license = $1; 30233b6e8ac9SJoe Perches if (!is_SPDX_License_valid($spdx_license)) { 30243b6e8ac9SJoe Perches WARN("SPDX_LICENSE_TAG", 30253b6e8ac9SJoe Perches "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr); 30263b6e8ac9SJoe Perches } 30279f3a8992SRob Herring } 30289f3a8992SRob Herring } 30299f3a8992SRob Herring } 30309f3a8992SRob Herring 30315368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 3032d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 30335368df20SAndy Whitcroft 303447e0c88bSJoe Perches# line length limit (with some exclusions) 303547e0c88bSJoe Perches# 303647e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 303747e0c88bSJoe Perches# logging functions like pr_info that end in a string 303847e0c88bSJoe Perches# lines with a single string 303947e0c88bSJoe Perches# #defines that are a single string 30402e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 304147e0c88bSJoe Perches# 304247e0c88bSJoe Perches# There are 3 different line length message types: 3043ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 304447e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 304547e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 304647e0c88bSJoe Perches# 304747e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 304847e0c88bSJoe Perches# 304947e0c88bSJoe Perches 3050b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 305147e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 305247e0c88bSJoe Perches 305347e0c88bSJoe Perches # Check the allowed long line types first 305447e0c88bSJoe Perches 305547e0c88bSJoe Perches # logging functions that end in a string that starts 305647e0c88bSJoe Perches # before $max_line_length 305747e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 305847e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 305947e0c88bSJoe Perches $msg_type = ""; 306047e0c88bSJoe Perches 306147e0c88bSJoe Perches # lines with only strings (w/ possible termination) 306247e0c88bSJoe Perches # #defines with only strings 306347e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 306447e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 306547e0c88bSJoe Perches $msg_type = ""; 306647e0c88bSJoe Perches 3067cc147506SJoe Perches # More special cases 3068cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3069cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3070d560a5f8SJoe Perches $msg_type = ""; 3071d560a5f8SJoe Perches 30722e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 30732e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 30742e4bbbc5SAndreas Brauchli $msg_type = ""; 30752e4bbbc5SAndreas Brauchli 307647e0c88bSJoe Perches # Otherwise set the alternate message types 307747e0c88bSJoe Perches 307847e0c88bSJoe Perches # a comment starts before $max_line_length 307947e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 308047e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 308147e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 308247e0c88bSJoe Perches 308347e0c88bSJoe Perches # a quoted string starts before $max_line_length 308447e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 308547e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 308647e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 308747e0c88bSJoe Perches } 308847e0c88bSJoe Perches 308947e0c88bSJoe Perches if ($msg_type ne "" && 309047e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 309147e0c88bSJoe Perches WARN($msg_type, 30926cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 30930a920b5bSAndy Whitcroft } 309447e0c88bSJoe Perches } 30950a920b5bSAndy Whitcroft 30968905a67cSAndy Whitcroft# check for adding lines without a newline. 30978905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 3098000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 3099000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 31008905a67cSAndy Whitcroft } 31018905a67cSAndy Whitcroft 3102b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3103de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 31040a920b5bSAndy Whitcroft 31050a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 31060a920b5bSAndy Whitcroft# more than 8 must use tabs. 3107c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3108c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3109c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3110d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 31113705ce5bSJoe Perches if (ERROR("CODE_INDENT", 31123705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 31133705ce5bSJoe Perches $fix) { 3114194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 31153705ce5bSJoe Perches } 31160a920b5bSAndy Whitcroft } 31170a920b5bSAndy Whitcroft 311808e44365SAlberto Panizzo# check for space before tabs. 311908e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 312008e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 31213705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 31223705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 31233705ce5bSJoe Perches $fix) { 3124194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3125d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 3126194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3127c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 31283705ce5bSJoe Perches } 312908e44365SAlberto Panizzo } 313008e44365SAlberto Panizzo 31316a487211SJoe Perches# check for assignments on the start of a line 31326a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 31336a487211SJoe Perches CHK("ASSIGNMENT_CONTINUATIONS", 31346a487211SJoe Perches "Assignment operator '$1' should be on the previous line\n" . $hereprev); 31356a487211SJoe Perches } 31366a487211SJoe Perches 3137d1fe9c09SJoe Perches# check for && or || at the start of a line 3138d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 3139d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 3140d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 3141d1fe9c09SJoe Perches } 3142d1fe9c09SJoe Perches 3143a91e8994SJoe Perches# check indentation starts on a tab stop 31445b57980dSJoe Perches if ($perl_version_ok && 3145bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3146a91e8994SJoe Perches my $indent = length($1); 3147a91e8994SJoe Perches if ($indent % 8) { 3148a91e8994SJoe Perches if (WARN("TABSTOP", 3149a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3150a91e8994SJoe Perches $fix) { 3151a91e8994SJoe Perches $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; 3152a91e8994SJoe Perches } 3153a91e8994SJoe Perches } 3154a91e8994SJoe Perches } 3155a91e8994SJoe Perches 3156d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 31575b57980dSJoe Perches if ($perl_version_ok && 3158fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3159d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3160d1fe9c09SJoe Perches my $oldindent = $1; 3161d1fe9c09SJoe Perches my $rest = $2; 3162d1fe9c09SJoe Perches 3163d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3164d1fe9c09SJoe Perches if ($pos >= 0) { 3165b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3166b34a26f3SJoe Perches my $newindent = $2; 3167d1fe9c09SJoe Perches 3168d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3169d1fe9c09SJoe Perches "\t" x ($pos / 8) . 3170d1fe9c09SJoe Perches " " x ($pos % 8); 3171d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3172d1fe9c09SJoe Perches 3173d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3174d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 31753705ce5bSJoe Perches 31763705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 31773705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 31783705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3179194f66fcSJoe Perches $fixed[$fixlinenr] =~ 31803705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 31813705ce5bSJoe Perches } 3182d1fe9c09SJoe Perches } 3183d1fe9c09SJoe Perches } 3184d1fe9c09SJoe Perches } 3185d1fe9c09SJoe Perches 31866ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 31876ab3a970SJoe Perches# avoid checking a few false positives: 31886ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 31896ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 31906ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 31916ab3a970SJoe Perches# multiline macros that define functions 31926ab3a970SJoe Perches# known attributes or the __attribute__ keyword 31936ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 31946ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 31953705ce5bSJoe Perches if (CHK("SPACING", 3196f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 31973705ce5bSJoe Perches $fix) { 3198194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3199f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 32003705ce5bSJoe Perches } 3201aad4f614SJoe Perches } 3202aad4f614SJoe Perches 320386406b1cSJoe Perches# Block comment styles 320486406b1cSJoe Perches# Networking with an initial /* 320505880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3206fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 320785ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 320885ad978cSJoe Perches $realline > 2) { 320905880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 321005880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 321105880600SJoe Perches } 321205880600SJoe Perches 321386406b1cSJoe Perches# Block comments use * on subsequent lines 321486406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 321586406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3216a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 321761135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3218a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 321986406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 322086406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3221a605e32eSJoe Perches } 3222a605e32eSJoe Perches 322386406b1cSJoe Perches# Block comments use */ on trailing lines 322486406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3225c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3226c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3227c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 322886406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 322986406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 323005880600SJoe Perches } 323105880600SJoe Perches 323208eb9b80SJoe Perches# Block comment * alignment 323308eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3234af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3235af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3236af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 323708eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3238af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3239af207524SJoe Perches my $oldindent; 324008eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3241af207524SJoe Perches if (defined($1)) { 3242af207524SJoe Perches $oldindent = expand_tabs($1); 3243af207524SJoe Perches } else { 3244af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3245af207524SJoe Perches $oldindent = expand_tabs($1); 3246af207524SJoe Perches } 324708eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 324808eb9b80SJoe Perches my $newindent = $1; 324908eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3250af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 325108eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 325208eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 325308eb9b80SJoe Perches } 325408eb9b80SJoe Perches } 325508eb9b80SJoe Perches 32567f619191SJoe Perches# check for missing blank lines after struct/union declarations 32577f619191SJoe Perches# with exceptions for various attributes and macros 32587f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 32597f619191SJoe Perches $line =~ /^\+/ && 32607f619191SJoe Perches !($line =~ /^\+\s*$/ || 32617f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 32627f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 32637f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 32647f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 32657f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 32667f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 32670bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 32687f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3269d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3270d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3271d752fcc8SJoe Perches $fix) { 3272f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3273d752fcc8SJoe Perches } 32747f619191SJoe Perches } 32757f619191SJoe Perches 3276365dd4eaSJoe Perches# check for multiple consecutive blank lines 3277365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3278365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3279365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3280d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3281d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3282d752fcc8SJoe Perches $fix) { 3283f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3284d752fcc8SJoe Perches } 3285d752fcc8SJoe Perches 3286365dd4eaSJoe Perches $last_blank_line = $linenr; 3287365dd4eaSJoe Perches } 3288365dd4eaSJoe Perches 32893b617e3bSJoe Perches# check for missing blank lines after declarations 32903f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 32913f7bac03SJoe Perches # actual declarations 32923f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 32935a4e1fd3SJoe Perches # function pointer declarations 32945a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 32953f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 32963f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 32973f7bac03SJoe Perches # known declaration macros 32983f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 32993f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 33003f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 33013f7bac03SJoe Perches # other possible extensions of declaration lines 33023f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 33033f7bac03SJoe Perches # not starting a section or a macro "\" extended line 33043f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 33053f7bac03SJoe Perches # looks like a declaration 33063f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 33075a4e1fd3SJoe Perches # function pointer declarations 33085a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 33093f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 33103f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 33113f7bac03SJoe Perches # known declaration macros 33123f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 33133f7bac03SJoe Perches # start of struct or union or enum 3314*328b5f41SJoe Perches $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ || 33153f7bac03SJoe Perches # start or end of block or continuation of declaration 33163f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 33173f7bac03SJoe Perches # bitfield continuation 33183f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 33193f7bac03SJoe Perches # other possible extensions of declaration lines 33203f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 33213f7bac03SJoe Perches # indentation of previous and current line are the same 33223f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3323d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3324d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3325d752fcc8SJoe Perches $fix) { 3326f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3327d752fcc8SJoe Perches } 33283b617e3bSJoe Perches } 33293b617e3bSJoe Perches 33305f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 33316b4c5bebSAndy Whitcroft# Exceptions: 33326b4c5bebSAndy Whitcroft# 1) within comments 33336b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 33346b4c5bebSAndy Whitcroft# 3) hanging labels 33353705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 33365f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 33373705ce5bSJoe Perches if (WARN("LEADING_SPACE", 33383705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 33393705ce5bSJoe Perches $fix) { 3340194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 33413705ce5bSJoe Perches } 33425f7ddae6SRaffaele Recalcati } 33435f7ddae6SRaffaele Recalcati 3344b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3345b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3346b9ea10d6SAndy Whitcroft 33475751a24eSJoe Perches# check for unusual line ending [ or ( 33485751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 33495751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 33505751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 33515751a24eSJoe Perches } 33525751a24eSJoe Perches 33534dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 33544dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 33554dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 33564dbed76fSJoe Perches $context_function = $1; 33574dbed76fSJoe Perches } 33584dbed76fSJoe Perches 33594dbed76fSJoe Perches# check if this appears to be the end of function declaration 33604dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 33614dbed76fSJoe Perches undef $context_function; 33624dbed76fSJoe Perches } 33634dbed76fSJoe Perches 3364032a4c0fSJoe Perches# check indentation of any line with a bare else 3365840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3366032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3367032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3368032a4c0fSJoe Perches my $tabs = length($1) + 1; 3369840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3370840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3371840080a0SJoe Perches defined $lines[$linenr] && 3372840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3373032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3374032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3375032a4c0fSJoe Perches } 3376032a4c0fSJoe Perches } 3377032a4c0fSJoe Perches 3378c00df19aSJoe Perches# check indentation of a line with a break; 3379c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3380c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3381c00df19aSJoe Perches my $tabs = $1; 3382c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3383c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3384c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3385c00df19aSJoe Perches } 3386c00df19aSJoe Perches } 3387c00df19aSJoe Perches 3388c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3389cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3390000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3391000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3392c2fdda0dSAndy Whitcroft } 339322f2a2efSAndy Whitcroft 339456e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 339556e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 339656e77d70SJoe Perches WARN("HOTPLUG_SECTION", 339756e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 339856e77d70SJoe Perches } 339956e77d70SJoe Perches 34009c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 34012b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 34022b474a1aSAndy Whitcroft $realline_next); 34033e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 3404ca819864SJoe Perches if ($linenr > $suppress_statement && 34051b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3406170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3407f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3408171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3409171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3410171ae1a4SAndy Whitcroft 34113e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 34123e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 34133e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 34143e469cdcSAndy Whitcroft # until we hit end of it. 34153e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 34163e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 34173e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 34183e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 34193e469cdcSAndy Whitcroft } 3420f74bd194SAndy Whitcroft 34212b474a1aSAndy Whitcroft # Find the real next line. 34222b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 34232b474a1aSAndy Whitcroft if (defined $realline_next && 34242b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 34252b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 34262b474a1aSAndy Whitcroft $realline_next++; 34272b474a1aSAndy Whitcroft } 34282b474a1aSAndy Whitcroft 3429171ae1a4SAndy Whitcroft my $s = $stat; 3430171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3431cf655043SAndy Whitcroft 3432c2fdda0dSAndy Whitcroft # Ignore goto labels. 3433171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3434c2fdda0dSAndy Whitcroft 3435c2fdda0dSAndy Whitcroft # Ignore functions being called 3436171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3437c2fdda0dSAndy Whitcroft 3438463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3439463f2864SAndy Whitcroft 3440c45dcabdSAndy Whitcroft # declarations always start with types 3441d2506586SAndy 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) { 3442c45dcabdSAndy Whitcroft my $type = $1; 3443c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3444c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3445c45dcabdSAndy Whitcroft 34466c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3447a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3448c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3449c2fdda0dSAndy Whitcroft } 34508905a67cSAndy Whitcroft 34516c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 345265863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3453c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 34549c0ca6f9SAndy Whitcroft } 34558905a67cSAndy Whitcroft 34568905a67cSAndy Whitcroft # Check for any sort of function declaration. 34578905a67cSAndy Whitcroft # int foo(something bar, other baz); 34588905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3459171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 34608905a67cSAndy Whitcroft my ($name_len) = length($1); 34618905a67cSAndy Whitcroft 3462cf655043SAndy Whitcroft my $ctx = $s; 3463773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 34648905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3465cf655043SAndy Whitcroft 34668905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3467c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 34688905a67cSAndy Whitcroft 3469c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 34708905a67cSAndy Whitcroft } 34718905a67cSAndy Whitcroft } 34728905a67cSAndy Whitcroft } 34738905a67cSAndy Whitcroft 34749c0ca6f9SAndy Whitcroft } 34759c0ca6f9SAndy Whitcroft 347600df344fSAndy Whitcroft# 347700df344fSAndy Whitcroft# Checks which may be anchored in the context. 347800df344fSAndy Whitcroft# 347900df344fSAndy Whitcroft 348000df344fSAndy Whitcroft# Check for switch () and associated case and default 348100df344fSAndy Whitcroft# statements should be at the same indent. 348200df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 348300df344fSAndy Whitcroft my $err = ''; 348400df344fSAndy Whitcroft my $sep = ''; 348500df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 348600df344fSAndy Whitcroft shift(@ctx); 348700df344fSAndy Whitcroft for my $ctx (@ctx) { 348800df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 348900df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 349000df344fSAndy Whitcroft $indent != $cindent) { 349100df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 349200df344fSAndy Whitcroft $sep = ''; 349300df344fSAndy Whitcroft } else { 349400df344fSAndy Whitcroft $sep = "[...]\n"; 349500df344fSAndy Whitcroft } 349600df344fSAndy Whitcroft } 349700df344fSAndy Whitcroft if ($err ne '') { 3498000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3499000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3500de7d4f0eSAndy Whitcroft } 3501de7d4f0eSAndy Whitcroft } 3502de7d4f0eSAndy Whitcroft 3503de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3504de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 35050fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3506773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3507773647a0SAndy Whitcroft 35089c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 35098eef05ddSJoe Perches 35108eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 35118eef05ddSJoe Perches WARN("DEEP_INDENTATION", 35128eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 35138eef05ddSJoe Perches } 35148eef05ddSJoe Perches 3515de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3516de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3517de7d4f0eSAndy Whitcroft 3518548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3519548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3520de7d4f0eSAndy Whitcroft 3521548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3522548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3523548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3524548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3525548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3526773647a0SAndy Whitcroft $ctx_ln++; 3527773647a0SAndy Whitcroft } 3528548596d5SAndy Whitcroft 352953210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 353053210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3531773647a0SAndy Whitcroft 3532773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3533000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3534000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 353501464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 353600df344fSAndy Whitcroft } 3537773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3538773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3539773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3540773647a0SAndy Whitcroft { 35419c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 35429c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3543000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3544000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 354501464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 35469c0ca6f9SAndy Whitcroft } 35479c0ca6f9SAndy Whitcroft } 354800df344fSAndy Whitcroft } 354900df344fSAndy Whitcroft 35504d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 3551f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 35523e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 35533e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 35543e469cdcSAndy Whitcroft if (!defined $stat); 35554d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 35564d001e4dSAndy Whitcroft 35574d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 35584d001e4dSAndy Whitcroft 35599f5af480SJoe Perches # remove inline comments 35609f5af480SJoe Perches $s =~ s/$;/ /g; 35619f5af480SJoe Perches $c =~ s/$;/ /g; 35624d001e4dSAndy Whitcroft 35634d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 35646f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 35656f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 35664d001e4dSAndy Whitcroft 35679f5af480SJoe Perches # Make sure we remove the line prefixes as we have 35689f5af480SJoe Perches # none on the first line, and are going to readd them 35699f5af480SJoe Perches # where necessary. 35709f5af480SJoe Perches $s =~ s/\n./\n/gs; 35719f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 35729f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 35739f5af480SJoe Perches } 35749f5af480SJoe Perches 35754d001e4dSAndy Whitcroft # We want to check the first line inside the block 35764d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 35774d001e4dSAndy Whitcroft # 1) any blank line termination 35784d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 35794d001e4dSAndy Whitcroft # 3) any do (...) { 35804d001e4dSAndy Whitcroft my $continuation = 0; 35814d001e4dSAndy Whitcroft my $check = 0; 35824d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 35834d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 35844d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 35854d001e4dSAndy Whitcroft $continuation = 1; 35864d001e4dSAndy Whitcroft } 35879bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 35884d001e4dSAndy Whitcroft $check = 1; 35894d001e4dSAndy Whitcroft $cond_lines++; 35904d001e4dSAndy Whitcroft } 35914d001e4dSAndy Whitcroft 35924d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 35934d001e4dSAndy Whitcroft # preprocessor statement. 35944d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 35954d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 35964d001e4dSAndy Whitcroft $check = 0; 35974d001e4dSAndy Whitcroft } 35984d001e4dSAndy Whitcroft 35999bd49efeSAndy Whitcroft my $cond_ptr = -1; 3600740504c6SAndy Whitcroft $continuation = 0; 36019bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 36029bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 36034d001e4dSAndy Whitcroft 3604f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3605f16fa28fSAndy Whitcroft # is not linear. 3606f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3607f16fa28fSAndy Whitcroft $check = 0; 3608f16fa28fSAndy Whitcroft } 3609f16fa28fSAndy Whitcroft 36109bd49efeSAndy Whitcroft # Ignore: 36119bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 36129bd49efeSAndy Whitcroft # 2) preprocessor lines, and 36139bd49efeSAndy Whitcroft # 3) labels. 3614740504c6SAndy Whitcroft if ($continuation || 3615740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 36169bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 36179bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3618740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 361930dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 36209bd49efeSAndy Whitcroft $cond_lines++; 36219bd49efeSAndy Whitcroft } 36224d001e4dSAndy Whitcroft } 362330dad6ebSAndy Whitcroft } 36244d001e4dSAndy Whitcroft 36254d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 36264d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 36274d001e4dSAndy Whitcroft 36284d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 36294d001e4dSAndy Whitcroft # this is not this patch's fault. 36304d001e4dSAndy Whitcroft if (!defined($stat_real) || 36314d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 36324d001e4dSAndy Whitcroft $check = 0; 36334d001e4dSAndy Whitcroft } 36344d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 36354d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 36364d001e4dSAndy Whitcroft } 36374d001e4dSAndy Whitcroft 36389bd49efeSAndy 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"; 36394d001e4dSAndy Whitcroft 36409f5af480SJoe Perches if ($check && $s ne '' && 36419f5af480SJoe Perches (($sindent % 8) != 0 || 36429f5af480SJoe Perches ($sindent < $indent) || 3643f6950a73SJoe Perches ($sindent == $indent && 3644f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 36459f5af480SJoe Perches ($sindent > $indent + 8))) { 3646000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3647000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 36484d001e4dSAndy Whitcroft } 36494d001e4dSAndy Whitcroft } 36504d001e4dSAndy Whitcroft 36516c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 36526c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 36531f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 36541f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 36556c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3656c2fdda0dSAndy Whitcroft if ($dbg_values) { 3657c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3658cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3659cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 36601f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3661c2fdda0dSAndy Whitcroft } 36626c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 36636c72ffaaSAndy Whitcroft 366400df344fSAndy Whitcroft#ignore lines not being added 36653705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 366600df344fSAndy Whitcroft 366711ca40a0SJoe Perches# check for dereferences that span multiple lines 366811ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 366911ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 367011ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 367111ca40a0SJoe Perches my $ref = $1; 367211ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 367311ca40a0SJoe Perches $ref .= $1; 367411ca40a0SJoe Perches $ref =~ s/\s//g; 367511ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 367611ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 367711ca40a0SJoe Perches } 367811ca40a0SJoe Perches 3679a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3680c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3681a1ce18e4SJoe Perches my $type = $1; 3682a1ce18e4SJoe Perches my $var = $2; 3683207a8e84SJoe Perches $var = "" if (!defined $var); 3684207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3685a1ce18e4SJoe Perches my $sign = $1; 3686a1ce18e4SJoe Perches my $pointer = $2; 3687a1ce18e4SJoe Perches 3688a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3689a1ce18e4SJoe Perches 3690a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3691a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3692a1ce18e4SJoe Perches $fix) { 3693a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3694207a8e84SJoe Perches my $comp_pointer = $pointer; 3695207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 3696207a8e84SJoe Perches $decl .= $comp_pointer; 3697207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 3698207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 3699a1ce18e4SJoe Perches } 3700a1ce18e4SJoe Perches } 3701a1ce18e4SJoe Perches } 3702a1ce18e4SJoe Perches 3703653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 37047429c690SAndy Whitcroft if ($dbg_type) { 37057429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3706000d1cc1SJoe Perches ERROR("TEST_TYPE", 3707000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 37087429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3709000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3710000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 37117429c690SAndy Whitcroft } 3712653d4876SAndy Whitcroft next; 3713653d4876SAndy Whitcroft } 3714a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3715a1ef277eSAndy Whitcroft if ($dbg_attr) { 37169360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3717000d1cc1SJoe Perches ERROR("TEST_ATTR", 3718000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 37199360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3720000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3721000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3722a1ef277eSAndy Whitcroft } 3723a1ef277eSAndy Whitcroft next; 3724a1ef277eSAndy Whitcroft } 3725653d4876SAndy Whitcroft 3726f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 372799423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 372899423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3729d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3730d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3731f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3732f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3733f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3734d752fcc8SJoe Perches my $fixedline = $prevrawline; 3735d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3736f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3737d752fcc8SJoe Perches $fixedline = $line; 37388d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 3739f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3740d752fcc8SJoe Perches } 3741f0a594c1SAndy Whitcroft } 3742f0a594c1SAndy Whitcroft 374300df344fSAndy Whitcroft# 374400df344fSAndy Whitcroft# Checks which are anchored on the added line. 374500df344fSAndy Whitcroft# 374600df344fSAndy Whitcroft 3747653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3748c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3749653d4876SAndy Whitcroft my $path = $1; 3750653d4876SAndy Whitcroft if ($path =~ m{//}) { 3751000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3752495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3753495e9d84SJoe Perches } 3754495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3755495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3756495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3757653d4876SAndy Whitcroft } 3758653d4876SAndy Whitcroft } 3759653d4876SAndy Whitcroft 376000df344fSAndy Whitcroft# no C99 // comments 376100df344fSAndy Whitcroft if ($line =~ m{//}) { 37623705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 37633705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 37643705ce5bSJoe Perches $fix) { 3765194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 37663705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 37673705ce5bSJoe Perches my $comment = trim($1); 3768194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 37693705ce5bSJoe Perches } 37703705ce5bSJoe Perches } 377100df344fSAndy Whitcroft } 377200df344fSAndy Whitcroft # Remove C99 comments. 37730a920b5bSAndy Whitcroft $line =~ s@//.*@@; 37746c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 37750a920b5bSAndy Whitcroft 37762b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 37772b474a1aSAndy Whitcroft# the whole statement. 37782b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 37792b474a1aSAndy Whitcroft if (defined $realline_next && 37802b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 37812b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 37822b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 37832b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 37843cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 37853cbf62dfSAndy Whitcroft # a prefix: 37863cbf62dfSAndy Whitcroft # XXX(foo); 37873cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3788653d4876SAndy Whitcroft my $name = $1; 378987a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 37903cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 37913cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 37923cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 37933cbf62dfSAndy Whitcroft 37943cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 37952b474a1aSAndy Whitcroft \n.}\s*$| 379648012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 379748012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 379848012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 37992b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 38002b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 380148012058SAndy Whitcroft )/x) { 38022b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 38032b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 38042b474a1aSAndy Whitcroft } else { 38052b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 38060a920b5bSAndy Whitcroft } 38070a920b5bSAndy Whitcroft } 38082b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 38092b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 38102b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 38112b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 38122b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 38132b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 38142b474a1aSAndy Whitcroft } 38152b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 38162b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3817000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3818000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 38192b474a1aSAndy Whitcroft } 38200a920b5bSAndy Whitcroft 38215150bda4SJoe Eloff# check for global initialisers. 38226d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 3823d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 38246d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 3825d5e616fcSJoe Perches $fix) { 38266d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 3827d5e616fcSJoe Perches } 3828f0a594c1SAndy Whitcroft } 38290a920b5bSAndy Whitcroft# check for static initialisers. 38306d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 3831d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 38326d32f7a3SJoe Perches "do not initialise statics to $1\n" . 3833d5e616fcSJoe Perches $herecurr) && 3834d5e616fcSJoe Perches $fix) { 38356d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 3836d5e616fcSJoe Perches } 38370a920b5bSAndy Whitcroft } 38380a920b5bSAndy Whitcroft 38391813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 38401813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 38411813087dSJoe Perches my $tmp = trim($1); 38421813087dSJoe Perches WARN("MISORDERED_TYPE", 38431813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 38441813087dSJoe Perches } 38451813087dSJoe Perches 3846809e082eSJoe Perches# check for unnecessary <signed> int declarations of short/long/long long 3847809e082eSJoe Perches while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) { 3848809e082eSJoe Perches my $type = trim($1); 3849809e082eSJoe Perches next if ($type !~ /\bint\b/); 3850809e082eSJoe Perches next if ($type !~ /\b(?:short|long\s+long|long)\b/); 3851809e082eSJoe Perches my $new_type = $type; 3852809e082eSJoe Perches $new_type =~ s/\b\s*int\s*\b/ /; 3853809e082eSJoe Perches $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /; 3854809e082eSJoe Perches $new_type =~ s/^const\s+//; 3855809e082eSJoe Perches $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/); 3856809e082eSJoe Perches $new_type = "const $new_type" if ($type =~ /^const\b/); 3857809e082eSJoe Perches $new_type =~ s/\s+/ /g; 3858809e082eSJoe Perches $new_type = trim($new_type); 3859809e082eSJoe Perches if (WARN("UNNECESSARY_INT", 3860809e082eSJoe Perches "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) && 3861809e082eSJoe Perches $fix) { 3862809e082eSJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/; 3863809e082eSJoe Perches } 3864809e082eSJoe Perches } 3865809e082eSJoe Perches 3866cb710ecaSJoe Perches# check for static const char * arrays. 3867cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3868000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3869000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3870cb710ecaSJoe Perches $herecurr); 3871cb710ecaSJoe Perches } 3872cb710ecaSJoe Perches 3873cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3874cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3875000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3876000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3877cb710ecaSJoe Perches $herecurr); 3878cb710ecaSJoe Perches } 3879cb710ecaSJoe Perches 3880ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3881ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3882ab7e23f3SJoe Perches my $found = $1; 3883ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3884ab7e23f3SJoe Perches WARN("CONST_CONST", 3885ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3886ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3887ab7e23f3SJoe Perches WARN("CONST_CONST", 3888ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3889ab7e23f3SJoe Perches } 3890ab7e23f3SJoe Perches } 3891ab7e23f3SJoe Perches 38929b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 38939b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 38949b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 38959b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 38969b0fa60dSJoe Perches $herecurr); 38979b0fa60dSJoe Perches } 38989b0fa60dSJoe Perches 3899b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3900b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3901b598b670SJoe Perches my $array = $1; 3902b598b670SJoe 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*\))@) { 3903b598b670SJoe Perches my $array_div = $1; 3904b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3905b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3906b598b670SJoe Perches $fix) { 3907b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3908b598b670SJoe Perches } 3909b598b670SJoe Perches } 3910b598b670SJoe Perches } 3911b598b670SJoe Perches 3912b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3913b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3914b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3915b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3916b36190c5SJoe Perches $fix) { 3917194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3918b36190c5SJoe Perches } 3919b36190c5SJoe Perches } 3920b36190c5SJoe Perches 3921653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3922653d4876SAndy Whitcroft# make sense. 3923653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 39248054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3925c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 39268ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 392746d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 3928000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3929000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 39300a920b5bSAndy Whitcroft } 39310a920b5bSAndy Whitcroft 39320a920b5bSAndy Whitcroft# * goes on variable not on type 393365863862SAndy Whitcroft # (char*[ const]) 3934bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3935bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 39363705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3937d8aaf121SAndy Whitcroft 393865863862SAndy Whitcroft # Should start with a space. 393965863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 394065863862SAndy Whitcroft # Should not end with a space. 394165863862SAndy Whitcroft $to =~ s/\s+$//; 394265863862SAndy Whitcroft # '*'s should not have spaces between. 3943f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 394465863862SAndy Whitcroft } 3945d8aaf121SAndy Whitcroft 39463705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 394765863862SAndy Whitcroft if ($from ne $to) { 39483705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 39493705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 39503705ce5bSJoe Perches $fix) { 39513705ce5bSJoe Perches my $sub_from = $ident; 39523705ce5bSJoe Perches my $sub_to = $ident; 39533705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3954194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39553705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 39563705ce5bSJoe Perches } 395765863862SAndy Whitcroft } 3958bfcb2cc7SAndy Whitcroft } 3959bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3960bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 39613705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3962d8aaf121SAndy Whitcroft 396365863862SAndy Whitcroft # Should start with a space. 396465863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 396565863862SAndy Whitcroft # Should not end with a space. 396665863862SAndy Whitcroft $to =~ s/\s+$//; 396765863862SAndy Whitcroft # '*'s should not have spaces between. 3968f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 396965863862SAndy Whitcroft } 397065863862SAndy Whitcroft # Modifiers should have spaces. 397165863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 397265863862SAndy Whitcroft 39733705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3974667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 39753705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 39763705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 39773705ce5bSJoe Perches $fix) { 39783705ce5bSJoe Perches 39793705ce5bSJoe Perches my $sub_from = $match; 39803705ce5bSJoe Perches my $sub_to = $match; 39813705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3982194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39833705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 39843705ce5bSJoe Perches } 398565863862SAndy Whitcroft } 39860a920b5bSAndy Whitcroft } 39870a920b5bSAndy Whitcroft 39889d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 39899d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 39900675a8fbSJean Delvare my $msg_level = \&WARN; 39910675a8fbSJean Delvare $msg_level = \&CHK if ($file); 39920675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 39939d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 39949d3e3c70SJoe Perches } 39950a920b5bSAndy Whitcroft 39969d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 39978905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3998000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3999000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 40008905a67cSAndy Whitcroft } 40018905a67cSAndy Whitcroft 400217441227SJoe Perches# check for uses of printk_ratelimit 400317441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 4004000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 4005000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 400617441227SJoe Perches } 400717441227SJoe Perches 4008eeef5733SJoe Perches# printk should use KERN_* levels 4009eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 4010000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 4011eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 401200df344fSAndy Whitcroft } 40130a920b5bSAndy Whitcroft 4014243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 4015243f3803SJoe Perches my $orig = $1; 4016243f3803SJoe Perches my $level = lc($orig); 4017243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 40188f26b837SJoe Perches my $level2 = $level; 40198f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 4020243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 4021daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 4022243f3803SJoe Perches } 4023243f3803SJoe Perches 4024243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 4025d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 4026d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 4027d5e616fcSJoe Perches $fix) { 4028194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4029d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 4030d5e616fcSJoe Perches } 4031243f3803SJoe Perches } 4032243f3803SJoe Perches 4033dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 4034dc139313SJoe Perches my $orig = $1; 4035dc139313SJoe Perches my $level = lc($orig); 4036dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 4037dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 4038dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 4039dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 4040dc139313SJoe Perches } 4041dc139313SJoe Perches 404291c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 404391c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 404491c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 404591c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 404691c9afafSAndy Lutomirski WARN("ENOSYS", 404791c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 404891c9afafSAndy Lutomirski } 404991c9afafSAndy Lutomirski 4050653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 4051653d4876SAndy Whitcroft# or if closed on same line 40525b57980dSJoe Perches if ($perl_version_ok && 40532d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 40542d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 40552d453e3bSJoe Perches $sline !~ /}/) { 40568d182478SJoe Perches if (ERROR("OPEN_BRACE", 40572d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 40588d182478SJoe Perches $fix) { 40598d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 40608d182478SJoe Perches my $fixed_line = $rawline; 40618d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 40628d182478SJoe Perches my $line1 = $1; 40638d182478SJoe Perches my $line2 = $2; 40648d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 40658d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 40668d182478SJoe Perches if ($line2 !~ /^\s*$/) { 40678d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 40688d182478SJoe Perches } 40698d182478SJoe Perches } 40700a920b5bSAndy Whitcroft } 4071653d4876SAndy Whitcroft 40728905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 40738905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 40748905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 40758d182478SJoe Perches if (ERROR("OPEN_BRACE", 40768d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 40778d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 40788d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 40798d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 40808d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 40818d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 40828d182478SJoe Perches $fixedline = $rawline; 40838d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 40848d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 40858d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 40868d182478SJoe Perches } 40878d182478SJoe Perches } 40888905a67cSAndy Whitcroft } 40898905a67cSAndy Whitcroft 40900c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 40913705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 40923705ce5bSJoe Perches if (WARN("SPACING", 40933705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 40943705ce5bSJoe Perches $fix) { 4095194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40963705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 40973705ce5bSJoe Perches } 40980c73b4ebSAndy Whitcroft } 40990c73b4ebSAndy Whitcroft 410031070b5dSJoe Perches# Function pointer declarations 410131070b5dSJoe Perches# check spacing between type, funcptr, and args 410231070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 410391f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 410431070b5dSJoe Perches my $declare = $1; 410531070b5dSJoe Perches my $pre_pointer_space = $2; 410631070b5dSJoe Perches my $post_pointer_space = $3; 410731070b5dSJoe Perches my $funcname = $4; 410831070b5dSJoe Perches my $post_funcname_space = $5; 410931070b5dSJoe Perches my $pre_args_space = $6; 411031070b5dSJoe Perches 411191f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 411291f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 411391f72e9cSJoe Perches# don't need a space so don't warn for those. 411491f72e9cSJoe Perches my $post_declare_space = ""; 411591f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 411691f72e9cSJoe Perches $post_declare_space = $1; 411791f72e9cSJoe Perches $declare = rtrim($declare); 411891f72e9cSJoe Perches } 411991f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 412031070b5dSJoe Perches WARN("SPACING", 412131070b5dSJoe Perches "missing space after return type\n" . $herecurr); 412291f72e9cSJoe Perches $post_declare_space = " "; 412331070b5dSJoe Perches } 412431070b5dSJoe Perches 412531070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 412691f72e9cSJoe Perches# This test is not currently implemented because these declarations are 412791f72e9cSJoe Perches# equivalent to 412891f72e9cSJoe Perches# int foo(int bar, ...) 412991f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 413091f72e9cSJoe Perches# 413191f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 413291f72e9cSJoe Perches# WARN("SPACING", 413391f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 413491f72e9cSJoe Perches# } 413531070b5dSJoe Perches 413631070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 413731070b5dSJoe Perches if (defined $pre_pointer_space && 413831070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 413931070b5dSJoe Perches WARN("SPACING", 414031070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 414131070b5dSJoe Perches } 414231070b5dSJoe Perches 414331070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 414431070b5dSJoe Perches if (defined $post_pointer_space && 414531070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 414631070b5dSJoe Perches WARN("SPACING", 414731070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 414831070b5dSJoe Perches } 414931070b5dSJoe Perches 415031070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 415131070b5dSJoe Perches if (defined $post_funcname_space && 415231070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 415331070b5dSJoe Perches WARN("SPACING", 415431070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 415531070b5dSJoe Perches } 415631070b5dSJoe Perches 415731070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 415831070b5dSJoe Perches if (defined $pre_args_space && 415931070b5dSJoe Perches $pre_args_space =~ /^\s/) { 416031070b5dSJoe Perches WARN("SPACING", 416131070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 416231070b5dSJoe Perches } 416331070b5dSJoe Perches 416431070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4165194f66fcSJoe Perches $fixed[$fixlinenr] =~ 416691f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 416731070b5dSJoe Perches } 416831070b5dSJoe Perches } 416931070b5dSJoe Perches 41708d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 41718d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4172fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4173fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 41748d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 41758d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 41768d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4177fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 417838dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 41793705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 41803705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 41813705ce5bSJoe Perches $fix) { 4182194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41833705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 41843705ce5bSJoe Perches } 41858d31cfceSAndy Whitcroft } 41868d31cfceSAndy Whitcroft } 41878d31cfceSAndy Whitcroft 4188f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 41896c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4190c2fdda0dSAndy Whitcroft my $name = $1; 4191773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4192773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4193c2fdda0dSAndy Whitcroft 4194c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4195773647a0SAndy Whitcroft if ($name =~ /^(?: 4196773647a0SAndy Whitcroft if|for|while|switch|return|case| 4197773647a0SAndy Whitcroft volatile|__volatile__| 4198773647a0SAndy Whitcroft __attribute__|format|__extension__| 4199773647a0SAndy Whitcroft asm|__asm__)$/x) 4200773647a0SAndy Whitcroft { 4201c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4202c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4203c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4204c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4205773647a0SAndy Whitcroft 4206773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4207c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4208c2fdda0dSAndy Whitcroft 4209c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4210c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4211773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4212c2fdda0dSAndy Whitcroft 4213c2fdda0dSAndy Whitcroft } else { 42143705ce5bSJoe Perches if (WARN("SPACING", 42153705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 42163705ce5bSJoe Perches $fix) { 4217194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42183705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 42193705ce5bSJoe Perches } 4220f0a594c1SAndy Whitcroft } 42216c72ffaaSAndy Whitcroft } 42229a4cad4eSEric Nelson 4223653d4876SAndy Whitcroft# Check operator spacing. 42240a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 42253705ce5bSJoe Perches my $fixed_line = ""; 42263705ce5bSJoe Perches my $line_fixed = 0; 42273705ce5bSJoe Perches 42289c0ca6f9SAndy Whitcroft my $ops = qr{ 42299c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 42309c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 42319c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 42321f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 423384731623SJoe Perches \?:|\?|: 42349c0ca6f9SAndy Whitcroft }x; 4235cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 42363705ce5bSJoe Perches 42373705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 42383705ce5bSJoe Perches## foreach my $el (@elements) { 42393705ce5bSJoe Perches## print("el: <$el>\n"); 42403705ce5bSJoe Perches## } 42413705ce5bSJoe Perches 42423705ce5bSJoe Perches my @fix_elements = (); 424300df344fSAndy Whitcroft my $off = 0; 42446c72ffaaSAndy Whitcroft 42453705ce5bSJoe Perches foreach my $el (@elements) { 42463705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 42473705ce5bSJoe Perches $off += length($el); 42483705ce5bSJoe Perches } 42493705ce5bSJoe Perches 42503705ce5bSJoe Perches $off = 0; 42513705ce5bSJoe Perches 42526c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4253b34c648bSJoe Perches my $last_after = -1; 42546c72ffaaSAndy Whitcroft 42550a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 42563705ce5bSJoe Perches 42573705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 42583705ce5bSJoe Perches 42593705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 42603705ce5bSJoe Perches 42614a0df2efSAndy Whitcroft $off += length($elements[$n]); 42624a0df2efSAndy Whitcroft 426325985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4264773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4265773647a0SAndy Whitcroft my $cc = ''; 4266773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4267773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4268773647a0SAndy Whitcroft } 4269773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4270773647a0SAndy Whitcroft 42714a0df2efSAndy Whitcroft my $a = ''; 42724a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 42734a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4274cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 42754a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 42764a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 4277773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 42784a0df2efSAndy Whitcroft 42790a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 42804a0df2efSAndy Whitcroft 42814a0df2efSAndy Whitcroft my $c = ''; 42820a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 42834a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 42844a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4285cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 42864a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 42874a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 42888b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 42894a0df2efSAndy Whitcroft } else { 42904a0df2efSAndy Whitcroft $c = 'E'; 42910a920b5bSAndy Whitcroft } 42920a920b5bSAndy Whitcroft 42934a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 42944a0df2efSAndy Whitcroft 42954a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 42964a0df2efSAndy Whitcroft 42976c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 4298de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 42990a920b5bSAndy Whitcroft 430074048ed8SAndy Whitcroft # Pull out the value of this operator. 43016c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 43020a920b5bSAndy Whitcroft 43031f65f947SAndy Whitcroft # Get the full operator variant. 43041f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 43051f65f947SAndy Whitcroft 430613214adfSAndy Whitcroft # Ignore operators passed as parameters. 430713214adfSAndy Whitcroft if ($op_type ne 'V' && 4308d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 430913214adfSAndy Whitcroft 4310cf655043SAndy Whitcroft# # Ignore comments 4311cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 431213214adfSAndy Whitcroft 4313d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 431413214adfSAndy Whitcroft } elsif ($op eq ';') { 4315cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 4316cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 43173705ce5bSJoe Perches if (ERROR("SPACING", 43183705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 4319b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 43203705ce5bSJoe Perches $line_fixed = 1; 43213705ce5bSJoe Perches } 4322d8aaf121SAndy Whitcroft } 4323d8aaf121SAndy Whitcroft 4324d8aaf121SAndy Whitcroft # // is a comment 4325d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 43260a920b5bSAndy Whitcroft 4327b00e4814SJoe Perches # : when part of a bitfield 4328b00e4814SJoe Perches } elsif ($opv eq ':B') { 4329b00e4814SJoe Perches # skip the bitfield test for now 4330b00e4814SJoe Perches 43311f65f947SAndy Whitcroft # No spaces for: 43321f65f947SAndy Whitcroft # -> 4333b00e4814SJoe Perches } elsif ($op eq '->') { 43344a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 43353705ce5bSJoe Perches if (ERROR("SPACING", 43363705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4337b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43383705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 43393705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 43403705ce5bSJoe Perches } 4341b34c648bSJoe Perches $line_fixed = 1; 43423705ce5bSJoe Perches } 43430a920b5bSAndy Whitcroft } 43440a920b5bSAndy Whitcroft 43452381097bSJoe Perches # , must not have a space before and must have a space on the right. 43460a920b5bSAndy Whitcroft } elsif ($op eq ',') { 43472381097bSJoe Perches my $rtrim_before = 0; 43482381097bSJoe Perches my $space_after = 0; 43492381097bSJoe Perches if ($ctx =~ /Wx./) { 43502381097bSJoe Perches if (ERROR("SPACING", 43512381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 43522381097bSJoe Perches $line_fixed = 1; 43532381097bSJoe Perches $rtrim_before = 1; 43542381097bSJoe Perches } 43552381097bSJoe Perches } 4356cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 43573705ce5bSJoe Perches if (ERROR("SPACING", 43583705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 43593705ce5bSJoe Perches $line_fixed = 1; 4360b34c648bSJoe Perches $last_after = $n; 43612381097bSJoe Perches $space_after = 1; 43622381097bSJoe Perches } 43632381097bSJoe Perches } 43642381097bSJoe Perches if ($rtrim_before || $space_after) { 43652381097bSJoe Perches if ($rtrim_before) { 43662381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43672381097bSJoe Perches } else { 43682381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 43692381097bSJoe Perches } 43702381097bSJoe Perches if ($space_after) { 43712381097bSJoe Perches $good .= " "; 43723705ce5bSJoe Perches } 43730a920b5bSAndy Whitcroft } 43740a920b5bSAndy Whitcroft 43759c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 437674048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 43779c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 43789c0ca6f9SAndy Whitcroft 43799c0ca6f9SAndy Whitcroft # unary operators should have a space before and 43809c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 43819c0ca6f9SAndy Whitcroft # unary operator, or a cast 43829c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 438374048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 43840d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4385cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 43863705ce5bSJoe Perches if (ERROR("SPACING", 43873705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4388b34c648bSJoe Perches if ($n != $last_after + 2) { 4389b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 43903705ce5bSJoe Perches $line_fixed = 1; 43913705ce5bSJoe Perches } 43920a920b5bSAndy Whitcroft } 4393b34c648bSJoe Perches } 4394a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4395171ae1a4SAndy Whitcroft # A unary '*' may be const 4396171ae1a4SAndy Whitcroft 4397171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 43983705ce5bSJoe Perches if (ERROR("SPACING", 43993705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4400b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 44013705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 44023705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 44033705ce5bSJoe Perches } 4404b34c648bSJoe Perches $line_fixed = 1; 44053705ce5bSJoe Perches } 44060a920b5bSAndy Whitcroft } 44070a920b5bSAndy Whitcroft 44080a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 44090a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4410773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 44113705ce5bSJoe Perches if (ERROR("SPACING", 44123705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4413b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 44143705ce5bSJoe Perches $line_fixed = 1; 44153705ce5bSJoe Perches } 44160a920b5bSAndy Whitcroft } 4417773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4418773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 44193705ce5bSJoe Perches if (ERROR("SPACING", 44203705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4421b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 44223705ce5bSJoe Perches $line_fixed = 1; 44233705ce5bSJoe Perches } 4424653d4876SAndy Whitcroft } 4425773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 44263705ce5bSJoe Perches if (ERROR("SPACING", 44273705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4428b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 44293705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 44303705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4431773647a0SAndy Whitcroft } 4432b34c648bSJoe Perches $line_fixed = 1; 44333705ce5bSJoe Perches } 44343705ce5bSJoe Perches } 44350a920b5bSAndy Whitcroft 44360a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 44379c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 44389c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 44399c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4440c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4441c2fdda0dSAndy Whitcroft $op eq '%') 44420a920b5bSAndy Whitcroft { 4443d2e025f3SJoe Perches if ($check) { 4444d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4445d2e025f3SJoe Perches if (CHK("SPACING", 4446d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4447d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4448d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4449d2e025f3SJoe Perches $line_fixed = 1; 4450d2e025f3SJoe Perches } 4451d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4452d2e025f3SJoe Perches if (CHK("SPACING", 4453d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4454d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4455d2e025f3SJoe Perches $line_fixed = 1; 4456d2e025f3SJoe Perches } 4457d2e025f3SJoe Perches } 4458d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 44593705ce5bSJoe Perches if (ERROR("SPACING", 44603705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4461b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4462b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4463b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4464b34c648bSJoe Perches } 44653705ce5bSJoe Perches $line_fixed = 1; 44663705ce5bSJoe Perches } 44670a920b5bSAndy Whitcroft } 44680a920b5bSAndy Whitcroft 44691f65f947SAndy Whitcroft # A colon needs no spaces before when it is 44701f65f947SAndy Whitcroft # terminating a case value or a label. 44711f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 44721f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 44733705ce5bSJoe Perches if (ERROR("SPACING", 44743705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4475b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 44763705ce5bSJoe Perches $line_fixed = 1; 44773705ce5bSJoe Perches } 44781f65f947SAndy Whitcroft } 44791f65f947SAndy Whitcroft 44800a920b5bSAndy Whitcroft # All the others need spaces both sides. 4481cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 44821f65f947SAndy Whitcroft my $ok = 0; 44831f65f947SAndy Whitcroft 448422f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 44851f65f947SAndy Whitcroft if (($op eq '<' && 44861f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 44871f65f947SAndy Whitcroft ($op eq '>' && 44881f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 44891f65f947SAndy Whitcroft { 44901f65f947SAndy Whitcroft $ok = 1; 44911f65f947SAndy Whitcroft } 44921f65f947SAndy Whitcroft 4493e0df7e1fSJoe Perches # for asm volatile statements 4494e0df7e1fSJoe Perches # ignore a colon with another 4495e0df7e1fSJoe Perches # colon immediately before or after 4496e0df7e1fSJoe Perches if (($op eq ':') && 4497e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4498e0df7e1fSJoe Perches $ok = 1; 4499e0df7e1fSJoe Perches } 4500e0df7e1fSJoe Perches 450184731623SJoe Perches # messages are ERROR, but ?: are CHK 45021f65f947SAndy Whitcroft if ($ok == 0) { 45030675a8fbSJean Delvare my $msg_level = \&ERROR; 45040675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 450584731623SJoe Perches 45060675a8fbSJean Delvare if (&{$msg_level}("SPACING", 45073705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4508b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4509b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4510b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4511b34c648bSJoe Perches } 45123705ce5bSJoe Perches $line_fixed = 1; 45133705ce5bSJoe Perches } 45140a920b5bSAndy Whitcroft } 451522f2a2efSAndy Whitcroft } 45164a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 45173705ce5bSJoe Perches 45183705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 45193705ce5bSJoe Perches 45203705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 45210a920b5bSAndy Whitcroft } 45223705ce5bSJoe Perches 45233705ce5bSJoe Perches if (($#elements % 2) == 0) { 45243705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 45253705ce5bSJoe Perches } 45263705ce5bSJoe Perches 4527194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4528194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 45293705ce5bSJoe Perches } 45303705ce5bSJoe Perches 45313705ce5bSJoe Perches 45320a920b5bSAndy Whitcroft } 45330a920b5bSAndy Whitcroft 4534786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4535d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4536786b6326SJoe Perches if (WARN("SPACING", 4537786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4538786b6326SJoe Perches $fix) { 4539194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4540786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4541786b6326SJoe Perches } 4542786b6326SJoe Perches } 4543786b6326SJoe Perches 4544f0a594c1SAndy Whitcroft# check for multiple assignments 4545f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4546000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4547000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4548f0a594c1SAndy Whitcroft } 4549f0a594c1SAndy Whitcroft 455022f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 455122f2a2efSAndy Whitcroft## # continuation. 455222f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 455322f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 455422f2a2efSAndy Whitcroft## 455522f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 455622f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 455722f2a2efSAndy Whitcroft## my $ln = $line; 455822f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 455922f2a2efSAndy Whitcroft## } 456022f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4561000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4562000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 456322f2a2efSAndy Whitcroft## } 456422f2a2efSAndy Whitcroft## } 4565f0a594c1SAndy Whitcroft 45660a920b5bSAndy Whitcroft#need space before brace following if, while, etc 45676b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 45686ad724e2SMichal Zylowski $line =~ /\b(?:else|do)\{/) { 45693705ce5bSJoe Perches if (ERROR("SPACING", 45703705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 45713705ce5bSJoe Perches $fix) { 45726ad724e2SMichal Zylowski $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/; 45733705ce5bSJoe Perches } 4574de7d4f0eSAndy Whitcroft } 4575de7d4f0eSAndy Whitcroft 4576c4a62ef9SJoe Perches## # check for blank lines before declarations 4577c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4578c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4579c4a62ef9SJoe Perches## WARN("SPACING", 4580c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4581c4a62ef9SJoe Perches## } 4582c4a62ef9SJoe Perches## 4583c4a62ef9SJoe Perches 4584de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4585de7d4f0eSAndy Whitcroft# on the line 4586de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4587d5e616fcSJoe Perches if (ERROR("SPACING", 4588d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4589d5e616fcSJoe Perches $fix) { 4590194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4591d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4592d5e616fcSJoe Perches } 45930a920b5bSAndy Whitcroft } 45940a920b5bSAndy Whitcroft 459522f2a2efSAndy Whitcroft# check spacing on square brackets 459622f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 45973705ce5bSJoe Perches if (ERROR("SPACING", 45983705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 45993705ce5bSJoe Perches $fix) { 4600194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46013705ce5bSJoe Perches s/\[\s+/\[/; 46023705ce5bSJoe Perches } 460322f2a2efSAndy Whitcroft } 460422f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 46053705ce5bSJoe Perches if (ERROR("SPACING", 46063705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 46073705ce5bSJoe Perches $fix) { 4608194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46093705ce5bSJoe Perches s/\s+\]/\]/; 46103705ce5bSJoe Perches } 461122f2a2efSAndy Whitcroft } 461222f2a2efSAndy Whitcroft 4613c45dcabdSAndy Whitcroft# check spacing on parentheses 46149c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 46159c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 46163705ce5bSJoe Perches if (ERROR("SPACING", 46173705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 46183705ce5bSJoe Perches $fix) { 4619194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46203705ce5bSJoe Perches s/\(\s+/\(/; 46213705ce5bSJoe Perches } 462222f2a2efSAndy Whitcroft } 462313214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4624c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4625c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 46263705ce5bSJoe Perches if (ERROR("SPACING", 46273705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 46283705ce5bSJoe Perches $fix) { 4629194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46303705ce5bSJoe Perches s/\s+\)/\)/; 46313705ce5bSJoe Perches } 463222f2a2efSAndy Whitcroft } 463322f2a2efSAndy Whitcroft 4634e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4635e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4636e2826fd0SJoe Perches 4637e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4638ea4acbb1SJoe Perches my $var = $1; 4639ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4640ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4641ea4acbb1SJoe Perches $fix) { 4642ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4643ea4acbb1SJoe Perches } 4644ea4acbb1SJoe Perches } 4645ea4acbb1SJoe Perches 4646ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4647ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4648ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4649ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4650ea4acbb1SJoe Perches my $var = $2; 4651ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4652ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4653ea4acbb1SJoe Perches $fix) { 4654ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4655ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4656ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4657ea4acbb1SJoe Perches } 4658e2826fd0SJoe Perches } 4659e2826fd0SJoe Perches 466063b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 4661a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 4662a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 46635b57980dSJoe Perches $perl_version_ok && defined($stat) && 466463b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 466563b7c73eSJoe Perches my $if_stat = $1; 466663b7c73eSJoe Perches my $test = substr($2, 1, -1); 466763b7c73eSJoe Perches my $herectx; 466863b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 466963b7c73eSJoe Perches my $match = $1; 467063b7c73eSJoe Perches # avoid parentheses around potential macro args 467163b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 467263b7c73eSJoe Perches if (!defined($herectx)) { 467363b7c73eSJoe Perches $herectx = $here . "\n"; 467463b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 467563b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 467663b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 467763b7c73eSJoe Perches $herectx .= $rl . "\n"; 467863b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 467963b7c73eSJoe Perches } 468063b7c73eSJoe Perches } 468163b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 468263b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 468363b7c73eSJoe Perches } 468463b7c73eSJoe Perches } 468563b7c73eSJoe Perches 46860a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 46874a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 46880a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 46893705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 46903705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 46913705ce5bSJoe Perches $fix) { 4692194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46933705ce5bSJoe Perches s/^(.)\s+/$1/; 46943705ce5bSJoe Perches } 46950a920b5bSAndy Whitcroft } 46960a920b5bSAndy Whitcroft 46975b9553abSJoe Perches# return is not a function 4698507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4699c45dcabdSAndy Whitcroft my $spacing = $1; 47005b57980dSJoe Perches if ($perl_version_ok && 47015b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 47025b9553abSJoe Perches my $value = $1; 47035b9553abSJoe Perches $value = deparenthesize($value); 47045b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4705000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4706000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 47075b9553abSJoe Perches } 4708c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4709000d1cc1SJoe Perches ERROR("SPACING", 4710000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4711c45dcabdSAndy Whitcroft } 4712c45dcabdSAndy Whitcroft } 4713507e5141SJoe Perches 4714b43ae21bSJoe Perches# unnecessary return in a void function 4715b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4716b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4717b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4718b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4719b43ae21bSJoe Perches $linenr >= 3 && 4720b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4721b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 47229819cf25SJoe Perches WARN("RETURN_VOID", 4723b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 47249819cf25SJoe Perches } 47259819cf25SJoe Perches 4726189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 47275b57980dSJoe Perches if ($perl_version_ok && 4728189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4729189248d8SJoe Perches my $openparens = $1; 4730189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4731189248d8SJoe Perches my $msg = ""; 4732189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4733189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4734189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4735189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4736189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4737189248d8SJoe Perches } 4738189248d8SJoe Perches } 4739189248d8SJoe Perches 4740c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4741c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4742c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4743c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 47445b57980dSJoe Perches if ($perl_version_ok && 4745c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4746c5595fa2SJoe Perches my $lead = $1; 4747c5595fa2SJoe Perches my $const = $2; 4748c5595fa2SJoe Perches my $comp = $3; 4749c5595fa2SJoe Perches my $to = $4; 4750c5595fa2SJoe Perches my $newcomp = $comp; 4751f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 4752c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4753c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4754c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4755c5595fa2SJoe Perches $fix) { 4756c5595fa2SJoe Perches if ($comp eq "<") { 4757c5595fa2SJoe Perches $newcomp = ">"; 4758c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4759c5595fa2SJoe Perches $newcomp = ">="; 4760c5595fa2SJoe Perches } elsif ($comp eq ">") { 4761c5595fa2SJoe Perches $newcomp = "<"; 4762c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4763c5595fa2SJoe Perches $newcomp = "<="; 4764c5595fa2SJoe Perches } 4765c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4766c5595fa2SJoe Perches } 4767c5595fa2SJoe Perches } 4768c5595fa2SJoe Perches 4769f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4770f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 477153a3c448SAndy Whitcroft my $name = $1; 477253a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4773000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4774f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 477553a3c448SAndy Whitcroft } 477653a3c448SAndy Whitcroft } 4777c45dcabdSAndy Whitcroft 47780a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 47794a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 47803705ce5bSJoe Perches if (ERROR("SPACING", 47813705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 47823705ce5bSJoe Perches $fix) { 4783194f66fcSJoe Perches $fixed[$fixlinenr] =~ 47843705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 47853705ce5bSJoe Perches } 47860a920b5bSAndy Whitcroft } 47870a920b5bSAndy Whitcroft 4788f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4789f5fe35ddSAndy Whitcroft# statements after the conditional. 4790170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 47913e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 47923e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 47933e469cdcSAndy Whitcroft if (!defined $stat); 4794170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4795170d3a22SAndy Whitcroft $remain_next, $off_next); 4796170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4797170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4798170d3a22SAndy Whitcroft 4799170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4800170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4801170d3a22SAndy Whitcroft # then count those as offsets. 4802170d3a22SAndy Whitcroft my ($whitespace) = 4803170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4804170d3a22SAndy Whitcroft my $offset = 4805170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4806170d3a22SAndy Whitcroft 4807170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4808170d3a22SAndy Whitcroft $offset} = 1; 4809170d3a22SAndy Whitcroft } 4810170d3a22SAndy Whitcroft } 4811170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4812c11230f4SJoe Perches defined($stat) && defined($cond) && 4813170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4814171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 48158905a67cSAndy Whitcroft 4816b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4817000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4818000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 48198905a67cSAndy Whitcroft } 48208905a67cSAndy Whitcroft 48218905a67cSAndy Whitcroft # Find out what is on the end of the line after the 48228905a67cSAndy Whitcroft # conditional. 4823773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 48248905a67cSAndy Whitcroft $s =~ s/\n.*//g; 482513214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 482653210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 482753210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4828773647a0SAndy Whitcroft { 4829bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4830bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4831bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 483242bdf74cSHidetoshi Seto my $stat_real = ''; 4833bb44ad39SAndy Whitcroft 483442bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 483542bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4836bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4837bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4838bb44ad39SAndy Whitcroft } 4839bb44ad39SAndy Whitcroft 4840000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4841000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 48428905a67cSAndy Whitcroft } 48438905a67cSAndy Whitcroft } 48448905a67cSAndy Whitcroft 484513214adfSAndy Whitcroft# Check for bitwise tests written as boolean 484613214adfSAndy Whitcroft if ($line =~ / 484713214adfSAndy Whitcroft (?: 484813214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 484913214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 485013214adfSAndy Whitcroft (?:\&\&|\|\|) 485113214adfSAndy Whitcroft | 485213214adfSAndy Whitcroft (?:\&\&|\|\|) 485313214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 485413214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 485513214adfSAndy Whitcroft )/x) 485613214adfSAndy Whitcroft { 4857000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4858000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 485913214adfSAndy Whitcroft } 486013214adfSAndy Whitcroft 48618905a67cSAndy Whitcroft# if and else should not have general statements after it 486213214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 486313214adfSAndy Whitcroft my $s = $1; 486413214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 486513214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4866000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4867000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 48680a920b5bSAndy Whitcroft } 486913214adfSAndy Whitcroft } 487039667782SAndy Whitcroft# if should not continue a brace 487139667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4872000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4873048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 487439667782SAndy Whitcroft $herecurr); 487539667782SAndy Whitcroft } 4876a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4877a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4878a1080bf8SAndy Whitcroft $line !~ /\G(?: 48793fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4880a1080bf8SAndy Whitcroft \s*return\s+ 4881a1080bf8SAndy Whitcroft )/xg) 4882a1080bf8SAndy Whitcroft { 4883000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4884000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4885a1080bf8SAndy Whitcroft } 48860a920b5bSAndy Whitcroft 48870a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 48880a920b5bSAndy Whitcroft # indent level to be relevant to each other. 48898b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 48900a920b5bSAndy Whitcroft $previndent == $indent) { 48918b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 48928b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 48938b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 48948b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48958b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 48968b8856f4SJoe Perches my $fixedline = $prevrawline; 48978b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 48988b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 48998b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 49008b8856f4SJoe Perches } 49018b8856f4SJoe Perches $fixedline = $rawline; 49028b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 49038b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 49048b8856f4SJoe Perches } 49050a920b5bSAndy Whitcroft } 49060a920b5bSAndy Whitcroft 49078b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4908c2fdda0dSAndy Whitcroft $previndent == $indent) { 4909c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4910c2fdda0dSAndy Whitcroft 4911c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4912c2fdda0dSAndy Whitcroft # conditional. 4913773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4914c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4915c2fdda0dSAndy Whitcroft 4916c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 49178b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 49188b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 49198b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 49208b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 49218b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 49228b8856f4SJoe Perches my $fixedline = $prevrawline; 49238b8856f4SJoe Perches my $trailing = $rawline; 49248b8856f4SJoe Perches $trailing =~ s/^\+//; 49258b8856f4SJoe Perches $trailing = trim($trailing); 49268b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 49278b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 49288b8856f4SJoe Perches } 4929c2fdda0dSAndy Whitcroft } 4930c2fdda0dSAndy Whitcroft } 4931c2fdda0dSAndy Whitcroft 493295e2c602SJoe Perches#Specific variable tests 4933323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4934323c1260SJoe Perches my $var = $1; 493595e2c602SJoe Perches 493695e2c602SJoe Perches#gcc binary extension 493795e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4938d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4939d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4940d5e616fcSJoe Perches $fix) { 4941d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4942194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4943d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4944d5e616fcSJoe Perches } 494595e2c602SJoe Perches } 494695e2c602SJoe Perches 494795e2c602SJoe Perches#CamelCase 4948807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4949be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 495022735ce8SJoe Perches#Ignore Page<foo> variants 4951807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 495222735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4953f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4954f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4955f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 49567e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 49577e781f67SJoe Perches my $word = $1; 49587e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4959d8b07710SJoe Perches if ($check) { 4960d8b07710SJoe Perches seed_camelcase_includes(); 4961d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4962d8b07710SJoe Perches seed_camelcase_file($realfile); 4963d8b07710SJoe Perches $camelcase_file_seeded = 1; 4964d8b07710SJoe Perches } 4965d8b07710SJoe Perches } 49667e781f67SJoe Perches if (!defined $camelcase{$word}) { 49677e781f67SJoe Perches $camelcase{$word} = 1; 4968be79794bSJoe Perches CHK("CAMELCASE", 49697e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 49707e781f67SJoe Perches } 4971323c1260SJoe Perches } 4972323c1260SJoe Perches } 49733445686aSJoe Perches } 49740a920b5bSAndy Whitcroft 49750a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4976d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4977d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4978d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4979d5e616fcSJoe Perches $fix) { 4980194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4981d5e616fcSJoe Perches } 49820a920b5bSAndy Whitcroft } 49830a920b5bSAndy Whitcroft 49840e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 49850e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4986c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4987e09dec48SAndy Whitcroft my $file = "$1.h"; 4988e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4989e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4990e09dec48SAndy Whitcroft $realfile ne $checkfile && 49917840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4992c45dcabdSAndy Whitcroft { 49930e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 49940e212e0aSFabian Frederick if ($asminclude > 0) { 4995e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4996000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4997000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4998e09dec48SAndy Whitcroft } else { 4999000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 5000000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5001e09dec48SAndy Whitcroft } 50020a920b5bSAndy Whitcroft } 50030a920b5bSAndy Whitcroft } 50040e212e0aSFabian Frederick } 50050a920b5bSAndy Whitcroft 5006653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 5007653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 5008cf655043SAndy Whitcroft# in a known good container 5009b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 5010b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 5011d8aaf121SAndy Whitcroft my $ln = $linenr; 5012d8aaf121SAndy Whitcroft my $cnt = $realcnt; 5013c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 5014c45dcabdSAndy Whitcroft my $ctx = ''; 501508a2843eSJoe Perches my $has_flow_statement = 0; 501608a2843eSJoe Perches my $has_arg_concat = 0; 5017c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 5018f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 5019f74bd194SAndy Whitcroft $ctx = $dstat; 5020c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 5021a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 5022c45dcabdSAndy Whitcroft 502308a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 502462e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 502508a2843eSJoe Perches 5026f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 5027f59b64bfSJoe Perches my $define_args = $1; 5028f59b64bfSJoe Perches my $define_stmt = $dstat; 5029f59b64bfSJoe Perches my @def_args = (); 5030f59b64bfSJoe Perches 5031f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 5032f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 5033f59b64bfSJoe Perches $define_args =~ s/\s*//g; 50348c8c45cfSJoe Perches $define_args =~ s/\\\+?//g; 5035f59b64bfSJoe Perches @def_args = split(",", $define_args); 5036f59b64bfSJoe Perches } 5037f59b64bfSJoe Perches 5038292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 5039c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 5040c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 5041c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 5042c45dcabdSAndy Whitcroft 5043c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 5044bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 5045bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 50466b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 5047bf30d6edSAndy Whitcroft { 5048c45dcabdSAndy Whitcroft } 5049c45dcabdSAndy Whitcroft 5050e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 505133acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 505233acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 5053e45bab8eSAndy Whitcroft { 5054e45bab8eSAndy Whitcroft } 5055e45bab8eSAndy Whitcroft 505642e15293SJoe Perches # Make asm volatile uses seem like a generic function 505742e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 505842e15293SJoe Perches 5059c45dcabdSAndy Whitcroft my $exceptions = qr{ 5060c45dcabdSAndy Whitcroft $Declare| 5061c45dcabdSAndy Whitcroft module_param_named| 5062a0a0a7a9SKees Cook MODULE_PARM_DESC| 5063c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 5064c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 5065383099fdSAndy Whitcroft __typeof__\(| 506622fd2d3eSStefani Seibold union| 506722fd2d3eSStefani Seibold struct| 5068ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 50696b10df42SVladimir Zapolskiy ^\"|\"$| 50706b10df42SVladimir Zapolskiy ^\[ 5071c45dcabdSAndy Whitcroft }x; 50725eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 5073f59b64bfSJoe Perches 5074f59b64bfSJoe Perches $ctx =~ s/\n*$//; 5075f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 5076e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 5077f59b64bfSJoe Perches 5078f74bd194SAndy Whitcroft if ($dstat ne '' && 5079f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 5080f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 50813cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 5082356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5083f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 5084f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5085e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 508672f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 5087f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5088f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5089f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 50904e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5091f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5092c45dcabdSAndy Whitcroft { 5093e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5094e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5095e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5096e795556aSJoe Perches } elsif ($dstat =~ /;/) { 5097f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5098f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5099f74bd194SAndy Whitcroft } else { 5100000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 5101388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5102d8aaf121SAndy Whitcroft } 5103f59b64bfSJoe Perches 5104f59b64bfSJoe Perches } 51055207649bSJoe Perches 51065207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 51075207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 51085207649bSJoe Perches my $first = 1; 51095207649bSJoe Perches $define_stmt = ""; 51105207649bSJoe Perches foreach my $l (@stmt_array) { 51115207649bSJoe Perches $l =~ s/\\$//; 51125207649bSJoe Perches if ($first) { 51135207649bSJoe Perches $define_stmt = $l; 51145207649bSJoe Perches $first = 0; 51155207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 51165207649bSJoe Perches $define_stmt .= substr($l, 1); 51175207649bSJoe Perches } 51185207649bSJoe Perches } 51195207649bSJoe Perches $define_stmt =~ s/$;//g; 51205207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 51215207649bSJoe Perches $define_stmt = trim($define_stmt); 51225207649bSJoe Perches 5123f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5124f59b64bfSJoe Perches foreach my $arg (@def_args) { 5125f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 51269192d41aSJoe Perches next if ($arg =~ /^type$/i); 51277fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 51287fe528a2SJoe Perches $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 51297fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 51307fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 5131d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 5132f59b64bfSJoe Perches if ($use_cnt > 1) { 5133f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5134f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5135f59b64bfSJoe Perches } 51369192d41aSJoe Perches# check if any macro arguments may have other precedence issues 51377fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 51389192d41aSJoe Perches ((defined($1) && $1 ne ',') || 51399192d41aSJoe Perches (defined($2) && $2 ne ','))) { 51409192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 51419192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 51429192d41aSJoe Perches } 51430a920b5bSAndy Whitcroft } 51445023d347SJoe Perches 514508a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 514608a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 514708a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 514808a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 5149e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 515008a2843eSJoe Perches 515108a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 515208a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 515308a2843eSJoe Perches } 515408a2843eSJoe Perches 5155481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 51565023d347SJoe Perches 51575023d347SJoe Perches } else { 51585023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5159481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5160481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 51615023d347SJoe Perches $line =~ /^\+.*\\$/) { 51625023d347SJoe Perches WARN("LINE_CONTINUATIONS", 51635023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 51645023d347SJoe Perches } 5165653d4876SAndy Whitcroft } 51660a920b5bSAndy Whitcroft 5167b13edf7fSJoe Perches# do {} while (0) macro tests: 5168b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5169b13edf7fSJoe Perches# macro should not end with a semicolon 51705b57980dSJoe Perches if ($perl_version_ok && 5171b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5172b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5173b13edf7fSJoe Perches my $ln = $linenr; 5174b13edf7fSJoe Perches my $cnt = $realcnt; 5175b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5176b13edf7fSJoe Perches my $ctx = ''; 5177b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5178b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5179b13edf7fSJoe Perches $ctx = $dstat; 5180b13edf7fSJoe Perches 5181b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 51821b36b201SJoe Perches $dstat =~ s/$;/ /g; 5183b13edf7fSJoe Perches 5184b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5185b13edf7fSJoe Perches my $stmts = $2; 5186b13edf7fSJoe Perches my $semis = $3; 5187b13edf7fSJoe Perches 5188b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5189b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5190e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5191b13edf7fSJoe Perches 5192ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5193ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5194b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5195b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5196b13edf7fSJoe Perches } 5197b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5198b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5199b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5200b13edf7fSJoe Perches } 5201f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5202f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5203f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5204e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5205f5ef95b1SJoe Perches 5206f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5207f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5208b13edf7fSJoe Perches } 5209b13edf7fSJoe Perches } 5210b13edf7fSJoe Perches 5211f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 521213214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 521313214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5214cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 521513214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5216cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5217cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5218aad4f614SJoe Perches my @allowed = (); 5219aad4f614SJoe Perches my $allow = 0; 522013214adfSAndy Whitcroft my $seen = 0; 5221773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5222cf655043SAndy Whitcroft my $ln = $linenr - 1; 522313214adfSAndy Whitcroft for my $chunk (@chunks) { 522413214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 522513214adfSAndy Whitcroft 5226773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5227773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5228773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 5229773647a0SAndy Whitcroft 5230aad4f614SJoe Perches $allowed[$allow] = 0; 5231773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5232773647a0SAndy Whitcroft 5233773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 5234773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 5235773647a0SAndy Whitcroft 5236773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5237cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 5238cf655043SAndy Whitcroft 5239773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 524013214adfSAndy Whitcroft 524113214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 524213214adfSAndy Whitcroft 5243aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5244cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5245cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5246aad4f614SJoe Perches $allowed[$allow] = 1; 524713214adfSAndy Whitcroft } 524813214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5249cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5250aad4f614SJoe Perches $allowed[$allow] = 1; 525113214adfSAndy Whitcroft } 5252cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5253cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5254aad4f614SJoe Perches $allowed[$allow] = 1; 525513214adfSAndy Whitcroft } 5256aad4f614SJoe Perches $allow++; 525713214adfSAndy Whitcroft } 5258aad4f614SJoe Perches if ($seen) { 5259aad4f614SJoe Perches my $sum_allowed = 0; 5260aad4f614SJoe Perches foreach (@allowed) { 5261aad4f614SJoe Perches $sum_allowed += $_; 5262aad4f614SJoe Perches } 5263aad4f614SJoe Perches if ($sum_allowed == 0) { 5264000d1cc1SJoe Perches WARN("BRACES", 5265000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 5266aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 5267aad4f614SJoe Perches $seen != $allow) { 5268aad4f614SJoe Perches CHK("BRACES", 5269aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 5270aad4f614SJoe Perches } 527113214adfSAndy Whitcroft } 527213214adfSAndy Whitcroft } 527313214adfSAndy Whitcroft } 5274773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 527513214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 5276cf655043SAndy Whitcroft my $allowed = 0; 5277f0a594c1SAndy Whitcroft 5278cf655043SAndy Whitcroft # Check the pre-context. 5279cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 5280cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 5281cf655043SAndy Whitcroft $allowed = 1; 5282f0a594c1SAndy Whitcroft } 5283773647a0SAndy Whitcroft 5284773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 5285773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 5286773647a0SAndy Whitcroft 5287cf655043SAndy Whitcroft # Check the condition. 5288cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 5289773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 5290cf655043SAndy Whitcroft if (defined $cond) { 5291773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5292cf655043SAndy Whitcroft } 5293cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5294cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5295cf655043SAndy Whitcroft $allowed = 1; 5296cf655043SAndy Whitcroft } 5297cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5298cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5299cf655043SAndy Whitcroft $allowed = 1; 5300cf655043SAndy Whitcroft } 5301cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5302cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5303cf655043SAndy Whitcroft $allowed = 1; 5304cf655043SAndy Whitcroft } 5305cf655043SAndy Whitcroft # Check the post-context. 5306cf655043SAndy Whitcroft if (defined $chunks[1]) { 5307cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 5308cf655043SAndy Whitcroft if (defined $cond) { 5309773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5310cf655043SAndy Whitcroft } 5311cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 5312cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5313cf655043SAndy Whitcroft $allowed = 1; 5314cf655043SAndy Whitcroft } 5315cf655043SAndy Whitcroft } 5316cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 5317f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 5318e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5319cf655043SAndy Whitcroft 5320000d1cc1SJoe Perches WARN("BRACES", 5321000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 5322f0a594c1SAndy Whitcroft } 5323f0a594c1SAndy Whitcroft } 5324f0a594c1SAndy Whitcroft 5325e4c5babdSJoe Perches# check for single line unbalanced braces 532695330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 532795330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 5328e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 5329e4c5babdSJoe Perches } 5330e4c5babdSJoe Perches 53310979ae66SJoe Perches# check for unnecessary blank lines around braces 533277b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5333f8e58219SJoe Perches if (CHK("BRACES", 5334f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5335f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 5336f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5337f8e58219SJoe Perches } 53380979ae66SJoe Perches } 533977b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5340f8e58219SJoe Perches if (CHK("BRACES", 5341f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5342f8e58219SJoe Perches $fix) { 5343f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 5344f8e58219SJoe Perches } 53450979ae66SJoe Perches } 53460979ae66SJoe Perches 53474a0df2efSAndy Whitcroft# no volatiles please 53486c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 53496c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5350000d1cc1SJoe Perches WARN("VOLATILE", 53518c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 53524a0df2efSAndy Whitcroft } 53534a0df2efSAndy Whitcroft 53545e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 53555e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 53565e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 53575e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 535833acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 53595e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 53605e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 53615e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 53625e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 53635e4f6ba5SJoe Perches $fix && 53645e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 53655e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 53665e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 53675e4f6ba5SJoe Perches my $comma_close = ""; 53685e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 53695e4f6ba5SJoe Perches $comma_close = $1; 53705e4f6ba5SJoe Perches } 53715e4f6ba5SJoe Perches 53725e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 53735e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 53745e4f6ba5SJoe Perches my $fixedline = $prevrawline; 53755e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 53765e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 53775e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 53785e4f6ba5SJoe Perches $fixedline = $rawline; 53795e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 53805e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 53815e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 53825e4f6ba5SJoe Perches } 53835e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 53845e4f6ba5SJoe Perches } 53855e4f6ba5SJoe Perches } 53865e4f6ba5SJoe Perches 53875e4f6ba5SJoe Perches# check for missing a space in a string concatenation 53885e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 53895e4f6ba5SJoe Perches WARN('MISSING_SPACE', 53905e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 53915e4f6ba5SJoe Perches } 53925e4f6ba5SJoe Perches 539377cb8546SJoe Perches# check for an embedded function name in a string when the function is known 5394e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 5395e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 5396e4b7d309SJoe Perches# function declarations 539777cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 539877cb8546SJoe Perches defined($context_function) && 5399e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 5400e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 540177cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 5402e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 540377cb8546SJoe Perches } 540477cb8546SJoe Perches 54055e4f6ba5SJoe Perches# check for spaces before a quoted newline 54065e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 54075e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 54085e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 54095e4f6ba5SJoe Perches $fix) { 54105e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 54115e4f6ba5SJoe Perches } 54125e4f6ba5SJoe Perches 54135e4f6ba5SJoe Perches } 54145e4f6ba5SJoe Perches 5415f17dba4fSJoe Perches# concatenated string without spaces between elements 541679682c0cSJoe Perches if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) { 541779682c0cSJoe Perches if (CHK("CONCATENATED_STRING", 541879682c0cSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr) && 541979682c0cSJoe Perches $fix) { 542079682c0cSJoe Perches while ($line =~ /($String)/g) { 542179682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 542279682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/; 542379682c0cSJoe Perches $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/; 542479682c0cSJoe Perches } 542579682c0cSJoe Perches } 5426f17dba4fSJoe Perches } 5427f17dba4fSJoe Perches 542890ad30e5SJoe Perches# uncoalesced string fragments 542933acb54aSJoe Perches if ($line =~ /$String\s*"/) { 543079682c0cSJoe Perches if (WARN("STRING_FRAGMENTS", 543179682c0cSJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr) && 543279682c0cSJoe Perches $fix) { 543379682c0cSJoe Perches while ($line =~ /($String)(?=\s*")/g) { 543479682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 543579682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e; 543679682c0cSJoe Perches } 543779682c0cSJoe Perches } 543890ad30e5SJoe Perches } 543990ad30e5SJoe Perches 5440522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 5441522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 5442522b837cSAlexey Dobriyan my $show_Z = 1; 54435e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 5444522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 54455e4f6ba5SJoe Perches $string =~ s/%%/__/g; 5446522b837cSAlexey Dobriyan # check for %L 5447522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 54485e4f6ba5SJoe Perches WARN("PRINTF_L", 5449522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 5450522b837cSAlexey Dobriyan $show_L = 0; 54515e4f6ba5SJoe Perches } 5452522b837cSAlexey Dobriyan # check for %Z 5453522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 5454522b837cSAlexey Dobriyan WARN("PRINTF_Z", 5455522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 5456522b837cSAlexey Dobriyan $show_Z = 0; 5457522b837cSAlexey Dobriyan } 5458522b837cSAlexey Dobriyan # check for 0x<decimal> 5459522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 5460522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 54616e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 54626e300757SJoe Perches } 54635e4f6ba5SJoe Perches } 54645e4f6ba5SJoe Perches 54655e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 54663f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 54675e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 54685e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 54695e4f6ba5SJoe Perches } 54705e4f6ba5SJoe Perches 547100df344fSAndy Whitcroft# warn about #if 0 5472c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 547360f89010SPrakruthi Deepak Heragu WARN("IF_0", 547460f89010SPrakruthi Deepak Heragu "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr); 547560f89010SPrakruthi Deepak Heragu } 547660f89010SPrakruthi Deepak Heragu 547760f89010SPrakruthi Deepak Heragu# warn about #if 1 547860f89010SPrakruthi Deepak Heragu if ($line =~ /^.\s*\#\s*if\s+1\b/) { 547960f89010SPrakruthi Deepak Heragu WARN("IF_1", 548060f89010SPrakruthi Deepak Heragu "Consider removing the #if 1 and its #endif\n" . $herecurr); 54814a0df2efSAndy Whitcroft } 54824a0df2efSAndy Whitcroft 548303df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 548403df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5485100425deSJoe Perches my $tested = quotemeta($1); 5486100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5487100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5488100425deSJoe Perches my $func = $1; 5489100425deSJoe Perches if (WARN('NEEDLESS_IF', 5490100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5491100425deSJoe Perches $fix) { 5492100425deSJoe Perches my $do_fix = 1; 5493100425deSJoe Perches my $leading_tabs = ""; 5494100425deSJoe Perches my $new_leading_tabs = ""; 5495100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5496100425deSJoe Perches $leading_tabs = $1; 5497100425deSJoe Perches } else { 5498100425deSJoe Perches $do_fix = 0; 5499100425deSJoe Perches } 5500100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5501100425deSJoe Perches $new_leading_tabs = $1; 5502100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5503100425deSJoe Perches $do_fix = 0; 5504100425deSJoe Perches } 5505100425deSJoe Perches } else { 5506100425deSJoe Perches $do_fix = 0; 5507100425deSJoe Perches } 5508100425deSJoe Perches if ($do_fix) { 5509100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5510100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5511100425deSJoe Perches } 5512100425deSJoe Perches } 55134c432a8fSGreg Kroah-Hartman } 55144c432a8fSGreg Kroah-Hartman } 5515f0a594c1SAndy Whitcroft 5516ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5517ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5518ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5519ebfdc409SJoe Perches (defined $1 || defined $3) && 5520ebfdc409SJoe Perches $linenr > 3) { 5521ebfdc409SJoe Perches my $testval = $2; 5522ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5523ebfdc409SJoe Perches 5524ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5525ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5526ebfdc409SJoe Perches 5527fb0d0e08SJoe 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)/) { 5528ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5529ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5530ebfdc409SJoe Perches } 5531ebfdc409SJoe Perches } 5532ebfdc409SJoe Perches 5533f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5534dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5535f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5536f78d98f6SJoe Perches my $level = $1; 5537f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5538f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5539f78d98f6SJoe Perches $fix) { 5540f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5541f78d98f6SJoe Perches } 5542f78d98f6SJoe Perches } 5543f78d98f6SJoe Perches 554445c55e92SJoe Perches# check for logging continuations 554545c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 554645c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 554745c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 554845c55e92SJoe Perches } 554945c55e92SJoe Perches 5550abb08a53SJoe Perches# check for mask then right shift without a parentheses 55515b57980dSJoe Perches if ($perl_version_ok && 5552abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5553abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5554abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5555abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5556abb08a53SJoe Perches } 5557abb08a53SJoe Perches 5558b75ac618SJoe Perches# check for pointer comparisons to NULL 55595b57980dSJoe Perches if ($perl_version_ok) { 5560b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5561b75ac618SJoe Perches my $val = $1; 5562b75ac618SJoe Perches my $equal = "!"; 5563b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5564b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5565b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5566b75ac618SJoe Perches $fix) { 5567b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5568b75ac618SJoe Perches } 5569b75ac618SJoe Perches } 5570b75ac618SJoe Perches } 5571b75ac618SJoe Perches 55728716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 55738716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 55748716de38SJoe Perches my $attr = $1; 55758716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 55768716de38SJoe Perches my $ptr = $1; 55778716de38SJoe Perches my $var = $2; 55788716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 55798716de38SJoe Perches ERROR("MISPLACED_INIT", 55808716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 55818716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 55828716de38SJoe Perches WARN("MISPLACED_INIT", 55838716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 55848716de38SJoe Perches $fix) { 5585194f66fcSJoe 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; 55868716de38SJoe Perches } 55878716de38SJoe Perches } 55888716de38SJoe Perches } 55898716de38SJoe Perches 5590e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5591e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5592e970b884SJoe Perches my $attr = $1; 5593e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5594e970b884SJoe Perches my $attr_prefix = $1; 5595e970b884SJoe Perches my $attr_type = $2; 5596e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5597e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5598e970b884SJoe Perches $fix) { 5599194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5600e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5601e970b884SJoe Perches } 5602e970b884SJoe Perches } 5603e970b884SJoe Perches 5604e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5605e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5606e970b884SJoe Perches my $attr = $1; 5607e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5608e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5609e970b884SJoe Perches $fix) { 5610194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5611e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5612e970b884SJoe Perches $lead = rtrim($1); 5613e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5614e970b884SJoe Perches $lead = "${lead}const "; 5615194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5616e970b884SJoe Perches } 5617e970b884SJoe Perches } 5618e970b884SJoe Perches 5619c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5620c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5621c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5622c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5623c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5624c17893c7SJoe Perches $fix) { 5625c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5626c17893c7SJoe Perches } 5627c17893c7SJoe Perches } 5628c17893c7SJoe Perches 5629fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5630fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5631fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5632fbdb8138SJoe Perches my $constant_func = $1; 5633fbdb8138SJoe Perches my $func = $constant_func; 5634fbdb8138SJoe Perches $func =~ s/^__constant_//; 5635fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5636fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5637fbdb8138SJoe Perches $fix) { 5638194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5639fbdb8138SJoe Perches } 5640fbdb8138SJoe Perches } 5641fbdb8138SJoe Perches 56421a15a250SPatrick Pannuto# prefer usleep_range over udelay 564337581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 564443c1d77cSJoe Perches my $delay = $1; 56451a15a250SPatrick Pannuto # ignore udelay's < 10, however 564643c1d77cSJoe Perches if (! ($delay < 10) ) { 5647000d1cc1SJoe Perches CHK("USLEEP_RANGE", 564843c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 564943c1d77cSJoe Perches } 565043c1d77cSJoe Perches if ($delay > 2000) { 565143c1d77cSJoe Perches WARN("LONG_UDELAY", 565243c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 56531a15a250SPatrick Pannuto } 56541a15a250SPatrick Pannuto } 56551a15a250SPatrick Pannuto 565609ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 565709ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 565809ef8725SPatrick Pannuto if ($1 < 20) { 5659000d1cc1SJoe Perches WARN("MSLEEP", 566043c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 566109ef8725SPatrick Pannuto } 566209ef8725SPatrick Pannuto } 566309ef8725SPatrick Pannuto 566436ec1939SJoe Perches# check for comparisons of jiffies 566536ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 566636ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 566736ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 566836ec1939SJoe Perches } 566936ec1939SJoe Perches 56709d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 56719d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 56729d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 56739d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 56749d7a34a5SJoe Perches } 56759d7a34a5SJoe Perches 567600df344fSAndy Whitcroft# warn about #ifdefs in C files 5677c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 567800df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 567900df344fSAndy Whitcroft# print "$herecurr"; 568000df344fSAndy Whitcroft# $clean = 0; 568100df344fSAndy Whitcroft# } 568200df344fSAndy Whitcroft 568322f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5684c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 56853705ce5bSJoe Perches if (ERROR("SPACING", 56863705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 56873705ce5bSJoe Perches $fix) { 5688194f66fcSJoe Perches $fixed[$fixlinenr] =~ 56893705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 56903705ce5bSJoe Perches } 56913705ce5bSJoe Perches 569222f2a2efSAndy Whitcroft } 569322f2a2efSAndy Whitcroft 56944a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5695171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5696171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 56974a0df2efSAndy Whitcroft my $which = $1; 56984a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5699000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5700000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 57014a0df2efSAndy Whitcroft } 57024a0df2efSAndy Whitcroft } 57034a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5704402c2553SMichael S. Tsirkin 5705402c2553SMichael S. Tsirkin my $barriers = qr{ 5706402c2553SMichael S. Tsirkin mb| 5707402c2553SMichael S. Tsirkin rmb| 5708402c2553SMichael S. Tsirkin wmb| 5709402c2553SMichael S. Tsirkin read_barrier_depends 5710402c2553SMichael S. Tsirkin }x; 5711402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5712402c2553SMichael S. Tsirkin mb__before_atomic| 5713402c2553SMichael S. Tsirkin mb__after_atomic| 5714402c2553SMichael S. Tsirkin store_release| 5715402c2553SMichael S. Tsirkin load_acquire| 5716402c2553SMichael S. Tsirkin store_mb| 5717402c2553SMichael S. Tsirkin (?:$barriers) 5718402c2553SMichael S. Tsirkin }x; 5719402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5720402c2553SMichael S. Tsirkin (?:$barriers)| 572143e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 572243e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5723402c2553SMichael S. Tsirkin }x; 5724402c2553SMichael S. Tsirkin 5725402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 57264a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5727c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5728000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 57294a0df2efSAndy Whitcroft } 57304a0df2efSAndy Whitcroft } 57313ad81779SPaul E. McKenney 5732f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5733f4073b0fSMichael S. Tsirkin 5734f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5735f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5736f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5737f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5738f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5739f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5740f4073b0fSMichael S. Tsirkin } 5741f4073b0fSMichael S. Tsirkin 5742cb426e99SJoe Perches# check for waitqueue_active without a comment. 5743cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5744cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5745cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5746cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5747cb426e99SJoe Perches } 5748cb426e99SJoe Perches } 57493ad81779SPaul E. McKenney 575091db2592SPaul E. McKenney# check for smp_read_barrier_depends and read_barrier_depends 575191db2592SPaul E. McKenney if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) { 575291db2592SPaul E. McKenney WARN("READ_BARRIER_DEPENDS", 575391db2592SPaul E. McKenney "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr); 575491db2592SPaul E. McKenney } 575591db2592SPaul E. McKenney 57564a0df2efSAndy Whitcroft# check of hardware specific defines 5757c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5758000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5759000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 57600a920b5bSAndy Whitcroft } 5761653d4876SAndy Whitcroft 5762596ed45bSJoe Perches# check that the storage class is not after a type 5763596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 5764000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5765596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 5766596ed45bSJoe Perches } 5767596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 5768596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 5769596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 5770596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 5771596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 5772596ed45bSJoe Perches WARN("STORAGE_CLASS", 5773596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 5774d4977c78STobias Klauser } 5775d4977c78STobias Klauser 5776de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5777de7d4f0eSAndy Whitcroft# storage class and type. 57789c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 57799c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5780000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5781000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5782de7d4f0eSAndy Whitcroft } 5783de7d4f0eSAndy Whitcroft 57848905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 57852b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57862b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5787d5e616fcSJoe Perches if (WARN("INLINE", 5788d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5789d5e616fcSJoe Perches $fix) { 5790194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5791d5e616fcSJoe Perches 5792d5e616fcSJoe Perches } 57938905a67cSAndy Whitcroft } 57948905a67cSAndy Whitcroft 57953d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 57962b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57972b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5798000d1cc1SJoe Perches WARN("PREFER_PACKED", 5799000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 58003d130fd0SJoe Perches } 58013d130fd0SJoe Perches 580239b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 58032b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 58042b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5805000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5806000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 580739b7e287SJoe Perches } 580839b7e287SJoe Perches 58095f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 58102b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 58112b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5812d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5813d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5814d5e616fcSJoe Perches $fix) { 5815194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5816d5e616fcSJoe Perches 5817d5e616fcSJoe Perches } 58185f14d3bdSJoe Perches } 58195f14d3bdSJoe Perches 58206061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 58212b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 58222b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5823d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5824d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5825d5e616fcSJoe Perches $fix) { 5826194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5827d5e616fcSJoe Perches } 58286061d949SJoe Perches } 58296061d949SJoe Perches 5830619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 58315b57980dSJoe Perches if ($perl_version_ok && 5832619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5833619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5834619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5835619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5836619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5837619a908aSJoe Perches } 5838619a908aSJoe Perches 5839fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 5840e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5841fd39f904STomas Winkler $realfile !~ m@\btools/@ && 5842e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5843e6176fa4SJoe Perches my $type = $1; 5844e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5845e6176fa4SJoe Perches $type = $1; 5846e6176fa4SJoe Perches my $kernel_type = 'u'; 5847e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5848e6176fa4SJoe Perches $type =~ /(\d+)/; 5849e6176fa4SJoe Perches $kernel_type .= $1; 5850e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5851e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5852e6176fa4SJoe Perches $fix) { 5853e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5854e6176fa4SJoe Perches } 5855e6176fa4SJoe Perches } 5856e6176fa4SJoe Perches } 5857e6176fa4SJoe Perches 5858938224b5SJoe Perches# check for cast of C90 native int or longer types constants 5859938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 5860938224b5SJoe Perches my $cast = $1; 5861938224b5SJoe Perches my $const = $2; 5862938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 5863938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 5864938224b5SJoe Perches $fix) { 5865938224b5SJoe Perches my $suffix = ""; 5866938224b5SJoe Perches my $newconst = $const; 5867938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 5868938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 5869938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 5870938224b5SJoe Perches $suffix .= 'LL'; 5871938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 5872938224b5SJoe Perches $suffix .= 'L'; 5873938224b5SJoe Perches } 5874938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 5875938224b5SJoe Perches } 5876938224b5SJoe Perches } 5877938224b5SJoe Perches 58788f53a9b8SJoe Perches# check for sizeof(&) 58798f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5880000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5881000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 58828f53a9b8SJoe Perches } 58838f53a9b8SJoe Perches 588466c80b60SJoe Perches# check for sizeof without parenthesis 588566c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5886d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5887d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5888d5e616fcSJoe Perches $fix) { 5889194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5890d5e616fcSJoe Perches } 589166c80b60SJoe Perches } 589266c80b60SJoe Perches 589388982feaSJoe Perches# check for struct spinlock declarations 589488982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 589588982feaSJoe Perches WARN("USE_SPINLOCK_T", 589688982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 589788982feaSJoe Perches } 589888982feaSJoe Perches 5899a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 590006668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5901a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5902caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5903caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5904d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5905d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5906d5e616fcSJoe Perches $fix) { 5907194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5908d5e616fcSJoe Perches } 5909a6962d72SJoe Perches } 5910a6962d72SJoe Perches } 5911a6962d72SJoe Perches 59120b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 59135b57980dSJoe Perches if ($perl_version_ok && 59140b523769SJoe Perches defined $stat && 59150b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 59160b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 5917e3c6bc95STobin C. Harding my $stat_real; 5918e3c6bc95STobin C. Harding 59190b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 59200b523769SJoe Perches $lc = $lc + $linenr; 59210b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 5922ffe07513SJoe Perches my $specifier; 5923ffe07513SJoe Perches my $extension; 5924ffe07513SJoe Perches my $bad_specifier = ""; 59250b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 59260b523769SJoe Perches $fmt =~ s/%%//g; 5927e3c6bc95STobin C. Harding 5928e3c6bc95STobin C. Harding while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) { 5929e3c6bc95STobin C. Harding $specifier = $1; 5930e3c6bc95STobin C. Harding $extension = $2; 5931e3c6bc95STobin C. Harding if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOx]/) { 5932e3c6bc95STobin C. Harding $bad_specifier = $specifier; 59330b523769SJoe Perches last; 59340b523769SJoe Perches } 5935e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 5936e3c6bc95STobin C. Harding if (!defined($stat_real)) { 5937e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 59380b523769SJoe Perches } 5939e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 5940e3c6bc95STobin 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"); 5941e3c6bc95STobin C. Harding } 5942e3c6bc95STobin C. Harding } 5943e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 59442a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 59451df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 59461df7338aSSergey Senozhatsky my $use = ""; 5947e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 59481df7338aSSergey Senozhatsky $ext_type = "Deprecated"; 59491df7338aSSergey Senozhatsky $use = " - use %pS instead"; 5950e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 59511df7338aSSergey Senozhatsky } 59522a9f9d85STobin C. Harding 59530b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 5954e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 5955e3c6bc95STobin C. Harding } 59560b523769SJoe Perches } 59570b523769SJoe Perches } 59580b523769SJoe Perches 5959554e165cSAndy Whitcroft# Check for misused memsets 59605b57980dSJoe Perches if ($perl_version_ok && 5961d1fe9c09SJoe Perches defined $stat && 59629e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5963554e165cSAndy Whitcroft 5964d7c76ba7SJoe Perches my $ms_addr = $2; 5965d1fe9c09SJoe Perches my $ms_val = $7; 5966d1fe9c09SJoe Perches my $ms_size = $12; 5967d7c76ba7SJoe Perches 5968554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5969554e165cSAndy Whitcroft ERROR("MEMSET", 5970d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5971554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5972554e165cSAndy Whitcroft WARN("MEMSET", 5973d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5974d7c76ba7SJoe Perches } 5975d7c76ba7SJoe Perches } 5976d7c76ba7SJoe Perches 597798a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 59785b57980dSJoe Perches# if ($perl_version_ok && 5979f333195dSJoe Perches# defined $stat && 5980f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5981f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 5982f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 5983f333195dSJoe Perches# $fix) { 5984f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 5985f333195dSJoe Perches# } 5986f333195dSJoe Perches# } 598798a9bba5SJoe Perches 5988b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 59895b57980dSJoe Perches# if ($perl_version_ok && 5990f333195dSJoe Perches# defined $stat && 5991f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5992f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 5993f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5994f333195dSJoe Perches# } 5995b6117d17SMateusz Kulikowski 59968617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 59978617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 59985b57980dSJoe Perches# if ($perl_version_ok && 5999f333195dSJoe Perches# defined $stat && 6000f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6001f333195dSJoe Perches# 6002f333195dSJoe Perches# my $ms_val = $7; 6003f333195dSJoe Perches# 6004f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 6005f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 6006f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 6007f333195dSJoe Perches# $fix) { 6008f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 6009f333195dSJoe Perches# } 6010f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 6011f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 6012f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 6013f333195dSJoe Perches# $fix) { 6014f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 6015f333195dSJoe Perches# } 6016f333195dSJoe Perches# } 6017f333195dSJoe Perches# } 60188617cd09SMateusz Kulikowski 6019d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 60205b57980dSJoe Perches if ($perl_version_ok && 6021d1fe9c09SJoe Perches defined $stat && 6022d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 6023d1fe9c09SJoe Perches if (defined $2 || defined $7) { 6024d7c76ba7SJoe Perches my $call = $1; 6025d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 6026d7c76ba7SJoe Perches my $arg1 = $3; 6027d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 6028d1fe9c09SJoe Perches my $arg2 = $8; 6029d7c76ba7SJoe Perches my $cast; 6030d7c76ba7SJoe Perches 6031d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 6032d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 6033d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 6034d7c76ba7SJoe Perches $cast = $cast1; 6035d7c76ba7SJoe Perches } else { 6036d7c76ba7SJoe Perches $cast = $cast2; 6037d7c76ba7SJoe Perches } 6038d7c76ba7SJoe Perches WARN("MINMAX", 6039d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 6040554e165cSAndy Whitcroft } 6041554e165cSAndy Whitcroft } 6042554e165cSAndy Whitcroft 60434a273195SJoe Perches# check usleep_range arguments 60445b57980dSJoe Perches if ($perl_version_ok && 60454a273195SJoe Perches defined $stat && 60464a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 60474a273195SJoe Perches my $min = $1; 60484a273195SJoe Perches my $max = $7; 60494a273195SJoe Perches if ($min eq $max) { 60504a273195SJoe Perches WARN("USLEEP_RANGE", 60514a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 60524a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 60534a273195SJoe Perches $min > $max) { 60544a273195SJoe Perches WARN("USLEEP_RANGE", 60554a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 60564a273195SJoe Perches } 60574a273195SJoe Perches } 60584a273195SJoe Perches 6059823b794cSJoe Perches# check for naked sscanf 60605b57980dSJoe Perches if ($perl_version_ok && 6061823b794cSJoe Perches defined $stat && 60626c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 6063823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 6064823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 6065823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 6066823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 6067823b794cSJoe Perches $lc = $lc + $linenr; 60682a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6069823b794cSJoe Perches WARN("NAKED_SSCANF", 6070823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 6071823b794cSJoe Perches } 6072823b794cSJoe Perches 6073afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 60745b57980dSJoe Perches if ($perl_version_ok && 6075afc819abSJoe Perches defined $stat && 6076afc819abSJoe Perches $line =~ /\bsscanf\b/) { 6077afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 6078afc819abSJoe Perches $lc = $lc + $linenr; 60792a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6080afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 6081afc819abSJoe Perches my $format = $6; 6082afc819abSJoe Perches my $count = $format =~ tr@%@%@; 6083afc819abSJoe Perches if ($count == 1 && 6084afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 6085afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 6086afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 6087afc819abSJoe Perches } 6088afc819abSJoe Perches } 6089afc819abSJoe Perches } 6090afc819abSJoe Perches 609170dc8a48SJoe Perches# check for new externs in .h files. 609270dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 609370dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 6094d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 609570dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 609670dc8a48SJoe Perches $fix) { 6097194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 609870dc8a48SJoe Perches } 609970dc8a48SJoe Perches } 610070dc8a48SJoe Perches 6101de7d4f0eSAndy Whitcroft# check for new externs in .c files. 6102171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 6103c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 6104171ae1a4SAndy Whitcroft { 6105c45dcabdSAndy Whitcroft my $function_name = $1; 6106c45dcabdSAndy Whitcroft my $paren_space = $2; 6107171ae1a4SAndy Whitcroft 6108171ae1a4SAndy Whitcroft my $s = $stat; 6109171ae1a4SAndy Whitcroft if (defined $cond) { 6110171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 6111171ae1a4SAndy Whitcroft } 6112c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 6113c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 6114c45dcabdSAndy Whitcroft { 6115000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6116000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6117de7d4f0eSAndy Whitcroft } 6118de7d4f0eSAndy Whitcroft 6119171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 6120000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 6121000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 6122171ae1a4SAndy Whitcroft } 61239c9ba34eSAndy Whitcroft 61249c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 61259c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 61269c9ba34eSAndy Whitcroft { 6127000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6128000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6129171ae1a4SAndy Whitcroft } 6130171ae1a4SAndy Whitcroft 6131a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 6132a0ad7596SJoe Perches if (defined $stat && 613325bdda2bSMiles Chen $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 6134ca0d8929SJoe Perches $1 ne "void") { 6135ca0d8929SJoe Perches my $args = trim($1); 6136ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6137ca0d8929SJoe Perches my $arg = trim($1); 6138ca0d8929SJoe Perches if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 6139ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 6140ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6141ca0d8929SJoe Perches } 6142ca0d8929SJoe Perches } 6143ca0d8929SJoe Perches } 6144ca0d8929SJoe Perches 6145a0ad7596SJoe Perches# check for function definitions 61465b57980dSJoe Perches if ($perl_version_ok && 6147a0ad7596SJoe Perches defined $stat && 6148a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6149a0ad7596SJoe Perches $context_function = $1; 6150a0ad7596SJoe Perches 6151a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 6152a0ad7596SJoe Perches my $ok = 0; 6153a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 6154a0ad7596SJoe Perches my $herectx = $here . "\n"; 6155a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6156a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 6157a0ad7596SJoe Perches $herectx .= $rl . "\n"; 6158a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 6159a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 6160a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 6161a0ad7596SJoe Perches } 6162a0ad7596SJoe Perches if (!$ok) { 6163a0ad7596SJoe Perches ERROR("OPEN_BRACE", 6164a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 6165a0ad7596SJoe Perches } 6166a0ad7596SJoe Perches } 6167a0ad7596SJoe Perches 6168de7d4f0eSAndy Whitcroft# checks for new __setup's 6169de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 6170de7d4f0eSAndy Whitcroft my $name = $1; 6171de7d4f0eSAndy Whitcroft 6172de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 6173000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 61748c27ceffSMauro Carvalho Chehab "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr); 6175de7d4f0eSAndy Whitcroft } 6176653d4876SAndy Whitcroft } 61779c0ca6f9SAndy Whitcroft 61789c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 6179caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 6180000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 6181000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 61829c0ca6f9SAndy Whitcroft } 618313214adfSAndy Whitcroft 6184a640d25cSJoe Perches# alloc style 6185a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 61865b57980dSJoe Perches if ($perl_version_ok && 6187a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 6188a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 6189a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 6190a640d25cSJoe Perches } 6191a640d25cSJoe Perches 619260a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 61935b57980dSJoe Perches if ($perl_version_ok && 61941b4a2ed4SJoe Perches defined $stat && 61951b4a2ed4SJoe Perches $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 619660a55369SJoe Perches my $oldfunc = $3; 619760a55369SJoe Perches my $a1 = $4; 619860a55369SJoe Perches my $a2 = $10; 619960a55369SJoe Perches my $newfunc = "kmalloc_array"; 620060a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 620160a55369SJoe Perches my $r1 = $a1; 620260a55369SJoe Perches my $r2 = $a2; 620360a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 620460a55369SJoe Perches $r1 = $a2; 620560a55369SJoe Perches $r2 = $a1; 620660a55369SJoe Perches } 6207e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 6208e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 62091b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 6210e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6211e3d95a2aSTobin C. Harding 6212e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 62131b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 62141b4a2ed4SJoe Perches $cnt == 1 && 6215e367455aSJoe Perches $fix) { 6216194f66fcSJoe 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; 621760a55369SJoe Perches } 621860a55369SJoe Perches } 621960a55369SJoe Perches } 622060a55369SJoe Perches 6221972fdea2SJoe Perches# check for krealloc arg reuse 62225b57980dSJoe Perches if ($perl_version_ok && 62234cab63ceSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ && 62244cab63ceSJoe Perches $1 eq $3) { 6225972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 6226972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 6227972fdea2SJoe Perches } 6228972fdea2SJoe Perches 62295ce59ae0SJoe Perches# check for alloc argument mismatch 62305ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 62315ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 62325ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 62335ce59ae0SJoe Perches } 62345ce59ae0SJoe Perches 6235caf2a54fSJoe Perches# check for multiple semicolons 6236caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 6237d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 6238d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 6239d5e616fcSJoe Perches $fix) { 6240194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 6241d5e616fcSJoe Perches } 6242d1e2ad07SJoe Perches } 6243d1e2ad07SJoe Perches 6244cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 6245cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 6246cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 62470ab90191SJoe Perches my $ull = ""; 62480ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 62490ab90191SJoe Perches if (CHK("BIT_MACRO", 62500ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 62510ab90191SJoe Perches $fix) { 62520ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 62530ab90191SJoe Perches } 62540ab90191SJoe Perches } 62550ab90191SJoe Perches 62562d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 62572d632745SJoe 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*$/) { 62582d632745SJoe Perches my $config = $1; 62592d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 62602d632745SJoe Perches "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) && 62612d632745SJoe Perches $fix) { 62622d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 62632d632745SJoe Perches } 62642d632745SJoe Perches } 62652d632745SJoe Perches 6266e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 6267c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 6268c34c09a8SJoe Perches my $has_break = 0; 6269c34c09a8SJoe Perches my $has_statement = 0; 6270c34c09a8SJoe Perches my $count = 0; 6271c34c09a8SJoe Perches my $prevline = $linenr; 6272e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 6273c34c09a8SJoe Perches $prevline--; 6274c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 6275c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 6276c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 6277c34c09a8SJoe Perches next if ($fline =~ /^\-/); 6278c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 6279c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 6280c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 6281c34c09a8SJoe Perches $has_statement = 1; 6282c34c09a8SJoe Perches $count++; 6283258f79d5SHeinrich Schuchardt $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/); 6284c34c09a8SJoe Perches } 6285c34c09a8SJoe Perches if (!$has_break && $has_statement) { 6286c34c09a8SJoe Perches WARN("MISSING_BREAK", 6287224236d9SAndrew Morton "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr); 6288c34c09a8SJoe Perches } 6289c34c09a8SJoe Perches } 6290c34c09a8SJoe Perches 6291d1e2ad07SJoe Perches# check for switch/default statements without a break; 62925b57980dSJoe Perches if ($perl_version_ok && 6293d1e2ad07SJoe Perches defined $stat && 6294d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 6295d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 6296e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6297e3d95a2aSTobin C. Harding 6298d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 6299d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 6300caf2a54fSJoe Perches } 6301caf2a54fSJoe Perches 630213214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 6303d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 6304d5e616fcSJoe Perches if (WARN("USE_FUNC", 6305d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 6306d5e616fcSJoe Perches $fix) { 6307194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 6308d5e616fcSJoe Perches } 630913214adfSAndy Whitcroft } 6310773647a0SAndy Whitcroft 631162ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 631262ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 631362ec818fSJoe Perches ERROR("DATE_TIME", 631462ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 631562ec818fSJoe Perches } 631662ec818fSJoe Perches 63172c92488aSJoe Perches# check for use of yield() 63182c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 63192c92488aSJoe Perches WARN("YIELD", 63202c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 63212c92488aSJoe Perches } 63222c92488aSJoe Perches 6323179f8f40SJoe Perches# check for comparisons against true and false 6324179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 6325179f8f40SJoe Perches my $lead = $1; 6326179f8f40SJoe Perches my $arg = $2; 6327179f8f40SJoe Perches my $test = $3; 6328179f8f40SJoe Perches my $otype = $4; 6329179f8f40SJoe Perches my $trail = $5; 6330179f8f40SJoe Perches my $op = "!"; 6331179f8f40SJoe Perches 6332179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 6333179f8f40SJoe Perches 6334179f8f40SJoe Perches my $type = lc($otype); 6335179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 6336179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 6337179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 6338179f8f40SJoe Perches $op = ""; 6339179f8f40SJoe Perches } 6340179f8f40SJoe Perches 6341179f8f40SJoe Perches CHK("BOOL_COMPARISON", 6342179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 6343179f8f40SJoe Perches 6344179f8f40SJoe Perches## maybe suggesting a correct construct would better 6345179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 6346179f8f40SJoe Perches 6347179f8f40SJoe Perches } 6348179f8f40SJoe Perches } 6349179f8f40SJoe Perches 63505d430902SJoe Perches# check for bool bitfields 63515d430902SJoe Perches if ($sline =~ /^.\s+bool\s*$Ident\s*:\s*\d+\s*;/) { 63525d430902SJoe Perches WARN("BOOL_BITFIELD", 63535d430902SJoe Perches "Avoid using bool as bitfield. Prefer bool bitfields as unsigned int or u<8|16|32>\n" . $herecurr); 63545d430902SJoe Perches } 63555d430902SJoe Perches 6356d729593eSJoe Perches# check for bool use in .h files 6357d729593eSJoe Perches if ($realfile =~ /\.h$/ && 6358d729593eSJoe Perches $sline =~ /^.\s+bool\s*$Ident\s*(?::\s*d+\s*)?;/) { 6359d729593eSJoe Perches CHK("BOOL_MEMBER", 6360d729593eSJoe Perches "Avoid using bool structure members because of possible alignment issues - see: https://lkml.org/lkml/2017/11/21/384\n" . $herecurr); 6361d729593eSJoe Perches } 6362d729593eSJoe Perches 63634882720bSThomas Gleixner# check for semaphores initialized locked 63644882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 6365000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 6366000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 6367773647a0SAndy Whitcroft } 63686712d858SJoe Perches 636967d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 637067d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 6371000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 637267d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 6373773647a0SAndy Whitcroft } 63746712d858SJoe Perches 6375ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 6376f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 6377000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 6378ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 6379f3db6639SMichael Ellerman } 63806712d858SJoe Perches 63810f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 6382d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 63836903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 6384d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 6385000d1cc1SJoe Perches WARN("CONST_STRUCT", 6386d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 63872b6db5cbSAndy Whitcroft } 6388773647a0SAndy Whitcroft 6389773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 6390773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 6391773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 6392c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 6393c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 6394171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 6395171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 6396171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 6397773647a0SAndy Whitcroft { 6398000d1cc1SJoe Perches WARN("NR_CPUS", 6399000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 6400773647a0SAndy Whitcroft } 64019c9ba34eSAndy Whitcroft 640252ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 640352ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 640452ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 640552ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 640652ea8506SJoe Perches } 640752ea8506SJoe Perches 6408acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 64095b57980dSJoe Perches if ($perl_version_ok && 6410acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 6411acd9362cSJoe Perches WARN("LIKELY_MISUSE", 6412acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 6413acd9362cSJoe Perches } 6414acd9362cSJoe Perches 6415691d77b6SAndy Whitcroft# whine mightly about in_atomic 6416691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 6417691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 6418000d1cc1SJoe Perches ERROR("IN_ATOMIC", 6419000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 6420f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 6421000d1cc1SJoe Perches WARN("IN_ATOMIC", 6422000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 6423691d77b6SAndy Whitcroft } 6424691d77b6SAndy Whitcroft } 64251704f47bSPeter Zijlstra 64260f5225b0SPeter Zijlstra# check for mutex_trylock_recursive usage 64270f5225b0SPeter Zijlstra if ($line =~ /mutex_trylock_recursive/) { 64280f5225b0SPeter Zijlstra ERROR("LOCKING", 64290f5225b0SPeter Zijlstra "recursive locking is bad, do not use this ever.\n" . $herecurr); 64300f5225b0SPeter Zijlstra } 64310f5225b0SPeter Zijlstra 64321704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 64331704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 64341704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 64351704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 64361704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 64371704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 6438000d1cc1SJoe Perches ERROR("LOCKDEP", 6439000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 64401704f47bSPeter Zijlstra } 64411704f47bSPeter Zijlstra } 644288f8831cSDave Jones 6443b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 6444b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 6445000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 6446000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 644788f8831cSDave Jones } 64482435880fSJoe Perches 644900180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 645000180468SJoe Perches# and whether or not function naming is typical and if 645100180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 64525b57980dSJoe Perches if ($perl_version_ok && 645300180468SJoe Perches defined $stat && 645400180468SJoe 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*\)/) { 645500180468SJoe Perches my $var = $1; 645600180468SJoe Perches my $perms = $2; 645700180468SJoe Perches my $show = $3; 645800180468SJoe Perches my $store = $4; 645900180468SJoe Perches my $octal_perms = perms_to_octal($perms); 646000180468SJoe Perches if ($show =~ /^${var}_show$/ && 646100180468SJoe Perches $store =~ /^${var}_store$/ && 646200180468SJoe Perches $octal_perms eq "0644") { 646300180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 646400180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 646500180468SJoe Perches $fix) { 646600180468SJoe 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})/; 646700180468SJoe Perches } 646800180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 646900180468SJoe Perches $store =~ /^NULL$/ && 647000180468SJoe Perches $octal_perms eq "0444") { 647100180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 647200180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 647300180468SJoe Perches $fix) { 647400180468SJoe 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})/; 647500180468SJoe Perches } 647600180468SJoe Perches } elsif ($show =~ /^NULL$/ && 647700180468SJoe Perches $store =~ /^${var}_store$/ && 647800180468SJoe Perches $octal_perms eq "0200") { 647900180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 648000180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 648100180468SJoe Perches $fix) { 648200180468SJoe 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})/; 648300180468SJoe Perches } 648400180468SJoe Perches } elsif ($octal_perms eq "0644" || 648500180468SJoe Perches $octal_perms eq "0444" || 648600180468SJoe Perches $octal_perms eq "0200") { 648700180468SJoe Perches my $newshow = "$show"; 648800180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 648900180468SJoe Perches my $newstore = $store; 649000180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 649100180468SJoe Perches my $rename = ""; 649200180468SJoe Perches if ($show ne $newshow) { 649300180468SJoe Perches $rename .= " '$show' to '$newshow'"; 649400180468SJoe Perches } 649500180468SJoe Perches if ($store ne $newstore) { 649600180468SJoe Perches $rename .= " '$store' to '$newstore'"; 649700180468SJoe Perches } 649800180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 649900180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 650000180468SJoe Perches } else { 650100180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 650200180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 650300180468SJoe Perches } 650400180468SJoe Perches } 650500180468SJoe Perches 6506515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 6507515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 650873121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 650973121534SJoe Perches# specific definition of not visible in sysfs. 651073121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 651173121534SJoe Perches# use the default permissions 65125b57980dSJoe Perches if ($perl_version_ok && 6513459cf0aeSJoe Perches defined $stat && 6514515a235eSJoe Perches $line =~ /$mode_perms_search/) { 65152435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 65162435880fSJoe Perches my $func = $entry->[0]; 65172435880fSJoe Perches my $arg_pos = $entry->[1]; 65182435880fSJoe Perches 6519459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 6520459cf0aeSJoe Perches $lc = $lc + $linenr; 65212a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6522459cf0aeSJoe Perches 65232435880fSJoe Perches my $skip_args = ""; 65242435880fSJoe Perches if ($arg_pos > 1) { 65252435880fSJoe Perches $arg_pos--; 65262435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 65272435880fSJoe Perches } 6528f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 6529459cf0aeSJoe Perches if ($stat =~ /$test/) { 65302435880fSJoe Perches my $val = $1; 65312435880fSJoe Perches $val = $6 if ($skip_args ne ""); 653273121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 653373121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 653473121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 65352435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 6536459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 6537f90774e1SJoe Perches } 6538f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6539c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6540459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 65412435880fSJoe Perches } 6542459cf0aeSJoe Perches } 6543459cf0aeSJoe Perches } 6544459cf0aeSJoe Perches } 6545459cf0aeSJoe Perches 6546459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 6547bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 654800180468SJoe Perches my $oval = $1; 654900180468SJoe Perches my $octal = perms_to_octal($oval); 6550f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 6551459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 6552f90774e1SJoe Perches $fix) { 655300180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 65542435880fSJoe Perches } 655513214adfSAndy Whitcroft } 65565a6d20ceSBjorn Andersson 65575a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 65585a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 65595a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 65605a6d20ceSBjorn Andersson my $valid_licenses = qr{ 65615a6d20ceSBjorn Andersson GPL| 65625a6d20ceSBjorn Andersson GPL\ v2| 65635a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 65645a6d20ceSBjorn Andersson Dual\ BSD/GPL| 65655a6d20ceSBjorn Andersson Dual\ MIT/GPL| 65665a6d20ceSBjorn Andersson Dual\ MPL/GPL| 65675a6d20ceSBjorn Andersson Proprietary 65685a6d20ceSBjorn Andersson }x; 65695a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 65705a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 65715a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 65725a6d20ceSBjorn Andersson } 65735a6d20ceSBjorn Andersson } 6574515a235eSJoe Perches } 657513214adfSAndy Whitcroft 657613214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 657713214adfSAndy Whitcroft # so just keep quiet. 657813214adfSAndy Whitcroft if ($#rawlines == -1) { 657913214adfSAndy Whitcroft exit(0); 65800a920b5bSAndy Whitcroft } 65810a920b5bSAndy Whitcroft 65828905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 65838905a67cSAndy Whitcroft # things that appear to be patches. 65848905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 65858905a67cSAndy Whitcroft exit(0); 65868905a67cSAndy Whitcroft } 65878905a67cSAndy Whitcroft 65888905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 65898905a67cSAndy Whitcroft # just keep quiet. 65908905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 65918905a67cSAndy Whitcroft exit(0); 65928905a67cSAndy Whitcroft } 65938905a67cSAndy Whitcroft 6594a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 6595000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6596000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 65970a920b5bSAndy Whitcroft } 6598cd261496SGeert Uytterhoeven if ($is_patch && $has_commit_log && $chk_signoff) { 6599cd261496SGeert Uytterhoeven if ($signoff == 0) { 6600000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6601000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 6602cd261496SGeert Uytterhoeven } elsif (!$authorsignoff) { 6603cd261496SGeert Uytterhoeven WARN("NO_AUTHOR_SIGN_OFF", 6604cd261496SGeert Uytterhoeven "Missing Signed-off-by: line by nominal patch author '$author'\n"); 6605cd261496SGeert Uytterhoeven } 66060a920b5bSAndy Whitcroft } 66070a920b5bSAndy Whitcroft 6608f0a594c1SAndy Whitcroft print report_dump(); 660913214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 661013214adfSAndy Whitcroft print "$filename " if ($summary_file); 66116c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 66126c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 66136c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 66146c72ffaaSAndy Whitcroft } 66158905a67cSAndy Whitcroft 6616d2c0a235SAndy Whitcroft if ($quiet == 0) { 6617ef212196SJoe Perches # If there were any defects found and not already fixing them 6618ef212196SJoe Perches if (!$clean and !$fix) { 6619ef212196SJoe Perches print << "EOM" 6620ef212196SJoe Perches 6621ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 6622ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 6623ef212196SJoe PerchesEOM 6624ef212196SJoe Perches } 6625d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 6626d2c0a235SAndy Whitcroft # then suggest that. 6627d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 6628b0781216SMike Frysinger $rpt_cleaners = 0; 6629d8469f16SJoe Perches print << "EOM" 6630d8469f16SJoe Perches 6631d8469f16SJoe PerchesNOTE: Whitespace errors detected. 6632d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 6633d8469f16SJoe PerchesEOM 6634d2c0a235SAndy Whitcroft } 6635d2c0a235SAndy Whitcroft } 6636d2c0a235SAndy Whitcroft 6637d752fcc8SJoe Perches if ($clean == 0 && $fix && 6638d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 6639d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 66409624b8d6SJoe Perches my $newfile = $filename; 66419624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 66423705ce5bSJoe Perches my $linecount = 0; 66433705ce5bSJoe Perches my $f; 66443705ce5bSJoe Perches 6645d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 6646d752fcc8SJoe Perches 66473705ce5bSJoe Perches open($f, '>', $newfile) 66483705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 66493705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 66503705ce5bSJoe Perches $linecount++; 66513705ce5bSJoe Perches if ($file) { 66523705ce5bSJoe Perches if ($linecount > 3) { 66533705ce5bSJoe Perches $fixed_line =~ s/^\+//; 66543705ce5bSJoe Perches print $f $fixed_line . "\n"; 66553705ce5bSJoe Perches } 66563705ce5bSJoe Perches } else { 66573705ce5bSJoe Perches print $f $fixed_line . "\n"; 66583705ce5bSJoe Perches } 66593705ce5bSJoe Perches } 66603705ce5bSJoe Perches close($f); 66613705ce5bSJoe Perches 66623705ce5bSJoe Perches if (!$quiet) { 66633705ce5bSJoe Perches print << "EOM"; 6664d8469f16SJoe Perches 66653705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 66663705ce5bSJoe Perches 66673705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 66683705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 66693705ce5bSJoe Perches 66703705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 66713705ce5bSJoe PerchesNo warranties, expressed or implied... 66723705ce5bSJoe PerchesEOM 66733705ce5bSJoe Perches } 66743705ce5bSJoe Perches } 66753705ce5bSJoe Perches 6676d8469f16SJoe Perches if ($quiet == 0) { 6677d8469f16SJoe Perches print "\n"; 6678d8469f16SJoe Perches if ($clean == 1) { 6679d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 6680d8469f16SJoe Perches } else { 6681d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 66820a920b5bSAndy Whitcroft } 66830a920b5bSAndy Whitcroft } 66840a920b5bSAndy Whitcroft return $clean; 66850a920b5bSAndy Whitcroft} 6686