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 2380*12c253abSJoe Perches# check if it's a mode change, rename or start of a patch 2381*12c253abSJoe Perches if (!$in_commit_log && 2382*12c253abSJoe Perches ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 2383*12c253abSJoe Perches ($line =~ /^rename (?:from|to) \S+\s*$/ || 2384*12c253abSJoe Perches $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 2385*12c253abSJoe Perches $is_patch = 1; 2386*12c253abSJoe Perches } 2387*12c253abSJoe 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 26099b3189ebSJoe Perches# Check for old stable address 26109b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 26119b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 26129b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 26139b3189ebSJoe Perches } 26149b3189ebSJoe Perches 26157ebd05efSChristopher Covington# Check for unwanted Gerrit info 26167ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 26177ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 26187ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 26197ebd05efSChristopher Covington } 26207ebd05efSChristopher Covington 2621369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2622369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2623369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2624369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2625369c8dd3SJoe Perches # timestamp 2626369c8dd3SJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) { 2627369c8dd3SJoe Perches # stack dump address 2628369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2629369c8dd3SJoe Perches } 2630369c8dd3SJoe Perches 26312a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 26322a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2633bf4daf12SJoe Perches length($line) > 75 && 2634bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2635bf4daf12SJoe Perches # file delta changes 2636bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2637bf4daf12SJoe Perches # filename then : 2638bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2639bf4daf12SJoe Perches # A Fixes: or Link: line 2640bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 26412a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 26422a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 26432a076f40SJoe Perches $commit_log_long_line = 1; 26442a076f40SJoe Perches } 26452a076f40SJoe Perches 2646bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2647bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2648bf4daf12SJoe Perches $line =~ /^\s*$/) { 2649bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2650bf4daf12SJoe Perches } 2651bf4daf12SJoe Perches 26520d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2653369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2654aab38f51SJoe Perches $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i && 2655e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 2656fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2657aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2658369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2659bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2660fe043ea1SJoe Perches my $init_char = "c"; 2661fe043ea1SJoe Perches my $orig_commit = ""; 26620d7835fcSJoe Perches my $short = 1; 26630d7835fcSJoe Perches my $long = 0; 26640d7835fcSJoe Perches my $case = 1; 26650d7835fcSJoe Perches my $space = 1; 26660d7835fcSJoe Perches my $hasdesc = 0; 266719c146a6SJoe Perches my $hasparens = 0; 26680d7835fcSJoe Perches my $id = '0123456789ab'; 26690d7835fcSJoe Perches my $orig_desc = "commit description"; 26700d7835fcSJoe Perches my $description = ""; 26710d7835fcSJoe Perches 2672fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2673fe043ea1SJoe Perches $init_char = $1; 2674fe043ea1SJoe Perches $orig_commit = lc($2); 2675fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2676fe043ea1SJoe Perches $orig_commit = lc($1); 2677fe043ea1SJoe Perches } 2678fe043ea1SJoe Perches 26790d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 26800d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 26810d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 26820d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 26830d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 26840d7835fcSJoe Perches $orig_desc = $1; 268519c146a6SJoe Perches $hasparens = 1; 26860d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 26870d7835fcSJoe Perches defined $rawlines[$linenr] && 26880d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 26890d7835fcSJoe Perches $orig_desc = $1; 269019c146a6SJoe Perches $hasparens = 1; 2691b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2692b671fde0SJoe Perches defined $rawlines[$linenr] && 2693b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2694b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2695b671fde0SJoe Perches $orig_desc = $1; 2696b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2697b671fde0SJoe Perches $orig_desc .= " " . $1; 269819c146a6SJoe Perches $hasparens = 1; 26990d7835fcSJoe Perches } 27000d7835fcSJoe Perches 27010d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 27020d7835fcSJoe Perches $id, $orig_desc); 27030d7835fcSJoe Perches 2704948b133aSHeinrich Schuchardt if (defined($id) && 2705948b133aSHeinrich Schuchardt ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { 2706d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 27070d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 27080d7835fcSJoe Perches } 2709d311cd44SJoe Perches } 2710d311cd44SJoe Perches 271113f1937eSJoe Perches# Check for added, moved or deleted files 271213f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 271313f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 271413f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 271513f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 271613f1937eSJoe Perches (defined($1) || defined($2))))) { 2717a82603a8SAndrew Jeffery $is_patch = 1; 271813f1937eSJoe Perches $reported_maintainer_file = 1; 271913f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 272013f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 272113f1937eSJoe Perches } 272213f1937eSJoe Perches 272300df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 27248905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2725000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2726000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 27276c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2728de7d4f0eSAndy Whitcroft } 2729de7d4f0eSAndy Whitcroft 2730de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2731de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2732171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2733171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2734171ae1a4SAndy Whitcroft 2735171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2736171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2737171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2738171ae1a4SAndy Whitcroft 273934d99219SJoe Perches CHK("INVALID_UTF8", 2740000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 274100df344fSAndy Whitcroft } 27420a920b5bSAndy Whitcroft 274315662b3eSJoe Perches# Check if it's the start of a commit log 274415662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 274515662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 2746eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 2747eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 274815662b3eSJoe Perches $in_header_lines = 0; 274915662b3eSJoe Perches $in_commit_log = 1; 2750ed43c4e5SAllen Hubbe $has_commit_log = 1; 275115662b3eSJoe Perches } 275215662b3eSJoe Perches 2753fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2754fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2755fa64205dSPasi Savanainen if ($in_header_lines && 2756fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2757fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2758fa64205dSPasi Savanainen $non_utf8_charset = 1; 2759fa64205dSPasi Savanainen } 2760fa64205dSPasi Savanainen 2761fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 276215662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2763fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 276415662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 276515662b3eSJoe Perches } 276615662b3eSJoe Perches 2767d6430f71SJoe Perches# Check for absolute kernel paths in commit message 2768d6430f71SJoe Perches if ($tree && $in_commit_log) { 2769d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 2770d6430f71SJoe Perches my $file = $1; 2771d6430f71SJoe Perches 2772d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 2773d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 2774d6430f71SJoe Perches # 2775d6430f71SJoe Perches } else { 2776d6430f71SJoe Perches check_absolute_file($file, $herecurr); 2777d6430f71SJoe Perches } 2778d6430f71SJoe Perches } 2779d6430f71SJoe Perches } 2780d6430f71SJoe Perches 278166b47b4aSKees Cook# Check for various typo / spelling mistakes 278266d7a382SJoe Perches if (defined($misspellings) && 278366d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2784ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 278566b47b4aSKees Cook my $typo = $1; 278666b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 278766b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 278866b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 27890675a8fbSJean Delvare my $msg_level = \&WARN; 27900675a8fbSJean Delvare $msg_level = \&CHK if ($file); 27910675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 279266b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 279366b47b4aSKees Cook $fix) { 279466b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 279566b47b4aSKees Cook } 279666b47b4aSKees Cook } 279766b47b4aSKees Cook } 279866b47b4aSKees Cook 279930670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 280030670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 280100df344fSAndy Whitcroft 28020a920b5bSAndy Whitcroft#trailing whitespace 28039c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2804c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2805d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2806d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2807d5e616fcSJoe Perches $fix) { 2808194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2809d5e616fcSJoe Perches } 2810c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2811c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28123705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 28133705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 28143705ce5bSJoe Perches $fix) { 2815194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 28163705ce5bSJoe Perches } 28173705ce5bSJoe Perches 2818d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 28190a920b5bSAndy Whitcroft } 28205368df20SAndy Whitcroft 28214783f894SJosh Triplett# Check for FSF mailing addresses. 2822109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 28231bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 28243e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 28253e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 28264783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28270675a8fbSJean Delvare my $msg_level = \&ERROR; 28280675a8fbSJean Delvare $msg_level = \&CHK if ($file); 28290675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 28304783f894SJosh 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) 28314783f894SJosh Triplett } 28324783f894SJosh Triplett 28333354957aSAndi Kleen# check for Kconfig help text having a real description 28349fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 28359fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 28363354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 2837678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 2838678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 2839678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 2840678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 28413354957aSAndi Kleen my $length = 0; 28429fe287d7SAndy Whitcroft my $cnt = $realcnt; 28439fe287d7SAndy Whitcroft my $ln = $linenr + 1; 28449fe287d7SAndy Whitcroft my $f; 2845a1385803SAndy Whitcroft my $is_start = 0; 28469fe287d7SAndy Whitcroft my $is_end = 0; 2847a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 28489fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 28499fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 28509fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 28519fe287d7SAndy Whitcroft 28529fe287d7SAndy Whitcroft next if ($f =~ /^-/); 28538d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2854a1385803SAndy Whitcroft 285586adf1a0SUlf Magnusson if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 2856a1385803SAndy Whitcroft $is_start = 1; 285784af7a61SUlf Magnusson } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) { 285884af7a61SUlf Magnusson if ($lines[$ln - 1] =~ "---help---") { 285984af7a61SUlf Magnusson WARN("CONFIG_DESCRIPTION", 286084af7a61SUlf Magnusson "prefer 'help' over '---help---' for new help texts\n" . $herecurr); 286184af7a61SUlf Magnusson } 2862a1385803SAndy Whitcroft $length = -1; 2863a1385803SAndy Whitcroft } 2864a1385803SAndy Whitcroft 28659fe287d7SAndy Whitcroft $f =~ s/^.//; 28663354957aSAndi Kleen $f =~ s/#.*//; 28673354957aSAndi Kleen $f =~ s/^\s+//; 28683354957aSAndi Kleen next if ($f =~ /^$/); 2869678ae162SUlf Magnusson 2870678ae162SUlf Magnusson # This only checks context lines in the patch 2871678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 2872678ae162SUlf Magnusson # positives, even though some of these are 2873678ae162SUlf Magnusson # common words in help texts 2874678ae162SUlf Magnusson if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| 2875678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 28769fe287d7SAndy Whitcroft $is_end = 1; 28779fe287d7SAndy Whitcroft last; 28789fe287d7SAndy Whitcroft } 28793354957aSAndi Kleen $length++; 28803354957aSAndi Kleen } 288156193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2882000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 288356193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 288456193274SVadim Bendebury } 2885a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 28863354957aSAndi Kleen } 28873354957aSAndi Kleen 2888628f91a2SJoe Perches# check for MAINTAINERS entries that don't have the right form 2889628f91a2SJoe Perches if ($realfile =~ /^MAINTAINERS$/ && 2890628f91a2SJoe Perches $rawline =~ /^\+[A-Z]:/ && 2891628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 2892628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 2893628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 2894628f91a2SJoe Perches $fix) { 2895628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 2896628f91a2SJoe Perches } 2897628f91a2SJoe Perches } 2898628f91a2SJoe Perches 2899327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2900327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2901327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2902327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2903327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2904327953e9SChristoph Jaeger } 2905327953e9SChristoph Jaeger 2906c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2907c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2908c68e5878SArnaud Lacombe my $flag = $1; 2909c68e5878SArnaud Lacombe my $replacement = { 2910c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2911c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2912c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2913c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2914c68e5878SArnaud Lacombe }; 2915c68e5878SArnaud Lacombe 2916c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2917c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2918c68e5878SArnaud Lacombe } 2919c68e5878SArnaud Lacombe 2920bff5da43SRob Herring# check for DT compatible documentation 29217dd05b38SFlorian Vaussard if (defined $root && 29227dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 29237dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 29247dd05b38SFlorian Vaussard 2925bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2926bff5da43SRob Herring 2927cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2928cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2929cc93319bSFlorian Vaussard 2930bff5da43SRob Herring foreach my $compat (@compats) { 2931bff5da43SRob Herring my $compat2 = $compat; 2932185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2933185d566bSRob Herring my $compat3 = $compat; 2934185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2935185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2936bff5da43SRob Herring if ( $? >> 8 ) { 2937bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2938bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2939bff5da43SRob Herring } 2940bff5da43SRob Herring 29414fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 29424fbf32a6SFlorian Vaussard my $vendor = $1; 2943cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2944bff5da43SRob Herring if ( $? >> 8 ) { 2945bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2946cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2947bff5da43SRob Herring } 2948bff5da43SRob Herring } 2949bff5da43SRob Herring } 2950bff5da43SRob Herring 29519f3a8992SRob Herring# check for using SPDX license tag at beginning of files 29529f3a8992SRob Herring if ($realline == $checklicenseline) { 29539f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 29549f3a8992SRob Herring $checklicenseline = 2; 29559f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 29569f3a8992SRob Herring my $comment = ""; 29579f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 29589f3a8992SRob Herring $comment = '/*'; 29599f3a8992SRob Herring } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 29609f3a8992SRob Herring $comment = '//'; 29619f3a8992SRob Herring } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) { 29629f3a8992SRob Herring $comment = '#'; 29639f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 29649f3a8992SRob Herring $comment = '..'; 29659f3a8992SRob Herring } 29669f3a8992SRob Herring 29679f3a8992SRob Herring if ($comment !~ /^$/ && 29689f3a8992SRob Herring $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) { 29699f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 29709f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 29719f3a8992SRob Herring } 29729f3a8992SRob Herring } 29739f3a8992SRob Herring } 29749f3a8992SRob Herring 29755368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2976d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 29775368df20SAndy Whitcroft 297847e0c88bSJoe Perches# line length limit (with some exclusions) 297947e0c88bSJoe Perches# 298047e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 298147e0c88bSJoe Perches# logging functions like pr_info that end in a string 298247e0c88bSJoe Perches# lines with a single string 298347e0c88bSJoe Perches# #defines that are a single string 29842e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 298547e0c88bSJoe Perches# 298647e0c88bSJoe Perches# There are 3 different line length message types: 2987ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 298847e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 298947e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 299047e0c88bSJoe Perches# 299147e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 299247e0c88bSJoe Perches# 299347e0c88bSJoe Perches 2994b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 299547e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 299647e0c88bSJoe Perches 299747e0c88bSJoe Perches # Check the allowed long line types first 299847e0c88bSJoe Perches 299947e0c88bSJoe Perches # logging functions that end in a string that starts 300047e0c88bSJoe Perches # before $max_line_length 300147e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 300247e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 300347e0c88bSJoe Perches $msg_type = ""; 300447e0c88bSJoe Perches 300547e0c88bSJoe Perches # lines with only strings (w/ possible termination) 300647e0c88bSJoe Perches # #defines with only strings 300747e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 300847e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 300947e0c88bSJoe Perches $msg_type = ""; 301047e0c88bSJoe Perches 3011cc147506SJoe Perches # More special cases 3012cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3013cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3014d560a5f8SJoe Perches $msg_type = ""; 3015d560a5f8SJoe Perches 30162e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 30172e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 30182e4bbbc5SAndreas Brauchli $msg_type = ""; 30192e4bbbc5SAndreas Brauchli 302047e0c88bSJoe Perches # Otherwise set the alternate message types 302147e0c88bSJoe Perches 302247e0c88bSJoe Perches # a comment starts before $max_line_length 302347e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 302447e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 302547e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 302647e0c88bSJoe Perches 302747e0c88bSJoe Perches # a quoted string starts before $max_line_length 302847e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 302947e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 303047e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 303147e0c88bSJoe Perches } 303247e0c88bSJoe Perches 303347e0c88bSJoe Perches if ($msg_type ne "" && 303447e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 303547e0c88bSJoe Perches WARN($msg_type, 30366cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 30370a920b5bSAndy Whitcroft } 303847e0c88bSJoe Perches } 30390a920b5bSAndy Whitcroft 30408905a67cSAndy Whitcroft# check for adding lines without a newline. 30418905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 3042000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 3043000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 30448905a67cSAndy Whitcroft } 30458905a67cSAndy Whitcroft 3046b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3047de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 30480a920b5bSAndy Whitcroft 30490a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 30500a920b5bSAndy Whitcroft# more than 8 must use tabs. 3051c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3052c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3053c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3054d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 30553705ce5bSJoe Perches if (ERROR("CODE_INDENT", 30563705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 30573705ce5bSJoe Perches $fix) { 3058194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 30593705ce5bSJoe Perches } 30600a920b5bSAndy Whitcroft } 30610a920b5bSAndy Whitcroft 306208e44365SAlberto Panizzo# check for space before tabs. 306308e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 306408e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 30653705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 30663705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 30673705ce5bSJoe Perches $fix) { 3068194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3069d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 3070194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3071c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 30723705ce5bSJoe Perches } 307308e44365SAlberto Panizzo } 307408e44365SAlberto Panizzo 30756a487211SJoe Perches# check for assignments on the start of a line 30766a487211SJoe Perches if ($sline =~ /^\+\s+($Assignment)[^=]/) { 30776a487211SJoe Perches CHK("ASSIGNMENT_CONTINUATIONS", 30786a487211SJoe Perches "Assignment operator '$1' should be on the previous line\n" . $hereprev); 30796a487211SJoe Perches } 30806a487211SJoe Perches 3081d1fe9c09SJoe Perches# check for && or || at the start of a line 3082d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 3083d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 3084d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 3085d1fe9c09SJoe Perches } 3086d1fe9c09SJoe Perches 3087a91e8994SJoe Perches# check indentation starts on a tab stop 3088a91e8994SJoe Perches if ($^V && $^V ge 5.10.0 && 3089bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3090a91e8994SJoe Perches my $indent = length($1); 3091a91e8994SJoe Perches if ($indent % 8) { 3092a91e8994SJoe Perches if (WARN("TABSTOP", 3093a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3094a91e8994SJoe Perches $fix) { 3095a91e8994SJoe Perches $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; 3096a91e8994SJoe Perches } 3097a91e8994SJoe Perches } 3098a91e8994SJoe Perches } 3099a91e8994SJoe Perches 3100d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 3101d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3102fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3103d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3104d1fe9c09SJoe Perches my $oldindent = $1; 3105d1fe9c09SJoe Perches my $rest = $2; 3106d1fe9c09SJoe Perches 3107d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3108d1fe9c09SJoe Perches if ($pos >= 0) { 3109b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3110b34a26f3SJoe Perches my $newindent = $2; 3111d1fe9c09SJoe Perches 3112d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3113d1fe9c09SJoe Perches "\t" x ($pos / 8) . 3114d1fe9c09SJoe Perches " " x ($pos % 8); 3115d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3116d1fe9c09SJoe Perches 3117d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3118d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 31193705ce5bSJoe Perches 31203705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 31213705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 31223705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3123194f66fcSJoe Perches $fixed[$fixlinenr] =~ 31243705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 31253705ce5bSJoe Perches } 3126d1fe9c09SJoe Perches } 3127d1fe9c09SJoe Perches } 3128d1fe9c09SJoe Perches } 3129d1fe9c09SJoe Perches 31306ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 31316ab3a970SJoe Perches# avoid checking a few false positives: 31326ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 31336ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 31346ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 31356ab3a970SJoe Perches# multiline macros that define functions 31366ab3a970SJoe Perches# known attributes or the __attribute__ keyword 31376ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 31386ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 31393705ce5bSJoe Perches if (CHK("SPACING", 3140f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 31413705ce5bSJoe Perches $fix) { 3142194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3143f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 31443705ce5bSJoe Perches } 3145aad4f614SJoe Perches } 3146aad4f614SJoe Perches 314786406b1cSJoe Perches# Block comment styles 314886406b1cSJoe Perches# Networking with an initial /* 314905880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3150fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 315185ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 315285ad978cSJoe Perches $realline > 2) { 315305880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 315405880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 315505880600SJoe Perches } 315605880600SJoe Perches 315786406b1cSJoe Perches# Block comments use * on subsequent lines 315886406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 315986406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3160a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 316161135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3162a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 316386406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 316486406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3165a605e32eSJoe Perches } 3166a605e32eSJoe Perches 316786406b1cSJoe Perches# Block comments use */ on trailing lines 316886406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3169c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3170c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3171c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 317286406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 317386406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 317405880600SJoe Perches } 317505880600SJoe Perches 317608eb9b80SJoe Perches# Block comment * alignment 317708eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3178af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3179af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3180af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 318108eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3182af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3183af207524SJoe Perches my $oldindent; 318408eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3185af207524SJoe Perches if (defined($1)) { 3186af207524SJoe Perches $oldindent = expand_tabs($1); 3187af207524SJoe Perches } else { 3188af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3189af207524SJoe Perches $oldindent = expand_tabs($1); 3190af207524SJoe Perches } 319108eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 319208eb9b80SJoe Perches my $newindent = $1; 319308eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3194af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 319508eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 319608eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 319708eb9b80SJoe Perches } 319808eb9b80SJoe Perches } 319908eb9b80SJoe Perches 32007f619191SJoe Perches# check for missing blank lines after struct/union declarations 32017f619191SJoe Perches# with exceptions for various attributes and macros 32027f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 32037f619191SJoe Perches $line =~ /^\+/ && 32047f619191SJoe Perches !($line =~ /^\+\s*$/ || 32057f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 32067f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 32077f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 32087f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 32097f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 32107f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 32110bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 32127f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3213d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3214d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3215d752fcc8SJoe Perches $fix) { 3216f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3217d752fcc8SJoe Perches } 32187f619191SJoe Perches } 32197f619191SJoe Perches 3220365dd4eaSJoe Perches# check for multiple consecutive blank lines 3221365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3222365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3223365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3224d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3225d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3226d752fcc8SJoe Perches $fix) { 3227f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3228d752fcc8SJoe Perches } 3229d752fcc8SJoe Perches 3230365dd4eaSJoe Perches $last_blank_line = $linenr; 3231365dd4eaSJoe Perches } 3232365dd4eaSJoe Perches 32333b617e3bSJoe Perches# check for missing blank lines after declarations 32343f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 32353f7bac03SJoe Perches # actual declarations 32363f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 32375a4e1fd3SJoe Perches # function pointer declarations 32385a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 32393f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 32403f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 32413f7bac03SJoe Perches # known declaration macros 32423f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 32433f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 32443f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 32453f7bac03SJoe Perches # other possible extensions of declaration lines 32463f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 32473f7bac03SJoe Perches # not starting a section or a macro "\" extended line 32483f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 32493f7bac03SJoe Perches # looks like a declaration 32503f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 32515a4e1fd3SJoe Perches # function pointer declarations 32525a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 32533f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 32543f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 32553f7bac03SJoe Perches # known declaration macros 32563f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 32573f7bac03SJoe Perches # start of struct or union or enum 32583b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 32593f7bac03SJoe Perches # start or end of block or continuation of declaration 32603f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 32613f7bac03SJoe Perches # bitfield continuation 32623f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 32633f7bac03SJoe Perches # other possible extensions of declaration lines 32643f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 32653f7bac03SJoe Perches # indentation of previous and current line are the same 32663f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3267d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3268d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3269d752fcc8SJoe Perches $fix) { 3270f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3271d752fcc8SJoe Perches } 32723b617e3bSJoe Perches } 32733b617e3bSJoe Perches 32745f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 32756b4c5bebSAndy Whitcroft# Exceptions: 32766b4c5bebSAndy Whitcroft# 1) within comments 32776b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 32786b4c5bebSAndy Whitcroft# 3) hanging labels 32793705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 32805f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 32813705ce5bSJoe Perches if (WARN("LEADING_SPACE", 32823705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 32833705ce5bSJoe Perches $fix) { 3284194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 32853705ce5bSJoe Perches } 32865f7ddae6SRaffaele Recalcati } 32875f7ddae6SRaffaele Recalcati 3288b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3289b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3290b9ea10d6SAndy Whitcroft 32915751a24eSJoe Perches# check for unusual line ending [ or ( 32925751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 32935751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 32945751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 32955751a24eSJoe Perches } 32965751a24eSJoe Perches 32974dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 32984dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 32994dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 33004dbed76fSJoe Perches $context_function = $1; 33014dbed76fSJoe Perches } 33024dbed76fSJoe Perches 33034dbed76fSJoe Perches# check if this appears to be the end of function declaration 33044dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 33054dbed76fSJoe Perches undef $context_function; 33064dbed76fSJoe Perches } 33074dbed76fSJoe Perches 3308032a4c0fSJoe Perches# check indentation of any line with a bare else 3309840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3310032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3311032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3312032a4c0fSJoe Perches my $tabs = length($1) + 1; 3313840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3314840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3315840080a0SJoe Perches defined $lines[$linenr] && 3316840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3317032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3318032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3319032a4c0fSJoe Perches } 3320032a4c0fSJoe Perches } 3321032a4c0fSJoe Perches 3322c00df19aSJoe Perches# check indentation of a line with a break; 3323c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3324c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3325c00df19aSJoe Perches my $tabs = $1; 3326c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3327c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3328c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3329c00df19aSJoe Perches } 3330c00df19aSJoe Perches } 3331c00df19aSJoe Perches 3332c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3333cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3334000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3335000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3336c2fdda0dSAndy Whitcroft } 333722f2a2efSAndy Whitcroft 333856e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 333956e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 334056e77d70SJoe Perches WARN("HOTPLUG_SECTION", 334156e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 334256e77d70SJoe Perches } 334356e77d70SJoe Perches 33449c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 33452b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 33462b474a1aSAndy Whitcroft $realline_next); 33473e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 3348ca819864SJoe Perches if ($linenr > $suppress_statement && 33491b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3350170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3351f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3352171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3353171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3354171ae1a4SAndy Whitcroft 33553e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 33563e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 33573e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 33583e469cdcSAndy Whitcroft # until we hit end of it. 33593e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 33603e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 33613e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 33623e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 33633e469cdcSAndy Whitcroft } 3364f74bd194SAndy Whitcroft 33652b474a1aSAndy Whitcroft # Find the real next line. 33662b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 33672b474a1aSAndy Whitcroft if (defined $realline_next && 33682b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 33692b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 33702b474a1aSAndy Whitcroft $realline_next++; 33712b474a1aSAndy Whitcroft } 33722b474a1aSAndy Whitcroft 3373171ae1a4SAndy Whitcroft my $s = $stat; 3374171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3375cf655043SAndy Whitcroft 3376c2fdda0dSAndy Whitcroft # Ignore goto labels. 3377171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3378c2fdda0dSAndy Whitcroft 3379c2fdda0dSAndy Whitcroft # Ignore functions being called 3380171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3381c2fdda0dSAndy Whitcroft 3382463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3383463f2864SAndy Whitcroft 3384c45dcabdSAndy Whitcroft # declarations always start with types 3385d2506586SAndy 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) { 3386c45dcabdSAndy Whitcroft my $type = $1; 3387c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3388c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3389c45dcabdSAndy Whitcroft 33906c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3391a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3392c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3393c2fdda0dSAndy Whitcroft } 33948905a67cSAndy Whitcroft 33956c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 339665863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3397c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 33989c0ca6f9SAndy Whitcroft } 33998905a67cSAndy Whitcroft 34008905a67cSAndy Whitcroft # Check for any sort of function declaration. 34018905a67cSAndy Whitcroft # int foo(something bar, other baz); 34028905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3403171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 34048905a67cSAndy Whitcroft my ($name_len) = length($1); 34058905a67cSAndy Whitcroft 3406cf655043SAndy Whitcroft my $ctx = $s; 3407773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 34088905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3409cf655043SAndy Whitcroft 34108905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3411c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 34128905a67cSAndy Whitcroft 3413c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 34148905a67cSAndy Whitcroft } 34158905a67cSAndy Whitcroft } 34168905a67cSAndy Whitcroft } 34178905a67cSAndy Whitcroft 34189c0ca6f9SAndy Whitcroft } 34199c0ca6f9SAndy Whitcroft 342000df344fSAndy Whitcroft# 342100df344fSAndy Whitcroft# Checks which may be anchored in the context. 342200df344fSAndy Whitcroft# 342300df344fSAndy Whitcroft 342400df344fSAndy Whitcroft# Check for switch () and associated case and default 342500df344fSAndy Whitcroft# statements should be at the same indent. 342600df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 342700df344fSAndy Whitcroft my $err = ''; 342800df344fSAndy Whitcroft my $sep = ''; 342900df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 343000df344fSAndy Whitcroft shift(@ctx); 343100df344fSAndy Whitcroft for my $ctx (@ctx) { 343200df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 343300df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 343400df344fSAndy Whitcroft $indent != $cindent) { 343500df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 343600df344fSAndy Whitcroft $sep = ''; 343700df344fSAndy Whitcroft } else { 343800df344fSAndy Whitcroft $sep = "[...]\n"; 343900df344fSAndy Whitcroft } 344000df344fSAndy Whitcroft } 344100df344fSAndy Whitcroft if ($err ne '') { 3442000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3443000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3444de7d4f0eSAndy Whitcroft } 3445de7d4f0eSAndy Whitcroft } 3446de7d4f0eSAndy Whitcroft 3447de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3448de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 34490fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3450773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3451773647a0SAndy Whitcroft 34529c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 34538eef05ddSJoe Perches 34548eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 34558eef05ddSJoe Perches WARN("DEEP_INDENTATION", 34568eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 34578eef05ddSJoe Perches } 34588eef05ddSJoe Perches 3459de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3460de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3461de7d4f0eSAndy Whitcroft 3462548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3463548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3464de7d4f0eSAndy Whitcroft 3465548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3466548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3467548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3468548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3469548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3470773647a0SAndy Whitcroft $ctx_ln++; 3471773647a0SAndy Whitcroft } 3472548596d5SAndy Whitcroft 347353210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 347453210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3475773647a0SAndy Whitcroft 3476773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3477000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3478000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 347901464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 348000df344fSAndy Whitcroft } 3481773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3482773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3483773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3484773647a0SAndy Whitcroft { 34859c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 34869c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3487000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3488000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 348901464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 34909c0ca6f9SAndy Whitcroft } 34919c0ca6f9SAndy Whitcroft } 349200df344fSAndy Whitcroft } 349300df344fSAndy Whitcroft 34944d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 3495f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 34963e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 34973e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 34983e469cdcSAndy Whitcroft if (!defined $stat); 34994d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 35004d001e4dSAndy Whitcroft 35014d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 35024d001e4dSAndy Whitcroft 35039f5af480SJoe Perches # remove inline comments 35049f5af480SJoe Perches $s =~ s/$;/ /g; 35059f5af480SJoe Perches $c =~ s/$;/ /g; 35064d001e4dSAndy Whitcroft 35074d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 35086f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 35096f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 35104d001e4dSAndy Whitcroft 35119f5af480SJoe Perches # Make sure we remove the line prefixes as we have 35129f5af480SJoe Perches # none on the first line, and are going to readd them 35139f5af480SJoe Perches # where necessary. 35149f5af480SJoe Perches $s =~ s/\n./\n/gs; 35159f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 35169f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 35179f5af480SJoe Perches } 35189f5af480SJoe Perches 35194d001e4dSAndy Whitcroft # We want to check the first line inside the block 35204d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 35214d001e4dSAndy Whitcroft # 1) any blank line termination 35224d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 35234d001e4dSAndy Whitcroft # 3) any do (...) { 35244d001e4dSAndy Whitcroft my $continuation = 0; 35254d001e4dSAndy Whitcroft my $check = 0; 35264d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 35274d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 35284d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 35294d001e4dSAndy Whitcroft $continuation = 1; 35304d001e4dSAndy Whitcroft } 35319bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 35324d001e4dSAndy Whitcroft $check = 1; 35334d001e4dSAndy Whitcroft $cond_lines++; 35344d001e4dSAndy Whitcroft } 35354d001e4dSAndy Whitcroft 35364d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 35374d001e4dSAndy Whitcroft # preprocessor statement. 35384d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 35394d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 35404d001e4dSAndy Whitcroft $check = 0; 35414d001e4dSAndy Whitcroft } 35424d001e4dSAndy Whitcroft 35439bd49efeSAndy Whitcroft my $cond_ptr = -1; 3544740504c6SAndy Whitcroft $continuation = 0; 35459bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 35469bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 35474d001e4dSAndy Whitcroft 3548f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3549f16fa28fSAndy Whitcroft # is not linear. 3550f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3551f16fa28fSAndy Whitcroft $check = 0; 3552f16fa28fSAndy Whitcroft } 3553f16fa28fSAndy Whitcroft 35549bd49efeSAndy Whitcroft # Ignore: 35559bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 35569bd49efeSAndy Whitcroft # 2) preprocessor lines, and 35579bd49efeSAndy Whitcroft # 3) labels. 3558740504c6SAndy Whitcroft if ($continuation || 3559740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 35609bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 35619bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3562740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 356330dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 35649bd49efeSAndy Whitcroft $cond_lines++; 35659bd49efeSAndy Whitcroft } 35664d001e4dSAndy Whitcroft } 356730dad6ebSAndy Whitcroft } 35684d001e4dSAndy Whitcroft 35694d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 35704d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 35714d001e4dSAndy Whitcroft 35724d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 35734d001e4dSAndy Whitcroft # this is not this patch's fault. 35744d001e4dSAndy Whitcroft if (!defined($stat_real) || 35754d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 35764d001e4dSAndy Whitcroft $check = 0; 35774d001e4dSAndy Whitcroft } 35784d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 35794d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 35804d001e4dSAndy Whitcroft } 35814d001e4dSAndy Whitcroft 35829bd49efeSAndy 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"; 35834d001e4dSAndy Whitcroft 35849f5af480SJoe Perches if ($check && $s ne '' && 35859f5af480SJoe Perches (($sindent % 8) != 0 || 35869f5af480SJoe Perches ($sindent < $indent) || 3587f6950a73SJoe Perches ($sindent == $indent && 3588f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 35899f5af480SJoe Perches ($sindent > $indent + 8))) { 3590000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3591000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 35924d001e4dSAndy Whitcroft } 35934d001e4dSAndy Whitcroft } 35944d001e4dSAndy Whitcroft 35956c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 35966c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 35971f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 35981f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 35996c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3600c2fdda0dSAndy Whitcroft if ($dbg_values) { 3601c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3602cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3603cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 36041f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3605c2fdda0dSAndy Whitcroft } 36066c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 36076c72ffaaSAndy Whitcroft 360800df344fSAndy Whitcroft#ignore lines not being added 36093705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 361000df344fSAndy Whitcroft 361111ca40a0SJoe Perches# check for dereferences that span multiple lines 361211ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 361311ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 361411ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 361511ca40a0SJoe Perches my $ref = $1; 361611ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 361711ca40a0SJoe Perches $ref .= $1; 361811ca40a0SJoe Perches $ref =~ s/\s//g; 361911ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 362011ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 362111ca40a0SJoe Perches } 362211ca40a0SJoe Perches 3623a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3624c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3625a1ce18e4SJoe Perches my $type = $1; 3626a1ce18e4SJoe Perches my $var = $2; 3627207a8e84SJoe Perches $var = "" if (!defined $var); 3628207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3629a1ce18e4SJoe Perches my $sign = $1; 3630a1ce18e4SJoe Perches my $pointer = $2; 3631a1ce18e4SJoe Perches 3632a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3633a1ce18e4SJoe Perches 3634a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3635a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3636a1ce18e4SJoe Perches $fix) { 3637a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3638207a8e84SJoe Perches my $comp_pointer = $pointer; 3639207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 3640207a8e84SJoe Perches $decl .= $comp_pointer; 3641207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 3642207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 3643a1ce18e4SJoe Perches } 3644a1ce18e4SJoe Perches } 3645a1ce18e4SJoe Perches } 3646a1ce18e4SJoe Perches 3647653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 36487429c690SAndy Whitcroft if ($dbg_type) { 36497429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3650000d1cc1SJoe Perches ERROR("TEST_TYPE", 3651000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 36527429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3653000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3654000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 36557429c690SAndy Whitcroft } 3656653d4876SAndy Whitcroft next; 3657653d4876SAndy Whitcroft } 3658a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3659a1ef277eSAndy Whitcroft if ($dbg_attr) { 36609360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3661000d1cc1SJoe Perches ERROR("TEST_ATTR", 3662000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 36639360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3664000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3665000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3666a1ef277eSAndy Whitcroft } 3667a1ef277eSAndy Whitcroft next; 3668a1ef277eSAndy Whitcroft } 3669653d4876SAndy Whitcroft 3670f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 367199423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 367299423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3673d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3674d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3675f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3676f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3677f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3678d752fcc8SJoe Perches my $fixedline = $prevrawline; 3679d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3680f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3681d752fcc8SJoe Perches $fixedline = $line; 36828d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 3683f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3684d752fcc8SJoe Perches } 3685f0a594c1SAndy Whitcroft } 3686f0a594c1SAndy Whitcroft 368700df344fSAndy Whitcroft# 368800df344fSAndy Whitcroft# Checks which are anchored on the added line. 368900df344fSAndy Whitcroft# 369000df344fSAndy Whitcroft 3691653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3692c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3693653d4876SAndy Whitcroft my $path = $1; 3694653d4876SAndy Whitcroft if ($path =~ m{//}) { 3695000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3696495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3697495e9d84SJoe Perches } 3698495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3699495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3700495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3701653d4876SAndy Whitcroft } 3702653d4876SAndy Whitcroft } 3703653d4876SAndy Whitcroft 370400df344fSAndy Whitcroft# no C99 // comments 370500df344fSAndy Whitcroft if ($line =~ m{//}) { 37063705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 37073705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 37083705ce5bSJoe Perches $fix) { 3709194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 37103705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 37113705ce5bSJoe Perches my $comment = trim($1); 3712194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 37133705ce5bSJoe Perches } 37143705ce5bSJoe Perches } 371500df344fSAndy Whitcroft } 371600df344fSAndy Whitcroft # Remove C99 comments. 37170a920b5bSAndy Whitcroft $line =~ s@//.*@@; 37186c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 37190a920b5bSAndy Whitcroft 37202b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 37212b474a1aSAndy Whitcroft# the whole statement. 37222b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 37232b474a1aSAndy Whitcroft if (defined $realline_next && 37242b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 37252b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 37262b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 37272b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 37283cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 37293cbf62dfSAndy Whitcroft # a prefix: 37303cbf62dfSAndy Whitcroft # XXX(foo); 37313cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3732653d4876SAndy Whitcroft my $name = $1; 373387a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 37343cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 37353cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 37363cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 37373cbf62dfSAndy Whitcroft 37383cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 37392b474a1aSAndy Whitcroft \n.}\s*$| 374048012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 374148012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 374248012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 37432b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 37442b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 374548012058SAndy Whitcroft )/x) { 37462b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 37472b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 37482b474a1aSAndy Whitcroft } else { 37492b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 37500a920b5bSAndy Whitcroft } 37510a920b5bSAndy Whitcroft } 37522b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 37532b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 37542b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 37552b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 37562b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 37572b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 37582b474a1aSAndy Whitcroft } 37592b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 37602b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3761000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3762000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 37632b474a1aSAndy Whitcroft } 37640a920b5bSAndy Whitcroft 37655150bda4SJoe Eloff# check for global initialisers. 37666d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 3767d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 37686d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 3769d5e616fcSJoe Perches $fix) { 37706d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 3771d5e616fcSJoe Perches } 3772f0a594c1SAndy Whitcroft } 37730a920b5bSAndy Whitcroft# check for static initialisers. 37746d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 3775d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 37766d32f7a3SJoe Perches "do not initialise statics to $1\n" . 3777d5e616fcSJoe Perches $herecurr) && 3778d5e616fcSJoe Perches $fix) { 37796d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 3780d5e616fcSJoe Perches } 37810a920b5bSAndy Whitcroft } 37820a920b5bSAndy Whitcroft 37831813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 37841813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 37851813087dSJoe Perches my $tmp = trim($1); 37861813087dSJoe Perches WARN("MISORDERED_TYPE", 37871813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 37881813087dSJoe Perches } 37891813087dSJoe Perches 3790cb710ecaSJoe Perches# check for static const char * arrays. 3791cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3792000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3793000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3794cb710ecaSJoe Perches $herecurr); 3795cb710ecaSJoe Perches } 3796cb710ecaSJoe Perches 3797cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3798cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3799000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3800000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3801cb710ecaSJoe Perches $herecurr); 3802cb710ecaSJoe Perches } 3803cb710ecaSJoe Perches 3804ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3805ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3806ab7e23f3SJoe Perches my $found = $1; 3807ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3808ab7e23f3SJoe Perches WARN("CONST_CONST", 3809ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3810ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3811ab7e23f3SJoe Perches WARN("CONST_CONST", 3812ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3813ab7e23f3SJoe Perches } 3814ab7e23f3SJoe Perches } 3815ab7e23f3SJoe Perches 38169b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 38179b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 38189b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 38199b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 38209b0fa60dSJoe Perches $herecurr); 38219b0fa60dSJoe Perches } 38229b0fa60dSJoe Perches 3823b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3824b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3825b598b670SJoe Perches my $array = $1; 3826b598b670SJoe 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*\))@) { 3827b598b670SJoe Perches my $array_div = $1; 3828b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3829b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3830b598b670SJoe Perches $fix) { 3831b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3832b598b670SJoe Perches } 3833b598b670SJoe Perches } 3834b598b670SJoe Perches } 3835b598b670SJoe Perches 3836b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3837b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3838b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3839b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3840b36190c5SJoe Perches $fix) { 3841194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3842b36190c5SJoe Perches } 3843b36190c5SJoe Perches } 3844b36190c5SJoe Perches 3845653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3846653d4876SAndy Whitcroft# make sense. 3847653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 38488054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3849c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 38508ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 385146d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 3852000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3853000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 38540a920b5bSAndy Whitcroft } 38550a920b5bSAndy Whitcroft 38560a920b5bSAndy Whitcroft# * goes on variable not on type 385765863862SAndy Whitcroft # (char*[ const]) 3858bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3859bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 38603705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3861d8aaf121SAndy Whitcroft 386265863862SAndy Whitcroft # Should start with a space. 386365863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 386465863862SAndy Whitcroft # Should not end with a space. 386565863862SAndy Whitcroft $to =~ s/\s+$//; 386665863862SAndy Whitcroft # '*'s should not have spaces between. 3867f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 386865863862SAndy Whitcroft } 3869d8aaf121SAndy Whitcroft 38703705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 387165863862SAndy Whitcroft if ($from ne $to) { 38723705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 38733705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 38743705ce5bSJoe Perches $fix) { 38753705ce5bSJoe Perches my $sub_from = $ident; 38763705ce5bSJoe Perches my $sub_to = $ident; 38773705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3878194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38793705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 38803705ce5bSJoe Perches } 388165863862SAndy Whitcroft } 3882bfcb2cc7SAndy Whitcroft } 3883bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3884bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 38853705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3886d8aaf121SAndy Whitcroft 388765863862SAndy Whitcroft # Should start with a space. 388865863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 388965863862SAndy Whitcroft # Should not end with a space. 389065863862SAndy Whitcroft $to =~ s/\s+$//; 389165863862SAndy Whitcroft # '*'s should not have spaces between. 3892f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 389365863862SAndy Whitcroft } 389465863862SAndy Whitcroft # Modifiers should have spaces. 389565863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 389665863862SAndy Whitcroft 38973705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3898667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 38993705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 39003705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 39013705ce5bSJoe Perches $fix) { 39023705ce5bSJoe Perches 39033705ce5bSJoe Perches my $sub_from = $match; 39043705ce5bSJoe Perches my $sub_to = $match; 39053705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3906194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39073705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 39083705ce5bSJoe Perches } 390965863862SAndy Whitcroft } 39100a920b5bSAndy Whitcroft } 39110a920b5bSAndy Whitcroft 39129d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 39139d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 39140675a8fbSJean Delvare my $msg_level = \&WARN; 39150675a8fbSJean Delvare $msg_level = \&CHK if ($file); 39160675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 39179d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 39189d3e3c70SJoe Perches } 39190a920b5bSAndy Whitcroft 39209d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 39218905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3922000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3923000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 39248905a67cSAndy Whitcroft } 39258905a67cSAndy Whitcroft 392617441227SJoe Perches# check for uses of printk_ratelimit 392717441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3928000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3929000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 393017441227SJoe Perches } 393117441227SJoe Perches 3932eeef5733SJoe Perches# printk should use KERN_* levels 3933eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 3934000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3935eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 393600df344fSAndy Whitcroft } 39370a920b5bSAndy Whitcroft 3938243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3939243f3803SJoe Perches my $orig = $1; 3940243f3803SJoe Perches my $level = lc($orig); 3941243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 39428f26b837SJoe Perches my $level2 = $level; 39438f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3944243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3945daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3946243f3803SJoe Perches } 3947243f3803SJoe Perches 3948243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3949d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3950d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3951d5e616fcSJoe Perches $fix) { 3952194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3953d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3954d5e616fcSJoe Perches } 3955243f3803SJoe Perches } 3956243f3803SJoe Perches 3957dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3958dc139313SJoe Perches my $orig = $1; 3959dc139313SJoe Perches my $level = lc($orig); 3960dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3961dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3962dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3963dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3964dc139313SJoe Perches } 3965dc139313SJoe Perches 396691c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 396791c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 396891c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 396991c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 397091c9afafSAndy Lutomirski WARN("ENOSYS", 397191c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 397291c9afafSAndy Lutomirski } 397391c9afafSAndy Lutomirski 3974653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3975653d4876SAndy Whitcroft# or if closed on same line 39762d453e3bSJoe Perches if ($^V && $^V ge 5.10.0 && 39772d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 39782d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 39792d453e3bSJoe Perches $sline !~ /}/) { 39808d182478SJoe Perches if (ERROR("OPEN_BRACE", 39812d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 39828d182478SJoe Perches $fix) { 39838d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 39848d182478SJoe Perches my $fixed_line = $rawline; 39858d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 39868d182478SJoe Perches my $line1 = $1; 39878d182478SJoe Perches my $line2 = $2; 39888d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 39898d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 39908d182478SJoe Perches if ($line2 !~ /^\s*$/) { 39918d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 39928d182478SJoe Perches } 39938d182478SJoe Perches } 39940a920b5bSAndy Whitcroft } 3995653d4876SAndy Whitcroft 39968905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 39978905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 39988905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 39998d182478SJoe Perches if (ERROR("OPEN_BRACE", 40008d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 40018d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 40028d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 40038d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 40048d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 40058d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 40068d182478SJoe Perches $fixedline = $rawline; 40078d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 40088d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 40098d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 40108d182478SJoe Perches } 40118d182478SJoe Perches } 40128905a67cSAndy Whitcroft } 40138905a67cSAndy Whitcroft 40140c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 40153705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 40163705ce5bSJoe Perches if (WARN("SPACING", 40173705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 40183705ce5bSJoe Perches $fix) { 4019194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40203705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 40213705ce5bSJoe Perches } 40220c73b4ebSAndy Whitcroft } 40230c73b4ebSAndy Whitcroft 402431070b5dSJoe Perches# Function pointer declarations 402531070b5dSJoe Perches# check spacing between type, funcptr, and args 402631070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 402791f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 402831070b5dSJoe Perches my $declare = $1; 402931070b5dSJoe Perches my $pre_pointer_space = $2; 403031070b5dSJoe Perches my $post_pointer_space = $3; 403131070b5dSJoe Perches my $funcname = $4; 403231070b5dSJoe Perches my $post_funcname_space = $5; 403331070b5dSJoe Perches my $pre_args_space = $6; 403431070b5dSJoe Perches 403591f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 403691f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 403791f72e9cSJoe Perches# don't need a space so don't warn for those. 403891f72e9cSJoe Perches my $post_declare_space = ""; 403991f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 404091f72e9cSJoe Perches $post_declare_space = $1; 404191f72e9cSJoe Perches $declare = rtrim($declare); 404291f72e9cSJoe Perches } 404391f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 404431070b5dSJoe Perches WARN("SPACING", 404531070b5dSJoe Perches "missing space after return type\n" . $herecurr); 404691f72e9cSJoe Perches $post_declare_space = " "; 404731070b5dSJoe Perches } 404831070b5dSJoe Perches 404931070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 405091f72e9cSJoe Perches# This test is not currently implemented because these declarations are 405191f72e9cSJoe Perches# equivalent to 405291f72e9cSJoe Perches# int foo(int bar, ...) 405391f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 405491f72e9cSJoe Perches# 405591f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 405691f72e9cSJoe Perches# WARN("SPACING", 405791f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 405891f72e9cSJoe Perches# } 405931070b5dSJoe Perches 406031070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 406131070b5dSJoe Perches if (defined $pre_pointer_space && 406231070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 406331070b5dSJoe Perches WARN("SPACING", 406431070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 406531070b5dSJoe Perches } 406631070b5dSJoe Perches 406731070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 406831070b5dSJoe Perches if (defined $post_pointer_space && 406931070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 407031070b5dSJoe Perches WARN("SPACING", 407131070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 407231070b5dSJoe Perches } 407331070b5dSJoe Perches 407431070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 407531070b5dSJoe Perches if (defined $post_funcname_space && 407631070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 407731070b5dSJoe Perches WARN("SPACING", 407831070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 407931070b5dSJoe Perches } 408031070b5dSJoe Perches 408131070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 408231070b5dSJoe Perches if (defined $pre_args_space && 408331070b5dSJoe Perches $pre_args_space =~ /^\s/) { 408431070b5dSJoe Perches WARN("SPACING", 408531070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 408631070b5dSJoe Perches } 408731070b5dSJoe Perches 408831070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4089194f66fcSJoe Perches $fixed[$fixlinenr] =~ 409091f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 409131070b5dSJoe Perches } 409231070b5dSJoe Perches } 409331070b5dSJoe Perches 40948d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 40958d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4096fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4097fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 40988d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 40998d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 41008d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4101fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 410238dca988SHeinrich Schuchardt $prefix !~ /[{,:]\s+$/) { 41033705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 41043705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 41053705ce5bSJoe Perches $fix) { 4106194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41073705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 41083705ce5bSJoe Perches } 41098d31cfceSAndy Whitcroft } 41108d31cfceSAndy Whitcroft } 41118d31cfceSAndy Whitcroft 4112f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 41136c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4114c2fdda0dSAndy Whitcroft my $name = $1; 4115773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4116773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4117c2fdda0dSAndy Whitcroft 4118c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4119773647a0SAndy Whitcroft if ($name =~ /^(?: 4120773647a0SAndy Whitcroft if|for|while|switch|return|case| 4121773647a0SAndy Whitcroft volatile|__volatile__| 4122773647a0SAndy Whitcroft __attribute__|format|__extension__| 4123773647a0SAndy Whitcroft asm|__asm__)$/x) 4124773647a0SAndy Whitcroft { 4125c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4126c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4127c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4128c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4129773647a0SAndy Whitcroft 4130773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4131c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4132c2fdda0dSAndy Whitcroft 4133c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4134c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4135773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4136c2fdda0dSAndy Whitcroft 4137c2fdda0dSAndy Whitcroft } else { 41383705ce5bSJoe Perches if (WARN("SPACING", 41393705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 41403705ce5bSJoe Perches $fix) { 4141194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41423705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 41433705ce5bSJoe Perches } 4144f0a594c1SAndy Whitcroft } 41456c72ffaaSAndy Whitcroft } 41469a4cad4eSEric Nelson 4147653d4876SAndy Whitcroft# Check operator spacing. 41480a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 41493705ce5bSJoe Perches my $fixed_line = ""; 41503705ce5bSJoe Perches my $line_fixed = 0; 41513705ce5bSJoe Perches 41529c0ca6f9SAndy Whitcroft my $ops = qr{ 41539c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 41549c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 41559c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 41561f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 415784731623SJoe Perches \?:|\?|: 41589c0ca6f9SAndy Whitcroft }x; 4159cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 41603705ce5bSJoe Perches 41613705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 41623705ce5bSJoe Perches## foreach my $el (@elements) { 41633705ce5bSJoe Perches## print("el: <$el>\n"); 41643705ce5bSJoe Perches## } 41653705ce5bSJoe Perches 41663705ce5bSJoe Perches my @fix_elements = (); 416700df344fSAndy Whitcroft my $off = 0; 41686c72ffaaSAndy Whitcroft 41693705ce5bSJoe Perches foreach my $el (@elements) { 41703705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 41713705ce5bSJoe Perches $off += length($el); 41723705ce5bSJoe Perches } 41733705ce5bSJoe Perches 41743705ce5bSJoe Perches $off = 0; 41753705ce5bSJoe Perches 41766c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4177b34c648bSJoe Perches my $last_after = -1; 41786c72ffaaSAndy Whitcroft 41790a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 41803705ce5bSJoe Perches 41813705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 41823705ce5bSJoe Perches 41833705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 41843705ce5bSJoe Perches 41854a0df2efSAndy Whitcroft $off += length($elements[$n]); 41864a0df2efSAndy Whitcroft 418725985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4188773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4189773647a0SAndy Whitcroft my $cc = ''; 4190773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4191773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4192773647a0SAndy Whitcroft } 4193773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4194773647a0SAndy Whitcroft 41954a0df2efSAndy Whitcroft my $a = ''; 41964a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 41974a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4198cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 41994a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 42004a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 4201773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 42024a0df2efSAndy Whitcroft 42030a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 42044a0df2efSAndy Whitcroft 42054a0df2efSAndy Whitcroft my $c = ''; 42060a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 42074a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 42084a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4209cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 42104a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 42114a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 42128b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 42134a0df2efSAndy Whitcroft } else { 42144a0df2efSAndy Whitcroft $c = 'E'; 42150a920b5bSAndy Whitcroft } 42160a920b5bSAndy Whitcroft 42174a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 42184a0df2efSAndy Whitcroft 42194a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 42204a0df2efSAndy Whitcroft 42216c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 4222de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 42230a920b5bSAndy Whitcroft 422474048ed8SAndy Whitcroft # Pull out the value of this operator. 42256c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 42260a920b5bSAndy Whitcroft 42271f65f947SAndy Whitcroft # Get the full operator variant. 42281f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 42291f65f947SAndy Whitcroft 423013214adfSAndy Whitcroft # Ignore operators passed as parameters. 423113214adfSAndy Whitcroft if ($op_type ne 'V' && 4232d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 423313214adfSAndy Whitcroft 4234cf655043SAndy Whitcroft# # Ignore comments 4235cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 423613214adfSAndy Whitcroft 4237d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 423813214adfSAndy Whitcroft } elsif ($op eq ';') { 4239cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 4240cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 42413705ce5bSJoe Perches if (ERROR("SPACING", 42423705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 4243b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 42443705ce5bSJoe Perches $line_fixed = 1; 42453705ce5bSJoe Perches } 4246d8aaf121SAndy Whitcroft } 4247d8aaf121SAndy Whitcroft 4248d8aaf121SAndy Whitcroft # // is a comment 4249d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 42500a920b5bSAndy Whitcroft 4251b00e4814SJoe Perches # : when part of a bitfield 4252b00e4814SJoe Perches } elsif ($opv eq ':B') { 4253b00e4814SJoe Perches # skip the bitfield test for now 4254b00e4814SJoe Perches 42551f65f947SAndy Whitcroft # No spaces for: 42561f65f947SAndy Whitcroft # -> 4257b00e4814SJoe Perches } elsif ($op eq '->') { 42584a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 42593705ce5bSJoe Perches if (ERROR("SPACING", 42603705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4261b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 42623705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 42633705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 42643705ce5bSJoe Perches } 4265b34c648bSJoe Perches $line_fixed = 1; 42663705ce5bSJoe Perches } 42670a920b5bSAndy Whitcroft } 42680a920b5bSAndy Whitcroft 42692381097bSJoe Perches # , must not have a space before and must have a space on the right. 42700a920b5bSAndy Whitcroft } elsif ($op eq ',') { 42712381097bSJoe Perches my $rtrim_before = 0; 42722381097bSJoe Perches my $space_after = 0; 42732381097bSJoe Perches if ($ctx =~ /Wx./) { 42742381097bSJoe Perches if (ERROR("SPACING", 42752381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 42762381097bSJoe Perches $line_fixed = 1; 42772381097bSJoe Perches $rtrim_before = 1; 42782381097bSJoe Perches } 42792381097bSJoe Perches } 4280cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 42813705ce5bSJoe Perches if (ERROR("SPACING", 42823705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 42833705ce5bSJoe Perches $line_fixed = 1; 4284b34c648bSJoe Perches $last_after = $n; 42852381097bSJoe Perches $space_after = 1; 42862381097bSJoe Perches } 42872381097bSJoe Perches } 42882381097bSJoe Perches if ($rtrim_before || $space_after) { 42892381097bSJoe Perches if ($rtrim_before) { 42902381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 42912381097bSJoe Perches } else { 42922381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 42932381097bSJoe Perches } 42942381097bSJoe Perches if ($space_after) { 42952381097bSJoe Perches $good .= " "; 42963705ce5bSJoe Perches } 42970a920b5bSAndy Whitcroft } 42980a920b5bSAndy Whitcroft 42999c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 430074048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 43019c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 43029c0ca6f9SAndy Whitcroft 43039c0ca6f9SAndy Whitcroft # unary operators should have a space before and 43049c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 43059c0ca6f9SAndy Whitcroft # unary operator, or a cast 43069c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 430774048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 43080d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4309cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 43103705ce5bSJoe Perches if (ERROR("SPACING", 43113705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4312b34c648bSJoe Perches if ($n != $last_after + 2) { 4313b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 43143705ce5bSJoe Perches $line_fixed = 1; 43153705ce5bSJoe Perches } 43160a920b5bSAndy Whitcroft } 4317b34c648bSJoe Perches } 4318a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4319171ae1a4SAndy Whitcroft # A unary '*' may be const 4320171ae1a4SAndy Whitcroft 4321171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 43223705ce5bSJoe Perches if (ERROR("SPACING", 43233705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4324b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 43253705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 43263705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 43273705ce5bSJoe Perches } 4328b34c648bSJoe Perches $line_fixed = 1; 43293705ce5bSJoe Perches } 43300a920b5bSAndy Whitcroft } 43310a920b5bSAndy Whitcroft 43320a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 43330a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4334773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 43353705ce5bSJoe Perches if (ERROR("SPACING", 43363705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4337b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 43383705ce5bSJoe Perches $line_fixed = 1; 43393705ce5bSJoe Perches } 43400a920b5bSAndy Whitcroft } 4341773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4342773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 43433705ce5bSJoe Perches if (ERROR("SPACING", 43443705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4345b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43463705ce5bSJoe Perches $line_fixed = 1; 43473705ce5bSJoe Perches } 4348653d4876SAndy Whitcroft } 4349773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 43503705ce5bSJoe Perches if (ERROR("SPACING", 43513705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4352b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 43533705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 43543705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4355773647a0SAndy Whitcroft } 4356b34c648bSJoe Perches $line_fixed = 1; 43573705ce5bSJoe Perches } 43583705ce5bSJoe Perches } 43590a920b5bSAndy Whitcroft 43600a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 43619c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 43629c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 43639c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4364c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4365c2fdda0dSAndy Whitcroft $op eq '%') 43660a920b5bSAndy Whitcroft { 4367d2e025f3SJoe Perches if ($check) { 4368d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4369d2e025f3SJoe Perches if (CHK("SPACING", 4370d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4371d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4372d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4373d2e025f3SJoe Perches $line_fixed = 1; 4374d2e025f3SJoe Perches } 4375d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4376d2e025f3SJoe Perches if (CHK("SPACING", 4377d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4378d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4379d2e025f3SJoe Perches $line_fixed = 1; 4380d2e025f3SJoe Perches } 4381d2e025f3SJoe Perches } 4382d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 43833705ce5bSJoe Perches if (ERROR("SPACING", 43843705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4385b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4386b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4387b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4388b34c648bSJoe Perches } 43893705ce5bSJoe Perches $line_fixed = 1; 43903705ce5bSJoe Perches } 43910a920b5bSAndy Whitcroft } 43920a920b5bSAndy Whitcroft 43931f65f947SAndy Whitcroft # A colon needs no spaces before when it is 43941f65f947SAndy Whitcroft # terminating a case value or a label. 43951f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 43961f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 43973705ce5bSJoe Perches if (ERROR("SPACING", 43983705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4399b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 44003705ce5bSJoe Perches $line_fixed = 1; 44013705ce5bSJoe Perches } 44021f65f947SAndy Whitcroft } 44031f65f947SAndy Whitcroft 44040a920b5bSAndy Whitcroft # All the others need spaces both sides. 4405cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 44061f65f947SAndy Whitcroft my $ok = 0; 44071f65f947SAndy Whitcroft 440822f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 44091f65f947SAndy Whitcroft if (($op eq '<' && 44101f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 44111f65f947SAndy Whitcroft ($op eq '>' && 44121f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 44131f65f947SAndy Whitcroft { 44141f65f947SAndy Whitcroft $ok = 1; 44151f65f947SAndy Whitcroft } 44161f65f947SAndy Whitcroft 4417e0df7e1fSJoe Perches # for asm volatile statements 4418e0df7e1fSJoe Perches # ignore a colon with another 4419e0df7e1fSJoe Perches # colon immediately before or after 4420e0df7e1fSJoe Perches if (($op eq ':') && 4421e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4422e0df7e1fSJoe Perches $ok = 1; 4423e0df7e1fSJoe Perches } 4424e0df7e1fSJoe Perches 442584731623SJoe Perches # messages are ERROR, but ?: are CHK 44261f65f947SAndy Whitcroft if ($ok == 0) { 44270675a8fbSJean Delvare my $msg_level = \&ERROR; 44280675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 442984731623SJoe Perches 44300675a8fbSJean Delvare if (&{$msg_level}("SPACING", 44313705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4432b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4433b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4434b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4435b34c648bSJoe Perches } 44363705ce5bSJoe Perches $line_fixed = 1; 44373705ce5bSJoe Perches } 44380a920b5bSAndy Whitcroft } 443922f2a2efSAndy Whitcroft } 44404a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 44413705ce5bSJoe Perches 44423705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 44433705ce5bSJoe Perches 44443705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 44450a920b5bSAndy Whitcroft } 44463705ce5bSJoe Perches 44473705ce5bSJoe Perches if (($#elements % 2) == 0) { 44483705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 44493705ce5bSJoe Perches } 44503705ce5bSJoe Perches 4451194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4452194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 44533705ce5bSJoe Perches } 44543705ce5bSJoe Perches 44553705ce5bSJoe Perches 44560a920b5bSAndy Whitcroft } 44570a920b5bSAndy Whitcroft 4458786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4459d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4460786b6326SJoe Perches if (WARN("SPACING", 4461786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4462786b6326SJoe Perches $fix) { 4463194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4464786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4465786b6326SJoe Perches } 4466786b6326SJoe Perches } 4467786b6326SJoe Perches 4468f0a594c1SAndy Whitcroft# check for multiple assignments 4469f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4470000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4471000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4472f0a594c1SAndy Whitcroft } 4473f0a594c1SAndy Whitcroft 447422f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 447522f2a2efSAndy Whitcroft## # continuation. 447622f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 447722f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 447822f2a2efSAndy Whitcroft## 447922f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 448022f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 448122f2a2efSAndy Whitcroft## my $ln = $line; 448222f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 448322f2a2efSAndy Whitcroft## } 448422f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4485000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4486000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 448722f2a2efSAndy Whitcroft## } 448822f2a2efSAndy Whitcroft## } 4489f0a594c1SAndy Whitcroft 44900a920b5bSAndy Whitcroft#need space before brace following if, while, etc 44916b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 44924e5d56bdSEddie Kovsky $line =~ /do\{/) { 44933705ce5bSJoe Perches if (ERROR("SPACING", 44943705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 44953705ce5bSJoe Perches $fix) { 44968d81ae05SCyril Bur $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/; 44973705ce5bSJoe Perches } 4498de7d4f0eSAndy Whitcroft } 4499de7d4f0eSAndy Whitcroft 4500c4a62ef9SJoe Perches## # check for blank lines before declarations 4501c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4502c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4503c4a62ef9SJoe Perches## WARN("SPACING", 4504c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4505c4a62ef9SJoe Perches## } 4506c4a62ef9SJoe Perches## 4507c4a62ef9SJoe Perches 4508de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4509de7d4f0eSAndy Whitcroft# on the line 4510de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4511d5e616fcSJoe Perches if (ERROR("SPACING", 4512d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4513d5e616fcSJoe Perches $fix) { 4514194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4515d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4516d5e616fcSJoe Perches } 45170a920b5bSAndy Whitcroft } 45180a920b5bSAndy Whitcroft 451922f2a2efSAndy Whitcroft# check spacing on square brackets 452022f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 45213705ce5bSJoe Perches if (ERROR("SPACING", 45223705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 45233705ce5bSJoe Perches $fix) { 4524194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45253705ce5bSJoe Perches s/\[\s+/\[/; 45263705ce5bSJoe Perches } 452722f2a2efSAndy Whitcroft } 452822f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 45293705ce5bSJoe Perches if (ERROR("SPACING", 45303705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 45313705ce5bSJoe Perches $fix) { 4532194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45333705ce5bSJoe Perches s/\s+\]/\]/; 45343705ce5bSJoe Perches } 453522f2a2efSAndy Whitcroft } 453622f2a2efSAndy Whitcroft 4537c45dcabdSAndy Whitcroft# check spacing on parentheses 45389c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 45399c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 45403705ce5bSJoe Perches if (ERROR("SPACING", 45413705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 45423705ce5bSJoe Perches $fix) { 4543194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45443705ce5bSJoe Perches s/\(\s+/\(/; 45453705ce5bSJoe Perches } 454622f2a2efSAndy Whitcroft } 454713214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4548c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4549c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 45503705ce5bSJoe Perches if (ERROR("SPACING", 45513705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 45523705ce5bSJoe Perches $fix) { 4553194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45543705ce5bSJoe Perches s/\s+\)/\)/; 45553705ce5bSJoe Perches } 455622f2a2efSAndy Whitcroft } 455722f2a2efSAndy Whitcroft 4558e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4559e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4560e2826fd0SJoe Perches 4561e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4562ea4acbb1SJoe Perches my $var = $1; 4563ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4564ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4565ea4acbb1SJoe Perches $fix) { 4566ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4567ea4acbb1SJoe Perches } 4568ea4acbb1SJoe Perches } 4569ea4acbb1SJoe Perches 4570ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4571ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4572ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4573ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4574ea4acbb1SJoe Perches my $var = $2; 4575ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4576ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4577ea4acbb1SJoe Perches $fix) { 4578ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4579ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4580ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4581ea4acbb1SJoe Perches } 4582e2826fd0SJoe Perches } 4583e2826fd0SJoe Perches 458463b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 4585a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 4586a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 4587a032aa4cSJoe Perches $^V && $^V ge 5.10.0 && defined($stat) && 458863b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 458963b7c73eSJoe Perches my $if_stat = $1; 459063b7c73eSJoe Perches my $test = substr($2, 1, -1); 459163b7c73eSJoe Perches my $herectx; 459263b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 459363b7c73eSJoe Perches my $match = $1; 459463b7c73eSJoe Perches # avoid parentheses around potential macro args 459563b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 459663b7c73eSJoe Perches if (!defined($herectx)) { 459763b7c73eSJoe Perches $herectx = $here . "\n"; 459863b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 459963b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 460063b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 460163b7c73eSJoe Perches $herectx .= $rl . "\n"; 460263b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 460363b7c73eSJoe Perches } 460463b7c73eSJoe Perches } 460563b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 460663b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 460763b7c73eSJoe Perches } 460863b7c73eSJoe Perches } 460963b7c73eSJoe Perches 46100a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 46114a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 46120a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 46133705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 46143705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 46153705ce5bSJoe Perches $fix) { 4616194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46173705ce5bSJoe Perches s/^(.)\s+/$1/; 46183705ce5bSJoe Perches } 46190a920b5bSAndy Whitcroft } 46200a920b5bSAndy Whitcroft 46215b9553abSJoe Perches# return is not a function 4622507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4623c45dcabdSAndy Whitcroft my $spacing = $1; 4624507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 46255b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 46265b9553abSJoe Perches my $value = $1; 46275b9553abSJoe Perches $value = deparenthesize($value); 46285b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4629000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4630000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 46315b9553abSJoe Perches } 4632c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4633000d1cc1SJoe Perches ERROR("SPACING", 4634000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4635c45dcabdSAndy Whitcroft } 4636c45dcabdSAndy Whitcroft } 4637507e5141SJoe Perches 4638b43ae21bSJoe Perches# unnecessary return in a void function 4639b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4640b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4641b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4642b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4643b43ae21bSJoe Perches $linenr >= 3 && 4644b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4645b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 46469819cf25SJoe Perches WARN("RETURN_VOID", 4647b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 46489819cf25SJoe Perches } 46499819cf25SJoe Perches 4650189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4651189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4652189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4653189248d8SJoe Perches my $openparens = $1; 4654189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4655189248d8SJoe Perches my $msg = ""; 4656189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4657189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4658189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4659189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4660189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4661189248d8SJoe Perches } 4662189248d8SJoe Perches } 4663189248d8SJoe Perches 4664c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4665c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4666c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4667c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 4668c5595fa2SJoe Perches if ($^V && $^V ge 5.10.0 && 4669c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4670c5595fa2SJoe Perches my $lead = $1; 4671c5595fa2SJoe Perches my $const = $2; 4672c5595fa2SJoe Perches my $comp = $3; 4673c5595fa2SJoe Perches my $to = $4; 4674c5595fa2SJoe Perches my $newcomp = $comp; 4675f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 4676c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4677c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4678c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4679c5595fa2SJoe Perches $fix) { 4680c5595fa2SJoe Perches if ($comp eq "<") { 4681c5595fa2SJoe Perches $newcomp = ">"; 4682c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4683c5595fa2SJoe Perches $newcomp = ">="; 4684c5595fa2SJoe Perches } elsif ($comp eq ">") { 4685c5595fa2SJoe Perches $newcomp = "<"; 4686c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4687c5595fa2SJoe Perches $newcomp = "<="; 4688c5595fa2SJoe Perches } 4689c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4690c5595fa2SJoe Perches } 4691c5595fa2SJoe Perches } 4692c5595fa2SJoe Perches 4693f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4694f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 469553a3c448SAndy Whitcroft my $name = $1; 469653a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4697000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4698f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 469953a3c448SAndy Whitcroft } 470053a3c448SAndy Whitcroft } 4701c45dcabdSAndy Whitcroft 47020a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 47034a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 47043705ce5bSJoe Perches if (ERROR("SPACING", 47053705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 47063705ce5bSJoe Perches $fix) { 4707194f66fcSJoe Perches $fixed[$fixlinenr] =~ 47083705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 47093705ce5bSJoe Perches } 47100a920b5bSAndy Whitcroft } 47110a920b5bSAndy Whitcroft 4712f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4713f5fe35ddSAndy Whitcroft# statements after the conditional. 4714170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 47153e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 47163e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 47173e469cdcSAndy Whitcroft if (!defined $stat); 4718170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4719170d3a22SAndy Whitcroft $remain_next, $off_next); 4720170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4721170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4722170d3a22SAndy Whitcroft 4723170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4724170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4725170d3a22SAndy Whitcroft # then count those as offsets. 4726170d3a22SAndy Whitcroft my ($whitespace) = 4727170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4728170d3a22SAndy Whitcroft my $offset = 4729170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4730170d3a22SAndy Whitcroft 4731170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4732170d3a22SAndy Whitcroft $offset} = 1; 4733170d3a22SAndy Whitcroft } 4734170d3a22SAndy Whitcroft } 4735170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4736c11230f4SJoe Perches defined($stat) && defined($cond) && 4737170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4738171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 47398905a67cSAndy Whitcroft 4740b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4741000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4742000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 47438905a67cSAndy Whitcroft } 47448905a67cSAndy Whitcroft 47458905a67cSAndy Whitcroft # Find out what is on the end of the line after the 47468905a67cSAndy Whitcroft # conditional. 4747773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 47488905a67cSAndy Whitcroft $s =~ s/\n.*//g; 474913214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 475053210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 475153210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4752773647a0SAndy Whitcroft { 4753bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4754bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4755bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 475642bdf74cSHidetoshi Seto my $stat_real = ''; 4757bb44ad39SAndy Whitcroft 475842bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 475942bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4760bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4761bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4762bb44ad39SAndy Whitcroft } 4763bb44ad39SAndy Whitcroft 4764000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4765000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 47668905a67cSAndy Whitcroft } 47678905a67cSAndy Whitcroft } 47688905a67cSAndy Whitcroft 476913214adfSAndy Whitcroft# Check for bitwise tests written as boolean 477013214adfSAndy Whitcroft if ($line =~ / 477113214adfSAndy Whitcroft (?: 477213214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 477313214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 477413214adfSAndy Whitcroft (?:\&\&|\|\|) 477513214adfSAndy Whitcroft | 477613214adfSAndy Whitcroft (?:\&\&|\|\|) 477713214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 477813214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 477913214adfSAndy Whitcroft )/x) 478013214adfSAndy Whitcroft { 4781000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4782000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 478313214adfSAndy Whitcroft } 478413214adfSAndy Whitcroft 47858905a67cSAndy Whitcroft# if and else should not have general statements after it 478613214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 478713214adfSAndy Whitcroft my $s = $1; 478813214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 478913214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4790000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4791000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 47920a920b5bSAndy Whitcroft } 479313214adfSAndy Whitcroft } 479439667782SAndy Whitcroft# if should not continue a brace 479539667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4796000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4797048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 479839667782SAndy Whitcroft $herecurr); 479939667782SAndy Whitcroft } 4800a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4801a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4802a1080bf8SAndy Whitcroft $line !~ /\G(?: 48033fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4804a1080bf8SAndy Whitcroft \s*return\s+ 4805a1080bf8SAndy Whitcroft )/xg) 4806a1080bf8SAndy Whitcroft { 4807000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4808000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4809a1080bf8SAndy Whitcroft } 48100a920b5bSAndy Whitcroft 48110a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 48120a920b5bSAndy Whitcroft # indent level to be relevant to each other. 48138b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 48140a920b5bSAndy Whitcroft $previndent == $indent) { 48158b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 48168b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 48178b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 48188b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48198b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 48208b8856f4SJoe Perches my $fixedline = $prevrawline; 48218b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 48228b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 48238b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48248b8856f4SJoe Perches } 48258b8856f4SJoe Perches $fixedline = $rawline; 48268b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 48278b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48288b8856f4SJoe Perches } 48290a920b5bSAndy Whitcroft } 48300a920b5bSAndy Whitcroft 48318b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4832c2fdda0dSAndy Whitcroft $previndent == $indent) { 4833c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4834c2fdda0dSAndy Whitcroft 4835c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4836c2fdda0dSAndy Whitcroft # conditional. 4837773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4838c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4839c2fdda0dSAndy Whitcroft 4840c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 48418b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 48428b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 48438b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 48448b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48458b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 48468b8856f4SJoe Perches my $fixedline = $prevrawline; 48478b8856f4SJoe Perches my $trailing = $rawline; 48488b8856f4SJoe Perches $trailing =~ s/^\+//; 48498b8856f4SJoe Perches $trailing = trim($trailing); 48508b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 48518b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48528b8856f4SJoe Perches } 4853c2fdda0dSAndy Whitcroft } 4854c2fdda0dSAndy Whitcroft } 4855c2fdda0dSAndy Whitcroft 485695e2c602SJoe Perches#Specific variable tests 4857323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4858323c1260SJoe Perches my $var = $1; 485995e2c602SJoe Perches 486095e2c602SJoe Perches#gcc binary extension 486195e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4862d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4863d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4864d5e616fcSJoe Perches $fix) { 4865d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4866194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4867d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4868d5e616fcSJoe Perches } 486995e2c602SJoe Perches } 487095e2c602SJoe Perches 487195e2c602SJoe Perches#CamelCase 4872807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4873be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 487422735ce8SJoe Perches#Ignore Page<foo> variants 4875807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 487622735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4877f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4878f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4879f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 48807e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 48817e781f67SJoe Perches my $word = $1; 48827e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4883d8b07710SJoe Perches if ($check) { 4884d8b07710SJoe Perches seed_camelcase_includes(); 4885d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4886d8b07710SJoe Perches seed_camelcase_file($realfile); 4887d8b07710SJoe Perches $camelcase_file_seeded = 1; 4888d8b07710SJoe Perches } 4889d8b07710SJoe Perches } 48907e781f67SJoe Perches if (!defined $camelcase{$word}) { 48917e781f67SJoe Perches $camelcase{$word} = 1; 4892be79794bSJoe Perches CHK("CAMELCASE", 48937e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 48947e781f67SJoe Perches } 4895323c1260SJoe Perches } 4896323c1260SJoe Perches } 48973445686aSJoe Perches } 48980a920b5bSAndy Whitcroft 48990a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4900d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4901d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4902d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4903d5e616fcSJoe Perches $fix) { 4904194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4905d5e616fcSJoe Perches } 49060a920b5bSAndy Whitcroft } 49070a920b5bSAndy Whitcroft 49080e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 49090e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4910c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4911e09dec48SAndy Whitcroft my $file = "$1.h"; 4912e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4913e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4914e09dec48SAndy Whitcroft $realfile ne $checkfile && 49157840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4916c45dcabdSAndy Whitcroft { 49170e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 49180e212e0aSFabian Frederick if ($asminclude > 0) { 4919e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4920000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4921000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4922e09dec48SAndy Whitcroft } else { 4923000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4924000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4925e09dec48SAndy Whitcroft } 49260a920b5bSAndy Whitcroft } 49270a920b5bSAndy Whitcroft } 49280e212e0aSFabian Frederick } 49290a920b5bSAndy Whitcroft 4930653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4931653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4932cf655043SAndy Whitcroft# in a known good container 4933b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4934b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4935d8aaf121SAndy Whitcroft my $ln = $linenr; 4936d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4937c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4938c45dcabdSAndy Whitcroft my $ctx = ''; 493908a2843eSJoe Perches my $has_flow_statement = 0; 494008a2843eSJoe Perches my $has_arg_concat = 0; 4941c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4942f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4943f74bd194SAndy Whitcroft $ctx = $dstat; 4944c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4945a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4946c45dcabdSAndy Whitcroft 494708a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 494862e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 494908a2843eSJoe Perches 4950f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 4951f59b64bfSJoe Perches my $define_args = $1; 4952f59b64bfSJoe Perches my $define_stmt = $dstat; 4953f59b64bfSJoe Perches my @def_args = (); 4954f59b64bfSJoe Perches 4955f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 4956f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 4957f59b64bfSJoe Perches $define_args =~ s/\s*//g; 4958f59b64bfSJoe Perches @def_args = split(",", $define_args); 4959f59b64bfSJoe Perches } 4960f59b64bfSJoe Perches 4961292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4962c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4963c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4964c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4965c45dcabdSAndy Whitcroft 4966c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4967bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4968bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 49696b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 4970bf30d6edSAndy Whitcroft { 4971c45dcabdSAndy Whitcroft } 4972c45dcabdSAndy Whitcroft 4973e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 497433acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 497533acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 4976e45bab8eSAndy Whitcroft { 4977e45bab8eSAndy Whitcroft } 4978e45bab8eSAndy Whitcroft 497942e15293SJoe Perches # Make asm volatile uses seem like a generic function 498042e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 498142e15293SJoe Perches 4982c45dcabdSAndy Whitcroft my $exceptions = qr{ 4983c45dcabdSAndy Whitcroft $Declare| 4984c45dcabdSAndy Whitcroft module_param_named| 4985a0a0a7a9SKees Cook MODULE_PARM_DESC| 4986c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4987c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4988383099fdSAndy Whitcroft __typeof__\(| 498922fd2d3eSStefani Seibold union| 499022fd2d3eSStefani Seibold struct| 4991ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 49926b10df42SVladimir Zapolskiy ^\"|\"$| 49936b10df42SVladimir Zapolskiy ^\[ 4994c45dcabdSAndy Whitcroft }x; 49955eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4996f59b64bfSJoe Perches 4997f59b64bfSJoe Perches $ctx =~ s/\n*$//; 4998f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 4999e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 5000f59b64bfSJoe Perches 5001f74bd194SAndy Whitcroft if ($dstat ne '' && 5002f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 5003f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 50043cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 5005356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5006f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 5007f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 5008e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 500972f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 5010f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 5011f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5012f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 50134e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 5014f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5015c45dcabdSAndy Whitcroft { 5016e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 5017e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5018e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5019e795556aSJoe Perches } elsif ($dstat =~ /;/) { 5020f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5021f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5022f74bd194SAndy Whitcroft } else { 5023000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 5024388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5025d8aaf121SAndy Whitcroft } 5026f59b64bfSJoe Perches 5027f59b64bfSJoe Perches } 50285207649bSJoe Perches 50295207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 50305207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 50315207649bSJoe Perches my $first = 1; 50325207649bSJoe Perches $define_stmt = ""; 50335207649bSJoe Perches foreach my $l (@stmt_array) { 50345207649bSJoe Perches $l =~ s/\\$//; 50355207649bSJoe Perches if ($first) { 50365207649bSJoe Perches $define_stmt = $l; 50375207649bSJoe Perches $first = 0; 50385207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 50395207649bSJoe Perches $define_stmt .= substr($l, 1); 50405207649bSJoe Perches } 50415207649bSJoe Perches } 50425207649bSJoe Perches $define_stmt =~ s/$;//g; 50435207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 50445207649bSJoe Perches $define_stmt = trim($define_stmt); 50455207649bSJoe Perches 5046f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5047f59b64bfSJoe Perches foreach my $arg (@def_args) { 5048f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 50499192d41aSJoe Perches next if ($arg =~ /^type$/i); 50507fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 50517fe528a2SJoe Perches $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 50527fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 50537fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 5054d41362edSJoe Perches my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 5055f59b64bfSJoe Perches if ($use_cnt > 1) { 5056f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5057f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5058f59b64bfSJoe Perches } 50599192d41aSJoe Perches# check if any macro arguments may have other precedence issues 50607fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 50619192d41aSJoe Perches ((defined($1) && $1 ne ',') || 50629192d41aSJoe Perches (defined($2) && $2 ne ','))) { 50639192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 50649192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 50659192d41aSJoe Perches } 50660a920b5bSAndy Whitcroft } 50675023d347SJoe Perches 506808a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 506908a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 507008a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 507108a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 5072e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 507308a2843eSJoe Perches 507408a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 507508a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 507608a2843eSJoe Perches } 507708a2843eSJoe Perches 5078481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 50795023d347SJoe Perches 50805023d347SJoe Perches } else { 50815023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5082481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5083481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 50845023d347SJoe Perches $line =~ /^\+.*\\$/) { 50855023d347SJoe Perches WARN("LINE_CONTINUATIONS", 50865023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 50875023d347SJoe Perches } 5088653d4876SAndy Whitcroft } 50890a920b5bSAndy Whitcroft 5090b13edf7fSJoe Perches# do {} while (0) macro tests: 5091b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5092b13edf7fSJoe Perches# macro should not end with a semicolon 5093b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 5094b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5095b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5096b13edf7fSJoe Perches my $ln = $linenr; 5097b13edf7fSJoe Perches my $cnt = $realcnt; 5098b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5099b13edf7fSJoe Perches my $ctx = ''; 5100b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5101b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5102b13edf7fSJoe Perches $ctx = $dstat; 5103b13edf7fSJoe Perches 5104b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 51051b36b201SJoe Perches $dstat =~ s/$;/ /g; 5106b13edf7fSJoe Perches 5107b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5108b13edf7fSJoe Perches my $stmts = $2; 5109b13edf7fSJoe Perches my $semis = $3; 5110b13edf7fSJoe Perches 5111b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5112b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5113e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5114b13edf7fSJoe Perches 5115ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5116ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5117b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5118b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5119b13edf7fSJoe Perches } 5120b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5121b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5122b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5123b13edf7fSJoe Perches } 5124f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5125f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5126f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5127e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5128f5ef95b1SJoe Perches 5129f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5130f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5131b13edf7fSJoe Perches } 5132b13edf7fSJoe Perches } 5133b13edf7fSJoe Perches 5134f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 513513214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 513613214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5137cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 513813214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5139cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5140cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5141aad4f614SJoe Perches my @allowed = (); 5142aad4f614SJoe Perches my $allow = 0; 514313214adfSAndy Whitcroft my $seen = 0; 5144773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5145cf655043SAndy Whitcroft my $ln = $linenr - 1; 514613214adfSAndy Whitcroft for my $chunk (@chunks) { 514713214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 514813214adfSAndy Whitcroft 5149773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5150773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5151773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 5152773647a0SAndy Whitcroft 5153aad4f614SJoe Perches $allowed[$allow] = 0; 5154773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5155773647a0SAndy Whitcroft 5156773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 5157773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 5158773647a0SAndy Whitcroft 5159773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5160cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 5161cf655043SAndy Whitcroft 5162773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 516313214adfSAndy Whitcroft 516413214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 516513214adfSAndy Whitcroft 5166aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5167cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5168cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5169aad4f614SJoe Perches $allowed[$allow] = 1; 517013214adfSAndy Whitcroft } 517113214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5172cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5173aad4f614SJoe Perches $allowed[$allow] = 1; 517413214adfSAndy Whitcroft } 5175cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5176cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5177aad4f614SJoe Perches $allowed[$allow] = 1; 517813214adfSAndy Whitcroft } 5179aad4f614SJoe Perches $allow++; 518013214adfSAndy Whitcroft } 5181aad4f614SJoe Perches if ($seen) { 5182aad4f614SJoe Perches my $sum_allowed = 0; 5183aad4f614SJoe Perches foreach (@allowed) { 5184aad4f614SJoe Perches $sum_allowed += $_; 5185aad4f614SJoe Perches } 5186aad4f614SJoe Perches if ($sum_allowed == 0) { 5187000d1cc1SJoe Perches WARN("BRACES", 5188000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 5189aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 5190aad4f614SJoe Perches $seen != $allow) { 5191aad4f614SJoe Perches CHK("BRACES", 5192aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 5193aad4f614SJoe Perches } 519413214adfSAndy Whitcroft } 519513214adfSAndy Whitcroft } 519613214adfSAndy Whitcroft } 5197773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 519813214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 5199cf655043SAndy Whitcroft my $allowed = 0; 5200f0a594c1SAndy Whitcroft 5201cf655043SAndy Whitcroft # Check the pre-context. 5202cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 5203cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 5204cf655043SAndy Whitcroft $allowed = 1; 5205f0a594c1SAndy Whitcroft } 5206773647a0SAndy Whitcroft 5207773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 5208773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 5209773647a0SAndy Whitcroft 5210cf655043SAndy Whitcroft # Check the condition. 5211cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 5212773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 5213cf655043SAndy Whitcroft if (defined $cond) { 5214773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5215cf655043SAndy Whitcroft } 5216cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5217cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5218cf655043SAndy Whitcroft $allowed = 1; 5219cf655043SAndy Whitcroft } 5220cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5221cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5222cf655043SAndy Whitcroft $allowed = 1; 5223cf655043SAndy Whitcroft } 5224cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5225cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5226cf655043SAndy Whitcroft $allowed = 1; 5227cf655043SAndy Whitcroft } 5228cf655043SAndy Whitcroft # Check the post-context. 5229cf655043SAndy Whitcroft if (defined $chunks[1]) { 5230cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 5231cf655043SAndy Whitcroft if (defined $cond) { 5232773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5233cf655043SAndy Whitcroft } 5234cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 5235cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5236cf655043SAndy Whitcroft $allowed = 1; 5237cf655043SAndy Whitcroft } 5238cf655043SAndy Whitcroft } 5239cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 5240f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 5241e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 5242cf655043SAndy Whitcroft 5243000d1cc1SJoe Perches WARN("BRACES", 5244000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 5245f0a594c1SAndy Whitcroft } 5246f0a594c1SAndy Whitcroft } 5247f0a594c1SAndy Whitcroft 5248e4c5babdSJoe Perches# check for single line unbalanced braces 524995330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 525095330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 5251e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 5252e4c5babdSJoe Perches } 5253e4c5babdSJoe Perches 52540979ae66SJoe Perches# check for unnecessary blank lines around braces 525577b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5256f8e58219SJoe Perches if (CHK("BRACES", 5257f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5258f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 5259f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5260f8e58219SJoe Perches } 52610979ae66SJoe Perches } 526277b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5263f8e58219SJoe Perches if (CHK("BRACES", 5264f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5265f8e58219SJoe Perches $fix) { 5266f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 5267f8e58219SJoe Perches } 52680979ae66SJoe Perches } 52690979ae66SJoe Perches 52704a0df2efSAndy Whitcroft# no volatiles please 52716c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 52726c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5273000d1cc1SJoe Perches WARN("VOLATILE", 52748c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 52754a0df2efSAndy Whitcroft } 52764a0df2efSAndy Whitcroft 52775e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 52785e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 52795e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 52805e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 528133acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 52825e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 52835e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 52845e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 52855e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 52865e4f6ba5SJoe Perches $fix && 52875e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 52885e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 52895e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 52905e4f6ba5SJoe Perches my $comma_close = ""; 52915e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 52925e4f6ba5SJoe Perches $comma_close = $1; 52935e4f6ba5SJoe Perches } 52945e4f6ba5SJoe Perches 52955e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 52965e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 52975e4f6ba5SJoe Perches my $fixedline = $prevrawline; 52985e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 52995e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 53005e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 53015e4f6ba5SJoe Perches $fixedline = $rawline; 53025e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 53035e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 53045e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 53055e4f6ba5SJoe Perches } 53065e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 53075e4f6ba5SJoe Perches } 53085e4f6ba5SJoe Perches } 53095e4f6ba5SJoe Perches 53105e4f6ba5SJoe Perches# check for missing a space in a string concatenation 53115e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 53125e4f6ba5SJoe Perches WARN('MISSING_SPACE', 53135e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 53145e4f6ba5SJoe Perches } 53155e4f6ba5SJoe Perches 531677cb8546SJoe Perches# check for an embedded function name in a string when the function is known 5317e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 5318e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 5319e4b7d309SJoe Perches# function declarations 532077cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 532177cb8546SJoe Perches defined($context_function) && 5322e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 5323e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 532477cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 5325e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 532677cb8546SJoe Perches } 532777cb8546SJoe Perches 53285e4f6ba5SJoe Perches# check for spaces before a quoted newline 53295e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 53305e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 53315e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 53325e4f6ba5SJoe Perches $fix) { 53335e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 53345e4f6ba5SJoe Perches } 53355e4f6ba5SJoe Perches 53365e4f6ba5SJoe Perches } 53375e4f6ba5SJoe Perches 5338f17dba4fSJoe Perches# concatenated string without spaces between elements 533933acb54aSJoe Perches if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) { 5340f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 5341f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 5342f17dba4fSJoe Perches } 5343f17dba4fSJoe Perches 534490ad30e5SJoe Perches# uncoalesced string fragments 534533acb54aSJoe Perches if ($line =~ /$String\s*"/) { 534690ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 534790ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 534890ad30e5SJoe Perches } 534990ad30e5SJoe Perches 5350522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 5351522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 5352522b837cSAlexey Dobriyan my $show_Z = 1; 53535e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 5354522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 53555e4f6ba5SJoe Perches $string =~ s/%%/__/g; 5356522b837cSAlexey Dobriyan # check for %L 5357522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 53585e4f6ba5SJoe Perches WARN("PRINTF_L", 5359522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 5360522b837cSAlexey Dobriyan $show_L = 0; 53615e4f6ba5SJoe Perches } 5362522b837cSAlexey Dobriyan # check for %Z 5363522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 5364522b837cSAlexey Dobriyan WARN("PRINTF_Z", 5365522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 5366522b837cSAlexey Dobriyan $show_Z = 0; 5367522b837cSAlexey Dobriyan } 5368522b837cSAlexey Dobriyan # check for 0x<decimal> 5369522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 5370522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 53716e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 53726e300757SJoe Perches } 53735e4f6ba5SJoe Perches } 53745e4f6ba5SJoe Perches 53755e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 53763f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 53775e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 53785e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 53795e4f6ba5SJoe Perches } 53805e4f6ba5SJoe Perches 538100df344fSAndy Whitcroft# warn about #if 0 5382c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 5383000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 5384000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 5385de7d4f0eSAndy Whitcroft $herecurr); 53864a0df2efSAndy Whitcroft } 53874a0df2efSAndy Whitcroft 538803df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 538903df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5390100425deSJoe Perches my $tested = quotemeta($1); 5391100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5392100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5393100425deSJoe Perches my $func = $1; 5394100425deSJoe Perches if (WARN('NEEDLESS_IF', 5395100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5396100425deSJoe Perches $fix) { 5397100425deSJoe Perches my $do_fix = 1; 5398100425deSJoe Perches my $leading_tabs = ""; 5399100425deSJoe Perches my $new_leading_tabs = ""; 5400100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5401100425deSJoe Perches $leading_tabs = $1; 5402100425deSJoe Perches } else { 5403100425deSJoe Perches $do_fix = 0; 5404100425deSJoe Perches } 5405100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5406100425deSJoe Perches $new_leading_tabs = $1; 5407100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5408100425deSJoe Perches $do_fix = 0; 5409100425deSJoe Perches } 5410100425deSJoe Perches } else { 5411100425deSJoe Perches $do_fix = 0; 5412100425deSJoe Perches } 5413100425deSJoe Perches if ($do_fix) { 5414100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5415100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5416100425deSJoe Perches } 5417100425deSJoe Perches } 54184c432a8fSGreg Kroah-Hartman } 54194c432a8fSGreg Kroah-Hartman } 5420f0a594c1SAndy Whitcroft 5421ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5422ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5423ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5424ebfdc409SJoe Perches (defined $1 || defined $3) && 5425ebfdc409SJoe Perches $linenr > 3) { 5426ebfdc409SJoe Perches my $testval = $2; 5427ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5428ebfdc409SJoe Perches 5429ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5430ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5431ebfdc409SJoe Perches 5432fb0d0e08SJoe 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)/) { 5433ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5434ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5435ebfdc409SJoe Perches } 5436ebfdc409SJoe Perches } 5437ebfdc409SJoe Perches 5438f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5439dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5440f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5441f78d98f6SJoe Perches my $level = $1; 5442f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5443f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5444f78d98f6SJoe Perches $fix) { 5445f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5446f78d98f6SJoe Perches } 5447f78d98f6SJoe Perches } 5448f78d98f6SJoe Perches 544945c55e92SJoe Perches# check for logging continuations 545045c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 545145c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 545245c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 545345c55e92SJoe Perches } 545445c55e92SJoe Perches 5455abb08a53SJoe Perches# check for mask then right shift without a parentheses 5456abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 5457abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5458abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5459abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5460abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5461abb08a53SJoe Perches } 5462abb08a53SJoe Perches 5463b75ac618SJoe Perches# check for pointer comparisons to NULL 5464b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 5465b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5466b75ac618SJoe Perches my $val = $1; 5467b75ac618SJoe Perches my $equal = "!"; 5468b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5469b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5470b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5471b75ac618SJoe Perches $fix) { 5472b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5473b75ac618SJoe Perches } 5474b75ac618SJoe Perches } 5475b75ac618SJoe Perches } 5476b75ac618SJoe Perches 54778716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 54788716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 54798716de38SJoe Perches my $attr = $1; 54808716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 54818716de38SJoe Perches my $ptr = $1; 54828716de38SJoe Perches my $var = $2; 54838716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 54848716de38SJoe Perches ERROR("MISPLACED_INIT", 54858716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 54868716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 54878716de38SJoe Perches WARN("MISPLACED_INIT", 54888716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 54898716de38SJoe Perches $fix) { 5490194f66fcSJoe 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; 54918716de38SJoe Perches } 54928716de38SJoe Perches } 54938716de38SJoe Perches } 54948716de38SJoe Perches 5495e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5496e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5497e970b884SJoe Perches my $attr = $1; 5498e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5499e970b884SJoe Perches my $attr_prefix = $1; 5500e970b884SJoe Perches my $attr_type = $2; 5501e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5502e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5503e970b884SJoe Perches $fix) { 5504194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5505e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5506e970b884SJoe Perches } 5507e970b884SJoe Perches } 5508e970b884SJoe Perches 5509e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5510e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5511e970b884SJoe Perches my $attr = $1; 5512e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5513e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5514e970b884SJoe Perches $fix) { 5515194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5516e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5517e970b884SJoe Perches $lead = rtrim($1); 5518e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5519e970b884SJoe Perches $lead = "${lead}const "; 5520194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5521e970b884SJoe Perches } 5522e970b884SJoe Perches } 5523e970b884SJoe Perches 5524c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5525c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5526c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5527c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5528c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5529c17893c7SJoe Perches $fix) { 5530c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5531c17893c7SJoe Perches } 5532c17893c7SJoe Perches } 5533c17893c7SJoe Perches 5534fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5535fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5536fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5537fbdb8138SJoe Perches my $constant_func = $1; 5538fbdb8138SJoe Perches my $func = $constant_func; 5539fbdb8138SJoe Perches $func =~ s/^__constant_//; 5540fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5541fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5542fbdb8138SJoe Perches $fix) { 5543194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5544fbdb8138SJoe Perches } 5545fbdb8138SJoe Perches } 5546fbdb8138SJoe Perches 55471a15a250SPatrick Pannuto# prefer usleep_range over udelay 554837581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 554943c1d77cSJoe Perches my $delay = $1; 55501a15a250SPatrick Pannuto # ignore udelay's < 10, however 555143c1d77cSJoe Perches if (! ($delay < 10) ) { 5552000d1cc1SJoe Perches CHK("USLEEP_RANGE", 555343c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 555443c1d77cSJoe Perches } 555543c1d77cSJoe Perches if ($delay > 2000) { 555643c1d77cSJoe Perches WARN("LONG_UDELAY", 555743c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 55581a15a250SPatrick Pannuto } 55591a15a250SPatrick Pannuto } 55601a15a250SPatrick Pannuto 556109ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 556209ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 556309ef8725SPatrick Pannuto if ($1 < 20) { 5564000d1cc1SJoe Perches WARN("MSLEEP", 556543c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 556609ef8725SPatrick Pannuto } 556709ef8725SPatrick Pannuto } 556809ef8725SPatrick Pannuto 556936ec1939SJoe Perches# check for comparisons of jiffies 557036ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 557136ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 557236ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 557336ec1939SJoe Perches } 557436ec1939SJoe Perches 55759d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 55769d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 55779d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 55789d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 55799d7a34a5SJoe Perches } 55809d7a34a5SJoe Perches 558100df344fSAndy Whitcroft# warn about #ifdefs in C files 5582c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 558300df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 558400df344fSAndy Whitcroft# print "$herecurr"; 558500df344fSAndy Whitcroft# $clean = 0; 558600df344fSAndy Whitcroft# } 558700df344fSAndy Whitcroft 558822f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5589c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 55903705ce5bSJoe Perches if (ERROR("SPACING", 55913705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 55923705ce5bSJoe Perches $fix) { 5593194f66fcSJoe Perches $fixed[$fixlinenr] =~ 55943705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 55953705ce5bSJoe Perches } 55963705ce5bSJoe Perches 559722f2a2efSAndy Whitcroft } 559822f2a2efSAndy Whitcroft 55994a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5600171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5601171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 56024a0df2efSAndy Whitcroft my $which = $1; 56034a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5604000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5605000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 56064a0df2efSAndy Whitcroft } 56074a0df2efSAndy Whitcroft } 56084a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5609402c2553SMichael S. Tsirkin 5610402c2553SMichael S. Tsirkin my $barriers = qr{ 5611402c2553SMichael S. Tsirkin mb| 5612402c2553SMichael S. Tsirkin rmb| 5613402c2553SMichael S. Tsirkin wmb| 5614402c2553SMichael S. Tsirkin read_barrier_depends 5615402c2553SMichael S. Tsirkin }x; 5616402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5617402c2553SMichael S. Tsirkin mb__before_atomic| 5618402c2553SMichael S. Tsirkin mb__after_atomic| 5619402c2553SMichael S. Tsirkin store_release| 5620402c2553SMichael S. Tsirkin load_acquire| 5621402c2553SMichael S. Tsirkin store_mb| 5622402c2553SMichael S. Tsirkin (?:$barriers) 5623402c2553SMichael S. Tsirkin }x; 5624402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5625402c2553SMichael S. Tsirkin (?:$barriers)| 562643e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 562743e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5628402c2553SMichael S. Tsirkin }x; 5629402c2553SMichael S. Tsirkin 5630402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 56314a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5632c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5633000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 56344a0df2efSAndy Whitcroft } 56354a0df2efSAndy Whitcroft } 56363ad81779SPaul E. McKenney 5637f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5638f4073b0fSMichael S. Tsirkin 5639f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5640f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5641f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5642f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5643f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5644f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5645f4073b0fSMichael S. Tsirkin } 5646f4073b0fSMichael S. Tsirkin 5647cb426e99SJoe Perches# check for waitqueue_active without a comment. 5648cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5649cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5650cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5651cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5652cb426e99SJoe Perches } 5653cb426e99SJoe Perches } 56543ad81779SPaul E. McKenney 565591db2592SPaul E. McKenney# check for smp_read_barrier_depends and read_barrier_depends 565691db2592SPaul E. McKenney if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) { 565791db2592SPaul E. McKenney WARN("READ_BARRIER_DEPENDS", 565891db2592SPaul E. McKenney "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr); 565991db2592SPaul E. McKenney } 566091db2592SPaul E. McKenney 56614a0df2efSAndy Whitcroft# check of hardware specific defines 5662c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5663000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5664000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 56650a920b5bSAndy Whitcroft } 5666653d4876SAndy Whitcroft 5667596ed45bSJoe Perches# check that the storage class is not after a type 5668596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 5669000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5670596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 5671596ed45bSJoe Perches } 5672596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 5673596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 5674596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 5675596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 5676596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 5677596ed45bSJoe Perches WARN("STORAGE_CLASS", 5678596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 5679d4977c78STobias Klauser } 5680d4977c78STobias Klauser 5681de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5682de7d4f0eSAndy Whitcroft# storage class and type. 56839c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 56849c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5685000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5686000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5687de7d4f0eSAndy Whitcroft } 5688de7d4f0eSAndy Whitcroft 56898905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 56902b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 56912b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5692d5e616fcSJoe Perches if (WARN("INLINE", 5693d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5694d5e616fcSJoe Perches $fix) { 5695194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5696d5e616fcSJoe Perches 5697d5e616fcSJoe Perches } 56988905a67cSAndy Whitcroft } 56998905a67cSAndy Whitcroft 57003d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 57012b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57022b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5703000d1cc1SJoe Perches WARN("PREFER_PACKED", 5704000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 57053d130fd0SJoe Perches } 57063d130fd0SJoe Perches 570739b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 57082b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57092b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5710000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5711000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 571239b7e287SJoe Perches } 571339b7e287SJoe Perches 57145f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 57152b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57162b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5717d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5718d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5719d5e616fcSJoe Perches $fix) { 5720194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5721d5e616fcSJoe Perches 5722d5e616fcSJoe Perches } 57235f14d3bdSJoe Perches } 57245f14d3bdSJoe Perches 57256061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 57262b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57272b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5728d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5729d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5730d5e616fcSJoe Perches $fix) { 5731194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5732d5e616fcSJoe Perches } 57336061d949SJoe Perches } 57346061d949SJoe Perches 5735619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 5736619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 5737619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5738619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5739619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5740619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5741619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5742619a908aSJoe Perches } 5743619a908aSJoe Perches 5744fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 5745e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5746fd39f904STomas Winkler $realfile !~ m@\btools/@ && 5747e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5748e6176fa4SJoe Perches my $type = $1; 5749e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5750e6176fa4SJoe Perches $type = $1; 5751e6176fa4SJoe Perches my $kernel_type = 'u'; 5752e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5753e6176fa4SJoe Perches $type =~ /(\d+)/; 5754e6176fa4SJoe Perches $kernel_type .= $1; 5755e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5756e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5757e6176fa4SJoe Perches $fix) { 5758e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5759e6176fa4SJoe Perches } 5760e6176fa4SJoe Perches } 5761e6176fa4SJoe Perches } 5762e6176fa4SJoe Perches 5763938224b5SJoe Perches# check for cast of C90 native int or longer types constants 5764938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 5765938224b5SJoe Perches my $cast = $1; 5766938224b5SJoe Perches my $const = $2; 5767938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 5768938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 5769938224b5SJoe Perches $fix) { 5770938224b5SJoe Perches my $suffix = ""; 5771938224b5SJoe Perches my $newconst = $const; 5772938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 5773938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 5774938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 5775938224b5SJoe Perches $suffix .= 'LL'; 5776938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 5777938224b5SJoe Perches $suffix .= 'L'; 5778938224b5SJoe Perches } 5779938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 5780938224b5SJoe Perches } 5781938224b5SJoe Perches } 5782938224b5SJoe Perches 57838f53a9b8SJoe Perches# check for sizeof(&) 57848f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5785000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5786000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 57878f53a9b8SJoe Perches } 57888f53a9b8SJoe Perches 578966c80b60SJoe Perches# check for sizeof without parenthesis 579066c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5791d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5792d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5793d5e616fcSJoe Perches $fix) { 5794194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5795d5e616fcSJoe Perches } 579666c80b60SJoe Perches } 579766c80b60SJoe Perches 579888982feaSJoe Perches# check for struct spinlock declarations 579988982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 580088982feaSJoe Perches WARN("USE_SPINLOCK_T", 580188982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 580288982feaSJoe Perches } 580388982feaSJoe Perches 5804a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 580506668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5806a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5807caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5808caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5809d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5810d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5811d5e616fcSJoe Perches $fix) { 5812194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5813d5e616fcSJoe Perches } 5814a6962d72SJoe Perches } 5815a6962d72SJoe Perches } 5816a6962d72SJoe Perches 58170b523769SJoe Perches# check for vsprintf extension %p<foo> misuses 58180b523769SJoe Perches if ($^V && $^V ge 5.10.0 && 58190b523769SJoe Perches defined $stat && 58200b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 58210b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 5822e3c6bc95STobin C. Harding my $specifier; 5823e3c6bc95STobin C. Harding my $extension; 5824e3c6bc95STobin C. Harding my $bad_specifier = ""; 5825e3c6bc95STobin C. Harding my $stat_real; 5826e3c6bc95STobin C. Harding 58270b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 58280b523769SJoe Perches $lc = $lc + $linenr; 58290b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 58300b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 58310b523769SJoe Perches $fmt =~ s/%%//g; 5832e3c6bc95STobin C. Harding 5833e3c6bc95STobin C. Harding while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) { 5834e3c6bc95STobin C. Harding $specifier = $1; 5835e3c6bc95STobin C. Harding $extension = $2; 5836e3c6bc95STobin C. Harding if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOx]/) { 5837e3c6bc95STobin C. Harding $bad_specifier = $specifier; 58380b523769SJoe Perches last; 58390b523769SJoe Perches } 5840e3c6bc95STobin C. Harding if ($extension eq "x" && !defined($stat_real)) { 5841e3c6bc95STobin C. Harding if (!defined($stat_real)) { 5842e3c6bc95STobin C. Harding $stat_real = get_stat_real($linenr, $lc); 58430b523769SJoe Perches } 5844e3c6bc95STobin C. Harding WARN("VSPRINTF_SPECIFIER_PX", 5845e3c6bc95STobin 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"); 5846e3c6bc95STobin C. Harding } 5847e3c6bc95STobin C. Harding } 5848e3c6bc95STobin C. Harding if ($bad_specifier ne "") { 58492a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 58501df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 58511df7338aSSergey Senozhatsky my $use = ""; 5852e3c6bc95STobin C. Harding if ($bad_specifier =~ /p[Ff]/) { 58531df7338aSSergey Senozhatsky $ext_type = "Deprecated"; 58541df7338aSSergey Senozhatsky $use = " - use %pS instead"; 5855e3c6bc95STobin C. Harding $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 58561df7338aSSergey Senozhatsky } 58572a9f9d85STobin C. Harding 58580b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 5859e3c6bc95STobin C. Harding "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 5860e3c6bc95STobin C. Harding } 58610b523769SJoe Perches } 58620b523769SJoe Perches } 58630b523769SJoe Perches 5864554e165cSAndy Whitcroft# Check for misused memsets 5865d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5866d1fe9c09SJoe Perches defined $stat && 58679e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5868554e165cSAndy Whitcroft 5869d7c76ba7SJoe Perches my $ms_addr = $2; 5870d1fe9c09SJoe Perches my $ms_val = $7; 5871d1fe9c09SJoe Perches my $ms_size = $12; 5872d7c76ba7SJoe Perches 5873554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5874554e165cSAndy Whitcroft ERROR("MEMSET", 5875d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5876554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5877554e165cSAndy Whitcroft WARN("MEMSET", 5878d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5879d7c76ba7SJoe Perches } 5880d7c76ba7SJoe Perches } 5881d7c76ba7SJoe Perches 588298a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 5883f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5884f333195dSJoe Perches# defined $stat && 5885f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5886f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 5887f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 5888f333195dSJoe Perches# $fix) { 5889f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 5890f333195dSJoe Perches# } 5891f333195dSJoe Perches# } 589298a9bba5SJoe Perches 5893b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 5894f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5895f333195dSJoe Perches# defined $stat && 5896f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5897f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 5898f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5899f333195dSJoe Perches# } 5900b6117d17SMateusz Kulikowski 59018617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 59028617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 5903f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5904f333195dSJoe Perches# defined $stat && 5905f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5906f333195dSJoe Perches# 5907f333195dSJoe Perches# my $ms_val = $7; 5908f333195dSJoe Perches# 5909f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 5910f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 5911f333195dSJoe Perches# "Prefer eth_zero_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_zero_addr($2)/; 5914f333195dSJoe Perches# } 5915f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 5916f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 5917f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 5918f333195dSJoe Perches# $fix) { 5919f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 5920f333195dSJoe Perches# } 5921f333195dSJoe Perches# } 5922f333195dSJoe Perches# } 59238617cd09SMateusz Kulikowski 5924d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5925d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5926d1fe9c09SJoe Perches defined $stat && 5927d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5928d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5929d7c76ba7SJoe Perches my $call = $1; 5930d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5931d7c76ba7SJoe Perches my $arg1 = $3; 5932d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5933d1fe9c09SJoe Perches my $arg2 = $8; 5934d7c76ba7SJoe Perches my $cast; 5935d7c76ba7SJoe Perches 5936d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5937d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5938d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5939d7c76ba7SJoe Perches $cast = $cast1; 5940d7c76ba7SJoe Perches } else { 5941d7c76ba7SJoe Perches $cast = $cast2; 5942d7c76ba7SJoe Perches } 5943d7c76ba7SJoe Perches WARN("MINMAX", 5944d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5945554e165cSAndy Whitcroft } 5946554e165cSAndy Whitcroft } 5947554e165cSAndy Whitcroft 59484a273195SJoe Perches# check usleep_range arguments 59494a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 59504a273195SJoe Perches defined $stat && 59514a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 59524a273195SJoe Perches my $min = $1; 59534a273195SJoe Perches my $max = $7; 59544a273195SJoe Perches if ($min eq $max) { 59554a273195SJoe Perches WARN("USLEEP_RANGE", 59564a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 59574a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 59584a273195SJoe Perches $min > $max) { 59594a273195SJoe Perches WARN("USLEEP_RANGE", 59604a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 59614a273195SJoe Perches } 59624a273195SJoe Perches } 59634a273195SJoe Perches 5964823b794cSJoe Perches# check for naked sscanf 5965823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5966823b794cSJoe Perches defined $stat && 59676c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5968823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5969823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5970823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5971823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5972823b794cSJoe Perches $lc = $lc + $linenr; 59732a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 5974823b794cSJoe Perches WARN("NAKED_SSCANF", 5975823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5976823b794cSJoe Perches } 5977823b794cSJoe Perches 5978afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5979afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5980afc819abSJoe Perches defined $stat && 5981afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5982afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5983afc819abSJoe Perches $lc = $lc + $linenr; 59842a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 5985afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5986afc819abSJoe Perches my $format = $6; 5987afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5988afc819abSJoe Perches if ($count == 1 && 5989afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5990afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5991afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5992afc819abSJoe Perches } 5993afc819abSJoe Perches } 5994afc819abSJoe Perches } 5995afc819abSJoe Perches 599670dc8a48SJoe Perches# check for new externs in .h files. 599770dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 599870dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5999d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 600070dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 600170dc8a48SJoe Perches $fix) { 6002194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 600370dc8a48SJoe Perches } 600470dc8a48SJoe Perches } 600570dc8a48SJoe Perches 6006de7d4f0eSAndy Whitcroft# check for new externs in .c files. 6007171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 6008c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 6009171ae1a4SAndy Whitcroft { 6010c45dcabdSAndy Whitcroft my $function_name = $1; 6011c45dcabdSAndy Whitcroft my $paren_space = $2; 6012171ae1a4SAndy Whitcroft 6013171ae1a4SAndy Whitcroft my $s = $stat; 6014171ae1a4SAndy Whitcroft if (defined $cond) { 6015171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 6016171ae1a4SAndy Whitcroft } 6017c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 6018c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 6019c45dcabdSAndy Whitcroft { 6020000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6021000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6022de7d4f0eSAndy Whitcroft } 6023de7d4f0eSAndy Whitcroft 6024171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 6025000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 6026000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 6027171ae1a4SAndy Whitcroft } 60289c9ba34eSAndy Whitcroft 60299c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 60309c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 60319c9ba34eSAndy Whitcroft { 6032000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6033000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6034171ae1a4SAndy Whitcroft } 6035171ae1a4SAndy Whitcroft 6036a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 6037a0ad7596SJoe Perches if (defined $stat && 603825bdda2bSMiles Chen $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 6039ca0d8929SJoe Perches $1 ne "void") { 6040ca0d8929SJoe Perches my $args = trim($1); 6041ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6042ca0d8929SJoe Perches my $arg = trim($1); 6043ca0d8929SJoe Perches if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 6044ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 6045ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6046ca0d8929SJoe Perches } 6047ca0d8929SJoe Perches } 6048ca0d8929SJoe Perches } 6049ca0d8929SJoe Perches 6050a0ad7596SJoe Perches# check for function definitions 6051a0ad7596SJoe Perches if ($^V && $^V ge 5.10.0 && 6052a0ad7596SJoe Perches defined $stat && 6053a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6054a0ad7596SJoe Perches $context_function = $1; 6055a0ad7596SJoe Perches 6056a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 6057a0ad7596SJoe Perches my $ok = 0; 6058a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 6059a0ad7596SJoe Perches my $herectx = $here . "\n"; 6060a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6061a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 6062a0ad7596SJoe Perches $herectx .= $rl . "\n"; 6063a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 6064a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 6065a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 6066a0ad7596SJoe Perches } 6067a0ad7596SJoe Perches if (!$ok) { 6068a0ad7596SJoe Perches ERROR("OPEN_BRACE", 6069a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 6070a0ad7596SJoe Perches } 6071a0ad7596SJoe Perches } 6072a0ad7596SJoe Perches 6073de7d4f0eSAndy Whitcroft# checks for new __setup's 6074de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 6075de7d4f0eSAndy Whitcroft my $name = $1; 6076de7d4f0eSAndy Whitcroft 6077de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 6078000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 60798c27ceffSMauro Carvalho Chehab "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr); 6080de7d4f0eSAndy Whitcroft } 6081653d4876SAndy Whitcroft } 60829c0ca6f9SAndy Whitcroft 60839c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 6084caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 6085000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 6086000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 60879c0ca6f9SAndy Whitcroft } 608813214adfSAndy Whitcroft 6089a640d25cSJoe Perches# alloc style 6090a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 6091a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 6092a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 6093a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 6094a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 6095a640d25cSJoe Perches } 6096a640d25cSJoe Perches 609760a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 609860a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 60991b4a2ed4SJoe Perches defined $stat && 61001b4a2ed4SJoe Perches $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 610160a55369SJoe Perches my $oldfunc = $3; 610260a55369SJoe Perches my $a1 = $4; 610360a55369SJoe Perches my $a2 = $10; 610460a55369SJoe Perches my $newfunc = "kmalloc_array"; 610560a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 610660a55369SJoe Perches my $r1 = $a1; 610760a55369SJoe Perches my $r2 = $a2; 610860a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 610960a55369SJoe Perches $r1 = $a2; 611060a55369SJoe Perches $r2 = $a1; 611160a55369SJoe Perches } 6112e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 6113e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 61141b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 6115e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6116e3d95a2aSTobin C. Harding 6117e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 61181b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 61191b4a2ed4SJoe Perches $cnt == 1 && 6120e367455aSJoe Perches $fix) { 6121194f66fcSJoe 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; 612260a55369SJoe Perches } 612360a55369SJoe Perches } 612460a55369SJoe Perches } 612560a55369SJoe Perches 6126972fdea2SJoe Perches# check for krealloc arg reuse 6127972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 6128972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 6129972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 6130972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 6131972fdea2SJoe Perches } 6132972fdea2SJoe Perches 61335ce59ae0SJoe Perches# check for alloc argument mismatch 61345ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 61355ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 61365ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 61375ce59ae0SJoe Perches } 61385ce59ae0SJoe Perches 6139caf2a54fSJoe Perches# check for multiple semicolons 6140caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 6141d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 6142d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 6143d5e616fcSJoe Perches $fix) { 6144194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 6145d5e616fcSJoe Perches } 6146d1e2ad07SJoe Perches } 6147d1e2ad07SJoe Perches 6148cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 6149cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 6150cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 61510ab90191SJoe Perches my $ull = ""; 61520ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 61530ab90191SJoe Perches if (CHK("BIT_MACRO", 61540ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 61550ab90191SJoe Perches $fix) { 61560ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 61570ab90191SJoe Perches } 61580ab90191SJoe Perches } 61590ab90191SJoe Perches 61602d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 61612d632745SJoe 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*$/) { 61622d632745SJoe Perches my $config = $1; 61632d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 61642d632745SJoe Perches "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) && 61652d632745SJoe Perches $fix) { 61662d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 61672d632745SJoe Perches } 61682d632745SJoe Perches } 61692d632745SJoe Perches 6170e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 6171c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 6172c34c09a8SJoe Perches my $has_break = 0; 6173c34c09a8SJoe Perches my $has_statement = 0; 6174c34c09a8SJoe Perches my $count = 0; 6175c34c09a8SJoe Perches my $prevline = $linenr; 6176e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 6177c34c09a8SJoe Perches $prevline--; 6178c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 6179c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 6180c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 6181c34c09a8SJoe Perches next if ($fline =~ /^\-/); 6182c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 6183c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 6184c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 6185c34c09a8SJoe Perches $has_statement = 1; 6186c34c09a8SJoe Perches $count++; 6187258f79d5SHeinrich Schuchardt $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/); 6188c34c09a8SJoe Perches } 6189c34c09a8SJoe Perches if (!$has_break && $has_statement) { 6190c34c09a8SJoe Perches WARN("MISSING_BREAK", 6191224236d9SAndrew Morton "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr); 6192c34c09a8SJoe Perches } 6193c34c09a8SJoe Perches } 6194c34c09a8SJoe Perches 6195d1e2ad07SJoe Perches# check for switch/default statements without a break; 6196d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 6197d1e2ad07SJoe Perches defined $stat && 6198d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 6199d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 6200e3d95a2aSTobin C. Harding my $herectx = get_stat_here($linenr, $cnt, $here); 6201e3d95a2aSTobin C. Harding 6202d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 6203d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 6204caf2a54fSJoe Perches } 6205caf2a54fSJoe Perches 620613214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 6207d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 6208d5e616fcSJoe Perches if (WARN("USE_FUNC", 6209d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 6210d5e616fcSJoe Perches $fix) { 6211194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 6212d5e616fcSJoe Perches } 621313214adfSAndy Whitcroft } 6214773647a0SAndy Whitcroft 621562ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 621662ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 621762ec818fSJoe Perches ERROR("DATE_TIME", 621862ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 621962ec818fSJoe Perches } 622062ec818fSJoe Perches 62212c92488aSJoe Perches# check for use of yield() 62222c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 62232c92488aSJoe Perches WARN("YIELD", 62242c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 62252c92488aSJoe Perches } 62262c92488aSJoe Perches 6227179f8f40SJoe Perches# check for comparisons against true and false 6228179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 6229179f8f40SJoe Perches my $lead = $1; 6230179f8f40SJoe Perches my $arg = $2; 6231179f8f40SJoe Perches my $test = $3; 6232179f8f40SJoe Perches my $otype = $4; 6233179f8f40SJoe Perches my $trail = $5; 6234179f8f40SJoe Perches my $op = "!"; 6235179f8f40SJoe Perches 6236179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 6237179f8f40SJoe Perches 6238179f8f40SJoe Perches my $type = lc($otype); 6239179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 6240179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 6241179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 6242179f8f40SJoe Perches $op = ""; 6243179f8f40SJoe Perches } 6244179f8f40SJoe Perches 6245179f8f40SJoe Perches CHK("BOOL_COMPARISON", 6246179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 6247179f8f40SJoe Perches 6248179f8f40SJoe Perches## maybe suggesting a correct construct would better 6249179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 6250179f8f40SJoe Perches 6251179f8f40SJoe Perches } 6252179f8f40SJoe Perches } 6253179f8f40SJoe Perches 62545d430902SJoe Perches# check for bool bitfields 62555d430902SJoe Perches if ($sline =~ /^.\s+bool\s*$Ident\s*:\s*\d+\s*;/) { 62565d430902SJoe Perches WARN("BOOL_BITFIELD", 62575d430902SJoe Perches "Avoid using bool as bitfield. Prefer bool bitfields as unsigned int or u<8|16|32>\n" . $herecurr); 62585d430902SJoe Perches } 62595d430902SJoe Perches 62604882720bSThomas Gleixner# check for semaphores initialized locked 62614882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 6262000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 6263000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 6264773647a0SAndy Whitcroft } 62656712d858SJoe Perches 626667d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 626767d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 6268000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 626967d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 6270773647a0SAndy Whitcroft } 62716712d858SJoe Perches 6272ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 6273f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 6274000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 6275ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 6276f3db6639SMichael Ellerman } 62776712d858SJoe Perches 62780f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 6279d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 62806903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 6281d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 6282000d1cc1SJoe Perches WARN("CONST_STRUCT", 6283d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 62842b6db5cbSAndy Whitcroft } 6285773647a0SAndy Whitcroft 6286773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 6287773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 6288773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 6289c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 6290c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 6291171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 6292171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 6293171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 6294773647a0SAndy Whitcroft { 6295000d1cc1SJoe Perches WARN("NR_CPUS", 6296000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 6297773647a0SAndy Whitcroft } 62989c9ba34eSAndy Whitcroft 629952ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 630052ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 630152ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 630252ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 630352ea8506SJoe Perches } 630452ea8506SJoe Perches 6305acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 6306acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 6307acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 6308acd9362cSJoe Perches WARN("LIKELY_MISUSE", 6309acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 6310acd9362cSJoe Perches } 6311acd9362cSJoe Perches 6312691d77b6SAndy Whitcroft# whine mightly about in_atomic 6313691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 6314691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 6315000d1cc1SJoe Perches ERROR("IN_ATOMIC", 6316000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 6317f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 6318000d1cc1SJoe Perches WARN("IN_ATOMIC", 6319000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 6320691d77b6SAndy Whitcroft } 6321691d77b6SAndy Whitcroft } 63221704f47bSPeter Zijlstra 63230f5225b0SPeter Zijlstra# check for mutex_trylock_recursive usage 63240f5225b0SPeter Zijlstra if ($line =~ /mutex_trylock_recursive/) { 63250f5225b0SPeter Zijlstra ERROR("LOCKING", 63260f5225b0SPeter Zijlstra "recursive locking is bad, do not use this ever.\n" . $herecurr); 63270f5225b0SPeter Zijlstra } 63280f5225b0SPeter Zijlstra 63291704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 63301704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 63311704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 63321704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 63331704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 63341704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 6335000d1cc1SJoe Perches ERROR("LOCKDEP", 6336000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 63371704f47bSPeter Zijlstra } 63381704f47bSPeter Zijlstra } 633988f8831cSDave Jones 6340b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 6341b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 6342000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 6343000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 634488f8831cSDave Jones } 63452435880fSJoe Perches 634600180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 634700180468SJoe Perches# and whether or not function naming is typical and if 634800180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 634900180468SJoe Perches if ($^V && $^V ge 5.10.0 && 635000180468SJoe Perches defined $stat && 635100180468SJoe 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*\)/) { 635200180468SJoe Perches my $var = $1; 635300180468SJoe Perches my $perms = $2; 635400180468SJoe Perches my $show = $3; 635500180468SJoe Perches my $store = $4; 635600180468SJoe Perches my $octal_perms = perms_to_octal($perms); 635700180468SJoe Perches if ($show =~ /^${var}_show$/ && 635800180468SJoe Perches $store =~ /^${var}_store$/ && 635900180468SJoe Perches $octal_perms eq "0644") { 636000180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 636100180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 636200180468SJoe Perches $fix) { 636300180468SJoe Perches $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/; 636400180468SJoe Perches } 636500180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 636600180468SJoe Perches $store =~ /^NULL$/ && 636700180468SJoe Perches $octal_perms eq "0444") { 636800180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 636900180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 637000180468SJoe Perches $fix) { 637100180468SJoe 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})/; 637200180468SJoe Perches } 637300180468SJoe Perches } elsif ($show =~ /^NULL$/ && 637400180468SJoe Perches $store =~ /^${var}_store$/ && 637500180468SJoe Perches $octal_perms eq "0200") { 637600180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 637700180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 637800180468SJoe Perches $fix) { 637900180468SJoe 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})/; 638000180468SJoe Perches } 638100180468SJoe Perches } elsif ($octal_perms eq "0644" || 638200180468SJoe Perches $octal_perms eq "0444" || 638300180468SJoe Perches $octal_perms eq "0200") { 638400180468SJoe Perches my $newshow = "$show"; 638500180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 638600180468SJoe Perches my $newstore = $store; 638700180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 638800180468SJoe Perches my $rename = ""; 638900180468SJoe Perches if ($show ne $newshow) { 639000180468SJoe Perches $rename .= " '$show' to '$newshow'"; 639100180468SJoe Perches } 639200180468SJoe Perches if ($store ne $newstore) { 639300180468SJoe Perches $rename .= " '$store' to '$newstore'"; 639400180468SJoe Perches } 639500180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 639600180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 639700180468SJoe Perches } else { 639800180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 639900180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 640000180468SJoe Perches } 640100180468SJoe Perches } 640200180468SJoe Perches 6403515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 6404515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 640573121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 640673121534SJoe Perches# specific definition of not visible in sysfs. 640773121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 640873121534SJoe Perches# use the default permissions 6409515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 6410459cf0aeSJoe Perches defined $stat && 6411515a235eSJoe Perches $line =~ /$mode_perms_search/) { 64122435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 64132435880fSJoe Perches my $func = $entry->[0]; 64142435880fSJoe Perches my $arg_pos = $entry->[1]; 64152435880fSJoe Perches 6416459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 6417459cf0aeSJoe Perches $lc = $lc + $linenr; 64182a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6419459cf0aeSJoe Perches 64202435880fSJoe Perches my $skip_args = ""; 64212435880fSJoe Perches if ($arg_pos > 1) { 64222435880fSJoe Perches $arg_pos--; 64232435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 64242435880fSJoe Perches } 6425f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 6426459cf0aeSJoe Perches if ($stat =~ /$test/) { 64272435880fSJoe Perches my $val = $1; 64282435880fSJoe Perches $val = $6 if ($skip_args ne ""); 642973121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 643073121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 643173121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 64322435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 6433459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 6434f90774e1SJoe Perches } 6435f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6436c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6437459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 64382435880fSJoe Perches } 6439459cf0aeSJoe Perches } 6440459cf0aeSJoe Perches } 6441459cf0aeSJoe Perches } 6442459cf0aeSJoe Perches 6443459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 6444bc22d9a7SJoe Perches while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 644500180468SJoe Perches my $oval = $1; 644600180468SJoe Perches my $octal = perms_to_octal($oval); 6447f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 6448459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 6449f90774e1SJoe Perches $fix) { 645000180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 64512435880fSJoe Perches } 645213214adfSAndy Whitcroft } 64535a6d20ceSBjorn Andersson 64545a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 64555a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 64565a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 64575a6d20ceSBjorn Andersson my $valid_licenses = qr{ 64585a6d20ceSBjorn Andersson GPL| 64595a6d20ceSBjorn Andersson GPL\ v2| 64605a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 64615a6d20ceSBjorn Andersson Dual\ BSD/GPL| 64625a6d20ceSBjorn Andersson Dual\ MIT/GPL| 64635a6d20ceSBjorn Andersson Dual\ MPL/GPL| 64645a6d20ceSBjorn Andersson Proprietary 64655a6d20ceSBjorn Andersson }x; 64665a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 64675a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 64685a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 64695a6d20ceSBjorn Andersson } 64705a6d20ceSBjorn Andersson } 6471515a235eSJoe Perches } 647213214adfSAndy Whitcroft 647313214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 647413214adfSAndy Whitcroft # so just keep quiet. 647513214adfSAndy Whitcroft if ($#rawlines == -1) { 647613214adfSAndy Whitcroft exit(0); 64770a920b5bSAndy Whitcroft } 64780a920b5bSAndy Whitcroft 64798905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 64808905a67cSAndy Whitcroft # things that appear to be patches. 64818905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 64828905a67cSAndy Whitcroft exit(0); 64838905a67cSAndy Whitcroft } 64848905a67cSAndy Whitcroft 64858905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 64868905a67cSAndy Whitcroft # just keep quiet. 64878905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 64888905a67cSAndy Whitcroft exit(0); 64898905a67cSAndy Whitcroft } 64908905a67cSAndy Whitcroft 6491a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 6492000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6493000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 64940a920b5bSAndy Whitcroft } 6495ed43c4e5SAllen Hubbe if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) { 6496000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6497000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 64980a920b5bSAndy Whitcroft } 64990a920b5bSAndy Whitcroft 6500f0a594c1SAndy Whitcroft print report_dump(); 650113214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 650213214adfSAndy Whitcroft print "$filename " if ($summary_file); 65036c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 65046c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 65056c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 65066c72ffaaSAndy Whitcroft } 65078905a67cSAndy Whitcroft 6508d2c0a235SAndy Whitcroft if ($quiet == 0) { 6509ef212196SJoe Perches # If there were any defects found and not already fixing them 6510ef212196SJoe Perches if (!$clean and !$fix) { 6511ef212196SJoe Perches print << "EOM" 6512ef212196SJoe Perches 6513ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 6514ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 6515ef212196SJoe PerchesEOM 6516ef212196SJoe Perches } 6517d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 6518d2c0a235SAndy Whitcroft # then suggest that. 6519d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 6520b0781216SMike Frysinger $rpt_cleaners = 0; 6521d8469f16SJoe Perches print << "EOM" 6522d8469f16SJoe Perches 6523d8469f16SJoe PerchesNOTE: Whitespace errors detected. 6524d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 6525d8469f16SJoe PerchesEOM 6526d2c0a235SAndy Whitcroft } 6527d2c0a235SAndy Whitcroft } 6528d2c0a235SAndy Whitcroft 6529d752fcc8SJoe Perches if ($clean == 0 && $fix && 6530d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 6531d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 65329624b8d6SJoe Perches my $newfile = $filename; 65339624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 65343705ce5bSJoe Perches my $linecount = 0; 65353705ce5bSJoe Perches my $f; 65363705ce5bSJoe Perches 6537d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 6538d752fcc8SJoe Perches 65393705ce5bSJoe Perches open($f, '>', $newfile) 65403705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 65413705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 65423705ce5bSJoe Perches $linecount++; 65433705ce5bSJoe Perches if ($file) { 65443705ce5bSJoe Perches if ($linecount > 3) { 65453705ce5bSJoe Perches $fixed_line =~ s/^\+//; 65463705ce5bSJoe Perches print $f $fixed_line . "\n"; 65473705ce5bSJoe Perches } 65483705ce5bSJoe Perches } else { 65493705ce5bSJoe Perches print $f $fixed_line . "\n"; 65503705ce5bSJoe Perches } 65513705ce5bSJoe Perches } 65523705ce5bSJoe Perches close($f); 65533705ce5bSJoe Perches 65543705ce5bSJoe Perches if (!$quiet) { 65553705ce5bSJoe Perches print << "EOM"; 6556d8469f16SJoe Perches 65573705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 65583705ce5bSJoe Perches 65593705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 65603705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 65613705ce5bSJoe Perches 65623705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 65633705ce5bSJoe PerchesNo warranties, expressed or implied... 65643705ce5bSJoe PerchesEOM 65653705ce5bSJoe Perches } 65663705ce5bSJoe Perches } 65673705ce5bSJoe Perches 6568d8469f16SJoe Perches if ($quiet == 0) { 6569d8469f16SJoe Perches print "\n"; 6570d8469f16SJoe Perches if ($clean == 1) { 6571d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 6572d8469f16SJoe Perches } else { 6573d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 65740a920b5bSAndy Whitcroft } 65750a920b5bSAndy Whitcroft } 65760a920b5bSAndy Whitcroft return $clean; 65770a920b5bSAndy Whitcroft} 6578