1cb77f0d6SKamil Rytarowski#!/usr/bin/env perl 2*882ea1d6SJoe Perches# SPDX-License-Identifier: GPL-2.0 3*882ea1d6SJoe 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]> 8*882ea1d6SJoe 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); 160a920b5bSAndy Whitcroft 170a920b5bSAndy Whitcroftmy $P = $0; 1836061e38SJoe Perchesmy $D = dirname(abs_path($P)); 190a920b5bSAndy Whitcroft 20000d1cc1SJoe Perchesmy $V = '0.32'; 210a920b5bSAndy Whitcroft 220a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 230a920b5bSAndy Whitcroft 240a920b5bSAndy Whitcroftmy $quiet = 0; 250a920b5bSAndy Whitcroftmy $tree = 1; 260a920b5bSAndy Whitcroftmy $chk_signoff = 1; 270a920b5bSAndy Whitcroftmy $chk_patch = 1; 28773647a0SAndy Whitcroftmy $tst_only; 296c72ffaaSAndy Whitcroftmy $emacs = 0; 308905a67cSAndy Whitcroftmy $terse = 0; 3134d8815fSJoe Perchesmy $showfile = 0; 326c72ffaaSAndy Whitcroftmy $file = 0; 334a593c34SDu, Changbinmy $git = 0; 340dea9f1eSJoe Perchesmy %git_commits = (); 356c72ffaaSAndy Whitcroftmy $check = 0; 362ac73b4fSJoe Perchesmy $check_orig = 0; 378905a67cSAndy Whitcroftmy $summary = 1; 388905a67cSAndy Whitcroftmy $mailback = 0; 3913214adfSAndy Whitcroftmy $summary_file = 0; 40000d1cc1SJoe Perchesmy $show_types = 0; 413beb42ecSJoe Perchesmy $list_types = 0; 423705ce5bSJoe Perchesmy $fix = 0; 439624b8d6SJoe Perchesmy $fix_inplace = 0; 446c72ffaaSAndy Whitcroftmy $root; 45c2fdda0dSAndy Whitcroftmy %debug; 463445686aSJoe Perchesmy %camelcase = (); 4791bfe484SJoe Perchesmy %use_type = (); 4891bfe484SJoe Perchesmy @use = (); 4991bfe484SJoe Perchesmy %ignore_type = (); 50000d1cc1SJoe Perchesmy @ignore = (); 5177f5b10aSHannes Edermy $help = 0; 52000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 536cd7f386SJoe Perchesmy $max_line_length = 80; 54d62a201fSDave Hansenmy $ignore_perl_version = 0; 55d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 5656193274SVadim Bendeburymy $min_conf_desc_length = 4; 5766b47b4aSKees Cookmy $spelling_file = "$D/spelling.txt"; 58ebfd7d62SJoe Perchesmy $codespell = 0; 59f1a63678SMaxim Uvarovmy $codespellfile = "/usr/share/codespell/dictionary.txt"; 60bf1fa1daSJoe Perchesmy $conststructsfile = "$D/const_structs.checkpatch"; 6175ad8c57SJerome Forissiermy $typedefsfile = ""; 62737c0767SJohn Brooksmy $color = "auto"; 63dadf680dSJoe Perchesmy $allow_c99_comments = 1; 6477f5b10aSHannes Eder 6577f5b10aSHannes Edersub help { 6677f5b10aSHannes Eder my ($exitcode) = @_; 6777f5b10aSHannes Eder 6877f5b10aSHannes Eder print << "EOM"; 6977f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 7077f5b10aSHannes EderVersion: $V 7177f5b10aSHannes Eder 7277f5b10aSHannes EderOptions: 7377f5b10aSHannes Eder -q, --quiet quiet 7477f5b10aSHannes Eder --no-tree run without a kernel tree 7577f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 7677f5b10aSHannes Eder --patch treat FILE as patchfile (default) 7777f5b10aSHannes Eder --emacs emacs compile window format 7877f5b10aSHannes Eder --terse one line per report 7934d8815fSJoe Perches --showfile emit diffed file position, not input file position 804a593c34SDu, Changbin -g, --git treat FILE as a single commit or git revision range 814a593c34SDu, Changbin single git commit with: 824a593c34SDu, Changbin <rev> 834a593c34SDu, Changbin <rev>^ 844a593c34SDu, Changbin <rev>~n 854a593c34SDu, Changbin multiple git commits with: 864a593c34SDu, Changbin <rev1>..<rev2> 874a593c34SDu, Changbin <rev1>...<rev2> 884a593c34SDu, Changbin <rev>-<count> 894a593c34SDu, Changbin git merges are ignored 9077f5b10aSHannes Eder -f, --file treat FILE as regular source file 9177f5b10aSHannes Eder --subjective, --strict enable more subjective tests 923beb42ecSJoe Perches --list-types list the possible message types 9391bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 94000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 953beb42ecSJoe Perches --show-types show the specific message type in the output 966cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 9756193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 9877f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 9977f5b10aSHannes Eder --no-summary suppress the per-file summary 10077f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 10177f5b10aSHannes Eder --summary-file include the filename in summary 10277f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 10377f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 10477f5b10aSHannes Eder is all off) 10577f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 10677f5b10aSHannes Eder literally 1073705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 1083705ce5bSJoe Perches If correctable single-line errors exist, create 1093705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 1103705ce5bSJoe Perches with potential errors corrected to the preferred 1113705ce5bSJoe Perches checkpatch style 1129624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 1139624b8d6SJoe Perches Is the same as --fix, but overwrites the input 1149624b8d6SJoe Perches file. It's your fault if there's no backup or git 115d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 116d62a201fSDave Hansen runtime errors. 117ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 118f1a63678SMaxim Uvarov (default:/usr/share/codespell/dictionary.txt) 119ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 12075ad8c57SJerome Forissier --typedefsfile Read additional types from this file 121737c0767SJohn Brooks --color[=WHEN] Use colors 'always', 'never', or only when output 122737c0767SJohn Brooks is a terminal ('auto'). Default is 'auto'. 12377f5b10aSHannes Eder -h, --help, --version display this help and exit 12477f5b10aSHannes Eder 12577f5b10aSHannes EderWhen FILE is - read standard input. 12677f5b10aSHannes EderEOM 12777f5b10aSHannes Eder 12877f5b10aSHannes Eder exit($exitcode); 12977f5b10aSHannes Eder} 13077f5b10aSHannes Eder 1313beb42ecSJoe Perchessub uniq { 1323beb42ecSJoe Perches my %seen; 1333beb42ecSJoe Perches return grep { !$seen{$_}++ } @_; 1343beb42ecSJoe Perches} 1353beb42ecSJoe Perches 1363beb42ecSJoe Perchessub list_types { 1373beb42ecSJoe Perches my ($exitcode) = @_; 1383beb42ecSJoe Perches 1393beb42ecSJoe Perches my $count = 0; 1403beb42ecSJoe Perches 1413beb42ecSJoe Perches local $/ = undef; 1423beb42ecSJoe Perches 1433beb42ecSJoe Perches open(my $script, '<', abs_path($P)) or 1443beb42ecSJoe Perches die "$P: Can't read '$P' $!\n"; 1453beb42ecSJoe Perches 1463beb42ecSJoe Perches my $text = <$script>; 1473beb42ecSJoe Perches close($script); 1483beb42ecSJoe Perches 1493beb42ecSJoe Perches my @types = (); 1500547fa58SJean Delvare # Also catch when type or level is passed through a variable 1510547fa58SJean Delvare for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) { 1523beb42ecSJoe Perches push (@types, $_); 1533beb42ecSJoe Perches } 1543beb42ecSJoe Perches @types = sort(uniq(@types)); 1553beb42ecSJoe Perches print("#\tMessage type\n\n"); 1563beb42ecSJoe Perches foreach my $type (@types) { 1573beb42ecSJoe Perches print(++$count . "\t" . $type . "\n"); 1583beb42ecSJoe Perches } 1593beb42ecSJoe Perches 1603beb42ecSJoe Perches exit($exitcode); 1613beb42ecSJoe Perches} 1623beb42ecSJoe Perches 163000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 164000d1cc1SJoe Perchesif (-f $conf) { 165000d1cc1SJoe Perches my @conf_args; 166000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 167000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 168000d1cc1SJoe Perches 169000d1cc1SJoe Perches while (<$conffile>) { 170000d1cc1SJoe Perches my $line = $_; 171000d1cc1SJoe Perches 172000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 173000d1cc1SJoe Perches $line =~ s/^\s*//g; 174000d1cc1SJoe Perches $line =~ s/\s+/ /g; 175000d1cc1SJoe Perches 176000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 177000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 178000d1cc1SJoe Perches 179000d1cc1SJoe Perches my @words = split(" ", $line); 180000d1cc1SJoe Perches foreach my $word (@words) { 181000d1cc1SJoe Perches last if ($word =~ m/^#/); 182000d1cc1SJoe Perches push (@conf_args, $word); 183000d1cc1SJoe Perches } 184000d1cc1SJoe Perches } 185000d1cc1SJoe Perches close($conffile); 186000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 187000d1cc1SJoe Perches} 188000d1cc1SJoe Perches 189737c0767SJohn Brooks# Perl's Getopt::Long allows options to take optional arguments after a space. 190737c0767SJohn Brooks# Prevent --color by itself from consuming other arguments 191737c0767SJohn Brooksforeach (@ARGV) { 192737c0767SJohn Brooks if ($_ eq "--color" || $_ eq "-color") { 193737c0767SJohn Brooks $_ = "--color=$color"; 194737c0767SJohn Brooks } 195737c0767SJohn Brooks} 196737c0767SJohn Brooks 1970a920b5bSAndy WhitcroftGetOptions( 1986c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1990a920b5bSAndy Whitcroft 'tree!' => \$tree, 2000a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 2010a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 2026c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 2038905a67cSAndy Whitcroft 'terse!' => \$terse, 20434d8815fSJoe Perches 'showfile!' => \$showfile, 20577f5b10aSHannes Eder 'f|file!' => \$file, 2064a593c34SDu, Changbin 'g|git!' => \$git, 2076c72ffaaSAndy Whitcroft 'subjective!' => \$check, 2086c72ffaaSAndy Whitcroft 'strict!' => \$check, 209000d1cc1SJoe Perches 'ignore=s' => \@ignore, 21091bfe484SJoe Perches 'types=s' => \@use, 211000d1cc1SJoe Perches 'show-types!' => \$show_types, 2123beb42ecSJoe Perches 'list-types!' => \$list_types, 2136cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 21456193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 2156c72ffaaSAndy Whitcroft 'root=s' => \$root, 2168905a67cSAndy Whitcroft 'summary!' => \$summary, 2178905a67cSAndy Whitcroft 'mailback!' => \$mailback, 21813214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 2193705ce5bSJoe Perches 'fix!' => \$fix, 2209624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 221d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 222c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 223773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 224ebfd7d62SJoe Perches 'codespell!' => \$codespell, 225ebfd7d62SJoe Perches 'codespellfile=s' => \$codespellfile, 22675ad8c57SJerome Forissier 'typedefsfile=s' => \$typedefsfile, 227737c0767SJohn Brooks 'color=s' => \$color, 228737c0767SJohn Brooks 'no-color' => \$color, #keep old behaviors of -nocolor 229737c0767SJohn Brooks 'nocolor' => \$color, #keep old behaviors of -nocolor 23077f5b10aSHannes Eder 'h|help' => \$help, 23177f5b10aSHannes Eder 'version' => \$help 23277f5b10aSHannes Eder) or help(1); 23377f5b10aSHannes Eder 23477f5b10aSHannes Ederhelp(0) if ($help); 2350a920b5bSAndy Whitcroft 2363beb42ecSJoe Percheslist_types(0) if ($list_types); 2373beb42ecSJoe Perches 2389624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 2392ac73b4fSJoe Perches$check_orig = $check; 2409624b8d6SJoe Perches 2410a920b5bSAndy Whitcroftmy $exit = 0; 2420a920b5bSAndy Whitcroft 243d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 244d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 245d62a201fSDave Hansen if (!$ignore_perl_version) { 246d62a201fSDave Hansen exit(1); 247d62a201fSDave Hansen } 248d62a201fSDave Hansen} 249d62a201fSDave Hansen 25045107ff6SAllen Hubbe#if no filenames are given, push '-' to read patch from stdin 2510a920b5bSAndy Whitcroftif ($#ARGV < 0) { 25245107ff6SAllen Hubbe push(@ARGV, '-'); 2530a920b5bSAndy Whitcroft} 2540a920b5bSAndy Whitcroft 255737c0767SJohn Brooksif ($color =~ /^[01]$/) { 256737c0767SJohn Brooks $color = !$color; 257737c0767SJohn Brooks} elsif ($color =~ /^always$/i) { 258737c0767SJohn Brooks $color = 1; 259737c0767SJohn Brooks} elsif ($color =~ /^never$/i) { 260737c0767SJohn Brooks $color = 0; 261737c0767SJohn Brooks} elsif ($color =~ /^auto$/i) { 262737c0767SJohn Brooks $color = (-t STDOUT); 263737c0767SJohn Brooks} else { 264737c0767SJohn Brooks die "Invalid color mode: $color\n"; 265737c0767SJohn Brooks} 266737c0767SJohn Brooks 26791bfe484SJoe Perchessub hash_save_array_words { 26891bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 26991bfe484SJoe Perches 27091bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 27191bfe484SJoe Perches foreach my $word (@array) { 272000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 273000d1cc1SJoe Perches $word =~ s/^\s*//g; 274000d1cc1SJoe Perches $word =~ s/\s+/ /g; 275000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 276000d1cc1SJoe Perches 277000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 278000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 279000d1cc1SJoe Perches 28091bfe484SJoe Perches $hashRef->{$word}++; 281000d1cc1SJoe Perches } 28291bfe484SJoe Perches} 28391bfe484SJoe Perches 28491bfe484SJoe Perchessub hash_show_words { 28591bfe484SJoe Perches my ($hashRef, $prefix) = @_; 28691bfe484SJoe Perches 2873c816e49SJoe Perches if (keys %$hashRef) { 288d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 28958cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 29091bfe484SJoe Perches print " $word"; 29191bfe484SJoe Perches } 292d8469f16SJoe Perches print "\n"; 29391bfe484SJoe Perches } 29491bfe484SJoe Perches} 29591bfe484SJoe Perches 29691bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 29791bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 298000d1cc1SJoe Perches 299c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 300c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 3017429c690SAndy Whitcroftmy $dbg_type = 0; 302a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 303c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 30421caa13cSAndy Whitcroft ## no critic 30521caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 30621caa13cSAndy Whitcroft die "$@" if ($@); 307c2fdda0dSAndy Whitcroft} 308c2fdda0dSAndy Whitcroft 309d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 310d2c0a235SAndy Whitcroft 3118905a67cSAndy Whitcroftif ($terse) { 3128905a67cSAndy Whitcroft $emacs = 1; 3138905a67cSAndy Whitcroft $quiet++; 3148905a67cSAndy Whitcroft} 3158905a67cSAndy Whitcroft 3166c72ffaaSAndy Whitcroftif ($tree) { 3176c72ffaaSAndy Whitcroft if (defined $root) { 3186c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 3196c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 3206c72ffaaSAndy Whitcroft } 3216c72ffaaSAndy Whitcroft } else { 3226c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 3236c72ffaaSAndy Whitcroft $root = '.'; 3246c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 3256c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 3266c72ffaaSAndy Whitcroft $root = $1; 3276c72ffaaSAndy Whitcroft } 3286c72ffaaSAndy Whitcroft } 3296c72ffaaSAndy Whitcroft 3306c72ffaaSAndy Whitcroft if (!defined $root) { 3310a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 3320a920b5bSAndy Whitcroft exit(2); 3330a920b5bSAndy Whitcroft } 3346c72ffaaSAndy Whitcroft} 3356c72ffaaSAndy Whitcroft 3366c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 3376c72ffaaSAndy Whitcroft 3382ceb532bSAndy Whitcroftour $Ident = qr{ 3392ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 3402ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 3412ceb532bSAndy Whitcroft }x; 3426c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 3436c72ffaaSAndy Whitcroftour $Sparse = qr{ 3446c72ffaaSAndy Whitcroft __user| 3456c72ffaaSAndy Whitcroft __kernel| 3466c72ffaaSAndy Whitcroft __force| 3476c72ffaaSAndy Whitcroft __iomem| 3486c72ffaaSAndy Whitcroft __must_check| 3496c72ffaaSAndy Whitcroft __init_refok| 350417495edSAndy Whitcroft __kprobes| 351165e72a6SSven Eckelmann __ref| 352ad315455SBoqun Feng __rcu| 353ad315455SBoqun Feng __private 3546c72ffaaSAndy Whitcroft }x; 355e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 356e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 357e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 358e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 359e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 3608716de38SJoe Perches 36152131292SWolfram Sang# Notes to $Attribute: 36252131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 3636c72ffaaSAndy Whitcroftour $Attribute = qr{ 3646c72ffaaSAndy Whitcroft const| 36503f1df7dSJoe Perches __percpu| 36603f1df7dSJoe Perches __nocast| 36703f1df7dSJoe Perches __safe| 36846d832f5SMichael S. Tsirkin __bitwise| 36903f1df7dSJoe Perches __packed__| 37003f1df7dSJoe Perches __packed2__| 37103f1df7dSJoe Perches __naked| 37203f1df7dSJoe Perches __maybe_unused| 37303f1df7dSJoe Perches __always_unused| 37403f1df7dSJoe Perches __noreturn| 37503f1df7dSJoe Perches __used| 37603f1df7dSJoe Perches __cold| 377e23ef1f3SJoe Perches __pure| 37803f1df7dSJoe Perches __noclone| 37903f1df7dSJoe Perches __deprecated| 3806c72ffaaSAndy Whitcroft __read_mostly| 3816c72ffaaSAndy Whitcroft __kprobes| 3828716de38SJoe Perches $InitAttribute| 38324e1d81aSAndy Whitcroft ____cacheline_aligned| 38424e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 3855fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 3865fe3af11SAndy Whitcroft __weak 3876c72ffaaSAndy Whitcroft }x; 388c45dcabdSAndy Whitcroftour $Modifier; 38991cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 3906c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 3916c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 3926c72ffaaSAndy Whitcroft 39395e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 39495e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 39595e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 39695e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 3972435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 398c0a5c898SJoe Perchesour $String = qr{"[X\t]*"}; 399326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 400326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 401326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 40274349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 4032435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 404326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 405447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 40623f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 4076c72ffaaSAndy Whitcroftour $Operators = qr{ 4086c72ffaaSAndy Whitcroft <=|>=|==|!=| 4096c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 41023f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 4116c72ffaaSAndy Whitcroft }x; 4126c72ffaaSAndy Whitcroft 41391cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 41491cb5195SJoe Perches 415ab7e23f3SJoe Perchesour $BasicType; 4168905a67cSAndy Whitcroftour $NonptrType; 4171813087dSJoe Perchesour $NonptrTypeMisordered; 4188716de38SJoe Perchesour $NonptrTypeWithAttr; 4198905a67cSAndy Whitcroftour $Type; 4201813087dSJoe Perchesour $TypeMisordered; 4218905a67cSAndy Whitcroftour $Declare; 4221813087dSJoe Perchesour $DeclareMisordered; 4238905a67cSAndy Whitcroft 42415662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 42515662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 426171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 427171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 428171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 429171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 430171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 431171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 432171ae1a4SAndy Whitcroft}x; 433171ae1a4SAndy Whitcroft 43415662b3eSJoe Perchesour $UTF8 = qr{ 43515662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 43615662b3eSJoe Perches | $NON_ASCII_UTF8 43715662b3eSJoe Perches}x; 43815662b3eSJoe Perches 439e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 440021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 441021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 442021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 443021158b4SJoe Perches)}; 444e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 445fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 4468ed22cadSAndy Whitcroft atomic_t 4478ed22cadSAndy Whitcroft)}; 448e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 449e6176fa4SJoe Perches $typeC99Typedefs\b| 450e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 451e6176fa4SJoe Perches $typeKernelTypedefs\b 452e6176fa4SJoe Perches)}; 4538ed22cadSAndy Whitcroft 4546d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 4556d32f7a3SJoe Perches 456691e669bSJoe Perchesour $logFunctions = qr{(?x: 457758d7aadSMiles Chen printk(?:_ratelimited|_once|_deferred_once|_deferred|)| 4587d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 45987bd499aSJoe Perches TP_printk| 4606e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 461b0531722SJoe Perches panic| 46206668727SJoe Perches MODULE_[A-Z_]+| 46306668727SJoe Perches seq_vprintf|seq_printf|seq_puts 464691e669bSJoe Perches)}; 465691e669bSJoe Perches 46620112475SJoe Perchesour $signature_tags = qr{(?xi: 46720112475SJoe Perches Signed-off-by:| 46820112475SJoe Perches Acked-by:| 46920112475SJoe Perches Tested-by:| 47020112475SJoe Perches Reviewed-by:| 47120112475SJoe Perches Reported-by:| 4728543ae12SMugunthan V N Suggested-by:| 47320112475SJoe Perches To:| 47420112475SJoe Perches Cc: 47520112475SJoe Perches)}; 47620112475SJoe Perches 4771813087dSJoe Perchesour @typeListMisordered = ( 4781813087dSJoe Perches qr{char\s+(?:un)?signed}, 4791813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 4801813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 4811813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 4821813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 4831813087dSJoe Perches qr{short\s+(?:un)?signed}, 4841813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 4851813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 4861813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 4871813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 4881813087dSJoe Perches qr{int\s+(?:un)?signed}, 4891813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 4901813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 4911813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 4921813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 4931813087dSJoe Perches qr{long\s+(?:un)?signed}, 4941813087dSJoe Perches); 4951813087dSJoe Perches 4968905a67cSAndy Whitcroftour @typeList = ( 4978905a67cSAndy Whitcroft qr{void}, 4980c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 4990c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 5000c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 5010c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 5020c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 5030c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 5040c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 5050c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 5060c773d9dSJoe Perches qr{(?:un)?signed}, 5078905a67cSAndy Whitcroft qr{float}, 5088905a67cSAndy Whitcroft qr{double}, 5098905a67cSAndy Whitcroft qr{bool}, 5108905a67cSAndy Whitcroft qr{struct\s+$Ident}, 5118905a67cSAndy Whitcroft qr{union\s+$Ident}, 5128905a67cSAndy Whitcroft qr{enum\s+$Ident}, 5138905a67cSAndy Whitcroft qr{${Ident}_t}, 5148905a67cSAndy Whitcroft qr{${Ident}_handler}, 5158905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 5161813087dSJoe Perches @typeListMisordered, 5178905a67cSAndy Whitcroft); 518938224b5SJoe Perches 519938224b5SJoe Perchesour $C90_int_types = qr{(?x: 520938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 521938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 522938224b5SJoe Perches long\s+long\s+(?:un)?signed| 523938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 524938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 525938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 526938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 527938224b5SJoe Perches 528938224b5SJoe Perches long\s+int\s+(?:un)?signed| 529938224b5SJoe Perches long\s+(?:un)?signed\s+int| 530938224b5SJoe Perches long\s+(?:un)?signed| 531938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 532938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 533938224b5SJoe Perches int\s+long\s+(?:un)?signed| 534938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 535938224b5SJoe Perches 536938224b5SJoe Perches int\s+(?:un)?signed| 537938224b5SJoe Perches (?:(?:un)?signed\s+)?int 538938224b5SJoe Perches)}; 539938224b5SJoe Perches 540485ff23eSAlex Dowadour @typeListFile = (); 5418716de38SJoe Perchesour @typeListWithAttr = ( 5428716de38SJoe Perches @typeList, 5438716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 5448716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 5458716de38SJoe Perches); 5468716de38SJoe Perches 547c45dcabdSAndy Whitcroftour @modifierList = ( 548c45dcabdSAndy Whitcroft qr{fastcall}, 549c45dcabdSAndy Whitcroft); 550485ff23eSAlex Dowadour @modifierListFile = (); 5518905a67cSAndy Whitcroft 5522435880fSJoe Perchesour @mode_permission_funcs = ( 5532435880fSJoe Perches ["module_param", 3], 5542435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 5552435880fSJoe Perches ["module_param_array_named", 5], 5562435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 5572435880fSJoe Perches ["proc_create(?:_data|)", 2], 558459cf0aeSJoe Perches ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2], 559459cf0aeSJoe Perches ["IIO_DEV_ATTR_[A-Z_]+", 1], 560459cf0aeSJoe Perches ["SENSOR_(?:DEVICE_|)ATTR_2", 2], 561459cf0aeSJoe Perches ["SENSOR_TEMPLATE(?:_2|)", 3], 562459cf0aeSJoe Perches ["__ATTR", 2], 5632435880fSJoe Perches); 5642435880fSJoe Perches 565515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 566515a235eSJoe Perchesour $mode_perms_search = ""; 567515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 568515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 569515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 570515a235eSJoe Perches} 57100180468SJoe Perches$mode_perms_search = "(?:${mode_perms_search})"; 572515a235eSJoe Perches 573b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 574b392c64fSJoe Perches S_IWUGO | 575b392c64fSJoe Perches S_IWOTH | 576b392c64fSJoe Perches S_IRWXUGO | 577b392c64fSJoe Perches S_IALLUGO | 578b392c64fSJoe Perches 0[0-7][0-7][2367] 579b392c64fSJoe Perches}x; 580b392c64fSJoe Perches 581f90774e1SJoe Perchesour %mode_permission_string_types = ( 582f90774e1SJoe Perches "S_IRWXU" => 0700, 583f90774e1SJoe Perches "S_IRUSR" => 0400, 584f90774e1SJoe Perches "S_IWUSR" => 0200, 585f90774e1SJoe Perches "S_IXUSR" => 0100, 586f90774e1SJoe Perches "S_IRWXG" => 0070, 587f90774e1SJoe Perches "S_IRGRP" => 0040, 588f90774e1SJoe Perches "S_IWGRP" => 0020, 589f90774e1SJoe Perches "S_IXGRP" => 0010, 590f90774e1SJoe Perches "S_IRWXO" => 0007, 591f90774e1SJoe Perches "S_IROTH" => 0004, 592f90774e1SJoe Perches "S_IWOTH" => 0002, 593f90774e1SJoe Perches "S_IXOTH" => 0001, 594f90774e1SJoe Perches "S_IRWXUGO" => 0777, 595f90774e1SJoe Perches "S_IRUGO" => 0444, 596f90774e1SJoe Perches "S_IWUGO" => 0222, 597f90774e1SJoe Perches "S_IXUGO" => 0111, 598f90774e1SJoe Perches); 599f90774e1SJoe Perches 600f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below 601f90774e1SJoe Perchesour $mode_perms_string_search = ""; 602f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) { 603f90774e1SJoe Perches $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); 604f90774e1SJoe Perches $mode_perms_string_search .= $entry; 605f90774e1SJoe Perches} 60600180468SJoe Perchesour $single_mode_perms_string_search = "(?:${mode_perms_string_search})"; 60700180468SJoe Perchesour $multi_mode_perms_string_search = qr{ 60800180468SJoe Perches ${single_mode_perms_string_search} 60900180468SJoe Perches (?:\s*\|\s*${single_mode_perms_string_search})* 61000180468SJoe Perches}x; 61100180468SJoe Perches 61200180468SJoe Perchessub perms_to_octal { 61300180468SJoe Perches my ($string) = @_; 61400180468SJoe Perches 61500180468SJoe Perches return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/); 61600180468SJoe Perches 61700180468SJoe Perches my $val = ""; 61800180468SJoe Perches my $oval = ""; 61900180468SJoe Perches my $to = 0; 62000180468SJoe Perches my $curpos = 0; 62100180468SJoe Perches my $lastpos = 0; 62200180468SJoe Perches while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) { 62300180468SJoe Perches $curpos = pos($string); 62400180468SJoe Perches my $match = $2; 62500180468SJoe Perches my $omatch = $1; 62600180468SJoe Perches last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos)); 62700180468SJoe Perches $lastpos = $curpos; 62800180468SJoe Perches $to |= $mode_permission_string_types{$match}; 62900180468SJoe Perches $val .= '\s*\|\s*' if ($val ne ""); 63000180468SJoe Perches $val .= $match; 63100180468SJoe Perches $oval .= $omatch; 63200180468SJoe Perches } 63300180468SJoe Perches $oval =~ s/^\s*\|\s*//; 63400180468SJoe Perches $oval =~ s/\s*\|\s*$//; 63500180468SJoe Perches return sprintf("%04o", $to); 63600180468SJoe Perches} 637f90774e1SJoe Perches 6387840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 6397840a94cSWolfram Sang irq| 640cdcee686SSergey Ryazanov memory| 641cdcee686SSergey Ryazanov time| 642cdcee686SSergey Ryazanov reboot 6437840a94cSWolfram Sang)}; 6447840a94cSWolfram Sang# memory.h: ARM has a custom one 6457840a94cSWolfram Sang 64666b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 64766b47b4aSKees Cookmy $misspellings; 64866b47b4aSKees Cookmy %spelling_fix; 64936061e38SJoe Perches 65036061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 65166b47b4aSKees Cook while (<$spelling>) { 65266b47b4aSKees Cook my $line = $_; 65366b47b4aSKees Cook 65466b47b4aSKees Cook $line =~ s/\s*\n?$//g; 65566b47b4aSKees Cook $line =~ s/^\s*//g; 65666b47b4aSKees Cook 65766b47b4aSKees Cook next if ($line =~ m/^\s*#/); 65866b47b4aSKees Cook next if ($line =~ m/^\s*$/); 65966b47b4aSKees Cook 66066b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 66166b47b4aSKees Cook 66266b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 66366b47b4aSKees Cook } 66466b47b4aSKees Cook close($spelling); 66536061e38SJoe Perches} else { 66636061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 66736061e38SJoe Perches} 66866b47b4aSKees Cook 669ebfd7d62SJoe Perchesif ($codespell) { 670ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 671ebfd7d62SJoe Perches while (<$spelling>) { 672ebfd7d62SJoe Perches my $line = $_; 673ebfd7d62SJoe Perches 674ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 675ebfd7d62SJoe Perches $line =~ s/^\s*//g; 676ebfd7d62SJoe Perches 677ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 678ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 679ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 680ebfd7d62SJoe Perches 681ebfd7d62SJoe Perches $line =~ s/,.*$//; 682ebfd7d62SJoe Perches 683ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 684ebfd7d62SJoe Perches 685ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 686ebfd7d62SJoe Perches } 687ebfd7d62SJoe Perches close($spelling); 688ebfd7d62SJoe Perches } else { 689ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 690ebfd7d62SJoe Perches } 691ebfd7d62SJoe Perches} 692ebfd7d62SJoe Perches 693ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 694ebfd7d62SJoe Perches 69575ad8c57SJerome Forissiersub read_words { 69675ad8c57SJerome Forissier my ($wordsRef, $file) = @_; 69775ad8c57SJerome Forissier 69875ad8c57SJerome Forissier if (open(my $words, '<', $file)) { 69975ad8c57SJerome Forissier while (<$words>) { 700bf1fa1daSJoe Perches my $line = $_; 701bf1fa1daSJoe Perches 702bf1fa1daSJoe Perches $line =~ s/\s*\n?$//g; 703bf1fa1daSJoe Perches $line =~ s/^\s*//g; 704bf1fa1daSJoe Perches 705bf1fa1daSJoe Perches next if ($line =~ m/^\s*#/); 706bf1fa1daSJoe Perches next if ($line =~ m/^\s*$/); 707bf1fa1daSJoe Perches if ($line =~ /\s/) { 70875ad8c57SJerome Forissier print("$file: '$line' invalid - ignored\n"); 709bf1fa1daSJoe Perches next; 710bf1fa1daSJoe Perches } 711bf1fa1daSJoe Perches 71275ad8c57SJerome Forissier $$wordsRef .= '|' if ($$wordsRef ne ""); 71375ad8c57SJerome Forissier $$wordsRef .= $line; 714bf1fa1daSJoe Perches } 71575ad8c57SJerome Forissier close($file); 71675ad8c57SJerome Forissier return 1; 717bf1fa1daSJoe Perches } 718bf1fa1daSJoe Perches 71975ad8c57SJerome Forissier return 0; 72075ad8c57SJerome Forissier} 72175ad8c57SJerome Forissier 72275ad8c57SJerome Forissiermy $const_structs = ""; 72375ad8c57SJerome Forissierread_words(\$const_structs, $conststructsfile) 72475ad8c57SJerome Forissier or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 72575ad8c57SJerome Forissier 72675ad8c57SJerome Forissiermy $typeOtherTypedefs = ""; 72775ad8c57SJerome Forissierif (length($typedefsfile)) { 72875ad8c57SJerome Forissier read_words(\$typeOtherTypedefs, $typedefsfile) 72975ad8c57SJerome Forissier or warn "No additional types will be considered - file '$typedefsfile': $!\n"; 73075ad8c57SJerome Forissier} 73175ad8c57SJerome Forissier$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne ""); 73275ad8c57SJerome Forissier 7338905a67cSAndy Whitcroftsub build_types { 734485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 735485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 7361813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 7378716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 738c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 739ab7e23f3SJoe Perches $BasicType = qr{ 740ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 741ab7e23f3SJoe Perches (?:${all}\b) 742ab7e23f3SJoe Perches }x; 7438905a67cSAndy Whitcroft $NonptrType = qr{ 744d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 745cf655043SAndy Whitcroft (?: 7466b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 7478ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 748c45dcabdSAndy Whitcroft (?:${all}\b) 749cf655043SAndy Whitcroft ) 750c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 7518905a67cSAndy Whitcroft }x; 7521813087dSJoe Perches $NonptrTypeMisordered = qr{ 7531813087dSJoe Perches (?:$Modifier\s+|const\s+)* 7541813087dSJoe Perches (?: 7551813087dSJoe Perches (?:${Misordered}\b) 7561813087dSJoe Perches ) 7571813087dSJoe Perches (?:\s+$Modifier|\s+const)* 7581813087dSJoe Perches }x; 7598716de38SJoe Perches $NonptrTypeWithAttr = qr{ 7608716de38SJoe Perches (?:$Modifier\s+|const\s+)* 7618716de38SJoe Perches (?: 7628716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 7638716de38SJoe Perches (?:$typeTypedefs\b)| 7648716de38SJoe Perches (?:${allWithAttr}\b) 7658716de38SJoe Perches ) 7668716de38SJoe Perches (?:\s+$Modifier|\s+const)* 7678716de38SJoe Perches }x; 7688905a67cSAndy Whitcroft $Type = qr{ 769c45dcabdSAndy Whitcroft $NonptrType 7701574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 771c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 7728905a67cSAndy Whitcroft }x; 7731813087dSJoe Perches $TypeMisordered = qr{ 7741813087dSJoe Perches $NonptrTypeMisordered 7751813087dSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 7761813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 7771813087dSJoe Perches }x; 77891cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 7791813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 7808905a67cSAndy Whitcroft} 7818905a67cSAndy Whitcroftbuild_types(); 7826c72ffaaSAndy Whitcroft 7837d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 784d1fe9c09SJoe Perches 785d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 786d1fe9c09SJoe Perches# requires at least perl version v5.10.0 787d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 788d1fe9c09SJoe Perches 789d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 7902435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 791c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 7927d2367afSJoe Perches 793f8422308SJoe Perchesour $declaration_macros = qr{(?x: 7943e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 795fe658f94SSteffen Maier (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(| 7963d102fc0SGilad Ben-Yossef (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(| 7973d102fc0SGilad Ben-Yossef (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\( 798f8422308SJoe Perches)}; 799f8422308SJoe Perches 8007d2367afSJoe Perchessub deparenthesize { 8017d2367afSJoe Perches my ($string) = @_; 8027d2367afSJoe Perches return "" if (!defined($string)); 8035b9553abSJoe Perches 8045b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 8055b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 8065b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 8075b9553abSJoe Perches } 8085b9553abSJoe Perches 8097d2367afSJoe Perches $string =~ s@\s+@ @g; 8105b9553abSJoe Perches 8117d2367afSJoe Perches return $string; 8127d2367afSJoe Perches} 8137d2367afSJoe Perches 8143445686aSJoe Perchessub seed_camelcase_file { 8153445686aSJoe Perches my ($file) = @_; 8163445686aSJoe Perches 8173445686aSJoe Perches return if (!(-f $file)); 8183445686aSJoe Perches 8193445686aSJoe Perches local $/; 8203445686aSJoe Perches 8213445686aSJoe Perches open(my $include_file, '<', "$file") 8223445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 8233445686aSJoe Perches my $text = <$include_file>; 8243445686aSJoe Perches close($include_file); 8253445686aSJoe Perches 8263445686aSJoe Perches my @lines = split('\n', $text); 8273445686aSJoe Perches 8283445686aSJoe Perches foreach my $line (@lines) { 8293445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 8303445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 8313445686aSJoe Perches $camelcase{$1} = 1; 83211ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 83311ea516aSJoe Perches $camelcase{$1} = 1; 83411ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 8353445686aSJoe Perches $camelcase{$1} = 1; 8363445686aSJoe Perches } 8373445686aSJoe Perches } 8383445686aSJoe Perches} 8393445686aSJoe Perches 84085b0ee18SJoe Perchessub is_maintained_obsolete { 84185b0ee18SJoe Perches my ($filename) = @_; 84285b0ee18SJoe Perches 843f2c19c2fSJerome Forissier return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 84485b0ee18SJoe Perches 8450616efa4SJoe Perches my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 84685b0ee18SJoe Perches 84785b0ee18SJoe Perches return $status =~ /obsolete/i; 84885b0ee18SJoe Perches} 84985b0ee18SJoe Perches 8503445686aSJoe Perchesmy $camelcase_seeded = 0; 8513445686aSJoe Perchessub seed_camelcase_includes { 8523445686aSJoe Perches return if ($camelcase_seeded); 8533445686aSJoe Perches 8543445686aSJoe Perches my $files; 855c707a81dSJoe Perches my $camelcase_cache = ""; 856c707a81dSJoe Perches my @include_files = (); 857c707a81dSJoe Perches 858c707a81dSJoe Perches $camelcase_seeded = 1; 859351b2a1fSJoe Perches 8603645e328SRichard Genoud if (-e ".git") { 861351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 862351b2a1fSJoe Perches chomp $git_last_include_commit; 863c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 864c707a81dSJoe Perches } else { 865c707a81dSJoe Perches my $last_mod_date = 0; 866c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 867c707a81dSJoe Perches @include_files = split('\n', $files); 868c707a81dSJoe Perches foreach my $file (@include_files) { 869c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 870c707a81dSJoe Perches localtime((stat $file)[9])); 871c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 872c707a81dSJoe Perches } 873c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 874c707a81dSJoe Perches } 875c707a81dSJoe Perches 876c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 877c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 878c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 879351b2a1fSJoe Perches while (<$camelcase_file>) { 880351b2a1fSJoe Perches chomp; 881351b2a1fSJoe Perches $camelcase{$_} = 1; 882351b2a1fSJoe Perches } 883351b2a1fSJoe Perches close($camelcase_file); 884351b2a1fSJoe Perches 885351b2a1fSJoe Perches return; 886351b2a1fSJoe Perches } 887c707a81dSJoe Perches 8883645e328SRichard Genoud if (-e ".git") { 889c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 890c707a81dSJoe Perches @include_files = split('\n', $files); 8913445686aSJoe Perches } 892c707a81dSJoe Perches 8933445686aSJoe Perches foreach my $file (@include_files) { 8943445686aSJoe Perches seed_camelcase_file($file); 8953445686aSJoe Perches } 896351b2a1fSJoe Perches 897c707a81dSJoe Perches if ($camelcase_cache ne "") { 898351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 899c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 900c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 901351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 902351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 903351b2a1fSJoe Perches } 904351b2a1fSJoe Perches close($camelcase_file); 905351b2a1fSJoe Perches } 9063445686aSJoe Perches} 9073445686aSJoe Perches 908d311cd44SJoe Perchessub git_commit_info { 909d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 910d311cd44SJoe Perches 911d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 912d311cd44SJoe Perches 913d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 914d311cd44SJoe Perches $output =~ s/^\s*//gm; 915d311cd44SJoe Perches my @lines = split("\n", $output); 916d311cd44SJoe Perches 9170d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 9180d7835fcSJoe Perches 919d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 920d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 921d311cd44SJoe Perches# all matching commit ids, but it's very slow... 922d311cd44SJoe Perches# 923d311cd44SJoe Perches# echo "checking commits $1..." 924d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 925d311cd44SJoe Perches# while read line ; do 926d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 927d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 928d311cd44SJoe Perches# done 929d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 930948b133aSHeinrich Schuchardt $id = undef; 931d311cd44SJoe Perches } else { 932d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 933d311cd44SJoe Perches $desc = substr($lines[0], 41); 934d311cd44SJoe Perches } 935d311cd44SJoe Perches 936d311cd44SJoe Perches return ($id, $desc); 937d311cd44SJoe Perches} 938d311cd44SJoe Perches 9396c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 9400a920b5bSAndy Whitcroft 94100df344fSAndy Whitcroftmy @rawlines = (); 942c2fdda0dSAndy Whitcroftmy @lines = (); 9433705ce5bSJoe Perchesmy @fixed = (); 944d752fcc8SJoe Perchesmy @fixed_inserted = (); 945d752fcc8SJoe Perchesmy @fixed_deleted = (); 946194f66fcSJoe Perchesmy $fixlinenr = -1; 947194f66fcSJoe Perches 9484a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 9494a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 9504a593c34SDu, Changbindie "$P: No git repository found\n" if ($git && !-e ".git"); 9514a593c34SDu, Changbin 9524a593c34SDu, Changbinif ($git) { 9534a593c34SDu, Changbin my @commits = (); 9540dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 9554a593c34SDu, Changbin my $git_range; 95628898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 95728898fd1SJoe Perches $git_range = "-$2 $1"; 9584a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 9594a593c34SDu, Changbin $git_range = "$commit_expr"; 9604a593c34SDu, Changbin } else { 9610dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 9620dea9f1eSJoe Perches } 9630dea9f1eSJoe Perches my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 9640dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 96528898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 96628898fd1SJoe Perches next if (!defined($1) || !defined($2)); 9670dea9f1eSJoe Perches my $sha1 = $1; 9680dea9f1eSJoe Perches my $subject = $2; 9690dea9f1eSJoe Perches unshift(@commits, $sha1); 9700dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 9714a593c34SDu, Changbin } 9724a593c34SDu, Changbin } 9734a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 9744a593c34SDu, Changbin @ARGV = @commits; 9754a593c34SDu, Changbin} 9764a593c34SDu, Changbin 977c2fdda0dSAndy Whitcroftmy $vname; 9786c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 97921caa13cSAndy Whitcroft my $FILE; 9804a593c34SDu, Changbin if ($git) { 9814a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 9824a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 9834a593c34SDu, Changbin } elsif ($file) { 98421caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 9856c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 98621caa13cSAndy Whitcroft } elsif ($filename eq '-') { 98721caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 9886c72ffaaSAndy Whitcroft } else { 98921caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 9906c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 9916c72ffaaSAndy Whitcroft } 992c2fdda0dSAndy Whitcroft if ($filename eq '-') { 993c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 9944a593c34SDu, Changbin } elsif ($git) { 9950dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 996c2fdda0dSAndy Whitcroft } else { 997c2fdda0dSAndy Whitcroft $vname = $filename; 998c2fdda0dSAndy Whitcroft } 99921caa13cSAndy Whitcroft while (<$FILE>) { 10000a920b5bSAndy Whitcroft chomp; 100100df344fSAndy Whitcroft push(@rawlines, $_); 10026c72ffaaSAndy Whitcroft } 100321caa13cSAndy Whitcroft close($FILE); 1004d8469f16SJoe Perches 1005d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 1006d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1007d8469f16SJoe Perches print "$vname\n"; 1008d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1009d8469f16SJoe Perches } 1010d8469f16SJoe Perches 1011c2fdda0dSAndy Whitcroft if (!process($filename)) { 10120a920b5bSAndy Whitcroft $exit = 1; 10130a920b5bSAndy Whitcroft } 101400df344fSAndy Whitcroft @rawlines = (); 101513214adfSAndy Whitcroft @lines = (); 10163705ce5bSJoe Perches @fixed = (); 1017d752fcc8SJoe Perches @fixed_inserted = (); 1018d752fcc8SJoe Perches @fixed_deleted = (); 1019194f66fcSJoe Perches $fixlinenr = -1; 1020485ff23eSAlex Dowad @modifierListFile = (); 1021485ff23eSAlex Dowad @typeListFile = (); 1022485ff23eSAlex Dowad build_types(); 10230a920b5bSAndy Whitcroft} 10240a920b5bSAndy Whitcroft 1025d8469f16SJoe Perchesif (!$quiet) { 10263c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 10273c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 10283c816e49SJoe Perches 1029d8469f16SJoe Perches if ($^V lt 5.10.0) { 1030d8469f16SJoe Perches print << "EOM" 1031d8469f16SJoe Perches 1032d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 1033d8469f16SJoe Perches An upgrade to at least perl v5.10.0 is suggested. 1034d8469f16SJoe PerchesEOM 1035d8469f16SJoe Perches } 1036d8469f16SJoe Perches if ($exit) { 1037d8469f16SJoe Perches print << "EOM" 1038d8469f16SJoe Perches 1039d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 1040d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 1041d8469f16SJoe PerchesEOM 1042d8469f16SJoe Perches } 1043d8469f16SJoe Perches} 1044d8469f16SJoe Perches 10450a920b5bSAndy Whitcroftexit($exit); 10460a920b5bSAndy Whitcroft 10470a920b5bSAndy Whitcroftsub top_of_kernel_tree { 10486c72ffaaSAndy Whitcroft my ($root) = @_; 10496c72ffaaSAndy Whitcroft 10506c72ffaaSAndy Whitcroft my @tree_check = ( 10516c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 10526c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 10536c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 10546c72ffaaSAndy Whitcroft ); 10556c72ffaaSAndy Whitcroft 10566c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 10576c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 10580a920b5bSAndy Whitcroft return 0; 10590a920b5bSAndy Whitcroft } 10606c72ffaaSAndy Whitcroft } 10616c72ffaaSAndy Whitcroft return 1; 10626c72ffaaSAndy Whitcroft} 10630a920b5bSAndy Whitcroft 106420112475SJoe Perchessub parse_email { 106520112475SJoe Perches my ($formatted_email) = @_; 106620112475SJoe Perches 106720112475SJoe Perches my $name = ""; 106820112475SJoe Perches my $address = ""; 106920112475SJoe Perches my $comment = ""; 107020112475SJoe Perches 107120112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 107220112475SJoe Perches $name = $1; 107320112475SJoe Perches $address = $2; 107420112475SJoe Perches $comment = $3 if defined $3; 107520112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 107620112475SJoe Perches $address = $1; 107720112475SJoe Perches $comment = $2 if defined $2; 107820112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 107920112475SJoe Perches $address = $1; 108020112475SJoe Perches $comment = $2 if defined $2; 108185e12066SJoe Perches $formatted_email =~ s/\Q$address\E.*$//; 108220112475SJoe Perches $name = $formatted_email; 10833705ce5bSJoe Perches $name = trim($name); 108420112475SJoe Perches $name =~ s/^\"|\"$//g; 108520112475SJoe Perches # If there's a name left after stripping spaces and 108620112475SJoe Perches # leading quotes, and the address doesn't have both 108720112475SJoe Perches # leading and trailing angle brackets, the address 108820112475SJoe Perches # is invalid. ie: 108920112475SJoe Perches # "joe smith [email protected]" bad 109020112475SJoe Perches # "joe smith <[email protected]" bad 109120112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 109220112475SJoe Perches $name = ""; 109320112475SJoe Perches $address = ""; 109420112475SJoe Perches $comment = ""; 109520112475SJoe Perches } 109620112475SJoe Perches } 109720112475SJoe Perches 10983705ce5bSJoe Perches $name = trim($name); 109920112475SJoe Perches $name =~ s/^\"|\"$//g; 11003705ce5bSJoe Perches $address = trim($address); 110120112475SJoe Perches $address =~ s/^\<|\>$//g; 110220112475SJoe Perches 110320112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 110420112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 110520112475SJoe Perches $name = "\"$name\""; 110620112475SJoe Perches } 110720112475SJoe Perches 110820112475SJoe Perches return ($name, $address, $comment); 110920112475SJoe Perches} 111020112475SJoe Perches 111120112475SJoe Perchessub format_email { 111220112475SJoe Perches my ($name, $address) = @_; 111320112475SJoe Perches 111420112475SJoe Perches my $formatted_email; 111520112475SJoe Perches 11163705ce5bSJoe Perches $name = trim($name); 111720112475SJoe Perches $name =~ s/^\"|\"$//g; 11183705ce5bSJoe Perches $address = trim($address); 111920112475SJoe Perches 112020112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 112120112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 112220112475SJoe Perches $name = "\"$name\""; 112320112475SJoe Perches } 112420112475SJoe Perches 112520112475SJoe Perches if ("$name" eq "") { 112620112475SJoe Perches $formatted_email = "$address"; 112720112475SJoe Perches } else { 112820112475SJoe Perches $formatted_email = "$name <$address>"; 112920112475SJoe Perches } 113020112475SJoe Perches 113120112475SJoe Perches return $formatted_email; 113220112475SJoe Perches} 113320112475SJoe Perches 1134d311cd44SJoe Perchessub which { 1135d311cd44SJoe Perches my ($bin) = @_; 1136d311cd44SJoe Perches 1137d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1138d311cd44SJoe Perches if (-e "$path/$bin") { 1139d311cd44SJoe Perches return "$path/$bin"; 1140d311cd44SJoe Perches } 1141d311cd44SJoe Perches } 1142d311cd44SJoe Perches 1143d311cd44SJoe Perches return ""; 1144d311cd44SJoe Perches} 1145d311cd44SJoe Perches 1146000d1cc1SJoe Perchessub which_conf { 1147000d1cc1SJoe Perches my ($conf) = @_; 1148000d1cc1SJoe Perches 1149000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1150000d1cc1SJoe Perches if (-e "$path/$conf") { 1151000d1cc1SJoe Perches return "$path/$conf"; 1152000d1cc1SJoe Perches } 1153000d1cc1SJoe Perches } 1154000d1cc1SJoe Perches 1155000d1cc1SJoe Perches return ""; 1156000d1cc1SJoe Perches} 1157000d1cc1SJoe Perches 11580a920b5bSAndy Whitcroftsub expand_tabs { 11590a920b5bSAndy Whitcroft my ($str) = @_; 11600a920b5bSAndy Whitcroft 11610a920b5bSAndy Whitcroft my $res = ''; 11620a920b5bSAndy Whitcroft my $n = 0; 11630a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 11640a920b5bSAndy Whitcroft if ($c eq "\t") { 11650a920b5bSAndy Whitcroft $res .= ' '; 11660a920b5bSAndy Whitcroft $n++; 11670a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 11680a920b5bSAndy Whitcroft $res .= ' '; 11690a920b5bSAndy Whitcroft } 11700a920b5bSAndy Whitcroft next; 11710a920b5bSAndy Whitcroft } 11720a920b5bSAndy Whitcroft $res .= $c; 11730a920b5bSAndy Whitcroft $n++; 11740a920b5bSAndy Whitcroft } 11750a920b5bSAndy Whitcroft 11760a920b5bSAndy Whitcroft return $res; 11770a920b5bSAndy Whitcroft} 11786c72ffaaSAndy Whitcroftsub copy_spacing { 1179773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 11806c72ffaaSAndy Whitcroft return $res; 11816c72ffaaSAndy Whitcroft} 11820a920b5bSAndy Whitcroft 11834a0df2efSAndy Whitcroftsub line_stats { 11844a0df2efSAndy Whitcroft my ($line) = @_; 11854a0df2efSAndy Whitcroft 11864a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 11874a0df2efSAndy Whitcroft $line =~ s/^.//; 11884a0df2efSAndy Whitcroft $line = expand_tabs($line); 11894a0df2efSAndy Whitcroft 11904a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 11914a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 11924a0df2efSAndy Whitcroft 11934a0df2efSAndy Whitcroft return (length($line), length($white)); 11944a0df2efSAndy Whitcroft} 11954a0df2efSAndy Whitcroft 1196773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1197773647a0SAndy Whitcroft 1198773647a0SAndy Whitcroftsub sanitise_line_reset { 1199773647a0SAndy Whitcroft my ($in_comment) = @_; 1200773647a0SAndy Whitcroft 1201773647a0SAndy Whitcroft if ($in_comment) { 1202773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1203773647a0SAndy Whitcroft } else { 1204773647a0SAndy Whitcroft $sanitise_quote = ''; 1205773647a0SAndy Whitcroft } 1206773647a0SAndy Whitcroft} 120700df344fSAndy Whitcroftsub sanitise_line { 120800df344fSAndy Whitcroft my ($line) = @_; 120900df344fSAndy Whitcroft 121000df344fSAndy Whitcroft my $res = ''; 121100df344fSAndy Whitcroft my $l = ''; 121200df344fSAndy Whitcroft 1213c2fdda0dSAndy Whitcroft my $qlen = 0; 1214773647a0SAndy Whitcroft my $off = 0; 1215773647a0SAndy Whitcroft my $c; 121600df344fSAndy Whitcroft 1217773647a0SAndy Whitcroft # Always copy over the diff marker. 1218773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1219773647a0SAndy Whitcroft 1220773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1221773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1222773647a0SAndy Whitcroft 12238d2e11b2SClaudio Fontana # Comments we are whacking completely including the begin 1224773647a0SAndy Whitcroft # and end, all to $;. 1225773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1226773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1227773647a0SAndy Whitcroft 1228773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1229773647a0SAndy Whitcroft $off++; 123000df344fSAndy Whitcroft next; 1231773647a0SAndy Whitcroft } 123281bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1233773647a0SAndy Whitcroft $sanitise_quote = ''; 1234773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1235773647a0SAndy Whitcroft $off++; 1236773647a0SAndy Whitcroft next; 1237773647a0SAndy Whitcroft } 1238113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1239113f04a8SDaniel Walker $sanitise_quote = '//'; 1240113f04a8SDaniel Walker 1241113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1242113f04a8SDaniel Walker $off++; 1243113f04a8SDaniel Walker next; 1244113f04a8SDaniel Walker } 1245773647a0SAndy Whitcroft 1246773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1247773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1248773647a0SAndy Whitcroft $c eq "\\") { 1249773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1250773647a0SAndy Whitcroft $off++; 1251773647a0SAndy Whitcroft next; 1252773647a0SAndy Whitcroft } 1253773647a0SAndy Whitcroft # Regular quotes. 1254773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1255773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1256773647a0SAndy Whitcroft $sanitise_quote = $c; 1257773647a0SAndy Whitcroft 1258773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1259773647a0SAndy Whitcroft next; 1260773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1261773647a0SAndy Whitcroft $sanitise_quote = ''; 126200df344fSAndy Whitcroft } 126300df344fSAndy Whitcroft } 1264773647a0SAndy Whitcroft 1265fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1266773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1267773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1268113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1269113f04a8SDaniel Walker substr($res, $off, 1, $;); 1270773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1271773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 127200df344fSAndy Whitcroft } else { 1273773647a0SAndy Whitcroft substr($res, $off, 1, $c); 127400df344fSAndy Whitcroft } 1275c2fdda0dSAndy Whitcroft } 1276c2fdda0dSAndy Whitcroft 1277113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1278113f04a8SDaniel Walker $sanitise_quote = ''; 1279113f04a8SDaniel Walker } 1280113f04a8SDaniel Walker 1281c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1282c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1283c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1284c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1285c2fdda0dSAndy Whitcroft 1286c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1287c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1288c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1289c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1290c2fdda0dSAndy Whitcroft } 1291c2fdda0dSAndy Whitcroft 1292dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1293dadf680dSJoe Perches my $match = $1; 1294dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1295dadf680dSJoe Perches } 1296dadf680dSJoe Perches 129700df344fSAndy Whitcroft return $res; 129800df344fSAndy Whitcroft} 129900df344fSAndy Whitcroft 1300a6962d72SJoe Perchessub get_quoted_string { 1301a6962d72SJoe Perches my ($line, $rawline) = @_; 1302a6962d72SJoe Perches 1303478b1799SJoe Perches return "" if (!defined($line) || !defined($rawline)); 130433acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1305a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1306a6962d72SJoe Perches} 1307a6962d72SJoe Perches 13088905a67cSAndy Whitcroftsub ctx_statement_block { 13098905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 13108905a67cSAndy Whitcroft my $line = $linenr - 1; 13118905a67cSAndy Whitcroft my $blk = ''; 13128905a67cSAndy Whitcroft my $soff = $off; 13138905a67cSAndy Whitcroft my $coff = $off - 1; 1314773647a0SAndy Whitcroft my $coff_set = 0; 13158905a67cSAndy Whitcroft 131613214adfSAndy Whitcroft my $loff = 0; 131713214adfSAndy Whitcroft 13188905a67cSAndy Whitcroft my $type = ''; 13198905a67cSAndy Whitcroft my $level = 0; 1320a2750645SAndy Whitcroft my @stack = (); 1321cf655043SAndy Whitcroft my $p; 13228905a67cSAndy Whitcroft my $c; 13238905a67cSAndy Whitcroft my $len = 0; 132413214adfSAndy Whitcroft 132513214adfSAndy Whitcroft my $remainder; 13268905a67cSAndy Whitcroft while (1) { 1327a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1328a2750645SAndy Whitcroft 1329773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 13308905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 13318905a67cSAndy Whitcroft # context. 13328905a67cSAndy Whitcroft if ($off >= $len) { 13338905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1334dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1335c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 13368905a67cSAndy Whitcroft $remain--; 133713214adfSAndy Whitcroft $loff = $len; 1338c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 13398905a67cSAndy Whitcroft $len = length($blk); 13408905a67cSAndy Whitcroft $line++; 13418905a67cSAndy Whitcroft last; 13428905a67cSAndy Whitcroft } 13438905a67cSAndy Whitcroft # Bail if there is no further context. 13448905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 134513214adfSAndy Whitcroft if ($off >= $len) { 13468905a67cSAndy Whitcroft last; 13478905a67cSAndy Whitcroft } 1348f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1349f74bd194SAndy Whitcroft $level++; 1350f74bd194SAndy Whitcroft $type = '#'; 1351f74bd194SAndy Whitcroft } 13528905a67cSAndy Whitcroft } 1353cf655043SAndy Whitcroft $p = $c; 13548905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 135513214adfSAndy Whitcroft $remainder = substr($blk, $off); 13568905a67cSAndy Whitcroft 1357773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 13584635f4fbSAndy Whitcroft 13594635f4fbSAndy Whitcroft # Handle nested #if/#else. 13604635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 13614635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 13624635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 13634635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 13644635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 13654635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 13664635f4fbSAndy Whitcroft } 13674635f4fbSAndy Whitcroft 13688905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 13698905a67cSAndy Whitcroft # outermost level. 13708905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 13718905a67cSAndy Whitcroft last; 13728905a67cSAndy Whitcroft } 13738905a67cSAndy Whitcroft 137413214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1375773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1376773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1377773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1378773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1379773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1380773647a0SAndy Whitcroft $coff_set = 1; 1381773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1382773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 138313214adfSAndy Whitcroft } 138413214adfSAndy Whitcroft 13858905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 13868905a67cSAndy Whitcroft $level++; 13878905a67cSAndy Whitcroft $type = '('; 13888905a67cSAndy Whitcroft } 13898905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 13908905a67cSAndy Whitcroft $level--; 13918905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 13928905a67cSAndy Whitcroft 13938905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 13948905a67cSAndy Whitcroft $coff = $off; 1395773647a0SAndy Whitcroft $coff_set = 1; 1396773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 13978905a67cSAndy Whitcroft } 13988905a67cSAndy Whitcroft } 13998905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 14008905a67cSAndy Whitcroft $level++; 14018905a67cSAndy Whitcroft $type = '{'; 14028905a67cSAndy Whitcroft } 14038905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 14048905a67cSAndy Whitcroft $level--; 14058905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 14068905a67cSAndy Whitcroft 14078905a67cSAndy Whitcroft if ($level == 0) { 1408b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1409b998e001SPatrick Pannuto $off++; 1410b998e001SPatrick Pannuto } 14118905a67cSAndy Whitcroft last; 14128905a67cSAndy Whitcroft } 14138905a67cSAndy Whitcroft } 1414f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1415f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1416f74bd194SAndy Whitcroft $level--; 1417f74bd194SAndy Whitcroft $type = ''; 1418f74bd194SAndy Whitcroft $off++; 1419f74bd194SAndy Whitcroft last; 1420f74bd194SAndy Whitcroft } 14218905a67cSAndy Whitcroft $off++; 14228905a67cSAndy Whitcroft } 1423a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 142413214adfSAndy Whitcroft if ($off == $len) { 1425a3bb97a7SAndy Whitcroft $loff = $len + 1; 142613214adfSAndy Whitcroft $line++; 142713214adfSAndy Whitcroft $remain--; 142813214adfSAndy Whitcroft } 14298905a67cSAndy Whitcroft 14308905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 14318905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 14328905a67cSAndy Whitcroft 14338905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 14348905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 14358905a67cSAndy Whitcroft 1436773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 143713214adfSAndy Whitcroft 143813214adfSAndy Whitcroft return ($statement, $condition, 143913214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 144013214adfSAndy Whitcroft} 144113214adfSAndy Whitcroft 1442cf655043SAndy Whitcroftsub statement_lines { 1443cf655043SAndy Whitcroft my ($stmt) = @_; 1444cf655043SAndy Whitcroft 1445cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1446cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1447cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1448cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1449cf655043SAndy Whitcroft 1450cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1451cf655043SAndy Whitcroft 1452cf655043SAndy Whitcroft return $#stmt_lines + 2; 1453cf655043SAndy Whitcroft} 1454cf655043SAndy Whitcroft 1455cf655043SAndy Whitcroftsub statement_rawlines { 1456cf655043SAndy Whitcroft my ($stmt) = @_; 1457cf655043SAndy Whitcroft 1458cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1459cf655043SAndy Whitcroft 1460cf655043SAndy Whitcroft return $#stmt_lines + 2; 1461cf655043SAndy Whitcroft} 1462cf655043SAndy Whitcroft 1463cf655043SAndy Whitcroftsub statement_block_size { 1464cf655043SAndy Whitcroft my ($stmt) = @_; 1465cf655043SAndy Whitcroft 1466cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1467cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1468cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1469cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1470cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1471cf655043SAndy Whitcroft 1472cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1473cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1474cf655043SAndy Whitcroft 1475cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1476cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1477cf655043SAndy Whitcroft 1478cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1479cf655043SAndy Whitcroft return $stmt_lines; 1480cf655043SAndy Whitcroft } else { 1481cf655043SAndy Whitcroft return $stmt_statements; 1482cf655043SAndy Whitcroft } 1483cf655043SAndy Whitcroft} 1484cf655043SAndy Whitcroft 148513214adfSAndy Whitcroftsub ctx_statement_full { 148613214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 148713214adfSAndy Whitcroft my ($statement, $condition, $level); 148813214adfSAndy Whitcroft 148913214adfSAndy Whitcroft my (@chunks); 149013214adfSAndy Whitcroft 1491cf655043SAndy Whitcroft # Grab the first conditional/block pair. 149213214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 149313214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1494773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 149513214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1496cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1497cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1498cf655043SAndy Whitcroft } 1499cf655043SAndy Whitcroft 1500cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1501cf655043SAndy Whitcroft # could continue the statement. 1502cf655043SAndy Whitcroft for (;;) { 150313214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 150413214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1505cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1506773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1507cf655043SAndy Whitcroft #print "C: push\n"; 1508cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 150913214adfSAndy Whitcroft } 151013214adfSAndy Whitcroft 151113214adfSAndy Whitcroft return ($level, $linenr, @chunks); 15128905a67cSAndy Whitcroft} 15138905a67cSAndy Whitcroft 15144a0df2efSAndy Whitcroftsub ctx_block_get { 1515f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 15164a0df2efSAndy Whitcroft my $line; 15174a0df2efSAndy Whitcroft my $start = $linenr - 1; 15184a0df2efSAndy Whitcroft my $blk = ''; 15194a0df2efSAndy Whitcroft my @o; 15204a0df2efSAndy Whitcroft my @c; 15214a0df2efSAndy Whitcroft my @res = (); 15224a0df2efSAndy Whitcroft 1523f0a594c1SAndy Whitcroft my $level = 0; 15244635f4fbSAndy Whitcroft my @stack = ($level); 152500df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 152600df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 152700df344fSAndy Whitcroft $remain--; 152800df344fSAndy Whitcroft 152900df344fSAndy Whitcroft $blk .= $rawlines[$line]; 15304635f4fbSAndy Whitcroft 15314635f4fbSAndy Whitcroft # Handle nested #if/#else. 153201464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 15334635f4fbSAndy Whitcroft push(@stack, $level); 153401464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 15354635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 153601464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 15374635f4fbSAndy Whitcroft $level = pop(@stack); 15384635f4fbSAndy Whitcroft } 15394635f4fbSAndy Whitcroft 154001464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1541f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1542f0a594c1SAndy Whitcroft if ($off > 0) { 1543f0a594c1SAndy Whitcroft $off--; 1544f0a594c1SAndy Whitcroft next; 1545f0a594c1SAndy Whitcroft } 15464a0df2efSAndy Whitcroft 1547f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1548f0a594c1SAndy Whitcroft $level--; 1549f0a594c1SAndy Whitcroft last if ($level == 0); 1550f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1551f0a594c1SAndy Whitcroft $level++; 1552f0a594c1SAndy Whitcroft } 1553f0a594c1SAndy Whitcroft } 15544a0df2efSAndy Whitcroft 1555f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 155600df344fSAndy Whitcroft push(@res, $rawlines[$line]); 15574a0df2efSAndy Whitcroft } 15584a0df2efSAndy Whitcroft 1559f0a594c1SAndy Whitcroft last if ($level == 0); 15604a0df2efSAndy Whitcroft } 15614a0df2efSAndy Whitcroft 1562f0a594c1SAndy Whitcroft return ($level, @res); 15634a0df2efSAndy Whitcroft} 15644a0df2efSAndy Whitcroftsub ctx_block_outer { 15654a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 15664a0df2efSAndy Whitcroft 1567f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1568f0a594c1SAndy Whitcroft return @r; 15694a0df2efSAndy Whitcroft} 15704a0df2efSAndy Whitcroftsub ctx_block { 15714a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 15724a0df2efSAndy Whitcroft 1573f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1574f0a594c1SAndy Whitcroft return @r; 1575653d4876SAndy Whitcroft} 1576653d4876SAndy Whitcroftsub ctx_statement { 1577f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1578f0a594c1SAndy Whitcroft 1579f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1580f0a594c1SAndy Whitcroft return @r; 1581f0a594c1SAndy Whitcroft} 1582f0a594c1SAndy Whitcroftsub ctx_block_level { 1583653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1584653d4876SAndy Whitcroft 1585f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 15864a0df2efSAndy Whitcroft} 15879c0ca6f9SAndy Whitcroftsub ctx_statement_level { 15889c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 15899c0ca6f9SAndy Whitcroft 15909c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 15919c0ca6f9SAndy Whitcroft} 15924a0df2efSAndy Whitcroft 15934a0df2efSAndy Whitcroftsub ctx_locate_comment { 15944a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 15954a0df2efSAndy Whitcroft 15964a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1597beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 15984a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 15994a0df2efSAndy Whitcroft 16004a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 16014a0df2efSAndy Whitcroft # comment. 16024a0df2efSAndy Whitcroft my $in_comment = 0; 16034a0df2efSAndy Whitcroft $current_comment = ''; 16044a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 160500df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 160600df344fSAndy Whitcroft #warn " $line\n"; 16074a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 16084a0df2efSAndy Whitcroft $in_comment = 1; 16094a0df2efSAndy Whitcroft } 16104a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 16114a0df2efSAndy Whitcroft $in_comment = 1; 16124a0df2efSAndy Whitcroft } 16134a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 16144a0df2efSAndy Whitcroft $current_comment = ''; 16154a0df2efSAndy Whitcroft } 16164a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 16174a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 16184a0df2efSAndy Whitcroft $in_comment = 0; 16194a0df2efSAndy Whitcroft } 16204a0df2efSAndy Whitcroft } 16214a0df2efSAndy Whitcroft 16224a0df2efSAndy Whitcroft chomp($current_comment); 16234a0df2efSAndy Whitcroft return($current_comment); 16244a0df2efSAndy Whitcroft} 16254a0df2efSAndy Whitcroftsub ctx_has_comment { 16264a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 16274a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 16284a0df2efSAndy Whitcroft 162900df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 16304a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 16314a0df2efSAndy Whitcroft 16324a0df2efSAndy Whitcroft return ($cmt ne ''); 16334a0df2efSAndy Whitcroft} 16344a0df2efSAndy Whitcroft 16354d001e4dSAndy Whitcroftsub raw_line { 16364d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 16374d001e4dSAndy Whitcroft 16384d001e4dSAndy Whitcroft my $offset = $linenr - 1; 16394d001e4dSAndy Whitcroft $cnt++; 16404d001e4dSAndy Whitcroft 16414d001e4dSAndy Whitcroft my $line; 16424d001e4dSAndy Whitcroft while ($cnt) { 16434d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 16444d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 16454d001e4dSAndy Whitcroft $cnt--; 16464d001e4dSAndy Whitcroft } 16474d001e4dSAndy Whitcroft 16484d001e4dSAndy Whitcroft return $line; 16494d001e4dSAndy Whitcroft} 16504d001e4dSAndy Whitcroft 16512a9f9d85STobin C. Hardingsub get_stat_real { 16522a9f9d85STobin C. Harding my ($linenr, $lc) = @_; 16532a9f9d85STobin C. Harding 16542a9f9d85STobin C. Harding my $stat_real = raw_line($linenr, 0); 16552a9f9d85STobin C. Harding for (my $count = $linenr + 1; $count <= $lc; $count++) { 16562a9f9d85STobin C. Harding $stat_real = $stat_real . "\n" . raw_line($count, 0); 16572a9f9d85STobin C. Harding } 16582a9f9d85STobin C. Harding 16592a9f9d85STobin C. Harding return $stat_real; 16602a9f9d85STobin C. Harding} 16612a9f9d85STobin C. Harding 1662e3d95a2aSTobin C. Hardingsub get_stat_here { 1663e3d95a2aSTobin C. Harding my ($linenr, $cnt, $here) = @_; 1664e3d95a2aSTobin C. Harding 1665e3d95a2aSTobin C. Harding my $herectx = $here . "\n"; 1666e3d95a2aSTobin C. Harding for (my $n = 0; $n < $cnt; $n++) { 1667e3d95a2aSTobin C. Harding $herectx .= raw_line($linenr, $n) . "\n"; 1668e3d95a2aSTobin C. Harding } 1669e3d95a2aSTobin C. Harding 1670e3d95a2aSTobin C. Harding return $herectx; 1671e3d95a2aSTobin C. Harding} 1672e3d95a2aSTobin C. Harding 16730a920b5bSAndy Whitcroftsub cat_vet { 16740a920b5bSAndy Whitcroft my ($vet) = @_; 16759c0ca6f9SAndy Whitcroft my ($res, $coded); 16760a920b5bSAndy Whitcroft 16779c0ca6f9SAndy Whitcroft $res = ''; 16786c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 16796c72ffaaSAndy Whitcroft $res .= $1; 16806c72ffaaSAndy Whitcroft if ($2 ne '') { 16819c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 16826c72ffaaSAndy Whitcroft $res .= $coded; 16836c72ffaaSAndy Whitcroft } 16849c0ca6f9SAndy Whitcroft } 16859c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 16860a920b5bSAndy Whitcroft 16879c0ca6f9SAndy Whitcroft return $res; 16880a920b5bSAndy Whitcroft} 16890a920b5bSAndy Whitcroft 1690c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1691cf655043SAndy Whitcroftmy $av_pending; 1692c2fdda0dSAndy Whitcroftmy @av_paren_type; 16931f65f947SAndy Whitcroftmy $av_pend_colon; 1694c2fdda0dSAndy Whitcroft 1695c2fdda0dSAndy Whitcroftsub annotate_reset { 1696c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1697cf655043SAndy Whitcroft $av_pending = '_'; 1698cf655043SAndy Whitcroft @av_paren_type = ('E'); 16991f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1700c2fdda0dSAndy Whitcroft} 1701c2fdda0dSAndy Whitcroft 17026c72ffaaSAndy Whitcroftsub annotate_values { 17036c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 17046c72ffaaSAndy Whitcroft 17056c72ffaaSAndy Whitcroft my $res; 17061f65f947SAndy Whitcroft my $var = '_' x length($stream); 17076c72ffaaSAndy Whitcroft my $cur = $stream; 17086c72ffaaSAndy Whitcroft 1709c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 17106c72ffaaSAndy Whitcroft 17116c72ffaaSAndy Whitcroft while (length($cur)) { 1712773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1713cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1714171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 17156c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1716c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1717c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1718cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1719c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 17206c72ffaaSAndy Whitcroft } 17216c72ffaaSAndy Whitcroft 1722c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 17239446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 17249446ef56SAndy Whitcroft push(@av_paren_type, $type); 1725addcdceaSAndy Whitcroft $type = 'c'; 17269446ef56SAndy Whitcroft 1727e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1728c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 17296c72ffaaSAndy Whitcroft $type = 'T'; 17306c72ffaaSAndy Whitcroft 1731389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1732389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1733389a2fe5SAndy Whitcroft $type = 'T'; 1734389a2fe5SAndy Whitcroft 1735c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1736171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1737c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1738171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1739171ae1a4SAndy Whitcroft if ($2 ne '') { 1740cf655043SAndy Whitcroft $av_pending = 'N'; 1741171ae1a4SAndy Whitcroft } 1742171ae1a4SAndy Whitcroft $type = 'E'; 1743171ae1a4SAndy Whitcroft 1744c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1745171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1746171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1747171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 17486c72ffaaSAndy Whitcroft 1749c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1750cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1751c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1752cf655043SAndy Whitcroft 1753cf655043SAndy Whitcroft push(@av_paren_type, $type); 1754cf655043SAndy Whitcroft push(@av_paren_type, $type); 1755171ae1a4SAndy Whitcroft $type = 'E'; 1756cf655043SAndy Whitcroft 1757c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1758cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1759cf655043SAndy Whitcroft $av_preprocessor = 1; 1760cf655043SAndy Whitcroft 1761cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1762cf655043SAndy Whitcroft 1763171ae1a4SAndy Whitcroft $type = 'E'; 1764cf655043SAndy Whitcroft 1765c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1766cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1767cf655043SAndy Whitcroft 1768cf655043SAndy Whitcroft $av_preprocessor = 1; 1769cf655043SAndy Whitcroft 1770cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1771cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1772cf655043SAndy Whitcroft pop(@av_paren_type); 1773cf655043SAndy Whitcroft push(@av_paren_type, $type); 1774171ae1a4SAndy Whitcroft $type = 'E'; 17756c72ffaaSAndy Whitcroft 17766c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1777c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 17786c72ffaaSAndy Whitcroft 1779171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1780171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1781171ae1a4SAndy Whitcroft $av_pending = $type; 1782171ae1a4SAndy Whitcroft $type = 'N'; 1783171ae1a4SAndy Whitcroft 17846c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1785c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 17866c72ffaaSAndy Whitcroft if (defined $2) { 1787cf655043SAndy Whitcroft $av_pending = 'V'; 17886c72ffaaSAndy Whitcroft } 17896c72ffaaSAndy Whitcroft $type = 'N'; 17906c72ffaaSAndy Whitcroft 179114b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1792c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 179314b111c1SAndy Whitcroft $av_pending = 'E'; 17946c72ffaaSAndy Whitcroft $type = 'N'; 17956c72ffaaSAndy Whitcroft 17961f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 17971f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 17981f65f947SAndy Whitcroft $av_pend_colon = 'C'; 17991f65f947SAndy Whitcroft $type = 'N'; 18001f65f947SAndy Whitcroft 180114b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1802c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 18036c72ffaaSAndy Whitcroft $type = 'N'; 18046c72ffaaSAndy Whitcroft 18056c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1806c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1807cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1808cf655043SAndy Whitcroft $av_pending = '_'; 18096c72ffaaSAndy Whitcroft $type = 'N'; 18106c72ffaaSAndy Whitcroft 18116c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1812cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1813cf655043SAndy Whitcroft if ($new_type ne '_') { 1814cf655043SAndy Whitcroft $type = $new_type; 1815c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1816c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 18176c72ffaaSAndy Whitcroft } else { 1818c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 18196c72ffaaSAndy Whitcroft } 18206c72ffaaSAndy Whitcroft 1821c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1822c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1823c8cb2ca3SAndy Whitcroft $type = 'V'; 1824cf655043SAndy Whitcroft $av_pending = 'V'; 18256c72ffaaSAndy Whitcroft 18268e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 18278e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 18281f65f947SAndy Whitcroft $av_pend_colon = 'B'; 18298e761b04SAndy Whitcroft } elsif ($type eq 'E') { 18308e761b04SAndy Whitcroft $av_pend_colon = 'L'; 18311f65f947SAndy Whitcroft } 18321f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 18331f65f947SAndy Whitcroft $type = 'V'; 18341f65f947SAndy Whitcroft 18356c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1836c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 18376c72ffaaSAndy Whitcroft $type = 'V'; 18386c72ffaaSAndy Whitcroft 18396c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1840c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 18416c72ffaaSAndy Whitcroft $type = 'N'; 18426c72ffaaSAndy Whitcroft 1843cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1844c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 184513214adfSAndy Whitcroft $type = 'E'; 18461f65f947SAndy Whitcroft $av_pend_colon = 'O'; 184713214adfSAndy Whitcroft 18488e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 18498e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 18508e761b04SAndy Whitcroft $type = 'C'; 18518e761b04SAndy Whitcroft 18521f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 18531f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 18541f65f947SAndy Whitcroft $type = 'N'; 18551f65f947SAndy Whitcroft 18561f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 18571f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 18581f65f947SAndy Whitcroft 18591f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 18601f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 18611f65f947SAndy Whitcroft $type = 'E'; 18621f65f947SAndy Whitcroft } else { 18631f65f947SAndy Whitcroft $type = 'N'; 18641f65f947SAndy Whitcroft } 18651f65f947SAndy Whitcroft $av_pend_colon = 'O'; 18661f65f947SAndy Whitcroft 18678e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 186813214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 18696c72ffaaSAndy Whitcroft $type = 'N'; 18706c72ffaaSAndy Whitcroft 18710d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 187274048ed8SAndy Whitcroft my $variant; 187374048ed8SAndy Whitcroft 187474048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 187574048ed8SAndy Whitcroft if ($type eq 'V') { 187674048ed8SAndy Whitcroft $variant = 'B'; 187774048ed8SAndy Whitcroft } else { 187874048ed8SAndy Whitcroft $variant = 'U'; 187974048ed8SAndy Whitcroft } 188074048ed8SAndy Whitcroft 188174048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 188274048ed8SAndy Whitcroft $type = 'N'; 188374048ed8SAndy Whitcroft 18846c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1885c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 18866c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 18876c72ffaaSAndy Whitcroft $type = 'N'; 18886c72ffaaSAndy Whitcroft } 18896c72ffaaSAndy Whitcroft 18906c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1891c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 18926c72ffaaSAndy Whitcroft } 18936c72ffaaSAndy Whitcroft if (defined $1) { 18946c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 18956c72ffaaSAndy Whitcroft $res .= $type x length($1); 18966c72ffaaSAndy Whitcroft } 18976c72ffaaSAndy Whitcroft } 18986c72ffaaSAndy Whitcroft 18991f65f947SAndy Whitcroft return ($res, $var); 19006c72ffaaSAndy Whitcroft} 19016c72ffaaSAndy Whitcroft 19028905a67cSAndy Whitcroftsub possible { 190313214adfSAndy Whitcroft my ($possible, $line) = @_; 19049a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 19050776e594SAndy Whitcroft ^(?: 19060776e594SAndy Whitcroft $Modifier| 19070776e594SAndy Whitcroft $Storage| 19080776e594SAndy Whitcroft $Type| 19099a974fdbSAndy Whitcroft DEFINE_\S+ 19109a974fdbSAndy Whitcroft )$| 19119a974fdbSAndy Whitcroft ^(?: 19120776e594SAndy Whitcroft goto| 19130776e594SAndy Whitcroft return| 19140776e594SAndy Whitcroft case| 19150776e594SAndy Whitcroft else| 19160776e594SAndy Whitcroft asm|__asm__| 191789a88353SAndy Whitcroft do| 191889a88353SAndy Whitcroft \#| 191989a88353SAndy Whitcroft \#\#| 19209a974fdbSAndy Whitcroft )(?:\s|$)| 19210776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 19229a974fdbSAndy Whitcroft )}x; 19239a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 19249a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1925c45dcabdSAndy Whitcroft # Check for modifiers. 1926c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1927c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1928c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1929c45dcabdSAndy Whitcroft 1930c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1931c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1932d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 19339a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1934d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1935485ff23eSAlex Dowad push(@modifierListFile, $modifier); 1936d2506586SAndy Whitcroft } 19379a974fdbSAndy Whitcroft } 1938c45dcabdSAndy Whitcroft 1939c45dcabdSAndy Whitcroft } else { 194013214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 1941485ff23eSAlex Dowad push(@typeListFile, $possible); 1942c45dcabdSAndy Whitcroft } 19438905a67cSAndy Whitcroft build_types(); 19440776e594SAndy Whitcroft } else { 19450776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 19468905a67cSAndy Whitcroft } 19478905a67cSAndy Whitcroft} 19488905a67cSAndy Whitcroft 19496c72ffaaSAndy Whitcroftmy $prefix = ''; 19506c72ffaaSAndy Whitcroft 1951000d1cc1SJoe Perchessub show_type { 1952cbec18afSJoe Perches my ($type) = @_; 195391bfe484SJoe Perches 1954522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 1955522b837cSAlexey Dobriyan 1956cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1957cbec18afSJoe Perches 1958cbec18afSJoe Perches return !defined $ignore_type{$type}; 1959000d1cc1SJoe Perches} 1960000d1cc1SJoe Perches 1961f0a594c1SAndy Whitcroftsub report { 1962cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1963cbec18afSJoe Perches 1964cbec18afSJoe Perches if (!show_type($type) || 1965cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1966773647a0SAndy Whitcroft return 0; 1967773647a0SAndy Whitcroft } 196857230297SJoe Perches my $output = ''; 1969737c0767SJohn Brooks if ($color) { 197057230297SJoe Perches if ($level eq 'ERROR') { 197157230297SJoe Perches $output .= RED; 197257230297SJoe Perches } elsif ($level eq 'WARNING') { 197357230297SJoe Perches $output .= YELLOW; 1974000d1cc1SJoe Perches } else { 197557230297SJoe Perches $output .= GREEN; 1976000d1cc1SJoe Perches } 197757230297SJoe Perches } 197857230297SJoe Perches $output .= $prefix . $level . ':'; 197957230297SJoe Perches if ($show_types) { 1980737c0767SJohn Brooks $output .= BLUE if ($color); 198157230297SJoe Perches $output .= "$type:"; 198257230297SJoe Perches } 1983737c0767SJohn Brooks $output .= RESET if ($color); 198457230297SJoe Perches $output .= ' ' . $msg . "\n"; 198534d8815fSJoe Perches 198634d8815fSJoe Perches if ($showfile) { 198734d8815fSJoe Perches my @lines = split("\n", $output, -1); 198834d8815fSJoe Perches splice(@lines, 1, 1); 198934d8815fSJoe Perches $output = join("\n", @lines); 199034d8815fSJoe Perches } 199157230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 19928905a67cSAndy Whitcroft 199357230297SJoe Perches push(our @report, $output); 1994773647a0SAndy Whitcroft 1995773647a0SAndy Whitcroft return 1; 1996f0a594c1SAndy Whitcroft} 1997cbec18afSJoe Perches 1998f0a594c1SAndy Whitcroftsub report_dump { 199913214adfSAndy Whitcroft our @report; 2000f0a594c1SAndy Whitcroft} 2001000d1cc1SJoe Perches 2002d752fcc8SJoe Perchessub fixup_current_range { 2003d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 2004d752fcc8SJoe Perches 2005d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 2006d752fcc8SJoe Perches my $o = $1; 2007d752fcc8SJoe Perches my $l = $2; 2008d752fcc8SJoe Perches my $no = $o + $offset; 2009d752fcc8SJoe Perches my $nl = $l + $length; 2010d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 2011d752fcc8SJoe Perches } 2012d752fcc8SJoe Perches} 2013d752fcc8SJoe Perches 2014d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 2015d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 2016d752fcc8SJoe Perches 2017d752fcc8SJoe Perches my $range_last_linenr = 0; 2018d752fcc8SJoe Perches my $delta_offset = 0; 2019d752fcc8SJoe Perches 2020d752fcc8SJoe Perches my $old_linenr = 0; 2021d752fcc8SJoe Perches my $new_linenr = 0; 2022d752fcc8SJoe Perches 2023d752fcc8SJoe Perches my $next_insert = 0; 2024d752fcc8SJoe Perches my $next_delete = 0; 2025d752fcc8SJoe Perches 2026d752fcc8SJoe Perches my @lines = (); 2027d752fcc8SJoe Perches 2028d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 2029d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 2030d752fcc8SJoe Perches 2031d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 2032d752fcc8SJoe Perches my $save_line = 1; 2033d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 2034323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2035d752fcc8SJoe Perches $delta_offset = 0; 2036d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2037d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 2038d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 2039d752fcc8SJoe Perches } 2040d752fcc8SJoe Perches 2041d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2042d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 2043d752fcc8SJoe Perches $save_line = 0; 2044d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2045d752fcc8SJoe Perches } 2046d752fcc8SJoe Perches 2047d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2048d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 2049d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 2050d752fcc8SJoe Perches $new_linenr++; 2051d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2052d752fcc8SJoe Perches } 2053d752fcc8SJoe Perches 2054d752fcc8SJoe Perches if ($save_line) { 2055d752fcc8SJoe Perches push(@lines, $line); 2056d752fcc8SJoe Perches $new_linenr++; 2057d752fcc8SJoe Perches } 2058d752fcc8SJoe Perches 2059d752fcc8SJoe Perches $old_linenr++; 2060d752fcc8SJoe Perches } 2061d752fcc8SJoe Perches 2062d752fcc8SJoe Perches return @lines; 2063d752fcc8SJoe Perches} 2064d752fcc8SJoe Perches 2065f2d7e4d4SJoe Perchessub fix_insert_line { 2066f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2067f2d7e4d4SJoe Perches 2068f2d7e4d4SJoe Perches my $inserted = { 2069f2d7e4d4SJoe Perches LINENR => $linenr, 2070f2d7e4d4SJoe Perches LINE => $line, 2071f2d7e4d4SJoe Perches }; 2072f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2073f2d7e4d4SJoe Perches} 2074f2d7e4d4SJoe Perches 2075f2d7e4d4SJoe Perchessub fix_delete_line { 2076f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2077f2d7e4d4SJoe Perches 2078f2d7e4d4SJoe Perches my $deleted = { 2079f2d7e4d4SJoe Perches LINENR => $linenr, 2080f2d7e4d4SJoe Perches LINE => $line, 2081f2d7e4d4SJoe Perches }; 2082f2d7e4d4SJoe Perches 2083f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2084f2d7e4d4SJoe Perches} 2085f2d7e4d4SJoe Perches 2086de7d4f0eSAndy Whitcroftsub ERROR { 2087cbec18afSJoe Perches my ($type, $msg) = @_; 2088cbec18afSJoe Perches 2089cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2090de7d4f0eSAndy Whitcroft our $clean = 0; 20916c72ffaaSAndy Whitcroft our $cnt_error++; 20923705ce5bSJoe Perches return 1; 2093de7d4f0eSAndy Whitcroft } 20943705ce5bSJoe Perches return 0; 2095773647a0SAndy Whitcroft} 2096de7d4f0eSAndy Whitcroftsub WARN { 2097cbec18afSJoe Perches my ($type, $msg) = @_; 2098cbec18afSJoe Perches 2099cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2100de7d4f0eSAndy Whitcroft our $clean = 0; 21016c72ffaaSAndy Whitcroft our $cnt_warn++; 21023705ce5bSJoe Perches return 1; 2103de7d4f0eSAndy Whitcroft } 21043705ce5bSJoe Perches return 0; 2105773647a0SAndy Whitcroft} 2106de7d4f0eSAndy Whitcroftsub CHK { 2107cbec18afSJoe Perches my ($type, $msg) = @_; 2108cbec18afSJoe Perches 2109cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2110de7d4f0eSAndy Whitcroft our $clean = 0; 21116c72ffaaSAndy Whitcroft our $cnt_chk++; 21123705ce5bSJoe Perches return 1; 21136c72ffaaSAndy Whitcroft } 21143705ce5bSJoe Perches return 0; 2115de7d4f0eSAndy Whitcroft} 2116de7d4f0eSAndy Whitcroft 21176ecd9674SAndy Whitcroftsub check_absolute_file { 21186ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 21196ecd9674SAndy Whitcroft my $file = $absolute; 21206ecd9674SAndy Whitcroft 21216ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 21226ecd9674SAndy Whitcroft 21236ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 21246ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 21256ecd9674SAndy Whitcroft if (-f "$root/$file") { 21266ecd9674SAndy Whitcroft ##print "file<$file>\n"; 21276ecd9674SAndy Whitcroft last; 21286ecd9674SAndy Whitcroft } 21296ecd9674SAndy Whitcroft } 21306ecd9674SAndy Whitcroft if (! -f _) { 21316ecd9674SAndy Whitcroft return 0; 21326ecd9674SAndy Whitcroft } 21336ecd9674SAndy Whitcroft 21346ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 21356ecd9674SAndy Whitcroft my $prefix = $absolute; 21366ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 21376ecd9674SAndy Whitcroft 21386ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 21396ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2140000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2141000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 21426ecd9674SAndy Whitcroft } 21436ecd9674SAndy Whitcroft} 21446ecd9674SAndy Whitcroft 21453705ce5bSJoe Perchessub trim { 21463705ce5bSJoe Perches my ($string) = @_; 21473705ce5bSJoe Perches 2148b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2149b34c648bSJoe Perches 2150b34c648bSJoe Perches return $string; 2151b34c648bSJoe Perches} 2152b34c648bSJoe Perches 2153b34c648bSJoe Perchessub ltrim { 2154b34c648bSJoe Perches my ($string) = @_; 2155b34c648bSJoe Perches 2156b34c648bSJoe Perches $string =~ s/^\s+//; 2157b34c648bSJoe Perches 2158b34c648bSJoe Perches return $string; 2159b34c648bSJoe Perches} 2160b34c648bSJoe Perches 2161b34c648bSJoe Perchessub rtrim { 2162b34c648bSJoe Perches my ($string) = @_; 2163b34c648bSJoe Perches 2164b34c648bSJoe Perches $string =~ s/\s+$//; 21653705ce5bSJoe Perches 21663705ce5bSJoe Perches return $string; 21673705ce5bSJoe Perches} 21683705ce5bSJoe Perches 216952ea8506SJoe Perchessub string_find_replace { 217052ea8506SJoe Perches my ($string, $find, $replace) = @_; 217152ea8506SJoe Perches 217252ea8506SJoe Perches $string =~ s/$find/$replace/g; 217352ea8506SJoe Perches 217452ea8506SJoe Perches return $string; 217552ea8506SJoe Perches} 217652ea8506SJoe Perches 21773705ce5bSJoe Perchessub tabify { 21783705ce5bSJoe Perches my ($leading) = @_; 21793705ce5bSJoe Perches 21803705ce5bSJoe Perches my $source_indent = 8; 21813705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 21823705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 21833705ce5bSJoe Perches 21843705ce5bSJoe Perches #convert leading spaces to tabs 21853705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 21863705ce5bSJoe Perches #Remove spaces before a tab 21873705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 21883705ce5bSJoe Perches 21893705ce5bSJoe Perches return "$leading"; 21903705ce5bSJoe Perches} 21913705ce5bSJoe Perches 2192d1fe9c09SJoe Perchessub pos_last_openparen { 2193d1fe9c09SJoe Perches my ($line) = @_; 2194d1fe9c09SJoe Perches 2195d1fe9c09SJoe Perches my $pos = 0; 2196d1fe9c09SJoe Perches 2197d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2198d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2199d1fe9c09SJoe Perches 2200d1fe9c09SJoe Perches my $last_openparen = 0; 2201d1fe9c09SJoe Perches 2202d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2203d1fe9c09SJoe Perches return -1; 2204d1fe9c09SJoe Perches } 2205d1fe9c09SJoe Perches 2206d1fe9c09SJoe Perches my $len = length($line); 2207d1fe9c09SJoe Perches 2208d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2209d1fe9c09SJoe Perches my $string = substr($line, $pos); 2210d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2211d1fe9c09SJoe Perches $pos += length($1) - 1; 2212d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2213d1fe9c09SJoe Perches $last_openparen = $pos; 2214d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2215d1fe9c09SJoe Perches last; 2216d1fe9c09SJoe Perches } 2217d1fe9c09SJoe Perches } 2218d1fe9c09SJoe Perches 221991cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2220d1fe9c09SJoe Perches} 2221d1fe9c09SJoe Perches 22220a920b5bSAndy Whitcroftsub process { 22230a920b5bSAndy Whitcroft my $filename = shift; 22240a920b5bSAndy Whitcroft 22250a920b5bSAndy Whitcroft my $linenr=0; 22260a920b5bSAndy Whitcroft my $prevline=""; 2227c2fdda0dSAndy Whitcroft my $prevrawline=""; 22280a920b5bSAndy Whitcroft my $stashline=""; 2229c2fdda0dSAndy Whitcroft my $stashrawline=""; 22300a920b5bSAndy Whitcroft 22314a0df2efSAndy Whitcroft my $length; 22320a920b5bSAndy Whitcroft my $indent; 22330a920b5bSAndy Whitcroft my $previndent=0; 22340a920b5bSAndy Whitcroft my $stashindent=0; 22350a920b5bSAndy Whitcroft 2236de7d4f0eSAndy Whitcroft our $clean = 1; 22370a920b5bSAndy Whitcroft my $signoff = 0; 22380a920b5bSAndy Whitcroft my $is_patch = 0; 223929ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 224015662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 2241ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2242bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 22432a076f40SJoe Perches my $commit_log_long_line = 0; 2244e518e9a5SJoe Perches my $commit_log_has_diff = 0; 224513f1937eSJoe Perches my $reported_maintainer_file = 0; 2246fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2247fa64205dSPasi Savanainen 2248365dd4eaSJoe Perches my $last_blank_line = 0; 22495e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2250365dd4eaSJoe Perches 225113214adfSAndy Whitcroft our @report = (); 22526c72ffaaSAndy Whitcroft our $cnt_lines = 0; 22536c72ffaaSAndy Whitcroft our $cnt_error = 0; 22546c72ffaaSAndy Whitcroft our $cnt_warn = 0; 22556c72ffaaSAndy Whitcroft our $cnt_chk = 0; 22566c72ffaaSAndy Whitcroft 22570a920b5bSAndy Whitcroft # Trace the real file/line as we go. 22580a920b5bSAndy Whitcroft my $realfile = ''; 22590a920b5bSAndy Whitcroft my $realline = 0; 22600a920b5bSAndy Whitcroft my $realcnt = 0; 22610a920b5bSAndy Whitcroft my $here = ''; 226277cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 22630a920b5bSAndy Whitcroft my $in_comment = 0; 2264c2fdda0dSAndy Whitcroft my $comment_edge = 0; 22650a920b5bSAndy Whitcroft my $first_line = 0; 22661e855726SWolfram Sang my $p1_prefix = ''; 22670a920b5bSAndy Whitcroft 226813214adfSAndy Whitcroft my $prev_values = 'E'; 226913214adfSAndy Whitcroft 227013214adfSAndy Whitcroft # suppression flags 2271773647a0SAndy Whitcroft my %suppress_ifbraces; 2272170d3a22SAndy Whitcroft my %suppress_whiletrailers; 22732b474a1aSAndy Whitcroft my %suppress_export; 22743e469cdcSAndy Whitcroft my $suppress_statement = 0; 2275653d4876SAndy Whitcroft 22767e51f197SJoe Perches my %signatures = (); 2277323c1260SJoe Perches 2278c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2279de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2280c2fdda0dSAndy Whitcroft # 2281de7d4f0eSAndy Whitcroft my @setup_docs = (); 2282de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2283773647a0SAndy Whitcroft 2284d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2285d8b07710SJoe Perches 22869f3a8992SRob Herring my $checklicenseline = 1; 22879f3a8992SRob Herring 2288773647a0SAndy Whitcroft sanitise_line_reset(); 2289c2fdda0dSAndy Whitcroft my $line; 2290c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2291773647a0SAndy Whitcroft $linenr++; 2292773647a0SAndy Whitcroft $line = $rawline; 2293c2fdda0dSAndy Whitcroft 22943705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 22953705ce5bSJoe Perches 2296773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2297de7d4f0eSAndy Whitcroft $setup_docs = 0; 22988c27ceffSMauro Carvalho Chehab if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) { 2299de7d4f0eSAndy Whitcroft $setup_docs = 1; 2300de7d4f0eSAndy Whitcroft } 2301773647a0SAndy Whitcroft #next; 2302de7d4f0eSAndy Whitcroft } 230374fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2304773647a0SAndy Whitcroft $realline=$1-1; 2305773647a0SAndy Whitcroft if (defined $2) { 2306773647a0SAndy Whitcroft $realcnt=$3+1; 2307773647a0SAndy Whitcroft } else { 2308773647a0SAndy Whitcroft $realcnt=1+1; 2309773647a0SAndy Whitcroft } 2310c45dcabdSAndy Whitcroft $in_comment = 0; 2311773647a0SAndy Whitcroft 2312773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2313773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2314773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2315773647a0SAndy Whitcroft # at context start. 2316773647a0SAndy Whitcroft my $edge; 231701fa9147SAndy Whitcroft my $cnt = $realcnt; 231801fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 231901fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 232001fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 232101fa9147SAndy Whitcroft $cnt--; 232201fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2323721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2324fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2325fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2326fae17daeSAndy Whitcroft ($edge) = $1; 2327fae17daeSAndy Whitcroft last; 2328fae17daeSAndy Whitcroft } 2329773647a0SAndy Whitcroft } 2330773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2331773647a0SAndy Whitcroft $in_comment = 1; 2332773647a0SAndy Whitcroft } 2333773647a0SAndy Whitcroft 2334773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2335773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2336773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2337773647a0SAndy Whitcroft if (!defined $edge && 233883242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2339773647a0SAndy Whitcroft { 2340773647a0SAndy Whitcroft $in_comment = 1; 2341773647a0SAndy Whitcroft } 2342773647a0SAndy Whitcroft 2343773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2344773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2345773647a0SAndy Whitcroft 2346171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2347773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2348171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2349773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2350773647a0SAndy Whitcroft } 2351773647a0SAndy Whitcroft push(@lines, $line); 2352773647a0SAndy Whitcroft 2353773647a0SAndy Whitcroft if ($realcnt > 1) { 2354773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2355773647a0SAndy Whitcroft } else { 2356773647a0SAndy Whitcroft $realcnt = 0; 2357773647a0SAndy Whitcroft } 2358773647a0SAndy Whitcroft 2359773647a0SAndy Whitcroft #print "==>$rawline\n"; 2360773647a0SAndy Whitcroft #print "-->$line\n"; 2361de7d4f0eSAndy Whitcroft 2362de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2363de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2364de7d4f0eSAndy Whitcroft } 2365de7d4f0eSAndy Whitcroft } 2366de7d4f0eSAndy Whitcroft 23676c72ffaaSAndy Whitcroft $prefix = ''; 23686c72ffaaSAndy Whitcroft 2369773647a0SAndy Whitcroft $realcnt = 0; 2370773647a0SAndy Whitcroft $linenr = 0; 2371194f66fcSJoe Perches $fixlinenr = -1; 23720a920b5bSAndy Whitcroft foreach my $line (@lines) { 23730a920b5bSAndy Whitcroft $linenr++; 2374194f66fcSJoe Perches $fixlinenr++; 23751b5539b1SJoe Perches my $sline = $line; #copy of $line 23761b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 23770a920b5bSAndy Whitcroft 2378c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 23796c72ffaaSAndy Whitcroft 23800a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2381e518e9a5SJoe Perches if (!$in_commit_log && 238274fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 238374fd4f34SJoe Perches my $context = $4; 23840a920b5bSAndy Whitcroft $is_patch = 1; 23854a0df2efSAndy Whitcroft $first_line = $linenr + 1; 23860a920b5bSAndy Whitcroft $realline=$1-1; 23870a920b5bSAndy Whitcroft if (defined $2) { 23880a920b5bSAndy Whitcroft $realcnt=$3+1; 23890a920b5bSAndy Whitcroft } else { 23900a920b5bSAndy Whitcroft $realcnt=1+1; 23910a920b5bSAndy Whitcroft } 2392c2fdda0dSAndy Whitcroft annotate_reset(); 239313214adfSAndy Whitcroft $prev_values = 'E'; 239413214adfSAndy Whitcroft 2395773647a0SAndy Whitcroft %suppress_ifbraces = (); 2396170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 23972b474a1aSAndy Whitcroft %suppress_export = (); 23983e469cdcSAndy Whitcroft $suppress_statement = 0; 239974fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 240074fd4f34SJoe Perches $context_function = $1; 240174fd4f34SJoe Perches } else { 240274fd4f34SJoe Perches undef $context_function; 240374fd4f34SJoe Perches } 24040a920b5bSAndy Whitcroft next; 24050a920b5bSAndy Whitcroft 24064a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 24074a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 24084a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2409773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 24100a920b5bSAndy Whitcroft $realline++; 2411d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 24120a920b5bSAndy Whitcroft 24134a0df2efSAndy Whitcroft # Measure the line length and indent. 2414c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 24150a920b5bSAndy Whitcroft 24160a920b5bSAndy Whitcroft # Track the previous line. 24170a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 24180a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2419c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2420c2fdda0dSAndy Whitcroft 2421773647a0SAndy Whitcroft #warn "line<$line>\n"; 24226c72ffaaSAndy Whitcroft 2423d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2424d8aaf121SAndy Whitcroft $realcnt--; 24250a920b5bSAndy Whitcroft } 24260a920b5bSAndy Whitcroft 2427cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2428cc77cdcaSAndy Whitcroft 24296c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 24306c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2431773647a0SAndy Whitcroft 24322ac73b4fSJoe Perches my $found_file = 0; 2433773647a0SAndy Whitcroft # extract the filename as it passes 24343bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 24353bf9a009SRabin Vincent $realfile = $1; 24362b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2437270c49a0SJoe Perches $in_commit_log = 0; 24382ac73b4fSJoe Perches $found_file = 1; 24393bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2440773647a0SAndy Whitcroft $realfile = $1; 24412b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2442270c49a0SJoe Perches $in_commit_log = 0; 24431e855726SWolfram Sang 24441e855726SWolfram Sang $p1_prefix = $1; 2445e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2446e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2447000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2448000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 24491e855726SWolfram Sang } 2450773647a0SAndy Whitcroft 2451c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2452000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2453000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2454773647a0SAndy Whitcroft } 24552ac73b4fSJoe Perches $found_file = 1; 24562ac73b4fSJoe Perches } 24572ac73b4fSJoe Perches 245834d8815fSJoe Perches#make up the handle for any error we report on this line 245934d8815fSJoe Perches if ($showfile) { 246034d8815fSJoe Perches $prefix = "$realfile:$realline: " 246134d8815fSJoe Perches } elsif ($emacs) { 24627d3a9f67SJoe Perches if ($file) { 24637d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 24647d3a9f67SJoe Perches } else { 246534d8815fSJoe Perches $prefix = "$filename:$linenr: "; 246634d8815fSJoe Perches } 24677d3a9f67SJoe Perches } 246834d8815fSJoe Perches 24692ac73b4fSJoe Perches if ($found_file) { 247085b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 247185b0ee18SJoe Perches WARN("OBSOLETE", 247285b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 247385b0ee18SJoe Perches } 24747bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 24752ac73b4fSJoe Perches $check = 1; 24762ac73b4fSJoe Perches } else { 24772ac73b4fSJoe Perches $check = $check_orig; 24782ac73b4fSJoe Perches } 24799f3a8992SRob Herring $checklicenseline = 1; 2480773647a0SAndy Whitcroft next; 2481773647a0SAndy Whitcroft } 2482773647a0SAndy Whitcroft 2483389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 24840a920b5bSAndy Whitcroft 2485c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2486c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2487c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 24880a920b5bSAndy Whitcroft 24896c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 24906c72ffaaSAndy Whitcroft 2491e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2492e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2493e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2494e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2495e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2496e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2497e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2498e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2499e518e9a5SJoe Perches $commit_log_has_diff = 1; 2500e518e9a5SJoe Perches } 2501e518e9a5SJoe Perches 25023bf9a009SRabin Vincent# Check for incorrect file permissions 25033bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 25043bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 250504db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 250604db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2507000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2508000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 25093bf9a009SRabin Vincent } 25103bf9a009SRabin Vincent } 25113bf9a009SRabin Vincent 251220112475SJoe Perches# Check the patch for a signoff: 2513d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 25144a0df2efSAndy Whitcroft $signoff++; 251515662b3eSJoe Perches $in_commit_log = 0; 25160a920b5bSAndy Whitcroft } 251720112475SJoe Perches 2518e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2519e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2520e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2521e0d975b1SJoe Perches $reported_maintainer_file = 1; 2522e0d975b1SJoe Perches } 2523e0d975b1SJoe Perches 252420112475SJoe Perches# Check signature styles 2525270c49a0SJoe Perches if (!$in_header_lines && 2526ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 252720112475SJoe Perches my $space_before = $1; 252820112475SJoe Perches my $sign_off = $2; 252920112475SJoe Perches my $space_after = $3; 253020112475SJoe Perches my $email = $4; 253120112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 253220112475SJoe Perches 2533ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2534ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2535ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2536ce0338dfSJoe Perches } 253720112475SJoe Perches if (defined $space_before && $space_before ne "") { 25383705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 25393705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 25403705ce5bSJoe Perches $fix) { 2541194f66fcSJoe Perches $fixed[$fixlinenr] = 25423705ce5bSJoe Perches "$ucfirst_sign_off $email"; 25433705ce5bSJoe Perches } 254420112475SJoe Perches } 254520112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 25463705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 25473705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 25483705ce5bSJoe Perches $fix) { 2549194f66fcSJoe Perches $fixed[$fixlinenr] = 25503705ce5bSJoe Perches "$ucfirst_sign_off $email"; 25513705ce5bSJoe Perches } 25523705ce5bSJoe Perches 255320112475SJoe Perches } 255420112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 25553705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 25563705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 25573705ce5bSJoe Perches $fix) { 2558194f66fcSJoe Perches $fixed[$fixlinenr] = 25593705ce5bSJoe Perches "$ucfirst_sign_off $email"; 25603705ce5bSJoe Perches } 256120112475SJoe Perches } 256220112475SJoe Perches 256320112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 256420112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 256520112475SJoe Perches if ($suggested_email eq "") { 2566000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2567000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 256820112475SJoe Perches } else { 256920112475SJoe Perches my $dequoted = $suggested_email; 257020112475SJoe Perches $dequoted =~ s/^"//; 257120112475SJoe Perches $dequoted =~ s/" </ </; 257220112475SJoe Perches # Don't force email to have quotes 257320112475SJoe Perches # Allow just an angle bracketed address 257420112475SJoe Perches if ("$dequoted$comment" ne $email && 257520112475SJoe Perches "<$email_address>$comment" ne $email && 257620112475SJoe Perches "$suggested_email$comment" ne $email) { 2577000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2578000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 257920112475SJoe Perches } 25800a920b5bSAndy Whitcroft } 25817e51f197SJoe Perches 25827e51f197SJoe Perches# Check for duplicate signatures 25837e51f197SJoe Perches my $sig_nospace = $line; 25847e51f197SJoe Perches $sig_nospace =~ s/\s//g; 25857e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 25867e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 25877e51f197SJoe Perches WARN("BAD_SIGN_OFF", 25887e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 25897e51f197SJoe Perches } else { 25907e51f197SJoe Perches $signatures{$sig_nospace} = 1; 25917e51f197SJoe Perches } 25920a920b5bSAndy Whitcroft } 25930a920b5bSAndy Whitcroft 2594a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2595a2fe16b9SJoe Perches if ($in_header_lines && 2596a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2597a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2598a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2599a2fe16b9SJoe Perches } 2600a2fe16b9SJoe Perches 26019b3189ebSJoe Perches# Check for old stable address 26029b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 26039b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 26049b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 26059b3189ebSJoe Perches } 26069b3189ebSJoe Perches 26077ebd05efSChristopher Covington# Check for unwanted Gerrit info 26087ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 26097ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 26107ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 26117ebd05efSChristopher Covington } 26127ebd05efSChristopher Covington 2613369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2614369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2615369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2616369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2617369c8dd3SJoe Perches # timestamp 2618369c8dd3SJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) { 2619369c8dd3SJoe Perches # stack dump address 2620369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2621369c8dd3SJoe Perches } 2622369c8dd3SJoe Perches 26232a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 26242a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2625bf4daf12SJoe Perches length($line) > 75 && 2626bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2627bf4daf12SJoe Perches # file delta changes 2628bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2629bf4daf12SJoe Perches # filename then : 2630bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2631bf4daf12SJoe Perches # A Fixes: or Link: line 2632bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 26332a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 26342a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 26352a076f40SJoe Perches $commit_log_long_line = 1; 26362a076f40SJoe Perches } 26372a076f40SJoe Perches 2638bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2639bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2640bf4daf12SJoe Perches $line =~ /^\s*$/) { 2641bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2642bf4daf12SJoe Perches } 2643bf4daf12SJoe Perches 26440d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2645369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2646aab38f51SJoe Perches $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i && 2647e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 2648fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2649aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2650369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2651bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2652fe043ea1SJoe Perches my $init_char = "c"; 2653fe043ea1SJoe Perches my $orig_commit = ""; 26540d7835fcSJoe Perches my $short = 1; 26550d7835fcSJoe Perches my $long = 0; 26560d7835fcSJoe Perches my $case = 1; 26570d7835fcSJoe Perches my $space = 1; 26580d7835fcSJoe Perches my $hasdesc = 0; 265919c146a6SJoe Perches my $hasparens = 0; 26600d7835fcSJoe Perches my $id = '0123456789ab'; 26610d7835fcSJoe Perches my $orig_desc = "commit description"; 26620d7835fcSJoe Perches my $description = ""; 26630d7835fcSJoe Perches 2664fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2665fe043ea1SJoe Perches $init_char = $1; 2666fe043ea1SJoe Perches $orig_commit = lc($2); 2667fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2668fe043ea1SJoe Perches $orig_commit = lc($1); 2669fe043ea1SJoe Perches } 2670fe043ea1SJoe Perches 26710d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 26720d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 26730d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 26740d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 26750d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 26760d7835fcSJoe Perches $orig_desc = $1; 267719c146a6SJoe Perches $hasparens = 1; 26780d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 26790d7835fcSJoe Perches defined $rawlines[$linenr] && 26800d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 26810d7835fcSJoe Perches $orig_desc = $1; 268219c146a6SJoe Perches $hasparens = 1; 2683b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2684b671fde0SJoe Perches defined $rawlines[$linenr] && 2685b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2686b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2687b671fde0SJoe Perches $orig_desc = $1; 2688b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2689b671fde0SJoe Perches $orig_desc .= " " . $1; 269019c146a6SJoe Perches $hasparens = 1; 26910d7835fcSJoe Perches } 26920d7835fcSJoe Perches 26930d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 26940d7835fcSJoe Perches $id, $orig_desc); 26950d7835fcSJoe Perches 2696948b133aSHeinrich Schuchardt if (defined($id) && 2697948b133aSHeinrich Schuchardt ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { 2698d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 26990d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 27000d7835fcSJoe Perches } 2701d311cd44SJoe Perches } 2702d311cd44SJoe Perches 270313f1937eSJoe Perches# Check for added, moved or deleted files 270413f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 270513f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 270613f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 270713f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 270813f1937eSJoe Perches (defined($1) || defined($2))))) { 2709a82603a8SAndrew Jeffery $is_patch = 1; 271013f1937eSJoe Perches $reported_maintainer_file = 1; 271113f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 271213f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 271313f1937eSJoe Perches } 271413f1937eSJoe Perches 271500df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 27168905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2717000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2718000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 27196c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2720de7d4f0eSAndy Whitcroft } 2721de7d4f0eSAndy Whitcroft 2722de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2723de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2724171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2725171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2726171ae1a4SAndy Whitcroft 2727171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2728171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2729171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2730171ae1a4SAndy Whitcroft 273134d99219SJoe Perches CHK("INVALID_UTF8", 2732000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 273300df344fSAndy Whitcroft } 27340a920b5bSAndy Whitcroft 273515662b3eSJoe Perches# Check if it's the start of a commit log 273615662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 273715662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 2738eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 2739eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 274015662b3eSJoe Perches $in_header_lines = 0; 274115662b3eSJoe Perches $in_commit_log = 1; 2742ed43c4e5SAllen Hubbe $has_commit_log = 1; 274315662b3eSJoe Perches } 274415662b3eSJoe Perches 2745fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2746fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2747fa64205dSPasi Savanainen if ($in_header_lines && 2748fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2749fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2750fa64205dSPasi Savanainen $non_utf8_charset = 1; 2751fa64205dSPasi Savanainen } 2752fa64205dSPasi Savanainen 2753fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 275415662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2755fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 275615662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 275715662b3eSJoe Perches } 275815662b3eSJoe Perches 2759d6430f71SJoe Perches# Check for absolute kernel paths in commit message 2760d6430f71SJoe Perches if ($tree && $in_commit_log) { 2761d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 2762d6430f71SJoe Perches my $file = $1; 2763d6430f71SJoe Perches 2764d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 2765d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 2766d6430f71SJoe Perches # 2767d6430f71SJoe Perches } else { 2768d6430f71SJoe Perches check_absolute_file($file, $herecurr); 2769d6430f71SJoe Perches } 2770d6430f71SJoe Perches } 2771d6430f71SJoe Perches } 2772d6430f71SJoe Perches 277366b47b4aSKees Cook# Check for various typo / spelling mistakes 277466d7a382SJoe Perches if (defined($misspellings) && 277566d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2776ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 277766b47b4aSKees Cook my $typo = $1; 277866b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 277966b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 278066b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 27810675a8fbSJean Delvare my $msg_level = \&WARN; 27820675a8fbSJean Delvare $msg_level = \&CHK if ($file); 27830675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 278466b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 278566b47b4aSKees Cook $fix) { 278666b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 278766b47b4aSKees Cook } 278866b47b4aSKees Cook } 278966b47b4aSKees Cook } 279066b47b4aSKees Cook 279130670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 279230670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 279300df344fSAndy Whitcroft 27940a920b5bSAndy Whitcroft#trailing whitespace 27959c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2796c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2797d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2798d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2799d5e616fcSJoe Perches $fix) { 2800194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2801d5e616fcSJoe Perches } 2802c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2803c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28043705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 28053705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 28063705ce5bSJoe Perches $fix) { 2807194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 28083705ce5bSJoe Perches } 28093705ce5bSJoe Perches 2810d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 28110a920b5bSAndy Whitcroft } 28125368df20SAndy Whitcroft 28134783f894SJosh Triplett# Check for FSF mailing addresses. 2814109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 28151bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 28163e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 28173e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 28184783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28190675a8fbSJean Delvare my $msg_level = \&ERROR; 28200675a8fbSJean Delvare $msg_level = \&CHK if ($file); 28210675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 28224783f894SJosh 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) 28234783f894SJosh Triplett } 28244783f894SJosh Triplett 28253354957aSAndi Kleen# check for Kconfig help text having a real description 28269fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 28279fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 28283354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 2829678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 2830678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 2831678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 2832678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 28333354957aSAndi Kleen my $length = 0; 28349fe287d7SAndy Whitcroft my $cnt = $realcnt; 28359fe287d7SAndy Whitcroft my $ln = $linenr + 1; 28369fe287d7SAndy Whitcroft my $f; 2837a1385803SAndy Whitcroft my $is_start = 0; 28389fe287d7SAndy Whitcroft my $is_end = 0; 2839a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 28409fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 28419fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 28429fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 28439fe287d7SAndy Whitcroft 28449fe287d7SAndy Whitcroft next if ($f =~ /^-/); 28458d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2846a1385803SAndy Whitcroft 284786adf1a0SUlf Magnusson if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 2848a1385803SAndy Whitcroft $is_start = 1; 284984af7a61SUlf Magnusson } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) { 285084af7a61SUlf Magnusson if ($lines[$ln - 1] =~ "---help---") { 285184af7a61SUlf Magnusson WARN("CONFIG_DESCRIPTION", 285284af7a61SUlf Magnusson "prefer 'help' over '---help---' for new help texts\n" . $herecurr); 285384af7a61SUlf Magnusson } 2854a1385803SAndy Whitcroft $length = -1; 2855a1385803SAndy Whitcroft } 2856a1385803SAndy Whitcroft 28579fe287d7SAndy Whitcroft $f =~ s/^.//; 28583354957aSAndi Kleen $f =~ s/#.*//; 28593354957aSAndi Kleen $f =~ s/^\s+//; 28603354957aSAndi Kleen next if ($f =~ /^$/); 2861678ae162SUlf Magnusson 2862678ae162SUlf Magnusson # This only checks context lines in the patch 2863678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 2864678ae162SUlf Magnusson # positives, even though some of these are 2865678ae162SUlf Magnusson # common words in help texts 2866678ae162SUlf Magnusson if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| 2867678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 28689fe287d7SAndy Whitcroft $is_end = 1; 28699fe287d7SAndy Whitcroft last; 28709fe287d7SAndy Whitcroft } 28713354957aSAndi Kleen $length++; 28723354957aSAndi Kleen } 287356193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2874000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 287556193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 287656193274SVadim Bendebury } 2877a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 28783354957aSAndi Kleen } 28793354957aSAndi Kleen 2880628f91a2SJoe Perches# check for MAINTAINERS entries that don't have the right form 2881628f91a2SJoe Perches if ($realfile =~ /^MAINTAINERS$/ && 2882628f91a2SJoe Perches $rawline =~ /^\+[A-Z]:/ && 2883628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 2884628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 2885628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 2886628f91a2SJoe Perches $fix) { 2887628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 2888628f91a2SJoe Perches } 2889628f91a2SJoe Perches } 2890628f91a2SJoe Perches 2891327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2892327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2893327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2894327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2895327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2896327953e9SChristoph Jaeger } 2897327953e9SChristoph Jaeger 2898c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2899c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2900c68e5878SArnaud Lacombe my $flag = $1; 2901c68e5878SArnaud Lacombe my $replacement = { 2902c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2903c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2904c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2905c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2906c68e5878SArnaud Lacombe }; 2907c68e5878SArnaud Lacombe 2908c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2909c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2910c68e5878SArnaud Lacombe } 2911c68e5878SArnaud Lacombe 2912bff5da43SRob Herring# check for DT compatible documentation 29137dd05b38SFlorian Vaussard if (defined $root && 29147dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 29157dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 29167dd05b38SFlorian Vaussard 2917bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2918bff5da43SRob Herring 2919cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2920cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2921cc93319bSFlorian Vaussard 2922bff5da43SRob Herring foreach my $compat (@compats) { 2923bff5da43SRob Herring my $compat2 = $compat; 2924185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2925185d566bSRob Herring my $compat3 = $compat; 2926185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2927185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2928bff5da43SRob Herring if ( $? >> 8 ) { 2929bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2930bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2931bff5da43SRob Herring } 2932bff5da43SRob Herring 29334fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 29344fbf32a6SFlorian Vaussard my $vendor = $1; 2935cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2936bff5da43SRob Herring if ( $? >> 8 ) { 2937bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2938cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2939bff5da43SRob Herring } 2940bff5da43SRob Herring } 2941bff5da43SRob Herring } 2942bff5da43SRob Herring 29439f3a8992SRob Herring# check for using SPDX license tag at beginning of files 29449f3a8992SRob Herring if ($realline == $checklicenseline) { 29459f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 29469f3a8992SRob Herring $checklicenseline = 2; 29479f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 29489f3a8992SRob Herring my $comment = ""; 29499f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 29509f3a8992SRob Herring $comment = '/*'; 29519f3a8992SRob Herring } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 29529f3a8992SRob Herring $comment = '//'; 29539f3a8992SRob Herring } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) { 29549f3a8992SRob Herring $comment = '#'; 29559f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 29569f3a8992SRob Herring $comment = '..'; 29579f3a8992SRob Herring } 29589f3a8992SRob Herring 29599f3a8992SRob Herring if ($comment !~ /^$/ && 29609f3a8992SRob Herring $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) { 29619f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 29629f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 29639f3a8992SRob Herring } 29649f3a8992SRob Herring } 29659f3a8992SRob Herring } 29669f3a8992SRob Herring 29675368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2968d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 29695368df20SAndy Whitcroft 297047e0c88bSJoe Perches# line length limit (with some exclusions) 297147e0c88bSJoe Perches# 297247e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 297347e0c88bSJoe Perches# logging functions like pr_info that end in a string 297447e0c88bSJoe Perches# lines with a single string 297547e0c88bSJoe Perches# #defines that are a single string 29762e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 297747e0c88bSJoe Perches# 297847e0c88bSJoe Perches# There are 3 different line length message types: 2979ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 298047e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 298147e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 298247e0c88bSJoe Perches# 298347e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 298447e0c88bSJoe Perches# 298547e0c88bSJoe Perches 2986b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 298747e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 298847e0c88bSJoe Perches 298947e0c88bSJoe Perches # Check the allowed long line types first 299047e0c88bSJoe Perches 299147e0c88bSJoe Perches # logging functions that end in a string that starts 299247e0c88bSJoe Perches # before $max_line_length 299347e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 299447e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 299547e0c88bSJoe Perches $msg_type = ""; 299647e0c88bSJoe Perches 299747e0c88bSJoe Perches # lines with only strings (w/ possible termination) 299847e0c88bSJoe Perches # #defines with only strings 299947e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 300047e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 300147e0c88bSJoe Perches $msg_type = ""; 300247e0c88bSJoe Perches 3003cc147506SJoe Perches # More special cases 3004cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3005cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3006d560a5f8SJoe Perches $msg_type = ""; 3007d560a5f8SJoe Perches 30082e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 30092e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 30102e4bbbc5SAndreas Brauchli $msg_type = ""; 30112e4bbbc5SAndreas Brauchli 301247e0c88bSJoe Perches # Otherwise set the alternate message types 301347e0c88bSJoe Perches 301447e0c88bSJoe Perches # a comment starts before $max_line_length 301547e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 301647e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 301747e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 301847e0c88bSJoe Perches 301947e0c88bSJoe Perches # a quoted string starts before $max_line_length 302047e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 302147e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 302247e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 302347e0c88bSJoe Perches } 302447e0c88bSJoe Perches 302547e0c88bSJoe Perches if ($msg_type ne "" && 302647e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 302747e0c88bSJoe Perches WARN($msg_type, 30286cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 30290a920b5bSAndy Whitcroft } 303047e0c88bSJoe Perches } 30310a920b5bSAndy Whitcroft 30328905a67cSAndy Whitcroft# check for adding lines without a newline. 30338905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 3034000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 3035000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 30368905a67cSAndy Whitcroft } 30378905a67cSAndy Whitcroft 3038b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3039de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 30400a920b5bSAndy Whitcroft 30410a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 30420a920b5bSAndy Whitcroft# more than 8 must use tabs. 3043c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3044c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3045c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3046d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 30473705ce5bSJoe Perches if (ERROR("CODE_INDENT", 30483705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 30493705ce5bSJoe Perches $fix) { 3050194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 30513705ce5bSJoe Perches } 30520a920b5bSAndy Whitcroft } 30530a920b5bSAndy Whitcroft 305408e44365SAlberto Panizzo# check for space before tabs. 305508e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 305608e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 30573705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 30583705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 30593705ce5bSJoe Perches $fix) { 3060194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3061d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 3062194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3063c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 30643705ce5bSJoe Perches } 306508e44365SAlberto Panizzo } 306608e44365SAlberto Panizzo 30676a487211SJoe Perches# check for assignments on the start of a line 30686a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 30696a487211SJoe Perches CHK("ASSIGNMENT_CONTINUATIONS", 30706a487211SJoe Perches "Assignment operator '$1' should be on the previous line\n" . $hereprev); 30716a487211SJoe Perches } 30726a487211SJoe Perches 3073d1fe9c09SJoe Perches# check for && or || at the start of a line 3074d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 3075d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 3076d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 3077d1fe9c09SJoe Perches } 3078d1fe9c09SJoe Perches 3079a91e8994SJoe Perches# check indentation starts on a tab stop 3080a91e8994SJoe Perches if ($^V && $^V ge 5.10.0 && 3081bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3082a91e8994SJoe Perches my $indent = length($1); 3083a91e8994SJoe Perches if ($indent % 8) { 3084a91e8994SJoe Perches if (WARN("TABSTOP", 3085a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3086a91e8994SJoe Perches $fix) { 3087a91e8994SJoe Perches $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; 3088a91e8994SJoe Perches } 3089a91e8994SJoe Perches } 3090a91e8994SJoe Perches } 3091a91e8994SJoe Perches 3092d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 3093d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3094fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3095d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3096d1fe9c09SJoe Perches my $oldindent = $1; 3097d1fe9c09SJoe Perches my $rest = $2; 3098d1fe9c09SJoe Perches 3099d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3100d1fe9c09SJoe Perches if ($pos >= 0) { 3101b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3102b34a26f3SJoe Perches my $newindent = $2; 3103d1fe9c09SJoe Perches 3104d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3105d1fe9c09SJoe Perches "\t" x ($pos / 8) . 3106d1fe9c09SJoe Perches " " x ($pos % 8); 3107d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3108d1fe9c09SJoe Perches 3109d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3110d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 31113705ce5bSJoe Perches 31123705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 31133705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 31143705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3115194f66fcSJoe Perches $fixed[$fixlinenr] =~ 31163705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 31173705ce5bSJoe Perches } 3118d1fe9c09SJoe Perches } 3119d1fe9c09SJoe Perches } 3120d1fe9c09SJoe Perches } 3121d1fe9c09SJoe Perches 31226ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 31236ab3a970SJoe Perches# avoid checking a few false positives: 31246ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 31256ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 31266ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 31276ab3a970SJoe Perches# multiline macros that define functions 31286ab3a970SJoe Perches# known attributes or the __attribute__ keyword 31296ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 31306ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 31313705ce5bSJoe Perches if (CHK("SPACING", 3132f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 31333705ce5bSJoe Perches $fix) { 3134194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3135f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 31363705ce5bSJoe Perches } 3137aad4f614SJoe Perches } 3138aad4f614SJoe Perches 313986406b1cSJoe Perches# Block comment styles 314086406b1cSJoe Perches# Networking with an initial /* 314105880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3142fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 314385ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 314485ad978cSJoe Perches $realline > 2) { 314505880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 314605880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 314705880600SJoe Perches } 314805880600SJoe Perches 314986406b1cSJoe Perches# Block comments use * on subsequent lines 315086406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 315186406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3152a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 315361135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3154a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 315586406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 315686406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3157a605e32eSJoe Perches } 3158a605e32eSJoe Perches 315986406b1cSJoe Perches# Block comments use */ on trailing lines 316086406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3161c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3162c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3163c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 316486406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 316586406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 316605880600SJoe Perches } 316705880600SJoe Perches 316808eb9b80SJoe Perches# Block comment * alignment 316908eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3170af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3171af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3172af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 317308eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3174af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3175af207524SJoe Perches my $oldindent; 317608eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3177af207524SJoe Perches if (defined($1)) { 3178af207524SJoe Perches $oldindent = expand_tabs($1); 3179af207524SJoe Perches } else { 3180af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3181af207524SJoe Perches $oldindent = expand_tabs($1); 3182af207524SJoe Perches } 318308eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 318408eb9b80SJoe Perches my $newindent = $1; 318508eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3186af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 318708eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 318808eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 318908eb9b80SJoe Perches } 319008eb9b80SJoe Perches } 319108eb9b80SJoe Perches 31927f619191SJoe Perches# check for missing blank lines after struct/union declarations 31937f619191SJoe Perches# with exceptions for various attributes and macros 31947f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 31957f619191SJoe Perches $line =~ /^\+/ && 31967f619191SJoe Perches !($line =~ /^\+\s*$/ || 31977f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 31987f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 31997f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 32007f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 32017f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 32027f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 32030bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 32047f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3205d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3206d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3207d752fcc8SJoe Perches $fix) { 3208f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3209d752fcc8SJoe Perches } 32107f619191SJoe Perches } 32117f619191SJoe Perches 3212365dd4eaSJoe Perches# check for multiple consecutive blank lines 3213365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3214365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3215365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3216d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3217d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3218d752fcc8SJoe Perches $fix) { 3219f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3220d752fcc8SJoe Perches } 3221d752fcc8SJoe Perches 3222365dd4eaSJoe Perches $last_blank_line = $linenr; 3223365dd4eaSJoe Perches } 3224365dd4eaSJoe Perches 32253b617e3bSJoe Perches# check for missing blank lines after declarations 32263f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 32273f7bac03SJoe Perches # actual declarations 32283f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 32295a4e1fd3SJoe Perches # function pointer declarations 32305a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 32313f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 32323f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 32333f7bac03SJoe Perches # known declaration macros 32343f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 32353f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 32363f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 32373f7bac03SJoe Perches # other possible extensions of declaration lines 32383f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 32393f7bac03SJoe Perches # not starting a section or a macro "\" extended line 32403f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 32413f7bac03SJoe Perches # looks like a declaration 32423f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 32435a4e1fd3SJoe Perches # function pointer declarations 32445a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 32453f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 32463f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 32473f7bac03SJoe Perches # known declaration macros 32483f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 32493f7bac03SJoe Perches # start of struct or union or enum 32503b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 32513f7bac03SJoe Perches # start or end of block or continuation of declaration 32523f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 32533f7bac03SJoe Perches # bitfield continuation 32543f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 32553f7bac03SJoe Perches # other possible extensions of declaration lines 32563f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 32573f7bac03SJoe Perches # indentation of previous and current line are the same 32583f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3259d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3260d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3261d752fcc8SJoe Perches $fix) { 3262f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3263d752fcc8SJoe Perches } 32643b617e3bSJoe Perches } 32653b617e3bSJoe Perches 32665f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 32676b4c5bebSAndy Whitcroft# Exceptions: 32686b4c5bebSAndy Whitcroft# 1) within comments 32696b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 32706b4c5bebSAndy Whitcroft# 3) hanging labels 32713705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 32725f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 32733705ce5bSJoe Perches if (WARN("LEADING_SPACE", 32743705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 32753705ce5bSJoe Perches $fix) { 3276194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 32773705ce5bSJoe Perches } 32785f7ddae6SRaffaele Recalcati } 32795f7ddae6SRaffaele Recalcati 3280b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3281b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3282b9ea10d6SAndy Whitcroft 32835751a24eSJoe Perches# check for unusual line ending [ or ( 32845751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 32855751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 32865751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 32875751a24eSJoe Perches } 32885751a24eSJoe Perches 32894dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 32904dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 32914dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 32924dbed76fSJoe Perches $context_function = $1; 32934dbed76fSJoe Perches } 32944dbed76fSJoe Perches 32954dbed76fSJoe Perches# check if this appears to be the end of function declaration 32964dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 32974dbed76fSJoe Perches undef $context_function; 32984dbed76fSJoe Perches } 32994dbed76fSJoe Perches 3300032a4c0fSJoe Perches# check indentation of any line with a bare else 3301840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3302032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3303032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3304032a4c0fSJoe Perches my $tabs = length($1) + 1; 3305840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3306840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3307840080a0SJoe Perches defined $lines[$linenr] && 3308840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3309032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3310032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3311032a4c0fSJoe Perches } 3312032a4c0fSJoe Perches } 3313032a4c0fSJoe Perches 3314c00df19aSJoe Perches# check indentation of a line with a break; 3315c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3316c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3317c00df19aSJoe Perches my $tabs = $1; 3318c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3319c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3320c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3321c00df19aSJoe Perches } 3322c00df19aSJoe Perches } 3323c00df19aSJoe Perches 3324c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3325cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3326000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3327000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3328c2fdda0dSAndy Whitcroft } 332922f2a2efSAndy Whitcroft 333056e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 333156e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 333256e77d70SJoe Perches WARN("HOTPLUG_SECTION", 333356e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 333456e77d70SJoe Perches } 333556e77d70SJoe Perches 33369c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 33372b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 33382b474a1aSAndy Whitcroft $realline_next); 33393e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 3340ca819864SJoe Perches if ($linenr > $suppress_statement && 33411b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3342170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3343f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3344171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3345171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3346171ae1a4SAndy Whitcroft 33473e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 33483e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 33493e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 33503e469cdcSAndy Whitcroft # until we hit end of it. 33513e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 33523e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 33533e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 33543e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 33553e469cdcSAndy Whitcroft } 3356f74bd194SAndy Whitcroft 33572b474a1aSAndy Whitcroft # Find the real next line. 33582b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 33592b474a1aSAndy Whitcroft if (defined $realline_next && 33602b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 33612b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 33622b474a1aSAndy Whitcroft $realline_next++; 33632b474a1aSAndy Whitcroft } 33642b474a1aSAndy Whitcroft 3365171ae1a4SAndy Whitcroft my $s = $stat; 3366171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3367cf655043SAndy Whitcroft 3368c2fdda0dSAndy Whitcroft # Ignore goto labels. 3369171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3370c2fdda0dSAndy Whitcroft 3371c2fdda0dSAndy Whitcroft # Ignore functions being called 3372171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3373c2fdda0dSAndy Whitcroft 3374463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3375463f2864SAndy Whitcroft 3376c45dcabdSAndy Whitcroft # declarations always start with types 3377d2506586SAndy 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) { 3378c45dcabdSAndy Whitcroft my $type = $1; 3379c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3380c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3381c45dcabdSAndy Whitcroft 33826c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3383a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3384c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3385c2fdda0dSAndy Whitcroft } 33868905a67cSAndy Whitcroft 33876c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 338865863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3389c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 33909c0ca6f9SAndy Whitcroft } 33918905a67cSAndy Whitcroft 33928905a67cSAndy Whitcroft # Check for any sort of function declaration. 33938905a67cSAndy Whitcroft # int foo(something bar, other baz); 33948905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3395171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 33968905a67cSAndy Whitcroft my ($name_len) = length($1); 33978905a67cSAndy Whitcroft 3398cf655043SAndy Whitcroft my $ctx = $s; 3399773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 34008905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3401cf655043SAndy Whitcroft 34028905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3403c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 34048905a67cSAndy Whitcroft 3405c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 34068905a67cSAndy Whitcroft } 34078905a67cSAndy Whitcroft } 34088905a67cSAndy Whitcroft } 34098905a67cSAndy Whitcroft 34109c0ca6f9SAndy Whitcroft } 34119c0ca6f9SAndy Whitcroft 341200df344fSAndy Whitcroft# 341300df344fSAndy Whitcroft# Checks which may be anchored in the context. 341400df344fSAndy Whitcroft# 341500df344fSAndy Whitcroft 341600df344fSAndy Whitcroft# Check for switch () and associated case and default 341700df344fSAndy Whitcroft# statements should be at the same indent. 341800df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 341900df344fSAndy Whitcroft my $err = ''; 342000df344fSAndy Whitcroft my $sep = ''; 342100df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 342200df344fSAndy Whitcroft shift(@ctx); 342300df344fSAndy Whitcroft for my $ctx (@ctx) { 342400df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 342500df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 342600df344fSAndy Whitcroft $indent != $cindent) { 342700df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 342800df344fSAndy Whitcroft $sep = ''; 342900df344fSAndy Whitcroft } else { 343000df344fSAndy Whitcroft $sep = "[...]\n"; 343100df344fSAndy Whitcroft } 343200df344fSAndy Whitcroft } 343300df344fSAndy Whitcroft if ($err ne '') { 3434000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3435000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3436de7d4f0eSAndy Whitcroft } 3437de7d4f0eSAndy Whitcroft } 3438de7d4f0eSAndy Whitcroft 3439de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3440de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 34410fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3442773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3443773647a0SAndy Whitcroft 34449c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 34458eef05ddSJoe Perches 34468eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 34478eef05ddSJoe Perches WARN("DEEP_INDENTATION", 34488eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 34498eef05ddSJoe Perches } 34508eef05ddSJoe Perches 3451de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3452de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3453de7d4f0eSAndy Whitcroft 3454548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3455548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3456de7d4f0eSAndy Whitcroft 3457548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3458548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3459548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3460548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3461548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3462773647a0SAndy Whitcroft $ctx_ln++; 3463773647a0SAndy Whitcroft } 3464548596d5SAndy Whitcroft 346553210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 346653210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3467773647a0SAndy Whitcroft 3468773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3469000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3470000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 347101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 347200df344fSAndy Whitcroft } 3473773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3474773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3475773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3476773647a0SAndy Whitcroft { 34779c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 34789c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3479000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3480000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 348101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 34829c0ca6f9SAndy Whitcroft } 34839c0ca6f9SAndy Whitcroft } 348400df344fSAndy Whitcroft } 348500df344fSAndy Whitcroft 34864d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 3487f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 34883e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 34893e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 34903e469cdcSAndy Whitcroft if (!defined $stat); 34914d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 34924d001e4dSAndy Whitcroft 34934d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 34944d001e4dSAndy Whitcroft 34959f5af480SJoe Perches # remove inline comments 34969f5af480SJoe Perches $s =~ s/$;/ /g; 34979f5af480SJoe Perches $c =~ s/$;/ /g; 34984d001e4dSAndy Whitcroft 34994d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 35006f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 35016f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 35024d001e4dSAndy Whitcroft 35039f5af480SJoe Perches # Make sure we remove the line prefixes as we have 35049f5af480SJoe Perches # none on the first line, and are going to readd them 35059f5af480SJoe Perches # where necessary. 35069f5af480SJoe Perches $s =~ s/\n./\n/gs; 35079f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 35089f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 35099f5af480SJoe Perches } 35109f5af480SJoe Perches 35114d001e4dSAndy Whitcroft # We want to check the first line inside the block 35124d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 35134d001e4dSAndy Whitcroft # 1) any blank line termination 35144d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 35154d001e4dSAndy Whitcroft # 3) any do (...) { 35164d001e4dSAndy Whitcroft my $continuation = 0; 35174d001e4dSAndy Whitcroft my $check = 0; 35184d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 35194d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 35204d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 35214d001e4dSAndy Whitcroft $continuation = 1; 35224d001e4dSAndy Whitcroft } 35239bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 35244d001e4dSAndy Whitcroft $check = 1; 35254d001e4dSAndy Whitcroft $cond_lines++; 35264d001e4dSAndy Whitcroft } 35274d001e4dSAndy Whitcroft 35284d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 35294d001e4dSAndy Whitcroft # preprocessor statement. 35304d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 35314d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 35324d001e4dSAndy Whitcroft $check = 0; 35334d001e4dSAndy Whitcroft } 35344d001e4dSAndy Whitcroft 35359bd49efeSAndy Whitcroft my $cond_ptr = -1; 3536740504c6SAndy Whitcroft $continuation = 0; 35379bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 35389bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 35394d001e4dSAndy Whitcroft 3540f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3541f16fa28fSAndy Whitcroft # is not linear. 3542f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3543f16fa28fSAndy Whitcroft $check = 0; 3544f16fa28fSAndy Whitcroft } 3545f16fa28fSAndy Whitcroft 35469bd49efeSAndy Whitcroft # Ignore: 35479bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 35489bd49efeSAndy Whitcroft # 2) preprocessor lines, and 35499bd49efeSAndy Whitcroft # 3) labels. 3550740504c6SAndy Whitcroft if ($continuation || 3551740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 35529bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 35539bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3554740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 355530dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 35569bd49efeSAndy Whitcroft $cond_lines++; 35579bd49efeSAndy Whitcroft } 35584d001e4dSAndy Whitcroft } 355930dad6ebSAndy Whitcroft } 35604d001e4dSAndy Whitcroft 35614d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 35624d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 35634d001e4dSAndy Whitcroft 35644d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 35654d001e4dSAndy Whitcroft # this is not this patch's fault. 35664d001e4dSAndy Whitcroft if (!defined($stat_real) || 35674d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 35684d001e4dSAndy Whitcroft $check = 0; 35694d001e4dSAndy Whitcroft } 35704d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 35714d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 35724d001e4dSAndy Whitcroft } 35734d001e4dSAndy Whitcroft 35749bd49efeSAndy 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"; 35754d001e4dSAndy Whitcroft 35769f5af480SJoe Perches if ($check && $s ne '' && 35779f5af480SJoe Perches (($sindent % 8) != 0 || 35789f5af480SJoe Perches ($sindent < $indent) || 3579f6950a73SJoe Perches ($sindent == $indent && 3580f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 35819f5af480SJoe Perches ($sindent > $indent + 8))) { 3582000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3583000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 35844d001e4dSAndy Whitcroft } 35854d001e4dSAndy Whitcroft } 35864d001e4dSAndy Whitcroft 35876c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 35886c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 35891f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 35901f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 35916c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3592c2fdda0dSAndy Whitcroft if ($dbg_values) { 3593c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3594cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3595cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 35961f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3597c2fdda0dSAndy Whitcroft } 35986c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 35996c72ffaaSAndy Whitcroft 360000df344fSAndy Whitcroft#ignore lines not being added 36013705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 360200df344fSAndy Whitcroft 360311ca40a0SJoe Perches# check for dereferences that span multiple lines 360411ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 360511ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 360611ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 360711ca40a0SJoe Perches my $ref = $1; 360811ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 360911ca40a0SJoe Perches $ref .= $1; 361011ca40a0SJoe Perches $ref =~ s/\s//g; 361111ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 361211ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 361311ca40a0SJoe Perches } 361411ca40a0SJoe Perches 3615a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3616c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3617a1ce18e4SJoe Perches my $type = $1; 3618a1ce18e4SJoe Perches my $var = $2; 3619207a8e84SJoe Perches $var = "" if (!defined $var); 3620207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3621a1ce18e4SJoe Perches my $sign = $1; 3622a1ce18e4SJoe Perches my $pointer = $2; 3623a1ce18e4SJoe Perches 3624a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3625a1ce18e4SJoe Perches 3626a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3627a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3628a1ce18e4SJoe Perches $fix) { 3629a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3630207a8e84SJoe Perches my $comp_pointer = $pointer; 3631207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 3632207a8e84SJoe Perches $decl .= $comp_pointer; 3633207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 3634207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 3635a1ce18e4SJoe Perches } 3636a1ce18e4SJoe Perches } 3637a1ce18e4SJoe Perches } 3638a1ce18e4SJoe Perches 3639653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 36407429c690SAndy Whitcroft if ($dbg_type) { 36417429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3642000d1cc1SJoe Perches ERROR("TEST_TYPE", 3643000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 36447429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3645000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3646000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 36477429c690SAndy Whitcroft } 3648653d4876SAndy Whitcroft next; 3649653d4876SAndy Whitcroft } 3650a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3651a1ef277eSAndy Whitcroft if ($dbg_attr) { 36529360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3653000d1cc1SJoe Perches ERROR("TEST_ATTR", 3654000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 36559360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3656000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3657000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3658a1ef277eSAndy Whitcroft } 3659a1ef277eSAndy Whitcroft next; 3660a1ef277eSAndy Whitcroft } 3661653d4876SAndy Whitcroft 3662f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 366399423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 366499423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3665d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3666d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3667f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3668f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3669f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3670d752fcc8SJoe Perches my $fixedline = $prevrawline; 3671d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3672f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3673d752fcc8SJoe Perches $fixedline = $line; 36748d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 3675f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3676d752fcc8SJoe Perches } 3677f0a594c1SAndy Whitcroft } 3678f0a594c1SAndy Whitcroft 367900df344fSAndy Whitcroft# 368000df344fSAndy Whitcroft# Checks which are anchored on the added line. 368100df344fSAndy Whitcroft# 368200df344fSAndy Whitcroft 3683653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3684c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3685653d4876SAndy Whitcroft my $path = $1; 3686653d4876SAndy Whitcroft if ($path =~ m{//}) { 3687000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3688495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3689495e9d84SJoe Perches } 3690495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3691495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3692495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3693653d4876SAndy Whitcroft } 3694653d4876SAndy Whitcroft } 3695653d4876SAndy Whitcroft 369600df344fSAndy Whitcroft# no C99 // comments 369700df344fSAndy Whitcroft if ($line =~ m{//}) { 36983705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 36993705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 37003705ce5bSJoe Perches $fix) { 3701194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 37023705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 37033705ce5bSJoe Perches my $comment = trim($1); 3704194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 37053705ce5bSJoe Perches } 37063705ce5bSJoe Perches } 370700df344fSAndy Whitcroft } 370800df344fSAndy Whitcroft # Remove C99 comments. 37090a920b5bSAndy Whitcroft $line =~ s@//.*@@; 37106c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 37110a920b5bSAndy Whitcroft 37122b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 37132b474a1aSAndy Whitcroft# the whole statement. 37142b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 37152b474a1aSAndy Whitcroft if (defined $realline_next && 37162b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 37172b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 37182b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 37192b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 37203cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 37213cbf62dfSAndy Whitcroft # a prefix: 37223cbf62dfSAndy Whitcroft # XXX(foo); 37233cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3724653d4876SAndy Whitcroft my $name = $1; 372587a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 37263cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 37273cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 37283cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 37293cbf62dfSAndy Whitcroft 37303cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 37312b474a1aSAndy Whitcroft \n.}\s*$| 373248012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 373348012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 373448012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 37352b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 37362b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 373748012058SAndy Whitcroft )/x) { 37382b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 37392b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 37402b474a1aSAndy Whitcroft } else { 37412b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 37420a920b5bSAndy Whitcroft } 37430a920b5bSAndy Whitcroft } 37442b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 37452b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 37462b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 37472b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 37482b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 37492b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 37502b474a1aSAndy Whitcroft } 37512b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 37522b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3753000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3754000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 37552b474a1aSAndy Whitcroft } 37560a920b5bSAndy Whitcroft 37575150bda4SJoe Eloff# check for global initialisers. 37586d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 3759d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 37606d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 3761d5e616fcSJoe Perches $fix) { 37626d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 3763d5e616fcSJoe Perches } 3764f0a594c1SAndy Whitcroft } 37650a920b5bSAndy Whitcroft# check for static initialisers. 37666d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 3767d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 37686d32f7a3SJoe Perches "do not initialise statics to $1\n" . 3769d5e616fcSJoe Perches $herecurr) && 3770d5e616fcSJoe Perches $fix) { 37716d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 3772d5e616fcSJoe Perches } 37730a920b5bSAndy Whitcroft } 37740a920b5bSAndy Whitcroft 37751813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 37761813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 37771813087dSJoe Perches my $tmp = trim($1); 37781813087dSJoe Perches WARN("MISORDERED_TYPE", 37791813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 37801813087dSJoe Perches } 37811813087dSJoe Perches 3782cb710ecaSJoe Perches# check for static const char * arrays. 3783cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3784000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3785000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3786cb710ecaSJoe Perches $herecurr); 3787cb710ecaSJoe Perches } 3788cb710ecaSJoe Perches 3789cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3790cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3791000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3792000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3793cb710ecaSJoe Perches $herecurr); 3794cb710ecaSJoe Perches } 3795cb710ecaSJoe Perches 3796ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3797ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3798ab7e23f3SJoe Perches my $found = $1; 3799ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3800ab7e23f3SJoe Perches WARN("CONST_CONST", 3801ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3802ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3803ab7e23f3SJoe Perches WARN("CONST_CONST", 3804ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3805ab7e23f3SJoe Perches } 3806ab7e23f3SJoe Perches } 3807ab7e23f3SJoe Perches 38089b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 38099b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 38109b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 38119b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 38129b0fa60dSJoe Perches $herecurr); 38139b0fa60dSJoe Perches } 38149b0fa60dSJoe Perches 3815b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3816b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3817b598b670SJoe Perches my $array = $1; 3818b598b670SJoe 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*\))@) { 3819b598b670SJoe Perches my $array_div = $1; 3820b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3821b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3822b598b670SJoe Perches $fix) { 3823b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3824b598b670SJoe Perches } 3825b598b670SJoe Perches } 3826b598b670SJoe Perches } 3827b598b670SJoe Perches 3828b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3829b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3830b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3831b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3832b36190c5SJoe Perches $fix) { 3833194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3834b36190c5SJoe Perches } 3835b36190c5SJoe Perches } 3836b36190c5SJoe Perches 3837653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3838653d4876SAndy Whitcroft# make sense. 3839653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 38408054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3841c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 38428ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 384346d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 3844000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3845000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 38460a920b5bSAndy Whitcroft } 38470a920b5bSAndy Whitcroft 38480a920b5bSAndy Whitcroft# * goes on variable not on type 384965863862SAndy Whitcroft # (char*[ const]) 3850bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3851bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 38523705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3853d8aaf121SAndy Whitcroft 385465863862SAndy Whitcroft # Should start with a space. 385565863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 385665863862SAndy Whitcroft # Should not end with a space. 385765863862SAndy Whitcroft $to =~ s/\s+$//; 385865863862SAndy Whitcroft # '*'s should not have spaces between. 3859f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 386065863862SAndy Whitcroft } 3861d8aaf121SAndy Whitcroft 38623705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 386365863862SAndy Whitcroft if ($from ne $to) { 38643705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 38653705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 38663705ce5bSJoe Perches $fix) { 38673705ce5bSJoe Perches my $sub_from = $ident; 38683705ce5bSJoe Perches my $sub_to = $ident; 38693705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3870194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38713705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 38723705ce5bSJoe Perches } 387365863862SAndy Whitcroft } 3874bfcb2cc7SAndy Whitcroft } 3875bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3876bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 38773705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3878d8aaf121SAndy Whitcroft 387965863862SAndy Whitcroft # Should start with a space. 388065863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 388165863862SAndy Whitcroft # Should not end with a space. 388265863862SAndy Whitcroft $to =~ s/\s+$//; 388365863862SAndy Whitcroft # '*'s should not have spaces between. 3884f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 388565863862SAndy Whitcroft } 388665863862SAndy Whitcroft # Modifiers should have spaces. 388765863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 388865863862SAndy Whitcroft 38893705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3890667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 38913705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 38923705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 38933705ce5bSJoe Perches $fix) { 38943705ce5bSJoe Perches 38953705ce5bSJoe Perches my $sub_from = $match; 38963705ce5bSJoe Perches my $sub_to = $match; 38973705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3898194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38993705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 39003705ce5bSJoe Perches } 390165863862SAndy Whitcroft } 39020a920b5bSAndy Whitcroft } 39030a920b5bSAndy Whitcroft 39049d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 39059d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 39060675a8fbSJean Delvare my $msg_level = \&WARN; 39070675a8fbSJean Delvare $msg_level = \&CHK if ($file); 39080675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 39099d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 39109d3e3c70SJoe Perches } 39110a920b5bSAndy Whitcroft 39129d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 39138905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3914000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3915000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 39168905a67cSAndy Whitcroft } 39178905a67cSAndy Whitcroft 391817441227SJoe Perches# check for uses of printk_ratelimit 391917441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3920000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3921000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 392217441227SJoe Perches } 392317441227SJoe Perches 3924eeef5733SJoe Perches# printk should use KERN_* levels 3925eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 3926000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3927eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 392800df344fSAndy Whitcroft } 39290a920b5bSAndy Whitcroft 3930243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3931243f3803SJoe Perches my $orig = $1; 3932243f3803SJoe Perches my $level = lc($orig); 3933243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 39348f26b837SJoe Perches my $level2 = $level; 39358f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3936243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3937daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3938243f3803SJoe Perches } 3939243f3803SJoe Perches 3940243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3941d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3942d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3943d5e616fcSJoe Perches $fix) { 3944194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3945d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3946d5e616fcSJoe Perches } 3947243f3803SJoe Perches } 3948243f3803SJoe Perches 3949dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3950dc139313SJoe Perches my $orig = $1; 3951dc139313SJoe Perches my $level = lc($orig); 3952dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3953dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3954dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3955dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3956dc139313SJoe Perches } 3957dc139313SJoe Perches 395891c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 395991c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 396091c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 396191c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 396291c9afafSAndy Lutomirski WARN("ENOSYS", 396391c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 396491c9afafSAndy Lutomirski } 396591c9afafSAndy Lutomirski 3966653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3967653d4876SAndy Whitcroft# or if closed on same line 39682d453e3bSJoe Perches if ($^V && $^V ge 5.10.0 && 39692d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 39702d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 39712d453e3bSJoe Perches $sline !~ /}/) { 39728d182478SJoe Perches if (ERROR("OPEN_BRACE", 39732d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 39748d182478SJoe Perches $fix) { 39758d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 39768d182478SJoe Perches my $fixed_line = $rawline; 39778d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 39788d182478SJoe Perches my $line1 = $1; 39798d182478SJoe Perches my $line2 = $2; 39808d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 39818d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 39828d182478SJoe Perches if ($line2 !~ /^\s*$/) { 39838d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 39848d182478SJoe Perches } 39858d182478SJoe Perches } 39860a920b5bSAndy Whitcroft } 3987653d4876SAndy Whitcroft 39888905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 39898905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 39908905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 39918d182478SJoe Perches if (ERROR("OPEN_BRACE", 39928d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 39938d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 39948d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 39958d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 39968d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 39978d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 39988d182478SJoe Perches $fixedline = $rawline; 39998d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 40008d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 40018d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 40028d182478SJoe Perches } 40038d182478SJoe Perches } 40048905a67cSAndy Whitcroft } 40058905a67cSAndy Whitcroft 40060c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 40073705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 40083705ce5bSJoe Perches if (WARN("SPACING", 40093705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 40103705ce5bSJoe Perches $fix) { 4011194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40123705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 40133705ce5bSJoe Perches } 40140c73b4ebSAndy Whitcroft } 40150c73b4ebSAndy Whitcroft 401631070b5dSJoe Perches# Function pointer declarations 401731070b5dSJoe Perches# check spacing between type, funcptr, and args 401831070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 401991f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 402031070b5dSJoe Perches my $declare = $1; 402131070b5dSJoe Perches my $pre_pointer_space = $2; 402231070b5dSJoe Perches my $post_pointer_space = $3; 402331070b5dSJoe Perches my $funcname = $4; 402431070b5dSJoe Perches my $post_funcname_space = $5; 402531070b5dSJoe Perches my $pre_args_space = $6; 402631070b5dSJoe Perches 402791f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 402891f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 402991f72e9cSJoe Perches# don't need a space so don't warn for those. 403091f72e9cSJoe Perches my $post_declare_space = ""; 403191f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 403291f72e9cSJoe Perches $post_declare_space = $1; 403391f72e9cSJoe Perches $declare = rtrim($declare); 403491f72e9cSJoe Perches } 403591f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 403631070b5dSJoe Perches WARN("SPACING", 403731070b5dSJoe Perches "missing space after return type\n" . $herecurr); 403891f72e9cSJoe Perches $post_declare_space = " "; 403931070b5dSJoe Perches } 404031070b5dSJoe Perches 404131070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 404291f72e9cSJoe Perches# This test is not currently implemented because these declarations are 404391f72e9cSJoe Perches# equivalent to 404491f72e9cSJoe Perches# int foo(int bar, ...) 404591f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 404691f72e9cSJoe Perches# 404791f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 404891f72e9cSJoe Perches# WARN("SPACING", 404991f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 405091f72e9cSJoe Perches# } 405131070b5dSJoe Perches 405231070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 405331070b5dSJoe Perches if (defined $pre_pointer_space && 405431070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 405531070b5dSJoe Perches WARN("SPACING", 405631070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 405731070b5dSJoe Perches } 405831070b5dSJoe Perches 405931070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 406031070b5dSJoe Perches if (defined $post_pointer_space && 406131070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 406231070b5dSJoe Perches WARN("SPACING", 406331070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 406431070b5dSJoe Perches } 406531070b5dSJoe Perches 406631070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 406731070b5dSJoe Perches if (defined $post_funcname_space && 406831070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 406931070b5dSJoe Perches WARN("SPACING", 407031070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 407131070b5dSJoe Perches } 407231070b5dSJoe Perches 407331070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 407431070b5dSJoe Perches if (defined $pre_args_space && 407531070b5dSJoe Perches $pre_args_space =~ /^\s/) { 407631070b5dSJoe Perches WARN("SPACING", 407731070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 407831070b5dSJoe Perches } 407931070b5dSJoe Perches 408031070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4081194f66fcSJoe Perches $fixed[$fixlinenr] =~ 408291f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 408331070b5dSJoe Perches } 408431070b5dSJoe Perches } 408531070b5dSJoe Perches 40868d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 40878d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4088fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4089fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 40908d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 40918d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 40928d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4093fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 409438dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 40953705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 40963705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 40973705ce5bSJoe Perches $fix) { 4098194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40993705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 41003705ce5bSJoe Perches } 41018d31cfceSAndy Whitcroft } 41028d31cfceSAndy Whitcroft } 41038d31cfceSAndy Whitcroft 4104f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 41056c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4106c2fdda0dSAndy Whitcroft my $name = $1; 4107773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4108773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4109c2fdda0dSAndy Whitcroft 4110c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4111773647a0SAndy Whitcroft if ($name =~ /^(?: 4112773647a0SAndy Whitcroft if|for|while|switch|return|case| 4113773647a0SAndy Whitcroft volatile|__volatile__| 4114773647a0SAndy Whitcroft __attribute__|format|__extension__| 4115773647a0SAndy Whitcroft asm|__asm__)$/x) 4116773647a0SAndy Whitcroft { 4117c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4118c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4119c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4120c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4121773647a0SAndy Whitcroft 4122773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4123c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4124c2fdda0dSAndy Whitcroft 4125c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4126c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4127773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4128c2fdda0dSAndy Whitcroft 4129c2fdda0dSAndy Whitcroft } else { 41303705ce5bSJoe Perches if (WARN("SPACING", 41313705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 41323705ce5bSJoe Perches $fix) { 4133194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41343705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 41353705ce5bSJoe Perches } 4136f0a594c1SAndy Whitcroft } 41376c72ffaaSAndy Whitcroft } 41389a4cad4eSEric Nelson 4139653d4876SAndy Whitcroft# Check operator spacing. 41400a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 41413705ce5bSJoe Perches my $fixed_line = ""; 41423705ce5bSJoe Perches my $line_fixed = 0; 41433705ce5bSJoe Perches 41449c0ca6f9SAndy Whitcroft my $ops = qr{ 41459c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 41469c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 41479c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 41481f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 414984731623SJoe Perches \?:|\?|: 41509c0ca6f9SAndy Whitcroft }x; 4151cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 41523705ce5bSJoe Perches 41533705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 41543705ce5bSJoe Perches## foreach my $el (@elements) { 41553705ce5bSJoe Perches## print("el: <$el>\n"); 41563705ce5bSJoe Perches## } 41573705ce5bSJoe Perches 41583705ce5bSJoe Perches my @fix_elements = (); 415900df344fSAndy Whitcroft my $off = 0; 41606c72ffaaSAndy Whitcroft 41613705ce5bSJoe Perches foreach my $el (@elements) { 41623705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 41633705ce5bSJoe Perches $off += length($el); 41643705ce5bSJoe Perches } 41653705ce5bSJoe Perches 41663705ce5bSJoe Perches $off = 0; 41673705ce5bSJoe Perches 41686c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4169b34c648bSJoe Perches my $last_after = -1; 41706c72ffaaSAndy Whitcroft 41710a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 41723705ce5bSJoe Perches 41733705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 41743705ce5bSJoe Perches 41753705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 41763705ce5bSJoe Perches 41774a0df2efSAndy Whitcroft $off += length($elements[$n]); 41784a0df2efSAndy Whitcroft 417925985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4180773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4181773647a0SAndy Whitcroft my $cc = ''; 4182773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4183773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4184773647a0SAndy Whitcroft } 4185773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4186773647a0SAndy Whitcroft 41874a0df2efSAndy Whitcroft my $a = ''; 41884a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 41894a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4190cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 41914a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 41924a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 4193773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 41944a0df2efSAndy Whitcroft 41950a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 41964a0df2efSAndy Whitcroft 41974a0df2efSAndy Whitcroft my $c = ''; 41980a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 41994a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 42004a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4201cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 42024a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 42034a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 42048b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 42054a0df2efSAndy Whitcroft } else { 42064a0df2efSAndy Whitcroft $c = 'E'; 42070a920b5bSAndy Whitcroft } 42080a920b5bSAndy Whitcroft 42094a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 42104a0df2efSAndy Whitcroft 42114a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 42124a0df2efSAndy Whitcroft 42136c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 4214de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 42150a920b5bSAndy Whitcroft 421674048ed8SAndy Whitcroft # Pull out the value of this operator. 42176c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 42180a920b5bSAndy Whitcroft 42191f65f947SAndy Whitcroft # Get the full operator variant. 42201f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 42211f65f947SAndy Whitcroft 422213214adfSAndy Whitcroft # Ignore operators passed as parameters. 422313214adfSAndy Whitcroft if ($op_type ne 'V' && 4224d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 422513214adfSAndy Whitcroft 4226cf655043SAndy Whitcroft# # Ignore comments 4227cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 422813214adfSAndy Whitcroft 4229d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 423013214adfSAndy Whitcroft } elsif ($op eq ';') { 4231cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 4232cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 42333705ce5bSJoe Perches if (ERROR("SPACING", 42343705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 4235b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 42363705ce5bSJoe Perches $line_fixed = 1; 42373705ce5bSJoe Perches } 4238d8aaf121SAndy Whitcroft } 4239d8aaf121SAndy Whitcroft 4240d8aaf121SAndy Whitcroft # // is a comment 4241d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 42420a920b5bSAndy Whitcroft 4243b00e4814SJoe Perches # : when part of a bitfield 4244b00e4814SJoe Perches } elsif ($opv eq ':B') { 4245b00e4814SJoe Perches # skip the bitfield test for now 4246b00e4814SJoe Perches 42471f65f947SAndy Whitcroft # No spaces for: 42481f65f947SAndy Whitcroft # -> 4249b00e4814SJoe Perches } elsif ($op eq '->') { 42504a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 42513705ce5bSJoe Perches if (ERROR("SPACING", 42523705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4253b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 42543705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 42553705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 42563705ce5bSJoe Perches } 4257b34c648bSJoe Perches $line_fixed = 1; 42583705ce5bSJoe Perches } 42590a920b5bSAndy Whitcroft } 42600a920b5bSAndy Whitcroft 42612381097bSJoe Perches # , must not have a space before and must have a space on the right. 42620a920b5bSAndy Whitcroft } elsif ($op eq ',') { 42632381097bSJoe Perches my $rtrim_before = 0; 42642381097bSJoe Perches my $space_after = 0; 42652381097bSJoe Perches if ($ctx =~ /Wx./) { 42662381097bSJoe Perches if (ERROR("SPACING", 42672381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 42682381097bSJoe Perches $line_fixed = 1; 42692381097bSJoe Perches $rtrim_before = 1; 42702381097bSJoe Perches } 42712381097bSJoe Perches } 4272cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 42733705ce5bSJoe Perches if (ERROR("SPACING", 42743705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 42753705ce5bSJoe Perches $line_fixed = 1; 4276b34c648bSJoe Perches $last_after = $n; 42772381097bSJoe Perches $space_after = 1; 42782381097bSJoe Perches } 42792381097bSJoe Perches } 42802381097bSJoe Perches if ($rtrim_before || $space_after) { 42812381097bSJoe Perches if ($rtrim_before) { 42822381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 42832381097bSJoe Perches } else { 42842381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 42852381097bSJoe Perches } 42862381097bSJoe Perches if ($space_after) { 42872381097bSJoe Perches $good .= " "; 42883705ce5bSJoe Perches } 42890a920b5bSAndy Whitcroft } 42900a920b5bSAndy Whitcroft 42919c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 429274048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 42939c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 42949c0ca6f9SAndy Whitcroft 42959c0ca6f9SAndy Whitcroft # unary operators should have a space before and 42969c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 42979c0ca6f9SAndy Whitcroft # unary operator, or a cast 42989c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 429974048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 43000d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4301cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 43023705ce5bSJoe Perches if (ERROR("SPACING", 43033705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4304b34c648bSJoe Perches if ($n != $last_after + 2) { 4305b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 43063705ce5bSJoe Perches $line_fixed = 1; 43073705ce5bSJoe Perches } 43080a920b5bSAndy Whitcroft } 4309b34c648bSJoe Perches } 4310a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4311171ae1a4SAndy Whitcroft # A unary '*' may be const 4312171ae1a4SAndy Whitcroft 4313171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 43143705ce5bSJoe Perches if (ERROR("SPACING", 43153705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4316b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 43173705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 43183705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 43193705ce5bSJoe Perches } 4320b34c648bSJoe Perches $line_fixed = 1; 43213705ce5bSJoe Perches } 43220a920b5bSAndy Whitcroft } 43230a920b5bSAndy Whitcroft 43240a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 43250a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4326773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 43273705ce5bSJoe Perches if (ERROR("SPACING", 43283705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4329b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 43303705ce5bSJoe Perches $line_fixed = 1; 43313705ce5bSJoe Perches } 43320a920b5bSAndy Whitcroft } 4333773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4334773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 43353705ce5bSJoe Perches if (ERROR("SPACING", 43363705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4337b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43383705ce5bSJoe Perches $line_fixed = 1; 43393705ce5bSJoe Perches } 4340653d4876SAndy Whitcroft } 4341773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 43423705ce5bSJoe Perches if (ERROR("SPACING", 43433705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4344b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 43453705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 43463705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4347773647a0SAndy Whitcroft } 4348b34c648bSJoe Perches $line_fixed = 1; 43493705ce5bSJoe Perches } 43503705ce5bSJoe Perches } 43510a920b5bSAndy Whitcroft 43520a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 43539c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 43549c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 43559c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4356c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4357c2fdda0dSAndy Whitcroft $op eq '%') 43580a920b5bSAndy Whitcroft { 4359d2e025f3SJoe Perches if ($check) { 4360d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4361d2e025f3SJoe Perches if (CHK("SPACING", 4362d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4363d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4364d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4365d2e025f3SJoe Perches $line_fixed = 1; 4366d2e025f3SJoe Perches } 4367d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4368d2e025f3SJoe Perches if (CHK("SPACING", 4369d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4370d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4371d2e025f3SJoe Perches $line_fixed = 1; 4372d2e025f3SJoe Perches } 4373d2e025f3SJoe Perches } 4374d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 43753705ce5bSJoe Perches if (ERROR("SPACING", 43763705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4377b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4378b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4379b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4380b34c648bSJoe Perches } 43813705ce5bSJoe Perches $line_fixed = 1; 43823705ce5bSJoe Perches } 43830a920b5bSAndy Whitcroft } 43840a920b5bSAndy Whitcroft 43851f65f947SAndy Whitcroft # A colon needs no spaces before when it is 43861f65f947SAndy Whitcroft # terminating a case value or a label. 43871f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 43881f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 43893705ce5bSJoe Perches if (ERROR("SPACING", 43903705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4391b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43923705ce5bSJoe Perches $line_fixed = 1; 43933705ce5bSJoe Perches } 43941f65f947SAndy Whitcroft } 43951f65f947SAndy Whitcroft 43960a920b5bSAndy Whitcroft # All the others need spaces both sides. 4397cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 43981f65f947SAndy Whitcroft my $ok = 0; 43991f65f947SAndy Whitcroft 440022f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 44011f65f947SAndy Whitcroft if (($op eq '<' && 44021f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 44031f65f947SAndy Whitcroft ($op eq '>' && 44041f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 44051f65f947SAndy Whitcroft { 44061f65f947SAndy Whitcroft $ok = 1; 44071f65f947SAndy Whitcroft } 44081f65f947SAndy Whitcroft 4409e0df7e1fSJoe Perches # for asm volatile statements 4410e0df7e1fSJoe Perches # ignore a colon with another 4411e0df7e1fSJoe Perches # colon immediately before or after 4412e0df7e1fSJoe Perches if (($op eq ':') && 4413e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4414e0df7e1fSJoe Perches $ok = 1; 4415e0df7e1fSJoe Perches } 4416e0df7e1fSJoe Perches 441784731623SJoe Perches # messages are ERROR, but ?: are CHK 44181f65f947SAndy Whitcroft if ($ok == 0) { 44190675a8fbSJean Delvare my $msg_level = \&ERROR; 44200675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 442184731623SJoe Perches 44220675a8fbSJean Delvare if (&{$msg_level}("SPACING", 44233705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4424b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4425b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4426b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4427b34c648bSJoe Perches } 44283705ce5bSJoe Perches $line_fixed = 1; 44293705ce5bSJoe Perches } 44300a920b5bSAndy Whitcroft } 443122f2a2efSAndy Whitcroft } 44324a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 44333705ce5bSJoe Perches 44343705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 44353705ce5bSJoe Perches 44363705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 44370a920b5bSAndy Whitcroft } 44383705ce5bSJoe Perches 44393705ce5bSJoe Perches if (($#elements % 2) == 0) { 44403705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 44413705ce5bSJoe Perches } 44423705ce5bSJoe Perches 4443194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4444194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 44453705ce5bSJoe Perches } 44463705ce5bSJoe Perches 44473705ce5bSJoe Perches 44480a920b5bSAndy Whitcroft } 44490a920b5bSAndy Whitcroft 4450786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4451d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4452786b6326SJoe Perches if (WARN("SPACING", 4453786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4454786b6326SJoe Perches $fix) { 4455194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4456786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4457786b6326SJoe Perches } 4458786b6326SJoe Perches } 4459786b6326SJoe Perches 4460f0a594c1SAndy Whitcroft# check for multiple assignments 4461f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4462000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4463000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4464f0a594c1SAndy Whitcroft } 4465f0a594c1SAndy Whitcroft 446622f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 446722f2a2efSAndy Whitcroft## # continuation. 446822f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 446922f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 447022f2a2efSAndy Whitcroft## 447122f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 447222f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 447322f2a2efSAndy Whitcroft## my $ln = $line; 447422f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 447522f2a2efSAndy Whitcroft## } 447622f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4477000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4478000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 447922f2a2efSAndy Whitcroft## } 448022f2a2efSAndy Whitcroft## } 4481f0a594c1SAndy Whitcroft 44820a920b5bSAndy Whitcroft#need space before brace following if, while, etc 44836b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 44844e5d56bdSEddie Kovsky $line =~ /do\{/) { 44853705ce5bSJoe Perches if (ERROR("SPACING", 44863705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 44873705ce5bSJoe Perches $fix) { 44888d81ae05SCyril Bur $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/; 44893705ce5bSJoe Perches } 4490de7d4f0eSAndy Whitcroft } 4491de7d4f0eSAndy Whitcroft 4492c4a62ef9SJoe Perches## # check for blank lines before declarations 4493c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4494c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4495c4a62ef9SJoe Perches## WARN("SPACING", 4496c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4497c4a62ef9SJoe Perches## } 4498c4a62ef9SJoe Perches## 4499c4a62ef9SJoe Perches 4500de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4501de7d4f0eSAndy Whitcroft# on the line 4502de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4503d5e616fcSJoe Perches if (ERROR("SPACING", 4504d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4505d5e616fcSJoe Perches $fix) { 4506194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4507d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4508d5e616fcSJoe Perches } 45090a920b5bSAndy Whitcroft } 45100a920b5bSAndy Whitcroft 451122f2a2efSAndy Whitcroft# check spacing on square brackets 451222f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 45133705ce5bSJoe Perches if (ERROR("SPACING", 45143705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 45153705ce5bSJoe Perches $fix) { 4516194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45173705ce5bSJoe Perches s/\[\s+/\[/; 45183705ce5bSJoe Perches } 451922f2a2efSAndy Whitcroft } 452022f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 45213705ce5bSJoe Perches if (ERROR("SPACING", 45223705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 45233705ce5bSJoe Perches $fix) { 4524194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45253705ce5bSJoe Perches s/\s+\]/\]/; 45263705ce5bSJoe Perches } 452722f2a2efSAndy Whitcroft } 452822f2a2efSAndy Whitcroft 4529c45dcabdSAndy Whitcroft# check spacing on parentheses 45309c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 45319c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 45323705ce5bSJoe Perches if (ERROR("SPACING", 45333705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 45343705ce5bSJoe Perches $fix) { 4535194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45363705ce5bSJoe Perches s/\(\s+/\(/; 45373705ce5bSJoe Perches } 453822f2a2efSAndy Whitcroft } 453913214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4540c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4541c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 45423705ce5bSJoe Perches if (ERROR("SPACING", 45433705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 45443705ce5bSJoe Perches $fix) { 4545194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45463705ce5bSJoe Perches s/\s+\)/\)/; 45473705ce5bSJoe Perches } 454822f2a2efSAndy Whitcroft } 454922f2a2efSAndy Whitcroft 4550e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4551e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4552e2826fd0SJoe Perches 4553e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4554ea4acbb1SJoe Perches my $var = $1; 4555ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4556ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4557ea4acbb1SJoe Perches $fix) { 4558ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4559ea4acbb1SJoe Perches } 4560ea4acbb1SJoe Perches } 4561ea4acbb1SJoe Perches 4562ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4563ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4564ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4565ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4566ea4acbb1SJoe Perches my $var = $2; 4567ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4568ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4569ea4acbb1SJoe Perches $fix) { 4570ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4571ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4572ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4573ea4acbb1SJoe Perches } 4574e2826fd0SJoe Perches } 4575e2826fd0SJoe Perches 457663b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 4577a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 4578a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 4579a032aa4cSJoe Perches $^V && $^V ge 5.10.0 && defined($stat) && 458063b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 458163b7c73eSJoe Perches my $if_stat = $1; 458263b7c73eSJoe Perches my $test = substr($2, 1, -1); 458363b7c73eSJoe Perches my $herectx; 458463b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 458563b7c73eSJoe Perches my $match = $1; 458663b7c73eSJoe Perches # avoid parentheses around potential macro args 458763b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 458863b7c73eSJoe Perches if (!defined($herectx)) { 458963b7c73eSJoe Perches $herectx = $here . "\n"; 459063b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 459163b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 459263b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 459363b7c73eSJoe Perches $herectx .= $rl . "\n"; 459463b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 459563b7c73eSJoe Perches } 459663b7c73eSJoe Perches } 459763b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 459863b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 459963b7c73eSJoe Perches } 460063b7c73eSJoe Perches } 460163b7c73eSJoe Perches 46020a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 46034a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 46040a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 46053705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 46063705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 46073705ce5bSJoe Perches $fix) { 4608194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46093705ce5bSJoe Perches s/^(.)\s+/$1/; 46103705ce5bSJoe Perches } 46110a920b5bSAndy Whitcroft } 46120a920b5bSAndy Whitcroft 46135b9553abSJoe Perches# return is not a function 4614507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4615c45dcabdSAndy Whitcroft my $spacing = $1; 4616507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 46175b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 46185b9553abSJoe Perches my $value = $1; 46195b9553abSJoe Perches $value = deparenthesize($value); 46205b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4621000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4622000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 46235b9553abSJoe Perches } 4624c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4625000d1cc1SJoe Perches ERROR("SPACING", 4626000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4627c45dcabdSAndy Whitcroft } 4628c45dcabdSAndy Whitcroft } 4629507e5141SJoe Perches 4630b43ae21bSJoe Perches# unnecessary return in a void function 4631b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4632b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4633b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4634b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4635b43ae21bSJoe Perches $linenr >= 3 && 4636b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4637b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 46389819cf25SJoe Perches WARN("RETURN_VOID", 4639b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 46409819cf25SJoe Perches } 46419819cf25SJoe Perches 4642189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4643189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4644189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4645189248d8SJoe Perches my $openparens = $1; 4646189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4647189248d8SJoe Perches my $msg = ""; 4648189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4649189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4650189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4651189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4652189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4653189248d8SJoe Perches } 4654189248d8SJoe Perches } 4655189248d8SJoe Perches 4656c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4657c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4658c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4659c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 4660c5595fa2SJoe Perches if ($^V && $^V ge 5.10.0 && 4661c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4662c5595fa2SJoe Perches my $lead = $1; 4663c5595fa2SJoe Perches my $const = $2; 4664c5595fa2SJoe Perches my $comp = $3; 4665c5595fa2SJoe Perches my $to = $4; 4666c5595fa2SJoe Perches my $newcomp = $comp; 4667f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 4668c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4669c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4670c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4671c5595fa2SJoe Perches $fix) { 4672c5595fa2SJoe Perches if ($comp eq "<") { 4673c5595fa2SJoe Perches $newcomp = ">"; 4674c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4675c5595fa2SJoe Perches $newcomp = ">="; 4676c5595fa2SJoe Perches } elsif ($comp eq ">") { 4677c5595fa2SJoe Perches $newcomp = "<"; 4678c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4679c5595fa2SJoe Perches $newcomp = "<="; 4680c5595fa2SJoe Perches } 4681c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4682c5595fa2SJoe Perches } 4683c5595fa2SJoe Perches } 4684c5595fa2SJoe Perches 4685f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4686f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 468753a3c448SAndy Whitcroft my $name = $1; 468853a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4689000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4690f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 469153a3c448SAndy Whitcroft } 469253a3c448SAndy Whitcroft } 4693c45dcabdSAndy Whitcroft 46940a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 46954a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 46963705ce5bSJoe Perches if (ERROR("SPACING", 46973705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 46983705ce5bSJoe Perches $fix) { 4699194f66fcSJoe Perches $fixed[$fixlinenr] =~ 47003705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 47013705ce5bSJoe Perches } 47020a920b5bSAndy Whitcroft } 47030a920b5bSAndy Whitcroft 4704f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4705f5fe35ddSAndy Whitcroft# statements after the conditional. 4706170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 47073e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 47083e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 47093e469cdcSAndy Whitcroft if (!defined $stat); 4710170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4711170d3a22SAndy Whitcroft $remain_next, $off_next); 4712170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4713170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4714170d3a22SAndy Whitcroft 4715170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4716170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4717170d3a22SAndy Whitcroft # then count those as offsets. 4718170d3a22SAndy Whitcroft my ($whitespace) = 4719170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4720170d3a22SAndy Whitcroft my $offset = 4721170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4722170d3a22SAndy Whitcroft 4723170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4724170d3a22SAndy Whitcroft $offset} = 1; 4725170d3a22SAndy Whitcroft } 4726170d3a22SAndy Whitcroft } 4727170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4728c11230f4SJoe Perches defined($stat) && defined($cond) && 4729170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4730171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 47318905a67cSAndy Whitcroft 4732b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4733000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4734000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 47358905a67cSAndy Whitcroft } 47368905a67cSAndy Whitcroft 47378905a67cSAndy Whitcroft # Find out what is on the end of the line after the 47388905a67cSAndy Whitcroft # conditional. 4739773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 47408905a67cSAndy Whitcroft $s =~ s/\n.*//g; 474113214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 474253210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 474353210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4744773647a0SAndy Whitcroft { 4745bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4746bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4747bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 474842bdf74cSHidetoshi Seto my $stat_real = ''; 4749bb44ad39SAndy Whitcroft 475042bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 475142bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4752bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4753bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4754bb44ad39SAndy Whitcroft } 4755bb44ad39SAndy Whitcroft 4756000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4757000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 47588905a67cSAndy Whitcroft } 47598905a67cSAndy Whitcroft } 47608905a67cSAndy Whitcroft 476113214adfSAndy Whitcroft# Check for bitwise tests written as boolean 476213214adfSAndy Whitcroft if ($line =~ / 476313214adfSAndy Whitcroft (?: 476413214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 476513214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 476613214adfSAndy Whitcroft (?:\&\&|\|\|) 476713214adfSAndy Whitcroft | 476813214adfSAndy Whitcroft (?:\&\&|\|\|) 476913214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 477013214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 477113214adfSAndy Whitcroft )/x) 477213214adfSAndy Whitcroft { 4773000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4774000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 477513214adfSAndy Whitcroft } 477613214adfSAndy Whitcroft 47778905a67cSAndy Whitcroft# if and else should not have general statements after it 477813214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 477913214adfSAndy Whitcroft my $s = $1; 478013214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 478113214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4782000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4783000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 47840a920b5bSAndy Whitcroft } 478513214adfSAndy Whitcroft } 478639667782SAndy Whitcroft# if should not continue a brace 478739667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4788000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4789048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 479039667782SAndy Whitcroft $herecurr); 479139667782SAndy Whitcroft } 4792a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4793a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4794a1080bf8SAndy Whitcroft $line !~ /\G(?: 47953fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4796a1080bf8SAndy Whitcroft \s*return\s+ 4797a1080bf8SAndy Whitcroft )/xg) 4798a1080bf8SAndy Whitcroft { 4799000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4800000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4801a1080bf8SAndy Whitcroft } 48020a920b5bSAndy Whitcroft 48030a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 48040a920b5bSAndy Whitcroft # indent level to be relevant to each other. 48058b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 48060a920b5bSAndy Whitcroft $previndent == $indent) { 48078b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 48088b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 48098b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 48108b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48118b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 48128b8856f4SJoe Perches my $fixedline = $prevrawline; 48138b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 48148b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 48158b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48168b8856f4SJoe Perches } 48178b8856f4SJoe Perches $fixedline = $rawline; 48188b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 48198b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48208b8856f4SJoe Perches } 48210a920b5bSAndy Whitcroft } 48220a920b5bSAndy Whitcroft 48238b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4824c2fdda0dSAndy Whitcroft $previndent == $indent) { 4825c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4826c2fdda0dSAndy Whitcroft 4827c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4828c2fdda0dSAndy Whitcroft # conditional. 4829773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4830c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4831c2fdda0dSAndy Whitcroft 4832c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 48338b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 48348b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 48358b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 48368b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48378b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 48388b8856f4SJoe Perches my $fixedline = $prevrawline; 48398b8856f4SJoe Perches my $trailing = $rawline; 48408b8856f4SJoe Perches $trailing =~ s/^\+//; 48418b8856f4SJoe Perches $trailing = trim($trailing); 48428b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 48438b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48448b8856f4SJoe Perches } 4845c2fdda0dSAndy Whitcroft } 4846c2fdda0dSAndy Whitcroft } 4847c2fdda0dSAndy Whitcroft 484895e2c602SJoe Perches#Specific variable tests 4849323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4850323c1260SJoe Perches my $var = $1; 485195e2c602SJoe Perches 485295e2c602SJoe Perches#gcc binary extension 485395e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4854d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4855d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4856d5e616fcSJoe Perches $fix) { 4857d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4858194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4859d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4860d5e616fcSJoe Perches } 486195e2c602SJoe Perches } 486295e2c602SJoe Perches 486395e2c602SJoe Perches#CamelCase 4864807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4865be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 486622735ce8SJoe Perches#Ignore Page<foo> variants 4867807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 486822735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4869f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4870f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4871f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 48727e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 48737e781f67SJoe Perches my $word = $1; 48747e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4875d8b07710SJoe Perches if ($check) { 4876d8b07710SJoe Perches seed_camelcase_includes(); 4877d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4878d8b07710SJoe Perches seed_camelcase_file($realfile); 4879d8b07710SJoe Perches $camelcase_file_seeded = 1; 4880d8b07710SJoe Perches } 4881d8b07710SJoe Perches } 48827e781f67SJoe Perches if (!defined $camelcase{$word}) { 48837e781f67SJoe Perches $camelcase{$word} = 1; 4884be79794bSJoe Perches CHK("CAMELCASE", 48857e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 48867e781f67SJoe Perches } 4887323c1260SJoe Perches } 4888323c1260SJoe Perches } 48893445686aSJoe Perches } 48900a920b5bSAndy Whitcroft 48910a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4892d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4893d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4894d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4895d5e616fcSJoe Perches $fix) { 4896194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4897d5e616fcSJoe Perches } 48980a920b5bSAndy Whitcroft } 48990a920b5bSAndy Whitcroft 49000e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 49010e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4902c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4903e09dec48SAndy Whitcroft my $file = "$1.h"; 4904e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4905e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4906e09dec48SAndy Whitcroft $realfile ne $checkfile && 49077840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4908c45dcabdSAndy Whitcroft { 49090e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 49100e212e0aSFabian Frederick if ($asminclude > 0) { 4911e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4912000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4913000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4914e09dec48SAndy Whitcroft } else { 4915000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4916000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4917e09dec48SAndy Whitcroft } 49180a920b5bSAndy Whitcroft } 49190a920b5bSAndy Whitcroft } 49200e212e0aSFabian Frederick } 49210a920b5bSAndy Whitcroft 4922653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4923653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4924cf655043SAndy Whitcroft# in a known good container 4925b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4926b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4927d8aaf121SAndy Whitcroft my $ln = $linenr; 4928d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4929c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4930c45dcabdSAndy Whitcroft my $ctx = ''; 493108a2843eSJoe Perches my $has_flow_statement = 0; 493208a2843eSJoe Perches my $has_arg_concat = 0; 4933c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4934f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4935f74bd194SAndy Whitcroft $ctx = $dstat; 4936c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4937a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4938c45dcabdSAndy Whitcroft 493908a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 494062e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 494108a2843eSJoe Perches 4942f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 4943f59b64bfSJoe Perches my $define_args = $1; 4944f59b64bfSJoe Perches my $define_stmt = $dstat; 4945f59b64bfSJoe Perches my @def_args = (); 4946f59b64bfSJoe Perches 4947f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 4948f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 4949f59b64bfSJoe Perches $define_args =~ s/\s*//g; 4950f59b64bfSJoe Perches @def_args = split(",", $define_args); 4951f59b64bfSJoe Perches } 4952f59b64bfSJoe Perches 4953292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4954c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4955c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4956c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4957c45dcabdSAndy Whitcroft 4958c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4959bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4960bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 49616b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 4962bf30d6edSAndy Whitcroft { 4963c45dcabdSAndy Whitcroft } 4964c45dcabdSAndy Whitcroft 4965e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 496633acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 496733acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 4968e45bab8eSAndy Whitcroft { 4969e45bab8eSAndy Whitcroft } 4970e45bab8eSAndy Whitcroft 497142e15293SJoe Perches # Make asm volatile uses seem like a generic function 497242e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 497342e15293SJoe Perches 4974c45dcabdSAndy Whitcroft my $exceptions = qr{ 4975c45dcabdSAndy Whitcroft $Declare| 4976c45dcabdSAndy Whitcroft module_param_named| 4977a0a0a7a9SKees Cook MODULE_PARM_DESC| 4978c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4979c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4980383099fdSAndy Whitcroft __typeof__\(| 498122fd2d3eSStefani Seibold union| 498222fd2d3eSStefani Seibold struct| 4983ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 49846b10df42SVladimir Zapolskiy ^\"|\"$| 49856b10df42SVladimir Zapolskiy ^\[ 4986c45dcabdSAndy Whitcroft }x; 49875eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4988f59b64bfSJoe Perches 4989f59b64bfSJoe Perches $ctx =~ s/\n*$//; 4990f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 4991e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 4992f59b64bfSJoe Perches 4993f74bd194SAndy Whitcroft if ($dstat ne '' && 4994f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4995f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 49963cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4997356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4998f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4999f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5000e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 500172f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 5002f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5003f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5004f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 50054e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5006f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5007c45dcabdSAndy Whitcroft { 5008e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5009e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5010e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5011e795556aSJoe Perches } elsif ($dstat =~ /;/) { 5012f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5013f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5014f74bd194SAndy Whitcroft } else { 5015000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 5016388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5017d8aaf121SAndy Whitcroft } 5018f59b64bfSJoe Perches 5019f59b64bfSJoe Perches } 50205207649bSJoe Perches 50215207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 50225207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 50235207649bSJoe Perches my $first = 1; 50245207649bSJoe Perches $define_stmt = ""; 50255207649bSJoe Perches foreach my $l (@stmt_array) { 50265207649bSJoe Perches $l =~ s/\\$//; 50275207649bSJoe Perches if ($first) { 50285207649bSJoe Perches $define_stmt = $l; 50295207649bSJoe Perches $first = 0; 50305207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 50315207649bSJoe Perches $define_stmt .= substr($l, 1); 50325207649bSJoe Perches } 50335207649bSJoe Perches } 50345207649bSJoe Perches $define_stmt =~ s/$;//g; 50355207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 50365207649bSJoe Perches $define_stmt = trim($define_stmt); 50375207649bSJoe Perches 5038f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5039f59b64bfSJoe Perches foreach my $arg (@def_args) { 5040f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 50419192d41aSJoe Perches next if ($arg =~ /^type$/i); 50427fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 50437fe528a2SJoe Perches $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 50447fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 50457fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 5046d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 5047f59b64bfSJoe Perches if ($use_cnt > 1) { 5048f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5049f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5050f59b64bfSJoe Perches } 50519192d41aSJoe Perches# check if any macro arguments may have other precedence issues 50527fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 50539192d41aSJoe Perches ((defined($1) && $1 ne ',') || 50549192d41aSJoe Perches (defined($2) && $2 ne ','))) { 50559192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 50569192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 50579192d41aSJoe Perches } 50580a920b5bSAndy Whitcroft } 50595023d347SJoe Perches 506008a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 506108a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 506208a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 506308a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 5064e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 506508a2843eSJoe Perches 506608a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 506708a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 506808a2843eSJoe Perches } 506908a2843eSJoe Perches 5070481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 50715023d347SJoe Perches 50725023d347SJoe Perches } else { 50735023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5074481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5075481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 50765023d347SJoe Perches $line =~ /^\+.*\\$/) { 50775023d347SJoe Perches WARN("LINE_CONTINUATIONS", 50785023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 50795023d347SJoe Perches } 5080653d4876SAndy Whitcroft } 50810a920b5bSAndy Whitcroft 5082b13edf7fSJoe Perches# do {} while (0) macro tests: 5083b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5084b13edf7fSJoe Perches# macro should not end with a semicolon 5085b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 5086b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5087b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5088b13edf7fSJoe Perches my $ln = $linenr; 5089b13edf7fSJoe Perches my $cnt = $realcnt; 5090b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5091b13edf7fSJoe Perches my $ctx = ''; 5092b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5093b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5094b13edf7fSJoe Perches $ctx = $dstat; 5095b13edf7fSJoe Perches 5096b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 50971b36b201SJoe Perches $dstat =~ s/$;/ /g; 5098b13edf7fSJoe Perches 5099b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5100b13edf7fSJoe Perches my $stmts = $2; 5101b13edf7fSJoe Perches my $semis = $3; 5102b13edf7fSJoe Perches 5103b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5104b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5105e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5106b13edf7fSJoe Perches 5107ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5108ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5109b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5110b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5111b13edf7fSJoe Perches } 5112b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5113b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5114b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5115b13edf7fSJoe Perches } 5116f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5117f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5118f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5119e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5120f5ef95b1SJoe Perches 5121f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5122f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5123b13edf7fSJoe Perches } 5124b13edf7fSJoe Perches } 5125b13edf7fSJoe Perches 5126f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 512713214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 512813214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5129cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 513013214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5131cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5132cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5133aad4f614SJoe Perches my @allowed = (); 5134aad4f614SJoe Perches my $allow = 0; 513513214adfSAndy Whitcroft my $seen = 0; 5136773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5137cf655043SAndy Whitcroft my $ln = $linenr - 1; 513813214adfSAndy Whitcroft for my $chunk (@chunks) { 513913214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 514013214adfSAndy Whitcroft 5141773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5142773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5143773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 5144773647a0SAndy Whitcroft 5145aad4f614SJoe Perches $allowed[$allow] = 0; 5146773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5147773647a0SAndy Whitcroft 5148773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 5149773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 5150773647a0SAndy Whitcroft 5151773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5152cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 5153cf655043SAndy Whitcroft 5154773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 515513214adfSAndy Whitcroft 515613214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 515713214adfSAndy Whitcroft 5158aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5159cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5160cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5161aad4f614SJoe Perches $allowed[$allow] = 1; 516213214adfSAndy Whitcroft } 516313214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5164cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5165aad4f614SJoe Perches $allowed[$allow] = 1; 516613214adfSAndy Whitcroft } 5167cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5168cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5169aad4f614SJoe Perches $allowed[$allow] = 1; 517013214adfSAndy Whitcroft } 5171aad4f614SJoe Perches $allow++; 517213214adfSAndy Whitcroft } 5173aad4f614SJoe Perches if ($seen) { 5174aad4f614SJoe Perches my $sum_allowed = 0; 5175aad4f614SJoe Perches foreach (@allowed) { 5176aad4f614SJoe Perches $sum_allowed += $_; 5177aad4f614SJoe Perches } 5178aad4f614SJoe Perches if ($sum_allowed == 0) { 5179000d1cc1SJoe Perches WARN("BRACES", 5180000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 5181aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 5182aad4f614SJoe Perches $seen != $allow) { 5183aad4f614SJoe Perches CHK("BRACES", 5184aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 5185aad4f614SJoe Perches } 518613214adfSAndy Whitcroft } 518713214adfSAndy Whitcroft } 518813214adfSAndy Whitcroft } 5189773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 519013214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 5191cf655043SAndy Whitcroft my $allowed = 0; 5192f0a594c1SAndy Whitcroft 5193cf655043SAndy Whitcroft # Check the pre-context. 5194cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 5195cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 5196cf655043SAndy Whitcroft $allowed = 1; 5197f0a594c1SAndy Whitcroft } 5198773647a0SAndy Whitcroft 5199773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 5200773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 5201773647a0SAndy Whitcroft 5202cf655043SAndy Whitcroft # Check the condition. 5203cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 5204773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 5205cf655043SAndy Whitcroft if (defined $cond) { 5206773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5207cf655043SAndy Whitcroft } 5208cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5209cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5210cf655043SAndy Whitcroft $allowed = 1; 5211cf655043SAndy Whitcroft } 5212cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5213cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5214cf655043SAndy Whitcroft $allowed = 1; 5215cf655043SAndy Whitcroft } 5216cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5217cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5218cf655043SAndy Whitcroft $allowed = 1; 5219cf655043SAndy Whitcroft } 5220cf655043SAndy Whitcroft # Check the post-context. 5221cf655043SAndy Whitcroft if (defined $chunks[1]) { 5222cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 5223cf655043SAndy Whitcroft if (defined $cond) { 5224773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5225cf655043SAndy Whitcroft } 5226cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 5227cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5228cf655043SAndy Whitcroft $allowed = 1; 5229cf655043SAndy Whitcroft } 5230cf655043SAndy Whitcroft } 5231cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 5232f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 5233e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5234cf655043SAndy Whitcroft 5235000d1cc1SJoe Perches WARN("BRACES", 5236000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 5237f0a594c1SAndy Whitcroft } 5238f0a594c1SAndy Whitcroft } 5239f0a594c1SAndy Whitcroft 5240e4c5babdSJoe Perches# check for single line unbalanced braces 524195330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 524295330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 5243e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 5244e4c5babdSJoe Perches } 5245e4c5babdSJoe Perches 52460979ae66SJoe Perches# check for unnecessary blank lines around braces 524777b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5248f8e58219SJoe Perches if (CHK("BRACES", 5249f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5250f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 5251f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5252f8e58219SJoe Perches } 52530979ae66SJoe Perches } 525477b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5255f8e58219SJoe Perches if (CHK("BRACES", 5256f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5257f8e58219SJoe Perches $fix) { 5258f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 5259f8e58219SJoe Perches } 52600979ae66SJoe Perches } 52610979ae66SJoe Perches 52624a0df2efSAndy Whitcroft# no volatiles please 52636c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 52646c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5265000d1cc1SJoe Perches WARN("VOLATILE", 52668c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 52674a0df2efSAndy Whitcroft } 52684a0df2efSAndy Whitcroft 52695e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 52705e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 52715e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 52725e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 527333acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 52745e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 52755e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 52765e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 52775e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 52785e4f6ba5SJoe Perches $fix && 52795e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 52805e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 52815e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 52825e4f6ba5SJoe Perches my $comma_close = ""; 52835e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 52845e4f6ba5SJoe Perches $comma_close = $1; 52855e4f6ba5SJoe Perches } 52865e4f6ba5SJoe Perches 52875e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 52885e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 52895e4f6ba5SJoe Perches my $fixedline = $prevrawline; 52905e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 52915e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 52925e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 52935e4f6ba5SJoe Perches $fixedline = $rawline; 52945e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 52955e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 52965e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 52975e4f6ba5SJoe Perches } 52985e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 52995e4f6ba5SJoe Perches } 53005e4f6ba5SJoe Perches } 53015e4f6ba5SJoe Perches 53025e4f6ba5SJoe Perches# check for missing a space in a string concatenation 53035e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 53045e4f6ba5SJoe Perches WARN('MISSING_SPACE', 53055e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 53065e4f6ba5SJoe Perches } 53075e4f6ba5SJoe Perches 530877cb8546SJoe Perches# check for an embedded function name in a string when the function is known 5309e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 5310e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 5311e4b7d309SJoe Perches# function declarations 531277cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 531377cb8546SJoe Perches defined($context_function) && 5314e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 5315e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 531677cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 5317e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 531877cb8546SJoe Perches } 531977cb8546SJoe Perches 53205e4f6ba5SJoe Perches# check for spaces before a quoted newline 53215e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 53225e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 53235e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 53245e4f6ba5SJoe Perches $fix) { 53255e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 53265e4f6ba5SJoe Perches } 53275e4f6ba5SJoe Perches 53285e4f6ba5SJoe Perches } 53295e4f6ba5SJoe Perches 5330f17dba4fSJoe Perches# concatenated string without spaces between elements 533133acb54aSJoe Perches if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) { 5332f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 5333f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 5334f17dba4fSJoe Perches } 5335f17dba4fSJoe Perches 533690ad30e5SJoe Perches# uncoalesced string fragments 533733acb54aSJoe Perches if ($line =~ /$String\s*"/) { 533890ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 533990ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 534090ad30e5SJoe Perches } 534190ad30e5SJoe Perches 5342522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 5343522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 5344522b837cSAlexey Dobriyan my $show_Z = 1; 53455e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 5346522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 53475e4f6ba5SJoe Perches $string =~ s/%%/__/g; 5348522b837cSAlexey Dobriyan # check for %L 5349522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 53505e4f6ba5SJoe Perches WARN("PRINTF_L", 5351522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 5352522b837cSAlexey Dobriyan $show_L = 0; 53535e4f6ba5SJoe Perches } 5354522b837cSAlexey Dobriyan # check for %Z 5355522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 5356522b837cSAlexey Dobriyan WARN("PRINTF_Z", 5357522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 5358522b837cSAlexey Dobriyan $show_Z = 0; 5359522b837cSAlexey Dobriyan } 5360522b837cSAlexey Dobriyan # check for 0x<decimal> 5361522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 5362522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 53636e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 53646e300757SJoe Perches } 53655e4f6ba5SJoe Perches } 53665e4f6ba5SJoe Perches 53675e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 53683f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 53695e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 53705e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 53715e4f6ba5SJoe Perches } 53725e4f6ba5SJoe Perches 537300df344fSAndy Whitcroft# warn about #if 0 5374c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 5375000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 5376000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 5377de7d4f0eSAndy Whitcroft $herecurr); 53784a0df2efSAndy Whitcroft } 53794a0df2efSAndy Whitcroft 538003df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 538103df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5382100425deSJoe Perches my $tested = quotemeta($1); 5383100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5384100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5385100425deSJoe Perches my $func = $1; 5386100425deSJoe Perches if (WARN('NEEDLESS_IF', 5387100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5388100425deSJoe Perches $fix) { 5389100425deSJoe Perches my $do_fix = 1; 5390100425deSJoe Perches my $leading_tabs = ""; 5391100425deSJoe Perches my $new_leading_tabs = ""; 5392100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5393100425deSJoe Perches $leading_tabs = $1; 5394100425deSJoe Perches } else { 5395100425deSJoe Perches $do_fix = 0; 5396100425deSJoe Perches } 5397100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5398100425deSJoe Perches $new_leading_tabs = $1; 5399100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5400100425deSJoe Perches $do_fix = 0; 5401100425deSJoe Perches } 5402100425deSJoe Perches } else { 5403100425deSJoe Perches $do_fix = 0; 5404100425deSJoe Perches } 5405100425deSJoe Perches if ($do_fix) { 5406100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5407100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5408100425deSJoe Perches } 5409100425deSJoe Perches } 54104c432a8fSGreg Kroah-Hartman } 54114c432a8fSGreg Kroah-Hartman } 5412f0a594c1SAndy Whitcroft 5413ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5414ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5415ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5416ebfdc409SJoe Perches (defined $1 || defined $3) && 5417ebfdc409SJoe Perches $linenr > 3) { 5418ebfdc409SJoe Perches my $testval = $2; 5419ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5420ebfdc409SJoe Perches 5421ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5422ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5423ebfdc409SJoe Perches 5424fb0d0e08SJoe 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)/) { 5425ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5426ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5427ebfdc409SJoe Perches } 5428ebfdc409SJoe Perches } 5429ebfdc409SJoe Perches 5430f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5431dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5432f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5433f78d98f6SJoe Perches my $level = $1; 5434f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5435f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5436f78d98f6SJoe Perches $fix) { 5437f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5438f78d98f6SJoe Perches } 5439f78d98f6SJoe Perches } 5440f78d98f6SJoe Perches 544145c55e92SJoe Perches# check for logging continuations 544245c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 544345c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 544445c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 544545c55e92SJoe Perches } 544645c55e92SJoe Perches 5447abb08a53SJoe Perches# check for mask then right shift without a parentheses 5448abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 5449abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5450abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5451abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5452abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5453abb08a53SJoe Perches } 5454abb08a53SJoe Perches 5455b75ac618SJoe Perches# check for pointer comparisons to NULL 5456b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 5457b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5458b75ac618SJoe Perches my $val = $1; 5459b75ac618SJoe Perches my $equal = "!"; 5460b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5461b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5462b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5463b75ac618SJoe Perches $fix) { 5464b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5465b75ac618SJoe Perches } 5466b75ac618SJoe Perches } 5467b75ac618SJoe Perches } 5468b75ac618SJoe Perches 54698716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 54708716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 54718716de38SJoe Perches my $attr = $1; 54728716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 54738716de38SJoe Perches my $ptr = $1; 54748716de38SJoe Perches my $var = $2; 54758716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 54768716de38SJoe Perches ERROR("MISPLACED_INIT", 54778716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 54788716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 54798716de38SJoe Perches WARN("MISPLACED_INIT", 54808716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 54818716de38SJoe Perches $fix) { 5482194f66fcSJoe 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; 54838716de38SJoe Perches } 54848716de38SJoe Perches } 54858716de38SJoe Perches } 54868716de38SJoe Perches 5487e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5488e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5489e970b884SJoe Perches my $attr = $1; 5490e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5491e970b884SJoe Perches my $attr_prefix = $1; 5492e970b884SJoe Perches my $attr_type = $2; 5493e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5494e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5495e970b884SJoe Perches $fix) { 5496194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5497e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5498e970b884SJoe Perches } 5499e970b884SJoe Perches } 5500e970b884SJoe Perches 5501e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5502e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5503e970b884SJoe Perches my $attr = $1; 5504e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5505e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5506e970b884SJoe Perches $fix) { 5507194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5508e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5509e970b884SJoe Perches $lead = rtrim($1); 5510e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5511e970b884SJoe Perches $lead = "${lead}const "; 5512194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5513e970b884SJoe Perches } 5514e970b884SJoe Perches } 5515e970b884SJoe Perches 5516c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5517c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5518c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5519c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5520c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5521c17893c7SJoe Perches $fix) { 5522c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5523c17893c7SJoe Perches } 5524c17893c7SJoe Perches } 5525c17893c7SJoe Perches 5526fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5527fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5528fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5529fbdb8138SJoe Perches my $constant_func = $1; 5530fbdb8138SJoe Perches my $func = $constant_func; 5531fbdb8138SJoe Perches $func =~ s/^__constant_//; 5532fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5533fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5534fbdb8138SJoe Perches $fix) { 5535194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5536fbdb8138SJoe Perches } 5537fbdb8138SJoe Perches } 5538fbdb8138SJoe Perches 55391a15a250SPatrick Pannuto# prefer usleep_range over udelay 554037581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 554143c1d77cSJoe Perches my $delay = $1; 55421a15a250SPatrick Pannuto # ignore udelay's < 10, however 554343c1d77cSJoe Perches if (! ($delay < 10) ) { 5544000d1cc1SJoe Perches CHK("USLEEP_RANGE", 554543c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 554643c1d77cSJoe Perches } 554743c1d77cSJoe Perches if ($delay > 2000) { 554843c1d77cSJoe Perches WARN("LONG_UDELAY", 554943c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 55501a15a250SPatrick Pannuto } 55511a15a250SPatrick Pannuto } 55521a15a250SPatrick Pannuto 555309ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 555409ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 555509ef8725SPatrick Pannuto if ($1 < 20) { 5556000d1cc1SJoe Perches WARN("MSLEEP", 555743c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 555809ef8725SPatrick Pannuto } 555909ef8725SPatrick Pannuto } 556009ef8725SPatrick Pannuto 556136ec1939SJoe Perches# check for comparisons of jiffies 556236ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 556336ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 556436ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 556536ec1939SJoe Perches } 556636ec1939SJoe Perches 55679d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 55689d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 55699d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 55709d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 55719d7a34a5SJoe Perches } 55729d7a34a5SJoe Perches 557300df344fSAndy Whitcroft# warn about #ifdefs in C files 5574c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 557500df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 557600df344fSAndy Whitcroft# print "$herecurr"; 557700df344fSAndy Whitcroft# $clean = 0; 557800df344fSAndy Whitcroft# } 557900df344fSAndy Whitcroft 558022f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5581c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 55823705ce5bSJoe Perches if (ERROR("SPACING", 55833705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 55843705ce5bSJoe Perches $fix) { 5585194f66fcSJoe Perches $fixed[$fixlinenr] =~ 55863705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 55873705ce5bSJoe Perches } 55883705ce5bSJoe Perches 558922f2a2efSAndy Whitcroft } 559022f2a2efSAndy Whitcroft 55914a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5592171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5593171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 55944a0df2efSAndy Whitcroft my $which = $1; 55954a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5596000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5597000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 55984a0df2efSAndy Whitcroft } 55994a0df2efSAndy Whitcroft } 56004a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5601402c2553SMichael S. Tsirkin 5602402c2553SMichael S. Tsirkin my $barriers = qr{ 5603402c2553SMichael S. Tsirkin mb| 5604402c2553SMichael S. Tsirkin rmb| 5605402c2553SMichael S. Tsirkin wmb| 5606402c2553SMichael S. Tsirkin read_barrier_depends 5607402c2553SMichael S. Tsirkin }x; 5608402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5609402c2553SMichael S. Tsirkin mb__before_atomic| 5610402c2553SMichael S. Tsirkin mb__after_atomic| 5611402c2553SMichael S. Tsirkin store_release| 5612402c2553SMichael S. Tsirkin load_acquire| 5613402c2553SMichael S. Tsirkin store_mb| 5614402c2553SMichael S. Tsirkin (?:$barriers) 5615402c2553SMichael S. Tsirkin }x; 5616402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5617402c2553SMichael S. Tsirkin (?:$barriers)| 561843e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 561943e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5620402c2553SMichael S. Tsirkin }x; 5621402c2553SMichael S. Tsirkin 5622402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 56234a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5624c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5625000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 56264a0df2efSAndy Whitcroft } 56274a0df2efSAndy Whitcroft } 56283ad81779SPaul E. McKenney 5629f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5630f4073b0fSMichael S. Tsirkin 5631f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5632f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5633f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5634f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5635f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5636f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5637f4073b0fSMichael S. Tsirkin } 5638f4073b0fSMichael S. Tsirkin 5639cb426e99SJoe Perches# check for waitqueue_active without a comment. 5640cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5641cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5642cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5643cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5644cb426e99SJoe Perches } 5645cb426e99SJoe Perches } 56463ad81779SPaul E. McKenney 564791db2592SPaul E. McKenney# check for smp_read_barrier_depends and read_barrier_depends 564891db2592SPaul E. McKenney if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) { 564991db2592SPaul E. McKenney WARN("READ_BARRIER_DEPENDS", 565091db2592SPaul E. McKenney "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr); 565191db2592SPaul E. McKenney } 565291db2592SPaul E. McKenney 56534a0df2efSAndy Whitcroft# check of hardware specific defines 5654c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5655000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5656000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 56570a920b5bSAndy Whitcroft } 5658653d4876SAndy Whitcroft 5659596ed45bSJoe Perches# check that the storage class is not after a type 5660596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 5661000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5662596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 5663596ed45bSJoe Perches } 5664596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 5665596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 5666596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 5667596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 5668596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 5669596ed45bSJoe Perches WARN("STORAGE_CLASS", 5670596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 5671d4977c78STobias Klauser } 5672d4977c78STobias Klauser 5673de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5674de7d4f0eSAndy Whitcroft# storage class and type. 56759c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 56769c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5677000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5678000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5679de7d4f0eSAndy Whitcroft } 5680de7d4f0eSAndy Whitcroft 56818905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 56822b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 56832b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5684d5e616fcSJoe Perches if (WARN("INLINE", 5685d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5686d5e616fcSJoe Perches $fix) { 5687194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5688d5e616fcSJoe Perches 5689d5e616fcSJoe Perches } 56908905a67cSAndy Whitcroft } 56918905a67cSAndy Whitcroft 56923d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 56932b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 56942b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5695000d1cc1SJoe Perches WARN("PREFER_PACKED", 5696000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 56973d130fd0SJoe Perches } 56983d130fd0SJoe Perches 569939b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 57002b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57012b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5702000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5703000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 570439b7e287SJoe Perches } 570539b7e287SJoe Perches 57065f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 57072b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57082b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5709d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5710d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5711d5e616fcSJoe Perches $fix) { 5712194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5713d5e616fcSJoe Perches 5714d5e616fcSJoe Perches } 57155f14d3bdSJoe Perches } 57165f14d3bdSJoe Perches 57176061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 57182b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57192b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5720d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5721d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5722d5e616fcSJoe Perches $fix) { 5723194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5724d5e616fcSJoe Perches } 57256061d949SJoe Perches } 57266061d949SJoe Perches 5727619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 5728619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 5729619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5730619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5731619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5732619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5733619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5734619a908aSJoe Perches } 5735619a908aSJoe Perches 5736fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 5737e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5738fd39f904STomas Winkler $realfile !~ m@\btools/@ && 5739e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5740e6176fa4SJoe Perches my $type = $1; 5741e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5742e6176fa4SJoe Perches $type = $1; 5743e6176fa4SJoe Perches my $kernel_type = 'u'; 5744e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5745e6176fa4SJoe Perches $type =~ /(\d+)/; 5746e6176fa4SJoe Perches $kernel_type .= $1; 5747e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5748e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5749e6176fa4SJoe Perches $fix) { 5750e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5751e6176fa4SJoe Perches } 5752e6176fa4SJoe Perches } 5753e6176fa4SJoe Perches } 5754e6176fa4SJoe Perches 5755938224b5SJoe Perches# check for cast of C90 native int or longer types constants 5756938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 5757938224b5SJoe Perches my $cast = $1; 5758938224b5SJoe Perches my $const = $2; 5759938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 5760938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 5761938224b5SJoe Perches $fix) { 5762938224b5SJoe Perches my $suffix = ""; 5763938224b5SJoe Perches my $newconst = $const; 5764938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 5765938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 5766938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 5767938224b5SJoe Perches $suffix .= 'LL'; 5768938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 5769938224b5SJoe Perches $suffix .= 'L'; 5770938224b5SJoe Perches } 5771938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 5772938224b5SJoe Perches } 5773938224b5SJoe Perches } 5774938224b5SJoe Perches 57758f53a9b8SJoe Perches# check for sizeof(&) 57768f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5777000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5778000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 57798f53a9b8SJoe Perches } 57808f53a9b8SJoe Perches 578166c80b60SJoe Perches# check for sizeof without parenthesis 578266c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5783d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5784d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5785d5e616fcSJoe Perches $fix) { 5786194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5787d5e616fcSJoe Perches } 578866c80b60SJoe Perches } 578966c80b60SJoe Perches 579088982feaSJoe Perches# check for struct spinlock declarations 579188982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 579288982feaSJoe Perches WARN("USE_SPINLOCK_T", 579388982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 579488982feaSJoe Perches } 579588982feaSJoe Perches 5796a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 579706668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5798a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5799caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5800caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5801d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5802d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5803d5e616fcSJoe Perches $fix) { 5804194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5805d5e616fcSJoe Perches } 5806a6962d72SJoe Perches } 5807a6962d72SJoe Perches } 5808a6962d72SJoe Perches 58090b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 58100b523769SJoe Perches if ($^V && $^V ge 5.10.0 && 58110b523769SJoe Perches defined $stat && 58120b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 58130b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 5814e3c6bc95STobin C. Harding my $specifier; 5815e3c6bc95STobin C. Harding my $extension; 5816e3c6bc95STobin C. Harding my $bad_specifier = ""; 5817e3c6bc95STobin C. Harding my $stat_real; 5818e3c6bc95STobin C. Harding 58190b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 58200b523769SJoe Perches $lc = $lc + $linenr; 58210b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 58220b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 58230b523769SJoe Perches $fmt =~ s/%%//g; 5824e3c6bc95STobin C. Harding 5825e3c6bc95STobin C. Harding while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) { 5826e3c6bc95STobin C. Harding $specifier = $1; 5827e3c6bc95STobin C. Harding $extension = $2; 5828e3c6bc95STobin C. Harding if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOx]/) { 5829e3c6bc95STobin C. Harding $bad_specifier = $specifier; 58300b523769SJoe Perches last; 58310b523769SJoe Perches } 5832e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 5833e3c6bc95STobin C. Harding if (!defined($stat_real)) { 5834e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 58350b523769SJoe Perches } 5836e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 5837e3c6bc95STobin 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"); 5838e3c6bc95STobin C. Harding } 5839e3c6bc95STobin C. Harding } 5840e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 58412a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 58421df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 58431df7338aSSergey Senozhatsky my $use = ""; 5844e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 58451df7338aSSergey Senozhatsky $ext_type = "Deprecated"; 58461df7338aSSergey Senozhatsky $use = " - use %pS instead"; 5847e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 58481df7338aSSergey Senozhatsky } 58492a9f9d85STobin C. Harding 58500b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 5851e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 5852e3c6bc95STobin C. Harding } 58530b523769SJoe Perches } 58540b523769SJoe Perches } 58550b523769SJoe Perches 5856554e165cSAndy Whitcroft# Check for misused memsets 5857d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5858d1fe9c09SJoe Perches defined $stat && 58599e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5860554e165cSAndy Whitcroft 5861d7c76ba7SJoe Perches my $ms_addr = $2; 5862d1fe9c09SJoe Perches my $ms_val = $7; 5863d1fe9c09SJoe Perches my $ms_size = $12; 5864d7c76ba7SJoe Perches 5865554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5866554e165cSAndy Whitcroft ERROR("MEMSET", 5867d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5868554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5869554e165cSAndy Whitcroft WARN("MEMSET", 5870d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5871d7c76ba7SJoe Perches } 5872d7c76ba7SJoe Perches } 5873d7c76ba7SJoe Perches 587498a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 5875f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5876f333195dSJoe Perches# defined $stat && 5877f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5878f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 5879f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 5880f333195dSJoe Perches# $fix) { 5881f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 5882f333195dSJoe Perches# } 5883f333195dSJoe Perches# } 588498a9bba5SJoe Perches 5885b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 5886f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5887f333195dSJoe Perches# defined $stat && 5888f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5889f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 5890f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5891f333195dSJoe Perches# } 5892b6117d17SMateusz Kulikowski 58938617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 58948617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 5895f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5896f333195dSJoe Perches# defined $stat && 5897f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5898f333195dSJoe Perches# 5899f333195dSJoe Perches# my $ms_val = $7; 5900f333195dSJoe Perches# 5901f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 5902f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 5903f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 5904f333195dSJoe Perches# $fix) { 5905f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 5906f333195dSJoe Perches# } 5907f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 5908f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 5909f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 5910f333195dSJoe Perches# $fix) { 5911f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 5912f333195dSJoe Perches# } 5913f333195dSJoe Perches# } 5914f333195dSJoe Perches# } 59158617cd09SMateusz Kulikowski 5916d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5917d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5918d1fe9c09SJoe Perches defined $stat && 5919d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5920d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5921d7c76ba7SJoe Perches my $call = $1; 5922d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5923d7c76ba7SJoe Perches my $arg1 = $3; 5924d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5925d1fe9c09SJoe Perches my $arg2 = $8; 5926d7c76ba7SJoe Perches my $cast; 5927d7c76ba7SJoe Perches 5928d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5929d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5930d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5931d7c76ba7SJoe Perches $cast = $cast1; 5932d7c76ba7SJoe Perches } else { 5933d7c76ba7SJoe Perches $cast = $cast2; 5934d7c76ba7SJoe Perches } 5935d7c76ba7SJoe Perches WARN("MINMAX", 5936d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5937554e165cSAndy Whitcroft } 5938554e165cSAndy Whitcroft } 5939554e165cSAndy Whitcroft 59404a273195SJoe Perches# check usleep_range arguments 59414a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 59424a273195SJoe Perches defined $stat && 59434a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 59444a273195SJoe Perches my $min = $1; 59454a273195SJoe Perches my $max = $7; 59464a273195SJoe Perches if ($min eq $max) { 59474a273195SJoe Perches WARN("USLEEP_RANGE", 59484a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 59494a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 59504a273195SJoe Perches $min > $max) { 59514a273195SJoe Perches WARN("USLEEP_RANGE", 59524a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 59534a273195SJoe Perches } 59544a273195SJoe Perches } 59554a273195SJoe Perches 5956823b794cSJoe Perches# check for naked sscanf 5957823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5958823b794cSJoe Perches defined $stat && 59596c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5960823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5961823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5962823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5963823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5964823b794cSJoe Perches $lc = $lc + $linenr; 59652a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 5966823b794cSJoe Perches WARN("NAKED_SSCANF", 5967823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5968823b794cSJoe Perches } 5969823b794cSJoe Perches 5970afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5971afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5972afc819abSJoe Perches defined $stat && 5973afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5974afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5975afc819abSJoe Perches $lc = $lc + $linenr; 59762a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 5977afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5978afc819abSJoe Perches my $format = $6; 5979afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5980afc819abSJoe Perches if ($count == 1 && 5981afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5982afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5983afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5984afc819abSJoe Perches } 5985afc819abSJoe Perches } 5986afc819abSJoe Perches } 5987afc819abSJoe Perches 598870dc8a48SJoe Perches# check for new externs in .h files. 598970dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 599070dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5991d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 599270dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 599370dc8a48SJoe Perches $fix) { 5994194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 599570dc8a48SJoe Perches } 599670dc8a48SJoe Perches } 599770dc8a48SJoe Perches 5998de7d4f0eSAndy Whitcroft# check for new externs in .c files. 5999171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 6000c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 6001171ae1a4SAndy Whitcroft { 6002c45dcabdSAndy Whitcroft my $function_name = $1; 6003c45dcabdSAndy Whitcroft my $paren_space = $2; 6004171ae1a4SAndy Whitcroft 6005171ae1a4SAndy Whitcroft my $s = $stat; 6006171ae1a4SAndy Whitcroft if (defined $cond) { 6007171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 6008171ae1a4SAndy Whitcroft } 6009c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 6010c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 6011c45dcabdSAndy Whitcroft { 6012000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6013000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6014de7d4f0eSAndy Whitcroft } 6015de7d4f0eSAndy Whitcroft 6016171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 6017000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 6018000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 6019171ae1a4SAndy Whitcroft } 60209c9ba34eSAndy Whitcroft 60219c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 60229c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 60239c9ba34eSAndy Whitcroft { 6024000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6025000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6026171ae1a4SAndy Whitcroft } 6027171ae1a4SAndy Whitcroft 6028a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 6029a0ad7596SJoe Perches if (defined $stat && 603025bdda2bSMiles Chen $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 6031ca0d8929SJoe Perches $1 ne "void") { 6032ca0d8929SJoe Perches my $args = trim($1); 6033ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6034ca0d8929SJoe Perches my $arg = trim($1); 6035ca0d8929SJoe Perches if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 6036ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 6037ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6038ca0d8929SJoe Perches } 6039ca0d8929SJoe Perches } 6040ca0d8929SJoe Perches } 6041ca0d8929SJoe Perches 6042a0ad7596SJoe Perches# check for function definitions 6043a0ad7596SJoe Perches if ($^V && $^V ge 5.10.0 && 6044a0ad7596SJoe Perches defined $stat && 6045a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6046a0ad7596SJoe Perches $context_function = $1; 6047a0ad7596SJoe Perches 6048a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 6049a0ad7596SJoe Perches my $ok = 0; 6050a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 6051a0ad7596SJoe Perches my $herectx = $here . "\n"; 6052a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6053a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 6054a0ad7596SJoe Perches $herectx .= $rl . "\n"; 6055a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 6056a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 6057a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 6058a0ad7596SJoe Perches } 6059a0ad7596SJoe Perches if (!$ok) { 6060a0ad7596SJoe Perches ERROR("OPEN_BRACE", 6061a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 6062a0ad7596SJoe Perches } 6063a0ad7596SJoe Perches } 6064a0ad7596SJoe Perches 6065de7d4f0eSAndy Whitcroft# checks for new __setup's 6066de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 6067de7d4f0eSAndy Whitcroft my $name = $1; 6068de7d4f0eSAndy Whitcroft 6069de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 6070000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 60718c27ceffSMauro Carvalho Chehab "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr); 6072de7d4f0eSAndy Whitcroft } 6073653d4876SAndy Whitcroft } 60749c0ca6f9SAndy Whitcroft 60759c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 6076caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 6077000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 6078000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 60799c0ca6f9SAndy Whitcroft } 608013214adfSAndy Whitcroft 6081a640d25cSJoe Perches# alloc style 6082a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 6083a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 6084a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 6085a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 6086a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 6087a640d25cSJoe Perches } 6088a640d25cSJoe Perches 608960a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 609060a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 60911b4a2ed4SJoe Perches defined $stat && 60921b4a2ed4SJoe Perches $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 609360a55369SJoe Perches my $oldfunc = $3; 609460a55369SJoe Perches my $a1 = $4; 609560a55369SJoe Perches my $a2 = $10; 609660a55369SJoe Perches my $newfunc = "kmalloc_array"; 609760a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 609860a55369SJoe Perches my $r1 = $a1; 609960a55369SJoe Perches my $r2 = $a2; 610060a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 610160a55369SJoe Perches $r1 = $a2; 610260a55369SJoe Perches $r2 = $a1; 610360a55369SJoe Perches } 6104e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 6105e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 61061b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 6107e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6108e3d95a2aSTobin C. Harding 6109e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 61101b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 61111b4a2ed4SJoe Perches $cnt == 1 && 6112e367455aSJoe Perches $fix) { 6113194f66fcSJoe 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; 611460a55369SJoe Perches } 611560a55369SJoe Perches } 611660a55369SJoe Perches } 611760a55369SJoe Perches 6118972fdea2SJoe Perches# check for krealloc arg reuse 6119972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 6120972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 6121972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 6122972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 6123972fdea2SJoe Perches } 6124972fdea2SJoe Perches 61255ce59ae0SJoe Perches# check for alloc argument mismatch 61265ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 61275ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 61285ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 61295ce59ae0SJoe Perches } 61305ce59ae0SJoe Perches 6131caf2a54fSJoe Perches# check for multiple semicolons 6132caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 6133d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 6134d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 6135d5e616fcSJoe Perches $fix) { 6136194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 6137d5e616fcSJoe Perches } 6138d1e2ad07SJoe Perches } 6139d1e2ad07SJoe Perches 6140cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 6141cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 6142cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 61430ab90191SJoe Perches my $ull = ""; 61440ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 61450ab90191SJoe Perches if (CHK("BIT_MACRO", 61460ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 61470ab90191SJoe Perches $fix) { 61480ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 61490ab90191SJoe Perches } 61500ab90191SJoe Perches } 61510ab90191SJoe Perches 61522d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 61532d632745SJoe 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*$/) { 61542d632745SJoe Perches my $config = $1; 61552d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 61562d632745SJoe Perches "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) && 61572d632745SJoe Perches $fix) { 61582d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 61592d632745SJoe Perches } 61602d632745SJoe Perches } 61612d632745SJoe Perches 6162e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 6163c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 6164c34c09a8SJoe Perches my $has_break = 0; 6165c34c09a8SJoe Perches my $has_statement = 0; 6166c34c09a8SJoe Perches my $count = 0; 6167c34c09a8SJoe Perches my $prevline = $linenr; 6168e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 6169c34c09a8SJoe Perches $prevline--; 6170c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 6171c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 6172c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 6173c34c09a8SJoe Perches next if ($fline =~ /^\-/); 6174c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 6175c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 6176c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 6177c34c09a8SJoe Perches $has_statement = 1; 6178c34c09a8SJoe Perches $count++; 6179258f79d5SHeinrich Schuchardt $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/); 6180c34c09a8SJoe Perches } 6181c34c09a8SJoe Perches if (!$has_break && $has_statement) { 6182c34c09a8SJoe Perches WARN("MISSING_BREAK", 6183224236d9SAndrew Morton "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr); 6184c34c09a8SJoe Perches } 6185c34c09a8SJoe Perches } 6186c34c09a8SJoe Perches 6187d1e2ad07SJoe Perches# check for switch/default statements without a break; 6188d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 6189d1e2ad07SJoe Perches defined $stat && 6190d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 6191d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 6192e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6193e3d95a2aSTobin C. Harding 6194d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 6195d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 6196caf2a54fSJoe Perches } 6197caf2a54fSJoe Perches 619813214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 6199d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 6200d5e616fcSJoe Perches if (WARN("USE_FUNC", 6201d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 6202d5e616fcSJoe Perches $fix) { 6203194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 6204d5e616fcSJoe Perches } 620513214adfSAndy Whitcroft } 6206773647a0SAndy Whitcroft 620762ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 620862ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 620962ec818fSJoe Perches ERROR("DATE_TIME", 621062ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 621162ec818fSJoe Perches } 621262ec818fSJoe Perches 62132c92488aSJoe Perches# check for use of yield() 62142c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 62152c92488aSJoe Perches WARN("YIELD", 62162c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 62172c92488aSJoe Perches } 62182c92488aSJoe Perches 6219179f8f40SJoe Perches# check for comparisons against true and false 6220179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 6221179f8f40SJoe Perches my $lead = $1; 6222179f8f40SJoe Perches my $arg = $2; 6223179f8f40SJoe Perches my $test = $3; 6224179f8f40SJoe Perches my $otype = $4; 6225179f8f40SJoe Perches my $trail = $5; 6226179f8f40SJoe Perches my $op = "!"; 6227179f8f40SJoe Perches 6228179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 6229179f8f40SJoe Perches 6230179f8f40SJoe Perches my $type = lc($otype); 6231179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 6232179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 6233179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 6234179f8f40SJoe Perches $op = ""; 6235179f8f40SJoe Perches } 6236179f8f40SJoe Perches 6237179f8f40SJoe Perches CHK("BOOL_COMPARISON", 6238179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 6239179f8f40SJoe Perches 6240179f8f40SJoe Perches## maybe suggesting a correct construct would better 6241179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 6242179f8f40SJoe Perches 6243179f8f40SJoe Perches } 6244179f8f40SJoe Perches } 6245179f8f40SJoe Perches 62465d430902SJoe Perches# check for bool bitfields 62475d430902SJoe Perches if ($sline =~ /^.\s+bool\s*$Ident\s*:\s*\d+\s*;/) { 62485d430902SJoe Perches WARN("BOOL_BITFIELD", 62495d430902SJoe Perches "Avoid using bool as bitfield. Prefer bool bitfields as unsigned int or u<8|16|32>\n" . $herecurr); 62505d430902SJoe Perches } 62515d430902SJoe Perches 62524882720bSThomas Gleixner# check for semaphores initialized locked 62534882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 6254000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 6255000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 6256773647a0SAndy Whitcroft } 62576712d858SJoe Perches 625867d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 625967d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 6260000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 626167d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 6262773647a0SAndy Whitcroft } 62636712d858SJoe Perches 6264ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 6265f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 6266000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 6267ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 6268f3db6639SMichael Ellerman } 62696712d858SJoe Perches 62700f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 6271d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 62726903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 6273d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 6274000d1cc1SJoe Perches WARN("CONST_STRUCT", 6275d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 62762b6db5cbSAndy Whitcroft } 6277773647a0SAndy Whitcroft 6278773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 6279773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 6280773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 6281c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 6282c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 6283171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 6284171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 6285171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 6286773647a0SAndy Whitcroft { 6287000d1cc1SJoe Perches WARN("NR_CPUS", 6288000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 6289773647a0SAndy Whitcroft } 62909c9ba34eSAndy Whitcroft 629152ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 629252ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 629352ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 629452ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 629552ea8506SJoe Perches } 629652ea8506SJoe Perches 6297acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 6298acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 6299acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 6300acd9362cSJoe Perches WARN("LIKELY_MISUSE", 6301acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 6302acd9362cSJoe Perches } 6303acd9362cSJoe Perches 6304691d77b6SAndy Whitcroft# whine mightly about in_atomic 6305691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 6306691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 6307000d1cc1SJoe Perches ERROR("IN_ATOMIC", 6308000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 6309f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 6310000d1cc1SJoe Perches WARN("IN_ATOMIC", 6311000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 6312691d77b6SAndy Whitcroft } 6313691d77b6SAndy Whitcroft } 63141704f47bSPeter Zijlstra 63150f5225b0SPeter Zijlstra# check for mutex_trylock_recursive usage 63160f5225b0SPeter Zijlstra if ($line =~ /mutex_trylock_recursive/) { 63170f5225b0SPeter Zijlstra ERROR("LOCKING", 63180f5225b0SPeter Zijlstra "recursive locking is bad, do not use this ever.\n" . $herecurr); 63190f5225b0SPeter Zijlstra } 63200f5225b0SPeter Zijlstra 63211704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 63221704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 63231704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 63241704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 63251704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 63261704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 6327000d1cc1SJoe Perches ERROR("LOCKDEP", 6328000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 63291704f47bSPeter Zijlstra } 63301704f47bSPeter Zijlstra } 633188f8831cSDave Jones 6332b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 6333b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 6334000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 6335000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 633688f8831cSDave Jones } 63372435880fSJoe Perches 633800180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 633900180468SJoe Perches# and whether or not function naming is typical and if 634000180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 634100180468SJoe Perches if ($^V && $^V ge 5.10.0 && 634200180468SJoe Perches defined $stat && 634300180468SJoe 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*\)/) { 634400180468SJoe Perches my $var = $1; 634500180468SJoe Perches my $perms = $2; 634600180468SJoe Perches my $show = $3; 634700180468SJoe Perches my $store = $4; 634800180468SJoe Perches my $octal_perms = perms_to_octal($perms); 634900180468SJoe Perches if ($show =~ /^${var}_show$/ && 635000180468SJoe Perches $store =~ /^${var}_store$/ && 635100180468SJoe Perches $octal_perms eq "0644") { 635200180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 635300180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 635400180468SJoe Perches $fix) { 635500180468SJoe 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})/; 635600180468SJoe Perches } 635700180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 635800180468SJoe Perches $store =~ /^NULL$/ && 635900180468SJoe Perches $octal_perms eq "0444") { 636000180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 636100180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 636200180468SJoe Perches $fix) { 636300180468SJoe 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})/; 636400180468SJoe Perches } 636500180468SJoe Perches } elsif ($show =~ /^NULL$/ && 636600180468SJoe Perches $store =~ /^${var}_store$/ && 636700180468SJoe Perches $octal_perms eq "0200") { 636800180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 636900180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 637000180468SJoe Perches $fix) { 637100180468SJoe 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})/; 637200180468SJoe Perches } 637300180468SJoe Perches } elsif ($octal_perms eq "0644" || 637400180468SJoe Perches $octal_perms eq "0444" || 637500180468SJoe Perches $octal_perms eq "0200") { 637600180468SJoe Perches my $newshow = "$show"; 637700180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 637800180468SJoe Perches my $newstore = $store; 637900180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 638000180468SJoe Perches my $rename = ""; 638100180468SJoe Perches if ($show ne $newshow) { 638200180468SJoe Perches $rename .= " '$show' to '$newshow'"; 638300180468SJoe Perches } 638400180468SJoe Perches if ($store ne $newstore) { 638500180468SJoe Perches $rename .= " '$store' to '$newstore'"; 638600180468SJoe Perches } 638700180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 638800180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 638900180468SJoe Perches } else { 639000180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 639100180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 639200180468SJoe Perches } 639300180468SJoe Perches } 639400180468SJoe Perches 6395515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 6396515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 639773121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 639873121534SJoe Perches# specific definition of not visible in sysfs. 639973121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 640073121534SJoe Perches# use the default permissions 6401515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 6402459cf0aeSJoe Perches defined $stat && 6403515a235eSJoe Perches $line =~ /$mode_perms_search/) { 64042435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 64052435880fSJoe Perches my $func = $entry->[0]; 64062435880fSJoe Perches my $arg_pos = $entry->[1]; 64072435880fSJoe Perches 6408459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 6409459cf0aeSJoe Perches $lc = $lc + $linenr; 64102a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6411459cf0aeSJoe Perches 64122435880fSJoe Perches my $skip_args = ""; 64132435880fSJoe Perches if ($arg_pos > 1) { 64142435880fSJoe Perches $arg_pos--; 64152435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 64162435880fSJoe Perches } 6417f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 6418459cf0aeSJoe Perches if ($stat =~ /$test/) { 64192435880fSJoe Perches my $val = $1; 64202435880fSJoe Perches $val = $6 if ($skip_args ne ""); 642173121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 642273121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 642373121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 64242435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 6425459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 6426f90774e1SJoe Perches } 6427f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6428c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6429459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 64302435880fSJoe Perches } 6431459cf0aeSJoe Perches } 6432459cf0aeSJoe Perches } 6433459cf0aeSJoe Perches } 6434459cf0aeSJoe Perches 6435459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 6436bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 643700180468SJoe Perches my $oval = $1; 643800180468SJoe Perches my $octal = perms_to_octal($oval); 6439f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 6440459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 6441f90774e1SJoe Perches $fix) { 644200180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 64432435880fSJoe Perches } 644413214adfSAndy Whitcroft } 64455a6d20ceSBjorn Andersson 64465a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 64475a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 64485a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 64495a6d20ceSBjorn Andersson my $valid_licenses = qr{ 64505a6d20ceSBjorn Andersson GPL| 64515a6d20ceSBjorn Andersson GPL\ v2| 64525a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 64535a6d20ceSBjorn Andersson Dual\ BSD/GPL| 64545a6d20ceSBjorn Andersson Dual\ MIT/GPL| 64555a6d20ceSBjorn Andersson Dual\ MPL/GPL| 64565a6d20ceSBjorn Andersson Proprietary 64575a6d20ceSBjorn Andersson }x; 64585a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 64595a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 64605a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 64615a6d20ceSBjorn Andersson } 64625a6d20ceSBjorn Andersson } 6463515a235eSJoe Perches } 646413214adfSAndy Whitcroft 646513214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 646613214adfSAndy Whitcroft # so just keep quiet. 646713214adfSAndy Whitcroft if ($#rawlines == -1) { 646813214adfSAndy Whitcroft exit(0); 64690a920b5bSAndy Whitcroft } 64700a920b5bSAndy Whitcroft 64718905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 64728905a67cSAndy Whitcroft # things that appear to be patches. 64738905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 64748905a67cSAndy Whitcroft exit(0); 64758905a67cSAndy Whitcroft } 64768905a67cSAndy Whitcroft 64778905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 64788905a67cSAndy Whitcroft # just keep quiet. 64798905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 64808905a67cSAndy Whitcroft exit(0); 64818905a67cSAndy Whitcroft } 64828905a67cSAndy Whitcroft 6483a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 6484000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6485000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 64860a920b5bSAndy Whitcroft } 6487ed43c4e5SAllen Hubbe if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) { 6488000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6489000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 64900a920b5bSAndy Whitcroft } 64910a920b5bSAndy Whitcroft 6492f0a594c1SAndy Whitcroft print report_dump(); 649313214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 649413214adfSAndy Whitcroft print "$filename " if ($summary_file); 64956c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 64966c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 64976c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 64986c72ffaaSAndy Whitcroft } 64998905a67cSAndy Whitcroft 6500d2c0a235SAndy Whitcroft if ($quiet == 0) { 6501ef212196SJoe Perches # If there were any defects found and not already fixing them 6502ef212196SJoe Perches if (!$clean and !$fix) { 6503ef212196SJoe Perches print << "EOM" 6504ef212196SJoe Perches 6505ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 6506ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 6507ef212196SJoe PerchesEOM 6508ef212196SJoe Perches } 6509d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 6510d2c0a235SAndy Whitcroft # then suggest that. 6511d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 6512b0781216SMike Frysinger $rpt_cleaners = 0; 6513d8469f16SJoe Perches print << "EOM" 6514d8469f16SJoe Perches 6515d8469f16SJoe PerchesNOTE: Whitespace errors detected. 6516d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 6517d8469f16SJoe PerchesEOM 6518d2c0a235SAndy Whitcroft } 6519d2c0a235SAndy Whitcroft } 6520d2c0a235SAndy Whitcroft 6521d752fcc8SJoe Perches if ($clean == 0 && $fix && 6522d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 6523d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 65249624b8d6SJoe Perches my $newfile = $filename; 65259624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 65263705ce5bSJoe Perches my $linecount = 0; 65273705ce5bSJoe Perches my $f; 65283705ce5bSJoe Perches 6529d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 6530d752fcc8SJoe Perches 65313705ce5bSJoe Perches open($f, '>', $newfile) 65323705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 65333705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 65343705ce5bSJoe Perches $linecount++; 65353705ce5bSJoe Perches if ($file) { 65363705ce5bSJoe Perches if ($linecount > 3) { 65373705ce5bSJoe Perches $fixed_line =~ s/^\+//; 65383705ce5bSJoe Perches print $f $fixed_line . "\n"; 65393705ce5bSJoe Perches } 65403705ce5bSJoe Perches } else { 65413705ce5bSJoe Perches print $f $fixed_line . "\n"; 65423705ce5bSJoe Perches } 65433705ce5bSJoe Perches } 65443705ce5bSJoe Perches close($f); 65453705ce5bSJoe Perches 65463705ce5bSJoe Perches if (!$quiet) { 65473705ce5bSJoe Perches print << "EOM"; 6548d8469f16SJoe Perches 65493705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 65503705ce5bSJoe Perches 65513705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 65523705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 65533705ce5bSJoe Perches 65543705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 65553705ce5bSJoe PerchesNo warranties, expressed or implied... 65563705ce5bSJoe PerchesEOM 65573705ce5bSJoe Perches } 65583705ce5bSJoe Perches } 65593705ce5bSJoe Perches 6560d8469f16SJoe Perches if ($quiet == 0) { 6561d8469f16SJoe Perches print "\n"; 6562d8469f16SJoe Perches if ($clean == 1) { 6563d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 6564d8469f16SJoe Perches } else { 6565d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 65660a920b5bSAndy Whitcroft } 65670a920b5bSAndy Whitcroft } 65680a920b5bSAndy Whitcroft return $clean; 65690a920b5bSAndy Whitcroft} 6570