1cb77f0d6SKamil Rytarowski#!/usr/bin/env perl 2dbf004d7SDave Jones# (c) 2001, Dave Jones. (the file handling bit) 300df344fSAndy Whitcroft# (c) 2005, Joel Schopp <[email protected]> (the ugly bit) 42a5a2c25SAndy Whitcroft# (c) 2007,2008, Andy Whitcroft <[email protected]> (new conditions, test suite) 5015830beSAndy Whitcroft# (c) 2008-2010 Andy Whitcroft <[email protected]> 60a920b5bSAndy Whitcroft# Licensed under the terms of the GNU GPL License version 2 70a920b5bSAndy Whitcroft 80a920b5bSAndy Whitcroftuse strict; 9cb77f0d6SKamil Rytarowskiuse warnings; 10c707a81dSJoe Perchesuse POSIX; 1136061e38SJoe Perchesuse File::Basename; 1236061e38SJoe Perchesuse Cwd 'abs_path'; 1357230297SJoe Perchesuse Term::ANSIColor qw(:constants); 140a920b5bSAndy Whitcroft 150a920b5bSAndy Whitcroftmy $P = $0; 1636061e38SJoe Perchesmy $D = dirname(abs_path($P)); 170a920b5bSAndy Whitcroft 18000d1cc1SJoe Perchesmy $V = '0.32'; 190a920b5bSAndy Whitcroft 200a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 210a920b5bSAndy Whitcroft 220a920b5bSAndy Whitcroftmy $quiet = 0; 230a920b5bSAndy Whitcroftmy $tree = 1; 240a920b5bSAndy Whitcroftmy $chk_signoff = 1; 250a920b5bSAndy Whitcroftmy $chk_patch = 1; 26773647a0SAndy Whitcroftmy $tst_only; 276c72ffaaSAndy Whitcroftmy $emacs = 0; 288905a67cSAndy Whitcroftmy $terse = 0; 2934d8815fSJoe Perchesmy $showfile = 0; 306c72ffaaSAndy Whitcroftmy $file = 0; 314a593c34SDu, Changbinmy $git = 0; 320dea9f1eSJoe Perchesmy %git_commits = (); 336c72ffaaSAndy Whitcroftmy $check = 0; 342ac73b4fSJoe Perchesmy $check_orig = 0; 358905a67cSAndy Whitcroftmy $summary = 1; 368905a67cSAndy Whitcroftmy $mailback = 0; 3713214adfSAndy Whitcroftmy $summary_file = 0; 38000d1cc1SJoe Perchesmy $show_types = 0; 393beb42ecSJoe Perchesmy $list_types = 0; 403705ce5bSJoe Perchesmy $fix = 0; 419624b8d6SJoe Perchesmy $fix_inplace = 0; 426c72ffaaSAndy Whitcroftmy $root; 43c2fdda0dSAndy Whitcroftmy %debug; 443445686aSJoe Perchesmy %camelcase = (); 4591bfe484SJoe Perchesmy %use_type = (); 4691bfe484SJoe Perchesmy @use = (); 4791bfe484SJoe Perchesmy %ignore_type = (); 48000d1cc1SJoe Perchesmy @ignore = (); 4977f5b10aSHannes Edermy $help = 0; 50000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 516cd7f386SJoe Perchesmy $max_line_length = 80; 52d62a201fSDave Hansenmy $ignore_perl_version = 0; 53d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 5456193274SVadim Bendeburymy $min_conf_desc_length = 4; 5566b47b4aSKees Cookmy $spelling_file = "$D/spelling.txt"; 56ebfd7d62SJoe Perchesmy $codespell = 0; 57f1a63678SMaxim Uvarovmy $codespellfile = "/usr/share/codespell/dictionary.txt"; 58bf1fa1daSJoe Perchesmy $conststructsfile = "$D/const_structs.checkpatch"; 5975ad8c57SJerome Forissiermy $typedefsfile = ""; 60737c0767SJohn Brooksmy $color = "auto"; 61dadf680dSJoe Perchesmy $allow_c99_comments = 1; 6277f5b10aSHannes Eder 6377f5b10aSHannes Edersub help { 6477f5b10aSHannes Eder my ($exitcode) = @_; 6577f5b10aSHannes Eder 6677f5b10aSHannes Eder print << "EOM"; 6777f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 6877f5b10aSHannes EderVersion: $V 6977f5b10aSHannes Eder 7077f5b10aSHannes EderOptions: 7177f5b10aSHannes Eder -q, --quiet quiet 7277f5b10aSHannes Eder --no-tree run without a kernel tree 7377f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 7477f5b10aSHannes Eder --patch treat FILE as patchfile (default) 7577f5b10aSHannes Eder --emacs emacs compile window format 7677f5b10aSHannes Eder --terse one line per report 7734d8815fSJoe Perches --showfile emit diffed file position, not input file position 784a593c34SDu, Changbin -g, --git treat FILE as a single commit or git revision range 794a593c34SDu, Changbin single git commit with: 804a593c34SDu, Changbin <rev> 814a593c34SDu, Changbin <rev>^ 824a593c34SDu, Changbin <rev>~n 834a593c34SDu, Changbin multiple git commits with: 844a593c34SDu, Changbin <rev1>..<rev2> 854a593c34SDu, Changbin <rev1>...<rev2> 864a593c34SDu, Changbin <rev>-<count> 874a593c34SDu, Changbin git merges are ignored 8877f5b10aSHannes Eder -f, --file treat FILE as regular source file 8977f5b10aSHannes Eder --subjective, --strict enable more subjective tests 903beb42ecSJoe Perches --list-types list the possible message types 9191bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 92000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 933beb42ecSJoe Perches --show-types show the specific message type in the output 946cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 9556193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 9677f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 9777f5b10aSHannes Eder --no-summary suppress the per-file summary 9877f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 9977f5b10aSHannes Eder --summary-file include the filename in summary 10077f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 10177f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 10277f5b10aSHannes Eder is all off) 10377f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 10477f5b10aSHannes Eder literally 1053705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 1063705ce5bSJoe Perches If correctable single-line errors exist, create 1073705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 1083705ce5bSJoe Perches with potential errors corrected to the preferred 1093705ce5bSJoe Perches checkpatch style 1109624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 1119624b8d6SJoe Perches Is the same as --fix, but overwrites the input 1129624b8d6SJoe Perches file. It's your fault if there's no backup or git 113d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 114d62a201fSDave Hansen runtime errors. 115ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 116f1a63678SMaxim Uvarov (default:/usr/share/codespell/dictionary.txt) 117ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 11875ad8c57SJerome Forissier --typedefsfile Read additional types from this file 119737c0767SJohn Brooks --color[=WHEN] Use colors 'always', 'never', or only when output 120737c0767SJohn Brooks is a terminal ('auto'). Default is 'auto'. 12177f5b10aSHannes Eder -h, --help, --version display this help and exit 12277f5b10aSHannes Eder 12377f5b10aSHannes EderWhen FILE is - read standard input. 12477f5b10aSHannes EderEOM 12577f5b10aSHannes Eder 12677f5b10aSHannes Eder exit($exitcode); 12777f5b10aSHannes Eder} 12877f5b10aSHannes Eder 1293beb42ecSJoe Perchessub uniq { 1303beb42ecSJoe Perches my %seen; 1313beb42ecSJoe Perches return grep { !$seen{$_}++ } @_; 1323beb42ecSJoe Perches} 1333beb42ecSJoe Perches 1343beb42ecSJoe Perchessub list_types { 1353beb42ecSJoe Perches my ($exitcode) = @_; 1363beb42ecSJoe Perches 1373beb42ecSJoe Perches my $count = 0; 1383beb42ecSJoe Perches 1393beb42ecSJoe Perches local $/ = undef; 1403beb42ecSJoe Perches 1413beb42ecSJoe Perches open(my $script, '<', abs_path($P)) or 1423beb42ecSJoe Perches die "$P: Can't read '$P' $!\n"; 1433beb42ecSJoe Perches 1443beb42ecSJoe Perches my $text = <$script>; 1453beb42ecSJoe Perches close($script); 1463beb42ecSJoe Perches 1473beb42ecSJoe Perches my @types = (); 1480547fa58SJean Delvare # Also catch when type or level is passed through a variable 1490547fa58SJean Delvare for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) { 1503beb42ecSJoe Perches push (@types, $_); 1513beb42ecSJoe Perches } 1523beb42ecSJoe Perches @types = sort(uniq(@types)); 1533beb42ecSJoe Perches print("#\tMessage type\n\n"); 1543beb42ecSJoe Perches foreach my $type (@types) { 1553beb42ecSJoe Perches print(++$count . "\t" . $type . "\n"); 1563beb42ecSJoe Perches } 1573beb42ecSJoe Perches 1583beb42ecSJoe Perches exit($exitcode); 1593beb42ecSJoe Perches} 1603beb42ecSJoe Perches 161000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 162000d1cc1SJoe Perchesif (-f $conf) { 163000d1cc1SJoe Perches my @conf_args; 164000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 165000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 166000d1cc1SJoe Perches 167000d1cc1SJoe Perches while (<$conffile>) { 168000d1cc1SJoe Perches my $line = $_; 169000d1cc1SJoe Perches 170000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 171000d1cc1SJoe Perches $line =~ s/^\s*//g; 172000d1cc1SJoe Perches $line =~ s/\s+/ /g; 173000d1cc1SJoe Perches 174000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 175000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 176000d1cc1SJoe Perches 177000d1cc1SJoe Perches my @words = split(" ", $line); 178000d1cc1SJoe Perches foreach my $word (@words) { 179000d1cc1SJoe Perches last if ($word =~ m/^#/); 180000d1cc1SJoe Perches push (@conf_args, $word); 181000d1cc1SJoe Perches } 182000d1cc1SJoe Perches } 183000d1cc1SJoe Perches close($conffile); 184000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 185000d1cc1SJoe Perches} 186000d1cc1SJoe Perches 187737c0767SJohn Brooks# Perl's Getopt::Long allows options to take optional arguments after a space. 188737c0767SJohn Brooks# Prevent --color by itself from consuming other arguments 189737c0767SJohn Brooksforeach (@ARGV) { 190737c0767SJohn Brooks if ($_ eq "--color" || $_ eq "-color") { 191737c0767SJohn Brooks $_ = "--color=$color"; 192737c0767SJohn Brooks } 193737c0767SJohn Brooks} 194737c0767SJohn Brooks 1950a920b5bSAndy WhitcroftGetOptions( 1966c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1970a920b5bSAndy Whitcroft 'tree!' => \$tree, 1980a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1990a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 2006c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 2018905a67cSAndy Whitcroft 'terse!' => \$terse, 20234d8815fSJoe Perches 'showfile!' => \$showfile, 20377f5b10aSHannes Eder 'f|file!' => \$file, 2044a593c34SDu, Changbin 'g|git!' => \$git, 2056c72ffaaSAndy Whitcroft 'subjective!' => \$check, 2066c72ffaaSAndy Whitcroft 'strict!' => \$check, 207000d1cc1SJoe Perches 'ignore=s' => \@ignore, 20891bfe484SJoe Perches 'types=s' => \@use, 209000d1cc1SJoe Perches 'show-types!' => \$show_types, 2103beb42ecSJoe Perches 'list-types!' => \$list_types, 2116cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 21256193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 2136c72ffaaSAndy Whitcroft 'root=s' => \$root, 2148905a67cSAndy Whitcroft 'summary!' => \$summary, 2158905a67cSAndy Whitcroft 'mailback!' => \$mailback, 21613214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 2173705ce5bSJoe Perches 'fix!' => \$fix, 2189624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 219d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 220c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 221773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 222ebfd7d62SJoe Perches 'codespell!' => \$codespell, 223ebfd7d62SJoe Perches 'codespellfile=s' => \$codespellfile, 22475ad8c57SJerome Forissier 'typedefsfile=s' => \$typedefsfile, 225737c0767SJohn Brooks 'color=s' => \$color, 226737c0767SJohn Brooks 'no-color' => \$color, #keep old behaviors of -nocolor 227737c0767SJohn Brooks 'nocolor' => \$color, #keep old behaviors of -nocolor 22877f5b10aSHannes Eder 'h|help' => \$help, 22977f5b10aSHannes Eder 'version' => \$help 23077f5b10aSHannes Eder) or help(1); 23177f5b10aSHannes Eder 23277f5b10aSHannes Ederhelp(0) if ($help); 2330a920b5bSAndy Whitcroft 2343beb42ecSJoe Percheslist_types(0) if ($list_types); 2353beb42ecSJoe Perches 2369624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 2372ac73b4fSJoe Perches$check_orig = $check; 2389624b8d6SJoe Perches 2390a920b5bSAndy Whitcroftmy $exit = 0; 2400a920b5bSAndy Whitcroft 241d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 242d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 243d62a201fSDave Hansen if (!$ignore_perl_version) { 244d62a201fSDave Hansen exit(1); 245d62a201fSDave Hansen } 246d62a201fSDave Hansen} 247d62a201fSDave Hansen 24845107ff6SAllen Hubbe#if no filenames are given, push '-' to read patch from stdin 2490a920b5bSAndy Whitcroftif ($#ARGV < 0) { 25045107ff6SAllen Hubbe push(@ARGV, '-'); 2510a920b5bSAndy Whitcroft} 2520a920b5bSAndy Whitcroft 253737c0767SJohn Brooksif ($color =~ /^[01]$/) { 254737c0767SJohn Brooks $color = !$color; 255737c0767SJohn Brooks} elsif ($color =~ /^always$/i) { 256737c0767SJohn Brooks $color = 1; 257737c0767SJohn Brooks} elsif ($color =~ /^never$/i) { 258737c0767SJohn Brooks $color = 0; 259737c0767SJohn Brooks} elsif ($color =~ /^auto$/i) { 260737c0767SJohn Brooks $color = (-t STDOUT); 261737c0767SJohn Brooks} else { 262737c0767SJohn Brooks die "Invalid color mode: $color\n"; 263737c0767SJohn Brooks} 264737c0767SJohn Brooks 26591bfe484SJoe Perchessub hash_save_array_words { 26691bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 26791bfe484SJoe Perches 26891bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 26991bfe484SJoe Perches foreach my $word (@array) { 270000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 271000d1cc1SJoe Perches $word =~ s/^\s*//g; 272000d1cc1SJoe Perches $word =~ s/\s+/ /g; 273000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 274000d1cc1SJoe Perches 275000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 276000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 277000d1cc1SJoe Perches 27891bfe484SJoe Perches $hashRef->{$word}++; 279000d1cc1SJoe Perches } 28091bfe484SJoe Perches} 28191bfe484SJoe Perches 28291bfe484SJoe Perchessub hash_show_words { 28391bfe484SJoe Perches my ($hashRef, $prefix) = @_; 28491bfe484SJoe Perches 2853c816e49SJoe Perches if (keys %$hashRef) { 286d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 28758cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 28891bfe484SJoe Perches print " $word"; 28991bfe484SJoe Perches } 290d8469f16SJoe Perches print "\n"; 29191bfe484SJoe Perches } 29291bfe484SJoe Perches} 29391bfe484SJoe Perches 29491bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 29591bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 296000d1cc1SJoe Perches 297c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 298c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 2997429c690SAndy Whitcroftmy $dbg_type = 0; 300a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 301c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 30221caa13cSAndy Whitcroft ## no critic 30321caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 30421caa13cSAndy Whitcroft die "$@" if ($@); 305c2fdda0dSAndy Whitcroft} 306c2fdda0dSAndy Whitcroft 307d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 308d2c0a235SAndy Whitcroft 3098905a67cSAndy Whitcroftif ($terse) { 3108905a67cSAndy Whitcroft $emacs = 1; 3118905a67cSAndy Whitcroft $quiet++; 3128905a67cSAndy Whitcroft} 3138905a67cSAndy Whitcroft 3146c72ffaaSAndy Whitcroftif ($tree) { 3156c72ffaaSAndy Whitcroft if (defined $root) { 3166c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 3176c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 3186c72ffaaSAndy Whitcroft } 3196c72ffaaSAndy Whitcroft } else { 3206c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 3216c72ffaaSAndy Whitcroft $root = '.'; 3226c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 3236c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 3246c72ffaaSAndy Whitcroft $root = $1; 3256c72ffaaSAndy Whitcroft } 3266c72ffaaSAndy Whitcroft } 3276c72ffaaSAndy Whitcroft 3286c72ffaaSAndy Whitcroft if (!defined $root) { 3290a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 3300a920b5bSAndy Whitcroft exit(2); 3310a920b5bSAndy Whitcroft } 3326c72ffaaSAndy Whitcroft} 3336c72ffaaSAndy Whitcroft 3346c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 3356c72ffaaSAndy Whitcroft 3362ceb532bSAndy Whitcroftour $Ident = qr{ 3372ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 3382ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 3392ceb532bSAndy Whitcroft }x; 3406c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 3416c72ffaaSAndy Whitcroftour $Sparse = qr{ 3426c72ffaaSAndy Whitcroft __user| 3436c72ffaaSAndy Whitcroft __kernel| 3446c72ffaaSAndy Whitcroft __force| 3456c72ffaaSAndy Whitcroft __iomem| 3466c72ffaaSAndy Whitcroft __must_check| 3476c72ffaaSAndy Whitcroft __init_refok| 348417495edSAndy Whitcroft __kprobes| 349165e72a6SSven Eckelmann __ref| 350ad315455SBoqun Feng __rcu| 351ad315455SBoqun Feng __private 3526c72ffaaSAndy Whitcroft }x; 353e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 354e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 355e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 356e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 357e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 3588716de38SJoe Perches 35952131292SWolfram Sang# Notes to $Attribute: 36052131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 3616c72ffaaSAndy Whitcroftour $Attribute = qr{ 3626c72ffaaSAndy Whitcroft const| 36303f1df7dSJoe Perches __percpu| 36403f1df7dSJoe Perches __nocast| 36503f1df7dSJoe Perches __safe| 36646d832f5SMichael S. Tsirkin __bitwise| 36703f1df7dSJoe Perches __packed__| 36803f1df7dSJoe Perches __packed2__| 36903f1df7dSJoe Perches __naked| 37003f1df7dSJoe Perches __maybe_unused| 37103f1df7dSJoe Perches __always_unused| 37203f1df7dSJoe Perches __noreturn| 37303f1df7dSJoe Perches __used| 37403f1df7dSJoe Perches __cold| 375e23ef1f3SJoe Perches __pure| 37603f1df7dSJoe Perches __noclone| 37703f1df7dSJoe Perches __deprecated| 3786c72ffaaSAndy Whitcroft __read_mostly| 3796c72ffaaSAndy Whitcroft __kprobes| 3808716de38SJoe Perches $InitAttribute| 38124e1d81aSAndy Whitcroft ____cacheline_aligned| 38224e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 3835fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 3845fe3af11SAndy Whitcroft __weak 3856c72ffaaSAndy Whitcroft }x; 386c45dcabdSAndy Whitcroftour $Modifier; 38791cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 3886c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 3896c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 3906c72ffaaSAndy Whitcroft 39195e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 39295e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 39395e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 39495e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 3952435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 396c0a5c898SJoe Perchesour $String = qr{"[X\t]*"}; 397326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 398326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 399326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 40074349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 4012435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 402326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 403447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 40423f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 4056c72ffaaSAndy Whitcroftour $Operators = qr{ 4066c72ffaaSAndy Whitcroft <=|>=|==|!=| 4076c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 40823f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 4096c72ffaaSAndy Whitcroft }x; 4106c72ffaaSAndy Whitcroft 41191cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 41291cb5195SJoe Perches 413ab7e23f3SJoe Perchesour $BasicType; 4148905a67cSAndy Whitcroftour $NonptrType; 4151813087dSJoe Perchesour $NonptrTypeMisordered; 4168716de38SJoe Perchesour $NonptrTypeWithAttr; 4178905a67cSAndy Whitcroftour $Type; 4181813087dSJoe Perchesour $TypeMisordered; 4198905a67cSAndy Whitcroftour $Declare; 4201813087dSJoe Perchesour $DeclareMisordered; 4218905a67cSAndy Whitcroft 42215662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 42315662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 424171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 425171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 426171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 427171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 428171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 429171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 430171ae1a4SAndy Whitcroft}x; 431171ae1a4SAndy Whitcroft 43215662b3eSJoe Perchesour $UTF8 = qr{ 43315662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 43415662b3eSJoe Perches | $NON_ASCII_UTF8 43515662b3eSJoe Perches}x; 43615662b3eSJoe Perches 437e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 438021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 439021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 440021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 441021158b4SJoe Perches)}; 442e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 443fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 4448ed22cadSAndy Whitcroft atomic_t 4458ed22cadSAndy Whitcroft)}; 446e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 447e6176fa4SJoe Perches $typeC99Typedefs\b| 448e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 449e6176fa4SJoe Perches $typeKernelTypedefs\b 450e6176fa4SJoe Perches)}; 4518ed22cadSAndy Whitcroft 4526d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 4536d32f7a3SJoe Perches 454691e669bSJoe Perchesour $logFunctions = qr{(?x: 455758d7aadSMiles Chen printk(?:_ratelimited|_once|_deferred_once|_deferred|)| 4567d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 4576e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 458b0531722SJoe Perches panic| 45906668727SJoe Perches MODULE_[A-Z_]+| 46006668727SJoe Perches seq_vprintf|seq_printf|seq_puts 461691e669bSJoe Perches)}; 462691e669bSJoe Perches 46320112475SJoe Perchesour $signature_tags = qr{(?xi: 46420112475SJoe Perches Signed-off-by:| 46520112475SJoe Perches Acked-by:| 46620112475SJoe Perches Tested-by:| 46720112475SJoe Perches Reviewed-by:| 46820112475SJoe Perches Reported-by:| 4698543ae12SMugunthan V N Suggested-by:| 47020112475SJoe Perches To:| 47120112475SJoe Perches Cc: 47220112475SJoe Perches)}; 47320112475SJoe Perches 4741813087dSJoe Perchesour @typeListMisordered = ( 4751813087dSJoe Perches qr{char\s+(?:un)?signed}, 4761813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 4771813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 4781813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 4791813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 4801813087dSJoe Perches qr{short\s+(?:un)?signed}, 4811813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 4821813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 4831813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 4841813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 4851813087dSJoe Perches qr{int\s+(?:un)?signed}, 4861813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 4871813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 4881813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 4891813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 4901813087dSJoe Perches qr{long\s+(?:un)?signed}, 4911813087dSJoe Perches); 4921813087dSJoe Perches 4938905a67cSAndy Whitcroftour @typeList = ( 4948905a67cSAndy Whitcroft qr{void}, 4950c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 4960c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 4970c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 4980c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 4990c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 5000c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 5010c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 5020c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 5030c773d9dSJoe Perches qr{(?:un)?signed}, 5048905a67cSAndy Whitcroft qr{float}, 5058905a67cSAndy Whitcroft qr{double}, 5068905a67cSAndy Whitcroft qr{bool}, 5078905a67cSAndy Whitcroft qr{struct\s+$Ident}, 5088905a67cSAndy Whitcroft qr{union\s+$Ident}, 5098905a67cSAndy Whitcroft qr{enum\s+$Ident}, 5108905a67cSAndy Whitcroft qr{${Ident}_t}, 5118905a67cSAndy Whitcroft qr{${Ident}_handler}, 5128905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 5131813087dSJoe Perches @typeListMisordered, 5148905a67cSAndy Whitcroft); 515938224b5SJoe Perches 516938224b5SJoe Perchesour $C90_int_types = qr{(?x: 517938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 518938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 519938224b5SJoe Perches long\s+long\s+(?:un)?signed| 520938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 521938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 522938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 523938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 524938224b5SJoe Perches 525938224b5SJoe Perches long\s+int\s+(?:un)?signed| 526938224b5SJoe Perches long\s+(?:un)?signed\s+int| 527938224b5SJoe Perches long\s+(?:un)?signed| 528938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 529938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 530938224b5SJoe Perches int\s+long\s+(?:un)?signed| 531938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 532938224b5SJoe Perches 533938224b5SJoe Perches int\s+(?:un)?signed| 534938224b5SJoe Perches (?:(?:un)?signed\s+)?int 535938224b5SJoe Perches)}; 536938224b5SJoe Perches 537485ff23eSAlex Dowadour @typeListFile = (); 5388716de38SJoe Perchesour @typeListWithAttr = ( 5398716de38SJoe Perches @typeList, 5408716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 5418716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 5428716de38SJoe Perches); 5438716de38SJoe Perches 544c45dcabdSAndy Whitcroftour @modifierList = ( 545c45dcabdSAndy Whitcroft qr{fastcall}, 546c45dcabdSAndy Whitcroft); 547485ff23eSAlex Dowadour @modifierListFile = (); 5488905a67cSAndy Whitcroft 5492435880fSJoe Perchesour @mode_permission_funcs = ( 5502435880fSJoe Perches ["module_param", 3], 5512435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 5522435880fSJoe Perches ["module_param_array_named", 5], 5532435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 5542435880fSJoe Perches ["proc_create(?:_data|)", 2], 555459cf0aeSJoe Perches ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2], 556459cf0aeSJoe Perches ["IIO_DEV_ATTR_[A-Z_]+", 1], 557459cf0aeSJoe Perches ["SENSOR_(?:DEVICE_|)ATTR_2", 2], 558459cf0aeSJoe Perches ["SENSOR_TEMPLATE(?:_2|)", 3], 559459cf0aeSJoe Perches ["__ATTR", 2], 5602435880fSJoe Perches); 5612435880fSJoe Perches 562515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 563515a235eSJoe Perchesour $mode_perms_search = ""; 564515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 565515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 566515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 567515a235eSJoe Perches} 568515a235eSJoe Perches 569b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 570b392c64fSJoe Perches S_IWUGO | 571b392c64fSJoe Perches S_IWOTH | 572b392c64fSJoe Perches S_IRWXUGO | 573b392c64fSJoe Perches S_IALLUGO | 574b392c64fSJoe Perches 0[0-7][0-7][2367] 575b392c64fSJoe Perches}x; 576b392c64fSJoe Perches 577f90774e1SJoe Perchesour %mode_permission_string_types = ( 578f90774e1SJoe Perches "S_IRWXU" => 0700, 579f90774e1SJoe Perches "S_IRUSR" => 0400, 580f90774e1SJoe Perches "S_IWUSR" => 0200, 581f90774e1SJoe Perches "S_IXUSR" => 0100, 582f90774e1SJoe Perches "S_IRWXG" => 0070, 583f90774e1SJoe Perches "S_IRGRP" => 0040, 584f90774e1SJoe Perches "S_IWGRP" => 0020, 585f90774e1SJoe Perches "S_IXGRP" => 0010, 586f90774e1SJoe Perches "S_IRWXO" => 0007, 587f90774e1SJoe Perches "S_IROTH" => 0004, 588f90774e1SJoe Perches "S_IWOTH" => 0002, 589f90774e1SJoe Perches "S_IXOTH" => 0001, 590f90774e1SJoe Perches "S_IRWXUGO" => 0777, 591f90774e1SJoe Perches "S_IRUGO" => 0444, 592f90774e1SJoe Perches "S_IWUGO" => 0222, 593f90774e1SJoe Perches "S_IXUGO" => 0111, 594f90774e1SJoe Perches); 595f90774e1SJoe Perches 596f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below 597f90774e1SJoe Perchesour $mode_perms_string_search = ""; 598f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) { 599f90774e1SJoe Perches $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); 600f90774e1SJoe Perches $mode_perms_string_search .= $entry; 601f90774e1SJoe Perches} 602f90774e1SJoe Perches 6037840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 6047840a94cSWolfram Sang irq| 605cdcee686SSergey Ryazanov memory| 606cdcee686SSergey Ryazanov time| 607cdcee686SSergey Ryazanov reboot 6087840a94cSWolfram Sang)}; 6097840a94cSWolfram Sang# memory.h: ARM has a custom one 6107840a94cSWolfram Sang 61166b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 61266b47b4aSKees Cookmy $misspellings; 61366b47b4aSKees Cookmy %spelling_fix; 61436061e38SJoe Perches 61536061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 61666b47b4aSKees Cook while (<$spelling>) { 61766b47b4aSKees Cook my $line = $_; 61866b47b4aSKees Cook 61966b47b4aSKees Cook $line =~ s/\s*\n?$//g; 62066b47b4aSKees Cook $line =~ s/^\s*//g; 62166b47b4aSKees Cook 62266b47b4aSKees Cook next if ($line =~ m/^\s*#/); 62366b47b4aSKees Cook next if ($line =~ m/^\s*$/); 62466b47b4aSKees Cook 62566b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 62666b47b4aSKees Cook 62766b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 62866b47b4aSKees Cook } 62966b47b4aSKees Cook close($spelling); 63036061e38SJoe Perches} else { 63136061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 63236061e38SJoe Perches} 63366b47b4aSKees Cook 634ebfd7d62SJoe Perchesif ($codespell) { 635ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 636ebfd7d62SJoe Perches while (<$spelling>) { 637ebfd7d62SJoe Perches my $line = $_; 638ebfd7d62SJoe Perches 639ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 640ebfd7d62SJoe Perches $line =~ s/^\s*//g; 641ebfd7d62SJoe Perches 642ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 643ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 644ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 645ebfd7d62SJoe Perches 646ebfd7d62SJoe Perches $line =~ s/,.*$//; 647ebfd7d62SJoe Perches 648ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 649ebfd7d62SJoe Perches 650ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 651ebfd7d62SJoe Perches } 652ebfd7d62SJoe Perches close($spelling); 653ebfd7d62SJoe Perches } else { 654ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 655ebfd7d62SJoe Perches } 656ebfd7d62SJoe Perches} 657ebfd7d62SJoe Perches 658ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 659ebfd7d62SJoe Perches 66075ad8c57SJerome Forissiersub read_words { 66175ad8c57SJerome Forissier my ($wordsRef, $file) = @_; 66275ad8c57SJerome Forissier 66375ad8c57SJerome Forissier if (open(my $words, '<', $file)) { 66475ad8c57SJerome Forissier while (<$words>) { 665bf1fa1daSJoe Perches my $line = $_; 666bf1fa1daSJoe Perches 667bf1fa1daSJoe Perches $line =~ s/\s*\n?$//g; 668bf1fa1daSJoe Perches $line =~ s/^\s*//g; 669bf1fa1daSJoe Perches 670bf1fa1daSJoe Perches next if ($line =~ m/^\s*#/); 671bf1fa1daSJoe Perches next if ($line =~ m/^\s*$/); 672bf1fa1daSJoe Perches if ($line =~ /\s/) { 67375ad8c57SJerome Forissier print("$file: '$line' invalid - ignored\n"); 674bf1fa1daSJoe Perches next; 675bf1fa1daSJoe Perches } 676bf1fa1daSJoe Perches 67775ad8c57SJerome Forissier $$wordsRef .= '|' if ($$wordsRef ne ""); 67875ad8c57SJerome Forissier $$wordsRef .= $line; 679bf1fa1daSJoe Perches } 68075ad8c57SJerome Forissier close($file); 68175ad8c57SJerome Forissier return 1; 682bf1fa1daSJoe Perches } 683bf1fa1daSJoe Perches 68475ad8c57SJerome Forissier return 0; 68575ad8c57SJerome Forissier} 68675ad8c57SJerome Forissier 68775ad8c57SJerome Forissiermy $const_structs = ""; 68875ad8c57SJerome Forissierread_words(\$const_structs, $conststructsfile) 68975ad8c57SJerome Forissier or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 69075ad8c57SJerome Forissier 69175ad8c57SJerome Forissiermy $typeOtherTypedefs = ""; 69275ad8c57SJerome Forissierif (length($typedefsfile)) { 69375ad8c57SJerome Forissier read_words(\$typeOtherTypedefs, $typedefsfile) 69475ad8c57SJerome Forissier or warn "No additional types will be considered - file '$typedefsfile': $!\n"; 69575ad8c57SJerome Forissier} 69675ad8c57SJerome Forissier$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne ""); 69775ad8c57SJerome Forissier 6988905a67cSAndy Whitcroftsub build_types { 699485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 700485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 7011813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 7028716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 703c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 704ab7e23f3SJoe Perches $BasicType = qr{ 705ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 706ab7e23f3SJoe Perches (?:${all}\b) 707ab7e23f3SJoe Perches }x; 7088905a67cSAndy Whitcroft $NonptrType = qr{ 709d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 710cf655043SAndy Whitcroft (?: 7116b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 7128ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 713c45dcabdSAndy Whitcroft (?:${all}\b) 714cf655043SAndy Whitcroft ) 715c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 7168905a67cSAndy Whitcroft }x; 7171813087dSJoe Perches $NonptrTypeMisordered = qr{ 7181813087dSJoe Perches (?:$Modifier\s+|const\s+)* 7191813087dSJoe Perches (?: 7201813087dSJoe Perches (?:${Misordered}\b) 7211813087dSJoe Perches ) 7221813087dSJoe Perches (?:\s+$Modifier|\s+const)* 7231813087dSJoe Perches }x; 7248716de38SJoe Perches $NonptrTypeWithAttr = qr{ 7258716de38SJoe Perches (?:$Modifier\s+|const\s+)* 7268716de38SJoe Perches (?: 7278716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 7288716de38SJoe Perches (?:$typeTypedefs\b)| 7298716de38SJoe Perches (?:${allWithAttr}\b) 7308716de38SJoe Perches ) 7318716de38SJoe Perches (?:\s+$Modifier|\s+const)* 7328716de38SJoe Perches }x; 7338905a67cSAndy Whitcroft $Type = qr{ 734c45dcabdSAndy Whitcroft $NonptrType 7351574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 736c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 7378905a67cSAndy Whitcroft }x; 7381813087dSJoe Perches $TypeMisordered = qr{ 7391813087dSJoe Perches $NonptrTypeMisordered 7401813087dSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 7411813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 7421813087dSJoe Perches }x; 74391cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 7441813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 7458905a67cSAndy Whitcroft} 7468905a67cSAndy Whitcroftbuild_types(); 7476c72ffaaSAndy Whitcroft 7487d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 749d1fe9c09SJoe Perches 750d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 751d1fe9c09SJoe Perches# requires at least perl version v5.10.0 752d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 753d1fe9c09SJoe Perches 754d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 7552435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 756c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 7577d2367afSJoe Perches 758f8422308SJoe Perchesour $declaration_macros = qr{(?x: 7593e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 760fe658f94SSteffen Maier (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(| 761f8422308SJoe Perches (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\( 762f8422308SJoe Perches)}; 763f8422308SJoe Perches 7647d2367afSJoe Perchessub deparenthesize { 7657d2367afSJoe Perches my ($string) = @_; 7667d2367afSJoe Perches return "" if (!defined($string)); 7675b9553abSJoe Perches 7685b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 7695b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 7705b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 7715b9553abSJoe Perches } 7725b9553abSJoe Perches 7737d2367afSJoe Perches $string =~ s@\s+@ @g; 7745b9553abSJoe Perches 7757d2367afSJoe Perches return $string; 7767d2367afSJoe Perches} 7777d2367afSJoe Perches 7783445686aSJoe Perchessub seed_camelcase_file { 7793445686aSJoe Perches my ($file) = @_; 7803445686aSJoe Perches 7813445686aSJoe Perches return if (!(-f $file)); 7823445686aSJoe Perches 7833445686aSJoe Perches local $/; 7843445686aSJoe Perches 7853445686aSJoe Perches open(my $include_file, '<', "$file") 7863445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 7873445686aSJoe Perches my $text = <$include_file>; 7883445686aSJoe Perches close($include_file); 7893445686aSJoe Perches 7903445686aSJoe Perches my @lines = split('\n', $text); 7913445686aSJoe Perches 7923445686aSJoe Perches foreach my $line (@lines) { 7933445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 7943445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 7953445686aSJoe Perches $camelcase{$1} = 1; 79611ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 79711ea516aSJoe Perches $camelcase{$1} = 1; 79811ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 7993445686aSJoe Perches $camelcase{$1} = 1; 8003445686aSJoe Perches } 8013445686aSJoe Perches } 8023445686aSJoe Perches} 8033445686aSJoe Perches 80485b0ee18SJoe Perchessub is_maintained_obsolete { 80585b0ee18SJoe Perches my ($filename) = @_; 80685b0ee18SJoe Perches 807f2c19c2fSJerome Forissier return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 80885b0ee18SJoe Perches 8090616efa4SJoe Perches my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 81085b0ee18SJoe Perches 81185b0ee18SJoe Perches return $status =~ /obsolete/i; 81285b0ee18SJoe Perches} 81385b0ee18SJoe Perches 8143445686aSJoe Perchesmy $camelcase_seeded = 0; 8153445686aSJoe Perchessub seed_camelcase_includes { 8163445686aSJoe Perches return if ($camelcase_seeded); 8173445686aSJoe Perches 8183445686aSJoe Perches my $files; 819c707a81dSJoe Perches my $camelcase_cache = ""; 820c707a81dSJoe Perches my @include_files = (); 821c707a81dSJoe Perches 822c707a81dSJoe Perches $camelcase_seeded = 1; 823351b2a1fSJoe Perches 8243645e328SRichard Genoud if (-e ".git") { 825351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 826351b2a1fSJoe Perches chomp $git_last_include_commit; 827c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 828c707a81dSJoe Perches } else { 829c707a81dSJoe Perches my $last_mod_date = 0; 830c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 831c707a81dSJoe Perches @include_files = split('\n', $files); 832c707a81dSJoe Perches foreach my $file (@include_files) { 833c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 834c707a81dSJoe Perches localtime((stat $file)[9])); 835c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 836c707a81dSJoe Perches } 837c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 838c707a81dSJoe Perches } 839c707a81dSJoe Perches 840c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 841c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 842c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 843351b2a1fSJoe Perches while (<$camelcase_file>) { 844351b2a1fSJoe Perches chomp; 845351b2a1fSJoe Perches $camelcase{$_} = 1; 846351b2a1fSJoe Perches } 847351b2a1fSJoe Perches close($camelcase_file); 848351b2a1fSJoe Perches 849351b2a1fSJoe Perches return; 850351b2a1fSJoe Perches } 851c707a81dSJoe Perches 8523645e328SRichard Genoud if (-e ".git") { 853c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 854c707a81dSJoe Perches @include_files = split('\n', $files); 8553445686aSJoe Perches } 856c707a81dSJoe Perches 8573445686aSJoe Perches foreach my $file (@include_files) { 8583445686aSJoe Perches seed_camelcase_file($file); 8593445686aSJoe Perches } 860351b2a1fSJoe Perches 861c707a81dSJoe Perches if ($camelcase_cache ne "") { 862351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 863c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 864c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 865351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 866351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 867351b2a1fSJoe Perches } 868351b2a1fSJoe Perches close($camelcase_file); 869351b2a1fSJoe Perches } 8703445686aSJoe Perches} 8713445686aSJoe Perches 872d311cd44SJoe Perchessub git_commit_info { 873d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 874d311cd44SJoe Perches 875d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 876d311cd44SJoe Perches 877d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 878d311cd44SJoe Perches $output =~ s/^\s*//gm; 879d311cd44SJoe Perches my @lines = split("\n", $output); 880d311cd44SJoe Perches 8810d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 8820d7835fcSJoe Perches 883d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 884d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 885d311cd44SJoe Perches# all matching commit ids, but it's very slow... 886d311cd44SJoe Perches# 887d311cd44SJoe Perches# echo "checking commits $1..." 888d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 889d311cd44SJoe Perches# while read line ; do 890d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 891d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 892d311cd44SJoe Perches# done 893d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 894948b133aSHeinrich Schuchardt $id = undef; 895d311cd44SJoe Perches } else { 896d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 897d311cd44SJoe Perches $desc = substr($lines[0], 41); 898d311cd44SJoe Perches } 899d311cd44SJoe Perches 900d311cd44SJoe Perches return ($id, $desc); 901d311cd44SJoe Perches} 902d311cd44SJoe Perches 9036c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 9040a920b5bSAndy Whitcroft 90500df344fSAndy Whitcroftmy @rawlines = (); 906c2fdda0dSAndy Whitcroftmy @lines = (); 9073705ce5bSJoe Perchesmy @fixed = (); 908d752fcc8SJoe Perchesmy @fixed_inserted = (); 909d752fcc8SJoe Perchesmy @fixed_deleted = (); 910194f66fcSJoe Perchesmy $fixlinenr = -1; 911194f66fcSJoe Perches 9124a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 9134a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 9144a593c34SDu, Changbindie "$P: No git repository found\n" if ($git && !-e ".git"); 9154a593c34SDu, Changbin 9164a593c34SDu, Changbinif ($git) { 9174a593c34SDu, Changbin my @commits = (); 9180dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 9194a593c34SDu, Changbin my $git_range; 92028898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 92128898fd1SJoe Perches $git_range = "-$2 $1"; 9224a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 9234a593c34SDu, Changbin $git_range = "$commit_expr"; 9244a593c34SDu, Changbin } else { 9250dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 9260dea9f1eSJoe Perches } 9270dea9f1eSJoe Perches my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 9280dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 92928898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 93028898fd1SJoe Perches next if (!defined($1) || !defined($2)); 9310dea9f1eSJoe Perches my $sha1 = $1; 9320dea9f1eSJoe Perches my $subject = $2; 9330dea9f1eSJoe Perches unshift(@commits, $sha1); 9340dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 9354a593c34SDu, Changbin } 9364a593c34SDu, Changbin } 9374a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 9384a593c34SDu, Changbin @ARGV = @commits; 9394a593c34SDu, Changbin} 9404a593c34SDu, Changbin 941c2fdda0dSAndy Whitcroftmy $vname; 9426c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 94321caa13cSAndy Whitcroft my $FILE; 9444a593c34SDu, Changbin if ($git) { 9454a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 9464a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 9474a593c34SDu, Changbin } elsif ($file) { 94821caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 9496c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 95021caa13cSAndy Whitcroft } elsif ($filename eq '-') { 95121caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 9526c72ffaaSAndy Whitcroft } else { 95321caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 9546c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 9556c72ffaaSAndy Whitcroft } 956c2fdda0dSAndy Whitcroft if ($filename eq '-') { 957c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 9584a593c34SDu, Changbin } elsif ($git) { 9590dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 960c2fdda0dSAndy Whitcroft } else { 961c2fdda0dSAndy Whitcroft $vname = $filename; 962c2fdda0dSAndy Whitcroft } 96321caa13cSAndy Whitcroft while (<$FILE>) { 9640a920b5bSAndy Whitcroft chomp; 96500df344fSAndy Whitcroft push(@rawlines, $_); 9666c72ffaaSAndy Whitcroft } 96721caa13cSAndy Whitcroft close($FILE); 968d8469f16SJoe Perches 969d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 970d8469f16SJoe Perches print '-' x length($vname) . "\n"; 971d8469f16SJoe Perches print "$vname\n"; 972d8469f16SJoe Perches print '-' x length($vname) . "\n"; 973d8469f16SJoe Perches } 974d8469f16SJoe Perches 975c2fdda0dSAndy Whitcroft if (!process($filename)) { 9760a920b5bSAndy Whitcroft $exit = 1; 9770a920b5bSAndy Whitcroft } 97800df344fSAndy Whitcroft @rawlines = (); 97913214adfSAndy Whitcroft @lines = (); 9803705ce5bSJoe Perches @fixed = (); 981d752fcc8SJoe Perches @fixed_inserted = (); 982d752fcc8SJoe Perches @fixed_deleted = (); 983194f66fcSJoe Perches $fixlinenr = -1; 984485ff23eSAlex Dowad @modifierListFile = (); 985485ff23eSAlex Dowad @typeListFile = (); 986485ff23eSAlex Dowad build_types(); 9870a920b5bSAndy Whitcroft} 9880a920b5bSAndy Whitcroft 989d8469f16SJoe Perchesif (!$quiet) { 9903c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 9913c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 9923c816e49SJoe Perches 993d8469f16SJoe Perches if ($^V lt 5.10.0) { 994d8469f16SJoe Perches print << "EOM" 995d8469f16SJoe Perches 996d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 997d8469f16SJoe Perches An upgrade to at least perl v5.10.0 is suggested. 998d8469f16SJoe PerchesEOM 999d8469f16SJoe Perches } 1000d8469f16SJoe Perches if ($exit) { 1001d8469f16SJoe Perches print << "EOM" 1002d8469f16SJoe Perches 1003d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 1004d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 1005d8469f16SJoe PerchesEOM 1006d8469f16SJoe Perches } 1007d8469f16SJoe Perches} 1008d8469f16SJoe Perches 10090a920b5bSAndy Whitcroftexit($exit); 10100a920b5bSAndy Whitcroft 10110a920b5bSAndy Whitcroftsub top_of_kernel_tree { 10126c72ffaaSAndy Whitcroft my ($root) = @_; 10136c72ffaaSAndy Whitcroft 10146c72ffaaSAndy Whitcroft my @tree_check = ( 10156c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 10166c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 10176c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 10186c72ffaaSAndy Whitcroft ); 10196c72ffaaSAndy Whitcroft 10206c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 10216c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 10220a920b5bSAndy Whitcroft return 0; 10230a920b5bSAndy Whitcroft } 10246c72ffaaSAndy Whitcroft } 10256c72ffaaSAndy Whitcroft return 1; 10266c72ffaaSAndy Whitcroft} 10270a920b5bSAndy Whitcroft 102820112475SJoe Perchessub parse_email { 102920112475SJoe Perches my ($formatted_email) = @_; 103020112475SJoe Perches 103120112475SJoe Perches my $name = ""; 103220112475SJoe Perches my $address = ""; 103320112475SJoe Perches my $comment = ""; 103420112475SJoe Perches 103520112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 103620112475SJoe Perches $name = $1; 103720112475SJoe Perches $address = $2; 103820112475SJoe Perches $comment = $3 if defined $3; 103920112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 104020112475SJoe Perches $address = $1; 104120112475SJoe Perches $comment = $2 if defined $2; 104220112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 104320112475SJoe Perches $address = $1; 104420112475SJoe Perches $comment = $2 if defined $2; 104520112475SJoe Perches $formatted_email =~ s/$address.*$//; 104620112475SJoe Perches $name = $formatted_email; 10473705ce5bSJoe Perches $name = trim($name); 104820112475SJoe Perches $name =~ s/^\"|\"$//g; 104920112475SJoe Perches # If there's a name left after stripping spaces and 105020112475SJoe Perches # leading quotes, and the address doesn't have both 105120112475SJoe Perches # leading and trailing angle brackets, the address 105220112475SJoe Perches # is invalid. ie: 105320112475SJoe Perches # "joe smith [email protected]" bad 105420112475SJoe Perches # "joe smith <[email protected]" bad 105520112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 105620112475SJoe Perches $name = ""; 105720112475SJoe Perches $address = ""; 105820112475SJoe Perches $comment = ""; 105920112475SJoe Perches } 106020112475SJoe Perches } 106120112475SJoe Perches 10623705ce5bSJoe Perches $name = trim($name); 106320112475SJoe Perches $name =~ s/^\"|\"$//g; 10643705ce5bSJoe Perches $address = trim($address); 106520112475SJoe Perches $address =~ s/^\<|\>$//g; 106620112475SJoe Perches 106720112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 106820112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 106920112475SJoe Perches $name = "\"$name\""; 107020112475SJoe Perches } 107120112475SJoe Perches 107220112475SJoe Perches return ($name, $address, $comment); 107320112475SJoe Perches} 107420112475SJoe Perches 107520112475SJoe Perchessub format_email { 107620112475SJoe Perches my ($name, $address) = @_; 107720112475SJoe Perches 107820112475SJoe Perches my $formatted_email; 107920112475SJoe Perches 10803705ce5bSJoe Perches $name = trim($name); 108120112475SJoe Perches $name =~ s/^\"|\"$//g; 10823705ce5bSJoe Perches $address = trim($address); 108320112475SJoe Perches 108420112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 108520112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 108620112475SJoe Perches $name = "\"$name\""; 108720112475SJoe Perches } 108820112475SJoe Perches 108920112475SJoe Perches if ("$name" eq "") { 109020112475SJoe Perches $formatted_email = "$address"; 109120112475SJoe Perches } else { 109220112475SJoe Perches $formatted_email = "$name <$address>"; 109320112475SJoe Perches } 109420112475SJoe Perches 109520112475SJoe Perches return $formatted_email; 109620112475SJoe Perches} 109720112475SJoe Perches 1098d311cd44SJoe Perchessub which { 1099d311cd44SJoe Perches my ($bin) = @_; 1100d311cd44SJoe Perches 1101d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1102d311cd44SJoe Perches if (-e "$path/$bin") { 1103d311cd44SJoe Perches return "$path/$bin"; 1104d311cd44SJoe Perches } 1105d311cd44SJoe Perches } 1106d311cd44SJoe Perches 1107d311cd44SJoe Perches return ""; 1108d311cd44SJoe Perches} 1109d311cd44SJoe Perches 1110000d1cc1SJoe Perchessub which_conf { 1111000d1cc1SJoe Perches my ($conf) = @_; 1112000d1cc1SJoe Perches 1113000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1114000d1cc1SJoe Perches if (-e "$path/$conf") { 1115000d1cc1SJoe Perches return "$path/$conf"; 1116000d1cc1SJoe Perches } 1117000d1cc1SJoe Perches } 1118000d1cc1SJoe Perches 1119000d1cc1SJoe Perches return ""; 1120000d1cc1SJoe Perches} 1121000d1cc1SJoe Perches 11220a920b5bSAndy Whitcroftsub expand_tabs { 11230a920b5bSAndy Whitcroft my ($str) = @_; 11240a920b5bSAndy Whitcroft 11250a920b5bSAndy Whitcroft my $res = ''; 11260a920b5bSAndy Whitcroft my $n = 0; 11270a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 11280a920b5bSAndy Whitcroft if ($c eq "\t") { 11290a920b5bSAndy Whitcroft $res .= ' '; 11300a920b5bSAndy Whitcroft $n++; 11310a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 11320a920b5bSAndy Whitcroft $res .= ' '; 11330a920b5bSAndy Whitcroft } 11340a920b5bSAndy Whitcroft next; 11350a920b5bSAndy Whitcroft } 11360a920b5bSAndy Whitcroft $res .= $c; 11370a920b5bSAndy Whitcroft $n++; 11380a920b5bSAndy Whitcroft } 11390a920b5bSAndy Whitcroft 11400a920b5bSAndy Whitcroft return $res; 11410a920b5bSAndy Whitcroft} 11426c72ffaaSAndy Whitcroftsub copy_spacing { 1143773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 11446c72ffaaSAndy Whitcroft return $res; 11456c72ffaaSAndy Whitcroft} 11460a920b5bSAndy Whitcroft 11474a0df2efSAndy Whitcroftsub line_stats { 11484a0df2efSAndy Whitcroft my ($line) = @_; 11494a0df2efSAndy Whitcroft 11504a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 11514a0df2efSAndy Whitcroft $line =~ s/^.//; 11524a0df2efSAndy Whitcroft $line = expand_tabs($line); 11534a0df2efSAndy Whitcroft 11544a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 11554a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 11564a0df2efSAndy Whitcroft 11574a0df2efSAndy Whitcroft return (length($line), length($white)); 11584a0df2efSAndy Whitcroft} 11594a0df2efSAndy Whitcroft 1160773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1161773647a0SAndy Whitcroft 1162773647a0SAndy Whitcroftsub sanitise_line_reset { 1163773647a0SAndy Whitcroft my ($in_comment) = @_; 1164773647a0SAndy Whitcroft 1165773647a0SAndy Whitcroft if ($in_comment) { 1166773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1167773647a0SAndy Whitcroft } else { 1168773647a0SAndy Whitcroft $sanitise_quote = ''; 1169773647a0SAndy Whitcroft } 1170773647a0SAndy Whitcroft} 117100df344fSAndy Whitcroftsub sanitise_line { 117200df344fSAndy Whitcroft my ($line) = @_; 117300df344fSAndy Whitcroft 117400df344fSAndy Whitcroft my $res = ''; 117500df344fSAndy Whitcroft my $l = ''; 117600df344fSAndy Whitcroft 1177c2fdda0dSAndy Whitcroft my $qlen = 0; 1178773647a0SAndy Whitcroft my $off = 0; 1179773647a0SAndy Whitcroft my $c; 118000df344fSAndy Whitcroft 1181773647a0SAndy Whitcroft # Always copy over the diff marker. 1182773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1183773647a0SAndy Whitcroft 1184773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1185773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1186773647a0SAndy Whitcroft 1187773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 1188773647a0SAndy Whitcroft # and end, all to $;. 1189773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1190773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1191773647a0SAndy Whitcroft 1192773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1193773647a0SAndy Whitcroft $off++; 119400df344fSAndy Whitcroft next; 1195773647a0SAndy Whitcroft } 119681bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1197773647a0SAndy Whitcroft $sanitise_quote = ''; 1198773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1199773647a0SAndy Whitcroft $off++; 1200773647a0SAndy Whitcroft next; 1201773647a0SAndy Whitcroft } 1202113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1203113f04a8SDaniel Walker $sanitise_quote = '//'; 1204113f04a8SDaniel Walker 1205113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1206113f04a8SDaniel Walker $off++; 1207113f04a8SDaniel Walker next; 1208113f04a8SDaniel Walker } 1209773647a0SAndy Whitcroft 1210773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1211773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1212773647a0SAndy Whitcroft $c eq "\\") { 1213773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1214773647a0SAndy Whitcroft $off++; 1215773647a0SAndy Whitcroft next; 1216773647a0SAndy Whitcroft } 1217773647a0SAndy Whitcroft # Regular quotes. 1218773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1219773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1220773647a0SAndy Whitcroft $sanitise_quote = $c; 1221773647a0SAndy Whitcroft 1222773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1223773647a0SAndy Whitcroft next; 1224773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1225773647a0SAndy Whitcroft $sanitise_quote = ''; 122600df344fSAndy Whitcroft } 122700df344fSAndy Whitcroft } 1228773647a0SAndy Whitcroft 1229fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1230773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1231773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1232113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1233113f04a8SDaniel Walker substr($res, $off, 1, $;); 1234773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1235773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 123600df344fSAndy Whitcroft } else { 1237773647a0SAndy Whitcroft substr($res, $off, 1, $c); 123800df344fSAndy Whitcroft } 1239c2fdda0dSAndy Whitcroft } 1240c2fdda0dSAndy Whitcroft 1241113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1242113f04a8SDaniel Walker $sanitise_quote = ''; 1243113f04a8SDaniel Walker } 1244113f04a8SDaniel Walker 1245c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1246c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1247c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1248c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1249c2fdda0dSAndy Whitcroft 1250c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1251c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1252c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1253c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1254c2fdda0dSAndy Whitcroft } 1255c2fdda0dSAndy Whitcroft 1256dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1257dadf680dSJoe Perches my $match = $1; 1258dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1259dadf680dSJoe Perches } 1260dadf680dSJoe Perches 126100df344fSAndy Whitcroft return $res; 126200df344fSAndy Whitcroft} 126300df344fSAndy Whitcroft 1264a6962d72SJoe Perchessub get_quoted_string { 1265a6962d72SJoe Perches my ($line, $rawline) = @_; 1266a6962d72SJoe Perches 126733acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1268a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1269a6962d72SJoe Perches} 1270a6962d72SJoe Perches 12718905a67cSAndy Whitcroftsub ctx_statement_block { 12728905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 12738905a67cSAndy Whitcroft my $line = $linenr - 1; 12748905a67cSAndy Whitcroft my $blk = ''; 12758905a67cSAndy Whitcroft my $soff = $off; 12768905a67cSAndy Whitcroft my $coff = $off - 1; 1277773647a0SAndy Whitcroft my $coff_set = 0; 12788905a67cSAndy Whitcroft 127913214adfSAndy Whitcroft my $loff = 0; 128013214adfSAndy Whitcroft 12818905a67cSAndy Whitcroft my $type = ''; 12828905a67cSAndy Whitcroft my $level = 0; 1283a2750645SAndy Whitcroft my @stack = (); 1284cf655043SAndy Whitcroft my $p; 12858905a67cSAndy Whitcroft my $c; 12868905a67cSAndy Whitcroft my $len = 0; 128713214adfSAndy Whitcroft 128813214adfSAndy Whitcroft my $remainder; 12898905a67cSAndy Whitcroft while (1) { 1290a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1291a2750645SAndy Whitcroft 1292773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 12938905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 12948905a67cSAndy Whitcroft # context. 12958905a67cSAndy Whitcroft if ($off >= $len) { 12968905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1297dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1298c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 12998905a67cSAndy Whitcroft $remain--; 130013214adfSAndy Whitcroft $loff = $len; 1301c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 13028905a67cSAndy Whitcroft $len = length($blk); 13038905a67cSAndy Whitcroft $line++; 13048905a67cSAndy Whitcroft last; 13058905a67cSAndy Whitcroft } 13068905a67cSAndy Whitcroft # Bail if there is no further context. 13078905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 130813214adfSAndy Whitcroft if ($off >= $len) { 13098905a67cSAndy Whitcroft last; 13108905a67cSAndy Whitcroft } 1311f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1312f74bd194SAndy Whitcroft $level++; 1313f74bd194SAndy Whitcroft $type = '#'; 1314f74bd194SAndy Whitcroft } 13158905a67cSAndy Whitcroft } 1316cf655043SAndy Whitcroft $p = $c; 13178905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 131813214adfSAndy Whitcroft $remainder = substr($blk, $off); 13198905a67cSAndy Whitcroft 1320773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 13214635f4fbSAndy Whitcroft 13224635f4fbSAndy Whitcroft # Handle nested #if/#else. 13234635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 13244635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 13254635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 13264635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 13274635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 13284635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 13294635f4fbSAndy Whitcroft } 13304635f4fbSAndy Whitcroft 13318905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 13328905a67cSAndy Whitcroft # outermost level. 13338905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 13348905a67cSAndy Whitcroft last; 13358905a67cSAndy Whitcroft } 13368905a67cSAndy Whitcroft 133713214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1338773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1339773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1340773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1341773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1342773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1343773647a0SAndy Whitcroft $coff_set = 1; 1344773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1345773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 134613214adfSAndy Whitcroft } 134713214adfSAndy Whitcroft 13488905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 13498905a67cSAndy Whitcroft $level++; 13508905a67cSAndy Whitcroft $type = '('; 13518905a67cSAndy Whitcroft } 13528905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 13538905a67cSAndy Whitcroft $level--; 13548905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 13558905a67cSAndy Whitcroft 13568905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 13578905a67cSAndy Whitcroft $coff = $off; 1358773647a0SAndy Whitcroft $coff_set = 1; 1359773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 13608905a67cSAndy Whitcroft } 13618905a67cSAndy Whitcroft } 13628905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 13638905a67cSAndy Whitcroft $level++; 13648905a67cSAndy Whitcroft $type = '{'; 13658905a67cSAndy Whitcroft } 13668905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 13678905a67cSAndy Whitcroft $level--; 13688905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 13698905a67cSAndy Whitcroft 13708905a67cSAndy Whitcroft if ($level == 0) { 1371b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1372b998e001SPatrick Pannuto $off++; 1373b998e001SPatrick Pannuto } 13748905a67cSAndy Whitcroft last; 13758905a67cSAndy Whitcroft } 13768905a67cSAndy Whitcroft } 1377f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1378f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1379f74bd194SAndy Whitcroft $level--; 1380f74bd194SAndy Whitcroft $type = ''; 1381f74bd194SAndy Whitcroft $off++; 1382f74bd194SAndy Whitcroft last; 1383f74bd194SAndy Whitcroft } 13848905a67cSAndy Whitcroft $off++; 13858905a67cSAndy Whitcroft } 1386a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 138713214adfSAndy Whitcroft if ($off == $len) { 1388a3bb97a7SAndy Whitcroft $loff = $len + 1; 138913214adfSAndy Whitcroft $line++; 139013214adfSAndy Whitcroft $remain--; 139113214adfSAndy Whitcroft } 13928905a67cSAndy Whitcroft 13938905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 13948905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 13958905a67cSAndy Whitcroft 13968905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 13978905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 13988905a67cSAndy Whitcroft 1399773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 140013214adfSAndy Whitcroft 140113214adfSAndy Whitcroft return ($statement, $condition, 140213214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 140313214adfSAndy Whitcroft} 140413214adfSAndy Whitcroft 1405cf655043SAndy Whitcroftsub statement_lines { 1406cf655043SAndy Whitcroft my ($stmt) = @_; 1407cf655043SAndy Whitcroft 1408cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1409cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1410cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1411cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1412cf655043SAndy Whitcroft 1413cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1414cf655043SAndy Whitcroft 1415cf655043SAndy Whitcroft return $#stmt_lines + 2; 1416cf655043SAndy Whitcroft} 1417cf655043SAndy Whitcroft 1418cf655043SAndy Whitcroftsub statement_rawlines { 1419cf655043SAndy Whitcroft my ($stmt) = @_; 1420cf655043SAndy Whitcroft 1421cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1422cf655043SAndy Whitcroft 1423cf655043SAndy Whitcroft return $#stmt_lines + 2; 1424cf655043SAndy Whitcroft} 1425cf655043SAndy Whitcroft 1426cf655043SAndy Whitcroftsub statement_block_size { 1427cf655043SAndy Whitcroft my ($stmt) = @_; 1428cf655043SAndy Whitcroft 1429cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1430cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1431cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1432cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1433cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1434cf655043SAndy Whitcroft 1435cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1436cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1437cf655043SAndy Whitcroft 1438cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1439cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1440cf655043SAndy Whitcroft 1441cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1442cf655043SAndy Whitcroft return $stmt_lines; 1443cf655043SAndy Whitcroft } else { 1444cf655043SAndy Whitcroft return $stmt_statements; 1445cf655043SAndy Whitcroft } 1446cf655043SAndy Whitcroft} 1447cf655043SAndy Whitcroft 144813214adfSAndy Whitcroftsub ctx_statement_full { 144913214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 145013214adfSAndy Whitcroft my ($statement, $condition, $level); 145113214adfSAndy Whitcroft 145213214adfSAndy Whitcroft my (@chunks); 145313214adfSAndy Whitcroft 1454cf655043SAndy Whitcroft # Grab the first conditional/block pair. 145513214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 145613214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1457773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 145813214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1459cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1460cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1461cf655043SAndy Whitcroft } 1462cf655043SAndy Whitcroft 1463cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1464cf655043SAndy Whitcroft # could continue the statement. 1465cf655043SAndy Whitcroft for (;;) { 146613214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 146713214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1468cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1469773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1470cf655043SAndy Whitcroft #print "C: push\n"; 1471cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 147213214adfSAndy Whitcroft } 147313214adfSAndy Whitcroft 147413214adfSAndy Whitcroft return ($level, $linenr, @chunks); 14758905a67cSAndy Whitcroft} 14768905a67cSAndy Whitcroft 14774a0df2efSAndy Whitcroftsub ctx_block_get { 1478f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 14794a0df2efSAndy Whitcroft my $line; 14804a0df2efSAndy Whitcroft my $start = $linenr - 1; 14814a0df2efSAndy Whitcroft my $blk = ''; 14824a0df2efSAndy Whitcroft my @o; 14834a0df2efSAndy Whitcroft my @c; 14844a0df2efSAndy Whitcroft my @res = (); 14854a0df2efSAndy Whitcroft 1486f0a594c1SAndy Whitcroft my $level = 0; 14874635f4fbSAndy Whitcroft my @stack = ($level); 148800df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 148900df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 149000df344fSAndy Whitcroft $remain--; 149100df344fSAndy Whitcroft 149200df344fSAndy Whitcroft $blk .= $rawlines[$line]; 14934635f4fbSAndy Whitcroft 14944635f4fbSAndy Whitcroft # Handle nested #if/#else. 149501464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 14964635f4fbSAndy Whitcroft push(@stack, $level); 149701464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 14984635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 149901464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 15004635f4fbSAndy Whitcroft $level = pop(@stack); 15014635f4fbSAndy Whitcroft } 15024635f4fbSAndy Whitcroft 150301464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1504f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1505f0a594c1SAndy Whitcroft if ($off > 0) { 1506f0a594c1SAndy Whitcroft $off--; 1507f0a594c1SAndy Whitcroft next; 1508f0a594c1SAndy Whitcroft } 15094a0df2efSAndy Whitcroft 1510f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1511f0a594c1SAndy Whitcroft $level--; 1512f0a594c1SAndy Whitcroft last if ($level == 0); 1513f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1514f0a594c1SAndy Whitcroft $level++; 1515f0a594c1SAndy Whitcroft } 1516f0a594c1SAndy Whitcroft } 15174a0df2efSAndy Whitcroft 1518f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 151900df344fSAndy Whitcroft push(@res, $rawlines[$line]); 15204a0df2efSAndy Whitcroft } 15214a0df2efSAndy Whitcroft 1522f0a594c1SAndy Whitcroft last if ($level == 0); 15234a0df2efSAndy Whitcroft } 15244a0df2efSAndy Whitcroft 1525f0a594c1SAndy Whitcroft return ($level, @res); 15264a0df2efSAndy Whitcroft} 15274a0df2efSAndy Whitcroftsub ctx_block_outer { 15284a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 15294a0df2efSAndy Whitcroft 1530f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1531f0a594c1SAndy Whitcroft return @r; 15324a0df2efSAndy Whitcroft} 15334a0df2efSAndy Whitcroftsub ctx_block { 15344a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 15354a0df2efSAndy Whitcroft 1536f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1537f0a594c1SAndy Whitcroft return @r; 1538653d4876SAndy Whitcroft} 1539653d4876SAndy Whitcroftsub ctx_statement { 1540f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1541f0a594c1SAndy Whitcroft 1542f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1543f0a594c1SAndy Whitcroft return @r; 1544f0a594c1SAndy Whitcroft} 1545f0a594c1SAndy Whitcroftsub ctx_block_level { 1546653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1547653d4876SAndy Whitcroft 1548f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 15494a0df2efSAndy Whitcroft} 15509c0ca6f9SAndy Whitcroftsub ctx_statement_level { 15519c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 15529c0ca6f9SAndy Whitcroft 15539c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 15549c0ca6f9SAndy Whitcroft} 15554a0df2efSAndy Whitcroft 15564a0df2efSAndy Whitcroftsub ctx_locate_comment { 15574a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 15584a0df2efSAndy Whitcroft 15594a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1560beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 15614a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 15624a0df2efSAndy Whitcroft 15634a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 15644a0df2efSAndy Whitcroft # comment. 15654a0df2efSAndy Whitcroft my $in_comment = 0; 15664a0df2efSAndy Whitcroft $current_comment = ''; 15674a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 156800df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 156900df344fSAndy Whitcroft #warn " $line\n"; 15704a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 15714a0df2efSAndy Whitcroft $in_comment = 1; 15724a0df2efSAndy Whitcroft } 15734a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 15744a0df2efSAndy Whitcroft $in_comment = 1; 15754a0df2efSAndy Whitcroft } 15764a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 15774a0df2efSAndy Whitcroft $current_comment = ''; 15784a0df2efSAndy Whitcroft } 15794a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 15804a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 15814a0df2efSAndy Whitcroft $in_comment = 0; 15824a0df2efSAndy Whitcroft } 15834a0df2efSAndy Whitcroft } 15844a0df2efSAndy Whitcroft 15854a0df2efSAndy Whitcroft chomp($current_comment); 15864a0df2efSAndy Whitcroft return($current_comment); 15874a0df2efSAndy Whitcroft} 15884a0df2efSAndy Whitcroftsub ctx_has_comment { 15894a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 15904a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 15914a0df2efSAndy Whitcroft 159200df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 15934a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 15944a0df2efSAndy Whitcroft 15954a0df2efSAndy Whitcroft return ($cmt ne ''); 15964a0df2efSAndy Whitcroft} 15974a0df2efSAndy Whitcroft 15984d001e4dSAndy Whitcroftsub raw_line { 15994d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 16004d001e4dSAndy Whitcroft 16014d001e4dSAndy Whitcroft my $offset = $linenr - 1; 16024d001e4dSAndy Whitcroft $cnt++; 16034d001e4dSAndy Whitcroft 16044d001e4dSAndy Whitcroft my $line; 16054d001e4dSAndy Whitcroft while ($cnt) { 16064d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 16074d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 16084d001e4dSAndy Whitcroft $cnt--; 16094d001e4dSAndy Whitcroft } 16104d001e4dSAndy Whitcroft 16114d001e4dSAndy Whitcroft return $line; 16124d001e4dSAndy Whitcroft} 16134d001e4dSAndy Whitcroft 16140a920b5bSAndy Whitcroftsub cat_vet { 16150a920b5bSAndy Whitcroft my ($vet) = @_; 16169c0ca6f9SAndy Whitcroft my ($res, $coded); 16170a920b5bSAndy Whitcroft 16189c0ca6f9SAndy Whitcroft $res = ''; 16196c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 16206c72ffaaSAndy Whitcroft $res .= $1; 16216c72ffaaSAndy Whitcroft if ($2 ne '') { 16229c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 16236c72ffaaSAndy Whitcroft $res .= $coded; 16246c72ffaaSAndy Whitcroft } 16259c0ca6f9SAndy Whitcroft } 16269c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 16270a920b5bSAndy Whitcroft 16289c0ca6f9SAndy Whitcroft return $res; 16290a920b5bSAndy Whitcroft} 16300a920b5bSAndy Whitcroft 1631c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1632cf655043SAndy Whitcroftmy $av_pending; 1633c2fdda0dSAndy Whitcroftmy @av_paren_type; 16341f65f947SAndy Whitcroftmy $av_pend_colon; 1635c2fdda0dSAndy Whitcroft 1636c2fdda0dSAndy Whitcroftsub annotate_reset { 1637c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1638cf655043SAndy Whitcroft $av_pending = '_'; 1639cf655043SAndy Whitcroft @av_paren_type = ('E'); 16401f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1641c2fdda0dSAndy Whitcroft} 1642c2fdda0dSAndy Whitcroft 16436c72ffaaSAndy Whitcroftsub annotate_values { 16446c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 16456c72ffaaSAndy Whitcroft 16466c72ffaaSAndy Whitcroft my $res; 16471f65f947SAndy Whitcroft my $var = '_' x length($stream); 16486c72ffaaSAndy Whitcroft my $cur = $stream; 16496c72ffaaSAndy Whitcroft 1650c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 16516c72ffaaSAndy Whitcroft 16526c72ffaaSAndy Whitcroft while (length($cur)) { 1653773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1654cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1655171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 16566c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1657c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1658c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1659cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1660c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 16616c72ffaaSAndy Whitcroft } 16626c72ffaaSAndy Whitcroft 1663c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 16649446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 16659446ef56SAndy Whitcroft push(@av_paren_type, $type); 1666addcdceaSAndy Whitcroft $type = 'c'; 16679446ef56SAndy Whitcroft 1668e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1669c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 16706c72ffaaSAndy Whitcroft $type = 'T'; 16716c72ffaaSAndy Whitcroft 1672389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1673389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1674389a2fe5SAndy Whitcroft $type = 'T'; 1675389a2fe5SAndy Whitcroft 1676c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1677171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1678c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1679171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1680171ae1a4SAndy Whitcroft if ($2 ne '') { 1681cf655043SAndy Whitcroft $av_pending = 'N'; 1682171ae1a4SAndy Whitcroft } 1683171ae1a4SAndy Whitcroft $type = 'E'; 1684171ae1a4SAndy Whitcroft 1685c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1686171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1687171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1688171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 16896c72ffaaSAndy Whitcroft 1690c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1691cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1692c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1693cf655043SAndy Whitcroft 1694cf655043SAndy Whitcroft push(@av_paren_type, $type); 1695cf655043SAndy Whitcroft push(@av_paren_type, $type); 1696171ae1a4SAndy Whitcroft $type = 'E'; 1697cf655043SAndy Whitcroft 1698c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1699cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1700cf655043SAndy Whitcroft $av_preprocessor = 1; 1701cf655043SAndy Whitcroft 1702cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1703cf655043SAndy Whitcroft 1704171ae1a4SAndy Whitcroft $type = 'E'; 1705cf655043SAndy Whitcroft 1706c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1707cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1708cf655043SAndy Whitcroft 1709cf655043SAndy Whitcroft $av_preprocessor = 1; 1710cf655043SAndy Whitcroft 1711cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1712cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1713cf655043SAndy Whitcroft pop(@av_paren_type); 1714cf655043SAndy Whitcroft push(@av_paren_type, $type); 1715171ae1a4SAndy Whitcroft $type = 'E'; 17166c72ffaaSAndy Whitcroft 17176c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1718c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 17196c72ffaaSAndy Whitcroft 1720171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1721171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1722171ae1a4SAndy Whitcroft $av_pending = $type; 1723171ae1a4SAndy Whitcroft $type = 'N'; 1724171ae1a4SAndy Whitcroft 17256c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1726c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 17276c72ffaaSAndy Whitcroft if (defined $2) { 1728cf655043SAndy Whitcroft $av_pending = 'V'; 17296c72ffaaSAndy Whitcroft } 17306c72ffaaSAndy Whitcroft $type = 'N'; 17316c72ffaaSAndy Whitcroft 173214b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1733c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 173414b111c1SAndy Whitcroft $av_pending = 'E'; 17356c72ffaaSAndy Whitcroft $type = 'N'; 17366c72ffaaSAndy Whitcroft 17371f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 17381f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 17391f65f947SAndy Whitcroft $av_pend_colon = 'C'; 17401f65f947SAndy Whitcroft $type = 'N'; 17411f65f947SAndy Whitcroft 174214b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1743c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 17446c72ffaaSAndy Whitcroft $type = 'N'; 17456c72ffaaSAndy Whitcroft 17466c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1747c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1748cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1749cf655043SAndy Whitcroft $av_pending = '_'; 17506c72ffaaSAndy Whitcroft $type = 'N'; 17516c72ffaaSAndy Whitcroft 17526c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1753cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1754cf655043SAndy Whitcroft if ($new_type ne '_') { 1755cf655043SAndy Whitcroft $type = $new_type; 1756c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1757c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 17586c72ffaaSAndy Whitcroft } else { 1759c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 17606c72ffaaSAndy Whitcroft } 17616c72ffaaSAndy Whitcroft 1762c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1763c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1764c8cb2ca3SAndy Whitcroft $type = 'V'; 1765cf655043SAndy Whitcroft $av_pending = 'V'; 17666c72ffaaSAndy Whitcroft 17678e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 17688e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 17691f65f947SAndy Whitcroft $av_pend_colon = 'B'; 17708e761b04SAndy Whitcroft } elsif ($type eq 'E') { 17718e761b04SAndy Whitcroft $av_pend_colon = 'L'; 17721f65f947SAndy Whitcroft } 17731f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 17741f65f947SAndy Whitcroft $type = 'V'; 17751f65f947SAndy Whitcroft 17766c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1777c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 17786c72ffaaSAndy Whitcroft $type = 'V'; 17796c72ffaaSAndy Whitcroft 17806c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1781c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 17826c72ffaaSAndy Whitcroft $type = 'N'; 17836c72ffaaSAndy Whitcroft 1784cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1785c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 178613214adfSAndy Whitcroft $type = 'E'; 17871f65f947SAndy Whitcroft $av_pend_colon = 'O'; 178813214adfSAndy Whitcroft 17898e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 17908e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 17918e761b04SAndy Whitcroft $type = 'C'; 17928e761b04SAndy Whitcroft 17931f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 17941f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 17951f65f947SAndy Whitcroft $type = 'N'; 17961f65f947SAndy Whitcroft 17971f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 17981f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 17991f65f947SAndy Whitcroft 18001f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 18011f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 18021f65f947SAndy Whitcroft $type = 'E'; 18031f65f947SAndy Whitcroft } else { 18041f65f947SAndy Whitcroft $type = 'N'; 18051f65f947SAndy Whitcroft } 18061f65f947SAndy Whitcroft $av_pend_colon = 'O'; 18071f65f947SAndy Whitcroft 18088e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 180913214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 18106c72ffaaSAndy Whitcroft $type = 'N'; 18116c72ffaaSAndy Whitcroft 18120d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 181374048ed8SAndy Whitcroft my $variant; 181474048ed8SAndy Whitcroft 181574048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 181674048ed8SAndy Whitcroft if ($type eq 'V') { 181774048ed8SAndy Whitcroft $variant = 'B'; 181874048ed8SAndy Whitcroft } else { 181974048ed8SAndy Whitcroft $variant = 'U'; 182074048ed8SAndy Whitcroft } 182174048ed8SAndy Whitcroft 182274048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 182374048ed8SAndy Whitcroft $type = 'N'; 182474048ed8SAndy Whitcroft 18256c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1826c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 18276c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 18286c72ffaaSAndy Whitcroft $type = 'N'; 18296c72ffaaSAndy Whitcroft } 18306c72ffaaSAndy Whitcroft 18316c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1832c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 18336c72ffaaSAndy Whitcroft } 18346c72ffaaSAndy Whitcroft if (defined $1) { 18356c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 18366c72ffaaSAndy Whitcroft $res .= $type x length($1); 18376c72ffaaSAndy Whitcroft } 18386c72ffaaSAndy Whitcroft } 18396c72ffaaSAndy Whitcroft 18401f65f947SAndy Whitcroft return ($res, $var); 18416c72ffaaSAndy Whitcroft} 18426c72ffaaSAndy Whitcroft 18438905a67cSAndy Whitcroftsub possible { 184413214adfSAndy Whitcroft my ($possible, $line) = @_; 18459a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 18460776e594SAndy Whitcroft ^(?: 18470776e594SAndy Whitcroft $Modifier| 18480776e594SAndy Whitcroft $Storage| 18490776e594SAndy Whitcroft $Type| 18509a974fdbSAndy Whitcroft DEFINE_\S+ 18519a974fdbSAndy Whitcroft )$| 18529a974fdbSAndy Whitcroft ^(?: 18530776e594SAndy Whitcroft goto| 18540776e594SAndy Whitcroft return| 18550776e594SAndy Whitcroft case| 18560776e594SAndy Whitcroft else| 18570776e594SAndy Whitcroft asm|__asm__| 185889a88353SAndy Whitcroft do| 185989a88353SAndy Whitcroft \#| 186089a88353SAndy Whitcroft \#\#| 18619a974fdbSAndy Whitcroft )(?:\s|$)| 18620776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 18639a974fdbSAndy Whitcroft )}x; 18649a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 18659a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1866c45dcabdSAndy Whitcroft # Check for modifiers. 1867c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1868c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1869c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1870c45dcabdSAndy Whitcroft 1871c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1872c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1873d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 18749a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1875d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1876485ff23eSAlex Dowad push(@modifierListFile, $modifier); 1877d2506586SAndy Whitcroft } 18789a974fdbSAndy Whitcroft } 1879c45dcabdSAndy Whitcroft 1880c45dcabdSAndy Whitcroft } else { 188113214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 1882485ff23eSAlex Dowad push(@typeListFile, $possible); 1883c45dcabdSAndy Whitcroft } 18848905a67cSAndy Whitcroft build_types(); 18850776e594SAndy Whitcroft } else { 18860776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 18878905a67cSAndy Whitcroft } 18888905a67cSAndy Whitcroft} 18898905a67cSAndy Whitcroft 18906c72ffaaSAndy Whitcroftmy $prefix = ''; 18916c72ffaaSAndy Whitcroft 1892000d1cc1SJoe Perchessub show_type { 1893cbec18afSJoe Perches my ($type) = @_; 189491bfe484SJoe Perches 1895522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 1896522b837cSAlexey Dobriyan 1897cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1898cbec18afSJoe Perches 1899cbec18afSJoe Perches return !defined $ignore_type{$type}; 1900000d1cc1SJoe Perches} 1901000d1cc1SJoe Perches 1902f0a594c1SAndy Whitcroftsub report { 1903cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1904cbec18afSJoe Perches 1905cbec18afSJoe Perches if (!show_type($type) || 1906cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1907773647a0SAndy Whitcroft return 0; 1908773647a0SAndy Whitcroft } 190957230297SJoe Perches my $output = ''; 1910737c0767SJohn Brooks if ($color) { 191157230297SJoe Perches if ($level eq 'ERROR') { 191257230297SJoe Perches $output .= RED; 191357230297SJoe Perches } elsif ($level eq 'WARNING') { 191457230297SJoe Perches $output .= YELLOW; 1915000d1cc1SJoe Perches } else { 191657230297SJoe Perches $output .= GREEN; 1917000d1cc1SJoe Perches } 191857230297SJoe Perches } 191957230297SJoe Perches $output .= $prefix . $level . ':'; 192057230297SJoe Perches if ($show_types) { 1921737c0767SJohn Brooks $output .= BLUE if ($color); 192257230297SJoe Perches $output .= "$type:"; 192357230297SJoe Perches } 1924737c0767SJohn Brooks $output .= RESET if ($color); 192557230297SJoe Perches $output .= ' ' . $msg . "\n"; 192634d8815fSJoe Perches 192734d8815fSJoe Perches if ($showfile) { 192834d8815fSJoe Perches my @lines = split("\n", $output, -1); 192934d8815fSJoe Perches splice(@lines, 1, 1); 193034d8815fSJoe Perches $output = join("\n", @lines); 193134d8815fSJoe Perches } 193257230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 19338905a67cSAndy Whitcroft 193457230297SJoe Perches push(our @report, $output); 1935773647a0SAndy Whitcroft 1936773647a0SAndy Whitcroft return 1; 1937f0a594c1SAndy Whitcroft} 1938cbec18afSJoe Perches 1939f0a594c1SAndy Whitcroftsub report_dump { 194013214adfSAndy Whitcroft our @report; 1941f0a594c1SAndy Whitcroft} 1942000d1cc1SJoe Perches 1943d752fcc8SJoe Perchessub fixup_current_range { 1944d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 1945d752fcc8SJoe Perches 1946d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 1947d752fcc8SJoe Perches my $o = $1; 1948d752fcc8SJoe Perches my $l = $2; 1949d752fcc8SJoe Perches my $no = $o + $offset; 1950d752fcc8SJoe Perches my $nl = $l + $length; 1951d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 1952d752fcc8SJoe Perches } 1953d752fcc8SJoe Perches} 1954d752fcc8SJoe Perches 1955d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 1956d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 1957d752fcc8SJoe Perches 1958d752fcc8SJoe Perches my $range_last_linenr = 0; 1959d752fcc8SJoe Perches my $delta_offset = 0; 1960d752fcc8SJoe Perches 1961d752fcc8SJoe Perches my $old_linenr = 0; 1962d752fcc8SJoe Perches my $new_linenr = 0; 1963d752fcc8SJoe Perches 1964d752fcc8SJoe Perches my $next_insert = 0; 1965d752fcc8SJoe Perches my $next_delete = 0; 1966d752fcc8SJoe Perches 1967d752fcc8SJoe Perches my @lines = (); 1968d752fcc8SJoe Perches 1969d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 1970d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 1971d752fcc8SJoe Perches 1972d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 1973d752fcc8SJoe Perches my $save_line = 1; 1974d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 1975323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 1976d752fcc8SJoe Perches $delta_offset = 0; 1977d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 1978d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 1979d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 1980d752fcc8SJoe Perches } 1981d752fcc8SJoe Perches 1982d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 1983d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 1984d752fcc8SJoe Perches $save_line = 0; 1985d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 1986d752fcc8SJoe Perches } 1987d752fcc8SJoe Perches 1988d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 1989d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 1990d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 1991d752fcc8SJoe Perches $new_linenr++; 1992d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 1993d752fcc8SJoe Perches } 1994d752fcc8SJoe Perches 1995d752fcc8SJoe Perches if ($save_line) { 1996d752fcc8SJoe Perches push(@lines, $line); 1997d752fcc8SJoe Perches $new_linenr++; 1998d752fcc8SJoe Perches } 1999d752fcc8SJoe Perches 2000d752fcc8SJoe Perches $old_linenr++; 2001d752fcc8SJoe Perches } 2002d752fcc8SJoe Perches 2003d752fcc8SJoe Perches return @lines; 2004d752fcc8SJoe Perches} 2005d752fcc8SJoe Perches 2006f2d7e4d4SJoe Perchessub fix_insert_line { 2007f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2008f2d7e4d4SJoe Perches 2009f2d7e4d4SJoe Perches my $inserted = { 2010f2d7e4d4SJoe Perches LINENR => $linenr, 2011f2d7e4d4SJoe Perches LINE => $line, 2012f2d7e4d4SJoe Perches }; 2013f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2014f2d7e4d4SJoe Perches} 2015f2d7e4d4SJoe Perches 2016f2d7e4d4SJoe Perchessub fix_delete_line { 2017f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2018f2d7e4d4SJoe Perches 2019f2d7e4d4SJoe Perches my $deleted = { 2020f2d7e4d4SJoe Perches LINENR => $linenr, 2021f2d7e4d4SJoe Perches LINE => $line, 2022f2d7e4d4SJoe Perches }; 2023f2d7e4d4SJoe Perches 2024f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2025f2d7e4d4SJoe Perches} 2026f2d7e4d4SJoe Perches 2027de7d4f0eSAndy Whitcroftsub ERROR { 2028cbec18afSJoe Perches my ($type, $msg) = @_; 2029cbec18afSJoe Perches 2030cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2031de7d4f0eSAndy Whitcroft our $clean = 0; 20326c72ffaaSAndy Whitcroft our $cnt_error++; 20333705ce5bSJoe Perches return 1; 2034de7d4f0eSAndy Whitcroft } 20353705ce5bSJoe Perches return 0; 2036773647a0SAndy Whitcroft} 2037de7d4f0eSAndy Whitcroftsub WARN { 2038cbec18afSJoe Perches my ($type, $msg) = @_; 2039cbec18afSJoe Perches 2040cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2041de7d4f0eSAndy Whitcroft our $clean = 0; 20426c72ffaaSAndy Whitcroft our $cnt_warn++; 20433705ce5bSJoe Perches return 1; 2044de7d4f0eSAndy Whitcroft } 20453705ce5bSJoe Perches return 0; 2046773647a0SAndy Whitcroft} 2047de7d4f0eSAndy Whitcroftsub CHK { 2048cbec18afSJoe Perches my ($type, $msg) = @_; 2049cbec18afSJoe Perches 2050cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2051de7d4f0eSAndy Whitcroft our $clean = 0; 20526c72ffaaSAndy Whitcroft our $cnt_chk++; 20533705ce5bSJoe Perches return 1; 20546c72ffaaSAndy Whitcroft } 20553705ce5bSJoe Perches return 0; 2056de7d4f0eSAndy Whitcroft} 2057de7d4f0eSAndy Whitcroft 20586ecd9674SAndy Whitcroftsub check_absolute_file { 20596ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 20606ecd9674SAndy Whitcroft my $file = $absolute; 20616ecd9674SAndy Whitcroft 20626ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 20636ecd9674SAndy Whitcroft 20646ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 20656ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 20666ecd9674SAndy Whitcroft if (-f "$root/$file") { 20676ecd9674SAndy Whitcroft ##print "file<$file>\n"; 20686ecd9674SAndy Whitcroft last; 20696ecd9674SAndy Whitcroft } 20706ecd9674SAndy Whitcroft } 20716ecd9674SAndy Whitcroft if (! -f _) { 20726ecd9674SAndy Whitcroft return 0; 20736ecd9674SAndy Whitcroft } 20746ecd9674SAndy Whitcroft 20756ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 20766ecd9674SAndy Whitcroft my $prefix = $absolute; 20776ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 20786ecd9674SAndy Whitcroft 20796ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 20806ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2081000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2082000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 20836ecd9674SAndy Whitcroft } 20846ecd9674SAndy Whitcroft} 20856ecd9674SAndy Whitcroft 20863705ce5bSJoe Perchessub trim { 20873705ce5bSJoe Perches my ($string) = @_; 20883705ce5bSJoe Perches 2089b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2090b34c648bSJoe Perches 2091b34c648bSJoe Perches return $string; 2092b34c648bSJoe Perches} 2093b34c648bSJoe Perches 2094b34c648bSJoe Perchessub ltrim { 2095b34c648bSJoe Perches my ($string) = @_; 2096b34c648bSJoe Perches 2097b34c648bSJoe Perches $string =~ s/^\s+//; 2098b34c648bSJoe Perches 2099b34c648bSJoe Perches return $string; 2100b34c648bSJoe Perches} 2101b34c648bSJoe Perches 2102b34c648bSJoe Perchessub rtrim { 2103b34c648bSJoe Perches my ($string) = @_; 2104b34c648bSJoe Perches 2105b34c648bSJoe Perches $string =~ s/\s+$//; 21063705ce5bSJoe Perches 21073705ce5bSJoe Perches return $string; 21083705ce5bSJoe Perches} 21093705ce5bSJoe Perches 211052ea8506SJoe Perchessub string_find_replace { 211152ea8506SJoe Perches my ($string, $find, $replace) = @_; 211252ea8506SJoe Perches 211352ea8506SJoe Perches $string =~ s/$find/$replace/g; 211452ea8506SJoe Perches 211552ea8506SJoe Perches return $string; 211652ea8506SJoe Perches} 211752ea8506SJoe Perches 21183705ce5bSJoe Perchessub tabify { 21193705ce5bSJoe Perches my ($leading) = @_; 21203705ce5bSJoe Perches 21213705ce5bSJoe Perches my $source_indent = 8; 21223705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 21233705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 21243705ce5bSJoe Perches 21253705ce5bSJoe Perches #convert leading spaces to tabs 21263705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 21273705ce5bSJoe Perches #Remove spaces before a tab 21283705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 21293705ce5bSJoe Perches 21303705ce5bSJoe Perches return "$leading"; 21313705ce5bSJoe Perches} 21323705ce5bSJoe Perches 2133d1fe9c09SJoe Perchessub pos_last_openparen { 2134d1fe9c09SJoe Perches my ($line) = @_; 2135d1fe9c09SJoe Perches 2136d1fe9c09SJoe Perches my $pos = 0; 2137d1fe9c09SJoe Perches 2138d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2139d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2140d1fe9c09SJoe Perches 2141d1fe9c09SJoe Perches my $last_openparen = 0; 2142d1fe9c09SJoe Perches 2143d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2144d1fe9c09SJoe Perches return -1; 2145d1fe9c09SJoe Perches } 2146d1fe9c09SJoe Perches 2147d1fe9c09SJoe Perches my $len = length($line); 2148d1fe9c09SJoe Perches 2149d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2150d1fe9c09SJoe Perches my $string = substr($line, $pos); 2151d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2152d1fe9c09SJoe Perches $pos += length($1) - 1; 2153d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2154d1fe9c09SJoe Perches $last_openparen = $pos; 2155d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2156d1fe9c09SJoe Perches last; 2157d1fe9c09SJoe Perches } 2158d1fe9c09SJoe Perches } 2159d1fe9c09SJoe Perches 216091cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2161d1fe9c09SJoe Perches} 2162d1fe9c09SJoe Perches 21630a920b5bSAndy Whitcroftsub process { 21640a920b5bSAndy Whitcroft my $filename = shift; 21650a920b5bSAndy Whitcroft 21660a920b5bSAndy Whitcroft my $linenr=0; 21670a920b5bSAndy Whitcroft my $prevline=""; 2168c2fdda0dSAndy Whitcroft my $prevrawline=""; 21690a920b5bSAndy Whitcroft my $stashline=""; 2170c2fdda0dSAndy Whitcroft my $stashrawline=""; 21710a920b5bSAndy Whitcroft 21724a0df2efSAndy Whitcroft my $length; 21730a920b5bSAndy Whitcroft my $indent; 21740a920b5bSAndy Whitcroft my $previndent=0; 21750a920b5bSAndy Whitcroft my $stashindent=0; 21760a920b5bSAndy Whitcroft 2177de7d4f0eSAndy Whitcroft our $clean = 1; 21780a920b5bSAndy Whitcroft my $signoff = 0; 21790a920b5bSAndy Whitcroft my $is_patch = 0; 218029ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 218115662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 2182ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2183bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 21842a076f40SJoe Perches my $commit_log_long_line = 0; 2185e518e9a5SJoe Perches my $commit_log_has_diff = 0; 218613f1937eSJoe Perches my $reported_maintainer_file = 0; 2187fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2188fa64205dSPasi Savanainen 2189365dd4eaSJoe Perches my $last_blank_line = 0; 21905e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2191365dd4eaSJoe Perches 219213214adfSAndy Whitcroft our @report = (); 21936c72ffaaSAndy Whitcroft our $cnt_lines = 0; 21946c72ffaaSAndy Whitcroft our $cnt_error = 0; 21956c72ffaaSAndy Whitcroft our $cnt_warn = 0; 21966c72ffaaSAndy Whitcroft our $cnt_chk = 0; 21976c72ffaaSAndy Whitcroft 21980a920b5bSAndy Whitcroft # Trace the real file/line as we go. 21990a920b5bSAndy Whitcroft my $realfile = ''; 22000a920b5bSAndy Whitcroft my $realline = 0; 22010a920b5bSAndy Whitcroft my $realcnt = 0; 22020a920b5bSAndy Whitcroft my $here = ''; 220377cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 22040a920b5bSAndy Whitcroft my $in_comment = 0; 2205c2fdda0dSAndy Whitcroft my $comment_edge = 0; 22060a920b5bSAndy Whitcroft my $first_line = 0; 22071e855726SWolfram Sang my $p1_prefix = ''; 22080a920b5bSAndy Whitcroft 220913214adfSAndy Whitcroft my $prev_values = 'E'; 221013214adfSAndy Whitcroft 221113214adfSAndy Whitcroft # suppression flags 2212773647a0SAndy Whitcroft my %suppress_ifbraces; 2213170d3a22SAndy Whitcroft my %suppress_whiletrailers; 22142b474a1aSAndy Whitcroft my %suppress_export; 22153e469cdcSAndy Whitcroft my $suppress_statement = 0; 2216653d4876SAndy Whitcroft 22177e51f197SJoe Perches my %signatures = (); 2218323c1260SJoe Perches 2219c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2220de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2221c2fdda0dSAndy Whitcroft # 2222de7d4f0eSAndy Whitcroft my @setup_docs = (); 2223de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2224773647a0SAndy Whitcroft 2225d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2226d8b07710SJoe Perches 2227773647a0SAndy Whitcroft sanitise_line_reset(); 2228c2fdda0dSAndy Whitcroft my $line; 2229c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2230773647a0SAndy Whitcroft $linenr++; 2231773647a0SAndy Whitcroft $line = $rawline; 2232c2fdda0dSAndy Whitcroft 22333705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 22343705ce5bSJoe Perches 2235773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2236de7d4f0eSAndy Whitcroft $setup_docs = 0; 22378c27ceffSMauro Carvalho Chehab if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) { 2238de7d4f0eSAndy Whitcroft $setup_docs = 1; 2239de7d4f0eSAndy Whitcroft } 2240773647a0SAndy Whitcroft #next; 2241de7d4f0eSAndy Whitcroft } 224274fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2243773647a0SAndy Whitcroft $realline=$1-1; 2244773647a0SAndy Whitcroft if (defined $2) { 2245773647a0SAndy Whitcroft $realcnt=$3+1; 2246773647a0SAndy Whitcroft } else { 2247773647a0SAndy Whitcroft $realcnt=1+1; 2248773647a0SAndy Whitcroft } 2249c45dcabdSAndy Whitcroft $in_comment = 0; 2250773647a0SAndy Whitcroft 2251773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2252773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2253773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2254773647a0SAndy Whitcroft # at context start. 2255773647a0SAndy Whitcroft my $edge; 225601fa9147SAndy Whitcroft my $cnt = $realcnt; 225701fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 225801fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 225901fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 226001fa9147SAndy Whitcroft $cnt--; 226101fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2262721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2263fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2264fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2265fae17daeSAndy Whitcroft ($edge) = $1; 2266fae17daeSAndy Whitcroft last; 2267fae17daeSAndy Whitcroft } 2268773647a0SAndy Whitcroft } 2269773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2270773647a0SAndy Whitcroft $in_comment = 1; 2271773647a0SAndy Whitcroft } 2272773647a0SAndy Whitcroft 2273773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2274773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2275773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2276773647a0SAndy Whitcroft if (!defined $edge && 227783242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2278773647a0SAndy Whitcroft { 2279773647a0SAndy Whitcroft $in_comment = 1; 2280773647a0SAndy Whitcroft } 2281773647a0SAndy Whitcroft 2282773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2283773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2284773647a0SAndy Whitcroft 2285171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2286773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2287171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2288773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2289773647a0SAndy Whitcroft } 2290773647a0SAndy Whitcroft push(@lines, $line); 2291773647a0SAndy Whitcroft 2292773647a0SAndy Whitcroft if ($realcnt > 1) { 2293773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2294773647a0SAndy Whitcroft } else { 2295773647a0SAndy Whitcroft $realcnt = 0; 2296773647a0SAndy Whitcroft } 2297773647a0SAndy Whitcroft 2298773647a0SAndy Whitcroft #print "==>$rawline\n"; 2299773647a0SAndy Whitcroft #print "-->$line\n"; 2300de7d4f0eSAndy Whitcroft 2301de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2302de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2303de7d4f0eSAndy Whitcroft } 2304de7d4f0eSAndy Whitcroft } 2305de7d4f0eSAndy Whitcroft 23066c72ffaaSAndy Whitcroft $prefix = ''; 23076c72ffaaSAndy Whitcroft 2308773647a0SAndy Whitcroft $realcnt = 0; 2309773647a0SAndy Whitcroft $linenr = 0; 2310194f66fcSJoe Perches $fixlinenr = -1; 23110a920b5bSAndy Whitcroft foreach my $line (@lines) { 23120a920b5bSAndy Whitcroft $linenr++; 2313194f66fcSJoe Perches $fixlinenr++; 23141b5539b1SJoe Perches my $sline = $line; #copy of $line 23151b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 23160a920b5bSAndy Whitcroft 2317c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 23186c72ffaaSAndy Whitcroft 23190a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2320e518e9a5SJoe Perches if (!$in_commit_log && 232174fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 232274fd4f34SJoe Perches my $context = $4; 23230a920b5bSAndy Whitcroft $is_patch = 1; 23244a0df2efSAndy Whitcroft $first_line = $linenr + 1; 23250a920b5bSAndy Whitcroft $realline=$1-1; 23260a920b5bSAndy Whitcroft if (defined $2) { 23270a920b5bSAndy Whitcroft $realcnt=$3+1; 23280a920b5bSAndy Whitcroft } else { 23290a920b5bSAndy Whitcroft $realcnt=1+1; 23300a920b5bSAndy Whitcroft } 2331c2fdda0dSAndy Whitcroft annotate_reset(); 233213214adfSAndy Whitcroft $prev_values = 'E'; 233313214adfSAndy Whitcroft 2334773647a0SAndy Whitcroft %suppress_ifbraces = (); 2335170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 23362b474a1aSAndy Whitcroft %suppress_export = (); 23373e469cdcSAndy Whitcroft $suppress_statement = 0; 233874fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 233974fd4f34SJoe Perches $context_function = $1; 234074fd4f34SJoe Perches } else { 234174fd4f34SJoe Perches undef $context_function; 234274fd4f34SJoe Perches } 23430a920b5bSAndy Whitcroft next; 23440a920b5bSAndy Whitcroft 23454a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 23464a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 23474a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2348773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 23490a920b5bSAndy Whitcroft $realline++; 2350d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 23510a920b5bSAndy Whitcroft 23524a0df2efSAndy Whitcroft # Measure the line length and indent. 2353c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 23540a920b5bSAndy Whitcroft 23550a920b5bSAndy Whitcroft # Track the previous line. 23560a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 23570a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2358c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2359c2fdda0dSAndy Whitcroft 2360773647a0SAndy Whitcroft #warn "line<$line>\n"; 23616c72ffaaSAndy Whitcroft 2362d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2363d8aaf121SAndy Whitcroft $realcnt--; 23640a920b5bSAndy Whitcroft } 23650a920b5bSAndy Whitcroft 2366cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2367cc77cdcaSAndy Whitcroft 23686c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 23696c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2370773647a0SAndy Whitcroft 23712ac73b4fSJoe Perches my $found_file = 0; 2372773647a0SAndy Whitcroft # extract the filename as it passes 23733bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 23743bf9a009SRabin Vincent $realfile = $1; 23752b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2376270c49a0SJoe Perches $in_commit_log = 0; 23772ac73b4fSJoe Perches $found_file = 1; 23783bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2379773647a0SAndy Whitcroft $realfile = $1; 23802b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2381270c49a0SJoe Perches $in_commit_log = 0; 23821e855726SWolfram Sang 23831e855726SWolfram Sang $p1_prefix = $1; 2384e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2385e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2386000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2387000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 23881e855726SWolfram Sang } 2389773647a0SAndy Whitcroft 2390c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2391000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2392000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2393773647a0SAndy Whitcroft } 23942ac73b4fSJoe Perches $found_file = 1; 23952ac73b4fSJoe Perches } 23962ac73b4fSJoe Perches 239734d8815fSJoe Perches#make up the handle for any error we report on this line 239834d8815fSJoe Perches if ($showfile) { 239934d8815fSJoe Perches $prefix = "$realfile:$realline: " 240034d8815fSJoe Perches } elsif ($emacs) { 24017d3a9f67SJoe Perches if ($file) { 24027d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 24037d3a9f67SJoe Perches } else { 240434d8815fSJoe Perches $prefix = "$filename:$linenr: "; 240534d8815fSJoe Perches } 24067d3a9f67SJoe Perches } 240734d8815fSJoe Perches 24082ac73b4fSJoe Perches if ($found_file) { 240985b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 241085b0ee18SJoe Perches WARN("OBSOLETE", 241185b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 241285b0ee18SJoe Perches } 24137bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 24142ac73b4fSJoe Perches $check = 1; 24152ac73b4fSJoe Perches } else { 24162ac73b4fSJoe Perches $check = $check_orig; 24172ac73b4fSJoe Perches } 2418773647a0SAndy Whitcroft next; 2419773647a0SAndy Whitcroft } 2420773647a0SAndy Whitcroft 2421389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 24220a920b5bSAndy Whitcroft 2423c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2424c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2425c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 24260a920b5bSAndy Whitcroft 24276c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 24286c72ffaaSAndy Whitcroft 2429e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2430e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2431e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2432e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2433e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2434e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2435e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2436e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2437e518e9a5SJoe Perches $commit_log_has_diff = 1; 2438e518e9a5SJoe Perches } 2439e518e9a5SJoe Perches 24403bf9a009SRabin Vincent# Check for incorrect file permissions 24413bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 24423bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 244304db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 244404db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2445000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2446000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 24473bf9a009SRabin Vincent } 24483bf9a009SRabin Vincent } 24493bf9a009SRabin Vincent 245020112475SJoe Perches# Check the patch for a signoff: 2451d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 24524a0df2efSAndy Whitcroft $signoff++; 245315662b3eSJoe Perches $in_commit_log = 0; 24540a920b5bSAndy Whitcroft } 245520112475SJoe Perches 2456e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2457e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2458e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2459e0d975b1SJoe Perches $reported_maintainer_file = 1; 2460e0d975b1SJoe Perches } 2461e0d975b1SJoe Perches 246220112475SJoe Perches# Check signature styles 2463270c49a0SJoe Perches if (!$in_header_lines && 2464ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 246520112475SJoe Perches my $space_before = $1; 246620112475SJoe Perches my $sign_off = $2; 246720112475SJoe Perches my $space_after = $3; 246820112475SJoe Perches my $email = $4; 246920112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 247020112475SJoe Perches 2471ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2472ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2473ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2474ce0338dfSJoe Perches } 247520112475SJoe Perches if (defined $space_before && $space_before ne "") { 24763705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 24773705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 24783705ce5bSJoe Perches $fix) { 2479194f66fcSJoe Perches $fixed[$fixlinenr] = 24803705ce5bSJoe Perches "$ucfirst_sign_off $email"; 24813705ce5bSJoe Perches } 248220112475SJoe Perches } 248320112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 24843705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 24853705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 24863705ce5bSJoe Perches $fix) { 2487194f66fcSJoe Perches $fixed[$fixlinenr] = 24883705ce5bSJoe Perches "$ucfirst_sign_off $email"; 24893705ce5bSJoe Perches } 24903705ce5bSJoe Perches 249120112475SJoe Perches } 249220112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 24933705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 24943705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 24953705ce5bSJoe Perches $fix) { 2496194f66fcSJoe Perches $fixed[$fixlinenr] = 24973705ce5bSJoe Perches "$ucfirst_sign_off $email"; 24983705ce5bSJoe Perches } 249920112475SJoe Perches } 250020112475SJoe Perches 250120112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 250220112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 250320112475SJoe Perches if ($suggested_email eq "") { 2504000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2505000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 250620112475SJoe Perches } else { 250720112475SJoe Perches my $dequoted = $suggested_email; 250820112475SJoe Perches $dequoted =~ s/^"//; 250920112475SJoe Perches $dequoted =~ s/" </ </; 251020112475SJoe Perches # Don't force email to have quotes 251120112475SJoe Perches # Allow just an angle bracketed address 251220112475SJoe Perches if ("$dequoted$comment" ne $email && 251320112475SJoe Perches "<$email_address>$comment" ne $email && 251420112475SJoe Perches "$suggested_email$comment" ne $email) { 2515000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2516000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 251720112475SJoe Perches } 25180a920b5bSAndy Whitcroft } 25197e51f197SJoe Perches 25207e51f197SJoe Perches# Check for duplicate signatures 25217e51f197SJoe Perches my $sig_nospace = $line; 25227e51f197SJoe Perches $sig_nospace =~ s/\s//g; 25237e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 25247e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 25257e51f197SJoe Perches WARN("BAD_SIGN_OFF", 25267e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 25277e51f197SJoe Perches } else { 25287e51f197SJoe Perches $signatures{$sig_nospace} = 1; 25297e51f197SJoe Perches } 25300a920b5bSAndy Whitcroft } 25310a920b5bSAndy Whitcroft 2532a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2533a2fe16b9SJoe Perches if ($in_header_lines && 2534a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2535a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2536a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2537a2fe16b9SJoe Perches } 2538a2fe16b9SJoe Perches 25399b3189ebSJoe Perches# Check for old stable address 25409b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 25419b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 25429b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 25439b3189ebSJoe Perches } 25449b3189ebSJoe Perches 25457ebd05efSChristopher Covington# Check for unwanted Gerrit info 25467ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 25477ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 25487ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 25497ebd05efSChristopher Covington } 25507ebd05efSChristopher Covington 2551369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2552369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2553369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2554369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2555369c8dd3SJoe Perches # timestamp 2556369c8dd3SJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) { 2557369c8dd3SJoe Perches # stack dump address 2558369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2559369c8dd3SJoe Perches } 2560369c8dd3SJoe Perches 25612a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 25622a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2563bf4daf12SJoe Perches length($line) > 75 && 2564bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2565bf4daf12SJoe Perches # file delta changes 2566bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2567bf4daf12SJoe Perches # filename then : 2568bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2569bf4daf12SJoe Perches # A Fixes: or Link: line 2570bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 25712a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 25722a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 25732a076f40SJoe Perches $commit_log_long_line = 1; 25742a076f40SJoe Perches } 25752a076f40SJoe Perches 2576bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2577bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2578bf4daf12SJoe Perches $line =~ /^\s*$/) { 2579bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2580bf4daf12SJoe Perches } 2581bf4daf12SJoe Perches 25820d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2583369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2584aab38f51SJoe Perches $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i && 2585e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 2586fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2587aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2588369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2589bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2590fe043ea1SJoe Perches my $init_char = "c"; 2591fe043ea1SJoe Perches my $orig_commit = ""; 25920d7835fcSJoe Perches my $short = 1; 25930d7835fcSJoe Perches my $long = 0; 25940d7835fcSJoe Perches my $case = 1; 25950d7835fcSJoe Perches my $space = 1; 25960d7835fcSJoe Perches my $hasdesc = 0; 259719c146a6SJoe Perches my $hasparens = 0; 25980d7835fcSJoe Perches my $id = '0123456789ab'; 25990d7835fcSJoe Perches my $orig_desc = "commit description"; 26000d7835fcSJoe Perches my $description = ""; 26010d7835fcSJoe Perches 2602fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2603fe043ea1SJoe Perches $init_char = $1; 2604fe043ea1SJoe Perches $orig_commit = lc($2); 2605fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2606fe043ea1SJoe Perches $orig_commit = lc($1); 2607fe043ea1SJoe Perches } 2608fe043ea1SJoe Perches 26090d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 26100d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 26110d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 26120d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 26130d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 26140d7835fcSJoe Perches $orig_desc = $1; 261519c146a6SJoe Perches $hasparens = 1; 26160d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 26170d7835fcSJoe Perches defined $rawlines[$linenr] && 26180d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 26190d7835fcSJoe Perches $orig_desc = $1; 262019c146a6SJoe Perches $hasparens = 1; 2621b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2622b671fde0SJoe Perches defined $rawlines[$linenr] && 2623b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2624b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2625b671fde0SJoe Perches $orig_desc = $1; 2626b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2627b671fde0SJoe Perches $orig_desc .= " " . $1; 262819c146a6SJoe Perches $hasparens = 1; 26290d7835fcSJoe Perches } 26300d7835fcSJoe Perches 26310d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 26320d7835fcSJoe Perches $id, $orig_desc); 26330d7835fcSJoe Perches 2634948b133aSHeinrich Schuchardt if (defined($id) && 2635948b133aSHeinrich Schuchardt ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { 2636d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 26370d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 26380d7835fcSJoe Perches } 2639d311cd44SJoe Perches } 2640d311cd44SJoe Perches 264113f1937eSJoe Perches# Check for added, moved or deleted files 264213f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 264313f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 264413f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 264513f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 264613f1937eSJoe Perches (defined($1) || defined($2))))) { 2647a82603a8SAndrew Jeffery $is_patch = 1; 264813f1937eSJoe Perches $reported_maintainer_file = 1; 264913f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 265013f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 265113f1937eSJoe Perches } 265213f1937eSJoe Perches 265300df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 26548905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2655000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2656000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 26576c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2658de7d4f0eSAndy Whitcroft } 2659de7d4f0eSAndy Whitcroft 2660de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2661de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2662171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2663171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2664171ae1a4SAndy Whitcroft 2665171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2666171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2667171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2668171ae1a4SAndy Whitcroft 266934d99219SJoe Perches CHK("INVALID_UTF8", 2670000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 267100df344fSAndy Whitcroft } 26720a920b5bSAndy Whitcroft 267315662b3eSJoe Perches# Check if it's the start of a commit log 267415662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 267515662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 2676eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 2677eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 267815662b3eSJoe Perches $in_header_lines = 0; 267915662b3eSJoe Perches $in_commit_log = 1; 2680ed43c4e5SAllen Hubbe $has_commit_log = 1; 268115662b3eSJoe Perches } 268215662b3eSJoe Perches 2683fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2684fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2685fa64205dSPasi Savanainen if ($in_header_lines && 2686fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2687fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2688fa64205dSPasi Savanainen $non_utf8_charset = 1; 2689fa64205dSPasi Savanainen } 2690fa64205dSPasi Savanainen 2691fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 269215662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2693fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 269415662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 269515662b3eSJoe Perches } 269615662b3eSJoe Perches 2697d6430f71SJoe Perches# Check for absolute kernel paths in commit message 2698d6430f71SJoe Perches if ($tree && $in_commit_log) { 2699d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 2700d6430f71SJoe Perches my $file = $1; 2701d6430f71SJoe Perches 2702d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 2703d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 2704d6430f71SJoe Perches # 2705d6430f71SJoe Perches } else { 2706d6430f71SJoe Perches check_absolute_file($file, $herecurr); 2707d6430f71SJoe Perches } 2708d6430f71SJoe Perches } 2709d6430f71SJoe Perches } 2710d6430f71SJoe Perches 271166b47b4aSKees Cook# Check for various typo / spelling mistakes 271266d7a382SJoe Perches if (defined($misspellings) && 271366d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2714ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 271566b47b4aSKees Cook my $typo = $1; 271666b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 271766b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 271866b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 27190675a8fbSJean Delvare my $msg_level = \&WARN; 27200675a8fbSJean Delvare $msg_level = \&CHK if ($file); 27210675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 272266b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 272366b47b4aSKees Cook $fix) { 272466b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 272566b47b4aSKees Cook } 272666b47b4aSKees Cook } 272766b47b4aSKees Cook } 272866b47b4aSKees Cook 272930670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 273030670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 273100df344fSAndy Whitcroft 27320a920b5bSAndy Whitcroft#trailing whitespace 27339c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2734c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2735d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2736d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2737d5e616fcSJoe Perches $fix) { 2738194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2739d5e616fcSJoe Perches } 2740c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2741c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 27423705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 27433705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 27443705ce5bSJoe Perches $fix) { 2745194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 27463705ce5bSJoe Perches } 27473705ce5bSJoe Perches 2748d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 27490a920b5bSAndy Whitcroft } 27505368df20SAndy Whitcroft 27514783f894SJosh Triplett# Check for FSF mailing addresses. 2752109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 27531bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 27543e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 27553e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 27564783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 27570675a8fbSJean Delvare my $msg_level = \&ERROR; 27580675a8fbSJean Delvare $msg_level = \&CHK if ($file); 27590675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 27604783f894SJosh 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) 27614783f894SJosh Triplett } 27624783f894SJosh Triplett 27633354957aSAndi Kleen# check for Kconfig help text having a real description 27649fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 27659fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 27663354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 27678d73e0e7SJoe Perches $line =~ /^\+\s*config\s+/) { 27683354957aSAndi Kleen my $length = 0; 27699fe287d7SAndy Whitcroft my $cnt = $realcnt; 27709fe287d7SAndy Whitcroft my $ln = $linenr + 1; 27719fe287d7SAndy Whitcroft my $f; 2772a1385803SAndy Whitcroft my $is_start = 0; 27739fe287d7SAndy Whitcroft my $is_end = 0; 2774a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 27759fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 27769fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 27779fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 27789fe287d7SAndy Whitcroft 27799fe287d7SAndy Whitcroft next if ($f =~ /^-/); 27808d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2781a1385803SAndy Whitcroft 27828d73e0e7SJoe Perches if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) { 2783a1385803SAndy Whitcroft $is_start = 1; 27848d73e0e7SJoe Perches } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 2785a1385803SAndy Whitcroft $length = -1; 2786a1385803SAndy Whitcroft } 2787a1385803SAndy Whitcroft 27889fe287d7SAndy Whitcroft $f =~ s/^.//; 27893354957aSAndi Kleen $f =~ s/#.*//; 27903354957aSAndi Kleen $f =~ s/^\s+//; 27913354957aSAndi Kleen next if ($f =~ /^$/); 27929fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 27939fe287d7SAndy Whitcroft $is_end = 1; 27949fe287d7SAndy Whitcroft last; 27959fe287d7SAndy Whitcroft } 27963354957aSAndi Kleen $length++; 27973354957aSAndi Kleen } 279856193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2799000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 280056193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 280156193274SVadim Bendebury } 2802a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 28033354957aSAndi Kleen } 28043354957aSAndi Kleen 2805628f91a2SJoe Perches# check for MAINTAINERS entries that don't have the right form 2806628f91a2SJoe Perches if ($realfile =~ /^MAINTAINERS$/ && 2807628f91a2SJoe Perches $rawline =~ /^\+[A-Z]:/ && 2808628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 2809628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 2810628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 2811628f91a2SJoe Perches $fix) { 2812628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 2813628f91a2SJoe Perches } 2814628f91a2SJoe Perches } 2815628f91a2SJoe Perches 2816327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2817327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2818327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2819327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2820327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2821327953e9SChristoph Jaeger } 2822327953e9SChristoph Jaeger 2823c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2824c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2825c68e5878SArnaud Lacombe my $flag = $1; 2826c68e5878SArnaud Lacombe my $replacement = { 2827c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2828c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2829c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2830c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2831c68e5878SArnaud Lacombe }; 2832c68e5878SArnaud Lacombe 2833c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2834c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2835c68e5878SArnaud Lacombe } 2836c68e5878SArnaud Lacombe 2837bff5da43SRob Herring# check for DT compatible documentation 28387dd05b38SFlorian Vaussard if (defined $root && 28397dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 28407dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 28417dd05b38SFlorian Vaussard 2842bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2843bff5da43SRob Herring 2844cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2845cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2846cc93319bSFlorian Vaussard 2847bff5da43SRob Herring foreach my $compat (@compats) { 2848bff5da43SRob Herring my $compat2 = $compat; 2849185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2850185d566bSRob Herring my $compat3 = $compat; 2851185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2852185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2853bff5da43SRob Herring if ( $? >> 8 ) { 2854bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2855bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2856bff5da43SRob Herring } 2857bff5da43SRob Herring 28584fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 28594fbf32a6SFlorian Vaussard my $vendor = $1; 2860cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2861bff5da43SRob Herring if ( $? >> 8 ) { 2862bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2863cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2864bff5da43SRob Herring } 2865bff5da43SRob Herring } 2866bff5da43SRob Herring } 2867bff5da43SRob Herring 28685368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2869d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 28705368df20SAndy Whitcroft 287147e0c88bSJoe Perches# line length limit (with some exclusions) 287247e0c88bSJoe Perches# 287347e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 287447e0c88bSJoe Perches# logging functions like pr_info that end in a string 287547e0c88bSJoe Perches# lines with a single string 287647e0c88bSJoe Perches# #defines that are a single string 287747e0c88bSJoe Perches# 287847e0c88bSJoe Perches# There are 3 different line length message types: 2879ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 288047e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 288147e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 288247e0c88bSJoe Perches# 288347e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 288447e0c88bSJoe Perches# 288547e0c88bSJoe Perches 2886b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 288747e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 288847e0c88bSJoe Perches 288947e0c88bSJoe Perches # Check the allowed long line types first 289047e0c88bSJoe Perches 289147e0c88bSJoe Perches # logging functions that end in a string that starts 289247e0c88bSJoe Perches # before $max_line_length 289347e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 289447e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 289547e0c88bSJoe Perches $msg_type = ""; 289647e0c88bSJoe Perches 289747e0c88bSJoe Perches # lines with only strings (w/ possible termination) 289847e0c88bSJoe Perches # #defines with only strings 289947e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 290047e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 290147e0c88bSJoe Perches $msg_type = ""; 290247e0c88bSJoe Perches 2903d560a5f8SJoe Perches # EFI_GUID is another special case 2904d560a5f8SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/) { 2905d560a5f8SJoe Perches $msg_type = ""; 2906d560a5f8SJoe Perches 290747e0c88bSJoe Perches # Otherwise set the alternate message types 290847e0c88bSJoe Perches 290947e0c88bSJoe Perches # a comment starts before $max_line_length 291047e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 291147e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 291247e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 291347e0c88bSJoe Perches 291447e0c88bSJoe Perches # a quoted string starts before $max_line_length 291547e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 291647e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 291747e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 291847e0c88bSJoe Perches } 291947e0c88bSJoe Perches 292047e0c88bSJoe Perches if ($msg_type ne "" && 292147e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 292247e0c88bSJoe Perches WARN($msg_type, 29236cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 29240a920b5bSAndy Whitcroft } 292547e0c88bSJoe Perches } 29260a920b5bSAndy Whitcroft 29278905a67cSAndy Whitcroft# check for adding lines without a newline. 29288905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2929000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2930000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 29318905a67cSAndy Whitcroft } 29328905a67cSAndy Whitcroft 293342e41c54SMike Frysinger# Blackfin: use hi/lo macros 293442e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 293542e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 293642e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2937000d1cc1SJoe Perches ERROR("LO_MACRO", 2938000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 293942e41c54SMike Frysinger } 294042e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 294142e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2942000d1cc1SJoe Perches ERROR("HI_MACRO", 2943000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 294442e41c54SMike Frysinger } 294542e41c54SMike Frysinger } 294642e41c54SMike Frysinger 2947b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2948de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 29490a920b5bSAndy Whitcroft 29500a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 29510a920b5bSAndy Whitcroft# more than 8 must use tabs. 2952c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2953c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2954c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2955d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 29563705ce5bSJoe Perches if (ERROR("CODE_INDENT", 29573705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 29583705ce5bSJoe Perches $fix) { 2959194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 29603705ce5bSJoe Perches } 29610a920b5bSAndy Whitcroft } 29620a920b5bSAndy Whitcroft 296308e44365SAlberto Panizzo# check for space before tabs. 296408e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 296508e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 29663705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 29673705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 29683705ce5bSJoe Perches $fix) { 2969194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2970d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 2971194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2972c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 29733705ce5bSJoe Perches } 297408e44365SAlberto Panizzo } 297508e44365SAlberto Panizzo 2976d1fe9c09SJoe Perches# check for && or || at the start of a line 2977d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2978d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2979d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2980d1fe9c09SJoe Perches } 2981d1fe9c09SJoe Perches 2982a91e8994SJoe Perches# check indentation starts on a tab stop 2983a91e8994SJoe Perches if ($^V && $^V ge 5.10.0 && 2984a91e8994SJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) { 2985a91e8994SJoe Perches my $indent = length($1); 2986a91e8994SJoe Perches if ($indent % 8) { 2987a91e8994SJoe Perches if (WARN("TABSTOP", 2988a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 2989a91e8994SJoe Perches $fix) { 2990a91e8994SJoe Perches $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; 2991a91e8994SJoe Perches } 2992a91e8994SJoe Perches } 2993a91e8994SJoe Perches } 2994a91e8994SJoe Perches 2995d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2996d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 2997fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2998d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2999d1fe9c09SJoe Perches my $oldindent = $1; 3000d1fe9c09SJoe Perches my $rest = $2; 3001d1fe9c09SJoe Perches 3002d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3003d1fe9c09SJoe Perches if ($pos >= 0) { 3004b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3005b34a26f3SJoe Perches my $newindent = $2; 3006d1fe9c09SJoe Perches 3007d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3008d1fe9c09SJoe Perches "\t" x ($pos / 8) . 3009d1fe9c09SJoe Perches " " x ($pos % 8); 3010d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3011d1fe9c09SJoe Perches 3012d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3013d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 30143705ce5bSJoe Perches 30153705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 30163705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 30173705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3018194f66fcSJoe Perches $fixed[$fixlinenr] =~ 30193705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 30203705ce5bSJoe Perches } 3021d1fe9c09SJoe Perches } 3022d1fe9c09SJoe Perches } 3023d1fe9c09SJoe Perches } 3024d1fe9c09SJoe Perches 30256ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 30266ab3a970SJoe Perches# avoid checking a few false positives: 30276ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 30286ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 30296ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 30306ab3a970SJoe Perches# multiline macros that define functions 30316ab3a970SJoe Perches# known attributes or the __attribute__ keyword 30326ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 30336ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 30343705ce5bSJoe Perches if (CHK("SPACING", 3035f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 30363705ce5bSJoe Perches $fix) { 3037194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3038f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 30393705ce5bSJoe Perches } 3040aad4f614SJoe Perches } 3041aad4f614SJoe Perches 304286406b1cSJoe Perches# Block comment styles 304386406b1cSJoe Perches# Networking with an initial /* 304405880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3045fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 304685ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 304785ad978cSJoe Perches $realline > 2) { 304805880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 304905880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 305005880600SJoe Perches } 305105880600SJoe Perches 305286406b1cSJoe Perches# Block comments use * on subsequent lines 305386406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 305486406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3055a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 305661135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3057a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 305886406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 305986406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3060a605e32eSJoe Perches } 3061a605e32eSJoe Perches 306286406b1cSJoe Perches# Block comments use */ on trailing lines 306386406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3064c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3065c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3066c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 306786406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 306886406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 306905880600SJoe Perches } 307005880600SJoe Perches 307108eb9b80SJoe Perches# Block comment * alignment 307208eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3073af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3074af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3075af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 307608eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3077af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3078af207524SJoe Perches my $oldindent; 307908eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3080af207524SJoe Perches if (defined($1)) { 3081af207524SJoe Perches $oldindent = expand_tabs($1); 3082af207524SJoe Perches } else { 3083af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3084af207524SJoe Perches $oldindent = expand_tabs($1); 3085af207524SJoe Perches } 308608eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 308708eb9b80SJoe Perches my $newindent = $1; 308808eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3089af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 309008eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 309108eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 309208eb9b80SJoe Perches } 309308eb9b80SJoe Perches } 309408eb9b80SJoe Perches 30957f619191SJoe Perches# check for missing blank lines after struct/union declarations 30967f619191SJoe Perches# with exceptions for various attributes and macros 30977f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 30987f619191SJoe Perches $line =~ /^\+/ && 30997f619191SJoe Perches !($line =~ /^\+\s*$/ || 31007f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 31017f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 31027f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 31037f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 31047f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 31057f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 31067f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3107d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3108d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3109d752fcc8SJoe Perches $fix) { 3110f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3111d752fcc8SJoe Perches } 31127f619191SJoe Perches } 31137f619191SJoe Perches 3114365dd4eaSJoe Perches# check for multiple consecutive blank lines 3115365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3116365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3117365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3118d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3119d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3120d752fcc8SJoe Perches $fix) { 3121f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3122d752fcc8SJoe Perches } 3123d752fcc8SJoe Perches 3124365dd4eaSJoe Perches $last_blank_line = $linenr; 3125365dd4eaSJoe Perches } 3126365dd4eaSJoe Perches 31273b617e3bSJoe Perches# check for missing blank lines after declarations 31283f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 31293f7bac03SJoe Perches # actual declarations 31303f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 31315a4e1fd3SJoe Perches # function pointer declarations 31325a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 31333f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 31343f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 31353f7bac03SJoe Perches # known declaration macros 31363f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 31373f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 31383f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 31393f7bac03SJoe Perches # other possible extensions of declaration lines 31403f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 31413f7bac03SJoe Perches # not starting a section or a macro "\" extended line 31423f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 31433f7bac03SJoe Perches # looks like a declaration 31443f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 31455a4e1fd3SJoe Perches # function pointer declarations 31465a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 31473f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 31483f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 31493f7bac03SJoe Perches # known declaration macros 31503f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 31513f7bac03SJoe Perches # start of struct or union or enum 31523b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 31533f7bac03SJoe Perches # start or end of block or continuation of declaration 31543f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 31553f7bac03SJoe Perches # bitfield continuation 31563f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 31573f7bac03SJoe Perches # other possible extensions of declaration lines 31583f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 31593f7bac03SJoe Perches # indentation of previous and current line are the same 31603f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3161d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3162d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3163d752fcc8SJoe Perches $fix) { 3164f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3165d752fcc8SJoe Perches } 31663b617e3bSJoe Perches } 31673b617e3bSJoe Perches 31685f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 31696b4c5bebSAndy Whitcroft# Exceptions: 31706b4c5bebSAndy Whitcroft# 1) within comments 31716b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 31726b4c5bebSAndy Whitcroft# 3) hanging labels 31733705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 31745f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 31753705ce5bSJoe Perches if (WARN("LEADING_SPACE", 31763705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 31773705ce5bSJoe Perches $fix) { 3178194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 31793705ce5bSJoe Perches } 31805f7ddae6SRaffaele Recalcati } 31815f7ddae6SRaffaele Recalcati 3182b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3183b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3184b9ea10d6SAndy Whitcroft 31854dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 31864dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 31874dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 31884dbed76fSJoe Perches $context_function = $1; 31894dbed76fSJoe Perches } 31904dbed76fSJoe Perches 31914dbed76fSJoe Perches# check if this appears to be the end of function declaration 31924dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 31934dbed76fSJoe Perches undef $context_function; 31944dbed76fSJoe Perches } 31954dbed76fSJoe Perches 3196032a4c0fSJoe Perches# check indentation of any line with a bare else 3197840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3198032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3199032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3200032a4c0fSJoe Perches my $tabs = length($1) + 1; 3201840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3202840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3203840080a0SJoe Perches defined $lines[$linenr] && 3204840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3205032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3206032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3207032a4c0fSJoe Perches } 3208032a4c0fSJoe Perches } 3209032a4c0fSJoe Perches 3210c00df19aSJoe Perches# check indentation of a line with a break; 3211c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3212c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3213c00df19aSJoe Perches my $tabs = $1; 3214c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3215c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3216c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3217c00df19aSJoe Perches } 3218c00df19aSJoe Perches } 3219c00df19aSJoe Perches 3220c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3221cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3222000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3223000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3224c2fdda0dSAndy Whitcroft } 322522f2a2efSAndy Whitcroft 322642e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 322742e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 322842e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 3229000d1cc1SJoe Perches ERROR("CSYNC", 3230000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 323142e41c54SMike Frysinger } 323242e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 323342e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 3234000d1cc1SJoe Perches ERROR("SSYNC", 3235000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 323642e41c54SMike Frysinger } 323742e41c54SMike Frysinger 323856e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 323956e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 324056e77d70SJoe Perches WARN("HOTPLUG_SECTION", 324156e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 324256e77d70SJoe Perches } 324356e77d70SJoe Perches 32449c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 32452b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 32462b474a1aSAndy Whitcroft $realline_next); 32473e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 3248ca819864SJoe Perches if ($linenr > $suppress_statement && 32491b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3250170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3251f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3252171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3253171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3254171ae1a4SAndy Whitcroft 32553e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 32563e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 32573e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 32583e469cdcSAndy Whitcroft # until we hit end of it. 32593e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 32603e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 32613e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 32623e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 32633e469cdcSAndy Whitcroft } 3264f74bd194SAndy Whitcroft 32652b474a1aSAndy Whitcroft # Find the real next line. 32662b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 32672b474a1aSAndy Whitcroft if (defined $realline_next && 32682b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 32692b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 32702b474a1aSAndy Whitcroft $realline_next++; 32712b474a1aSAndy Whitcroft } 32722b474a1aSAndy Whitcroft 3273171ae1a4SAndy Whitcroft my $s = $stat; 3274171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3275cf655043SAndy Whitcroft 3276c2fdda0dSAndy Whitcroft # Ignore goto labels. 3277171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3278c2fdda0dSAndy Whitcroft 3279c2fdda0dSAndy Whitcroft # Ignore functions being called 3280171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3281c2fdda0dSAndy Whitcroft 3282463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3283463f2864SAndy Whitcroft 3284c45dcabdSAndy Whitcroft # declarations always start with types 3285d2506586SAndy 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) { 3286c45dcabdSAndy Whitcroft my $type = $1; 3287c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3288c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3289c45dcabdSAndy Whitcroft 32906c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3291a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3292c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3293c2fdda0dSAndy Whitcroft } 32948905a67cSAndy Whitcroft 32956c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 329665863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3297c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 32989c0ca6f9SAndy Whitcroft } 32998905a67cSAndy Whitcroft 33008905a67cSAndy Whitcroft # Check for any sort of function declaration. 33018905a67cSAndy Whitcroft # int foo(something bar, other baz); 33028905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3303171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 33048905a67cSAndy Whitcroft my ($name_len) = length($1); 33058905a67cSAndy Whitcroft 3306cf655043SAndy Whitcroft my $ctx = $s; 3307773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 33088905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3309cf655043SAndy Whitcroft 33108905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3311c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 33128905a67cSAndy Whitcroft 3313c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 33148905a67cSAndy Whitcroft } 33158905a67cSAndy Whitcroft } 33168905a67cSAndy Whitcroft } 33178905a67cSAndy Whitcroft 33189c0ca6f9SAndy Whitcroft } 33199c0ca6f9SAndy Whitcroft 332000df344fSAndy Whitcroft# 332100df344fSAndy Whitcroft# Checks which may be anchored in the context. 332200df344fSAndy Whitcroft# 332300df344fSAndy Whitcroft 332400df344fSAndy Whitcroft# Check for switch () and associated case and default 332500df344fSAndy Whitcroft# statements should be at the same indent. 332600df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 332700df344fSAndy Whitcroft my $err = ''; 332800df344fSAndy Whitcroft my $sep = ''; 332900df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 333000df344fSAndy Whitcroft shift(@ctx); 333100df344fSAndy Whitcroft for my $ctx (@ctx) { 333200df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 333300df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 333400df344fSAndy Whitcroft $indent != $cindent) { 333500df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 333600df344fSAndy Whitcroft $sep = ''; 333700df344fSAndy Whitcroft } else { 333800df344fSAndy Whitcroft $sep = "[...]\n"; 333900df344fSAndy Whitcroft } 334000df344fSAndy Whitcroft } 334100df344fSAndy Whitcroft if ($err ne '') { 3342000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3343000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3344de7d4f0eSAndy Whitcroft } 3345de7d4f0eSAndy Whitcroft } 3346de7d4f0eSAndy Whitcroft 3347de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3348de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 33490fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3350773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3351773647a0SAndy Whitcroft 33529c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 33538eef05ddSJoe Perches 33548eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 33558eef05ddSJoe Perches WARN("DEEP_INDENTATION", 33568eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 33578eef05ddSJoe Perches } 33588eef05ddSJoe Perches 3359de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3360de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3361de7d4f0eSAndy Whitcroft 3362548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3363548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3364de7d4f0eSAndy Whitcroft 3365548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3366548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3367548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3368548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3369548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3370773647a0SAndy Whitcroft $ctx_ln++; 3371773647a0SAndy Whitcroft } 3372548596d5SAndy Whitcroft 337353210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 337453210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3375773647a0SAndy Whitcroft 3376773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3377000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3378000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 337901464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 338000df344fSAndy Whitcroft } 3381773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3382773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3383773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3384773647a0SAndy Whitcroft { 33859c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 33869c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3387000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3388000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 338901464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 33909c0ca6f9SAndy Whitcroft } 33919c0ca6f9SAndy Whitcroft } 339200df344fSAndy Whitcroft } 339300df344fSAndy Whitcroft 33944d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 3395f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 33963e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 33973e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 33983e469cdcSAndy Whitcroft if (!defined $stat); 33994d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 34004d001e4dSAndy Whitcroft 34014d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 34024d001e4dSAndy Whitcroft 34039f5af480SJoe Perches # remove inline comments 34049f5af480SJoe Perches $s =~ s/$;/ /g; 34059f5af480SJoe Perches $c =~ s/$;/ /g; 34064d001e4dSAndy Whitcroft 34074d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 34086f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 34096f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 34104d001e4dSAndy Whitcroft 34119f5af480SJoe Perches # Make sure we remove the line prefixes as we have 34129f5af480SJoe Perches # none on the first line, and are going to readd them 34139f5af480SJoe Perches # where necessary. 34149f5af480SJoe Perches $s =~ s/\n./\n/gs; 34159f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 34169f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 34179f5af480SJoe Perches } 34189f5af480SJoe Perches 34194d001e4dSAndy Whitcroft # We want to check the first line inside the block 34204d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 34214d001e4dSAndy Whitcroft # 1) any blank line termination 34224d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 34234d001e4dSAndy Whitcroft # 3) any do (...) { 34244d001e4dSAndy Whitcroft my $continuation = 0; 34254d001e4dSAndy Whitcroft my $check = 0; 34264d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 34274d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 34284d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 34294d001e4dSAndy Whitcroft $continuation = 1; 34304d001e4dSAndy Whitcroft } 34319bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 34324d001e4dSAndy Whitcroft $check = 1; 34334d001e4dSAndy Whitcroft $cond_lines++; 34344d001e4dSAndy Whitcroft } 34354d001e4dSAndy Whitcroft 34364d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 34374d001e4dSAndy Whitcroft # preprocessor statement. 34384d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 34394d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 34404d001e4dSAndy Whitcroft $check = 0; 34414d001e4dSAndy Whitcroft } 34424d001e4dSAndy Whitcroft 34439bd49efeSAndy Whitcroft my $cond_ptr = -1; 3444740504c6SAndy Whitcroft $continuation = 0; 34459bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 34469bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 34474d001e4dSAndy Whitcroft 3448f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3449f16fa28fSAndy Whitcroft # is not linear. 3450f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3451f16fa28fSAndy Whitcroft $check = 0; 3452f16fa28fSAndy Whitcroft } 3453f16fa28fSAndy Whitcroft 34549bd49efeSAndy Whitcroft # Ignore: 34559bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 34569bd49efeSAndy Whitcroft # 2) preprocessor lines, and 34579bd49efeSAndy Whitcroft # 3) labels. 3458740504c6SAndy Whitcroft if ($continuation || 3459740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 34609bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 34619bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3462740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 346330dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 34649bd49efeSAndy Whitcroft $cond_lines++; 34659bd49efeSAndy Whitcroft } 34664d001e4dSAndy Whitcroft } 346730dad6ebSAndy Whitcroft } 34684d001e4dSAndy Whitcroft 34694d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 34704d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 34714d001e4dSAndy Whitcroft 34724d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 34734d001e4dSAndy Whitcroft # this is not this patch's fault. 34744d001e4dSAndy Whitcroft if (!defined($stat_real) || 34754d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 34764d001e4dSAndy Whitcroft $check = 0; 34774d001e4dSAndy Whitcroft } 34784d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 34794d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 34804d001e4dSAndy Whitcroft } 34814d001e4dSAndy Whitcroft 34829bd49efeSAndy 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"; 34834d001e4dSAndy Whitcroft 34849f5af480SJoe Perches if ($check && $s ne '' && 34859f5af480SJoe Perches (($sindent % 8) != 0 || 34869f5af480SJoe Perches ($sindent < $indent) || 3487f6950a73SJoe Perches ($sindent == $indent && 3488f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 34899f5af480SJoe Perches ($sindent > $indent + 8))) { 3490000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3491000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 34924d001e4dSAndy Whitcroft } 34934d001e4dSAndy Whitcroft } 34944d001e4dSAndy Whitcroft 34956c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 34966c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 34971f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 34981f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 34996c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3500c2fdda0dSAndy Whitcroft if ($dbg_values) { 3501c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3502cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3503cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 35041f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3505c2fdda0dSAndy Whitcroft } 35066c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 35076c72ffaaSAndy Whitcroft 350800df344fSAndy Whitcroft#ignore lines not being added 35093705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 351000df344fSAndy Whitcroft 351111ca40a0SJoe Perches# check for dereferences that span multiple lines 351211ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 351311ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 351411ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 351511ca40a0SJoe Perches my $ref = $1; 351611ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 351711ca40a0SJoe Perches $ref .= $1; 351811ca40a0SJoe Perches $ref =~ s/\s//g; 351911ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 352011ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 352111ca40a0SJoe Perches } 352211ca40a0SJoe Perches 3523a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3524c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3525a1ce18e4SJoe Perches my $type = $1; 3526a1ce18e4SJoe Perches my $var = $2; 3527207a8e84SJoe Perches $var = "" if (!defined $var); 3528207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3529a1ce18e4SJoe Perches my $sign = $1; 3530a1ce18e4SJoe Perches my $pointer = $2; 3531a1ce18e4SJoe Perches 3532a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3533a1ce18e4SJoe Perches 3534a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3535a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3536a1ce18e4SJoe Perches $fix) { 3537a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3538207a8e84SJoe Perches my $comp_pointer = $pointer; 3539207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 3540207a8e84SJoe Perches $decl .= $comp_pointer; 3541207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 3542207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 3543a1ce18e4SJoe Perches } 3544a1ce18e4SJoe Perches } 3545a1ce18e4SJoe Perches } 3546a1ce18e4SJoe Perches 3547653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 35487429c690SAndy Whitcroft if ($dbg_type) { 35497429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3550000d1cc1SJoe Perches ERROR("TEST_TYPE", 3551000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 35527429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3553000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3554000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 35557429c690SAndy Whitcroft } 3556653d4876SAndy Whitcroft next; 3557653d4876SAndy Whitcroft } 3558a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3559a1ef277eSAndy Whitcroft if ($dbg_attr) { 35609360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3561000d1cc1SJoe Perches ERROR("TEST_ATTR", 3562000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 35639360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3564000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3565000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3566a1ef277eSAndy Whitcroft } 3567a1ef277eSAndy Whitcroft next; 3568a1ef277eSAndy Whitcroft } 3569653d4876SAndy Whitcroft 3570f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 357199423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 357299423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3573d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3574d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3575f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3576f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3577f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3578d752fcc8SJoe Perches my $fixedline = $prevrawline; 3579d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3580f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3581d752fcc8SJoe Perches $fixedline = $line; 35828d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 3583f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3584d752fcc8SJoe Perches } 3585f0a594c1SAndy Whitcroft } 3586f0a594c1SAndy Whitcroft 358700df344fSAndy Whitcroft# 358800df344fSAndy Whitcroft# Checks which are anchored on the added line. 358900df344fSAndy Whitcroft# 359000df344fSAndy Whitcroft 3591653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3592c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3593653d4876SAndy Whitcroft my $path = $1; 3594653d4876SAndy Whitcroft if ($path =~ m{//}) { 3595000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3596495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3597495e9d84SJoe Perches } 3598495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3599495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3600495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3601653d4876SAndy Whitcroft } 3602653d4876SAndy Whitcroft } 3603653d4876SAndy Whitcroft 360400df344fSAndy Whitcroft# no C99 // comments 360500df344fSAndy Whitcroft if ($line =~ m{//}) { 36063705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 36073705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 36083705ce5bSJoe Perches $fix) { 3609194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 36103705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 36113705ce5bSJoe Perches my $comment = trim($1); 3612194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 36133705ce5bSJoe Perches } 36143705ce5bSJoe Perches } 361500df344fSAndy Whitcroft } 361600df344fSAndy Whitcroft # Remove C99 comments. 36170a920b5bSAndy Whitcroft $line =~ s@//.*@@; 36186c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 36190a920b5bSAndy Whitcroft 36202b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 36212b474a1aSAndy Whitcroft# the whole statement. 36222b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 36232b474a1aSAndy Whitcroft if (defined $realline_next && 36242b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 36252b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 36262b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 36272b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 36283cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 36293cbf62dfSAndy Whitcroft # a prefix: 36303cbf62dfSAndy Whitcroft # XXX(foo); 36313cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3632653d4876SAndy Whitcroft my $name = $1; 363387a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 36343cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 36353cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 36363cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 36373cbf62dfSAndy Whitcroft 36383cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 36392b474a1aSAndy Whitcroft \n.}\s*$| 364048012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 364148012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 364248012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 36432b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 36442b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 364548012058SAndy Whitcroft )/x) { 36462b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 36472b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 36482b474a1aSAndy Whitcroft } else { 36492b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 36500a920b5bSAndy Whitcroft } 36510a920b5bSAndy Whitcroft } 36522b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 36532b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 36542b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 36552b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 36562b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 36572b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 36582b474a1aSAndy Whitcroft } 36592b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 36602b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3661000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3662000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 36632b474a1aSAndy Whitcroft } 36640a920b5bSAndy Whitcroft 36655150bda4SJoe Eloff# check for global initialisers. 36666d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 3667d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 36686d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 3669d5e616fcSJoe Perches $fix) { 36706d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 3671d5e616fcSJoe Perches } 3672f0a594c1SAndy Whitcroft } 36730a920b5bSAndy Whitcroft# check for static initialisers. 36746d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 3675d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 36766d32f7a3SJoe Perches "do not initialise statics to $1\n" . 3677d5e616fcSJoe Perches $herecurr) && 3678d5e616fcSJoe Perches $fix) { 36796d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 3680d5e616fcSJoe Perches } 36810a920b5bSAndy Whitcroft } 36820a920b5bSAndy Whitcroft 36831813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 36841813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 36851813087dSJoe Perches my $tmp = trim($1); 36861813087dSJoe Perches WARN("MISORDERED_TYPE", 36871813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 36881813087dSJoe Perches } 36891813087dSJoe Perches 3690cb710ecaSJoe Perches# check for static const char * arrays. 3691cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3692000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3693000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3694cb710ecaSJoe Perches $herecurr); 3695cb710ecaSJoe Perches } 3696cb710ecaSJoe Perches 3697cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3698cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3699000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3700000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3701cb710ecaSJoe Perches $herecurr); 3702cb710ecaSJoe Perches } 3703cb710ecaSJoe Perches 3704ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3705ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3706ab7e23f3SJoe Perches my $found = $1; 3707ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3708ab7e23f3SJoe Perches WARN("CONST_CONST", 3709ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3710ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3711ab7e23f3SJoe Perches WARN("CONST_CONST", 3712ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3713ab7e23f3SJoe Perches } 3714ab7e23f3SJoe Perches } 3715ab7e23f3SJoe Perches 37169b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 37179b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 37189b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 37199b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 37209b0fa60dSJoe Perches $herecurr); 37219b0fa60dSJoe Perches } 37229b0fa60dSJoe Perches 3723b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3724b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3725b598b670SJoe Perches my $array = $1; 3726b598b670SJoe 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*\))@) { 3727b598b670SJoe Perches my $array_div = $1; 3728b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3729b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3730b598b670SJoe Perches $fix) { 3731b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3732b598b670SJoe Perches } 3733b598b670SJoe Perches } 3734b598b670SJoe Perches } 3735b598b670SJoe Perches 3736b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3737b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3738b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3739b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3740b36190c5SJoe Perches $fix) { 3741194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3742b36190c5SJoe Perches } 3743b36190c5SJoe Perches } 3744b36190c5SJoe Perches 3745653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3746653d4876SAndy Whitcroft# make sense. 3747653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 37488054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3749c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 37508ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 375146d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 3752000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3753000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 37540a920b5bSAndy Whitcroft } 37550a920b5bSAndy Whitcroft 37560a920b5bSAndy Whitcroft# * goes on variable not on type 375765863862SAndy Whitcroft # (char*[ const]) 3758bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3759bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 37603705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3761d8aaf121SAndy Whitcroft 376265863862SAndy Whitcroft # Should start with a space. 376365863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 376465863862SAndy Whitcroft # Should not end with a space. 376565863862SAndy Whitcroft $to =~ s/\s+$//; 376665863862SAndy Whitcroft # '*'s should not have spaces between. 3767f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 376865863862SAndy Whitcroft } 3769d8aaf121SAndy Whitcroft 37703705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 377165863862SAndy Whitcroft if ($from ne $to) { 37723705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 37733705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 37743705ce5bSJoe Perches $fix) { 37753705ce5bSJoe Perches my $sub_from = $ident; 37763705ce5bSJoe Perches my $sub_to = $ident; 37773705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3778194f66fcSJoe Perches $fixed[$fixlinenr] =~ 37793705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 37803705ce5bSJoe Perches } 378165863862SAndy Whitcroft } 3782bfcb2cc7SAndy Whitcroft } 3783bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3784bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 37853705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3786d8aaf121SAndy Whitcroft 378765863862SAndy Whitcroft # Should start with a space. 378865863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 378965863862SAndy Whitcroft # Should not end with a space. 379065863862SAndy Whitcroft $to =~ s/\s+$//; 379165863862SAndy Whitcroft # '*'s should not have spaces between. 3792f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 379365863862SAndy Whitcroft } 379465863862SAndy Whitcroft # Modifiers should have spaces. 379565863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 379665863862SAndy Whitcroft 37973705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3798667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 37993705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 38003705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 38013705ce5bSJoe Perches $fix) { 38023705ce5bSJoe Perches 38033705ce5bSJoe Perches my $sub_from = $match; 38043705ce5bSJoe Perches my $sub_to = $match; 38053705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3806194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38073705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 38083705ce5bSJoe Perches } 380965863862SAndy Whitcroft } 38100a920b5bSAndy Whitcroft } 38110a920b5bSAndy Whitcroft 38129d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 38139d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 38140675a8fbSJean Delvare my $msg_level = \&WARN; 38150675a8fbSJean Delvare $msg_level = \&CHK if ($file); 38160675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 38179d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 38189d3e3c70SJoe Perches } 38190a920b5bSAndy Whitcroft 38209d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 38218905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3822000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3823000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 38248905a67cSAndy Whitcroft } 38258905a67cSAndy Whitcroft 382617441227SJoe Perches# check for uses of printk_ratelimit 382717441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3828000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3829000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 383017441227SJoe Perches } 383117441227SJoe Perches 383200df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 383300df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 383400df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 383525985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 383600df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 3837f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 383800df344fSAndy Whitcroft my $ok = 0; 383900df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 384000df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 384125985edcSLucas De Marchi # we have a preceding printk if it ends 384200df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 384300df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 384400df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 384500df344fSAndy Whitcroft $ok = 1; 384600df344fSAndy Whitcroft } 384700df344fSAndy Whitcroft last; 384800df344fSAndy Whitcroft } 384900df344fSAndy Whitcroft } 385000df344fSAndy Whitcroft if ($ok == 0) { 3851000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3852000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 38530a920b5bSAndy Whitcroft } 385400df344fSAndy Whitcroft } 38550a920b5bSAndy Whitcroft 3856243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3857243f3803SJoe Perches my $orig = $1; 3858243f3803SJoe Perches my $level = lc($orig); 3859243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 38608f26b837SJoe Perches my $level2 = $level; 38618f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3862243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3863daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3864243f3803SJoe Perches } 3865243f3803SJoe Perches 3866243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3867d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3868d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3869d5e616fcSJoe Perches $fix) { 3870194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3871d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3872d5e616fcSJoe Perches } 3873243f3803SJoe Perches } 3874243f3803SJoe Perches 3875dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3876dc139313SJoe Perches my $orig = $1; 3877dc139313SJoe Perches my $level = lc($orig); 3878dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3879dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3880dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3881dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3882dc139313SJoe Perches } 3883dc139313SJoe Perches 388491c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 388591c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 388691c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 388791c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 388891c9afafSAndy Lutomirski WARN("ENOSYS", 388991c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 389091c9afafSAndy Lutomirski } 389191c9afafSAndy Lutomirski 3892653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3893653d4876SAndy Whitcroft# or if closed on same line 38948d182478SJoe Perches if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and 38954e5d56bdSEddie Kovsky !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) { 38968d182478SJoe Perches if (ERROR("OPEN_BRACE", 38978d182478SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr) && 38988d182478SJoe Perches $fix) { 38998d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 39008d182478SJoe Perches my $fixed_line = $rawline; 39018d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 39028d182478SJoe Perches my $line1 = $1; 39038d182478SJoe Perches my $line2 = $2; 39048d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 39058d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 39068d182478SJoe Perches if ($line2 !~ /^\s*$/) { 39078d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 39088d182478SJoe Perches } 39098d182478SJoe Perches } 39100a920b5bSAndy Whitcroft } 3911653d4876SAndy Whitcroft 39128905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 39138905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 39148905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 39158d182478SJoe Perches if (ERROR("OPEN_BRACE", 39168d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 39178d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 39188d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 39198d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 39208d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 39218d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 39228d182478SJoe Perches $fixedline = $rawline; 39238d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 39248d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 39258d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 39268d182478SJoe Perches } 39278d182478SJoe Perches } 39288905a67cSAndy Whitcroft } 39298905a67cSAndy Whitcroft 39300c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 39313705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 39323705ce5bSJoe Perches if (WARN("SPACING", 39333705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 39343705ce5bSJoe Perches $fix) { 3935194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39363705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 39373705ce5bSJoe Perches } 39380c73b4ebSAndy Whitcroft } 39390c73b4ebSAndy Whitcroft 394031070b5dSJoe Perches# Function pointer declarations 394131070b5dSJoe Perches# check spacing between type, funcptr, and args 394231070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 394391f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 394431070b5dSJoe Perches my $declare = $1; 394531070b5dSJoe Perches my $pre_pointer_space = $2; 394631070b5dSJoe Perches my $post_pointer_space = $3; 394731070b5dSJoe Perches my $funcname = $4; 394831070b5dSJoe Perches my $post_funcname_space = $5; 394931070b5dSJoe Perches my $pre_args_space = $6; 395031070b5dSJoe Perches 395191f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 395291f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 395391f72e9cSJoe Perches# don't need a space so don't warn for those. 395491f72e9cSJoe Perches my $post_declare_space = ""; 395591f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 395691f72e9cSJoe Perches $post_declare_space = $1; 395791f72e9cSJoe Perches $declare = rtrim($declare); 395891f72e9cSJoe Perches } 395991f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 396031070b5dSJoe Perches WARN("SPACING", 396131070b5dSJoe Perches "missing space after return type\n" . $herecurr); 396291f72e9cSJoe Perches $post_declare_space = " "; 396331070b5dSJoe Perches } 396431070b5dSJoe Perches 396531070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 396691f72e9cSJoe Perches# This test is not currently implemented because these declarations are 396791f72e9cSJoe Perches# equivalent to 396891f72e9cSJoe Perches# int foo(int bar, ...) 396991f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 397091f72e9cSJoe Perches# 397191f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 397291f72e9cSJoe Perches# WARN("SPACING", 397391f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 397491f72e9cSJoe Perches# } 397531070b5dSJoe Perches 397631070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 397731070b5dSJoe Perches if (defined $pre_pointer_space && 397831070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 397931070b5dSJoe Perches WARN("SPACING", 398031070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 398131070b5dSJoe Perches } 398231070b5dSJoe Perches 398331070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 398431070b5dSJoe Perches if (defined $post_pointer_space && 398531070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 398631070b5dSJoe Perches WARN("SPACING", 398731070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 398831070b5dSJoe Perches } 398931070b5dSJoe Perches 399031070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 399131070b5dSJoe Perches if (defined $post_funcname_space && 399231070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 399331070b5dSJoe Perches WARN("SPACING", 399431070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 399531070b5dSJoe Perches } 399631070b5dSJoe Perches 399731070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 399831070b5dSJoe Perches if (defined $pre_args_space && 399931070b5dSJoe Perches $pre_args_space =~ /^\s/) { 400031070b5dSJoe Perches WARN("SPACING", 400131070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 400231070b5dSJoe Perches } 400331070b5dSJoe Perches 400431070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4005194f66fcSJoe Perches $fixed[$fixlinenr] =~ 400691f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 400731070b5dSJoe Perches } 400831070b5dSJoe Perches } 400931070b5dSJoe Perches 40108d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 40118d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4012fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4013fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 40148d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 40158d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 40168d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4017fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 4018daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 40193705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 40203705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 40213705ce5bSJoe Perches $fix) { 4022194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40233705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 40243705ce5bSJoe Perches } 40258d31cfceSAndy Whitcroft } 40268d31cfceSAndy Whitcroft } 40278d31cfceSAndy Whitcroft 4028f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 40296c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4030c2fdda0dSAndy Whitcroft my $name = $1; 4031773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4032773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4033c2fdda0dSAndy Whitcroft 4034c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4035773647a0SAndy Whitcroft if ($name =~ /^(?: 4036773647a0SAndy Whitcroft if|for|while|switch|return|case| 4037773647a0SAndy Whitcroft volatile|__volatile__| 4038773647a0SAndy Whitcroft __attribute__|format|__extension__| 4039773647a0SAndy Whitcroft asm|__asm__)$/x) 4040773647a0SAndy Whitcroft { 4041c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4042c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4043c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4044c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4045773647a0SAndy Whitcroft 4046773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4047c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4048c2fdda0dSAndy Whitcroft 4049c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4050c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4051773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4052c2fdda0dSAndy Whitcroft 4053c2fdda0dSAndy Whitcroft } else { 40543705ce5bSJoe Perches if (WARN("SPACING", 40553705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 40563705ce5bSJoe Perches $fix) { 4057194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40583705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 40593705ce5bSJoe Perches } 4060f0a594c1SAndy Whitcroft } 40616c72ffaaSAndy Whitcroft } 40629a4cad4eSEric Nelson 4063653d4876SAndy Whitcroft# Check operator spacing. 40640a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 40653705ce5bSJoe Perches my $fixed_line = ""; 40663705ce5bSJoe Perches my $line_fixed = 0; 40673705ce5bSJoe Perches 40689c0ca6f9SAndy Whitcroft my $ops = qr{ 40699c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 40709c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 40719c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 40721f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 407384731623SJoe Perches \?:|\?|: 40749c0ca6f9SAndy Whitcroft }x; 4075cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 40763705ce5bSJoe Perches 40773705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 40783705ce5bSJoe Perches## foreach my $el (@elements) { 40793705ce5bSJoe Perches## print("el: <$el>\n"); 40803705ce5bSJoe Perches## } 40813705ce5bSJoe Perches 40823705ce5bSJoe Perches my @fix_elements = (); 408300df344fSAndy Whitcroft my $off = 0; 40846c72ffaaSAndy Whitcroft 40853705ce5bSJoe Perches foreach my $el (@elements) { 40863705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 40873705ce5bSJoe Perches $off += length($el); 40883705ce5bSJoe Perches } 40893705ce5bSJoe Perches 40903705ce5bSJoe Perches $off = 0; 40913705ce5bSJoe Perches 40926c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4093b34c648bSJoe Perches my $last_after = -1; 40946c72ffaaSAndy Whitcroft 40950a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 40963705ce5bSJoe Perches 40973705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 40983705ce5bSJoe Perches 40993705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 41003705ce5bSJoe Perches 41014a0df2efSAndy Whitcroft $off += length($elements[$n]); 41024a0df2efSAndy Whitcroft 410325985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4104773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4105773647a0SAndy Whitcroft my $cc = ''; 4106773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4107773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4108773647a0SAndy Whitcroft } 4109773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4110773647a0SAndy Whitcroft 41114a0df2efSAndy Whitcroft my $a = ''; 41124a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 41134a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4114cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 41154a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 41164a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 4117773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 41184a0df2efSAndy Whitcroft 41190a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 41204a0df2efSAndy Whitcroft 41214a0df2efSAndy Whitcroft my $c = ''; 41220a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 41234a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 41244a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4125cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 41264a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 41274a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 41288b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 41294a0df2efSAndy Whitcroft } else { 41304a0df2efSAndy Whitcroft $c = 'E'; 41310a920b5bSAndy Whitcroft } 41320a920b5bSAndy Whitcroft 41334a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 41344a0df2efSAndy Whitcroft 41354a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 41364a0df2efSAndy Whitcroft 41376c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 4138de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 41390a920b5bSAndy Whitcroft 414074048ed8SAndy Whitcroft # Pull out the value of this operator. 41416c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 41420a920b5bSAndy Whitcroft 41431f65f947SAndy Whitcroft # Get the full operator variant. 41441f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 41451f65f947SAndy Whitcroft 414613214adfSAndy Whitcroft # Ignore operators passed as parameters. 414713214adfSAndy Whitcroft if ($op_type ne 'V' && 4148d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 414913214adfSAndy Whitcroft 4150cf655043SAndy Whitcroft# # Ignore comments 4151cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 415213214adfSAndy Whitcroft 4153d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 415413214adfSAndy Whitcroft } elsif ($op eq ';') { 4155cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 4156cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 41573705ce5bSJoe Perches if (ERROR("SPACING", 41583705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 4159b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 41603705ce5bSJoe Perches $line_fixed = 1; 41613705ce5bSJoe Perches } 4162d8aaf121SAndy Whitcroft } 4163d8aaf121SAndy Whitcroft 4164d8aaf121SAndy Whitcroft # // is a comment 4165d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 41660a920b5bSAndy Whitcroft 4167b00e4814SJoe Perches # : when part of a bitfield 4168b00e4814SJoe Perches } elsif ($opv eq ':B') { 4169b00e4814SJoe Perches # skip the bitfield test for now 4170b00e4814SJoe Perches 41711f65f947SAndy Whitcroft # No spaces for: 41721f65f947SAndy Whitcroft # -> 4173b00e4814SJoe Perches } elsif ($op eq '->') { 41744a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 41753705ce5bSJoe Perches if (ERROR("SPACING", 41763705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4177b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 41783705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 41793705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 41803705ce5bSJoe Perches } 4181b34c648bSJoe Perches $line_fixed = 1; 41823705ce5bSJoe Perches } 41830a920b5bSAndy Whitcroft } 41840a920b5bSAndy Whitcroft 41852381097bSJoe Perches # , must not have a space before and must have a space on the right. 41860a920b5bSAndy Whitcroft } elsif ($op eq ',') { 41872381097bSJoe Perches my $rtrim_before = 0; 41882381097bSJoe Perches my $space_after = 0; 41892381097bSJoe Perches if ($ctx =~ /Wx./) { 41902381097bSJoe Perches if (ERROR("SPACING", 41912381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 41922381097bSJoe Perches $line_fixed = 1; 41932381097bSJoe Perches $rtrim_before = 1; 41942381097bSJoe Perches } 41952381097bSJoe Perches } 4196cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 41973705ce5bSJoe Perches if (ERROR("SPACING", 41983705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 41993705ce5bSJoe Perches $line_fixed = 1; 4200b34c648bSJoe Perches $last_after = $n; 42012381097bSJoe Perches $space_after = 1; 42022381097bSJoe Perches } 42032381097bSJoe Perches } 42042381097bSJoe Perches if ($rtrim_before || $space_after) { 42052381097bSJoe Perches if ($rtrim_before) { 42062381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 42072381097bSJoe Perches } else { 42082381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 42092381097bSJoe Perches } 42102381097bSJoe Perches if ($space_after) { 42112381097bSJoe Perches $good .= " "; 42123705ce5bSJoe Perches } 42130a920b5bSAndy Whitcroft } 42140a920b5bSAndy Whitcroft 42159c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 421674048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 42179c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 42189c0ca6f9SAndy Whitcroft 42199c0ca6f9SAndy Whitcroft # unary operators should have a space before and 42209c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 42219c0ca6f9SAndy Whitcroft # unary operator, or a cast 42229c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 422374048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 42240d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4225cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 42263705ce5bSJoe Perches if (ERROR("SPACING", 42273705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4228b34c648bSJoe Perches if ($n != $last_after + 2) { 4229b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 42303705ce5bSJoe Perches $line_fixed = 1; 42313705ce5bSJoe Perches } 42320a920b5bSAndy Whitcroft } 4233b34c648bSJoe Perches } 4234a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4235171ae1a4SAndy Whitcroft # A unary '*' may be const 4236171ae1a4SAndy Whitcroft 4237171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 42383705ce5bSJoe Perches if (ERROR("SPACING", 42393705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4240b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 42413705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 42423705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 42433705ce5bSJoe Perches } 4244b34c648bSJoe Perches $line_fixed = 1; 42453705ce5bSJoe Perches } 42460a920b5bSAndy Whitcroft } 42470a920b5bSAndy Whitcroft 42480a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 42490a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4250773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 42513705ce5bSJoe Perches if (ERROR("SPACING", 42523705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4253b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 42543705ce5bSJoe Perches $line_fixed = 1; 42553705ce5bSJoe Perches } 42560a920b5bSAndy Whitcroft } 4257773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4258773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 42593705ce5bSJoe Perches if (ERROR("SPACING", 42603705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4261b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 42623705ce5bSJoe Perches $line_fixed = 1; 42633705ce5bSJoe Perches } 4264653d4876SAndy Whitcroft } 4265773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 42663705ce5bSJoe Perches if (ERROR("SPACING", 42673705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4268b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 42693705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 42703705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4271773647a0SAndy Whitcroft } 4272b34c648bSJoe Perches $line_fixed = 1; 42733705ce5bSJoe Perches } 42743705ce5bSJoe Perches } 42750a920b5bSAndy Whitcroft 42760a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 42779c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 42789c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 42799c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4280c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4281c2fdda0dSAndy Whitcroft $op eq '%') 42820a920b5bSAndy Whitcroft { 4283d2e025f3SJoe Perches if ($check) { 4284d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4285d2e025f3SJoe Perches if (CHK("SPACING", 4286d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4287d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4288d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4289d2e025f3SJoe Perches $line_fixed = 1; 4290d2e025f3SJoe Perches } 4291d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4292d2e025f3SJoe Perches if (CHK("SPACING", 4293d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4294d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4295d2e025f3SJoe Perches $line_fixed = 1; 4296d2e025f3SJoe Perches } 4297d2e025f3SJoe Perches } 4298d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 42993705ce5bSJoe Perches if (ERROR("SPACING", 43003705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4301b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4302b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4303b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4304b34c648bSJoe Perches } 43053705ce5bSJoe Perches $line_fixed = 1; 43063705ce5bSJoe Perches } 43070a920b5bSAndy Whitcroft } 43080a920b5bSAndy Whitcroft 43091f65f947SAndy Whitcroft # A colon needs no spaces before when it is 43101f65f947SAndy Whitcroft # terminating a case value or a label. 43111f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 43121f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 43133705ce5bSJoe Perches if (ERROR("SPACING", 43143705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4315b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43163705ce5bSJoe Perches $line_fixed = 1; 43173705ce5bSJoe Perches } 43181f65f947SAndy Whitcroft } 43191f65f947SAndy Whitcroft 43200a920b5bSAndy Whitcroft # All the others need spaces both sides. 4321cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 43221f65f947SAndy Whitcroft my $ok = 0; 43231f65f947SAndy Whitcroft 432422f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 43251f65f947SAndy Whitcroft if (($op eq '<' && 43261f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 43271f65f947SAndy Whitcroft ($op eq '>' && 43281f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 43291f65f947SAndy Whitcroft { 43301f65f947SAndy Whitcroft $ok = 1; 43311f65f947SAndy Whitcroft } 43321f65f947SAndy Whitcroft 4333e0df7e1fSJoe Perches # for asm volatile statements 4334e0df7e1fSJoe Perches # ignore a colon with another 4335e0df7e1fSJoe Perches # colon immediately before or after 4336e0df7e1fSJoe Perches if (($op eq ':') && 4337e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4338e0df7e1fSJoe Perches $ok = 1; 4339e0df7e1fSJoe Perches } 4340e0df7e1fSJoe Perches 434184731623SJoe Perches # messages are ERROR, but ?: are CHK 43421f65f947SAndy Whitcroft if ($ok == 0) { 43430675a8fbSJean Delvare my $msg_level = \&ERROR; 43440675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 434584731623SJoe Perches 43460675a8fbSJean Delvare if (&{$msg_level}("SPACING", 43473705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4348b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4349b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4350b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4351b34c648bSJoe Perches } 43523705ce5bSJoe Perches $line_fixed = 1; 43533705ce5bSJoe Perches } 43540a920b5bSAndy Whitcroft } 435522f2a2efSAndy Whitcroft } 43564a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 43573705ce5bSJoe Perches 43583705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 43593705ce5bSJoe Perches 43603705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 43610a920b5bSAndy Whitcroft } 43623705ce5bSJoe Perches 43633705ce5bSJoe Perches if (($#elements % 2) == 0) { 43643705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 43653705ce5bSJoe Perches } 43663705ce5bSJoe Perches 4367194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4368194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 43693705ce5bSJoe Perches } 43703705ce5bSJoe Perches 43713705ce5bSJoe Perches 43720a920b5bSAndy Whitcroft } 43730a920b5bSAndy Whitcroft 4374786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4375d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4376786b6326SJoe Perches if (WARN("SPACING", 4377786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4378786b6326SJoe Perches $fix) { 4379194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4380786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4381786b6326SJoe Perches } 4382786b6326SJoe Perches } 4383786b6326SJoe Perches 4384f0a594c1SAndy Whitcroft# check for multiple assignments 4385f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4386000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4387000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4388f0a594c1SAndy Whitcroft } 4389f0a594c1SAndy Whitcroft 439022f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 439122f2a2efSAndy Whitcroft## # continuation. 439222f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 439322f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 439422f2a2efSAndy Whitcroft## 439522f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 439622f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 439722f2a2efSAndy Whitcroft## my $ln = $line; 439822f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 439922f2a2efSAndy Whitcroft## } 440022f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4401000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4402000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 440322f2a2efSAndy Whitcroft## } 440422f2a2efSAndy Whitcroft## } 4405f0a594c1SAndy Whitcroft 44060a920b5bSAndy Whitcroft#need space before brace following if, while, etc 44076b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 44084e5d56bdSEddie Kovsky $line =~ /do\{/) { 44093705ce5bSJoe Perches if (ERROR("SPACING", 44103705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 44113705ce5bSJoe Perches $fix) { 44128d81ae05SCyril Bur $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/; 44133705ce5bSJoe Perches } 4414de7d4f0eSAndy Whitcroft } 4415de7d4f0eSAndy Whitcroft 4416c4a62ef9SJoe Perches## # check for blank lines before declarations 4417c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4418c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4419c4a62ef9SJoe Perches## WARN("SPACING", 4420c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4421c4a62ef9SJoe Perches## } 4422c4a62ef9SJoe Perches## 4423c4a62ef9SJoe Perches 4424de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4425de7d4f0eSAndy Whitcroft# on the line 4426de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4427d5e616fcSJoe Perches if (ERROR("SPACING", 4428d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4429d5e616fcSJoe Perches $fix) { 4430194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4431d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4432d5e616fcSJoe Perches } 44330a920b5bSAndy Whitcroft } 44340a920b5bSAndy Whitcroft 443522f2a2efSAndy Whitcroft# check spacing on square brackets 443622f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 44373705ce5bSJoe Perches if (ERROR("SPACING", 44383705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 44393705ce5bSJoe Perches $fix) { 4440194f66fcSJoe Perches $fixed[$fixlinenr] =~ 44413705ce5bSJoe Perches s/\[\s+/\[/; 44423705ce5bSJoe Perches } 444322f2a2efSAndy Whitcroft } 444422f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 44453705ce5bSJoe Perches if (ERROR("SPACING", 44463705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 44473705ce5bSJoe Perches $fix) { 4448194f66fcSJoe Perches $fixed[$fixlinenr] =~ 44493705ce5bSJoe Perches s/\s+\]/\]/; 44503705ce5bSJoe Perches } 445122f2a2efSAndy Whitcroft } 445222f2a2efSAndy Whitcroft 4453c45dcabdSAndy Whitcroft# check spacing on parentheses 44549c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 44559c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 44563705ce5bSJoe Perches if (ERROR("SPACING", 44573705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 44583705ce5bSJoe Perches $fix) { 4459194f66fcSJoe Perches $fixed[$fixlinenr] =~ 44603705ce5bSJoe Perches s/\(\s+/\(/; 44613705ce5bSJoe Perches } 446222f2a2efSAndy Whitcroft } 446313214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4464c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4465c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 44663705ce5bSJoe Perches if (ERROR("SPACING", 44673705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 44683705ce5bSJoe Perches $fix) { 4469194f66fcSJoe Perches $fixed[$fixlinenr] =~ 44703705ce5bSJoe Perches s/\s+\)/\)/; 44713705ce5bSJoe Perches } 447222f2a2efSAndy Whitcroft } 447322f2a2efSAndy Whitcroft 4474e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4475e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4476e2826fd0SJoe Perches 4477e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4478ea4acbb1SJoe Perches my $var = $1; 4479ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4480ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4481ea4acbb1SJoe Perches $fix) { 4482ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4483ea4acbb1SJoe Perches } 4484ea4acbb1SJoe Perches } 4485ea4acbb1SJoe Perches 4486ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4487ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4488ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4489ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4490ea4acbb1SJoe Perches my $var = $2; 4491ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4492ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4493ea4acbb1SJoe Perches $fix) { 4494ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4495ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4496ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4497ea4acbb1SJoe Perches } 4498e2826fd0SJoe Perches } 4499e2826fd0SJoe Perches 450063b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 450163b7c73eSJoe Perches if ($^V && $^V ge 5.10.0 && defined($stat) && 450263b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 450363b7c73eSJoe Perches my $if_stat = $1; 450463b7c73eSJoe Perches my $test = substr($2, 1, -1); 450563b7c73eSJoe Perches my $herectx; 450663b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 450763b7c73eSJoe Perches my $match = $1; 450863b7c73eSJoe Perches # avoid parentheses around potential macro args 450963b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 451063b7c73eSJoe Perches if (!defined($herectx)) { 451163b7c73eSJoe Perches $herectx = $here . "\n"; 451263b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 451363b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 451463b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 451563b7c73eSJoe Perches $herectx .= $rl . "\n"; 451663b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 451763b7c73eSJoe Perches } 451863b7c73eSJoe Perches } 451963b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 452063b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 452163b7c73eSJoe Perches } 452263b7c73eSJoe Perches } 452363b7c73eSJoe Perches 45240a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 45254a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 45260a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 45273705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 45283705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 45293705ce5bSJoe Perches $fix) { 4530194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45313705ce5bSJoe Perches s/^(.)\s+/$1/; 45323705ce5bSJoe Perches } 45330a920b5bSAndy Whitcroft } 45340a920b5bSAndy Whitcroft 45355b9553abSJoe Perches# return is not a function 4536507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4537c45dcabdSAndy Whitcroft my $spacing = $1; 4538507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 45395b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 45405b9553abSJoe Perches my $value = $1; 45415b9553abSJoe Perches $value = deparenthesize($value); 45425b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4543000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4544000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 45455b9553abSJoe Perches } 4546c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4547000d1cc1SJoe Perches ERROR("SPACING", 4548000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4549c45dcabdSAndy Whitcroft } 4550c45dcabdSAndy Whitcroft } 4551507e5141SJoe Perches 4552b43ae21bSJoe Perches# unnecessary return in a void function 4553b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4554b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4555b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4556b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4557b43ae21bSJoe Perches $linenr >= 3 && 4558b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4559b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 45609819cf25SJoe Perches WARN("RETURN_VOID", 4561b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 45629819cf25SJoe Perches } 45639819cf25SJoe Perches 4564189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4565189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4566189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4567189248d8SJoe Perches my $openparens = $1; 4568189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4569189248d8SJoe Perches my $msg = ""; 4570189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4571189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4572189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4573189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4574189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4575189248d8SJoe Perches } 4576189248d8SJoe Perches } 4577189248d8SJoe Perches 4578c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4579c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4580c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4581c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 4582c5595fa2SJoe Perches if ($^V && $^V ge 5.10.0 && 4583c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4584c5595fa2SJoe Perches my $lead = $1; 4585c5595fa2SJoe Perches my $const = $2; 4586c5595fa2SJoe Perches my $comp = $3; 4587c5595fa2SJoe Perches my $to = $4; 4588c5595fa2SJoe Perches my $newcomp = $comp; 4589f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 4590c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4591c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4592c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4593c5595fa2SJoe Perches $fix) { 4594c5595fa2SJoe Perches if ($comp eq "<") { 4595c5595fa2SJoe Perches $newcomp = ">"; 4596c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4597c5595fa2SJoe Perches $newcomp = ">="; 4598c5595fa2SJoe Perches } elsif ($comp eq ">") { 4599c5595fa2SJoe Perches $newcomp = "<"; 4600c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4601c5595fa2SJoe Perches $newcomp = "<="; 4602c5595fa2SJoe Perches } 4603c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4604c5595fa2SJoe Perches } 4605c5595fa2SJoe Perches } 4606c5595fa2SJoe Perches 4607f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4608f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 460953a3c448SAndy Whitcroft my $name = $1; 461053a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4611000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4612f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 461353a3c448SAndy Whitcroft } 461453a3c448SAndy Whitcroft } 4615c45dcabdSAndy Whitcroft 46160a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 46174a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 46183705ce5bSJoe Perches if (ERROR("SPACING", 46193705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 46203705ce5bSJoe Perches $fix) { 4621194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46223705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 46233705ce5bSJoe Perches } 46240a920b5bSAndy Whitcroft } 46250a920b5bSAndy Whitcroft 4626f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4627f5fe35ddSAndy Whitcroft# statements after the conditional. 4628170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 46293e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 46303e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 46313e469cdcSAndy Whitcroft if (!defined $stat); 4632170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4633170d3a22SAndy Whitcroft $remain_next, $off_next); 4634170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4635170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4636170d3a22SAndy Whitcroft 4637170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4638170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4639170d3a22SAndy Whitcroft # then count those as offsets. 4640170d3a22SAndy Whitcroft my ($whitespace) = 4641170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4642170d3a22SAndy Whitcroft my $offset = 4643170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4644170d3a22SAndy Whitcroft 4645170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4646170d3a22SAndy Whitcroft $offset} = 1; 4647170d3a22SAndy Whitcroft } 4648170d3a22SAndy Whitcroft } 4649170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4650c11230f4SJoe Perches defined($stat) && defined($cond) && 4651170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4652171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 46538905a67cSAndy Whitcroft 4654b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4655000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4656000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 46578905a67cSAndy Whitcroft } 46588905a67cSAndy Whitcroft 46598905a67cSAndy Whitcroft # Find out what is on the end of the line after the 46608905a67cSAndy Whitcroft # conditional. 4661773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 46628905a67cSAndy Whitcroft $s =~ s/\n.*//g; 466313214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 466453210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 466553210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4666773647a0SAndy Whitcroft { 4667bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4668bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4669bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 467042bdf74cSHidetoshi Seto my $stat_real = ''; 4671bb44ad39SAndy Whitcroft 467242bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 467342bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4674bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4675bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4676bb44ad39SAndy Whitcroft } 4677bb44ad39SAndy Whitcroft 4678000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4679000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 46808905a67cSAndy Whitcroft } 46818905a67cSAndy Whitcroft } 46828905a67cSAndy Whitcroft 468313214adfSAndy Whitcroft# Check for bitwise tests written as boolean 468413214adfSAndy Whitcroft if ($line =~ / 468513214adfSAndy Whitcroft (?: 468613214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 468713214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 468813214adfSAndy Whitcroft (?:\&\&|\|\|) 468913214adfSAndy Whitcroft | 469013214adfSAndy Whitcroft (?:\&\&|\|\|) 469113214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 469213214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 469313214adfSAndy Whitcroft )/x) 469413214adfSAndy Whitcroft { 4695000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4696000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 469713214adfSAndy Whitcroft } 469813214adfSAndy Whitcroft 46998905a67cSAndy Whitcroft# if and else should not have general statements after it 470013214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 470113214adfSAndy Whitcroft my $s = $1; 470213214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 470313214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4704000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4705000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 47060a920b5bSAndy Whitcroft } 470713214adfSAndy Whitcroft } 470839667782SAndy Whitcroft# if should not continue a brace 470939667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4710000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4711048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 471239667782SAndy Whitcroft $herecurr); 471339667782SAndy Whitcroft } 4714a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4715a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4716a1080bf8SAndy Whitcroft $line !~ /\G(?: 47173fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4718a1080bf8SAndy Whitcroft \s*return\s+ 4719a1080bf8SAndy Whitcroft )/xg) 4720a1080bf8SAndy Whitcroft { 4721000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4722000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4723a1080bf8SAndy Whitcroft } 47240a920b5bSAndy Whitcroft 47250a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 47260a920b5bSAndy Whitcroft # indent level to be relevant to each other. 47278b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 47280a920b5bSAndy Whitcroft $previndent == $indent) { 47298b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 47308b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 47318b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 47328b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 47338b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 47348b8856f4SJoe Perches my $fixedline = $prevrawline; 47358b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 47368b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 47378b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 47388b8856f4SJoe Perches } 47398b8856f4SJoe Perches $fixedline = $rawline; 47408b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 47418b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 47428b8856f4SJoe Perches } 47430a920b5bSAndy Whitcroft } 47440a920b5bSAndy Whitcroft 47458b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4746c2fdda0dSAndy Whitcroft $previndent == $indent) { 4747c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4748c2fdda0dSAndy Whitcroft 4749c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4750c2fdda0dSAndy Whitcroft # conditional. 4751773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4752c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4753c2fdda0dSAndy Whitcroft 4754c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 47558b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 47568b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 47578b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 47588b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 47598b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 47608b8856f4SJoe Perches my $fixedline = $prevrawline; 47618b8856f4SJoe Perches my $trailing = $rawline; 47628b8856f4SJoe Perches $trailing =~ s/^\+//; 47638b8856f4SJoe Perches $trailing = trim($trailing); 47648b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 47658b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 47668b8856f4SJoe Perches } 4767c2fdda0dSAndy Whitcroft } 4768c2fdda0dSAndy Whitcroft } 4769c2fdda0dSAndy Whitcroft 477095e2c602SJoe Perches#Specific variable tests 4771323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4772323c1260SJoe Perches my $var = $1; 477395e2c602SJoe Perches 477495e2c602SJoe Perches#gcc binary extension 477595e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4776d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4777d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4778d5e616fcSJoe Perches $fix) { 4779d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4780194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4781d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4782d5e616fcSJoe Perches } 478395e2c602SJoe Perches } 478495e2c602SJoe Perches 478595e2c602SJoe Perches#CamelCase 4786807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4787be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 478822735ce8SJoe Perches#Ignore Page<foo> variants 4789807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 479022735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4791f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4792f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4793f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 47947e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 47957e781f67SJoe Perches my $word = $1; 47967e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4797d8b07710SJoe Perches if ($check) { 4798d8b07710SJoe Perches seed_camelcase_includes(); 4799d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4800d8b07710SJoe Perches seed_camelcase_file($realfile); 4801d8b07710SJoe Perches $camelcase_file_seeded = 1; 4802d8b07710SJoe Perches } 4803d8b07710SJoe Perches } 48047e781f67SJoe Perches if (!defined $camelcase{$word}) { 48057e781f67SJoe Perches $camelcase{$word} = 1; 4806be79794bSJoe Perches CHK("CAMELCASE", 48077e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 48087e781f67SJoe Perches } 4809323c1260SJoe Perches } 4810323c1260SJoe Perches } 48113445686aSJoe Perches } 48120a920b5bSAndy Whitcroft 48130a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4814d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4815d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4816d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4817d5e616fcSJoe Perches $fix) { 4818194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4819d5e616fcSJoe Perches } 48200a920b5bSAndy Whitcroft } 48210a920b5bSAndy Whitcroft 48220e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 48230e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4824c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4825e09dec48SAndy Whitcroft my $file = "$1.h"; 4826e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4827e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4828e09dec48SAndy Whitcroft $realfile ne $checkfile && 48297840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4830c45dcabdSAndy Whitcroft { 48310e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 48320e212e0aSFabian Frederick if ($asminclude > 0) { 4833e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4834000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4835000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4836e09dec48SAndy Whitcroft } else { 4837000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4838000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4839e09dec48SAndy Whitcroft } 48400a920b5bSAndy Whitcroft } 48410a920b5bSAndy Whitcroft } 48420e212e0aSFabian Frederick } 48430a920b5bSAndy Whitcroft 4844653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4845653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4846cf655043SAndy Whitcroft# in a known good container 4847b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4848b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4849d8aaf121SAndy Whitcroft my $ln = $linenr; 4850d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4851c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4852c45dcabdSAndy Whitcroft my $ctx = ''; 485308a2843eSJoe Perches my $has_flow_statement = 0; 485408a2843eSJoe Perches my $has_arg_concat = 0; 4855c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4856f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4857f74bd194SAndy Whitcroft $ctx = $dstat; 4858c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4859a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4860c45dcabdSAndy Whitcroft 486108a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 486262e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 486308a2843eSJoe Perches 4864f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 4865f59b64bfSJoe Perches my $define_args = $1; 4866f59b64bfSJoe Perches my $define_stmt = $dstat; 4867f59b64bfSJoe Perches my @def_args = (); 4868f59b64bfSJoe Perches 4869f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 4870f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 4871f59b64bfSJoe Perches $define_args =~ s/\s*//g; 4872f59b64bfSJoe Perches @def_args = split(",", $define_args); 4873f59b64bfSJoe Perches } 4874f59b64bfSJoe Perches 4875292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4876c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4877c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4878c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4879c45dcabdSAndy Whitcroft 4880c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4881bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4882bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 48836b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 4884bf30d6edSAndy Whitcroft { 4885c45dcabdSAndy Whitcroft } 4886c45dcabdSAndy Whitcroft 4887e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 488833acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 488933acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 4890e45bab8eSAndy Whitcroft { 4891e45bab8eSAndy Whitcroft } 4892e45bab8eSAndy Whitcroft 489342e15293SJoe Perches # Make asm volatile uses seem like a generic function 489442e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 489542e15293SJoe Perches 4896c45dcabdSAndy Whitcroft my $exceptions = qr{ 4897c45dcabdSAndy Whitcroft $Declare| 4898c45dcabdSAndy Whitcroft module_param_named| 4899a0a0a7a9SKees Cook MODULE_PARM_DESC| 4900c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4901c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4902383099fdSAndy Whitcroft __typeof__\(| 490322fd2d3eSStefani Seibold union| 490422fd2d3eSStefani Seibold struct| 4905ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 49066b10df42SVladimir Zapolskiy ^\"|\"$| 49076b10df42SVladimir Zapolskiy ^\[ 4908c45dcabdSAndy Whitcroft }x; 49095eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4910f59b64bfSJoe Perches 4911f59b64bfSJoe Perches $ctx =~ s/\n*$//; 4912f59b64bfSJoe Perches my $herectx = $here . "\n"; 4913f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 4914f59b64bfSJoe Perches 4915f59b64bfSJoe Perches for (my $n = 0; $n < $stmt_cnt; $n++) { 4916f59b64bfSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4917f59b64bfSJoe Perches } 4918f59b64bfSJoe Perches 4919f74bd194SAndy Whitcroft if ($dstat ne '' && 4920f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4921f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 49223cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4923356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4924f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4925f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4926e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 492772f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4928f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4929f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4930f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 49314e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 4932f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4933c45dcabdSAndy Whitcroft { 4934e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 4935e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4936e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 4937e795556aSJoe Perches } elsif ($dstat =~ /;/) { 4938f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4939f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4940f74bd194SAndy Whitcroft } else { 4941000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 4942388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 4943d8aaf121SAndy Whitcroft } 4944f59b64bfSJoe Perches 4945f59b64bfSJoe Perches } 49465207649bSJoe Perches 49475207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 49485207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 49495207649bSJoe Perches my $first = 1; 49505207649bSJoe Perches $define_stmt = ""; 49515207649bSJoe Perches foreach my $l (@stmt_array) { 49525207649bSJoe Perches $l =~ s/\\$//; 49535207649bSJoe Perches if ($first) { 49545207649bSJoe Perches $define_stmt = $l; 49555207649bSJoe Perches $first = 0; 49565207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 49575207649bSJoe Perches $define_stmt .= substr($l, 1); 49585207649bSJoe Perches } 49595207649bSJoe Perches } 49605207649bSJoe Perches $define_stmt =~ s/$;//g; 49615207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 49625207649bSJoe Perches $define_stmt = trim($define_stmt); 49635207649bSJoe Perches 4964f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 4965f59b64bfSJoe Perches foreach my $arg (@def_args) { 4966f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 49679192d41aSJoe Perches next if ($arg =~ /^type$/i); 49687fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 49697fe528a2SJoe Perches $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 49707fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 49717fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 49727fe528a2SJoe Perches my $use_cnt = $tmp_stmt =~ s/\b$arg\b//g; 4973f59b64bfSJoe Perches if ($use_cnt > 1) { 4974f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 4975f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 4976f59b64bfSJoe Perches } 49779192d41aSJoe Perches# check if any macro arguments may have other precedence issues 49787fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 49799192d41aSJoe Perches ((defined($1) && $1 ne ',') || 49809192d41aSJoe Perches (defined($2) && $2 ne ','))) { 49819192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 49829192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 49839192d41aSJoe Perches } 49840a920b5bSAndy Whitcroft } 49855023d347SJoe Perches 498608a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 498708a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 498808a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 498908a2843eSJoe Perches my $herectx = $here . "\n"; 499008a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 499108a2843eSJoe Perches 499208a2843eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 499308a2843eSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 499408a2843eSJoe Perches } 499508a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 499608a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 499708a2843eSJoe Perches } 499808a2843eSJoe Perches 4999481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 50005023d347SJoe Perches 50015023d347SJoe Perches } else { 50025023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5003481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5004481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 50055023d347SJoe Perches $line =~ /^\+.*\\$/) { 50065023d347SJoe Perches WARN("LINE_CONTINUATIONS", 50075023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 50085023d347SJoe Perches } 5009653d4876SAndy Whitcroft } 50100a920b5bSAndy Whitcroft 5011b13edf7fSJoe Perches# do {} while (0) macro tests: 5012b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5013b13edf7fSJoe Perches# macro should not end with a semicolon 5014b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 5015b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5016b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5017b13edf7fSJoe Perches my $ln = $linenr; 5018b13edf7fSJoe Perches my $cnt = $realcnt; 5019b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5020b13edf7fSJoe Perches my $ctx = ''; 5021b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5022b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5023b13edf7fSJoe Perches $ctx = $dstat; 5024b13edf7fSJoe Perches 5025b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 50261b36b201SJoe Perches $dstat =~ s/$;/ /g; 5027b13edf7fSJoe Perches 5028b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5029b13edf7fSJoe Perches my $stmts = $2; 5030b13edf7fSJoe Perches my $semis = $3; 5031b13edf7fSJoe Perches 5032b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5033b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5034b13edf7fSJoe Perches my $herectx = $here . "\n"; 5035b13edf7fSJoe Perches 5036b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5037b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5038b13edf7fSJoe Perches } 5039b13edf7fSJoe Perches 5040ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5041ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5042b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5043b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5044b13edf7fSJoe Perches } 5045b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5046b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5047b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5048b13edf7fSJoe Perches } 5049f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5050f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5051f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5052f5ef95b1SJoe Perches my $herectx = $here . "\n"; 5053f5ef95b1SJoe Perches 5054f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5055f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5056f5ef95b1SJoe Perches } 5057f5ef95b1SJoe Perches 5058f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5059f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5060b13edf7fSJoe Perches } 5061b13edf7fSJoe Perches } 5062b13edf7fSJoe Perches 5063080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 5064080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 5065080ba929SMike Frysinger# . 5066080ba929SMike Frysinger# ALIGN(...) 5067080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 5068080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 5069000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 5070000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 5071080ba929SMike Frysinger } 5072080ba929SMike Frysinger 5073f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 507413214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 507513214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5076cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 507713214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5078cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5079cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5080aad4f614SJoe Perches my @allowed = (); 5081aad4f614SJoe Perches my $allow = 0; 508213214adfSAndy Whitcroft my $seen = 0; 5083773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5084cf655043SAndy Whitcroft my $ln = $linenr - 1; 508513214adfSAndy Whitcroft for my $chunk (@chunks) { 508613214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 508713214adfSAndy Whitcroft 5088773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5089773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5090773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 5091773647a0SAndy Whitcroft 5092aad4f614SJoe Perches $allowed[$allow] = 0; 5093773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5094773647a0SAndy Whitcroft 5095773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 5096773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 5097773647a0SAndy Whitcroft 5098773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5099cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 5100cf655043SAndy Whitcroft 5101773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 510213214adfSAndy Whitcroft 510313214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 510413214adfSAndy Whitcroft 5105aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5106cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5107cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5108aad4f614SJoe Perches $allowed[$allow] = 1; 510913214adfSAndy Whitcroft } 511013214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5111cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5112aad4f614SJoe Perches $allowed[$allow] = 1; 511313214adfSAndy Whitcroft } 5114cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5115cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5116aad4f614SJoe Perches $allowed[$allow] = 1; 511713214adfSAndy Whitcroft } 5118aad4f614SJoe Perches $allow++; 511913214adfSAndy Whitcroft } 5120aad4f614SJoe Perches if ($seen) { 5121aad4f614SJoe Perches my $sum_allowed = 0; 5122aad4f614SJoe Perches foreach (@allowed) { 5123aad4f614SJoe Perches $sum_allowed += $_; 5124aad4f614SJoe Perches } 5125aad4f614SJoe Perches if ($sum_allowed == 0) { 5126000d1cc1SJoe Perches WARN("BRACES", 5127000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 5128aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 5129aad4f614SJoe Perches $seen != $allow) { 5130aad4f614SJoe Perches CHK("BRACES", 5131aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 5132aad4f614SJoe Perches } 513313214adfSAndy Whitcroft } 513413214adfSAndy Whitcroft } 513513214adfSAndy Whitcroft } 5136773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 513713214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 5138cf655043SAndy Whitcroft my $allowed = 0; 5139f0a594c1SAndy Whitcroft 5140cf655043SAndy Whitcroft # Check the pre-context. 5141cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 5142cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 5143cf655043SAndy Whitcroft $allowed = 1; 5144f0a594c1SAndy Whitcroft } 5145773647a0SAndy Whitcroft 5146773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 5147773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 5148773647a0SAndy Whitcroft 5149cf655043SAndy Whitcroft # Check the condition. 5150cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 5151773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 5152cf655043SAndy Whitcroft if (defined $cond) { 5153773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5154cf655043SAndy Whitcroft } 5155cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5156cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5157cf655043SAndy Whitcroft $allowed = 1; 5158cf655043SAndy Whitcroft } 5159cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5160cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5161cf655043SAndy Whitcroft $allowed = 1; 5162cf655043SAndy Whitcroft } 5163cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5164cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5165cf655043SAndy Whitcroft $allowed = 1; 5166cf655043SAndy Whitcroft } 5167cf655043SAndy Whitcroft # Check the post-context. 5168cf655043SAndy Whitcroft if (defined $chunks[1]) { 5169cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 5170cf655043SAndy Whitcroft if (defined $cond) { 5171773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5172cf655043SAndy Whitcroft } 5173cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 5174cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5175cf655043SAndy Whitcroft $allowed = 1; 5176cf655043SAndy Whitcroft } 5177cf655043SAndy Whitcroft } 5178cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 517969932487SJustin P. Mattock my $herectx = $here . "\n"; 5180f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 5181cf655043SAndy Whitcroft 5182f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 518369932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 5184cf655043SAndy Whitcroft } 5185cf655043SAndy Whitcroft 5186000d1cc1SJoe Perches WARN("BRACES", 5187000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 5188f0a594c1SAndy Whitcroft } 5189f0a594c1SAndy Whitcroft } 5190f0a594c1SAndy Whitcroft 5191e4c5babdSJoe Perches# check for single line unbalanced braces 519295330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 519395330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 5194e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 5195e4c5babdSJoe Perches } 5196e4c5babdSJoe Perches 51970979ae66SJoe Perches# check for unnecessary blank lines around braces 519877b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5199f8e58219SJoe Perches if (CHK("BRACES", 5200f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5201f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 5202f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5203f8e58219SJoe Perches } 52040979ae66SJoe Perches } 520577b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5206f8e58219SJoe Perches if (CHK("BRACES", 5207f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5208f8e58219SJoe Perches $fix) { 5209f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 5210f8e58219SJoe Perches } 52110979ae66SJoe Perches } 52120979ae66SJoe Perches 52134a0df2efSAndy Whitcroft# no volatiles please 52146c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 52156c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5216000d1cc1SJoe Perches WARN("VOLATILE", 52178c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 52184a0df2efSAndy Whitcroft } 52194a0df2efSAndy Whitcroft 52205e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 52215e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 52225e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 52235e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 522433acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 52255e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 52265e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 52275e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 52285e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 52295e4f6ba5SJoe Perches $fix && 52305e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 52315e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 52325e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 52335e4f6ba5SJoe Perches my $comma_close = ""; 52345e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 52355e4f6ba5SJoe Perches $comma_close = $1; 52365e4f6ba5SJoe Perches } 52375e4f6ba5SJoe Perches 52385e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 52395e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 52405e4f6ba5SJoe Perches my $fixedline = $prevrawline; 52415e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 52425e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 52435e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 52445e4f6ba5SJoe Perches $fixedline = $rawline; 52455e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 52465e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 52475e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 52485e4f6ba5SJoe Perches } 52495e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 52505e4f6ba5SJoe Perches } 52515e4f6ba5SJoe Perches } 52525e4f6ba5SJoe Perches 52535e4f6ba5SJoe Perches# check for missing a space in a string concatenation 52545e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 52555e4f6ba5SJoe Perches WARN('MISSING_SPACE', 52565e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 52575e4f6ba5SJoe Perches } 52585e4f6ba5SJoe Perches 525977cb8546SJoe Perches# check for an embedded function name in a string when the function is known 5260e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 5261e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 5262e4b7d309SJoe Perches# function declarations 526377cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 526477cb8546SJoe Perches defined($context_function) && 5265e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 5266e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 526777cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 5268e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 526977cb8546SJoe Perches } 527077cb8546SJoe Perches 52715e4f6ba5SJoe Perches# check for spaces before a quoted newline 52725e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 52735e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 52745e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 52755e4f6ba5SJoe Perches $fix) { 52765e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 52775e4f6ba5SJoe Perches } 52785e4f6ba5SJoe Perches 52795e4f6ba5SJoe Perches } 52805e4f6ba5SJoe Perches 5281f17dba4fSJoe Perches# concatenated string without spaces between elements 528233acb54aSJoe Perches if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) { 5283f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 5284f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 5285f17dba4fSJoe Perches } 5286f17dba4fSJoe Perches 528790ad30e5SJoe Perches# uncoalesced string fragments 528833acb54aSJoe Perches if ($line =~ /$String\s*"/) { 528990ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 529090ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 529190ad30e5SJoe Perches } 529290ad30e5SJoe Perches 5293522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 5294522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 5295522b837cSAlexey Dobriyan my $show_Z = 1; 52965e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 5297522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 52985e4f6ba5SJoe Perches $string =~ s/%%/__/g; 5299522b837cSAlexey Dobriyan # check for %L 5300522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 53015e4f6ba5SJoe Perches WARN("PRINTF_L", 5302522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 5303522b837cSAlexey Dobriyan $show_L = 0; 53045e4f6ba5SJoe Perches } 5305522b837cSAlexey Dobriyan # check for %Z 5306522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 5307522b837cSAlexey Dobriyan WARN("PRINTF_Z", 5308522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 5309522b837cSAlexey Dobriyan $show_Z = 0; 5310522b837cSAlexey Dobriyan } 5311522b837cSAlexey Dobriyan # check for 0x<decimal> 5312522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 5313522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 53146e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 53156e300757SJoe Perches } 53165e4f6ba5SJoe Perches } 53175e4f6ba5SJoe Perches 53185e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 53195e4f6ba5SJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 53205e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 53215e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 53225e4f6ba5SJoe Perches } 53235e4f6ba5SJoe Perches 532400df344fSAndy Whitcroft# warn about #if 0 5325c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 5326000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 5327000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 5328de7d4f0eSAndy Whitcroft $herecurr); 53294a0df2efSAndy Whitcroft } 53304a0df2efSAndy Whitcroft 533103df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 533203df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5333100425deSJoe Perches my $tested = quotemeta($1); 5334100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5335100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5336100425deSJoe Perches my $func = $1; 5337100425deSJoe Perches if (WARN('NEEDLESS_IF', 5338100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5339100425deSJoe Perches $fix) { 5340100425deSJoe Perches my $do_fix = 1; 5341100425deSJoe Perches my $leading_tabs = ""; 5342100425deSJoe Perches my $new_leading_tabs = ""; 5343100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5344100425deSJoe Perches $leading_tabs = $1; 5345100425deSJoe Perches } else { 5346100425deSJoe Perches $do_fix = 0; 5347100425deSJoe Perches } 5348100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5349100425deSJoe Perches $new_leading_tabs = $1; 5350100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5351100425deSJoe Perches $do_fix = 0; 5352100425deSJoe Perches } 5353100425deSJoe Perches } else { 5354100425deSJoe Perches $do_fix = 0; 5355100425deSJoe Perches } 5356100425deSJoe Perches if ($do_fix) { 5357100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5358100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5359100425deSJoe Perches } 5360100425deSJoe Perches } 53614c432a8fSGreg Kroah-Hartman } 53624c432a8fSGreg Kroah-Hartman } 5363f0a594c1SAndy Whitcroft 5364ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5365ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5366ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5367ebfdc409SJoe Perches (defined $1 || defined $3) && 5368ebfdc409SJoe Perches $linenr > 3) { 5369ebfdc409SJoe Perches my $testval = $2; 5370ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5371ebfdc409SJoe Perches 5372ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5373ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5374ebfdc409SJoe Perches 5375fb0d0e08SJoe 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)/) { 5376ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5377ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5378ebfdc409SJoe Perches } 5379ebfdc409SJoe Perches } 5380ebfdc409SJoe Perches 5381f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5382dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5383f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5384f78d98f6SJoe Perches my $level = $1; 5385f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5386f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5387f78d98f6SJoe Perches $fix) { 5388f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5389f78d98f6SJoe Perches } 5390f78d98f6SJoe Perches } 5391f78d98f6SJoe Perches 539245c55e92SJoe Perches# check for logging continuations 539345c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 539445c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 539545c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 539645c55e92SJoe Perches } 539745c55e92SJoe Perches 5398abb08a53SJoe Perches# check for mask then right shift without a parentheses 5399abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 5400abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5401abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5402abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5403abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5404abb08a53SJoe Perches } 5405abb08a53SJoe Perches 5406b75ac618SJoe Perches# check for pointer comparisons to NULL 5407b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 5408b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5409b75ac618SJoe Perches my $val = $1; 5410b75ac618SJoe Perches my $equal = "!"; 5411b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5412b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5413b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5414b75ac618SJoe Perches $fix) { 5415b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5416b75ac618SJoe Perches } 5417b75ac618SJoe Perches } 5418b75ac618SJoe Perches } 5419b75ac618SJoe Perches 54208716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 54218716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 54228716de38SJoe Perches my $attr = $1; 54238716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 54248716de38SJoe Perches my $ptr = $1; 54258716de38SJoe Perches my $var = $2; 54268716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 54278716de38SJoe Perches ERROR("MISPLACED_INIT", 54288716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 54298716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 54308716de38SJoe Perches WARN("MISPLACED_INIT", 54318716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 54328716de38SJoe Perches $fix) { 5433194f66fcSJoe 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; 54348716de38SJoe Perches } 54358716de38SJoe Perches } 54368716de38SJoe Perches } 54378716de38SJoe Perches 5438e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5439e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5440e970b884SJoe Perches my $attr = $1; 5441e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5442e970b884SJoe Perches my $attr_prefix = $1; 5443e970b884SJoe Perches my $attr_type = $2; 5444e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5445e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5446e970b884SJoe Perches $fix) { 5447194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5448e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5449e970b884SJoe Perches } 5450e970b884SJoe Perches } 5451e970b884SJoe Perches 5452e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5453e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5454e970b884SJoe Perches my $attr = $1; 5455e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5456e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5457e970b884SJoe Perches $fix) { 5458194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5459e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5460e970b884SJoe Perches $lead = rtrim($1); 5461e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5462e970b884SJoe Perches $lead = "${lead}const "; 5463194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5464e970b884SJoe Perches } 5465e970b884SJoe Perches } 5466e970b884SJoe Perches 5467c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5468c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5469c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5470c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5471c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5472c17893c7SJoe Perches $fix) { 5473c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5474c17893c7SJoe Perches } 5475c17893c7SJoe Perches } 5476c17893c7SJoe Perches 5477fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5478fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5479fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5480fbdb8138SJoe Perches my $constant_func = $1; 5481fbdb8138SJoe Perches my $func = $constant_func; 5482fbdb8138SJoe Perches $func =~ s/^__constant_//; 5483fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5484fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5485fbdb8138SJoe Perches $fix) { 5486194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5487fbdb8138SJoe Perches } 5488fbdb8138SJoe Perches } 5489fbdb8138SJoe Perches 54901a15a250SPatrick Pannuto# prefer usleep_range over udelay 549137581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 549243c1d77cSJoe Perches my $delay = $1; 54931a15a250SPatrick Pannuto # ignore udelay's < 10, however 549443c1d77cSJoe Perches if (! ($delay < 10) ) { 5495000d1cc1SJoe Perches CHK("USLEEP_RANGE", 549643c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 549743c1d77cSJoe Perches } 549843c1d77cSJoe Perches if ($delay > 2000) { 549943c1d77cSJoe Perches WARN("LONG_UDELAY", 550043c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 55011a15a250SPatrick Pannuto } 55021a15a250SPatrick Pannuto } 55031a15a250SPatrick Pannuto 550409ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 550509ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 550609ef8725SPatrick Pannuto if ($1 < 20) { 5507000d1cc1SJoe Perches WARN("MSLEEP", 550843c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 550909ef8725SPatrick Pannuto } 551009ef8725SPatrick Pannuto } 551109ef8725SPatrick Pannuto 551236ec1939SJoe Perches# check for comparisons of jiffies 551336ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 551436ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 551536ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 551636ec1939SJoe Perches } 551736ec1939SJoe Perches 55189d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 55199d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 55209d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 55219d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 55229d7a34a5SJoe Perches } 55239d7a34a5SJoe Perches 552400df344fSAndy Whitcroft# warn about #ifdefs in C files 5525c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 552600df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 552700df344fSAndy Whitcroft# print "$herecurr"; 552800df344fSAndy Whitcroft# $clean = 0; 552900df344fSAndy Whitcroft# } 553000df344fSAndy Whitcroft 553122f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5532c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 55333705ce5bSJoe Perches if (ERROR("SPACING", 55343705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 55353705ce5bSJoe Perches $fix) { 5536194f66fcSJoe Perches $fixed[$fixlinenr] =~ 55373705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 55383705ce5bSJoe Perches } 55393705ce5bSJoe Perches 554022f2a2efSAndy Whitcroft } 554122f2a2efSAndy Whitcroft 55424a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5543171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5544171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 55454a0df2efSAndy Whitcroft my $which = $1; 55464a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5547000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5548000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 55494a0df2efSAndy Whitcroft } 55504a0df2efSAndy Whitcroft } 55514a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5552402c2553SMichael S. Tsirkin 5553402c2553SMichael S. Tsirkin my $barriers = qr{ 5554402c2553SMichael S. Tsirkin mb| 5555402c2553SMichael S. Tsirkin rmb| 5556402c2553SMichael S. Tsirkin wmb| 5557402c2553SMichael S. Tsirkin read_barrier_depends 5558402c2553SMichael S. Tsirkin }x; 5559402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5560402c2553SMichael S. Tsirkin mb__before_atomic| 5561402c2553SMichael S. Tsirkin mb__after_atomic| 5562402c2553SMichael S. Tsirkin store_release| 5563402c2553SMichael S. Tsirkin load_acquire| 5564402c2553SMichael S. Tsirkin store_mb| 5565402c2553SMichael S. Tsirkin (?:$barriers) 5566402c2553SMichael S. Tsirkin }x; 5567402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5568402c2553SMichael S. Tsirkin (?:$barriers)| 556943e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 557043e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5571402c2553SMichael S. Tsirkin }x; 5572402c2553SMichael S. Tsirkin 5573402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 55744a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5575c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5576000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 55774a0df2efSAndy Whitcroft } 55784a0df2efSAndy Whitcroft } 55793ad81779SPaul E. McKenney 5580f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5581f4073b0fSMichael S. Tsirkin 5582f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5583f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5584f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5585f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5586f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5587f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5588f4073b0fSMichael S. Tsirkin } 5589f4073b0fSMichael S. Tsirkin 5590cb426e99SJoe Perches# check for waitqueue_active without a comment. 5591cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5592cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5593cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5594cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5595cb426e99SJoe Perches } 5596cb426e99SJoe Perches } 55973ad81779SPaul E. McKenney 55984a0df2efSAndy Whitcroft# check of hardware specific defines 5599c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5600000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5601000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 56020a920b5bSAndy Whitcroft } 5603653d4876SAndy Whitcroft 5604596ed45bSJoe Perches# check that the storage class is not after a type 5605596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 5606000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5607596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 5608596ed45bSJoe Perches } 5609596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 5610596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 5611596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 5612596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 5613596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 5614596ed45bSJoe Perches WARN("STORAGE_CLASS", 5615596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 5616d4977c78STobias Klauser } 5617d4977c78STobias Klauser 5618de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5619de7d4f0eSAndy Whitcroft# storage class and type. 56209c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 56219c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5622000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5623000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5624de7d4f0eSAndy Whitcroft } 5625de7d4f0eSAndy Whitcroft 56268905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 56272b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 56282b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5629d5e616fcSJoe Perches if (WARN("INLINE", 5630d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5631d5e616fcSJoe Perches $fix) { 5632194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5633d5e616fcSJoe Perches 5634d5e616fcSJoe Perches } 56358905a67cSAndy Whitcroft } 56368905a67cSAndy Whitcroft 56373d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 56382b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 56392b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5640000d1cc1SJoe Perches WARN("PREFER_PACKED", 5641000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 56423d130fd0SJoe Perches } 56433d130fd0SJoe Perches 564439b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 56452b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 56462b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5647000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5648000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 564939b7e287SJoe Perches } 565039b7e287SJoe Perches 56515f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 56522b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 56532b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5654d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5655d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5656d5e616fcSJoe Perches $fix) { 5657194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5658d5e616fcSJoe Perches 5659d5e616fcSJoe Perches } 56605f14d3bdSJoe Perches } 56615f14d3bdSJoe Perches 56626061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 56632b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 56642b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5665d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5666d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5667d5e616fcSJoe Perches $fix) { 5668194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5669d5e616fcSJoe Perches } 56706061d949SJoe Perches } 56716061d949SJoe Perches 5672619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 5673619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 5674619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5675619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5676619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5677619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5678619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5679619a908aSJoe Perches } 5680619a908aSJoe Perches 5681fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 5682e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5683fd39f904STomas Winkler $realfile !~ m@\btools/@ && 5684e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5685e6176fa4SJoe Perches my $type = $1; 5686e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5687e6176fa4SJoe Perches $type = $1; 5688e6176fa4SJoe Perches my $kernel_type = 'u'; 5689e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5690e6176fa4SJoe Perches $type =~ /(\d+)/; 5691e6176fa4SJoe Perches $kernel_type .= $1; 5692e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5693e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5694e6176fa4SJoe Perches $fix) { 5695e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5696e6176fa4SJoe Perches } 5697e6176fa4SJoe Perches } 5698e6176fa4SJoe Perches } 5699e6176fa4SJoe Perches 5700938224b5SJoe Perches# check for cast of C90 native int or longer types constants 5701938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 5702938224b5SJoe Perches my $cast = $1; 5703938224b5SJoe Perches my $const = $2; 5704938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 5705938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 5706938224b5SJoe Perches $fix) { 5707938224b5SJoe Perches my $suffix = ""; 5708938224b5SJoe Perches my $newconst = $const; 5709938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 5710938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 5711938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 5712938224b5SJoe Perches $suffix .= 'LL'; 5713938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 5714938224b5SJoe Perches $suffix .= 'L'; 5715938224b5SJoe Perches } 5716938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 5717938224b5SJoe Perches } 5718938224b5SJoe Perches } 5719938224b5SJoe Perches 57208f53a9b8SJoe Perches# check for sizeof(&) 57218f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5722000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5723000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 57248f53a9b8SJoe Perches } 57258f53a9b8SJoe Perches 572666c80b60SJoe Perches# check for sizeof without parenthesis 572766c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5728d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5729d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5730d5e616fcSJoe Perches $fix) { 5731194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5732d5e616fcSJoe Perches } 573366c80b60SJoe Perches } 573466c80b60SJoe Perches 573588982feaSJoe Perches# check for struct spinlock declarations 573688982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 573788982feaSJoe Perches WARN("USE_SPINLOCK_T", 573888982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 573988982feaSJoe Perches } 574088982feaSJoe Perches 5741a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 574206668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5743a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5744caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5745caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5746d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5747d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5748d5e616fcSJoe Perches $fix) { 5749194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5750d5e616fcSJoe Perches } 5751a6962d72SJoe Perches } 5752a6962d72SJoe Perches } 5753a6962d72SJoe Perches 57540b523769SJoe Perches # check for vsprintf extension %p<foo> misuses 57550b523769SJoe Perches if ($^V && $^V ge 5.10.0 && 57560b523769SJoe Perches defined $stat && 57570b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 57580b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 57590b523769SJoe Perches my $bad_extension = ""; 57600b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 57610b523769SJoe Perches $lc = $lc + $linenr; 57620b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 57630b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 57640b523769SJoe Perches $fmt =~ s/%%//g; 5765ce4fecf1SPantelis Antoniou if ($fmt =~ /(\%[\*\d\.]*p(?![\WFfSsBKRraEhMmIiUDdgVCbGNO]).)/) { 57660b523769SJoe Perches $bad_extension = $1; 57670b523769SJoe Perches last; 57680b523769SJoe Perches } 57690b523769SJoe Perches } 57700b523769SJoe Perches if ($bad_extension ne "") { 57710b523769SJoe Perches my $stat_real = raw_line($linenr, 0); 57720b523769SJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 57730b523769SJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 57740b523769SJoe Perches } 57750b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 57760b523769SJoe Perches "Invalid vsprintf pointer extension '$bad_extension'\n" . "$here\n$stat_real\n"); 57770b523769SJoe Perches } 57780b523769SJoe Perches } 57790b523769SJoe Perches 5780554e165cSAndy Whitcroft# Check for misused memsets 5781d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5782d1fe9c09SJoe Perches defined $stat && 57839e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5784554e165cSAndy Whitcroft 5785d7c76ba7SJoe Perches my $ms_addr = $2; 5786d1fe9c09SJoe Perches my $ms_val = $7; 5787d1fe9c09SJoe Perches my $ms_size = $12; 5788d7c76ba7SJoe Perches 5789554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5790554e165cSAndy Whitcroft ERROR("MEMSET", 5791d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5792554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5793554e165cSAndy Whitcroft WARN("MEMSET", 5794d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5795d7c76ba7SJoe Perches } 5796d7c76ba7SJoe Perches } 5797d7c76ba7SJoe Perches 579898a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 5799f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5800f333195dSJoe Perches# defined $stat && 5801f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5802f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 5803f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 5804f333195dSJoe Perches# $fix) { 5805f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 5806f333195dSJoe Perches# } 5807f333195dSJoe Perches# } 580898a9bba5SJoe Perches 5809b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 5810f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5811f333195dSJoe Perches# defined $stat && 5812f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5813f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 5814f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5815f333195dSJoe Perches# } 5816b6117d17SMateusz Kulikowski 58178617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 58188617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 5819f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5820f333195dSJoe Perches# defined $stat && 5821f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5822f333195dSJoe Perches# 5823f333195dSJoe Perches# my $ms_val = $7; 5824f333195dSJoe Perches# 5825f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 5826f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 5827f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 5828f333195dSJoe Perches# $fix) { 5829f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 5830f333195dSJoe Perches# } 5831f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 5832f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 5833f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 5834f333195dSJoe Perches# $fix) { 5835f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 5836f333195dSJoe Perches# } 5837f333195dSJoe Perches# } 5838f333195dSJoe Perches# } 58398617cd09SMateusz Kulikowski 5840d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5841d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5842d1fe9c09SJoe Perches defined $stat && 5843d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5844d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5845d7c76ba7SJoe Perches my $call = $1; 5846d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5847d7c76ba7SJoe Perches my $arg1 = $3; 5848d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5849d1fe9c09SJoe Perches my $arg2 = $8; 5850d7c76ba7SJoe Perches my $cast; 5851d7c76ba7SJoe Perches 5852d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5853d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5854d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5855d7c76ba7SJoe Perches $cast = $cast1; 5856d7c76ba7SJoe Perches } else { 5857d7c76ba7SJoe Perches $cast = $cast2; 5858d7c76ba7SJoe Perches } 5859d7c76ba7SJoe Perches WARN("MINMAX", 5860d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5861554e165cSAndy Whitcroft } 5862554e165cSAndy Whitcroft } 5863554e165cSAndy Whitcroft 58644a273195SJoe Perches# check usleep_range arguments 58654a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 58664a273195SJoe Perches defined $stat && 58674a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 58684a273195SJoe Perches my $min = $1; 58694a273195SJoe Perches my $max = $7; 58704a273195SJoe Perches if ($min eq $max) { 58714a273195SJoe Perches WARN("USLEEP_RANGE", 58724a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 58734a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 58744a273195SJoe Perches $min > $max) { 58754a273195SJoe Perches WARN("USLEEP_RANGE", 58764a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 58774a273195SJoe Perches } 58784a273195SJoe Perches } 58794a273195SJoe Perches 5880823b794cSJoe Perches# check for naked sscanf 5881823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5882823b794cSJoe Perches defined $stat && 58836c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5884823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5885823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5886823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5887823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5888823b794cSJoe Perches $lc = $lc + $linenr; 5889823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 5890823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5891823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5892823b794cSJoe Perches } 5893823b794cSJoe Perches WARN("NAKED_SSCANF", 5894823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5895823b794cSJoe Perches } 5896823b794cSJoe Perches 5897afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5898afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5899afc819abSJoe Perches defined $stat && 5900afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5901afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5902afc819abSJoe Perches $lc = $lc + $linenr; 5903afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 5904afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5905afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5906afc819abSJoe Perches } 5907afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5908afc819abSJoe Perches my $format = $6; 5909afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5910afc819abSJoe Perches if ($count == 1 && 5911afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5912afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5913afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5914afc819abSJoe Perches } 5915afc819abSJoe Perches } 5916afc819abSJoe Perches } 5917afc819abSJoe Perches 591870dc8a48SJoe Perches# check for new externs in .h files. 591970dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 592070dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5921d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 592270dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 592370dc8a48SJoe Perches $fix) { 5924194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 592570dc8a48SJoe Perches } 592670dc8a48SJoe Perches } 592770dc8a48SJoe Perches 5928de7d4f0eSAndy Whitcroft# check for new externs in .c files. 5929171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 5930c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 5931171ae1a4SAndy Whitcroft { 5932c45dcabdSAndy Whitcroft my $function_name = $1; 5933c45dcabdSAndy Whitcroft my $paren_space = $2; 5934171ae1a4SAndy Whitcroft 5935171ae1a4SAndy Whitcroft my $s = $stat; 5936171ae1a4SAndy Whitcroft if (defined $cond) { 5937171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 5938171ae1a4SAndy Whitcroft } 5939c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 5940c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 5941c45dcabdSAndy Whitcroft { 5942000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5943000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5944de7d4f0eSAndy Whitcroft } 5945de7d4f0eSAndy Whitcroft 5946171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 5947000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 5948000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 5949171ae1a4SAndy Whitcroft } 59509c9ba34eSAndy Whitcroft 59519c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 59529c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 59539c9ba34eSAndy Whitcroft { 5954000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5955000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5956171ae1a4SAndy Whitcroft } 5957171ae1a4SAndy Whitcroft 5958a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 5959a0ad7596SJoe Perches if (defined $stat && 5960ca0d8929SJoe Perches $stat =~ /^.\s*(?:extern\s+)?$Type\s*$Ident\s*\(\s*([^{]+)\s*\)\s*;/s && 5961ca0d8929SJoe Perches $1 ne "void") { 5962ca0d8929SJoe Perches my $args = trim($1); 5963ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 5964ca0d8929SJoe Perches my $arg = trim($1); 5965ca0d8929SJoe Perches if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 5966ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 5967ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 5968ca0d8929SJoe Perches } 5969ca0d8929SJoe Perches } 5970ca0d8929SJoe Perches } 5971ca0d8929SJoe Perches 5972a0ad7596SJoe Perches# check for function definitions 5973a0ad7596SJoe Perches if ($^V && $^V ge 5.10.0 && 5974a0ad7596SJoe Perches defined $stat && 5975a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 5976a0ad7596SJoe Perches $context_function = $1; 5977a0ad7596SJoe Perches 5978a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 5979a0ad7596SJoe Perches my $ok = 0; 5980a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 5981a0ad7596SJoe Perches my $herectx = $here . "\n"; 5982a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5983a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 5984a0ad7596SJoe Perches $herectx .= $rl . "\n"; 5985a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 5986a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 5987a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 5988a0ad7596SJoe Perches } 5989a0ad7596SJoe Perches if (!$ok) { 5990a0ad7596SJoe Perches ERROR("OPEN_BRACE", 5991a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 5992a0ad7596SJoe Perches } 5993a0ad7596SJoe Perches } 5994a0ad7596SJoe Perches 5995de7d4f0eSAndy Whitcroft# checks for new __setup's 5996de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 5997de7d4f0eSAndy Whitcroft my $name = $1; 5998de7d4f0eSAndy Whitcroft 5999de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 6000000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 60018c27ceffSMauro Carvalho Chehab "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr); 6002de7d4f0eSAndy Whitcroft } 6003653d4876SAndy Whitcroft } 60049c0ca6f9SAndy Whitcroft 60059c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 6006caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 6007000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 6008000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 60099c0ca6f9SAndy Whitcroft } 601013214adfSAndy Whitcroft 6011a640d25cSJoe Perches# alloc style 6012a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 6013a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 6014a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 6015a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 6016a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 6017a640d25cSJoe Perches } 6018a640d25cSJoe Perches 601960a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 602060a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 60211b4a2ed4SJoe Perches defined $stat && 60221b4a2ed4SJoe Perches $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 602360a55369SJoe Perches my $oldfunc = $3; 602460a55369SJoe Perches my $a1 = $4; 602560a55369SJoe Perches my $a2 = $10; 602660a55369SJoe Perches my $newfunc = "kmalloc_array"; 602760a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 602860a55369SJoe Perches my $r1 = $a1; 602960a55369SJoe Perches my $r2 = $a2; 603060a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 603160a55369SJoe Perches $r1 = $a2; 603260a55369SJoe Perches $r2 = $a1; 603360a55369SJoe Perches } 6034e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 6035e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 60361b4a2ed4SJoe Perches my $ctx = ''; 60371b4a2ed4SJoe Perches my $herectx = $here . "\n"; 60381b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 60391b4a2ed4SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 60401b4a2ed4SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 60411b4a2ed4SJoe Perches } 6042e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 60431b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 60441b4a2ed4SJoe Perches $cnt == 1 && 6045e367455aSJoe Perches $fix) { 6046194f66fcSJoe 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; 604760a55369SJoe Perches } 604860a55369SJoe Perches } 604960a55369SJoe Perches } 605060a55369SJoe Perches 6051972fdea2SJoe Perches# check for krealloc arg reuse 6052972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 6053972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 6054972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 6055972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 6056972fdea2SJoe Perches } 6057972fdea2SJoe Perches 60585ce59ae0SJoe Perches# check for alloc argument mismatch 60595ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 60605ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 60615ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 60625ce59ae0SJoe Perches } 60635ce59ae0SJoe Perches 6064caf2a54fSJoe Perches# check for multiple semicolons 6065caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 6066d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 6067d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 6068d5e616fcSJoe Perches $fix) { 6069194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 6070d5e616fcSJoe Perches } 6071d1e2ad07SJoe Perches } 6072d1e2ad07SJoe Perches 6073cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 6074cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 6075cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 60760ab90191SJoe Perches my $ull = ""; 60770ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 60780ab90191SJoe Perches if (CHK("BIT_MACRO", 60790ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 60800ab90191SJoe Perches $fix) { 60810ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 60820ab90191SJoe Perches } 60830ab90191SJoe Perches } 60840ab90191SJoe Perches 60852d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 60862d632745SJoe 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*$/) { 60872d632745SJoe Perches my $config = $1; 60882d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 60892d632745SJoe Perches "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) && 60902d632745SJoe Perches $fix) { 60912d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 60922d632745SJoe Perches } 60932d632745SJoe Perches } 60942d632745SJoe Perches 6095e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 6096c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 6097c34c09a8SJoe Perches my $has_break = 0; 6098c34c09a8SJoe Perches my $has_statement = 0; 6099c34c09a8SJoe Perches my $count = 0; 6100c34c09a8SJoe Perches my $prevline = $linenr; 6101e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 6102c34c09a8SJoe Perches $prevline--; 6103c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 6104c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 6105c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 6106c34c09a8SJoe Perches next if ($fline =~ /^\-/); 6107c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 6108c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 6109c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 6110c34c09a8SJoe Perches $has_statement = 1; 6111c34c09a8SJoe Perches $count++; 6112c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 6113c34c09a8SJoe Perches } 6114c34c09a8SJoe Perches if (!$has_break && $has_statement) { 6115c34c09a8SJoe Perches WARN("MISSING_BREAK", 6116224236d9SAndrew Morton "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr); 6117c34c09a8SJoe Perches } 6118c34c09a8SJoe Perches } 6119c34c09a8SJoe Perches 6120d1e2ad07SJoe Perches# check for switch/default statements without a break; 6121d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 6122d1e2ad07SJoe Perches defined $stat && 6123d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 6124d1e2ad07SJoe Perches my $ctx = ''; 6125d1e2ad07SJoe Perches my $herectx = $here . "\n"; 6126d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 6127d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6128d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 6129d1e2ad07SJoe Perches } 6130d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 6131d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 6132caf2a54fSJoe Perches } 6133caf2a54fSJoe Perches 613413214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 6135d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 6136d5e616fcSJoe Perches if (WARN("USE_FUNC", 6137d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 6138d5e616fcSJoe Perches $fix) { 6139194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 6140d5e616fcSJoe Perches } 614113214adfSAndy Whitcroft } 6142773647a0SAndy Whitcroft 614362ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 614462ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 614562ec818fSJoe Perches ERROR("DATE_TIME", 614662ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 614762ec818fSJoe Perches } 614862ec818fSJoe Perches 61492c92488aSJoe Perches# check for use of yield() 61502c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 61512c92488aSJoe Perches WARN("YIELD", 61522c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 61532c92488aSJoe Perches } 61542c92488aSJoe Perches 6155179f8f40SJoe Perches# check for comparisons against true and false 6156179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 6157179f8f40SJoe Perches my $lead = $1; 6158179f8f40SJoe Perches my $arg = $2; 6159179f8f40SJoe Perches my $test = $3; 6160179f8f40SJoe Perches my $otype = $4; 6161179f8f40SJoe Perches my $trail = $5; 6162179f8f40SJoe Perches my $op = "!"; 6163179f8f40SJoe Perches 6164179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 6165179f8f40SJoe Perches 6166179f8f40SJoe Perches my $type = lc($otype); 6167179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 6168179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 6169179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 6170179f8f40SJoe Perches $op = ""; 6171179f8f40SJoe Perches } 6172179f8f40SJoe Perches 6173179f8f40SJoe Perches CHK("BOOL_COMPARISON", 6174179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 6175179f8f40SJoe Perches 6176179f8f40SJoe Perches## maybe suggesting a correct construct would better 6177179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 6178179f8f40SJoe Perches 6179179f8f40SJoe Perches } 6180179f8f40SJoe Perches } 6181179f8f40SJoe Perches 61824882720bSThomas Gleixner# check for semaphores initialized locked 61834882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 6184000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 6185000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 6186773647a0SAndy Whitcroft } 61876712d858SJoe Perches 618867d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 618967d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 6190000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 619167d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 6192773647a0SAndy Whitcroft } 61936712d858SJoe Perches 6194ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 6195f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 6196000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 6197ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 6198f3db6639SMichael Ellerman } 61996712d858SJoe Perches 62000f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 6201d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 62026903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 6203d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 6204000d1cc1SJoe Perches WARN("CONST_STRUCT", 6205d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 62062b6db5cbSAndy Whitcroft } 6207773647a0SAndy Whitcroft 6208773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 6209773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 6210773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 6211c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 6212c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 6213171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 6214171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 6215171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 6216773647a0SAndy Whitcroft { 6217000d1cc1SJoe Perches WARN("NR_CPUS", 6218000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 6219773647a0SAndy Whitcroft } 62209c9ba34eSAndy Whitcroft 622152ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 622252ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 622352ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 622452ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 622552ea8506SJoe Perches } 622652ea8506SJoe Perches 6227acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 6228acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 6229acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 6230acd9362cSJoe Perches WARN("LIKELY_MISUSE", 6231acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 6232acd9362cSJoe Perches } 6233acd9362cSJoe Perches 6234691d77b6SAndy Whitcroft# whine mightly about in_atomic 6235691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 6236691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 6237000d1cc1SJoe Perches ERROR("IN_ATOMIC", 6238000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 6239f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 6240000d1cc1SJoe Perches WARN("IN_ATOMIC", 6241000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 6242691d77b6SAndy Whitcroft } 6243691d77b6SAndy Whitcroft } 62441704f47bSPeter Zijlstra 6245481aea5cSJoe Perches# whine about ACCESS_ONCE 6246481aea5cSJoe Perches if ($^V && $^V ge 5.10.0 && 6247481aea5cSJoe Perches $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) { 6248481aea5cSJoe Perches my $par = $1; 6249481aea5cSJoe Perches my $eq = $2; 6250481aea5cSJoe Perches my $fun = $3; 6251481aea5cSJoe Perches $par =~ s/^\(\s*(.*)\s*\)$/$1/; 6252481aea5cSJoe Perches if (defined($eq)) { 6253481aea5cSJoe Perches if (WARN("PREFER_WRITE_ONCE", 6254481aea5cSJoe Perches "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) && 6255481aea5cSJoe Perches $fix) { 6256481aea5cSJoe Perches $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/; 6257481aea5cSJoe Perches } 6258481aea5cSJoe Perches } else { 6259481aea5cSJoe Perches if (WARN("PREFER_READ_ONCE", 6260481aea5cSJoe Perches "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) && 6261481aea5cSJoe Perches $fix) { 6262481aea5cSJoe Perches $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/; 6263481aea5cSJoe Perches } 6264481aea5cSJoe Perches } 6265481aea5cSJoe Perches } 6266481aea5cSJoe Perches 62670f5225b0SPeter Zijlstra# check for mutex_trylock_recursive usage 62680f5225b0SPeter Zijlstra if ($line =~ /mutex_trylock_recursive/) { 62690f5225b0SPeter Zijlstra ERROR("LOCKING", 62700f5225b0SPeter Zijlstra "recursive locking is bad, do not use this ever.\n" . $herecurr); 62710f5225b0SPeter Zijlstra } 62720f5225b0SPeter Zijlstra 62731704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 62741704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 62751704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 62761704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 62771704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 62781704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 6279000d1cc1SJoe Perches ERROR("LOCKDEP", 6280000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 62811704f47bSPeter Zijlstra } 62821704f47bSPeter Zijlstra } 628388f8831cSDave Jones 6284b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 6285b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 6286000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 6287000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 628888f8831cSDave Jones } 62892435880fSJoe Perches 6290515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 6291515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 6292515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 6293459cf0aeSJoe Perches defined $stat && 6294515a235eSJoe Perches $line =~ /$mode_perms_search/) { 62952435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 62962435880fSJoe Perches my $func = $entry->[0]; 62972435880fSJoe Perches my $arg_pos = $entry->[1]; 62982435880fSJoe Perches 6299459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 6300459cf0aeSJoe Perches $lc = $lc + $linenr; 6301459cf0aeSJoe Perches my $stat_real = raw_line($linenr, 0); 6302459cf0aeSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 6303459cf0aeSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 6304459cf0aeSJoe Perches } 6305459cf0aeSJoe Perches 63062435880fSJoe Perches my $skip_args = ""; 63072435880fSJoe Perches if ($arg_pos > 1) { 63082435880fSJoe Perches $arg_pos--; 63092435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 63102435880fSJoe Perches } 6311f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 6312459cf0aeSJoe Perches if ($stat =~ /$test/) { 63132435880fSJoe Perches my $val = $1; 63142435880fSJoe Perches $val = $6 if ($skip_args ne ""); 6315f90774e1SJoe Perches if (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 6316f90774e1SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4)) { 63172435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 6318459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 6319f90774e1SJoe Perches } 6320f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6321c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6322459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 63232435880fSJoe Perches } 6324459cf0aeSJoe Perches } 6325459cf0aeSJoe Perches } 6326459cf0aeSJoe Perches } 6327459cf0aeSJoe Perches 6328459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 6329459cf0aeSJoe Perches if ($line =~ /\b$mode_perms_string_search\b/) { 6330459cf0aeSJoe Perches my $val = ""; 6331459cf0aeSJoe Perches my $oval = ""; 6332f90774e1SJoe Perches my $to = 0; 6333459cf0aeSJoe Perches my $curpos = 0; 6334459cf0aeSJoe Perches my $lastpos = 0; 6335459cf0aeSJoe Perches while ($line =~ /\b(($mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) { 6336459cf0aeSJoe Perches $curpos = pos($line); 6337459cf0aeSJoe Perches my $match = $2; 6338459cf0aeSJoe Perches my $omatch = $1; 6339459cf0aeSJoe Perches last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos)); 6340459cf0aeSJoe Perches $lastpos = $curpos; 6341459cf0aeSJoe Perches $to |= $mode_permission_string_types{$match}; 6342459cf0aeSJoe Perches $val .= '\s*\|\s*' if ($val ne ""); 6343459cf0aeSJoe Perches $val .= $match; 6344459cf0aeSJoe Perches $oval .= $omatch; 6345f90774e1SJoe Perches } 6346459cf0aeSJoe Perches $oval =~ s/^\s*\|\s*//; 6347459cf0aeSJoe Perches $oval =~ s/\s*\|\s*$//; 6348459cf0aeSJoe Perches my $octal = sprintf("%04o", $to); 6349f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 6350459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 6351f90774e1SJoe Perches $fix) { 6352459cf0aeSJoe Perches $fixed[$fixlinenr] =~ s/$val/$octal/; 63532435880fSJoe Perches } 635413214adfSAndy Whitcroft } 63555a6d20ceSBjorn Andersson 63565a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 63575a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 63585a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 63595a6d20ceSBjorn Andersson my $valid_licenses = qr{ 63605a6d20ceSBjorn Andersson GPL| 63615a6d20ceSBjorn Andersson GPL\ v2| 63625a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 63635a6d20ceSBjorn Andersson Dual\ BSD/GPL| 63645a6d20ceSBjorn Andersson Dual\ MIT/GPL| 63655a6d20ceSBjorn Andersson Dual\ MPL/GPL| 63665a6d20ceSBjorn Andersson Proprietary 63675a6d20ceSBjorn Andersson }x; 63685a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 63695a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 63705a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 63715a6d20ceSBjorn Andersson } 63725a6d20ceSBjorn Andersson } 6373515a235eSJoe Perches } 637413214adfSAndy Whitcroft 637513214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 637613214adfSAndy Whitcroft # so just keep quiet. 637713214adfSAndy Whitcroft if ($#rawlines == -1) { 637813214adfSAndy Whitcroft exit(0); 63790a920b5bSAndy Whitcroft } 63800a920b5bSAndy Whitcroft 63818905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 63828905a67cSAndy Whitcroft # things that appear to be patches. 63838905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 63848905a67cSAndy Whitcroft exit(0); 63858905a67cSAndy Whitcroft } 63868905a67cSAndy Whitcroft 63878905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 63888905a67cSAndy Whitcroft # just keep quiet. 63898905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 63908905a67cSAndy Whitcroft exit(0); 63918905a67cSAndy Whitcroft } 63928905a67cSAndy Whitcroft 6393*a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 6394000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6395000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 63960a920b5bSAndy Whitcroft } 6397ed43c4e5SAllen Hubbe if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) { 6398000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6399000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 64000a920b5bSAndy Whitcroft } 64010a920b5bSAndy Whitcroft 6402f0a594c1SAndy Whitcroft print report_dump(); 640313214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 640413214adfSAndy Whitcroft print "$filename " if ($summary_file); 64056c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 64066c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 64076c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 64086c72ffaaSAndy Whitcroft } 64098905a67cSAndy Whitcroft 6410d2c0a235SAndy Whitcroft if ($quiet == 0) { 6411ef212196SJoe Perches # If there were any defects found and not already fixing them 6412ef212196SJoe Perches if (!$clean and !$fix) { 6413ef212196SJoe Perches print << "EOM" 6414ef212196SJoe Perches 6415ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 6416ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 6417ef212196SJoe PerchesEOM 6418ef212196SJoe Perches } 6419d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 6420d2c0a235SAndy Whitcroft # then suggest that. 6421d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 6422b0781216SMike Frysinger $rpt_cleaners = 0; 6423d8469f16SJoe Perches print << "EOM" 6424d8469f16SJoe Perches 6425d8469f16SJoe PerchesNOTE: Whitespace errors detected. 6426d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 6427d8469f16SJoe PerchesEOM 6428d2c0a235SAndy Whitcroft } 6429d2c0a235SAndy Whitcroft } 6430d2c0a235SAndy Whitcroft 6431d752fcc8SJoe Perches if ($clean == 0 && $fix && 6432d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 6433d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 64349624b8d6SJoe Perches my $newfile = $filename; 64359624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 64363705ce5bSJoe Perches my $linecount = 0; 64373705ce5bSJoe Perches my $f; 64383705ce5bSJoe Perches 6439d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 6440d752fcc8SJoe Perches 64413705ce5bSJoe Perches open($f, '>', $newfile) 64423705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 64433705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 64443705ce5bSJoe Perches $linecount++; 64453705ce5bSJoe Perches if ($file) { 64463705ce5bSJoe Perches if ($linecount > 3) { 64473705ce5bSJoe Perches $fixed_line =~ s/^\+//; 64483705ce5bSJoe Perches print $f $fixed_line . "\n"; 64493705ce5bSJoe Perches } 64503705ce5bSJoe Perches } else { 64513705ce5bSJoe Perches print $f $fixed_line . "\n"; 64523705ce5bSJoe Perches } 64533705ce5bSJoe Perches } 64543705ce5bSJoe Perches close($f); 64553705ce5bSJoe Perches 64563705ce5bSJoe Perches if (!$quiet) { 64573705ce5bSJoe Perches print << "EOM"; 6458d8469f16SJoe Perches 64593705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 64603705ce5bSJoe Perches 64613705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 64623705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 64633705ce5bSJoe Perches 64643705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 64653705ce5bSJoe PerchesNo warranties, expressed or implied... 64663705ce5bSJoe PerchesEOM 64673705ce5bSJoe Perches } 64683705ce5bSJoe Perches } 64693705ce5bSJoe Perches 6470d8469f16SJoe Perches if ($quiet == 0) { 6471d8469f16SJoe Perches print "\n"; 6472d8469f16SJoe Perches if ($clean == 1) { 6473d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 6474d8469f16SJoe Perches } else { 6475d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 64760a920b5bSAndy Whitcroft } 64770a920b5bSAndy Whitcroft } 64780a920b5bSAndy Whitcroft return $clean; 64790a920b5bSAndy Whitcroft} 6480