1cb77f0d6SKamil Rytarowski#!/usr/bin/env perl 2882ea1d6SJoe Perches# SPDX-License-Identifier: GPL-2.0 3882ea1d6SJoe Perches# 4dbf004d7SDave Jones# (c) 2001, Dave Jones. (the file handling bit) 500df344fSAndy Whitcroft# (c) 2005, Joel Schopp <[email protected]> (the ugly bit) 62a5a2c25SAndy Whitcroft# (c) 2007,2008, Andy Whitcroft <[email protected]> (new conditions, test suite) 7015830beSAndy Whitcroft# (c) 2008-2010 Andy Whitcroft <[email protected]> 8882ea1d6SJoe Perches# (c) 2010-2018 Joe Perches <[email protected]> 90a920b5bSAndy Whitcroft 100a920b5bSAndy Whitcroftuse strict; 11cb77f0d6SKamil Rytarowskiuse warnings; 12c707a81dSJoe Perchesuse POSIX; 1336061e38SJoe Perchesuse File::Basename; 1436061e38SJoe Perchesuse Cwd 'abs_path'; 1557230297SJoe Perchesuse Term::ANSIColor qw(:constants); 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 238012c253abSJoe Perches# check if it's a mode change, rename or start of a patch 238112c253abSJoe Perches if (!$in_commit_log && 238212c253abSJoe Perches ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 238312c253abSJoe Perches ($line =~ /^rename (?:from|to) \S+\s*$/ || 238412c253abSJoe Perches $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 238512c253abSJoe Perches $is_patch = 1; 238612c253abSJoe Perches } 238712c253abSJoe Perches 23880a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2389e518e9a5SJoe Perches if (!$in_commit_log && 239074fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 239174fd4f34SJoe Perches my $context = $4; 23920a920b5bSAndy Whitcroft $is_patch = 1; 23934a0df2efSAndy Whitcroft $first_line = $linenr + 1; 23940a920b5bSAndy Whitcroft $realline=$1-1; 23950a920b5bSAndy Whitcroft if (defined $2) { 23960a920b5bSAndy Whitcroft $realcnt=$3+1; 23970a920b5bSAndy Whitcroft } else { 23980a920b5bSAndy Whitcroft $realcnt=1+1; 23990a920b5bSAndy Whitcroft } 2400c2fdda0dSAndy Whitcroft annotate_reset(); 240113214adfSAndy Whitcroft $prev_values = 'E'; 240213214adfSAndy Whitcroft 2403773647a0SAndy Whitcroft %suppress_ifbraces = (); 2404170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 24052b474a1aSAndy Whitcroft %suppress_export = (); 24063e469cdcSAndy Whitcroft $suppress_statement = 0; 240774fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 240874fd4f34SJoe Perches $context_function = $1; 240974fd4f34SJoe Perches } else { 241074fd4f34SJoe Perches undef $context_function; 241174fd4f34SJoe Perches } 24120a920b5bSAndy Whitcroft next; 24130a920b5bSAndy Whitcroft 24144a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 24154a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 24164a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2417773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 24180a920b5bSAndy Whitcroft $realline++; 2419d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 24200a920b5bSAndy Whitcroft 24214a0df2efSAndy Whitcroft # Measure the line length and indent. 2422c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 24230a920b5bSAndy Whitcroft 24240a920b5bSAndy Whitcroft # Track the previous line. 24250a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 24260a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2427c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2428c2fdda0dSAndy Whitcroft 2429773647a0SAndy Whitcroft #warn "line<$line>\n"; 24306c72ffaaSAndy Whitcroft 2431d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2432d8aaf121SAndy Whitcroft $realcnt--; 24330a920b5bSAndy Whitcroft } 24340a920b5bSAndy Whitcroft 2435cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2436cc77cdcaSAndy Whitcroft 24376c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 24386c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2439773647a0SAndy Whitcroft 24402ac73b4fSJoe Perches my $found_file = 0; 2441773647a0SAndy Whitcroft # extract the filename as it passes 24423bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 24433bf9a009SRabin Vincent $realfile = $1; 24442b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2445270c49a0SJoe Perches $in_commit_log = 0; 24462ac73b4fSJoe Perches $found_file = 1; 24473bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2448773647a0SAndy Whitcroft $realfile = $1; 24492b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2450270c49a0SJoe Perches $in_commit_log = 0; 24511e855726SWolfram Sang 24521e855726SWolfram Sang $p1_prefix = $1; 2453e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2454e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2455000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2456000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 24571e855726SWolfram Sang } 2458773647a0SAndy Whitcroft 2459c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2460000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2461000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2462773647a0SAndy Whitcroft } 24632ac73b4fSJoe Perches $found_file = 1; 24642ac73b4fSJoe Perches } 24652ac73b4fSJoe Perches 246634d8815fSJoe Perches#make up the handle for any error we report on this line 246734d8815fSJoe Perches if ($showfile) { 246834d8815fSJoe Perches $prefix = "$realfile:$realline: " 246934d8815fSJoe Perches } elsif ($emacs) { 24707d3a9f67SJoe Perches if ($file) { 24717d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 24727d3a9f67SJoe Perches } else { 247334d8815fSJoe Perches $prefix = "$filename:$linenr: "; 247434d8815fSJoe Perches } 24757d3a9f67SJoe Perches } 247634d8815fSJoe Perches 24772ac73b4fSJoe Perches if ($found_file) { 247885b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 247985b0ee18SJoe Perches WARN("OBSOLETE", 248085b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 248185b0ee18SJoe Perches } 24827bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 24832ac73b4fSJoe Perches $check = 1; 24842ac73b4fSJoe Perches } else { 24852ac73b4fSJoe Perches $check = $check_orig; 24862ac73b4fSJoe Perches } 24879f3a8992SRob Herring $checklicenseline = 1; 2488773647a0SAndy Whitcroft next; 2489773647a0SAndy Whitcroft } 2490773647a0SAndy Whitcroft 2491389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 24920a920b5bSAndy Whitcroft 2493c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2494c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2495c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 24960a920b5bSAndy Whitcroft 24976c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 24986c72ffaaSAndy Whitcroft 2499e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2500e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2501e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2502e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2503e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2504e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2505e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2506e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2507e518e9a5SJoe Perches $commit_log_has_diff = 1; 2508e518e9a5SJoe Perches } 2509e518e9a5SJoe Perches 25103bf9a009SRabin Vincent# Check for incorrect file permissions 25113bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 25123bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 251304db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 251404db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2515000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2516000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 25173bf9a009SRabin Vincent } 25183bf9a009SRabin Vincent } 25193bf9a009SRabin Vincent 252020112475SJoe Perches# Check the patch for a signoff: 2521d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 25224a0df2efSAndy Whitcroft $signoff++; 252315662b3eSJoe Perches $in_commit_log = 0; 25240a920b5bSAndy Whitcroft } 252520112475SJoe Perches 2526e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2527e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2528e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2529e0d975b1SJoe Perches $reported_maintainer_file = 1; 2530e0d975b1SJoe Perches } 2531e0d975b1SJoe Perches 253220112475SJoe Perches# Check signature styles 2533270c49a0SJoe Perches if (!$in_header_lines && 2534ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 253520112475SJoe Perches my $space_before = $1; 253620112475SJoe Perches my $sign_off = $2; 253720112475SJoe Perches my $space_after = $3; 253820112475SJoe Perches my $email = $4; 253920112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 254020112475SJoe Perches 2541ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2542ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2543ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2544ce0338dfSJoe Perches } 254520112475SJoe Perches if (defined $space_before && $space_before ne "") { 25463705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 25473705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 25483705ce5bSJoe Perches $fix) { 2549194f66fcSJoe Perches $fixed[$fixlinenr] = 25503705ce5bSJoe Perches "$ucfirst_sign_off $email"; 25513705ce5bSJoe Perches } 255220112475SJoe Perches } 255320112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 25543705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 25553705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 25563705ce5bSJoe Perches $fix) { 2557194f66fcSJoe Perches $fixed[$fixlinenr] = 25583705ce5bSJoe Perches "$ucfirst_sign_off $email"; 25593705ce5bSJoe Perches } 25603705ce5bSJoe Perches 256120112475SJoe Perches } 256220112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 25633705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 25643705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 25653705ce5bSJoe Perches $fix) { 2566194f66fcSJoe Perches $fixed[$fixlinenr] = 25673705ce5bSJoe Perches "$ucfirst_sign_off $email"; 25683705ce5bSJoe Perches } 256920112475SJoe Perches } 257020112475SJoe Perches 257120112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 257220112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 257320112475SJoe Perches if ($suggested_email eq "") { 2574000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2575000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 257620112475SJoe Perches } else { 257720112475SJoe Perches my $dequoted = $suggested_email; 257820112475SJoe Perches $dequoted =~ s/^"//; 257920112475SJoe Perches $dequoted =~ s/" </ </; 258020112475SJoe Perches # Don't force email to have quotes 258120112475SJoe Perches # Allow just an angle bracketed address 258220112475SJoe Perches if ("$dequoted$comment" ne $email && 258320112475SJoe Perches "<$email_address>$comment" ne $email && 258420112475SJoe Perches "$suggested_email$comment" ne $email) { 2585000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2586000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 258720112475SJoe Perches } 25880a920b5bSAndy Whitcroft } 25897e51f197SJoe Perches 25907e51f197SJoe Perches# Check for duplicate signatures 25917e51f197SJoe Perches my $sig_nospace = $line; 25927e51f197SJoe Perches $sig_nospace =~ s/\s//g; 25937e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 25947e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 25957e51f197SJoe Perches WARN("BAD_SIGN_OFF", 25967e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 25977e51f197SJoe Perches } else { 25987e51f197SJoe Perches $signatures{$sig_nospace} = 1; 25997e51f197SJoe Perches } 26000a920b5bSAndy Whitcroft } 26010a920b5bSAndy Whitcroft 2602a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2603a2fe16b9SJoe Perches if ($in_header_lines && 2604a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2605a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2606a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2607a2fe16b9SJoe Perches } 2608a2fe16b9SJoe Perches 26097ebd05efSChristopher Covington# Check for unwanted Gerrit info 26107ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 26117ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 26127ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 26137ebd05efSChristopher Covington } 26147ebd05efSChristopher Covington 2615369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2616369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2617369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2618369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2619369c8dd3SJoe Perches # timestamp 2620369c8dd3SJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) { 2621369c8dd3SJoe Perches # stack dump address 2622369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2623369c8dd3SJoe Perches } 2624369c8dd3SJoe Perches 26252a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 26262a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2627bf4daf12SJoe Perches length($line) > 75 && 2628bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2629bf4daf12SJoe Perches # file delta changes 2630bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2631bf4daf12SJoe Perches # filename then : 2632bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2633bf4daf12SJoe Perches # A Fixes: or Link: line 2634bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 26352a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 26362a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 26372a076f40SJoe Perches $commit_log_long_line = 1; 26382a076f40SJoe Perches } 26392a076f40SJoe Perches 2640bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2641bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2642bf4daf12SJoe Perches $line =~ /^\s*$/) { 2643bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2644bf4daf12SJoe Perches } 2645bf4daf12SJoe Perches 26460d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2647369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2648aab38f51SJoe Perches $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i && 2649e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 2650fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2651aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2652369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2653bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2654fe043ea1SJoe Perches my $init_char = "c"; 2655fe043ea1SJoe Perches my $orig_commit = ""; 26560d7835fcSJoe Perches my $short = 1; 26570d7835fcSJoe Perches my $long = 0; 26580d7835fcSJoe Perches my $case = 1; 26590d7835fcSJoe Perches my $space = 1; 26600d7835fcSJoe Perches my $hasdesc = 0; 266119c146a6SJoe Perches my $hasparens = 0; 26620d7835fcSJoe Perches my $id = '0123456789ab'; 26630d7835fcSJoe Perches my $orig_desc = "commit description"; 26640d7835fcSJoe Perches my $description = ""; 26650d7835fcSJoe Perches 2666fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2667fe043ea1SJoe Perches $init_char = $1; 2668fe043ea1SJoe Perches $orig_commit = lc($2); 2669fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2670fe043ea1SJoe Perches $orig_commit = lc($1); 2671fe043ea1SJoe Perches } 2672fe043ea1SJoe Perches 26730d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 26740d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 26750d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 26760d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 26770d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 26780d7835fcSJoe Perches $orig_desc = $1; 267919c146a6SJoe Perches $hasparens = 1; 26800d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 26810d7835fcSJoe Perches defined $rawlines[$linenr] && 26820d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 26830d7835fcSJoe Perches $orig_desc = $1; 268419c146a6SJoe Perches $hasparens = 1; 2685b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2686b671fde0SJoe Perches defined $rawlines[$linenr] && 2687b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2688b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2689b671fde0SJoe Perches $orig_desc = $1; 2690b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2691b671fde0SJoe Perches $orig_desc .= " " . $1; 269219c146a6SJoe Perches $hasparens = 1; 26930d7835fcSJoe Perches } 26940d7835fcSJoe Perches 26950d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 26960d7835fcSJoe Perches $id, $orig_desc); 26970d7835fcSJoe Perches 2698948b133aSHeinrich Schuchardt if (defined($id) && 2699948b133aSHeinrich Schuchardt ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { 2700d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 27010d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 27020d7835fcSJoe Perches } 2703d311cd44SJoe Perches } 2704d311cd44SJoe Perches 270513f1937eSJoe Perches# Check for added, moved or deleted files 270613f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 270713f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 270813f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 270913f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 271013f1937eSJoe Perches (defined($1) || defined($2))))) { 2711a82603a8SAndrew Jeffery $is_patch = 1; 271213f1937eSJoe Perches $reported_maintainer_file = 1; 271313f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 271413f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 271513f1937eSJoe Perches } 271613f1937eSJoe Perches 271700df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 27188905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2719000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2720000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 27216c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2722de7d4f0eSAndy Whitcroft } 2723de7d4f0eSAndy Whitcroft 2724de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2725de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2726171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2727171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2728171ae1a4SAndy Whitcroft 2729171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2730171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2731171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2732171ae1a4SAndy Whitcroft 273334d99219SJoe Perches CHK("INVALID_UTF8", 2734000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 273500df344fSAndy Whitcroft } 27360a920b5bSAndy Whitcroft 273715662b3eSJoe Perches# Check if it's the start of a commit log 273815662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 273915662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 2740eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 2741eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 274215662b3eSJoe Perches $in_header_lines = 0; 274315662b3eSJoe Perches $in_commit_log = 1; 2744ed43c4e5SAllen Hubbe $has_commit_log = 1; 274515662b3eSJoe Perches } 274615662b3eSJoe Perches 2747fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2748fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2749fa64205dSPasi Savanainen if ($in_header_lines && 2750fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2751fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2752fa64205dSPasi Savanainen $non_utf8_charset = 1; 2753fa64205dSPasi Savanainen } 2754fa64205dSPasi Savanainen 2755fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 275615662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2757fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 275815662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 275915662b3eSJoe Perches } 276015662b3eSJoe Perches 2761d6430f71SJoe Perches# Check for absolute kernel paths in commit message 2762d6430f71SJoe Perches if ($tree && $in_commit_log) { 2763d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 2764d6430f71SJoe Perches my $file = $1; 2765d6430f71SJoe Perches 2766d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 2767d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 2768d6430f71SJoe Perches # 2769d6430f71SJoe Perches } else { 2770d6430f71SJoe Perches check_absolute_file($file, $herecurr); 2771d6430f71SJoe Perches } 2772d6430f71SJoe Perches } 2773d6430f71SJoe Perches } 2774d6430f71SJoe Perches 277566b47b4aSKees Cook# Check for various typo / spelling mistakes 277666d7a382SJoe Perches if (defined($misspellings) && 277766d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2778ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 277966b47b4aSKees Cook my $typo = $1; 278066b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 278166b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 278266b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 27830675a8fbSJean Delvare my $msg_level = \&WARN; 27840675a8fbSJean Delvare $msg_level = \&CHK if ($file); 27850675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 278666b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 278766b47b4aSKees Cook $fix) { 278866b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 278966b47b4aSKees Cook } 279066b47b4aSKees Cook } 279166b47b4aSKees Cook } 279266b47b4aSKees Cook 279330670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 279430670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 279500df344fSAndy Whitcroft 27960a920b5bSAndy Whitcroft#trailing whitespace 27979c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2798c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2799d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2800d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2801d5e616fcSJoe Perches $fix) { 2802194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2803d5e616fcSJoe Perches } 2804c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2805c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28063705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 28073705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 28083705ce5bSJoe Perches $fix) { 2809194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 28103705ce5bSJoe Perches } 28113705ce5bSJoe Perches 2812d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 28130a920b5bSAndy Whitcroft } 28145368df20SAndy Whitcroft 28154783f894SJosh Triplett# Check for FSF mailing addresses. 2816109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 28171bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 28183e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 28193e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 28204783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28210675a8fbSJean Delvare my $msg_level = \&ERROR; 28220675a8fbSJean Delvare $msg_level = \&CHK if ($file); 28230675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 28244783f894SJosh 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) 28254783f894SJosh Triplett } 28264783f894SJosh Triplett 28273354957aSAndi Kleen# check for Kconfig help text having a real description 28289fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 28299fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 28303354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 2831678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 2832678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 2833678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 2834678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 28353354957aSAndi Kleen my $length = 0; 28369fe287d7SAndy Whitcroft my $cnt = $realcnt; 28379fe287d7SAndy Whitcroft my $ln = $linenr + 1; 28389fe287d7SAndy Whitcroft my $f; 2839a1385803SAndy Whitcroft my $is_start = 0; 28409fe287d7SAndy Whitcroft my $is_end = 0; 2841a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 28429fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 28439fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 28449fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 28459fe287d7SAndy Whitcroft 28469fe287d7SAndy Whitcroft next if ($f =~ /^-/); 28478d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2848a1385803SAndy Whitcroft 284986adf1a0SUlf Magnusson if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 2850a1385803SAndy Whitcroft $is_start = 1; 285184af7a61SUlf Magnusson } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) { 285284af7a61SUlf Magnusson if ($lines[$ln - 1] =~ "---help---") { 285384af7a61SUlf Magnusson WARN("CONFIG_DESCRIPTION", 285484af7a61SUlf Magnusson "prefer 'help' over '---help---' for new help texts\n" . $herecurr); 285584af7a61SUlf Magnusson } 2856a1385803SAndy Whitcroft $length = -1; 2857a1385803SAndy Whitcroft } 2858a1385803SAndy Whitcroft 28599fe287d7SAndy Whitcroft $f =~ s/^.//; 28603354957aSAndi Kleen $f =~ s/#.*//; 28613354957aSAndi Kleen $f =~ s/^\s+//; 28623354957aSAndi Kleen next if ($f =~ /^$/); 2863678ae162SUlf Magnusson 2864678ae162SUlf Magnusson # This only checks context lines in the patch 2865678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 2866678ae162SUlf Magnusson # positives, even though some of these are 2867678ae162SUlf Magnusson # common words in help texts 2868678ae162SUlf Magnusson if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| 2869678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 28709fe287d7SAndy Whitcroft $is_end = 1; 28719fe287d7SAndy Whitcroft last; 28729fe287d7SAndy Whitcroft } 28733354957aSAndi Kleen $length++; 28743354957aSAndi Kleen } 287556193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2876000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 287756193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 287856193274SVadim Bendebury } 2879a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 28803354957aSAndi Kleen } 28813354957aSAndi Kleen 2882628f91a2SJoe Perches# check for MAINTAINERS entries that don't have the right form 2883628f91a2SJoe Perches if ($realfile =~ /^MAINTAINERS$/ && 2884628f91a2SJoe Perches $rawline =~ /^\+[A-Z]:/ && 2885628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 2886628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 2887628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 2888628f91a2SJoe Perches $fix) { 2889628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 2890628f91a2SJoe Perches } 2891628f91a2SJoe Perches } 2892628f91a2SJoe Perches 2893327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2894327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2895327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2896327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2897327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2898327953e9SChristoph Jaeger } 2899327953e9SChristoph Jaeger 2900c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2901c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2902c68e5878SArnaud Lacombe my $flag = $1; 2903c68e5878SArnaud Lacombe my $replacement = { 2904c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2905c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2906c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2907c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2908c68e5878SArnaud Lacombe }; 2909c68e5878SArnaud Lacombe 2910c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2911c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2912c68e5878SArnaud Lacombe } 2913c68e5878SArnaud Lacombe 2914bff5da43SRob Herring# check for DT compatible documentation 29157dd05b38SFlorian Vaussard if (defined $root && 29167dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 29177dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 29187dd05b38SFlorian Vaussard 2919bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2920bff5da43SRob Herring 2921cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2922cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2923cc93319bSFlorian Vaussard 2924bff5da43SRob Herring foreach my $compat (@compats) { 2925bff5da43SRob Herring my $compat2 = $compat; 2926185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2927185d566bSRob Herring my $compat3 = $compat; 2928185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2929185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2930bff5da43SRob Herring if ( $? >> 8 ) { 2931bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2932bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2933bff5da43SRob Herring } 2934bff5da43SRob Herring 29354fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 29364fbf32a6SFlorian Vaussard my $vendor = $1; 2937cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2938bff5da43SRob Herring if ( $? >> 8 ) { 2939bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2940cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2941bff5da43SRob Herring } 2942bff5da43SRob Herring } 2943bff5da43SRob Herring } 2944bff5da43SRob Herring 29459f3a8992SRob Herring# check for using SPDX license tag at beginning of files 29469f3a8992SRob Herring if ($realline == $checklicenseline) { 29479f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 29489f3a8992SRob Herring $checklicenseline = 2; 29499f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 29509f3a8992SRob Herring my $comment = ""; 29519f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 29529f3a8992SRob Herring $comment = '/*'; 29539f3a8992SRob Herring } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 29549f3a8992SRob Herring $comment = '//'; 29559f3a8992SRob Herring } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) { 29569f3a8992SRob Herring $comment = '#'; 29579f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 29589f3a8992SRob Herring $comment = '..'; 29599f3a8992SRob Herring } 29609f3a8992SRob Herring 29619f3a8992SRob Herring if ($comment !~ /^$/ && 29629f3a8992SRob Herring $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) { 29639f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 29649f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 29659f3a8992SRob Herring } 29669f3a8992SRob Herring } 29679f3a8992SRob Herring } 29689f3a8992SRob Herring 29695368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2970d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 29715368df20SAndy Whitcroft 297247e0c88bSJoe Perches# line length limit (with some exclusions) 297347e0c88bSJoe Perches# 297447e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 297547e0c88bSJoe Perches# logging functions like pr_info that end in a string 297647e0c88bSJoe Perches# lines with a single string 297747e0c88bSJoe Perches# #defines that are a single string 29782e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 297947e0c88bSJoe Perches# 298047e0c88bSJoe Perches# There are 3 different line length message types: 2981ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 298247e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 298347e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 298447e0c88bSJoe Perches# 298547e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 298647e0c88bSJoe Perches# 298747e0c88bSJoe Perches 2988b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 298947e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 299047e0c88bSJoe Perches 299147e0c88bSJoe Perches # Check the allowed long line types first 299247e0c88bSJoe Perches 299347e0c88bSJoe Perches # logging functions that end in a string that starts 299447e0c88bSJoe Perches # before $max_line_length 299547e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 299647e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 299747e0c88bSJoe Perches $msg_type = ""; 299847e0c88bSJoe Perches 299947e0c88bSJoe Perches # lines with only strings (w/ possible termination) 300047e0c88bSJoe Perches # #defines with only strings 300147e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 300247e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 300347e0c88bSJoe Perches $msg_type = ""; 300447e0c88bSJoe Perches 3005cc147506SJoe Perches # More special cases 3006cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3007cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3008d560a5f8SJoe Perches $msg_type = ""; 3009d560a5f8SJoe Perches 30102e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 30112e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 30122e4bbbc5SAndreas Brauchli $msg_type = ""; 30132e4bbbc5SAndreas Brauchli 301447e0c88bSJoe Perches # Otherwise set the alternate message types 301547e0c88bSJoe Perches 301647e0c88bSJoe Perches # a comment starts before $max_line_length 301747e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 301847e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 301947e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 302047e0c88bSJoe Perches 302147e0c88bSJoe Perches # a quoted string starts before $max_line_length 302247e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 302347e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 302447e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 302547e0c88bSJoe Perches } 302647e0c88bSJoe Perches 302747e0c88bSJoe Perches if ($msg_type ne "" && 302847e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 302947e0c88bSJoe Perches WARN($msg_type, 30306cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 30310a920b5bSAndy Whitcroft } 303247e0c88bSJoe Perches } 30330a920b5bSAndy Whitcroft 30348905a67cSAndy Whitcroft# check for adding lines without a newline. 30358905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 3036000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 3037000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 30388905a67cSAndy Whitcroft } 30398905a67cSAndy Whitcroft 3040b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3041de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 30420a920b5bSAndy Whitcroft 30430a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 30440a920b5bSAndy Whitcroft# more than 8 must use tabs. 3045c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3046c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3047c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3048d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 30493705ce5bSJoe Perches if (ERROR("CODE_INDENT", 30503705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 30513705ce5bSJoe Perches $fix) { 3052194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 30533705ce5bSJoe Perches } 30540a920b5bSAndy Whitcroft } 30550a920b5bSAndy Whitcroft 305608e44365SAlberto Panizzo# check for space before tabs. 305708e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 305808e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 30593705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 30603705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 30613705ce5bSJoe Perches $fix) { 3062194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3063d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 3064194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3065c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 30663705ce5bSJoe Perches } 306708e44365SAlberto Panizzo } 306808e44365SAlberto Panizzo 30696a487211SJoe Perches# check for assignments on the start of a line 30706a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 30716a487211SJoe Perches CHK("ASSIGNMENT_CONTINUATIONS", 30726a487211SJoe Perches "Assignment operator '$1' should be on the previous line\n" . $hereprev); 30736a487211SJoe Perches } 30746a487211SJoe Perches 3075d1fe9c09SJoe Perches# check for && or || at the start of a line 3076d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 3077d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 3078d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 3079d1fe9c09SJoe Perches } 3080d1fe9c09SJoe Perches 3081a91e8994SJoe Perches# check indentation starts on a tab stop 3082a91e8994SJoe Perches if ($^V && $^V ge 5.10.0 && 3083bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3084a91e8994SJoe Perches my $indent = length($1); 3085a91e8994SJoe Perches if ($indent % 8) { 3086a91e8994SJoe Perches if (WARN("TABSTOP", 3087a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3088a91e8994SJoe Perches $fix) { 3089a91e8994SJoe Perches $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; 3090a91e8994SJoe Perches } 3091a91e8994SJoe Perches } 3092a91e8994SJoe Perches } 3093a91e8994SJoe Perches 3094d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 3095d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3096fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3097d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3098d1fe9c09SJoe Perches my $oldindent = $1; 3099d1fe9c09SJoe Perches my $rest = $2; 3100d1fe9c09SJoe Perches 3101d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3102d1fe9c09SJoe Perches if ($pos >= 0) { 3103b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3104b34a26f3SJoe Perches my $newindent = $2; 3105d1fe9c09SJoe Perches 3106d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3107d1fe9c09SJoe Perches "\t" x ($pos / 8) . 3108d1fe9c09SJoe Perches " " x ($pos % 8); 3109d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3110d1fe9c09SJoe Perches 3111d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3112d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 31133705ce5bSJoe Perches 31143705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 31153705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 31163705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3117194f66fcSJoe Perches $fixed[$fixlinenr] =~ 31183705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 31193705ce5bSJoe Perches } 3120d1fe9c09SJoe Perches } 3121d1fe9c09SJoe Perches } 3122d1fe9c09SJoe Perches } 3123d1fe9c09SJoe Perches 31246ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 31256ab3a970SJoe Perches# avoid checking a few false positives: 31266ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 31276ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 31286ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 31296ab3a970SJoe Perches# multiline macros that define functions 31306ab3a970SJoe Perches# known attributes or the __attribute__ keyword 31316ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 31326ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 31333705ce5bSJoe Perches if (CHK("SPACING", 3134f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 31353705ce5bSJoe Perches $fix) { 3136194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3137f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 31383705ce5bSJoe Perches } 3139aad4f614SJoe Perches } 3140aad4f614SJoe Perches 314186406b1cSJoe Perches# Block comment styles 314286406b1cSJoe Perches# Networking with an initial /* 314305880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3144fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 314585ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 314685ad978cSJoe Perches $realline > 2) { 314705880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 314805880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 314905880600SJoe Perches } 315005880600SJoe Perches 315186406b1cSJoe Perches# Block comments use * on subsequent lines 315286406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 315386406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3154a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 315561135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3156a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 315786406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 315886406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3159a605e32eSJoe Perches } 3160a605e32eSJoe Perches 316186406b1cSJoe Perches# Block comments use */ on trailing lines 316286406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3163c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3164c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3165c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 316686406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 316786406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 316805880600SJoe Perches } 316905880600SJoe Perches 317008eb9b80SJoe Perches# Block comment * alignment 317108eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3172af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3173af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3174af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 317508eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3176af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3177af207524SJoe Perches my $oldindent; 317808eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3179af207524SJoe Perches if (defined($1)) { 3180af207524SJoe Perches $oldindent = expand_tabs($1); 3181af207524SJoe Perches } else { 3182af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3183af207524SJoe Perches $oldindent = expand_tabs($1); 3184af207524SJoe Perches } 318508eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 318608eb9b80SJoe Perches my $newindent = $1; 318708eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3188af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 318908eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 319008eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 319108eb9b80SJoe Perches } 319208eb9b80SJoe Perches } 319308eb9b80SJoe Perches 31947f619191SJoe Perches# check for missing blank lines after struct/union declarations 31957f619191SJoe Perches# with exceptions for various attributes and macros 31967f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 31977f619191SJoe Perches $line =~ /^\+/ && 31987f619191SJoe Perches !($line =~ /^\+\s*$/ || 31997f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 32007f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 32017f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 32027f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 32037f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 32047f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 32050bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 32067f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3207d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3208d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3209d752fcc8SJoe Perches $fix) { 3210f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3211d752fcc8SJoe Perches } 32127f619191SJoe Perches } 32137f619191SJoe Perches 3214365dd4eaSJoe Perches# check for multiple consecutive blank lines 3215365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3216365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3217365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3218d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3219d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3220d752fcc8SJoe Perches $fix) { 3221f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3222d752fcc8SJoe Perches } 3223d752fcc8SJoe Perches 3224365dd4eaSJoe Perches $last_blank_line = $linenr; 3225365dd4eaSJoe Perches } 3226365dd4eaSJoe Perches 32273b617e3bSJoe Perches# check for missing blank lines after declarations 32283f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 32293f7bac03SJoe Perches # actual declarations 32303f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 32315a4e1fd3SJoe Perches # function pointer declarations 32325a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 32333f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 32343f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 32353f7bac03SJoe Perches # known declaration macros 32363f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 32373f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 32383f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 32393f7bac03SJoe Perches # other possible extensions of declaration lines 32403f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 32413f7bac03SJoe Perches # not starting a section or a macro "\" extended line 32423f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 32433f7bac03SJoe Perches # looks like a declaration 32443f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 32455a4e1fd3SJoe Perches # function pointer declarations 32465a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 32473f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 32483f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 32493f7bac03SJoe Perches # known declaration macros 32503f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 32513f7bac03SJoe Perches # start of struct or union or enum 32523b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 32533f7bac03SJoe Perches # start or end of block or continuation of declaration 32543f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 32553f7bac03SJoe Perches # bitfield continuation 32563f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 32573f7bac03SJoe Perches # other possible extensions of declaration lines 32583f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 32593f7bac03SJoe Perches # indentation of previous and current line are the same 32603f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3261d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3262d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3263d752fcc8SJoe Perches $fix) { 3264f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3265d752fcc8SJoe Perches } 32663b617e3bSJoe Perches } 32673b617e3bSJoe Perches 32685f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 32696b4c5bebSAndy Whitcroft# Exceptions: 32706b4c5bebSAndy Whitcroft# 1) within comments 32716b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 32726b4c5bebSAndy Whitcroft# 3) hanging labels 32733705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 32745f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 32753705ce5bSJoe Perches if (WARN("LEADING_SPACE", 32763705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 32773705ce5bSJoe Perches $fix) { 3278194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 32793705ce5bSJoe Perches } 32805f7ddae6SRaffaele Recalcati } 32815f7ddae6SRaffaele Recalcati 3282b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3283b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3284b9ea10d6SAndy Whitcroft 32855751a24eSJoe Perches# check for unusual line ending [ or ( 32865751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 32875751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 32885751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 32895751a24eSJoe Perches } 32905751a24eSJoe Perches 32914dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 32924dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 32934dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 32944dbed76fSJoe Perches $context_function = $1; 32954dbed76fSJoe Perches } 32964dbed76fSJoe Perches 32974dbed76fSJoe Perches# check if this appears to be the end of function declaration 32984dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 32994dbed76fSJoe Perches undef $context_function; 33004dbed76fSJoe Perches } 33014dbed76fSJoe Perches 3302032a4c0fSJoe Perches# check indentation of any line with a bare else 3303840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3304032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3305032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3306032a4c0fSJoe Perches my $tabs = length($1) + 1; 3307840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3308840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3309840080a0SJoe Perches defined $lines[$linenr] && 3310840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3311032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3312032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3313032a4c0fSJoe Perches } 3314032a4c0fSJoe Perches } 3315032a4c0fSJoe Perches 3316c00df19aSJoe Perches# check indentation of a line with a break; 3317c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3318c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3319c00df19aSJoe Perches my $tabs = $1; 3320c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3321c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3322c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3323c00df19aSJoe Perches } 3324c00df19aSJoe Perches } 3325c00df19aSJoe Perches 3326c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3327cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3328000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3329000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3330c2fdda0dSAndy Whitcroft } 333122f2a2efSAndy Whitcroft 333256e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 333356e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 333456e77d70SJoe Perches WARN("HOTPLUG_SECTION", 333556e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 333656e77d70SJoe Perches } 333756e77d70SJoe Perches 33389c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 33392b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 33402b474a1aSAndy Whitcroft $realline_next); 33413e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 3342ca819864SJoe Perches if ($linenr > $suppress_statement && 33431b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3344170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3345f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3346171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3347171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3348171ae1a4SAndy Whitcroft 33493e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 33503e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 33513e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 33523e469cdcSAndy Whitcroft # until we hit end of it. 33533e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 33543e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 33553e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 33563e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 33573e469cdcSAndy Whitcroft } 3358f74bd194SAndy Whitcroft 33592b474a1aSAndy Whitcroft # Find the real next line. 33602b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 33612b474a1aSAndy Whitcroft if (defined $realline_next && 33622b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 33632b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 33642b474a1aSAndy Whitcroft $realline_next++; 33652b474a1aSAndy Whitcroft } 33662b474a1aSAndy Whitcroft 3367171ae1a4SAndy Whitcroft my $s = $stat; 3368171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3369cf655043SAndy Whitcroft 3370c2fdda0dSAndy Whitcroft # Ignore goto labels. 3371171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3372c2fdda0dSAndy Whitcroft 3373c2fdda0dSAndy Whitcroft # Ignore functions being called 3374171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3375c2fdda0dSAndy Whitcroft 3376463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3377463f2864SAndy Whitcroft 3378c45dcabdSAndy Whitcroft # declarations always start with types 3379d2506586SAndy 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) { 3380c45dcabdSAndy Whitcroft my $type = $1; 3381c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3382c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3383c45dcabdSAndy Whitcroft 33846c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3385a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3386c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3387c2fdda0dSAndy Whitcroft } 33888905a67cSAndy Whitcroft 33896c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 339065863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3391c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 33929c0ca6f9SAndy Whitcroft } 33938905a67cSAndy Whitcroft 33948905a67cSAndy Whitcroft # Check for any sort of function declaration. 33958905a67cSAndy Whitcroft # int foo(something bar, other baz); 33968905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3397171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 33988905a67cSAndy Whitcroft my ($name_len) = length($1); 33998905a67cSAndy Whitcroft 3400cf655043SAndy Whitcroft my $ctx = $s; 3401773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 34028905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3403cf655043SAndy Whitcroft 34048905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3405c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 34068905a67cSAndy Whitcroft 3407c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 34088905a67cSAndy Whitcroft } 34098905a67cSAndy Whitcroft } 34108905a67cSAndy Whitcroft } 34118905a67cSAndy Whitcroft 34129c0ca6f9SAndy Whitcroft } 34139c0ca6f9SAndy Whitcroft 341400df344fSAndy Whitcroft# 341500df344fSAndy Whitcroft# Checks which may be anchored in the context. 341600df344fSAndy Whitcroft# 341700df344fSAndy Whitcroft 341800df344fSAndy Whitcroft# Check for switch () and associated case and default 341900df344fSAndy Whitcroft# statements should be at the same indent. 342000df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 342100df344fSAndy Whitcroft my $err = ''; 342200df344fSAndy Whitcroft my $sep = ''; 342300df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 342400df344fSAndy Whitcroft shift(@ctx); 342500df344fSAndy Whitcroft for my $ctx (@ctx) { 342600df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 342700df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 342800df344fSAndy Whitcroft $indent != $cindent) { 342900df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 343000df344fSAndy Whitcroft $sep = ''; 343100df344fSAndy Whitcroft } else { 343200df344fSAndy Whitcroft $sep = "[...]\n"; 343300df344fSAndy Whitcroft } 343400df344fSAndy Whitcroft } 343500df344fSAndy Whitcroft if ($err ne '') { 3436000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3437000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3438de7d4f0eSAndy Whitcroft } 3439de7d4f0eSAndy Whitcroft } 3440de7d4f0eSAndy Whitcroft 3441de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3442de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 34430fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3444773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3445773647a0SAndy Whitcroft 34469c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 34478eef05ddSJoe Perches 34488eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 34498eef05ddSJoe Perches WARN("DEEP_INDENTATION", 34508eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 34518eef05ddSJoe Perches } 34528eef05ddSJoe Perches 3453de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3454de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3455de7d4f0eSAndy Whitcroft 3456548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3457548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3458de7d4f0eSAndy Whitcroft 3459548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3460548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3461548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3462548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3463548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3464773647a0SAndy Whitcroft $ctx_ln++; 3465773647a0SAndy Whitcroft } 3466548596d5SAndy Whitcroft 346753210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 346853210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3469773647a0SAndy Whitcroft 3470773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3471000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3472000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 347301464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 347400df344fSAndy Whitcroft } 3475773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3476773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3477773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3478773647a0SAndy Whitcroft { 34799c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 34809c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3481000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3482000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 348301464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 34849c0ca6f9SAndy Whitcroft } 34859c0ca6f9SAndy Whitcroft } 348600df344fSAndy Whitcroft } 348700df344fSAndy Whitcroft 34884d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 3489f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 34903e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 34913e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 34923e469cdcSAndy Whitcroft if (!defined $stat); 34934d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 34944d001e4dSAndy Whitcroft 34954d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 34964d001e4dSAndy Whitcroft 34979f5af480SJoe Perches # remove inline comments 34989f5af480SJoe Perches $s =~ s/$;/ /g; 34999f5af480SJoe Perches $c =~ s/$;/ /g; 35004d001e4dSAndy Whitcroft 35014d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 35026f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 35036f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 35044d001e4dSAndy Whitcroft 35059f5af480SJoe Perches # Make sure we remove the line prefixes as we have 35069f5af480SJoe Perches # none on the first line, and are going to readd them 35079f5af480SJoe Perches # where necessary. 35089f5af480SJoe Perches $s =~ s/\n./\n/gs; 35099f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 35109f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 35119f5af480SJoe Perches } 35129f5af480SJoe Perches 35134d001e4dSAndy Whitcroft # We want to check the first line inside the block 35144d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 35154d001e4dSAndy Whitcroft # 1) any blank line termination 35164d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 35174d001e4dSAndy Whitcroft # 3) any do (...) { 35184d001e4dSAndy Whitcroft my $continuation = 0; 35194d001e4dSAndy Whitcroft my $check = 0; 35204d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 35214d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 35224d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 35234d001e4dSAndy Whitcroft $continuation = 1; 35244d001e4dSAndy Whitcroft } 35259bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 35264d001e4dSAndy Whitcroft $check = 1; 35274d001e4dSAndy Whitcroft $cond_lines++; 35284d001e4dSAndy Whitcroft } 35294d001e4dSAndy Whitcroft 35304d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 35314d001e4dSAndy Whitcroft # preprocessor statement. 35324d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 35334d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 35344d001e4dSAndy Whitcroft $check = 0; 35354d001e4dSAndy Whitcroft } 35364d001e4dSAndy Whitcroft 35379bd49efeSAndy Whitcroft my $cond_ptr = -1; 3538740504c6SAndy Whitcroft $continuation = 0; 35399bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 35409bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 35414d001e4dSAndy Whitcroft 3542f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3543f16fa28fSAndy Whitcroft # is not linear. 3544f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3545f16fa28fSAndy Whitcroft $check = 0; 3546f16fa28fSAndy Whitcroft } 3547f16fa28fSAndy Whitcroft 35489bd49efeSAndy Whitcroft # Ignore: 35499bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 35509bd49efeSAndy Whitcroft # 2) preprocessor lines, and 35519bd49efeSAndy Whitcroft # 3) labels. 3552740504c6SAndy Whitcroft if ($continuation || 3553740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 35549bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 35559bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3556740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 355730dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 35589bd49efeSAndy Whitcroft $cond_lines++; 35599bd49efeSAndy Whitcroft } 35604d001e4dSAndy Whitcroft } 356130dad6ebSAndy Whitcroft } 35624d001e4dSAndy Whitcroft 35634d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 35644d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 35654d001e4dSAndy Whitcroft 35664d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 35674d001e4dSAndy Whitcroft # this is not this patch's fault. 35684d001e4dSAndy Whitcroft if (!defined($stat_real) || 35694d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 35704d001e4dSAndy Whitcroft $check = 0; 35714d001e4dSAndy Whitcroft } 35724d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 35734d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 35744d001e4dSAndy Whitcroft } 35754d001e4dSAndy Whitcroft 35769bd49efeSAndy 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"; 35774d001e4dSAndy Whitcroft 35789f5af480SJoe Perches if ($check && $s ne '' && 35799f5af480SJoe Perches (($sindent % 8) != 0 || 35809f5af480SJoe Perches ($sindent < $indent) || 3581f6950a73SJoe Perches ($sindent == $indent && 3582f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 35839f5af480SJoe Perches ($sindent > $indent + 8))) { 3584000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3585000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 35864d001e4dSAndy Whitcroft } 35874d001e4dSAndy Whitcroft } 35884d001e4dSAndy Whitcroft 35896c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 35906c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 35911f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 35921f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 35936c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3594c2fdda0dSAndy Whitcroft if ($dbg_values) { 3595c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3596cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3597cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 35981f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3599c2fdda0dSAndy Whitcroft } 36006c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 36016c72ffaaSAndy Whitcroft 360200df344fSAndy Whitcroft#ignore lines not being added 36033705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 360400df344fSAndy Whitcroft 360511ca40a0SJoe Perches# check for dereferences that span multiple lines 360611ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 360711ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 360811ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 360911ca40a0SJoe Perches my $ref = $1; 361011ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 361111ca40a0SJoe Perches $ref .= $1; 361211ca40a0SJoe Perches $ref =~ s/\s//g; 361311ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 361411ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 361511ca40a0SJoe Perches } 361611ca40a0SJoe Perches 3617a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3618c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3619a1ce18e4SJoe Perches my $type = $1; 3620a1ce18e4SJoe Perches my $var = $2; 3621207a8e84SJoe Perches $var = "" if (!defined $var); 3622207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3623a1ce18e4SJoe Perches my $sign = $1; 3624a1ce18e4SJoe Perches my $pointer = $2; 3625a1ce18e4SJoe Perches 3626a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3627a1ce18e4SJoe Perches 3628a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3629a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3630a1ce18e4SJoe Perches $fix) { 3631a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3632207a8e84SJoe Perches my $comp_pointer = $pointer; 3633207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 3634207a8e84SJoe Perches $decl .= $comp_pointer; 3635207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 3636207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 3637a1ce18e4SJoe Perches } 3638a1ce18e4SJoe Perches } 3639a1ce18e4SJoe Perches } 3640a1ce18e4SJoe Perches 3641653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 36427429c690SAndy Whitcroft if ($dbg_type) { 36437429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3644000d1cc1SJoe Perches ERROR("TEST_TYPE", 3645000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 36467429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3647000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3648000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 36497429c690SAndy Whitcroft } 3650653d4876SAndy Whitcroft next; 3651653d4876SAndy Whitcroft } 3652a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3653a1ef277eSAndy Whitcroft if ($dbg_attr) { 36549360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3655000d1cc1SJoe Perches ERROR("TEST_ATTR", 3656000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 36579360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3658000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3659000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3660a1ef277eSAndy Whitcroft } 3661a1ef277eSAndy Whitcroft next; 3662a1ef277eSAndy Whitcroft } 3663653d4876SAndy Whitcroft 3664f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 366599423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 366699423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3667d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3668d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3669f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3670f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3671f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3672d752fcc8SJoe Perches my $fixedline = $prevrawline; 3673d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3674f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3675d752fcc8SJoe Perches $fixedline = $line; 36768d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 3677f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3678d752fcc8SJoe Perches } 3679f0a594c1SAndy Whitcroft } 3680f0a594c1SAndy Whitcroft 368100df344fSAndy Whitcroft# 368200df344fSAndy Whitcroft# Checks which are anchored on the added line. 368300df344fSAndy Whitcroft# 368400df344fSAndy Whitcroft 3685653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3686c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3687653d4876SAndy Whitcroft my $path = $1; 3688653d4876SAndy Whitcroft if ($path =~ m{//}) { 3689000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3690495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3691495e9d84SJoe Perches } 3692495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3693495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3694495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3695653d4876SAndy Whitcroft } 3696653d4876SAndy Whitcroft } 3697653d4876SAndy Whitcroft 369800df344fSAndy Whitcroft# no C99 // comments 369900df344fSAndy Whitcroft if ($line =~ m{//}) { 37003705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 37013705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 37023705ce5bSJoe Perches $fix) { 3703194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 37043705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 37053705ce5bSJoe Perches my $comment = trim($1); 3706194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 37073705ce5bSJoe Perches } 37083705ce5bSJoe Perches } 370900df344fSAndy Whitcroft } 371000df344fSAndy Whitcroft # Remove C99 comments. 37110a920b5bSAndy Whitcroft $line =~ s@//.*@@; 37126c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 37130a920b5bSAndy Whitcroft 37142b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 37152b474a1aSAndy Whitcroft# the whole statement. 37162b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 37172b474a1aSAndy Whitcroft if (defined $realline_next && 37182b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 37192b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 37202b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 37212b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 37223cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 37233cbf62dfSAndy Whitcroft # a prefix: 37243cbf62dfSAndy Whitcroft # XXX(foo); 37253cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3726653d4876SAndy Whitcroft my $name = $1; 372787a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 37283cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 37293cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 37303cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 37313cbf62dfSAndy Whitcroft 37323cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 37332b474a1aSAndy Whitcroft \n.}\s*$| 373448012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 373548012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 373648012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 37372b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 37382b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 373948012058SAndy Whitcroft )/x) { 37402b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 37412b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 37422b474a1aSAndy Whitcroft } else { 37432b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 37440a920b5bSAndy Whitcroft } 37450a920b5bSAndy Whitcroft } 37462b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 37472b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 37482b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 37492b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 37502b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 37512b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 37522b474a1aSAndy Whitcroft } 37532b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 37542b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3755000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3756000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 37572b474a1aSAndy Whitcroft } 37580a920b5bSAndy Whitcroft 37595150bda4SJoe Eloff# check for global initialisers. 37606d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 3761d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 37626d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 3763d5e616fcSJoe Perches $fix) { 37646d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 3765d5e616fcSJoe Perches } 3766f0a594c1SAndy Whitcroft } 37670a920b5bSAndy Whitcroft# check for static initialisers. 37686d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 3769d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 37706d32f7a3SJoe Perches "do not initialise statics to $1\n" . 3771d5e616fcSJoe Perches $herecurr) && 3772d5e616fcSJoe Perches $fix) { 37736d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 3774d5e616fcSJoe Perches } 37750a920b5bSAndy Whitcroft } 37760a920b5bSAndy Whitcroft 37771813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 37781813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 37791813087dSJoe Perches my $tmp = trim($1); 37801813087dSJoe Perches WARN("MISORDERED_TYPE", 37811813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 37821813087dSJoe Perches } 37831813087dSJoe Perches 3784cb710ecaSJoe Perches# check for static const char * arrays. 3785cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3786000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3787000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3788cb710ecaSJoe Perches $herecurr); 3789cb710ecaSJoe Perches } 3790cb710ecaSJoe Perches 3791cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3792cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3793000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3794000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3795cb710ecaSJoe Perches $herecurr); 3796cb710ecaSJoe Perches } 3797cb710ecaSJoe Perches 3798ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3799ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3800ab7e23f3SJoe Perches my $found = $1; 3801ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3802ab7e23f3SJoe Perches WARN("CONST_CONST", 3803ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3804ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3805ab7e23f3SJoe Perches WARN("CONST_CONST", 3806ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3807ab7e23f3SJoe Perches } 3808ab7e23f3SJoe Perches } 3809ab7e23f3SJoe Perches 38109b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 38119b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 38129b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 38139b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 38149b0fa60dSJoe Perches $herecurr); 38159b0fa60dSJoe Perches } 38169b0fa60dSJoe Perches 3817b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3818b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3819b598b670SJoe Perches my $array = $1; 3820b598b670SJoe 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*\))@) { 3821b598b670SJoe Perches my $array_div = $1; 3822b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3823b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3824b598b670SJoe Perches $fix) { 3825b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3826b598b670SJoe Perches } 3827b598b670SJoe Perches } 3828b598b670SJoe Perches } 3829b598b670SJoe Perches 3830b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3831b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3832b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3833b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3834b36190c5SJoe Perches $fix) { 3835194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3836b36190c5SJoe Perches } 3837b36190c5SJoe Perches } 3838b36190c5SJoe Perches 3839653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3840653d4876SAndy Whitcroft# make sense. 3841653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 38428054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3843c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 38448ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 384546d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 3846000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3847000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 38480a920b5bSAndy Whitcroft } 38490a920b5bSAndy Whitcroft 38500a920b5bSAndy Whitcroft# * goes on variable not on type 385165863862SAndy Whitcroft # (char*[ const]) 3852bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3853bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 38543705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3855d8aaf121SAndy Whitcroft 385665863862SAndy Whitcroft # Should start with a space. 385765863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 385865863862SAndy Whitcroft # Should not end with a space. 385965863862SAndy Whitcroft $to =~ s/\s+$//; 386065863862SAndy Whitcroft # '*'s should not have spaces between. 3861f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 386265863862SAndy Whitcroft } 3863d8aaf121SAndy Whitcroft 38643705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 386565863862SAndy Whitcroft if ($from ne $to) { 38663705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 38673705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 38683705ce5bSJoe Perches $fix) { 38693705ce5bSJoe Perches my $sub_from = $ident; 38703705ce5bSJoe Perches my $sub_to = $ident; 38713705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3872194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38733705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 38743705ce5bSJoe Perches } 387565863862SAndy Whitcroft } 3876bfcb2cc7SAndy Whitcroft } 3877bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3878bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 38793705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3880d8aaf121SAndy Whitcroft 388165863862SAndy Whitcroft # Should start with a space. 388265863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 388365863862SAndy Whitcroft # Should not end with a space. 388465863862SAndy Whitcroft $to =~ s/\s+$//; 388565863862SAndy Whitcroft # '*'s should not have spaces between. 3886f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 388765863862SAndy Whitcroft } 388865863862SAndy Whitcroft # Modifiers should have spaces. 388965863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 389065863862SAndy Whitcroft 38913705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3892667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 38933705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 38943705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 38953705ce5bSJoe Perches $fix) { 38963705ce5bSJoe Perches 38973705ce5bSJoe Perches my $sub_from = $match; 38983705ce5bSJoe Perches my $sub_to = $match; 38993705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3900194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39013705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 39023705ce5bSJoe Perches } 390365863862SAndy Whitcroft } 39040a920b5bSAndy Whitcroft } 39050a920b5bSAndy Whitcroft 39069d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 39079d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 39080675a8fbSJean Delvare my $msg_level = \&WARN; 39090675a8fbSJean Delvare $msg_level = \&CHK if ($file); 39100675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 39119d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 39129d3e3c70SJoe Perches } 39130a920b5bSAndy Whitcroft 39149d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 39158905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3916000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3917000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 39188905a67cSAndy Whitcroft } 39198905a67cSAndy Whitcroft 392017441227SJoe Perches# check for uses of printk_ratelimit 392117441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3922000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3923000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 392417441227SJoe Perches } 392517441227SJoe Perches 3926eeef5733SJoe Perches# printk should use KERN_* levels 3927eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 3928000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3929eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 393000df344fSAndy Whitcroft } 39310a920b5bSAndy Whitcroft 3932243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3933243f3803SJoe Perches my $orig = $1; 3934243f3803SJoe Perches my $level = lc($orig); 3935243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 39368f26b837SJoe Perches my $level2 = $level; 39378f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3938243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3939daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3940243f3803SJoe Perches } 3941243f3803SJoe Perches 3942243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3943d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3944d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3945d5e616fcSJoe Perches $fix) { 3946194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3947d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3948d5e616fcSJoe Perches } 3949243f3803SJoe Perches } 3950243f3803SJoe Perches 3951dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3952dc139313SJoe Perches my $orig = $1; 3953dc139313SJoe Perches my $level = lc($orig); 3954dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3955dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3956dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3957dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3958dc139313SJoe Perches } 3959dc139313SJoe Perches 396091c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 396191c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 396291c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 396391c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 396491c9afafSAndy Lutomirski WARN("ENOSYS", 396591c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 396691c9afafSAndy Lutomirski } 396791c9afafSAndy Lutomirski 3968653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3969653d4876SAndy Whitcroft# or if closed on same line 39702d453e3bSJoe Perches if ($^V && $^V ge 5.10.0 && 39712d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 39722d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 39732d453e3bSJoe Perches $sline !~ /}/) { 39748d182478SJoe Perches if (ERROR("OPEN_BRACE", 39752d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 39768d182478SJoe Perches $fix) { 39778d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 39788d182478SJoe Perches my $fixed_line = $rawline; 39798d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 39808d182478SJoe Perches my $line1 = $1; 39818d182478SJoe Perches my $line2 = $2; 39828d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 39838d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 39848d182478SJoe Perches if ($line2 !~ /^\s*$/) { 39858d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 39868d182478SJoe Perches } 39878d182478SJoe Perches } 39880a920b5bSAndy Whitcroft } 3989653d4876SAndy Whitcroft 39908905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 39918905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 39928905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 39938d182478SJoe Perches if (ERROR("OPEN_BRACE", 39948d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 39958d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 39968d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 39978d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 39988d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 39998d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 40008d182478SJoe Perches $fixedline = $rawline; 40018d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 40028d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 40038d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 40048d182478SJoe Perches } 40058d182478SJoe Perches } 40068905a67cSAndy Whitcroft } 40078905a67cSAndy Whitcroft 40080c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 40093705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 40103705ce5bSJoe Perches if (WARN("SPACING", 40113705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 40123705ce5bSJoe Perches $fix) { 4013194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40143705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 40153705ce5bSJoe Perches } 40160c73b4ebSAndy Whitcroft } 40170c73b4ebSAndy Whitcroft 401831070b5dSJoe Perches# Function pointer declarations 401931070b5dSJoe Perches# check spacing between type, funcptr, and args 402031070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 402191f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 402231070b5dSJoe Perches my $declare = $1; 402331070b5dSJoe Perches my $pre_pointer_space = $2; 402431070b5dSJoe Perches my $post_pointer_space = $3; 402531070b5dSJoe Perches my $funcname = $4; 402631070b5dSJoe Perches my $post_funcname_space = $5; 402731070b5dSJoe Perches my $pre_args_space = $6; 402831070b5dSJoe Perches 402991f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 403091f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 403191f72e9cSJoe Perches# don't need a space so don't warn for those. 403291f72e9cSJoe Perches my $post_declare_space = ""; 403391f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 403491f72e9cSJoe Perches $post_declare_space = $1; 403591f72e9cSJoe Perches $declare = rtrim($declare); 403691f72e9cSJoe Perches } 403791f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 403831070b5dSJoe Perches WARN("SPACING", 403931070b5dSJoe Perches "missing space after return type\n" . $herecurr); 404091f72e9cSJoe Perches $post_declare_space = " "; 404131070b5dSJoe Perches } 404231070b5dSJoe Perches 404331070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 404491f72e9cSJoe Perches# This test is not currently implemented because these declarations are 404591f72e9cSJoe Perches# equivalent to 404691f72e9cSJoe Perches# int foo(int bar, ...) 404791f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 404891f72e9cSJoe Perches# 404991f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 405091f72e9cSJoe Perches# WARN("SPACING", 405191f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 405291f72e9cSJoe Perches# } 405331070b5dSJoe Perches 405431070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 405531070b5dSJoe Perches if (defined $pre_pointer_space && 405631070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 405731070b5dSJoe Perches WARN("SPACING", 405831070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 405931070b5dSJoe Perches } 406031070b5dSJoe Perches 406131070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 406231070b5dSJoe Perches if (defined $post_pointer_space && 406331070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 406431070b5dSJoe Perches WARN("SPACING", 406531070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 406631070b5dSJoe Perches } 406731070b5dSJoe Perches 406831070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 406931070b5dSJoe Perches if (defined $post_funcname_space && 407031070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 407131070b5dSJoe Perches WARN("SPACING", 407231070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 407331070b5dSJoe Perches } 407431070b5dSJoe Perches 407531070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 407631070b5dSJoe Perches if (defined $pre_args_space && 407731070b5dSJoe Perches $pre_args_space =~ /^\s/) { 407831070b5dSJoe Perches WARN("SPACING", 407931070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 408031070b5dSJoe Perches } 408131070b5dSJoe Perches 408231070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4083194f66fcSJoe Perches $fixed[$fixlinenr] =~ 408491f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 408531070b5dSJoe Perches } 408631070b5dSJoe Perches } 408731070b5dSJoe Perches 40888d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 40898d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4090fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4091fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 40928d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 40938d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 40948d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4095fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 409638dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 40973705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 40983705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 40993705ce5bSJoe Perches $fix) { 4100194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41013705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 41023705ce5bSJoe Perches } 41038d31cfceSAndy Whitcroft } 41048d31cfceSAndy Whitcroft } 41058d31cfceSAndy Whitcroft 4106f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 41076c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4108c2fdda0dSAndy Whitcroft my $name = $1; 4109773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4110773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4111c2fdda0dSAndy Whitcroft 4112c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4113773647a0SAndy Whitcroft if ($name =~ /^(?: 4114773647a0SAndy Whitcroft if|for|while|switch|return|case| 4115773647a0SAndy Whitcroft volatile|__volatile__| 4116773647a0SAndy Whitcroft __attribute__|format|__extension__| 4117773647a0SAndy Whitcroft asm|__asm__)$/x) 4118773647a0SAndy Whitcroft { 4119c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4120c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4121c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4122c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4123773647a0SAndy Whitcroft 4124773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4125c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4126c2fdda0dSAndy Whitcroft 4127c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4128c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4129773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4130c2fdda0dSAndy Whitcroft 4131c2fdda0dSAndy Whitcroft } else { 41323705ce5bSJoe Perches if (WARN("SPACING", 41333705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 41343705ce5bSJoe Perches $fix) { 4135194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41363705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 41373705ce5bSJoe Perches } 4138f0a594c1SAndy Whitcroft } 41396c72ffaaSAndy Whitcroft } 41409a4cad4eSEric Nelson 4141653d4876SAndy Whitcroft# Check operator spacing. 41420a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 41433705ce5bSJoe Perches my $fixed_line = ""; 41443705ce5bSJoe Perches my $line_fixed = 0; 41453705ce5bSJoe Perches 41469c0ca6f9SAndy Whitcroft my $ops = qr{ 41479c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 41489c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 41499c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 41501f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 415184731623SJoe Perches \?:|\?|: 41529c0ca6f9SAndy Whitcroft }x; 4153cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 41543705ce5bSJoe Perches 41553705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 41563705ce5bSJoe Perches## foreach my $el (@elements) { 41573705ce5bSJoe Perches## print("el: <$el>\n"); 41583705ce5bSJoe Perches## } 41593705ce5bSJoe Perches 41603705ce5bSJoe Perches my @fix_elements = (); 416100df344fSAndy Whitcroft my $off = 0; 41626c72ffaaSAndy Whitcroft 41633705ce5bSJoe Perches foreach my $el (@elements) { 41643705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 41653705ce5bSJoe Perches $off += length($el); 41663705ce5bSJoe Perches } 41673705ce5bSJoe Perches 41683705ce5bSJoe Perches $off = 0; 41693705ce5bSJoe Perches 41706c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4171b34c648bSJoe Perches my $last_after = -1; 41726c72ffaaSAndy Whitcroft 41730a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 41743705ce5bSJoe Perches 41753705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 41763705ce5bSJoe Perches 41773705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 41783705ce5bSJoe Perches 41794a0df2efSAndy Whitcroft $off += length($elements[$n]); 41804a0df2efSAndy Whitcroft 418125985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4182773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4183773647a0SAndy Whitcroft my $cc = ''; 4184773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4185773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4186773647a0SAndy Whitcroft } 4187773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4188773647a0SAndy Whitcroft 41894a0df2efSAndy Whitcroft my $a = ''; 41904a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 41914a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4192cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 41934a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 41944a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 4195773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 41964a0df2efSAndy Whitcroft 41970a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 41984a0df2efSAndy Whitcroft 41994a0df2efSAndy Whitcroft my $c = ''; 42000a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 42014a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 42024a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4203cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 42044a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 42054a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 42068b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 42074a0df2efSAndy Whitcroft } else { 42084a0df2efSAndy Whitcroft $c = 'E'; 42090a920b5bSAndy Whitcroft } 42100a920b5bSAndy Whitcroft 42114a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 42124a0df2efSAndy Whitcroft 42134a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 42144a0df2efSAndy Whitcroft 42156c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 4216de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 42170a920b5bSAndy Whitcroft 421874048ed8SAndy Whitcroft # Pull out the value of this operator. 42196c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 42200a920b5bSAndy Whitcroft 42211f65f947SAndy Whitcroft # Get the full operator variant. 42221f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 42231f65f947SAndy Whitcroft 422413214adfSAndy Whitcroft # Ignore operators passed as parameters. 422513214adfSAndy Whitcroft if ($op_type ne 'V' && 4226d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 422713214adfSAndy Whitcroft 4228cf655043SAndy Whitcroft# # Ignore comments 4229cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 423013214adfSAndy Whitcroft 4231d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 423213214adfSAndy Whitcroft } elsif ($op eq ';') { 4233cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 4234cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 42353705ce5bSJoe Perches if (ERROR("SPACING", 42363705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 4237b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 42383705ce5bSJoe Perches $line_fixed = 1; 42393705ce5bSJoe Perches } 4240d8aaf121SAndy Whitcroft } 4241d8aaf121SAndy Whitcroft 4242d8aaf121SAndy Whitcroft # // is a comment 4243d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 42440a920b5bSAndy Whitcroft 4245b00e4814SJoe Perches # : when part of a bitfield 4246b00e4814SJoe Perches } elsif ($opv eq ':B') { 4247b00e4814SJoe Perches # skip the bitfield test for now 4248b00e4814SJoe Perches 42491f65f947SAndy Whitcroft # No spaces for: 42501f65f947SAndy Whitcroft # -> 4251b00e4814SJoe Perches } elsif ($op eq '->') { 42524a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 42533705ce5bSJoe Perches if (ERROR("SPACING", 42543705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4255b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 42563705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 42573705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 42583705ce5bSJoe Perches } 4259b34c648bSJoe Perches $line_fixed = 1; 42603705ce5bSJoe Perches } 42610a920b5bSAndy Whitcroft } 42620a920b5bSAndy Whitcroft 42632381097bSJoe Perches # , must not have a space before and must have a space on the right. 42640a920b5bSAndy Whitcroft } elsif ($op eq ',') { 42652381097bSJoe Perches my $rtrim_before = 0; 42662381097bSJoe Perches my $space_after = 0; 42672381097bSJoe Perches if ($ctx =~ /Wx./) { 42682381097bSJoe Perches if (ERROR("SPACING", 42692381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 42702381097bSJoe Perches $line_fixed = 1; 42712381097bSJoe Perches $rtrim_before = 1; 42722381097bSJoe Perches } 42732381097bSJoe Perches } 4274cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 42753705ce5bSJoe Perches if (ERROR("SPACING", 42763705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 42773705ce5bSJoe Perches $line_fixed = 1; 4278b34c648bSJoe Perches $last_after = $n; 42792381097bSJoe Perches $space_after = 1; 42802381097bSJoe Perches } 42812381097bSJoe Perches } 42822381097bSJoe Perches if ($rtrim_before || $space_after) { 42832381097bSJoe Perches if ($rtrim_before) { 42842381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 42852381097bSJoe Perches } else { 42862381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 42872381097bSJoe Perches } 42882381097bSJoe Perches if ($space_after) { 42892381097bSJoe Perches $good .= " "; 42903705ce5bSJoe Perches } 42910a920b5bSAndy Whitcroft } 42920a920b5bSAndy Whitcroft 42939c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 429474048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 42959c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 42969c0ca6f9SAndy Whitcroft 42979c0ca6f9SAndy Whitcroft # unary operators should have a space before and 42989c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 42999c0ca6f9SAndy Whitcroft # unary operator, or a cast 43009c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 430174048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 43020d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4303cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 43043705ce5bSJoe Perches if (ERROR("SPACING", 43053705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4306b34c648bSJoe Perches if ($n != $last_after + 2) { 4307b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 43083705ce5bSJoe Perches $line_fixed = 1; 43093705ce5bSJoe Perches } 43100a920b5bSAndy Whitcroft } 4311b34c648bSJoe Perches } 4312a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4313171ae1a4SAndy Whitcroft # A unary '*' may be const 4314171ae1a4SAndy Whitcroft 4315171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 43163705ce5bSJoe Perches if (ERROR("SPACING", 43173705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4318b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 43193705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 43203705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 43213705ce5bSJoe Perches } 4322b34c648bSJoe Perches $line_fixed = 1; 43233705ce5bSJoe Perches } 43240a920b5bSAndy Whitcroft } 43250a920b5bSAndy Whitcroft 43260a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 43270a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4328773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 43293705ce5bSJoe Perches if (ERROR("SPACING", 43303705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4331b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 43323705ce5bSJoe Perches $line_fixed = 1; 43333705ce5bSJoe Perches } 43340a920b5bSAndy Whitcroft } 4335773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4336773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 43373705ce5bSJoe Perches if (ERROR("SPACING", 43383705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4339b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43403705ce5bSJoe Perches $line_fixed = 1; 43413705ce5bSJoe Perches } 4342653d4876SAndy Whitcroft } 4343773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 43443705ce5bSJoe Perches if (ERROR("SPACING", 43453705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4346b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 43473705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 43483705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4349773647a0SAndy Whitcroft } 4350b34c648bSJoe Perches $line_fixed = 1; 43513705ce5bSJoe Perches } 43523705ce5bSJoe Perches } 43530a920b5bSAndy Whitcroft 43540a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 43559c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 43569c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 43579c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4358c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4359c2fdda0dSAndy Whitcroft $op eq '%') 43600a920b5bSAndy Whitcroft { 4361d2e025f3SJoe Perches if ($check) { 4362d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4363d2e025f3SJoe Perches if (CHK("SPACING", 4364d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4365d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4366d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4367d2e025f3SJoe Perches $line_fixed = 1; 4368d2e025f3SJoe Perches } 4369d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4370d2e025f3SJoe Perches if (CHK("SPACING", 4371d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4372d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4373d2e025f3SJoe Perches $line_fixed = 1; 4374d2e025f3SJoe Perches } 4375d2e025f3SJoe Perches } 4376d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 43773705ce5bSJoe Perches if (ERROR("SPACING", 43783705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4379b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4380b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4381b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4382b34c648bSJoe Perches } 43833705ce5bSJoe Perches $line_fixed = 1; 43843705ce5bSJoe Perches } 43850a920b5bSAndy Whitcroft } 43860a920b5bSAndy Whitcroft 43871f65f947SAndy Whitcroft # A colon needs no spaces before when it is 43881f65f947SAndy Whitcroft # terminating a case value or a label. 43891f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 43901f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 43913705ce5bSJoe Perches if (ERROR("SPACING", 43923705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4393b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43943705ce5bSJoe Perches $line_fixed = 1; 43953705ce5bSJoe Perches } 43961f65f947SAndy Whitcroft } 43971f65f947SAndy Whitcroft 43980a920b5bSAndy Whitcroft # All the others need spaces both sides. 4399cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 44001f65f947SAndy Whitcroft my $ok = 0; 44011f65f947SAndy Whitcroft 440222f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 44031f65f947SAndy Whitcroft if (($op eq '<' && 44041f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 44051f65f947SAndy Whitcroft ($op eq '>' && 44061f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 44071f65f947SAndy Whitcroft { 44081f65f947SAndy Whitcroft $ok = 1; 44091f65f947SAndy Whitcroft } 44101f65f947SAndy Whitcroft 4411e0df7e1fSJoe Perches # for asm volatile statements 4412e0df7e1fSJoe Perches # ignore a colon with another 4413e0df7e1fSJoe Perches # colon immediately before or after 4414e0df7e1fSJoe Perches if (($op eq ':') && 4415e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4416e0df7e1fSJoe Perches $ok = 1; 4417e0df7e1fSJoe Perches } 4418e0df7e1fSJoe Perches 441984731623SJoe Perches # messages are ERROR, but ?: are CHK 44201f65f947SAndy Whitcroft if ($ok == 0) { 44210675a8fbSJean Delvare my $msg_level = \&ERROR; 44220675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 442384731623SJoe Perches 44240675a8fbSJean Delvare if (&{$msg_level}("SPACING", 44253705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4426b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4427b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4428b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4429b34c648bSJoe Perches } 44303705ce5bSJoe Perches $line_fixed = 1; 44313705ce5bSJoe Perches } 44320a920b5bSAndy Whitcroft } 443322f2a2efSAndy Whitcroft } 44344a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 44353705ce5bSJoe Perches 44363705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 44373705ce5bSJoe Perches 44383705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 44390a920b5bSAndy Whitcroft } 44403705ce5bSJoe Perches 44413705ce5bSJoe Perches if (($#elements % 2) == 0) { 44423705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 44433705ce5bSJoe Perches } 44443705ce5bSJoe Perches 4445194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4446194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 44473705ce5bSJoe Perches } 44483705ce5bSJoe Perches 44493705ce5bSJoe Perches 44500a920b5bSAndy Whitcroft } 44510a920b5bSAndy Whitcroft 4452786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4453d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4454786b6326SJoe Perches if (WARN("SPACING", 4455786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4456786b6326SJoe Perches $fix) { 4457194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4458786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4459786b6326SJoe Perches } 4460786b6326SJoe Perches } 4461786b6326SJoe Perches 4462f0a594c1SAndy Whitcroft# check for multiple assignments 4463f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4464000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4465000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4466f0a594c1SAndy Whitcroft } 4467f0a594c1SAndy Whitcroft 446822f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 446922f2a2efSAndy Whitcroft## # continuation. 447022f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 447122f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 447222f2a2efSAndy Whitcroft## 447322f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 447422f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 447522f2a2efSAndy Whitcroft## my $ln = $line; 447622f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 447722f2a2efSAndy Whitcroft## } 447822f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4479000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4480000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 448122f2a2efSAndy Whitcroft## } 448222f2a2efSAndy Whitcroft## } 4483f0a594c1SAndy Whitcroft 44840a920b5bSAndy Whitcroft#need space before brace following if, while, etc 44856b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 44864e5d56bdSEddie Kovsky $line =~ /do\{/) { 44873705ce5bSJoe Perches if (ERROR("SPACING", 44883705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 44893705ce5bSJoe Perches $fix) { 44908d81ae05SCyril Bur $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/; 44913705ce5bSJoe Perches } 4492de7d4f0eSAndy Whitcroft } 4493de7d4f0eSAndy Whitcroft 4494c4a62ef9SJoe Perches## # check for blank lines before declarations 4495c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4496c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4497c4a62ef9SJoe Perches## WARN("SPACING", 4498c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4499c4a62ef9SJoe Perches## } 4500c4a62ef9SJoe Perches## 4501c4a62ef9SJoe Perches 4502de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4503de7d4f0eSAndy Whitcroft# on the line 4504de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4505d5e616fcSJoe Perches if (ERROR("SPACING", 4506d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4507d5e616fcSJoe Perches $fix) { 4508194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4509d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4510d5e616fcSJoe Perches } 45110a920b5bSAndy Whitcroft } 45120a920b5bSAndy Whitcroft 451322f2a2efSAndy Whitcroft# check spacing on square brackets 451422f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 45153705ce5bSJoe Perches if (ERROR("SPACING", 45163705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 45173705ce5bSJoe Perches $fix) { 4518194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45193705ce5bSJoe Perches s/\[\s+/\[/; 45203705ce5bSJoe Perches } 452122f2a2efSAndy Whitcroft } 452222f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 45233705ce5bSJoe Perches if (ERROR("SPACING", 45243705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 45253705ce5bSJoe Perches $fix) { 4526194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45273705ce5bSJoe Perches s/\s+\]/\]/; 45283705ce5bSJoe Perches } 452922f2a2efSAndy Whitcroft } 453022f2a2efSAndy Whitcroft 4531c45dcabdSAndy Whitcroft# check spacing on parentheses 45329c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 45339c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 45343705ce5bSJoe Perches if (ERROR("SPACING", 45353705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 45363705ce5bSJoe Perches $fix) { 4537194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45383705ce5bSJoe Perches s/\(\s+/\(/; 45393705ce5bSJoe Perches } 454022f2a2efSAndy Whitcroft } 454113214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4542c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4543c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 45443705ce5bSJoe Perches if (ERROR("SPACING", 45453705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 45463705ce5bSJoe Perches $fix) { 4547194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45483705ce5bSJoe Perches s/\s+\)/\)/; 45493705ce5bSJoe Perches } 455022f2a2efSAndy Whitcroft } 455122f2a2efSAndy Whitcroft 4552e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4553e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4554e2826fd0SJoe Perches 4555e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4556ea4acbb1SJoe Perches my $var = $1; 4557ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4558ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4559ea4acbb1SJoe Perches $fix) { 4560ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4561ea4acbb1SJoe Perches } 4562ea4acbb1SJoe Perches } 4563ea4acbb1SJoe Perches 4564ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4565ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4566ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4567ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4568ea4acbb1SJoe Perches my $var = $2; 4569ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4570ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4571ea4acbb1SJoe Perches $fix) { 4572ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4573ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4574ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4575ea4acbb1SJoe Perches } 4576e2826fd0SJoe Perches } 4577e2826fd0SJoe Perches 457863b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 4579a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 4580a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 4581a032aa4cSJoe Perches $^V && $^V ge 5.10.0 && defined($stat) && 458263b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 458363b7c73eSJoe Perches my $if_stat = $1; 458463b7c73eSJoe Perches my $test = substr($2, 1, -1); 458563b7c73eSJoe Perches my $herectx; 458663b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 458763b7c73eSJoe Perches my $match = $1; 458863b7c73eSJoe Perches # avoid parentheses around potential macro args 458963b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 459063b7c73eSJoe Perches if (!defined($herectx)) { 459163b7c73eSJoe Perches $herectx = $here . "\n"; 459263b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 459363b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 459463b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 459563b7c73eSJoe Perches $herectx .= $rl . "\n"; 459663b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 459763b7c73eSJoe Perches } 459863b7c73eSJoe Perches } 459963b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 460063b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 460163b7c73eSJoe Perches } 460263b7c73eSJoe Perches } 460363b7c73eSJoe Perches 46040a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 46054a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 46060a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 46073705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 46083705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 46093705ce5bSJoe Perches $fix) { 4610194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46113705ce5bSJoe Perches s/^(.)\s+/$1/; 46123705ce5bSJoe Perches } 46130a920b5bSAndy Whitcroft } 46140a920b5bSAndy Whitcroft 46155b9553abSJoe Perches# return is not a function 4616507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4617c45dcabdSAndy Whitcroft my $spacing = $1; 4618507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 46195b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 46205b9553abSJoe Perches my $value = $1; 46215b9553abSJoe Perches $value = deparenthesize($value); 46225b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4623000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4624000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 46255b9553abSJoe Perches } 4626c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4627000d1cc1SJoe Perches ERROR("SPACING", 4628000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4629c45dcabdSAndy Whitcroft } 4630c45dcabdSAndy Whitcroft } 4631507e5141SJoe Perches 4632b43ae21bSJoe Perches# unnecessary return in a void function 4633b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4634b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4635b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4636b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4637b43ae21bSJoe Perches $linenr >= 3 && 4638b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4639b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 46409819cf25SJoe Perches WARN("RETURN_VOID", 4641b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 46429819cf25SJoe Perches } 46439819cf25SJoe Perches 4644189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4645189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4646189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4647189248d8SJoe Perches my $openparens = $1; 4648189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4649189248d8SJoe Perches my $msg = ""; 4650189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4651189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4652189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4653189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4654189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4655189248d8SJoe Perches } 4656189248d8SJoe Perches } 4657189248d8SJoe Perches 4658c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4659c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4660c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4661c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 4662c5595fa2SJoe Perches if ($^V && $^V ge 5.10.0 && 4663c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4664c5595fa2SJoe Perches my $lead = $1; 4665c5595fa2SJoe Perches my $const = $2; 4666c5595fa2SJoe Perches my $comp = $3; 4667c5595fa2SJoe Perches my $to = $4; 4668c5595fa2SJoe Perches my $newcomp = $comp; 4669f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 4670c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4671c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4672c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4673c5595fa2SJoe Perches $fix) { 4674c5595fa2SJoe Perches if ($comp eq "<") { 4675c5595fa2SJoe Perches $newcomp = ">"; 4676c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4677c5595fa2SJoe Perches $newcomp = ">="; 4678c5595fa2SJoe Perches } elsif ($comp eq ">") { 4679c5595fa2SJoe Perches $newcomp = "<"; 4680c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4681c5595fa2SJoe Perches $newcomp = "<="; 4682c5595fa2SJoe Perches } 4683c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4684c5595fa2SJoe Perches } 4685c5595fa2SJoe Perches } 4686c5595fa2SJoe Perches 4687f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4688f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 468953a3c448SAndy Whitcroft my $name = $1; 469053a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4691000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4692f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 469353a3c448SAndy Whitcroft } 469453a3c448SAndy Whitcroft } 4695c45dcabdSAndy Whitcroft 46960a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 46974a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 46983705ce5bSJoe Perches if (ERROR("SPACING", 46993705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 47003705ce5bSJoe Perches $fix) { 4701194f66fcSJoe Perches $fixed[$fixlinenr] =~ 47023705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 47033705ce5bSJoe Perches } 47040a920b5bSAndy Whitcroft } 47050a920b5bSAndy Whitcroft 4706f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4707f5fe35ddSAndy Whitcroft# statements after the conditional. 4708170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 47093e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 47103e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 47113e469cdcSAndy Whitcroft if (!defined $stat); 4712170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4713170d3a22SAndy Whitcroft $remain_next, $off_next); 4714170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4715170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4716170d3a22SAndy Whitcroft 4717170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4718170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4719170d3a22SAndy Whitcroft # then count those as offsets. 4720170d3a22SAndy Whitcroft my ($whitespace) = 4721170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4722170d3a22SAndy Whitcroft my $offset = 4723170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4724170d3a22SAndy Whitcroft 4725170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4726170d3a22SAndy Whitcroft $offset} = 1; 4727170d3a22SAndy Whitcroft } 4728170d3a22SAndy Whitcroft } 4729170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4730c11230f4SJoe Perches defined($stat) && defined($cond) && 4731170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4732171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 47338905a67cSAndy Whitcroft 4734b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4735000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4736000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 47378905a67cSAndy Whitcroft } 47388905a67cSAndy Whitcroft 47398905a67cSAndy Whitcroft # Find out what is on the end of the line after the 47408905a67cSAndy Whitcroft # conditional. 4741773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 47428905a67cSAndy Whitcroft $s =~ s/\n.*//g; 474313214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 474453210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 474553210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4746773647a0SAndy Whitcroft { 4747bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4748bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4749bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 475042bdf74cSHidetoshi Seto my $stat_real = ''; 4751bb44ad39SAndy Whitcroft 475242bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 475342bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4754bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4755bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4756bb44ad39SAndy Whitcroft } 4757bb44ad39SAndy Whitcroft 4758000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4759000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 47608905a67cSAndy Whitcroft } 47618905a67cSAndy Whitcroft } 47628905a67cSAndy Whitcroft 476313214adfSAndy Whitcroft# Check for bitwise tests written as boolean 476413214adfSAndy Whitcroft if ($line =~ / 476513214adfSAndy Whitcroft (?: 476613214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 476713214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 476813214adfSAndy Whitcroft (?:\&\&|\|\|) 476913214adfSAndy Whitcroft | 477013214adfSAndy Whitcroft (?:\&\&|\|\|) 477113214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 477213214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 477313214adfSAndy Whitcroft )/x) 477413214adfSAndy Whitcroft { 4775000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4776000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 477713214adfSAndy Whitcroft } 477813214adfSAndy Whitcroft 47798905a67cSAndy Whitcroft# if and else should not have general statements after it 478013214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 478113214adfSAndy Whitcroft my $s = $1; 478213214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 478313214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4784000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4785000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 47860a920b5bSAndy Whitcroft } 478713214adfSAndy Whitcroft } 478839667782SAndy Whitcroft# if should not continue a brace 478939667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4790000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4791048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 479239667782SAndy Whitcroft $herecurr); 479339667782SAndy Whitcroft } 4794a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4795a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4796a1080bf8SAndy Whitcroft $line !~ /\G(?: 47973fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4798a1080bf8SAndy Whitcroft \s*return\s+ 4799a1080bf8SAndy Whitcroft )/xg) 4800a1080bf8SAndy Whitcroft { 4801000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4802000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4803a1080bf8SAndy Whitcroft } 48040a920b5bSAndy Whitcroft 48050a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 48060a920b5bSAndy Whitcroft # indent level to be relevant to each other. 48078b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 48080a920b5bSAndy Whitcroft $previndent == $indent) { 48098b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 48108b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 48118b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 48128b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48138b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 48148b8856f4SJoe Perches my $fixedline = $prevrawline; 48158b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 48168b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 48178b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48188b8856f4SJoe Perches } 48198b8856f4SJoe Perches $fixedline = $rawline; 48208b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 48218b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48228b8856f4SJoe Perches } 48230a920b5bSAndy Whitcroft } 48240a920b5bSAndy Whitcroft 48258b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4826c2fdda0dSAndy Whitcroft $previndent == $indent) { 4827c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4828c2fdda0dSAndy Whitcroft 4829c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4830c2fdda0dSAndy Whitcroft # conditional. 4831773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4832c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4833c2fdda0dSAndy Whitcroft 4834c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 48358b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 48368b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 48378b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 48388b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48398b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 48408b8856f4SJoe Perches my $fixedline = $prevrawline; 48418b8856f4SJoe Perches my $trailing = $rawline; 48428b8856f4SJoe Perches $trailing =~ s/^\+//; 48438b8856f4SJoe Perches $trailing = trim($trailing); 48448b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 48458b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48468b8856f4SJoe Perches } 4847c2fdda0dSAndy Whitcroft } 4848c2fdda0dSAndy Whitcroft } 4849c2fdda0dSAndy Whitcroft 485095e2c602SJoe Perches#Specific variable tests 4851323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4852323c1260SJoe Perches my $var = $1; 485395e2c602SJoe Perches 485495e2c602SJoe Perches#gcc binary extension 485595e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4856d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4857d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4858d5e616fcSJoe Perches $fix) { 4859d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4860194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4861d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4862d5e616fcSJoe Perches } 486395e2c602SJoe Perches } 486495e2c602SJoe Perches 486595e2c602SJoe Perches#CamelCase 4866807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4867be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 486822735ce8SJoe Perches#Ignore Page<foo> variants 4869807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 487022735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4871f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4872f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4873f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 48747e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 48757e781f67SJoe Perches my $word = $1; 48767e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4877d8b07710SJoe Perches if ($check) { 4878d8b07710SJoe Perches seed_camelcase_includes(); 4879d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4880d8b07710SJoe Perches seed_camelcase_file($realfile); 4881d8b07710SJoe Perches $camelcase_file_seeded = 1; 4882d8b07710SJoe Perches } 4883d8b07710SJoe Perches } 48847e781f67SJoe Perches if (!defined $camelcase{$word}) { 48857e781f67SJoe Perches $camelcase{$word} = 1; 4886be79794bSJoe Perches CHK("CAMELCASE", 48877e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 48887e781f67SJoe Perches } 4889323c1260SJoe Perches } 4890323c1260SJoe Perches } 48913445686aSJoe Perches } 48920a920b5bSAndy Whitcroft 48930a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4894d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4895d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4896d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4897d5e616fcSJoe Perches $fix) { 4898194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4899d5e616fcSJoe Perches } 49000a920b5bSAndy Whitcroft } 49010a920b5bSAndy Whitcroft 49020e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 49030e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4904c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4905e09dec48SAndy Whitcroft my $file = "$1.h"; 4906e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4907e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4908e09dec48SAndy Whitcroft $realfile ne $checkfile && 49097840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4910c45dcabdSAndy Whitcroft { 49110e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 49120e212e0aSFabian Frederick if ($asminclude > 0) { 4913e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4914000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4915000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4916e09dec48SAndy Whitcroft } else { 4917000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4918000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4919e09dec48SAndy Whitcroft } 49200a920b5bSAndy Whitcroft } 49210a920b5bSAndy Whitcroft } 49220e212e0aSFabian Frederick } 49230a920b5bSAndy Whitcroft 4924653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4925653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4926cf655043SAndy Whitcroft# in a known good container 4927b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4928b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4929d8aaf121SAndy Whitcroft my $ln = $linenr; 4930d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4931c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4932c45dcabdSAndy Whitcroft my $ctx = ''; 493308a2843eSJoe Perches my $has_flow_statement = 0; 493408a2843eSJoe Perches my $has_arg_concat = 0; 4935c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4936f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4937f74bd194SAndy Whitcroft $ctx = $dstat; 4938c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4939a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4940c45dcabdSAndy Whitcroft 494108a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 494262e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 494308a2843eSJoe Perches 4944f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 4945f59b64bfSJoe Perches my $define_args = $1; 4946f59b64bfSJoe Perches my $define_stmt = $dstat; 4947f59b64bfSJoe Perches my @def_args = (); 4948f59b64bfSJoe Perches 4949f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 4950f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 4951f59b64bfSJoe Perches $define_args =~ s/\s*//g; 4952f59b64bfSJoe Perches @def_args = split(",", $define_args); 4953f59b64bfSJoe Perches } 4954f59b64bfSJoe Perches 4955292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4956c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4957c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4958c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4959c45dcabdSAndy Whitcroft 4960c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4961bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4962bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 49636b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 4964bf30d6edSAndy Whitcroft { 4965c45dcabdSAndy Whitcroft } 4966c45dcabdSAndy Whitcroft 4967e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 496833acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 496933acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 4970e45bab8eSAndy Whitcroft { 4971e45bab8eSAndy Whitcroft } 4972e45bab8eSAndy Whitcroft 497342e15293SJoe Perches # Make asm volatile uses seem like a generic function 497442e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 497542e15293SJoe Perches 4976c45dcabdSAndy Whitcroft my $exceptions = qr{ 4977c45dcabdSAndy Whitcroft $Declare| 4978c45dcabdSAndy Whitcroft module_param_named| 4979a0a0a7a9SKees Cook MODULE_PARM_DESC| 4980c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4981c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4982383099fdSAndy Whitcroft __typeof__\(| 498322fd2d3eSStefani Seibold union| 498422fd2d3eSStefani Seibold struct| 4985ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 49866b10df42SVladimir Zapolskiy ^\"|\"$| 49876b10df42SVladimir Zapolskiy ^\[ 4988c45dcabdSAndy Whitcroft }x; 49895eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4990f59b64bfSJoe Perches 4991f59b64bfSJoe Perches $ctx =~ s/\n*$//; 4992f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 4993e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 4994f59b64bfSJoe Perches 4995f74bd194SAndy Whitcroft if ($dstat ne '' && 4996f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4997f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 49983cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4999356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5000f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 5001f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5002e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 500372f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 5004f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5005f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5006f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 50074e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5008f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5009c45dcabdSAndy Whitcroft { 5010e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5011e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5012e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5013e795556aSJoe Perches } elsif ($dstat =~ /;/) { 5014f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5015f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5016f74bd194SAndy Whitcroft } else { 5017000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 5018388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5019d8aaf121SAndy Whitcroft } 5020f59b64bfSJoe Perches 5021f59b64bfSJoe Perches } 50225207649bSJoe Perches 50235207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 50245207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 50255207649bSJoe Perches my $first = 1; 50265207649bSJoe Perches $define_stmt = ""; 50275207649bSJoe Perches foreach my $l (@stmt_array) { 50285207649bSJoe Perches $l =~ s/\\$//; 50295207649bSJoe Perches if ($first) { 50305207649bSJoe Perches $define_stmt = $l; 50315207649bSJoe Perches $first = 0; 50325207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 50335207649bSJoe Perches $define_stmt .= substr($l, 1); 50345207649bSJoe Perches } 50355207649bSJoe Perches } 50365207649bSJoe Perches $define_stmt =~ s/$;//g; 50375207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 50385207649bSJoe Perches $define_stmt = trim($define_stmt); 50395207649bSJoe Perches 5040f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5041f59b64bfSJoe Perches foreach my $arg (@def_args) { 5042f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 50439192d41aSJoe Perches next if ($arg =~ /^type$/i); 50447fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 50457fe528a2SJoe Perches $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 50467fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 50477fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 5048d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 5049f59b64bfSJoe Perches if ($use_cnt > 1) { 5050f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5051f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5052f59b64bfSJoe Perches } 50539192d41aSJoe Perches# check if any macro arguments may have other precedence issues 50547fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 50559192d41aSJoe Perches ((defined($1) && $1 ne ',') || 50569192d41aSJoe Perches (defined($2) && $2 ne ','))) { 50579192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 50589192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 50599192d41aSJoe Perches } 50600a920b5bSAndy Whitcroft } 50615023d347SJoe Perches 506208a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 506308a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 506408a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 506508a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 5066e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 506708a2843eSJoe Perches 506808a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 506908a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 507008a2843eSJoe Perches } 507108a2843eSJoe Perches 5072481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 50735023d347SJoe Perches 50745023d347SJoe Perches } else { 50755023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5076481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5077481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 50785023d347SJoe Perches $line =~ /^\+.*\\$/) { 50795023d347SJoe Perches WARN("LINE_CONTINUATIONS", 50805023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 50815023d347SJoe Perches } 5082653d4876SAndy Whitcroft } 50830a920b5bSAndy Whitcroft 5084b13edf7fSJoe Perches# do {} while (0) macro tests: 5085b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5086b13edf7fSJoe Perches# macro should not end with a semicolon 5087b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 5088b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5089b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5090b13edf7fSJoe Perches my $ln = $linenr; 5091b13edf7fSJoe Perches my $cnt = $realcnt; 5092b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5093b13edf7fSJoe Perches my $ctx = ''; 5094b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5095b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5096b13edf7fSJoe Perches $ctx = $dstat; 5097b13edf7fSJoe Perches 5098b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 50991b36b201SJoe Perches $dstat =~ s/$;/ /g; 5100b13edf7fSJoe Perches 5101b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5102b13edf7fSJoe Perches my $stmts = $2; 5103b13edf7fSJoe Perches my $semis = $3; 5104b13edf7fSJoe Perches 5105b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5106b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5107e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5108b13edf7fSJoe Perches 5109ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5110ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5111b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5112b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5113b13edf7fSJoe Perches } 5114b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5115b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5116b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5117b13edf7fSJoe Perches } 5118f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5119f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5120f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5121e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5122f5ef95b1SJoe Perches 5123f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5124f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5125b13edf7fSJoe Perches } 5126b13edf7fSJoe Perches } 5127b13edf7fSJoe Perches 5128f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 512913214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 513013214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5131cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 513213214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5133cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5134cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5135aad4f614SJoe Perches my @allowed = (); 5136aad4f614SJoe Perches my $allow = 0; 513713214adfSAndy Whitcroft my $seen = 0; 5138773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5139cf655043SAndy Whitcroft my $ln = $linenr - 1; 514013214adfSAndy Whitcroft for my $chunk (@chunks) { 514113214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 514213214adfSAndy Whitcroft 5143773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5144773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5145773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 5146773647a0SAndy Whitcroft 5147aad4f614SJoe Perches $allowed[$allow] = 0; 5148773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5149773647a0SAndy Whitcroft 5150773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 5151773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 5152773647a0SAndy Whitcroft 5153773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5154cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 5155cf655043SAndy Whitcroft 5156773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 515713214adfSAndy Whitcroft 515813214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 515913214adfSAndy Whitcroft 5160aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5161cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5162cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5163aad4f614SJoe Perches $allowed[$allow] = 1; 516413214adfSAndy Whitcroft } 516513214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5166cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5167aad4f614SJoe Perches $allowed[$allow] = 1; 516813214adfSAndy Whitcroft } 5169cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5170cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5171aad4f614SJoe Perches $allowed[$allow] = 1; 517213214adfSAndy Whitcroft } 5173aad4f614SJoe Perches $allow++; 517413214adfSAndy Whitcroft } 5175aad4f614SJoe Perches if ($seen) { 5176aad4f614SJoe Perches my $sum_allowed = 0; 5177aad4f614SJoe Perches foreach (@allowed) { 5178aad4f614SJoe Perches $sum_allowed += $_; 5179aad4f614SJoe Perches } 5180aad4f614SJoe Perches if ($sum_allowed == 0) { 5181000d1cc1SJoe Perches WARN("BRACES", 5182000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 5183aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 5184aad4f614SJoe Perches $seen != $allow) { 5185aad4f614SJoe Perches CHK("BRACES", 5186aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 5187aad4f614SJoe Perches } 518813214adfSAndy Whitcroft } 518913214adfSAndy Whitcroft } 519013214adfSAndy Whitcroft } 5191773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 519213214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 5193cf655043SAndy Whitcroft my $allowed = 0; 5194f0a594c1SAndy Whitcroft 5195cf655043SAndy Whitcroft # Check the pre-context. 5196cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 5197cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 5198cf655043SAndy Whitcroft $allowed = 1; 5199f0a594c1SAndy Whitcroft } 5200773647a0SAndy Whitcroft 5201773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 5202773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 5203773647a0SAndy Whitcroft 5204cf655043SAndy Whitcroft # Check the condition. 5205cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 5206773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 5207cf655043SAndy Whitcroft if (defined $cond) { 5208773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5209cf655043SAndy Whitcroft } 5210cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5211cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5212cf655043SAndy Whitcroft $allowed = 1; 5213cf655043SAndy Whitcroft } 5214cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5215cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5216cf655043SAndy Whitcroft $allowed = 1; 5217cf655043SAndy Whitcroft } 5218cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5219cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5220cf655043SAndy Whitcroft $allowed = 1; 5221cf655043SAndy Whitcroft } 5222cf655043SAndy Whitcroft # Check the post-context. 5223cf655043SAndy Whitcroft if (defined $chunks[1]) { 5224cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 5225cf655043SAndy Whitcroft if (defined $cond) { 5226773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5227cf655043SAndy Whitcroft } 5228cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 5229cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5230cf655043SAndy Whitcroft $allowed = 1; 5231cf655043SAndy Whitcroft } 5232cf655043SAndy Whitcroft } 5233cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 5234f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 5235e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5236cf655043SAndy Whitcroft 5237000d1cc1SJoe Perches WARN("BRACES", 5238000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 5239f0a594c1SAndy Whitcroft } 5240f0a594c1SAndy Whitcroft } 5241f0a594c1SAndy Whitcroft 5242e4c5babdSJoe Perches# check for single line unbalanced braces 524395330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 524495330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 5245e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 5246e4c5babdSJoe Perches } 5247e4c5babdSJoe Perches 52480979ae66SJoe Perches# check for unnecessary blank lines around braces 524977b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5250f8e58219SJoe Perches if (CHK("BRACES", 5251f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5252f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 5253f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5254f8e58219SJoe Perches } 52550979ae66SJoe Perches } 525677b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5257f8e58219SJoe Perches if (CHK("BRACES", 5258f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5259f8e58219SJoe Perches $fix) { 5260f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 5261f8e58219SJoe Perches } 52620979ae66SJoe Perches } 52630979ae66SJoe Perches 52644a0df2efSAndy Whitcroft# no volatiles please 52656c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 52666c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5267000d1cc1SJoe Perches WARN("VOLATILE", 52688c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 52694a0df2efSAndy Whitcroft } 52704a0df2efSAndy Whitcroft 52715e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 52725e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 52735e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 52745e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 527533acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 52765e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 52775e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 52785e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 52795e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 52805e4f6ba5SJoe Perches $fix && 52815e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 52825e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 52835e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 52845e4f6ba5SJoe Perches my $comma_close = ""; 52855e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 52865e4f6ba5SJoe Perches $comma_close = $1; 52875e4f6ba5SJoe Perches } 52885e4f6ba5SJoe Perches 52895e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 52905e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 52915e4f6ba5SJoe Perches my $fixedline = $prevrawline; 52925e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 52935e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 52945e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 52955e4f6ba5SJoe Perches $fixedline = $rawline; 52965e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 52975e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 52985e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 52995e4f6ba5SJoe Perches } 53005e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 53015e4f6ba5SJoe Perches } 53025e4f6ba5SJoe Perches } 53035e4f6ba5SJoe Perches 53045e4f6ba5SJoe Perches# check for missing a space in a string concatenation 53055e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 53065e4f6ba5SJoe Perches WARN('MISSING_SPACE', 53075e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 53085e4f6ba5SJoe Perches } 53095e4f6ba5SJoe Perches 531077cb8546SJoe Perches# check for an embedded function name in a string when the function is known 5311e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 5312e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 5313e4b7d309SJoe Perches# function declarations 531477cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 531577cb8546SJoe Perches defined($context_function) && 5316e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 5317e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 531877cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 5319e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 532077cb8546SJoe Perches } 532177cb8546SJoe Perches 53225e4f6ba5SJoe Perches# check for spaces before a quoted newline 53235e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 53245e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 53255e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 53265e4f6ba5SJoe Perches $fix) { 53275e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 53285e4f6ba5SJoe Perches } 53295e4f6ba5SJoe Perches 53305e4f6ba5SJoe Perches } 53315e4f6ba5SJoe Perches 5332f17dba4fSJoe Perches# concatenated string without spaces between elements 533333acb54aSJoe Perches if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) { 5334f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 5335f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 5336f17dba4fSJoe Perches } 5337f17dba4fSJoe Perches 533890ad30e5SJoe Perches# uncoalesced string fragments 533933acb54aSJoe Perches if ($line =~ /$String\s*"/) { 534090ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 534190ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 534290ad30e5SJoe Perches } 534390ad30e5SJoe Perches 5344522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 5345522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 5346522b837cSAlexey Dobriyan my $show_Z = 1; 53475e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 5348522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 53495e4f6ba5SJoe Perches $string =~ s/%%/__/g; 5350522b837cSAlexey Dobriyan # check for %L 5351522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 53525e4f6ba5SJoe Perches WARN("PRINTF_L", 5353522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 5354522b837cSAlexey Dobriyan $show_L = 0; 53555e4f6ba5SJoe Perches } 5356522b837cSAlexey Dobriyan # check for %Z 5357522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 5358522b837cSAlexey Dobriyan WARN("PRINTF_Z", 5359522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 5360522b837cSAlexey Dobriyan $show_Z = 0; 5361522b837cSAlexey Dobriyan } 5362522b837cSAlexey Dobriyan # check for 0x<decimal> 5363522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 5364522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 53656e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 53666e300757SJoe Perches } 53675e4f6ba5SJoe Perches } 53685e4f6ba5SJoe Perches 53695e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 53703f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 53715e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 53725e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 53735e4f6ba5SJoe Perches } 53745e4f6ba5SJoe Perches 537500df344fSAndy Whitcroft# warn about #if 0 5376c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 5377000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 5378000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 5379de7d4f0eSAndy Whitcroft $herecurr); 53804a0df2efSAndy Whitcroft } 53814a0df2efSAndy Whitcroft 538203df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 538303df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5384100425deSJoe Perches my $tested = quotemeta($1); 5385100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5386100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5387100425deSJoe Perches my $func = $1; 5388100425deSJoe Perches if (WARN('NEEDLESS_IF', 5389100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5390100425deSJoe Perches $fix) { 5391100425deSJoe Perches my $do_fix = 1; 5392100425deSJoe Perches my $leading_tabs = ""; 5393100425deSJoe Perches my $new_leading_tabs = ""; 5394100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5395100425deSJoe Perches $leading_tabs = $1; 5396100425deSJoe Perches } else { 5397100425deSJoe Perches $do_fix = 0; 5398100425deSJoe Perches } 5399100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5400100425deSJoe Perches $new_leading_tabs = $1; 5401100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5402100425deSJoe Perches $do_fix = 0; 5403100425deSJoe Perches } 5404100425deSJoe Perches } else { 5405100425deSJoe Perches $do_fix = 0; 5406100425deSJoe Perches } 5407100425deSJoe Perches if ($do_fix) { 5408100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5409100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5410100425deSJoe Perches } 5411100425deSJoe Perches } 54124c432a8fSGreg Kroah-Hartman } 54134c432a8fSGreg Kroah-Hartman } 5414f0a594c1SAndy Whitcroft 5415ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5416ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5417ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5418ebfdc409SJoe Perches (defined $1 || defined $3) && 5419ebfdc409SJoe Perches $linenr > 3) { 5420ebfdc409SJoe Perches my $testval = $2; 5421ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5422ebfdc409SJoe Perches 5423ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5424ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5425ebfdc409SJoe Perches 5426fb0d0e08SJoe 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)/) { 5427ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5428ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5429ebfdc409SJoe Perches } 5430ebfdc409SJoe Perches } 5431ebfdc409SJoe Perches 5432f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5433dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5434f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5435f78d98f6SJoe Perches my $level = $1; 5436f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5437f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5438f78d98f6SJoe Perches $fix) { 5439f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5440f78d98f6SJoe Perches } 5441f78d98f6SJoe Perches } 5442f78d98f6SJoe Perches 544345c55e92SJoe Perches# check for logging continuations 544445c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 544545c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 544645c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 544745c55e92SJoe Perches } 544845c55e92SJoe Perches 5449abb08a53SJoe Perches# check for mask then right shift without a parentheses 5450abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 5451abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5452abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5453abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5454abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5455abb08a53SJoe Perches } 5456abb08a53SJoe Perches 5457b75ac618SJoe Perches# check for pointer comparisons to NULL 5458b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 5459b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5460b75ac618SJoe Perches my $val = $1; 5461b75ac618SJoe Perches my $equal = "!"; 5462b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5463b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5464b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5465b75ac618SJoe Perches $fix) { 5466b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5467b75ac618SJoe Perches } 5468b75ac618SJoe Perches } 5469b75ac618SJoe Perches } 5470b75ac618SJoe Perches 54718716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 54728716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 54738716de38SJoe Perches my $attr = $1; 54748716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 54758716de38SJoe Perches my $ptr = $1; 54768716de38SJoe Perches my $var = $2; 54778716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 54788716de38SJoe Perches ERROR("MISPLACED_INIT", 54798716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 54808716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 54818716de38SJoe Perches WARN("MISPLACED_INIT", 54828716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 54838716de38SJoe Perches $fix) { 5484194f66fcSJoe 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; 54858716de38SJoe Perches } 54868716de38SJoe Perches } 54878716de38SJoe Perches } 54888716de38SJoe Perches 5489e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5490e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5491e970b884SJoe Perches my $attr = $1; 5492e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5493e970b884SJoe Perches my $attr_prefix = $1; 5494e970b884SJoe Perches my $attr_type = $2; 5495e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5496e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5497e970b884SJoe Perches $fix) { 5498194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5499e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5500e970b884SJoe Perches } 5501e970b884SJoe Perches } 5502e970b884SJoe Perches 5503e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5504e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5505e970b884SJoe Perches my $attr = $1; 5506e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5507e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5508e970b884SJoe Perches $fix) { 5509194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5510e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5511e970b884SJoe Perches $lead = rtrim($1); 5512e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5513e970b884SJoe Perches $lead = "${lead}const "; 5514194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5515e970b884SJoe Perches } 5516e970b884SJoe Perches } 5517e970b884SJoe Perches 5518c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5519c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5520c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5521c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5522c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5523c17893c7SJoe Perches $fix) { 5524c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5525c17893c7SJoe Perches } 5526c17893c7SJoe Perches } 5527c17893c7SJoe Perches 5528fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5529fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5530fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5531fbdb8138SJoe Perches my $constant_func = $1; 5532fbdb8138SJoe Perches my $func = $constant_func; 5533fbdb8138SJoe Perches $func =~ s/^__constant_//; 5534fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5535fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5536fbdb8138SJoe Perches $fix) { 5537194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5538fbdb8138SJoe Perches } 5539fbdb8138SJoe Perches } 5540fbdb8138SJoe Perches 55411a15a250SPatrick Pannuto# prefer usleep_range over udelay 554237581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 554343c1d77cSJoe Perches my $delay = $1; 55441a15a250SPatrick Pannuto # ignore udelay's < 10, however 554543c1d77cSJoe Perches if (! ($delay < 10) ) { 5546000d1cc1SJoe Perches CHK("USLEEP_RANGE", 554743c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 554843c1d77cSJoe Perches } 554943c1d77cSJoe Perches if ($delay > 2000) { 555043c1d77cSJoe Perches WARN("LONG_UDELAY", 555143c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 55521a15a250SPatrick Pannuto } 55531a15a250SPatrick Pannuto } 55541a15a250SPatrick Pannuto 555509ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 555609ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 555709ef8725SPatrick Pannuto if ($1 < 20) { 5558000d1cc1SJoe Perches WARN("MSLEEP", 555943c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 556009ef8725SPatrick Pannuto } 556109ef8725SPatrick Pannuto } 556209ef8725SPatrick Pannuto 556336ec1939SJoe Perches# check for comparisons of jiffies 556436ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 556536ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 556636ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 556736ec1939SJoe Perches } 556836ec1939SJoe Perches 55699d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 55709d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 55719d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 55729d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 55739d7a34a5SJoe Perches } 55749d7a34a5SJoe Perches 557500df344fSAndy Whitcroft# warn about #ifdefs in C files 5576c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 557700df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 557800df344fSAndy Whitcroft# print "$herecurr"; 557900df344fSAndy Whitcroft# $clean = 0; 558000df344fSAndy Whitcroft# } 558100df344fSAndy Whitcroft 558222f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5583c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 55843705ce5bSJoe Perches if (ERROR("SPACING", 55853705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 55863705ce5bSJoe Perches $fix) { 5587194f66fcSJoe Perches $fixed[$fixlinenr] =~ 55883705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 55893705ce5bSJoe Perches } 55903705ce5bSJoe Perches 559122f2a2efSAndy Whitcroft } 559222f2a2efSAndy Whitcroft 55934a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5594171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5595171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 55964a0df2efSAndy Whitcroft my $which = $1; 55974a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5598000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5599000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 56004a0df2efSAndy Whitcroft } 56014a0df2efSAndy Whitcroft } 56024a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5603402c2553SMichael S. Tsirkin 5604402c2553SMichael S. Tsirkin my $barriers = qr{ 5605402c2553SMichael S. Tsirkin mb| 5606402c2553SMichael S. Tsirkin rmb| 5607402c2553SMichael S. Tsirkin wmb| 5608402c2553SMichael S. Tsirkin read_barrier_depends 5609402c2553SMichael S. Tsirkin }x; 5610402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5611402c2553SMichael S. Tsirkin mb__before_atomic| 5612402c2553SMichael S. Tsirkin mb__after_atomic| 5613402c2553SMichael S. Tsirkin store_release| 5614402c2553SMichael S. Tsirkin load_acquire| 5615402c2553SMichael S. Tsirkin store_mb| 5616402c2553SMichael S. Tsirkin (?:$barriers) 5617402c2553SMichael S. Tsirkin }x; 5618402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5619402c2553SMichael S. Tsirkin (?:$barriers)| 562043e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 562143e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5622402c2553SMichael S. Tsirkin }x; 5623402c2553SMichael S. Tsirkin 5624402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 56254a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5626c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5627000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 56284a0df2efSAndy Whitcroft } 56294a0df2efSAndy Whitcroft } 56303ad81779SPaul E. McKenney 5631f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5632f4073b0fSMichael S. Tsirkin 5633f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5634f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5635f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5636f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5637f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5638f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5639f4073b0fSMichael S. Tsirkin } 5640f4073b0fSMichael S. Tsirkin 5641cb426e99SJoe Perches# check for waitqueue_active without a comment. 5642cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5643cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5644cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5645cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5646cb426e99SJoe Perches } 5647cb426e99SJoe Perches } 56483ad81779SPaul E. McKenney 564991db2592SPaul E. McKenney# check for smp_read_barrier_depends and read_barrier_depends 565091db2592SPaul E. McKenney if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) { 565191db2592SPaul E. McKenney WARN("READ_BARRIER_DEPENDS", 565291db2592SPaul E. McKenney "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr); 565391db2592SPaul E. McKenney } 565491db2592SPaul E. McKenney 56554a0df2efSAndy Whitcroft# check of hardware specific defines 5656c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5657000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5658000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 56590a920b5bSAndy Whitcroft } 5660653d4876SAndy Whitcroft 5661596ed45bSJoe Perches# check that the storage class is not after a type 5662596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 5663000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5664596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 5665596ed45bSJoe Perches } 5666596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 5667596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 5668596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 5669596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 5670596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 5671596ed45bSJoe Perches WARN("STORAGE_CLASS", 5672596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 5673d4977c78STobias Klauser } 5674d4977c78STobias Klauser 5675de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5676de7d4f0eSAndy Whitcroft# storage class and type. 56779c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 56789c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5679000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5680000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5681de7d4f0eSAndy Whitcroft } 5682de7d4f0eSAndy Whitcroft 56838905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 56842b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 56852b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5686d5e616fcSJoe Perches if (WARN("INLINE", 5687d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5688d5e616fcSJoe Perches $fix) { 5689194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5690d5e616fcSJoe Perches 5691d5e616fcSJoe Perches } 56928905a67cSAndy Whitcroft } 56938905a67cSAndy Whitcroft 56943d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 56952b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 56962b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5697000d1cc1SJoe Perches WARN("PREFER_PACKED", 5698000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 56993d130fd0SJoe Perches } 57003d130fd0SJoe Perches 570139b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 57022b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57032b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5704000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5705000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 570639b7e287SJoe Perches } 570739b7e287SJoe Perches 57085f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 57092b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57102b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5711d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5712d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5713d5e616fcSJoe Perches $fix) { 5714194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5715d5e616fcSJoe Perches 5716d5e616fcSJoe Perches } 57175f14d3bdSJoe Perches } 57185f14d3bdSJoe Perches 57196061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 57202b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57212b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5722d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5723d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5724d5e616fcSJoe Perches $fix) { 5725194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5726d5e616fcSJoe Perches } 57276061d949SJoe Perches } 57286061d949SJoe Perches 5729619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 5730619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 5731619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5732619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5733619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5734619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5735619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5736619a908aSJoe Perches } 5737619a908aSJoe Perches 5738fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 5739e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5740fd39f904STomas Winkler $realfile !~ m@\btools/@ && 5741e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5742e6176fa4SJoe Perches my $type = $1; 5743e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5744e6176fa4SJoe Perches $type = $1; 5745e6176fa4SJoe Perches my $kernel_type = 'u'; 5746e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5747e6176fa4SJoe Perches $type =~ /(\d+)/; 5748e6176fa4SJoe Perches $kernel_type .= $1; 5749e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5750e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5751e6176fa4SJoe Perches $fix) { 5752e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5753e6176fa4SJoe Perches } 5754e6176fa4SJoe Perches } 5755e6176fa4SJoe Perches } 5756e6176fa4SJoe Perches 5757938224b5SJoe Perches# check for cast of C90 native int or longer types constants 5758938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 5759938224b5SJoe Perches my $cast = $1; 5760938224b5SJoe Perches my $const = $2; 5761938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 5762938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 5763938224b5SJoe Perches $fix) { 5764938224b5SJoe Perches my $suffix = ""; 5765938224b5SJoe Perches my $newconst = $const; 5766938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 5767938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 5768938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 5769938224b5SJoe Perches $suffix .= 'LL'; 5770938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 5771938224b5SJoe Perches $suffix .= 'L'; 5772938224b5SJoe Perches } 5773938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 5774938224b5SJoe Perches } 5775938224b5SJoe Perches } 5776938224b5SJoe Perches 57778f53a9b8SJoe Perches# check for sizeof(&) 57788f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5779000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5780000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 57818f53a9b8SJoe Perches } 57828f53a9b8SJoe Perches 578366c80b60SJoe Perches# check for sizeof without parenthesis 578466c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5785d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5786d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5787d5e616fcSJoe Perches $fix) { 5788194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5789d5e616fcSJoe Perches } 579066c80b60SJoe Perches } 579166c80b60SJoe Perches 579288982feaSJoe Perches# check for struct spinlock declarations 579388982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 579488982feaSJoe Perches WARN("USE_SPINLOCK_T", 579588982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 579688982feaSJoe Perches } 579788982feaSJoe Perches 5798a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 579906668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5800a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5801caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5802caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5803d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5804d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5805d5e616fcSJoe Perches $fix) { 5806194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5807d5e616fcSJoe Perches } 5808a6962d72SJoe Perches } 5809a6962d72SJoe Perches } 5810a6962d72SJoe Perches 58110b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 58120b523769SJoe Perches if ($^V && $^V ge 5.10.0 && 58130b523769SJoe Perches defined $stat && 58140b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 58150b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 5816e3c6bc95STobin C. Harding my $stat_real; 5817e3c6bc95STobin C. Harding 58180b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 58190b523769SJoe Perches $lc = $lc + $linenr; 58200b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 5821ffe07513SJoe Perches my $specifier; 5822ffe07513SJoe Perches my $extension; 5823ffe07513SJoe Perches my $bad_specifier = ""; 58240b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 58250b523769SJoe Perches $fmt =~ s/%%//g; 5826e3c6bc95STobin C. Harding 5827e3c6bc95STobin C. Harding while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) { 5828e3c6bc95STobin C. Harding $specifier = $1; 5829e3c6bc95STobin C. Harding $extension = $2; 5830e3c6bc95STobin C. Harding if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOx]/) { 5831e3c6bc95STobin C. Harding $bad_specifier = $specifier; 58320b523769SJoe Perches last; 58330b523769SJoe Perches } 5834e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 5835e3c6bc95STobin C. Harding if (!defined($stat_real)) { 5836e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 58370b523769SJoe Perches } 5838e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 5839e3c6bc95STobin 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"); 5840e3c6bc95STobin C. Harding } 5841e3c6bc95STobin C. Harding } 5842e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 58432a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 58441df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 58451df7338aSSergey Senozhatsky my $use = ""; 5846e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 58471df7338aSSergey Senozhatsky $ext_type = "Deprecated"; 58481df7338aSSergey Senozhatsky $use = " - use %pS instead"; 5849e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 58501df7338aSSergey Senozhatsky } 58512a9f9d85STobin C. Harding 58520b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 5853e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 5854e3c6bc95STobin C. Harding } 58550b523769SJoe Perches } 58560b523769SJoe Perches } 58570b523769SJoe Perches 5858554e165cSAndy Whitcroft# Check for misused memsets 5859d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5860d1fe9c09SJoe Perches defined $stat && 58619e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5862554e165cSAndy Whitcroft 5863d7c76ba7SJoe Perches my $ms_addr = $2; 5864d1fe9c09SJoe Perches my $ms_val = $7; 5865d1fe9c09SJoe Perches my $ms_size = $12; 5866d7c76ba7SJoe Perches 5867554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5868554e165cSAndy Whitcroft ERROR("MEMSET", 5869d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5870554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5871554e165cSAndy Whitcroft WARN("MEMSET", 5872d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5873d7c76ba7SJoe Perches } 5874d7c76ba7SJoe Perches } 5875d7c76ba7SJoe Perches 587698a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 5877f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5878f333195dSJoe Perches# defined $stat && 5879f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5880f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 5881f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 5882f333195dSJoe Perches# $fix) { 5883f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 5884f333195dSJoe Perches# } 5885f333195dSJoe Perches# } 588698a9bba5SJoe Perches 5887b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 5888f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5889f333195dSJoe Perches# defined $stat && 5890f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5891f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 5892f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5893f333195dSJoe Perches# } 5894b6117d17SMateusz Kulikowski 58958617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 58968617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 5897f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5898f333195dSJoe Perches# defined $stat && 5899f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5900f333195dSJoe Perches# 5901f333195dSJoe Perches# my $ms_val = $7; 5902f333195dSJoe Perches# 5903f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 5904f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 5905f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 5906f333195dSJoe Perches# $fix) { 5907f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 5908f333195dSJoe Perches# } 5909f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 5910f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 5911f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 5912f333195dSJoe Perches# $fix) { 5913f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 5914f333195dSJoe Perches# } 5915f333195dSJoe Perches# } 5916f333195dSJoe Perches# } 59178617cd09SMateusz Kulikowski 5918d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5919d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5920d1fe9c09SJoe Perches defined $stat && 5921d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5922d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5923d7c76ba7SJoe Perches my $call = $1; 5924d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5925d7c76ba7SJoe Perches my $arg1 = $3; 5926d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5927d1fe9c09SJoe Perches my $arg2 = $8; 5928d7c76ba7SJoe Perches my $cast; 5929d7c76ba7SJoe Perches 5930d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5931d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5932d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5933d7c76ba7SJoe Perches $cast = $cast1; 5934d7c76ba7SJoe Perches } else { 5935d7c76ba7SJoe Perches $cast = $cast2; 5936d7c76ba7SJoe Perches } 5937d7c76ba7SJoe Perches WARN("MINMAX", 5938d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5939554e165cSAndy Whitcroft } 5940554e165cSAndy Whitcroft } 5941554e165cSAndy Whitcroft 59424a273195SJoe Perches# check usleep_range arguments 59434a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 59444a273195SJoe Perches defined $stat && 59454a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 59464a273195SJoe Perches my $min = $1; 59474a273195SJoe Perches my $max = $7; 59484a273195SJoe Perches if ($min eq $max) { 59494a273195SJoe Perches WARN("USLEEP_RANGE", 59504a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 59514a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 59524a273195SJoe Perches $min > $max) { 59534a273195SJoe Perches WARN("USLEEP_RANGE", 59544a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 59554a273195SJoe Perches } 59564a273195SJoe Perches } 59574a273195SJoe Perches 5958823b794cSJoe Perches# check for naked sscanf 5959823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5960823b794cSJoe Perches defined $stat && 59616c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5962823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5963823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5964823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5965823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5966823b794cSJoe Perches $lc = $lc + $linenr; 59672a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 5968823b794cSJoe Perches WARN("NAKED_SSCANF", 5969823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5970823b794cSJoe Perches } 5971823b794cSJoe Perches 5972afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5973afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5974afc819abSJoe Perches defined $stat && 5975afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5976afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5977afc819abSJoe Perches $lc = $lc + $linenr; 59782a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 5979afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5980afc819abSJoe Perches my $format = $6; 5981afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5982afc819abSJoe Perches if ($count == 1 && 5983afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5984afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5985afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5986afc819abSJoe Perches } 5987afc819abSJoe Perches } 5988afc819abSJoe Perches } 5989afc819abSJoe Perches 599070dc8a48SJoe Perches# check for new externs in .h files. 599170dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 599270dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5993d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 599470dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 599570dc8a48SJoe Perches $fix) { 5996194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 599770dc8a48SJoe Perches } 599870dc8a48SJoe Perches } 599970dc8a48SJoe Perches 6000de7d4f0eSAndy Whitcroft# check for new externs in .c files. 6001171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 6002c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 6003171ae1a4SAndy Whitcroft { 6004c45dcabdSAndy Whitcroft my $function_name = $1; 6005c45dcabdSAndy Whitcroft my $paren_space = $2; 6006171ae1a4SAndy Whitcroft 6007171ae1a4SAndy Whitcroft my $s = $stat; 6008171ae1a4SAndy Whitcroft if (defined $cond) { 6009171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 6010171ae1a4SAndy Whitcroft } 6011c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 6012c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 6013c45dcabdSAndy Whitcroft { 6014000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6015000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6016de7d4f0eSAndy Whitcroft } 6017de7d4f0eSAndy Whitcroft 6018171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 6019000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 6020000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 6021171ae1a4SAndy Whitcroft } 60229c9ba34eSAndy Whitcroft 60239c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 60249c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 60259c9ba34eSAndy Whitcroft { 6026000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6027000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6028171ae1a4SAndy Whitcroft } 6029171ae1a4SAndy Whitcroft 6030a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 6031a0ad7596SJoe Perches if (defined $stat && 603225bdda2bSMiles Chen $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 6033ca0d8929SJoe Perches $1 ne "void") { 6034ca0d8929SJoe Perches my $args = trim($1); 6035ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6036ca0d8929SJoe Perches my $arg = trim($1); 6037ca0d8929SJoe Perches if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 6038ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 6039ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6040ca0d8929SJoe Perches } 6041ca0d8929SJoe Perches } 6042ca0d8929SJoe Perches } 6043ca0d8929SJoe Perches 6044a0ad7596SJoe Perches# check for function definitions 6045a0ad7596SJoe Perches if ($^V && $^V ge 5.10.0 && 6046a0ad7596SJoe Perches defined $stat && 6047a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6048a0ad7596SJoe Perches $context_function = $1; 6049a0ad7596SJoe Perches 6050a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 6051a0ad7596SJoe Perches my $ok = 0; 6052a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 6053a0ad7596SJoe Perches my $herectx = $here . "\n"; 6054a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6055a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 6056a0ad7596SJoe Perches $herectx .= $rl . "\n"; 6057a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 6058a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 6059a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 6060a0ad7596SJoe Perches } 6061a0ad7596SJoe Perches if (!$ok) { 6062a0ad7596SJoe Perches ERROR("OPEN_BRACE", 6063a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 6064a0ad7596SJoe Perches } 6065a0ad7596SJoe Perches } 6066a0ad7596SJoe Perches 6067de7d4f0eSAndy Whitcroft# checks for new __setup's 6068de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 6069de7d4f0eSAndy Whitcroft my $name = $1; 6070de7d4f0eSAndy Whitcroft 6071de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 6072000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 60738c27ceffSMauro Carvalho Chehab "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr); 6074de7d4f0eSAndy Whitcroft } 6075653d4876SAndy Whitcroft } 60769c0ca6f9SAndy Whitcroft 60779c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 6078caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 6079000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 6080000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 60819c0ca6f9SAndy Whitcroft } 608213214adfSAndy Whitcroft 6083a640d25cSJoe Perches# alloc style 6084a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 6085a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 6086a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 6087a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 6088a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 6089a640d25cSJoe Perches } 6090a640d25cSJoe Perches 609160a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 609260a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 60931b4a2ed4SJoe Perches defined $stat && 60941b4a2ed4SJoe Perches $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 609560a55369SJoe Perches my $oldfunc = $3; 609660a55369SJoe Perches my $a1 = $4; 609760a55369SJoe Perches my $a2 = $10; 609860a55369SJoe Perches my $newfunc = "kmalloc_array"; 609960a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 610060a55369SJoe Perches my $r1 = $a1; 610160a55369SJoe Perches my $r2 = $a2; 610260a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 610360a55369SJoe Perches $r1 = $a2; 610460a55369SJoe Perches $r2 = $a1; 610560a55369SJoe Perches } 6106e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 6107e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 61081b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 6109e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6110e3d95a2aSTobin C. Harding 6111e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 61121b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 61131b4a2ed4SJoe Perches $cnt == 1 && 6114e367455aSJoe Perches $fix) { 6115194f66fcSJoe 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; 611660a55369SJoe Perches } 611760a55369SJoe Perches } 611860a55369SJoe Perches } 611960a55369SJoe Perches 6120972fdea2SJoe Perches# check for krealloc arg reuse 6121972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 6122972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 6123972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 6124972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 6125972fdea2SJoe Perches } 6126972fdea2SJoe Perches 61275ce59ae0SJoe Perches# check for alloc argument mismatch 61285ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 61295ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 61305ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 61315ce59ae0SJoe Perches } 61325ce59ae0SJoe Perches 6133caf2a54fSJoe Perches# check for multiple semicolons 6134caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 6135d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 6136d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 6137d5e616fcSJoe Perches $fix) { 6138194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 6139d5e616fcSJoe Perches } 6140d1e2ad07SJoe Perches } 6141d1e2ad07SJoe Perches 6142cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 6143cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 6144cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 61450ab90191SJoe Perches my $ull = ""; 61460ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 61470ab90191SJoe Perches if (CHK("BIT_MACRO", 61480ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 61490ab90191SJoe Perches $fix) { 61500ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 61510ab90191SJoe Perches } 61520ab90191SJoe Perches } 61530ab90191SJoe Perches 61542d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 61552d632745SJoe 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*$/) { 61562d632745SJoe Perches my $config = $1; 61572d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 61582d632745SJoe Perches "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) && 61592d632745SJoe Perches $fix) { 61602d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 61612d632745SJoe Perches } 61622d632745SJoe Perches } 61632d632745SJoe Perches 6164e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 6165c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 6166c34c09a8SJoe Perches my $has_break = 0; 6167c34c09a8SJoe Perches my $has_statement = 0; 6168c34c09a8SJoe Perches my $count = 0; 6169c34c09a8SJoe Perches my $prevline = $linenr; 6170e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 6171c34c09a8SJoe Perches $prevline--; 6172c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 6173c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 6174c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 6175c34c09a8SJoe Perches next if ($fline =~ /^\-/); 6176c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 6177c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 6178c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 6179c34c09a8SJoe Perches $has_statement = 1; 6180c34c09a8SJoe Perches $count++; 6181258f79d5SHeinrich Schuchardt $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/); 6182c34c09a8SJoe Perches } 6183c34c09a8SJoe Perches if (!$has_break && $has_statement) { 6184c34c09a8SJoe Perches WARN("MISSING_BREAK", 6185224236d9SAndrew Morton "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr); 6186c34c09a8SJoe Perches } 6187c34c09a8SJoe Perches } 6188c34c09a8SJoe Perches 6189d1e2ad07SJoe Perches# check for switch/default statements without a break; 6190d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 6191d1e2ad07SJoe Perches defined $stat && 6192d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 6193d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 6194e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6195e3d95a2aSTobin C. Harding 6196d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 6197d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 6198caf2a54fSJoe Perches } 6199caf2a54fSJoe Perches 620013214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 6201d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 6202d5e616fcSJoe Perches if (WARN("USE_FUNC", 6203d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 6204d5e616fcSJoe Perches $fix) { 6205194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 6206d5e616fcSJoe Perches } 620713214adfSAndy Whitcroft } 6208773647a0SAndy Whitcroft 620962ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 621062ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 621162ec818fSJoe Perches ERROR("DATE_TIME", 621262ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 621362ec818fSJoe Perches } 621462ec818fSJoe Perches 62152c92488aSJoe Perches# check for use of yield() 62162c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 62172c92488aSJoe Perches WARN("YIELD", 62182c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 62192c92488aSJoe Perches } 62202c92488aSJoe Perches 6221179f8f40SJoe Perches# check for comparisons against true and false 6222179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 6223179f8f40SJoe Perches my $lead = $1; 6224179f8f40SJoe Perches my $arg = $2; 6225179f8f40SJoe Perches my $test = $3; 6226179f8f40SJoe Perches my $otype = $4; 6227179f8f40SJoe Perches my $trail = $5; 6228179f8f40SJoe Perches my $op = "!"; 6229179f8f40SJoe Perches 6230179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 6231179f8f40SJoe Perches 6232179f8f40SJoe Perches my $type = lc($otype); 6233179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 6234179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 6235179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 6236179f8f40SJoe Perches $op = ""; 6237179f8f40SJoe Perches } 6238179f8f40SJoe Perches 6239179f8f40SJoe Perches CHK("BOOL_COMPARISON", 6240179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 6241179f8f40SJoe Perches 6242179f8f40SJoe Perches## maybe suggesting a correct construct would better 6243179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 6244179f8f40SJoe Perches 6245179f8f40SJoe Perches } 6246179f8f40SJoe Perches } 6247179f8f40SJoe Perches 62485d430902SJoe Perches# check for bool bitfields 62495d430902SJoe Perches if ($sline =~ /^.\s+bool\s*$Ident\s*:\s*\d+\s*;/) { 62505d430902SJoe Perches WARN("BOOL_BITFIELD", 62515d430902SJoe Perches "Avoid using bool as bitfield. Prefer bool bitfields as unsigned int or u<8|16|32>\n" . $herecurr); 62525d430902SJoe Perches } 62535d430902SJoe Perches 6254*d729593eSJoe Perches# check for bool use in .h files 6255*d729593eSJoe Perches if ($realfile =~ /\.h$/ && 6256*d729593eSJoe Perches $sline =~ /^.\s+bool\s*$Ident\s*(?::\s*d+\s*)?;/) { 6257*d729593eSJoe Perches CHK("BOOL_MEMBER", 6258*d729593eSJoe Perches "Avoid using bool structure members because of possible alignment issues - see: https://lkml.org/lkml/2017/11/21/384\n" . $herecurr); 6259*d729593eSJoe Perches } 6260*d729593eSJoe Perches 62614882720bSThomas Gleixner# check for semaphores initialized locked 62624882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 6263000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 6264000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 6265773647a0SAndy Whitcroft } 62666712d858SJoe Perches 626767d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 626867d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 6269000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 627067d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 6271773647a0SAndy Whitcroft } 62726712d858SJoe Perches 6273ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 6274f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 6275000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 6276ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 6277f3db6639SMichael Ellerman } 62786712d858SJoe Perches 62790f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 6280d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 62816903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 6282d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 6283000d1cc1SJoe Perches WARN("CONST_STRUCT", 6284d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 62852b6db5cbSAndy Whitcroft } 6286773647a0SAndy Whitcroft 6287773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 6288773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 6289773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 6290c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 6291c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 6292171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 6293171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 6294171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 6295773647a0SAndy Whitcroft { 6296000d1cc1SJoe Perches WARN("NR_CPUS", 6297000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 6298773647a0SAndy Whitcroft } 62999c9ba34eSAndy Whitcroft 630052ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 630152ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 630252ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 630352ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 630452ea8506SJoe Perches } 630552ea8506SJoe Perches 6306acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 6307acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 6308acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 6309acd9362cSJoe Perches WARN("LIKELY_MISUSE", 6310acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 6311acd9362cSJoe Perches } 6312acd9362cSJoe Perches 6313691d77b6SAndy Whitcroft# whine mightly about in_atomic 6314691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 6315691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 6316000d1cc1SJoe Perches ERROR("IN_ATOMIC", 6317000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 6318f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 6319000d1cc1SJoe Perches WARN("IN_ATOMIC", 6320000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 6321691d77b6SAndy Whitcroft } 6322691d77b6SAndy Whitcroft } 63231704f47bSPeter Zijlstra 63240f5225b0SPeter Zijlstra# check for mutex_trylock_recursive usage 63250f5225b0SPeter Zijlstra if ($line =~ /mutex_trylock_recursive/) { 63260f5225b0SPeter Zijlstra ERROR("LOCKING", 63270f5225b0SPeter Zijlstra "recursive locking is bad, do not use this ever.\n" . $herecurr); 63280f5225b0SPeter Zijlstra } 63290f5225b0SPeter Zijlstra 63301704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 63311704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 63321704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 63331704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 63341704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 63351704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 6336000d1cc1SJoe Perches ERROR("LOCKDEP", 6337000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 63381704f47bSPeter Zijlstra } 63391704f47bSPeter Zijlstra } 634088f8831cSDave Jones 6341b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 6342b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 6343000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 6344000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 634588f8831cSDave Jones } 63462435880fSJoe Perches 634700180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 634800180468SJoe Perches# and whether or not function naming is typical and if 634900180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 635000180468SJoe Perches if ($^V && $^V ge 5.10.0 && 635100180468SJoe Perches defined $stat && 635200180468SJoe 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*\)/) { 635300180468SJoe Perches my $var = $1; 635400180468SJoe Perches my $perms = $2; 635500180468SJoe Perches my $show = $3; 635600180468SJoe Perches my $store = $4; 635700180468SJoe Perches my $octal_perms = perms_to_octal($perms); 635800180468SJoe Perches if ($show =~ /^${var}_show$/ && 635900180468SJoe Perches $store =~ /^${var}_store$/ && 636000180468SJoe Perches $octal_perms eq "0644") { 636100180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 636200180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 636300180468SJoe Perches $fix) { 636400180468SJoe 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})/; 636500180468SJoe Perches } 636600180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 636700180468SJoe Perches $store =~ /^NULL$/ && 636800180468SJoe Perches $octal_perms eq "0444") { 636900180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 637000180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 637100180468SJoe Perches $fix) { 637200180468SJoe 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})/; 637300180468SJoe Perches } 637400180468SJoe Perches } elsif ($show =~ /^NULL$/ && 637500180468SJoe Perches $store =~ /^${var}_store$/ && 637600180468SJoe Perches $octal_perms eq "0200") { 637700180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 637800180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 637900180468SJoe Perches $fix) { 638000180468SJoe 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})/; 638100180468SJoe Perches } 638200180468SJoe Perches } elsif ($octal_perms eq "0644" || 638300180468SJoe Perches $octal_perms eq "0444" || 638400180468SJoe Perches $octal_perms eq "0200") { 638500180468SJoe Perches my $newshow = "$show"; 638600180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 638700180468SJoe Perches my $newstore = $store; 638800180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 638900180468SJoe Perches my $rename = ""; 639000180468SJoe Perches if ($show ne $newshow) { 639100180468SJoe Perches $rename .= " '$show' to '$newshow'"; 639200180468SJoe Perches } 639300180468SJoe Perches if ($store ne $newstore) { 639400180468SJoe Perches $rename .= " '$store' to '$newstore'"; 639500180468SJoe Perches } 639600180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 639700180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 639800180468SJoe Perches } else { 639900180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 640000180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 640100180468SJoe Perches } 640200180468SJoe Perches } 640300180468SJoe Perches 6404515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 6405515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 640673121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 640773121534SJoe Perches# specific definition of not visible in sysfs. 640873121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 640973121534SJoe Perches# use the default permissions 6410515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 6411459cf0aeSJoe Perches defined $stat && 6412515a235eSJoe Perches $line =~ /$mode_perms_search/) { 64132435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 64142435880fSJoe Perches my $func = $entry->[0]; 64152435880fSJoe Perches my $arg_pos = $entry->[1]; 64162435880fSJoe Perches 6417459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 6418459cf0aeSJoe Perches $lc = $lc + $linenr; 64192a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6420459cf0aeSJoe Perches 64212435880fSJoe Perches my $skip_args = ""; 64222435880fSJoe Perches if ($arg_pos > 1) { 64232435880fSJoe Perches $arg_pos--; 64242435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 64252435880fSJoe Perches } 6426f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 6427459cf0aeSJoe Perches if ($stat =~ /$test/) { 64282435880fSJoe Perches my $val = $1; 64292435880fSJoe Perches $val = $6 if ($skip_args ne ""); 643073121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 643173121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 643273121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 64332435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 6434459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 6435f90774e1SJoe Perches } 6436f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6437c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6438459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 64392435880fSJoe Perches } 6440459cf0aeSJoe Perches } 6441459cf0aeSJoe Perches } 6442459cf0aeSJoe Perches } 6443459cf0aeSJoe Perches 6444459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 6445bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 644600180468SJoe Perches my $oval = $1; 644700180468SJoe Perches my $octal = perms_to_octal($oval); 6448f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 6449459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 6450f90774e1SJoe Perches $fix) { 645100180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 64522435880fSJoe Perches } 645313214adfSAndy Whitcroft } 64545a6d20ceSBjorn Andersson 64555a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 64565a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 64575a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 64585a6d20ceSBjorn Andersson my $valid_licenses = qr{ 64595a6d20ceSBjorn Andersson GPL| 64605a6d20ceSBjorn Andersson GPL\ v2| 64615a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 64625a6d20ceSBjorn Andersson Dual\ BSD/GPL| 64635a6d20ceSBjorn Andersson Dual\ MIT/GPL| 64645a6d20ceSBjorn Andersson Dual\ MPL/GPL| 64655a6d20ceSBjorn Andersson Proprietary 64665a6d20ceSBjorn Andersson }x; 64675a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 64685a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 64695a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 64705a6d20ceSBjorn Andersson } 64715a6d20ceSBjorn Andersson } 6472515a235eSJoe Perches } 647313214adfSAndy Whitcroft 647413214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 647513214adfSAndy Whitcroft # so just keep quiet. 647613214adfSAndy Whitcroft if ($#rawlines == -1) { 647713214adfSAndy Whitcroft exit(0); 64780a920b5bSAndy Whitcroft } 64790a920b5bSAndy Whitcroft 64808905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 64818905a67cSAndy Whitcroft # things that appear to be patches. 64828905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 64838905a67cSAndy Whitcroft exit(0); 64848905a67cSAndy Whitcroft } 64858905a67cSAndy Whitcroft 64868905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 64878905a67cSAndy Whitcroft # just keep quiet. 64888905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 64898905a67cSAndy Whitcroft exit(0); 64908905a67cSAndy Whitcroft } 64918905a67cSAndy Whitcroft 6492a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 6493000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6494000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 64950a920b5bSAndy Whitcroft } 6496ed43c4e5SAllen Hubbe if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) { 6497000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6498000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 64990a920b5bSAndy Whitcroft } 65000a920b5bSAndy Whitcroft 6501f0a594c1SAndy Whitcroft print report_dump(); 650213214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 650313214adfSAndy Whitcroft print "$filename " if ($summary_file); 65046c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 65056c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 65066c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 65076c72ffaaSAndy Whitcroft } 65088905a67cSAndy Whitcroft 6509d2c0a235SAndy Whitcroft if ($quiet == 0) { 6510ef212196SJoe Perches # If there were any defects found and not already fixing them 6511ef212196SJoe Perches if (!$clean and !$fix) { 6512ef212196SJoe Perches print << "EOM" 6513ef212196SJoe Perches 6514ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 6515ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 6516ef212196SJoe PerchesEOM 6517ef212196SJoe Perches } 6518d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 6519d2c0a235SAndy Whitcroft # then suggest that. 6520d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 6521b0781216SMike Frysinger $rpt_cleaners = 0; 6522d8469f16SJoe Perches print << "EOM" 6523d8469f16SJoe Perches 6524d8469f16SJoe PerchesNOTE: Whitespace errors detected. 6525d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 6526d8469f16SJoe PerchesEOM 6527d2c0a235SAndy Whitcroft } 6528d2c0a235SAndy Whitcroft } 6529d2c0a235SAndy Whitcroft 6530d752fcc8SJoe Perches if ($clean == 0 && $fix && 6531d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 6532d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 65339624b8d6SJoe Perches my $newfile = $filename; 65349624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 65353705ce5bSJoe Perches my $linecount = 0; 65363705ce5bSJoe Perches my $f; 65373705ce5bSJoe Perches 6538d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 6539d752fcc8SJoe Perches 65403705ce5bSJoe Perches open($f, '>', $newfile) 65413705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 65423705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 65433705ce5bSJoe Perches $linecount++; 65443705ce5bSJoe Perches if ($file) { 65453705ce5bSJoe Perches if ($linecount > 3) { 65463705ce5bSJoe Perches $fixed_line =~ s/^\+//; 65473705ce5bSJoe Perches print $f $fixed_line . "\n"; 65483705ce5bSJoe Perches } 65493705ce5bSJoe Perches } else { 65503705ce5bSJoe Perches print $f $fixed_line . "\n"; 65513705ce5bSJoe Perches } 65523705ce5bSJoe Perches } 65533705ce5bSJoe Perches close($f); 65543705ce5bSJoe Perches 65553705ce5bSJoe Perches if (!$quiet) { 65563705ce5bSJoe Perches print << "EOM"; 6557d8469f16SJoe Perches 65583705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 65593705ce5bSJoe Perches 65603705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 65613705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 65623705ce5bSJoe Perches 65633705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 65643705ce5bSJoe PerchesNo warranties, expressed or implied... 65653705ce5bSJoe PerchesEOM 65663705ce5bSJoe Perches } 65673705ce5bSJoe Perches } 65683705ce5bSJoe Perches 6569d8469f16SJoe Perches if ($quiet == 0) { 6570d8469f16SJoe Perches print "\n"; 6571d8469f16SJoe Perches if ($clean == 1) { 6572d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 6573d8469f16SJoe Perches } else { 6574d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 65750a920b5bSAndy Whitcroft } 65760a920b5bSAndy Whitcroft } 65770a920b5bSAndy Whitcroft return $clean; 65780a920b5bSAndy Whitcroft} 6579