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"; 6498005e8cSVadim Bendeburymy $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE 6577f5b10aSHannes Eder 6677f5b10aSHannes Edersub help { 6777f5b10aSHannes Eder my ($exitcode) = @_; 6877f5b10aSHannes Eder 6977f5b10aSHannes Eder print << "EOM"; 7077f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 7177f5b10aSHannes EderVersion: $V 7277f5b10aSHannes Eder 7377f5b10aSHannes EderOptions: 7477f5b10aSHannes Eder -q, --quiet quiet 7577f5b10aSHannes Eder --no-tree run without a kernel tree 7677f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 7777f5b10aSHannes Eder --patch treat FILE as patchfile (default) 7877f5b10aSHannes Eder --emacs emacs compile window format 7977f5b10aSHannes Eder --terse one line per report 8034d8815fSJoe Perches --showfile emit diffed file position, not input file position 814a593c34SDu, Changbin -g, --git treat FILE as a single commit or git revision range 824a593c34SDu, Changbin single git commit with: 834a593c34SDu, Changbin <rev> 844a593c34SDu, Changbin <rev>^ 854a593c34SDu, Changbin <rev>~n 864a593c34SDu, Changbin multiple git commits with: 874a593c34SDu, Changbin <rev1>..<rev2> 884a593c34SDu, Changbin <rev1>...<rev2> 894a593c34SDu, Changbin <rev>-<count> 904a593c34SDu, Changbin git merges are ignored 9177f5b10aSHannes Eder -f, --file treat FILE as regular source file 9277f5b10aSHannes Eder --subjective, --strict enable more subjective tests 933beb42ecSJoe Perches --list-types list the possible message types 9491bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 95000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 963beb42ecSJoe Perches --show-types show the specific message type in the output 976cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 9856193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 9977f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 10077f5b10aSHannes Eder --no-summary suppress the per-file summary 10177f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 10277f5b10aSHannes Eder --summary-file include the filename in summary 10377f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 10477f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 10577f5b10aSHannes Eder is all off) 10677f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 10777f5b10aSHannes Eder literally 1083705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 1093705ce5bSJoe Perches If correctable single-line errors exist, create 1103705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 1113705ce5bSJoe Perches with potential errors corrected to the preferred 1123705ce5bSJoe Perches checkpatch style 1139624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 1149624b8d6SJoe Perches Is the same as --fix, but overwrites the input 1159624b8d6SJoe Perches file. It's your fault if there's no backup or git 116d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 117d62a201fSDave Hansen runtime errors. 118ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 119f1a63678SMaxim Uvarov (default:/usr/share/codespell/dictionary.txt) 120ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 12175ad8c57SJerome Forissier --typedefsfile Read additional types from this file 122737c0767SJohn Brooks --color[=WHEN] Use colors 'always', 'never', or only when output 123737c0767SJohn Brooks is a terminal ('auto'). Default is 'auto'. 12477f5b10aSHannes Eder -h, --help, --version display this help and exit 12577f5b10aSHannes Eder 12677f5b10aSHannes EderWhen FILE is - read standard input. 12777f5b10aSHannes EderEOM 12877f5b10aSHannes Eder 12977f5b10aSHannes Eder exit($exitcode); 13077f5b10aSHannes Eder} 13177f5b10aSHannes Eder 1323beb42ecSJoe Perchessub uniq { 1333beb42ecSJoe Perches my %seen; 1343beb42ecSJoe Perches return grep { !$seen{$_}++ } @_; 1353beb42ecSJoe Perches} 1363beb42ecSJoe Perches 1373beb42ecSJoe Perchessub list_types { 1383beb42ecSJoe Perches my ($exitcode) = @_; 1393beb42ecSJoe Perches 1403beb42ecSJoe Perches my $count = 0; 1413beb42ecSJoe Perches 1423beb42ecSJoe Perches local $/ = undef; 1433beb42ecSJoe Perches 1443beb42ecSJoe Perches open(my $script, '<', abs_path($P)) or 1453beb42ecSJoe Perches die "$P: Can't read '$P' $!\n"; 1463beb42ecSJoe Perches 1473beb42ecSJoe Perches my $text = <$script>; 1483beb42ecSJoe Perches close($script); 1493beb42ecSJoe Perches 1503beb42ecSJoe Perches my @types = (); 1510547fa58SJean Delvare # Also catch when type or level is passed through a variable 1520547fa58SJean Delvare for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) { 1533beb42ecSJoe Perches push (@types, $_); 1543beb42ecSJoe Perches } 1553beb42ecSJoe Perches @types = sort(uniq(@types)); 1563beb42ecSJoe Perches print("#\tMessage type\n\n"); 1573beb42ecSJoe Perches foreach my $type (@types) { 1583beb42ecSJoe Perches print(++$count . "\t" . $type . "\n"); 1593beb42ecSJoe Perches } 1603beb42ecSJoe Perches 1613beb42ecSJoe Perches exit($exitcode); 1623beb42ecSJoe Perches} 1633beb42ecSJoe Perches 164000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 165000d1cc1SJoe Perchesif (-f $conf) { 166000d1cc1SJoe Perches my @conf_args; 167000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 168000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 169000d1cc1SJoe Perches 170000d1cc1SJoe Perches while (<$conffile>) { 171000d1cc1SJoe Perches my $line = $_; 172000d1cc1SJoe Perches 173000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 174000d1cc1SJoe Perches $line =~ s/^\s*//g; 175000d1cc1SJoe Perches $line =~ s/\s+/ /g; 176000d1cc1SJoe Perches 177000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 178000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 179000d1cc1SJoe Perches 180000d1cc1SJoe Perches my @words = split(" ", $line); 181000d1cc1SJoe Perches foreach my $word (@words) { 182000d1cc1SJoe Perches last if ($word =~ m/^#/); 183000d1cc1SJoe Perches push (@conf_args, $word); 184000d1cc1SJoe Perches } 185000d1cc1SJoe Perches } 186000d1cc1SJoe Perches close($conffile); 187000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 188000d1cc1SJoe Perches} 189000d1cc1SJoe Perches 190737c0767SJohn Brooks# Perl's Getopt::Long allows options to take optional arguments after a space. 191737c0767SJohn Brooks# Prevent --color by itself from consuming other arguments 192737c0767SJohn Brooksforeach (@ARGV) { 193737c0767SJohn Brooks if ($_ eq "--color" || $_ eq "-color") { 194737c0767SJohn Brooks $_ = "--color=$color"; 195737c0767SJohn Brooks } 196737c0767SJohn Brooks} 197737c0767SJohn Brooks 1980a920b5bSAndy WhitcroftGetOptions( 1996c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 2000a920b5bSAndy Whitcroft 'tree!' => \$tree, 2010a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 2020a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 2036c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 2048905a67cSAndy Whitcroft 'terse!' => \$terse, 20534d8815fSJoe Perches 'showfile!' => \$showfile, 20677f5b10aSHannes Eder 'f|file!' => \$file, 2074a593c34SDu, Changbin 'g|git!' => \$git, 2086c72ffaaSAndy Whitcroft 'subjective!' => \$check, 2096c72ffaaSAndy Whitcroft 'strict!' => \$check, 210000d1cc1SJoe Perches 'ignore=s' => \@ignore, 21191bfe484SJoe Perches 'types=s' => \@use, 212000d1cc1SJoe Perches 'show-types!' => \$show_types, 2133beb42ecSJoe Perches 'list-types!' => \$list_types, 2146cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 21556193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 2166c72ffaaSAndy Whitcroft 'root=s' => \$root, 2178905a67cSAndy Whitcroft 'summary!' => \$summary, 2188905a67cSAndy Whitcroft 'mailback!' => \$mailback, 21913214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 2203705ce5bSJoe Perches 'fix!' => \$fix, 2219624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 222d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 223c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 224773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 225ebfd7d62SJoe Perches 'codespell!' => \$codespell, 226ebfd7d62SJoe Perches 'codespellfile=s' => \$codespellfile, 22775ad8c57SJerome Forissier 'typedefsfile=s' => \$typedefsfile, 228737c0767SJohn Brooks 'color=s' => \$color, 229737c0767SJohn Brooks 'no-color' => \$color, #keep old behaviors of -nocolor 230737c0767SJohn Brooks 'nocolor' => \$color, #keep old behaviors of -nocolor 23177f5b10aSHannes Eder 'h|help' => \$help, 23277f5b10aSHannes Eder 'version' => \$help 23377f5b10aSHannes Eder) or help(1); 23477f5b10aSHannes Eder 23577f5b10aSHannes Ederhelp(0) if ($help); 2360a920b5bSAndy Whitcroft 2373beb42ecSJoe Percheslist_types(0) if ($list_types); 2383beb42ecSJoe Perches 2399624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 2402ac73b4fSJoe Perches$check_orig = $check; 2419624b8d6SJoe Perches 2420a920b5bSAndy Whitcroftmy $exit = 0; 2430a920b5bSAndy Whitcroft 2445b57980dSJoe Perchesmy $perl_version_ok = 1; 245d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 2465b57980dSJoe Perches $perl_version_ok = 0; 247d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 2485b57980dSJoe Perches exit(1) if (!$ignore_perl_version); 249d62a201fSDave Hansen} 250d62a201fSDave Hansen 25145107ff6SAllen Hubbe#if no filenames are given, push '-' to read patch from stdin 2520a920b5bSAndy Whitcroftif ($#ARGV < 0) { 25345107ff6SAllen Hubbe push(@ARGV, '-'); 2540a920b5bSAndy Whitcroft} 2550a920b5bSAndy Whitcroft 256737c0767SJohn Brooksif ($color =~ /^[01]$/) { 257737c0767SJohn Brooks $color = !$color; 258737c0767SJohn Brooks} elsif ($color =~ /^always$/i) { 259737c0767SJohn Brooks $color = 1; 260737c0767SJohn Brooks} elsif ($color =~ /^never$/i) { 261737c0767SJohn Brooks $color = 0; 262737c0767SJohn Brooks} elsif ($color =~ /^auto$/i) { 263737c0767SJohn Brooks $color = (-t STDOUT); 264737c0767SJohn Brooks} else { 265737c0767SJohn Brooks die "Invalid color mode: $color\n"; 266737c0767SJohn Brooks} 267737c0767SJohn Brooks 26891bfe484SJoe Perchessub hash_save_array_words { 26991bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 27091bfe484SJoe Perches 27191bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 27291bfe484SJoe Perches foreach my $word (@array) { 273000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 274000d1cc1SJoe Perches $word =~ s/^\s*//g; 275000d1cc1SJoe Perches $word =~ s/\s+/ /g; 276000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 277000d1cc1SJoe Perches 278000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 279000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 280000d1cc1SJoe Perches 28191bfe484SJoe Perches $hashRef->{$word}++; 282000d1cc1SJoe Perches } 28391bfe484SJoe Perches} 28491bfe484SJoe Perches 28591bfe484SJoe Perchessub hash_show_words { 28691bfe484SJoe Perches my ($hashRef, $prefix) = @_; 28791bfe484SJoe Perches 2883c816e49SJoe Perches if (keys %$hashRef) { 289d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 29058cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 29191bfe484SJoe Perches print " $word"; 29291bfe484SJoe Perches } 293d8469f16SJoe Perches print "\n"; 29491bfe484SJoe Perches } 29591bfe484SJoe Perches} 29691bfe484SJoe Perches 29791bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 29891bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 299000d1cc1SJoe Perches 300c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 301c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 3027429c690SAndy Whitcroftmy $dbg_type = 0; 303a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 304c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 30521caa13cSAndy Whitcroft ## no critic 30621caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 30721caa13cSAndy Whitcroft die "$@" if ($@); 308c2fdda0dSAndy Whitcroft} 309c2fdda0dSAndy Whitcroft 310d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 311d2c0a235SAndy Whitcroft 3128905a67cSAndy Whitcroftif ($terse) { 3138905a67cSAndy Whitcroft $emacs = 1; 3148905a67cSAndy Whitcroft $quiet++; 3158905a67cSAndy Whitcroft} 3168905a67cSAndy Whitcroft 3176c72ffaaSAndy Whitcroftif ($tree) { 3186c72ffaaSAndy Whitcroft if (defined $root) { 3196c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 3206c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 3216c72ffaaSAndy Whitcroft } 3226c72ffaaSAndy Whitcroft } else { 3236c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 3246c72ffaaSAndy Whitcroft $root = '.'; 3256c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 3266c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 3276c72ffaaSAndy Whitcroft $root = $1; 3286c72ffaaSAndy Whitcroft } 3296c72ffaaSAndy Whitcroft } 3306c72ffaaSAndy Whitcroft 3316c72ffaaSAndy Whitcroft if (!defined $root) { 3320a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 3330a920b5bSAndy Whitcroft exit(2); 3340a920b5bSAndy Whitcroft } 3356c72ffaaSAndy Whitcroft} 3366c72ffaaSAndy Whitcroft 3376c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 3386c72ffaaSAndy Whitcroft 3392ceb532bSAndy Whitcroftour $Ident = qr{ 3402ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 3412ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 3422ceb532bSAndy Whitcroft }x; 3436c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 3446c72ffaaSAndy Whitcroftour $Sparse = qr{ 3456c72ffaaSAndy Whitcroft __user| 3466c72ffaaSAndy Whitcroft __kernel| 3476c72ffaaSAndy Whitcroft __force| 3486c72ffaaSAndy Whitcroft __iomem| 3496c72ffaaSAndy Whitcroft __must_check| 350417495edSAndy Whitcroft __kprobes| 351165e72a6SSven Eckelmann __ref| 35233aa4597SGeert Uytterhoeven __refconst| 35333aa4597SGeert Uytterhoeven __refdata| 354ad315455SBoqun Feng __rcu| 355ad315455SBoqun Feng __private 3566c72ffaaSAndy Whitcroft }x; 357e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 358e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 359e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 360e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 361e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 3628716de38SJoe Perches 36352131292SWolfram Sang# Notes to $Attribute: 36452131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 3656c72ffaaSAndy Whitcroftour $Attribute = qr{ 3666c72ffaaSAndy Whitcroft const| 36703f1df7dSJoe Perches __percpu| 36803f1df7dSJoe Perches __nocast| 36903f1df7dSJoe Perches __safe| 37046d832f5SMichael S. Tsirkin __bitwise| 37103f1df7dSJoe Perches __packed__| 37203f1df7dSJoe Perches __packed2__| 37303f1df7dSJoe Perches __naked| 37403f1df7dSJoe Perches __maybe_unused| 37503f1df7dSJoe Perches __always_unused| 37603f1df7dSJoe Perches __noreturn| 37703f1df7dSJoe Perches __used| 37803f1df7dSJoe Perches __cold| 379e23ef1f3SJoe Perches __pure| 38003f1df7dSJoe Perches __noclone| 38103f1df7dSJoe Perches __deprecated| 3826c72ffaaSAndy Whitcroft __read_mostly| 383c5967e98SJoe Perches __ro_after_init| 3846c72ffaaSAndy Whitcroft __kprobes| 3858716de38SJoe Perches $InitAttribute| 38624e1d81aSAndy Whitcroft ____cacheline_aligned| 38724e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 3885fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 3895fe3af11SAndy Whitcroft __weak 3906c72ffaaSAndy Whitcroft }x; 391c45dcabdSAndy Whitcroftour $Modifier; 39291cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 3936c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 3946c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 3956c72ffaaSAndy Whitcroft 39695e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 39795e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 39895e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 39995e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 4002435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 401c0a5c898SJoe Perchesour $String = qr{"[X\t]*"}; 402326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 403326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 404326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 40574349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 4062435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 407326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 408447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 40923f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 4106c72ffaaSAndy Whitcroftour $Operators = qr{ 4116c72ffaaSAndy Whitcroft <=|>=|==|!=| 4126c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 41323f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 4146c72ffaaSAndy Whitcroft }x; 4156c72ffaaSAndy Whitcroft 41691cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 41791cb5195SJoe Perches 418ab7e23f3SJoe Perchesour $BasicType; 4198905a67cSAndy Whitcroftour $NonptrType; 4201813087dSJoe Perchesour $NonptrTypeMisordered; 4218716de38SJoe Perchesour $NonptrTypeWithAttr; 4228905a67cSAndy Whitcroftour $Type; 4231813087dSJoe Perchesour $TypeMisordered; 4248905a67cSAndy Whitcroftour $Declare; 4251813087dSJoe Perchesour $DeclareMisordered; 4268905a67cSAndy Whitcroft 42715662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 42815662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 429171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 430171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 431171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 432171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 433171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 434171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 435171ae1a4SAndy Whitcroft}x; 436171ae1a4SAndy Whitcroft 43715662b3eSJoe Perchesour $UTF8 = qr{ 43815662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 43915662b3eSJoe Perches | $NON_ASCII_UTF8 44015662b3eSJoe Perches}x; 44115662b3eSJoe Perches 442e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 443021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 444021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 445021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 446021158b4SJoe Perches)}; 447e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 448fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 4498ed22cadSAndy Whitcroft atomic_t 4508ed22cadSAndy Whitcroft)}; 451e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 452e6176fa4SJoe Perches $typeC99Typedefs\b| 453e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 454e6176fa4SJoe Perches $typeKernelTypedefs\b 455e6176fa4SJoe Perches)}; 4568ed22cadSAndy Whitcroft 4576d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 4586d32f7a3SJoe Perches 459691e669bSJoe Perchesour $logFunctions = qr{(?x: 460758d7aadSMiles Chen printk(?:_ratelimited|_once|_deferred_once|_deferred|)| 4617d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 46287bd499aSJoe Perches TP_printk| 4636e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 464b0531722SJoe Perches panic| 46506668727SJoe Perches MODULE_[A-Z_]+| 46606668727SJoe Perches seq_vprintf|seq_printf|seq_puts 467691e669bSJoe Perches)}; 468691e669bSJoe Perches 469e29a70f1SJoe Perchesour $allocFunctions = qr{(?x: 470e29a70f1SJoe Perches (?:(?:devm_)? 471e29a70f1SJoe Perches (?:kv|k|v)[czm]alloc(?:_node|_array)? | 472e29a70f1SJoe Perches kstrdup(?:_const)? | 473e29a70f1SJoe Perches kmemdup(?:_nul)?) | 474e29a70f1SJoe Perches (?:\w+)?alloc_skb(?:ip_align)? | 475e29a70f1SJoe Perches # dev_alloc_skb/netdev_alloc_skb, et al 476e29a70f1SJoe Perches dma_alloc_coherent 477e29a70f1SJoe Perches)}; 478e29a70f1SJoe Perches 47920112475SJoe Perchesour $signature_tags = qr{(?xi: 48020112475SJoe Perches Signed-off-by:| 481d499480cSJorge Ramirez-Ortiz Co-developed-by:| 48220112475SJoe Perches Acked-by:| 48320112475SJoe Perches Tested-by:| 48420112475SJoe Perches Reviewed-by:| 48520112475SJoe Perches Reported-by:| 4868543ae12SMugunthan V N Suggested-by:| 48720112475SJoe Perches To:| 48820112475SJoe Perches Cc: 48920112475SJoe Perches)}; 49020112475SJoe Perches 4911813087dSJoe Perchesour @typeListMisordered = ( 4921813087dSJoe Perches qr{char\s+(?:un)?signed}, 4931813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 4941813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 4951813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 4961813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 4971813087dSJoe Perches qr{short\s+(?:un)?signed}, 4981813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 4991813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 5001813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 5011813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 5021813087dSJoe Perches qr{int\s+(?:un)?signed}, 5031813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 5041813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 5051813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 5061813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 5071813087dSJoe Perches qr{long\s+(?:un)?signed}, 5081813087dSJoe Perches); 5091813087dSJoe Perches 5108905a67cSAndy Whitcroftour @typeList = ( 5118905a67cSAndy Whitcroft qr{void}, 5120c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 5130c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 5140c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 5150c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 5160c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 5170c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 5180c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 5190c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 5200c773d9dSJoe Perches qr{(?:un)?signed}, 5218905a67cSAndy Whitcroft qr{float}, 5228905a67cSAndy Whitcroft qr{double}, 5238905a67cSAndy Whitcroft qr{bool}, 5248905a67cSAndy Whitcroft qr{struct\s+$Ident}, 5258905a67cSAndy Whitcroft qr{union\s+$Ident}, 5268905a67cSAndy Whitcroft qr{enum\s+$Ident}, 5278905a67cSAndy Whitcroft qr{${Ident}_t}, 5288905a67cSAndy Whitcroft qr{${Ident}_handler}, 5298905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 5301813087dSJoe Perches @typeListMisordered, 5318905a67cSAndy Whitcroft); 532938224b5SJoe Perches 533938224b5SJoe Perchesour $C90_int_types = qr{(?x: 534938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 535938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 536938224b5SJoe Perches long\s+long\s+(?:un)?signed| 537938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 538938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 539938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 540938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 541938224b5SJoe Perches 542938224b5SJoe Perches long\s+int\s+(?:un)?signed| 543938224b5SJoe Perches long\s+(?:un)?signed\s+int| 544938224b5SJoe Perches long\s+(?:un)?signed| 545938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 546938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 547938224b5SJoe Perches int\s+long\s+(?:un)?signed| 548938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 549938224b5SJoe Perches 550938224b5SJoe Perches int\s+(?:un)?signed| 551938224b5SJoe Perches (?:(?:un)?signed\s+)?int 552938224b5SJoe Perches)}; 553938224b5SJoe Perches 554485ff23eSAlex Dowadour @typeListFile = (); 5558716de38SJoe Perchesour @typeListWithAttr = ( 5568716de38SJoe Perches @typeList, 5578716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 5588716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 5598716de38SJoe Perches); 5608716de38SJoe Perches 561c45dcabdSAndy Whitcroftour @modifierList = ( 562c45dcabdSAndy Whitcroft qr{fastcall}, 563c45dcabdSAndy Whitcroft); 564485ff23eSAlex Dowadour @modifierListFile = (); 5658905a67cSAndy Whitcroft 5662435880fSJoe Perchesour @mode_permission_funcs = ( 5672435880fSJoe Perches ["module_param", 3], 5682435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 5692435880fSJoe Perches ["module_param_array_named", 5], 5702435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 5712435880fSJoe Perches ["proc_create(?:_data|)", 2], 572459cf0aeSJoe Perches ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2], 573459cf0aeSJoe Perches ["IIO_DEV_ATTR_[A-Z_]+", 1], 574459cf0aeSJoe Perches ["SENSOR_(?:DEVICE_|)ATTR_2", 2], 575459cf0aeSJoe Perches ["SENSOR_TEMPLATE(?:_2|)", 3], 576459cf0aeSJoe Perches ["__ATTR", 2], 5772435880fSJoe Perches); 5782435880fSJoe Perches 579515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 580515a235eSJoe Perchesour $mode_perms_search = ""; 581515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 582515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 583515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 584515a235eSJoe Perches} 58500180468SJoe Perches$mode_perms_search = "(?:${mode_perms_search})"; 586515a235eSJoe Perches 5879189c7e7SJoe Perchesour %deprecated_apis = ( 5889189c7e7SJoe Perches "synchronize_rcu_bh" => "synchronize_rcu", 5899189c7e7SJoe Perches "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited", 5909189c7e7SJoe Perches "call_rcu_bh" => "call_rcu", 5919189c7e7SJoe Perches "rcu_barrier_bh" => "rcu_barrier", 5929189c7e7SJoe Perches "synchronize_sched" => "synchronize_rcu", 5939189c7e7SJoe Perches "synchronize_sched_expedited" => "synchronize_rcu_expedited", 5949189c7e7SJoe Perches "call_rcu_sched" => "call_rcu", 5959189c7e7SJoe Perches "rcu_barrier_sched" => "rcu_barrier", 5969189c7e7SJoe Perches "get_state_synchronize_sched" => "get_state_synchronize_rcu", 5979189c7e7SJoe Perches "cond_synchronize_sched" => "cond_synchronize_rcu", 5989189c7e7SJoe Perches); 5999189c7e7SJoe Perches 6009189c7e7SJoe Perches#Create a search pattern for all these strings to speed up a loop below 6019189c7e7SJoe Perchesour $deprecated_apis_search = ""; 6029189c7e7SJoe Perchesforeach my $entry (keys %deprecated_apis) { 6039189c7e7SJoe Perches $deprecated_apis_search .= '|' if ($deprecated_apis_search ne ""); 6049189c7e7SJoe Perches $deprecated_apis_search .= $entry; 6059189c7e7SJoe Perches} 6069189c7e7SJoe Perches$deprecated_apis_search = "(?:${deprecated_apis_search})"; 6079189c7e7SJoe Perches 608b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 609b392c64fSJoe Perches S_IWUGO | 610b392c64fSJoe Perches S_IWOTH | 611b392c64fSJoe Perches S_IRWXUGO | 612b392c64fSJoe Perches S_IALLUGO | 613b392c64fSJoe Perches 0[0-7][0-7][2367] 614b392c64fSJoe Perches}x; 615b392c64fSJoe Perches 616f90774e1SJoe Perchesour %mode_permission_string_types = ( 617f90774e1SJoe Perches "S_IRWXU" => 0700, 618f90774e1SJoe Perches "S_IRUSR" => 0400, 619f90774e1SJoe Perches "S_IWUSR" => 0200, 620f90774e1SJoe Perches "S_IXUSR" => 0100, 621f90774e1SJoe Perches "S_IRWXG" => 0070, 622f90774e1SJoe Perches "S_IRGRP" => 0040, 623f90774e1SJoe Perches "S_IWGRP" => 0020, 624f90774e1SJoe Perches "S_IXGRP" => 0010, 625f90774e1SJoe Perches "S_IRWXO" => 0007, 626f90774e1SJoe Perches "S_IROTH" => 0004, 627f90774e1SJoe Perches "S_IWOTH" => 0002, 628f90774e1SJoe Perches "S_IXOTH" => 0001, 629f90774e1SJoe Perches "S_IRWXUGO" => 0777, 630f90774e1SJoe Perches "S_IRUGO" => 0444, 631f90774e1SJoe Perches "S_IWUGO" => 0222, 632f90774e1SJoe Perches "S_IXUGO" => 0111, 633f90774e1SJoe Perches); 634f90774e1SJoe Perches 635f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below 636f90774e1SJoe Perchesour $mode_perms_string_search = ""; 637f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) { 638f90774e1SJoe Perches $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); 639f90774e1SJoe Perches $mode_perms_string_search .= $entry; 640f90774e1SJoe Perches} 64100180468SJoe Perchesour $single_mode_perms_string_search = "(?:${mode_perms_string_search})"; 64200180468SJoe Perchesour $multi_mode_perms_string_search = qr{ 64300180468SJoe Perches ${single_mode_perms_string_search} 64400180468SJoe Perches (?:\s*\|\s*${single_mode_perms_string_search})* 64500180468SJoe Perches}x; 64600180468SJoe Perches 64700180468SJoe Perchessub perms_to_octal { 64800180468SJoe Perches my ($string) = @_; 64900180468SJoe Perches 65000180468SJoe Perches return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/); 65100180468SJoe Perches 65200180468SJoe Perches my $val = ""; 65300180468SJoe Perches my $oval = ""; 65400180468SJoe Perches my $to = 0; 65500180468SJoe Perches my $curpos = 0; 65600180468SJoe Perches my $lastpos = 0; 65700180468SJoe Perches while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) { 65800180468SJoe Perches $curpos = pos($string); 65900180468SJoe Perches my $match = $2; 66000180468SJoe Perches my $omatch = $1; 66100180468SJoe Perches last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos)); 66200180468SJoe Perches $lastpos = $curpos; 66300180468SJoe Perches $to |= $mode_permission_string_types{$match}; 66400180468SJoe Perches $val .= '\s*\|\s*' if ($val ne ""); 66500180468SJoe Perches $val .= $match; 66600180468SJoe Perches $oval .= $omatch; 66700180468SJoe Perches } 66800180468SJoe Perches $oval =~ s/^\s*\|\s*//; 66900180468SJoe Perches $oval =~ s/\s*\|\s*$//; 67000180468SJoe Perches return sprintf("%04o", $to); 67100180468SJoe Perches} 672f90774e1SJoe Perches 6737840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 6747840a94cSWolfram Sang irq| 675cdcee686SSergey Ryazanov memory| 676cdcee686SSergey Ryazanov time| 677cdcee686SSergey Ryazanov reboot 6787840a94cSWolfram Sang)}; 6797840a94cSWolfram Sang# memory.h: ARM has a custom one 6807840a94cSWolfram Sang 68166b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 68266b47b4aSKees Cookmy $misspellings; 68366b47b4aSKees Cookmy %spelling_fix; 68436061e38SJoe Perches 68536061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 68666b47b4aSKees Cook while (<$spelling>) { 68766b47b4aSKees Cook my $line = $_; 68866b47b4aSKees Cook 68966b47b4aSKees Cook $line =~ s/\s*\n?$//g; 69066b47b4aSKees Cook $line =~ s/^\s*//g; 69166b47b4aSKees Cook 69266b47b4aSKees Cook next if ($line =~ m/^\s*#/); 69366b47b4aSKees Cook next if ($line =~ m/^\s*$/); 69466b47b4aSKees Cook 69566b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 69666b47b4aSKees Cook 69766b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 69866b47b4aSKees Cook } 69966b47b4aSKees Cook close($spelling); 70036061e38SJoe Perches} else { 70136061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 70236061e38SJoe Perches} 70366b47b4aSKees Cook 704ebfd7d62SJoe Perchesif ($codespell) { 705ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 706ebfd7d62SJoe Perches while (<$spelling>) { 707ebfd7d62SJoe Perches my $line = $_; 708ebfd7d62SJoe Perches 709ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 710ebfd7d62SJoe Perches $line =~ s/^\s*//g; 711ebfd7d62SJoe Perches 712ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 713ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 714ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 715ebfd7d62SJoe Perches 716ebfd7d62SJoe Perches $line =~ s/,.*$//; 717ebfd7d62SJoe Perches 718ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 719ebfd7d62SJoe Perches 720ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 721ebfd7d62SJoe Perches } 722ebfd7d62SJoe Perches close($spelling); 723ebfd7d62SJoe Perches } else { 724ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 725ebfd7d62SJoe Perches } 726ebfd7d62SJoe Perches} 727ebfd7d62SJoe Perches 728ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 729ebfd7d62SJoe Perches 73075ad8c57SJerome Forissiersub read_words { 73175ad8c57SJerome Forissier my ($wordsRef, $file) = @_; 73275ad8c57SJerome Forissier 73375ad8c57SJerome Forissier if (open(my $words, '<', $file)) { 73475ad8c57SJerome Forissier while (<$words>) { 735bf1fa1daSJoe Perches my $line = $_; 736bf1fa1daSJoe Perches 737bf1fa1daSJoe Perches $line =~ s/\s*\n?$//g; 738bf1fa1daSJoe Perches $line =~ s/^\s*//g; 739bf1fa1daSJoe Perches 740bf1fa1daSJoe Perches next if ($line =~ m/^\s*#/); 741bf1fa1daSJoe Perches next if ($line =~ m/^\s*$/); 742bf1fa1daSJoe Perches if ($line =~ /\s/) { 74375ad8c57SJerome Forissier print("$file: '$line' invalid - ignored\n"); 744bf1fa1daSJoe Perches next; 745bf1fa1daSJoe Perches } 746bf1fa1daSJoe Perches 74775ad8c57SJerome Forissier $$wordsRef .= '|' if ($$wordsRef ne ""); 74875ad8c57SJerome Forissier $$wordsRef .= $line; 749bf1fa1daSJoe Perches } 75075ad8c57SJerome Forissier close($file); 75175ad8c57SJerome Forissier return 1; 752bf1fa1daSJoe Perches } 753bf1fa1daSJoe Perches 75475ad8c57SJerome Forissier return 0; 75575ad8c57SJerome Forissier} 75675ad8c57SJerome Forissier 75775ad8c57SJerome Forissiermy $const_structs = ""; 75875ad8c57SJerome Forissierread_words(\$const_structs, $conststructsfile) 75975ad8c57SJerome Forissier or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 76075ad8c57SJerome Forissier 76175ad8c57SJerome Forissiermy $typeOtherTypedefs = ""; 76275ad8c57SJerome Forissierif (length($typedefsfile)) { 76375ad8c57SJerome Forissier read_words(\$typeOtherTypedefs, $typedefsfile) 76475ad8c57SJerome Forissier or warn "No additional types will be considered - file '$typedefsfile': $!\n"; 76575ad8c57SJerome Forissier} 76675ad8c57SJerome Forissier$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne ""); 76775ad8c57SJerome Forissier 7688905a67cSAndy Whitcroftsub build_types { 769485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 770485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 7711813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 7728716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 773c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 774ab7e23f3SJoe Perches $BasicType = qr{ 775ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 776ab7e23f3SJoe Perches (?:${all}\b) 777ab7e23f3SJoe Perches }x; 7788905a67cSAndy Whitcroft $NonptrType = qr{ 779d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 780cf655043SAndy Whitcroft (?: 7816b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 7828ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 783c45dcabdSAndy Whitcroft (?:${all}\b) 784cf655043SAndy Whitcroft ) 785c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 7868905a67cSAndy Whitcroft }x; 7871813087dSJoe Perches $NonptrTypeMisordered = qr{ 7881813087dSJoe Perches (?:$Modifier\s+|const\s+)* 7891813087dSJoe Perches (?: 7901813087dSJoe Perches (?:${Misordered}\b) 7911813087dSJoe Perches ) 7921813087dSJoe Perches (?:\s+$Modifier|\s+const)* 7931813087dSJoe Perches }x; 7948716de38SJoe Perches $NonptrTypeWithAttr = qr{ 7958716de38SJoe Perches (?:$Modifier\s+|const\s+)* 7968716de38SJoe Perches (?: 7978716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 7988716de38SJoe Perches (?:$typeTypedefs\b)| 7998716de38SJoe Perches (?:${allWithAttr}\b) 8008716de38SJoe Perches ) 8018716de38SJoe Perches (?:\s+$Modifier|\s+const)* 8028716de38SJoe Perches }x; 8038905a67cSAndy Whitcroft $Type = qr{ 804c45dcabdSAndy Whitcroft $NonptrType 8051574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 806c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 8078905a67cSAndy Whitcroft }x; 8081813087dSJoe Perches $TypeMisordered = qr{ 8091813087dSJoe Perches $NonptrTypeMisordered 8101813087dSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 8111813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 8121813087dSJoe Perches }x; 81391cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 8141813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 8158905a67cSAndy Whitcroft} 8168905a67cSAndy Whitcroftbuild_types(); 8176c72ffaaSAndy Whitcroft 8187d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 819d1fe9c09SJoe Perches 820d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 821d1fe9c09SJoe Perches# requires at least perl version v5.10.0 822d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 823d1fe9c09SJoe Perches 824d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 8252435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 826c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 8277d2367afSJoe Perches 828f8422308SJoe Perchesour $declaration_macros = qr{(?x: 8293e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 830fe658f94SSteffen Maier (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(| 8313d102fc0SGilad Ben-Yossef (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(| 8323d102fc0SGilad Ben-Yossef (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\( 833f8422308SJoe Perches)}; 834f8422308SJoe Perches 8357d2367afSJoe Perchessub deparenthesize { 8367d2367afSJoe Perches my ($string) = @_; 8377d2367afSJoe Perches return "" if (!defined($string)); 8385b9553abSJoe Perches 8395b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 8405b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 8415b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 8425b9553abSJoe Perches } 8435b9553abSJoe Perches 8447d2367afSJoe Perches $string =~ s@\s+@ @g; 8455b9553abSJoe Perches 8467d2367afSJoe Perches return $string; 8477d2367afSJoe Perches} 8487d2367afSJoe Perches 8493445686aSJoe Perchessub seed_camelcase_file { 8503445686aSJoe Perches my ($file) = @_; 8513445686aSJoe Perches 8523445686aSJoe Perches return if (!(-f $file)); 8533445686aSJoe Perches 8543445686aSJoe Perches local $/; 8553445686aSJoe Perches 8563445686aSJoe Perches open(my $include_file, '<', "$file") 8573445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 8583445686aSJoe Perches my $text = <$include_file>; 8593445686aSJoe Perches close($include_file); 8603445686aSJoe Perches 8613445686aSJoe Perches my @lines = split('\n', $text); 8623445686aSJoe Perches 8633445686aSJoe Perches foreach my $line (@lines) { 8643445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 8653445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 8663445686aSJoe Perches $camelcase{$1} = 1; 86711ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 86811ea516aSJoe Perches $camelcase{$1} = 1; 86911ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 8703445686aSJoe Perches $camelcase{$1} = 1; 8713445686aSJoe Perches } 8723445686aSJoe Perches } 8733445686aSJoe Perches} 8743445686aSJoe Perches 87585b0ee18SJoe Perchessub is_maintained_obsolete { 87685b0ee18SJoe Perches my ($filename) = @_; 87785b0ee18SJoe Perches 878f2c19c2fSJerome Forissier return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 87985b0ee18SJoe Perches 8800616efa4SJoe Perches my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 88185b0ee18SJoe Perches 88285b0ee18SJoe Perches return $status =~ /obsolete/i; 88385b0ee18SJoe Perches} 88485b0ee18SJoe Perches 8853b6e8ac9SJoe Perchessub is_SPDX_License_valid { 8863b6e8ac9SJoe Perches my ($license) = @_; 8873b6e8ac9SJoe Perches 88856294112SJoe Perches return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git")); 8893b6e8ac9SJoe Perches 89056294112SJoe Perches my $root_path = abs_path($root); 89156294112SJoe Perches my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`; 8923b6e8ac9SJoe Perches return 0 if ($status ne ""); 8933b6e8ac9SJoe Perches return 1; 8943b6e8ac9SJoe Perches} 8953b6e8ac9SJoe Perches 8963445686aSJoe Perchesmy $camelcase_seeded = 0; 8973445686aSJoe Perchessub seed_camelcase_includes { 8983445686aSJoe Perches return if ($camelcase_seeded); 8993445686aSJoe Perches 9003445686aSJoe Perches my $files; 901c707a81dSJoe Perches my $camelcase_cache = ""; 902c707a81dSJoe Perches my @include_files = (); 903c707a81dSJoe Perches 904c707a81dSJoe Perches $camelcase_seeded = 1; 905351b2a1fSJoe Perches 9063645e328SRichard Genoud if (-e ".git") { 907351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 908351b2a1fSJoe Perches chomp $git_last_include_commit; 909c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 910c707a81dSJoe Perches } else { 911c707a81dSJoe Perches my $last_mod_date = 0; 912c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 913c707a81dSJoe Perches @include_files = split('\n', $files); 914c707a81dSJoe Perches foreach my $file (@include_files) { 915c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 916c707a81dSJoe Perches localtime((stat $file)[9])); 917c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 918c707a81dSJoe Perches } 919c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 920c707a81dSJoe Perches } 921c707a81dSJoe Perches 922c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 923c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 924c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 925351b2a1fSJoe Perches while (<$camelcase_file>) { 926351b2a1fSJoe Perches chomp; 927351b2a1fSJoe Perches $camelcase{$_} = 1; 928351b2a1fSJoe Perches } 929351b2a1fSJoe Perches close($camelcase_file); 930351b2a1fSJoe Perches 931351b2a1fSJoe Perches return; 932351b2a1fSJoe Perches } 933c707a81dSJoe Perches 9343645e328SRichard Genoud if (-e ".git") { 935c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 936c707a81dSJoe Perches @include_files = split('\n', $files); 9373445686aSJoe Perches } 938c707a81dSJoe Perches 9393445686aSJoe Perches foreach my $file (@include_files) { 9403445686aSJoe Perches seed_camelcase_file($file); 9413445686aSJoe Perches } 942351b2a1fSJoe Perches 943c707a81dSJoe Perches if ($camelcase_cache ne "") { 944351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 945c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 946c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 947351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 948351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 949351b2a1fSJoe Perches } 950351b2a1fSJoe Perches close($camelcase_file); 951351b2a1fSJoe Perches } 9523445686aSJoe Perches} 9533445686aSJoe Perches 954d311cd44SJoe Perchessub git_commit_info { 955d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 956d311cd44SJoe Perches 957d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 958d311cd44SJoe Perches 959d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 960d311cd44SJoe Perches $output =~ s/^\s*//gm; 961d311cd44SJoe Perches my @lines = split("\n", $output); 962d311cd44SJoe Perches 9630d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 9640d7835fcSJoe Perches 965d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 966d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 967d311cd44SJoe Perches# all matching commit ids, but it's very slow... 968d311cd44SJoe Perches# 969d311cd44SJoe Perches# echo "checking commits $1..." 970d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 971d311cd44SJoe Perches# while read line ; do 972d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 973d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 974d311cd44SJoe Perches# done 975d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 976948b133aSHeinrich Schuchardt $id = undef; 977d311cd44SJoe Perches } else { 978d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 979d311cd44SJoe Perches $desc = substr($lines[0], 41); 980d311cd44SJoe Perches } 981d311cd44SJoe Perches 982d311cd44SJoe Perches return ($id, $desc); 983d311cd44SJoe Perches} 984d311cd44SJoe Perches 9856c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 9860a920b5bSAndy Whitcroft 98700df344fSAndy Whitcroftmy @rawlines = (); 988c2fdda0dSAndy Whitcroftmy @lines = (); 9893705ce5bSJoe Perchesmy @fixed = (); 990d752fcc8SJoe Perchesmy @fixed_inserted = (); 991d752fcc8SJoe Perchesmy @fixed_deleted = (); 992194f66fcSJoe Perchesmy $fixlinenr = -1; 993194f66fcSJoe Perches 9944a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 9954a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 9964a593c34SDu, Changbindie "$P: No git repository found\n" if ($git && !-e ".git"); 9974a593c34SDu, Changbin 9984a593c34SDu, Changbinif ($git) { 9994a593c34SDu, Changbin my @commits = (); 10000dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 10014a593c34SDu, Changbin my $git_range; 100228898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 100328898fd1SJoe Perches $git_range = "-$2 $1"; 10044a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 10054a593c34SDu, Changbin $git_range = "$commit_expr"; 10064a593c34SDu, Changbin } else { 10070dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 10080dea9f1eSJoe Perches } 10090dea9f1eSJoe Perches my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 10100dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 101128898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 101228898fd1SJoe Perches next if (!defined($1) || !defined($2)); 10130dea9f1eSJoe Perches my $sha1 = $1; 10140dea9f1eSJoe Perches my $subject = $2; 10150dea9f1eSJoe Perches unshift(@commits, $sha1); 10160dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 10174a593c34SDu, Changbin } 10184a593c34SDu, Changbin } 10194a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 10204a593c34SDu, Changbin @ARGV = @commits; 10214a593c34SDu, Changbin} 10224a593c34SDu, Changbin 1023c2fdda0dSAndy Whitcroftmy $vname; 102498005e8cSVadim Bendebury$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"}; 10256c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 102621caa13cSAndy Whitcroft my $FILE; 10274a593c34SDu, Changbin if ($git) { 10284a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 10294a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 10304a593c34SDu, Changbin } elsif ($file) { 103121caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 10326c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 103321caa13cSAndy Whitcroft } elsif ($filename eq '-') { 103421caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 10356c72ffaaSAndy Whitcroft } else { 103621caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 10376c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 10386c72ffaaSAndy Whitcroft } 1039c2fdda0dSAndy Whitcroft if ($filename eq '-') { 1040c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 10414a593c34SDu, Changbin } elsif ($git) { 10420dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 1043c2fdda0dSAndy Whitcroft } else { 1044c2fdda0dSAndy Whitcroft $vname = $filename; 1045c2fdda0dSAndy Whitcroft } 104621caa13cSAndy Whitcroft while (<$FILE>) { 10470a920b5bSAndy Whitcroft chomp; 104800df344fSAndy Whitcroft push(@rawlines, $_); 10496c72ffaaSAndy Whitcroft } 105021caa13cSAndy Whitcroft close($FILE); 1051d8469f16SJoe Perches 1052d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 1053d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1054d8469f16SJoe Perches print "$vname\n"; 1055d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1056d8469f16SJoe Perches } 1057d8469f16SJoe Perches 1058c2fdda0dSAndy Whitcroft if (!process($filename)) { 10590a920b5bSAndy Whitcroft $exit = 1; 10600a920b5bSAndy Whitcroft } 106100df344fSAndy Whitcroft @rawlines = (); 106213214adfSAndy Whitcroft @lines = (); 10633705ce5bSJoe Perches @fixed = (); 1064d752fcc8SJoe Perches @fixed_inserted = (); 1065d752fcc8SJoe Perches @fixed_deleted = (); 1066194f66fcSJoe Perches $fixlinenr = -1; 1067485ff23eSAlex Dowad @modifierListFile = (); 1068485ff23eSAlex Dowad @typeListFile = (); 1069485ff23eSAlex Dowad build_types(); 10700a920b5bSAndy Whitcroft} 10710a920b5bSAndy Whitcroft 1072d8469f16SJoe Perchesif (!$quiet) { 10733c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 10743c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 10753c816e49SJoe Perches 10765b57980dSJoe Perches if (!$perl_version_ok) { 1077d8469f16SJoe Perches print << "EOM" 1078d8469f16SJoe Perches 1079d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 10805b57980dSJoe Perches An upgrade to at least perl $minimum_perl_version is suggested. 1081d8469f16SJoe PerchesEOM 1082d8469f16SJoe Perches } 1083d8469f16SJoe Perches if ($exit) { 1084d8469f16SJoe Perches print << "EOM" 1085d8469f16SJoe Perches 1086d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 1087d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 1088d8469f16SJoe PerchesEOM 1089d8469f16SJoe Perches } 1090d8469f16SJoe Perches} 1091d8469f16SJoe Perches 10920a920b5bSAndy Whitcroftexit($exit); 10930a920b5bSAndy Whitcroft 10940a920b5bSAndy Whitcroftsub top_of_kernel_tree { 10956c72ffaaSAndy Whitcroft my ($root) = @_; 10966c72ffaaSAndy Whitcroft 10976c72ffaaSAndy Whitcroft my @tree_check = ( 10986c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 10996c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 11006c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 11016c72ffaaSAndy Whitcroft ); 11026c72ffaaSAndy Whitcroft 11036c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 11046c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 11050a920b5bSAndy Whitcroft return 0; 11060a920b5bSAndy Whitcroft } 11076c72ffaaSAndy Whitcroft } 11086c72ffaaSAndy Whitcroft return 1; 11096c72ffaaSAndy Whitcroft} 11100a920b5bSAndy Whitcroft 111120112475SJoe Perchessub parse_email { 111220112475SJoe Perches my ($formatted_email) = @_; 111320112475SJoe Perches 111420112475SJoe Perches my $name = ""; 111520112475SJoe Perches my $address = ""; 111620112475SJoe Perches my $comment = ""; 111720112475SJoe Perches 111820112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 111920112475SJoe Perches $name = $1; 112020112475SJoe Perches $address = $2; 112120112475SJoe Perches $comment = $3 if defined $3; 112220112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 112320112475SJoe Perches $address = $1; 112420112475SJoe Perches $comment = $2 if defined $2; 112520112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 112620112475SJoe Perches $address = $1; 112720112475SJoe Perches $comment = $2 if defined $2; 112885e12066SJoe Perches $formatted_email =~ s/\Q$address\E.*$//; 112920112475SJoe Perches $name = $formatted_email; 11303705ce5bSJoe Perches $name = trim($name); 113120112475SJoe Perches $name =~ s/^\"|\"$//g; 113220112475SJoe Perches # If there's a name left after stripping spaces and 113320112475SJoe Perches # leading quotes, and the address doesn't have both 113420112475SJoe Perches # leading and trailing angle brackets, the address 113520112475SJoe Perches # is invalid. ie: 113620112475SJoe Perches # "joe smith [email protected]" bad 113720112475SJoe Perches # "joe smith <[email protected]" bad 113820112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 113920112475SJoe Perches $name = ""; 114020112475SJoe Perches $address = ""; 114120112475SJoe Perches $comment = ""; 114220112475SJoe Perches } 114320112475SJoe Perches } 114420112475SJoe Perches 11453705ce5bSJoe Perches $name = trim($name); 114620112475SJoe Perches $name =~ s/^\"|\"$//g; 11473705ce5bSJoe Perches $address = trim($address); 114820112475SJoe Perches $address =~ s/^\<|\>$//g; 114920112475SJoe Perches 115020112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 115120112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 115220112475SJoe Perches $name = "\"$name\""; 115320112475SJoe Perches } 115420112475SJoe Perches 115520112475SJoe Perches return ($name, $address, $comment); 115620112475SJoe Perches} 115720112475SJoe Perches 115820112475SJoe Perchessub format_email { 115920112475SJoe Perches my ($name, $address) = @_; 116020112475SJoe Perches 116120112475SJoe Perches my $formatted_email; 116220112475SJoe Perches 11633705ce5bSJoe Perches $name = trim($name); 116420112475SJoe Perches $name =~ s/^\"|\"$//g; 11653705ce5bSJoe Perches $address = trim($address); 116620112475SJoe Perches 116720112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 116820112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 116920112475SJoe Perches $name = "\"$name\""; 117020112475SJoe Perches } 117120112475SJoe Perches 117220112475SJoe Perches if ("$name" eq "") { 117320112475SJoe Perches $formatted_email = "$address"; 117420112475SJoe Perches } else { 117520112475SJoe Perches $formatted_email = "$name <$address>"; 117620112475SJoe Perches } 117720112475SJoe Perches 117820112475SJoe Perches return $formatted_email; 117920112475SJoe Perches} 118020112475SJoe Perches 1181d311cd44SJoe Perchessub which { 1182d311cd44SJoe Perches my ($bin) = @_; 1183d311cd44SJoe Perches 1184d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1185d311cd44SJoe Perches if (-e "$path/$bin") { 1186d311cd44SJoe Perches return "$path/$bin"; 1187d311cd44SJoe Perches } 1188d311cd44SJoe Perches } 1189d311cd44SJoe Perches 1190d311cd44SJoe Perches return ""; 1191d311cd44SJoe Perches} 1192d311cd44SJoe Perches 1193000d1cc1SJoe Perchessub which_conf { 1194000d1cc1SJoe Perches my ($conf) = @_; 1195000d1cc1SJoe Perches 1196000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1197000d1cc1SJoe Perches if (-e "$path/$conf") { 1198000d1cc1SJoe Perches return "$path/$conf"; 1199000d1cc1SJoe Perches } 1200000d1cc1SJoe Perches } 1201000d1cc1SJoe Perches 1202000d1cc1SJoe Perches return ""; 1203000d1cc1SJoe Perches} 1204000d1cc1SJoe Perches 12050a920b5bSAndy Whitcroftsub expand_tabs { 12060a920b5bSAndy Whitcroft my ($str) = @_; 12070a920b5bSAndy Whitcroft 12080a920b5bSAndy Whitcroft my $res = ''; 12090a920b5bSAndy Whitcroft my $n = 0; 12100a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 12110a920b5bSAndy Whitcroft if ($c eq "\t") { 12120a920b5bSAndy Whitcroft $res .= ' '; 12130a920b5bSAndy Whitcroft $n++; 12140a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 12150a920b5bSAndy Whitcroft $res .= ' '; 12160a920b5bSAndy Whitcroft } 12170a920b5bSAndy Whitcroft next; 12180a920b5bSAndy Whitcroft } 12190a920b5bSAndy Whitcroft $res .= $c; 12200a920b5bSAndy Whitcroft $n++; 12210a920b5bSAndy Whitcroft } 12220a920b5bSAndy Whitcroft 12230a920b5bSAndy Whitcroft return $res; 12240a920b5bSAndy Whitcroft} 12256c72ffaaSAndy Whitcroftsub copy_spacing { 1226773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 12276c72ffaaSAndy Whitcroft return $res; 12286c72ffaaSAndy Whitcroft} 12290a920b5bSAndy Whitcroft 12304a0df2efSAndy Whitcroftsub line_stats { 12314a0df2efSAndy Whitcroft my ($line) = @_; 12324a0df2efSAndy Whitcroft 12334a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 12344a0df2efSAndy Whitcroft $line =~ s/^.//; 12354a0df2efSAndy Whitcroft $line = expand_tabs($line); 12364a0df2efSAndy Whitcroft 12374a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 12384a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 12394a0df2efSAndy Whitcroft 12404a0df2efSAndy Whitcroft return (length($line), length($white)); 12414a0df2efSAndy Whitcroft} 12424a0df2efSAndy Whitcroft 1243773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1244773647a0SAndy Whitcroft 1245773647a0SAndy Whitcroftsub sanitise_line_reset { 1246773647a0SAndy Whitcroft my ($in_comment) = @_; 1247773647a0SAndy Whitcroft 1248773647a0SAndy Whitcroft if ($in_comment) { 1249773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1250773647a0SAndy Whitcroft } else { 1251773647a0SAndy Whitcroft $sanitise_quote = ''; 1252773647a0SAndy Whitcroft } 1253773647a0SAndy Whitcroft} 125400df344fSAndy Whitcroftsub sanitise_line { 125500df344fSAndy Whitcroft my ($line) = @_; 125600df344fSAndy Whitcroft 125700df344fSAndy Whitcroft my $res = ''; 125800df344fSAndy Whitcroft my $l = ''; 125900df344fSAndy Whitcroft 1260c2fdda0dSAndy Whitcroft my $qlen = 0; 1261773647a0SAndy Whitcroft my $off = 0; 1262773647a0SAndy Whitcroft my $c; 126300df344fSAndy Whitcroft 1264773647a0SAndy Whitcroft # Always copy over the diff marker. 1265773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1266773647a0SAndy Whitcroft 1267773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1268773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1269773647a0SAndy Whitcroft 12708d2e11b2SClaudio Fontana # Comments we are whacking completely including the begin 1271773647a0SAndy Whitcroft # and end, all to $;. 1272773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1273773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1274773647a0SAndy Whitcroft 1275773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1276773647a0SAndy Whitcroft $off++; 127700df344fSAndy Whitcroft next; 1278773647a0SAndy Whitcroft } 127981bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1280773647a0SAndy Whitcroft $sanitise_quote = ''; 1281773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1282773647a0SAndy Whitcroft $off++; 1283773647a0SAndy Whitcroft next; 1284773647a0SAndy Whitcroft } 1285113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1286113f04a8SDaniel Walker $sanitise_quote = '//'; 1287113f04a8SDaniel Walker 1288113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1289113f04a8SDaniel Walker $off++; 1290113f04a8SDaniel Walker next; 1291113f04a8SDaniel Walker } 1292773647a0SAndy Whitcroft 1293773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1294773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1295773647a0SAndy Whitcroft $c eq "\\") { 1296773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1297773647a0SAndy Whitcroft $off++; 1298773647a0SAndy Whitcroft next; 1299773647a0SAndy Whitcroft } 1300773647a0SAndy Whitcroft # Regular quotes. 1301773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1302773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1303773647a0SAndy Whitcroft $sanitise_quote = $c; 1304773647a0SAndy Whitcroft 1305773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1306773647a0SAndy Whitcroft next; 1307773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1308773647a0SAndy Whitcroft $sanitise_quote = ''; 130900df344fSAndy Whitcroft } 131000df344fSAndy Whitcroft } 1311773647a0SAndy Whitcroft 1312fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1313773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1314773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1315113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1316113f04a8SDaniel Walker substr($res, $off, 1, $;); 1317773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1318773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 131900df344fSAndy Whitcroft } else { 1320773647a0SAndy Whitcroft substr($res, $off, 1, $c); 132100df344fSAndy Whitcroft } 1322c2fdda0dSAndy Whitcroft } 1323c2fdda0dSAndy Whitcroft 1324113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1325113f04a8SDaniel Walker $sanitise_quote = ''; 1326113f04a8SDaniel Walker } 1327113f04a8SDaniel Walker 1328c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1329c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1330c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1331c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1332c2fdda0dSAndy Whitcroft 1333c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1334c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1335c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1336c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1337c2fdda0dSAndy Whitcroft } 1338c2fdda0dSAndy Whitcroft 1339dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1340dadf680dSJoe Perches my $match = $1; 1341dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1342dadf680dSJoe Perches } 1343dadf680dSJoe Perches 134400df344fSAndy Whitcroft return $res; 134500df344fSAndy Whitcroft} 134600df344fSAndy Whitcroft 1347a6962d72SJoe Perchessub get_quoted_string { 1348a6962d72SJoe Perches my ($line, $rawline) = @_; 1349a6962d72SJoe Perches 1350478b1799SJoe Perches return "" if (!defined($line) || !defined($rawline)); 135133acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1352a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1353a6962d72SJoe Perches} 1354a6962d72SJoe Perches 13558905a67cSAndy Whitcroftsub ctx_statement_block { 13568905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 13578905a67cSAndy Whitcroft my $line = $linenr - 1; 13588905a67cSAndy Whitcroft my $blk = ''; 13598905a67cSAndy Whitcroft my $soff = $off; 13608905a67cSAndy Whitcroft my $coff = $off - 1; 1361773647a0SAndy Whitcroft my $coff_set = 0; 13628905a67cSAndy Whitcroft 136313214adfSAndy Whitcroft my $loff = 0; 136413214adfSAndy Whitcroft 13658905a67cSAndy Whitcroft my $type = ''; 13668905a67cSAndy Whitcroft my $level = 0; 1367a2750645SAndy Whitcroft my @stack = (); 1368cf655043SAndy Whitcroft my $p; 13698905a67cSAndy Whitcroft my $c; 13708905a67cSAndy Whitcroft my $len = 0; 137113214adfSAndy Whitcroft 137213214adfSAndy Whitcroft my $remainder; 13738905a67cSAndy Whitcroft while (1) { 1374a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1375a2750645SAndy Whitcroft 1376773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 13778905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 13788905a67cSAndy Whitcroft # context. 13798905a67cSAndy Whitcroft if ($off >= $len) { 13808905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1381dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1382c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 13838905a67cSAndy Whitcroft $remain--; 138413214adfSAndy Whitcroft $loff = $len; 1385c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 13868905a67cSAndy Whitcroft $len = length($blk); 13878905a67cSAndy Whitcroft $line++; 13888905a67cSAndy Whitcroft last; 13898905a67cSAndy Whitcroft } 13908905a67cSAndy Whitcroft # Bail if there is no further context. 13918905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 139213214adfSAndy Whitcroft if ($off >= $len) { 13938905a67cSAndy Whitcroft last; 13948905a67cSAndy Whitcroft } 1395f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1396f74bd194SAndy Whitcroft $level++; 1397f74bd194SAndy Whitcroft $type = '#'; 1398f74bd194SAndy Whitcroft } 13998905a67cSAndy Whitcroft } 1400cf655043SAndy Whitcroft $p = $c; 14018905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 140213214adfSAndy Whitcroft $remainder = substr($blk, $off); 14038905a67cSAndy Whitcroft 1404773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 14054635f4fbSAndy Whitcroft 14064635f4fbSAndy Whitcroft # Handle nested #if/#else. 14074635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 14084635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 14094635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 14104635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 14114635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 14124635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 14134635f4fbSAndy Whitcroft } 14144635f4fbSAndy Whitcroft 14158905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 14168905a67cSAndy Whitcroft # outermost level. 14178905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 14188905a67cSAndy Whitcroft last; 14198905a67cSAndy Whitcroft } 14208905a67cSAndy Whitcroft 142113214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1422773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1423773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1424773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1425773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1426773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1427773647a0SAndy Whitcroft $coff_set = 1; 1428773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1429773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 143013214adfSAndy Whitcroft } 143113214adfSAndy Whitcroft 14328905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 14338905a67cSAndy Whitcroft $level++; 14348905a67cSAndy Whitcroft $type = '('; 14358905a67cSAndy Whitcroft } 14368905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 14378905a67cSAndy Whitcroft $level--; 14388905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 14398905a67cSAndy Whitcroft 14408905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 14418905a67cSAndy Whitcroft $coff = $off; 1442773647a0SAndy Whitcroft $coff_set = 1; 1443773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 14448905a67cSAndy Whitcroft } 14458905a67cSAndy Whitcroft } 14468905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 14478905a67cSAndy Whitcroft $level++; 14488905a67cSAndy Whitcroft $type = '{'; 14498905a67cSAndy Whitcroft } 14508905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 14518905a67cSAndy Whitcroft $level--; 14528905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 14538905a67cSAndy Whitcroft 14548905a67cSAndy Whitcroft if ($level == 0) { 1455b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1456b998e001SPatrick Pannuto $off++; 1457b998e001SPatrick Pannuto } 14588905a67cSAndy Whitcroft last; 14598905a67cSAndy Whitcroft } 14608905a67cSAndy Whitcroft } 1461f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1462f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1463f74bd194SAndy Whitcroft $level--; 1464f74bd194SAndy Whitcroft $type = ''; 1465f74bd194SAndy Whitcroft $off++; 1466f74bd194SAndy Whitcroft last; 1467f74bd194SAndy Whitcroft } 14688905a67cSAndy Whitcroft $off++; 14698905a67cSAndy Whitcroft } 1470a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 147113214adfSAndy Whitcroft if ($off == $len) { 1472a3bb97a7SAndy Whitcroft $loff = $len + 1; 147313214adfSAndy Whitcroft $line++; 147413214adfSAndy Whitcroft $remain--; 147513214adfSAndy Whitcroft } 14768905a67cSAndy Whitcroft 14778905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 14788905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 14798905a67cSAndy Whitcroft 14808905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 14818905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 14828905a67cSAndy Whitcroft 1483773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 148413214adfSAndy Whitcroft 148513214adfSAndy Whitcroft return ($statement, $condition, 148613214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 148713214adfSAndy Whitcroft} 148813214adfSAndy Whitcroft 1489cf655043SAndy Whitcroftsub statement_lines { 1490cf655043SAndy Whitcroft my ($stmt) = @_; 1491cf655043SAndy Whitcroft 1492cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1493cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1494cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1495cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1496cf655043SAndy Whitcroft 1497cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1498cf655043SAndy Whitcroft 1499cf655043SAndy Whitcroft return $#stmt_lines + 2; 1500cf655043SAndy Whitcroft} 1501cf655043SAndy Whitcroft 1502cf655043SAndy Whitcroftsub statement_rawlines { 1503cf655043SAndy Whitcroft my ($stmt) = @_; 1504cf655043SAndy Whitcroft 1505cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1506cf655043SAndy Whitcroft 1507cf655043SAndy Whitcroft return $#stmt_lines + 2; 1508cf655043SAndy Whitcroft} 1509cf655043SAndy Whitcroft 1510cf655043SAndy Whitcroftsub statement_block_size { 1511cf655043SAndy Whitcroft my ($stmt) = @_; 1512cf655043SAndy Whitcroft 1513cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1514cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1515cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1516cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1517cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1518cf655043SAndy Whitcroft 1519cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1520cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1521cf655043SAndy Whitcroft 1522cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1523cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1524cf655043SAndy Whitcroft 1525cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1526cf655043SAndy Whitcroft return $stmt_lines; 1527cf655043SAndy Whitcroft } else { 1528cf655043SAndy Whitcroft return $stmt_statements; 1529cf655043SAndy Whitcroft } 1530cf655043SAndy Whitcroft} 1531cf655043SAndy Whitcroft 153213214adfSAndy Whitcroftsub ctx_statement_full { 153313214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 153413214adfSAndy Whitcroft my ($statement, $condition, $level); 153513214adfSAndy Whitcroft 153613214adfSAndy Whitcroft my (@chunks); 153713214adfSAndy Whitcroft 1538cf655043SAndy Whitcroft # Grab the first conditional/block pair. 153913214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 154013214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1541773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 154213214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1543cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1544cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1545cf655043SAndy Whitcroft } 1546cf655043SAndy Whitcroft 1547cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1548cf655043SAndy Whitcroft # could continue the statement. 1549cf655043SAndy Whitcroft for (;;) { 155013214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 155113214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1552cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1553773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1554cf655043SAndy Whitcroft #print "C: push\n"; 1555cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 155613214adfSAndy Whitcroft } 155713214adfSAndy Whitcroft 155813214adfSAndy Whitcroft return ($level, $linenr, @chunks); 15598905a67cSAndy Whitcroft} 15608905a67cSAndy Whitcroft 15614a0df2efSAndy Whitcroftsub ctx_block_get { 1562f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 15634a0df2efSAndy Whitcroft my $line; 15644a0df2efSAndy Whitcroft my $start = $linenr - 1; 15654a0df2efSAndy Whitcroft my $blk = ''; 15664a0df2efSAndy Whitcroft my @o; 15674a0df2efSAndy Whitcroft my @c; 15684a0df2efSAndy Whitcroft my @res = (); 15694a0df2efSAndy Whitcroft 1570f0a594c1SAndy Whitcroft my $level = 0; 15714635f4fbSAndy Whitcroft my @stack = ($level); 157200df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 157300df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 157400df344fSAndy Whitcroft $remain--; 157500df344fSAndy Whitcroft 157600df344fSAndy Whitcroft $blk .= $rawlines[$line]; 15774635f4fbSAndy Whitcroft 15784635f4fbSAndy Whitcroft # Handle nested #if/#else. 157901464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 15804635f4fbSAndy Whitcroft push(@stack, $level); 158101464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 15824635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 158301464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 15844635f4fbSAndy Whitcroft $level = pop(@stack); 15854635f4fbSAndy Whitcroft } 15864635f4fbSAndy Whitcroft 158701464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1588f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1589f0a594c1SAndy Whitcroft if ($off > 0) { 1590f0a594c1SAndy Whitcroft $off--; 1591f0a594c1SAndy Whitcroft next; 1592f0a594c1SAndy Whitcroft } 15934a0df2efSAndy Whitcroft 1594f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1595f0a594c1SAndy Whitcroft $level--; 1596f0a594c1SAndy Whitcroft last if ($level == 0); 1597f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1598f0a594c1SAndy Whitcroft $level++; 1599f0a594c1SAndy Whitcroft } 1600f0a594c1SAndy Whitcroft } 16014a0df2efSAndy Whitcroft 1602f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 160300df344fSAndy Whitcroft push(@res, $rawlines[$line]); 16044a0df2efSAndy Whitcroft } 16054a0df2efSAndy Whitcroft 1606f0a594c1SAndy Whitcroft last if ($level == 0); 16074a0df2efSAndy Whitcroft } 16084a0df2efSAndy Whitcroft 1609f0a594c1SAndy Whitcroft return ($level, @res); 16104a0df2efSAndy Whitcroft} 16114a0df2efSAndy Whitcroftsub ctx_block_outer { 16124a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 16134a0df2efSAndy Whitcroft 1614f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1615f0a594c1SAndy Whitcroft return @r; 16164a0df2efSAndy Whitcroft} 16174a0df2efSAndy Whitcroftsub ctx_block { 16184a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 16194a0df2efSAndy Whitcroft 1620f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1621f0a594c1SAndy Whitcroft return @r; 1622653d4876SAndy Whitcroft} 1623653d4876SAndy Whitcroftsub ctx_statement { 1624f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1625f0a594c1SAndy Whitcroft 1626f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1627f0a594c1SAndy Whitcroft return @r; 1628f0a594c1SAndy Whitcroft} 1629f0a594c1SAndy Whitcroftsub ctx_block_level { 1630653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1631653d4876SAndy Whitcroft 1632f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 16334a0df2efSAndy Whitcroft} 16349c0ca6f9SAndy Whitcroftsub ctx_statement_level { 16359c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 16369c0ca6f9SAndy Whitcroft 16379c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 16389c0ca6f9SAndy Whitcroft} 16394a0df2efSAndy Whitcroft 16404a0df2efSAndy Whitcroftsub ctx_locate_comment { 16414a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 16424a0df2efSAndy Whitcroft 16434a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1644beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 16454a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 16464a0df2efSAndy Whitcroft 16474a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 16484a0df2efSAndy Whitcroft # comment. 16494a0df2efSAndy Whitcroft my $in_comment = 0; 16504a0df2efSAndy Whitcroft $current_comment = ''; 16514a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 165200df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 165300df344fSAndy Whitcroft #warn " $line\n"; 16544a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 16554a0df2efSAndy Whitcroft $in_comment = 1; 16564a0df2efSAndy Whitcroft } 16574a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 16584a0df2efSAndy Whitcroft $in_comment = 1; 16594a0df2efSAndy Whitcroft } 16604a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 16614a0df2efSAndy Whitcroft $current_comment = ''; 16624a0df2efSAndy Whitcroft } 16634a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 16644a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 16654a0df2efSAndy Whitcroft $in_comment = 0; 16664a0df2efSAndy Whitcroft } 16674a0df2efSAndy Whitcroft } 16684a0df2efSAndy Whitcroft 16694a0df2efSAndy Whitcroft chomp($current_comment); 16704a0df2efSAndy Whitcroft return($current_comment); 16714a0df2efSAndy Whitcroft} 16724a0df2efSAndy Whitcroftsub ctx_has_comment { 16734a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 16744a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 16754a0df2efSAndy Whitcroft 167600df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 16774a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 16784a0df2efSAndy Whitcroft 16794a0df2efSAndy Whitcroft return ($cmt ne ''); 16804a0df2efSAndy Whitcroft} 16814a0df2efSAndy Whitcroft 16824d001e4dSAndy Whitcroftsub raw_line { 16834d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 16844d001e4dSAndy Whitcroft 16854d001e4dSAndy Whitcroft my $offset = $linenr - 1; 16864d001e4dSAndy Whitcroft $cnt++; 16874d001e4dSAndy Whitcroft 16884d001e4dSAndy Whitcroft my $line; 16894d001e4dSAndy Whitcroft while ($cnt) { 16904d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 16914d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 16924d001e4dSAndy Whitcroft $cnt--; 16934d001e4dSAndy Whitcroft } 16944d001e4dSAndy Whitcroft 16954d001e4dSAndy Whitcroft return $line; 16964d001e4dSAndy Whitcroft} 16974d001e4dSAndy Whitcroft 16982a9f9d85STobin C. Hardingsub get_stat_real { 16992a9f9d85STobin C. Harding my ($linenr, $lc) = @_; 17002a9f9d85STobin C. Harding 17012a9f9d85STobin C. Harding my $stat_real = raw_line($linenr, 0); 17022a9f9d85STobin C. Harding for (my $count = $linenr + 1; $count <= $lc; $count++) { 17032a9f9d85STobin C. Harding $stat_real = $stat_real . "\n" . raw_line($count, 0); 17042a9f9d85STobin C. Harding } 17052a9f9d85STobin C. Harding 17062a9f9d85STobin C. Harding return $stat_real; 17072a9f9d85STobin C. Harding} 17082a9f9d85STobin C. Harding 1709e3d95a2aSTobin C. Hardingsub get_stat_here { 1710e3d95a2aSTobin C. Harding my ($linenr, $cnt, $here) = @_; 1711e3d95a2aSTobin C. Harding 1712e3d95a2aSTobin C. Harding my $herectx = $here . "\n"; 1713e3d95a2aSTobin C. Harding for (my $n = 0; $n < $cnt; $n++) { 1714e3d95a2aSTobin C. Harding $herectx .= raw_line($linenr, $n) . "\n"; 1715e3d95a2aSTobin C. Harding } 1716e3d95a2aSTobin C. Harding 1717e3d95a2aSTobin C. Harding return $herectx; 1718e3d95a2aSTobin C. Harding} 1719e3d95a2aSTobin C. Harding 17200a920b5bSAndy Whitcroftsub cat_vet { 17210a920b5bSAndy Whitcroft my ($vet) = @_; 17229c0ca6f9SAndy Whitcroft my ($res, $coded); 17230a920b5bSAndy Whitcroft 17249c0ca6f9SAndy Whitcroft $res = ''; 17256c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 17266c72ffaaSAndy Whitcroft $res .= $1; 17276c72ffaaSAndy Whitcroft if ($2 ne '') { 17289c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 17296c72ffaaSAndy Whitcroft $res .= $coded; 17306c72ffaaSAndy Whitcroft } 17319c0ca6f9SAndy Whitcroft } 17329c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 17330a920b5bSAndy Whitcroft 17349c0ca6f9SAndy Whitcroft return $res; 17350a920b5bSAndy Whitcroft} 17360a920b5bSAndy Whitcroft 1737c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1738cf655043SAndy Whitcroftmy $av_pending; 1739c2fdda0dSAndy Whitcroftmy @av_paren_type; 17401f65f947SAndy Whitcroftmy $av_pend_colon; 1741c2fdda0dSAndy Whitcroft 1742c2fdda0dSAndy Whitcroftsub annotate_reset { 1743c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1744cf655043SAndy Whitcroft $av_pending = '_'; 1745cf655043SAndy Whitcroft @av_paren_type = ('E'); 17461f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1747c2fdda0dSAndy Whitcroft} 1748c2fdda0dSAndy Whitcroft 17496c72ffaaSAndy Whitcroftsub annotate_values { 17506c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 17516c72ffaaSAndy Whitcroft 17526c72ffaaSAndy Whitcroft my $res; 17531f65f947SAndy Whitcroft my $var = '_' x length($stream); 17546c72ffaaSAndy Whitcroft my $cur = $stream; 17556c72ffaaSAndy Whitcroft 1756c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 17576c72ffaaSAndy Whitcroft 17586c72ffaaSAndy Whitcroft while (length($cur)) { 1759773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1760cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1761171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 17626c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1763c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1764c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1765cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1766c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 17676c72ffaaSAndy Whitcroft } 17686c72ffaaSAndy Whitcroft 1769c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 17709446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 17719446ef56SAndy Whitcroft push(@av_paren_type, $type); 1772addcdceaSAndy Whitcroft $type = 'c'; 17739446ef56SAndy Whitcroft 1774e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1775c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 17766c72ffaaSAndy Whitcroft $type = 'T'; 17776c72ffaaSAndy Whitcroft 1778389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1779389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1780389a2fe5SAndy Whitcroft $type = 'T'; 1781389a2fe5SAndy Whitcroft 1782c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1783171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1784c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1785171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1786171ae1a4SAndy Whitcroft if ($2 ne '') { 1787cf655043SAndy Whitcroft $av_pending = 'N'; 1788171ae1a4SAndy Whitcroft } 1789171ae1a4SAndy Whitcroft $type = 'E'; 1790171ae1a4SAndy Whitcroft 1791c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1792171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1793171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1794171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 17956c72ffaaSAndy Whitcroft 1796c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1797cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1798c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1799cf655043SAndy Whitcroft 1800cf655043SAndy Whitcroft push(@av_paren_type, $type); 1801cf655043SAndy Whitcroft push(@av_paren_type, $type); 1802171ae1a4SAndy Whitcroft $type = 'E'; 1803cf655043SAndy Whitcroft 1804c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1805cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1806cf655043SAndy Whitcroft $av_preprocessor = 1; 1807cf655043SAndy Whitcroft 1808cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1809cf655043SAndy Whitcroft 1810171ae1a4SAndy Whitcroft $type = 'E'; 1811cf655043SAndy Whitcroft 1812c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1813cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1814cf655043SAndy Whitcroft 1815cf655043SAndy Whitcroft $av_preprocessor = 1; 1816cf655043SAndy Whitcroft 1817cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1818cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1819cf655043SAndy Whitcroft pop(@av_paren_type); 1820cf655043SAndy Whitcroft push(@av_paren_type, $type); 1821171ae1a4SAndy Whitcroft $type = 'E'; 18226c72ffaaSAndy Whitcroft 18236c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1824c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 18256c72ffaaSAndy Whitcroft 1826171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1827171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1828171ae1a4SAndy Whitcroft $av_pending = $type; 1829171ae1a4SAndy Whitcroft $type = 'N'; 1830171ae1a4SAndy Whitcroft 18316c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1832c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 18336c72ffaaSAndy Whitcroft if (defined $2) { 1834cf655043SAndy Whitcroft $av_pending = 'V'; 18356c72ffaaSAndy Whitcroft } 18366c72ffaaSAndy Whitcroft $type = 'N'; 18376c72ffaaSAndy Whitcroft 183814b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1839c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 184014b111c1SAndy Whitcroft $av_pending = 'E'; 18416c72ffaaSAndy Whitcroft $type = 'N'; 18426c72ffaaSAndy Whitcroft 18431f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 18441f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 18451f65f947SAndy Whitcroft $av_pend_colon = 'C'; 18461f65f947SAndy Whitcroft $type = 'N'; 18471f65f947SAndy Whitcroft 184814b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1849c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 18506c72ffaaSAndy Whitcroft $type = 'N'; 18516c72ffaaSAndy Whitcroft 18526c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1853c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1854cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1855cf655043SAndy Whitcroft $av_pending = '_'; 18566c72ffaaSAndy Whitcroft $type = 'N'; 18576c72ffaaSAndy Whitcroft 18586c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1859cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1860cf655043SAndy Whitcroft if ($new_type ne '_') { 1861cf655043SAndy Whitcroft $type = $new_type; 1862c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1863c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 18646c72ffaaSAndy Whitcroft } else { 1865c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 18666c72ffaaSAndy Whitcroft } 18676c72ffaaSAndy Whitcroft 1868c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1869c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1870c8cb2ca3SAndy Whitcroft $type = 'V'; 1871cf655043SAndy Whitcroft $av_pending = 'V'; 18726c72ffaaSAndy Whitcroft 18738e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 18748e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 18751f65f947SAndy Whitcroft $av_pend_colon = 'B'; 18768e761b04SAndy Whitcroft } elsif ($type eq 'E') { 18778e761b04SAndy Whitcroft $av_pend_colon = 'L'; 18781f65f947SAndy Whitcroft } 18791f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 18801f65f947SAndy Whitcroft $type = 'V'; 18811f65f947SAndy Whitcroft 18826c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1883c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 18846c72ffaaSAndy Whitcroft $type = 'V'; 18856c72ffaaSAndy Whitcroft 18866c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1887c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 18886c72ffaaSAndy Whitcroft $type = 'N'; 18896c72ffaaSAndy Whitcroft 1890cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1891c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 189213214adfSAndy Whitcroft $type = 'E'; 18931f65f947SAndy Whitcroft $av_pend_colon = 'O'; 189413214adfSAndy Whitcroft 18958e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 18968e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 18978e761b04SAndy Whitcroft $type = 'C'; 18988e761b04SAndy Whitcroft 18991f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 19001f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 19011f65f947SAndy Whitcroft $type = 'N'; 19021f65f947SAndy Whitcroft 19031f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 19041f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 19051f65f947SAndy Whitcroft 19061f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 19071f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 19081f65f947SAndy Whitcroft $type = 'E'; 19091f65f947SAndy Whitcroft } else { 19101f65f947SAndy Whitcroft $type = 'N'; 19111f65f947SAndy Whitcroft } 19121f65f947SAndy Whitcroft $av_pend_colon = 'O'; 19131f65f947SAndy Whitcroft 19148e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 191513214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 19166c72ffaaSAndy Whitcroft $type = 'N'; 19176c72ffaaSAndy Whitcroft 19180d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 191974048ed8SAndy Whitcroft my $variant; 192074048ed8SAndy Whitcroft 192174048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 192274048ed8SAndy Whitcroft if ($type eq 'V') { 192374048ed8SAndy Whitcroft $variant = 'B'; 192474048ed8SAndy Whitcroft } else { 192574048ed8SAndy Whitcroft $variant = 'U'; 192674048ed8SAndy Whitcroft } 192774048ed8SAndy Whitcroft 192874048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 192974048ed8SAndy Whitcroft $type = 'N'; 193074048ed8SAndy Whitcroft 19316c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1932c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 19336c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 19346c72ffaaSAndy Whitcroft $type = 'N'; 19356c72ffaaSAndy Whitcroft } 19366c72ffaaSAndy Whitcroft 19376c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1938c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 19396c72ffaaSAndy Whitcroft } 19406c72ffaaSAndy Whitcroft if (defined $1) { 19416c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 19426c72ffaaSAndy Whitcroft $res .= $type x length($1); 19436c72ffaaSAndy Whitcroft } 19446c72ffaaSAndy Whitcroft } 19456c72ffaaSAndy Whitcroft 19461f65f947SAndy Whitcroft return ($res, $var); 19476c72ffaaSAndy Whitcroft} 19486c72ffaaSAndy Whitcroft 19498905a67cSAndy Whitcroftsub possible { 195013214adfSAndy Whitcroft my ($possible, $line) = @_; 19519a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 19520776e594SAndy Whitcroft ^(?: 19530776e594SAndy Whitcroft $Modifier| 19540776e594SAndy Whitcroft $Storage| 19550776e594SAndy Whitcroft $Type| 19569a974fdbSAndy Whitcroft DEFINE_\S+ 19579a974fdbSAndy Whitcroft )$| 19589a974fdbSAndy Whitcroft ^(?: 19590776e594SAndy Whitcroft goto| 19600776e594SAndy Whitcroft return| 19610776e594SAndy Whitcroft case| 19620776e594SAndy Whitcroft else| 19630776e594SAndy Whitcroft asm|__asm__| 196489a88353SAndy Whitcroft do| 196589a88353SAndy Whitcroft \#| 196689a88353SAndy Whitcroft \#\#| 19679a974fdbSAndy Whitcroft )(?:\s|$)| 19680776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 19699a974fdbSAndy Whitcroft )}x; 19709a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 19719a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1972c45dcabdSAndy Whitcroft # Check for modifiers. 1973c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1974c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1975c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1976c45dcabdSAndy Whitcroft 1977c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1978c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1979d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 19809a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1981d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1982485ff23eSAlex Dowad push(@modifierListFile, $modifier); 1983d2506586SAndy Whitcroft } 19849a974fdbSAndy Whitcroft } 1985c45dcabdSAndy Whitcroft 1986c45dcabdSAndy Whitcroft } else { 198713214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 1988485ff23eSAlex Dowad push(@typeListFile, $possible); 1989c45dcabdSAndy Whitcroft } 19908905a67cSAndy Whitcroft build_types(); 19910776e594SAndy Whitcroft } else { 19920776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 19938905a67cSAndy Whitcroft } 19948905a67cSAndy Whitcroft} 19958905a67cSAndy Whitcroft 19966c72ffaaSAndy Whitcroftmy $prefix = ''; 19976c72ffaaSAndy Whitcroft 1998000d1cc1SJoe Perchessub show_type { 1999cbec18afSJoe Perches my ($type) = @_; 200091bfe484SJoe Perches 2001522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 2002522b837cSAlexey Dobriyan 2003cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 2004cbec18afSJoe Perches 2005cbec18afSJoe Perches return !defined $ignore_type{$type}; 2006000d1cc1SJoe Perches} 2007000d1cc1SJoe Perches 2008f0a594c1SAndy Whitcroftsub report { 2009cbec18afSJoe Perches my ($level, $type, $msg) = @_; 2010cbec18afSJoe Perches 2011cbec18afSJoe Perches if (!show_type($type) || 2012cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 2013773647a0SAndy Whitcroft return 0; 2014773647a0SAndy Whitcroft } 201557230297SJoe Perches my $output = ''; 2016737c0767SJohn Brooks if ($color) { 201757230297SJoe Perches if ($level eq 'ERROR') { 201857230297SJoe Perches $output .= RED; 201957230297SJoe Perches } elsif ($level eq 'WARNING') { 202057230297SJoe Perches $output .= YELLOW; 2021000d1cc1SJoe Perches } else { 202257230297SJoe Perches $output .= GREEN; 2023000d1cc1SJoe Perches } 202457230297SJoe Perches } 202557230297SJoe Perches $output .= $prefix . $level . ':'; 202657230297SJoe Perches if ($show_types) { 2027737c0767SJohn Brooks $output .= BLUE if ($color); 202857230297SJoe Perches $output .= "$type:"; 202957230297SJoe Perches } 2030737c0767SJohn Brooks $output .= RESET if ($color); 203157230297SJoe Perches $output .= ' ' . $msg . "\n"; 203234d8815fSJoe Perches 203334d8815fSJoe Perches if ($showfile) { 203434d8815fSJoe Perches my @lines = split("\n", $output, -1); 203534d8815fSJoe Perches splice(@lines, 1, 1); 203634d8815fSJoe Perches $output = join("\n", @lines); 203734d8815fSJoe Perches } 203857230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 20398905a67cSAndy Whitcroft 204057230297SJoe Perches push(our @report, $output); 2041773647a0SAndy Whitcroft 2042773647a0SAndy Whitcroft return 1; 2043f0a594c1SAndy Whitcroft} 2044cbec18afSJoe Perches 2045f0a594c1SAndy Whitcroftsub report_dump { 204613214adfSAndy Whitcroft our @report; 2047f0a594c1SAndy Whitcroft} 2048000d1cc1SJoe Perches 2049d752fcc8SJoe Perchessub fixup_current_range { 2050d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 2051d752fcc8SJoe Perches 2052d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 2053d752fcc8SJoe Perches my $o = $1; 2054d752fcc8SJoe Perches my $l = $2; 2055d752fcc8SJoe Perches my $no = $o + $offset; 2056d752fcc8SJoe Perches my $nl = $l + $length; 2057d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 2058d752fcc8SJoe Perches } 2059d752fcc8SJoe Perches} 2060d752fcc8SJoe Perches 2061d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 2062d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 2063d752fcc8SJoe Perches 2064d752fcc8SJoe Perches my $range_last_linenr = 0; 2065d752fcc8SJoe Perches my $delta_offset = 0; 2066d752fcc8SJoe Perches 2067d752fcc8SJoe Perches my $old_linenr = 0; 2068d752fcc8SJoe Perches my $new_linenr = 0; 2069d752fcc8SJoe Perches 2070d752fcc8SJoe Perches my $next_insert = 0; 2071d752fcc8SJoe Perches my $next_delete = 0; 2072d752fcc8SJoe Perches 2073d752fcc8SJoe Perches my @lines = (); 2074d752fcc8SJoe Perches 2075d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 2076d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 2077d752fcc8SJoe Perches 2078d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 2079d752fcc8SJoe Perches my $save_line = 1; 2080d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 2081323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2082d752fcc8SJoe Perches $delta_offset = 0; 2083d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2084d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 2085d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 2086d752fcc8SJoe Perches } 2087d752fcc8SJoe Perches 2088d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2089d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 2090d752fcc8SJoe Perches $save_line = 0; 2091d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2092d752fcc8SJoe Perches } 2093d752fcc8SJoe Perches 2094d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2095d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 2096d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 2097d752fcc8SJoe Perches $new_linenr++; 2098d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2099d752fcc8SJoe Perches } 2100d752fcc8SJoe Perches 2101d752fcc8SJoe Perches if ($save_line) { 2102d752fcc8SJoe Perches push(@lines, $line); 2103d752fcc8SJoe Perches $new_linenr++; 2104d752fcc8SJoe Perches } 2105d752fcc8SJoe Perches 2106d752fcc8SJoe Perches $old_linenr++; 2107d752fcc8SJoe Perches } 2108d752fcc8SJoe Perches 2109d752fcc8SJoe Perches return @lines; 2110d752fcc8SJoe Perches} 2111d752fcc8SJoe Perches 2112f2d7e4d4SJoe Perchessub fix_insert_line { 2113f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2114f2d7e4d4SJoe Perches 2115f2d7e4d4SJoe Perches my $inserted = { 2116f2d7e4d4SJoe Perches LINENR => $linenr, 2117f2d7e4d4SJoe Perches LINE => $line, 2118f2d7e4d4SJoe Perches }; 2119f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2120f2d7e4d4SJoe Perches} 2121f2d7e4d4SJoe Perches 2122f2d7e4d4SJoe Perchessub fix_delete_line { 2123f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2124f2d7e4d4SJoe Perches 2125f2d7e4d4SJoe Perches my $deleted = { 2126f2d7e4d4SJoe Perches LINENR => $linenr, 2127f2d7e4d4SJoe Perches LINE => $line, 2128f2d7e4d4SJoe Perches }; 2129f2d7e4d4SJoe Perches 2130f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2131f2d7e4d4SJoe Perches} 2132f2d7e4d4SJoe Perches 2133de7d4f0eSAndy Whitcroftsub ERROR { 2134cbec18afSJoe Perches my ($type, $msg) = @_; 2135cbec18afSJoe Perches 2136cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2137de7d4f0eSAndy Whitcroft our $clean = 0; 21386c72ffaaSAndy Whitcroft our $cnt_error++; 21393705ce5bSJoe Perches return 1; 2140de7d4f0eSAndy Whitcroft } 21413705ce5bSJoe Perches return 0; 2142773647a0SAndy Whitcroft} 2143de7d4f0eSAndy Whitcroftsub WARN { 2144cbec18afSJoe Perches my ($type, $msg) = @_; 2145cbec18afSJoe Perches 2146cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2147de7d4f0eSAndy Whitcroft our $clean = 0; 21486c72ffaaSAndy Whitcroft our $cnt_warn++; 21493705ce5bSJoe Perches return 1; 2150de7d4f0eSAndy Whitcroft } 21513705ce5bSJoe Perches return 0; 2152773647a0SAndy Whitcroft} 2153de7d4f0eSAndy Whitcroftsub CHK { 2154cbec18afSJoe Perches my ($type, $msg) = @_; 2155cbec18afSJoe Perches 2156cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2157de7d4f0eSAndy Whitcroft our $clean = 0; 21586c72ffaaSAndy Whitcroft our $cnt_chk++; 21593705ce5bSJoe Perches return 1; 21606c72ffaaSAndy Whitcroft } 21613705ce5bSJoe Perches return 0; 2162de7d4f0eSAndy Whitcroft} 2163de7d4f0eSAndy Whitcroft 21646ecd9674SAndy Whitcroftsub check_absolute_file { 21656ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 21666ecd9674SAndy Whitcroft my $file = $absolute; 21676ecd9674SAndy Whitcroft 21686ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 21696ecd9674SAndy Whitcroft 21706ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 21716ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 21726ecd9674SAndy Whitcroft if (-f "$root/$file") { 21736ecd9674SAndy Whitcroft ##print "file<$file>\n"; 21746ecd9674SAndy Whitcroft last; 21756ecd9674SAndy Whitcroft } 21766ecd9674SAndy Whitcroft } 21776ecd9674SAndy Whitcroft if (! -f _) { 21786ecd9674SAndy Whitcroft return 0; 21796ecd9674SAndy Whitcroft } 21806ecd9674SAndy Whitcroft 21816ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 21826ecd9674SAndy Whitcroft my $prefix = $absolute; 21836ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 21846ecd9674SAndy Whitcroft 21856ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 21866ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2187000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2188000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 21896ecd9674SAndy Whitcroft } 21906ecd9674SAndy Whitcroft} 21916ecd9674SAndy Whitcroft 21923705ce5bSJoe Perchessub trim { 21933705ce5bSJoe Perches my ($string) = @_; 21943705ce5bSJoe Perches 2195b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2196b34c648bSJoe Perches 2197b34c648bSJoe Perches return $string; 2198b34c648bSJoe Perches} 2199b34c648bSJoe Perches 2200b34c648bSJoe Perchessub ltrim { 2201b34c648bSJoe Perches my ($string) = @_; 2202b34c648bSJoe Perches 2203b34c648bSJoe Perches $string =~ s/^\s+//; 2204b34c648bSJoe Perches 2205b34c648bSJoe Perches return $string; 2206b34c648bSJoe Perches} 2207b34c648bSJoe Perches 2208b34c648bSJoe Perchessub rtrim { 2209b34c648bSJoe Perches my ($string) = @_; 2210b34c648bSJoe Perches 2211b34c648bSJoe Perches $string =~ s/\s+$//; 22123705ce5bSJoe Perches 22133705ce5bSJoe Perches return $string; 22143705ce5bSJoe Perches} 22153705ce5bSJoe Perches 221652ea8506SJoe Perchessub string_find_replace { 221752ea8506SJoe Perches my ($string, $find, $replace) = @_; 221852ea8506SJoe Perches 221952ea8506SJoe Perches $string =~ s/$find/$replace/g; 222052ea8506SJoe Perches 222152ea8506SJoe Perches return $string; 222252ea8506SJoe Perches} 222352ea8506SJoe Perches 22243705ce5bSJoe Perchessub tabify { 22253705ce5bSJoe Perches my ($leading) = @_; 22263705ce5bSJoe Perches 22273705ce5bSJoe Perches my $source_indent = 8; 22283705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 22293705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 22303705ce5bSJoe Perches 22313705ce5bSJoe Perches #convert leading spaces to tabs 22323705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 22333705ce5bSJoe Perches #Remove spaces before a tab 22343705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 22353705ce5bSJoe Perches 22363705ce5bSJoe Perches return "$leading"; 22373705ce5bSJoe Perches} 22383705ce5bSJoe Perches 2239d1fe9c09SJoe Perchessub pos_last_openparen { 2240d1fe9c09SJoe Perches my ($line) = @_; 2241d1fe9c09SJoe Perches 2242d1fe9c09SJoe Perches my $pos = 0; 2243d1fe9c09SJoe Perches 2244d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2245d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2246d1fe9c09SJoe Perches 2247d1fe9c09SJoe Perches my $last_openparen = 0; 2248d1fe9c09SJoe Perches 2249d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2250d1fe9c09SJoe Perches return -1; 2251d1fe9c09SJoe Perches } 2252d1fe9c09SJoe Perches 2253d1fe9c09SJoe Perches my $len = length($line); 2254d1fe9c09SJoe Perches 2255d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2256d1fe9c09SJoe Perches my $string = substr($line, $pos); 2257d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2258d1fe9c09SJoe Perches $pos += length($1) - 1; 2259d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2260d1fe9c09SJoe Perches $last_openparen = $pos; 2261d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2262d1fe9c09SJoe Perches last; 2263d1fe9c09SJoe Perches } 2264d1fe9c09SJoe Perches } 2265d1fe9c09SJoe Perches 226691cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2267d1fe9c09SJoe Perches} 2268d1fe9c09SJoe Perches 22690a920b5bSAndy Whitcroftsub process { 22700a920b5bSAndy Whitcroft my $filename = shift; 22710a920b5bSAndy Whitcroft 22720a920b5bSAndy Whitcroft my $linenr=0; 22730a920b5bSAndy Whitcroft my $prevline=""; 2274c2fdda0dSAndy Whitcroft my $prevrawline=""; 22750a920b5bSAndy Whitcroft my $stashline=""; 2276c2fdda0dSAndy Whitcroft my $stashrawline=""; 22770a920b5bSAndy Whitcroft 22784a0df2efSAndy Whitcroft my $length; 22790a920b5bSAndy Whitcroft my $indent; 22800a920b5bSAndy Whitcroft my $previndent=0; 22810a920b5bSAndy Whitcroft my $stashindent=0; 22820a920b5bSAndy Whitcroft 2283de7d4f0eSAndy Whitcroft our $clean = 1; 22840a920b5bSAndy Whitcroft my $signoff = 0; 2285cd261496SGeert Uytterhoeven my $author = ''; 2286cd261496SGeert Uytterhoeven my $authorsignoff = 0; 22870a920b5bSAndy Whitcroft my $is_patch = 0; 2288133712a2SRob Herring my $is_binding_patch = -1; 228929ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 229015662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 2291ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2292490b292cSJoe Perches my $commit_log_lines = 0; #Number of commit log lines 2293bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 22942a076f40SJoe Perches my $commit_log_long_line = 0; 2295e518e9a5SJoe Perches my $commit_log_has_diff = 0; 229613f1937eSJoe Perches my $reported_maintainer_file = 0; 2297fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2298fa64205dSPasi Savanainen 2299365dd4eaSJoe Perches my $last_blank_line = 0; 23005e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2301365dd4eaSJoe Perches 230213214adfSAndy Whitcroft our @report = (); 23036c72ffaaSAndy Whitcroft our $cnt_lines = 0; 23046c72ffaaSAndy Whitcroft our $cnt_error = 0; 23056c72ffaaSAndy Whitcroft our $cnt_warn = 0; 23066c72ffaaSAndy Whitcroft our $cnt_chk = 0; 23076c72ffaaSAndy Whitcroft 23080a920b5bSAndy Whitcroft # Trace the real file/line as we go. 23090a920b5bSAndy Whitcroft my $realfile = ''; 23100a920b5bSAndy Whitcroft my $realline = 0; 23110a920b5bSAndy Whitcroft my $realcnt = 0; 23120a920b5bSAndy Whitcroft my $here = ''; 231377cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 23140a920b5bSAndy Whitcroft my $in_comment = 0; 2315c2fdda0dSAndy Whitcroft my $comment_edge = 0; 23160a920b5bSAndy Whitcroft my $first_line = 0; 23171e855726SWolfram Sang my $p1_prefix = ''; 23180a920b5bSAndy Whitcroft 231913214adfSAndy Whitcroft my $prev_values = 'E'; 232013214adfSAndy Whitcroft 232113214adfSAndy Whitcroft # suppression flags 2322773647a0SAndy Whitcroft my %suppress_ifbraces; 2323170d3a22SAndy Whitcroft my %suppress_whiletrailers; 23242b474a1aSAndy Whitcroft my %suppress_export; 23253e469cdcSAndy Whitcroft my $suppress_statement = 0; 2326653d4876SAndy Whitcroft 23277e51f197SJoe Perches my %signatures = (); 2328323c1260SJoe Perches 2329c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2330de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2331c2fdda0dSAndy Whitcroft # 2332de7d4f0eSAndy Whitcroft my @setup_docs = (); 2333de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2334773647a0SAndy Whitcroft 2335d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2336d8b07710SJoe Perches 23379f3a8992SRob Herring my $checklicenseline = 1; 23389f3a8992SRob Herring 2339773647a0SAndy Whitcroft sanitise_line_reset(); 2340c2fdda0dSAndy Whitcroft my $line; 2341c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2342773647a0SAndy Whitcroft $linenr++; 2343773647a0SAndy Whitcroft $line = $rawline; 2344c2fdda0dSAndy Whitcroft 23453705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 23463705ce5bSJoe Perches 2347773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2348de7d4f0eSAndy Whitcroft $setup_docs = 0; 23498c27ceffSMauro Carvalho Chehab if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) { 2350de7d4f0eSAndy Whitcroft $setup_docs = 1; 2351de7d4f0eSAndy Whitcroft } 2352773647a0SAndy Whitcroft #next; 2353de7d4f0eSAndy Whitcroft } 235474fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2355773647a0SAndy Whitcroft $realline=$1-1; 2356773647a0SAndy Whitcroft if (defined $2) { 2357773647a0SAndy Whitcroft $realcnt=$3+1; 2358773647a0SAndy Whitcroft } else { 2359773647a0SAndy Whitcroft $realcnt=1+1; 2360773647a0SAndy Whitcroft } 2361c45dcabdSAndy Whitcroft $in_comment = 0; 2362773647a0SAndy Whitcroft 2363773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2364773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2365773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2366773647a0SAndy Whitcroft # at context start. 2367773647a0SAndy Whitcroft my $edge; 236801fa9147SAndy Whitcroft my $cnt = $realcnt; 236901fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 237001fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 237101fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 237201fa9147SAndy Whitcroft $cnt--; 237301fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2374721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2375fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2376fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2377fae17daeSAndy Whitcroft ($edge) = $1; 2378fae17daeSAndy Whitcroft last; 2379fae17daeSAndy Whitcroft } 2380773647a0SAndy Whitcroft } 2381773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2382773647a0SAndy Whitcroft $in_comment = 1; 2383773647a0SAndy Whitcroft } 2384773647a0SAndy Whitcroft 2385773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2386773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2387773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2388773647a0SAndy Whitcroft if (!defined $edge && 238983242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2390773647a0SAndy Whitcroft { 2391773647a0SAndy Whitcroft $in_comment = 1; 2392773647a0SAndy Whitcroft } 2393773647a0SAndy Whitcroft 2394773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2395773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2396773647a0SAndy Whitcroft 2397171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2398773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2399171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2400773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2401773647a0SAndy Whitcroft } 2402773647a0SAndy Whitcroft push(@lines, $line); 2403773647a0SAndy Whitcroft 2404773647a0SAndy Whitcroft if ($realcnt > 1) { 2405773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2406773647a0SAndy Whitcroft } else { 2407773647a0SAndy Whitcroft $realcnt = 0; 2408773647a0SAndy Whitcroft } 2409773647a0SAndy Whitcroft 2410773647a0SAndy Whitcroft #print "==>$rawline\n"; 2411773647a0SAndy Whitcroft #print "-->$line\n"; 2412de7d4f0eSAndy Whitcroft 2413de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2414de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2415de7d4f0eSAndy Whitcroft } 2416de7d4f0eSAndy Whitcroft } 2417de7d4f0eSAndy Whitcroft 24186c72ffaaSAndy Whitcroft $prefix = ''; 24196c72ffaaSAndy Whitcroft 2420773647a0SAndy Whitcroft $realcnt = 0; 2421773647a0SAndy Whitcroft $linenr = 0; 2422194f66fcSJoe Perches $fixlinenr = -1; 24230a920b5bSAndy Whitcroft foreach my $line (@lines) { 24240a920b5bSAndy Whitcroft $linenr++; 2425194f66fcSJoe Perches $fixlinenr++; 24261b5539b1SJoe Perches my $sline = $line; #copy of $line 24271b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 24280a920b5bSAndy Whitcroft 2429c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 24306c72ffaaSAndy Whitcroft 243112c253abSJoe Perches# check if it's a mode change, rename or start of a patch 243212c253abSJoe Perches if (!$in_commit_log && 243312c253abSJoe Perches ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 243412c253abSJoe Perches ($line =~ /^rename (?:from|to) \S+\s*$/ || 243512c253abSJoe Perches $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 243612c253abSJoe Perches $is_patch = 1; 243712c253abSJoe Perches } 243812c253abSJoe Perches 24390a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2440e518e9a5SJoe Perches if (!$in_commit_log && 244174fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 244274fd4f34SJoe Perches my $context = $4; 24430a920b5bSAndy Whitcroft $is_patch = 1; 24444a0df2efSAndy Whitcroft $first_line = $linenr + 1; 24450a920b5bSAndy Whitcroft $realline=$1-1; 24460a920b5bSAndy Whitcroft if (defined $2) { 24470a920b5bSAndy Whitcroft $realcnt=$3+1; 24480a920b5bSAndy Whitcroft } else { 24490a920b5bSAndy Whitcroft $realcnt=1+1; 24500a920b5bSAndy Whitcroft } 2451c2fdda0dSAndy Whitcroft annotate_reset(); 245213214adfSAndy Whitcroft $prev_values = 'E'; 245313214adfSAndy Whitcroft 2454773647a0SAndy Whitcroft %suppress_ifbraces = (); 2455170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 24562b474a1aSAndy Whitcroft %suppress_export = (); 24573e469cdcSAndy Whitcroft $suppress_statement = 0; 245874fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 245974fd4f34SJoe Perches $context_function = $1; 246074fd4f34SJoe Perches } else { 246174fd4f34SJoe Perches undef $context_function; 246274fd4f34SJoe Perches } 24630a920b5bSAndy Whitcroft next; 24640a920b5bSAndy Whitcroft 24654a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 24664a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 24674a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2468773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 24690a920b5bSAndy Whitcroft $realline++; 2470d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 24710a920b5bSAndy Whitcroft 24724a0df2efSAndy Whitcroft # Measure the line length and indent. 2473c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 24740a920b5bSAndy Whitcroft 24750a920b5bSAndy Whitcroft # Track the previous line. 24760a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 24770a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2478c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2479c2fdda0dSAndy Whitcroft 2480773647a0SAndy Whitcroft #warn "line<$line>\n"; 24816c72ffaaSAndy Whitcroft 2482d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2483d8aaf121SAndy Whitcroft $realcnt--; 24840a920b5bSAndy Whitcroft } 24850a920b5bSAndy Whitcroft 2486cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2487cc77cdcaSAndy Whitcroft 24886c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 24896c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2490773647a0SAndy Whitcroft 24912ac73b4fSJoe Perches my $found_file = 0; 2492773647a0SAndy Whitcroft # extract the filename as it passes 24933bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 24943bf9a009SRabin Vincent $realfile = $1; 24952b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2496270c49a0SJoe Perches $in_commit_log = 0; 24972ac73b4fSJoe Perches $found_file = 1; 24983bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2499773647a0SAndy Whitcroft $realfile = $1; 25002b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2501270c49a0SJoe Perches $in_commit_log = 0; 25021e855726SWolfram Sang 25031e855726SWolfram Sang $p1_prefix = $1; 2504e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2505e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2506000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2507000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 25081e855726SWolfram Sang } 2509773647a0SAndy Whitcroft 2510c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2511000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2512000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2513773647a0SAndy Whitcroft } 25142ac73b4fSJoe Perches $found_file = 1; 25152ac73b4fSJoe Perches } 25162ac73b4fSJoe Perches 251734d8815fSJoe Perches#make up the handle for any error we report on this line 251834d8815fSJoe Perches if ($showfile) { 251934d8815fSJoe Perches $prefix = "$realfile:$realline: " 252034d8815fSJoe Perches } elsif ($emacs) { 25217d3a9f67SJoe Perches if ($file) { 25227d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 25237d3a9f67SJoe Perches } else { 252434d8815fSJoe Perches $prefix = "$filename:$linenr: "; 252534d8815fSJoe Perches } 25267d3a9f67SJoe Perches } 252734d8815fSJoe Perches 25282ac73b4fSJoe Perches if ($found_file) { 252985b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 253085b0ee18SJoe Perches WARN("OBSOLETE", 253185b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 253285b0ee18SJoe Perches } 25337bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 25342ac73b4fSJoe Perches $check = 1; 25352ac73b4fSJoe Perches } else { 25362ac73b4fSJoe Perches $check = $check_orig; 25372ac73b4fSJoe Perches } 25389f3a8992SRob Herring $checklicenseline = 1; 2539133712a2SRob Herring 2540133712a2SRob Herring if ($realfile !~ /^MAINTAINERS/) { 2541133712a2SRob Herring my $last_binding_patch = $is_binding_patch; 2542133712a2SRob Herring 2543133712a2SRob Herring $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@; 2544133712a2SRob Herring 2545133712a2SRob Herring if (($last_binding_patch != -1) && 2546133712a2SRob Herring ($last_binding_patch ^ $is_binding_patch)) { 2547133712a2SRob Herring WARN("DT_SPLIT_BINDING_PATCH", 2548133712a2SRob Herring "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n"); 2549133712a2SRob Herring } 2550133712a2SRob Herring } 2551133712a2SRob Herring 2552773647a0SAndy Whitcroft next; 2553773647a0SAndy Whitcroft } 2554773647a0SAndy Whitcroft 2555389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 25560a920b5bSAndy Whitcroft 2557c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2558c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2559c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 25600a920b5bSAndy Whitcroft 25616c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 25626c72ffaaSAndy Whitcroft 2563490b292cSJoe Perches# Verify the existence of a commit log if appropriate 2564490b292cSJoe Perches# 2 is used because a $signature is counted in $commit_log_lines 2565490b292cSJoe Perches if ($in_commit_log) { 2566490b292cSJoe Perches if ($line !~ /^\s*$/) { 2567490b292cSJoe Perches $commit_log_lines++; #could be a $signature 2568490b292cSJoe Perches } 2569490b292cSJoe Perches } elsif ($has_commit_log && $commit_log_lines < 2) { 2570490b292cSJoe Perches WARN("COMMIT_MESSAGE", 2571490b292cSJoe Perches "Missing commit description - Add an appropriate one\n"); 2572490b292cSJoe Perches $commit_log_lines = 2; #warn only once 2573490b292cSJoe Perches } 2574490b292cSJoe Perches 2575e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2576e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2577e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2578e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2579e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2580e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2581e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2582e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2583e518e9a5SJoe Perches $commit_log_has_diff = 1; 2584e518e9a5SJoe Perches } 2585e518e9a5SJoe Perches 25863bf9a009SRabin Vincent# Check for incorrect file permissions 25873bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 25883bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 258904db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 259004db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2591000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2592000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 25933bf9a009SRabin Vincent } 25943bf9a009SRabin Vincent } 25953bf9a009SRabin Vincent 2596cd261496SGeert Uytterhoeven# Check the patch for a From: 2597cd261496SGeert Uytterhoeven if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { 2598cd261496SGeert Uytterhoeven $author = $1; 2599cd261496SGeert Uytterhoeven $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); 2600cd261496SGeert Uytterhoeven $author =~ s/"//g; 2601cd261496SGeert Uytterhoeven } 2602cd261496SGeert Uytterhoeven 260320112475SJoe Perches# Check the patch for a signoff: 2604d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 26054a0df2efSAndy Whitcroft $signoff++; 260615662b3eSJoe Perches $in_commit_log = 0; 2607cd261496SGeert Uytterhoeven if ($author ne '') { 2608cd261496SGeert Uytterhoeven my $l = $line; 2609cd261496SGeert Uytterhoeven $l =~ s/"//g; 2610cd261496SGeert Uytterhoeven if ($l =~ /^\s*signed-off-by:\s*\Q$author\E/i) { 2611cd261496SGeert Uytterhoeven $authorsignoff = 1; 2612cd261496SGeert Uytterhoeven } 2613cd261496SGeert Uytterhoeven } 26140a920b5bSAndy Whitcroft } 261520112475SJoe Perches 2616e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2617e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2618e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2619e0d975b1SJoe Perches $reported_maintainer_file = 1; 2620e0d975b1SJoe Perches } 2621e0d975b1SJoe Perches 262220112475SJoe Perches# Check signature styles 2623270c49a0SJoe Perches if (!$in_header_lines && 2624ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 262520112475SJoe Perches my $space_before = $1; 262620112475SJoe Perches my $sign_off = $2; 262720112475SJoe Perches my $space_after = $3; 262820112475SJoe Perches my $email = $4; 262920112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 263020112475SJoe Perches 2631ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2632ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2633ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2634ce0338dfSJoe Perches } 263520112475SJoe Perches if (defined $space_before && $space_before ne "") { 26363705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 26373705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 26383705ce5bSJoe Perches $fix) { 2639194f66fcSJoe Perches $fixed[$fixlinenr] = 26403705ce5bSJoe Perches "$ucfirst_sign_off $email"; 26413705ce5bSJoe Perches } 264220112475SJoe Perches } 264320112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 26443705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 26453705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 26463705ce5bSJoe Perches $fix) { 2647194f66fcSJoe Perches $fixed[$fixlinenr] = 26483705ce5bSJoe Perches "$ucfirst_sign_off $email"; 26493705ce5bSJoe Perches } 26503705ce5bSJoe Perches 265120112475SJoe Perches } 265220112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 26533705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 26543705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 26553705ce5bSJoe Perches $fix) { 2656194f66fcSJoe Perches $fixed[$fixlinenr] = 26573705ce5bSJoe Perches "$ucfirst_sign_off $email"; 26583705ce5bSJoe Perches } 265920112475SJoe Perches } 266020112475SJoe Perches 266120112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 266220112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 266320112475SJoe Perches if ($suggested_email eq "") { 2664000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2665000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 266620112475SJoe Perches } else { 266720112475SJoe Perches my $dequoted = $suggested_email; 266820112475SJoe Perches $dequoted =~ s/^"//; 266920112475SJoe Perches $dequoted =~ s/" </ </; 267020112475SJoe Perches # Don't force email to have quotes 267120112475SJoe Perches # Allow just an angle bracketed address 267220112475SJoe Perches if ("$dequoted$comment" ne $email && 267320112475SJoe Perches "<$email_address>$comment" ne $email && 267420112475SJoe Perches "$suggested_email$comment" ne $email) { 2675000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2676000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 267720112475SJoe Perches } 26780a920b5bSAndy Whitcroft } 26797e51f197SJoe Perches 26807e51f197SJoe Perches# Check for duplicate signatures 26817e51f197SJoe Perches my $sig_nospace = $line; 26827e51f197SJoe Perches $sig_nospace =~ s/\s//g; 26837e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 26847e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 26857e51f197SJoe Perches WARN("BAD_SIGN_OFF", 26867e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 26877e51f197SJoe Perches } else { 26887e51f197SJoe Perches $signatures{$sig_nospace} = 1; 26897e51f197SJoe Perches } 26900a920b5bSAndy Whitcroft } 26910a920b5bSAndy Whitcroft 2692a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2693a2fe16b9SJoe Perches if ($in_header_lines && 2694a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2695a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2696a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2697a2fe16b9SJoe Perches } 2698a2fe16b9SJoe Perches 26997ebd05efSChristopher Covington# Check for unwanted Gerrit info 27007ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 27017ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 27027ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 27037ebd05efSChristopher Covington } 27047ebd05efSChristopher Covington 2705369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2706369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2707369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2708369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2709369c8dd3SJoe Perches # timestamp 2710369c8dd3SJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) { 2711369c8dd3SJoe Perches # stack dump address 2712369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2713369c8dd3SJoe Perches } 2714369c8dd3SJoe Perches 27152a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 27162a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2717bf4daf12SJoe Perches length($line) > 75 && 2718bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2719bf4daf12SJoe Perches # file delta changes 2720bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2721bf4daf12SJoe Perches # filename then : 2722bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2723bf4daf12SJoe Perches # A Fixes: or Link: line 2724bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 27252a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 27262a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 27272a076f40SJoe Perches $commit_log_long_line = 1; 27282a076f40SJoe Perches } 27292a076f40SJoe Perches 2730bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2731bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2732bf4daf12SJoe Perches $line =~ /^\s*$/) { 2733bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2734bf4daf12SJoe Perches } 2735bf4daf12SJoe Perches 27360d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2737369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2738aab38f51SJoe Perches $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i && 2739e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 2740fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2741aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2742369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2743bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2744fe043ea1SJoe Perches my $init_char = "c"; 2745fe043ea1SJoe Perches my $orig_commit = ""; 27460d7835fcSJoe Perches my $short = 1; 27470d7835fcSJoe Perches my $long = 0; 27480d7835fcSJoe Perches my $case = 1; 27490d7835fcSJoe Perches my $space = 1; 27500d7835fcSJoe Perches my $hasdesc = 0; 275119c146a6SJoe Perches my $hasparens = 0; 27520d7835fcSJoe Perches my $id = '0123456789ab'; 27530d7835fcSJoe Perches my $orig_desc = "commit description"; 27540d7835fcSJoe Perches my $description = ""; 27550d7835fcSJoe Perches 2756fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2757fe043ea1SJoe Perches $init_char = $1; 2758fe043ea1SJoe Perches $orig_commit = lc($2); 2759fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2760fe043ea1SJoe Perches $orig_commit = lc($1); 2761fe043ea1SJoe Perches } 2762fe043ea1SJoe Perches 27630d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 27640d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 27650d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 27660d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 27670d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 27680d7835fcSJoe Perches $orig_desc = $1; 276919c146a6SJoe Perches $hasparens = 1; 27700d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 27710d7835fcSJoe Perches defined $rawlines[$linenr] && 27720d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 27730d7835fcSJoe Perches $orig_desc = $1; 277419c146a6SJoe Perches $hasparens = 1; 2775b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2776b671fde0SJoe Perches defined $rawlines[$linenr] && 2777b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2778b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2779b671fde0SJoe Perches $orig_desc = $1; 2780b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2781b671fde0SJoe Perches $orig_desc .= " " . $1; 278219c146a6SJoe Perches $hasparens = 1; 27830d7835fcSJoe Perches } 27840d7835fcSJoe Perches 27850d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 27860d7835fcSJoe Perches $id, $orig_desc); 27870d7835fcSJoe Perches 2788948b133aSHeinrich Schuchardt if (defined($id) && 2789948b133aSHeinrich Schuchardt ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { 2790d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 27910d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 27920d7835fcSJoe Perches } 2793d311cd44SJoe Perches } 2794d311cd44SJoe Perches 279513f1937eSJoe Perches# Check for added, moved or deleted files 279613f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 279713f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 279813f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 279913f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 280013f1937eSJoe Perches (defined($1) || defined($2))))) { 2801a82603a8SAndrew Jeffery $is_patch = 1; 280213f1937eSJoe Perches $reported_maintainer_file = 1; 280313f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 280413f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 280513f1937eSJoe Perches } 280613f1937eSJoe Perches 280700df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 28088905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2809000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2810000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 28116c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2812de7d4f0eSAndy Whitcroft } 2813de7d4f0eSAndy Whitcroft 2814de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2815de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2816171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2817171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2818171ae1a4SAndy Whitcroft 2819171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2820171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2821171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2822171ae1a4SAndy Whitcroft 282334d99219SJoe Perches CHK("INVALID_UTF8", 2824000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 282500df344fSAndy Whitcroft } 28260a920b5bSAndy Whitcroft 282715662b3eSJoe Perches# Check if it's the start of a commit log 282815662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 282915662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 2830eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 2831eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 283215662b3eSJoe Perches $in_header_lines = 0; 283315662b3eSJoe Perches $in_commit_log = 1; 2834ed43c4e5SAllen Hubbe $has_commit_log = 1; 283515662b3eSJoe Perches } 283615662b3eSJoe Perches 2837fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2838fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2839fa64205dSPasi Savanainen if ($in_header_lines && 2840fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2841fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2842fa64205dSPasi Savanainen $non_utf8_charset = 1; 2843fa64205dSPasi Savanainen } 2844fa64205dSPasi Savanainen 2845fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 284615662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2847fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 284815662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 284915662b3eSJoe Perches } 285015662b3eSJoe Perches 2851d6430f71SJoe Perches# Check for absolute kernel paths in commit message 2852d6430f71SJoe Perches if ($tree && $in_commit_log) { 2853d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 2854d6430f71SJoe Perches my $file = $1; 2855d6430f71SJoe Perches 2856d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 2857d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 2858d6430f71SJoe Perches # 2859d6430f71SJoe Perches } else { 2860d6430f71SJoe Perches check_absolute_file($file, $herecurr); 2861d6430f71SJoe Perches } 2862d6430f71SJoe Perches } 2863d6430f71SJoe Perches } 2864d6430f71SJoe Perches 286566b47b4aSKees Cook# Check for various typo / spelling mistakes 286666d7a382SJoe Perches if (defined($misspellings) && 286766d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2868ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 286966b47b4aSKees Cook my $typo = $1; 287066b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 287166b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 287266b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 28730675a8fbSJean Delvare my $msg_level = \&WARN; 28740675a8fbSJean Delvare $msg_level = \&CHK if ($file); 28750675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 287666b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 287766b47b4aSKees Cook $fix) { 287866b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 287966b47b4aSKees Cook } 288066b47b4aSKees Cook } 288166b47b4aSKees Cook } 288266b47b4aSKees Cook 288330670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 288430670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 288500df344fSAndy Whitcroft 28860a920b5bSAndy Whitcroft#trailing whitespace 28879c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2888c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2889d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2890d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2891d5e616fcSJoe Perches $fix) { 2892194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2893d5e616fcSJoe Perches } 2894c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2895c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28963705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 28973705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 28983705ce5bSJoe Perches $fix) { 2899194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 29003705ce5bSJoe Perches } 29013705ce5bSJoe Perches 2902d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 29030a920b5bSAndy Whitcroft } 29045368df20SAndy Whitcroft 29054783f894SJosh Triplett# Check for FSF mailing addresses. 2906109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 29071bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 29083e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 29093e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 29104783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 29110675a8fbSJean Delvare my $msg_level = \&ERROR; 29120675a8fbSJean Delvare $msg_level = \&CHK if ($file); 29130675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 29144783f894SJosh 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) 29154783f894SJosh Triplett } 29164783f894SJosh Triplett 29173354957aSAndi Kleen# check for Kconfig help text having a real description 29189fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 29199fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 29203354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 2921678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 2922678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 2923678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 2924678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 29253354957aSAndi Kleen my $length = 0; 29269fe287d7SAndy Whitcroft my $cnt = $realcnt; 29279fe287d7SAndy Whitcroft my $ln = $linenr + 1; 29289fe287d7SAndy Whitcroft my $f; 2929a1385803SAndy Whitcroft my $is_start = 0; 29309fe287d7SAndy Whitcroft my $is_end = 0; 2931a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 29329fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 29339fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 29349fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 29359fe287d7SAndy Whitcroft 29369fe287d7SAndy Whitcroft next if ($f =~ /^-/); 29378d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2938a1385803SAndy Whitcroft 293986adf1a0SUlf Magnusson if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 2940a1385803SAndy Whitcroft $is_start = 1; 294184af7a61SUlf Magnusson } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) { 294284af7a61SUlf Magnusson if ($lines[$ln - 1] =~ "---help---") { 294384af7a61SUlf Magnusson WARN("CONFIG_DESCRIPTION", 294484af7a61SUlf Magnusson "prefer 'help' over '---help---' for new help texts\n" . $herecurr); 294584af7a61SUlf Magnusson } 2946a1385803SAndy Whitcroft $length = -1; 2947a1385803SAndy Whitcroft } 2948a1385803SAndy Whitcroft 29499fe287d7SAndy Whitcroft $f =~ s/^.//; 29503354957aSAndi Kleen $f =~ s/#.*//; 29513354957aSAndi Kleen $f =~ s/^\s+//; 29523354957aSAndi Kleen next if ($f =~ /^$/); 2953678ae162SUlf Magnusson 2954678ae162SUlf Magnusson # This only checks context lines in the patch 2955678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 2956678ae162SUlf Magnusson # positives, even though some of these are 2957678ae162SUlf Magnusson # common words in help texts 2958678ae162SUlf Magnusson if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| 2959678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 29609fe287d7SAndy Whitcroft $is_end = 1; 29619fe287d7SAndy Whitcroft last; 29629fe287d7SAndy Whitcroft } 29633354957aSAndi Kleen $length++; 29643354957aSAndi Kleen } 296556193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2966000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 296756193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 296856193274SVadim Bendebury } 2969a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 29703354957aSAndi Kleen } 29713354957aSAndi Kleen 2972628f91a2SJoe Perches# check for MAINTAINERS entries that don't have the right form 2973628f91a2SJoe Perches if ($realfile =~ /^MAINTAINERS$/ && 2974628f91a2SJoe Perches $rawline =~ /^\+[A-Z]:/ && 2975628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 2976628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 2977628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 2978628f91a2SJoe Perches $fix) { 2979628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 2980628f91a2SJoe Perches } 2981628f91a2SJoe Perches } 2982628f91a2SJoe Perches 2983327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2984327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2985327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2986327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2987327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2988327953e9SChristoph Jaeger } 2989327953e9SChristoph Jaeger 2990c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2991c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2992c68e5878SArnaud Lacombe my $flag = $1; 2993c68e5878SArnaud Lacombe my $replacement = { 2994c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2995c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2996c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2997c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2998c68e5878SArnaud Lacombe }; 2999c68e5878SArnaud Lacombe 3000c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 3001c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 3002c68e5878SArnaud Lacombe } 3003c68e5878SArnaud Lacombe 3004bff5da43SRob Herring# check for DT compatible documentation 30057dd05b38SFlorian Vaussard if (defined $root && 30067dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 30077dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 30087dd05b38SFlorian Vaussard 3009bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 3010bff5da43SRob Herring 3011cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 3012cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 3013cc93319bSFlorian Vaussard 3014bff5da43SRob Herring foreach my $compat (@compats) { 3015bff5da43SRob Herring my $compat2 = $compat; 3016185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 3017185d566bSRob Herring my $compat3 = $compat; 3018185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 3019185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 3020bff5da43SRob Herring if ( $? >> 8 ) { 3021bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3022bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 3023bff5da43SRob Herring } 3024bff5da43SRob Herring 30254fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 30264fbf32a6SFlorian Vaussard my $vendor = $1; 3027cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 3028bff5da43SRob Herring if ( $? >> 8 ) { 3029bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 3030cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 3031bff5da43SRob Herring } 3032bff5da43SRob Herring } 3033bff5da43SRob Herring } 3034bff5da43SRob Herring 30359f3a8992SRob Herring# check for using SPDX license tag at beginning of files 30369f3a8992SRob Herring if ($realline == $checklicenseline) { 30379f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 30389f3a8992SRob Herring $checklicenseline = 2; 30399f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 30409f3a8992SRob Herring my $comment = ""; 30419f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 30429f3a8992SRob Herring $comment = '/*'; 30439f3a8992SRob Herring } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 30449f3a8992SRob Herring $comment = '//'; 30459f3a8992SRob Herring } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) { 30469f3a8992SRob Herring $comment = '#'; 30479f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 30489f3a8992SRob Herring $comment = '..'; 30499f3a8992SRob Herring } 30509f3a8992SRob Herring 3051fdf13693SJoe Perches# check SPDX comment style for .[chsS] files 3052fdf13693SJoe Perches if ($realfile =~ /\.[chsS]$/ && 3053fdf13693SJoe Perches $rawline =~ /SPDX-License-Identifier:/ && 3054fdf13693SJoe Perches $rawline !~ /^\+\s*\Q$comment\E\s*/) { 3055fdf13693SJoe Perches WARN("SPDX_LICENSE_TAG", 3056fdf13693SJoe Perches "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr); 3057fdf13693SJoe Perches } 3058fdf13693SJoe Perches 30599f3a8992SRob Herring if ($comment !~ /^$/ && 30609f3a8992SRob Herring $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) { 30619f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 30629f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 30633b6e8ac9SJoe Perches } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) { 30643b6e8ac9SJoe Perches my $spdx_license = $1; 30653b6e8ac9SJoe Perches if (!is_SPDX_License_valid($spdx_license)) { 30663b6e8ac9SJoe Perches WARN("SPDX_LICENSE_TAG", 30673b6e8ac9SJoe Perches "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr); 30683b6e8ac9SJoe Perches } 30699f3a8992SRob Herring } 30709f3a8992SRob Herring } 30719f3a8992SRob Herring } 30729f3a8992SRob Herring 30735368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 3074d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 30755368df20SAndy Whitcroft 3076a8da38a9SJoe Perches# check for using SPDX-License-Identifier on the wrong line number 3077a8da38a9SJoe Perches if ($realline != $checklicenseline && 3078a8da38a9SJoe Perches $rawline =~ /\bSPDX-License-Identifier:/ && 3079a8da38a9SJoe Perches substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) { 3080a8da38a9SJoe Perches WARN("SPDX_LICENSE_TAG", 3081a8da38a9SJoe Perches "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr); 3082a8da38a9SJoe Perches } 3083a8da38a9SJoe Perches 308447e0c88bSJoe Perches# line length limit (with some exclusions) 308547e0c88bSJoe Perches# 308647e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 308747e0c88bSJoe Perches# logging functions like pr_info that end in a string 308847e0c88bSJoe Perches# lines with a single string 308947e0c88bSJoe Perches# #defines that are a single string 30902e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 309147e0c88bSJoe Perches# 309247e0c88bSJoe Perches# There are 3 different line length message types: 3093ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 309447e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 309547e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 309647e0c88bSJoe Perches# 309747e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 309847e0c88bSJoe Perches# 309947e0c88bSJoe Perches 3100b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 310147e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 310247e0c88bSJoe Perches 310347e0c88bSJoe Perches # Check the allowed long line types first 310447e0c88bSJoe Perches 310547e0c88bSJoe Perches # logging functions that end in a string that starts 310647e0c88bSJoe Perches # before $max_line_length 310747e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 310847e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 310947e0c88bSJoe Perches $msg_type = ""; 311047e0c88bSJoe Perches 311147e0c88bSJoe Perches # lines with only strings (w/ possible termination) 311247e0c88bSJoe Perches # #defines with only strings 311347e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 311447e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 311547e0c88bSJoe Perches $msg_type = ""; 311647e0c88bSJoe Perches 3117cc147506SJoe Perches # More special cases 3118cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3119cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3120d560a5f8SJoe Perches $msg_type = ""; 3121d560a5f8SJoe Perches 31222e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 31232e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 31242e4bbbc5SAndreas Brauchli $msg_type = ""; 31252e4bbbc5SAndreas Brauchli 312647e0c88bSJoe Perches # Otherwise set the alternate message types 312747e0c88bSJoe Perches 312847e0c88bSJoe Perches # a comment starts before $max_line_length 312947e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 313047e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 313147e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 313247e0c88bSJoe Perches 313347e0c88bSJoe Perches # a quoted string starts before $max_line_length 313447e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 313547e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 313647e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 313747e0c88bSJoe Perches } 313847e0c88bSJoe Perches 313947e0c88bSJoe Perches if ($msg_type ne "" && 314047e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 314147e0c88bSJoe Perches WARN($msg_type, 31426cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 31430a920b5bSAndy Whitcroft } 314447e0c88bSJoe Perches } 31450a920b5bSAndy Whitcroft 31468905a67cSAndy Whitcroft# check for adding lines without a newline. 31478905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 3148000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 3149000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 31508905a67cSAndy Whitcroft } 31518905a67cSAndy Whitcroft 3152b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3153de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 31540a920b5bSAndy Whitcroft 31550a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 31560a920b5bSAndy Whitcroft# more than 8 must use tabs. 3157c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3158c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3159c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3160d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 31613705ce5bSJoe Perches if (ERROR("CODE_INDENT", 31623705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 31633705ce5bSJoe Perches $fix) { 3164194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 31653705ce5bSJoe Perches } 31660a920b5bSAndy Whitcroft } 31670a920b5bSAndy Whitcroft 316808e44365SAlberto Panizzo# check for space before tabs. 316908e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 317008e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 31713705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 31723705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 31733705ce5bSJoe Perches $fix) { 3174194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3175d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 3176194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3177c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 31783705ce5bSJoe Perches } 317908e44365SAlberto Panizzo } 318008e44365SAlberto Panizzo 31816a487211SJoe Perches# check for assignments on the start of a line 31826a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 31836a487211SJoe Perches CHK("ASSIGNMENT_CONTINUATIONS", 31846a487211SJoe Perches "Assignment operator '$1' should be on the previous line\n" . $hereprev); 31856a487211SJoe Perches } 31866a487211SJoe Perches 3187d1fe9c09SJoe Perches# check for && or || at the start of a line 3188d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 3189d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 3190d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 3191d1fe9c09SJoe Perches } 3192d1fe9c09SJoe Perches 3193a91e8994SJoe Perches# check indentation starts on a tab stop 31945b57980dSJoe Perches if ($perl_version_ok && 3195bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3196a91e8994SJoe Perches my $indent = length($1); 3197a91e8994SJoe Perches if ($indent % 8) { 3198a91e8994SJoe Perches if (WARN("TABSTOP", 3199a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3200a91e8994SJoe Perches $fix) { 3201a91e8994SJoe Perches $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; 3202a91e8994SJoe Perches } 3203a91e8994SJoe Perches } 3204a91e8994SJoe Perches } 3205a91e8994SJoe Perches 3206d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 32075b57980dSJoe Perches if ($perl_version_ok && 3208fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3209d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3210d1fe9c09SJoe Perches my $oldindent = $1; 3211d1fe9c09SJoe Perches my $rest = $2; 3212d1fe9c09SJoe Perches 3213d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3214d1fe9c09SJoe Perches if ($pos >= 0) { 3215b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3216b34a26f3SJoe Perches my $newindent = $2; 3217d1fe9c09SJoe Perches 3218d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3219d1fe9c09SJoe Perches "\t" x ($pos / 8) . 3220d1fe9c09SJoe Perches " " x ($pos % 8); 3221d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3222d1fe9c09SJoe Perches 3223d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3224d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 32253705ce5bSJoe Perches 32263705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 32273705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 32283705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3229194f66fcSJoe Perches $fixed[$fixlinenr] =~ 32303705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 32313705ce5bSJoe Perches } 3232d1fe9c09SJoe Perches } 3233d1fe9c09SJoe Perches } 3234d1fe9c09SJoe Perches } 3235d1fe9c09SJoe Perches 32366ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 32376ab3a970SJoe Perches# avoid checking a few false positives: 32386ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 32396ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 32406ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 32416ab3a970SJoe Perches# multiline macros that define functions 32426ab3a970SJoe Perches# known attributes or the __attribute__ keyword 32436ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 32446ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 32453705ce5bSJoe Perches if (CHK("SPACING", 3246f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 32473705ce5bSJoe Perches $fix) { 3248194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3249f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 32503705ce5bSJoe Perches } 3251aad4f614SJoe Perches } 3252aad4f614SJoe Perches 325386406b1cSJoe Perches# Block comment styles 325486406b1cSJoe Perches# Networking with an initial /* 325505880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3256fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 325785ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 325885ad978cSJoe Perches $realline > 2) { 325905880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 326005880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 326105880600SJoe Perches } 326205880600SJoe Perches 326386406b1cSJoe Perches# Block comments use * on subsequent lines 326486406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 326586406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3266a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 326761135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3268a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 326986406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 327086406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3271a605e32eSJoe Perches } 3272a605e32eSJoe Perches 327386406b1cSJoe Perches# Block comments use */ on trailing lines 327486406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3275c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3276c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3277c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 327886406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 327986406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 328005880600SJoe Perches } 328105880600SJoe Perches 328208eb9b80SJoe Perches# Block comment * alignment 328308eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3284af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3285af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3286af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 328708eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3288af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3289af207524SJoe Perches my $oldindent; 329008eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3291af207524SJoe Perches if (defined($1)) { 3292af207524SJoe Perches $oldindent = expand_tabs($1); 3293af207524SJoe Perches } else { 3294af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3295af207524SJoe Perches $oldindent = expand_tabs($1); 3296af207524SJoe Perches } 329708eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 329808eb9b80SJoe Perches my $newindent = $1; 329908eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3300af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 330108eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 330208eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 330308eb9b80SJoe Perches } 330408eb9b80SJoe Perches } 330508eb9b80SJoe Perches 33067f619191SJoe Perches# check for missing blank lines after struct/union declarations 33077f619191SJoe Perches# with exceptions for various attributes and macros 33087f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 33097f619191SJoe Perches $line =~ /^\+/ && 33107f619191SJoe Perches !($line =~ /^\+\s*$/ || 33117f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 33127f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 33137f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 33147f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 33157f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 33167f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 33170bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 33187f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3319d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3320d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3321d752fcc8SJoe Perches $fix) { 3322f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3323d752fcc8SJoe Perches } 33247f619191SJoe Perches } 33257f619191SJoe Perches 3326365dd4eaSJoe Perches# check for multiple consecutive blank lines 3327365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3328365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3329365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3330d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3331d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3332d752fcc8SJoe Perches $fix) { 3333f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3334d752fcc8SJoe Perches } 3335d752fcc8SJoe Perches 3336365dd4eaSJoe Perches $last_blank_line = $linenr; 3337365dd4eaSJoe Perches } 3338365dd4eaSJoe Perches 33393b617e3bSJoe Perches# check for missing blank lines after declarations 33403f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 33413f7bac03SJoe Perches # actual declarations 33423f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 33435a4e1fd3SJoe Perches # function pointer declarations 33445a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 33453f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 33463f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 33473f7bac03SJoe Perches # known declaration macros 33483f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 33493f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 33503f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 33513f7bac03SJoe Perches # other possible extensions of declaration lines 33523f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 33533f7bac03SJoe Perches # not starting a section or a macro "\" extended line 33543f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 33553f7bac03SJoe Perches # looks like a declaration 33563f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 33575a4e1fd3SJoe Perches # function pointer declarations 33585a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 33593f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 33603f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 33613f7bac03SJoe Perches # known declaration macros 33623f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 33633f7bac03SJoe Perches # start of struct or union or enum 3364328b5f41SJoe Perches $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ || 33653f7bac03SJoe Perches # start or end of block or continuation of declaration 33663f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 33673f7bac03SJoe Perches # bitfield continuation 33683f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 33693f7bac03SJoe Perches # other possible extensions of declaration lines 33703f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 33713f7bac03SJoe Perches # indentation of previous and current line are the same 33723f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3373d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3374d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3375d752fcc8SJoe Perches $fix) { 3376f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3377d752fcc8SJoe Perches } 33783b617e3bSJoe Perches } 33793b617e3bSJoe Perches 33805f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 33816b4c5bebSAndy Whitcroft# Exceptions: 33826b4c5bebSAndy Whitcroft# 1) within comments 33836b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 33846b4c5bebSAndy Whitcroft# 3) hanging labels 33853705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 33865f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 33873705ce5bSJoe Perches if (WARN("LEADING_SPACE", 33883705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 33893705ce5bSJoe Perches $fix) { 3390194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 33913705ce5bSJoe Perches } 33925f7ddae6SRaffaele Recalcati } 33935f7ddae6SRaffaele Recalcati 3394b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3395b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3396b9ea10d6SAndy Whitcroft 33975751a24eSJoe Perches# check for unusual line ending [ or ( 33985751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 33995751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 34005751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 34015751a24eSJoe Perches } 34025751a24eSJoe Perches 34034dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 34044dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 34054dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 34064dbed76fSJoe Perches $context_function = $1; 34074dbed76fSJoe Perches } 34084dbed76fSJoe Perches 34094dbed76fSJoe Perches# check if this appears to be the end of function declaration 34104dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 34114dbed76fSJoe Perches undef $context_function; 34124dbed76fSJoe Perches } 34134dbed76fSJoe Perches 3414032a4c0fSJoe Perches# check indentation of any line with a bare else 3415840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3416032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3417032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3418032a4c0fSJoe Perches my $tabs = length($1) + 1; 3419840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3420840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3421840080a0SJoe Perches defined $lines[$linenr] && 3422840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3423032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3424032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3425032a4c0fSJoe Perches } 3426032a4c0fSJoe Perches } 3427032a4c0fSJoe Perches 3428c00df19aSJoe Perches# check indentation of a line with a break; 3429c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3430c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3431c00df19aSJoe Perches my $tabs = $1; 3432c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3433c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3434c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3435c00df19aSJoe Perches } 3436c00df19aSJoe Perches } 3437c00df19aSJoe Perches 3438c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3439cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3440000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3441000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3442c2fdda0dSAndy Whitcroft } 344322f2a2efSAndy Whitcroft 344456e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 344556e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 344656e77d70SJoe Perches WARN("HOTPLUG_SECTION", 344756e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 344856e77d70SJoe Perches } 344956e77d70SJoe Perches 34509c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 34512b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 34522b474a1aSAndy Whitcroft $realline_next); 34533e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 3454ca819864SJoe Perches if ($linenr > $suppress_statement && 34551b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3456170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3457f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3458171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3459171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3460171ae1a4SAndy Whitcroft 34613e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 34623e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 34633e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 34643e469cdcSAndy Whitcroft # until we hit end of it. 34653e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 34663e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 34673e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 34683e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 34693e469cdcSAndy Whitcroft } 3470f74bd194SAndy Whitcroft 34712b474a1aSAndy Whitcroft # Find the real next line. 34722b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 34732b474a1aSAndy Whitcroft if (defined $realline_next && 34742b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 34752b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 34762b474a1aSAndy Whitcroft $realline_next++; 34772b474a1aSAndy Whitcroft } 34782b474a1aSAndy Whitcroft 3479171ae1a4SAndy Whitcroft my $s = $stat; 3480171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3481cf655043SAndy Whitcroft 3482c2fdda0dSAndy Whitcroft # Ignore goto labels. 3483171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3484c2fdda0dSAndy Whitcroft 3485c2fdda0dSAndy Whitcroft # Ignore functions being called 3486171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3487c2fdda0dSAndy Whitcroft 3488463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3489463f2864SAndy Whitcroft 3490c45dcabdSAndy Whitcroft # declarations always start with types 3491d2506586SAndy 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) { 3492c45dcabdSAndy Whitcroft my $type = $1; 3493c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3494c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3495c45dcabdSAndy Whitcroft 34966c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3497a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3498c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3499c2fdda0dSAndy Whitcroft } 35008905a67cSAndy Whitcroft 35016c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 350265863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3503c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 35049c0ca6f9SAndy Whitcroft } 35058905a67cSAndy Whitcroft 35068905a67cSAndy Whitcroft # Check for any sort of function declaration. 35078905a67cSAndy Whitcroft # int foo(something bar, other baz); 35088905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3509171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 35108905a67cSAndy Whitcroft my ($name_len) = length($1); 35118905a67cSAndy Whitcroft 3512cf655043SAndy Whitcroft my $ctx = $s; 3513773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 35148905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3515cf655043SAndy Whitcroft 35168905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3517c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 35188905a67cSAndy Whitcroft 3519c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 35208905a67cSAndy Whitcroft } 35218905a67cSAndy Whitcroft } 35228905a67cSAndy Whitcroft } 35238905a67cSAndy Whitcroft 35249c0ca6f9SAndy Whitcroft } 35259c0ca6f9SAndy Whitcroft 352600df344fSAndy Whitcroft# 352700df344fSAndy Whitcroft# Checks which may be anchored in the context. 352800df344fSAndy Whitcroft# 352900df344fSAndy Whitcroft 353000df344fSAndy Whitcroft# Check for switch () and associated case and default 353100df344fSAndy Whitcroft# statements should be at the same indent. 353200df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 353300df344fSAndy Whitcroft my $err = ''; 353400df344fSAndy Whitcroft my $sep = ''; 353500df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 353600df344fSAndy Whitcroft shift(@ctx); 353700df344fSAndy Whitcroft for my $ctx (@ctx) { 353800df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 353900df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 354000df344fSAndy Whitcroft $indent != $cindent) { 354100df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 354200df344fSAndy Whitcroft $sep = ''; 354300df344fSAndy Whitcroft } else { 354400df344fSAndy Whitcroft $sep = "[...]\n"; 354500df344fSAndy Whitcroft } 354600df344fSAndy Whitcroft } 354700df344fSAndy Whitcroft if ($err ne '') { 3548000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3549000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3550de7d4f0eSAndy Whitcroft } 3551de7d4f0eSAndy Whitcroft } 3552de7d4f0eSAndy Whitcroft 3553de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3554de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 35550fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3556773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3557773647a0SAndy Whitcroft 35589c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 35598eef05ddSJoe Perches 35608eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 35618eef05ddSJoe Perches WARN("DEEP_INDENTATION", 35628eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 35638eef05ddSJoe Perches } 35648eef05ddSJoe Perches 3565de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3566de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3567de7d4f0eSAndy Whitcroft 3568548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3569548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3570de7d4f0eSAndy Whitcroft 3571548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3572548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3573548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3574548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3575548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3576773647a0SAndy Whitcroft $ctx_ln++; 3577773647a0SAndy Whitcroft } 3578548596d5SAndy Whitcroft 357953210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 358053210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3581773647a0SAndy Whitcroft 3582773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3583000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3584000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 358501464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 358600df344fSAndy Whitcroft } 3587773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3588773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3589773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3590773647a0SAndy Whitcroft { 35919c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 35929c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3593000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3594000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 359501464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 35969c0ca6f9SAndy Whitcroft } 35979c0ca6f9SAndy Whitcroft } 359800df344fSAndy Whitcroft } 359900df344fSAndy Whitcroft 36004d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 3601f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 36023e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 36033e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 36043e469cdcSAndy Whitcroft if (!defined $stat); 36054d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 36064d001e4dSAndy Whitcroft 36074d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 36084d001e4dSAndy Whitcroft 36099f5af480SJoe Perches # remove inline comments 36109f5af480SJoe Perches $s =~ s/$;/ /g; 36119f5af480SJoe Perches $c =~ s/$;/ /g; 36124d001e4dSAndy Whitcroft 36134d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 36146f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 36156f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 36164d001e4dSAndy Whitcroft 36179f5af480SJoe Perches # Make sure we remove the line prefixes as we have 36189f5af480SJoe Perches # none on the first line, and are going to readd them 36199f5af480SJoe Perches # where necessary. 36209f5af480SJoe Perches $s =~ s/\n./\n/gs; 36219f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 36229f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 36239f5af480SJoe Perches } 36249f5af480SJoe Perches 36254d001e4dSAndy Whitcroft # We want to check the first line inside the block 36264d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 36274d001e4dSAndy Whitcroft # 1) any blank line termination 36284d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 36294d001e4dSAndy Whitcroft # 3) any do (...) { 36304d001e4dSAndy Whitcroft my $continuation = 0; 36314d001e4dSAndy Whitcroft my $check = 0; 36324d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 36334d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 36344d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 36354d001e4dSAndy Whitcroft $continuation = 1; 36364d001e4dSAndy Whitcroft } 36379bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 36384d001e4dSAndy Whitcroft $check = 1; 36394d001e4dSAndy Whitcroft $cond_lines++; 36404d001e4dSAndy Whitcroft } 36414d001e4dSAndy Whitcroft 36424d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 36434d001e4dSAndy Whitcroft # preprocessor statement. 36444d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 36454d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 36464d001e4dSAndy Whitcroft $check = 0; 36474d001e4dSAndy Whitcroft } 36484d001e4dSAndy Whitcroft 36499bd49efeSAndy Whitcroft my $cond_ptr = -1; 3650740504c6SAndy Whitcroft $continuation = 0; 36519bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 36529bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 36534d001e4dSAndy Whitcroft 3654f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3655f16fa28fSAndy Whitcroft # is not linear. 3656f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3657f16fa28fSAndy Whitcroft $check = 0; 3658f16fa28fSAndy Whitcroft } 3659f16fa28fSAndy Whitcroft 36609bd49efeSAndy Whitcroft # Ignore: 36619bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 36629bd49efeSAndy Whitcroft # 2) preprocessor lines, and 36639bd49efeSAndy Whitcroft # 3) labels. 3664740504c6SAndy Whitcroft if ($continuation || 3665740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 36669bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 36679bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3668740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 366930dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 36709bd49efeSAndy Whitcroft $cond_lines++; 36719bd49efeSAndy Whitcroft } 36724d001e4dSAndy Whitcroft } 367330dad6ebSAndy Whitcroft } 36744d001e4dSAndy Whitcroft 36754d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 36764d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 36774d001e4dSAndy Whitcroft 36784d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 36794d001e4dSAndy Whitcroft # this is not this patch's fault. 36804d001e4dSAndy Whitcroft if (!defined($stat_real) || 36814d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 36824d001e4dSAndy Whitcroft $check = 0; 36834d001e4dSAndy Whitcroft } 36844d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 36854d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 36864d001e4dSAndy Whitcroft } 36874d001e4dSAndy Whitcroft 36889bd49efeSAndy 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"; 36894d001e4dSAndy Whitcroft 36909f5af480SJoe Perches if ($check && $s ne '' && 36919f5af480SJoe Perches (($sindent % 8) != 0 || 36929f5af480SJoe Perches ($sindent < $indent) || 3693f6950a73SJoe Perches ($sindent == $indent && 3694f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 36959f5af480SJoe Perches ($sindent > $indent + 8))) { 3696000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3697000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 36984d001e4dSAndy Whitcroft } 36994d001e4dSAndy Whitcroft } 37004d001e4dSAndy Whitcroft 37016c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 37026c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 37031f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 37041f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 37056c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3706c2fdda0dSAndy Whitcroft if ($dbg_values) { 3707c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3708cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3709cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 37101f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3711c2fdda0dSAndy Whitcroft } 37126c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 37136c72ffaaSAndy Whitcroft 371400df344fSAndy Whitcroft#ignore lines not being added 37153705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 371600df344fSAndy Whitcroft 371711ca40a0SJoe Perches# check for dereferences that span multiple lines 371811ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 371911ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 372011ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 372111ca40a0SJoe Perches my $ref = $1; 372211ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 372311ca40a0SJoe Perches $ref .= $1; 372411ca40a0SJoe Perches $ref =~ s/\s//g; 372511ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 372611ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 372711ca40a0SJoe Perches } 372811ca40a0SJoe Perches 3729a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3730c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3731a1ce18e4SJoe Perches my $type = $1; 3732a1ce18e4SJoe Perches my $var = $2; 3733207a8e84SJoe Perches $var = "" if (!defined $var); 3734207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3735a1ce18e4SJoe Perches my $sign = $1; 3736a1ce18e4SJoe Perches my $pointer = $2; 3737a1ce18e4SJoe Perches 3738a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3739a1ce18e4SJoe Perches 3740a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3741a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3742a1ce18e4SJoe Perches $fix) { 3743a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3744207a8e84SJoe Perches my $comp_pointer = $pointer; 3745207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 3746207a8e84SJoe Perches $decl .= $comp_pointer; 3747207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 3748207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 3749a1ce18e4SJoe Perches } 3750a1ce18e4SJoe Perches } 3751a1ce18e4SJoe Perches } 3752a1ce18e4SJoe Perches 3753653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 37547429c690SAndy Whitcroft if ($dbg_type) { 37557429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3756000d1cc1SJoe Perches ERROR("TEST_TYPE", 3757000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 37587429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3759000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3760000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 37617429c690SAndy Whitcroft } 3762653d4876SAndy Whitcroft next; 3763653d4876SAndy Whitcroft } 3764a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3765a1ef277eSAndy Whitcroft if ($dbg_attr) { 37669360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3767000d1cc1SJoe Perches ERROR("TEST_ATTR", 3768000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 37699360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3770000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3771000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3772a1ef277eSAndy Whitcroft } 3773a1ef277eSAndy Whitcroft next; 3774a1ef277eSAndy Whitcroft } 3775653d4876SAndy Whitcroft 3776f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 377799423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 377899423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3779d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3780d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3781f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3782f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3783f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3784d752fcc8SJoe Perches my $fixedline = $prevrawline; 3785d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3786f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3787d752fcc8SJoe Perches $fixedline = $line; 37888d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 3789f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3790d752fcc8SJoe Perches } 3791f0a594c1SAndy Whitcroft } 3792f0a594c1SAndy Whitcroft 379300df344fSAndy Whitcroft# 379400df344fSAndy Whitcroft# Checks which are anchored on the added line. 379500df344fSAndy Whitcroft# 379600df344fSAndy Whitcroft 3797653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3798c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3799653d4876SAndy Whitcroft my $path = $1; 3800653d4876SAndy Whitcroft if ($path =~ m{//}) { 3801000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3802495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3803495e9d84SJoe Perches } 3804495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3805495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3806495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3807653d4876SAndy Whitcroft } 3808653d4876SAndy Whitcroft } 3809653d4876SAndy Whitcroft 381000df344fSAndy Whitcroft# no C99 // comments 381100df344fSAndy Whitcroft if ($line =~ m{//}) { 38123705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 38133705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 38143705ce5bSJoe Perches $fix) { 3815194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 38163705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 38173705ce5bSJoe Perches my $comment = trim($1); 3818194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 38193705ce5bSJoe Perches } 38203705ce5bSJoe Perches } 382100df344fSAndy Whitcroft } 382200df344fSAndy Whitcroft # Remove C99 comments. 38230a920b5bSAndy Whitcroft $line =~ s@//.*@@; 38246c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 38250a920b5bSAndy Whitcroft 38262b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 38272b474a1aSAndy Whitcroft# the whole statement. 38282b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 38292b474a1aSAndy Whitcroft if (defined $realline_next && 38302b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 38312b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 38322b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 38332b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 38343cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 38353cbf62dfSAndy Whitcroft # a prefix: 38363cbf62dfSAndy Whitcroft # XXX(foo); 38373cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3838653d4876SAndy Whitcroft my $name = $1; 383987a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 38403cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 38413cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 38423cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 38433cbf62dfSAndy Whitcroft 38443cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 38452b474a1aSAndy Whitcroft \n.}\s*$| 384648012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 384748012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 384848012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 38492b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 38502b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 385148012058SAndy Whitcroft )/x) { 38522b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 38532b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 38542b474a1aSAndy Whitcroft } else { 38552b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 38560a920b5bSAndy Whitcroft } 38570a920b5bSAndy Whitcroft } 38582b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 38592b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 38602b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 38612b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 38622b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 38632b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 38642b474a1aSAndy Whitcroft } 38652b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 38662b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3867000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3868000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 38692b474a1aSAndy Whitcroft } 38700a920b5bSAndy Whitcroft 38715150bda4SJoe Eloff# check for global initialisers. 38726d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 3873d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 38746d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 3875d5e616fcSJoe Perches $fix) { 38766d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 3877d5e616fcSJoe Perches } 3878f0a594c1SAndy Whitcroft } 38790a920b5bSAndy Whitcroft# check for static initialisers. 38806d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 3881d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 38826d32f7a3SJoe Perches "do not initialise statics to $1\n" . 3883d5e616fcSJoe Perches $herecurr) && 3884d5e616fcSJoe Perches $fix) { 38856d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 3886d5e616fcSJoe Perches } 38870a920b5bSAndy Whitcroft } 38880a920b5bSAndy Whitcroft 38891813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 38901813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 38911813087dSJoe Perches my $tmp = trim($1); 38921813087dSJoe Perches WARN("MISORDERED_TYPE", 38931813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 38941813087dSJoe Perches } 38951813087dSJoe Perches 3896809e082eSJoe Perches# check for unnecessary <signed> int declarations of short/long/long long 3897809e082eSJoe Perches while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) { 3898809e082eSJoe Perches my $type = trim($1); 3899809e082eSJoe Perches next if ($type !~ /\bint\b/); 3900809e082eSJoe Perches next if ($type !~ /\b(?:short|long\s+long|long)\b/); 3901809e082eSJoe Perches my $new_type = $type; 3902809e082eSJoe Perches $new_type =~ s/\b\s*int\s*\b/ /; 3903809e082eSJoe Perches $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /; 3904809e082eSJoe Perches $new_type =~ s/^const\s+//; 3905809e082eSJoe Perches $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/); 3906809e082eSJoe Perches $new_type = "const $new_type" if ($type =~ /^const\b/); 3907809e082eSJoe Perches $new_type =~ s/\s+/ /g; 3908809e082eSJoe Perches $new_type = trim($new_type); 3909809e082eSJoe Perches if (WARN("UNNECESSARY_INT", 3910809e082eSJoe Perches "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) && 3911809e082eSJoe Perches $fix) { 3912809e082eSJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/; 3913809e082eSJoe Perches } 3914809e082eSJoe Perches } 3915809e082eSJoe Perches 3916cb710ecaSJoe Perches# check for static const char * arrays. 3917cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3918000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3919000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3920cb710ecaSJoe Perches $herecurr); 3921cb710ecaSJoe Perches } 3922cb710ecaSJoe Perches 392377b8c0a8SJoe Perches# check for initialized const char arrays that should be static const 392477b8c0a8SJoe Perches if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) { 392577b8c0a8SJoe Perches if (WARN("STATIC_CONST_CHAR_ARRAY", 392677b8c0a8SJoe Perches "const array should probably be static const\n" . $herecurr) && 392777b8c0a8SJoe Perches $fix) { 392877b8c0a8SJoe Perches $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/; 392977b8c0a8SJoe Perches } 393077b8c0a8SJoe Perches } 393177b8c0a8SJoe Perches 3932cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3933cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3934000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3935000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3936cb710ecaSJoe Perches $herecurr); 3937cb710ecaSJoe Perches } 3938cb710ecaSJoe Perches 3939ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3940ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3941ab7e23f3SJoe Perches my $found = $1; 3942ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3943ab7e23f3SJoe Perches WARN("CONST_CONST", 3944ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3945ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3946ab7e23f3SJoe Perches WARN("CONST_CONST", 3947ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3948ab7e23f3SJoe Perches } 3949ab7e23f3SJoe Perches } 3950ab7e23f3SJoe Perches 39519b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 39529b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 39539b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 39549b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 39559b0fa60dSJoe Perches $herecurr); 39569b0fa60dSJoe Perches } 39579b0fa60dSJoe Perches 3958b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3959b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3960b598b670SJoe Perches my $array = $1; 3961b598b670SJoe 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*\))@) { 3962b598b670SJoe Perches my $array_div = $1; 3963b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3964b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3965b598b670SJoe Perches $fix) { 3966b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3967b598b670SJoe Perches } 3968b598b670SJoe Perches } 3969b598b670SJoe Perches } 3970b598b670SJoe Perches 3971b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3972b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3973b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3974b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3975b36190c5SJoe Perches $fix) { 3976194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3977b36190c5SJoe Perches } 3978b36190c5SJoe Perches } 3979b36190c5SJoe Perches 3980653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3981653d4876SAndy Whitcroft# make sense. 3982653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 39838054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3984c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 39858ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 398646d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 3987000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3988000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 39890a920b5bSAndy Whitcroft } 39900a920b5bSAndy Whitcroft 39910a920b5bSAndy Whitcroft# * goes on variable not on type 399265863862SAndy Whitcroft # (char*[ const]) 3993bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3994bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 39953705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3996d8aaf121SAndy Whitcroft 399765863862SAndy Whitcroft # Should start with a space. 399865863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 399965863862SAndy Whitcroft # Should not end with a space. 400065863862SAndy Whitcroft $to =~ s/\s+$//; 400165863862SAndy Whitcroft # '*'s should not have spaces between. 4002f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 400365863862SAndy Whitcroft } 4004d8aaf121SAndy Whitcroft 40053705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 400665863862SAndy Whitcroft if ($from ne $to) { 40073705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 40083705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 40093705ce5bSJoe Perches $fix) { 40103705ce5bSJoe Perches my $sub_from = $ident; 40113705ce5bSJoe Perches my $sub_to = $ident; 40123705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4013194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40143705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 40153705ce5bSJoe Perches } 401665863862SAndy Whitcroft } 4017bfcb2cc7SAndy Whitcroft } 4018bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 4019bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 40203705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 4021d8aaf121SAndy Whitcroft 402265863862SAndy Whitcroft # Should start with a space. 402365863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 402465863862SAndy Whitcroft # Should not end with a space. 402565863862SAndy Whitcroft $to =~ s/\s+$//; 402665863862SAndy Whitcroft # '*'s should not have spaces between. 4027f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 402865863862SAndy Whitcroft } 402965863862SAndy Whitcroft # Modifiers should have spaces. 403065863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 403165863862SAndy Whitcroft 40323705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 4033667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 40343705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 40353705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 40363705ce5bSJoe Perches $fix) { 40373705ce5bSJoe Perches 40383705ce5bSJoe Perches my $sub_from = $match; 40393705ce5bSJoe Perches my $sub_to = $match; 40403705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 4041194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40423705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 40433705ce5bSJoe Perches } 404465863862SAndy Whitcroft } 40450a920b5bSAndy Whitcroft } 40460a920b5bSAndy Whitcroft 40479d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 40489d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 40490675a8fbSJean Delvare my $msg_level = \&WARN; 40500675a8fbSJean Delvare $msg_level = \&CHK if ($file); 40510675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 40529d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 40539d3e3c70SJoe Perches } 40540a920b5bSAndy Whitcroft 40559d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 40568905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 4057000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 4058000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 40598905a67cSAndy Whitcroft } 40608905a67cSAndy Whitcroft 406117441227SJoe Perches# check for uses of printk_ratelimit 406217441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 4063000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 4064000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 406517441227SJoe Perches } 406617441227SJoe Perches 4067eeef5733SJoe Perches# printk should use KERN_* levels 4068eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 4069000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 4070eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 407100df344fSAndy Whitcroft } 40720a920b5bSAndy Whitcroft 4073243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 4074243f3803SJoe Perches my $orig = $1; 4075243f3803SJoe Perches my $level = lc($orig); 4076243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 40778f26b837SJoe Perches my $level2 = $level; 40788f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 4079243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 4080daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 4081243f3803SJoe Perches } 4082243f3803SJoe Perches 4083243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 4084d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 4085d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 4086d5e616fcSJoe Perches $fix) { 4087194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4088d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 4089d5e616fcSJoe Perches } 4090243f3803SJoe Perches } 4091243f3803SJoe Perches 4092dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 4093dc139313SJoe Perches my $orig = $1; 4094dc139313SJoe Perches my $level = lc($orig); 4095dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 4096dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 4097dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 4098dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 4099dc139313SJoe Perches } 4100dc139313SJoe Perches 410191c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 410291c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 410391c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 410491c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 410591c9afafSAndy Lutomirski WARN("ENOSYS", 410691c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 410791c9afafSAndy Lutomirski } 410891c9afafSAndy Lutomirski 4109653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 4110653d4876SAndy Whitcroft# or if closed on same line 41115b57980dSJoe Perches if ($perl_version_ok && 41122d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 41132d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 41142d453e3bSJoe Perches $sline !~ /}/) { 41158d182478SJoe Perches if (ERROR("OPEN_BRACE", 41162d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 41178d182478SJoe Perches $fix) { 41188d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 41198d182478SJoe Perches my $fixed_line = $rawline; 41208d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 41218d182478SJoe Perches my $line1 = $1; 41228d182478SJoe Perches my $line2 = $2; 41238d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 41248d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 41258d182478SJoe Perches if ($line2 !~ /^\s*$/) { 41268d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 41278d182478SJoe Perches } 41288d182478SJoe Perches } 41290a920b5bSAndy Whitcroft } 4130653d4876SAndy Whitcroft 41318905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 41328905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 41338905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 41348d182478SJoe Perches if (ERROR("OPEN_BRACE", 41358d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 41368d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 41378d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 41388d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 41398d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 41408d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 41418d182478SJoe Perches $fixedline = $rawline; 41428d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 41438d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 41448d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 41458d182478SJoe Perches } 41468d182478SJoe Perches } 41478905a67cSAndy Whitcroft } 41488905a67cSAndy Whitcroft 41490c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 41503705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 41513705ce5bSJoe Perches if (WARN("SPACING", 41523705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 41533705ce5bSJoe Perches $fix) { 4154194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41553705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 41563705ce5bSJoe Perches } 41570c73b4ebSAndy Whitcroft } 41580c73b4ebSAndy Whitcroft 415931070b5dSJoe Perches# Function pointer declarations 416031070b5dSJoe Perches# check spacing between type, funcptr, and args 416131070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 416291f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 416331070b5dSJoe Perches my $declare = $1; 416431070b5dSJoe Perches my $pre_pointer_space = $2; 416531070b5dSJoe Perches my $post_pointer_space = $3; 416631070b5dSJoe Perches my $funcname = $4; 416731070b5dSJoe Perches my $post_funcname_space = $5; 416831070b5dSJoe Perches my $pre_args_space = $6; 416931070b5dSJoe Perches 417091f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 417191f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 417291f72e9cSJoe Perches# don't need a space so don't warn for those. 417391f72e9cSJoe Perches my $post_declare_space = ""; 417491f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 417591f72e9cSJoe Perches $post_declare_space = $1; 417691f72e9cSJoe Perches $declare = rtrim($declare); 417791f72e9cSJoe Perches } 417891f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 417931070b5dSJoe Perches WARN("SPACING", 418031070b5dSJoe Perches "missing space after return type\n" . $herecurr); 418191f72e9cSJoe Perches $post_declare_space = " "; 418231070b5dSJoe Perches } 418331070b5dSJoe Perches 418431070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 418591f72e9cSJoe Perches# This test is not currently implemented because these declarations are 418691f72e9cSJoe Perches# equivalent to 418791f72e9cSJoe Perches# int foo(int bar, ...) 418891f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 418991f72e9cSJoe Perches# 419091f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 419191f72e9cSJoe Perches# WARN("SPACING", 419291f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 419391f72e9cSJoe Perches# } 419431070b5dSJoe Perches 419531070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 419631070b5dSJoe Perches if (defined $pre_pointer_space && 419731070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 419831070b5dSJoe Perches WARN("SPACING", 419931070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 420031070b5dSJoe Perches } 420131070b5dSJoe Perches 420231070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 420331070b5dSJoe Perches if (defined $post_pointer_space && 420431070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 420531070b5dSJoe Perches WARN("SPACING", 420631070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 420731070b5dSJoe Perches } 420831070b5dSJoe Perches 420931070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 421031070b5dSJoe Perches if (defined $post_funcname_space && 421131070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 421231070b5dSJoe Perches WARN("SPACING", 421331070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 421431070b5dSJoe Perches } 421531070b5dSJoe Perches 421631070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 421731070b5dSJoe Perches if (defined $pre_args_space && 421831070b5dSJoe Perches $pre_args_space =~ /^\s/) { 421931070b5dSJoe Perches WARN("SPACING", 422031070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 422131070b5dSJoe Perches } 422231070b5dSJoe Perches 422331070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4224194f66fcSJoe Perches $fixed[$fixlinenr] =~ 422591f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 422631070b5dSJoe Perches } 422731070b5dSJoe Perches } 422831070b5dSJoe Perches 42298d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 42308d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4231fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4232fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 42338d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 42348d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 42358d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4236fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 423738dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 42383705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 42393705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 42403705ce5bSJoe Perches $fix) { 4241194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42423705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 42433705ce5bSJoe Perches } 42448d31cfceSAndy Whitcroft } 42458d31cfceSAndy Whitcroft } 42468d31cfceSAndy Whitcroft 4247f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 42486c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4249c2fdda0dSAndy Whitcroft my $name = $1; 4250773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4251773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4252c2fdda0dSAndy Whitcroft 4253c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4254773647a0SAndy Whitcroft if ($name =~ /^(?: 4255773647a0SAndy Whitcroft if|for|while|switch|return|case| 4256773647a0SAndy Whitcroft volatile|__volatile__| 4257773647a0SAndy Whitcroft __attribute__|format|__extension__| 4258773647a0SAndy Whitcroft asm|__asm__)$/x) 4259773647a0SAndy Whitcroft { 4260c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4261c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4262c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4263c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4264773647a0SAndy Whitcroft 4265773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4266c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4267c2fdda0dSAndy Whitcroft 4268c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4269c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4270773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4271c2fdda0dSAndy Whitcroft 4272c2fdda0dSAndy Whitcroft } else { 42733705ce5bSJoe Perches if (WARN("SPACING", 42743705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 42753705ce5bSJoe Perches $fix) { 4276194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42773705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 42783705ce5bSJoe Perches } 4279f0a594c1SAndy Whitcroft } 42806c72ffaaSAndy Whitcroft } 42819a4cad4eSEric Nelson 4282653d4876SAndy Whitcroft# Check operator spacing. 42830a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 42843705ce5bSJoe Perches my $fixed_line = ""; 42853705ce5bSJoe Perches my $line_fixed = 0; 42863705ce5bSJoe Perches 42879c0ca6f9SAndy Whitcroft my $ops = qr{ 42889c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 42899c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 42909c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 42911f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 429284731623SJoe Perches \?:|\?|: 42939c0ca6f9SAndy Whitcroft }x; 4294cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 42953705ce5bSJoe Perches 42963705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 42973705ce5bSJoe Perches## foreach my $el (@elements) { 42983705ce5bSJoe Perches## print("el: <$el>\n"); 42993705ce5bSJoe Perches## } 43003705ce5bSJoe Perches 43013705ce5bSJoe Perches my @fix_elements = (); 430200df344fSAndy Whitcroft my $off = 0; 43036c72ffaaSAndy Whitcroft 43043705ce5bSJoe Perches foreach my $el (@elements) { 43053705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 43063705ce5bSJoe Perches $off += length($el); 43073705ce5bSJoe Perches } 43083705ce5bSJoe Perches 43093705ce5bSJoe Perches $off = 0; 43103705ce5bSJoe Perches 43116c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4312b34c648bSJoe Perches my $last_after = -1; 43136c72ffaaSAndy Whitcroft 43140a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 43153705ce5bSJoe Perches 43163705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 43173705ce5bSJoe Perches 43183705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 43193705ce5bSJoe Perches 43204a0df2efSAndy Whitcroft $off += length($elements[$n]); 43214a0df2efSAndy Whitcroft 432225985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4323773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4324773647a0SAndy Whitcroft my $cc = ''; 4325773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4326773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4327773647a0SAndy Whitcroft } 4328773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4329773647a0SAndy Whitcroft 43304a0df2efSAndy Whitcroft my $a = ''; 43314a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 43324a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4333cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 43344a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 43354a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 4336773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 43374a0df2efSAndy Whitcroft 43380a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 43394a0df2efSAndy Whitcroft 43404a0df2efSAndy Whitcroft my $c = ''; 43410a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 43424a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 43434a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4344cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 43454a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 43464a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 43478b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 43484a0df2efSAndy Whitcroft } else { 43494a0df2efSAndy Whitcroft $c = 'E'; 43500a920b5bSAndy Whitcroft } 43510a920b5bSAndy Whitcroft 43524a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 43534a0df2efSAndy Whitcroft 43544a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 43554a0df2efSAndy Whitcroft 43566c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 4357de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 43580a920b5bSAndy Whitcroft 435974048ed8SAndy Whitcroft # Pull out the value of this operator. 43606c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 43610a920b5bSAndy Whitcroft 43621f65f947SAndy Whitcroft # Get the full operator variant. 43631f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 43641f65f947SAndy Whitcroft 436513214adfSAndy Whitcroft # Ignore operators passed as parameters. 436613214adfSAndy Whitcroft if ($op_type ne 'V' && 4367d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 436813214adfSAndy Whitcroft 4369cf655043SAndy Whitcroft# # Ignore comments 4370cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 437113214adfSAndy Whitcroft 4372d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 437313214adfSAndy Whitcroft } elsif ($op eq ';') { 4374cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 4375cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 43763705ce5bSJoe Perches if (ERROR("SPACING", 43773705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 4378b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 43793705ce5bSJoe Perches $line_fixed = 1; 43803705ce5bSJoe Perches } 4381d8aaf121SAndy Whitcroft } 4382d8aaf121SAndy Whitcroft 4383d8aaf121SAndy Whitcroft # // is a comment 4384d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 43850a920b5bSAndy Whitcroft 4386b00e4814SJoe Perches # : when part of a bitfield 4387b00e4814SJoe Perches } elsif ($opv eq ':B') { 4388b00e4814SJoe Perches # skip the bitfield test for now 4389b00e4814SJoe Perches 43901f65f947SAndy Whitcroft # No spaces for: 43911f65f947SAndy Whitcroft # -> 4392b00e4814SJoe Perches } elsif ($op eq '->') { 43934a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 43943705ce5bSJoe Perches if (ERROR("SPACING", 43953705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4396b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43973705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 43983705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 43993705ce5bSJoe Perches } 4400b34c648bSJoe Perches $line_fixed = 1; 44013705ce5bSJoe Perches } 44020a920b5bSAndy Whitcroft } 44030a920b5bSAndy Whitcroft 44042381097bSJoe Perches # , must not have a space before and must have a space on the right. 44050a920b5bSAndy Whitcroft } elsif ($op eq ',') { 44062381097bSJoe Perches my $rtrim_before = 0; 44072381097bSJoe Perches my $space_after = 0; 44082381097bSJoe Perches if ($ctx =~ /Wx./) { 44092381097bSJoe Perches if (ERROR("SPACING", 44102381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 44112381097bSJoe Perches $line_fixed = 1; 44122381097bSJoe Perches $rtrim_before = 1; 44132381097bSJoe Perches } 44142381097bSJoe Perches } 4415cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 44163705ce5bSJoe Perches if (ERROR("SPACING", 44173705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 44183705ce5bSJoe Perches $line_fixed = 1; 4419b34c648bSJoe Perches $last_after = $n; 44202381097bSJoe Perches $space_after = 1; 44212381097bSJoe Perches } 44222381097bSJoe Perches } 44232381097bSJoe Perches if ($rtrim_before || $space_after) { 44242381097bSJoe Perches if ($rtrim_before) { 44252381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 44262381097bSJoe Perches } else { 44272381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 44282381097bSJoe Perches } 44292381097bSJoe Perches if ($space_after) { 44302381097bSJoe Perches $good .= " "; 44313705ce5bSJoe Perches } 44320a920b5bSAndy Whitcroft } 44330a920b5bSAndy Whitcroft 44349c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 443574048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 44369c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 44379c0ca6f9SAndy Whitcroft 44389c0ca6f9SAndy Whitcroft # unary operators should have a space before and 44399c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 44409c0ca6f9SAndy Whitcroft # unary operator, or a cast 44419c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 444274048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 44430d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4444cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 44453705ce5bSJoe Perches if (ERROR("SPACING", 44463705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4447b34c648bSJoe Perches if ($n != $last_after + 2) { 4448b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 44493705ce5bSJoe Perches $line_fixed = 1; 44503705ce5bSJoe Perches } 44510a920b5bSAndy Whitcroft } 4452b34c648bSJoe Perches } 4453a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4454171ae1a4SAndy Whitcroft # A unary '*' may be const 4455171ae1a4SAndy Whitcroft 4456171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 44573705ce5bSJoe Perches if (ERROR("SPACING", 44583705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4459b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 44603705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 44613705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 44623705ce5bSJoe Perches } 4463b34c648bSJoe Perches $line_fixed = 1; 44643705ce5bSJoe Perches } 44650a920b5bSAndy Whitcroft } 44660a920b5bSAndy Whitcroft 44670a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 44680a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4469773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 44703705ce5bSJoe Perches if (ERROR("SPACING", 44713705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4472b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 44733705ce5bSJoe Perches $line_fixed = 1; 44743705ce5bSJoe Perches } 44750a920b5bSAndy Whitcroft } 4476773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4477773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 44783705ce5bSJoe Perches if (ERROR("SPACING", 44793705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4480b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 44813705ce5bSJoe Perches $line_fixed = 1; 44823705ce5bSJoe Perches } 4483653d4876SAndy Whitcroft } 4484773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 44853705ce5bSJoe Perches if (ERROR("SPACING", 44863705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4487b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 44883705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 44893705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4490773647a0SAndy Whitcroft } 4491b34c648bSJoe Perches $line_fixed = 1; 44923705ce5bSJoe Perches } 44933705ce5bSJoe Perches } 44940a920b5bSAndy Whitcroft 44950a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 44969c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 44979c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 44989c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4499c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4500c2fdda0dSAndy Whitcroft $op eq '%') 45010a920b5bSAndy Whitcroft { 4502d2e025f3SJoe Perches if ($check) { 4503d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4504d2e025f3SJoe Perches if (CHK("SPACING", 4505d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4506d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4507d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4508d2e025f3SJoe Perches $line_fixed = 1; 4509d2e025f3SJoe Perches } 4510d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4511d2e025f3SJoe Perches if (CHK("SPACING", 4512d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4513d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4514d2e025f3SJoe Perches $line_fixed = 1; 4515d2e025f3SJoe Perches } 4516d2e025f3SJoe Perches } 4517d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 45183705ce5bSJoe Perches if (ERROR("SPACING", 45193705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4520b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4521b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4522b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4523b34c648bSJoe Perches } 45243705ce5bSJoe Perches $line_fixed = 1; 45253705ce5bSJoe Perches } 45260a920b5bSAndy Whitcroft } 45270a920b5bSAndy Whitcroft 45281f65f947SAndy Whitcroft # A colon needs no spaces before when it is 45291f65f947SAndy Whitcroft # terminating a case value or a label. 45301f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 45311f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 45323705ce5bSJoe Perches if (ERROR("SPACING", 45333705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4534b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 45353705ce5bSJoe Perches $line_fixed = 1; 45363705ce5bSJoe Perches } 45371f65f947SAndy Whitcroft } 45381f65f947SAndy Whitcroft 45390a920b5bSAndy Whitcroft # All the others need spaces both sides. 4540cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 45411f65f947SAndy Whitcroft my $ok = 0; 45421f65f947SAndy Whitcroft 454322f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 45441f65f947SAndy Whitcroft if (($op eq '<' && 45451f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 45461f65f947SAndy Whitcroft ($op eq '>' && 45471f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 45481f65f947SAndy Whitcroft { 45491f65f947SAndy Whitcroft $ok = 1; 45501f65f947SAndy Whitcroft } 45511f65f947SAndy Whitcroft 4552e0df7e1fSJoe Perches # for asm volatile statements 4553e0df7e1fSJoe Perches # ignore a colon with another 4554e0df7e1fSJoe Perches # colon immediately before or after 4555e0df7e1fSJoe Perches if (($op eq ':') && 4556e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4557e0df7e1fSJoe Perches $ok = 1; 4558e0df7e1fSJoe Perches } 4559e0df7e1fSJoe Perches 456084731623SJoe Perches # messages are ERROR, but ?: are CHK 45611f65f947SAndy Whitcroft if ($ok == 0) { 45620675a8fbSJean Delvare my $msg_level = \&ERROR; 45630675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 456484731623SJoe Perches 45650675a8fbSJean Delvare if (&{$msg_level}("SPACING", 45663705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4567b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4568b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4569b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4570b34c648bSJoe Perches } 45713705ce5bSJoe Perches $line_fixed = 1; 45723705ce5bSJoe Perches } 45730a920b5bSAndy Whitcroft } 457422f2a2efSAndy Whitcroft } 45754a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 45763705ce5bSJoe Perches 45773705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 45783705ce5bSJoe Perches 45793705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 45800a920b5bSAndy Whitcroft } 45813705ce5bSJoe Perches 45823705ce5bSJoe Perches if (($#elements % 2) == 0) { 45833705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 45843705ce5bSJoe Perches } 45853705ce5bSJoe Perches 4586194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4587194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 45883705ce5bSJoe Perches } 45893705ce5bSJoe Perches 45903705ce5bSJoe Perches 45910a920b5bSAndy Whitcroft } 45920a920b5bSAndy Whitcroft 4593786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4594d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4595786b6326SJoe Perches if (WARN("SPACING", 4596786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4597786b6326SJoe Perches $fix) { 4598194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4599786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4600786b6326SJoe Perches } 4601786b6326SJoe Perches } 4602786b6326SJoe Perches 4603f0a594c1SAndy Whitcroft# check for multiple assignments 4604f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4605000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4606000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4607f0a594c1SAndy Whitcroft } 4608f0a594c1SAndy Whitcroft 460922f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 461022f2a2efSAndy Whitcroft## # continuation. 461122f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 461222f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 461322f2a2efSAndy Whitcroft## 461422f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 461522f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 461622f2a2efSAndy Whitcroft## my $ln = $line; 461722f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 461822f2a2efSAndy Whitcroft## } 461922f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4620000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4621000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 462222f2a2efSAndy Whitcroft## } 462322f2a2efSAndy Whitcroft## } 4624f0a594c1SAndy Whitcroft 46250a920b5bSAndy Whitcroft#need space before brace following if, while, etc 46266b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 46276ad724e2SMichal Zylowski $line =~ /\b(?:else|do)\{/) { 46283705ce5bSJoe Perches if (ERROR("SPACING", 46293705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 46303705ce5bSJoe Perches $fix) { 46316ad724e2SMichal Zylowski $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/; 46323705ce5bSJoe Perches } 4633de7d4f0eSAndy Whitcroft } 4634de7d4f0eSAndy Whitcroft 4635c4a62ef9SJoe Perches## # check for blank lines before declarations 4636c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4637c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4638c4a62ef9SJoe Perches## WARN("SPACING", 4639c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4640c4a62ef9SJoe Perches## } 4641c4a62ef9SJoe Perches## 4642c4a62ef9SJoe Perches 4643de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4644de7d4f0eSAndy Whitcroft# on the line 4645de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4646d5e616fcSJoe Perches if (ERROR("SPACING", 4647d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4648d5e616fcSJoe Perches $fix) { 4649194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4650d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4651d5e616fcSJoe Perches } 46520a920b5bSAndy Whitcroft } 46530a920b5bSAndy Whitcroft 465422f2a2efSAndy Whitcroft# check spacing on square brackets 465522f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 46563705ce5bSJoe Perches if (ERROR("SPACING", 46573705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 46583705ce5bSJoe Perches $fix) { 4659194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46603705ce5bSJoe Perches s/\[\s+/\[/; 46613705ce5bSJoe Perches } 466222f2a2efSAndy Whitcroft } 466322f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 46643705ce5bSJoe Perches if (ERROR("SPACING", 46653705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 46663705ce5bSJoe Perches $fix) { 4667194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46683705ce5bSJoe Perches s/\s+\]/\]/; 46693705ce5bSJoe Perches } 467022f2a2efSAndy Whitcroft } 467122f2a2efSAndy Whitcroft 4672c45dcabdSAndy Whitcroft# check spacing on parentheses 46739c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 46749c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 46753705ce5bSJoe Perches if (ERROR("SPACING", 46763705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 46773705ce5bSJoe Perches $fix) { 4678194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46793705ce5bSJoe Perches s/\(\s+/\(/; 46803705ce5bSJoe Perches } 468122f2a2efSAndy Whitcroft } 468213214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4683c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4684c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 46853705ce5bSJoe Perches if (ERROR("SPACING", 46863705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 46873705ce5bSJoe Perches $fix) { 4688194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46893705ce5bSJoe Perches s/\s+\)/\)/; 46903705ce5bSJoe Perches } 469122f2a2efSAndy Whitcroft } 469222f2a2efSAndy Whitcroft 4693e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4694e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4695e2826fd0SJoe Perches 4696e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4697ea4acbb1SJoe Perches my $var = $1; 4698ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4699ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4700ea4acbb1SJoe Perches $fix) { 4701ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4702ea4acbb1SJoe Perches } 4703ea4acbb1SJoe Perches } 4704ea4acbb1SJoe Perches 4705ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4706ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4707ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4708ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4709ea4acbb1SJoe Perches my $var = $2; 4710ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4711ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4712ea4acbb1SJoe Perches $fix) { 4713ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4714ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4715ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4716ea4acbb1SJoe Perches } 4717e2826fd0SJoe Perches } 4718e2826fd0SJoe Perches 471963b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 4720a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 4721a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 47225b57980dSJoe Perches $perl_version_ok && defined($stat) && 472363b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 472463b7c73eSJoe Perches my $if_stat = $1; 472563b7c73eSJoe Perches my $test = substr($2, 1, -1); 472663b7c73eSJoe Perches my $herectx; 472763b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 472863b7c73eSJoe Perches my $match = $1; 472963b7c73eSJoe Perches # avoid parentheses around potential macro args 473063b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 473163b7c73eSJoe Perches if (!defined($herectx)) { 473263b7c73eSJoe Perches $herectx = $here . "\n"; 473363b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 473463b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 473563b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 473663b7c73eSJoe Perches $herectx .= $rl . "\n"; 473763b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 473863b7c73eSJoe Perches } 473963b7c73eSJoe Perches } 474063b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 474163b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 474263b7c73eSJoe Perches } 474363b7c73eSJoe Perches } 474463b7c73eSJoe Perches 47450a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 47464a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 47470a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 47483705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 47493705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 47503705ce5bSJoe Perches $fix) { 4751194f66fcSJoe Perches $fixed[$fixlinenr] =~ 47523705ce5bSJoe Perches s/^(.)\s+/$1/; 47533705ce5bSJoe Perches } 47540a920b5bSAndy Whitcroft } 47550a920b5bSAndy Whitcroft 47565b9553abSJoe Perches# return is not a function 4757507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4758c45dcabdSAndy Whitcroft my $spacing = $1; 47595b57980dSJoe Perches if ($perl_version_ok && 47605b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 47615b9553abSJoe Perches my $value = $1; 47625b9553abSJoe Perches $value = deparenthesize($value); 47635b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4764000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4765000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 47665b9553abSJoe Perches } 4767c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4768000d1cc1SJoe Perches ERROR("SPACING", 4769000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4770c45dcabdSAndy Whitcroft } 4771c45dcabdSAndy Whitcroft } 4772507e5141SJoe Perches 4773b43ae21bSJoe Perches# unnecessary return in a void function 4774b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4775b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4776b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4777b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4778b43ae21bSJoe Perches $linenr >= 3 && 4779b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4780b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 47819819cf25SJoe Perches WARN("RETURN_VOID", 4782b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 47839819cf25SJoe Perches } 47849819cf25SJoe Perches 4785189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 47865b57980dSJoe Perches if ($perl_version_ok && 4787189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4788189248d8SJoe Perches my $openparens = $1; 4789189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4790189248d8SJoe Perches my $msg = ""; 4791189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4792189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4793189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4794189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4795189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4796189248d8SJoe Perches } 4797189248d8SJoe Perches } 4798189248d8SJoe Perches 4799c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4800c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4801c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4802c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 48035b57980dSJoe Perches if ($perl_version_ok && 4804c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4805c5595fa2SJoe Perches my $lead = $1; 4806c5595fa2SJoe Perches my $const = $2; 4807c5595fa2SJoe Perches my $comp = $3; 4808c5595fa2SJoe Perches my $to = $4; 4809c5595fa2SJoe Perches my $newcomp = $comp; 4810f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 4811c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4812c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4813c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4814c5595fa2SJoe Perches $fix) { 4815c5595fa2SJoe Perches if ($comp eq "<") { 4816c5595fa2SJoe Perches $newcomp = ">"; 4817c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4818c5595fa2SJoe Perches $newcomp = ">="; 4819c5595fa2SJoe Perches } elsif ($comp eq ">") { 4820c5595fa2SJoe Perches $newcomp = "<"; 4821c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4822c5595fa2SJoe Perches $newcomp = "<="; 4823c5595fa2SJoe Perches } 4824c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4825c5595fa2SJoe Perches } 4826c5595fa2SJoe Perches } 4827c5595fa2SJoe Perches 4828f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4829f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 483053a3c448SAndy Whitcroft my $name = $1; 483153a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4832000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4833f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 483453a3c448SAndy Whitcroft } 483553a3c448SAndy Whitcroft } 4836c45dcabdSAndy Whitcroft 48370a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 48384a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 48393705ce5bSJoe Perches if (ERROR("SPACING", 48403705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 48413705ce5bSJoe Perches $fix) { 4842194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48433705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 48443705ce5bSJoe Perches } 48450a920b5bSAndy Whitcroft } 48460a920b5bSAndy Whitcroft 4847f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4848f5fe35ddSAndy Whitcroft# statements after the conditional. 4849170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 48503e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 48513e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 48523e469cdcSAndy Whitcroft if (!defined $stat); 4853170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4854170d3a22SAndy Whitcroft $remain_next, $off_next); 4855170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4856170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4857170d3a22SAndy Whitcroft 4858170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4859170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4860170d3a22SAndy Whitcroft # then count those as offsets. 4861170d3a22SAndy Whitcroft my ($whitespace) = 4862170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4863170d3a22SAndy Whitcroft my $offset = 4864170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4865170d3a22SAndy Whitcroft 4866170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4867170d3a22SAndy Whitcroft $offset} = 1; 4868170d3a22SAndy Whitcroft } 4869170d3a22SAndy Whitcroft } 4870170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4871c11230f4SJoe Perches defined($stat) && defined($cond) && 4872170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4873171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 48748905a67cSAndy Whitcroft 4875b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4876000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4877000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 48788905a67cSAndy Whitcroft } 48798905a67cSAndy Whitcroft 48808905a67cSAndy Whitcroft # Find out what is on the end of the line after the 48818905a67cSAndy Whitcroft # conditional. 4882773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 48838905a67cSAndy Whitcroft $s =~ s/\n.*//g; 488413214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 488553210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 488653210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4887773647a0SAndy Whitcroft { 4888bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4889bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4890bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 489142bdf74cSHidetoshi Seto my $stat_real = ''; 4892bb44ad39SAndy Whitcroft 489342bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 489442bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4895bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4896bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4897bb44ad39SAndy Whitcroft } 4898bb44ad39SAndy Whitcroft 4899000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4900000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 49018905a67cSAndy Whitcroft } 49028905a67cSAndy Whitcroft } 49038905a67cSAndy Whitcroft 490413214adfSAndy Whitcroft# Check for bitwise tests written as boolean 490513214adfSAndy Whitcroft if ($line =~ / 490613214adfSAndy Whitcroft (?: 490713214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 490813214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 490913214adfSAndy Whitcroft (?:\&\&|\|\|) 491013214adfSAndy Whitcroft | 491113214adfSAndy Whitcroft (?:\&\&|\|\|) 491213214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 491313214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 491413214adfSAndy Whitcroft )/x) 491513214adfSAndy Whitcroft { 4916000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4917000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 491813214adfSAndy Whitcroft } 491913214adfSAndy Whitcroft 49208905a67cSAndy Whitcroft# if and else should not have general statements after it 492113214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 492213214adfSAndy Whitcroft my $s = $1; 492313214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 492413214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4925000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4926000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 49270a920b5bSAndy Whitcroft } 492813214adfSAndy Whitcroft } 492939667782SAndy Whitcroft# if should not continue a brace 493039667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4931000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4932048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 493339667782SAndy Whitcroft $herecurr); 493439667782SAndy Whitcroft } 4935a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4936a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4937a1080bf8SAndy Whitcroft $line !~ /\G(?: 49383fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4939a1080bf8SAndy Whitcroft \s*return\s+ 4940a1080bf8SAndy Whitcroft )/xg) 4941a1080bf8SAndy Whitcroft { 4942000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4943000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4944a1080bf8SAndy Whitcroft } 49450a920b5bSAndy Whitcroft 49460a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 49470a920b5bSAndy Whitcroft # indent level to be relevant to each other. 49488b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 49490a920b5bSAndy Whitcroft $previndent == $indent) { 49508b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 49518b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 49528b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 49538b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 49548b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 49558b8856f4SJoe Perches my $fixedline = $prevrawline; 49568b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 49578b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 49588b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 49598b8856f4SJoe Perches } 49608b8856f4SJoe Perches $fixedline = $rawline; 49618b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 49628b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 49638b8856f4SJoe Perches } 49640a920b5bSAndy Whitcroft } 49650a920b5bSAndy Whitcroft 49668b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4967c2fdda0dSAndy Whitcroft $previndent == $indent) { 4968c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4969c2fdda0dSAndy Whitcroft 4970c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4971c2fdda0dSAndy Whitcroft # conditional. 4972773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4973c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4974c2fdda0dSAndy Whitcroft 4975c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 49768b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 49778b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 49788b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 49798b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 49808b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 49818b8856f4SJoe Perches my $fixedline = $prevrawline; 49828b8856f4SJoe Perches my $trailing = $rawline; 49838b8856f4SJoe Perches $trailing =~ s/^\+//; 49848b8856f4SJoe Perches $trailing = trim($trailing); 49858b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 49868b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 49878b8856f4SJoe Perches } 4988c2fdda0dSAndy Whitcroft } 4989c2fdda0dSAndy Whitcroft } 4990c2fdda0dSAndy Whitcroft 499195e2c602SJoe Perches#Specific variable tests 4992323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4993323c1260SJoe Perches my $var = $1; 499495e2c602SJoe Perches 499595e2c602SJoe Perches#CamelCase 4996807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4997be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 499822735ce8SJoe Perches#Ignore Page<foo> variants 4999807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 500022735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 5001f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 5002f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 5003f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 50047e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 50057e781f67SJoe Perches my $word = $1; 50067e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 5007d8b07710SJoe Perches if ($check) { 5008d8b07710SJoe Perches seed_camelcase_includes(); 5009d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 5010d8b07710SJoe Perches seed_camelcase_file($realfile); 5011d8b07710SJoe Perches $camelcase_file_seeded = 1; 5012d8b07710SJoe Perches } 5013d8b07710SJoe Perches } 50147e781f67SJoe Perches if (!defined $camelcase{$word}) { 50157e781f67SJoe Perches $camelcase{$word} = 1; 5016be79794bSJoe Perches CHK("CAMELCASE", 50177e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 50187e781f67SJoe Perches } 5019323c1260SJoe Perches } 5020323c1260SJoe Perches } 50213445686aSJoe Perches } 50220a920b5bSAndy Whitcroft 50230a920b5bSAndy Whitcroft#no spaces allowed after \ in define 5024d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 5025d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 5026d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 5027d5e616fcSJoe Perches $fix) { 5028194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 5029d5e616fcSJoe Perches } 50300a920b5bSAndy Whitcroft } 50310a920b5bSAndy Whitcroft 50320e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 50330e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 5034c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 5035e09dec48SAndy Whitcroft my $file = "$1.h"; 5036e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 5037e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 5038e09dec48SAndy Whitcroft $realfile ne $checkfile && 50397840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 5040c45dcabdSAndy Whitcroft { 50410e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 50420e212e0aSFabian Frederick if ($asminclude > 0) { 5043e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 5044000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 5045000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5046e09dec48SAndy Whitcroft } else { 5047000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 5048000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5049e09dec48SAndy Whitcroft } 50500a920b5bSAndy Whitcroft } 50510a920b5bSAndy Whitcroft } 50520e212e0aSFabian Frederick } 50530a920b5bSAndy Whitcroft 5054653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 5055653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 5056cf655043SAndy Whitcroft# in a known good container 5057b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 5058b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 5059d8aaf121SAndy Whitcroft my $ln = $linenr; 5060d8aaf121SAndy Whitcroft my $cnt = $realcnt; 5061c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 5062c45dcabdSAndy Whitcroft my $ctx = ''; 506308a2843eSJoe Perches my $has_flow_statement = 0; 506408a2843eSJoe Perches my $has_arg_concat = 0; 5065c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 5066f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 5067f74bd194SAndy Whitcroft $ctx = $dstat; 5068c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 5069a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 5070c45dcabdSAndy Whitcroft 507108a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 507262e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 507308a2843eSJoe Perches 5074f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 5075f59b64bfSJoe Perches my $define_args = $1; 5076f59b64bfSJoe Perches my $define_stmt = $dstat; 5077f59b64bfSJoe Perches my @def_args = (); 5078f59b64bfSJoe Perches 5079f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 5080f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 5081f59b64bfSJoe Perches $define_args =~ s/\s*//g; 50828c8c45cfSJoe Perches $define_args =~ s/\\\+?//g; 5083f59b64bfSJoe Perches @def_args = split(",", $define_args); 5084f59b64bfSJoe Perches } 5085f59b64bfSJoe Perches 5086292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 5087c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 5088c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 5089c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 5090c45dcabdSAndy Whitcroft 5091c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 5092bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 5093bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 50946b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 5095bf30d6edSAndy Whitcroft { 5096c45dcabdSAndy Whitcroft } 5097c45dcabdSAndy Whitcroft 5098e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 509933acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 510033acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 5101e45bab8eSAndy Whitcroft { 5102e45bab8eSAndy Whitcroft } 5103e45bab8eSAndy Whitcroft 510442e15293SJoe Perches # Make asm volatile uses seem like a generic function 510542e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 510642e15293SJoe Perches 5107c45dcabdSAndy Whitcroft my $exceptions = qr{ 5108c45dcabdSAndy Whitcroft $Declare| 5109c45dcabdSAndy Whitcroft module_param_named| 5110a0a0a7a9SKees Cook MODULE_PARM_DESC| 5111c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 5112c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 5113383099fdSAndy Whitcroft __typeof__\(| 511422fd2d3eSStefani Seibold union| 511522fd2d3eSStefani Seibold struct| 5116ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 51176b10df42SVladimir Zapolskiy ^\"|\"$| 51186b10df42SVladimir Zapolskiy ^\[ 5119c45dcabdSAndy Whitcroft }x; 51205eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 5121f59b64bfSJoe Perches 5122f59b64bfSJoe Perches $ctx =~ s/\n*$//; 5123f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 5124e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 5125f59b64bfSJoe Perches 5126f74bd194SAndy Whitcroft if ($dstat ne '' && 5127f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 5128f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 51293cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 5130356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5131f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 5132f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5133e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 513472f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 5135f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5136f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5137f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 51384e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5139f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5140c45dcabdSAndy Whitcroft { 5141e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5142e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5143e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5144e795556aSJoe Perches } elsif ($dstat =~ /;/) { 5145f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5146f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5147f74bd194SAndy Whitcroft } else { 5148000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 5149388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5150d8aaf121SAndy Whitcroft } 5151f59b64bfSJoe Perches 5152f59b64bfSJoe Perches } 51535207649bSJoe Perches 51545207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 51555207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 51565207649bSJoe Perches my $first = 1; 51575207649bSJoe Perches $define_stmt = ""; 51585207649bSJoe Perches foreach my $l (@stmt_array) { 51595207649bSJoe Perches $l =~ s/\\$//; 51605207649bSJoe Perches if ($first) { 51615207649bSJoe Perches $define_stmt = $l; 51625207649bSJoe Perches $first = 0; 51635207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 51645207649bSJoe Perches $define_stmt .= substr($l, 1); 51655207649bSJoe Perches } 51665207649bSJoe Perches } 51675207649bSJoe Perches $define_stmt =~ s/$;//g; 51685207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 51695207649bSJoe Perches $define_stmt = trim($define_stmt); 51705207649bSJoe Perches 5171f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5172f59b64bfSJoe Perches foreach my $arg (@def_args) { 5173f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 51749192d41aSJoe Perches next if ($arg =~ /^type$/i); 51757fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 51767fe528a2SJoe Perches $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 51777fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 51787fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 5179d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 5180f59b64bfSJoe Perches if ($use_cnt > 1) { 5181f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5182f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5183f59b64bfSJoe Perches } 51849192d41aSJoe Perches# check if any macro arguments may have other precedence issues 51857fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 51869192d41aSJoe Perches ((defined($1) && $1 ne ',') || 51879192d41aSJoe Perches (defined($2) && $2 ne ','))) { 51889192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 51899192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 51909192d41aSJoe Perches } 51910a920b5bSAndy Whitcroft } 51925023d347SJoe Perches 519308a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 519408a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 519508a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 519608a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 5197e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 519808a2843eSJoe Perches 519908a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 520008a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 520108a2843eSJoe Perches } 520208a2843eSJoe Perches 5203481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 52045023d347SJoe Perches 52055023d347SJoe Perches } else { 52065023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5207481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5208481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 52095023d347SJoe Perches $line =~ /^\+.*\\$/) { 52105023d347SJoe Perches WARN("LINE_CONTINUATIONS", 52115023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 52125023d347SJoe Perches } 5213653d4876SAndy Whitcroft } 52140a920b5bSAndy Whitcroft 5215b13edf7fSJoe Perches# do {} while (0) macro tests: 5216b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5217b13edf7fSJoe Perches# macro should not end with a semicolon 52185b57980dSJoe Perches if ($perl_version_ok && 5219b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5220b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5221b13edf7fSJoe Perches my $ln = $linenr; 5222b13edf7fSJoe Perches my $cnt = $realcnt; 5223b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5224b13edf7fSJoe Perches my $ctx = ''; 5225b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5226b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5227b13edf7fSJoe Perches $ctx = $dstat; 5228b13edf7fSJoe Perches 5229b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 52301b36b201SJoe Perches $dstat =~ s/$;/ /g; 5231b13edf7fSJoe Perches 5232b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5233b13edf7fSJoe Perches my $stmts = $2; 5234b13edf7fSJoe Perches my $semis = $3; 5235b13edf7fSJoe Perches 5236b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5237b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5238e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5239b13edf7fSJoe Perches 5240ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5241ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5242b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5243b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5244b13edf7fSJoe Perches } 5245b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5246b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5247b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5248b13edf7fSJoe Perches } 5249f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5250f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5251f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5252e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5253f5ef95b1SJoe Perches 5254f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5255f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5256b13edf7fSJoe Perches } 5257b13edf7fSJoe Perches } 5258b13edf7fSJoe Perches 5259f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 526013214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 526113214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5262cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 526313214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5264cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5265cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5266aad4f614SJoe Perches my @allowed = (); 5267aad4f614SJoe Perches my $allow = 0; 526813214adfSAndy Whitcroft my $seen = 0; 5269773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5270cf655043SAndy Whitcroft my $ln = $linenr - 1; 527113214adfSAndy Whitcroft for my $chunk (@chunks) { 527213214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 527313214adfSAndy Whitcroft 5274773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5275773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5276773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 5277773647a0SAndy Whitcroft 5278aad4f614SJoe Perches $allowed[$allow] = 0; 5279773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5280773647a0SAndy Whitcroft 5281773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 5282773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 5283773647a0SAndy Whitcroft 5284773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5285cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 5286cf655043SAndy Whitcroft 5287773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 528813214adfSAndy Whitcroft 528913214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 529013214adfSAndy Whitcroft 5291aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5292cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5293cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5294aad4f614SJoe Perches $allowed[$allow] = 1; 529513214adfSAndy Whitcroft } 529613214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5297cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5298aad4f614SJoe Perches $allowed[$allow] = 1; 529913214adfSAndy Whitcroft } 5300cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5301cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5302aad4f614SJoe Perches $allowed[$allow] = 1; 530313214adfSAndy Whitcroft } 5304aad4f614SJoe Perches $allow++; 530513214adfSAndy Whitcroft } 5306aad4f614SJoe Perches if ($seen) { 5307aad4f614SJoe Perches my $sum_allowed = 0; 5308aad4f614SJoe Perches foreach (@allowed) { 5309aad4f614SJoe Perches $sum_allowed += $_; 5310aad4f614SJoe Perches } 5311aad4f614SJoe Perches if ($sum_allowed == 0) { 5312000d1cc1SJoe Perches WARN("BRACES", 5313000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 5314aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 5315aad4f614SJoe Perches $seen != $allow) { 5316aad4f614SJoe Perches CHK("BRACES", 5317aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 5318aad4f614SJoe Perches } 531913214adfSAndy Whitcroft } 532013214adfSAndy Whitcroft } 532113214adfSAndy Whitcroft } 5322773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 532313214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 5324cf655043SAndy Whitcroft my $allowed = 0; 5325f0a594c1SAndy Whitcroft 5326cf655043SAndy Whitcroft # Check the pre-context. 5327cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 5328cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 5329cf655043SAndy Whitcroft $allowed = 1; 5330f0a594c1SAndy Whitcroft } 5331773647a0SAndy Whitcroft 5332773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 5333773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 5334773647a0SAndy Whitcroft 5335cf655043SAndy Whitcroft # Check the condition. 5336cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 5337773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 5338cf655043SAndy Whitcroft if (defined $cond) { 5339773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5340cf655043SAndy Whitcroft } 5341cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5342cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5343cf655043SAndy Whitcroft $allowed = 1; 5344cf655043SAndy Whitcroft } 5345cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5346cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5347cf655043SAndy Whitcroft $allowed = 1; 5348cf655043SAndy Whitcroft } 5349cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5350cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5351cf655043SAndy Whitcroft $allowed = 1; 5352cf655043SAndy Whitcroft } 5353cf655043SAndy Whitcroft # Check the post-context. 5354cf655043SAndy Whitcroft if (defined $chunks[1]) { 5355cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 5356cf655043SAndy Whitcroft if (defined $cond) { 5357773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5358cf655043SAndy Whitcroft } 5359cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 5360cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5361cf655043SAndy Whitcroft $allowed = 1; 5362cf655043SAndy Whitcroft } 5363cf655043SAndy Whitcroft } 5364cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 5365f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 5366e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5367cf655043SAndy Whitcroft 5368000d1cc1SJoe Perches WARN("BRACES", 5369000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 5370f0a594c1SAndy Whitcroft } 5371f0a594c1SAndy Whitcroft } 5372f0a594c1SAndy Whitcroft 5373e4c5babdSJoe Perches# check for single line unbalanced braces 537495330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 537595330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 5376e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 5377e4c5babdSJoe Perches } 5378e4c5babdSJoe Perches 53790979ae66SJoe Perches# check for unnecessary blank lines around braces 538077b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5381f8e58219SJoe Perches if (CHK("BRACES", 5382f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5383f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 5384f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5385f8e58219SJoe Perches } 53860979ae66SJoe Perches } 538777b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5388f8e58219SJoe Perches if (CHK("BRACES", 5389f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5390f8e58219SJoe Perches $fix) { 5391f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 5392f8e58219SJoe Perches } 53930979ae66SJoe Perches } 53940979ae66SJoe Perches 53954a0df2efSAndy Whitcroft# no volatiles please 53966c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 53976c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5398000d1cc1SJoe Perches WARN("VOLATILE", 53998c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 54004a0df2efSAndy Whitcroft } 54014a0df2efSAndy Whitcroft 54025e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 54035e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 54045e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 54055e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 540633acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 54075e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 54085e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 54095e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 54105e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 54115e4f6ba5SJoe Perches $fix && 54125e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 54135e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 54145e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 54155e4f6ba5SJoe Perches my $comma_close = ""; 54165e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 54175e4f6ba5SJoe Perches $comma_close = $1; 54185e4f6ba5SJoe Perches } 54195e4f6ba5SJoe Perches 54205e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 54215e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 54225e4f6ba5SJoe Perches my $fixedline = $prevrawline; 54235e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 54245e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 54255e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 54265e4f6ba5SJoe Perches $fixedline = $rawline; 54275e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 54285e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 54295e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 54305e4f6ba5SJoe Perches } 54315e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 54325e4f6ba5SJoe Perches } 54335e4f6ba5SJoe Perches } 54345e4f6ba5SJoe Perches 54355e4f6ba5SJoe Perches# check for missing a space in a string concatenation 54365e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 54375e4f6ba5SJoe Perches WARN('MISSING_SPACE', 54385e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 54395e4f6ba5SJoe Perches } 54405e4f6ba5SJoe Perches 544177cb8546SJoe Perches# check for an embedded function name in a string when the function is known 5442e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 5443e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 5444e4b7d309SJoe Perches# function declarations 544577cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 544677cb8546SJoe Perches defined($context_function) && 5447e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 5448e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 544977cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 5450e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 545177cb8546SJoe Perches } 545277cb8546SJoe Perches 54535e4f6ba5SJoe Perches# check for spaces before a quoted newline 54545e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 54555e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 54565e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 54575e4f6ba5SJoe Perches $fix) { 54585e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 54595e4f6ba5SJoe Perches } 54605e4f6ba5SJoe Perches 54615e4f6ba5SJoe Perches } 54625e4f6ba5SJoe Perches 5463f17dba4fSJoe Perches# concatenated string without spaces between elements 546479682c0cSJoe Perches if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) { 546579682c0cSJoe Perches if (CHK("CONCATENATED_STRING", 546679682c0cSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr) && 546779682c0cSJoe Perches $fix) { 546879682c0cSJoe Perches while ($line =~ /($String)/g) { 546979682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 547079682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/; 547179682c0cSJoe Perches $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/; 547279682c0cSJoe Perches } 547379682c0cSJoe Perches } 5474f17dba4fSJoe Perches } 5475f17dba4fSJoe Perches 547690ad30e5SJoe Perches# uncoalesced string fragments 547733acb54aSJoe Perches if ($line =~ /$String\s*"/) { 547879682c0cSJoe Perches if (WARN("STRING_FRAGMENTS", 547979682c0cSJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr) && 548079682c0cSJoe Perches $fix) { 548179682c0cSJoe Perches while ($line =~ /($String)(?=\s*")/g) { 548279682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 548379682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e; 548479682c0cSJoe Perches } 548579682c0cSJoe Perches } 548690ad30e5SJoe Perches } 548790ad30e5SJoe Perches 5488522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 5489522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 5490522b837cSAlexey Dobriyan my $show_Z = 1; 54915e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 5492522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 54935e4f6ba5SJoe Perches $string =~ s/%%/__/g; 5494522b837cSAlexey Dobriyan # check for %L 5495522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 54965e4f6ba5SJoe Perches WARN("PRINTF_L", 5497522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 5498522b837cSAlexey Dobriyan $show_L = 0; 54995e4f6ba5SJoe Perches } 5500522b837cSAlexey Dobriyan # check for %Z 5501522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 5502522b837cSAlexey Dobriyan WARN("PRINTF_Z", 5503522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 5504522b837cSAlexey Dobriyan $show_Z = 0; 5505522b837cSAlexey Dobriyan } 5506522b837cSAlexey Dobriyan # check for 0x<decimal> 5507522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 5508522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 55096e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 55106e300757SJoe Perches } 55115e4f6ba5SJoe Perches } 55125e4f6ba5SJoe Perches 55135e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 55143f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 55155e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 55165e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 55175e4f6ba5SJoe Perches } 55185e4f6ba5SJoe Perches 551900df344fSAndy Whitcroft# warn about #if 0 5520c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 552160f89010SPrakruthi Deepak Heragu WARN("IF_0", 552260f89010SPrakruthi Deepak Heragu "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr); 552360f89010SPrakruthi Deepak Heragu } 552460f89010SPrakruthi Deepak Heragu 552560f89010SPrakruthi Deepak Heragu# warn about #if 1 552660f89010SPrakruthi Deepak Heragu if ($line =~ /^.\s*\#\s*if\s+1\b/) { 552760f89010SPrakruthi Deepak Heragu WARN("IF_1", 552860f89010SPrakruthi Deepak Heragu "Consider removing the #if 1 and its #endif\n" . $herecurr); 55294a0df2efSAndy Whitcroft } 55304a0df2efSAndy Whitcroft 553103df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 553203df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5533100425deSJoe Perches my $tested = quotemeta($1); 5534100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5535100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5536100425deSJoe Perches my $func = $1; 5537100425deSJoe Perches if (WARN('NEEDLESS_IF', 5538100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5539100425deSJoe Perches $fix) { 5540100425deSJoe Perches my $do_fix = 1; 5541100425deSJoe Perches my $leading_tabs = ""; 5542100425deSJoe Perches my $new_leading_tabs = ""; 5543100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5544100425deSJoe Perches $leading_tabs = $1; 5545100425deSJoe Perches } else { 5546100425deSJoe Perches $do_fix = 0; 5547100425deSJoe Perches } 5548100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5549100425deSJoe Perches $new_leading_tabs = $1; 5550100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5551100425deSJoe Perches $do_fix = 0; 5552100425deSJoe Perches } 5553100425deSJoe Perches } else { 5554100425deSJoe Perches $do_fix = 0; 5555100425deSJoe Perches } 5556100425deSJoe Perches if ($do_fix) { 5557100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5558100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5559100425deSJoe Perches } 5560100425deSJoe Perches } 55614c432a8fSGreg Kroah-Hartman } 55624c432a8fSGreg Kroah-Hartman } 5563f0a594c1SAndy Whitcroft 5564ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5565ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5566ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5567ebfdc409SJoe Perches (defined $1 || defined $3) && 5568ebfdc409SJoe Perches $linenr > 3) { 5569ebfdc409SJoe Perches my $testval = $2; 5570ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5571ebfdc409SJoe Perches 5572ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5573ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5574ebfdc409SJoe Perches 5575e29a70f1SJoe Perches if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ && 5576e29a70f1SJoe Perches $s !~ /\b__GFP_NOWARN\b/ ) { 5577ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5578ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5579ebfdc409SJoe Perches } 5580ebfdc409SJoe Perches } 5581ebfdc409SJoe Perches 5582f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5583dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5584f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5585f78d98f6SJoe Perches my $level = $1; 5586f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5587f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5588f78d98f6SJoe Perches $fix) { 5589f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5590f78d98f6SJoe Perches } 5591f78d98f6SJoe Perches } 5592f78d98f6SJoe Perches 559345c55e92SJoe Perches# check for logging continuations 559445c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 559545c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 559645c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 559745c55e92SJoe Perches } 559845c55e92SJoe Perches 5599abb08a53SJoe Perches# check for mask then right shift without a parentheses 56005b57980dSJoe Perches if ($perl_version_ok && 5601abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5602abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5603abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5604abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5605abb08a53SJoe Perches } 5606abb08a53SJoe Perches 5607b75ac618SJoe Perches# check for pointer comparisons to NULL 56085b57980dSJoe Perches if ($perl_version_ok) { 5609b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5610b75ac618SJoe Perches my $val = $1; 5611b75ac618SJoe Perches my $equal = "!"; 5612b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5613b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5614b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5615b75ac618SJoe Perches $fix) { 5616b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5617b75ac618SJoe Perches } 5618b75ac618SJoe Perches } 5619b75ac618SJoe Perches } 5620b75ac618SJoe Perches 56218716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 56228716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 56238716de38SJoe Perches my $attr = $1; 56248716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 56258716de38SJoe Perches my $ptr = $1; 56268716de38SJoe Perches my $var = $2; 56278716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 56288716de38SJoe Perches ERROR("MISPLACED_INIT", 56298716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 56308716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 56318716de38SJoe Perches WARN("MISPLACED_INIT", 56328716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 56338716de38SJoe Perches $fix) { 5634194f66fcSJoe 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; 56358716de38SJoe Perches } 56368716de38SJoe Perches } 56378716de38SJoe Perches } 56388716de38SJoe Perches 5639e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5640e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5641e970b884SJoe Perches my $attr = $1; 5642e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5643e970b884SJoe Perches my $attr_prefix = $1; 5644e970b884SJoe Perches my $attr_type = $2; 5645e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5646e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5647e970b884SJoe Perches $fix) { 5648194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5649e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5650e970b884SJoe Perches } 5651e970b884SJoe Perches } 5652e970b884SJoe Perches 5653e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5654e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5655e970b884SJoe Perches my $attr = $1; 5656e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5657e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5658e970b884SJoe Perches $fix) { 5659194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5660e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5661e970b884SJoe Perches $lead = rtrim($1); 5662e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5663e970b884SJoe Perches $lead = "${lead}const "; 5664194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5665e970b884SJoe Perches } 5666e970b884SJoe Perches } 5667e970b884SJoe Perches 5668c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5669c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5670c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5671c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5672c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5673c17893c7SJoe Perches $fix) { 5674c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5675c17893c7SJoe Perches } 5676c17893c7SJoe Perches } 5677c17893c7SJoe Perches 5678fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5679fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5680fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5681fbdb8138SJoe Perches my $constant_func = $1; 5682fbdb8138SJoe Perches my $func = $constant_func; 5683fbdb8138SJoe Perches $func =~ s/^__constant_//; 5684fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5685fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5686fbdb8138SJoe Perches $fix) { 5687194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5688fbdb8138SJoe Perches } 5689fbdb8138SJoe Perches } 5690fbdb8138SJoe Perches 56911a15a250SPatrick Pannuto# prefer usleep_range over udelay 569237581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 569343c1d77cSJoe Perches my $delay = $1; 56941a15a250SPatrick Pannuto # ignore udelay's < 10, however 569543c1d77cSJoe Perches if (! ($delay < 10) ) { 5696000d1cc1SJoe Perches CHK("USLEEP_RANGE", 569743c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 569843c1d77cSJoe Perches } 569943c1d77cSJoe Perches if ($delay > 2000) { 570043c1d77cSJoe Perches WARN("LONG_UDELAY", 570143c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 57021a15a250SPatrick Pannuto } 57031a15a250SPatrick Pannuto } 57041a15a250SPatrick Pannuto 570509ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 570609ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 570709ef8725SPatrick Pannuto if ($1 < 20) { 5708000d1cc1SJoe Perches WARN("MSLEEP", 570943c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 571009ef8725SPatrick Pannuto } 571109ef8725SPatrick Pannuto } 571209ef8725SPatrick Pannuto 571336ec1939SJoe Perches# check for comparisons of jiffies 571436ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 571536ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 571636ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 571736ec1939SJoe Perches } 571836ec1939SJoe Perches 57199d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 57209d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 57219d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 57229d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 57239d7a34a5SJoe Perches } 57249d7a34a5SJoe Perches 572500df344fSAndy Whitcroft# warn about #ifdefs in C files 5726c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 572700df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 572800df344fSAndy Whitcroft# print "$herecurr"; 572900df344fSAndy Whitcroft# $clean = 0; 573000df344fSAndy Whitcroft# } 573100df344fSAndy Whitcroft 573222f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5733c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 57343705ce5bSJoe Perches if (ERROR("SPACING", 57353705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 57363705ce5bSJoe Perches $fix) { 5737194f66fcSJoe Perches $fixed[$fixlinenr] =~ 57383705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 57393705ce5bSJoe Perches } 57403705ce5bSJoe Perches 574122f2a2efSAndy Whitcroft } 574222f2a2efSAndy Whitcroft 57434a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5744171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5745171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 57464a0df2efSAndy Whitcroft my $which = $1; 57474a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5748000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5749000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 57504a0df2efSAndy Whitcroft } 57514a0df2efSAndy Whitcroft } 57524a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5753402c2553SMichael S. Tsirkin 5754402c2553SMichael S. Tsirkin my $barriers = qr{ 5755402c2553SMichael S. Tsirkin mb| 5756402c2553SMichael S. Tsirkin rmb| 5757402c2553SMichael S. Tsirkin wmb| 5758402c2553SMichael S. Tsirkin read_barrier_depends 5759402c2553SMichael S. Tsirkin }x; 5760402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5761402c2553SMichael S. Tsirkin mb__before_atomic| 5762402c2553SMichael S. Tsirkin mb__after_atomic| 5763402c2553SMichael S. Tsirkin store_release| 5764402c2553SMichael S. Tsirkin load_acquire| 5765402c2553SMichael S. Tsirkin store_mb| 5766402c2553SMichael S. Tsirkin (?:$barriers) 5767402c2553SMichael S. Tsirkin }x; 5768402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5769402c2553SMichael S. Tsirkin (?:$barriers)| 577043e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 577143e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5772402c2553SMichael S. Tsirkin }x; 5773402c2553SMichael S. Tsirkin 5774402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 57754a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5776c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5777000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 57784a0df2efSAndy Whitcroft } 57794a0df2efSAndy Whitcroft } 57803ad81779SPaul E. McKenney 5781f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5782f4073b0fSMichael S. Tsirkin 5783f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5784f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5785f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5786f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5787f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5788f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5789f4073b0fSMichael S. Tsirkin } 5790f4073b0fSMichael S. Tsirkin 5791cb426e99SJoe Perches# check for waitqueue_active without a comment. 5792cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5793cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5794cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5795cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5796cb426e99SJoe Perches } 5797cb426e99SJoe Perches } 57983ad81779SPaul E. McKenney 579991db2592SPaul E. McKenney# check for smp_read_barrier_depends and read_barrier_depends 580091db2592SPaul E. McKenney if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) { 580191db2592SPaul E. McKenney WARN("READ_BARRIER_DEPENDS", 580291db2592SPaul E. McKenney "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr); 580391db2592SPaul E. McKenney } 580491db2592SPaul E. McKenney 58054a0df2efSAndy Whitcroft# check of hardware specific defines 5806c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5807000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5808000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 58090a920b5bSAndy Whitcroft } 5810653d4876SAndy Whitcroft 5811596ed45bSJoe Perches# check that the storage class is not after a type 5812596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 5813000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5814596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 5815596ed45bSJoe Perches } 5816596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 5817596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 5818596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 5819596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 5820596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 5821596ed45bSJoe Perches WARN("STORAGE_CLASS", 5822596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 5823d4977c78STobias Klauser } 5824d4977c78STobias Klauser 5825de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5826de7d4f0eSAndy Whitcroft# storage class and type. 58279c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 58289c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5829000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5830000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5831de7d4f0eSAndy Whitcroft } 5832de7d4f0eSAndy Whitcroft 58338905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 58342b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 58352b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5836d5e616fcSJoe Perches if (WARN("INLINE", 5837d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5838d5e616fcSJoe Perches $fix) { 5839194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5840d5e616fcSJoe Perches 5841d5e616fcSJoe Perches } 58428905a67cSAndy Whitcroft } 58438905a67cSAndy Whitcroft 58443d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 58452b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 58462b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5847000d1cc1SJoe Perches WARN("PREFER_PACKED", 5848000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 58493d130fd0SJoe Perches } 58503d130fd0SJoe Perches 585139b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 58522b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 58532b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5854000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5855000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 585639b7e287SJoe Perches } 585739b7e287SJoe Perches 58585f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 58592b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 58602b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5861d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5862d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5863d5e616fcSJoe Perches $fix) { 5864194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5865d5e616fcSJoe Perches 5866d5e616fcSJoe Perches } 58675f14d3bdSJoe Perches } 58685f14d3bdSJoe Perches 58696061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 58702b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 58712b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5872d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5873d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5874d5e616fcSJoe Perches $fix) { 5875194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5876d5e616fcSJoe Perches } 58776061d949SJoe Perches } 58786061d949SJoe Perches 5879619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 58805b57980dSJoe Perches if ($perl_version_ok && 5881619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5882619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5883619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5884619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5885619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5886619a908aSJoe Perches } 5887619a908aSJoe Perches 5888fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 5889e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5890fd39f904STomas Winkler $realfile !~ m@\btools/@ && 5891e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5892e6176fa4SJoe Perches my $type = $1; 5893e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5894e6176fa4SJoe Perches $type = $1; 5895e6176fa4SJoe Perches my $kernel_type = 'u'; 5896e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5897e6176fa4SJoe Perches $type =~ /(\d+)/; 5898e6176fa4SJoe Perches $kernel_type .= $1; 5899e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5900e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5901e6176fa4SJoe Perches $fix) { 5902e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5903e6176fa4SJoe Perches } 5904e6176fa4SJoe Perches } 5905e6176fa4SJoe Perches } 5906e6176fa4SJoe Perches 5907938224b5SJoe Perches# check for cast of C90 native int or longer types constants 5908938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 5909938224b5SJoe Perches my $cast = $1; 5910938224b5SJoe Perches my $const = $2; 5911938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 5912938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 5913938224b5SJoe Perches $fix) { 5914938224b5SJoe Perches my $suffix = ""; 5915938224b5SJoe Perches my $newconst = $const; 5916938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 5917938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 5918938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 5919938224b5SJoe Perches $suffix .= 'LL'; 5920938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 5921938224b5SJoe Perches $suffix .= 'L'; 5922938224b5SJoe Perches } 5923938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 5924938224b5SJoe Perches } 5925938224b5SJoe Perches } 5926938224b5SJoe Perches 59278f53a9b8SJoe Perches# check for sizeof(&) 59288f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5929000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5930000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 59318f53a9b8SJoe Perches } 59328f53a9b8SJoe Perches 593366c80b60SJoe Perches# check for sizeof without parenthesis 593466c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5935d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5936d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5937d5e616fcSJoe Perches $fix) { 5938194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5939d5e616fcSJoe Perches } 594066c80b60SJoe Perches } 594166c80b60SJoe Perches 594288982feaSJoe Perches# check for struct spinlock declarations 594388982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 594488982feaSJoe Perches WARN("USE_SPINLOCK_T", 594588982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 594688982feaSJoe Perches } 594788982feaSJoe Perches 5948a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 594906668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5950a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5951caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5952caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5953d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5954d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5955d5e616fcSJoe Perches $fix) { 5956194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5957d5e616fcSJoe Perches } 5958a6962d72SJoe Perches } 5959a6962d72SJoe Perches } 5960a6962d72SJoe Perches 59610b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 59625b57980dSJoe Perches if ($perl_version_ok && 59630b523769SJoe Perches defined $stat && 59640b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 59650b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 5966e3c6bc95STobin C. Harding my $stat_real; 5967e3c6bc95STobin C. Harding 59680b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 59690b523769SJoe Perches $lc = $lc + $linenr; 59700b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 5971ffe07513SJoe Perches my $specifier; 5972ffe07513SJoe Perches my $extension; 5973ffe07513SJoe Perches my $bad_specifier = ""; 59740b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 59750b523769SJoe Perches $fmt =~ s/%%//g; 5976e3c6bc95STobin C. Harding 5977e3c6bc95STobin C. Harding while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) { 5978e3c6bc95STobin C. Harding $specifier = $1; 5979e3c6bc95STobin C. Harding $extension = $2; 5980*4462996eSAlexandre Belloni if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOxt]/) { 5981e3c6bc95STobin C. Harding $bad_specifier = $specifier; 59820b523769SJoe Perches last; 59830b523769SJoe Perches } 5984e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 5985e3c6bc95STobin C. Harding if (!defined($stat_real)) { 5986e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 59870b523769SJoe Perches } 5988e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 5989e3c6bc95STobin 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"); 5990e3c6bc95STobin C. Harding } 5991e3c6bc95STobin C. Harding } 5992e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 59932a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 59941df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 59951df7338aSSergey Senozhatsky my $use = ""; 5996e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 59971df7338aSSergey Senozhatsky $ext_type = "Deprecated"; 59981df7338aSSergey Senozhatsky $use = " - use %pS instead"; 5999e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 60001df7338aSSergey Senozhatsky } 60012a9f9d85STobin C. Harding 60020b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 6003e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 6004e3c6bc95STobin C. Harding } 60050b523769SJoe Perches } 60060b523769SJoe Perches } 60070b523769SJoe Perches 6008554e165cSAndy Whitcroft# Check for misused memsets 60095b57980dSJoe Perches if ($perl_version_ok && 6010d1fe9c09SJoe Perches defined $stat && 60119e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 6012554e165cSAndy Whitcroft 6013d7c76ba7SJoe Perches my $ms_addr = $2; 6014d1fe9c09SJoe Perches my $ms_val = $7; 6015d1fe9c09SJoe Perches my $ms_size = $12; 6016d7c76ba7SJoe Perches 6017554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 6018554e165cSAndy Whitcroft ERROR("MEMSET", 6019d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 6020554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 6021554e165cSAndy Whitcroft WARN("MEMSET", 6022d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 6023d7c76ba7SJoe Perches } 6024d7c76ba7SJoe Perches } 6025d7c76ba7SJoe Perches 602698a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 60275b57980dSJoe Perches# if ($perl_version_ok && 6028f333195dSJoe Perches# defined $stat && 6029f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6030f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 6031f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 6032f333195dSJoe Perches# $fix) { 6033f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 6034f333195dSJoe Perches# } 6035f333195dSJoe Perches# } 603698a9bba5SJoe Perches 6037b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 60385b57980dSJoe Perches# if ($perl_version_ok && 6039f333195dSJoe Perches# defined $stat && 6040f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6041f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 6042f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 6043f333195dSJoe Perches# } 6044b6117d17SMateusz Kulikowski 60458617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 60468617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 60475b57980dSJoe Perches# if ($perl_version_ok && 6048f333195dSJoe Perches# defined $stat && 6049f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6050f333195dSJoe Perches# 6051f333195dSJoe Perches# my $ms_val = $7; 6052f333195dSJoe Perches# 6053f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 6054f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 6055f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 6056f333195dSJoe Perches# $fix) { 6057f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 6058f333195dSJoe Perches# } 6059f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 6060f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 6061f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 6062f333195dSJoe Perches# $fix) { 6063f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 6064f333195dSJoe Perches# } 6065f333195dSJoe Perches# } 6066f333195dSJoe Perches# } 60678617cd09SMateusz Kulikowski 6068d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 60695b57980dSJoe Perches if ($perl_version_ok && 6070d1fe9c09SJoe Perches defined $stat && 6071d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 6072d1fe9c09SJoe Perches if (defined $2 || defined $7) { 6073d7c76ba7SJoe Perches my $call = $1; 6074d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 6075d7c76ba7SJoe Perches my $arg1 = $3; 6076d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 6077d1fe9c09SJoe Perches my $arg2 = $8; 6078d7c76ba7SJoe Perches my $cast; 6079d7c76ba7SJoe Perches 6080d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 6081d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 6082d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 6083d7c76ba7SJoe Perches $cast = $cast1; 6084d7c76ba7SJoe Perches } else { 6085d7c76ba7SJoe Perches $cast = $cast2; 6086d7c76ba7SJoe Perches } 6087d7c76ba7SJoe Perches WARN("MINMAX", 6088d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 6089554e165cSAndy Whitcroft } 6090554e165cSAndy Whitcroft } 6091554e165cSAndy Whitcroft 60924a273195SJoe Perches# check usleep_range arguments 60935b57980dSJoe Perches if ($perl_version_ok && 60944a273195SJoe Perches defined $stat && 60954a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 60964a273195SJoe Perches my $min = $1; 60974a273195SJoe Perches my $max = $7; 60984a273195SJoe Perches if ($min eq $max) { 60994a273195SJoe Perches WARN("USLEEP_RANGE", 61004a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 61014a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 61024a273195SJoe Perches $min > $max) { 61034a273195SJoe Perches WARN("USLEEP_RANGE", 61044a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 61054a273195SJoe Perches } 61064a273195SJoe Perches } 61074a273195SJoe Perches 6108823b794cSJoe Perches# check for naked sscanf 61095b57980dSJoe Perches if ($perl_version_ok && 6110823b794cSJoe Perches defined $stat && 61116c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 6112823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 6113823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 6114823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 6115823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 6116823b794cSJoe Perches $lc = $lc + $linenr; 61172a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6118823b794cSJoe Perches WARN("NAKED_SSCANF", 6119823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 6120823b794cSJoe Perches } 6121823b794cSJoe Perches 6122afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 61235b57980dSJoe Perches if ($perl_version_ok && 6124afc819abSJoe Perches defined $stat && 6125afc819abSJoe Perches $line =~ /\bsscanf\b/) { 6126afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 6127afc819abSJoe Perches $lc = $lc + $linenr; 61282a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6129afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 6130afc819abSJoe Perches my $format = $6; 6131afc819abSJoe Perches my $count = $format =~ tr@%@%@; 6132afc819abSJoe Perches if ($count == 1 && 6133afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 6134afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 6135afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 6136afc819abSJoe Perches } 6137afc819abSJoe Perches } 6138afc819abSJoe Perches } 6139afc819abSJoe Perches 614070dc8a48SJoe Perches# check for new externs in .h files. 614170dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 614270dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 6143d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 614470dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 614570dc8a48SJoe Perches $fix) { 6146194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 614770dc8a48SJoe Perches } 614870dc8a48SJoe Perches } 614970dc8a48SJoe Perches 6150de7d4f0eSAndy Whitcroft# check for new externs in .c files. 6151171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 6152c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 6153171ae1a4SAndy Whitcroft { 6154c45dcabdSAndy Whitcroft my $function_name = $1; 6155c45dcabdSAndy Whitcroft my $paren_space = $2; 6156171ae1a4SAndy Whitcroft 6157171ae1a4SAndy Whitcroft my $s = $stat; 6158171ae1a4SAndy Whitcroft if (defined $cond) { 6159171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 6160171ae1a4SAndy Whitcroft } 6161c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 6162c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 6163c45dcabdSAndy Whitcroft { 6164000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6165000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6166de7d4f0eSAndy Whitcroft } 6167de7d4f0eSAndy Whitcroft 6168171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 6169000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 6170000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 6171171ae1a4SAndy Whitcroft } 61729c9ba34eSAndy Whitcroft 61739c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 61749c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 61759c9ba34eSAndy Whitcroft { 6176000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6177000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6178171ae1a4SAndy Whitcroft } 6179171ae1a4SAndy Whitcroft 6180a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 6181a0ad7596SJoe Perches if (defined $stat && 618225bdda2bSMiles Chen $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 6183ca0d8929SJoe Perches $1 ne "void") { 6184ca0d8929SJoe Perches my $args = trim($1); 6185ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6186ca0d8929SJoe Perches my $arg = trim($1); 6187ca0d8929SJoe Perches if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 6188ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 6189ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6190ca0d8929SJoe Perches } 6191ca0d8929SJoe Perches } 6192ca0d8929SJoe Perches } 6193ca0d8929SJoe Perches 6194a0ad7596SJoe Perches# check for function definitions 61955b57980dSJoe Perches if ($perl_version_ok && 6196a0ad7596SJoe Perches defined $stat && 6197a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6198a0ad7596SJoe Perches $context_function = $1; 6199a0ad7596SJoe Perches 6200a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 6201a0ad7596SJoe Perches my $ok = 0; 6202a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 6203a0ad7596SJoe Perches my $herectx = $here . "\n"; 6204a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6205a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 6206a0ad7596SJoe Perches $herectx .= $rl . "\n"; 6207a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 6208a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 6209a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 6210a0ad7596SJoe Perches } 6211a0ad7596SJoe Perches if (!$ok) { 6212a0ad7596SJoe Perches ERROR("OPEN_BRACE", 6213a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 6214a0ad7596SJoe Perches } 6215a0ad7596SJoe Perches } 6216a0ad7596SJoe Perches 6217de7d4f0eSAndy Whitcroft# checks for new __setup's 6218de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 6219de7d4f0eSAndy Whitcroft my $name = $1; 6220de7d4f0eSAndy Whitcroft 6221de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 6222000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 62238c27ceffSMauro Carvalho Chehab "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr); 6224de7d4f0eSAndy Whitcroft } 6225653d4876SAndy Whitcroft } 62269c0ca6f9SAndy Whitcroft 6227e29a70f1SJoe Perches# check for pointless casting of alloc functions 6228e29a70f1SJoe Perches if ($line =~ /\*\s*\)\s*$allocFunctions\b/) { 6229000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 6230000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 62319c0ca6f9SAndy Whitcroft } 623213214adfSAndy Whitcroft 6233a640d25cSJoe Perches# alloc style 6234a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 62355b57980dSJoe Perches if ($perl_version_ok && 6236e29a70f1SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 6237a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 6238a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 6239a640d25cSJoe Perches } 6240a640d25cSJoe Perches 624160a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 62425b57980dSJoe Perches if ($perl_version_ok && 62431b4a2ed4SJoe Perches defined $stat && 62441b4a2ed4SJoe Perches $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 624560a55369SJoe Perches my $oldfunc = $3; 624660a55369SJoe Perches my $a1 = $4; 624760a55369SJoe Perches my $a2 = $10; 624860a55369SJoe Perches my $newfunc = "kmalloc_array"; 624960a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 625060a55369SJoe Perches my $r1 = $a1; 625160a55369SJoe Perches my $r2 = $a2; 625260a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 625360a55369SJoe Perches $r1 = $a2; 625460a55369SJoe Perches $r2 = $a1; 625560a55369SJoe Perches } 6256e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 6257e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 62581b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 6259e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6260e3d95a2aSTobin C. Harding 6261e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 62621b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 62631b4a2ed4SJoe Perches $cnt == 1 && 6264e367455aSJoe Perches $fix) { 6265194f66fcSJoe 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; 626660a55369SJoe Perches } 626760a55369SJoe Perches } 626860a55369SJoe Perches } 626960a55369SJoe Perches 6270972fdea2SJoe Perches# check for krealloc arg reuse 62715b57980dSJoe Perches if ($perl_version_ok && 62724cab63ceSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ && 62734cab63ceSJoe Perches $1 eq $3) { 6274972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 6275972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 6276972fdea2SJoe Perches } 6277972fdea2SJoe Perches 62785ce59ae0SJoe Perches# check for alloc argument mismatch 62795ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 62805ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 62815ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 62825ce59ae0SJoe Perches } 62835ce59ae0SJoe Perches 6284caf2a54fSJoe Perches# check for multiple semicolons 6285caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 6286d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 6287d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 6288d5e616fcSJoe Perches $fix) { 6289194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 6290d5e616fcSJoe Perches } 6291d1e2ad07SJoe Perches } 6292d1e2ad07SJoe Perches 6293cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 6294cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 6295cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 62960ab90191SJoe Perches my $ull = ""; 62970ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 62980ab90191SJoe Perches if (CHK("BIT_MACRO", 62990ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 63000ab90191SJoe Perches $fix) { 63010ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 63020ab90191SJoe Perches } 63030ab90191SJoe Perches } 63040ab90191SJoe Perches 63052d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 63062d632745SJoe 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*$/) { 63072d632745SJoe Perches my $config = $1; 63082d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 63092d632745SJoe Perches "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) && 63102d632745SJoe Perches $fix) { 63112d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 63122d632745SJoe Perches } 63132d632745SJoe Perches } 63142d632745SJoe Perches 6315e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 6316c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 6317c34c09a8SJoe Perches my $has_break = 0; 6318c34c09a8SJoe Perches my $has_statement = 0; 6319c34c09a8SJoe Perches my $count = 0; 6320c34c09a8SJoe Perches my $prevline = $linenr; 6321e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 6322c34c09a8SJoe Perches $prevline--; 6323c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 6324c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 6325c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 6326c34c09a8SJoe Perches next if ($fline =~ /^\-/); 6327c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 6328c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 6329c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 6330c34c09a8SJoe Perches $has_statement = 1; 6331c34c09a8SJoe Perches $count++; 6332258f79d5SHeinrich Schuchardt $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/); 6333c34c09a8SJoe Perches } 6334c34c09a8SJoe Perches if (!$has_break && $has_statement) { 6335c34c09a8SJoe Perches WARN("MISSING_BREAK", 6336224236d9SAndrew Morton "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr); 6337c34c09a8SJoe Perches } 6338c34c09a8SJoe Perches } 6339c34c09a8SJoe Perches 6340d1e2ad07SJoe Perches# check for switch/default statements without a break; 63415b57980dSJoe Perches if ($perl_version_ok && 6342d1e2ad07SJoe Perches defined $stat && 6343d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 6344d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 6345e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6346e3d95a2aSTobin C. Harding 6347d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 6348d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 6349caf2a54fSJoe Perches } 6350caf2a54fSJoe Perches 635113214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 6352d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 6353d5e616fcSJoe Perches if (WARN("USE_FUNC", 6354d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 6355d5e616fcSJoe Perches $fix) { 6356194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 6357d5e616fcSJoe Perches } 635813214adfSAndy Whitcroft } 6359773647a0SAndy Whitcroft 636062ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 636162ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 636262ec818fSJoe Perches ERROR("DATE_TIME", 636362ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 636462ec818fSJoe Perches } 636562ec818fSJoe Perches 63662c92488aSJoe Perches# check for use of yield() 63672c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 63682c92488aSJoe Perches WARN("YIELD", 63692c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 63702c92488aSJoe Perches } 63712c92488aSJoe Perches 6372179f8f40SJoe Perches# check for comparisons against true and false 6373179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 6374179f8f40SJoe Perches my $lead = $1; 6375179f8f40SJoe Perches my $arg = $2; 6376179f8f40SJoe Perches my $test = $3; 6377179f8f40SJoe Perches my $otype = $4; 6378179f8f40SJoe Perches my $trail = $5; 6379179f8f40SJoe Perches my $op = "!"; 6380179f8f40SJoe Perches 6381179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 6382179f8f40SJoe Perches 6383179f8f40SJoe Perches my $type = lc($otype); 6384179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 6385179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 6386179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 6387179f8f40SJoe Perches $op = ""; 6388179f8f40SJoe Perches } 6389179f8f40SJoe Perches 6390179f8f40SJoe Perches CHK("BOOL_COMPARISON", 6391179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 6392179f8f40SJoe Perches 6393179f8f40SJoe Perches## maybe suggesting a correct construct would better 6394179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 6395179f8f40SJoe Perches 6396179f8f40SJoe Perches } 6397179f8f40SJoe Perches } 6398179f8f40SJoe Perches 63994882720bSThomas Gleixner# check for semaphores initialized locked 64004882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 6401000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 6402000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 6403773647a0SAndy Whitcroft } 64046712d858SJoe Perches 640567d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 640667d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 6407000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 640867d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 6409773647a0SAndy Whitcroft } 64106712d858SJoe Perches 6411ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 6412f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 6413000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 6414ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 6415f3db6639SMichael Ellerman } 64166712d858SJoe Perches 64173d709ab5SPaul E. McKenney# check for spin_is_locked(), suggest lockdep instead 64183d709ab5SPaul E. McKenney if ($line =~ /\bspin_is_locked\(/) { 64193d709ab5SPaul E. McKenney WARN("USE_LOCKDEP", 64203d709ab5SPaul E. McKenney "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr); 64213d709ab5SPaul E. McKenney } 64223d709ab5SPaul E. McKenney 64239189c7e7SJoe Perches# check for deprecated apis 64249189c7e7SJoe Perches if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) { 64259189c7e7SJoe Perches my $deprecated_api = $1; 64269189c7e7SJoe Perches my $new_api = $deprecated_apis{$deprecated_api}; 64279189c7e7SJoe Perches WARN("DEPRECATED_API", 64289189c7e7SJoe Perches "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr); 64299189c7e7SJoe Perches } 64309189c7e7SJoe Perches 64310f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 6432d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 64336903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 6434d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 6435000d1cc1SJoe Perches WARN("CONST_STRUCT", 6436d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 64372b6db5cbSAndy Whitcroft } 6438773647a0SAndy Whitcroft 6439773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 6440773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 6441773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 6442c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 6443c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 6444171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 6445171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 6446171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 6447773647a0SAndy Whitcroft { 6448000d1cc1SJoe Perches WARN("NR_CPUS", 6449000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 6450773647a0SAndy Whitcroft } 64519c9ba34eSAndy Whitcroft 645252ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 645352ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 645452ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 645552ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 645652ea8506SJoe Perches } 645752ea8506SJoe Perches 6458acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 64595b57980dSJoe Perches if ($perl_version_ok && 6460acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 6461acd9362cSJoe Perches WARN("LIKELY_MISUSE", 6462acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 6463acd9362cSJoe Perches } 6464acd9362cSJoe Perches 6465691d77b6SAndy Whitcroft# whine mightly about in_atomic 6466691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 6467691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 6468000d1cc1SJoe Perches ERROR("IN_ATOMIC", 6469000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 6470f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 6471000d1cc1SJoe Perches WARN("IN_ATOMIC", 6472000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 6473691d77b6SAndy Whitcroft } 6474691d77b6SAndy Whitcroft } 64751704f47bSPeter Zijlstra 64760f5225b0SPeter Zijlstra# check for mutex_trylock_recursive usage 64770f5225b0SPeter Zijlstra if ($line =~ /mutex_trylock_recursive/) { 64780f5225b0SPeter Zijlstra ERROR("LOCKING", 64790f5225b0SPeter Zijlstra "recursive locking is bad, do not use this ever.\n" . $herecurr); 64800f5225b0SPeter Zijlstra } 64810f5225b0SPeter Zijlstra 64821704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 64831704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 64841704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 64851704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 64861704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 64871704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 6488000d1cc1SJoe Perches ERROR("LOCKDEP", 6489000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 64901704f47bSPeter Zijlstra } 64911704f47bSPeter Zijlstra } 649288f8831cSDave Jones 6493b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 6494b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 6495000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 6496000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 649788f8831cSDave Jones } 64982435880fSJoe Perches 649900180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 650000180468SJoe Perches# and whether or not function naming is typical and if 650100180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 65025b57980dSJoe Perches if ($perl_version_ok && 650300180468SJoe Perches defined $stat && 650400180468SJoe 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*\)/) { 650500180468SJoe Perches my $var = $1; 650600180468SJoe Perches my $perms = $2; 650700180468SJoe Perches my $show = $3; 650800180468SJoe Perches my $store = $4; 650900180468SJoe Perches my $octal_perms = perms_to_octal($perms); 651000180468SJoe Perches if ($show =~ /^${var}_show$/ && 651100180468SJoe Perches $store =~ /^${var}_store$/ && 651200180468SJoe Perches $octal_perms eq "0644") { 651300180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 651400180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 651500180468SJoe Perches $fix) { 651600180468SJoe 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})/; 651700180468SJoe Perches } 651800180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 651900180468SJoe Perches $store =~ /^NULL$/ && 652000180468SJoe Perches $octal_perms eq "0444") { 652100180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 652200180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 652300180468SJoe Perches $fix) { 652400180468SJoe 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})/; 652500180468SJoe Perches } 652600180468SJoe Perches } elsif ($show =~ /^NULL$/ && 652700180468SJoe Perches $store =~ /^${var}_store$/ && 652800180468SJoe Perches $octal_perms eq "0200") { 652900180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 653000180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 653100180468SJoe Perches $fix) { 653200180468SJoe 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})/; 653300180468SJoe Perches } 653400180468SJoe Perches } elsif ($octal_perms eq "0644" || 653500180468SJoe Perches $octal_perms eq "0444" || 653600180468SJoe Perches $octal_perms eq "0200") { 653700180468SJoe Perches my $newshow = "$show"; 653800180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 653900180468SJoe Perches my $newstore = $store; 654000180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 654100180468SJoe Perches my $rename = ""; 654200180468SJoe Perches if ($show ne $newshow) { 654300180468SJoe Perches $rename .= " '$show' to '$newshow'"; 654400180468SJoe Perches } 654500180468SJoe Perches if ($store ne $newstore) { 654600180468SJoe Perches $rename .= " '$store' to '$newstore'"; 654700180468SJoe Perches } 654800180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 654900180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 655000180468SJoe Perches } else { 655100180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 655200180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 655300180468SJoe Perches } 655400180468SJoe Perches } 655500180468SJoe Perches 6556515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 6557515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 655873121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 655973121534SJoe Perches# specific definition of not visible in sysfs. 656073121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 656173121534SJoe Perches# use the default permissions 65625b57980dSJoe Perches if ($perl_version_ok && 6563459cf0aeSJoe Perches defined $stat && 6564515a235eSJoe Perches $line =~ /$mode_perms_search/) { 65652435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 65662435880fSJoe Perches my $func = $entry->[0]; 65672435880fSJoe Perches my $arg_pos = $entry->[1]; 65682435880fSJoe Perches 6569459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 6570459cf0aeSJoe Perches $lc = $lc + $linenr; 65712a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6572459cf0aeSJoe Perches 65732435880fSJoe Perches my $skip_args = ""; 65742435880fSJoe Perches if ($arg_pos > 1) { 65752435880fSJoe Perches $arg_pos--; 65762435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 65772435880fSJoe Perches } 6578f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 6579459cf0aeSJoe Perches if ($stat =~ /$test/) { 65802435880fSJoe Perches my $val = $1; 65812435880fSJoe Perches $val = $6 if ($skip_args ne ""); 658273121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 658373121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 658473121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 65852435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 6586459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 6587f90774e1SJoe Perches } 6588f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6589c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6590459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 65912435880fSJoe Perches } 6592459cf0aeSJoe Perches } 6593459cf0aeSJoe Perches } 6594459cf0aeSJoe Perches } 6595459cf0aeSJoe Perches 6596459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 6597bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 659800180468SJoe Perches my $oval = $1; 659900180468SJoe Perches my $octal = perms_to_octal($oval); 6600f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 6601459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 6602f90774e1SJoe Perches $fix) { 660300180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 66042435880fSJoe Perches } 660513214adfSAndy Whitcroft } 66065a6d20ceSBjorn Andersson 66075a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 66085a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 66095a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 66105a6d20ceSBjorn Andersson my $valid_licenses = qr{ 66115a6d20ceSBjorn Andersson GPL| 66125a6d20ceSBjorn Andersson GPL\ v2| 66135a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 66145a6d20ceSBjorn Andersson Dual\ BSD/GPL| 66155a6d20ceSBjorn Andersson Dual\ MIT/GPL| 66165a6d20ceSBjorn Andersson Dual\ MPL/GPL| 66175a6d20ceSBjorn Andersson Proprietary 66185a6d20ceSBjorn Andersson }x; 66195a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 66205a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 66215a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 66225a6d20ceSBjorn Andersson } 66235a6d20ceSBjorn Andersson } 6624515a235eSJoe Perches } 662513214adfSAndy Whitcroft 662613214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 662713214adfSAndy Whitcroft # so just keep quiet. 662813214adfSAndy Whitcroft if ($#rawlines == -1) { 662913214adfSAndy Whitcroft exit(0); 66300a920b5bSAndy Whitcroft } 66310a920b5bSAndy Whitcroft 66328905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 66338905a67cSAndy Whitcroft # things that appear to be patches. 66348905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 66358905a67cSAndy Whitcroft exit(0); 66368905a67cSAndy Whitcroft } 66378905a67cSAndy Whitcroft 66388905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 66398905a67cSAndy Whitcroft # just keep quiet. 66408905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 66418905a67cSAndy Whitcroft exit(0); 66428905a67cSAndy Whitcroft } 66438905a67cSAndy Whitcroft 6644a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 6645000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6646000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 66470a920b5bSAndy Whitcroft } 6648cd261496SGeert Uytterhoeven if ($is_patch && $has_commit_log && $chk_signoff) { 6649cd261496SGeert Uytterhoeven if ($signoff == 0) { 6650000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6651000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 6652cd261496SGeert Uytterhoeven } elsif (!$authorsignoff) { 6653cd261496SGeert Uytterhoeven WARN("NO_AUTHOR_SIGN_OFF", 6654cd261496SGeert Uytterhoeven "Missing Signed-off-by: line by nominal patch author '$author'\n"); 6655cd261496SGeert Uytterhoeven } 66560a920b5bSAndy Whitcroft } 66570a920b5bSAndy Whitcroft 6658f0a594c1SAndy Whitcroft print report_dump(); 665913214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 666013214adfSAndy Whitcroft print "$filename " if ($summary_file); 66616c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 66626c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 66636c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 66646c72ffaaSAndy Whitcroft } 66658905a67cSAndy Whitcroft 6666d2c0a235SAndy Whitcroft if ($quiet == 0) { 6667ef212196SJoe Perches # If there were any defects found and not already fixing them 6668ef212196SJoe Perches if (!$clean and !$fix) { 6669ef212196SJoe Perches print << "EOM" 6670ef212196SJoe Perches 6671ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 6672ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 6673ef212196SJoe PerchesEOM 6674ef212196SJoe Perches } 6675d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 6676d2c0a235SAndy Whitcroft # then suggest that. 6677d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 6678b0781216SMike Frysinger $rpt_cleaners = 0; 6679d8469f16SJoe Perches print << "EOM" 6680d8469f16SJoe Perches 6681d8469f16SJoe PerchesNOTE: Whitespace errors detected. 6682d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 6683d8469f16SJoe PerchesEOM 6684d2c0a235SAndy Whitcroft } 6685d2c0a235SAndy Whitcroft } 6686d2c0a235SAndy Whitcroft 6687d752fcc8SJoe Perches if ($clean == 0 && $fix && 6688d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 6689d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 66909624b8d6SJoe Perches my $newfile = $filename; 66919624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 66923705ce5bSJoe Perches my $linecount = 0; 66933705ce5bSJoe Perches my $f; 66943705ce5bSJoe Perches 6695d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 6696d752fcc8SJoe Perches 66973705ce5bSJoe Perches open($f, '>', $newfile) 66983705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 66993705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 67003705ce5bSJoe Perches $linecount++; 67013705ce5bSJoe Perches if ($file) { 67023705ce5bSJoe Perches if ($linecount > 3) { 67033705ce5bSJoe Perches $fixed_line =~ s/^\+//; 67043705ce5bSJoe Perches print $f $fixed_line . "\n"; 67053705ce5bSJoe Perches } 67063705ce5bSJoe Perches } else { 67073705ce5bSJoe Perches print $f $fixed_line . "\n"; 67083705ce5bSJoe Perches } 67093705ce5bSJoe Perches } 67103705ce5bSJoe Perches close($f); 67113705ce5bSJoe Perches 67123705ce5bSJoe Perches if (!$quiet) { 67133705ce5bSJoe Perches print << "EOM"; 6714d8469f16SJoe Perches 67153705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 67163705ce5bSJoe Perches 67173705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 67183705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 67193705ce5bSJoe Perches 67203705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 67213705ce5bSJoe PerchesNo warranties, expressed or implied... 67223705ce5bSJoe PerchesEOM 67233705ce5bSJoe Perches } 67243705ce5bSJoe Perches } 67253705ce5bSJoe Perches 6726d8469f16SJoe Perches if ($quiet == 0) { 6727d8469f16SJoe Perches print "\n"; 6728d8469f16SJoe Perches if ($clean == 1) { 6729d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 6730d8469f16SJoe Perches } else { 6731d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 67320a920b5bSAndy Whitcroft } 67330a920b5bSAndy Whitcroft } 67340a920b5bSAndy Whitcroft return $clean; 67350a920b5bSAndy Whitcroft} 6736