1cb77f0d6SKamil Rytarowski#!/usr/bin/env perl 2882ea1d6SJoe Perches# SPDX-License-Identifier: GPL-2.0 3882ea1d6SJoe Perches# 4dbf004d7SDave Jones# (c) 2001, Dave Jones. (the file handling bit) 500df344fSAndy Whitcroft# (c) 2005, Joel Schopp <[email protected]> (the ugly bit) 62a5a2c25SAndy Whitcroft# (c) 2007,2008, Andy Whitcroft <[email protected]> (new conditions, test suite) 7015830beSAndy Whitcroft# (c) 2008-2010 Andy Whitcroft <[email protected]> 8882ea1d6SJoe Perches# (c) 2010-2018 Joe Perches <[email protected]> 90a920b5bSAndy Whitcroft 100a920b5bSAndy Whitcroftuse strict; 11cb77f0d6SKamil Rytarowskiuse warnings; 12c707a81dSJoe Perchesuse POSIX; 1336061e38SJoe Perchesuse File::Basename; 1436061e38SJoe Perchesuse Cwd 'abs_path'; 1557230297SJoe Perchesuse Term::ANSIColor qw(:constants); 16cd261496SGeert Uytterhoevenuse Encode qw(decode encode); 170a920b5bSAndy Whitcroft 180a920b5bSAndy Whitcroftmy $P = $0; 1936061e38SJoe Perchesmy $D = dirname(abs_path($P)); 200a920b5bSAndy Whitcroft 21000d1cc1SJoe Perchesmy $V = '0.32'; 220a920b5bSAndy Whitcroft 230a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 240a920b5bSAndy Whitcroft 250a920b5bSAndy Whitcroftmy $quiet = 0; 260a920b5bSAndy Whitcroftmy $tree = 1; 270a920b5bSAndy Whitcroftmy $chk_signoff = 1; 280a920b5bSAndy Whitcroftmy $chk_patch = 1; 29773647a0SAndy Whitcroftmy $tst_only; 306c72ffaaSAndy Whitcroftmy $emacs = 0; 318905a67cSAndy Whitcroftmy $terse = 0; 3234d8815fSJoe Perchesmy $showfile = 0; 336c72ffaaSAndy Whitcroftmy $file = 0; 344a593c34SDu, Changbinmy $git = 0; 350dea9f1eSJoe Perchesmy %git_commits = (); 366c72ffaaSAndy Whitcroftmy $check = 0; 372ac73b4fSJoe Perchesmy $check_orig = 0; 388905a67cSAndy Whitcroftmy $summary = 1; 398905a67cSAndy Whitcroftmy $mailback = 0; 4013214adfSAndy Whitcroftmy $summary_file = 0; 41000d1cc1SJoe Perchesmy $show_types = 0; 423beb42ecSJoe Perchesmy $list_types = 0; 433705ce5bSJoe Perchesmy $fix = 0; 449624b8d6SJoe Perchesmy $fix_inplace = 0; 456c72ffaaSAndy Whitcroftmy $root; 46c2fdda0dSAndy Whitcroftmy %debug; 473445686aSJoe Perchesmy %camelcase = (); 4891bfe484SJoe Perchesmy %use_type = (); 4991bfe484SJoe Perchesmy @use = (); 5091bfe484SJoe Perchesmy %ignore_type = (); 51000d1cc1SJoe Perchesmy @ignore = (); 5277f5b10aSHannes Edermy $help = 0; 53000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 546cd7f386SJoe Perchesmy $max_line_length = 80; 55d62a201fSDave Hansenmy $ignore_perl_version = 0; 56d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 5756193274SVadim Bendeburymy $min_conf_desc_length = 4; 5866b47b4aSKees Cookmy $spelling_file = "$D/spelling.txt"; 59ebfd7d62SJoe Perchesmy $codespell = 0; 60f1a63678SMaxim Uvarovmy $codespellfile = "/usr/share/codespell/dictionary.txt"; 61bf1fa1daSJoe Perchesmy $conststructsfile = "$D/const_structs.checkpatch"; 6275ad8c57SJerome Forissiermy $typedefsfile = ""; 63737c0767SJohn Brooksmy $color = "auto"; 64dadf680dSJoe Perchesmy $allow_c99_comments = 1; 6577f5b10aSHannes Eder 6677f5b10aSHannes Edersub help { 6777f5b10aSHannes Eder my ($exitcode) = @_; 6877f5b10aSHannes Eder 6977f5b10aSHannes Eder print << "EOM"; 7077f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 7177f5b10aSHannes EderVersion: $V 7277f5b10aSHannes Eder 7377f5b10aSHannes EderOptions: 7477f5b10aSHannes Eder -q, --quiet quiet 7577f5b10aSHannes Eder --no-tree run without a kernel tree 7677f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 7777f5b10aSHannes Eder --patch treat FILE as patchfile (default) 7877f5b10aSHannes Eder --emacs emacs compile window format 7977f5b10aSHannes Eder --terse one line per report 8034d8815fSJoe Perches --showfile emit diffed file position, not input file position 814a593c34SDu, Changbin -g, --git treat FILE as a single commit or git revision range 824a593c34SDu, Changbin single git commit with: 834a593c34SDu, Changbin <rev> 844a593c34SDu, Changbin <rev>^ 854a593c34SDu, Changbin <rev>~n 864a593c34SDu, Changbin multiple git commits with: 874a593c34SDu, Changbin <rev1>..<rev2> 884a593c34SDu, Changbin <rev1>...<rev2> 894a593c34SDu, Changbin <rev>-<count> 904a593c34SDu, Changbin git merges are ignored 9177f5b10aSHannes Eder -f, --file treat FILE as regular source file 9277f5b10aSHannes Eder --subjective, --strict enable more subjective tests 933beb42ecSJoe Perches --list-types list the possible message types 9491bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 95000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 963beb42ecSJoe Perches --show-types show the specific message type in the output 976cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 9856193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 9977f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 10077f5b10aSHannes Eder --no-summary suppress the per-file summary 10177f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 10277f5b10aSHannes Eder --summary-file include the filename in summary 10377f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 10477f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 10577f5b10aSHannes Eder is all off) 10677f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 10777f5b10aSHannes Eder literally 1083705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 1093705ce5bSJoe Perches If correctable single-line errors exist, create 1103705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 1113705ce5bSJoe Perches with potential errors corrected to the preferred 1123705ce5bSJoe Perches checkpatch style 1139624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 1149624b8d6SJoe Perches Is the same as --fix, but overwrites the input 1159624b8d6SJoe Perches file. It's your fault if there's no backup or git 116d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 117d62a201fSDave Hansen runtime errors. 118ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 119f1a63678SMaxim Uvarov (default:/usr/share/codespell/dictionary.txt) 120ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 12175ad8c57SJerome Forissier --typedefsfile Read additional types from this file 122737c0767SJohn Brooks --color[=WHEN] Use colors 'always', 'never', or only when output 123737c0767SJohn Brooks is a terminal ('auto'). Default is 'auto'. 12477f5b10aSHannes Eder -h, --help, --version display this help and exit 12577f5b10aSHannes Eder 12677f5b10aSHannes EderWhen FILE is - read standard input. 12777f5b10aSHannes EderEOM 12877f5b10aSHannes Eder 12977f5b10aSHannes Eder exit($exitcode); 13077f5b10aSHannes Eder} 13177f5b10aSHannes Eder 1323beb42ecSJoe Perchessub uniq { 1333beb42ecSJoe Perches my %seen; 1343beb42ecSJoe Perches return grep { !$seen{$_}++ } @_; 1353beb42ecSJoe Perches} 1363beb42ecSJoe Perches 1373beb42ecSJoe Perchessub list_types { 1383beb42ecSJoe Perches my ($exitcode) = @_; 1393beb42ecSJoe Perches 1403beb42ecSJoe Perches my $count = 0; 1413beb42ecSJoe Perches 1423beb42ecSJoe Perches local $/ = undef; 1433beb42ecSJoe Perches 1443beb42ecSJoe Perches open(my $script, '<', abs_path($P)) or 1453beb42ecSJoe Perches die "$P: Can't read '$P' $!\n"; 1463beb42ecSJoe Perches 1473beb42ecSJoe Perches my $text = <$script>; 1483beb42ecSJoe Perches close($script); 1493beb42ecSJoe Perches 1503beb42ecSJoe Perches my @types = (); 1510547fa58SJean Delvare # Also catch when type or level is passed through a variable 1520547fa58SJean Delvare for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) { 1533beb42ecSJoe Perches push (@types, $_); 1543beb42ecSJoe Perches } 1553beb42ecSJoe Perches @types = sort(uniq(@types)); 1563beb42ecSJoe Perches print("#\tMessage type\n\n"); 1573beb42ecSJoe Perches foreach my $type (@types) { 1583beb42ecSJoe Perches print(++$count . "\t" . $type . "\n"); 1593beb42ecSJoe Perches } 1603beb42ecSJoe Perches 1613beb42ecSJoe Perches exit($exitcode); 1623beb42ecSJoe Perches} 1633beb42ecSJoe Perches 164000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 165000d1cc1SJoe Perchesif (-f $conf) { 166000d1cc1SJoe Perches my @conf_args; 167000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 168000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 169000d1cc1SJoe Perches 170000d1cc1SJoe Perches while (<$conffile>) { 171000d1cc1SJoe Perches my $line = $_; 172000d1cc1SJoe Perches 173000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 174000d1cc1SJoe Perches $line =~ s/^\s*//g; 175000d1cc1SJoe Perches $line =~ s/\s+/ /g; 176000d1cc1SJoe Perches 177000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 178000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 179000d1cc1SJoe Perches 180000d1cc1SJoe Perches my @words = split(" ", $line); 181000d1cc1SJoe Perches foreach my $word (@words) { 182000d1cc1SJoe Perches last if ($word =~ m/^#/); 183000d1cc1SJoe Perches push (@conf_args, $word); 184000d1cc1SJoe Perches } 185000d1cc1SJoe Perches } 186000d1cc1SJoe Perches close($conffile); 187000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 188000d1cc1SJoe Perches} 189000d1cc1SJoe Perches 190737c0767SJohn Brooks# Perl's Getopt::Long allows options to take optional arguments after a space. 191737c0767SJohn Brooks# Prevent --color by itself from consuming other arguments 192737c0767SJohn Brooksforeach (@ARGV) { 193737c0767SJohn Brooks if ($_ eq "--color" || $_ eq "-color") { 194737c0767SJohn Brooks $_ = "--color=$color"; 195737c0767SJohn Brooks } 196737c0767SJohn Brooks} 197737c0767SJohn Brooks 1980a920b5bSAndy WhitcroftGetOptions( 1996c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 2000a920b5bSAndy Whitcroft 'tree!' => \$tree, 2010a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 2020a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 2036c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 2048905a67cSAndy Whitcroft 'terse!' => \$terse, 20534d8815fSJoe Perches 'showfile!' => \$showfile, 20677f5b10aSHannes Eder 'f|file!' => \$file, 2074a593c34SDu, Changbin 'g|git!' => \$git, 2086c72ffaaSAndy Whitcroft 'subjective!' => \$check, 2096c72ffaaSAndy Whitcroft 'strict!' => \$check, 210000d1cc1SJoe Perches 'ignore=s' => \@ignore, 21191bfe484SJoe Perches 'types=s' => \@use, 212000d1cc1SJoe Perches 'show-types!' => \$show_types, 2133beb42ecSJoe Perches 'list-types!' => \$list_types, 2146cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 21556193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 2166c72ffaaSAndy Whitcroft 'root=s' => \$root, 2178905a67cSAndy Whitcroft 'summary!' => \$summary, 2188905a67cSAndy Whitcroft 'mailback!' => \$mailback, 21913214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 2203705ce5bSJoe Perches 'fix!' => \$fix, 2219624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 222d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 223c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 224773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 225ebfd7d62SJoe Perches 'codespell!' => \$codespell, 226ebfd7d62SJoe Perches 'codespellfile=s' => \$codespellfile, 22775ad8c57SJerome Forissier 'typedefsfile=s' => \$typedefsfile, 228737c0767SJohn Brooks 'color=s' => \$color, 229737c0767SJohn Brooks 'no-color' => \$color, #keep old behaviors of -nocolor 230737c0767SJohn Brooks 'nocolor' => \$color, #keep old behaviors of -nocolor 23177f5b10aSHannes Eder 'h|help' => \$help, 23277f5b10aSHannes Eder 'version' => \$help 23377f5b10aSHannes Eder) or help(1); 23477f5b10aSHannes Eder 23577f5b10aSHannes Ederhelp(0) if ($help); 2360a920b5bSAndy Whitcroft 2373beb42ecSJoe Percheslist_types(0) if ($list_types); 2383beb42ecSJoe Perches 2399624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 2402ac73b4fSJoe Perches$check_orig = $check; 2419624b8d6SJoe Perches 2420a920b5bSAndy Whitcroftmy $exit = 0; 2430a920b5bSAndy Whitcroft 2445b57980dSJoe Perchesmy $perl_version_ok = 1; 245d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 2465b57980dSJoe Perches $perl_version_ok = 0; 247d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 2485b57980dSJoe Perches exit(1) if (!$ignore_perl_version); 249d62a201fSDave Hansen} 250d62a201fSDave Hansen 25145107ff6SAllen Hubbe#if no filenames are given, push '-' to read patch from stdin 2520a920b5bSAndy Whitcroftif ($#ARGV < 0) { 25345107ff6SAllen Hubbe push(@ARGV, '-'); 2540a920b5bSAndy Whitcroft} 2550a920b5bSAndy Whitcroft 256737c0767SJohn Brooksif ($color =~ /^[01]$/) { 257737c0767SJohn Brooks $color = !$color; 258737c0767SJohn Brooks} elsif ($color =~ /^always$/i) { 259737c0767SJohn Brooks $color = 1; 260737c0767SJohn Brooks} elsif ($color =~ /^never$/i) { 261737c0767SJohn Brooks $color = 0; 262737c0767SJohn Brooks} elsif ($color =~ /^auto$/i) { 263737c0767SJohn Brooks $color = (-t STDOUT); 264737c0767SJohn Brooks} else { 265737c0767SJohn Brooks die "Invalid color mode: $color\n"; 266737c0767SJohn Brooks} 267737c0767SJohn Brooks 26891bfe484SJoe Perchessub hash_save_array_words { 26991bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 27091bfe484SJoe Perches 27191bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 27291bfe484SJoe Perches foreach my $word (@array) { 273000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 274000d1cc1SJoe Perches $word =~ s/^\s*//g; 275000d1cc1SJoe Perches $word =~ s/\s+/ /g; 276000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 277000d1cc1SJoe Perches 278000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 279000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 280000d1cc1SJoe Perches 28191bfe484SJoe Perches $hashRef->{$word}++; 282000d1cc1SJoe Perches } 28391bfe484SJoe Perches} 28491bfe484SJoe Perches 28591bfe484SJoe Perchessub hash_show_words { 28691bfe484SJoe Perches my ($hashRef, $prefix) = @_; 28791bfe484SJoe Perches 2883c816e49SJoe Perches if (keys %$hashRef) { 289d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 29058cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 29191bfe484SJoe Perches print " $word"; 29291bfe484SJoe Perches } 293d8469f16SJoe Perches print "\n"; 29491bfe484SJoe Perches } 29591bfe484SJoe Perches} 29691bfe484SJoe Perches 29791bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 29891bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 299000d1cc1SJoe Perches 300c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 301c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 3027429c690SAndy Whitcroftmy $dbg_type = 0; 303a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 304c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 30521caa13cSAndy Whitcroft ## no critic 30621caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 30721caa13cSAndy Whitcroft die "$@" if ($@); 308c2fdda0dSAndy Whitcroft} 309c2fdda0dSAndy Whitcroft 310d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 311d2c0a235SAndy Whitcroft 3128905a67cSAndy Whitcroftif ($terse) { 3138905a67cSAndy Whitcroft $emacs = 1; 3148905a67cSAndy Whitcroft $quiet++; 3158905a67cSAndy Whitcroft} 3168905a67cSAndy Whitcroft 3176c72ffaaSAndy Whitcroftif ($tree) { 3186c72ffaaSAndy Whitcroft if (defined $root) { 3196c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 3206c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 3216c72ffaaSAndy Whitcroft } 3226c72ffaaSAndy Whitcroft } else { 3236c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 3246c72ffaaSAndy Whitcroft $root = '.'; 3256c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 3266c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 3276c72ffaaSAndy Whitcroft $root = $1; 3286c72ffaaSAndy Whitcroft } 3296c72ffaaSAndy Whitcroft } 3306c72ffaaSAndy Whitcroft 3316c72ffaaSAndy Whitcroft if (!defined $root) { 3320a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 3330a920b5bSAndy Whitcroft exit(2); 3340a920b5bSAndy Whitcroft } 3356c72ffaaSAndy Whitcroft} 3366c72ffaaSAndy Whitcroft 3376c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 3386c72ffaaSAndy Whitcroft 3392ceb532bSAndy Whitcroftour $Ident = qr{ 3402ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 3412ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 3422ceb532bSAndy Whitcroft }x; 3436c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 3446c72ffaaSAndy Whitcroftour $Sparse = qr{ 3456c72ffaaSAndy Whitcroft __user| 3466c72ffaaSAndy Whitcroft __kernel| 3476c72ffaaSAndy Whitcroft __force| 3486c72ffaaSAndy Whitcroft __iomem| 3496c72ffaaSAndy Whitcroft __must_check| 350417495edSAndy Whitcroft __kprobes| 351165e72a6SSven Eckelmann __ref| 35233aa4597SGeert Uytterhoeven __refconst| 35333aa4597SGeert Uytterhoeven __refdata| 354ad315455SBoqun Feng __rcu| 355ad315455SBoqun Feng __private 3566c72ffaaSAndy Whitcroft }x; 357e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 358e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 359e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 360e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 361e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 3628716de38SJoe Perches 36352131292SWolfram Sang# Notes to $Attribute: 36452131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 3656c72ffaaSAndy Whitcroftour $Attribute = qr{ 3666c72ffaaSAndy Whitcroft const| 36703f1df7dSJoe Perches __percpu| 36803f1df7dSJoe Perches __nocast| 36903f1df7dSJoe Perches __safe| 37046d832f5SMichael S. Tsirkin __bitwise| 37103f1df7dSJoe Perches __packed__| 37203f1df7dSJoe Perches __packed2__| 37303f1df7dSJoe Perches __naked| 37403f1df7dSJoe Perches __maybe_unused| 37503f1df7dSJoe Perches __always_unused| 37603f1df7dSJoe Perches __noreturn| 37703f1df7dSJoe Perches __used| 37803f1df7dSJoe Perches __cold| 379e23ef1f3SJoe Perches __pure| 38003f1df7dSJoe Perches __noclone| 38103f1df7dSJoe Perches __deprecated| 3826c72ffaaSAndy Whitcroft __read_mostly| 3836c72ffaaSAndy Whitcroft __kprobes| 3848716de38SJoe Perches $InitAttribute| 38524e1d81aSAndy Whitcroft ____cacheline_aligned| 38624e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 3875fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 3885fe3af11SAndy Whitcroft __weak 3896c72ffaaSAndy Whitcroft }x; 390c45dcabdSAndy Whitcroftour $Modifier; 39191cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 3926c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 3936c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 3946c72ffaaSAndy Whitcroft 39595e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 39695e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 39795e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 39895e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 3992435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 400c0a5c898SJoe Perchesour $String = qr{"[X\t]*"}; 401326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 402326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 403326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 40474349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 4052435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 406326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 407447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 40823f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 4096c72ffaaSAndy Whitcroftour $Operators = qr{ 4106c72ffaaSAndy Whitcroft <=|>=|==|!=| 4116c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 41223f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 4136c72ffaaSAndy Whitcroft }x; 4146c72ffaaSAndy Whitcroft 41591cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 41691cb5195SJoe Perches 417ab7e23f3SJoe Perchesour $BasicType; 4188905a67cSAndy Whitcroftour $NonptrType; 4191813087dSJoe Perchesour $NonptrTypeMisordered; 4208716de38SJoe Perchesour $NonptrTypeWithAttr; 4218905a67cSAndy Whitcroftour $Type; 4221813087dSJoe Perchesour $TypeMisordered; 4238905a67cSAndy Whitcroftour $Declare; 4241813087dSJoe Perchesour $DeclareMisordered; 4258905a67cSAndy Whitcroft 42615662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 42715662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 428171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 429171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 430171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 431171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 432171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 433171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 434171ae1a4SAndy Whitcroft}x; 435171ae1a4SAndy Whitcroft 43615662b3eSJoe Perchesour $UTF8 = qr{ 43715662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 43815662b3eSJoe Perches | $NON_ASCII_UTF8 43915662b3eSJoe Perches}x; 44015662b3eSJoe Perches 441e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 442021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 443021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 444021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 445021158b4SJoe Perches)}; 446e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 447fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 4488ed22cadSAndy Whitcroft atomic_t 4498ed22cadSAndy Whitcroft)}; 450e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 451e6176fa4SJoe Perches $typeC99Typedefs\b| 452e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 453e6176fa4SJoe Perches $typeKernelTypedefs\b 454e6176fa4SJoe Perches)}; 4558ed22cadSAndy Whitcroft 4566d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 4576d32f7a3SJoe Perches 458691e669bSJoe Perchesour $logFunctions = qr{(?x: 459758d7aadSMiles Chen printk(?:_ratelimited|_once|_deferred_once|_deferred|)| 4607d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 46187bd499aSJoe Perches TP_printk| 4626e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 463b0531722SJoe Perches panic| 46406668727SJoe Perches MODULE_[A-Z_]+| 46506668727SJoe Perches seq_vprintf|seq_printf|seq_puts 466691e669bSJoe Perches)}; 467691e669bSJoe Perches 46820112475SJoe Perchesour $signature_tags = qr{(?xi: 46920112475SJoe Perches Signed-off-by:| 47020112475SJoe Perches Acked-by:| 47120112475SJoe Perches Tested-by:| 47220112475SJoe Perches Reviewed-by:| 47320112475SJoe Perches Reported-by:| 4748543ae12SMugunthan V N Suggested-by:| 47520112475SJoe Perches To:| 47620112475SJoe Perches Cc: 47720112475SJoe Perches)}; 47820112475SJoe Perches 4791813087dSJoe Perchesour @typeListMisordered = ( 4801813087dSJoe Perches qr{char\s+(?:un)?signed}, 4811813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 4821813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 4831813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 4841813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 4851813087dSJoe Perches qr{short\s+(?:un)?signed}, 4861813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 4871813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 4881813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 4891813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 4901813087dSJoe Perches qr{int\s+(?:un)?signed}, 4911813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 4921813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 4931813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 4941813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 4951813087dSJoe Perches qr{long\s+(?:un)?signed}, 4961813087dSJoe Perches); 4971813087dSJoe Perches 4988905a67cSAndy Whitcroftour @typeList = ( 4998905a67cSAndy Whitcroft qr{void}, 5000c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 5010c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 5020c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 5030c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 5040c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 5050c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 5060c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 5070c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 5080c773d9dSJoe Perches qr{(?:un)?signed}, 5098905a67cSAndy Whitcroft qr{float}, 5108905a67cSAndy Whitcroft qr{double}, 5118905a67cSAndy Whitcroft qr{bool}, 5128905a67cSAndy Whitcroft qr{struct\s+$Ident}, 5138905a67cSAndy Whitcroft qr{union\s+$Ident}, 5148905a67cSAndy Whitcroft qr{enum\s+$Ident}, 5158905a67cSAndy Whitcroft qr{${Ident}_t}, 5168905a67cSAndy Whitcroft qr{${Ident}_handler}, 5178905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 5181813087dSJoe Perches @typeListMisordered, 5198905a67cSAndy Whitcroft); 520938224b5SJoe Perches 521938224b5SJoe Perchesour $C90_int_types = qr{(?x: 522938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 523938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 524938224b5SJoe Perches long\s+long\s+(?:un)?signed| 525938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 526938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 527938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 528938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 529938224b5SJoe Perches 530938224b5SJoe Perches long\s+int\s+(?:un)?signed| 531938224b5SJoe Perches long\s+(?:un)?signed\s+int| 532938224b5SJoe Perches long\s+(?:un)?signed| 533938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 534938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 535938224b5SJoe Perches int\s+long\s+(?:un)?signed| 536938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 537938224b5SJoe Perches 538938224b5SJoe Perches int\s+(?:un)?signed| 539938224b5SJoe Perches (?:(?:un)?signed\s+)?int 540938224b5SJoe Perches)}; 541938224b5SJoe Perches 542485ff23eSAlex Dowadour @typeListFile = (); 5438716de38SJoe Perchesour @typeListWithAttr = ( 5448716de38SJoe Perches @typeList, 5458716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 5468716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 5478716de38SJoe Perches); 5488716de38SJoe Perches 549c45dcabdSAndy Whitcroftour @modifierList = ( 550c45dcabdSAndy Whitcroft qr{fastcall}, 551c45dcabdSAndy Whitcroft); 552485ff23eSAlex Dowadour @modifierListFile = (); 5538905a67cSAndy Whitcroft 5542435880fSJoe Perchesour @mode_permission_funcs = ( 5552435880fSJoe Perches ["module_param", 3], 5562435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 5572435880fSJoe Perches ["module_param_array_named", 5], 5582435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 5592435880fSJoe Perches ["proc_create(?:_data|)", 2], 560459cf0aeSJoe Perches ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2], 561459cf0aeSJoe Perches ["IIO_DEV_ATTR_[A-Z_]+", 1], 562459cf0aeSJoe Perches ["SENSOR_(?:DEVICE_|)ATTR_2", 2], 563459cf0aeSJoe Perches ["SENSOR_TEMPLATE(?:_2|)", 3], 564459cf0aeSJoe Perches ["__ATTR", 2], 5652435880fSJoe Perches); 5662435880fSJoe Perches 567515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 568515a235eSJoe Perchesour $mode_perms_search = ""; 569515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 570515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 571515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 572515a235eSJoe Perches} 57300180468SJoe Perches$mode_perms_search = "(?:${mode_perms_search})"; 574515a235eSJoe Perches 575b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 576b392c64fSJoe Perches S_IWUGO | 577b392c64fSJoe Perches S_IWOTH | 578b392c64fSJoe Perches S_IRWXUGO | 579b392c64fSJoe Perches S_IALLUGO | 580b392c64fSJoe Perches 0[0-7][0-7][2367] 581b392c64fSJoe Perches}x; 582b392c64fSJoe Perches 583f90774e1SJoe Perchesour %mode_permission_string_types = ( 584f90774e1SJoe Perches "S_IRWXU" => 0700, 585f90774e1SJoe Perches "S_IRUSR" => 0400, 586f90774e1SJoe Perches "S_IWUSR" => 0200, 587f90774e1SJoe Perches "S_IXUSR" => 0100, 588f90774e1SJoe Perches "S_IRWXG" => 0070, 589f90774e1SJoe Perches "S_IRGRP" => 0040, 590f90774e1SJoe Perches "S_IWGRP" => 0020, 591f90774e1SJoe Perches "S_IXGRP" => 0010, 592f90774e1SJoe Perches "S_IRWXO" => 0007, 593f90774e1SJoe Perches "S_IROTH" => 0004, 594f90774e1SJoe Perches "S_IWOTH" => 0002, 595f90774e1SJoe Perches "S_IXOTH" => 0001, 596f90774e1SJoe Perches "S_IRWXUGO" => 0777, 597f90774e1SJoe Perches "S_IRUGO" => 0444, 598f90774e1SJoe Perches "S_IWUGO" => 0222, 599f90774e1SJoe Perches "S_IXUGO" => 0111, 600f90774e1SJoe Perches); 601f90774e1SJoe Perches 602f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below 603f90774e1SJoe Perchesour $mode_perms_string_search = ""; 604f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) { 605f90774e1SJoe Perches $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); 606f90774e1SJoe Perches $mode_perms_string_search .= $entry; 607f90774e1SJoe Perches} 60800180468SJoe Perchesour $single_mode_perms_string_search = "(?:${mode_perms_string_search})"; 60900180468SJoe Perchesour $multi_mode_perms_string_search = qr{ 61000180468SJoe Perches ${single_mode_perms_string_search} 61100180468SJoe Perches (?:\s*\|\s*${single_mode_perms_string_search})* 61200180468SJoe Perches}x; 61300180468SJoe Perches 61400180468SJoe Perchessub perms_to_octal { 61500180468SJoe Perches my ($string) = @_; 61600180468SJoe Perches 61700180468SJoe Perches return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/); 61800180468SJoe Perches 61900180468SJoe Perches my $val = ""; 62000180468SJoe Perches my $oval = ""; 62100180468SJoe Perches my $to = 0; 62200180468SJoe Perches my $curpos = 0; 62300180468SJoe Perches my $lastpos = 0; 62400180468SJoe Perches while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) { 62500180468SJoe Perches $curpos = pos($string); 62600180468SJoe Perches my $match = $2; 62700180468SJoe Perches my $omatch = $1; 62800180468SJoe Perches last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos)); 62900180468SJoe Perches $lastpos = $curpos; 63000180468SJoe Perches $to |= $mode_permission_string_types{$match}; 63100180468SJoe Perches $val .= '\s*\|\s*' if ($val ne ""); 63200180468SJoe Perches $val .= $match; 63300180468SJoe Perches $oval .= $omatch; 63400180468SJoe Perches } 63500180468SJoe Perches $oval =~ s/^\s*\|\s*//; 63600180468SJoe Perches $oval =~ s/\s*\|\s*$//; 63700180468SJoe Perches return sprintf("%04o", $to); 63800180468SJoe Perches} 639f90774e1SJoe Perches 6407840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 6417840a94cSWolfram Sang irq| 642cdcee686SSergey Ryazanov memory| 643cdcee686SSergey Ryazanov time| 644cdcee686SSergey Ryazanov reboot 6457840a94cSWolfram Sang)}; 6467840a94cSWolfram Sang# memory.h: ARM has a custom one 6477840a94cSWolfram Sang 64866b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 64966b47b4aSKees Cookmy $misspellings; 65066b47b4aSKees Cookmy %spelling_fix; 65136061e38SJoe Perches 65236061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 65366b47b4aSKees Cook while (<$spelling>) { 65466b47b4aSKees Cook my $line = $_; 65566b47b4aSKees Cook 65666b47b4aSKees Cook $line =~ s/\s*\n?$//g; 65766b47b4aSKees Cook $line =~ s/^\s*//g; 65866b47b4aSKees Cook 65966b47b4aSKees Cook next if ($line =~ m/^\s*#/); 66066b47b4aSKees Cook next if ($line =~ m/^\s*$/); 66166b47b4aSKees Cook 66266b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 66366b47b4aSKees Cook 66466b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 66566b47b4aSKees Cook } 66666b47b4aSKees Cook close($spelling); 66736061e38SJoe Perches} else { 66836061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 66936061e38SJoe Perches} 67066b47b4aSKees Cook 671ebfd7d62SJoe Perchesif ($codespell) { 672ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 673ebfd7d62SJoe Perches while (<$spelling>) { 674ebfd7d62SJoe Perches my $line = $_; 675ebfd7d62SJoe Perches 676ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 677ebfd7d62SJoe Perches $line =~ s/^\s*//g; 678ebfd7d62SJoe Perches 679ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 680ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 681ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 682ebfd7d62SJoe Perches 683ebfd7d62SJoe Perches $line =~ s/,.*$//; 684ebfd7d62SJoe Perches 685ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 686ebfd7d62SJoe Perches 687ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 688ebfd7d62SJoe Perches } 689ebfd7d62SJoe Perches close($spelling); 690ebfd7d62SJoe Perches } else { 691ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 692ebfd7d62SJoe Perches } 693ebfd7d62SJoe Perches} 694ebfd7d62SJoe Perches 695ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 696ebfd7d62SJoe Perches 69775ad8c57SJerome Forissiersub read_words { 69875ad8c57SJerome Forissier my ($wordsRef, $file) = @_; 69975ad8c57SJerome Forissier 70075ad8c57SJerome Forissier if (open(my $words, '<', $file)) { 70175ad8c57SJerome Forissier while (<$words>) { 702bf1fa1daSJoe Perches my $line = $_; 703bf1fa1daSJoe Perches 704bf1fa1daSJoe Perches $line =~ s/\s*\n?$//g; 705bf1fa1daSJoe Perches $line =~ s/^\s*//g; 706bf1fa1daSJoe Perches 707bf1fa1daSJoe Perches next if ($line =~ m/^\s*#/); 708bf1fa1daSJoe Perches next if ($line =~ m/^\s*$/); 709bf1fa1daSJoe Perches if ($line =~ /\s/) { 71075ad8c57SJerome Forissier print("$file: '$line' invalid - ignored\n"); 711bf1fa1daSJoe Perches next; 712bf1fa1daSJoe Perches } 713bf1fa1daSJoe Perches 71475ad8c57SJerome Forissier $$wordsRef .= '|' if ($$wordsRef ne ""); 71575ad8c57SJerome Forissier $$wordsRef .= $line; 716bf1fa1daSJoe Perches } 71775ad8c57SJerome Forissier close($file); 71875ad8c57SJerome Forissier return 1; 719bf1fa1daSJoe Perches } 720bf1fa1daSJoe Perches 72175ad8c57SJerome Forissier return 0; 72275ad8c57SJerome Forissier} 72375ad8c57SJerome Forissier 72475ad8c57SJerome Forissiermy $const_structs = ""; 72575ad8c57SJerome Forissierread_words(\$const_structs, $conststructsfile) 72675ad8c57SJerome Forissier or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 72775ad8c57SJerome Forissier 72875ad8c57SJerome Forissiermy $typeOtherTypedefs = ""; 72975ad8c57SJerome Forissierif (length($typedefsfile)) { 73075ad8c57SJerome Forissier read_words(\$typeOtherTypedefs, $typedefsfile) 73175ad8c57SJerome Forissier or warn "No additional types will be considered - file '$typedefsfile': $!\n"; 73275ad8c57SJerome Forissier} 73375ad8c57SJerome Forissier$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne ""); 73475ad8c57SJerome Forissier 7358905a67cSAndy Whitcroftsub build_types { 736485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 737485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 7381813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 7398716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 740c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 741ab7e23f3SJoe Perches $BasicType = qr{ 742ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 743ab7e23f3SJoe Perches (?:${all}\b) 744ab7e23f3SJoe Perches }x; 7458905a67cSAndy Whitcroft $NonptrType = qr{ 746d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 747cf655043SAndy Whitcroft (?: 7486b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 7498ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 750c45dcabdSAndy Whitcroft (?:${all}\b) 751cf655043SAndy Whitcroft ) 752c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 7538905a67cSAndy Whitcroft }x; 7541813087dSJoe Perches $NonptrTypeMisordered = qr{ 7551813087dSJoe Perches (?:$Modifier\s+|const\s+)* 7561813087dSJoe Perches (?: 7571813087dSJoe Perches (?:${Misordered}\b) 7581813087dSJoe Perches ) 7591813087dSJoe Perches (?:\s+$Modifier|\s+const)* 7601813087dSJoe Perches }x; 7618716de38SJoe Perches $NonptrTypeWithAttr = qr{ 7628716de38SJoe Perches (?:$Modifier\s+|const\s+)* 7638716de38SJoe Perches (?: 7648716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 7658716de38SJoe Perches (?:$typeTypedefs\b)| 7668716de38SJoe Perches (?:${allWithAttr}\b) 7678716de38SJoe Perches ) 7688716de38SJoe Perches (?:\s+$Modifier|\s+const)* 7698716de38SJoe Perches }x; 7708905a67cSAndy Whitcroft $Type = qr{ 771c45dcabdSAndy Whitcroft $NonptrType 7721574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 773c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 7748905a67cSAndy Whitcroft }x; 7751813087dSJoe Perches $TypeMisordered = qr{ 7761813087dSJoe Perches $NonptrTypeMisordered 7771813087dSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 7781813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 7791813087dSJoe Perches }x; 78091cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 7811813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 7828905a67cSAndy Whitcroft} 7838905a67cSAndy Whitcroftbuild_types(); 7846c72ffaaSAndy Whitcroft 7857d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 786d1fe9c09SJoe Perches 787d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 788d1fe9c09SJoe Perches# requires at least perl version v5.10.0 789d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 790d1fe9c09SJoe Perches 791d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 7922435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 793c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 7947d2367afSJoe Perches 795f8422308SJoe Perchesour $declaration_macros = qr{(?x: 7963e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 797fe658f94SSteffen Maier (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(| 7983d102fc0SGilad Ben-Yossef (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(| 7993d102fc0SGilad Ben-Yossef (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\( 800f8422308SJoe Perches)}; 801f8422308SJoe Perches 8027d2367afSJoe Perchessub deparenthesize { 8037d2367afSJoe Perches my ($string) = @_; 8047d2367afSJoe Perches return "" if (!defined($string)); 8055b9553abSJoe Perches 8065b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 8075b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 8085b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 8095b9553abSJoe Perches } 8105b9553abSJoe Perches 8117d2367afSJoe Perches $string =~ s@\s+@ @g; 8125b9553abSJoe Perches 8137d2367afSJoe Perches return $string; 8147d2367afSJoe Perches} 8157d2367afSJoe Perches 8163445686aSJoe Perchessub seed_camelcase_file { 8173445686aSJoe Perches my ($file) = @_; 8183445686aSJoe Perches 8193445686aSJoe Perches return if (!(-f $file)); 8203445686aSJoe Perches 8213445686aSJoe Perches local $/; 8223445686aSJoe Perches 8233445686aSJoe Perches open(my $include_file, '<', "$file") 8243445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 8253445686aSJoe Perches my $text = <$include_file>; 8263445686aSJoe Perches close($include_file); 8273445686aSJoe Perches 8283445686aSJoe Perches my @lines = split('\n', $text); 8293445686aSJoe Perches 8303445686aSJoe Perches foreach my $line (@lines) { 8313445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 8323445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 8333445686aSJoe Perches $camelcase{$1} = 1; 83411ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 83511ea516aSJoe Perches $camelcase{$1} = 1; 83611ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 8373445686aSJoe Perches $camelcase{$1} = 1; 8383445686aSJoe Perches } 8393445686aSJoe Perches } 8403445686aSJoe Perches} 8413445686aSJoe Perches 84285b0ee18SJoe Perchessub is_maintained_obsolete { 84385b0ee18SJoe Perches my ($filename) = @_; 84485b0ee18SJoe Perches 845f2c19c2fSJerome Forissier return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 84685b0ee18SJoe Perches 8470616efa4SJoe Perches my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 84885b0ee18SJoe Perches 84985b0ee18SJoe Perches return $status =~ /obsolete/i; 85085b0ee18SJoe Perches} 85185b0ee18SJoe Perches 8523b6e8ac9SJoe Perchessub is_SPDX_License_valid { 8533b6e8ac9SJoe Perches my ($license) = @_; 8543b6e8ac9SJoe Perches 8553b6e8ac9SJoe Perches return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py")); 8563b6e8ac9SJoe Perches 8573b6e8ac9SJoe Perches my $status = `echo "$license" | python $root/scripts/spdxcheck.py -`; 8583b6e8ac9SJoe Perches return 0 if ($status ne ""); 8593b6e8ac9SJoe Perches return 1; 8603b6e8ac9SJoe Perches} 8613b6e8ac9SJoe Perches 8623445686aSJoe Perchesmy $camelcase_seeded = 0; 8633445686aSJoe Perchessub seed_camelcase_includes { 8643445686aSJoe Perches return if ($camelcase_seeded); 8653445686aSJoe Perches 8663445686aSJoe Perches my $files; 867c707a81dSJoe Perches my $camelcase_cache = ""; 868c707a81dSJoe Perches my @include_files = (); 869c707a81dSJoe Perches 870c707a81dSJoe Perches $camelcase_seeded = 1; 871351b2a1fSJoe Perches 8723645e328SRichard Genoud if (-e ".git") { 873351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 874351b2a1fSJoe Perches chomp $git_last_include_commit; 875c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 876c707a81dSJoe Perches } else { 877c707a81dSJoe Perches my $last_mod_date = 0; 878c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 879c707a81dSJoe Perches @include_files = split('\n', $files); 880c707a81dSJoe Perches foreach my $file (@include_files) { 881c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 882c707a81dSJoe Perches localtime((stat $file)[9])); 883c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 884c707a81dSJoe Perches } 885c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 886c707a81dSJoe Perches } 887c707a81dSJoe Perches 888c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 889c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 890c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 891351b2a1fSJoe Perches while (<$camelcase_file>) { 892351b2a1fSJoe Perches chomp; 893351b2a1fSJoe Perches $camelcase{$_} = 1; 894351b2a1fSJoe Perches } 895351b2a1fSJoe Perches close($camelcase_file); 896351b2a1fSJoe Perches 897351b2a1fSJoe Perches return; 898351b2a1fSJoe Perches } 899c707a81dSJoe Perches 9003645e328SRichard Genoud if (-e ".git") { 901c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 902c707a81dSJoe Perches @include_files = split('\n', $files); 9033445686aSJoe Perches } 904c707a81dSJoe Perches 9053445686aSJoe Perches foreach my $file (@include_files) { 9063445686aSJoe Perches seed_camelcase_file($file); 9073445686aSJoe Perches } 908351b2a1fSJoe Perches 909c707a81dSJoe Perches if ($camelcase_cache ne "") { 910351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 911c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 912c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 913351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 914351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 915351b2a1fSJoe Perches } 916351b2a1fSJoe Perches close($camelcase_file); 917351b2a1fSJoe Perches } 9183445686aSJoe Perches} 9193445686aSJoe Perches 920d311cd44SJoe Perchessub git_commit_info { 921d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 922d311cd44SJoe Perches 923d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 924d311cd44SJoe Perches 925d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 926d311cd44SJoe Perches $output =~ s/^\s*//gm; 927d311cd44SJoe Perches my @lines = split("\n", $output); 928d311cd44SJoe Perches 9290d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 9300d7835fcSJoe Perches 931d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 932d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 933d311cd44SJoe Perches# all matching commit ids, but it's very slow... 934d311cd44SJoe Perches# 935d311cd44SJoe Perches# echo "checking commits $1..." 936d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 937d311cd44SJoe Perches# while read line ; do 938d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 939d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 940d311cd44SJoe Perches# done 941d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 942948b133aSHeinrich Schuchardt $id = undef; 943d311cd44SJoe Perches } else { 944d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 945d311cd44SJoe Perches $desc = substr($lines[0], 41); 946d311cd44SJoe Perches } 947d311cd44SJoe Perches 948d311cd44SJoe Perches return ($id, $desc); 949d311cd44SJoe Perches} 950d311cd44SJoe Perches 9516c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 9520a920b5bSAndy Whitcroft 95300df344fSAndy Whitcroftmy @rawlines = (); 954c2fdda0dSAndy Whitcroftmy @lines = (); 9553705ce5bSJoe Perchesmy @fixed = (); 956d752fcc8SJoe Perchesmy @fixed_inserted = (); 957d752fcc8SJoe Perchesmy @fixed_deleted = (); 958194f66fcSJoe Perchesmy $fixlinenr = -1; 959194f66fcSJoe Perches 9604a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 9614a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 9624a593c34SDu, Changbindie "$P: No git repository found\n" if ($git && !-e ".git"); 9634a593c34SDu, Changbin 9644a593c34SDu, Changbinif ($git) { 9654a593c34SDu, Changbin my @commits = (); 9660dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 9674a593c34SDu, Changbin my $git_range; 96828898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 96928898fd1SJoe Perches $git_range = "-$2 $1"; 9704a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 9714a593c34SDu, Changbin $git_range = "$commit_expr"; 9724a593c34SDu, Changbin } else { 9730dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 9740dea9f1eSJoe Perches } 9750dea9f1eSJoe Perches my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 9760dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 97728898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 97828898fd1SJoe Perches next if (!defined($1) || !defined($2)); 9790dea9f1eSJoe Perches my $sha1 = $1; 9800dea9f1eSJoe Perches my $subject = $2; 9810dea9f1eSJoe Perches unshift(@commits, $sha1); 9820dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 9834a593c34SDu, Changbin } 9844a593c34SDu, Changbin } 9854a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 9864a593c34SDu, Changbin @ARGV = @commits; 9874a593c34SDu, Changbin} 9884a593c34SDu, Changbin 989c2fdda0dSAndy Whitcroftmy $vname; 9906c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 99121caa13cSAndy Whitcroft my $FILE; 9924a593c34SDu, Changbin if ($git) { 9934a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 9944a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 9954a593c34SDu, Changbin } elsif ($file) { 99621caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 9976c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 99821caa13cSAndy Whitcroft } elsif ($filename eq '-') { 99921caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 10006c72ffaaSAndy Whitcroft } else { 100121caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 10026c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 10036c72ffaaSAndy Whitcroft } 1004c2fdda0dSAndy Whitcroft if ($filename eq '-') { 1005c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 10064a593c34SDu, Changbin } elsif ($git) { 10070dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 1008c2fdda0dSAndy Whitcroft } else { 1009c2fdda0dSAndy Whitcroft $vname = $filename; 1010c2fdda0dSAndy Whitcroft } 101121caa13cSAndy Whitcroft while (<$FILE>) { 10120a920b5bSAndy Whitcroft chomp; 101300df344fSAndy Whitcroft push(@rawlines, $_); 10146c72ffaaSAndy Whitcroft } 101521caa13cSAndy Whitcroft close($FILE); 1016d8469f16SJoe Perches 1017d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 1018d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1019d8469f16SJoe Perches print "$vname\n"; 1020d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1021d8469f16SJoe Perches } 1022d8469f16SJoe Perches 1023c2fdda0dSAndy Whitcroft if (!process($filename)) { 10240a920b5bSAndy Whitcroft $exit = 1; 10250a920b5bSAndy Whitcroft } 102600df344fSAndy Whitcroft @rawlines = (); 102713214adfSAndy Whitcroft @lines = (); 10283705ce5bSJoe Perches @fixed = (); 1029d752fcc8SJoe Perches @fixed_inserted = (); 1030d752fcc8SJoe Perches @fixed_deleted = (); 1031194f66fcSJoe Perches $fixlinenr = -1; 1032485ff23eSAlex Dowad @modifierListFile = (); 1033485ff23eSAlex Dowad @typeListFile = (); 1034485ff23eSAlex Dowad build_types(); 10350a920b5bSAndy Whitcroft} 10360a920b5bSAndy Whitcroft 1037d8469f16SJoe Perchesif (!$quiet) { 10383c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 10393c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 10403c816e49SJoe Perches 10415b57980dSJoe Perches if (!$perl_version_ok) { 1042d8469f16SJoe Perches print << "EOM" 1043d8469f16SJoe Perches 1044d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 10455b57980dSJoe Perches An upgrade to at least perl $minimum_perl_version is suggested. 1046d8469f16SJoe PerchesEOM 1047d8469f16SJoe Perches } 1048d8469f16SJoe Perches if ($exit) { 1049d8469f16SJoe Perches print << "EOM" 1050d8469f16SJoe Perches 1051d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 1052d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 1053d8469f16SJoe PerchesEOM 1054d8469f16SJoe Perches } 1055d8469f16SJoe Perches} 1056d8469f16SJoe Perches 10570a920b5bSAndy Whitcroftexit($exit); 10580a920b5bSAndy Whitcroft 10590a920b5bSAndy Whitcroftsub top_of_kernel_tree { 10606c72ffaaSAndy Whitcroft my ($root) = @_; 10616c72ffaaSAndy Whitcroft 10626c72ffaaSAndy Whitcroft my @tree_check = ( 10636c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 10646c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 10656c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 10666c72ffaaSAndy Whitcroft ); 10676c72ffaaSAndy Whitcroft 10686c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 10696c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 10700a920b5bSAndy Whitcroft return 0; 10710a920b5bSAndy Whitcroft } 10726c72ffaaSAndy Whitcroft } 10736c72ffaaSAndy Whitcroft return 1; 10746c72ffaaSAndy Whitcroft} 10750a920b5bSAndy Whitcroft 107620112475SJoe Perchessub parse_email { 107720112475SJoe Perches my ($formatted_email) = @_; 107820112475SJoe Perches 107920112475SJoe Perches my $name = ""; 108020112475SJoe Perches my $address = ""; 108120112475SJoe Perches my $comment = ""; 108220112475SJoe Perches 108320112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 108420112475SJoe Perches $name = $1; 108520112475SJoe Perches $address = $2; 108620112475SJoe Perches $comment = $3 if defined $3; 108720112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 108820112475SJoe Perches $address = $1; 108920112475SJoe Perches $comment = $2 if defined $2; 109020112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 109120112475SJoe Perches $address = $1; 109220112475SJoe Perches $comment = $2 if defined $2; 109385e12066SJoe Perches $formatted_email =~ s/\Q$address\E.*$//; 109420112475SJoe Perches $name = $formatted_email; 10953705ce5bSJoe Perches $name = trim($name); 109620112475SJoe Perches $name =~ s/^\"|\"$//g; 109720112475SJoe Perches # If there's a name left after stripping spaces and 109820112475SJoe Perches # leading quotes, and the address doesn't have both 109920112475SJoe Perches # leading and trailing angle brackets, the address 110020112475SJoe Perches # is invalid. ie: 110120112475SJoe Perches # "joe smith [email protected]" bad 110220112475SJoe Perches # "joe smith <[email protected]" bad 110320112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 110420112475SJoe Perches $name = ""; 110520112475SJoe Perches $address = ""; 110620112475SJoe Perches $comment = ""; 110720112475SJoe Perches } 110820112475SJoe Perches } 110920112475SJoe Perches 11103705ce5bSJoe Perches $name = trim($name); 111120112475SJoe Perches $name =~ s/^\"|\"$//g; 11123705ce5bSJoe Perches $address = trim($address); 111320112475SJoe Perches $address =~ s/^\<|\>$//g; 111420112475SJoe Perches 111520112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 111620112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 111720112475SJoe Perches $name = "\"$name\""; 111820112475SJoe Perches } 111920112475SJoe Perches 112020112475SJoe Perches return ($name, $address, $comment); 112120112475SJoe Perches} 112220112475SJoe Perches 112320112475SJoe Perchessub format_email { 112420112475SJoe Perches my ($name, $address) = @_; 112520112475SJoe Perches 112620112475SJoe Perches my $formatted_email; 112720112475SJoe Perches 11283705ce5bSJoe Perches $name = trim($name); 112920112475SJoe Perches $name =~ s/^\"|\"$//g; 11303705ce5bSJoe Perches $address = trim($address); 113120112475SJoe Perches 113220112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 113320112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 113420112475SJoe Perches $name = "\"$name\""; 113520112475SJoe Perches } 113620112475SJoe Perches 113720112475SJoe Perches if ("$name" eq "") { 113820112475SJoe Perches $formatted_email = "$address"; 113920112475SJoe Perches } else { 114020112475SJoe Perches $formatted_email = "$name <$address>"; 114120112475SJoe Perches } 114220112475SJoe Perches 114320112475SJoe Perches return $formatted_email; 114420112475SJoe Perches} 114520112475SJoe Perches 1146d311cd44SJoe Perchessub which { 1147d311cd44SJoe Perches my ($bin) = @_; 1148d311cd44SJoe Perches 1149d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1150d311cd44SJoe Perches if (-e "$path/$bin") { 1151d311cd44SJoe Perches return "$path/$bin"; 1152d311cd44SJoe Perches } 1153d311cd44SJoe Perches } 1154d311cd44SJoe Perches 1155d311cd44SJoe Perches return ""; 1156d311cd44SJoe Perches} 1157d311cd44SJoe Perches 1158000d1cc1SJoe Perchessub which_conf { 1159000d1cc1SJoe Perches my ($conf) = @_; 1160000d1cc1SJoe Perches 1161000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1162000d1cc1SJoe Perches if (-e "$path/$conf") { 1163000d1cc1SJoe Perches return "$path/$conf"; 1164000d1cc1SJoe Perches } 1165000d1cc1SJoe Perches } 1166000d1cc1SJoe Perches 1167000d1cc1SJoe Perches return ""; 1168000d1cc1SJoe Perches} 1169000d1cc1SJoe Perches 11700a920b5bSAndy Whitcroftsub expand_tabs { 11710a920b5bSAndy Whitcroft my ($str) = @_; 11720a920b5bSAndy Whitcroft 11730a920b5bSAndy Whitcroft my $res = ''; 11740a920b5bSAndy Whitcroft my $n = 0; 11750a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 11760a920b5bSAndy Whitcroft if ($c eq "\t") { 11770a920b5bSAndy Whitcroft $res .= ' '; 11780a920b5bSAndy Whitcroft $n++; 11790a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 11800a920b5bSAndy Whitcroft $res .= ' '; 11810a920b5bSAndy Whitcroft } 11820a920b5bSAndy Whitcroft next; 11830a920b5bSAndy Whitcroft } 11840a920b5bSAndy Whitcroft $res .= $c; 11850a920b5bSAndy Whitcroft $n++; 11860a920b5bSAndy Whitcroft } 11870a920b5bSAndy Whitcroft 11880a920b5bSAndy Whitcroft return $res; 11890a920b5bSAndy Whitcroft} 11906c72ffaaSAndy Whitcroftsub copy_spacing { 1191773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 11926c72ffaaSAndy Whitcroft return $res; 11936c72ffaaSAndy Whitcroft} 11940a920b5bSAndy Whitcroft 11954a0df2efSAndy Whitcroftsub line_stats { 11964a0df2efSAndy Whitcroft my ($line) = @_; 11974a0df2efSAndy Whitcroft 11984a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 11994a0df2efSAndy Whitcroft $line =~ s/^.//; 12004a0df2efSAndy Whitcroft $line = expand_tabs($line); 12014a0df2efSAndy Whitcroft 12024a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 12034a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 12044a0df2efSAndy Whitcroft 12054a0df2efSAndy Whitcroft return (length($line), length($white)); 12064a0df2efSAndy Whitcroft} 12074a0df2efSAndy Whitcroft 1208773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1209773647a0SAndy Whitcroft 1210773647a0SAndy Whitcroftsub sanitise_line_reset { 1211773647a0SAndy Whitcroft my ($in_comment) = @_; 1212773647a0SAndy Whitcroft 1213773647a0SAndy Whitcroft if ($in_comment) { 1214773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1215773647a0SAndy Whitcroft } else { 1216773647a0SAndy Whitcroft $sanitise_quote = ''; 1217773647a0SAndy Whitcroft } 1218773647a0SAndy Whitcroft} 121900df344fSAndy Whitcroftsub sanitise_line { 122000df344fSAndy Whitcroft my ($line) = @_; 122100df344fSAndy Whitcroft 122200df344fSAndy Whitcroft my $res = ''; 122300df344fSAndy Whitcroft my $l = ''; 122400df344fSAndy Whitcroft 1225c2fdda0dSAndy Whitcroft my $qlen = 0; 1226773647a0SAndy Whitcroft my $off = 0; 1227773647a0SAndy Whitcroft my $c; 122800df344fSAndy Whitcroft 1229773647a0SAndy Whitcroft # Always copy over the diff marker. 1230773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1231773647a0SAndy Whitcroft 1232773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1233773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1234773647a0SAndy Whitcroft 12358d2e11b2SClaudio Fontana # Comments we are whacking completely including the begin 1236773647a0SAndy Whitcroft # and end, all to $;. 1237773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1238773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1239773647a0SAndy Whitcroft 1240773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1241773647a0SAndy Whitcroft $off++; 124200df344fSAndy Whitcroft next; 1243773647a0SAndy Whitcroft } 124481bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1245773647a0SAndy Whitcroft $sanitise_quote = ''; 1246773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1247773647a0SAndy Whitcroft $off++; 1248773647a0SAndy Whitcroft next; 1249773647a0SAndy Whitcroft } 1250113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1251113f04a8SDaniel Walker $sanitise_quote = '//'; 1252113f04a8SDaniel Walker 1253113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1254113f04a8SDaniel Walker $off++; 1255113f04a8SDaniel Walker next; 1256113f04a8SDaniel Walker } 1257773647a0SAndy Whitcroft 1258773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1259773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1260773647a0SAndy Whitcroft $c eq "\\") { 1261773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1262773647a0SAndy Whitcroft $off++; 1263773647a0SAndy Whitcroft next; 1264773647a0SAndy Whitcroft } 1265773647a0SAndy Whitcroft # Regular quotes. 1266773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1267773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1268773647a0SAndy Whitcroft $sanitise_quote = $c; 1269773647a0SAndy Whitcroft 1270773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1271773647a0SAndy Whitcroft next; 1272773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1273773647a0SAndy Whitcroft $sanitise_quote = ''; 127400df344fSAndy Whitcroft } 127500df344fSAndy Whitcroft } 1276773647a0SAndy Whitcroft 1277fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1278773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1279773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1280113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1281113f04a8SDaniel Walker substr($res, $off, 1, $;); 1282773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1283773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 128400df344fSAndy Whitcroft } else { 1285773647a0SAndy Whitcroft substr($res, $off, 1, $c); 128600df344fSAndy Whitcroft } 1287c2fdda0dSAndy Whitcroft } 1288c2fdda0dSAndy Whitcroft 1289113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1290113f04a8SDaniel Walker $sanitise_quote = ''; 1291113f04a8SDaniel Walker } 1292113f04a8SDaniel Walker 1293c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1294c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1295c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1296c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1297c2fdda0dSAndy Whitcroft 1298c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1299c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1300c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1301c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1302c2fdda0dSAndy Whitcroft } 1303c2fdda0dSAndy Whitcroft 1304dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1305dadf680dSJoe Perches my $match = $1; 1306dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1307dadf680dSJoe Perches } 1308dadf680dSJoe Perches 130900df344fSAndy Whitcroft return $res; 131000df344fSAndy Whitcroft} 131100df344fSAndy Whitcroft 1312a6962d72SJoe Perchessub get_quoted_string { 1313a6962d72SJoe Perches my ($line, $rawline) = @_; 1314a6962d72SJoe Perches 1315478b1799SJoe Perches return "" if (!defined($line) || !defined($rawline)); 131633acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1317a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1318a6962d72SJoe Perches} 1319a6962d72SJoe Perches 13208905a67cSAndy Whitcroftsub ctx_statement_block { 13218905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 13228905a67cSAndy Whitcroft my $line = $linenr - 1; 13238905a67cSAndy Whitcroft my $blk = ''; 13248905a67cSAndy Whitcroft my $soff = $off; 13258905a67cSAndy Whitcroft my $coff = $off - 1; 1326773647a0SAndy Whitcroft my $coff_set = 0; 13278905a67cSAndy Whitcroft 132813214adfSAndy Whitcroft my $loff = 0; 132913214adfSAndy Whitcroft 13308905a67cSAndy Whitcroft my $type = ''; 13318905a67cSAndy Whitcroft my $level = 0; 1332a2750645SAndy Whitcroft my @stack = (); 1333cf655043SAndy Whitcroft my $p; 13348905a67cSAndy Whitcroft my $c; 13358905a67cSAndy Whitcroft my $len = 0; 133613214adfSAndy Whitcroft 133713214adfSAndy Whitcroft my $remainder; 13388905a67cSAndy Whitcroft while (1) { 1339a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1340a2750645SAndy Whitcroft 1341773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 13428905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 13438905a67cSAndy Whitcroft # context. 13448905a67cSAndy Whitcroft if ($off >= $len) { 13458905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1346dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1347c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 13488905a67cSAndy Whitcroft $remain--; 134913214adfSAndy Whitcroft $loff = $len; 1350c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 13518905a67cSAndy Whitcroft $len = length($blk); 13528905a67cSAndy Whitcroft $line++; 13538905a67cSAndy Whitcroft last; 13548905a67cSAndy Whitcroft } 13558905a67cSAndy Whitcroft # Bail if there is no further context. 13568905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 135713214adfSAndy Whitcroft if ($off >= $len) { 13588905a67cSAndy Whitcroft last; 13598905a67cSAndy Whitcroft } 1360f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1361f74bd194SAndy Whitcroft $level++; 1362f74bd194SAndy Whitcroft $type = '#'; 1363f74bd194SAndy Whitcroft } 13648905a67cSAndy Whitcroft } 1365cf655043SAndy Whitcroft $p = $c; 13668905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 136713214adfSAndy Whitcroft $remainder = substr($blk, $off); 13688905a67cSAndy Whitcroft 1369773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 13704635f4fbSAndy Whitcroft 13714635f4fbSAndy Whitcroft # Handle nested #if/#else. 13724635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 13734635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 13744635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 13754635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 13764635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 13774635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 13784635f4fbSAndy Whitcroft } 13794635f4fbSAndy Whitcroft 13808905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 13818905a67cSAndy Whitcroft # outermost level. 13828905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 13838905a67cSAndy Whitcroft last; 13848905a67cSAndy Whitcroft } 13858905a67cSAndy Whitcroft 138613214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1387773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1388773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1389773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1390773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1391773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1392773647a0SAndy Whitcroft $coff_set = 1; 1393773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1394773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 139513214adfSAndy Whitcroft } 139613214adfSAndy Whitcroft 13978905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 13988905a67cSAndy Whitcroft $level++; 13998905a67cSAndy Whitcroft $type = '('; 14008905a67cSAndy Whitcroft } 14018905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 14028905a67cSAndy Whitcroft $level--; 14038905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 14048905a67cSAndy Whitcroft 14058905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 14068905a67cSAndy Whitcroft $coff = $off; 1407773647a0SAndy Whitcroft $coff_set = 1; 1408773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 14098905a67cSAndy Whitcroft } 14108905a67cSAndy Whitcroft } 14118905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 14128905a67cSAndy Whitcroft $level++; 14138905a67cSAndy Whitcroft $type = '{'; 14148905a67cSAndy Whitcroft } 14158905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 14168905a67cSAndy Whitcroft $level--; 14178905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 14188905a67cSAndy Whitcroft 14198905a67cSAndy Whitcroft if ($level == 0) { 1420b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1421b998e001SPatrick Pannuto $off++; 1422b998e001SPatrick Pannuto } 14238905a67cSAndy Whitcroft last; 14248905a67cSAndy Whitcroft } 14258905a67cSAndy Whitcroft } 1426f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1427f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1428f74bd194SAndy Whitcroft $level--; 1429f74bd194SAndy Whitcroft $type = ''; 1430f74bd194SAndy Whitcroft $off++; 1431f74bd194SAndy Whitcroft last; 1432f74bd194SAndy Whitcroft } 14338905a67cSAndy Whitcroft $off++; 14348905a67cSAndy Whitcroft } 1435a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 143613214adfSAndy Whitcroft if ($off == $len) { 1437a3bb97a7SAndy Whitcroft $loff = $len + 1; 143813214adfSAndy Whitcroft $line++; 143913214adfSAndy Whitcroft $remain--; 144013214adfSAndy Whitcroft } 14418905a67cSAndy Whitcroft 14428905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 14438905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 14448905a67cSAndy Whitcroft 14458905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 14468905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 14478905a67cSAndy Whitcroft 1448773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 144913214adfSAndy Whitcroft 145013214adfSAndy Whitcroft return ($statement, $condition, 145113214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 145213214adfSAndy Whitcroft} 145313214adfSAndy Whitcroft 1454cf655043SAndy Whitcroftsub statement_lines { 1455cf655043SAndy Whitcroft my ($stmt) = @_; 1456cf655043SAndy Whitcroft 1457cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1458cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1459cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1460cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1461cf655043SAndy Whitcroft 1462cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1463cf655043SAndy Whitcroft 1464cf655043SAndy Whitcroft return $#stmt_lines + 2; 1465cf655043SAndy Whitcroft} 1466cf655043SAndy Whitcroft 1467cf655043SAndy Whitcroftsub statement_rawlines { 1468cf655043SAndy Whitcroft my ($stmt) = @_; 1469cf655043SAndy Whitcroft 1470cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1471cf655043SAndy Whitcroft 1472cf655043SAndy Whitcroft return $#stmt_lines + 2; 1473cf655043SAndy Whitcroft} 1474cf655043SAndy Whitcroft 1475cf655043SAndy Whitcroftsub statement_block_size { 1476cf655043SAndy Whitcroft my ($stmt) = @_; 1477cf655043SAndy Whitcroft 1478cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1479cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1480cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1481cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1482cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1483cf655043SAndy Whitcroft 1484cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1485cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1486cf655043SAndy Whitcroft 1487cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1488cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1489cf655043SAndy Whitcroft 1490cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1491cf655043SAndy Whitcroft return $stmt_lines; 1492cf655043SAndy Whitcroft } else { 1493cf655043SAndy Whitcroft return $stmt_statements; 1494cf655043SAndy Whitcroft } 1495cf655043SAndy Whitcroft} 1496cf655043SAndy Whitcroft 149713214adfSAndy Whitcroftsub ctx_statement_full { 149813214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 149913214adfSAndy Whitcroft my ($statement, $condition, $level); 150013214adfSAndy Whitcroft 150113214adfSAndy Whitcroft my (@chunks); 150213214adfSAndy Whitcroft 1503cf655043SAndy Whitcroft # Grab the first conditional/block pair. 150413214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 150513214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1506773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 150713214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1508cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1509cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1510cf655043SAndy Whitcroft } 1511cf655043SAndy Whitcroft 1512cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1513cf655043SAndy Whitcroft # could continue the statement. 1514cf655043SAndy Whitcroft for (;;) { 151513214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 151613214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1517cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1518773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1519cf655043SAndy Whitcroft #print "C: push\n"; 1520cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 152113214adfSAndy Whitcroft } 152213214adfSAndy Whitcroft 152313214adfSAndy Whitcroft return ($level, $linenr, @chunks); 15248905a67cSAndy Whitcroft} 15258905a67cSAndy Whitcroft 15264a0df2efSAndy Whitcroftsub ctx_block_get { 1527f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 15284a0df2efSAndy Whitcroft my $line; 15294a0df2efSAndy Whitcroft my $start = $linenr - 1; 15304a0df2efSAndy Whitcroft my $blk = ''; 15314a0df2efSAndy Whitcroft my @o; 15324a0df2efSAndy Whitcroft my @c; 15334a0df2efSAndy Whitcroft my @res = (); 15344a0df2efSAndy Whitcroft 1535f0a594c1SAndy Whitcroft my $level = 0; 15364635f4fbSAndy Whitcroft my @stack = ($level); 153700df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 153800df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 153900df344fSAndy Whitcroft $remain--; 154000df344fSAndy Whitcroft 154100df344fSAndy Whitcroft $blk .= $rawlines[$line]; 15424635f4fbSAndy Whitcroft 15434635f4fbSAndy Whitcroft # Handle nested #if/#else. 154401464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 15454635f4fbSAndy Whitcroft push(@stack, $level); 154601464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 15474635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 154801464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 15494635f4fbSAndy Whitcroft $level = pop(@stack); 15504635f4fbSAndy Whitcroft } 15514635f4fbSAndy Whitcroft 155201464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1553f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1554f0a594c1SAndy Whitcroft if ($off > 0) { 1555f0a594c1SAndy Whitcroft $off--; 1556f0a594c1SAndy Whitcroft next; 1557f0a594c1SAndy Whitcroft } 15584a0df2efSAndy Whitcroft 1559f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1560f0a594c1SAndy Whitcroft $level--; 1561f0a594c1SAndy Whitcroft last if ($level == 0); 1562f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1563f0a594c1SAndy Whitcroft $level++; 1564f0a594c1SAndy Whitcroft } 1565f0a594c1SAndy Whitcroft } 15664a0df2efSAndy Whitcroft 1567f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 156800df344fSAndy Whitcroft push(@res, $rawlines[$line]); 15694a0df2efSAndy Whitcroft } 15704a0df2efSAndy Whitcroft 1571f0a594c1SAndy Whitcroft last if ($level == 0); 15724a0df2efSAndy Whitcroft } 15734a0df2efSAndy Whitcroft 1574f0a594c1SAndy Whitcroft return ($level, @res); 15754a0df2efSAndy Whitcroft} 15764a0df2efSAndy Whitcroftsub ctx_block_outer { 15774a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 15784a0df2efSAndy Whitcroft 1579f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1580f0a594c1SAndy Whitcroft return @r; 15814a0df2efSAndy Whitcroft} 15824a0df2efSAndy Whitcroftsub ctx_block { 15834a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 15844a0df2efSAndy Whitcroft 1585f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1586f0a594c1SAndy Whitcroft return @r; 1587653d4876SAndy Whitcroft} 1588653d4876SAndy Whitcroftsub ctx_statement { 1589f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1590f0a594c1SAndy Whitcroft 1591f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1592f0a594c1SAndy Whitcroft return @r; 1593f0a594c1SAndy Whitcroft} 1594f0a594c1SAndy Whitcroftsub ctx_block_level { 1595653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1596653d4876SAndy Whitcroft 1597f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 15984a0df2efSAndy Whitcroft} 15999c0ca6f9SAndy Whitcroftsub ctx_statement_level { 16009c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 16019c0ca6f9SAndy Whitcroft 16029c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 16039c0ca6f9SAndy Whitcroft} 16044a0df2efSAndy Whitcroft 16054a0df2efSAndy Whitcroftsub ctx_locate_comment { 16064a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 16074a0df2efSAndy Whitcroft 16084a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1609beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 16104a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 16114a0df2efSAndy Whitcroft 16124a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 16134a0df2efSAndy Whitcroft # comment. 16144a0df2efSAndy Whitcroft my $in_comment = 0; 16154a0df2efSAndy Whitcroft $current_comment = ''; 16164a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 161700df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 161800df344fSAndy Whitcroft #warn " $line\n"; 16194a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 16204a0df2efSAndy Whitcroft $in_comment = 1; 16214a0df2efSAndy Whitcroft } 16224a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 16234a0df2efSAndy Whitcroft $in_comment = 1; 16244a0df2efSAndy Whitcroft } 16254a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 16264a0df2efSAndy Whitcroft $current_comment = ''; 16274a0df2efSAndy Whitcroft } 16284a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 16294a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 16304a0df2efSAndy Whitcroft $in_comment = 0; 16314a0df2efSAndy Whitcroft } 16324a0df2efSAndy Whitcroft } 16334a0df2efSAndy Whitcroft 16344a0df2efSAndy Whitcroft chomp($current_comment); 16354a0df2efSAndy Whitcroft return($current_comment); 16364a0df2efSAndy Whitcroft} 16374a0df2efSAndy Whitcroftsub ctx_has_comment { 16384a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 16394a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 16404a0df2efSAndy Whitcroft 164100df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 16424a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 16434a0df2efSAndy Whitcroft 16444a0df2efSAndy Whitcroft return ($cmt ne ''); 16454a0df2efSAndy Whitcroft} 16464a0df2efSAndy Whitcroft 16474d001e4dSAndy Whitcroftsub raw_line { 16484d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 16494d001e4dSAndy Whitcroft 16504d001e4dSAndy Whitcroft my $offset = $linenr - 1; 16514d001e4dSAndy Whitcroft $cnt++; 16524d001e4dSAndy Whitcroft 16534d001e4dSAndy Whitcroft my $line; 16544d001e4dSAndy Whitcroft while ($cnt) { 16554d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 16564d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 16574d001e4dSAndy Whitcroft $cnt--; 16584d001e4dSAndy Whitcroft } 16594d001e4dSAndy Whitcroft 16604d001e4dSAndy Whitcroft return $line; 16614d001e4dSAndy Whitcroft} 16624d001e4dSAndy Whitcroft 16632a9f9d85STobin C. Hardingsub get_stat_real { 16642a9f9d85STobin C. Harding my ($linenr, $lc) = @_; 16652a9f9d85STobin C. Harding 16662a9f9d85STobin C. Harding my $stat_real = raw_line($linenr, 0); 16672a9f9d85STobin C. Harding for (my $count = $linenr + 1; $count <= $lc; $count++) { 16682a9f9d85STobin C. Harding $stat_real = $stat_real . "\n" . raw_line($count, 0); 16692a9f9d85STobin C. Harding } 16702a9f9d85STobin C. Harding 16712a9f9d85STobin C. Harding return $stat_real; 16722a9f9d85STobin C. Harding} 16732a9f9d85STobin C. Harding 1674e3d95a2aSTobin C. Hardingsub get_stat_here { 1675e3d95a2aSTobin C. Harding my ($linenr, $cnt, $here) = @_; 1676e3d95a2aSTobin C. Harding 1677e3d95a2aSTobin C. Harding my $herectx = $here . "\n"; 1678e3d95a2aSTobin C. Harding for (my $n = 0; $n < $cnt; $n++) { 1679e3d95a2aSTobin C. Harding $herectx .= raw_line($linenr, $n) . "\n"; 1680e3d95a2aSTobin C. Harding } 1681e3d95a2aSTobin C. Harding 1682e3d95a2aSTobin C. Harding return $herectx; 1683e3d95a2aSTobin C. Harding} 1684e3d95a2aSTobin C. Harding 16850a920b5bSAndy Whitcroftsub cat_vet { 16860a920b5bSAndy Whitcroft my ($vet) = @_; 16879c0ca6f9SAndy Whitcroft my ($res, $coded); 16880a920b5bSAndy Whitcroft 16899c0ca6f9SAndy Whitcroft $res = ''; 16906c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 16916c72ffaaSAndy Whitcroft $res .= $1; 16926c72ffaaSAndy Whitcroft if ($2 ne '') { 16939c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 16946c72ffaaSAndy Whitcroft $res .= $coded; 16956c72ffaaSAndy Whitcroft } 16969c0ca6f9SAndy Whitcroft } 16979c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 16980a920b5bSAndy Whitcroft 16999c0ca6f9SAndy Whitcroft return $res; 17000a920b5bSAndy Whitcroft} 17010a920b5bSAndy Whitcroft 1702c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1703cf655043SAndy Whitcroftmy $av_pending; 1704c2fdda0dSAndy Whitcroftmy @av_paren_type; 17051f65f947SAndy Whitcroftmy $av_pend_colon; 1706c2fdda0dSAndy Whitcroft 1707c2fdda0dSAndy Whitcroftsub annotate_reset { 1708c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1709cf655043SAndy Whitcroft $av_pending = '_'; 1710cf655043SAndy Whitcroft @av_paren_type = ('E'); 17111f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1712c2fdda0dSAndy Whitcroft} 1713c2fdda0dSAndy Whitcroft 17146c72ffaaSAndy Whitcroftsub annotate_values { 17156c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 17166c72ffaaSAndy Whitcroft 17176c72ffaaSAndy Whitcroft my $res; 17181f65f947SAndy Whitcroft my $var = '_' x length($stream); 17196c72ffaaSAndy Whitcroft my $cur = $stream; 17206c72ffaaSAndy Whitcroft 1721c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 17226c72ffaaSAndy Whitcroft 17236c72ffaaSAndy Whitcroft while (length($cur)) { 1724773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1725cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1726171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 17276c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1728c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1729c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1730cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1731c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 17326c72ffaaSAndy Whitcroft } 17336c72ffaaSAndy Whitcroft 1734c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 17359446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 17369446ef56SAndy Whitcroft push(@av_paren_type, $type); 1737addcdceaSAndy Whitcroft $type = 'c'; 17389446ef56SAndy Whitcroft 1739e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1740c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 17416c72ffaaSAndy Whitcroft $type = 'T'; 17426c72ffaaSAndy Whitcroft 1743389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1744389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1745389a2fe5SAndy Whitcroft $type = 'T'; 1746389a2fe5SAndy Whitcroft 1747c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1748171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1749c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1750171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1751171ae1a4SAndy Whitcroft if ($2 ne '') { 1752cf655043SAndy Whitcroft $av_pending = 'N'; 1753171ae1a4SAndy Whitcroft } 1754171ae1a4SAndy Whitcroft $type = 'E'; 1755171ae1a4SAndy Whitcroft 1756c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1757171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1758171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1759171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 17606c72ffaaSAndy Whitcroft 1761c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1762cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1763c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1764cf655043SAndy Whitcroft 1765cf655043SAndy Whitcroft push(@av_paren_type, $type); 1766cf655043SAndy Whitcroft push(@av_paren_type, $type); 1767171ae1a4SAndy Whitcroft $type = 'E'; 1768cf655043SAndy Whitcroft 1769c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1770cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1771cf655043SAndy Whitcroft $av_preprocessor = 1; 1772cf655043SAndy Whitcroft 1773cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1774cf655043SAndy Whitcroft 1775171ae1a4SAndy Whitcroft $type = 'E'; 1776cf655043SAndy Whitcroft 1777c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1778cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1779cf655043SAndy Whitcroft 1780cf655043SAndy Whitcroft $av_preprocessor = 1; 1781cf655043SAndy Whitcroft 1782cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1783cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1784cf655043SAndy Whitcroft pop(@av_paren_type); 1785cf655043SAndy Whitcroft push(@av_paren_type, $type); 1786171ae1a4SAndy Whitcroft $type = 'E'; 17876c72ffaaSAndy Whitcroft 17886c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1789c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 17906c72ffaaSAndy Whitcroft 1791171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1792171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1793171ae1a4SAndy Whitcroft $av_pending = $type; 1794171ae1a4SAndy Whitcroft $type = 'N'; 1795171ae1a4SAndy Whitcroft 17966c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1797c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 17986c72ffaaSAndy Whitcroft if (defined $2) { 1799cf655043SAndy Whitcroft $av_pending = 'V'; 18006c72ffaaSAndy Whitcroft } 18016c72ffaaSAndy Whitcroft $type = 'N'; 18026c72ffaaSAndy Whitcroft 180314b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1804c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 180514b111c1SAndy Whitcroft $av_pending = 'E'; 18066c72ffaaSAndy Whitcroft $type = 'N'; 18076c72ffaaSAndy Whitcroft 18081f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 18091f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 18101f65f947SAndy Whitcroft $av_pend_colon = 'C'; 18111f65f947SAndy Whitcroft $type = 'N'; 18121f65f947SAndy Whitcroft 181314b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1814c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 18156c72ffaaSAndy Whitcroft $type = 'N'; 18166c72ffaaSAndy Whitcroft 18176c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1818c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1819cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1820cf655043SAndy Whitcroft $av_pending = '_'; 18216c72ffaaSAndy Whitcroft $type = 'N'; 18226c72ffaaSAndy Whitcroft 18236c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1824cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1825cf655043SAndy Whitcroft if ($new_type ne '_') { 1826cf655043SAndy Whitcroft $type = $new_type; 1827c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1828c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 18296c72ffaaSAndy Whitcroft } else { 1830c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 18316c72ffaaSAndy Whitcroft } 18326c72ffaaSAndy Whitcroft 1833c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1834c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1835c8cb2ca3SAndy Whitcroft $type = 'V'; 1836cf655043SAndy Whitcroft $av_pending = 'V'; 18376c72ffaaSAndy Whitcroft 18388e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 18398e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 18401f65f947SAndy Whitcroft $av_pend_colon = 'B'; 18418e761b04SAndy Whitcroft } elsif ($type eq 'E') { 18428e761b04SAndy Whitcroft $av_pend_colon = 'L'; 18431f65f947SAndy Whitcroft } 18441f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 18451f65f947SAndy Whitcroft $type = 'V'; 18461f65f947SAndy Whitcroft 18476c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1848c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 18496c72ffaaSAndy Whitcroft $type = 'V'; 18506c72ffaaSAndy Whitcroft 18516c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1852c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 18536c72ffaaSAndy Whitcroft $type = 'N'; 18546c72ffaaSAndy Whitcroft 1855cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1856c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 185713214adfSAndy Whitcroft $type = 'E'; 18581f65f947SAndy Whitcroft $av_pend_colon = 'O'; 185913214adfSAndy Whitcroft 18608e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 18618e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 18628e761b04SAndy Whitcroft $type = 'C'; 18638e761b04SAndy Whitcroft 18641f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 18651f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 18661f65f947SAndy Whitcroft $type = 'N'; 18671f65f947SAndy Whitcroft 18681f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 18691f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 18701f65f947SAndy Whitcroft 18711f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 18721f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 18731f65f947SAndy Whitcroft $type = 'E'; 18741f65f947SAndy Whitcroft } else { 18751f65f947SAndy Whitcroft $type = 'N'; 18761f65f947SAndy Whitcroft } 18771f65f947SAndy Whitcroft $av_pend_colon = 'O'; 18781f65f947SAndy Whitcroft 18798e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 188013214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 18816c72ffaaSAndy Whitcroft $type = 'N'; 18826c72ffaaSAndy Whitcroft 18830d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 188474048ed8SAndy Whitcroft my $variant; 188574048ed8SAndy Whitcroft 188674048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 188774048ed8SAndy Whitcroft if ($type eq 'V') { 188874048ed8SAndy Whitcroft $variant = 'B'; 188974048ed8SAndy Whitcroft } else { 189074048ed8SAndy Whitcroft $variant = 'U'; 189174048ed8SAndy Whitcroft } 189274048ed8SAndy Whitcroft 189374048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 189474048ed8SAndy Whitcroft $type = 'N'; 189574048ed8SAndy Whitcroft 18966c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1897c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 18986c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 18996c72ffaaSAndy Whitcroft $type = 'N'; 19006c72ffaaSAndy Whitcroft } 19016c72ffaaSAndy Whitcroft 19026c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1903c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 19046c72ffaaSAndy Whitcroft } 19056c72ffaaSAndy Whitcroft if (defined $1) { 19066c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 19076c72ffaaSAndy Whitcroft $res .= $type x length($1); 19086c72ffaaSAndy Whitcroft } 19096c72ffaaSAndy Whitcroft } 19106c72ffaaSAndy Whitcroft 19111f65f947SAndy Whitcroft return ($res, $var); 19126c72ffaaSAndy Whitcroft} 19136c72ffaaSAndy Whitcroft 19148905a67cSAndy Whitcroftsub possible { 191513214adfSAndy Whitcroft my ($possible, $line) = @_; 19169a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 19170776e594SAndy Whitcroft ^(?: 19180776e594SAndy Whitcroft $Modifier| 19190776e594SAndy Whitcroft $Storage| 19200776e594SAndy Whitcroft $Type| 19219a974fdbSAndy Whitcroft DEFINE_\S+ 19229a974fdbSAndy Whitcroft )$| 19239a974fdbSAndy Whitcroft ^(?: 19240776e594SAndy Whitcroft goto| 19250776e594SAndy Whitcroft return| 19260776e594SAndy Whitcroft case| 19270776e594SAndy Whitcroft else| 19280776e594SAndy Whitcroft asm|__asm__| 192989a88353SAndy Whitcroft do| 193089a88353SAndy Whitcroft \#| 193189a88353SAndy Whitcroft \#\#| 19329a974fdbSAndy Whitcroft )(?:\s|$)| 19330776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 19349a974fdbSAndy Whitcroft )}x; 19359a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 19369a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1937c45dcabdSAndy Whitcroft # Check for modifiers. 1938c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1939c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1940c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1941c45dcabdSAndy Whitcroft 1942c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1943c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1944d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 19459a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1946d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1947485ff23eSAlex Dowad push(@modifierListFile, $modifier); 1948d2506586SAndy Whitcroft } 19499a974fdbSAndy Whitcroft } 1950c45dcabdSAndy Whitcroft 1951c45dcabdSAndy Whitcroft } else { 195213214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 1953485ff23eSAlex Dowad push(@typeListFile, $possible); 1954c45dcabdSAndy Whitcroft } 19558905a67cSAndy Whitcroft build_types(); 19560776e594SAndy Whitcroft } else { 19570776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 19588905a67cSAndy Whitcroft } 19598905a67cSAndy Whitcroft} 19608905a67cSAndy Whitcroft 19616c72ffaaSAndy Whitcroftmy $prefix = ''; 19626c72ffaaSAndy Whitcroft 1963000d1cc1SJoe Perchessub show_type { 1964cbec18afSJoe Perches my ($type) = @_; 196591bfe484SJoe Perches 1966522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 1967522b837cSAlexey Dobriyan 1968cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1969cbec18afSJoe Perches 1970cbec18afSJoe Perches return !defined $ignore_type{$type}; 1971000d1cc1SJoe Perches} 1972000d1cc1SJoe Perches 1973f0a594c1SAndy Whitcroftsub report { 1974cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1975cbec18afSJoe Perches 1976cbec18afSJoe Perches if (!show_type($type) || 1977cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1978773647a0SAndy Whitcroft return 0; 1979773647a0SAndy Whitcroft } 198057230297SJoe Perches my $output = ''; 1981737c0767SJohn Brooks if ($color) { 198257230297SJoe Perches if ($level eq 'ERROR') { 198357230297SJoe Perches $output .= RED; 198457230297SJoe Perches } elsif ($level eq 'WARNING') { 198557230297SJoe Perches $output .= YELLOW; 1986000d1cc1SJoe Perches } else { 198757230297SJoe Perches $output .= GREEN; 1988000d1cc1SJoe Perches } 198957230297SJoe Perches } 199057230297SJoe Perches $output .= $prefix . $level . ':'; 199157230297SJoe Perches if ($show_types) { 1992737c0767SJohn Brooks $output .= BLUE if ($color); 199357230297SJoe Perches $output .= "$type:"; 199457230297SJoe Perches } 1995737c0767SJohn Brooks $output .= RESET if ($color); 199657230297SJoe Perches $output .= ' ' . $msg . "\n"; 199734d8815fSJoe Perches 199834d8815fSJoe Perches if ($showfile) { 199934d8815fSJoe Perches my @lines = split("\n", $output, -1); 200034d8815fSJoe Perches splice(@lines, 1, 1); 200134d8815fSJoe Perches $output = join("\n", @lines); 200234d8815fSJoe Perches } 200357230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 20048905a67cSAndy Whitcroft 200557230297SJoe Perches push(our @report, $output); 2006773647a0SAndy Whitcroft 2007773647a0SAndy Whitcroft return 1; 2008f0a594c1SAndy Whitcroft} 2009cbec18afSJoe Perches 2010f0a594c1SAndy Whitcroftsub report_dump { 201113214adfSAndy Whitcroft our @report; 2012f0a594c1SAndy Whitcroft} 2013000d1cc1SJoe Perches 2014d752fcc8SJoe Perchessub fixup_current_range { 2015d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 2016d752fcc8SJoe Perches 2017d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 2018d752fcc8SJoe Perches my $o = $1; 2019d752fcc8SJoe Perches my $l = $2; 2020d752fcc8SJoe Perches my $no = $o + $offset; 2021d752fcc8SJoe Perches my $nl = $l + $length; 2022d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 2023d752fcc8SJoe Perches } 2024d752fcc8SJoe Perches} 2025d752fcc8SJoe Perches 2026d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 2027d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 2028d752fcc8SJoe Perches 2029d752fcc8SJoe Perches my $range_last_linenr = 0; 2030d752fcc8SJoe Perches my $delta_offset = 0; 2031d752fcc8SJoe Perches 2032d752fcc8SJoe Perches my $old_linenr = 0; 2033d752fcc8SJoe Perches my $new_linenr = 0; 2034d752fcc8SJoe Perches 2035d752fcc8SJoe Perches my $next_insert = 0; 2036d752fcc8SJoe Perches my $next_delete = 0; 2037d752fcc8SJoe Perches 2038d752fcc8SJoe Perches my @lines = (); 2039d752fcc8SJoe Perches 2040d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 2041d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 2042d752fcc8SJoe Perches 2043d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 2044d752fcc8SJoe Perches my $save_line = 1; 2045d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 2046323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2047d752fcc8SJoe Perches $delta_offset = 0; 2048d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2049d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 2050d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 2051d752fcc8SJoe Perches } 2052d752fcc8SJoe Perches 2053d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2054d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 2055d752fcc8SJoe Perches $save_line = 0; 2056d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2057d752fcc8SJoe Perches } 2058d752fcc8SJoe Perches 2059d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2060d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 2061d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 2062d752fcc8SJoe Perches $new_linenr++; 2063d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2064d752fcc8SJoe Perches } 2065d752fcc8SJoe Perches 2066d752fcc8SJoe Perches if ($save_line) { 2067d752fcc8SJoe Perches push(@lines, $line); 2068d752fcc8SJoe Perches $new_linenr++; 2069d752fcc8SJoe Perches } 2070d752fcc8SJoe Perches 2071d752fcc8SJoe Perches $old_linenr++; 2072d752fcc8SJoe Perches } 2073d752fcc8SJoe Perches 2074d752fcc8SJoe Perches return @lines; 2075d752fcc8SJoe Perches} 2076d752fcc8SJoe Perches 2077f2d7e4d4SJoe Perchessub fix_insert_line { 2078f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2079f2d7e4d4SJoe Perches 2080f2d7e4d4SJoe Perches my $inserted = { 2081f2d7e4d4SJoe Perches LINENR => $linenr, 2082f2d7e4d4SJoe Perches LINE => $line, 2083f2d7e4d4SJoe Perches }; 2084f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2085f2d7e4d4SJoe Perches} 2086f2d7e4d4SJoe Perches 2087f2d7e4d4SJoe Perchessub fix_delete_line { 2088f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2089f2d7e4d4SJoe Perches 2090f2d7e4d4SJoe Perches my $deleted = { 2091f2d7e4d4SJoe Perches LINENR => $linenr, 2092f2d7e4d4SJoe Perches LINE => $line, 2093f2d7e4d4SJoe Perches }; 2094f2d7e4d4SJoe Perches 2095f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2096f2d7e4d4SJoe Perches} 2097f2d7e4d4SJoe Perches 2098de7d4f0eSAndy Whitcroftsub ERROR { 2099cbec18afSJoe Perches my ($type, $msg) = @_; 2100cbec18afSJoe Perches 2101cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2102de7d4f0eSAndy Whitcroft our $clean = 0; 21036c72ffaaSAndy Whitcroft our $cnt_error++; 21043705ce5bSJoe Perches return 1; 2105de7d4f0eSAndy Whitcroft } 21063705ce5bSJoe Perches return 0; 2107773647a0SAndy Whitcroft} 2108de7d4f0eSAndy Whitcroftsub WARN { 2109cbec18afSJoe Perches my ($type, $msg) = @_; 2110cbec18afSJoe Perches 2111cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2112de7d4f0eSAndy Whitcroft our $clean = 0; 21136c72ffaaSAndy Whitcroft our $cnt_warn++; 21143705ce5bSJoe Perches return 1; 2115de7d4f0eSAndy Whitcroft } 21163705ce5bSJoe Perches return 0; 2117773647a0SAndy Whitcroft} 2118de7d4f0eSAndy Whitcroftsub CHK { 2119cbec18afSJoe Perches my ($type, $msg) = @_; 2120cbec18afSJoe Perches 2121cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2122de7d4f0eSAndy Whitcroft our $clean = 0; 21236c72ffaaSAndy Whitcroft our $cnt_chk++; 21243705ce5bSJoe Perches return 1; 21256c72ffaaSAndy Whitcroft } 21263705ce5bSJoe Perches return 0; 2127de7d4f0eSAndy Whitcroft} 2128de7d4f0eSAndy Whitcroft 21296ecd9674SAndy Whitcroftsub check_absolute_file { 21306ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 21316ecd9674SAndy Whitcroft my $file = $absolute; 21326ecd9674SAndy Whitcroft 21336ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 21346ecd9674SAndy Whitcroft 21356ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 21366ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 21376ecd9674SAndy Whitcroft if (-f "$root/$file") { 21386ecd9674SAndy Whitcroft ##print "file<$file>\n"; 21396ecd9674SAndy Whitcroft last; 21406ecd9674SAndy Whitcroft } 21416ecd9674SAndy Whitcroft } 21426ecd9674SAndy Whitcroft if (! -f _) { 21436ecd9674SAndy Whitcroft return 0; 21446ecd9674SAndy Whitcroft } 21456ecd9674SAndy Whitcroft 21466ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 21476ecd9674SAndy Whitcroft my $prefix = $absolute; 21486ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 21496ecd9674SAndy Whitcroft 21506ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 21516ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2152000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2153000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 21546ecd9674SAndy Whitcroft } 21556ecd9674SAndy Whitcroft} 21566ecd9674SAndy Whitcroft 21573705ce5bSJoe Perchessub trim { 21583705ce5bSJoe Perches my ($string) = @_; 21593705ce5bSJoe Perches 2160b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2161b34c648bSJoe Perches 2162b34c648bSJoe Perches return $string; 2163b34c648bSJoe Perches} 2164b34c648bSJoe Perches 2165b34c648bSJoe Perchessub ltrim { 2166b34c648bSJoe Perches my ($string) = @_; 2167b34c648bSJoe Perches 2168b34c648bSJoe Perches $string =~ s/^\s+//; 2169b34c648bSJoe Perches 2170b34c648bSJoe Perches return $string; 2171b34c648bSJoe Perches} 2172b34c648bSJoe Perches 2173b34c648bSJoe Perchessub rtrim { 2174b34c648bSJoe Perches my ($string) = @_; 2175b34c648bSJoe Perches 2176b34c648bSJoe Perches $string =~ s/\s+$//; 21773705ce5bSJoe Perches 21783705ce5bSJoe Perches return $string; 21793705ce5bSJoe Perches} 21803705ce5bSJoe Perches 218152ea8506SJoe Perchessub string_find_replace { 218252ea8506SJoe Perches my ($string, $find, $replace) = @_; 218352ea8506SJoe Perches 218452ea8506SJoe Perches $string =~ s/$find/$replace/g; 218552ea8506SJoe Perches 218652ea8506SJoe Perches return $string; 218752ea8506SJoe Perches} 218852ea8506SJoe Perches 21893705ce5bSJoe Perchessub tabify { 21903705ce5bSJoe Perches my ($leading) = @_; 21913705ce5bSJoe Perches 21923705ce5bSJoe Perches my $source_indent = 8; 21933705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 21943705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 21953705ce5bSJoe Perches 21963705ce5bSJoe Perches #convert leading spaces to tabs 21973705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 21983705ce5bSJoe Perches #Remove spaces before a tab 21993705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 22003705ce5bSJoe Perches 22013705ce5bSJoe Perches return "$leading"; 22023705ce5bSJoe Perches} 22033705ce5bSJoe Perches 2204d1fe9c09SJoe Perchessub pos_last_openparen { 2205d1fe9c09SJoe Perches my ($line) = @_; 2206d1fe9c09SJoe Perches 2207d1fe9c09SJoe Perches my $pos = 0; 2208d1fe9c09SJoe Perches 2209d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2210d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2211d1fe9c09SJoe Perches 2212d1fe9c09SJoe Perches my $last_openparen = 0; 2213d1fe9c09SJoe Perches 2214d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2215d1fe9c09SJoe Perches return -1; 2216d1fe9c09SJoe Perches } 2217d1fe9c09SJoe Perches 2218d1fe9c09SJoe Perches my $len = length($line); 2219d1fe9c09SJoe Perches 2220d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2221d1fe9c09SJoe Perches my $string = substr($line, $pos); 2222d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2223d1fe9c09SJoe Perches $pos += length($1) - 1; 2224d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2225d1fe9c09SJoe Perches $last_openparen = $pos; 2226d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2227d1fe9c09SJoe Perches last; 2228d1fe9c09SJoe Perches } 2229d1fe9c09SJoe Perches } 2230d1fe9c09SJoe Perches 223191cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2232d1fe9c09SJoe Perches} 2233d1fe9c09SJoe Perches 22340a920b5bSAndy Whitcroftsub process { 22350a920b5bSAndy Whitcroft my $filename = shift; 22360a920b5bSAndy Whitcroft 22370a920b5bSAndy Whitcroft my $linenr=0; 22380a920b5bSAndy Whitcroft my $prevline=""; 2239c2fdda0dSAndy Whitcroft my $prevrawline=""; 22400a920b5bSAndy Whitcroft my $stashline=""; 2241c2fdda0dSAndy Whitcroft my $stashrawline=""; 22420a920b5bSAndy Whitcroft 22434a0df2efSAndy Whitcroft my $length; 22440a920b5bSAndy Whitcroft my $indent; 22450a920b5bSAndy Whitcroft my $previndent=0; 22460a920b5bSAndy Whitcroft my $stashindent=0; 22470a920b5bSAndy Whitcroft 2248de7d4f0eSAndy Whitcroft our $clean = 1; 22490a920b5bSAndy Whitcroft my $signoff = 0; 2250cd261496SGeert Uytterhoeven my $author = ''; 2251cd261496SGeert Uytterhoeven my $authorsignoff = 0; 22520a920b5bSAndy Whitcroft my $is_patch = 0; 225329ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 225415662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 2255ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2256bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 22572a076f40SJoe Perches my $commit_log_long_line = 0; 2258e518e9a5SJoe Perches my $commit_log_has_diff = 0; 225913f1937eSJoe Perches my $reported_maintainer_file = 0; 2260fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2261fa64205dSPasi Savanainen 2262365dd4eaSJoe Perches my $last_blank_line = 0; 22635e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2264365dd4eaSJoe Perches 226513214adfSAndy Whitcroft our @report = (); 22666c72ffaaSAndy Whitcroft our $cnt_lines = 0; 22676c72ffaaSAndy Whitcroft our $cnt_error = 0; 22686c72ffaaSAndy Whitcroft our $cnt_warn = 0; 22696c72ffaaSAndy Whitcroft our $cnt_chk = 0; 22706c72ffaaSAndy Whitcroft 22710a920b5bSAndy Whitcroft # Trace the real file/line as we go. 22720a920b5bSAndy Whitcroft my $realfile = ''; 22730a920b5bSAndy Whitcroft my $realline = 0; 22740a920b5bSAndy Whitcroft my $realcnt = 0; 22750a920b5bSAndy Whitcroft my $here = ''; 227677cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 22770a920b5bSAndy Whitcroft my $in_comment = 0; 2278c2fdda0dSAndy Whitcroft my $comment_edge = 0; 22790a920b5bSAndy Whitcroft my $first_line = 0; 22801e855726SWolfram Sang my $p1_prefix = ''; 22810a920b5bSAndy Whitcroft 228213214adfSAndy Whitcroft my $prev_values = 'E'; 228313214adfSAndy Whitcroft 228413214adfSAndy Whitcroft # suppression flags 2285773647a0SAndy Whitcroft my %suppress_ifbraces; 2286170d3a22SAndy Whitcroft my %suppress_whiletrailers; 22872b474a1aSAndy Whitcroft my %suppress_export; 22883e469cdcSAndy Whitcroft my $suppress_statement = 0; 2289653d4876SAndy Whitcroft 22907e51f197SJoe Perches my %signatures = (); 2291323c1260SJoe Perches 2292c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2293de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2294c2fdda0dSAndy Whitcroft # 2295de7d4f0eSAndy Whitcroft my @setup_docs = (); 2296de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2297773647a0SAndy Whitcroft 2298d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2299d8b07710SJoe Perches 23009f3a8992SRob Herring my $checklicenseline = 1; 23019f3a8992SRob Herring 2302773647a0SAndy Whitcroft sanitise_line_reset(); 2303c2fdda0dSAndy Whitcroft my $line; 2304c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2305773647a0SAndy Whitcroft $linenr++; 2306773647a0SAndy Whitcroft $line = $rawline; 2307c2fdda0dSAndy Whitcroft 23083705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 23093705ce5bSJoe Perches 2310773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2311de7d4f0eSAndy Whitcroft $setup_docs = 0; 23128c27ceffSMauro Carvalho Chehab if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) { 2313de7d4f0eSAndy Whitcroft $setup_docs = 1; 2314de7d4f0eSAndy Whitcroft } 2315773647a0SAndy Whitcroft #next; 2316de7d4f0eSAndy Whitcroft } 231774fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2318773647a0SAndy Whitcroft $realline=$1-1; 2319773647a0SAndy Whitcroft if (defined $2) { 2320773647a0SAndy Whitcroft $realcnt=$3+1; 2321773647a0SAndy Whitcroft } else { 2322773647a0SAndy Whitcroft $realcnt=1+1; 2323773647a0SAndy Whitcroft } 2324c45dcabdSAndy Whitcroft $in_comment = 0; 2325773647a0SAndy Whitcroft 2326773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2327773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2328773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2329773647a0SAndy Whitcroft # at context start. 2330773647a0SAndy Whitcroft my $edge; 233101fa9147SAndy Whitcroft my $cnt = $realcnt; 233201fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 233301fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 233401fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 233501fa9147SAndy Whitcroft $cnt--; 233601fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2337721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2338fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2339fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2340fae17daeSAndy Whitcroft ($edge) = $1; 2341fae17daeSAndy Whitcroft last; 2342fae17daeSAndy Whitcroft } 2343773647a0SAndy Whitcroft } 2344773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2345773647a0SAndy Whitcroft $in_comment = 1; 2346773647a0SAndy Whitcroft } 2347773647a0SAndy Whitcroft 2348773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2349773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2350773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2351773647a0SAndy Whitcroft if (!defined $edge && 235283242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2353773647a0SAndy Whitcroft { 2354773647a0SAndy Whitcroft $in_comment = 1; 2355773647a0SAndy Whitcroft } 2356773647a0SAndy Whitcroft 2357773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2358773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2359773647a0SAndy Whitcroft 2360171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2361773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2362171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2363773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2364773647a0SAndy Whitcroft } 2365773647a0SAndy Whitcroft push(@lines, $line); 2366773647a0SAndy Whitcroft 2367773647a0SAndy Whitcroft if ($realcnt > 1) { 2368773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2369773647a0SAndy Whitcroft } else { 2370773647a0SAndy Whitcroft $realcnt = 0; 2371773647a0SAndy Whitcroft } 2372773647a0SAndy Whitcroft 2373773647a0SAndy Whitcroft #print "==>$rawline\n"; 2374773647a0SAndy Whitcroft #print "-->$line\n"; 2375de7d4f0eSAndy Whitcroft 2376de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2377de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2378de7d4f0eSAndy Whitcroft } 2379de7d4f0eSAndy Whitcroft } 2380de7d4f0eSAndy Whitcroft 23816c72ffaaSAndy Whitcroft $prefix = ''; 23826c72ffaaSAndy Whitcroft 2383773647a0SAndy Whitcroft $realcnt = 0; 2384773647a0SAndy Whitcroft $linenr = 0; 2385194f66fcSJoe Perches $fixlinenr = -1; 23860a920b5bSAndy Whitcroft foreach my $line (@lines) { 23870a920b5bSAndy Whitcroft $linenr++; 2388194f66fcSJoe Perches $fixlinenr++; 23891b5539b1SJoe Perches my $sline = $line; #copy of $line 23901b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 23910a920b5bSAndy Whitcroft 2392c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 23936c72ffaaSAndy Whitcroft 239412c253abSJoe Perches# check if it's a mode change, rename or start of a patch 239512c253abSJoe Perches if (!$in_commit_log && 239612c253abSJoe Perches ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 239712c253abSJoe Perches ($line =~ /^rename (?:from|to) \S+\s*$/ || 239812c253abSJoe Perches $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 239912c253abSJoe Perches $is_patch = 1; 240012c253abSJoe Perches } 240112c253abSJoe Perches 24020a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2403e518e9a5SJoe Perches if (!$in_commit_log && 240474fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 240574fd4f34SJoe Perches my $context = $4; 24060a920b5bSAndy Whitcroft $is_patch = 1; 24074a0df2efSAndy Whitcroft $first_line = $linenr + 1; 24080a920b5bSAndy Whitcroft $realline=$1-1; 24090a920b5bSAndy Whitcroft if (defined $2) { 24100a920b5bSAndy Whitcroft $realcnt=$3+1; 24110a920b5bSAndy Whitcroft } else { 24120a920b5bSAndy Whitcroft $realcnt=1+1; 24130a920b5bSAndy Whitcroft } 2414c2fdda0dSAndy Whitcroft annotate_reset(); 241513214adfSAndy Whitcroft $prev_values = 'E'; 241613214adfSAndy Whitcroft 2417773647a0SAndy Whitcroft %suppress_ifbraces = (); 2418170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 24192b474a1aSAndy Whitcroft %suppress_export = (); 24203e469cdcSAndy Whitcroft $suppress_statement = 0; 242174fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 242274fd4f34SJoe Perches $context_function = $1; 242374fd4f34SJoe Perches } else { 242474fd4f34SJoe Perches undef $context_function; 242574fd4f34SJoe Perches } 24260a920b5bSAndy Whitcroft next; 24270a920b5bSAndy Whitcroft 24284a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 24294a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 24304a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2431773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 24320a920b5bSAndy Whitcroft $realline++; 2433d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 24340a920b5bSAndy Whitcroft 24354a0df2efSAndy Whitcroft # Measure the line length and indent. 2436c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 24370a920b5bSAndy Whitcroft 24380a920b5bSAndy Whitcroft # Track the previous line. 24390a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 24400a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2441c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2442c2fdda0dSAndy Whitcroft 2443773647a0SAndy Whitcroft #warn "line<$line>\n"; 24446c72ffaaSAndy Whitcroft 2445d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2446d8aaf121SAndy Whitcroft $realcnt--; 24470a920b5bSAndy Whitcroft } 24480a920b5bSAndy Whitcroft 2449cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2450cc77cdcaSAndy Whitcroft 24516c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 24526c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2453773647a0SAndy Whitcroft 24542ac73b4fSJoe Perches my $found_file = 0; 2455773647a0SAndy Whitcroft # extract the filename as it passes 24563bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 24573bf9a009SRabin Vincent $realfile = $1; 24582b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2459270c49a0SJoe Perches $in_commit_log = 0; 24602ac73b4fSJoe Perches $found_file = 1; 24613bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2462773647a0SAndy Whitcroft $realfile = $1; 24632b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2464270c49a0SJoe Perches $in_commit_log = 0; 24651e855726SWolfram Sang 24661e855726SWolfram Sang $p1_prefix = $1; 2467e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2468e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2469000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2470000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 24711e855726SWolfram Sang } 2472773647a0SAndy Whitcroft 2473c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2474000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2475000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2476773647a0SAndy Whitcroft } 24772ac73b4fSJoe Perches $found_file = 1; 24782ac73b4fSJoe Perches } 24792ac73b4fSJoe Perches 248034d8815fSJoe Perches#make up the handle for any error we report on this line 248134d8815fSJoe Perches if ($showfile) { 248234d8815fSJoe Perches $prefix = "$realfile:$realline: " 248334d8815fSJoe Perches } elsif ($emacs) { 24847d3a9f67SJoe Perches if ($file) { 24857d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 24867d3a9f67SJoe Perches } else { 248734d8815fSJoe Perches $prefix = "$filename:$linenr: "; 248834d8815fSJoe Perches } 24897d3a9f67SJoe Perches } 249034d8815fSJoe Perches 24912ac73b4fSJoe Perches if ($found_file) { 249285b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 249385b0ee18SJoe Perches WARN("OBSOLETE", 249485b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 249585b0ee18SJoe Perches } 24967bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 24972ac73b4fSJoe Perches $check = 1; 24982ac73b4fSJoe Perches } else { 24992ac73b4fSJoe Perches $check = $check_orig; 25002ac73b4fSJoe Perches } 25019f3a8992SRob Herring $checklicenseline = 1; 2502773647a0SAndy Whitcroft next; 2503773647a0SAndy Whitcroft } 2504773647a0SAndy Whitcroft 2505389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 25060a920b5bSAndy Whitcroft 2507c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2508c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2509c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 25100a920b5bSAndy Whitcroft 25116c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 25126c72ffaaSAndy Whitcroft 2513e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2514e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2515e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2516e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2517e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2518e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2519e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2520e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2521e518e9a5SJoe Perches $commit_log_has_diff = 1; 2522e518e9a5SJoe Perches } 2523e518e9a5SJoe Perches 25243bf9a009SRabin Vincent# Check for incorrect file permissions 25253bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 25263bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 252704db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 252804db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2529000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2530000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 25313bf9a009SRabin Vincent } 25323bf9a009SRabin Vincent } 25333bf9a009SRabin Vincent 2534cd261496SGeert Uytterhoeven# Check the patch for a From: 2535cd261496SGeert Uytterhoeven if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { 2536cd261496SGeert Uytterhoeven $author = $1; 2537cd261496SGeert Uytterhoeven $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); 2538cd261496SGeert Uytterhoeven $author =~ s/"//g; 2539cd261496SGeert Uytterhoeven } 2540cd261496SGeert Uytterhoeven 254120112475SJoe Perches# Check the patch for a signoff: 2542d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 25434a0df2efSAndy Whitcroft $signoff++; 254415662b3eSJoe Perches $in_commit_log = 0; 2545cd261496SGeert Uytterhoeven if ($author ne '') { 2546cd261496SGeert Uytterhoeven my $l = $line; 2547cd261496SGeert Uytterhoeven $l =~ s/"//g; 2548cd261496SGeert Uytterhoeven if ($l =~ /^\s*signed-off-by:\s*\Q$author\E/i) { 2549cd261496SGeert Uytterhoeven $authorsignoff = 1; 2550cd261496SGeert Uytterhoeven } 2551cd261496SGeert Uytterhoeven } 25520a920b5bSAndy Whitcroft } 255320112475SJoe Perches 2554e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2555e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2556e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2557e0d975b1SJoe Perches $reported_maintainer_file = 1; 2558e0d975b1SJoe Perches } 2559e0d975b1SJoe Perches 256020112475SJoe Perches# Check signature styles 2561270c49a0SJoe Perches if (!$in_header_lines && 2562ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 256320112475SJoe Perches my $space_before = $1; 256420112475SJoe Perches my $sign_off = $2; 256520112475SJoe Perches my $space_after = $3; 256620112475SJoe Perches my $email = $4; 256720112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 256820112475SJoe Perches 2569ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2570ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2571ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2572ce0338dfSJoe Perches } 257320112475SJoe Perches if (defined $space_before && $space_before ne "") { 25743705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 25753705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 25763705ce5bSJoe Perches $fix) { 2577194f66fcSJoe Perches $fixed[$fixlinenr] = 25783705ce5bSJoe Perches "$ucfirst_sign_off $email"; 25793705ce5bSJoe Perches } 258020112475SJoe Perches } 258120112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 25823705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 25833705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 25843705ce5bSJoe Perches $fix) { 2585194f66fcSJoe Perches $fixed[$fixlinenr] = 25863705ce5bSJoe Perches "$ucfirst_sign_off $email"; 25873705ce5bSJoe Perches } 25883705ce5bSJoe Perches 258920112475SJoe Perches } 259020112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 25913705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 25923705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 25933705ce5bSJoe Perches $fix) { 2594194f66fcSJoe Perches $fixed[$fixlinenr] = 25953705ce5bSJoe Perches "$ucfirst_sign_off $email"; 25963705ce5bSJoe Perches } 259720112475SJoe Perches } 259820112475SJoe Perches 259920112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 260020112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 260120112475SJoe Perches if ($suggested_email eq "") { 2602000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2603000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 260420112475SJoe Perches } else { 260520112475SJoe Perches my $dequoted = $suggested_email; 260620112475SJoe Perches $dequoted =~ s/^"//; 260720112475SJoe Perches $dequoted =~ s/" </ </; 260820112475SJoe Perches # Don't force email to have quotes 260920112475SJoe Perches # Allow just an angle bracketed address 261020112475SJoe Perches if ("$dequoted$comment" ne $email && 261120112475SJoe Perches "<$email_address>$comment" ne $email && 261220112475SJoe Perches "$suggested_email$comment" ne $email) { 2613000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2614000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 261520112475SJoe Perches } 26160a920b5bSAndy Whitcroft } 26177e51f197SJoe Perches 26187e51f197SJoe Perches# Check for duplicate signatures 26197e51f197SJoe Perches my $sig_nospace = $line; 26207e51f197SJoe Perches $sig_nospace =~ s/\s//g; 26217e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 26227e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 26237e51f197SJoe Perches WARN("BAD_SIGN_OFF", 26247e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 26257e51f197SJoe Perches } else { 26267e51f197SJoe Perches $signatures{$sig_nospace} = 1; 26277e51f197SJoe Perches } 26280a920b5bSAndy Whitcroft } 26290a920b5bSAndy Whitcroft 2630a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2631a2fe16b9SJoe Perches if ($in_header_lines && 2632a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2633a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2634a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2635a2fe16b9SJoe Perches } 2636a2fe16b9SJoe Perches 26377ebd05efSChristopher Covington# Check for unwanted Gerrit info 26387ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 26397ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 26407ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 26417ebd05efSChristopher Covington } 26427ebd05efSChristopher Covington 2643369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2644369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2645369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2646369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2647369c8dd3SJoe Perches # timestamp 2648369c8dd3SJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) { 2649369c8dd3SJoe Perches # stack dump address 2650369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2651369c8dd3SJoe Perches } 2652369c8dd3SJoe Perches 26532a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 26542a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2655bf4daf12SJoe Perches length($line) > 75 && 2656bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2657bf4daf12SJoe Perches # file delta changes 2658bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2659bf4daf12SJoe Perches # filename then : 2660bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2661bf4daf12SJoe Perches # A Fixes: or Link: line 2662bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 26632a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 26642a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 26652a076f40SJoe Perches $commit_log_long_line = 1; 26662a076f40SJoe Perches } 26672a076f40SJoe Perches 2668bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2669bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2670bf4daf12SJoe Perches $line =~ /^\s*$/) { 2671bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2672bf4daf12SJoe Perches } 2673bf4daf12SJoe Perches 26740d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2675369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2676aab38f51SJoe Perches $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i && 2677e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 2678fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2679aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2680369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2681bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2682fe043ea1SJoe Perches my $init_char = "c"; 2683fe043ea1SJoe Perches my $orig_commit = ""; 26840d7835fcSJoe Perches my $short = 1; 26850d7835fcSJoe Perches my $long = 0; 26860d7835fcSJoe Perches my $case = 1; 26870d7835fcSJoe Perches my $space = 1; 26880d7835fcSJoe Perches my $hasdesc = 0; 268919c146a6SJoe Perches my $hasparens = 0; 26900d7835fcSJoe Perches my $id = '0123456789ab'; 26910d7835fcSJoe Perches my $orig_desc = "commit description"; 26920d7835fcSJoe Perches my $description = ""; 26930d7835fcSJoe Perches 2694fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2695fe043ea1SJoe Perches $init_char = $1; 2696fe043ea1SJoe Perches $orig_commit = lc($2); 2697fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2698fe043ea1SJoe Perches $orig_commit = lc($1); 2699fe043ea1SJoe Perches } 2700fe043ea1SJoe Perches 27010d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 27020d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 27030d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 27040d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 27050d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 27060d7835fcSJoe Perches $orig_desc = $1; 270719c146a6SJoe Perches $hasparens = 1; 27080d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 27090d7835fcSJoe Perches defined $rawlines[$linenr] && 27100d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 27110d7835fcSJoe Perches $orig_desc = $1; 271219c146a6SJoe Perches $hasparens = 1; 2713b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2714b671fde0SJoe Perches defined $rawlines[$linenr] && 2715b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2716b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2717b671fde0SJoe Perches $orig_desc = $1; 2718b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2719b671fde0SJoe Perches $orig_desc .= " " . $1; 272019c146a6SJoe Perches $hasparens = 1; 27210d7835fcSJoe Perches } 27220d7835fcSJoe Perches 27230d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 27240d7835fcSJoe Perches $id, $orig_desc); 27250d7835fcSJoe Perches 2726948b133aSHeinrich Schuchardt if (defined($id) && 2727948b133aSHeinrich Schuchardt ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { 2728d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 27290d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 27300d7835fcSJoe Perches } 2731d311cd44SJoe Perches } 2732d311cd44SJoe Perches 273313f1937eSJoe Perches# Check for added, moved or deleted files 273413f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 273513f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 273613f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 273713f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 273813f1937eSJoe Perches (defined($1) || defined($2))))) { 2739a82603a8SAndrew Jeffery $is_patch = 1; 274013f1937eSJoe Perches $reported_maintainer_file = 1; 274113f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 274213f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 274313f1937eSJoe Perches } 274413f1937eSJoe Perches 274500df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 27468905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2747000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2748000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 27496c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2750de7d4f0eSAndy Whitcroft } 2751de7d4f0eSAndy Whitcroft 2752de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2753de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2754171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2755171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2756171ae1a4SAndy Whitcroft 2757171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2758171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2759171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2760171ae1a4SAndy Whitcroft 276134d99219SJoe Perches CHK("INVALID_UTF8", 2762000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 276300df344fSAndy Whitcroft } 27640a920b5bSAndy Whitcroft 276515662b3eSJoe Perches# Check if it's the start of a commit log 276615662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 276715662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 2768eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 2769eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 277015662b3eSJoe Perches $in_header_lines = 0; 277115662b3eSJoe Perches $in_commit_log = 1; 2772ed43c4e5SAllen Hubbe $has_commit_log = 1; 277315662b3eSJoe Perches } 277415662b3eSJoe Perches 2775fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2776fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2777fa64205dSPasi Savanainen if ($in_header_lines && 2778fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2779fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2780fa64205dSPasi Savanainen $non_utf8_charset = 1; 2781fa64205dSPasi Savanainen } 2782fa64205dSPasi Savanainen 2783fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 278415662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2785fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 278615662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 278715662b3eSJoe Perches } 278815662b3eSJoe Perches 2789d6430f71SJoe Perches# Check for absolute kernel paths in commit message 2790d6430f71SJoe Perches if ($tree && $in_commit_log) { 2791d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 2792d6430f71SJoe Perches my $file = $1; 2793d6430f71SJoe Perches 2794d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 2795d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 2796d6430f71SJoe Perches # 2797d6430f71SJoe Perches } else { 2798d6430f71SJoe Perches check_absolute_file($file, $herecurr); 2799d6430f71SJoe Perches } 2800d6430f71SJoe Perches } 2801d6430f71SJoe Perches } 2802d6430f71SJoe Perches 280366b47b4aSKees Cook# Check for various typo / spelling mistakes 280466d7a382SJoe Perches if (defined($misspellings) && 280566d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2806ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 280766b47b4aSKees Cook my $typo = $1; 280866b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 280966b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 281066b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 28110675a8fbSJean Delvare my $msg_level = \&WARN; 28120675a8fbSJean Delvare $msg_level = \&CHK if ($file); 28130675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 281466b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 281566b47b4aSKees Cook $fix) { 281666b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 281766b47b4aSKees Cook } 281866b47b4aSKees Cook } 281966b47b4aSKees Cook } 282066b47b4aSKees Cook 282130670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 282230670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 282300df344fSAndy Whitcroft 28240a920b5bSAndy Whitcroft#trailing whitespace 28259c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2826c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2827d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2828d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2829d5e616fcSJoe Perches $fix) { 2830194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2831d5e616fcSJoe Perches } 2832c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2833c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28343705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 28353705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 28363705ce5bSJoe Perches $fix) { 2837194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 28383705ce5bSJoe Perches } 28393705ce5bSJoe Perches 2840d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 28410a920b5bSAndy Whitcroft } 28425368df20SAndy Whitcroft 28434783f894SJosh Triplett# Check for FSF mailing addresses. 2844109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 28451bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 28463e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 28473e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 28484783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28490675a8fbSJean Delvare my $msg_level = \&ERROR; 28500675a8fbSJean Delvare $msg_level = \&CHK if ($file); 28510675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 28524783f894SJosh 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) 28534783f894SJosh Triplett } 28544783f894SJosh Triplett 28553354957aSAndi Kleen# check for Kconfig help text having a real description 28569fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 28579fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 28583354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 2859678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 2860678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 2861678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 2862678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 28633354957aSAndi Kleen my $length = 0; 28649fe287d7SAndy Whitcroft my $cnt = $realcnt; 28659fe287d7SAndy Whitcroft my $ln = $linenr + 1; 28669fe287d7SAndy Whitcroft my $f; 2867a1385803SAndy Whitcroft my $is_start = 0; 28689fe287d7SAndy Whitcroft my $is_end = 0; 2869a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 28709fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 28719fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 28729fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 28739fe287d7SAndy Whitcroft 28749fe287d7SAndy Whitcroft next if ($f =~ /^-/); 28758d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2876a1385803SAndy Whitcroft 287786adf1a0SUlf Magnusson if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 2878a1385803SAndy Whitcroft $is_start = 1; 287984af7a61SUlf Magnusson } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) { 288084af7a61SUlf Magnusson if ($lines[$ln - 1] =~ "---help---") { 288184af7a61SUlf Magnusson WARN("CONFIG_DESCRIPTION", 288284af7a61SUlf Magnusson "prefer 'help' over '---help---' for new help texts\n" . $herecurr); 288384af7a61SUlf Magnusson } 2884a1385803SAndy Whitcroft $length = -1; 2885a1385803SAndy Whitcroft } 2886a1385803SAndy Whitcroft 28879fe287d7SAndy Whitcroft $f =~ s/^.//; 28883354957aSAndi Kleen $f =~ s/#.*//; 28893354957aSAndi Kleen $f =~ s/^\s+//; 28903354957aSAndi Kleen next if ($f =~ /^$/); 2891678ae162SUlf Magnusson 2892678ae162SUlf Magnusson # This only checks context lines in the patch 2893678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 2894678ae162SUlf Magnusson # positives, even though some of these are 2895678ae162SUlf Magnusson # common words in help texts 2896678ae162SUlf Magnusson if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| 2897678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 28989fe287d7SAndy Whitcroft $is_end = 1; 28999fe287d7SAndy Whitcroft last; 29009fe287d7SAndy Whitcroft } 29013354957aSAndi Kleen $length++; 29023354957aSAndi Kleen } 290356193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2904000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 290556193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 290656193274SVadim Bendebury } 2907a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 29083354957aSAndi Kleen } 29093354957aSAndi Kleen 2910628f91a2SJoe Perches# check for MAINTAINERS entries that don't have the right form 2911628f91a2SJoe Perches if ($realfile =~ /^MAINTAINERS$/ && 2912628f91a2SJoe Perches $rawline =~ /^\+[A-Z]:/ && 2913628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 2914628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 2915628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 2916628f91a2SJoe Perches $fix) { 2917628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 2918628f91a2SJoe Perches } 2919628f91a2SJoe Perches } 2920628f91a2SJoe Perches 2921327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2922327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2923327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2924327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2925327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2926327953e9SChristoph Jaeger } 2927327953e9SChristoph Jaeger 2928c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2929c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2930c68e5878SArnaud Lacombe my $flag = $1; 2931c68e5878SArnaud Lacombe my $replacement = { 2932c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2933c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2934c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2935c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2936c68e5878SArnaud Lacombe }; 2937c68e5878SArnaud Lacombe 2938c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2939c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2940c68e5878SArnaud Lacombe } 2941c68e5878SArnaud Lacombe 2942bff5da43SRob Herring# check for DT compatible documentation 29437dd05b38SFlorian Vaussard if (defined $root && 29447dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 29457dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 29467dd05b38SFlorian Vaussard 2947bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2948bff5da43SRob Herring 2949cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2950cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2951cc93319bSFlorian Vaussard 2952bff5da43SRob Herring foreach my $compat (@compats) { 2953bff5da43SRob Herring my $compat2 = $compat; 2954185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2955185d566bSRob Herring my $compat3 = $compat; 2956185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2957185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2958bff5da43SRob Herring if ( $? >> 8 ) { 2959bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2960bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2961bff5da43SRob Herring } 2962bff5da43SRob Herring 29634fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 29644fbf32a6SFlorian Vaussard my $vendor = $1; 2965cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2966bff5da43SRob Herring if ( $? >> 8 ) { 2967bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2968cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2969bff5da43SRob Herring } 2970bff5da43SRob Herring } 2971bff5da43SRob Herring } 2972bff5da43SRob Herring 29739f3a8992SRob Herring# check for using SPDX license tag at beginning of files 29749f3a8992SRob Herring if ($realline == $checklicenseline) { 29759f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 29769f3a8992SRob Herring $checklicenseline = 2; 29779f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 29789f3a8992SRob Herring my $comment = ""; 29799f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 29809f3a8992SRob Herring $comment = '/*'; 29819f3a8992SRob Herring } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 29829f3a8992SRob Herring $comment = '//'; 29839f3a8992SRob Herring } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) { 29849f3a8992SRob Herring $comment = '#'; 29859f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 29869f3a8992SRob Herring $comment = '..'; 29879f3a8992SRob Herring } 29889f3a8992SRob Herring 29899f3a8992SRob Herring if ($comment !~ /^$/ && 29909f3a8992SRob Herring $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) { 29919f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 29929f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 29933b6e8ac9SJoe Perches } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) { 29943b6e8ac9SJoe Perches my $spdx_license = $1; 29953b6e8ac9SJoe Perches if (!is_SPDX_License_valid($spdx_license)) { 29963b6e8ac9SJoe Perches WARN("SPDX_LICENSE_TAG", 29973b6e8ac9SJoe Perches "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr); 29983b6e8ac9SJoe Perches } 29999f3a8992SRob Herring } 30009f3a8992SRob Herring } 30019f3a8992SRob Herring } 30029f3a8992SRob Herring 30035368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 3004d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 30055368df20SAndy Whitcroft 300647e0c88bSJoe Perches# line length limit (with some exclusions) 300747e0c88bSJoe Perches# 300847e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 300947e0c88bSJoe Perches# logging functions like pr_info that end in a string 301047e0c88bSJoe Perches# lines with a single string 301147e0c88bSJoe Perches# #defines that are a single string 30122e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 301347e0c88bSJoe Perches# 301447e0c88bSJoe Perches# There are 3 different line length message types: 3015ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 301647e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 301747e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 301847e0c88bSJoe Perches# 301947e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 302047e0c88bSJoe Perches# 302147e0c88bSJoe Perches 3022b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 302347e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 302447e0c88bSJoe Perches 302547e0c88bSJoe Perches # Check the allowed long line types first 302647e0c88bSJoe Perches 302747e0c88bSJoe Perches # logging functions that end in a string that starts 302847e0c88bSJoe Perches # before $max_line_length 302947e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 303047e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 303147e0c88bSJoe Perches $msg_type = ""; 303247e0c88bSJoe Perches 303347e0c88bSJoe Perches # lines with only strings (w/ possible termination) 303447e0c88bSJoe Perches # #defines with only strings 303547e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 303647e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 303747e0c88bSJoe Perches $msg_type = ""; 303847e0c88bSJoe Perches 3039cc147506SJoe Perches # More special cases 3040cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3041cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3042d560a5f8SJoe Perches $msg_type = ""; 3043d560a5f8SJoe Perches 30442e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 30452e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 30462e4bbbc5SAndreas Brauchli $msg_type = ""; 30472e4bbbc5SAndreas Brauchli 304847e0c88bSJoe Perches # Otherwise set the alternate message types 304947e0c88bSJoe Perches 305047e0c88bSJoe Perches # a comment starts before $max_line_length 305147e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 305247e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 305347e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 305447e0c88bSJoe Perches 305547e0c88bSJoe Perches # a quoted string starts before $max_line_length 305647e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 305747e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 305847e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 305947e0c88bSJoe Perches } 306047e0c88bSJoe Perches 306147e0c88bSJoe Perches if ($msg_type ne "" && 306247e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 306347e0c88bSJoe Perches WARN($msg_type, 30646cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 30650a920b5bSAndy Whitcroft } 306647e0c88bSJoe Perches } 30670a920b5bSAndy Whitcroft 30688905a67cSAndy Whitcroft# check for adding lines without a newline. 30698905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 3070000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 3071000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 30728905a67cSAndy Whitcroft } 30738905a67cSAndy Whitcroft 3074b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3075de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 30760a920b5bSAndy Whitcroft 30770a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 30780a920b5bSAndy Whitcroft# more than 8 must use tabs. 3079c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3080c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3081c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3082d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 30833705ce5bSJoe Perches if (ERROR("CODE_INDENT", 30843705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 30853705ce5bSJoe Perches $fix) { 3086194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 30873705ce5bSJoe Perches } 30880a920b5bSAndy Whitcroft } 30890a920b5bSAndy Whitcroft 309008e44365SAlberto Panizzo# check for space before tabs. 309108e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 309208e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 30933705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 30943705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 30953705ce5bSJoe Perches $fix) { 3096194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3097d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 3098194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3099c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 31003705ce5bSJoe Perches } 310108e44365SAlberto Panizzo } 310208e44365SAlberto Panizzo 31036a487211SJoe Perches# check for assignments on the start of a line 31046a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 31056a487211SJoe Perches CHK("ASSIGNMENT_CONTINUATIONS", 31066a487211SJoe Perches "Assignment operator '$1' should be on the previous line\n" . $hereprev); 31076a487211SJoe Perches } 31086a487211SJoe Perches 3109d1fe9c09SJoe Perches# check for && or || at the start of a line 3110d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 3111d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 3112d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 3113d1fe9c09SJoe Perches } 3114d1fe9c09SJoe Perches 3115a91e8994SJoe Perches# check indentation starts on a tab stop 31165b57980dSJoe Perches if ($perl_version_ok && 3117bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3118a91e8994SJoe Perches my $indent = length($1); 3119a91e8994SJoe Perches if ($indent % 8) { 3120a91e8994SJoe Perches if (WARN("TABSTOP", 3121a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3122a91e8994SJoe Perches $fix) { 3123a91e8994SJoe Perches $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; 3124a91e8994SJoe Perches } 3125a91e8994SJoe Perches } 3126a91e8994SJoe Perches } 3127a91e8994SJoe Perches 3128d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 31295b57980dSJoe Perches if ($perl_version_ok && 3130fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3131d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3132d1fe9c09SJoe Perches my $oldindent = $1; 3133d1fe9c09SJoe Perches my $rest = $2; 3134d1fe9c09SJoe Perches 3135d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3136d1fe9c09SJoe Perches if ($pos >= 0) { 3137b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3138b34a26f3SJoe Perches my $newindent = $2; 3139d1fe9c09SJoe Perches 3140d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3141d1fe9c09SJoe Perches "\t" x ($pos / 8) . 3142d1fe9c09SJoe Perches " " x ($pos % 8); 3143d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3144d1fe9c09SJoe Perches 3145d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3146d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 31473705ce5bSJoe Perches 31483705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 31493705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 31503705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3151194f66fcSJoe Perches $fixed[$fixlinenr] =~ 31523705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 31533705ce5bSJoe Perches } 3154d1fe9c09SJoe Perches } 3155d1fe9c09SJoe Perches } 3156d1fe9c09SJoe Perches } 3157d1fe9c09SJoe Perches 31586ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 31596ab3a970SJoe Perches# avoid checking a few false positives: 31606ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 31616ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 31626ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 31636ab3a970SJoe Perches# multiline macros that define functions 31646ab3a970SJoe Perches# known attributes or the __attribute__ keyword 31656ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 31666ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 31673705ce5bSJoe Perches if (CHK("SPACING", 3168f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 31693705ce5bSJoe Perches $fix) { 3170194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3171f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 31723705ce5bSJoe Perches } 3173aad4f614SJoe Perches } 3174aad4f614SJoe Perches 317586406b1cSJoe Perches# Block comment styles 317686406b1cSJoe Perches# Networking with an initial /* 317705880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3178fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 317985ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 318085ad978cSJoe Perches $realline > 2) { 318105880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 318205880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 318305880600SJoe Perches } 318405880600SJoe Perches 318586406b1cSJoe Perches# Block comments use * on subsequent lines 318686406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 318786406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3188a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 318961135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3190a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 319186406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 319286406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3193a605e32eSJoe Perches } 3194a605e32eSJoe Perches 319586406b1cSJoe Perches# Block comments use */ on trailing lines 319686406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3197c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3198c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3199c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 320086406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 320186406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 320205880600SJoe Perches } 320305880600SJoe Perches 320408eb9b80SJoe Perches# Block comment * alignment 320508eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3206af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3207af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3208af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 320908eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3210af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3211af207524SJoe Perches my $oldindent; 321208eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3213af207524SJoe Perches if (defined($1)) { 3214af207524SJoe Perches $oldindent = expand_tabs($1); 3215af207524SJoe Perches } else { 3216af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3217af207524SJoe Perches $oldindent = expand_tabs($1); 3218af207524SJoe Perches } 321908eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 322008eb9b80SJoe Perches my $newindent = $1; 322108eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3222af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 322308eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 322408eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 322508eb9b80SJoe Perches } 322608eb9b80SJoe Perches } 322708eb9b80SJoe Perches 32287f619191SJoe Perches# check for missing blank lines after struct/union declarations 32297f619191SJoe Perches# with exceptions for various attributes and macros 32307f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 32317f619191SJoe Perches $line =~ /^\+/ && 32327f619191SJoe Perches !($line =~ /^\+\s*$/ || 32337f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 32347f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 32357f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 32367f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 32377f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 32387f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 32390bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 32407f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3241d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3242d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3243d752fcc8SJoe Perches $fix) { 3244f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3245d752fcc8SJoe Perches } 32467f619191SJoe Perches } 32477f619191SJoe Perches 3248365dd4eaSJoe Perches# check for multiple consecutive blank lines 3249365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3250365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3251365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3252d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3253d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3254d752fcc8SJoe Perches $fix) { 3255f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3256d752fcc8SJoe Perches } 3257d752fcc8SJoe Perches 3258365dd4eaSJoe Perches $last_blank_line = $linenr; 3259365dd4eaSJoe Perches } 3260365dd4eaSJoe Perches 32613b617e3bSJoe Perches# check for missing blank lines after declarations 32623f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 32633f7bac03SJoe Perches # actual declarations 32643f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 32655a4e1fd3SJoe Perches # function pointer declarations 32665a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 32673f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 32683f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 32693f7bac03SJoe Perches # known declaration macros 32703f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 32713f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 32723f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 32733f7bac03SJoe Perches # other possible extensions of declaration lines 32743f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 32753f7bac03SJoe Perches # not starting a section or a macro "\" extended line 32763f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 32773f7bac03SJoe Perches # looks like a declaration 32783f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 32795a4e1fd3SJoe Perches # function pointer declarations 32805a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 32813f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 32823f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 32833f7bac03SJoe Perches # known declaration macros 32843f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 32853f7bac03SJoe Perches # start of struct or union or enum 32863b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 32873f7bac03SJoe Perches # start or end of block or continuation of declaration 32883f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 32893f7bac03SJoe Perches # bitfield continuation 32903f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 32913f7bac03SJoe Perches # other possible extensions of declaration lines 32923f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 32933f7bac03SJoe Perches # indentation of previous and current line are the same 32943f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3295d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3296d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3297d752fcc8SJoe Perches $fix) { 3298f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3299d752fcc8SJoe Perches } 33003b617e3bSJoe Perches } 33013b617e3bSJoe Perches 33025f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 33036b4c5bebSAndy Whitcroft# Exceptions: 33046b4c5bebSAndy Whitcroft# 1) within comments 33056b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 33066b4c5bebSAndy Whitcroft# 3) hanging labels 33073705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 33085f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 33093705ce5bSJoe Perches if (WARN("LEADING_SPACE", 33103705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 33113705ce5bSJoe Perches $fix) { 3312194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 33133705ce5bSJoe Perches } 33145f7ddae6SRaffaele Recalcati } 33155f7ddae6SRaffaele Recalcati 3316b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3317b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3318b9ea10d6SAndy Whitcroft 33195751a24eSJoe Perches# check for unusual line ending [ or ( 33205751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 33215751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 33225751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 33235751a24eSJoe Perches } 33245751a24eSJoe Perches 33254dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 33264dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 33274dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 33284dbed76fSJoe Perches $context_function = $1; 33294dbed76fSJoe Perches } 33304dbed76fSJoe Perches 33314dbed76fSJoe Perches# check if this appears to be the end of function declaration 33324dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 33334dbed76fSJoe Perches undef $context_function; 33344dbed76fSJoe Perches } 33354dbed76fSJoe Perches 3336032a4c0fSJoe Perches# check indentation of any line with a bare else 3337840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3338032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3339032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3340032a4c0fSJoe Perches my $tabs = length($1) + 1; 3341840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3342840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3343840080a0SJoe Perches defined $lines[$linenr] && 3344840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3345032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3346032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3347032a4c0fSJoe Perches } 3348032a4c0fSJoe Perches } 3349032a4c0fSJoe Perches 3350c00df19aSJoe Perches# check indentation of a line with a break; 3351c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3352c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3353c00df19aSJoe Perches my $tabs = $1; 3354c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3355c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3356c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3357c00df19aSJoe Perches } 3358c00df19aSJoe Perches } 3359c00df19aSJoe Perches 3360c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3361cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3362000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3363000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3364c2fdda0dSAndy Whitcroft } 336522f2a2efSAndy Whitcroft 336656e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 336756e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 336856e77d70SJoe Perches WARN("HOTPLUG_SECTION", 336956e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 337056e77d70SJoe Perches } 337156e77d70SJoe Perches 33729c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 33732b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 33742b474a1aSAndy Whitcroft $realline_next); 33753e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 3376ca819864SJoe Perches if ($linenr > $suppress_statement && 33771b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3378170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3379f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3380171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3381171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3382171ae1a4SAndy Whitcroft 33833e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 33843e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 33853e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 33863e469cdcSAndy Whitcroft # until we hit end of it. 33873e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 33883e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 33893e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 33903e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 33913e469cdcSAndy Whitcroft } 3392f74bd194SAndy Whitcroft 33932b474a1aSAndy Whitcroft # Find the real next line. 33942b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 33952b474a1aSAndy Whitcroft if (defined $realline_next && 33962b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 33972b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 33982b474a1aSAndy Whitcroft $realline_next++; 33992b474a1aSAndy Whitcroft } 34002b474a1aSAndy Whitcroft 3401171ae1a4SAndy Whitcroft my $s = $stat; 3402171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3403cf655043SAndy Whitcroft 3404c2fdda0dSAndy Whitcroft # Ignore goto labels. 3405171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3406c2fdda0dSAndy Whitcroft 3407c2fdda0dSAndy Whitcroft # Ignore functions being called 3408171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3409c2fdda0dSAndy Whitcroft 3410463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3411463f2864SAndy Whitcroft 3412c45dcabdSAndy Whitcroft # declarations always start with types 3413d2506586SAndy 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) { 3414c45dcabdSAndy Whitcroft my $type = $1; 3415c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3416c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3417c45dcabdSAndy Whitcroft 34186c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3419a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3420c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3421c2fdda0dSAndy Whitcroft } 34228905a67cSAndy Whitcroft 34236c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 342465863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3425c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 34269c0ca6f9SAndy Whitcroft } 34278905a67cSAndy Whitcroft 34288905a67cSAndy Whitcroft # Check for any sort of function declaration. 34298905a67cSAndy Whitcroft # int foo(something bar, other baz); 34308905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3431171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 34328905a67cSAndy Whitcroft my ($name_len) = length($1); 34338905a67cSAndy Whitcroft 3434cf655043SAndy Whitcroft my $ctx = $s; 3435773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 34368905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3437cf655043SAndy Whitcroft 34388905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3439c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 34408905a67cSAndy Whitcroft 3441c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 34428905a67cSAndy Whitcroft } 34438905a67cSAndy Whitcroft } 34448905a67cSAndy Whitcroft } 34458905a67cSAndy Whitcroft 34469c0ca6f9SAndy Whitcroft } 34479c0ca6f9SAndy Whitcroft 344800df344fSAndy Whitcroft# 344900df344fSAndy Whitcroft# Checks which may be anchored in the context. 345000df344fSAndy Whitcroft# 345100df344fSAndy Whitcroft 345200df344fSAndy Whitcroft# Check for switch () and associated case and default 345300df344fSAndy Whitcroft# statements should be at the same indent. 345400df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 345500df344fSAndy Whitcroft my $err = ''; 345600df344fSAndy Whitcroft my $sep = ''; 345700df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 345800df344fSAndy Whitcroft shift(@ctx); 345900df344fSAndy Whitcroft for my $ctx (@ctx) { 346000df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 346100df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 346200df344fSAndy Whitcroft $indent != $cindent) { 346300df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 346400df344fSAndy Whitcroft $sep = ''; 346500df344fSAndy Whitcroft } else { 346600df344fSAndy Whitcroft $sep = "[...]\n"; 346700df344fSAndy Whitcroft } 346800df344fSAndy Whitcroft } 346900df344fSAndy Whitcroft if ($err ne '') { 3470000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3471000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3472de7d4f0eSAndy Whitcroft } 3473de7d4f0eSAndy Whitcroft } 3474de7d4f0eSAndy Whitcroft 3475de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3476de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 34770fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3478773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3479773647a0SAndy Whitcroft 34809c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 34818eef05ddSJoe Perches 34828eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 34838eef05ddSJoe Perches WARN("DEEP_INDENTATION", 34848eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 34858eef05ddSJoe Perches } 34868eef05ddSJoe Perches 3487de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3488de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3489de7d4f0eSAndy Whitcroft 3490548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3491548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3492de7d4f0eSAndy Whitcroft 3493548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3494548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3495548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3496548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3497548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3498773647a0SAndy Whitcroft $ctx_ln++; 3499773647a0SAndy Whitcroft } 3500548596d5SAndy Whitcroft 350153210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 350253210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3503773647a0SAndy Whitcroft 3504773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3505000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3506000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 350701464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 350800df344fSAndy Whitcroft } 3509773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3510773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3511773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3512773647a0SAndy Whitcroft { 35139c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 35149c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3515000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3516000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 351701464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 35189c0ca6f9SAndy Whitcroft } 35199c0ca6f9SAndy Whitcroft } 352000df344fSAndy Whitcroft } 352100df344fSAndy Whitcroft 35224d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 3523f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 35243e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 35253e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 35263e469cdcSAndy Whitcroft if (!defined $stat); 35274d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 35284d001e4dSAndy Whitcroft 35294d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 35304d001e4dSAndy Whitcroft 35319f5af480SJoe Perches # remove inline comments 35329f5af480SJoe Perches $s =~ s/$;/ /g; 35339f5af480SJoe Perches $c =~ s/$;/ /g; 35344d001e4dSAndy Whitcroft 35354d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 35366f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 35376f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 35384d001e4dSAndy Whitcroft 35399f5af480SJoe Perches # Make sure we remove the line prefixes as we have 35409f5af480SJoe Perches # none on the first line, and are going to readd them 35419f5af480SJoe Perches # where necessary. 35429f5af480SJoe Perches $s =~ s/\n./\n/gs; 35439f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 35449f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 35459f5af480SJoe Perches } 35469f5af480SJoe Perches 35474d001e4dSAndy Whitcroft # We want to check the first line inside the block 35484d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 35494d001e4dSAndy Whitcroft # 1) any blank line termination 35504d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 35514d001e4dSAndy Whitcroft # 3) any do (...) { 35524d001e4dSAndy Whitcroft my $continuation = 0; 35534d001e4dSAndy Whitcroft my $check = 0; 35544d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 35554d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 35564d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 35574d001e4dSAndy Whitcroft $continuation = 1; 35584d001e4dSAndy Whitcroft } 35599bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 35604d001e4dSAndy Whitcroft $check = 1; 35614d001e4dSAndy Whitcroft $cond_lines++; 35624d001e4dSAndy Whitcroft } 35634d001e4dSAndy Whitcroft 35644d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 35654d001e4dSAndy Whitcroft # preprocessor statement. 35664d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 35674d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 35684d001e4dSAndy Whitcroft $check = 0; 35694d001e4dSAndy Whitcroft } 35704d001e4dSAndy Whitcroft 35719bd49efeSAndy Whitcroft my $cond_ptr = -1; 3572740504c6SAndy Whitcroft $continuation = 0; 35739bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 35749bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 35754d001e4dSAndy Whitcroft 3576f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3577f16fa28fSAndy Whitcroft # is not linear. 3578f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3579f16fa28fSAndy Whitcroft $check = 0; 3580f16fa28fSAndy Whitcroft } 3581f16fa28fSAndy Whitcroft 35829bd49efeSAndy Whitcroft # Ignore: 35839bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 35849bd49efeSAndy Whitcroft # 2) preprocessor lines, and 35859bd49efeSAndy Whitcroft # 3) labels. 3586740504c6SAndy Whitcroft if ($continuation || 3587740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 35889bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 35899bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3590740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 359130dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 35929bd49efeSAndy Whitcroft $cond_lines++; 35939bd49efeSAndy Whitcroft } 35944d001e4dSAndy Whitcroft } 359530dad6ebSAndy Whitcroft } 35964d001e4dSAndy Whitcroft 35974d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 35984d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 35994d001e4dSAndy Whitcroft 36004d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 36014d001e4dSAndy Whitcroft # this is not this patch's fault. 36024d001e4dSAndy Whitcroft if (!defined($stat_real) || 36034d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 36044d001e4dSAndy Whitcroft $check = 0; 36054d001e4dSAndy Whitcroft } 36064d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 36074d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 36084d001e4dSAndy Whitcroft } 36094d001e4dSAndy Whitcroft 36109bd49efeSAndy 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"; 36114d001e4dSAndy Whitcroft 36129f5af480SJoe Perches if ($check && $s ne '' && 36139f5af480SJoe Perches (($sindent % 8) != 0 || 36149f5af480SJoe Perches ($sindent < $indent) || 3615f6950a73SJoe Perches ($sindent == $indent && 3616f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 36179f5af480SJoe Perches ($sindent > $indent + 8))) { 3618000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3619000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 36204d001e4dSAndy Whitcroft } 36214d001e4dSAndy Whitcroft } 36224d001e4dSAndy Whitcroft 36236c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 36246c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 36251f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 36261f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 36276c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3628c2fdda0dSAndy Whitcroft if ($dbg_values) { 3629c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3630cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3631cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 36321f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3633c2fdda0dSAndy Whitcroft } 36346c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 36356c72ffaaSAndy Whitcroft 363600df344fSAndy Whitcroft#ignore lines not being added 36373705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 363800df344fSAndy Whitcroft 363911ca40a0SJoe Perches# check for dereferences that span multiple lines 364011ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 364111ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 364211ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 364311ca40a0SJoe Perches my $ref = $1; 364411ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 364511ca40a0SJoe Perches $ref .= $1; 364611ca40a0SJoe Perches $ref =~ s/\s//g; 364711ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 364811ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 364911ca40a0SJoe Perches } 365011ca40a0SJoe Perches 3651a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3652c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3653a1ce18e4SJoe Perches my $type = $1; 3654a1ce18e4SJoe Perches my $var = $2; 3655207a8e84SJoe Perches $var = "" if (!defined $var); 3656207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3657a1ce18e4SJoe Perches my $sign = $1; 3658a1ce18e4SJoe Perches my $pointer = $2; 3659a1ce18e4SJoe Perches 3660a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3661a1ce18e4SJoe Perches 3662a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3663a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3664a1ce18e4SJoe Perches $fix) { 3665a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3666207a8e84SJoe Perches my $comp_pointer = $pointer; 3667207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 3668207a8e84SJoe Perches $decl .= $comp_pointer; 3669207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 3670207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 3671a1ce18e4SJoe Perches } 3672a1ce18e4SJoe Perches } 3673a1ce18e4SJoe Perches } 3674a1ce18e4SJoe Perches 3675653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 36767429c690SAndy Whitcroft if ($dbg_type) { 36777429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3678000d1cc1SJoe Perches ERROR("TEST_TYPE", 3679000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 36807429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3681000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3682000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 36837429c690SAndy Whitcroft } 3684653d4876SAndy Whitcroft next; 3685653d4876SAndy Whitcroft } 3686a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3687a1ef277eSAndy Whitcroft if ($dbg_attr) { 36889360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3689000d1cc1SJoe Perches ERROR("TEST_ATTR", 3690000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 36919360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3692000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3693000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3694a1ef277eSAndy Whitcroft } 3695a1ef277eSAndy Whitcroft next; 3696a1ef277eSAndy Whitcroft } 3697653d4876SAndy Whitcroft 3698f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 369999423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 370099423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3701d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3702d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3703f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3704f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3705f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3706d752fcc8SJoe Perches my $fixedline = $prevrawline; 3707d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3708f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3709d752fcc8SJoe Perches $fixedline = $line; 37108d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 3711f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3712d752fcc8SJoe Perches } 3713f0a594c1SAndy Whitcroft } 3714f0a594c1SAndy Whitcroft 371500df344fSAndy Whitcroft# 371600df344fSAndy Whitcroft# Checks which are anchored on the added line. 371700df344fSAndy Whitcroft# 371800df344fSAndy Whitcroft 3719653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3720c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3721653d4876SAndy Whitcroft my $path = $1; 3722653d4876SAndy Whitcroft if ($path =~ m{//}) { 3723000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3724495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3725495e9d84SJoe Perches } 3726495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3727495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3728495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3729653d4876SAndy Whitcroft } 3730653d4876SAndy Whitcroft } 3731653d4876SAndy Whitcroft 373200df344fSAndy Whitcroft# no C99 // comments 373300df344fSAndy Whitcroft if ($line =~ m{//}) { 37343705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 37353705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 37363705ce5bSJoe Perches $fix) { 3737194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 37383705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 37393705ce5bSJoe Perches my $comment = trim($1); 3740194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 37413705ce5bSJoe Perches } 37423705ce5bSJoe Perches } 374300df344fSAndy Whitcroft } 374400df344fSAndy Whitcroft # Remove C99 comments. 37450a920b5bSAndy Whitcroft $line =~ s@//.*@@; 37466c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 37470a920b5bSAndy Whitcroft 37482b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 37492b474a1aSAndy Whitcroft# the whole statement. 37502b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 37512b474a1aSAndy Whitcroft if (defined $realline_next && 37522b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 37532b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 37542b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 37552b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 37563cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 37573cbf62dfSAndy Whitcroft # a prefix: 37583cbf62dfSAndy Whitcroft # XXX(foo); 37593cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3760653d4876SAndy Whitcroft my $name = $1; 376187a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 37623cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 37633cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 37643cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 37653cbf62dfSAndy Whitcroft 37663cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 37672b474a1aSAndy Whitcroft \n.}\s*$| 376848012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 376948012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 377048012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 37712b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 37722b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 377348012058SAndy Whitcroft )/x) { 37742b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 37752b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 37762b474a1aSAndy Whitcroft } else { 37772b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 37780a920b5bSAndy Whitcroft } 37790a920b5bSAndy Whitcroft } 37802b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 37812b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 37822b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 37832b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 37842b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 37852b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 37862b474a1aSAndy Whitcroft } 37872b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 37882b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3789000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3790000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 37912b474a1aSAndy Whitcroft } 37920a920b5bSAndy Whitcroft 37935150bda4SJoe Eloff# check for global initialisers. 37946d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 3795d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 37966d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 3797d5e616fcSJoe Perches $fix) { 37986d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 3799d5e616fcSJoe Perches } 3800f0a594c1SAndy Whitcroft } 38010a920b5bSAndy Whitcroft# check for static initialisers. 38026d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 3803d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 38046d32f7a3SJoe Perches "do not initialise statics to $1\n" . 3805d5e616fcSJoe Perches $herecurr) && 3806d5e616fcSJoe Perches $fix) { 38076d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 3808d5e616fcSJoe Perches } 38090a920b5bSAndy Whitcroft } 38100a920b5bSAndy Whitcroft 38111813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 38121813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 38131813087dSJoe Perches my $tmp = trim($1); 38141813087dSJoe Perches WARN("MISORDERED_TYPE", 38151813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 38161813087dSJoe Perches } 38171813087dSJoe Perches 3818cb710ecaSJoe Perches# check for static const char * arrays. 3819cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3820000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3821000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3822cb710ecaSJoe Perches $herecurr); 3823cb710ecaSJoe Perches } 3824cb710ecaSJoe Perches 3825cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3826cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3827000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3828000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3829cb710ecaSJoe Perches $herecurr); 3830cb710ecaSJoe Perches } 3831cb710ecaSJoe Perches 3832ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3833ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3834ab7e23f3SJoe Perches my $found = $1; 3835ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3836ab7e23f3SJoe Perches WARN("CONST_CONST", 3837ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3838ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3839ab7e23f3SJoe Perches WARN("CONST_CONST", 3840ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3841ab7e23f3SJoe Perches } 3842ab7e23f3SJoe Perches } 3843ab7e23f3SJoe Perches 38449b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 38459b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 38469b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 38479b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 38489b0fa60dSJoe Perches $herecurr); 38499b0fa60dSJoe Perches } 38509b0fa60dSJoe Perches 3851b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3852b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3853b598b670SJoe Perches my $array = $1; 3854b598b670SJoe 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*\))@) { 3855b598b670SJoe Perches my $array_div = $1; 3856b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3857b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3858b598b670SJoe Perches $fix) { 3859b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3860b598b670SJoe Perches } 3861b598b670SJoe Perches } 3862b598b670SJoe Perches } 3863b598b670SJoe Perches 3864b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3865b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3866b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3867b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3868b36190c5SJoe Perches $fix) { 3869194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3870b36190c5SJoe Perches } 3871b36190c5SJoe Perches } 3872b36190c5SJoe Perches 3873653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3874653d4876SAndy Whitcroft# make sense. 3875653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 38768054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3877c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 38788ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 387946d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 3880000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3881000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 38820a920b5bSAndy Whitcroft } 38830a920b5bSAndy Whitcroft 38840a920b5bSAndy Whitcroft# * goes on variable not on type 388565863862SAndy Whitcroft # (char*[ const]) 3886bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3887bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 38883705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3889d8aaf121SAndy Whitcroft 389065863862SAndy Whitcroft # Should start with a space. 389165863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 389265863862SAndy Whitcroft # Should not end with a space. 389365863862SAndy Whitcroft $to =~ s/\s+$//; 389465863862SAndy Whitcroft # '*'s should not have spaces between. 3895f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 389665863862SAndy Whitcroft } 3897d8aaf121SAndy Whitcroft 38983705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 389965863862SAndy Whitcroft if ($from ne $to) { 39003705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 39013705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 39023705ce5bSJoe Perches $fix) { 39033705ce5bSJoe Perches my $sub_from = $ident; 39043705ce5bSJoe Perches my $sub_to = $ident; 39053705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3906194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39073705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 39083705ce5bSJoe Perches } 390965863862SAndy Whitcroft } 3910bfcb2cc7SAndy Whitcroft } 3911bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3912bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 39133705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3914d8aaf121SAndy Whitcroft 391565863862SAndy Whitcroft # Should start with a space. 391665863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 391765863862SAndy Whitcroft # Should not end with a space. 391865863862SAndy Whitcroft $to =~ s/\s+$//; 391965863862SAndy Whitcroft # '*'s should not have spaces between. 3920f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 392165863862SAndy Whitcroft } 392265863862SAndy Whitcroft # Modifiers should have spaces. 392365863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 392465863862SAndy Whitcroft 39253705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3926667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 39273705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 39283705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 39293705ce5bSJoe Perches $fix) { 39303705ce5bSJoe Perches 39313705ce5bSJoe Perches my $sub_from = $match; 39323705ce5bSJoe Perches my $sub_to = $match; 39333705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3934194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39353705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 39363705ce5bSJoe Perches } 393765863862SAndy Whitcroft } 39380a920b5bSAndy Whitcroft } 39390a920b5bSAndy Whitcroft 39409d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 39419d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 39420675a8fbSJean Delvare my $msg_level = \&WARN; 39430675a8fbSJean Delvare $msg_level = \&CHK if ($file); 39440675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 39459d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 39469d3e3c70SJoe Perches } 39470a920b5bSAndy Whitcroft 39489d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 39498905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3950000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3951000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 39528905a67cSAndy Whitcroft } 39538905a67cSAndy Whitcroft 395417441227SJoe Perches# check for uses of printk_ratelimit 395517441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3956000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3957000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 395817441227SJoe Perches } 395917441227SJoe Perches 3960eeef5733SJoe Perches# printk should use KERN_* levels 3961eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 3962000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3963eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 396400df344fSAndy Whitcroft } 39650a920b5bSAndy Whitcroft 3966243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3967243f3803SJoe Perches my $orig = $1; 3968243f3803SJoe Perches my $level = lc($orig); 3969243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 39708f26b837SJoe Perches my $level2 = $level; 39718f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3972243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3973daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3974243f3803SJoe Perches } 3975243f3803SJoe Perches 3976243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3977d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3978d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3979d5e616fcSJoe Perches $fix) { 3980194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3981d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3982d5e616fcSJoe Perches } 3983243f3803SJoe Perches } 3984243f3803SJoe Perches 3985dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3986dc139313SJoe Perches my $orig = $1; 3987dc139313SJoe Perches my $level = lc($orig); 3988dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3989dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3990dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3991dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3992dc139313SJoe Perches } 3993dc139313SJoe Perches 399491c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 399591c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 399691c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 399791c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 399891c9afafSAndy Lutomirski WARN("ENOSYS", 399991c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 400091c9afafSAndy Lutomirski } 400191c9afafSAndy Lutomirski 4002653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 4003653d4876SAndy Whitcroft# or if closed on same line 40045b57980dSJoe Perches if ($perl_version_ok && 40052d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 40062d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 40072d453e3bSJoe Perches $sline !~ /}/) { 40088d182478SJoe Perches if (ERROR("OPEN_BRACE", 40092d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 40108d182478SJoe Perches $fix) { 40118d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 40128d182478SJoe Perches my $fixed_line = $rawline; 40138d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 40148d182478SJoe Perches my $line1 = $1; 40158d182478SJoe Perches my $line2 = $2; 40168d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 40178d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 40188d182478SJoe Perches if ($line2 !~ /^\s*$/) { 40198d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 40208d182478SJoe Perches } 40218d182478SJoe Perches } 40220a920b5bSAndy Whitcroft } 4023653d4876SAndy Whitcroft 40248905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 40258905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 40268905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 40278d182478SJoe Perches if (ERROR("OPEN_BRACE", 40288d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 40298d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 40308d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 40318d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 40328d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 40338d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 40348d182478SJoe Perches $fixedline = $rawline; 40358d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 40368d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 40378d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 40388d182478SJoe Perches } 40398d182478SJoe Perches } 40408905a67cSAndy Whitcroft } 40418905a67cSAndy Whitcroft 40420c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 40433705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 40443705ce5bSJoe Perches if (WARN("SPACING", 40453705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 40463705ce5bSJoe Perches $fix) { 4047194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40483705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 40493705ce5bSJoe Perches } 40500c73b4ebSAndy Whitcroft } 40510c73b4ebSAndy Whitcroft 405231070b5dSJoe Perches# Function pointer declarations 405331070b5dSJoe Perches# check spacing between type, funcptr, and args 405431070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 405591f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 405631070b5dSJoe Perches my $declare = $1; 405731070b5dSJoe Perches my $pre_pointer_space = $2; 405831070b5dSJoe Perches my $post_pointer_space = $3; 405931070b5dSJoe Perches my $funcname = $4; 406031070b5dSJoe Perches my $post_funcname_space = $5; 406131070b5dSJoe Perches my $pre_args_space = $6; 406231070b5dSJoe Perches 406391f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 406491f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 406591f72e9cSJoe Perches# don't need a space so don't warn for those. 406691f72e9cSJoe Perches my $post_declare_space = ""; 406791f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 406891f72e9cSJoe Perches $post_declare_space = $1; 406991f72e9cSJoe Perches $declare = rtrim($declare); 407091f72e9cSJoe Perches } 407191f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 407231070b5dSJoe Perches WARN("SPACING", 407331070b5dSJoe Perches "missing space after return type\n" . $herecurr); 407491f72e9cSJoe Perches $post_declare_space = " "; 407531070b5dSJoe Perches } 407631070b5dSJoe Perches 407731070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 407891f72e9cSJoe Perches# This test is not currently implemented because these declarations are 407991f72e9cSJoe Perches# equivalent to 408091f72e9cSJoe Perches# int foo(int bar, ...) 408191f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 408291f72e9cSJoe Perches# 408391f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 408491f72e9cSJoe Perches# WARN("SPACING", 408591f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 408691f72e9cSJoe Perches# } 408731070b5dSJoe Perches 408831070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 408931070b5dSJoe Perches if (defined $pre_pointer_space && 409031070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 409131070b5dSJoe Perches WARN("SPACING", 409231070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 409331070b5dSJoe Perches } 409431070b5dSJoe Perches 409531070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 409631070b5dSJoe Perches if (defined $post_pointer_space && 409731070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 409831070b5dSJoe Perches WARN("SPACING", 409931070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 410031070b5dSJoe Perches } 410131070b5dSJoe Perches 410231070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 410331070b5dSJoe Perches if (defined $post_funcname_space && 410431070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 410531070b5dSJoe Perches WARN("SPACING", 410631070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 410731070b5dSJoe Perches } 410831070b5dSJoe Perches 410931070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 411031070b5dSJoe Perches if (defined $pre_args_space && 411131070b5dSJoe Perches $pre_args_space =~ /^\s/) { 411231070b5dSJoe Perches WARN("SPACING", 411331070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 411431070b5dSJoe Perches } 411531070b5dSJoe Perches 411631070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4117194f66fcSJoe Perches $fixed[$fixlinenr] =~ 411891f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 411931070b5dSJoe Perches } 412031070b5dSJoe Perches } 412131070b5dSJoe Perches 41228d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 41238d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4124fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4125fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 41268d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 41278d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 41288d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4129fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 413038dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 41313705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 41323705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 41333705ce5bSJoe Perches $fix) { 4134194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41353705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 41363705ce5bSJoe Perches } 41378d31cfceSAndy Whitcroft } 41388d31cfceSAndy Whitcroft } 41398d31cfceSAndy Whitcroft 4140f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 41416c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4142c2fdda0dSAndy Whitcroft my $name = $1; 4143773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4144773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4145c2fdda0dSAndy Whitcroft 4146c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4147773647a0SAndy Whitcroft if ($name =~ /^(?: 4148773647a0SAndy Whitcroft if|for|while|switch|return|case| 4149773647a0SAndy Whitcroft volatile|__volatile__| 4150773647a0SAndy Whitcroft __attribute__|format|__extension__| 4151773647a0SAndy Whitcroft asm|__asm__)$/x) 4152773647a0SAndy Whitcroft { 4153c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4154c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4155c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4156c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4157773647a0SAndy Whitcroft 4158773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4159c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4160c2fdda0dSAndy Whitcroft 4161c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4162c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4163773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4164c2fdda0dSAndy Whitcroft 4165c2fdda0dSAndy Whitcroft } else { 41663705ce5bSJoe Perches if (WARN("SPACING", 41673705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 41683705ce5bSJoe Perches $fix) { 4169194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41703705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 41713705ce5bSJoe Perches } 4172f0a594c1SAndy Whitcroft } 41736c72ffaaSAndy Whitcroft } 41749a4cad4eSEric Nelson 4175653d4876SAndy Whitcroft# Check operator spacing. 41760a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 41773705ce5bSJoe Perches my $fixed_line = ""; 41783705ce5bSJoe Perches my $line_fixed = 0; 41793705ce5bSJoe Perches 41809c0ca6f9SAndy Whitcroft my $ops = qr{ 41819c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 41829c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 41839c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 41841f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 418584731623SJoe Perches \?:|\?|: 41869c0ca6f9SAndy Whitcroft }x; 4187cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 41883705ce5bSJoe Perches 41893705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 41903705ce5bSJoe Perches## foreach my $el (@elements) { 41913705ce5bSJoe Perches## print("el: <$el>\n"); 41923705ce5bSJoe Perches## } 41933705ce5bSJoe Perches 41943705ce5bSJoe Perches my @fix_elements = (); 419500df344fSAndy Whitcroft my $off = 0; 41966c72ffaaSAndy Whitcroft 41973705ce5bSJoe Perches foreach my $el (@elements) { 41983705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 41993705ce5bSJoe Perches $off += length($el); 42003705ce5bSJoe Perches } 42013705ce5bSJoe Perches 42023705ce5bSJoe Perches $off = 0; 42033705ce5bSJoe Perches 42046c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4205b34c648bSJoe Perches my $last_after = -1; 42066c72ffaaSAndy Whitcroft 42070a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 42083705ce5bSJoe Perches 42093705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 42103705ce5bSJoe Perches 42113705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 42123705ce5bSJoe Perches 42134a0df2efSAndy Whitcroft $off += length($elements[$n]); 42144a0df2efSAndy Whitcroft 421525985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4216773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4217773647a0SAndy Whitcroft my $cc = ''; 4218773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4219773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4220773647a0SAndy Whitcroft } 4221773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4222773647a0SAndy Whitcroft 42234a0df2efSAndy Whitcroft my $a = ''; 42244a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 42254a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4226cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 42274a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 42284a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 4229773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 42304a0df2efSAndy Whitcroft 42310a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 42324a0df2efSAndy Whitcroft 42334a0df2efSAndy Whitcroft my $c = ''; 42340a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 42354a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 42364a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4237cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 42384a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 42394a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 42408b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 42414a0df2efSAndy Whitcroft } else { 42424a0df2efSAndy Whitcroft $c = 'E'; 42430a920b5bSAndy Whitcroft } 42440a920b5bSAndy Whitcroft 42454a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 42464a0df2efSAndy Whitcroft 42474a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 42484a0df2efSAndy Whitcroft 42496c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 4250de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 42510a920b5bSAndy Whitcroft 425274048ed8SAndy Whitcroft # Pull out the value of this operator. 42536c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 42540a920b5bSAndy Whitcroft 42551f65f947SAndy Whitcroft # Get the full operator variant. 42561f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 42571f65f947SAndy Whitcroft 425813214adfSAndy Whitcroft # Ignore operators passed as parameters. 425913214adfSAndy Whitcroft if ($op_type ne 'V' && 4260d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 426113214adfSAndy Whitcroft 4262cf655043SAndy Whitcroft# # Ignore comments 4263cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 426413214adfSAndy Whitcroft 4265d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 426613214adfSAndy Whitcroft } elsif ($op eq ';') { 4267cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 4268cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 42693705ce5bSJoe Perches if (ERROR("SPACING", 42703705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 4271b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 42723705ce5bSJoe Perches $line_fixed = 1; 42733705ce5bSJoe Perches } 4274d8aaf121SAndy Whitcroft } 4275d8aaf121SAndy Whitcroft 4276d8aaf121SAndy Whitcroft # // is a comment 4277d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 42780a920b5bSAndy Whitcroft 4279b00e4814SJoe Perches # : when part of a bitfield 4280b00e4814SJoe Perches } elsif ($opv eq ':B') { 4281b00e4814SJoe Perches # skip the bitfield test for now 4282b00e4814SJoe Perches 42831f65f947SAndy Whitcroft # No spaces for: 42841f65f947SAndy Whitcroft # -> 4285b00e4814SJoe Perches } elsif ($op eq '->') { 42864a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 42873705ce5bSJoe Perches if (ERROR("SPACING", 42883705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4289b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 42903705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 42913705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 42923705ce5bSJoe Perches } 4293b34c648bSJoe Perches $line_fixed = 1; 42943705ce5bSJoe Perches } 42950a920b5bSAndy Whitcroft } 42960a920b5bSAndy Whitcroft 42972381097bSJoe Perches # , must not have a space before and must have a space on the right. 42980a920b5bSAndy Whitcroft } elsif ($op eq ',') { 42992381097bSJoe Perches my $rtrim_before = 0; 43002381097bSJoe Perches my $space_after = 0; 43012381097bSJoe Perches if ($ctx =~ /Wx./) { 43022381097bSJoe Perches if (ERROR("SPACING", 43032381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 43042381097bSJoe Perches $line_fixed = 1; 43052381097bSJoe Perches $rtrim_before = 1; 43062381097bSJoe Perches } 43072381097bSJoe Perches } 4308cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 43093705ce5bSJoe Perches if (ERROR("SPACING", 43103705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 43113705ce5bSJoe Perches $line_fixed = 1; 4312b34c648bSJoe Perches $last_after = $n; 43132381097bSJoe Perches $space_after = 1; 43142381097bSJoe Perches } 43152381097bSJoe Perches } 43162381097bSJoe Perches if ($rtrim_before || $space_after) { 43172381097bSJoe Perches if ($rtrim_before) { 43182381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43192381097bSJoe Perches } else { 43202381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 43212381097bSJoe Perches } 43222381097bSJoe Perches if ($space_after) { 43232381097bSJoe Perches $good .= " "; 43243705ce5bSJoe Perches } 43250a920b5bSAndy Whitcroft } 43260a920b5bSAndy Whitcroft 43279c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 432874048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 43299c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 43309c0ca6f9SAndy Whitcroft 43319c0ca6f9SAndy Whitcroft # unary operators should have a space before and 43329c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 43339c0ca6f9SAndy Whitcroft # unary operator, or a cast 43349c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 433574048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 43360d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4337cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 43383705ce5bSJoe Perches if (ERROR("SPACING", 43393705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4340b34c648bSJoe Perches if ($n != $last_after + 2) { 4341b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 43423705ce5bSJoe Perches $line_fixed = 1; 43433705ce5bSJoe Perches } 43440a920b5bSAndy Whitcroft } 4345b34c648bSJoe Perches } 4346a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4347171ae1a4SAndy Whitcroft # A unary '*' may be const 4348171ae1a4SAndy Whitcroft 4349171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 43503705ce5bSJoe Perches if (ERROR("SPACING", 43513705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4352b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 43533705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 43543705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 43553705ce5bSJoe Perches } 4356b34c648bSJoe Perches $line_fixed = 1; 43573705ce5bSJoe Perches } 43580a920b5bSAndy Whitcroft } 43590a920b5bSAndy Whitcroft 43600a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 43610a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4362773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 43633705ce5bSJoe Perches if (ERROR("SPACING", 43643705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4365b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 43663705ce5bSJoe Perches $line_fixed = 1; 43673705ce5bSJoe Perches } 43680a920b5bSAndy Whitcroft } 4369773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4370773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 43713705ce5bSJoe Perches if (ERROR("SPACING", 43723705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4373b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43743705ce5bSJoe Perches $line_fixed = 1; 43753705ce5bSJoe Perches } 4376653d4876SAndy Whitcroft } 4377773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 43783705ce5bSJoe Perches if (ERROR("SPACING", 43793705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4380b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 43813705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 43823705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4383773647a0SAndy Whitcroft } 4384b34c648bSJoe Perches $line_fixed = 1; 43853705ce5bSJoe Perches } 43863705ce5bSJoe Perches } 43870a920b5bSAndy Whitcroft 43880a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 43899c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 43909c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 43919c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4392c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4393c2fdda0dSAndy Whitcroft $op eq '%') 43940a920b5bSAndy Whitcroft { 4395d2e025f3SJoe Perches if ($check) { 4396d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4397d2e025f3SJoe Perches if (CHK("SPACING", 4398d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4399d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4400d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4401d2e025f3SJoe Perches $line_fixed = 1; 4402d2e025f3SJoe Perches } 4403d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4404d2e025f3SJoe Perches if (CHK("SPACING", 4405d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4406d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4407d2e025f3SJoe Perches $line_fixed = 1; 4408d2e025f3SJoe Perches } 4409d2e025f3SJoe Perches } 4410d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 44113705ce5bSJoe Perches if (ERROR("SPACING", 44123705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4413b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4414b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4415b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4416b34c648bSJoe Perches } 44173705ce5bSJoe Perches $line_fixed = 1; 44183705ce5bSJoe Perches } 44190a920b5bSAndy Whitcroft } 44200a920b5bSAndy Whitcroft 44211f65f947SAndy Whitcroft # A colon needs no spaces before when it is 44221f65f947SAndy Whitcroft # terminating a case value or a label. 44231f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 44241f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 44253705ce5bSJoe Perches if (ERROR("SPACING", 44263705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4427b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 44283705ce5bSJoe Perches $line_fixed = 1; 44293705ce5bSJoe Perches } 44301f65f947SAndy Whitcroft } 44311f65f947SAndy Whitcroft 44320a920b5bSAndy Whitcroft # All the others need spaces both sides. 4433cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 44341f65f947SAndy Whitcroft my $ok = 0; 44351f65f947SAndy Whitcroft 443622f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 44371f65f947SAndy Whitcroft if (($op eq '<' && 44381f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 44391f65f947SAndy Whitcroft ($op eq '>' && 44401f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 44411f65f947SAndy Whitcroft { 44421f65f947SAndy Whitcroft $ok = 1; 44431f65f947SAndy Whitcroft } 44441f65f947SAndy Whitcroft 4445e0df7e1fSJoe Perches # for asm volatile statements 4446e0df7e1fSJoe Perches # ignore a colon with another 4447e0df7e1fSJoe Perches # colon immediately before or after 4448e0df7e1fSJoe Perches if (($op eq ':') && 4449e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4450e0df7e1fSJoe Perches $ok = 1; 4451e0df7e1fSJoe Perches } 4452e0df7e1fSJoe Perches 445384731623SJoe Perches # messages are ERROR, but ?: are CHK 44541f65f947SAndy Whitcroft if ($ok == 0) { 44550675a8fbSJean Delvare my $msg_level = \&ERROR; 44560675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 445784731623SJoe Perches 44580675a8fbSJean Delvare if (&{$msg_level}("SPACING", 44593705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4460b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4461b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4462b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4463b34c648bSJoe Perches } 44643705ce5bSJoe Perches $line_fixed = 1; 44653705ce5bSJoe Perches } 44660a920b5bSAndy Whitcroft } 446722f2a2efSAndy Whitcroft } 44684a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 44693705ce5bSJoe Perches 44703705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 44713705ce5bSJoe Perches 44723705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 44730a920b5bSAndy Whitcroft } 44743705ce5bSJoe Perches 44753705ce5bSJoe Perches if (($#elements % 2) == 0) { 44763705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 44773705ce5bSJoe Perches } 44783705ce5bSJoe Perches 4479194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4480194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 44813705ce5bSJoe Perches } 44823705ce5bSJoe Perches 44833705ce5bSJoe Perches 44840a920b5bSAndy Whitcroft } 44850a920b5bSAndy Whitcroft 4486786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4487d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4488786b6326SJoe Perches if (WARN("SPACING", 4489786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4490786b6326SJoe Perches $fix) { 4491194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4492786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4493786b6326SJoe Perches } 4494786b6326SJoe Perches } 4495786b6326SJoe Perches 4496f0a594c1SAndy Whitcroft# check for multiple assignments 4497f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4498000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4499000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4500f0a594c1SAndy Whitcroft } 4501f0a594c1SAndy Whitcroft 450222f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 450322f2a2efSAndy Whitcroft## # continuation. 450422f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 450522f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 450622f2a2efSAndy Whitcroft## 450722f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 450822f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 450922f2a2efSAndy Whitcroft## my $ln = $line; 451022f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 451122f2a2efSAndy Whitcroft## } 451222f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4513000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4514000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 451522f2a2efSAndy Whitcroft## } 451622f2a2efSAndy Whitcroft## } 4517f0a594c1SAndy Whitcroft 45180a920b5bSAndy Whitcroft#need space before brace following if, while, etc 45196b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 45204e5d56bdSEddie Kovsky $line =~ /do\{/) { 45213705ce5bSJoe Perches if (ERROR("SPACING", 45223705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 45233705ce5bSJoe Perches $fix) { 45248d81ae05SCyril Bur $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/; 45253705ce5bSJoe Perches } 4526de7d4f0eSAndy Whitcroft } 4527de7d4f0eSAndy Whitcroft 4528c4a62ef9SJoe Perches## # check for blank lines before declarations 4529c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4530c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4531c4a62ef9SJoe Perches## WARN("SPACING", 4532c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4533c4a62ef9SJoe Perches## } 4534c4a62ef9SJoe Perches## 4535c4a62ef9SJoe Perches 4536de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4537de7d4f0eSAndy Whitcroft# on the line 4538de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4539d5e616fcSJoe Perches if (ERROR("SPACING", 4540d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4541d5e616fcSJoe Perches $fix) { 4542194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4543d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4544d5e616fcSJoe Perches } 45450a920b5bSAndy Whitcroft } 45460a920b5bSAndy Whitcroft 454722f2a2efSAndy Whitcroft# check spacing on square brackets 454822f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 45493705ce5bSJoe Perches if (ERROR("SPACING", 45503705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 45513705ce5bSJoe Perches $fix) { 4552194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45533705ce5bSJoe Perches s/\[\s+/\[/; 45543705ce5bSJoe Perches } 455522f2a2efSAndy Whitcroft } 455622f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 45573705ce5bSJoe Perches if (ERROR("SPACING", 45583705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 45593705ce5bSJoe Perches $fix) { 4560194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45613705ce5bSJoe Perches s/\s+\]/\]/; 45623705ce5bSJoe Perches } 456322f2a2efSAndy Whitcroft } 456422f2a2efSAndy Whitcroft 4565c45dcabdSAndy Whitcroft# check spacing on parentheses 45669c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 45679c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 45683705ce5bSJoe Perches if (ERROR("SPACING", 45693705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 45703705ce5bSJoe Perches $fix) { 4571194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45723705ce5bSJoe Perches s/\(\s+/\(/; 45733705ce5bSJoe Perches } 457422f2a2efSAndy Whitcroft } 457513214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4576c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4577c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 45783705ce5bSJoe Perches if (ERROR("SPACING", 45793705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 45803705ce5bSJoe Perches $fix) { 4581194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45823705ce5bSJoe Perches s/\s+\)/\)/; 45833705ce5bSJoe Perches } 458422f2a2efSAndy Whitcroft } 458522f2a2efSAndy Whitcroft 4586e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4587e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4588e2826fd0SJoe Perches 4589e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4590ea4acbb1SJoe Perches my $var = $1; 4591ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4592ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4593ea4acbb1SJoe Perches $fix) { 4594ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4595ea4acbb1SJoe Perches } 4596ea4acbb1SJoe Perches } 4597ea4acbb1SJoe Perches 4598ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4599ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4600ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4601ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4602ea4acbb1SJoe Perches my $var = $2; 4603ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4604ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4605ea4acbb1SJoe Perches $fix) { 4606ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4607ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4608ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4609ea4acbb1SJoe Perches } 4610e2826fd0SJoe Perches } 4611e2826fd0SJoe Perches 461263b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 4613a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 4614a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 46155b57980dSJoe Perches $perl_version_ok && defined($stat) && 461663b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 461763b7c73eSJoe Perches my $if_stat = $1; 461863b7c73eSJoe Perches my $test = substr($2, 1, -1); 461963b7c73eSJoe Perches my $herectx; 462063b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 462163b7c73eSJoe Perches my $match = $1; 462263b7c73eSJoe Perches # avoid parentheses around potential macro args 462363b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 462463b7c73eSJoe Perches if (!defined($herectx)) { 462563b7c73eSJoe Perches $herectx = $here . "\n"; 462663b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 462763b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 462863b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 462963b7c73eSJoe Perches $herectx .= $rl . "\n"; 463063b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 463163b7c73eSJoe Perches } 463263b7c73eSJoe Perches } 463363b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 463463b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 463563b7c73eSJoe Perches } 463663b7c73eSJoe Perches } 463763b7c73eSJoe Perches 46380a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 46394a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 46400a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 46413705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 46423705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 46433705ce5bSJoe Perches $fix) { 4644194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46453705ce5bSJoe Perches s/^(.)\s+/$1/; 46463705ce5bSJoe Perches } 46470a920b5bSAndy Whitcroft } 46480a920b5bSAndy Whitcroft 46495b9553abSJoe Perches# return is not a function 4650507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4651c45dcabdSAndy Whitcroft my $spacing = $1; 46525b57980dSJoe Perches if ($perl_version_ok && 46535b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 46545b9553abSJoe Perches my $value = $1; 46555b9553abSJoe Perches $value = deparenthesize($value); 46565b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4657000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4658000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 46595b9553abSJoe Perches } 4660c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4661000d1cc1SJoe Perches ERROR("SPACING", 4662000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4663c45dcabdSAndy Whitcroft } 4664c45dcabdSAndy Whitcroft } 4665507e5141SJoe Perches 4666b43ae21bSJoe Perches# unnecessary return in a void function 4667b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4668b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4669b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4670b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4671b43ae21bSJoe Perches $linenr >= 3 && 4672b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4673b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 46749819cf25SJoe Perches WARN("RETURN_VOID", 4675b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 46769819cf25SJoe Perches } 46779819cf25SJoe Perches 4678189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 46795b57980dSJoe Perches if ($perl_version_ok && 4680189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4681189248d8SJoe Perches my $openparens = $1; 4682189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4683189248d8SJoe Perches my $msg = ""; 4684189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4685189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4686189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4687189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4688189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4689189248d8SJoe Perches } 4690189248d8SJoe Perches } 4691189248d8SJoe Perches 4692c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4693c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4694c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4695c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 46965b57980dSJoe Perches if ($perl_version_ok && 4697c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4698c5595fa2SJoe Perches my $lead = $1; 4699c5595fa2SJoe Perches my $const = $2; 4700c5595fa2SJoe Perches my $comp = $3; 4701c5595fa2SJoe Perches my $to = $4; 4702c5595fa2SJoe Perches my $newcomp = $comp; 4703f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 4704c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4705c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4706c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4707c5595fa2SJoe Perches $fix) { 4708c5595fa2SJoe Perches if ($comp eq "<") { 4709c5595fa2SJoe Perches $newcomp = ">"; 4710c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4711c5595fa2SJoe Perches $newcomp = ">="; 4712c5595fa2SJoe Perches } elsif ($comp eq ">") { 4713c5595fa2SJoe Perches $newcomp = "<"; 4714c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4715c5595fa2SJoe Perches $newcomp = "<="; 4716c5595fa2SJoe Perches } 4717c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4718c5595fa2SJoe Perches } 4719c5595fa2SJoe Perches } 4720c5595fa2SJoe Perches 4721f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4722f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 472353a3c448SAndy Whitcroft my $name = $1; 472453a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4725000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4726f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 472753a3c448SAndy Whitcroft } 472853a3c448SAndy Whitcroft } 4729c45dcabdSAndy Whitcroft 47300a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 47314a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 47323705ce5bSJoe Perches if (ERROR("SPACING", 47333705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 47343705ce5bSJoe Perches $fix) { 4735194f66fcSJoe Perches $fixed[$fixlinenr] =~ 47363705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 47373705ce5bSJoe Perches } 47380a920b5bSAndy Whitcroft } 47390a920b5bSAndy Whitcroft 4740f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4741f5fe35ddSAndy Whitcroft# statements after the conditional. 4742170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 47433e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 47443e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 47453e469cdcSAndy Whitcroft if (!defined $stat); 4746170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4747170d3a22SAndy Whitcroft $remain_next, $off_next); 4748170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4749170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4750170d3a22SAndy Whitcroft 4751170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4752170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4753170d3a22SAndy Whitcroft # then count those as offsets. 4754170d3a22SAndy Whitcroft my ($whitespace) = 4755170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4756170d3a22SAndy Whitcroft my $offset = 4757170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4758170d3a22SAndy Whitcroft 4759170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4760170d3a22SAndy Whitcroft $offset} = 1; 4761170d3a22SAndy Whitcroft } 4762170d3a22SAndy Whitcroft } 4763170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4764c11230f4SJoe Perches defined($stat) && defined($cond) && 4765170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4766171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 47678905a67cSAndy Whitcroft 4768b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4769000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4770000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 47718905a67cSAndy Whitcroft } 47728905a67cSAndy Whitcroft 47738905a67cSAndy Whitcroft # Find out what is on the end of the line after the 47748905a67cSAndy Whitcroft # conditional. 4775773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 47768905a67cSAndy Whitcroft $s =~ s/\n.*//g; 477713214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 477853210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 477953210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4780773647a0SAndy Whitcroft { 4781bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4782bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4783bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 478442bdf74cSHidetoshi Seto my $stat_real = ''; 4785bb44ad39SAndy Whitcroft 478642bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 478742bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4788bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4789bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4790bb44ad39SAndy Whitcroft } 4791bb44ad39SAndy Whitcroft 4792000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4793000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 47948905a67cSAndy Whitcroft } 47958905a67cSAndy Whitcroft } 47968905a67cSAndy Whitcroft 479713214adfSAndy Whitcroft# Check for bitwise tests written as boolean 479813214adfSAndy Whitcroft if ($line =~ / 479913214adfSAndy Whitcroft (?: 480013214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 480113214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 480213214adfSAndy Whitcroft (?:\&\&|\|\|) 480313214adfSAndy Whitcroft | 480413214adfSAndy Whitcroft (?:\&\&|\|\|) 480513214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 480613214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 480713214adfSAndy Whitcroft )/x) 480813214adfSAndy Whitcroft { 4809000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4810000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 481113214adfSAndy Whitcroft } 481213214adfSAndy Whitcroft 48138905a67cSAndy Whitcroft# if and else should not have general statements after it 481413214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 481513214adfSAndy Whitcroft my $s = $1; 481613214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 481713214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4818000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4819000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 48200a920b5bSAndy Whitcroft } 482113214adfSAndy Whitcroft } 482239667782SAndy Whitcroft# if should not continue a brace 482339667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4824000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4825048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 482639667782SAndy Whitcroft $herecurr); 482739667782SAndy Whitcroft } 4828a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4829a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4830a1080bf8SAndy Whitcroft $line !~ /\G(?: 48313fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4832a1080bf8SAndy Whitcroft \s*return\s+ 4833a1080bf8SAndy Whitcroft )/xg) 4834a1080bf8SAndy Whitcroft { 4835000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4836000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4837a1080bf8SAndy Whitcroft } 48380a920b5bSAndy Whitcroft 48390a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 48400a920b5bSAndy Whitcroft # indent level to be relevant to each other. 48418b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 48420a920b5bSAndy Whitcroft $previndent == $indent) { 48438b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 48448b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 48458b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 48468b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48478b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 48488b8856f4SJoe Perches my $fixedline = $prevrawline; 48498b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 48508b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 48518b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48528b8856f4SJoe Perches } 48538b8856f4SJoe Perches $fixedline = $rawline; 48548b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 48558b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48568b8856f4SJoe Perches } 48570a920b5bSAndy Whitcroft } 48580a920b5bSAndy Whitcroft 48598b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4860c2fdda0dSAndy Whitcroft $previndent == $indent) { 4861c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4862c2fdda0dSAndy Whitcroft 4863c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4864c2fdda0dSAndy Whitcroft # conditional. 4865773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4866c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4867c2fdda0dSAndy Whitcroft 4868c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 48698b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 48708b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 48718b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 48728b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48738b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 48748b8856f4SJoe Perches my $fixedline = $prevrawline; 48758b8856f4SJoe Perches my $trailing = $rawline; 48768b8856f4SJoe Perches $trailing =~ s/^\+//; 48778b8856f4SJoe Perches $trailing = trim($trailing); 48788b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 48798b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48808b8856f4SJoe Perches } 4881c2fdda0dSAndy Whitcroft } 4882c2fdda0dSAndy Whitcroft } 4883c2fdda0dSAndy Whitcroft 488495e2c602SJoe Perches#Specific variable tests 4885323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4886323c1260SJoe Perches my $var = $1; 488795e2c602SJoe Perches 488895e2c602SJoe Perches#gcc binary extension 488995e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4890d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4891d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4892d5e616fcSJoe Perches $fix) { 4893d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4894194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4895d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4896d5e616fcSJoe Perches } 489795e2c602SJoe Perches } 489895e2c602SJoe Perches 489995e2c602SJoe Perches#CamelCase 4900807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4901be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 490222735ce8SJoe Perches#Ignore Page<foo> variants 4903807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 490422735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4905f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4906f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4907f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 49087e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 49097e781f67SJoe Perches my $word = $1; 49107e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4911d8b07710SJoe Perches if ($check) { 4912d8b07710SJoe Perches seed_camelcase_includes(); 4913d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4914d8b07710SJoe Perches seed_camelcase_file($realfile); 4915d8b07710SJoe Perches $camelcase_file_seeded = 1; 4916d8b07710SJoe Perches } 4917d8b07710SJoe Perches } 49187e781f67SJoe Perches if (!defined $camelcase{$word}) { 49197e781f67SJoe Perches $camelcase{$word} = 1; 4920be79794bSJoe Perches CHK("CAMELCASE", 49217e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 49227e781f67SJoe Perches } 4923323c1260SJoe Perches } 4924323c1260SJoe Perches } 49253445686aSJoe Perches } 49260a920b5bSAndy Whitcroft 49270a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4928d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4929d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4930d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4931d5e616fcSJoe Perches $fix) { 4932194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4933d5e616fcSJoe Perches } 49340a920b5bSAndy Whitcroft } 49350a920b5bSAndy Whitcroft 49360e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 49370e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4938c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4939e09dec48SAndy Whitcroft my $file = "$1.h"; 4940e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4941e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4942e09dec48SAndy Whitcroft $realfile ne $checkfile && 49437840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4944c45dcabdSAndy Whitcroft { 49450e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 49460e212e0aSFabian Frederick if ($asminclude > 0) { 4947e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4948000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4949000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4950e09dec48SAndy Whitcroft } else { 4951000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4952000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4953e09dec48SAndy Whitcroft } 49540a920b5bSAndy Whitcroft } 49550a920b5bSAndy Whitcroft } 49560e212e0aSFabian Frederick } 49570a920b5bSAndy Whitcroft 4958653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4959653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4960cf655043SAndy Whitcroft# in a known good container 4961b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4962b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4963d8aaf121SAndy Whitcroft my $ln = $linenr; 4964d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4965c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4966c45dcabdSAndy Whitcroft my $ctx = ''; 496708a2843eSJoe Perches my $has_flow_statement = 0; 496808a2843eSJoe Perches my $has_arg_concat = 0; 4969c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4970f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4971f74bd194SAndy Whitcroft $ctx = $dstat; 4972c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4973a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4974c45dcabdSAndy Whitcroft 497508a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 497662e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 497708a2843eSJoe Perches 4978f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 4979f59b64bfSJoe Perches my $define_args = $1; 4980f59b64bfSJoe Perches my $define_stmt = $dstat; 4981f59b64bfSJoe Perches my @def_args = (); 4982f59b64bfSJoe Perches 4983f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 4984f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 4985f59b64bfSJoe Perches $define_args =~ s/\s*//g; 49868c8c45cfSJoe Perches $define_args =~ s/\\\+?//g; 4987f59b64bfSJoe Perches @def_args = split(",", $define_args); 4988f59b64bfSJoe Perches } 4989f59b64bfSJoe Perches 4990292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4991c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4992c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4993c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4994c45dcabdSAndy Whitcroft 4995c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4996bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4997bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 49986b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 4999bf30d6edSAndy Whitcroft { 5000c45dcabdSAndy Whitcroft } 5001c45dcabdSAndy Whitcroft 5002e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 500333acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 500433acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 5005e45bab8eSAndy Whitcroft { 5006e45bab8eSAndy Whitcroft } 5007e45bab8eSAndy Whitcroft 500842e15293SJoe Perches # Make asm volatile uses seem like a generic function 500942e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 501042e15293SJoe Perches 5011c45dcabdSAndy Whitcroft my $exceptions = qr{ 5012c45dcabdSAndy Whitcroft $Declare| 5013c45dcabdSAndy Whitcroft module_param_named| 5014a0a0a7a9SKees Cook MODULE_PARM_DESC| 5015c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 5016c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 5017383099fdSAndy Whitcroft __typeof__\(| 501822fd2d3eSStefani Seibold union| 501922fd2d3eSStefani Seibold struct| 5020ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 50216b10df42SVladimir Zapolskiy ^\"|\"$| 50226b10df42SVladimir Zapolskiy ^\[ 5023c45dcabdSAndy Whitcroft }x; 50245eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 5025f59b64bfSJoe Perches 5026f59b64bfSJoe Perches $ctx =~ s/\n*$//; 5027f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 5028e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 5029f59b64bfSJoe Perches 5030f74bd194SAndy Whitcroft if ($dstat ne '' && 5031f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 5032f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 50333cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 5034356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5035f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 5036f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5037e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 503872f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 5039f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5040f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5041f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 50424e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5043f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5044c45dcabdSAndy Whitcroft { 5045e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5046e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5047e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5048e795556aSJoe Perches } elsif ($dstat =~ /;/) { 5049f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5050f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5051f74bd194SAndy Whitcroft } else { 5052000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 5053388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5054d8aaf121SAndy Whitcroft } 5055f59b64bfSJoe Perches 5056f59b64bfSJoe Perches } 50575207649bSJoe Perches 50585207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 50595207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 50605207649bSJoe Perches my $first = 1; 50615207649bSJoe Perches $define_stmt = ""; 50625207649bSJoe Perches foreach my $l (@stmt_array) { 50635207649bSJoe Perches $l =~ s/\\$//; 50645207649bSJoe Perches if ($first) { 50655207649bSJoe Perches $define_stmt = $l; 50665207649bSJoe Perches $first = 0; 50675207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 50685207649bSJoe Perches $define_stmt .= substr($l, 1); 50695207649bSJoe Perches } 50705207649bSJoe Perches } 50715207649bSJoe Perches $define_stmt =~ s/$;//g; 50725207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 50735207649bSJoe Perches $define_stmt = trim($define_stmt); 50745207649bSJoe Perches 5075f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5076f59b64bfSJoe Perches foreach my $arg (@def_args) { 5077f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 50789192d41aSJoe Perches next if ($arg =~ /^type$/i); 50797fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 50807fe528a2SJoe Perches $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 50817fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 50827fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 5083d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 5084f59b64bfSJoe Perches if ($use_cnt > 1) { 5085f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5086f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5087f59b64bfSJoe Perches } 50889192d41aSJoe Perches# check if any macro arguments may have other precedence issues 50897fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 50909192d41aSJoe Perches ((defined($1) && $1 ne ',') || 50919192d41aSJoe Perches (defined($2) && $2 ne ','))) { 50929192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 50939192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 50949192d41aSJoe Perches } 50950a920b5bSAndy Whitcroft } 50965023d347SJoe Perches 509708a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 509808a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 509908a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 510008a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 5101e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 510208a2843eSJoe Perches 510308a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 510408a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 510508a2843eSJoe Perches } 510608a2843eSJoe Perches 5107481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 51085023d347SJoe Perches 51095023d347SJoe Perches } else { 51105023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5111481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5112481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 51135023d347SJoe Perches $line =~ /^\+.*\\$/) { 51145023d347SJoe Perches WARN("LINE_CONTINUATIONS", 51155023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 51165023d347SJoe Perches } 5117653d4876SAndy Whitcroft } 51180a920b5bSAndy Whitcroft 5119b13edf7fSJoe Perches# do {} while (0) macro tests: 5120b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5121b13edf7fSJoe Perches# macro should not end with a semicolon 51225b57980dSJoe Perches if ($perl_version_ok && 5123b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5124b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5125b13edf7fSJoe Perches my $ln = $linenr; 5126b13edf7fSJoe Perches my $cnt = $realcnt; 5127b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5128b13edf7fSJoe Perches my $ctx = ''; 5129b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5130b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5131b13edf7fSJoe Perches $ctx = $dstat; 5132b13edf7fSJoe Perches 5133b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 51341b36b201SJoe Perches $dstat =~ s/$;/ /g; 5135b13edf7fSJoe Perches 5136b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5137b13edf7fSJoe Perches my $stmts = $2; 5138b13edf7fSJoe Perches my $semis = $3; 5139b13edf7fSJoe Perches 5140b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5141b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5142e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5143b13edf7fSJoe Perches 5144ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5145ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5146b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5147b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5148b13edf7fSJoe Perches } 5149b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5150b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5151b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5152b13edf7fSJoe Perches } 5153f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5154f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5155f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5156e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5157f5ef95b1SJoe Perches 5158f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5159f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5160b13edf7fSJoe Perches } 5161b13edf7fSJoe Perches } 5162b13edf7fSJoe Perches 5163f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 516413214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 516513214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5166cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 516713214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5168cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5169cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5170aad4f614SJoe Perches my @allowed = (); 5171aad4f614SJoe Perches my $allow = 0; 517213214adfSAndy Whitcroft my $seen = 0; 5173773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5174cf655043SAndy Whitcroft my $ln = $linenr - 1; 517513214adfSAndy Whitcroft for my $chunk (@chunks) { 517613214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 517713214adfSAndy Whitcroft 5178773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5179773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5180773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 5181773647a0SAndy Whitcroft 5182aad4f614SJoe Perches $allowed[$allow] = 0; 5183773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5184773647a0SAndy Whitcroft 5185773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 5186773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 5187773647a0SAndy Whitcroft 5188773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5189cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 5190cf655043SAndy Whitcroft 5191773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 519213214adfSAndy Whitcroft 519313214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 519413214adfSAndy Whitcroft 5195aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5196cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5197cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5198aad4f614SJoe Perches $allowed[$allow] = 1; 519913214adfSAndy Whitcroft } 520013214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5201cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5202aad4f614SJoe Perches $allowed[$allow] = 1; 520313214adfSAndy Whitcroft } 5204cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5205cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5206aad4f614SJoe Perches $allowed[$allow] = 1; 520713214adfSAndy Whitcroft } 5208aad4f614SJoe Perches $allow++; 520913214adfSAndy Whitcroft } 5210aad4f614SJoe Perches if ($seen) { 5211aad4f614SJoe Perches my $sum_allowed = 0; 5212aad4f614SJoe Perches foreach (@allowed) { 5213aad4f614SJoe Perches $sum_allowed += $_; 5214aad4f614SJoe Perches } 5215aad4f614SJoe Perches if ($sum_allowed == 0) { 5216000d1cc1SJoe Perches WARN("BRACES", 5217000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 5218aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 5219aad4f614SJoe Perches $seen != $allow) { 5220aad4f614SJoe Perches CHK("BRACES", 5221aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 5222aad4f614SJoe Perches } 522313214adfSAndy Whitcroft } 522413214adfSAndy Whitcroft } 522513214adfSAndy Whitcroft } 5226773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 522713214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 5228cf655043SAndy Whitcroft my $allowed = 0; 5229f0a594c1SAndy Whitcroft 5230cf655043SAndy Whitcroft # Check the pre-context. 5231cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 5232cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 5233cf655043SAndy Whitcroft $allowed = 1; 5234f0a594c1SAndy Whitcroft } 5235773647a0SAndy Whitcroft 5236773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 5237773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 5238773647a0SAndy Whitcroft 5239cf655043SAndy Whitcroft # Check the condition. 5240cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 5241773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 5242cf655043SAndy Whitcroft if (defined $cond) { 5243773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5244cf655043SAndy Whitcroft } 5245cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5246cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5247cf655043SAndy Whitcroft $allowed = 1; 5248cf655043SAndy Whitcroft } 5249cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5250cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5251cf655043SAndy Whitcroft $allowed = 1; 5252cf655043SAndy Whitcroft } 5253cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5254cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5255cf655043SAndy Whitcroft $allowed = 1; 5256cf655043SAndy Whitcroft } 5257cf655043SAndy Whitcroft # Check the post-context. 5258cf655043SAndy Whitcroft if (defined $chunks[1]) { 5259cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 5260cf655043SAndy Whitcroft if (defined $cond) { 5261773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5262cf655043SAndy Whitcroft } 5263cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 5264cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5265cf655043SAndy Whitcroft $allowed = 1; 5266cf655043SAndy Whitcroft } 5267cf655043SAndy Whitcroft } 5268cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 5269f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 5270e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5271cf655043SAndy Whitcroft 5272000d1cc1SJoe Perches WARN("BRACES", 5273000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 5274f0a594c1SAndy Whitcroft } 5275f0a594c1SAndy Whitcroft } 5276f0a594c1SAndy Whitcroft 5277e4c5babdSJoe Perches# check for single line unbalanced braces 527895330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 527995330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 5280e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 5281e4c5babdSJoe Perches } 5282e4c5babdSJoe Perches 52830979ae66SJoe Perches# check for unnecessary blank lines around braces 528477b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5285f8e58219SJoe Perches if (CHK("BRACES", 5286f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5287f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 5288f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5289f8e58219SJoe Perches } 52900979ae66SJoe Perches } 529177b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5292f8e58219SJoe Perches if (CHK("BRACES", 5293f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5294f8e58219SJoe Perches $fix) { 5295f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 5296f8e58219SJoe Perches } 52970979ae66SJoe Perches } 52980979ae66SJoe Perches 52994a0df2efSAndy Whitcroft# no volatiles please 53006c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 53016c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5302000d1cc1SJoe Perches WARN("VOLATILE", 53038c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 53044a0df2efSAndy Whitcroft } 53054a0df2efSAndy Whitcroft 53065e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 53075e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 53085e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 53095e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 531033acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 53115e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 53125e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 53135e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 53145e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 53155e4f6ba5SJoe Perches $fix && 53165e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 53175e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 53185e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 53195e4f6ba5SJoe Perches my $comma_close = ""; 53205e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 53215e4f6ba5SJoe Perches $comma_close = $1; 53225e4f6ba5SJoe Perches } 53235e4f6ba5SJoe Perches 53245e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 53255e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 53265e4f6ba5SJoe Perches my $fixedline = $prevrawline; 53275e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 53285e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 53295e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 53305e4f6ba5SJoe Perches $fixedline = $rawline; 53315e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 53325e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 53335e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 53345e4f6ba5SJoe Perches } 53355e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 53365e4f6ba5SJoe Perches } 53375e4f6ba5SJoe Perches } 53385e4f6ba5SJoe Perches 53395e4f6ba5SJoe Perches# check for missing a space in a string concatenation 53405e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 53415e4f6ba5SJoe Perches WARN('MISSING_SPACE', 53425e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 53435e4f6ba5SJoe Perches } 53445e4f6ba5SJoe Perches 534577cb8546SJoe Perches# check for an embedded function name in a string when the function is known 5346e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 5347e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 5348e4b7d309SJoe Perches# function declarations 534977cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 535077cb8546SJoe Perches defined($context_function) && 5351e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 5352e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 535377cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 5354e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 535577cb8546SJoe Perches } 535677cb8546SJoe Perches 53575e4f6ba5SJoe Perches# check for spaces before a quoted newline 53585e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 53595e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 53605e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 53615e4f6ba5SJoe Perches $fix) { 53625e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 53635e4f6ba5SJoe Perches } 53645e4f6ba5SJoe Perches 53655e4f6ba5SJoe Perches } 53665e4f6ba5SJoe Perches 5367f17dba4fSJoe Perches# concatenated string without spaces between elements 536879682c0cSJoe Perches if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) { 536979682c0cSJoe Perches if (CHK("CONCATENATED_STRING", 537079682c0cSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr) && 537179682c0cSJoe Perches $fix) { 537279682c0cSJoe Perches while ($line =~ /($String)/g) { 537379682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 537479682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/; 537579682c0cSJoe Perches $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/; 537679682c0cSJoe Perches } 537779682c0cSJoe Perches } 5378f17dba4fSJoe Perches } 5379f17dba4fSJoe Perches 538090ad30e5SJoe Perches# uncoalesced string fragments 538133acb54aSJoe Perches if ($line =~ /$String\s*"/) { 538279682c0cSJoe Perches if (WARN("STRING_FRAGMENTS", 538379682c0cSJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr) && 538479682c0cSJoe Perches $fix) { 538579682c0cSJoe Perches while ($line =~ /($String)(?=\s*")/g) { 538679682c0cSJoe Perches my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 538779682c0cSJoe Perches $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e; 538879682c0cSJoe Perches } 538979682c0cSJoe Perches } 539090ad30e5SJoe Perches } 539190ad30e5SJoe Perches 5392522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 5393522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 5394522b837cSAlexey Dobriyan my $show_Z = 1; 53955e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 5396522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 53975e4f6ba5SJoe Perches $string =~ s/%%/__/g; 5398522b837cSAlexey Dobriyan # check for %L 5399522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 54005e4f6ba5SJoe Perches WARN("PRINTF_L", 5401522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 5402522b837cSAlexey Dobriyan $show_L = 0; 54035e4f6ba5SJoe Perches } 5404522b837cSAlexey Dobriyan # check for %Z 5405522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 5406522b837cSAlexey Dobriyan WARN("PRINTF_Z", 5407522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 5408522b837cSAlexey Dobriyan $show_Z = 0; 5409522b837cSAlexey Dobriyan } 5410522b837cSAlexey Dobriyan # check for 0x<decimal> 5411522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 5412522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 54136e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 54146e300757SJoe Perches } 54155e4f6ba5SJoe Perches } 54165e4f6ba5SJoe Perches 54175e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 54183f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 54195e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 54205e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 54215e4f6ba5SJoe Perches } 54225e4f6ba5SJoe Perches 542300df344fSAndy Whitcroft# warn about #if 0 5424c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 5425000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 5426000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 5427de7d4f0eSAndy Whitcroft $herecurr); 54284a0df2efSAndy Whitcroft } 54294a0df2efSAndy Whitcroft 543003df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 543103df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5432100425deSJoe Perches my $tested = quotemeta($1); 5433100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5434100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5435100425deSJoe Perches my $func = $1; 5436100425deSJoe Perches if (WARN('NEEDLESS_IF', 5437100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5438100425deSJoe Perches $fix) { 5439100425deSJoe Perches my $do_fix = 1; 5440100425deSJoe Perches my $leading_tabs = ""; 5441100425deSJoe Perches my $new_leading_tabs = ""; 5442100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5443100425deSJoe Perches $leading_tabs = $1; 5444100425deSJoe Perches } else { 5445100425deSJoe Perches $do_fix = 0; 5446100425deSJoe Perches } 5447100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5448100425deSJoe Perches $new_leading_tabs = $1; 5449100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5450100425deSJoe Perches $do_fix = 0; 5451100425deSJoe Perches } 5452100425deSJoe Perches } else { 5453100425deSJoe Perches $do_fix = 0; 5454100425deSJoe Perches } 5455100425deSJoe Perches if ($do_fix) { 5456100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5457100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5458100425deSJoe Perches } 5459100425deSJoe Perches } 54604c432a8fSGreg Kroah-Hartman } 54614c432a8fSGreg Kroah-Hartman } 5462f0a594c1SAndy Whitcroft 5463ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5464ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5465ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5466ebfdc409SJoe Perches (defined $1 || defined $3) && 5467ebfdc409SJoe Perches $linenr > 3) { 5468ebfdc409SJoe Perches my $testval = $2; 5469ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5470ebfdc409SJoe Perches 5471ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5472ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5473ebfdc409SJoe Perches 5474fb0d0e08SJoe Perches if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|kmemdup|(?:dev_)?alloc_skb)/) { 5475ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5476ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5477ebfdc409SJoe Perches } 5478ebfdc409SJoe Perches } 5479ebfdc409SJoe Perches 5480f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5481dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5482f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5483f78d98f6SJoe Perches my $level = $1; 5484f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5485f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5486f78d98f6SJoe Perches $fix) { 5487f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5488f78d98f6SJoe Perches } 5489f78d98f6SJoe Perches } 5490f78d98f6SJoe Perches 549145c55e92SJoe Perches# check for logging continuations 549245c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 549345c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 549445c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 549545c55e92SJoe Perches } 549645c55e92SJoe Perches 5497abb08a53SJoe Perches# check for mask then right shift without a parentheses 54985b57980dSJoe Perches if ($perl_version_ok && 5499abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5500abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5501abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5502abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5503abb08a53SJoe Perches } 5504abb08a53SJoe Perches 5505b75ac618SJoe Perches# check for pointer comparisons to NULL 55065b57980dSJoe Perches if ($perl_version_ok) { 5507b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5508b75ac618SJoe Perches my $val = $1; 5509b75ac618SJoe Perches my $equal = "!"; 5510b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5511b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5512b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5513b75ac618SJoe Perches $fix) { 5514b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5515b75ac618SJoe Perches } 5516b75ac618SJoe Perches } 5517b75ac618SJoe Perches } 5518b75ac618SJoe Perches 55198716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 55208716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 55218716de38SJoe Perches my $attr = $1; 55228716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 55238716de38SJoe Perches my $ptr = $1; 55248716de38SJoe Perches my $var = $2; 55258716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 55268716de38SJoe Perches ERROR("MISPLACED_INIT", 55278716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 55288716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 55298716de38SJoe Perches WARN("MISPLACED_INIT", 55308716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 55318716de38SJoe Perches $fix) { 5532194f66fcSJoe 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; 55338716de38SJoe Perches } 55348716de38SJoe Perches } 55358716de38SJoe Perches } 55368716de38SJoe Perches 5537e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5538e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5539e970b884SJoe Perches my $attr = $1; 5540e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5541e970b884SJoe Perches my $attr_prefix = $1; 5542e970b884SJoe Perches my $attr_type = $2; 5543e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5544e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5545e970b884SJoe Perches $fix) { 5546194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5547e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5548e970b884SJoe Perches } 5549e970b884SJoe Perches } 5550e970b884SJoe Perches 5551e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5552e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5553e970b884SJoe Perches my $attr = $1; 5554e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5555e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5556e970b884SJoe Perches $fix) { 5557194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5558e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5559e970b884SJoe Perches $lead = rtrim($1); 5560e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5561e970b884SJoe Perches $lead = "${lead}const "; 5562194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5563e970b884SJoe Perches } 5564e970b884SJoe Perches } 5565e970b884SJoe Perches 5566c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5567c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5568c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5569c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5570c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5571c17893c7SJoe Perches $fix) { 5572c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5573c17893c7SJoe Perches } 5574c17893c7SJoe Perches } 5575c17893c7SJoe Perches 5576fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5577fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5578fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5579fbdb8138SJoe Perches my $constant_func = $1; 5580fbdb8138SJoe Perches my $func = $constant_func; 5581fbdb8138SJoe Perches $func =~ s/^__constant_//; 5582fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5583fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5584fbdb8138SJoe Perches $fix) { 5585194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5586fbdb8138SJoe Perches } 5587fbdb8138SJoe Perches } 5588fbdb8138SJoe Perches 55891a15a250SPatrick Pannuto# prefer usleep_range over udelay 559037581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 559143c1d77cSJoe Perches my $delay = $1; 55921a15a250SPatrick Pannuto # ignore udelay's < 10, however 559343c1d77cSJoe Perches if (! ($delay < 10) ) { 5594000d1cc1SJoe Perches CHK("USLEEP_RANGE", 559543c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 559643c1d77cSJoe Perches } 559743c1d77cSJoe Perches if ($delay > 2000) { 559843c1d77cSJoe Perches WARN("LONG_UDELAY", 559943c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 56001a15a250SPatrick Pannuto } 56011a15a250SPatrick Pannuto } 56021a15a250SPatrick Pannuto 560309ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 560409ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 560509ef8725SPatrick Pannuto if ($1 < 20) { 5606000d1cc1SJoe Perches WARN("MSLEEP", 560743c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 560809ef8725SPatrick Pannuto } 560909ef8725SPatrick Pannuto } 561009ef8725SPatrick Pannuto 561136ec1939SJoe Perches# check for comparisons of jiffies 561236ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 561336ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 561436ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 561536ec1939SJoe Perches } 561636ec1939SJoe Perches 56179d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 56189d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 56199d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 56209d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 56219d7a34a5SJoe Perches } 56229d7a34a5SJoe Perches 562300df344fSAndy Whitcroft# warn about #ifdefs in C files 5624c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 562500df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 562600df344fSAndy Whitcroft# print "$herecurr"; 562700df344fSAndy Whitcroft# $clean = 0; 562800df344fSAndy Whitcroft# } 562900df344fSAndy Whitcroft 563022f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5631c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 56323705ce5bSJoe Perches if (ERROR("SPACING", 56333705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 56343705ce5bSJoe Perches $fix) { 5635194f66fcSJoe Perches $fixed[$fixlinenr] =~ 56363705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 56373705ce5bSJoe Perches } 56383705ce5bSJoe Perches 563922f2a2efSAndy Whitcroft } 564022f2a2efSAndy Whitcroft 56414a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5642171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5643171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 56444a0df2efSAndy Whitcroft my $which = $1; 56454a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5646000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5647000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 56484a0df2efSAndy Whitcroft } 56494a0df2efSAndy Whitcroft } 56504a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5651402c2553SMichael S. Tsirkin 5652402c2553SMichael S. Tsirkin my $barriers = qr{ 5653402c2553SMichael S. Tsirkin mb| 5654402c2553SMichael S. Tsirkin rmb| 5655402c2553SMichael S. Tsirkin wmb| 5656402c2553SMichael S. Tsirkin read_barrier_depends 5657402c2553SMichael S. Tsirkin }x; 5658402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5659402c2553SMichael S. Tsirkin mb__before_atomic| 5660402c2553SMichael S. Tsirkin mb__after_atomic| 5661402c2553SMichael S. Tsirkin store_release| 5662402c2553SMichael S. Tsirkin load_acquire| 5663402c2553SMichael S. Tsirkin store_mb| 5664402c2553SMichael S. Tsirkin (?:$barriers) 5665402c2553SMichael S. Tsirkin }x; 5666402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5667402c2553SMichael S. Tsirkin (?:$barriers)| 566843e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 566943e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5670402c2553SMichael S. Tsirkin }x; 5671402c2553SMichael S. Tsirkin 5672402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 56734a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5674c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5675000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 56764a0df2efSAndy Whitcroft } 56774a0df2efSAndy Whitcroft } 56783ad81779SPaul E. McKenney 5679f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5680f4073b0fSMichael S. Tsirkin 5681f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5682f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5683f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5684f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5685f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5686f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5687f4073b0fSMichael S. Tsirkin } 5688f4073b0fSMichael S. Tsirkin 5689cb426e99SJoe Perches# check for waitqueue_active without a comment. 5690cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5691cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5692cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5693cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5694cb426e99SJoe Perches } 5695cb426e99SJoe Perches } 56963ad81779SPaul E. McKenney 569791db2592SPaul E. McKenney# check for smp_read_barrier_depends and read_barrier_depends 569891db2592SPaul E. McKenney if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) { 569991db2592SPaul E. McKenney WARN("READ_BARRIER_DEPENDS", 570091db2592SPaul E. McKenney "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr); 570191db2592SPaul E. McKenney } 570291db2592SPaul E. McKenney 57034a0df2efSAndy Whitcroft# check of hardware specific defines 5704c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5705000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5706000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 57070a920b5bSAndy Whitcroft } 5708653d4876SAndy Whitcroft 5709596ed45bSJoe Perches# check that the storage class is not after a type 5710596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 5711000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5712596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 5713596ed45bSJoe Perches } 5714596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 5715596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 5716596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 5717596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 5718596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 5719596ed45bSJoe Perches WARN("STORAGE_CLASS", 5720596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 5721d4977c78STobias Klauser } 5722d4977c78STobias Klauser 5723de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5724de7d4f0eSAndy Whitcroft# storage class and type. 57259c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 57269c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5727000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5728000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5729de7d4f0eSAndy Whitcroft } 5730de7d4f0eSAndy Whitcroft 57318905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 57322b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57332b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5734d5e616fcSJoe Perches if (WARN("INLINE", 5735d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5736d5e616fcSJoe Perches $fix) { 5737194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5738d5e616fcSJoe Perches 5739d5e616fcSJoe Perches } 57408905a67cSAndy Whitcroft } 57418905a67cSAndy Whitcroft 57423d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 57432b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57442b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5745000d1cc1SJoe Perches WARN("PREFER_PACKED", 5746000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 57473d130fd0SJoe Perches } 57483d130fd0SJoe Perches 574939b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 57502b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57512b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5752000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5753000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 575439b7e287SJoe Perches } 575539b7e287SJoe Perches 57565f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 57572b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57582b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5759d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5760d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5761d5e616fcSJoe Perches $fix) { 5762194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5763d5e616fcSJoe Perches 5764d5e616fcSJoe Perches } 57655f14d3bdSJoe Perches } 57665f14d3bdSJoe Perches 57676061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 57682b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57692b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5770d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5771d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5772d5e616fcSJoe Perches $fix) { 5773194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5774d5e616fcSJoe Perches } 57756061d949SJoe Perches } 57766061d949SJoe Perches 5777619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 57785b57980dSJoe Perches if ($perl_version_ok && 5779619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5780619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5781619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5782619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5783619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5784619a908aSJoe Perches } 5785619a908aSJoe Perches 5786fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 5787e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5788fd39f904STomas Winkler $realfile !~ m@\btools/@ && 5789e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5790e6176fa4SJoe Perches my $type = $1; 5791e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5792e6176fa4SJoe Perches $type = $1; 5793e6176fa4SJoe Perches my $kernel_type = 'u'; 5794e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5795e6176fa4SJoe Perches $type =~ /(\d+)/; 5796e6176fa4SJoe Perches $kernel_type .= $1; 5797e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5798e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5799e6176fa4SJoe Perches $fix) { 5800e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5801e6176fa4SJoe Perches } 5802e6176fa4SJoe Perches } 5803e6176fa4SJoe Perches } 5804e6176fa4SJoe Perches 5805938224b5SJoe Perches# check for cast of C90 native int or longer types constants 5806938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 5807938224b5SJoe Perches my $cast = $1; 5808938224b5SJoe Perches my $const = $2; 5809938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 5810938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 5811938224b5SJoe Perches $fix) { 5812938224b5SJoe Perches my $suffix = ""; 5813938224b5SJoe Perches my $newconst = $const; 5814938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 5815938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 5816938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 5817938224b5SJoe Perches $suffix .= 'LL'; 5818938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 5819938224b5SJoe Perches $suffix .= 'L'; 5820938224b5SJoe Perches } 5821938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 5822938224b5SJoe Perches } 5823938224b5SJoe Perches } 5824938224b5SJoe Perches 58258f53a9b8SJoe Perches# check for sizeof(&) 58268f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5827000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5828000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 58298f53a9b8SJoe Perches } 58308f53a9b8SJoe Perches 583166c80b60SJoe Perches# check for sizeof without parenthesis 583266c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5833d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5834d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5835d5e616fcSJoe Perches $fix) { 5836194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5837d5e616fcSJoe Perches } 583866c80b60SJoe Perches } 583966c80b60SJoe Perches 584088982feaSJoe Perches# check for struct spinlock declarations 584188982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 584288982feaSJoe Perches WARN("USE_SPINLOCK_T", 584388982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 584488982feaSJoe Perches } 584588982feaSJoe Perches 5846a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 584706668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5848a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5849caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5850caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5851d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5852d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5853d5e616fcSJoe Perches $fix) { 5854194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5855d5e616fcSJoe Perches } 5856a6962d72SJoe Perches } 5857a6962d72SJoe Perches } 5858a6962d72SJoe Perches 58590b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 58605b57980dSJoe Perches if ($perl_version_ok && 58610b523769SJoe Perches defined $stat && 58620b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 58630b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 5864e3c6bc95STobin C. Harding my $stat_real; 5865e3c6bc95STobin C. Harding 58660b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 58670b523769SJoe Perches $lc = $lc + $linenr; 58680b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 5869ffe07513SJoe Perches my $specifier; 5870ffe07513SJoe Perches my $extension; 5871ffe07513SJoe Perches my $bad_specifier = ""; 58720b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 58730b523769SJoe Perches $fmt =~ s/%%//g; 5874e3c6bc95STobin C. Harding 5875e3c6bc95STobin C. Harding while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) { 5876e3c6bc95STobin C. Harding $specifier = $1; 5877e3c6bc95STobin C. Harding $extension = $2; 5878e3c6bc95STobin C. Harding if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOx]/) { 5879e3c6bc95STobin C. Harding $bad_specifier = $specifier; 58800b523769SJoe Perches last; 58810b523769SJoe Perches } 5882e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 5883e3c6bc95STobin C. Harding if (!defined($stat_real)) { 5884e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 58850b523769SJoe Perches } 5886e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 5887e3c6bc95STobin 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"); 5888e3c6bc95STobin C. Harding } 5889e3c6bc95STobin C. Harding } 5890e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 58912a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 58921df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 58931df7338aSSergey Senozhatsky my $use = ""; 5894e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 58951df7338aSSergey Senozhatsky $ext_type = "Deprecated"; 58961df7338aSSergey Senozhatsky $use = " - use %pS instead"; 5897e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 58981df7338aSSergey Senozhatsky } 58992a9f9d85STobin C. Harding 59000b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 5901e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 5902e3c6bc95STobin C. Harding } 59030b523769SJoe Perches } 59040b523769SJoe Perches } 59050b523769SJoe Perches 5906554e165cSAndy Whitcroft# Check for misused memsets 59075b57980dSJoe Perches if ($perl_version_ok && 5908d1fe9c09SJoe Perches defined $stat && 59099e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5910554e165cSAndy Whitcroft 5911d7c76ba7SJoe Perches my $ms_addr = $2; 5912d1fe9c09SJoe Perches my $ms_val = $7; 5913d1fe9c09SJoe Perches my $ms_size = $12; 5914d7c76ba7SJoe Perches 5915554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5916554e165cSAndy Whitcroft ERROR("MEMSET", 5917d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5918554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5919554e165cSAndy Whitcroft WARN("MEMSET", 5920d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5921d7c76ba7SJoe Perches } 5922d7c76ba7SJoe Perches } 5923d7c76ba7SJoe Perches 592498a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 59255b57980dSJoe Perches# if ($perl_version_ok && 5926f333195dSJoe Perches# defined $stat && 5927f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5928f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 5929f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 5930f333195dSJoe Perches# $fix) { 5931f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 5932f333195dSJoe Perches# } 5933f333195dSJoe Perches# } 593498a9bba5SJoe Perches 5935b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 59365b57980dSJoe Perches# if ($perl_version_ok && 5937f333195dSJoe Perches# defined $stat && 5938f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5939f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 5940f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5941f333195dSJoe Perches# } 5942b6117d17SMateusz Kulikowski 59438617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 59448617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 59455b57980dSJoe Perches# if ($perl_version_ok && 5946f333195dSJoe Perches# defined $stat && 5947f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5948f333195dSJoe Perches# 5949f333195dSJoe Perches# my $ms_val = $7; 5950f333195dSJoe Perches# 5951f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 5952f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 5953f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 5954f333195dSJoe Perches# $fix) { 5955f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 5956f333195dSJoe Perches# } 5957f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 5958f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 5959f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 5960f333195dSJoe Perches# $fix) { 5961f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 5962f333195dSJoe Perches# } 5963f333195dSJoe Perches# } 5964f333195dSJoe Perches# } 59658617cd09SMateusz Kulikowski 5966d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 59675b57980dSJoe Perches if ($perl_version_ok && 5968d1fe9c09SJoe Perches defined $stat && 5969d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5970d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5971d7c76ba7SJoe Perches my $call = $1; 5972d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5973d7c76ba7SJoe Perches my $arg1 = $3; 5974d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5975d1fe9c09SJoe Perches my $arg2 = $8; 5976d7c76ba7SJoe Perches my $cast; 5977d7c76ba7SJoe Perches 5978d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5979d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5980d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5981d7c76ba7SJoe Perches $cast = $cast1; 5982d7c76ba7SJoe Perches } else { 5983d7c76ba7SJoe Perches $cast = $cast2; 5984d7c76ba7SJoe Perches } 5985d7c76ba7SJoe Perches WARN("MINMAX", 5986d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5987554e165cSAndy Whitcroft } 5988554e165cSAndy Whitcroft } 5989554e165cSAndy Whitcroft 59904a273195SJoe Perches# check usleep_range arguments 59915b57980dSJoe Perches if ($perl_version_ok && 59924a273195SJoe Perches defined $stat && 59934a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 59944a273195SJoe Perches my $min = $1; 59954a273195SJoe Perches my $max = $7; 59964a273195SJoe Perches if ($min eq $max) { 59974a273195SJoe Perches WARN("USLEEP_RANGE", 59984a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 59994a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 60004a273195SJoe Perches $min > $max) { 60014a273195SJoe Perches WARN("USLEEP_RANGE", 60024a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 60034a273195SJoe Perches } 60044a273195SJoe Perches } 60054a273195SJoe Perches 6006823b794cSJoe Perches# check for naked sscanf 60075b57980dSJoe Perches if ($perl_version_ok && 6008823b794cSJoe Perches defined $stat && 60096c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 6010823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 6011823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 6012823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 6013823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 6014823b794cSJoe Perches $lc = $lc + $linenr; 60152a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6016823b794cSJoe Perches WARN("NAKED_SSCANF", 6017823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 6018823b794cSJoe Perches } 6019823b794cSJoe Perches 6020afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 60215b57980dSJoe Perches if ($perl_version_ok && 6022afc819abSJoe Perches defined $stat && 6023afc819abSJoe Perches $line =~ /\bsscanf\b/) { 6024afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 6025afc819abSJoe Perches $lc = $lc + $linenr; 60262a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6027afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 6028afc819abSJoe Perches my $format = $6; 6029afc819abSJoe Perches my $count = $format =~ tr@%@%@; 6030afc819abSJoe Perches if ($count == 1 && 6031afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 6032afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 6033afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 6034afc819abSJoe Perches } 6035afc819abSJoe Perches } 6036afc819abSJoe Perches } 6037afc819abSJoe Perches 603870dc8a48SJoe Perches# check for new externs in .h files. 603970dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 604070dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 6041d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 604270dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 604370dc8a48SJoe Perches $fix) { 6044194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 604570dc8a48SJoe Perches } 604670dc8a48SJoe Perches } 604770dc8a48SJoe Perches 6048de7d4f0eSAndy Whitcroft# check for new externs in .c files. 6049171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 6050c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 6051171ae1a4SAndy Whitcroft { 6052c45dcabdSAndy Whitcroft my $function_name = $1; 6053c45dcabdSAndy Whitcroft my $paren_space = $2; 6054171ae1a4SAndy Whitcroft 6055171ae1a4SAndy Whitcroft my $s = $stat; 6056171ae1a4SAndy Whitcroft if (defined $cond) { 6057171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 6058171ae1a4SAndy Whitcroft } 6059c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 6060c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 6061c45dcabdSAndy Whitcroft { 6062000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6063000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6064de7d4f0eSAndy Whitcroft } 6065de7d4f0eSAndy Whitcroft 6066171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 6067000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 6068000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 6069171ae1a4SAndy Whitcroft } 60709c9ba34eSAndy Whitcroft 60719c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 60729c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 60739c9ba34eSAndy Whitcroft { 6074000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6075000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6076171ae1a4SAndy Whitcroft } 6077171ae1a4SAndy Whitcroft 6078a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 6079a0ad7596SJoe Perches if (defined $stat && 608025bdda2bSMiles Chen $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 6081ca0d8929SJoe Perches $1 ne "void") { 6082ca0d8929SJoe Perches my $args = trim($1); 6083ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6084ca0d8929SJoe Perches my $arg = trim($1); 6085ca0d8929SJoe Perches if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 6086ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 6087ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6088ca0d8929SJoe Perches } 6089ca0d8929SJoe Perches } 6090ca0d8929SJoe Perches } 6091ca0d8929SJoe Perches 6092a0ad7596SJoe Perches# check for function definitions 60935b57980dSJoe Perches if ($perl_version_ok && 6094a0ad7596SJoe Perches defined $stat && 6095a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6096a0ad7596SJoe Perches $context_function = $1; 6097a0ad7596SJoe Perches 6098a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 6099a0ad7596SJoe Perches my $ok = 0; 6100a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 6101a0ad7596SJoe Perches my $herectx = $here . "\n"; 6102a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6103a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 6104a0ad7596SJoe Perches $herectx .= $rl . "\n"; 6105a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 6106a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 6107a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 6108a0ad7596SJoe Perches } 6109a0ad7596SJoe Perches if (!$ok) { 6110a0ad7596SJoe Perches ERROR("OPEN_BRACE", 6111a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 6112a0ad7596SJoe Perches } 6113a0ad7596SJoe Perches } 6114a0ad7596SJoe Perches 6115de7d4f0eSAndy Whitcroft# checks for new __setup's 6116de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 6117de7d4f0eSAndy Whitcroft my $name = $1; 6118de7d4f0eSAndy Whitcroft 6119de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 6120000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 61218c27ceffSMauro Carvalho Chehab "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr); 6122de7d4f0eSAndy Whitcroft } 6123653d4876SAndy Whitcroft } 61249c0ca6f9SAndy Whitcroft 61259c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 6126caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 6127000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 6128000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 61299c0ca6f9SAndy Whitcroft } 613013214adfSAndy Whitcroft 6131a640d25cSJoe Perches# alloc style 6132a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 61335b57980dSJoe Perches if ($perl_version_ok && 6134a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 6135a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 6136a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 6137a640d25cSJoe Perches } 6138a640d25cSJoe Perches 613960a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 61405b57980dSJoe Perches if ($perl_version_ok && 61411b4a2ed4SJoe Perches defined $stat && 61421b4a2ed4SJoe Perches $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 614360a55369SJoe Perches my $oldfunc = $3; 614460a55369SJoe Perches my $a1 = $4; 614560a55369SJoe Perches my $a2 = $10; 614660a55369SJoe Perches my $newfunc = "kmalloc_array"; 614760a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 614860a55369SJoe Perches my $r1 = $a1; 614960a55369SJoe Perches my $r2 = $a2; 615060a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 615160a55369SJoe Perches $r1 = $a2; 615260a55369SJoe Perches $r2 = $a1; 615360a55369SJoe Perches } 6154e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 6155e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 61561b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 6157e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6158e3d95a2aSTobin C. Harding 6159e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 61601b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 61611b4a2ed4SJoe Perches $cnt == 1 && 6162e367455aSJoe Perches $fix) { 6163194f66fcSJoe 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; 616460a55369SJoe Perches } 616560a55369SJoe Perches } 616660a55369SJoe Perches } 616760a55369SJoe Perches 6168972fdea2SJoe Perches# check for krealloc arg reuse 61695b57980dSJoe Perches if ($perl_version_ok && 6170*4cab63ceSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ && 6171*4cab63ceSJoe Perches $1 eq $3) { 6172972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 6173972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 6174972fdea2SJoe Perches } 6175972fdea2SJoe Perches 61765ce59ae0SJoe Perches# check for alloc argument mismatch 61775ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 61785ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 61795ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 61805ce59ae0SJoe Perches } 61815ce59ae0SJoe Perches 6182caf2a54fSJoe Perches# check for multiple semicolons 6183caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 6184d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 6185d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 6186d5e616fcSJoe Perches $fix) { 6187194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 6188d5e616fcSJoe Perches } 6189d1e2ad07SJoe Perches } 6190d1e2ad07SJoe Perches 6191cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 6192cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 6193cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 61940ab90191SJoe Perches my $ull = ""; 61950ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 61960ab90191SJoe Perches if (CHK("BIT_MACRO", 61970ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 61980ab90191SJoe Perches $fix) { 61990ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 62000ab90191SJoe Perches } 62010ab90191SJoe Perches } 62020ab90191SJoe Perches 62032d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 62042d632745SJoe 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*$/) { 62052d632745SJoe Perches my $config = $1; 62062d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 62072d632745SJoe Perches "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) && 62082d632745SJoe Perches $fix) { 62092d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 62102d632745SJoe Perches } 62112d632745SJoe Perches } 62122d632745SJoe Perches 6213e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 6214c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 6215c34c09a8SJoe Perches my $has_break = 0; 6216c34c09a8SJoe Perches my $has_statement = 0; 6217c34c09a8SJoe Perches my $count = 0; 6218c34c09a8SJoe Perches my $prevline = $linenr; 6219e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 6220c34c09a8SJoe Perches $prevline--; 6221c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 6222c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 6223c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 6224c34c09a8SJoe Perches next if ($fline =~ /^\-/); 6225c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 6226c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 6227c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 6228c34c09a8SJoe Perches $has_statement = 1; 6229c34c09a8SJoe Perches $count++; 6230258f79d5SHeinrich Schuchardt $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/); 6231c34c09a8SJoe Perches } 6232c34c09a8SJoe Perches if (!$has_break && $has_statement) { 6233c34c09a8SJoe Perches WARN("MISSING_BREAK", 6234224236d9SAndrew Morton "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr); 6235c34c09a8SJoe Perches } 6236c34c09a8SJoe Perches } 6237c34c09a8SJoe Perches 6238d1e2ad07SJoe Perches# check for switch/default statements without a break; 62395b57980dSJoe Perches if ($perl_version_ok && 6240d1e2ad07SJoe Perches defined $stat && 6241d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 6242d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 6243e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6244e3d95a2aSTobin C. Harding 6245d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 6246d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 6247caf2a54fSJoe Perches } 6248caf2a54fSJoe Perches 624913214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 6250d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 6251d5e616fcSJoe Perches if (WARN("USE_FUNC", 6252d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 6253d5e616fcSJoe Perches $fix) { 6254194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 6255d5e616fcSJoe Perches } 625613214adfSAndy Whitcroft } 6257773647a0SAndy Whitcroft 625862ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 625962ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 626062ec818fSJoe Perches ERROR("DATE_TIME", 626162ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 626262ec818fSJoe Perches } 626362ec818fSJoe Perches 62642c92488aSJoe Perches# check for use of yield() 62652c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 62662c92488aSJoe Perches WARN("YIELD", 62672c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 62682c92488aSJoe Perches } 62692c92488aSJoe Perches 6270179f8f40SJoe Perches# check for comparisons against true and false 6271179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 6272179f8f40SJoe Perches my $lead = $1; 6273179f8f40SJoe Perches my $arg = $2; 6274179f8f40SJoe Perches my $test = $3; 6275179f8f40SJoe Perches my $otype = $4; 6276179f8f40SJoe Perches my $trail = $5; 6277179f8f40SJoe Perches my $op = "!"; 6278179f8f40SJoe Perches 6279179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 6280179f8f40SJoe Perches 6281179f8f40SJoe Perches my $type = lc($otype); 6282179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 6283179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 6284179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 6285179f8f40SJoe Perches $op = ""; 6286179f8f40SJoe Perches } 6287179f8f40SJoe Perches 6288179f8f40SJoe Perches CHK("BOOL_COMPARISON", 6289179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 6290179f8f40SJoe Perches 6291179f8f40SJoe Perches## maybe suggesting a correct construct would better 6292179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 6293179f8f40SJoe Perches 6294179f8f40SJoe Perches } 6295179f8f40SJoe Perches } 6296179f8f40SJoe Perches 62975d430902SJoe Perches# check for bool bitfields 62985d430902SJoe Perches if ($sline =~ /^.\s+bool\s*$Ident\s*:\s*\d+\s*;/) { 62995d430902SJoe Perches WARN("BOOL_BITFIELD", 63005d430902SJoe Perches "Avoid using bool as bitfield. Prefer bool bitfields as unsigned int or u<8|16|32>\n" . $herecurr); 63015d430902SJoe Perches } 63025d430902SJoe Perches 6303d729593eSJoe Perches# check for bool use in .h files 6304d729593eSJoe Perches if ($realfile =~ /\.h$/ && 6305d729593eSJoe Perches $sline =~ /^.\s+bool\s*$Ident\s*(?::\s*d+\s*)?;/) { 6306d729593eSJoe Perches CHK("BOOL_MEMBER", 6307d729593eSJoe Perches "Avoid using bool structure members because of possible alignment issues - see: https://lkml.org/lkml/2017/11/21/384\n" . $herecurr); 6308d729593eSJoe Perches } 6309d729593eSJoe Perches 63104882720bSThomas Gleixner# check for semaphores initialized locked 63114882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 6312000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 6313000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 6314773647a0SAndy Whitcroft } 63156712d858SJoe Perches 631667d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 631767d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 6318000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 631967d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 6320773647a0SAndy Whitcroft } 63216712d858SJoe Perches 6322ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 6323f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 6324000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 6325ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 6326f3db6639SMichael Ellerman } 63276712d858SJoe Perches 63280f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 6329d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 63306903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 6331d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 6332000d1cc1SJoe Perches WARN("CONST_STRUCT", 6333d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 63342b6db5cbSAndy Whitcroft } 6335773647a0SAndy Whitcroft 6336773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 6337773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 6338773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 6339c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 6340c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 6341171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 6342171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 6343171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 6344773647a0SAndy Whitcroft { 6345000d1cc1SJoe Perches WARN("NR_CPUS", 6346000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 6347773647a0SAndy Whitcroft } 63489c9ba34eSAndy Whitcroft 634952ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 635052ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 635152ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 635252ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 635352ea8506SJoe Perches } 635452ea8506SJoe Perches 6355acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 63565b57980dSJoe Perches if ($perl_version_ok && 6357acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 6358acd9362cSJoe Perches WARN("LIKELY_MISUSE", 6359acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 6360acd9362cSJoe Perches } 6361acd9362cSJoe Perches 6362691d77b6SAndy Whitcroft# whine mightly about in_atomic 6363691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 6364691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 6365000d1cc1SJoe Perches ERROR("IN_ATOMIC", 6366000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 6367f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 6368000d1cc1SJoe Perches WARN("IN_ATOMIC", 6369000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 6370691d77b6SAndy Whitcroft } 6371691d77b6SAndy Whitcroft } 63721704f47bSPeter Zijlstra 63730f5225b0SPeter Zijlstra# check for mutex_trylock_recursive usage 63740f5225b0SPeter Zijlstra if ($line =~ /mutex_trylock_recursive/) { 63750f5225b0SPeter Zijlstra ERROR("LOCKING", 63760f5225b0SPeter Zijlstra "recursive locking is bad, do not use this ever.\n" . $herecurr); 63770f5225b0SPeter Zijlstra } 63780f5225b0SPeter Zijlstra 63791704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 63801704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 63811704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 63821704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 63831704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 63841704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 6385000d1cc1SJoe Perches ERROR("LOCKDEP", 6386000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 63871704f47bSPeter Zijlstra } 63881704f47bSPeter Zijlstra } 638988f8831cSDave Jones 6390b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 6391b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 6392000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 6393000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 639488f8831cSDave Jones } 63952435880fSJoe Perches 639600180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 639700180468SJoe Perches# and whether or not function naming is typical and if 639800180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 63995b57980dSJoe Perches if ($perl_version_ok && 640000180468SJoe Perches defined $stat && 640100180468SJoe 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*\)/) { 640200180468SJoe Perches my $var = $1; 640300180468SJoe Perches my $perms = $2; 640400180468SJoe Perches my $show = $3; 640500180468SJoe Perches my $store = $4; 640600180468SJoe Perches my $octal_perms = perms_to_octal($perms); 640700180468SJoe Perches if ($show =~ /^${var}_show$/ && 640800180468SJoe Perches $store =~ /^${var}_store$/ && 640900180468SJoe Perches $octal_perms eq "0644") { 641000180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 641100180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 641200180468SJoe Perches $fix) { 641300180468SJoe 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})/; 641400180468SJoe Perches } 641500180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 641600180468SJoe Perches $store =~ /^NULL$/ && 641700180468SJoe Perches $octal_perms eq "0444") { 641800180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 641900180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 642000180468SJoe Perches $fix) { 642100180468SJoe 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})/; 642200180468SJoe Perches } 642300180468SJoe Perches } elsif ($show =~ /^NULL$/ && 642400180468SJoe Perches $store =~ /^${var}_store$/ && 642500180468SJoe Perches $octal_perms eq "0200") { 642600180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 642700180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 642800180468SJoe Perches $fix) { 642900180468SJoe 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})/; 643000180468SJoe Perches } 643100180468SJoe Perches } elsif ($octal_perms eq "0644" || 643200180468SJoe Perches $octal_perms eq "0444" || 643300180468SJoe Perches $octal_perms eq "0200") { 643400180468SJoe Perches my $newshow = "$show"; 643500180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 643600180468SJoe Perches my $newstore = $store; 643700180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 643800180468SJoe Perches my $rename = ""; 643900180468SJoe Perches if ($show ne $newshow) { 644000180468SJoe Perches $rename .= " '$show' to '$newshow'"; 644100180468SJoe Perches } 644200180468SJoe Perches if ($store ne $newstore) { 644300180468SJoe Perches $rename .= " '$store' to '$newstore'"; 644400180468SJoe Perches } 644500180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 644600180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 644700180468SJoe Perches } else { 644800180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 644900180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 645000180468SJoe Perches } 645100180468SJoe Perches } 645200180468SJoe Perches 6453515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 6454515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 645573121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 645673121534SJoe Perches# specific definition of not visible in sysfs. 645773121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 645873121534SJoe Perches# use the default permissions 64595b57980dSJoe Perches if ($perl_version_ok && 6460459cf0aeSJoe Perches defined $stat && 6461515a235eSJoe Perches $line =~ /$mode_perms_search/) { 64622435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 64632435880fSJoe Perches my $func = $entry->[0]; 64642435880fSJoe Perches my $arg_pos = $entry->[1]; 64652435880fSJoe Perches 6466459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 6467459cf0aeSJoe Perches $lc = $lc + $linenr; 64682a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6469459cf0aeSJoe Perches 64702435880fSJoe Perches my $skip_args = ""; 64712435880fSJoe Perches if ($arg_pos > 1) { 64722435880fSJoe Perches $arg_pos--; 64732435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 64742435880fSJoe Perches } 6475f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 6476459cf0aeSJoe Perches if ($stat =~ /$test/) { 64772435880fSJoe Perches my $val = $1; 64782435880fSJoe Perches $val = $6 if ($skip_args ne ""); 647973121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 648073121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 648173121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 64822435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 6483459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 6484f90774e1SJoe Perches } 6485f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6486c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6487459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 64882435880fSJoe Perches } 6489459cf0aeSJoe Perches } 6490459cf0aeSJoe Perches } 6491459cf0aeSJoe Perches } 6492459cf0aeSJoe Perches 6493459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 6494bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 649500180468SJoe Perches my $oval = $1; 649600180468SJoe Perches my $octal = perms_to_octal($oval); 6497f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 6498459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 6499f90774e1SJoe Perches $fix) { 650000180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 65012435880fSJoe Perches } 650213214adfSAndy Whitcroft } 65035a6d20ceSBjorn Andersson 65045a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 65055a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 65065a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 65075a6d20ceSBjorn Andersson my $valid_licenses = qr{ 65085a6d20ceSBjorn Andersson GPL| 65095a6d20ceSBjorn Andersson GPL\ v2| 65105a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 65115a6d20ceSBjorn Andersson Dual\ BSD/GPL| 65125a6d20ceSBjorn Andersson Dual\ MIT/GPL| 65135a6d20ceSBjorn Andersson Dual\ MPL/GPL| 65145a6d20ceSBjorn Andersson Proprietary 65155a6d20ceSBjorn Andersson }x; 65165a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 65175a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 65185a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 65195a6d20ceSBjorn Andersson } 65205a6d20ceSBjorn Andersson } 6521515a235eSJoe Perches } 652213214adfSAndy Whitcroft 652313214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 652413214adfSAndy Whitcroft # so just keep quiet. 652513214adfSAndy Whitcroft if ($#rawlines == -1) { 652613214adfSAndy Whitcroft exit(0); 65270a920b5bSAndy Whitcroft } 65280a920b5bSAndy Whitcroft 65298905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 65308905a67cSAndy Whitcroft # things that appear to be patches. 65318905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 65328905a67cSAndy Whitcroft exit(0); 65338905a67cSAndy Whitcroft } 65348905a67cSAndy Whitcroft 65358905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 65368905a67cSAndy Whitcroft # just keep quiet. 65378905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 65388905a67cSAndy Whitcroft exit(0); 65398905a67cSAndy Whitcroft } 65408905a67cSAndy Whitcroft 6541a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 6542000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6543000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 65440a920b5bSAndy Whitcroft } 6545cd261496SGeert Uytterhoeven if ($is_patch && $has_commit_log && $chk_signoff) { 6546cd261496SGeert Uytterhoeven if ($signoff == 0) { 6547000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6548000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 6549cd261496SGeert Uytterhoeven } elsif (!$authorsignoff) { 6550cd261496SGeert Uytterhoeven WARN("NO_AUTHOR_SIGN_OFF", 6551cd261496SGeert Uytterhoeven "Missing Signed-off-by: line by nominal patch author '$author'\n"); 6552cd261496SGeert Uytterhoeven } 65530a920b5bSAndy Whitcroft } 65540a920b5bSAndy Whitcroft 6555f0a594c1SAndy Whitcroft print report_dump(); 655613214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 655713214adfSAndy Whitcroft print "$filename " if ($summary_file); 65586c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 65596c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 65606c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 65616c72ffaaSAndy Whitcroft } 65628905a67cSAndy Whitcroft 6563d2c0a235SAndy Whitcroft if ($quiet == 0) { 6564ef212196SJoe Perches # If there were any defects found and not already fixing them 6565ef212196SJoe Perches if (!$clean and !$fix) { 6566ef212196SJoe Perches print << "EOM" 6567ef212196SJoe Perches 6568ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 6569ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 6570ef212196SJoe PerchesEOM 6571ef212196SJoe Perches } 6572d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 6573d2c0a235SAndy Whitcroft # then suggest that. 6574d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 6575b0781216SMike Frysinger $rpt_cleaners = 0; 6576d8469f16SJoe Perches print << "EOM" 6577d8469f16SJoe Perches 6578d8469f16SJoe PerchesNOTE: Whitespace errors detected. 6579d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 6580d8469f16SJoe PerchesEOM 6581d2c0a235SAndy Whitcroft } 6582d2c0a235SAndy Whitcroft } 6583d2c0a235SAndy Whitcroft 6584d752fcc8SJoe Perches if ($clean == 0 && $fix && 6585d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 6586d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 65879624b8d6SJoe Perches my $newfile = $filename; 65889624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 65893705ce5bSJoe Perches my $linecount = 0; 65903705ce5bSJoe Perches my $f; 65913705ce5bSJoe Perches 6592d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 6593d752fcc8SJoe Perches 65943705ce5bSJoe Perches open($f, '>', $newfile) 65953705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 65963705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 65973705ce5bSJoe Perches $linecount++; 65983705ce5bSJoe Perches if ($file) { 65993705ce5bSJoe Perches if ($linecount > 3) { 66003705ce5bSJoe Perches $fixed_line =~ s/^\+//; 66013705ce5bSJoe Perches print $f $fixed_line . "\n"; 66023705ce5bSJoe Perches } 66033705ce5bSJoe Perches } else { 66043705ce5bSJoe Perches print $f $fixed_line . "\n"; 66053705ce5bSJoe Perches } 66063705ce5bSJoe Perches } 66073705ce5bSJoe Perches close($f); 66083705ce5bSJoe Perches 66093705ce5bSJoe Perches if (!$quiet) { 66103705ce5bSJoe Perches print << "EOM"; 6611d8469f16SJoe Perches 66123705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 66133705ce5bSJoe Perches 66143705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 66153705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 66163705ce5bSJoe Perches 66173705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 66183705ce5bSJoe PerchesNo warranties, expressed or implied... 66193705ce5bSJoe PerchesEOM 66203705ce5bSJoe Perches } 66213705ce5bSJoe Perches } 66223705ce5bSJoe Perches 6623d8469f16SJoe Perches if ($quiet == 0) { 6624d8469f16SJoe Perches print "\n"; 6625d8469f16SJoe Perches if ($clean == 1) { 6626d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 6627d8469f16SJoe Perches } else { 6628d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 66290a920b5bSAndy Whitcroft } 66300a920b5bSAndy Whitcroft } 66310a920b5bSAndy Whitcroft return $clean; 66320a920b5bSAndy Whitcroft} 6633