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|)| 45787bd499aSJoe Perches TP_printk| 4586e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 459b0531722SJoe Perches panic| 46006668727SJoe Perches MODULE_[A-Z_]+| 46106668727SJoe Perches seq_vprintf|seq_printf|seq_puts 462691e669bSJoe Perches)}; 463691e669bSJoe Perches 46420112475SJoe Perchesour $signature_tags = qr{(?xi: 46520112475SJoe Perches Signed-off-by:| 46620112475SJoe Perches Acked-by:| 46720112475SJoe Perches Tested-by:| 46820112475SJoe Perches Reviewed-by:| 46920112475SJoe Perches Reported-by:| 4708543ae12SMugunthan V N Suggested-by:| 47120112475SJoe Perches To:| 47220112475SJoe Perches Cc: 47320112475SJoe Perches)}; 47420112475SJoe Perches 4751813087dSJoe Perchesour @typeListMisordered = ( 4761813087dSJoe Perches qr{char\s+(?:un)?signed}, 4771813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 4781813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 4791813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 4801813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 4811813087dSJoe Perches qr{short\s+(?:un)?signed}, 4821813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 4831813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 4841813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 4851813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 4861813087dSJoe Perches qr{int\s+(?:un)?signed}, 4871813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 4881813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 4891813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 4901813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 4911813087dSJoe Perches qr{long\s+(?:un)?signed}, 4921813087dSJoe Perches); 4931813087dSJoe Perches 4948905a67cSAndy Whitcroftour @typeList = ( 4958905a67cSAndy Whitcroft qr{void}, 4960c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 4970c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 4980c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 4990c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 5000c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 5010c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 5020c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 5030c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 5040c773d9dSJoe Perches qr{(?:un)?signed}, 5058905a67cSAndy Whitcroft qr{float}, 5068905a67cSAndy Whitcroft qr{double}, 5078905a67cSAndy Whitcroft qr{bool}, 5088905a67cSAndy Whitcroft qr{struct\s+$Ident}, 5098905a67cSAndy Whitcroft qr{union\s+$Ident}, 5108905a67cSAndy Whitcroft qr{enum\s+$Ident}, 5118905a67cSAndy Whitcroft qr{${Ident}_t}, 5128905a67cSAndy Whitcroft qr{${Ident}_handler}, 5138905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 5141813087dSJoe Perches @typeListMisordered, 5158905a67cSAndy Whitcroft); 516938224b5SJoe Perches 517938224b5SJoe Perchesour $C90_int_types = qr{(?x: 518938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 519938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 520938224b5SJoe Perches long\s+long\s+(?:un)?signed| 521938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 522938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 523938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 524938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 525938224b5SJoe Perches 526938224b5SJoe Perches long\s+int\s+(?:un)?signed| 527938224b5SJoe Perches long\s+(?:un)?signed\s+int| 528938224b5SJoe Perches long\s+(?:un)?signed| 529938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 530938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 531938224b5SJoe Perches int\s+long\s+(?:un)?signed| 532938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 533938224b5SJoe Perches 534938224b5SJoe Perches int\s+(?:un)?signed| 535938224b5SJoe Perches (?:(?:un)?signed\s+)?int 536938224b5SJoe Perches)}; 537938224b5SJoe Perches 538485ff23eSAlex Dowadour @typeListFile = (); 5398716de38SJoe Perchesour @typeListWithAttr = ( 5408716de38SJoe Perches @typeList, 5418716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 5428716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 5438716de38SJoe Perches); 5448716de38SJoe Perches 545c45dcabdSAndy Whitcroftour @modifierList = ( 546c45dcabdSAndy Whitcroft qr{fastcall}, 547c45dcabdSAndy Whitcroft); 548485ff23eSAlex Dowadour @modifierListFile = (); 5498905a67cSAndy Whitcroft 5502435880fSJoe Perchesour @mode_permission_funcs = ( 5512435880fSJoe Perches ["module_param", 3], 5522435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 5532435880fSJoe Perches ["module_param_array_named", 5], 5542435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 5552435880fSJoe Perches ["proc_create(?:_data|)", 2], 556459cf0aeSJoe Perches ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2], 557459cf0aeSJoe Perches ["IIO_DEV_ATTR_[A-Z_]+", 1], 558459cf0aeSJoe Perches ["SENSOR_(?:DEVICE_|)ATTR_2", 2], 559459cf0aeSJoe Perches ["SENSOR_TEMPLATE(?:_2|)", 3], 560459cf0aeSJoe Perches ["__ATTR", 2], 5612435880fSJoe Perches); 5622435880fSJoe Perches 563515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 564515a235eSJoe Perchesour $mode_perms_search = ""; 565515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 566515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 567515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 568515a235eSJoe Perches} 56900180468SJoe Perches$mode_perms_search = "(?:${mode_perms_search})"; 570515a235eSJoe Perches 571b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 572b392c64fSJoe Perches S_IWUGO | 573b392c64fSJoe Perches S_IWOTH | 574b392c64fSJoe Perches S_IRWXUGO | 575b392c64fSJoe Perches S_IALLUGO | 576b392c64fSJoe Perches 0[0-7][0-7][2367] 577b392c64fSJoe Perches}x; 578b392c64fSJoe Perches 579f90774e1SJoe Perchesour %mode_permission_string_types = ( 580f90774e1SJoe Perches "S_IRWXU" => 0700, 581f90774e1SJoe Perches "S_IRUSR" => 0400, 582f90774e1SJoe Perches "S_IWUSR" => 0200, 583f90774e1SJoe Perches "S_IXUSR" => 0100, 584f90774e1SJoe Perches "S_IRWXG" => 0070, 585f90774e1SJoe Perches "S_IRGRP" => 0040, 586f90774e1SJoe Perches "S_IWGRP" => 0020, 587f90774e1SJoe Perches "S_IXGRP" => 0010, 588f90774e1SJoe Perches "S_IRWXO" => 0007, 589f90774e1SJoe Perches "S_IROTH" => 0004, 590f90774e1SJoe Perches "S_IWOTH" => 0002, 591f90774e1SJoe Perches "S_IXOTH" => 0001, 592f90774e1SJoe Perches "S_IRWXUGO" => 0777, 593f90774e1SJoe Perches "S_IRUGO" => 0444, 594f90774e1SJoe Perches "S_IWUGO" => 0222, 595f90774e1SJoe Perches "S_IXUGO" => 0111, 596f90774e1SJoe Perches); 597f90774e1SJoe Perches 598f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below 599f90774e1SJoe Perchesour $mode_perms_string_search = ""; 600f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) { 601f90774e1SJoe Perches $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); 602f90774e1SJoe Perches $mode_perms_string_search .= $entry; 603f90774e1SJoe Perches} 60400180468SJoe Perchesour $single_mode_perms_string_search = "(?:${mode_perms_string_search})"; 60500180468SJoe Perchesour $multi_mode_perms_string_search = qr{ 60600180468SJoe Perches ${single_mode_perms_string_search} 60700180468SJoe Perches (?:\s*\|\s*${single_mode_perms_string_search})* 60800180468SJoe Perches}x; 60900180468SJoe Perches 61000180468SJoe Perchessub perms_to_octal { 61100180468SJoe Perches my ($string) = @_; 61200180468SJoe Perches 61300180468SJoe Perches return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/); 61400180468SJoe Perches 61500180468SJoe Perches my $val = ""; 61600180468SJoe Perches my $oval = ""; 61700180468SJoe Perches my $to = 0; 61800180468SJoe Perches my $curpos = 0; 61900180468SJoe Perches my $lastpos = 0; 62000180468SJoe Perches while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) { 62100180468SJoe Perches $curpos = pos($string); 62200180468SJoe Perches my $match = $2; 62300180468SJoe Perches my $omatch = $1; 62400180468SJoe Perches last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos)); 62500180468SJoe Perches $lastpos = $curpos; 62600180468SJoe Perches $to |= $mode_permission_string_types{$match}; 62700180468SJoe Perches $val .= '\s*\|\s*' if ($val ne ""); 62800180468SJoe Perches $val .= $match; 62900180468SJoe Perches $oval .= $omatch; 63000180468SJoe Perches } 63100180468SJoe Perches $oval =~ s/^\s*\|\s*//; 63200180468SJoe Perches $oval =~ s/\s*\|\s*$//; 63300180468SJoe Perches return sprintf("%04o", $to); 63400180468SJoe Perches} 635f90774e1SJoe Perches 6367840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 6377840a94cSWolfram Sang irq| 638cdcee686SSergey Ryazanov memory| 639cdcee686SSergey Ryazanov time| 640cdcee686SSergey Ryazanov reboot 6417840a94cSWolfram Sang)}; 6427840a94cSWolfram Sang# memory.h: ARM has a custom one 6437840a94cSWolfram Sang 64466b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 64566b47b4aSKees Cookmy $misspellings; 64666b47b4aSKees Cookmy %spelling_fix; 64736061e38SJoe Perches 64836061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 64966b47b4aSKees Cook while (<$spelling>) { 65066b47b4aSKees Cook my $line = $_; 65166b47b4aSKees Cook 65266b47b4aSKees Cook $line =~ s/\s*\n?$//g; 65366b47b4aSKees Cook $line =~ s/^\s*//g; 65466b47b4aSKees Cook 65566b47b4aSKees Cook next if ($line =~ m/^\s*#/); 65666b47b4aSKees Cook next if ($line =~ m/^\s*$/); 65766b47b4aSKees Cook 65866b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 65966b47b4aSKees Cook 66066b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 66166b47b4aSKees Cook } 66266b47b4aSKees Cook close($spelling); 66336061e38SJoe Perches} else { 66436061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 66536061e38SJoe Perches} 66666b47b4aSKees Cook 667ebfd7d62SJoe Perchesif ($codespell) { 668ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 669ebfd7d62SJoe Perches while (<$spelling>) { 670ebfd7d62SJoe Perches my $line = $_; 671ebfd7d62SJoe Perches 672ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 673ebfd7d62SJoe Perches $line =~ s/^\s*//g; 674ebfd7d62SJoe Perches 675ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 676ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 677ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 678ebfd7d62SJoe Perches 679ebfd7d62SJoe Perches $line =~ s/,.*$//; 680ebfd7d62SJoe Perches 681ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 682ebfd7d62SJoe Perches 683ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 684ebfd7d62SJoe Perches } 685ebfd7d62SJoe Perches close($spelling); 686ebfd7d62SJoe Perches } else { 687ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 688ebfd7d62SJoe Perches } 689ebfd7d62SJoe Perches} 690ebfd7d62SJoe Perches 691ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 692ebfd7d62SJoe Perches 69375ad8c57SJerome Forissiersub read_words { 69475ad8c57SJerome Forissier my ($wordsRef, $file) = @_; 69575ad8c57SJerome Forissier 69675ad8c57SJerome Forissier if (open(my $words, '<', $file)) { 69775ad8c57SJerome Forissier while (<$words>) { 698bf1fa1daSJoe Perches my $line = $_; 699bf1fa1daSJoe Perches 700bf1fa1daSJoe Perches $line =~ s/\s*\n?$//g; 701bf1fa1daSJoe Perches $line =~ s/^\s*//g; 702bf1fa1daSJoe Perches 703bf1fa1daSJoe Perches next if ($line =~ m/^\s*#/); 704bf1fa1daSJoe Perches next if ($line =~ m/^\s*$/); 705bf1fa1daSJoe Perches if ($line =~ /\s/) { 70675ad8c57SJerome Forissier print("$file: '$line' invalid - ignored\n"); 707bf1fa1daSJoe Perches next; 708bf1fa1daSJoe Perches } 709bf1fa1daSJoe Perches 71075ad8c57SJerome Forissier $$wordsRef .= '|' if ($$wordsRef ne ""); 71175ad8c57SJerome Forissier $$wordsRef .= $line; 712bf1fa1daSJoe Perches } 71375ad8c57SJerome Forissier close($file); 71475ad8c57SJerome Forissier return 1; 715bf1fa1daSJoe Perches } 716bf1fa1daSJoe Perches 71775ad8c57SJerome Forissier return 0; 71875ad8c57SJerome Forissier} 71975ad8c57SJerome Forissier 72075ad8c57SJerome Forissiermy $const_structs = ""; 72175ad8c57SJerome Forissierread_words(\$const_structs, $conststructsfile) 72275ad8c57SJerome Forissier or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 72375ad8c57SJerome Forissier 72475ad8c57SJerome Forissiermy $typeOtherTypedefs = ""; 72575ad8c57SJerome Forissierif (length($typedefsfile)) { 72675ad8c57SJerome Forissier read_words(\$typeOtherTypedefs, $typedefsfile) 72775ad8c57SJerome Forissier or warn "No additional types will be considered - file '$typedefsfile': $!\n"; 72875ad8c57SJerome Forissier} 72975ad8c57SJerome Forissier$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne ""); 73075ad8c57SJerome Forissier 7318905a67cSAndy Whitcroftsub build_types { 732485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 733485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 7341813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 7358716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 736c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 737ab7e23f3SJoe Perches $BasicType = qr{ 738ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 739ab7e23f3SJoe Perches (?:${all}\b) 740ab7e23f3SJoe Perches }x; 7418905a67cSAndy Whitcroft $NonptrType = qr{ 742d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 743cf655043SAndy Whitcroft (?: 7446b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 7458ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 746c45dcabdSAndy Whitcroft (?:${all}\b) 747cf655043SAndy Whitcroft ) 748c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 7498905a67cSAndy Whitcroft }x; 7501813087dSJoe Perches $NonptrTypeMisordered = qr{ 7511813087dSJoe Perches (?:$Modifier\s+|const\s+)* 7521813087dSJoe Perches (?: 7531813087dSJoe Perches (?:${Misordered}\b) 7541813087dSJoe Perches ) 7551813087dSJoe Perches (?:\s+$Modifier|\s+const)* 7561813087dSJoe Perches }x; 7578716de38SJoe Perches $NonptrTypeWithAttr = qr{ 7588716de38SJoe Perches (?:$Modifier\s+|const\s+)* 7598716de38SJoe Perches (?: 7608716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 7618716de38SJoe Perches (?:$typeTypedefs\b)| 7628716de38SJoe Perches (?:${allWithAttr}\b) 7638716de38SJoe Perches ) 7648716de38SJoe Perches (?:\s+$Modifier|\s+const)* 7658716de38SJoe Perches }x; 7668905a67cSAndy Whitcroft $Type = qr{ 767c45dcabdSAndy Whitcroft $NonptrType 7681574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 769c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 7708905a67cSAndy Whitcroft }x; 7711813087dSJoe Perches $TypeMisordered = qr{ 7721813087dSJoe Perches $NonptrTypeMisordered 7731813087dSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 7741813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 7751813087dSJoe Perches }x; 77691cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 7771813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 7788905a67cSAndy Whitcroft} 7798905a67cSAndy Whitcroftbuild_types(); 7806c72ffaaSAndy Whitcroft 7817d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 782d1fe9c09SJoe Perches 783d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 784d1fe9c09SJoe Perches# requires at least perl version v5.10.0 785d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 786d1fe9c09SJoe Perches 787d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 7882435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 789c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 7907d2367afSJoe Perches 791f8422308SJoe Perchesour $declaration_macros = qr{(?x: 7923e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 793fe658f94SSteffen Maier (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(| 7943d102fc0SGilad Ben-Yossef (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(| 7953d102fc0SGilad Ben-Yossef (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\( 796f8422308SJoe Perches)}; 797f8422308SJoe Perches 7987d2367afSJoe Perchessub deparenthesize { 7997d2367afSJoe Perches my ($string) = @_; 8007d2367afSJoe Perches return "" if (!defined($string)); 8015b9553abSJoe Perches 8025b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 8035b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 8045b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 8055b9553abSJoe Perches } 8065b9553abSJoe Perches 8077d2367afSJoe Perches $string =~ s@\s+@ @g; 8085b9553abSJoe Perches 8097d2367afSJoe Perches return $string; 8107d2367afSJoe Perches} 8117d2367afSJoe Perches 8123445686aSJoe Perchessub seed_camelcase_file { 8133445686aSJoe Perches my ($file) = @_; 8143445686aSJoe Perches 8153445686aSJoe Perches return if (!(-f $file)); 8163445686aSJoe Perches 8173445686aSJoe Perches local $/; 8183445686aSJoe Perches 8193445686aSJoe Perches open(my $include_file, '<', "$file") 8203445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 8213445686aSJoe Perches my $text = <$include_file>; 8223445686aSJoe Perches close($include_file); 8233445686aSJoe Perches 8243445686aSJoe Perches my @lines = split('\n', $text); 8253445686aSJoe Perches 8263445686aSJoe Perches foreach my $line (@lines) { 8273445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 8283445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 8293445686aSJoe Perches $camelcase{$1} = 1; 83011ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 83111ea516aSJoe Perches $camelcase{$1} = 1; 83211ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 8333445686aSJoe Perches $camelcase{$1} = 1; 8343445686aSJoe Perches } 8353445686aSJoe Perches } 8363445686aSJoe Perches} 8373445686aSJoe Perches 83885b0ee18SJoe Perchessub is_maintained_obsolete { 83985b0ee18SJoe Perches my ($filename) = @_; 84085b0ee18SJoe Perches 841f2c19c2fSJerome Forissier return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 84285b0ee18SJoe Perches 8430616efa4SJoe Perches my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 84485b0ee18SJoe Perches 84585b0ee18SJoe Perches return $status =~ /obsolete/i; 84685b0ee18SJoe Perches} 84785b0ee18SJoe Perches 8483445686aSJoe Perchesmy $camelcase_seeded = 0; 8493445686aSJoe Perchessub seed_camelcase_includes { 8503445686aSJoe Perches return if ($camelcase_seeded); 8513445686aSJoe Perches 8523445686aSJoe Perches my $files; 853c707a81dSJoe Perches my $camelcase_cache = ""; 854c707a81dSJoe Perches my @include_files = (); 855c707a81dSJoe Perches 856c707a81dSJoe Perches $camelcase_seeded = 1; 857351b2a1fSJoe Perches 8583645e328SRichard Genoud if (-e ".git") { 859351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 860351b2a1fSJoe Perches chomp $git_last_include_commit; 861c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 862c707a81dSJoe Perches } else { 863c707a81dSJoe Perches my $last_mod_date = 0; 864c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 865c707a81dSJoe Perches @include_files = split('\n', $files); 866c707a81dSJoe Perches foreach my $file (@include_files) { 867c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 868c707a81dSJoe Perches localtime((stat $file)[9])); 869c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 870c707a81dSJoe Perches } 871c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 872c707a81dSJoe Perches } 873c707a81dSJoe Perches 874c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 875c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 876c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 877351b2a1fSJoe Perches while (<$camelcase_file>) { 878351b2a1fSJoe Perches chomp; 879351b2a1fSJoe Perches $camelcase{$_} = 1; 880351b2a1fSJoe Perches } 881351b2a1fSJoe Perches close($camelcase_file); 882351b2a1fSJoe Perches 883351b2a1fSJoe Perches return; 884351b2a1fSJoe Perches } 885c707a81dSJoe Perches 8863645e328SRichard Genoud if (-e ".git") { 887c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 888c707a81dSJoe Perches @include_files = split('\n', $files); 8893445686aSJoe Perches } 890c707a81dSJoe Perches 8913445686aSJoe Perches foreach my $file (@include_files) { 8923445686aSJoe Perches seed_camelcase_file($file); 8933445686aSJoe Perches } 894351b2a1fSJoe Perches 895c707a81dSJoe Perches if ($camelcase_cache ne "") { 896351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 897c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 898c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 899351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 900351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 901351b2a1fSJoe Perches } 902351b2a1fSJoe Perches close($camelcase_file); 903351b2a1fSJoe Perches } 9043445686aSJoe Perches} 9053445686aSJoe Perches 906d311cd44SJoe Perchessub git_commit_info { 907d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 908d311cd44SJoe Perches 909d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 910d311cd44SJoe Perches 911d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 912d311cd44SJoe Perches $output =~ s/^\s*//gm; 913d311cd44SJoe Perches my @lines = split("\n", $output); 914d311cd44SJoe Perches 9150d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 9160d7835fcSJoe Perches 917d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 918d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 919d311cd44SJoe Perches# all matching commit ids, but it's very slow... 920d311cd44SJoe Perches# 921d311cd44SJoe Perches# echo "checking commits $1..." 922d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 923d311cd44SJoe Perches# while read line ; do 924d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 925d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 926d311cd44SJoe Perches# done 927d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 928948b133aSHeinrich Schuchardt $id = undef; 929d311cd44SJoe Perches } else { 930d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 931d311cd44SJoe Perches $desc = substr($lines[0], 41); 932d311cd44SJoe Perches } 933d311cd44SJoe Perches 934d311cd44SJoe Perches return ($id, $desc); 935d311cd44SJoe Perches} 936d311cd44SJoe Perches 9376c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 9380a920b5bSAndy Whitcroft 93900df344fSAndy Whitcroftmy @rawlines = (); 940c2fdda0dSAndy Whitcroftmy @lines = (); 9413705ce5bSJoe Perchesmy @fixed = (); 942d752fcc8SJoe Perchesmy @fixed_inserted = (); 943d752fcc8SJoe Perchesmy @fixed_deleted = (); 944194f66fcSJoe Perchesmy $fixlinenr = -1; 945194f66fcSJoe Perches 9464a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 9474a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 9484a593c34SDu, Changbindie "$P: No git repository found\n" if ($git && !-e ".git"); 9494a593c34SDu, Changbin 9504a593c34SDu, Changbinif ($git) { 9514a593c34SDu, Changbin my @commits = (); 9520dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 9534a593c34SDu, Changbin my $git_range; 95428898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 95528898fd1SJoe Perches $git_range = "-$2 $1"; 9564a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 9574a593c34SDu, Changbin $git_range = "$commit_expr"; 9584a593c34SDu, Changbin } else { 9590dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 9600dea9f1eSJoe Perches } 9610dea9f1eSJoe Perches my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 9620dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 96328898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 96428898fd1SJoe Perches next if (!defined($1) || !defined($2)); 9650dea9f1eSJoe Perches my $sha1 = $1; 9660dea9f1eSJoe Perches my $subject = $2; 9670dea9f1eSJoe Perches unshift(@commits, $sha1); 9680dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 9694a593c34SDu, Changbin } 9704a593c34SDu, Changbin } 9714a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 9724a593c34SDu, Changbin @ARGV = @commits; 9734a593c34SDu, Changbin} 9744a593c34SDu, Changbin 975c2fdda0dSAndy Whitcroftmy $vname; 9766c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 97721caa13cSAndy Whitcroft my $FILE; 9784a593c34SDu, Changbin if ($git) { 9794a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 9804a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 9814a593c34SDu, Changbin } elsif ($file) { 98221caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 9836c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 98421caa13cSAndy Whitcroft } elsif ($filename eq '-') { 98521caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 9866c72ffaaSAndy Whitcroft } else { 98721caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 9886c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 9896c72ffaaSAndy Whitcroft } 990c2fdda0dSAndy Whitcroft if ($filename eq '-') { 991c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 9924a593c34SDu, Changbin } elsif ($git) { 9930dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 994c2fdda0dSAndy Whitcroft } else { 995c2fdda0dSAndy Whitcroft $vname = $filename; 996c2fdda0dSAndy Whitcroft } 99721caa13cSAndy Whitcroft while (<$FILE>) { 9980a920b5bSAndy Whitcroft chomp; 99900df344fSAndy Whitcroft push(@rawlines, $_); 10006c72ffaaSAndy Whitcroft } 100121caa13cSAndy Whitcroft close($FILE); 1002d8469f16SJoe Perches 1003d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 1004d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1005d8469f16SJoe Perches print "$vname\n"; 1006d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1007d8469f16SJoe Perches } 1008d8469f16SJoe Perches 1009c2fdda0dSAndy Whitcroft if (!process($filename)) { 10100a920b5bSAndy Whitcroft $exit = 1; 10110a920b5bSAndy Whitcroft } 101200df344fSAndy Whitcroft @rawlines = (); 101313214adfSAndy Whitcroft @lines = (); 10143705ce5bSJoe Perches @fixed = (); 1015d752fcc8SJoe Perches @fixed_inserted = (); 1016d752fcc8SJoe Perches @fixed_deleted = (); 1017194f66fcSJoe Perches $fixlinenr = -1; 1018485ff23eSAlex Dowad @modifierListFile = (); 1019485ff23eSAlex Dowad @typeListFile = (); 1020485ff23eSAlex Dowad build_types(); 10210a920b5bSAndy Whitcroft} 10220a920b5bSAndy Whitcroft 1023d8469f16SJoe Perchesif (!$quiet) { 10243c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 10253c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 10263c816e49SJoe Perches 1027d8469f16SJoe Perches if ($^V lt 5.10.0) { 1028d8469f16SJoe Perches print << "EOM" 1029d8469f16SJoe Perches 1030d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 1031d8469f16SJoe Perches An upgrade to at least perl v5.10.0 is suggested. 1032d8469f16SJoe PerchesEOM 1033d8469f16SJoe Perches } 1034d8469f16SJoe Perches if ($exit) { 1035d8469f16SJoe Perches print << "EOM" 1036d8469f16SJoe Perches 1037d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 1038d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 1039d8469f16SJoe PerchesEOM 1040d8469f16SJoe Perches } 1041d8469f16SJoe Perches} 1042d8469f16SJoe Perches 10430a920b5bSAndy Whitcroftexit($exit); 10440a920b5bSAndy Whitcroft 10450a920b5bSAndy Whitcroftsub top_of_kernel_tree { 10466c72ffaaSAndy Whitcroft my ($root) = @_; 10476c72ffaaSAndy Whitcroft 10486c72ffaaSAndy Whitcroft my @tree_check = ( 10496c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 10506c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 10516c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 10526c72ffaaSAndy Whitcroft ); 10536c72ffaaSAndy Whitcroft 10546c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 10556c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 10560a920b5bSAndy Whitcroft return 0; 10570a920b5bSAndy Whitcroft } 10586c72ffaaSAndy Whitcroft } 10596c72ffaaSAndy Whitcroft return 1; 10606c72ffaaSAndy Whitcroft} 10610a920b5bSAndy Whitcroft 106220112475SJoe Perchessub parse_email { 106320112475SJoe Perches my ($formatted_email) = @_; 106420112475SJoe Perches 106520112475SJoe Perches my $name = ""; 106620112475SJoe Perches my $address = ""; 106720112475SJoe Perches my $comment = ""; 106820112475SJoe Perches 106920112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 107020112475SJoe Perches $name = $1; 107120112475SJoe Perches $address = $2; 107220112475SJoe Perches $comment = $3 if defined $3; 107320112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 107420112475SJoe Perches $address = $1; 107520112475SJoe Perches $comment = $2 if defined $2; 107620112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 107720112475SJoe Perches $address = $1; 107820112475SJoe Perches $comment = $2 if defined $2; 107985e12066SJoe Perches $formatted_email =~ s/\Q$address\E.*$//; 108020112475SJoe Perches $name = $formatted_email; 10813705ce5bSJoe Perches $name = trim($name); 108220112475SJoe Perches $name =~ s/^\"|\"$//g; 108320112475SJoe Perches # If there's a name left after stripping spaces and 108420112475SJoe Perches # leading quotes, and the address doesn't have both 108520112475SJoe Perches # leading and trailing angle brackets, the address 108620112475SJoe Perches # is invalid. ie: 108720112475SJoe Perches # "joe smith [email protected]" bad 108820112475SJoe Perches # "joe smith <[email protected]" bad 108920112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 109020112475SJoe Perches $name = ""; 109120112475SJoe Perches $address = ""; 109220112475SJoe Perches $comment = ""; 109320112475SJoe Perches } 109420112475SJoe Perches } 109520112475SJoe Perches 10963705ce5bSJoe Perches $name = trim($name); 109720112475SJoe Perches $name =~ s/^\"|\"$//g; 10983705ce5bSJoe Perches $address = trim($address); 109920112475SJoe Perches $address =~ s/^\<|\>$//g; 110020112475SJoe Perches 110120112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 110220112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 110320112475SJoe Perches $name = "\"$name\""; 110420112475SJoe Perches } 110520112475SJoe Perches 110620112475SJoe Perches return ($name, $address, $comment); 110720112475SJoe Perches} 110820112475SJoe Perches 110920112475SJoe Perchessub format_email { 111020112475SJoe Perches my ($name, $address) = @_; 111120112475SJoe Perches 111220112475SJoe Perches my $formatted_email; 111320112475SJoe Perches 11143705ce5bSJoe Perches $name = trim($name); 111520112475SJoe Perches $name =~ s/^\"|\"$//g; 11163705ce5bSJoe Perches $address = trim($address); 111720112475SJoe Perches 111820112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 111920112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 112020112475SJoe Perches $name = "\"$name\""; 112120112475SJoe Perches } 112220112475SJoe Perches 112320112475SJoe Perches if ("$name" eq "") { 112420112475SJoe Perches $formatted_email = "$address"; 112520112475SJoe Perches } else { 112620112475SJoe Perches $formatted_email = "$name <$address>"; 112720112475SJoe Perches } 112820112475SJoe Perches 112920112475SJoe Perches return $formatted_email; 113020112475SJoe Perches} 113120112475SJoe Perches 1132d311cd44SJoe Perchessub which { 1133d311cd44SJoe Perches my ($bin) = @_; 1134d311cd44SJoe Perches 1135d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1136d311cd44SJoe Perches if (-e "$path/$bin") { 1137d311cd44SJoe Perches return "$path/$bin"; 1138d311cd44SJoe Perches } 1139d311cd44SJoe Perches } 1140d311cd44SJoe Perches 1141d311cd44SJoe Perches return ""; 1142d311cd44SJoe Perches} 1143d311cd44SJoe Perches 1144000d1cc1SJoe Perchessub which_conf { 1145000d1cc1SJoe Perches my ($conf) = @_; 1146000d1cc1SJoe Perches 1147000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1148000d1cc1SJoe Perches if (-e "$path/$conf") { 1149000d1cc1SJoe Perches return "$path/$conf"; 1150000d1cc1SJoe Perches } 1151000d1cc1SJoe Perches } 1152000d1cc1SJoe Perches 1153000d1cc1SJoe Perches return ""; 1154000d1cc1SJoe Perches} 1155000d1cc1SJoe Perches 11560a920b5bSAndy Whitcroftsub expand_tabs { 11570a920b5bSAndy Whitcroft my ($str) = @_; 11580a920b5bSAndy Whitcroft 11590a920b5bSAndy Whitcroft my $res = ''; 11600a920b5bSAndy Whitcroft my $n = 0; 11610a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 11620a920b5bSAndy Whitcroft if ($c eq "\t") { 11630a920b5bSAndy Whitcroft $res .= ' '; 11640a920b5bSAndy Whitcroft $n++; 11650a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 11660a920b5bSAndy Whitcroft $res .= ' '; 11670a920b5bSAndy Whitcroft } 11680a920b5bSAndy Whitcroft next; 11690a920b5bSAndy Whitcroft } 11700a920b5bSAndy Whitcroft $res .= $c; 11710a920b5bSAndy Whitcroft $n++; 11720a920b5bSAndy Whitcroft } 11730a920b5bSAndy Whitcroft 11740a920b5bSAndy Whitcroft return $res; 11750a920b5bSAndy Whitcroft} 11766c72ffaaSAndy Whitcroftsub copy_spacing { 1177773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 11786c72ffaaSAndy Whitcroft return $res; 11796c72ffaaSAndy Whitcroft} 11800a920b5bSAndy Whitcroft 11814a0df2efSAndy Whitcroftsub line_stats { 11824a0df2efSAndy Whitcroft my ($line) = @_; 11834a0df2efSAndy Whitcroft 11844a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 11854a0df2efSAndy Whitcroft $line =~ s/^.//; 11864a0df2efSAndy Whitcroft $line = expand_tabs($line); 11874a0df2efSAndy Whitcroft 11884a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 11894a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 11904a0df2efSAndy Whitcroft 11914a0df2efSAndy Whitcroft return (length($line), length($white)); 11924a0df2efSAndy Whitcroft} 11934a0df2efSAndy Whitcroft 1194773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1195773647a0SAndy Whitcroft 1196773647a0SAndy Whitcroftsub sanitise_line_reset { 1197773647a0SAndy Whitcroft my ($in_comment) = @_; 1198773647a0SAndy Whitcroft 1199773647a0SAndy Whitcroft if ($in_comment) { 1200773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1201773647a0SAndy Whitcroft } else { 1202773647a0SAndy Whitcroft $sanitise_quote = ''; 1203773647a0SAndy Whitcroft } 1204773647a0SAndy Whitcroft} 120500df344fSAndy Whitcroftsub sanitise_line { 120600df344fSAndy Whitcroft my ($line) = @_; 120700df344fSAndy Whitcroft 120800df344fSAndy Whitcroft my $res = ''; 120900df344fSAndy Whitcroft my $l = ''; 121000df344fSAndy Whitcroft 1211c2fdda0dSAndy Whitcroft my $qlen = 0; 1212773647a0SAndy Whitcroft my $off = 0; 1213773647a0SAndy Whitcroft my $c; 121400df344fSAndy Whitcroft 1215773647a0SAndy Whitcroft # Always copy over the diff marker. 1216773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1217773647a0SAndy Whitcroft 1218773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1219773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1220773647a0SAndy Whitcroft 1221773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 1222773647a0SAndy Whitcroft # and end, all to $;. 1223773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1224773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1225773647a0SAndy Whitcroft 1226773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1227773647a0SAndy Whitcroft $off++; 122800df344fSAndy Whitcroft next; 1229773647a0SAndy Whitcroft } 123081bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1231773647a0SAndy Whitcroft $sanitise_quote = ''; 1232773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1233773647a0SAndy Whitcroft $off++; 1234773647a0SAndy Whitcroft next; 1235773647a0SAndy Whitcroft } 1236113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1237113f04a8SDaniel Walker $sanitise_quote = '//'; 1238113f04a8SDaniel Walker 1239113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1240113f04a8SDaniel Walker $off++; 1241113f04a8SDaniel Walker next; 1242113f04a8SDaniel Walker } 1243773647a0SAndy Whitcroft 1244773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1245773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1246773647a0SAndy Whitcroft $c eq "\\") { 1247773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1248773647a0SAndy Whitcroft $off++; 1249773647a0SAndy Whitcroft next; 1250773647a0SAndy Whitcroft } 1251773647a0SAndy Whitcroft # Regular quotes. 1252773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1253773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1254773647a0SAndy Whitcroft $sanitise_quote = $c; 1255773647a0SAndy Whitcroft 1256773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1257773647a0SAndy Whitcroft next; 1258773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1259773647a0SAndy Whitcroft $sanitise_quote = ''; 126000df344fSAndy Whitcroft } 126100df344fSAndy Whitcroft } 1262773647a0SAndy Whitcroft 1263fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1264773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1265773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1266113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1267113f04a8SDaniel Walker substr($res, $off, 1, $;); 1268773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1269773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 127000df344fSAndy Whitcroft } else { 1271773647a0SAndy Whitcroft substr($res, $off, 1, $c); 127200df344fSAndy Whitcroft } 1273c2fdda0dSAndy Whitcroft } 1274c2fdda0dSAndy Whitcroft 1275113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1276113f04a8SDaniel Walker $sanitise_quote = ''; 1277113f04a8SDaniel Walker } 1278113f04a8SDaniel Walker 1279c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1280c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1281c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1282c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1283c2fdda0dSAndy Whitcroft 1284c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1285c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1286c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1287c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1288c2fdda0dSAndy Whitcroft } 1289c2fdda0dSAndy Whitcroft 1290dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1291dadf680dSJoe Perches my $match = $1; 1292dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1293dadf680dSJoe Perches } 1294dadf680dSJoe Perches 129500df344fSAndy Whitcroft return $res; 129600df344fSAndy Whitcroft} 129700df344fSAndy Whitcroft 1298a6962d72SJoe Perchessub get_quoted_string { 1299a6962d72SJoe Perches my ($line, $rawline) = @_; 1300a6962d72SJoe Perches 130133acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1302a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1303a6962d72SJoe Perches} 1304a6962d72SJoe Perches 13058905a67cSAndy Whitcroftsub ctx_statement_block { 13068905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 13078905a67cSAndy Whitcroft my $line = $linenr - 1; 13088905a67cSAndy Whitcroft my $blk = ''; 13098905a67cSAndy Whitcroft my $soff = $off; 13108905a67cSAndy Whitcroft my $coff = $off - 1; 1311773647a0SAndy Whitcroft my $coff_set = 0; 13128905a67cSAndy Whitcroft 131313214adfSAndy Whitcroft my $loff = 0; 131413214adfSAndy Whitcroft 13158905a67cSAndy Whitcroft my $type = ''; 13168905a67cSAndy Whitcroft my $level = 0; 1317a2750645SAndy Whitcroft my @stack = (); 1318cf655043SAndy Whitcroft my $p; 13198905a67cSAndy Whitcroft my $c; 13208905a67cSAndy Whitcroft my $len = 0; 132113214adfSAndy Whitcroft 132213214adfSAndy Whitcroft my $remainder; 13238905a67cSAndy Whitcroft while (1) { 1324a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1325a2750645SAndy Whitcroft 1326773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 13278905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 13288905a67cSAndy Whitcroft # context. 13298905a67cSAndy Whitcroft if ($off >= $len) { 13308905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1331dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1332c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 13338905a67cSAndy Whitcroft $remain--; 133413214adfSAndy Whitcroft $loff = $len; 1335c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 13368905a67cSAndy Whitcroft $len = length($blk); 13378905a67cSAndy Whitcroft $line++; 13388905a67cSAndy Whitcroft last; 13398905a67cSAndy Whitcroft } 13408905a67cSAndy Whitcroft # Bail if there is no further context. 13418905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 134213214adfSAndy Whitcroft if ($off >= $len) { 13438905a67cSAndy Whitcroft last; 13448905a67cSAndy Whitcroft } 1345f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1346f74bd194SAndy Whitcroft $level++; 1347f74bd194SAndy Whitcroft $type = '#'; 1348f74bd194SAndy Whitcroft } 13498905a67cSAndy Whitcroft } 1350cf655043SAndy Whitcroft $p = $c; 13518905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 135213214adfSAndy Whitcroft $remainder = substr($blk, $off); 13538905a67cSAndy Whitcroft 1354773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 13554635f4fbSAndy Whitcroft 13564635f4fbSAndy Whitcroft # Handle nested #if/#else. 13574635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 13584635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 13594635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 13604635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 13614635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 13624635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 13634635f4fbSAndy Whitcroft } 13644635f4fbSAndy Whitcroft 13658905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 13668905a67cSAndy Whitcroft # outermost level. 13678905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 13688905a67cSAndy Whitcroft last; 13698905a67cSAndy Whitcroft } 13708905a67cSAndy Whitcroft 137113214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1372773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1373773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1374773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1375773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1376773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1377773647a0SAndy Whitcroft $coff_set = 1; 1378773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1379773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 138013214adfSAndy Whitcroft } 138113214adfSAndy Whitcroft 13828905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 13838905a67cSAndy Whitcroft $level++; 13848905a67cSAndy Whitcroft $type = '('; 13858905a67cSAndy Whitcroft } 13868905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 13878905a67cSAndy Whitcroft $level--; 13888905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 13898905a67cSAndy Whitcroft 13908905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 13918905a67cSAndy Whitcroft $coff = $off; 1392773647a0SAndy Whitcroft $coff_set = 1; 1393773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 13948905a67cSAndy Whitcroft } 13958905a67cSAndy Whitcroft } 13968905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 13978905a67cSAndy Whitcroft $level++; 13988905a67cSAndy Whitcroft $type = '{'; 13998905a67cSAndy Whitcroft } 14008905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 14018905a67cSAndy Whitcroft $level--; 14028905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 14038905a67cSAndy Whitcroft 14048905a67cSAndy Whitcroft if ($level == 0) { 1405b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1406b998e001SPatrick Pannuto $off++; 1407b998e001SPatrick Pannuto } 14088905a67cSAndy Whitcroft last; 14098905a67cSAndy Whitcroft } 14108905a67cSAndy Whitcroft } 1411f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1412f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1413f74bd194SAndy Whitcroft $level--; 1414f74bd194SAndy Whitcroft $type = ''; 1415f74bd194SAndy Whitcroft $off++; 1416f74bd194SAndy Whitcroft last; 1417f74bd194SAndy Whitcroft } 14188905a67cSAndy Whitcroft $off++; 14198905a67cSAndy Whitcroft } 1420a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 142113214adfSAndy Whitcroft if ($off == $len) { 1422a3bb97a7SAndy Whitcroft $loff = $len + 1; 142313214adfSAndy Whitcroft $line++; 142413214adfSAndy Whitcroft $remain--; 142513214adfSAndy Whitcroft } 14268905a67cSAndy Whitcroft 14278905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 14288905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 14298905a67cSAndy Whitcroft 14308905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 14318905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 14328905a67cSAndy Whitcroft 1433773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 143413214adfSAndy Whitcroft 143513214adfSAndy Whitcroft return ($statement, $condition, 143613214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 143713214adfSAndy Whitcroft} 143813214adfSAndy Whitcroft 1439cf655043SAndy Whitcroftsub statement_lines { 1440cf655043SAndy Whitcroft my ($stmt) = @_; 1441cf655043SAndy Whitcroft 1442cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1443cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1444cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1445cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1446cf655043SAndy Whitcroft 1447cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1448cf655043SAndy Whitcroft 1449cf655043SAndy Whitcroft return $#stmt_lines + 2; 1450cf655043SAndy Whitcroft} 1451cf655043SAndy Whitcroft 1452cf655043SAndy Whitcroftsub statement_rawlines { 1453cf655043SAndy Whitcroft my ($stmt) = @_; 1454cf655043SAndy Whitcroft 1455cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1456cf655043SAndy Whitcroft 1457cf655043SAndy Whitcroft return $#stmt_lines + 2; 1458cf655043SAndy Whitcroft} 1459cf655043SAndy Whitcroft 1460cf655043SAndy Whitcroftsub statement_block_size { 1461cf655043SAndy Whitcroft my ($stmt) = @_; 1462cf655043SAndy Whitcroft 1463cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1464cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1465cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1466cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1467cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1468cf655043SAndy Whitcroft 1469cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1470cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1471cf655043SAndy Whitcroft 1472cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1473cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1474cf655043SAndy Whitcroft 1475cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1476cf655043SAndy Whitcroft return $stmt_lines; 1477cf655043SAndy Whitcroft } else { 1478cf655043SAndy Whitcroft return $stmt_statements; 1479cf655043SAndy Whitcroft } 1480cf655043SAndy Whitcroft} 1481cf655043SAndy Whitcroft 148213214adfSAndy Whitcroftsub ctx_statement_full { 148313214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 148413214adfSAndy Whitcroft my ($statement, $condition, $level); 148513214adfSAndy Whitcroft 148613214adfSAndy Whitcroft my (@chunks); 148713214adfSAndy Whitcroft 1488cf655043SAndy Whitcroft # Grab the first conditional/block pair. 148913214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 149013214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1491773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 149213214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1493cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1494cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1495cf655043SAndy Whitcroft } 1496cf655043SAndy Whitcroft 1497cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1498cf655043SAndy Whitcroft # could continue the statement. 1499cf655043SAndy Whitcroft for (;;) { 150013214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 150113214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1502cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1503773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1504cf655043SAndy Whitcroft #print "C: push\n"; 1505cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 150613214adfSAndy Whitcroft } 150713214adfSAndy Whitcroft 150813214adfSAndy Whitcroft return ($level, $linenr, @chunks); 15098905a67cSAndy Whitcroft} 15108905a67cSAndy Whitcroft 15114a0df2efSAndy Whitcroftsub ctx_block_get { 1512f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 15134a0df2efSAndy Whitcroft my $line; 15144a0df2efSAndy Whitcroft my $start = $linenr - 1; 15154a0df2efSAndy Whitcroft my $blk = ''; 15164a0df2efSAndy Whitcroft my @o; 15174a0df2efSAndy Whitcroft my @c; 15184a0df2efSAndy Whitcroft my @res = (); 15194a0df2efSAndy Whitcroft 1520f0a594c1SAndy Whitcroft my $level = 0; 15214635f4fbSAndy Whitcroft my @stack = ($level); 152200df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 152300df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 152400df344fSAndy Whitcroft $remain--; 152500df344fSAndy Whitcroft 152600df344fSAndy Whitcroft $blk .= $rawlines[$line]; 15274635f4fbSAndy Whitcroft 15284635f4fbSAndy Whitcroft # Handle nested #if/#else. 152901464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 15304635f4fbSAndy Whitcroft push(@stack, $level); 153101464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 15324635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 153301464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 15344635f4fbSAndy Whitcroft $level = pop(@stack); 15354635f4fbSAndy Whitcroft } 15364635f4fbSAndy Whitcroft 153701464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1538f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1539f0a594c1SAndy Whitcroft if ($off > 0) { 1540f0a594c1SAndy Whitcroft $off--; 1541f0a594c1SAndy Whitcroft next; 1542f0a594c1SAndy Whitcroft } 15434a0df2efSAndy Whitcroft 1544f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1545f0a594c1SAndy Whitcroft $level--; 1546f0a594c1SAndy Whitcroft last if ($level == 0); 1547f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1548f0a594c1SAndy Whitcroft $level++; 1549f0a594c1SAndy Whitcroft } 1550f0a594c1SAndy Whitcroft } 15514a0df2efSAndy Whitcroft 1552f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 155300df344fSAndy Whitcroft push(@res, $rawlines[$line]); 15544a0df2efSAndy Whitcroft } 15554a0df2efSAndy Whitcroft 1556f0a594c1SAndy Whitcroft last if ($level == 0); 15574a0df2efSAndy Whitcroft } 15584a0df2efSAndy Whitcroft 1559f0a594c1SAndy Whitcroft return ($level, @res); 15604a0df2efSAndy Whitcroft} 15614a0df2efSAndy Whitcroftsub ctx_block_outer { 15624a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 15634a0df2efSAndy Whitcroft 1564f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1565f0a594c1SAndy Whitcroft return @r; 15664a0df2efSAndy Whitcroft} 15674a0df2efSAndy Whitcroftsub ctx_block { 15684a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 15694a0df2efSAndy Whitcroft 1570f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1571f0a594c1SAndy Whitcroft return @r; 1572653d4876SAndy Whitcroft} 1573653d4876SAndy Whitcroftsub ctx_statement { 1574f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1575f0a594c1SAndy Whitcroft 1576f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1577f0a594c1SAndy Whitcroft return @r; 1578f0a594c1SAndy Whitcroft} 1579f0a594c1SAndy Whitcroftsub ctx_block_level { 1580653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1581653d4876SAndy Whitcroft 1582f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 15834a0df2efSAndy Whitcroft} 15849c0ca6f9SAndy Whitcroftsub ctx_statement_level { 15859c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 15869c0ca6f9SAndy Whitcroft 15879c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 15889c0ca6f9SAndy Whitcroft} 15894a0df2efSAndy Whitcroft 15904a0df2efSAndy Whitcroftsub ctx_locate_comment { 15914a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 15924a0df2efSAndy Whitcroft 15934a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1594beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 15954a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 15964a0df2efSAndy Whitcroft 15974a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 15984a0df2efSAndy Whitcroft # comment. 15994a0df2efSAndy Whitcroft my $in_comment = 0; 16004a0df2efSAndy Whitcroft $current_comment = ''; 16014a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 160200df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 160300df344fSAndy Whitcroft #warn " $line\n"; 16044a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 16054a0df2efSAndy Whitcroft $in_comment = 1; 16064a0df2efSAndy Whitcroft } 16074a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 16084a0df2efSAndy Whitcroft $in_comment = 1; 16094a0df2efSAndy Whitcroft } 16104a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 16114a0df2efSAndy Whitcroft $current_comment = ''; 16124a0df2efSAndy Whitcroft } 16134a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 16144a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 16154a0df2efSAndy Whitcroft $in_comment = 0; 16164a0df2efSAndy Whitcroft } 16174a0df2efSAndy Whitcroft } 16184a0df2efSAndy Whitcroft 16194a0df2efSAndy Whitcroft chomp($current_comment); 16204a0df2efSAndy Whitcroft return($current_comment); 16214a0df2efSAndy Whitcroft} 16224a0df2efSAndy Whitcroftsub ctx_has_comment { 16234a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 16244a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 16254a0df2efSAndy Whitcroft 162600df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 16274a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 16284a0df2efSAndy Whitcroft 16294a0df2efSAndy Whitcroft return ($cmt ne ''); 16304a0df2efSAndy Whitcroft} 16314a0df2efSAndy Whitcroft 16324d001e4dSAndy Whitcroftsub raw_line { 16334d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 16344d001e4dSAndy Whitcroft 16354d001e4dSAndy Whitcroft my $offset = $linenr - 1; 16364d001e4dSAndy Whitcroft $cnt++; 16374d001e4dSAndy Whitcroft 16384d001e4dSAndy Whitcroft my $line; 16394d001e4dSAndy Whitcroft while ($cnt) { 16404d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 16414d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 16424d001e4dSAndy Whitcroft $cnt--; 16434d001e4dSAndy Whitcroft } 16444d001e4dSAndy Whitcroft 16454d001e4dSAndy Whitcroft return $line; 16464d001e4dSAndy Whitcroft} 16474d001e4dSAndy Whitcroft 1648*2a9f9d85STobin C. Hardingsub get_stat_real { 1649*2a9f9d85STobin C. Harding my ($linenr, $lc) = @_; 1650*2a9f9d85STobin C. Harding 1651*2a9f9d85STobin C. Harding my $stat_real = raw_line($linenr, 0); 1652*2a9f9d85STobin C. Harding for (my $count = $linenr + 1; $count <= $lc; $count++) { 1653*2a9f9d85STobin C. Harding $stat_real = $stat_real . "\n" . raw_line($count, 0); 1654*2a9f9d85STobin C. Harding } 1655*2a9f9d85STobin C. Harding 1656*2a9f9d85STobin C. Harding return $stat_real; 1657*2a9f9d85STobin C. Harding} 1658*2a9f9d85STobin C. Harding 16590a920b5bSAndy Whitcroftsub cat_vet { 16600a920b5bSAndy Whitcroft my ($vet) = @_; 16619c0ca6f9SAndy Whitcroft my ($res, $coded); 16620a920b5bSAndy Whitcroft 16639c0ca6f9SAndy Whitcroft $res = ''; 16646c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 16656c72ffaaSAndy Whitcroft $res .= $1; 16666c72ffaaSAndy Whitcroft if ($2 ne '') { 16679c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 16686c72ffaaSAndy Whitcroft $res .= $coded; 16696c72ffaaSAndy Whitcroft } 16709c0ca6f9SAndy Whitcroft } 16719c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 16720a920b5bSAndy Whitcroft 16739c0ca6f9SAndy Whitcroft return $res; 16740a920b5bSAndy Whitcroft} 16750a920b5bSAndy Whitcroft 1676c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1677cf655043SAndy Whitcroftmy $av_pending; 1678c2fdda0dSAndy Whitcroftmy @av_paren_type; 16791f65f947SAndy Whitcroftmy $av_pend_colon; 1680c2fdda0dSAndy Whitcroft 1681c2fdda0dSAndy Whitcroftsub annotate_reset { 1682c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1683cf655043SAndy Whitcroft $av_pending = '_'; 1684cf655043SAndy Whitcroft @av_paren_type = ('E'); 16851f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1686c2fdda0dSAndy Whitcroft} 1687c2fdda0dSAndy Whitcroft 16886c72ffaaSAndy Whitcroftsub annotate_values { 16896c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 16906c72ffaaSAndy Whitcroft 16916c72ffaaSAndy Whitcroft my $res; 16921f65f947SAndy Whitcroft my $var = '_' x length($stream); 16936c72ffaaSAndy Whitcroft my $cur = $stream; 16946c72ffaaSAndy Whitcroft 1695c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 16966c72ffaaSAndy Whitcroft 16976c72ffaaSAndy Whitcroft while (length($cur)) { 1698773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1699cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1700171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 17016c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1702c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1703c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1704cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1705c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 17066c72ffaaSAndy Whitcroft } 17076c72ffaaSAndy Whitcroft 1708c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 17099446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 17109446ef56SAndy Whitcroft push(@av_paren_type, $type); 1711addcdceaSAndy Whitcroft $type = 'c'; 17129446ef56SAndy Whitcroft 1713e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1714c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 17156c72ffaaSAndy Whitcroft $type = 'T'; 17166c72ffaaSAndy Whitcroft 1717389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1718389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1719389a2fe5SAndy Whitcroft $type = 'T'; 1720389a2fe5SAndy Whitcroft 1721c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1722171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1723c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1724171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1725171ae1a4SAndy Whitcroft if ($2 ne '') { 1726cf655043SAndy Whitcroft $av_pending = 'N'; 1727171ae1a4SAndy Whitcroft } 1728171ae1a4SAndy Whitcroft $type = 'E'; 1729171ae1a4SAndy Whitcroft 1730c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1731171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1732171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1733171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 17346c72ffaaSAndy Whitcroft 1735c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1736cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1737c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1738cf655043SAndy Whitcroft 1739cf655043SAndy Whitcroft push(@av_paren_type, $type); 1740cf655043SAndy Whitcroft push(@av_paren_type, $type); 1741171ae1a4SAndy Whitcroft $type = 'E'; 1742cf655043SAndy Whitcroft 1743c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1744cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1745cf655043SAndy Whitcroft $av_preprocessor = 1; 1746cf655043SAndy Whitcroft 1747cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1748cf655043SAndy Whitcroft 1749171ae1a4SAndy Whitcroft $type = 'E'; 1750cf655043SAndy Whitcroft 1751c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1752cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1753cf655043SAndy Whitcroft 1754cf655043SAndy Whitcroft $av_preprocessor = 1; 1755cf655043SAndy Whitcroft 1756cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1757cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1758cf655043SAndy Whitcroft pop(@av_paren_type); 1759cf655043SAndy Whitcroft push(@av_paren_type, $type); 1760171ae1a4SAndy Whitcroft $type = 'E'; 17616c72ffaaSAndy Whitcroft 17626c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1763c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 17646c72ffaaSAndy Whitcroft 1765171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1766171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1767171ae1a4SAndy Whitcroft $av_pending = $type; 1768171ae1a4SAndy Whitcroft $type = 'N'; 1769171ae1a4SAndy Whitcroft 17706c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1771c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 17726c72ffaaSAndy Whitcroft if (defined $2) { 1773cf655043SAndy Whitcroft $av_pending = 'V'; 17746c72ffaaSAndy Whitcroft } 17756c72ffaaSAndy Whitcroft $type = 'N'; 17766c72ffaaSAndy Whitcroft 177714b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1778c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 177914b111c1SAndy Whitcroft $av_pending = 'E'; 17806c72ffaaSAndy Whitcroft $type = 'N'; 17816c72ffaaSAndy Whitcroft 17821f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 17831f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 17841f65f947SAndy Whitcroft $av_pend_colon = 'C'; 17851f65f947SAndy Whitcroft $type = 'N'; 17861f65f947SAndy Whitcroft 178714b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1788c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 17896c72ffaaSAndy Whitcroft $type = 'N'; 17906c72ffaaSAndy Whitcroft 17916c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1792c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1793cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1794cf655043SAndy Whitcroft $av_pending = '_'; 17956c72ffaaSAndy Whitcroft $type = 'N'; 17966c72ffaaSAndy Whitcroft 17976c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1798cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1799cf655043SAndy Whitcroft if ($new_type ne '_') { 1800cf655043SAndy Whitcroft $type = $new_type; 1801c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1802c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 18036c72ffaaSAndy Whitcroft } else { 1804c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 18056c72ffaaSAndy Whitcroft } 18066c72ffaaSAndy Whitcroft 1807c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1808c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1809c8cb2ca3SAndy Whitcroft $type = 'V'; 1810cf655043SAndy Whitcroft $av_pending = 'V'; 18116c72ffaaSAndy Whitcroft 18128e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 18138e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 18141f65f947SAndy Whitcroft $av_pend_colon = 'B'; 18158e761b04SAndy Whitcroft } elsif ($type eq 'E') { 18168e761b04SAndy Whitcroft $av_pend_colon = 'L'; 18171f65f947SAndy Whitcroft } 18181f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 18191f65f947SAndy Whitcroft $type = 'V'; 18201f65f947SAndy Whitcroft 18216c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1822c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 18236c72ffaaSAndy Whitcroft $type = 'V'; 18246c72ffaaSAndy Whitcroft 18256c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1826c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 18276c72ffaaSAndy Whitcroft $type = 'N'; 18286c72ffaaSAndy Whitcroft 1829cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1830c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 183113214adfSAndy Whitcroft $type = 'E'; 18321f65f947SAndy Whitcroft $av_pend_colon = 'O'; 183313214adfSAndy Whitcroft 18348e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 18358e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 18368e761b04SAndy Whitcroft $type = 'C'; 18378e761b04SAndy Whitcroft 18381f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 18391f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 18401f65f947SAndy Whitcroft $type = 'N'; 18411f65f947SAndy Whitcroft 18421f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 18431f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 18441f65f947SAndy Whitcroft 18451f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 18461f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 18471f65f947SAndy Whitcroft $type = 'E'; 18481f65f947SAndy Whitcroft } else { 18491f65f947SAndy Whitcroft $type = 'N'; 18501f65f947SAndy Whitcroft } 18511f65f947SAndy Whitcroft $av_pend_colon = 'O'; 18521f65f947SAndy Whitcroft 18538e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 185413214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 18556c72ffaaSAndy Whitcroft $type = 'N'; 18566c72ffaaSAndy Whitcroft 18570d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 185874048ed8SAndy Whitcroft my $variant; 185974048ed8SAndy Whitcroft 186074048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 186174048ed8SAndy Whitcroft if ($type eq 'V') { 186274048ed8SAndy Whitcroft $variant = 'B'; 186374048ed8SAndy Whitcroft } else { 186474048ed8SAndy Whitcroft $variant = 'U'; 186574048ed8SAndy Whitcroft } 186674048ed8SAndy Whitcroft 186774048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 186874048ed8SAndy Whitcroft $type = 'N'; 186974048ed8SAndy Whitcroft 18706c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1871c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 18726c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 18736c72ffaaSAndy Whitcroft $type = 'N'; 18746c72ffaaSAndy Whitcroft } 18756c72ffaaSAndy Whitcroft 18766c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1877c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 18786c72ffaaSAndy Whitcroft } 18796c72ffaaSAndy Whitcroft if (defined $1) { 18806c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 18816c72ffaaSAndy Whitcroft $res .= $type x length($1); 18826c72ffaaSAndy Whitcroft } 18836c72ffaaSAndy Whitcroft } 18846c72ffaaSAndy Whitcroft 18851f65f947SAndy Whitcroft return ($res, $var); 18866c72ffaaSAndy Whitcroft} 18876c72ffaaSAndy Whitcroft 18888905a67cSAndy Whitcroftsub possible { 188913214adfSAndy Whitcroft my ($possible, $line) = @_; 18909a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 18910776e594SAndy Whitcroft ^(?: 18920776e594SAndy Whitcroft $Modifier| 18930776e594SAndy Whitcroft $Storage| 18940776e594SAndy Whitcroft $Type| 18959a974fdbSAndy Whitcroft DEFINE_\S+ 18969a974fdbSAndy Whitcroft )$| 18979a974fdbSAndy Whitcroft ^(?: 18980776e594SAndy Whitcroft goto| 18990776e594SAndy Whitcroft return| 19000776e594SAndy Whitcroft case| 19010776e594SAndy Whitcroft else| 19020776e594SAndy Whitcroft asm|__asm__| 190389a88353SAndy Whitcroft do| 190489a88353SAndy Whitcroft \#| 190589a88353SAndy Whitcroft \#\#| 19069a974fdbSAndy Whitcroft )(?:\s|$)| 19070776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 19089a974fdbSAndy Whitcroft )}x; 19099a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 19109a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1911c45dcabdSAndy Whitcroft # Check for modifiers. 1912c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1913c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1914c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1915c45dcabdSAndy Whitcroft 1916c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1917c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1918d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 19199a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1920d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1921485ff23eSAlex Dowad push(@modifierListFile, $modifier); 1922d2506586SAndy Whitcroft } 19239a974fdbSAndy Whitcroft } 1924c45dcabdSAndy Whitcroft 1925c45dcabdSAndy Whitcroft } else { 192613214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 1927485ff23eSAlex Dowad push(@typeListFile, $possible); 1928c45dcabdSAndy Whitcroft } 19298905a67cSAndy Whitcroft build_types(); 19300776e594SAndy Whitcroft } else { 19310776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 19328905a67cSAndy Whitcroft } 19338905a67cSAndy Whitcroft} 19348905a67cSAndy Whitcroft 19356c72ffaaSAndy Whitcroftmy $prefix = ''; 19366c72ffaaSAndy Whitcroft 1937000d1cc1SJoe Perchessub show_type { 1938cbec18afSJoe Perches my ($type) = @_; 193991bfe484SJoe Perches 1940522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 1941522b837cSAlexey Dobriyan 1942cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1943cbec18afSJoe Perches 1944cbec18afSJoe Perches return !defined $ignore_type{$type}; 1945000d1cc1SJoe Perches} 1946000d1cc1SJoe Perches 1947f0a594c1SAndy Whitcroftsub report { 1948cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1949cbec18afSJoe Perches 1950cbec18afSJoe Perches if (!show_type($type) || 1951cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1952773647a0SAndy Whitcroft return 0; 1953773647a0SAndy Whitcroft } 195457230297SJoe Perches my $output = ''; 1955737c0767SJohn Brooks if ($color) { 195657230297SJoe Perches if ($level eq 'ERROR') { 195757230297SJoe Perches $output .= RED; 195857230297SJoe Perches } elsif ($level eq 'WARNING') { 195957230297SJoe Perches $output .= YELLOW; 1960000d1cc1SJoe Perches } else { 196157230297SJoe Perches $output .= GREEN; 1962000d1cc1SJoe Perches } 196357230297SJoe Perches } 196457230297SJoe Perches $output .= $prefix . $level . ':'; 196557230297SJoe Perches if ($show_types) { 1966737c0767SJohn Brooks $output .= BLUE if ($color); 196757230297SJoe Perches $output .= "$type:"; 196857230297SJoe Perches } 1969737c0767SJohn Brooks $output .= RESET if ($color); 197057230297SJoe Perches $output .= ' ' . $msg . "\n"; 197134d8815fSJoe Perches 197234d8815fSJoe Perches if ($showfile) { 197334d8815fSJoe Perches my @lines = split("\n", $output, -1); 197434d8815fSJoe Perches splice(@lines, 1, 1); 197534d8815fSJoe Perches $output = join("\n", @lines); 197634d8815fSJoe Perches } 197757230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 19788905a67cSAndy Whitcroft 197957230297SJoe Perches push(our @report, $output); 1980773647a0SAndy Whitcroft 1981773647a0SAndy Whitcroft return 1; 1982f0a594c1SAndy Whitcroft} 1983cbec18afSJoe Perches 1984f0a594c1SAndy Whitcroftsub report_dump { 198513214adfSAndy Whitcroft our @report; 1986f0a594c1SAndy Whitcroft} 1987000d1cc1SJoe Perches 1988d752fcc8SJoe Perchessub fixup_current_range { 1989d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 1990d752fcc8SJoe Perches 1991d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 1992d752fcc8SJoe Perches my $o = $1; 1993d752fcc8SJoe Perches my $l = $2; 1994d752fcc8SJoe Perches my $no = $o + $offset; 1995d752fcc8SJoe Perches my $nl = $l + $length; 1996d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 1997d752fcc8SJoe Perches } 1998d752fcc8SJoe Perches} 1999d752fcc8SJoe Perches 2000d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 2001d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 2002d752fcc8SJoe Perches 2003d752fcc8SJoe Perches my $range_last_linenr = 0; 2004d752fcc8SJoe Perches my $delta_offset = 0; 2005d752fcc8SJoe Perches 2006d752fcc8SJoe Perches my $old_linenr = 0; 2007d752fcc8SJoe Perches my $new_linenr = 0; 2008d752fcc8SJoe Perches 2009d752fcc8SJoe Perches my $next_insert = 0; 2010d752fcc8SJoe Perches my $next_delete = 0; 2011d752fcc8SJoe Perches 2012d752fcc8SJoe Perches my @lines = (); 2013d752fcc8SJoe Perches 2014d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 2015d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 2016d752fcc8SJoe Perches 2017d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 2018d752fcc8SJoe Perches my $save_line = 1; 2019d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 2020323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2021d752fcc8SJoe Perches $delta_offset = 0; 2022d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2023d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 2024d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 2025d752fcc8SJoe Perches } 2026d752fcc8SJoe Perches 2027d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2028d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 2029d752fcc8SJoe Perches $save_line = 0; 2030d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2031d752fcc8SJoe Perches } 2032d752fcc8SJoe Perches 2033d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2034d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 2035d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 2036d752fcc8SJoe Perches $new_linenr++; 2037d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2038d752fcc8SJoe Perches } 2039d752fcc8SJoe Perches 2040d752fcc8SJoe Perches if ($save_line) { 2041d752fcc8SJoe Perches push(@lines, $line); 2042d752fcc8SJoe Perches $new_linenr++; 2043d752fcc8SJoe Perches } 2044d752fcc8SJoe Perches 2045d752fcc8SJoe Perches $old_linenr++; 2046d752fcc8SJoe Perches } 2047d752fcc8SJoe Perches 2048d752fcc8SJoe Perches return @lines; 2049d752fcc8SJoe Perches} 2050d752fcc8SJoe Perches 2051f2d7e4d4SJoe Perchessub fix_insert_line { 2052f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2053f2d7e4d4SJoe Perches 2054f2d7e4d4SJoe Perches my $inserted = { 2055f2d7e4d4SJoe Perches LINENR => $linenr, 2056f2d7e4d4SJoe Perches LINE => $line, 2057f2d7e4d4SJoe Perches }; 2058f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2059f2d7e4d4SJoe Perches} 2060f2d7e4d4SJoe Perches 2061f2d7e4d4SJoe Perchessub fix_delete_line { 2062f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2063f2d7e4d4SJoe Perches 2064f2d7e4d4SJoe Perches my $deleted = { 2065f2d7e4d4SJoe Perches LINENR => $linenr, 2066f2d7e4d4SJoe Perches LINE => $line, 2067f2d7e4d4SJoe Perches }; 2068f2d7e4d4SJoe Perches 2069f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2070f2d7e4d4SJoe Perches} 2071f2d7e4d4SJoe Perches 2072de7d4f0eSAndy Whitcroftsub ERROR { 2073cbec18afSJoe Perches my ($type, $msg) = @_; 2074cbec18afSJoe Perches 2075cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2076de7d4f0eSAndy Whitcroft our $clean = 0; 20776c72ffaaSAndy Whitcroft our $cnt_error++; 20783705ce5bSJoe Perches return 1; 2079de7d4f0eSAndy Whitcroft } 20803705ce5bSJoe Perches return 0; 2081773647a0SAndy Whitcroft} 2082de7d4f0eSAndy Whitcroftsub WARN { 2083cbec18afSJoe Perches my ($type, $msg) = @_; 2084cbec18afSJoe Perches 2085cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2086de7d4f0eSAndy Whitcroft our $clean = 0; 20876c72ffaaSAndy Whitcroft our $cnt_warn++; 20883705ce5bSJoe Perches return 1; 2089de7d4f0eSAndy Whitcroft } 20903705ce5bSJoe Perches return 0; 2091773647a0SAndy Whitcroft} 2092de7d4f0eSAndy Whitcroftsub CHK { 2093cbec18afSJoe Perches my ($type, $msg) = @_; 2094cbec18afSJoe Perches 2095cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2096de7d4f0eSAndy Whitcroft our $clean = 0; 20976c72ffaaSAndy Whitcroft our $cnt_chk++; 20983705ce5bSJoe Perches return 1; 20996c72ffaaSAndy Whitcroft } 21003705ce5bSJoe Perches return 0; 2101de7d4f0eSAndy Whitcroft} 2102de7d4f0eSAndy Whitcroft 21036ecd9674SAndy Whitcroftsub check_absolute_file { 21046ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 21056ecd9674SAndy Whitcroft my $file = $absolute; 21066ecd9674SAndy Whitcroft 21076ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 21086ecd9674SAndy Whitcroft 21096ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 21106ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 21116ecd9674SAndy Whitcroft if (-f "$root/$file") { 21126ecd9674SAndy Whitcroft ##print "file<$file>\n"; 21136ecd9674SAndy Whitcroft last; 21146ecd9674SAndy Whitcroft } 21156ecd9674SAndy Whitcroft } 21166ecd9674SAndy Whitcroft if (! -f _) { 21176ecd9674SAndy Whitcroft return 0; 21186ecd9674SAndy Whitcroft } 21196ecd9674SAndy Whitcroft 21206ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 21216ecd9674SAndy Whitcroft my $prefix = $absolute; 21226ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 21236ecd9674SAndy Whitcroft 21246ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 21256ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2126000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2127000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 21286ecd9674SAndy Whitcroft } 21296ecd9674SAndy Whitcroft} 21306ecd9674SAndy Whitcroft 21313705ce5bSJoe Perchessub trim { 21323705ce5bSJoe Perches my ($string) = @_; 21333705ce5bSJoe Perches 2134b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2135b34c648bSJoe Perches 2136b34c648bSJoe Perches return $string; 2137b34c648bSJoe Perches} 2138b34c648bSJoe Perches 2139b34c648bSJoe Perchessub ltrim { 2140b34c648bSJoe Perches my ($string) = @_; 2141b34c648bSJoe Perches 2142b34c648bSJoe Perches $string =~ s/^\s+//; 2143b34c648bSJoe Perches 2144b34c648bSJoe Perches return $string; 2145b34c648bSJoe Perches} 2146b34c648bSJoe Perches 2147b34c648bSJoe Perchessub rtrim { 2148b34c648bSJoe Perches my ($string) = @_; 2149b34c648bSJoe Perches 2150b34c648bSJoe Perches $string =~ s/\s+$//; 21513705ce5bSJoe Perches 21523705ce5bSJoe Perches return $string; 21533705ce5bSJoe Perches} 21543705ce5bSJoe Perches 215552ea8506SJoe Perchessub string_find_replace { 215652ea8506SJoe Perches my ($string, $find, $replace) = @_; 215752ea8506SJoe Perches 215852ea8506SJoe Perches $string =~ s/$find/$replace/g; 215952ea8506SJoe Perches 216052ea8506SJoe Perches return $string; 216152ea8506SJoe Perches} 216252ea8506SJoe Perches 21633705ce5bSJoe Perchessub tabify { 21643705ce5bSJoe Perches my ($leading) = @_; 21653705ce5bSJoe Perches 21663705ce5bSJoe Perches my $source_indent = 8; 21673705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 21683705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 21693705ce5bSJoe Perches 21703705ce5bSJoe Perches #convert leading spaces to tabs 21713705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 21723705ce5bSJoe Perches #Remove spaces before a tab 21733705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 21743705ce5bSJoe Perches 21753705ce5bSJoe Perches return "$leading"; 21763705ce5bSJoe Perches} 21773705ce5bSJoe Perches 2178d1fe9c09SJoe Perchessub pos_last_openparen { 2179d1fe9c09SJoe Perches my ($line) = @_; 2180d1fe9c09SJoe Perches 2181d1fe9c09SJoe Perches my $pos = 0; 2182d1fe9c09SJoe Perches 2183d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2184d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2185d1fe9c09SJoe Perches 2186d1fe9c09SJoe Perches my $last_openparen = 0; 2187d1fe9c09SJoe Perches 2188d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2189d1fe9c09SJoe Perches return -1; 2190d1fe9c09SJoe Perches } 2191d1fe9c09SJoe Perches 2192d1fe9c09SJoe Perches my $len = length($line); 2193d1fe9c09SJoe Perches 2194d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2195d1fe9c09SJoe Perches my $string = substr($line, $pos); 2196d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2197d1fe9c09SJoe Perches $pos += length($1) - 1; 2198d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2199d1fe9c09SJoe Perches $last_openparen = $pos; 2200d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2201d1fe9c09SJoe Perches last; 2202d1fe9c09SJoe Perches } 2203d1fe9c09SJoe Perches } 2204d1fe9c09SJoe Perches 220591cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2206d1fe9c09SJoe Perches} 2207d1fe9c09SJoe Perches 22080a920b5bSAndy Whitcroftsub process { 22090a920b5bSAndy Whitcroft my $filename = shift; 22100a920b5bSAndy Whitcroft 22110a920b5bSAndy Whitcroft my $linenr=0; 22120a920b5bSAndy Whitcroft my $prevline=""; 2213c2fdda0dSAndy Whitcroft my $prevrawline=""; 22140a920b5bSAndy Whitcroft my $stashline=""; 2215c2fdda0dSAndy Whitcroft my $stashrawline=""; 22160a920b5bSAndy Whitcroft 22174a0df2efSAndy Whitcroft my $length; 22180a920b5bSAndy Whitcroft my $indent; 22190a920b5bSAndy Whitcroft my $previndent=0; 22200a920b5bSAndy Whitcroft my $stashindent=0; 22210a920b5bSAndy Whitcroft 2222de7d4f0eSAndy Whitcroft our $clean = 1; 22230a920b5bSAndy Whitcroft my $signoff = 0; 22240a920b5bSAndy Whitcroft my $is_patch = 0; 222529ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 222615662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 2227ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2228bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 22292a076f40SJoe Perches my $commit_log_long_line = 0; 2230e518e9a5SJoe Perches my $commit_log_has_diff = 0; 223113f1937eSJoe Perches my $reported_maintainer_file = 0; 2232fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2233fa64205dSPasi Savanainen 2234365dd4eaSJoe Perches my $last_blank_line = 0; 22355e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2236365dd4eaSJoe Perches 223713214adfSAndy Whitcroft our @report = (); 22386c72ffaaSAndy Whitcroft our $cnt_lines = 0; 22396c72ffaaSAndy Whitcroft our $cnt_error = 0; 22406c72ffaaSAndy Whitcroft our $cnt_warn = 0; 22416c72ffaaSAndy Whitcroft our $cnt_chk = 0; 22426c72ffaaSAndy Whitcroft 22430a920b5bSAndy Whitcroft # Trace the real file/line as we go. 22440a920b5bSAndy Whitcroft my $realfile = ''; 22450a920b5bSAndy Whitcroft my $realline = 0; 22460a920b5bSAndy Whitcroft my $realcnt = 0; 22470a920b5bSAndy Whitcroft my $here = ''; 224877cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 22490a920b5bSAndy Whitcroft my $in_comment = 0; 2250c2fdda0dSAndy Whitcroft my $comment_edge = 0; 22510a920b5bSAndy Whitcroft my $first_line = 0; 22521e855726SWolfram Sang my $p1_prefix = ''; 22530a920b5bSAndy Whitcroft 225413214adfSAndy Whitcroft my $prev_values = 'E'; 225513214adfSAndy Whitcroft 225613214adfSAndy Whitcroft # suppression flags 2257773647a0SAndy Whitcroft my %suppress_ifbraces; 2258170d3a22SAndy Whitcroft my %suppress_whiletrailers; 22592b474a1aSAndy Whitcroft my %suppress_export; 22603e469cdcSAndy Whitcroft my $suppress_statement = 0; 2261653d4876SAndy Whitcroft 22627e51f197SJoe Perches my %signatures = (); 2263323c1260SJoe Perches 2264c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2265de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2266c2fdda0dSAndy Whitcroft # 2267de7d4f0eSAndy Whitcroft my @setup_docs = (); 2268de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2269773647a0SAndy Whitcroft 2270d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2271d8b07710SJoe Perches 22729f3a8992SRob Herring my $checklicenseline = 1; 22739f3a8992SRob Herring 2274773647a0SAndy Whitcroft sanitise_line_reset(); 2275c2fdda0dSAndy Whitcroft my $line; 2276c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2277773647a0SAndy Whitcroft $linenr++; 2278773647a0SAndy Whitcroft $line = $rawline; 2279c2fdda0dSAndy Whitcroft 22803705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 22813705ce5bSJoe Perches 2282773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2283de7d4f0eSAndy Whitcroft $setup_docs = 0; 22848c27ceffSMauro Carvalho Chehab if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) { 2285de7d4f0eSAndy Whitcroft $setup_docs = 1; 2286de7d4f0eSAndy Whitcroft } 2287773647a0SAndy Whitcroft #next; 2288de7d4f0eSAndy Whitcroft } 228974fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2290773647a0SAndy Whitcroft $realline=$1-1; 2291773647a0SAndy Whitcroft if (defined $2) { 2292773647a0SAndy Whitcroft $realcnt=$3+1; 2293773647a0SAndy Whitcroft } else { 2294773647a0SAndy Whitcroft $realcnt=1+1; 2295773647a0SAndy Whitcroft } 2296c45dcabdSAndy Whitcroft $in_comment = 0; 2297773647a0SAndy Whitcroft 2298773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2299773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2300773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2301773647a0SAndy Whitcroft # at context start. 2302773647a0SAndy Whitcroft my $edge; 230301fa9147SAndy Whitcroft my $cnt = $realcnt; 230401fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 230501fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 230601fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 230701fa9147SAndy Whitcroft $cnt--; 230801fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2309721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2310fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2311fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2312fae17daeSAndy Whitcroft ($edge) = $1; 2313fae17daeSAndy Whitcroft last; 2314fae17daeSAndy Whitcroft } 2315773647a0SAndy Whitcroft } 2316773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2317773647a0SAndy Whitcroft $in_comment = 1; 2318773647a0SAndy Whitcroft } 2319773647a0SAndy Whitcroft 2320773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2321773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2322773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2323773647a0SAndy Whitcroft if (!defined $edge && 232483242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2325773647a0SAndy Whitcroft { 2326773647a0SAndy Whitcroft $in_comment = 1; 2327773647a0SAndy Whitcroft } 2328773647a0SAndy Whitcroft 2329773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2330773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2331773647a0SAndy Whitcroft 2332171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2333773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2334171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2335773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2336773647a0SAndy Whitcroft } 2337773647a0SAndy Whitcroft push(@lines, $line); 2338773647a0SAndy Whitcroft 2339773647a0SAndy Whitcroft if ($realcnt > 1) { 2340773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2341773647a0SAndy Whitcroft } else { 2342773647a0SAndy Whitcroft $realcnt = 0; 2343773647a0SAndy Whitcroft } 2344773647a0SAndy Whitcroft 2345773647a0SAndy Whitcroft #print "==>$rawline\n"; 2346773647a0SAndy Whitcroft #print "-->$line\n"; 2347de7d4f0eSAndy Whitcroft 2348de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2349de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2350de7d4f0eSAndy Whitcroft } 2351de7d4f0eSAndy Whitcroft } 2352de7d4f0eSAndy Whitcroft 23536c72ffaaSAndy Whitcroft $prefix = ''; 23546c72ffaaSAndy Whitcroft 2355773647a0SAndy Whitcroft $realcnt = 0; 2356773647a0SAndy Whitcroft $linenr = 0; 2357194f66fcSJoe Perches $fixlinenr = -1; 23580a920b5bSAndy Whitcroft foreach my $line (@lines) { 23590a920b5bSAndy Whitcroft $linenr++; 2360194f66fcSJoe Perches $fixlinenr++; 23611b5539b1SJoe Perches my $sline = $line; #copy of $line 23621b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 23630a920b5bSAndy Whitcroft 2364c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 23656c72ffaaSAndy Whitcroft 23660a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2367e518e9a5SJoe Perches if (!$in_commit_log && 236874fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 236974fd4f34SJoe Perches my $context = $4; 23700a920b5bSAndy Whitcroft $is_patch = 1; 23714a0df2efSAndy Whitcroft $first_line = $linenr + 1; 23720a920b5bSAndy Whitcroft $realline=$1-1; 23730a920b5bSAndy Whitcroft if (defined $2) { 23740a920b5bSAndy Whitcroft $realcnt=$3+1; 23750a920b5bSAndy Whitcroft } else { 23760a920b5bSAndy Whitcroft $realcnt=1+1; 23770a920b5bSAndy Whitcroft } 2378c2fdda0dSAndy Whitcroft annotate_reset(); 237913214adfSAndy Whitcroft $prev_values = 'E'; 238013214adfSAndy Whitcroft 2381773647a0SAndy Whitcroft %suppress_ifbraces = (); 2382170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 23832b474a1aSAndy Whitcroft %suppress_export = (); 23843e469cdcSAndy Whitcroft $suppress_statement = 0; 238574fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 238674fd4f34SJoe Perches $context_function = $1; 238774fd4f34SJoe Perches } else { 238874fd4f34SJoe Perches undef $context_function; 238974fd4f34SJoe Perches } 23900a920b5bSAndy Whitcroft next; 23910a920b5bSAndy Whitcroft 23924a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 23934a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 23944a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2395773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 23960a920b5bSAndy Whitcroft $realline++; 2397d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 23980a920b5bSAndy Whitcroft 23994a0df2efSAndy Whitcroft # Measure the line length and indent. 2400c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 24010a920b5bSAndy Whitcroft 24020a920b5bSAndy Whitcroft # Track the previous line. 24030a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 24040a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2405c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2406c2fdda0dSAndy Whitcroft 2407773647a0SAndy Whitcroft #warn "line<$line>\n"; 24086c72ffaaSAndy Whitcroft 2409d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2410d8aaf121SAndy Whitcroft $realcnt--; 24110a920b5bSAndy Whitcroft } 24120a920b5bSAndy Whitcroft 2413cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2414cc77cdcaSAndy Whitcroft 24156c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 24166c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2417773647a0SAndy Whitcroft 24182ac73b4fSJoe Perches my $found_file = 0; 2419773647a0SAndy Whitcroft # extract the filename as it passes 24203bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 24213bf9a009SRabin Vincent $realfile = $1; 24222b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2423270c49a0SJoe Perches $in_commit_log = 0; 24242ac73b4fSJoe Perches $found_file = 1; 24253bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2426773647a0SAndy Whitcroft $realfile = $1; 24272b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2428270c49a0SJoe Perches $in_commit_log = 0; 24291e855726SWolfram Sang 24301e855726SWolfram Sang $p1_prefix = $1; 2431e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2432e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2433000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2434000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 24351e855726SWolfram Sang } 2436773647a0SAndy Whitcroft 2437c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2438000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2439000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2440773647a0SAndy Whitcroft } 24412ac73b4fSJoe Perches $found_file = 1; 24422ac73b4fSJoe Perches } 24432ac73b4fSJoe Perches 244434d8815fSJoe Perches#make up the handle for any error we report on this line 244534d8815fSJoe Perches if ($showfile) { 244634d8815fSJoe Perches $prefix = "$realfile:$realline: " 244734d8815fSJoe Perches } elsif ($emacs) { 24487d3a9f67SJoe Perches if ($file) { 24497d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 24507d3a9f67SJoe Perches } else { 245134d8815fSJoe Perches $prefix = "$filename:$linenr: "; 245234d8815fSJoe Perches } 24537d3a9f67SJoe Perches } 245434d8815fSJoe Perches 24552ac73b4fSJoe Perches if ($found_file) { 245685b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 245785b0ee18SJoe Perches WARN("OBSOLETE", 245885b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 245985b0ee18SJoe Perches } 24607bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 24612ac73b4fSJoe Perches $check = 1; 24622ac73b4fSJoe Perches } else { 24632ac73b4fSJoe Perches $check = $check_orig; 24642ac73b4fSJoe Perches } 24659f3a8992SRob Herring $checklicenseline = 1; 2466773647a0SAndy Whitcroft next; 2467773647a0SAndy Whitcroft } 2468773647a0SAndy Whitcroft 2469389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 24700a920b5bSAndy Whitcroft 2471c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2472c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2473c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 24740a920b5bSAndy Whitcroft 24756c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 24766c72ffaaSAndy Whitcroft 2477e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2478e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2479e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2480e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2481e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2482e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2483e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2484e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2485e518e9a5SJoe Perches $commit_log_has_diff = 1; 2486e518e9a5SJoe Perches } 2487e518e9a5SJoe Perches 24883bf9a009SRabin Vincent# Check for incorrect file permissions 24893bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 24903bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 249104db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 249204db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2493000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2494000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 24953bf9a009SRabin Vincent } 24963bf9a009SRabin Vincent } 24973bf9a009SRabin Vincent 249820112475SJoe Perches# Check the patch for a signoff: 2499d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 25004a0df2efSAndy Whitcroft $signoff++; 250115662b3eSJoe Perches $in_commit_log = 0; 25020a920b5bSAndy Whitcroft } 250320112475SJoe Perches 2504e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2505e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2506e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2507e0d975b1SJoe Perches $reported_maintainer_file = 1; 2508e0d975b1SJoe Perches } 2509e0d975b1SJoe Perches 251020112475SJoe Perches# Check signature styles 2511270c49a0SJoe Perches if (!$in_header_lines && 2512ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 251320112475SJoe Perches my $space_before = $1; 251420112475SJoe Perches my $sign_off = $2; 251520112475SJoe Perches my $space_after = $3; 251620112475SJoe Perches my $email = $4; 251720112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 251820112475SJoe Perches 2519ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2520ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2521ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2522ce0338dfSJoe Perches } 252320112475SJoe Perches if (defined $space_before && $space_before ne "") { 25243705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 25253705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 25263705ce5bSJoe Perches $fix) { 2527194f66fcSJoe Perches $fixed[$fixlinenr] = 25283705ce5bSJoe Perches "$ucfirst_sign_off $email"; 25293705ce5bSJoe Perches } 253020112475SJoe Perches } 253120112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 25323705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 25333705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 25343705ce5bSJoe Perches $fix) { 2535194f66fcSJoe Perches $fixed[$fixlinenr] = 25363705ce5bSJoe Perches "$ucfirst_sign_off $email"; 25373705ce5bSJoe Perches } 25383705ce5bSJoe Perches 253920112475SJoe Perches } 254020112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 25413705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 25423705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 25433705ce5bSJoe Perches $fix) { 2544194f66fcSJoe Perches $fixed[$fixlinenr] = 25453705ce5bSJoe Perches "$ucfirst_sign_off $email"; 25463705ce5bSJoe Perches } 254720112475SJoe Perches } 254820112475SJoe Perches 254920112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 255020112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 255120112475SJoe Perches if ($suggested_email eq "") { 2552000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2553000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 255420112475SJoe Perches } else { 255520112475SJoe Perches my $dequoted = $suggested_email; 255620112475SJoe Perches $dequoted =~ s/^"//; 255720112475SJoe Perches $dequoted =~ s/" </ </; 255820112475SJoe Perches # Don't force email to have quotes 255920112475SJoe Perches # Allow just an angle bracketed address 256020112475SJoe Perches if ("$dequoted$comment" ne $email && 256120112475SJoe Perches "<$email_address>$comment" ne $email && 256220112475SJoe Perches "$suggested_email$comment" ne $email) { 2563000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2564000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 256520112475SJoe Perches } 25660a920b5bSAndy Whitcroft } 25677e51f197SJoe Perches 25687e51f197SJoe Perches# Check for duplicate signatures 25697e51f197SJoe Perches my $sig_nospace = $line; 25707e51f197SJoe Perches $sig_nospace =~ s/\s//g; 25717e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 25727e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 25737e51f197SJoe Perches WARN("BAD_SIGN_OFF", 25747e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 25757e51f197SJoe Perches } else { 25767e51f197SJoe Perches $signatures{$sig_nospace} = 1; 25777e51f197SJoe Perches } 25780a920b5bSAndy Whitcroft } 25790a920b5bSAndy Whitcroft 2580a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2581a2fe16b9SJoe Perches if ($in_header_lines && 2582a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2583a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2584a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2585a2fe16b9SJoe Perches } 2586a2fe16b9SJoe Perches 25879b3189ebSJoe Perches# Check for old stable address 25889b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 25899b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 25909b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 25919b3189ebSJoe Perches } 25929b3189ebSJoe Perches 25937ebd05efSChristopher Covington# Check for unwanted Gerrit info 25947ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 25957ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 25967ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 25977ebd05efSChristopher Covington } 25987ebd05efSChristopher Covington 2599369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2600369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2601369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2602369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2603369c8dd3SJoe Perches # timestamp 2604369c8dd3SJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) { 2605369c8dd3SJoe Perches # stack dump address 2606369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2607369c8dd3SJoe Perches } 2608369c8dd3SJoe Perches 26092a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 26102a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2611bf4daf12SJoe Perches length($line) > 75 && 2612bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2613bf4daf12SJoe Perches # file delta changes 2614bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2615bf4daf12SJoe Perches # filename then : 2616bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2617bf4daf12SJoe Perches # A Fixes: or Link: line 2618bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 26192a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 26202a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 26212a076f40SJoe Perches $commit_log_long_line = 1; 26222a076f40SJoe Perches } 26232a076f40SJoe Perches 2624bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2625bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2626bf4daf12SJoe Perches $line =~ /^\s*$/) { 2627bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2628bf4daf12SJoe Perches } 2629bf4daf12SJoe Perches 26300d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2631369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2632aab38f51SJoe Perches $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i && 2633e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 2634fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2635aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2636369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2637bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2638fe043ea1SJoe Perches my $init_char = "c"; 2639fe043ea1SJoe Perches my $orig_commit = ""; 26400d7835fcSJoe Perches my $short = 1; 26410d7835fcSJoe Perches my $long = 0; 26420d7835fcSJoe Perches my $case = 1; 26430d7835fcSJoe Perches my $space = 1; 26440d7835fcSJoe Perches my $hasdesc = 0; 264519c146a6SJoe Perches my $hasparens = 0; 26460d7835fcSJoe Perches my $id = '0123456789ab'; 26470d7835fcSJoe Perches my $orig_desc = "commit description"; 26480d7835fcSJoe Perches my $description = ""; 26490d7835fcSJoe Perches 2650fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2651fe043ea1SJoe Perches $init_char = $1; 2652fe043ea1SJoe Perches $orig_commit = lc($2); 2653fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2654fe043ea1SJoe Perches $orig_commit = lc($1); 2655fe043ea1SJoe Perches } 2656fe043ea1SJoe Perches 26570d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 26580d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 26590d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 26600d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 26610d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 26620d7835fcSJoe Perches $orig_desc = $1; 266319c146a6SJoe Perches $hasparens = 1; 26640d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 26650d7835fcSJoe Perches defined $rawlines[$linenr] && 26660d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 26670d7835fcSJoe Perches $orig_desc = $1; 266819c146a6SJoe Perches $hasparens = 1; 2669b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2670b671fde0SJoe Perches defined $rawlines[$linenr] && 2671b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2672b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2673b671fde0SJoe Perches $orig_desc = $1; 2674b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2675b671fde0SJoe Perches $orig_desc .= " " . $1; 267619c146a6SJoe Perches $hasparens = 1; 26770d7835fcSJoe Perches } 26780d7835fcSJoe Perches 26790d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 26800d7835fcSJoe Perches $id, $orig_desc); 26810d7835fcSJoe Perches 2682948b133aSHeinrich Schuchardt if (defined($id) && 2683948b133aSHeinrich Schuchardt ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { 2684d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 26850d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 26860d7835fcSJoe Perches } 2687d311cd44SJoe Perches } 2688d311cd44SJoe Perches 268913f1937eSJoe Perches# Check for added, moved or deleted files 269013f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 269113f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 269213f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 269313f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 269413f1937eSJoe Perches (defined($1) || defined($2))))) { 2695a82603a8SAndrew Jeffery $is_patch = 1; 269613f1937eSJoe Perches $reported_maintainer_file = 1; 269713f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 269813f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 269913f1937eSJoe Perches } 270013f1937eSJoe Perches 270100df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 27028905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2703000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2704000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 27056c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2706de7d4f0eSAndy Whitcroft } 2707de7d4f0eSAndy Whitcroft 2708de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2709de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2710171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2711171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2712171ae1a4SAndy Whitcroft 2713171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2714171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2715171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2716171ae1a4SAndy Whitcroft 271734d99219SJoe Perches CHK("INVALID_UTF8", 2718000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 271900df344fSAndy Whitcroft } 27200a920b5bSAndy Whitcroft 272115662b3eSJoe Perches# Check if it's the start of a commit log 272215662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 272315662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 2724eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 2725eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 272615662b3eSJoe Perches $in_header_lines = 0; 272715662b3eSJoe Perches $in_commit_log = 1; 2728ed43c4e5SAllen Hubbe $has_commit_log = 1; 272915662b3eSJoe Perches } 273015662b3eSJoe Perches 2731fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2732fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2733fa64205dSPasi Savanainen if ($in_header_lines && 2734fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2735fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2736fa64205dSPasi Savanainen $non_utf8_charset = 1; 2737fa64205dSPasi Savanainen } 2738fa64205dSPasi Savanainen 2739fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 274015662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2741fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 274215662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 274315662b3eSJoe Perches } 274415662b3eSJoe Perches 2745d6430f71SJoe Perches# Check for absolute kernel paths in commit message 2746d6430f71SJoe Perches if ($tree && $in_commit_log) { 2747d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 2748d6430f71SJoe Perches my $file = $1; 2749d6430f71SJoe Perches 2750d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 2751d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 2752d6430f71SJoe Perches # 2753d6430f71SJoe Perches } else { 2754d6430f71SJoe Perches check_absolute_file($file, $herecurr); 2755d6430f71SJoe Perches } 2756d6430f71SJoe Perches } 2757d6430f71SJoe Perches } 2758d6430f71SJoe Perches 275966b47b4aSKees Cook# Check for various typo / spelling mistakes 276066d7a382SJoe Perches if (defined($misspellings) && 276166d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2762ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 276366b47b4aSKees Cook my $typo = $1; 276466b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 276566b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 276666b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 27670675a8fbSJean Delvare my $msg_level = \&WARN; 27680675a8fbSJean Delvare $msg_level = \&CHK if ($file); 27690675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 277066b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 277166b47b4aSKees Cook $fix) { 277266b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 277366b47b4aSKees Cook } 277466b47b4aSKees Cook } 277566b47b4aSKees Cook } 277666b47b4aSKees Cook 277730670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 277830670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 277900df344fSAndy Whitcroft 27800a920b5bSAndy Whitcroft#trailing whitespace 27819c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2782c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2783d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2784d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2785d5e616fcSJoe Perches $fix) { 2786194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2787d5e616fcSJoe Perches } 2788c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2789c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 27903705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 27913705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 27923705ce5bSJoe Perches $fix) { 2793194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 27943705ce5bSJoe Perches } 27953705ce5bSJoe Perches 2796d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 27970a920b5bSAndy Whitcroft } 27985368df20SAndy Whitcroft 27994783f894SJosh Triplett# Check for FSF mailing addresses. 2800109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 28011bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 28023e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 28033e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 28044783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28050675a8fbSJean Delvare my $msg_level = \&ERROR; 28060675a8fbSJean Delvare $msg_level = \&CHK if ($file); 28070675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 28084783f894SJosh 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) 28094783f894SJosh Triplett } 28104783f894SJosh Triplett 28113354957aSAndi Kleen# check for Kconfig help text having a real description 28129fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 28139fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 28143354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 2815678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 2816678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 2817678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 2818678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 28193354957aSAndi Kleen my $length = 0; 28209fe287d7SAndy Whitcroft my $cnt = $realcnt; 28219fe287d7SAndy Whitcroft my $ln = $linenr + 1; 28229fe287d7SAndy Whitcroft my $f; 2823a1385803SAndy Whitcroft my $is_start = 0; 28249fe287d7SAndy Whitcroft my $is_end = 0; 2825a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 28269fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 28279fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 28289fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 28299fe287d7SAndy Whitcroft 28309fe287d7SAndy Whitcroft next if ($f =~ /^-/); 28318d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2832a1385803SAndy Whitcroft 283386adf1a0SUlf Magnusson if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 2834a1385803SAndy Whitcroft $is_start = 1; 283584af7a61SUlf Magnusson } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) { 283684af7a61SUlf Magnusson if ($lines[$ln - 1] =~ "---help---") { 283784af7a61SUlf Magnusson WARN("CONFIG_DESCRIPTION", 283884af7a61SUlf Magnusson "prefer 'help' over '---help---' for new help texts\n" . $herecurr); 283984af7a61SUlf Magnusson } 2840a1385803SAndy Whitcroft $length = -1; 2841a1385803SAndy Whitcroft } 2842a1385803SAndy Whitcroft 28439fe287d7SAndy Whitcroft $f =~ s/^.//; 28443354957aSAndi Kleen $f =~ s/#.*//; 28453354957aSAndi Kleen $f =~ s/^\s+//; 28463354957aSAndi Kleen next if ($f =~ /^$/); 2847678ae162SUlf Magnusson 2848678ae162SUlf Magnusson # This only checks context lines in the patch 2849678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 2850678ae162SUlf Magnusson # positives, even though some of these are 2851678ae162SUlf Magnusson # common words in help texts 2852678ae162SUlf Magnusson if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| 2853678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 28549fe287d7SAndy Whitcroft $is_end = 1; 28559fe287d7SAndy Whitcroft last; 28569fe287d7SAndy Whitcroft } 28573354957aSAndi Kleen $length++; 28583354957aSAndi Kleen } 285956193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2860000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 286156193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 286256193274SVadim Bendebury } 2863a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 28643354957aSAndi Kleen } 28653354957aSAndi Kleen 2866628f91a2SJoe Perches# check for MAINTAINERS entries that don't have the right form 2867628f91a2SJoe Perches if ($realfile =~ /^MAINTAINERS$/ && 2868628f91a2SJoe Perches $rawline =~ /^\+[A-Z]:/ && 2869628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 2870628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 2871628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 2872628f91a2SJoe Perches $fix) { 2873628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 2874628f91a2SJoe Perches } 2875628f91a2SJoe Perches } 2876628f91a2SJoe Perches 2877327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2878327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2879327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2880327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2881327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2882327953e9SChristoph Jaeger } 2883327953e9SChristoph Jaeger 2884c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2885c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2886c68e5878SArnaud Lacombe my $flag = $1; 2887c68e5878SArnaud Lacombe my $replacement = { 2888c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2889c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2890c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2891c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2892c68e5878SArnaud Lacombe }; 2893c68e5878SArnaud Lacombe 2894c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2895c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2896c68e5878SArnaud Lacombe } 2897c68e5878SArnaud Lacombe 2898bff5da43SRob Herring# check for DT compatible documentation 28997dd05b38SFlorian Vaussard if (defined $root && 29007dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 29017dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 29027dd05b38SFlorian Vaussard 2903bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2904bff5da43SRob Herring 2905cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2906cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2907cc93319bSFlorian Vaussard 2908bff5da43SRob Herring foreach my $compat (@compats) { 2909bff5da43SRob Herring my $compat2 = $compat; 2910185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2911185d566bSRob Herring my $compat3 = $compat; 2912185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2913185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2914bff5da43SRob Herring if ( $? >> 8 ) { 2915bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2916bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2917bff5da43SRob Herring } 2918bff5da43SRob Herring 29194fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 29204fbf32a6SFlorian Vaussard my $vendor = $1; 2921cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2922bff5da43SRob Herring if ( $? >> 8 ) { 2923bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2924cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2925bff5da43SRob Herring } 2926bff5da43SRob Herring } 2927bff5da43SRob Herring } 2928bff5da43SRob Herring 29299f3a8992SRob Herring# check for using SPDX license tag at beginning of files 29309f3a8992SRob Herring if ($realline == $checklicenseline) { 29319f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 29329f3a8992SRob Herring $checklicenseline = 2; 29339f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 29349f3a8992SRob Herring my $comment = ""; 29359f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 29369f3a8992SRob Herring $comment = '/*'; 29379f3a8992SRob Herring } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 29389f3a8992SRob Herring $comment = '//'; 29399f3a8992SRob Herring } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) { 29409f3a8992SRob Herring $comment = '#'; 29419f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 29429f3a8992SRob Herring $comment = '..'; 29439f3a8992SRob Herring } 29449f3a8992SRob Herring 29459f3a8992SRob Herring if ($comment !~ /^$/ && 29469f3a8992SRob Herring $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) { 29479f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 29489f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 29499f3a8992SRob Herring } 29509f3a8992SRob Herring } 29519f3a8992SRob Herring } 29529f3a8992SRob Herring 29535368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2954d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 29555368df20SAndy Whitcroft 295647e0c88bSJoe Perches# line length limit (with some exclusions) 295747e0c88bSJoe Perches# 295847e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 295947e0c88bSJoe Perches# logging functions like pr_info that end in a string 296047e0c88bSJoe Perches# lines with a single string 296147e0c88bSJoe Perches# #defines that are a single string 29622e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 296347e0c88bSJoe Perches# 296447e0c88bSJoe Perches# There are 3 different line length message types: 2965ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 296647e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 296747e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 296847e0c88bSJoe Perches# 296947e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 297047e0c88bSJoe Perches# 297147e0c88bSJoe Perches 2972b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 297347e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 297447e0c88bSJoe Perches 297547e0c88bSJoe Perches # Check the allowed long line types first 297647e0c88bSJoe Perches 297747e0c88bSJoe Perches # logging functions that end in a string that starts 297847e0c88bSJoe Perches # before $max_line_length 297947e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 298047e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 298147e0c88bSJoe Perches $msg_type = ""; 298247e0c88bSJoe Perches 298347e0c88bSJoe Perches # lines with only strings (w/ possible termination) 298447e0c88bSJoe Perches # #defines with only strings 298547e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 298647e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 298747e0c88bSJoe Perches $msg_type = ""; 298847e0c88bSJoe Perches 2989cc147506SJoe Perches # More special cases 2990cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 2991cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 2992d560a5f8SJoe Perches $msg_type = ""; 2993d560a5f8SJoe Perches 29942e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 29952e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 29962e4bbbc5SAndreas Brauchli $msg_type = ""; 29972e4bbbc5SAndreas Brauchli 299847e0c88bSJoe Perches # Otherwise set the alternate message types 299947e0c88bSJoe Perches 300047e0c88bSJoe Perches # a comment starts before $max_line_length 300147e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 300247e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 300347e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 300447e0c88bSJoe Perches 300547e0c88bSJoe Perches # a quoted string starts before $max_line_length 300647e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 300747e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 300847e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 300947e0c88bSJoe Perches } 301047e0c88bSJoe Perches 301147e0c88bSJoe Perches if ($msg_type ne "" && 301247e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 301347e0c88bSJoe Perches WARN($msg_type, 30146cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 30150a920b5bSAndy Whitcroft } 301647e0c88bSJoe Perches } 30170a920b5bSAndy Whitcroft 30188905a67cSAndy Whitcroft# check for adding lines without a newline. 30198905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 3020000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 3021000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 30228905a67cSAndy Whitcroft } 30238905a67cSAndy Whitcroft 3024b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3025de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 30260a920b5bSAndy Whitcroft 30270a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 30280a920b5bSAndy Whitcroft# more than 8 must use tabs. 3029c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3030c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3031c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3032d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 30333705ce5bSJoe Perches if (ERROR("CODE_INDENT", 30343705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 30353705ce5bSJoe Perches $fix) { 3036194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 30373705ce5bSJoe Perches } 30380a920b5bSAndy Whitcroft } 30390a920b5bSAndy Whitcroft 304008e44365SAlberto Panizzo# check for space before tabs. 304108e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 304208e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 30433705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 30443705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 30453705ce5bSJoe Perches $fix) { 3046194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3047d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 3048194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3049c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 30503705ce5bSJoe Perches } 305108e44365SAlberto Panizzo } 305208e44365SAlberto Panizzo 3053d1fe9c09SJoe Perches# check for && or || at the start of a line 3054d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 3055d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 3056d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 3057d1fe9c09SJoe Perches } 3058d1fe9c09SJoe Perches 3059a91e8994SJoe Perches# check indentation starts on a tab stop 3060a91e8994SJoe Perches if ($^V && $^V ge 5.10.0 && 3061bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3062a91e8994SJoe Perches my $indent = length($1); 3063a91e8994SJoe Perches if ($indent % 8) { 3064a91e8994SJoe Perches if (WARN("TABSTOP", 3065a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3066a91e8994SJoe Perches $fix) { 3067a91e8994SJoe Perches $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; 3068a91e8994SJoe Perches } 3069a91e8994SJoe Perches } 3070a91e8994SJoe Perches } 3071a91e8994SJoe Perches 3072d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 3073d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3074fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3075d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3076d1fe9c09SJoe Perches my $oldindent = $1; 3077d1fe9c09SJoe Perches my $rest = $2; 3078d1fe9c09SJoe Perches 3079d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3080d1fe9c09SJoe Perches if ($pos >= 0) { 3081b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3082b34a26f3SJoe Perches my $newindent = $2; 3083d1fe9c09SJoe Perches 3084d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3085d1fe9c09SJoe Perches "\t" x ($pos / 8) . 3086d1fe9c09SJoe Perches " " x ($pos % 8); 3087d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3088d1fe9c09SJoe Perches 3089d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3090d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 30913705ce5bSJoe Perches 30923705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 30933705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 30943705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3095194f66fcSJoe Perches $fixed[$fixlinenr] =~ 30963705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 30973705ce5bSJoe Perches } 3098d1fe9c09SJoe Perches } 3099d1fe9c09SJoe Perches } 3100d1fe9c09SJoe Perches } 3101d1fe9c09SJoe Perches 31026ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 31036ab3a970SJoe Perches# avoid checking a few false positives: 31046ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 31056ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 31066ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 31076ab3a970SJoe Perches# multiline macros that define functions 31086ab3a970SJoe Perches# known attributes or the __attribute__ keyword 31096ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 31106ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 31113705ce5bSJoe Perches if (CHK("SPACING", 3112f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 31133705ce5bSJoe Perches $fix) { 3114194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3115f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 31163705ce5bSJoe Perches } 3117aad4f614SJoe Perches } 3118aad4f614SJoe Perches 311986406b1cSJoe Perches# Block comment styles 312086406b1cSJoe Perches# Networking with an initial /* 312105880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3122fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 312385ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 312485ad978cSJoe Perches $realline > 2) { 312505880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 312605880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 312705880600SJoe Perches } 312805880600SJoe Perches 312986406b1cSJoe Perches# Block comments use * on subsequent lines 313086406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 313186406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3132a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 313361135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3134a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 313586406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 313686406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3137a605e32eSJoe Perches } 3138a605e32eSJoe Perches 313986406b1cSJoe Perches# Block comments use */ on trailing lines 314086406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3141c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3142c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3143c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 314486406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 314586406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 314605880600SJoe Perches } 314705880600SJoe Perches 314808eb9b80SJoe Perches# Block comment * alignment 314908eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3150af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3151af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3152af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 315308eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3154af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3155af207524SJoe Perches my $oldindent; 315608eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3157af207524SJoe Perches if (defined($1)) { 3158af207524SJoe Perches $oldindent = expand_tabs($1); 3159af207524SJoe Perches } else { 3160af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3161af207524SJoe Perches $oldindent = expand_tabs($1); 3162af207524SJoe Perches } 316308eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 316408eb9b80SJoe Perches my $newindent = $1; 316508eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3166af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 316708eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 316808eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 316908eb9b80SJoe Perches } 317008eb9b80SJoe Perches } 317108eb9b80SJoe Perches 31727f619191SJoe Perches# check for missing blank lines after struct/union declarations 31737f619191SJoe Perches# with exceptions for various attributes and macros 31747f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 31757f619191SJoe Perches $line =~ /^\+/ && 31767f619191SJoe Perches !($line =~ /^\+\s*$/ || 31777f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 31787f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 31797f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 31807f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 31817f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 31827f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 31830bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 31847f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3185d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3186d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3187d752fcc8SJoe Perches $fix) { 3188f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3189d752fcc8SJoe Perches } 31907f619191SJoe Perches } 31917f619191SJoe Perches 3192365dd4eaSJoe Perches# check for multiple consecutive blank lines 3193365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3194365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3195365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3196d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3197d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3198d752fcc8SJoe Perches $fix) { 3199f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3200d752fcc8SJoe Perches } 3201d752fcc8SJoe Perches 3202365dd4eaSJoe Perches $last_blank_line = $linenr; 3203365dd4eaSJoe Perches } 3204365dd4eaSJoe Perches 32053b617e3bSJoe Perches# check for missing blank lines after declarations 32063f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 32073f7bac03SJoe Perches # actual declarations 32083f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 32095a4e1fd3SJoe Perches # function pointer declarations 32105a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 32113f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 32123f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 32133f7bac03SJoe Perches # known declaration macros 32143f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 32153f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 32163f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 32173f7bac03SJoe Perches # other possible extensions of declaration lines 32183f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 32193f7bac03SJoe Perches # not starting a section or a macro "\" extended line 32203f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 32213f7bac03SJoe Perches # looks like a declaration 32223f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 32235a4e1fd3SJoe Perches # function pointer declarations 32245a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 32253f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 32263f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 32273f7bac03SJoe Perches # known declaration macros 32283f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 32293f7bac03SJoe Perches # start of struct or union or enum 32303b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 32313f7bac03SJoe Perches # start or end of block or continuation of declaration 32323f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 32333f7bac03SJoe Perches # bitfield continuation 32343f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 32353f7bac03SJoe Perches # other possible extensions of declaration lines 32363f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 32373f7bac03SJoe Perches # indentation of previous and current line are the same 32383f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3239d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3240d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3241d752fcc8SJoe Perches $fix) { 3242f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3243d752fcc8SJoe Perches } 32443b617e3bSJoe Perches } 32453b617e3bSJoe Perches 32465f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 32476b4c5bebSAndy Whitcroft# Exceptions: 32486b4c5bebSAndy Whitcroft# 1) within comments 32496b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 32506b4c5bebSAndy Whitcroft# 3) hanging labels 32513705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 32525f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 32533705ce5bSJoe Perches if (WARN("LEADING_SPACE", 32543705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 32553705ce5bSJoe Perches $fix) { 3256194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 32573705ce5bSJoe Perches } 32585f7ddae6SRaffaele Recalcati } 32595f7ddae6SRaffaele Recalcati 3260b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3261b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3262b9ea10d6SAndy Whitcroft 32635751a24eSJoe Perches# check for unusual line ending [ or ( 32645751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 32655751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 32665751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 32675751a24eSJoe Perches } 32685751a24eSJoe Perches 32694dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 32704dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 32714dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 32724dbed76fSJoe Perches $context_function = $1; 32734dbed76fSJoe Perches } 32744dbed76fSJoe Perches 32754dbed76fSJoe Perches# check if this appears to be the end of function declaration 32764dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 32774dbed76fSJoe Perches undef $context_function; 32784dbed76fSJoe Perches } 32794dbed76fSJoe Perches 3280032a4c0fSJoe Perches# check indentation of any line with a bare else 3281840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3282032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3283032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3284032a4c0fSJoe Perches my $tabs = length($1) + 1; 3285840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3286840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3287840080a0SJoe Perches defined $lines[$linenr] && 3288840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3289032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3290032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3291032a4c0fSJoe Perches } 3292032a4c0fSJoe Perches } 3293032a4c0fSJoe Perches 3294c00df19aSJoe Perches# check indentation of a line with a break; 3295c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3296c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3297c00df19aSJoe Perches my $tabs = $1; 3298c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3299c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3300c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3301c00df19aSJoe Perches } 3302c00df19aSJoe Perches } 3303c00df19aSJoe Perches 3304c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3305cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3306000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3307000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3308c2fdda0dSAndy Whitcroft } 330922f2a2efSAndy Whitcroft 331056e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 331156e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 331256e77d70SJoe Perches WARN("HOTPLUG_SECTION", 331356e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 331456e77d70SJoe Perches } 331556e77d70SJoe Perches 33169c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 33172b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 33182b474a1aSAndy Whitcroft $realline_next); 33193e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 3320ca819864SJoe Perches if ($linenr > $suppress_statement && 33211b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3322170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3323f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3324171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3325171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3326171ae1a4SAndy Whitcroft 33273e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 33283e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 33293e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 33303e469cdcSAndy Whitcroft # until we hit end of it. 33313e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 33323e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 33333e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 33343e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 33353e469cdcSAndy Whitcroft } 3336f74bd194SAndy Whitcroft 33372b474a1aSAndy Whitcroft # Find the real next line. 33382b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 33392b474a1aSAndy Whitcroft if (defined $realline_next && 33402b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 33412b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 33422b474a1aSAndy Whitcroft $realline_next++; 33432b474a1aSAndy Whitcroft } 33442b474a1aSAndy Whitcroft 3345171ae1a4SAndy Whitcroft my $s = $stat; 3346171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3347cf655043SAndy Whitcroft 3348c2fdda0dSAndy Whitcroft # Ignore goto labels. 3349171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3350c2fdda0dSAndy Whitcroft 3351c2fdda0dSAndy Whitcroft # Ignore functions being called 3352171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3353c2fdda0dSAndy Whitcroft 3354463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3355463f2864SAndy Whitcroft 3356c45dcabdSAndy Whitcroft # declarations always start with types 3357d2506586SAndy 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) { 3358c45dcabdSAndy Whitcroft my $type = $1; 3359c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3360c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3361c45dcabdSAndy Whitcroft 33626c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3363a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3364c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3365c2fdda0dSAndy Whitcroft } 33668905a67cSAndy Whitcroft 33676c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 336865863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3369c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 33709c0ca6f9SAndy Whitcroft } 33718905a67cSAndy Whitcroft 33728905a67cSAndy Whitcroft # Check for any sort of function declaration. 33738905a67cSAndy Whitcroft # int foo(something bar, other baz); 33748905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3375171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 33768905a67cSAndy Whitcroft my ($name_len) = length($1); 33778905a67cSAndy Whitcroft 3378cf655043SAndy Whitcroft my $ctx = $s; 3379773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 33808905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3381cf655043SAndy Whitcroft 33828905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3383c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 33848905a67cSAndy Whitcroft 3385c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 33868905a67cSAndy Whitcroft } 33878905a67cSAndy Whitcroft } 33888905a67cSAndy Whitcroft } 33898905a67cSAndy Whitcroft 33909c0ca6f9SAndy Whitcroft } 33919c0ca6f9SAndy Whitcroft 339200df344fSAndy Whitcroft# 339300df344fSAndy Whitcroft# Checks which may be anchored in the context. 339400df344fSAndy Whitcroft# 339500df344fSAndy Whitcroft 339600df344fSAndy Whitcroft# Check for switch () and associated case and default 339700df344fSAndy Whitcroft# statements should be at the same indent. 339800df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 339900df344fSAndy Whitcroft my $err = ''; 340000df344fSAndy Whitcroft my $sep = ''; 340100df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 340200df344fSAndy Whitcroft shift(@ctx); 340300df344fSAndy Whitcroft for my $ctx (@ctx) { 340400df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 340500df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 340600df344fSAndy Whitcroft $indent != $cindent) { 340700df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 340800df344fSAndy Whitcroft $sep = ''; 340900df344fSAndy Whitcroft } else { 341000df344fSAndy Whitcroft $sep = "[...]\n"; 341100df344fSAndy Whitcroft } 341200df344fSAndy Whitcroft } 341300df344fSAndy Whitcroft if ($err ne '') { 3414000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3415000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3416de7d4f0eSAndy Whitcroft } 3417de7d4f0eSAndy Whitcroft } 3418de7d4f0eSAndy Whitcroft 3419de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3420de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 34210fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3422773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3423773647a0SAndy Whitcroft 34249c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 34258eef05ddSJoe Perches 34268eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 34278eef05ddSJoe Perches WARN("DEEP_INDENTATION", 34288eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 34298eef05ddSJoe Perches } 34308eef05ddSJoe Perches 3431de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3432de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3433de7d4f0eSAndy Whitcroft 3434548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3435548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3436de7d4f0eSAndy Whitcroft 3437548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3438548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3439548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3440548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3441548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3442773647a0SAndy Whitcroft $ctx_ln++; 3443773647a0SAndy Whitcroft } 3444548596d5SAndy Whitcroft 344553210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 344653210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3447773647a0SAndy Whitcroft 3448773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3449000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3450000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 345101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 345200df344fSAndy Whitcroft } 3453773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3454773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3455773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3456773647a0SAndy Whitcroft { 34579c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 34589c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3459000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3460000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 346101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 34629c0ca6f9SAndy Whitcroft } 34639c0ca6f9SAndy Whitcroft } 346400df344fSAndy Whitcroft } 346500df344fSAndy Whitcroft 34664d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 3467f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 34683e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 34693e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 34703e469cdcSAndy Whitcroft if (!defined $stat); 34714d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 34724d001e4dSAndy Whitcroft 34734d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 34744d001e4dSAndy Whitcroft 34759f5af480SJoe Perches # remove inline comments 34769f5af480SJoe Perches $s =~ s/$;/ /g; 34779f5af480SJoe Perches $c =~ s/$;/ /g; 34784d001e4dSAndy Whitcroft 34794d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 34806f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 34816f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 34824d001e4dSAndy Whitcroft 34839f5af480SJoe Perches # Make sure we remove the line prefixes as we have 34849f5af480SJoe Perches # none on the first line, and are going to readd them 34859f5af480SJoe Perches # where necessary. 34869f5af480SJoe Perches $s =~ s/\n./\n/gs; 34879f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 34889f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 34899f5af480SJoe Perches } 34909f5af480SJoe Perches 34914d001e4dSAndy Whitcroft # We want to check the first line inside the block 34924d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 34934d001e4dSAndy Whitcroft # 1) any blank line termination 34944d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 34954d001e4dSAndy Whitcroft # 3) any do (...) { 34964d001e4dSAndy Whitcroft my $continuation = 0; 34974d001e4dSAndy Whitcroft my $check = 0; 34984d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 34994d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 35004d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 35014d001e4dSAndy Whitcroft $continuation = 1; 35024d001e4dSAndy Whitcroft } 35039bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 35044d001e4dSAndy Whitcroft $check = 1; 35054d001e4dSAndy Whitcroft $cond_lines++; 35064d001e4dSAndy Whitcroft } 35074d001e4dSAndy Whitcroft 35084d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 35094d001e4dSAndy Whitcroft # preprocessor statement. 35104d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 35114d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 35124d001e4dSAndy Whitcroft $check = 0; 35134d001e4dSAndy Whitcroft } 35144d001e4dSAndy Whitcroft 35159bd49efeSAndy Whitcroft my $cond_ptr = -1; 3516740504c6SAndy Whitcroft $continuation = 0; 35179bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 35189bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 35194d001e4dSAndy Whitcroft 3520f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3521f16fa28fSAndy Whitcroft # is not linear. 3522f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3523f16fa28fSAndy Whitcroft $check = 0; 3524f16fa28fSAndy Whitcroft } 3525f16fa28fSAndy Whitcroft 35269bd49efeSAndy Whitcroft # Ignore: 35279bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 35289bd49efeSAndy Whitcroft # 2) preprocessor lines, and 35299bd49efeSAndy Whitcroft # 3) labels. 3530740504c6SAndy Whitcroft if ($continuation || 3531740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 35329bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 35339bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3534740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 353530dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 35369bd49efeSAndy Whitcroft $cond_lines++; 35379bd49efeSAndy Whitcroft } 35384d001e4dSAndy Whitcroft } 353930dad6ebSAndy Whitcroft } 35404d001e4dSAndy Whitcroft 35414d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 35424d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 35434d001e4dSAndy Whitcroft 35444d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 35454d001e4dSAndy Whitcroft # this is not this patch's fault. 35464d001e4dSAndy Whitcroft if (!defined($stat_real) || 35474d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 35484d001e4dSAndy Whitcroft $check = 0; 35494d001e4dSAndy Whitcroft } 35504d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 35514d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 35524d001e4dSAndy Whitcroft } 35534d001e4dSAndy Whitcroft 35549bd49efeSAndy 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"; 35554d001e4dSAndy Whitcroft 35569f5af480SJoe Perches if ($check && $s ne '' && 35579f5af480SJoe Perches (($sindent % 8) != 0 || 35589f5af480SJoe Perches ($sindent < $indent) || 3559f6950a73SJoe Perches ($sindent == $indent && 3560f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 35619f5af480SJoe Perches ($sindent > $indent + 8))) { 3562000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3563000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 35644d001e4dSAndy Whitcroft } 35654d001e4dSAndy Whitcroft } 35664d001e4dSAndy Whitcroft 35676c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 35686c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 35691f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 35701f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 35716c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3572c2fdda0dSAndy Whitcroft if ($dbg_values) { 3573c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3574cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3575cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 35761f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3577c2fdda0dSAndy Whitcroft } 35786c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 35796c72ffaaSAndy Whitcroft 358000df344fSAndy Whitcroft#ignore lines not being added 35813705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 358200df344fSAndy Whitcroft 358311ca40a0SJoe Perches# check for dereferences that span multiple lines 358411ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 358511ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 358611ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 358711ca40a0SJoe Perches my $ref = $1; 358811ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 358911ca40a0SJoe Perches $ref .= $1; 359011ca40a0SJoe Perches $ref =~ s/\s//g; 359111ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 359211ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 359311ca40a0SJoe Perches } 359411ca40a0SJoe Perches 3595a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3596c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3597a1ce18e4SJoe Perches my $type = $1; 3598a1ce18e4SJoe Perches my $var = $2; 3599207a8e84SJoe Perches $var = "" if (!defined $var); 3600207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3601a1ce18e4SJoe Perches my $sign = $1; 3602a1ce18e4SJoe Perches my $pointer = $2; 3603a1ce18e4SJoe Perches 3604a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3605a1ce18e4SJoe Perches 3606a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3607a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3608a1ce18e4SJoe Perches $fix) { 3609a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3610207a8e84SJoe Perches my $comp_pointer = $pointer; 3611207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 3612207a8e84SJoe Perches $decl .= $comp_pointer; 3613207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 3614207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 3615a1ce18e4SJoe Perches } 3616a1ce18e4SJoe Perches } 3617a1ce18e4SJoe Perches } 3618a1ce18e4SJoe Perches 3619653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 36207429c690SAndy Whitcroft if ($dbg_type) { 36217429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3622000d1cc1SJoe Perches ERROR("TEST_TYPE", 3623000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 36247429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3625000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3626000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 36277429c690SAndy Whitcroft } 3628653d4876SAndy Whitcroft next; 3629653d4876SAndy Whitcroft } 3630a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3631a1ef277eSAndy Whitcroft if ($dbg_attr) { 36329360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3633000d1cc1SJoe Perches ERROR("TEST_ATTR", 3634000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 36359360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3636000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3637000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3638a1ef277eSAndy Whitcroft } 3639a1ef277eSAndy Whitcroft next; 3640a1ef277eSAndy Whitcroft } 3641653d4876SAndy Whitcroft 3642f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 364399423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 364499423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3645d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3646d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3647f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3648f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3649f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3650d752fcc8SJoe Perches my $fixedline = $prevrawline; 3651d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3652f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3653d752fcc8SJoe Perches $fixedline = $line; 36548d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 3655f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3656d752fcc8SJoe Perches } 3657f0a594c1SAndy Whitcroft } 3658f0a594c1SAndy Whitcroft 365900df344fSAndy Whitcroft# 366000df344fSAndy Whitcroft# Checks which are anchored on the added line. 366100df344fSAndy Whitcroft# 366200df344fSAndy Whitcroft 3663653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3664c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3665653d4876SAndy Whitcroft my $path = $1; 3666653d4876SAndy Whitcroft if ($path =~ m{//}) { 3667000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3668495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3669495e9d84SJoe Perches } 3670495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3671495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3672495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3673653d4876SAndy Whitcroft } 3674653d4876SAndy Whitcroft } 3675653d4876SAndy Whitcroft 367600df344fSAndy Whitcroft# no C99 // comments 367700df344fSAndy Whitcroft if ($line =~ m{//}) { 36783705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 36793705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 36803705ce5bSJoe Perches $fix) { 3681194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 36823705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 36833705ce5bSJoe Perches my $comment = trim($1); 3684194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 36853705ce5bSJoe Perches } 36863705ce5bSJoe Perches } 368700df344fSAndy Whitcroft } 368800df344fSAndy Whitcroft # Remove C99 comments. 36890a920b5bSAndy Whitcroft $line =~ s@//.*@@; 36906c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 36910a920b5bSAndy Whitcroft 36922b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 36932b474a1aSAndy Whitcroft# the whole statement. 36942b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 36952b474a1aSAndy Whitcroft if (defined $realline_next && 36962b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 36972b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 36982b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 36992b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 37003cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 37013cbf62dfSAndy Whitcroft # a prefix: 37023cbf62dfSAndy Whitcroft # XXX(foo); 37033cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3704653d4876SAndy Whitcroft my $name = $1; 370587a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 37063cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 37073cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 37083cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 37093cbf62dfSAndy Whitcroft 37103cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 37112b474a1aSAndy Whitcroft \n.}\s*$| 371248012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 371348012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 371448012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 37152b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 37162b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 371748012058SAndy Whitcroft )/x) { 37182b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 37192b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 37202b474a1aSAndy Whitcroft } else { 37212b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 37220a920b5bSAndy Whitcroft } 37230a920b5bSAndy Whitcroft } 37242b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 37252b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 37262b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 37272b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 37282b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 37292b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 37302b474a1aSAndy Whitcroft } 37312b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 37322b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3733000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3734000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 37352b474a1aSAndy Whitcroft } 37360a920b5bSAndy Whitcroft 37375150bda4SJoe Eloff# check for global initialisers. 37386d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 3739d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 37406d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 3741d5e616fcSJoe Perches $fix) { 37426d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 3743d5e616fcSJoe Perches } 3744f0a594c1SAndy Whitcroft } 37450a920b5bSAndy Whitcroft# check for static initialisers. 37466d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 3747d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 37486d32f7a3SJoe Perches "do not initialise statics to $1\n" . 3749d5e616fcSJoe Perches $herecurr) && 3750d5e616fcSJoe Perches $fix) { 37516d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 3752d5e616fcSJoe Perches } 37530a920b5bSAndy Whitcroft } 37540a920b5bSAndy Whitcroft 37551813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 37561813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 37571813087dSJoe Perches my $tmp = trim($1); 37581813087dSJoe Perches WARN("MISORDERED_TYPE", 37591813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 37601813087dSJoe Perches } 37611813087dSJoe Perches 3762cb710ecaSJoe Perches# check for static const char * arrays. 3763cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3764000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3765000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3766cb710ecaSJoe Perches $herecurr); 3767cb710ecaSJoe Perches } 3768cb710ecaSJoe Perches 3769cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3770cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3771000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3772000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3773cb710ecaSJoe Perches $herecurr); 3774cb710ecaSJoe Perches } 3775cb710ecaSJoe Perches 3776ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3777ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3778ab7e23f3SJoe Perches my $found = $1; 3779ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3780ab7e23f3SJoe Perches WARN("CONST_CONST", 3781ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3782ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3783ab7e23f3SJoe Perches WARN("CONST_CONST", 3784ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3785ab7e23f3SJoe Perches } 3786ab7e23f3SJoe Perches } 3787ab7e23f3SJoe Perches 37889b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 37899b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 37909b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 37919b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 37929b0fa60dSJoe Perches $herecurr); 37939b0fa60dSJoe Perches } 37949b0fa60dSJoe Perches 3795b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3796b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3797b598b670SJoe Perches my $array = $1; 3798b598b670SJoe 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*\))@) { 3799b598b670SJoe Perches my $array_div = $1; 3800b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3801b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3802b598b670SJoe Perches $fix) { 3803b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3804b598b670SJoe Perches } 3805b598b670SJoe Perches } 3806b598b670SJoe Perches } 3807b598b670SJoe Perches 3808b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3809b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3810b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3811b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3812b36190c5SJoe Perches $fix) { 3813194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3814b36190c5SJoe Perches } 3815b36190c5SJoe Perches } 3816b36190c5SJoe Perches 3817653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3818653d4876SAndy Whitcroft# make sense. 3819653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 38208054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3821c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 38228ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 382346d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 3824000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3825000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 38260a920b5bSAndy Whitcroft } 38270a920b5bSAndy Whitcroft 38280a920b5bSAndy Whitcroft# * goes on variable not on type 382965863862SAndy Whitcroft # (char*[ const]) 3830bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3831bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 38323705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3833d8aaf121SAndy Whitcroft 383465863862SAndy Whitcroft # Should start with a space. 383565863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 383665863862SAndy Whitcroft # Should not end with a space. 383765863862SAndy Whitcroft $to =~ s/\s+$//; 383865863862SAndy Whitcroft # '*'s should not have spaces between. 3839f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 384065863862SAndy Whitcroft } 3841d8aaf121SAndy Whitcroft 38423705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 384365863862SAndy Whitcroft if ($from ne $to) { 38443705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 38453705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 38463705ce5bSJoe Perches $fix) { 38473705ce5bSJoe Perches my $sub_from = $ident; 38483705ce5bSJoe Perches my $sub_to = $ident; 38493705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3850194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38513705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 38523705ce5bSJoe Perches } 385365863862SAndy Whitcroft } 3854bfcb2cc7SAndy Whitcroft } 3855bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3856bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 38573705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3858d8aaf121SAndy Whitcroft 385965863862SAndy Whitcroft # Should start with a space. 386065863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 386165863862SAndy Whitcroft # Should not end with a space. 386265863862SAndy Whitcroft $to =~ s/\s+$//; 386365863862SAndy Whitcroft # '*'s should not have spaces between. 3864f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 386565863862SAndy Whitcroft } 386665863862SAndy Whitcroft # Modifiers should have spaces. 386765863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 386865863862SAndy Whitcroft 38693705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3870667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 38713705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 38723705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 38733705ce5bSJoe Perches $fix) { 38743705ce5bSJoe Perches 38753705ce5bSJoe Perches my $sub_from = $match; 38763705ce5bSJoe Perches my $sub_to = $match; 38773705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3878194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38793705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 38803705ce5bSJoe Perches } 388165863862SAndy Whitcroft } 38820a920b5bSAndy Whitcroft } 38830a920b5bSAndy Whitcroft 38849d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 38859d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 38860675a8fbSJean Delvare my $msg_level = \&WARN; 38870675a8fbSJean Delvare $msg_level = \&CHK if ($file); 38880675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 38899d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 38909d3e3c70SJoe Perches } 38910a920b5bSAndy Whitcroft 38929d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 38938905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3894000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3895000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 38968905a67cSAndy Whitcroft } 38978905a67cSAndy Whitcroft 389817441227SJoe Perches# check for uses of printk_ratelimit 389917441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3900000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3901000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 390217441227SJoe Perches } 390317441227SJoe Perches 3904eeef5733SJoe Perches# printk should use KERN_* levels 3905eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 3906000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3907eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 390800df344fSAndy Whitcroft } 39090a920b5bSAndy Whitcroft 3910243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3911243f3803SJoe Perches my $orig = $1; 3912243f3803SJoe Perches my $level = lc($orig); 3913243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 39148f26b837SJoe Perches my $level2 = $level; 39158f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3916243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3917daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3918243f3803SJoe Perches } 3919243f3803SJoe Perches 3920243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3921d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3922d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3923d5e616fcSJoe Perches $fix) { 3924194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3925d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3926d5e616fcSJoe Perches } 3927243f3803SJoe Perches } 3928243f3803SJoe Perches 3929dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3930dc139313SJoe Perches my $orig = $1; 3931dc139313SJoe Perches my $level = lc($orig); 3932dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3933dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3934dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3935dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3936dc139313SJoe Perches } 3937dc139313SJoe Perches 393891c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 393991c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 394091c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 394191c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 394291c9afafSAndy Lutomirski WARN("ENOSYS", 394391c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 394491c9afafSAndy Lutomirski } 394591c9afafSAndy Lutomirski 3946653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3947653d4876SAndy Whitcroft# or if closed on same line 39482d453e3bSJoe Perches if ($^V && $^V ge 5.10.0 && 39492d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 39502d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 39512d453e3bSJoe Perches $sline !~ /}/) { 39528d182478SJoe Perches if (ERROR("OPEN_BRACE", 39532d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 39548d182478SJoe Perches $fix) { 39558d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 39568d182478SJoe Perches my $fixed_line = $rawline; 39578d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 39588d182478SJoe Perches my $line1 = $1; 39598d182478SJoe Perches my $line2 = $2; 39608d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 39618d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 39628d182478SJoe Perches if ($line2 !~ /^\s*$/) { 39638d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 39648d182478SJoe Perches } 39658d182478SJoe Perches } 39660a920b5bSAndy Whitcroft } 3967653d4876SAndy Whitcroft 39688905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 39698905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 39708905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 39718d182478SJoe Perches if (ERROR("OPEN_BRACE", 39728d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 39738d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 39748d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 39758d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 39768d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 39778d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 39788d182478SJoe Perches $fixedline = $rawline; 39798d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 39808d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 39818d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 39828d182478SJoe Perches } 39838d182478SJoe Perches } 39848905a67cSAndy Whitcroft } 39858905a67cSAndy Whitcroft 39860c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 39873705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 39883705ce5bSJoe Perches if (WARN("SPACING", 39893705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 39903705ce5bSJoe Perches $fix) { 3991194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39923705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 39933705ce5bSJoe Perches } 39940c73b4ebSAndy Whitcroft } 39950c73b4ebSAndy Whitcroft 399631070b5dSJoe Perches# Function pointer declarations 399731070b5dSJoe Perches# check spacing between type, funcptr, and args 399831070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 399991f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 400031070b5dSJoe Perches my $declare = $1; 400131070b5dSJoe Perches my $pre_pointer_space = $2; 400231070b5dSJoe Perches my $post_pointer_space = $3; 400331070b5dSJoe Perches my $funcname = $4; 400431070b5dSJoe Perches my $post_funcname_space = $5; 400531070b5dSJoe Perches my $pre_args_space = $6; 400631070b5dSJoe Perches 400791f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 400891f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 400991f72e9cSJoe Perches# don't need a space so don't warn for those. 401091f72e9cSJoe Perches my $post_declare_space = ""; 401191f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 401291f72e9cSJoe Perches $post_declare_space = $1; 401391f72e9cSJoe Perches $declare = rtrim($declare); 401491f72e9cSJoe Perches } 401591f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 401631070b5dSJoe Perches WARN("SPACING", 401731070b5dSJoe Perches "missing space after return type\n" . $herecurr); 401891f72e9cSJoe Perches $post_declare_space = " "; 401931070b5dSJoe Perches } 402031070b5dSJoe Perches 402131070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 402291f72e9cSJoe Perches# This test is not currently implemented because these declarations are 402391f72e9cSJoe Perches# equivalent to 402491f72e9cSJoe Perches# int foo(int bar, ...) 402591f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 402691f72e9cSJoe Perches# 402791f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 402891f72e9cSJoe Perches# WARN("SPACING", 402991f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 403091f72e9cSJoe Perches# } 403131070b5dSJoe Perches 403231070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 403331070b5dSJoe Perches if (defined $pre_pointer_space && 403431070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 403531070b5dSJoe Perches WARN("SPACING", 403631070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 403731070b5dSJoe Perches } 403831070b5dSJoe Perches 403931070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 404031070b5dSJoe Perches if (defined $post_pointer_space && 404131070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 404231070b5dSJoe Perches WARN("SPACING", 404331070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 404431070b5dSJoe Perches } 404531070b5dSJoe Perches 404631070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 404731070b5dSJoe Perches if (defined $post_funcname_space && 404831070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 404931070b5dSJoe Perches WARN("SPACING", 405031070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 405131070b5dSJoe Perches } 405231070b5dSJoe Perches 405331070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 405431070b5dSJoe Perches if (defined $pre_args_space && 405531070b5dSJoe Perches $pre_args_space =~ /^\s/) { 405631070b5dSJoe Perches WARN("SPACING", 405731070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 405831070b5dSJoe Perches } 405931070b5dSJoe Perches 406031070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4061194f66fcSJoe Perches $fixed[$fixlinenr] =~ 406291f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 406331070b5dSJoe Perches } 406431070b5dSJoe Perches } 406531070b5dSJoe Perches 40668d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 40678d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4068fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4069fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 40708d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 40718d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 40728d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4073fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 4074daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 40753705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 40763705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 40773705ce5bSJoe Perches $fix) { 4078194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40793705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 40803705ce5bSJoe Perches } 40818d31cfceSAndy Whitcroft } 40828d31cfceSAndy Whitcroft } 40838d31cfceSAndy Whitcroft 4084f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 40856c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4086c2fdda0dSAndy Whitcroft my $name = $1; 4087773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4088773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4089c2fdda0dSAndy Whitcroft 4090c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4091773647a0SAndy Whitcroft if ($name =~ /^(?: 4092773647a0SAndy Whitcroft if|for|while|switch|return|case| 4093773647a0SAndy Whitcroft volatile|__volatile__| 4094773647a0SAndy Whitcroft __attribute__|format|__extension__| 4095773647a0SAndy Whitcroft asm|__asm__)$/x) 4096773647a0SAndy Whitcroft { 4097c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4098c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4099c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4100c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4101773647a0SAndy Whitcroft 4102773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4103c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4104c2fdda0dSAndy Whitcroft 4105c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4106c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4107773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4108c2fdda0dSAndy Whitcroft 4109c2fdda0dSAndy Whitcroft } else { 41103705ce5bSJoe Perches if (WARN("SPACING", 41113705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 41123705ce5bSJoe Perches $fix) { 4113194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41143705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 41153705ce5bSJoe Perches } 4116f0a594c1SAndy Whitcroft } 41176c72ffaaSAndy Whitcroft } 41189a4cad4eSEric Nelson 4119653d4876SAndy Whitcroft# Check operator spacing. 41200a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 41213705ce5bSJoe Perches my $fixed_line = ""; 41223705ce5bSJoe Perches my $line_fixed = 0; 41233705ce5bSJoe Perches 41249c0ca6f9SAndy Whitcroft my $ops = qr{ 41259c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 41269c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 41279c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 41281f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 412984731623SJoe Perches \?:|\?|: 41309c0ca6f9SAndy Whitcroft }x; 4131cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 41323705ce5bSJoe Perches 41333705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 41343705ce5bSJoe Perches## foreach my $el (@elements) { 41353705ce5bSJoe Perches## print("el: <$el>\n"); 41363705ce5bSJoe Perches## } 41373705ce5bSJoe Perches 41383705ce5bSJoe Perches my @fix_elements = (); 413900df344fSAndy Whitcroft my $off = 0; 41406c72ffaaSAndy Whitcroft 41413705ce5bSJoe Perches foreach my $el (@elements) { 41423705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 41433705ce5bSJoe Perches $off += length($el); 41443705ce5bSJoe Perches } 41453705ce5bSJoe Perches 41463705ce5bSJoe Perches $off = 0; 41473705ce5bSJoe Perches 41486c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4149b34c648bSJoe Perches my $last_after = -1; 41506c72ffaaSAndy Whitcroft 41510a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 41523705ce5bSJoe Perches 41533705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 41543705ce5bSJoe Perches 41553705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 41563705ce5bSJoe Perches 41574a0df2efSAndy Whitcroft $off += length($elements[$n]); 41584a0df2efSAndy Whitcroft 415925985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4160773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4161773647a0SAndy Whitcroft my $cc = ''; 4162773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4163773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4164773647a0SAndy Whitcroft } 4165773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4166773647a0SAndy Whitcroft 41674a0df2efSAndy Whitcroft my $a = ''; 41684a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 41694a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4170cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 41714a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 41724a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 4173773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 41744a0df2efSAndy Whitcroft 41750a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 41764a0df2efSAndy Whitcroft 41774a0df2efSAndy Whitcroft my $c = ''; 41780a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 41794a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 41804a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4181cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 41824a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 41834a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 41848b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 41854a0df2efSAndy Whitcroft } else { 41864a0df2efSAndy Whitcroft $c = 'E'; 41870a920b5bSAndy Whitcroft } 41880a920b5bSAndy Whitcroft 41894a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 41904a0df2efSAndy Whitcroft 41914a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 41924a0df2efSAndy Whitcroft 41936c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 4194de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 41950a920b5bSAndy Whitcroft 419674048ed8SAndy Whitcroft # Pull out the value of this operator. 41976c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 41980a920b5bSAndy Whitcroft 41991f65f947SAndy Whitcroft # Get the full operator variant. 42001f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 42011f65f947SAndy Whitcroft 420213214adfSAndy Whitcroft # Ignore operators passed as parameters. 420313214adfSAndy Whitcroft if ($op_type ne 'V' && 4204d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 420513214adfSAndy Whitcroft 4206cf655043SAndy Whitcroft# # Ignore comments 4207cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 420813214adfSAndy Whitcroft 4209d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 421013214adfSAndy Whitcroft } elsif ($op eq ';') { 4211cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 4212cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 42133705ce5bSJoe Perches if (ERROR("SPACING", 42143705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 4215b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 42163705ce5bSJoe Perches $line_fixed = 1; 42173705ce5bSJoe Perches } 4218d8aaf121SAndy Whitcroft } 4219d8aaf121SAndy Whitcroft 4220d8aaf121SAndy Whitcroft # // is a comment 4221d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 42220a920b5bSAndy Whitcroft 4223b00e4814SJoe Perches # : when part of a bitfield 4224b00e4814SJoe Perches } elsif ($opv eq ':B') { 4225b00e4814SJoe Perches # skip the bitfield test for now 4226b00e4814SJoe Perches 42271f65f947SAndy Whitcroft # No spaces for: 42281f65f947SAndy Whitcroft # -> 4229b00e4814SJoe Perches } elsif ($op eq '->') { 42304a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 42313705ce5bSJoe Perches if (ERROR("SPACING", 42323705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4233b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 42343705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 42353705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 42363705ce5bSJoe Perches } 4237b34c648bSJoe Perches $line_fixed = 1; 42383705ce5bSJoe Perches } 42390a920b5bSAndy Whitcroft } 42400a920b5bSAndy Whitcroft 42412381097bSJoe Perches # , must not have a space before and must have a space on the right. 42420a920b5bSAndy Whitcroft } elsif ($op eq ',') { 42432381097bSJoe Perches my $rtrim_before = 0; 42442381097bSJoe Perches my $space_after = 0; 42452381097bSJoe Perches if ($ctx =~ /Wx./) { 42462381097bSJoe Perches if (ERROR("SPACING", 42472381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 42482381097bSJoe Perches $line_fixed = 1; 42492381097bSJoe Perches $rtrim_before = 1; 42502381097bSJoe Perches } 42512381097bSJoe Perches } 4252cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 42533705ce5bSJoe Perches if (ERROR("SPACING", 42543705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 42553705ce5bSJoe Perches $line_fixed = 1; 4256b34c648bSJoe Perches $last_after = $n; 42572381097bSJoe Perches $space_after = 1; 42582381097bSJoe Perches } 42592381097bSJoe Perches } 42602381097bSJoe Perches if ($rtrim_before || $space_after) { 42612381097bSJoe Perches if ($rtrim_before) { 42622381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 42632381097bSJoe Perches } else { 42642381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 42652381097bSJoe Perches } 42662381097bSJoe Perches if ($space_after) { 42672381097bSJoe Perches $good .= " "; 42683705ce5bSJoe Perches } 42690a920b5bSAndy Whitcroft } 42700a920b5bSAndy Whitcroft 42719c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 427274048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 42739c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 42749c0ca6f9SAndy Whitcroft 42759c0ca6f9SAndy Whitcroft # unary operators should have a space before and 42769c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 42779c0ca6f9SAndy Whitcroft # unary operator, or a cast 42789c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 427974048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 42800d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4281cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 42823705ce5bSJoe Perches if (ERROR("SPACING", 42833705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4284b34c648bSJoe Perches if ($n != $last_after + 2) { 4285b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 42863705ce5bSJoe Perches $line_fixed = 1; 42873705ce5bSJoe Perches } 42880a920b5bSAndy Whitcroft } 4289b34c648bSJoe Perches } 4290a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4291171ae1a4SAndy Whitcroft # A unary '*' may be const 4292171ae1a4SAndy Whitcroft 4293171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 42943705ce5bSJoe Perches if (ERROR("SPACING", 42953705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4296b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 42973705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 42983705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 42993705ce5bSJoe Perches } 4300b34c648bSJoe Perches $line_fixed = 1; 43013705ce5bSJoe Perches } 43020a920b5bSAndy Whitcroft } 43030a920b5bSAndy Whitcroft 43040a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 43050a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4306773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 43073705ce5bSJoe Perches if (ERROR("SPACING", 43083705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4309b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 43103705ce5bSJoe Perches $line_fixed = 1; 43113705ce5bSJoe Perches } 43120a920b5bSAndy Whitcroft } 4313773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4314773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 43153705ce5bSJoe Perches if (ERROR("SPACING", 43163705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4317b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43183705ce5bSJoe Perches $line_fixed = 1; 43193705ce5bSJoe Perches } 4320653d4876SAndy Whitcroft } 4321773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 43223705ce5bSJoe Perches if (ERROR("SPACING", 43233705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4324b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 43253705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 43263705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4327773647a0SAndy Whitcroft } 4328b34c648bSJoe Perches $line_fixed = 1; 43293705ce5bSJoe Perches } 43303705ce5bSJoe Perches } 43310a920b5bSAndy Whitcroft 43320a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 43339c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 43349c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 43359c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4336c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4337c2fdda0dSAndy Whitcroft $op eq '%') 43380a920b5bSAndy Whitcroft { 4339d2e025f3SJoe Perches if ($check) { 4340d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4341d2e025f3SJoe Perches if (CHK("SPACING", 4342d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4343d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4344d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4345d2e025f3SJoe Perches $line_fixed = 1; 4346d2e025f3SJoe Perches } 4347d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4348d2e025f3SJoe Perches if (CHK("SPACING", 4349d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4350d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4351d2e025f3SJoe Perches $line_fixed = 1; 4352d2e025f3SJoe Perches } 4353d2e025f3SJoe Perches } 4354d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 43553705ce5bSJoe Perches if (ERROR("SPACING", 43563705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4357b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4358b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4359b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4360b34c648bSJoe Perches } 43613705ce5bSJoe Perches $line_fixed = 1; 43623705ce5bSJoe Perches } 43630a920b5bSAndy Whitcroft } 43640a920b5bSAndy Whitcroft 43651f65f947SAndy Whitcroft # A colon needs no spaces before when it is 43661f65f947SAndy Whitcroft # terminating a case value or a label. 43671f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 43681f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 43693705ce5bSJoe Perches if (ERROR("SPACING", 43703705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4371b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43723705ce5bSJoe Perches $line_fixed = 1; 43733705ce5bSJoe Perches } 43741f65f947SAndy Whitcroft } 43751f65f947SAndy Whitcroft 43760a920b5bSAndy Whitcroft # All the others need spaces both sides. 4377cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 43781f65f947SAndy Whitcroft my $ok = 0; 43791f65f947SAndy Whitcroft 438022f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 43811f65f947SAndy Whitcroft if (($op eq '<' && 43821f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 43831f65f947SAndy Whitcroft ($op eq '>' && 43841f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 43851f65f947SAndy Whitcroft { 43861f65f947SAndy Whitcroft $ok = 1; 43871f65f947SAndy Whitcroft } 43881f65f947SAndy Whitcroft 4389e0df7e1fSJoe Perches # for asm volatile statements 4390e0df7e1fSJoe Perches # ignore a colon with another 4391e0df7e1fSJoe Perches # colon immediately before or after 4392e0df7e1fSJoe Perches if (($op eq ':') && 4393e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4394e0df7e1fSJoe Perches $ok = 1; 4395e0df7e1fSJoe Perches } 4396e0df7e1fSJoe Perches 439784731623SJoe Perches # messages are ERROR, but ?: are CHK 43981f65f947SAndy Whitcroft if ($ok == 0) { 43990675a8fbSJean Delvare my $msg_level = \&ERROR; 44000675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 440184731623SJoe Perches 44020675a8fbSJean Delvare if (&{$msg_level}("SPACING", 44033705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4404b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4405b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4406b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4407b34c648bSJoe Perches } 44083705ce5bSJoe Perches $line_fixed = 1; 44093705ce5bSJoe Perches } 44100a920b5bSAndy Whitcroft } 441122f2a2efSAndy Whitcroft } 44124a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 44133705ce5bSJoe Perches 44143705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 44153705ce5bSJoe Perches 44163705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 44170a920b5bSAndy Whitcroft } 44183705ce5bSJoe Perches 44193705ce5bSJoe Perches if (($#elements % 2) == 0) { 44203705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 44213705ce5bSJoe Perches } 44223705ce5bSJoe Perches 4423194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4424194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 44253705ce5bSJoe Perches } 44263705ce5bSJoe Perches 44273705ce5bSJoe Perches 44280a920b5bSAndy Whitcroft } 44290a920b5bSAndy Whitcroft 4430786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4431d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4432786b6326SJoe Perches if (WARN("SPACING", 4433786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4434786b6326SJoe Perches $fix) { 4435194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4436786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4437786b6326SJoe Perches } 4438786b6326SJoe Perches } 4439786b6326SJoe Perches 4440f0a594c1SAndy Whitcroft# check for multiple assignments 4441f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4442000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4443000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4444f0a594c1SAndy Whitcroft } 4445f0a594c1SAndy Whitcroft 444622f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 444722f2a2efSAndy Whitcroft## # continuation. 444822f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 444922f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 445022f2a2efSAndy Whitcroft## 445122f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 445222f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 445322f2a2efSAndy Whitcroft## my $ln = $line; 445422f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 445522f2a2efSAndy Whitcroft## } 445622f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4457000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4458000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 445922f2a2efSAndy Whitcroft## } 446022f2a2efSAndy Whitcroft## } 4461f0a594c1SAndy Whitcroft 44620a920b5bSAndy Whitcroft#need space before brace following if, while, etc 44636b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 44644e5d56bdSEddie Kovsky $line =~ /do\{/) { 44653705ce5bSJoe Perches if (ERROR("SPACING", 44663705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 44673705ce5bSJoe Perches $fix) { 44688d81ae05SCyril Bur $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/; 44693705ce5bSJoe Perches } 4470de7d4f0eSAndy Whitcroft } 4471de7d4f0eSAndy Whitcroft 4472c4a62ef9SJoe Perches## # check for blank lines before declarations 4473c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4474c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4475c4a62ef9SJoe Perches## WARN("SPACING", 4476c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4477c4a62ef9SJoe Perches## } 4478c4a62ef9SJoe Perches## 4479c4a62ef9SJoe Perches 4480de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4481de7d4f0eSAndy Whitcroft# on the line 4482de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4483d5e616fcSJoe Perches if (ERROR("SPACING", 4484d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4485d5e616fcSJoe Perches $fix) { 4486194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4487d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4488d5e616fcSJoe Perches } 44890a920b5bSAndy Whitcroft } 44900a920b5bSAndy Whitcroft 449122f2a2efSAndy Whitcroft# check spacing on square brackets 449222f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 44933705ce5bSJoe Perches if (ERROR("SPACING", 44943705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 44953705ce5bSJoe Perches $fix) { 4496194f66fcSJoe Perches $fixed[$fixlinenr] =~ 44973705ce5bSJoe Perches s/\[\s+/\[/; 44983705ce5bSJoe Perches } 449922f2a2efSAndy Whitcroft } 450022f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 45013705ce5bSJoe Perches if (ERROR("SPACING", 45023705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 45033705ce5bSJoe Perches $fix) { 4504194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45053705ce5bSJoe Perches s/\s+\]/\]/; 45063705ce5bSJoe Perches } 450722f2a2efSAndy Whitcroft } 450822f2a2efSAndy Whitcroft 4509c45dcabdSAndy Whitcroft# check spacing on parentheses 45109c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 45119c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 45123705ce5bSJoe Perches if (ERROR("SPACING", 45133705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 45143705ce5bSJoe Perches $fix) { 4515194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45163705ce5bSJoe Perches s/\(\s+/\(/; 45173705ce5bSJoe Perches } 451822f2a2efSAndy Whitcroft } 451913214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4520c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4521c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 45223705ce5bSJoe Perches if (ERROR("SPACING", 45233705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 45243705ce5bSJoe Perches $fix) { 4525194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45263705ce5bSJoe Perches s/\s+\)/\)/; 45273705ce5bSJoe Perches } 452822f2a2efSAndy Whitcroft } 452922f2a2efSAndy Whitcroft 4530e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4531e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4532e2826fd0SJoe Perches 4533e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4534ea4acbb1SJoe Perches my $var = $1; 4535ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4536ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4537ea4acbb1SJoe Perches $fix) { 4538ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4539ea4acbb1SJoe Perches } 4540ea4acbb1SJoe Perches } 4541ea4acbb1SJoe Perches 4542ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4543ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4544ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4545ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4546ea4acbb1SJoe Perches my $var = $2; 4547ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4548ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4549ea4acbb1SJoe Perches $fix) { 4550ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4551ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4552ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4553ea4acbb1SJoe Perches } 4554e2826fd0SJoe Perches } 4555e2826fd0SJoe Perches 455663b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 4557a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 4558a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 4559a032aa4cSJoe Perches $^V && $^V ge 5.10.0 && defined($stat) && 456063b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 456163b7c73eSJoe Perches my $if_stat = $1; 456263b7c73eSJoe Perches my $test = substr($2, 1, -1); 456363b7c73eSJoe Perches my $herectx; 456463b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 456563b7c73eSJoe Perches my $match = $1; 456663b7c73eSJoe Perches # avoid parentheses around potential macro args 456763b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 456863b7c73eSJoe Perches if (!defined($herectx)) { 456963b7c73eSJoe Perches $herectx = $here . "\n"; 457063b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 457163b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 457263b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 457363b7c73eSJoe Perches $herectx .= $rl . "\n"; 457463b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 457563b7c73eSJoe Perches } 457663b7c73eSJoe Perches } 457763b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 457863b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 457963b7c73eSJoe Perches } 458063b7c73eSJoe Perches } 458163b7c73eSJoe Perches 45820a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 45834a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 45840a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 45853705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 45863705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 45873705ce5bSJoe Perches $fix) { 4588194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45893705ce5bSJoe Perches s/^(.)\s+/$1/; 45903705ce5bSJoe Perches } 45910a920b5bSAndy Whitcroft } 45920a920b5bSAndy Whitcroft 45935b9553abSJoe Perches# return is not a function 4594507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4595c45dcabdSAndy Whitcroft my $spacing = $1; 4596507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 45975b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 45985b9553abSJoe Perches my $value = $1; 45995b9553abSJoe Perches $value = deparenthesize($value); 46005b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4601000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4602000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 46035b9553abSJoe Perches } 4604c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4605000d1cc1SJoe Perches ERROR("SPACING", 4606000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4607c45dcabdSAndy Whitcroft } 4608c45dcabdSAndy Whitcroft } 4609507e5141SJoe Perches 4610b43ae21bSJoe Perches# unnecessary return in a void function 4611b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4612b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4613b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4614b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4615b43ae21bSJoe Perches $linenr >= 3 && 4616b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4617b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 46189819cf25SJoe Perches WARN("RETURN_VOID", 4619b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 46209819cf25SJoe Perches } 46219819cf25SJoe Perches 4622189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4623189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4624189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4625189248d8SJoe Perches my $openparens = $1; 4626189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4627189248d8SJoe Perches my $msg = ""; 4628189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4629189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4630189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4631189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4632189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4633189248d8SJoe Perches } 4634189248d8SJoe Perches } 4635189248d8SJoe Perches 4636c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4637c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4638c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4639c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 4640c5595fa2SJoe Perches if ($^V && $^V ge 5.10.0 && 4641c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4642c5595fa2SJoe Perches my $lead = $1; 4643c5595fa2SJoe Perches my $const = $2; 4644c5595fa2SJoe Perches my $comp = $3; 4645c5595fa2SJoe Perches my $to = $4; 4646c5595fa2SJoe Perches my $newcomp = $comp; 4647f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 4648c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4649c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4650c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4651c5595fa2SJoe Perches $fix) { 4652c5595fa2SJoe Perches if ($comp eq "<") { 4653c5595fa2SJoe Perches $newcomp = ">"; 4654c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4655c5595fa2SJoe Perches $newcomp = ">="; 4656c5595fa2SJoe Perches } elsif ($comp eq ">") { 4657c5595fa2SJoe Perches $newcomp = "<"; 4658c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4659c5595fa2SJoe Perches $newcomp = "<="; 4660c5595fa2SJoe Perches } 4661c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4662c5595fa2SJoe Perches } 4663c5595fa2SJoe Perches } 4664c5595fa2SJoe Perches 4665f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4666f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 466753a3c448SAndy Whitcroft my $name = $1; 466853a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4669000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4670f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 467153a3c448SAndy Whitcroft } 467253a3c448SAndy Whitcroft } 4673c45dcabdSAndy Whitcroft 46740a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 46754a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 46763705ce5bSJoe Perches if (ERROR("SPACING", 46773705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 46783705ce5bSJoe Perches $fix) { 4679194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46803705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 46813705ce5bSJoe Perches } 46820a920b5bSAndy Whitcroft } 46830a920b5bSAndy Whitcroft 4684f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4685f5fe35ddSAndy Whitcroft# statements after the conditional. 4686170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 46873e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 46883e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 46893e469cdcSAndy Whitcroft if (!defined $stat); 4690170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4691170d3a22SAndy Whitcroft $remain_next, $off_next); 4692170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4693170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4694170d3a22SAndy Whitcroft 4695170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4696170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4697170d3a22SAndy Whitcroft # then count those as offsets. 4698170d3a22SAndy Whitcroft my ($whitespace) = 4699170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4700170d3a22SAndy Whitcroft my $offset = 4701170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4702170d3a22SAndy Whitcroft 4703170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4704170d3a22SAndy Whitcroft $offset} = 1; 4705170d3a22SAndy Whitcroft } 4706170d3a22SAndy Whitcroft } 4707170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4708c11230f4SJoe Perches defined($stat) && defined($cond) && 4709170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4710171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 47118905a67cSAndy Whitcroft 4712b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4713000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4714000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 47158905a67cSAndy Whitcroft } 47168905a67cSAndy Whitcroft 47178905a67cSAndy Whitcroft # Find out what is on the end of the line after the 47188905a67cSAndy Whitcroft # conditional. 4719773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 47208905a67cSAndy Whitcroft $s =~ s/\n.*//g; 472113214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 472253210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 472353210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4724773647a0SAndy Whitcroft { 4725bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4726bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4727bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 472842bdf74cSHidetoshi Seto my $stat_real = ''; 4729bb44ad39SAndy Whitcroft 473042bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 473142bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4732bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4733bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4734bb44ad39SAndy Whitcroft } 4735bb44ad39SAndy Whitcroft 4736000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4737000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 47388905a67cSAndy Whitcroft } 47398905a67cSAndy Whitcroft } 47408905a67cSAndy Whitcroft 474113214adfSAndy Whitcroft# Check for bitwise tests written as boolean 474213214adfSAndy Whitcroft if ($line =~ / 474313214adfSAndy Whitcroft (?: 474413214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 474513214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 474613214adfSAndy Whitcroft (?:\&\&|\|\|) 474713214adfSAndy Whitcroft | 474813214adfSAndy Whitcroft (?:\&\&|\|\|) 474913214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 475013214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 475113214adfSAndy Whitcroft )/x) 475213214adfSAndy Whitcroft { 4753000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4754000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 475513214adfSAndy Whitcroft } 475613214adfSAndy Whitcroft 47578905a67cSAndy Whitcroft# if and else should not have general statements after it 475813214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 475913214adfSAndy Whitcroft my $s = $1; 476013214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 476113214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4762000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4763000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 47640a920b5bSAndy Whitcroft } 476513214adfSAndy Whitcroft } 476639667782SAndy Whitcroft# if should not continue a brace 476739667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4768000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4769048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 477039667782SAndy Whitcroft $herecurr); 477139667782SAndy Whitcroft } 4772a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4773a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4774a1080bf8SAndy Whitcroft $line !~ /\G(?: 47753fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4776a1080bf8SAndy Whitcroft \s*return\s+ 4777a1080bf8SAndy Whitcroft )/xg) 4778a1080bf8SAndy Whitcroft { 4779000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4780000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4781a1080bf8SAndy Whitcroft } 47820a920b5bSAndy Whitcroft 47830a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 47840a920b5bSAndy Whitcroft # indent level to be relevant to each other. 47858b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 47860a920b5bSAndy Whitcroft $previndent == $indent) { 47878b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 47888b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 47898b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 47908b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 47918b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 47928b8856f4SJoe Perches my $fixedline = $prevrawline; 47938b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 47948b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 47958b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 47968b8856f4SJoe Perches } 47978b8856f4SJoe Perches $fixedline = $rawline; 47988b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 47998b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48008b8856f4SJoe Perches } 48010a920b5bSAndy Whitcroft } 48020a920b5bSAndy Whitcroft 48038b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4804c2fdda0dSAndy Whitcroft $previndent == $indent) { 4805c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4806c2fdda0dSAndy Whitcroft 4807c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4808c2fdda0dSAndy Whitcroft # conditional. 4809773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4810c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4811c2fdda0dSAndy Whitcroft 4812c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 48138b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 48148b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 48158b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 48168b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48178b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 48188b8856f4SJoe Perches my $fixedline = $prevrawline; 48198b8856f4SJoe Perches my $trailing = $rawline; 48208b8856f4SJoe Perches $trailing =~ s/^\+//; 48218b8856f4SJoe Perches $trailing = trim($trailing); 48228b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 48238b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48248b8856f4SJoe Perches } 4825c2fdda0dSAndy Whitcroft } 4826c2fdda0dSAndy Whitcroft } 4827c2fdda0dSAndy Whitcroft 482895e2c602SJoe Perches#Specific variable tests 4829323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4830323c1260SJoe Perches my $var = $1; 483195e2c602SJoe Perches 483295e2c602SJoe Perches#gcc binary extension 483395e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4834d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4835d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4836d5e616fcSJoe Perches $fix) { 4837d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4838194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4839d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4840d5e616fcSJoe Perches } 484195e2c602SJoe Perches } 484295e2c602SJoe Perches 484395e2c602SJoe Perches#CamelCase 4844807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4845be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 484622735ce8SJoe Perches#Ignore Page<foo> variants 4847807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 484822735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4849f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4850f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4851f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 48527e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 48537e781f67SJoe Perches my $word = $1; 48547e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4855d8b07710SJoe Perches if ($check) { 4856d8b07710SJoe Perches seed_camelcase_includes(); 4857d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4858d8b07710SJoe Perches seed_camelcase_file($realfile); 4859d8b07710SJoe Perches $camelcase_file_seeded = 1; 4860d8b07710SJoe Perches } 4861d8b07710SJoe Perches } 48627e781f67SJoe Perches if (!defined $camelcase{$word}) { 48637e781f67SJoe Perches $camelcase{$word} = 1; 4864be79794bSJoe Perches CHK("CAMELCASE", 48657e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 48667e781f67SJoe Perches } 4867323c1260SJoe Perches } 4868323c1260SJoe Perches } 48693445686aSJoe Perches } 48700a920b5bSAndy Whitcroft 48710a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4872d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4873d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4874d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4875d5e616fcSJoe Perches $fix) { 4876194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4877d5e616fcSJoe Perches } 48780a920b5bSAndy Whitcroft } 48790a920b5bSAndy Whitcroft 48800e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 48810e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4882c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4883e09dec48SAndy Whitcroft my $file = "$1.h"; 4884e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4885e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4886e09dec48SAndy Whitcroft $realfile ne $checkfile && 48877840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4888c45dcabdSAndy Whitcroft { 48890e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 48900e212e0aSFabian Frederick if ($asminclude > 0) { 4891e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4892000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4893000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4894e09dec48SAndy Whitcroft } else { 4895000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4896000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4897e09dec48SAndy Whitcroft } 48980a920b5bSAndy Whitcroft } 48990a920b5bSAndy Whitcroft } 49000e212e0aSFabian Frederick } 49010a920b5bSAndy Whitcroft 4902653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4903653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4904cf655043SAndy Whitcroft# in a known good container 4905b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4906b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4907d8aaf121SAndy Whitcroft my $ln = $linenr; 4908d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4909c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4910c45dcabdSAndy Whitcroft my $ctx = ''; 491108a2843eSJoe Perches my $has_flow_statement = 0; 491208a2843eSJoe Perches my $has_arg_concat = 0; 4913c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4914f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4915f74bd194SAndy Whitcroft $ctx = $dstat; 4916c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4917a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4918c45dcabdSAndy Whitcroft 491908a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 492062e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 492108a2843eSJoe Perches 4922f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 4923f59b64bfSJoe Perches my $define_args = $1; 4924f59b64bfSJoe Perches my $define_stmt = $dstat; 4925f59b64bfSJoe Perches my @def_args = (); 4926f59b64bfSJoe Perches 4927f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 4928f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 4929f59b64bfSJoe Perches $define_args =~ s/\s*//g; 4930f59b64bfSJoe Perches @def_args = split(",", $define_args); 4931f59b64bfSJoe Perches } 4932f59b64bfSJoe Perches 4933292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4934c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4935c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4936c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4937c45dcabdSAndy Whitcroft 4938c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4939bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4940bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 49416b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 4942bf30d6edSAndy Whitcroft { 4943c45dcabdSAndy Whitcroft } 4944c45dcabdSAndy Whitcroft 4945e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 494633acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 494733acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 4948e45bab8eSAndy Whitcroft { 4949e45bab8eSAndy Whitcroft } 4950e45bab8eSAndy Whitcroft 495142e15293SJoe Perches # Make asm volatile uses seem like a generic function 495242e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 495342e15293SJoe Perches 4954c45dcabdSAndy Whitcroft my $exceptions = qr{ 4955c45dcabdSAndy Whitcroft $Declare| 4956c45dcabdSAndy Whitcroft module_param_named| 4957a0a0a7a9SKees Cook MODULE_PARM_DESC| 4958c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4959c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4960383099fdSAndy Whitcroft __typeof__\(| 496122fd2d3eSStefani Seibold union| 496222fd2d3eSStefani Seibold struct| 4963ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 49646b10df42SVladimir Zapolskiy ^\"|\"$| 49656b10df42SVladimir Zapolskiy ^\[ 4966c45dcabdSAndy Whitcroft }x; 49675eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4968f59b64bfSJoe Perches 4969f59b64bfSJoe Perches $ctx =~ s/\n*$//; 4970f59b64bfSJoe Perches my $herectx = $here . "\n"; 4971f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 4972f59b64bfSJoe Perches 4973f59b64bfSJoe Perches for (my $n = 0; $n < $stmt_cnt; $n++) { 4974f59b64bfSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4975f59b64bfSJoe Perches } 4976f59b64bfSJoe Perches 4977f74bd194SAndy Whitcroft if ($dstat ne '' && 4978f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4979f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 49803cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4981356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4982f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4983f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4984e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 498572f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4986f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4987f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4988f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 49894e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 4990f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4991c45dcabdSAndy Whitcroft { 4992e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 4993e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4994e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 4995e795556aSJoe Perches } elsif ($dstat =~ /;/) { 4996f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4997f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4998f74bd194SAndy Whitcroft } else { 4999000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 5000388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5001d8aaf121SAndy Whitcroft } 5002f59b64bfSJoe Perches 5003f59b64bfSJoe Perches } 50045207649bSJoe Perches 50055207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 50065207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 50075207649bSJoe Perches my $first = 1; 50085207649bSJoe Perches $define_stmt = ""; 50095207649bSJoe Perches foreach my $l (@stmt_array) { 50105207649bSJoe Perches $l =~ s/\\$//; 50115207649bSJoe Perches if ($first) { 50125207649bSJoe Perches $define_stmt = $l; 50135207649bSJoe Perches $first = 0; 50145207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 50155207649bSJoe Perches $define_stmt .= substr($l, 1); 50165207649bSJoe Perches } 50175207649bSJoe Perches } 50185207649bSJoe Perches $define_stmt =~ s/$;//g; 50195207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 50205207649bSJoe Perches $define_stmt = trim($define_stmt); 50215207649bSJoe Perches 5022f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5023f59b64bfSJoe Perches foreach my $arg (@def_args) { 5024f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 50259192d41aSJoe Perches next if ($arg =~ /^type$/i); 50267fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 50277fe528a2SJoe Perches $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 50287fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 50297fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 50307fe528a2SJoe Perches my $use_cnt = $tmp_stmt =~ s/\b$arg\b//g; 5031f59b64bfSJoe Perches if ($use_cnt > 1) { 5032f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5033f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5034f59b64bfSJoe Perches } 50359192d41aSJoe Perches# check if any macro arguments may have other precedence issues 50367fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 50379192d41aSJoe Perches ((defined($1) && $1 ne ',') || 50389192d41aSJoe Perches (defined($2) && $2 ne ','))) { 50399192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 50409192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 50419192d41aSJoe Perches } 50420a920b5bSAndy Whitcroft } 50435023d347SJoe Perches 504408a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 504508a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 504608a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 504708a2843eSJoe Perches my $herectx = $here . "\n"; 504808a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 504908a2843eSJoe Perches 505008a2843eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 505108a2843eSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 505208a2843eSJoe Perches } 505308a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 505408a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 505508a2843eSJoe Perches } 505608a2843eSJoe Perches 5057481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 50585023d347SJoe Perches 50595023d347SJoe Perches } else { 50605023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5061481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5062481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 50635023d347SJoe Perches $line =~ /^\+.*\\$/) { 50645023d347SJoe Perches WARN("LINE_CONTINUATIONS", 50655023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 50665023d347SJoe Perches } 5067653d4876SAndy Whitcroft } 50680a920b5bSAndy Whitcroft 5069b13edf7fSJoe Perches# do {} while (0) macro tests: 5070b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5071b13edf7fSJoe Perches# macro should not end with a semicolon 5072b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 5073b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5074b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5075b13edf7fSJoe Perches my $ln = $linenr; 5076b13edf7fSJoe Perches my $cnt = $realcnt; 5077b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5078b13edf7fSJoe Perches my $ctx = ''; 5079b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5080b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5081b13edf7fSJoe Perches $ctx = $dstat; 5082b13edf7fSJoe Perches 5083b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 50841b36b201SJoe Perches $dstat =~ s/$;/ /g; 5085b13edf7fSJoe Perches 5086b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5087b13edf7fSJoe Perches my $stmts = $2; 5088b13edf7fSJoe Perches my $semis = $3; 5089b13edf7fSJoe Perches 5090b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5091b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5092b13edf7fSJoe Perches my $herectx = $here . "\n"; 5093b13edf7fSJoe Perches 5094b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5095b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5096b13edf7fSJoe Perches } 5097b13edf7fSJoe Perches 5098ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5099ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5100b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5101b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5102b13edf7fSJoe Perches } 5103b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5104b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5105b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5106b13edf7fSJoe Perches } 5107f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5108f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5109f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5110f5ef95b1SJoe Perches my $herectx = $here . "\n"; 5111f5ef95b1SJoe Perches 5112f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5113f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5114f5ef95b1SJoe Perches } 5115f5ef95b1SJoe Perches 5116f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5117f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5118b13edf7fSJoe Perches } 5119b13edf7fSJoe Perches } 5120b13edf7fSJoe Perches 5121080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 5122080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 5123080ba929SMike Frysinger# . 5124080ba929SMike Frysinger# ALIGN(...) 5125080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 5126080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 5127000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 5128000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 5129080ba929SMike Frysinger } 5130080ba929SMike Frysinger 5131f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 513213214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 513313214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5134cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 513513214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5136cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5137cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5138aad4f614SJoe Perches my @allowed = (); 5139aad4f614SJoe Perches my $allow = 0; 514013214adfSAndy Whitcroft my $seen = 0; 5141773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5142cf655043SAndy Whitcroft my $ln = $linenr - 1; 514313214adfSAndy Whitcroft for my $chunk (@chunks) { 514413214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 514513214adfSAndy Whitcroft 5146773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5147773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5148773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 5149773647a0SAndy Whitcroft 5150aad4f614SJoe Perches $allowed[$allow] = 0; 5151773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5152773647a0SAndy Whitcroft 5153773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 5154773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 5155773647a0SAndy Whitcroft 5156773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5157cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 5158cf655043SAndy Whitcroft 5159773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 516013214adfSAndy Whitcroft 516113214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 516213214adfSAndy Whitcroft 5163aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5164cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5165cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5166aad4f614SJoe Perches $allowed[$allow] = 1; 516713214adfSAndy Whitcroft } 516813214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5169cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5170aad4f614SJoe Perches $allowed[$allow] = 1; 517113214adfSAndy Whitcroft } 5172cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5173cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5174aad4f614SJoe Perches $allowed[$allow] = 1; 517513214adfSAndy Whitcroft } 5176aad4f614SJoe Perches $allow++; 517713214adfSAndy Whitcroft } 5178aad4f614SJoe Perches if ($seen) { 5179aad4f614SJoe Perches my $sum_allowed = 0; 5180aad4f614SJoe Perches foreach (@allowed) { 5181aad4f614SJoe Perches $sum_allowed += $_; 5182aad4f614SJoe Perches } 5183aad4f614SJoe Perches if ($sum_allowed == 0) { 5184000d1cc1SJoe Perches WARN("BRACES", 5185000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 5186aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 5187aad4f614SJoe Perches $seen != $allow) { 5188aad4f614SJoe Perches CHK("BRACES", 5189aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 5190aad4f614SJoe Perches } 519113214adfSAndy Whitcroft } 519213214adfSAndy Whitcroft } 519313214adfSAndy Whitcroft } 5194773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 519513214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 5196cf655043SAndy Whitcroft my $allowed = 0; 5197f0a594c1SAndy Whitcroft 5198cf655043SAndy Whitcroft # Check the pre-context. 5199cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 5200cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 5201cf655043SAndy Whitcroft $allowed = 1; 5202f0a594c1SAndy Whitcroft } 5203773647a0SAndy Whitcroft 5204773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 5205773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 5206773647a0SAndy Whitcroft 5207cf655043SAndy Whitcroft # Check the condition. 5208cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 5209773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 5210cf655043SAndy Whitcroft if (defined $cond) { 5211773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5212cf655043SAndy Whitcroft } 5213cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5214cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5215cf655043SAndy Whitcroft $allowed = 1; 5216cf655043SAndy Whitcroft } 5217cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5218cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5219cf655043SAndy Whitcroft $allowed = 1; 5220cf655043SAndy Whitcroft } 5221cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5222cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5223cf655043SAndy Whitcroft $allowed = 1; 5224cf655043SAndy Whitcroft } 5225cf655043SAndy Whitcroft # Check the post-context. 5226cf655043SAndy Whitcroft if (defined $chunks[1]) { 5227cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 5228cf655043SAndy Whitcroft if (defined $cond) { 5229773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5230cf655043SAndy Whitcroft } 5231cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 5232cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5233cf655043SAndy Whitcroft $allowed = 1; 5234cf655043SAndy Whitcroft } 5235cf655043SAndy Whitcroft } 5236cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 523769932487SJustin P. Mattock my $herectx = $here . "\n"; 5238f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 5239cf655043SAndy Whitcroft 5240f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 524169932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 5242cf655043SAndy Whitcroft } 5243cf655043SAndy Whitcroft 5244000d1cc1SJoe Perches WARN("BRACES", 5245000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 5246f0a594c1SAndy Whitcroft } 5247f0a594c1SAndy Whitcroft } 5248f0a594c1SAndy Whitcroft 5249e4c5babdSJoe Perches# check for single line unbalanced braces 525095330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 525195330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 5252e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 5253e4c5babdSJoe Perches } 5254e4c5babdSJoe Perches 52550979ae66SJoe Perches# check for unnecessary blank lines around braces 525677b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5257f8e58219SJoe Perches if (CHK("BRACES", 5258f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5259f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 5260f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5261f8e58219SJoe Perches } 52620979ae66SJoe Perches } 526377b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5264f8e58219SJoe Perches if (CHK("BRACES", 5265f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5266f8e58219SJoe Perches $fix) { 5267f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 5268f8e58219SJoe Perches } 52690979ae66SJoe Perches } 52700979ae66SJoe Perches 52714a0df2efSAndy Whitcroft# no volatiles please 52726c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 52736c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5274000d1cc1SJoe Perches WARN("VOLATILE", 52758c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 52764a0df2efSAndy Whitcroft } 52774a0df2efSAndy Whitcroft 52785e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 52795e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 52805e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 52815e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 528233acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 52835e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 52845e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 52855e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 52865e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 52875e4f6ba5SJoe Perches $fix && 52885e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 52895e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 52905e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 52915e4f6ba5SJoe Perches my $comma_close = ""; 52925e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 52935e4f6ba5SJoe Perches $comma_close = $1; 52945e4f6ba5SJoe Perches } 52955e4f6ba5SJoe Perches 52965e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 52975e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 52985e4f6ba5SJoe Perches my $fixedline = $prevrawline; 52995e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 53005e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 53015e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 53025e4f6ba5SJoe Perches $fixedline = $rawline; 53035e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 53045e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 53055e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 53065e4f6ba5SJoe Perches } 53075e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 53085e4f6ba5SJoe Perches } 53095e4f6ba5SJoe Perches } 53105e4f6ba5SJoe Perches 53115e4f6ba5SJoe Perches# check for missing a space in a string concatenation 53125e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 53135e4f6ba5SJoe Perches WARN('MISSING_SPACE', 53145e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 53155e4f6ba5SJoe Perches } 53165e4f6ba5SJoe Perches 531777cb8546SJoe Perches# check for an embedded function name in a string when the function is known 5318e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 5319e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 5320e4b7d309SJoe Perches# function declarations 532177cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 532277cb8546SJoe Perches defined($context_function) && 5323e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 5324e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 532577cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 5326e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 532777cb8546SJoe Perches } 532877cb8546SJoe Perches 53295e4f6ba5SJoe Perches# check for spaces before a quoted newline 53305e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 53315e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 53325e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 53335e4f6ba5SJoe Perches $fix) { 53345e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 53355e4f6ba5SJoe Perches } 53365e4f6ba5SJoe Perches 53375e4f6ba5SJoe Perches } 53385e4f6ba5SJoe Perches 5339f17dba4fSJoe Perches# concatenated string without spaces between elements 534033acb54aSJoe Perches if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) { 5341f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 5342f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 5343f17dba4fSJoe Perches } 5344f17dba4fSJoe Perches 534590ad30e5SJoe Perches# uncoalesced string fragments 534633acb54aSJoe Perches if ($line =~ /$String\s*"/) { 534790ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 534890ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 534990ad30e5SJoe Perches } 535090ad30e5SJoe Perches 5351522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 5352522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 5353522b837cSAlexey Dobriyan my $show_Z = 1; 53545e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 5355522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 53565e4f6ba5SJoe Perches $string =~ s/%%/__/g; 5357522b837cSAlexey Dobriyan # check for %L 5358522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 53595e4f6ba5SJoe Perches WARN("PRINTF_L", 5360522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 5361522b837cSAlexey Dobriyan $show_L = 0; 53625e4f6ba5SJoe Perches } 5363522b837cSAlexey Dobriyan # check for %Z 5364522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 5365522b837cSAlexey Dobriyan WARN("PRINTF_Z", 5366522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 5367522b837cSAlexey Dobriyan $show_Z = 0; 5368522b837cSAlexey Dobriyan } 5369522b837cSAlexey Dobriyan # check for 0x<decimal> 5370522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 5371522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 53726e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 53736e300757SJoe Perches } 53745e4f6ba5SJoe Perches } 53755e4f6ba5SJoe Perches 53765e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 53773f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 53785e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 53795e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 53805e4f6ba5SJoe Perches } 53815e4f6ba5SJoe Perches 538200df344fSAndy Whitcroft# warn about #if 0 5383c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 5384000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 5385000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 5386de7d4f0eSAndy Whitcroft $herecurr); 53874a0df2efSAndy Whitcroft } 53884a0df2efSAndy Whitcroft 538903df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 539003df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5391100425deSJoe Perches my $tested = quotemeta($1); 5392100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5393100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5394100425deSJoe Perches my $func = $1; 5395100425deSJoe Perches if (WARN('NEEDLESS_IF', 5396100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5397100425deSJoe Perches $fix) { 5398100425deSJoe Perches my $do_fix = 1; 5399100425deSJoe Perches my $leading_tabs = ""; 5400100425deSJoe Perches my $new_leading_tabs = ""; 5401100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5402100425deSJoe Perches $leading_tabs = $1; 5403100425deSJoe Perches } else { 5404100425deSJoe Perches $do_fix = 0; 5405100425deSJoe Perches } 5406100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5407100425deSJoe Perches $new_leading_tabs = $1; 5408100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5409100425deSJoe Perches $do_fix = 0; 5410100425deSJoe Perches } 5411100425deSJoe Perches } else { 5412100425deSJoe Perches $do_fix = 0; 5413100425deSJoe Perches } 5414100425deSJoe Perches if ($do_fix) { 5415100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5416100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5417100425deSJoe Perches } 5418100425deSJoe Perches } 54194c432a8fSGreg Kroah-Hartman } 54204c432a8fSGreg Kroah-Hartman } 5421f0a594c1SAndy Whitcroft 5422ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5423ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5424ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5425ebfdc409SJoe Perches (defined $1 || defined $3) && 5426ebfdc409SJoe Perches $linenr > 3) { 5427ebfdc409SJoe Perches my $testval = $2; 5428ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5429ebfdc409SJoe Perches 5430ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5431ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5432ebfdc409SJoe Perches 5433fb0d0e08SJoe 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)/) { 5434ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5435ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5436ebfdc409SJoe Perches } 5437ebfdc409SJoe Perches } 5438ebfdc409SJoe Perches 5439f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5440dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5441f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5442f78d98f6SJoe Perches my $level = $1; 5443f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5444f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5445f78d98f6SJoe Perches $fix) { 5446f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5447f78d98f6SJoe Perches } 5448f78d98f6SJoe Perches } 5449f78d98f6SJoe Perches 545045c55e92SJoe Perches# check for logging continuations 545145c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 545245c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 545345c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 545445c55e92SJoe Perches } 545545c55e92SJoe Perches 5456abb08a53SJoe Perches# check for mask then right shift without a parentheses 5457abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 5458abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5459abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5460abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5461abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5462abb08a53SJoe Perches } 5463abb08a53SJoe Perches 5464b75ac618SJoe Perches# check for pointer comparisons to NULL 5465b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 5466b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5467b75ac618SJoe Perches my $val = $1; 5468b75ac618SJoe Perches my $equal = "!"; 5469b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5470b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5471b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5472b75ac618SJoe Perches $fix) { 5473b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5474b75ac618SJoe Perches } 5475b75ac618SJoe Perches } 5476b75ac618SJoe Perches } 5477b75ac618SJoe Perches 54788716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 54798716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 54808716de38SJoe Perches my $attr = $1; 54818716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 54828716de38SJoe Perches my $ptr = $1; 54838716de38SJoe Perches my $var = $2; 54848716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 54858716de38SJoe Perches ERROR("MISPLACED_INIT", 54868716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 54878716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 54888716de38SJoe Perches WARN("MISPLACED_INIT", 54898716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 54908716de38SJoe Perches $fix) { 5491194f66fcSJoe 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; 54928716de38SJoe Perches } 54938716de38SJoe Perches } 54948716de38SJoe Perches } 54958716de38SJoe Perches 5496e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5497e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5498e970b884SJoe Perches my $attr = $1; 5499e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5500e970b884SJoe Perches my $attr_prefix = $1; 5501e970b884SJoe Perches my $attr_type = $2; 5502e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5503e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5504e970b884SJoe Perches $fix) { 5505194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5506e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5507e970b884SJoe Perches } 5508e970b884SJoe Perches } 5509e970b884SJoe Perches 5510e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5511e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5512e970b884SJoe Perches my $attr = $1; 5513e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5514e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5515e970b884SJoe Perches $fix) { 5516194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5517e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5518e970b884SJoe Perches $lead = rtrim($1); 5519e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5520e970b884SJoe Perches $lead = "${lead}const "; 5521194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5522e970b884SJoe Perches } 5523e970b884SJoe Perches } 5524e970b884SJoe Perches 5525c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5526c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5527c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5528c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5529c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5530c17893c7SJoe Perches $fix) { 5531c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5532c17893c7SJoe Perches } 5533c17893c7SJoe Perches } 5534c17893c7SJoe Perches 5535fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5536fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5537fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5538fbdb8138SJoe Perches my $constant_func = $1; 5539fbdb8138SJoe Perches my $func = $constant_func; 5540fbdb8138SJoe Perches $func =~ s/^__constant_//; 5541fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5542fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5543fbdb8138SJoe Perches $fix) { 5544194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5545fbdb8138SJoe Perches } 5546fbdb8138SJoe Perches } 5547fbdb8138SJoe Perches 55481a15a250SPatrick Pannuto# prefer usleep_range over udelay 554937581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 555043c1d77cSJoe Perches my $delay = $1; 55511a15a250SPatrick Pannuto # ignore udelay's < 10, however 555243c1d77cSJoe Perches if (! ($delay < 10) ) { 5553000d1cc1SJoe Perches CHK("USLEEP_RANGE", 555443c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 555543c1d77cSJoe Perches } 555643c1d77cSJoe Perches if ($delay > 2000) { 555743c1d77cSJoe Perches WARN("LONG_UDELAY", 555843c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 55591a15a250SPatrick Pannuto } 55601a15a250SPatrick Pannuto } 55611a15a250SPatrick Pannuto 556209ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 556309ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 556409ef8725SPatrick Pannuto if ($1 < 20) { 5565000d1cc1SJoe Perches WARN("MSLEEP", 556643c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 556709ef8725SPatrick Pannuto } 556809ef8725SPatrick Pannuto } 556909ef8725SPatrick Pannuto 557036ec1939SJoe Perches# check for comparisons of jiffies 557136ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 557236ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 557336ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 557436ec1939SJoe Perches } 557536ec1939SJoe Perches 55769d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 55779d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 55789d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 55799d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 55809d7a34a5SJoe Perches } 55819d7a34a5SJoe Perches 558200df344fSAndy Whitcroft# warn about #ifdefs in C files 5583c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 558400df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 558500df344fSAndy Whitcroft# print "$herecurr"; 558600df344fSAndy Whitcroft# $clean = 0; 558700df344fSAndy Whitcroft# } 558800df344fSAndy Whitcroft 558922f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5590c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 55913705ce5bSJoe Perches if (ERROR("SPACING", 55923705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 55933705ce5bSJoe Perches $fix) { 5594194f66fcSJoe Perches $fixed[$fixlinenr] =~ 55953705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 55963705ce5bSJoe Perches } 55973705ce5bSJoe Perches 559822f2a2efSAndy Whitcroft } 559922f2a2efSAndy Whitcroft 56004a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5601171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5602171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 56034a0df2efSAndy Whitcroft my $which = $1; 56044a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5605000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5606000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 56074a0df2efSAndy Whitcroft } 56084a0df2efSAndy Whitcroft } 56094a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5610402c2553SMichael S. Tsirkin 5611402c2553SMichael S. Tsirkin my $barriers = qr{ 5612402c2553SMichael S. Tsirkin mb| 5613402c2553SMichael S. Tsirkin rmb| 5614402c2553SMichael S. Tsirkin wmb| 5615402c2553SMichael S. Tsirkin read_barrier_depends 5616402c2553SMichael S. Tsirkin }x; 5617402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5618402c2553SMichael S. Tsirkin mb__before_atomic| 5619402c2553SMichael S. Tsirkin mb__after_atomic| 5620402c2553SMichael S. Tsirkin store_release| 5621402c2553SMichael S. Tsirkin load_acquire| 5622402c2553SMichael S. Tsirkin store_mb| 5623402c2553SMichael S. Tsirkin (?:$barriers) 5624402c2553SMichael S. Tsirkin }x; 5625402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5626402c2553SMichael S. Tsirkin (?:$barriers)| 562743e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 562843e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5629402c2553SMichael S. Tsirkin }x; 5630402c2553SMichael S. Tsirkin 5631402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 56324a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5633c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5634000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 56354a0df2efSAndy Whitcroft } 56364a0df2efSAndy Whitcroft } 56373ad81779SPaul E. McKenney 5638f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5639f4073b0fSMichael S. Tsirkin 5640f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5641f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5642f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5643f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5644f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5645f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5646f4073b0fSMichael S. Tsirkin } 5647f4073b0fSMichael S. Tsirkin 5648cb426e99SJoe Perches# check for waitqueue_active without a comment. 5649cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5650cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5651cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5652cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5653cb426e99SJoe Perches } 5654cb426e99SJoe Perches } 56553ad81779SPaul E. McKenney 565691db2592SPaul E. McKenney# check for smp_read_barrier_depends and read_barrier_depends 565791db2592SPaul E. McKenney if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) { 565891db2592SPaul E. McKenney WARN("READ_BARRIER_DEPENDS", 565991db2592SPaul E. McKenney "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr); 566091db2592SPaul E. McKenney } 566191db2592SPaul E. McKenney 56624a0df2efSAndy Whitcroft# check of hardware specific defines 5663c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5664000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5665000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 56660a920b5bSAndy Whitcroft } 5667653d4876SAndy Whitcroft 5668596ed45bSJoe Perches# check that the storage class is not after a type 5669596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 5670000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5671596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 5672596ed45bSJoe Perches } 5673596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 5674596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 5675596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 5676596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 5677596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 5678596ed45bSJoe Perches WARN("STORAGE_CLASS", 5679596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 5680d4977c78STobias Klauser } 5681d4977c78STobias Klauser 5682de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5683de7d4f0eSAndy Whitcroft# storage class and type. 56849c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 56859c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5686000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5687000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5688de7d4f0eSAndy Whitcroft } 5689de7d4f0eSAndy Whitcroft 56908905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 56912b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 56922b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5693d5e616fcSJoe Perches if (WARN("INLINE", 5694d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5695d5e616fcSJoe Perches $fix) { 5696194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5697d5e616fcSJoe Perches 5698d5e616fcSJoe Perches } 56998905a67cSAndy Whitcroft } 57008905a67cSAndy Whitcroft 57013d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 57022b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57032b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5704000d1cc1SJoe Perches WARN("PREFER_PACKED", 5705000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 57063d130fd0SJoe Perches } 57073d130fd0SJoe Perches 570839b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 57092b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57102b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5711000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5712000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 571339b7e287SJoe Perches } 571439b7e287SJoe Perches 57155f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 57162b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57172b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5718d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5719d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5720d5e616fcSJoe Perches $fix) { 5721194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5722d5e616fcSJoe Perches 5723d5e616fcSJoe Perches } 57245f14d3bdSJoe Perches } 57255f14d3bdSJoe Perches 57266061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 57272b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57282b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5729d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5730d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5731d5e616fcSJoe Perches $fix) { 5732194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5733d5e616fcSJoe Perches } 57346061d949SJoe Perches } 57356061d949SJoe Perches 5736619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 5737619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 5738619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5739619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5740619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5741619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5742619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5743619a908aSJoe Perches } 5744619a908aSJoe Perches 5745fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 5746e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5747fd39f904STomas Winkler $realfile !~ m@\btools/@ && 5748e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5749e6176fa4SJoe Perches my $type = $1; 5750e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5751e6176fa4SJoe Perches $type = $1; 5752e6176fa4SJoe Perches my $kernel_type = 'u'; 5753e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5754e6176fa4SJoe Perches $type =~ /(\d+)/; 5755e6176fa4SJoe Perches $kernel_type .= $1; 5756e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5757e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5758e6176fa4SJoe Perches $fix) { 5759e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5760e6176fa4SJoe Perches } 5761e6176fa4SJoe Perches } 5762e6176fa4SJoe Perches } 5763e6176fa4SJoe Perches 5764938224b5SJoe Perches# check for cast of C90 native int or longer types constants 5765938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 5766938224b5SJoe Perches my $cast = $1; 5767938224b5SJoe Perches my $const = $2; 5768938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 5769938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 5770938224b5SJoe Perches $fix) { 5771938224b5SJoe Perches my $suffix = ""; 5772938224b5SJoe Perches my $newconst = $const; 5773938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 5774938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 5775938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 5776938224b5SJoe Perches $suffix .= 'LL'; 5777938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 5778938224b5SJoe Perches $suffix .= 'L'; 5779938224b5SJoe Perches } 5780938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 5781938224b5SJoe Perches } 5782938224b5SJoe Perches } 5783938224b5SJoe Perches 57848f53a9b8SJoe Perches# check for sizeof(&) 57858f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5786000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5787000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 57888f53a9b8SJoe Perches } 57898f53a9b8SJoe Perches 579066c80b60SJoe Perches# check for sizeof without parenthesis 579166c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5792d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5793d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5794d5e616fcSJoe Perches $fix) { 5795194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5796d5e616fcSJoe Perches } 579766c80b60SJoe Perches } 579866c80b60SJoe Perches 579988982feaSJoe Perches# check for struct spinlock declarations 580088982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 580188982feaSJoe Perches WARN("USE_SPINLOCK_T", 580288982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 580388982feaSJoe Perches } 580488982feaSJoe Perches 5805a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 580606668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5807a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5808caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5809caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5810d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5811d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5812d5e616fcSJoe Perches $fix) { 5813194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5814d5e616fcSJoe Perches } 5815a6962d72SJoe Perches } 5816a6962d72SJoe Perches } 5817a6962d72SJoe Perches 58180b523769SJoe Perches # check for vsprintf extension %p<foo> misuses 58190b523769SJoe Perches if ($^V && $^V ge 5.10.0 && 58200b523769SJoe Perches defined $stat && 58210b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 58220b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 58230b523769SJoe Perches my $bad_extension = ""; 58240b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 58250b523769SJoe Perches $lc = $lc + $linenr; 58260b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 58270b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 58280b523769SJoe Perches $fmt =~ s/%%//g; 5829ab486bc9SLinus Torvalds if ($fmt =~ /(\%[\*\d\.]*p(?![\WSsBKRraEhMmIiUDdgVCbGNOx]).)/) { 58300b523769SJoe Perches $bad_extension = $1; 58310b523769SJoe Perches last; 58320b523769SJoe Perches } 58330b523769SJoe Perches } 58340b523769SJoe Perches if ($bad_extension ne "") { 5835*2a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 58361df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 58371df7338aSSergey Senozhatsky my $use = ""; 58381df7338aSSergey Senozhatsky if ($bad_extension =~ /p[Ff]/) { 58391df7338aSSergey Senozhatsky $ext_type = "Deprecated"; 58401df7338aSSergey Senozhatsky $use = " - use %pS instead"; 58411df7338aSSergey Senozhatsky $use =~ s/pS/ps/ if ($bad_extension =~ /pf/); 58421df7338aSSergey Senozhatsky } 5843*2a9f9d85STobin C. Harding 58440b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 58451df7338aSSergey Senozhatsky "$ext_type vsprintf pointer extension '$bad_extension'$use\n" . "$here\n$stat_real\n"); 58460b523769SJoe Perches } 58470b523769SJoe Perches } 58480b523769SJoe Perches 5849554e165cSAndy Whitcroft# Check for misused memsets 5850d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5851d1fe9c09SJoe Perches defined $stat && 58529e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5853554e165cSAndy Whitcroft 5854d7c76ba7SJoe Perches my $ms_addr = $2; 5855d1fe9c09SJoe Perches my $ms_val = $7; 5856d1fe9c09SJoe Perches my $ms_size = $12; 5857d7c76ba7SJoe Perches 5858554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5859554e165cSAndy Whitcroft ERROR("MEMSET", 5860d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5861554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5862554e165cSAndy Whitcroft WARN("MEMSET", 5863d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5864d7c76ba7SJoe Perches } 5865d7c76ba7SJoe Perches } 5866d7c76ba7SJoe Perches 586798a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 5868f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5869f333195dSJoe Perches# defined $stat && 5870f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5871f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 5872f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 5873f333195dSJoe Perches# $fix) { 5874f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 5875f333195dSJoe Perches# } 5876f333195dSJoe Perches# } 587798a9bba5SJoe Perches 5878b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 5879f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5880f333195dSJoe Perches# defined $stat && 5881f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5882f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 5883f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5884f333195dSJoe Perches# } 5885b6117d17SMateusz Kulikowski 58868617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 58878617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 5888f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5889f333195dSJoe Perches# defined $stat && 5890f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5891f333195dSJoe Perches# 5892f333195dSJoe Perches# my $ms_val = $7; 5893f333195dSJoe Perches# 5894f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 5895f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 5896f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 5897f333195dSJoe Perches# $fix) { 5898f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 5899f333195dSJoe Perches# } 5900f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 5901f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 5902f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 5903f333195dSJoe Perches# $fix) { 5904f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 5905f333195dSJoe Perches# } 5906f333195dSJoe Perches# } 5907f333195dSJoe Perches# } 59088617cd09SMateusz Kulikowski 5909d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5910d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5911d1fe9c09SJoe Perches defined $stat && 5912d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5913d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5914d7c76ba7SJoe Perches my $call = $1; 5915d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5916d7c76ba7SJoe Perches my $arg1 = $3; 5917d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5918d1fe9c09SJoe Perches my $arg2 = $8; 5919d7c76ba7SJoe Perches my $cast; 5920d7c76ba7SJoe Perches 5921d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5922d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5923d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5924d7c76ba7SJoe Perches $cast = $cast1; 5925d7c76ba7SJoe Perches } else { 5926d7c76ba7SJoe Perches $cast = $cast2; 5927d7c76ba7SJoe Perches } 5928d7c76ba7SJoe Perches WARN("MINMAX", 5929d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5930554e165cSAndy Whitcroft } 5931554e165cSAndy Whitcroft } 5932554e165cSAndy Whitcroft 59334a273195SJoe Perches# check usleep_range arguments 59344a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 59354a273195SJoe Perches defined $stat && 59364a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 59374a273195SJoe Perches my $min = $1; 59384a273195SJoe Perches my $max = $7; 59394a273195SJoe Perches if ($min eq $max) { 59404a273195SJoe Perches WARN("USLEEP_RANGE", 59414a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 59424a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 59434a273195SJoe Perches $min > $max) { 59444a273195SJoe Perches WARN("USLEEP_RANGE", 59454a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 59464a273195SJoe Perches } 59474a273195SJoe Perches } 59484a273195SJoe Perches 5949823b794cSJoe Perches# check for naked sscanf 5950823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5951823b794cSJoe Perches defined $stat && 59526c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5953823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5954823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5955823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5956823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5957823b794cSJoe Perches $lc = $lc + $linenr; 5958*2a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 5959823b794cSJoe Perches WARN("NAKED_SSCANF", 5960823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5961823b794cSJoe Perches } 5962823b794cSJoe Perches 5963afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5964afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5965afc819abSJoe Perches defined $stat && 5966afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5967afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5968afc819abSJoe Perches $lc = $lc + $linenr; 5969*2a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 5970afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5971afc819abSJoe Perches my $format = $6; 5972afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5973afc819abSJoe Perches if ($count == 1 && 5974afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5975afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5976afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5977afc819abSJoe Perches } 5978afc819abSJoe Perches } 5979afc819abSJoe Perches } 5980afc819abSJoe Perches 598170dc8a48SJoe Perches# check for new externs in .h files. 598270dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 598370dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5984d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 598570dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 598670dc8a48SJoe Perches $fix) { 5987194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 598870dc8a48SJoe Perches } 598970dc8a48SJoe Perches } 599070dc8a48SJoe Perches 5991de7d4f0eSAndy Whitcroft# check for new externs in .c files. 5992171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 5993c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 5994171ae1a4SAndy Whitcroft { 5995c45dcabdSAndy Whitcroft my $function_name = $1; 5996c45dcabdSAndy Whitcroft my $paren_space = $2; 5997171ae1a4SAndy Whitcroft 5998171ae1a4SAndy Whitcroft my $s = $stat; 5999171ae1a4SAndy Whitcroft if (defined $cond) { 6000171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 6001171ae1a4SAndy Whitcroft } 6002c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 6003c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 6004c45dcabdSAndy Whitcroft { 6005000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6006000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6007de7d4f0eSAndy Whitcroft } 6008de7d4f0eSAndy Whitcroft 6009171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 6010000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 6011000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 6012171ae1a4SAndy Whitcroft } 60139c9ba34eSAndy Whitcroft 60149c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 60159c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 60169c9ba34eSAndy Whitcroft { 6017000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6018000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6019171ae1a4SAndy Whitcroft } 6020171ae1a4SAndy Whitcroft 6021a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 6022a0ad7596SJoe Perches if (defined $stat && 602325bdda2bSMiles Chen $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 6024ca0d8929SJoe Perches $1 ne "void") { 6025ca0d8929SJoe Perches my $args = trim($1); 6026ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6027ca0d8929SJoe Perches my $arg = trim($1); 6028ca0d8929SJoe Perches if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 6029ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 6030ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6031ca0d8929SJoe Perches } 6032ca0d8929SJoe Perches } 6033ca0d8929SJoe Perches } 6034ca0d8929SJoe Perches 6035a0ad7596SJoe Perches# check for function definitions 6036a0ad7596SJoe Perches if ($^V && $^V ge 5.10.0 && 6037a0ad7596SJoe Perches defined $stat && 6038a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6039a0ad7596SJoe Perches $context_function = $1; 6040a0ad7596SJoe Perches 6041a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 6042a0ad7596SJoe Perches my $ok = 0; 6043a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 6044a0ad7596SJoe Perches my $herectx = $here . "\n"; 6045a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6046a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 6047a0ad7596SJoe Perches $herectx .= $rl . "\n"; 6048a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 6049a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 6050a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 6051a0ad7596SJoe Perches } 6052a0ad7596SJoe Perches if (!$ok) { 6053a0ad7596SJoe Perches ERROR("OPEN_BRACE", 6054a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 6055a0ad7596SJoe Perches } 6056a0ad7596SJoe Perches } 6057a0ad7596SJoe Perches 6058de7d4f0eSAndy Whitcroft# checks for new __setup's 6059de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 6060de7d4f0eSAndy Whitcroft my $name = $1; 6061de7d4f0eSAndy Whitcroft 6062de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 6063000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 60648c27ceffSMauro Carvalho Chehab "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr); 6065de7d4f0eSAndy Whitcroft } 6066653d4876SAndy Whitcroft } 60679c0ca6f9SAndy Whitcroft 60689c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 6069caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 6070000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 6071000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 60729c0ca6f9SAndy Whitcroft } 607313214adfSAndy Whitcroft 6074a640d25cSJoe Perches# alloc style 6075a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 6076a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 6077a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 6078a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 6079a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 6080a640d25cSJoe Perches } 6081a640d25cSJoe Perches 608260a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 608360a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 60841b4a2ed4SJoe Perches defined $stat && 60851b4a2ed4SJoe Perches $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 608660a55369SJoe Perches my $oldfunc = $3; 608760a55369SJoe Perches my $a1 = $4; 608860a55369SJoe Perches my $a2 = $10; 608960a55369SJoe Perches my $newfunc = "kmalloc_array"; 609060a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 609160a55369SJoe Perches my $r1 = $a1; 609260a55369SJoe Perches my $r2 = $a2; 609360a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 609460a55369SJoe Perches $r1 = $a2; 609560a55369SJoe Perches $r2 = $a1; 609660a55369SJoe Perches } 6097e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 6098e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 60991b4a2ed4SJoe Perches my $ctx = ''; 61001b4a2ed4SJoe Perches my $herectx = $here . "\n"; 61011b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 61021b4a2ed4SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 61031b4a2ed4SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 61041b4a2ed4SJoe Perches } 6105e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 61061b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 61071b4a2ed4SJoe Perches $cnt == 1 && 6108e367455aSJoe Perches $fix) { 6109194f66fcSJoe 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; 611060a55369SJoe Perches } 611160a55369SJoe Perches } 611260a55369SJoe Perches } 611360a55369SJoe Perches 6114972fdea2SJoe Perches# check for krealloc arg reuse 6115972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 6116972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 6117972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 6118972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 6119972fdea2SJoe Perches } 6120972fdea2SJoe Perches 61215ce59ae0SJoe Perches# check for alloc argument mismatch 61225ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 61235ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 61245ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 61255ce59ae0SJoe Perches } 61265ce59ae0SJoe Perches 6127caf2a54fSJoe Perches# check for multiple semicolons 6128caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 6129d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 6130d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 6131d5e616fcSJoe Perches $fix) { 6132194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 6133d5e616fcSJoe Perches } 6134d1e2ad07SJoe Perches } 6135d1e2ad07SJoe Perches 6136cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 6137cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 6138cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 61390ab90191SJoe Perches my $ull = ""; 61400ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 61410ab90191SJoe Perches if (CHK("BIT_MACRO", 61420ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 61430ab90191SJoe Perches $fix) { 61440ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 61450ab90191SJoe Perches } 61460ab90191SJoe Perches } 61470ab90191SJoe Perches 61482d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 61492d632745SJoe 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*$/) { 61502d632745SJoe Perches my $config = $1; 61512d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 61522d632745SJoe Perches "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) && 61532d632745SJoe Perches $fix) { 61542d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 61552d632745SJoe Perches } 61562d632745SJoe Perches } 61572d632745SJoe Perches 6158e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 6159c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 6160c34c09a8SJoe Perches my $has_break = 0; 6161c34c09a8SJoe Perches my $has_statement = 0; 6162c34c09a8SJoe Perches my $count = 0; 6163c34c09a8SJoe Perches my $prevline = $linenr; 6164e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 6165c34c09a8SJoe Perches $prevline--; 6166c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 6167c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 6168c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 6169c34c09a8SJoe Perches next if ($fline =~ /^\-/); 6170c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 6171c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 6172c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 6173c34c09a8SJoe Perches $has_statement = 1; 6174c34c09a8SJoe Perches $count++; 6175258f79d5SHeinrich Schuchardt $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/); 6176c34c09a8SJoe Perches } 6177c34c09a8SJoe Perches if (!$has_break && $has_statement) { 6178c34c09a8SJoe Perches WARN("MISSING_BREAK", 6179224236d9SAndrew Morton "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr); 6180c34c09a8SJoe Perches } 6181c34c09a8SJoe Perches } 6182c34c09a8SJoe Perches 6183d1e2ad07SJoe Perches# check for switch/default statements without a break; 6184d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 6185d1e2ad07SJoe Perches defined $stat && 6186d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 6187d1e2ad07SJoe Perches my $ctx = ''; 6188d1e2ad07SJoe Perches my $herectx = $here . "\n"; 6189d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 6190d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6191d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 6192d1e2ad07SJoe Perches } 6193d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 6194d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 6195caf2a54fSJoe Perches } 6196caf2a54fSJoe Perches 619713214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 6198d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 6199d5e616fcSJoe Perches if (WARN("USE_FUNC", 6200d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 6201d5e616fcSJoe Perches $fix) { 6202194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 6203d5e616fcSJoe Perches } 620413214adfSAndy Whitcroft } 6205773647a0SAndy Whitcroft 620662ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 620762ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 620862ec818fSJoe Perches ERROR("DATE_TIME", 620962ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 621062ec818fSJoe Perches } 621162ec818fSJoe Perches 62122c92488aSJoe Perches# check for use of yield() 62132c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 62142c92488aSJoe Perches WARN("YIELD", 62152c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 62162c92488aSJoe Perches } 62172c92488aSJoe Perches 6218179f8f40SJoe Perches# check for comparisons against true and false 6219179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 6220179f8f40SJoe Perches my $lead = $1; 6221179f8f40SJoe Perches my $arg = $2; 6222179f8f40SJoe Perches my $test = $3; 6223179f8f40SJoe Perches my $otype = $4; 6224179f8f40SJoe Perches my $trail = $5; 6225179f8f40SJoe Perches my $op = "!"; 6226179f8f40SJoe Perches 6227179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 6228179f8f40SJoe Perches 6229179f8f40SJoe Perches my $type = lc($otype); 6230179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 6231179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 6232179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 6233179f8f40SJoe Perches $op = ""; 6234179f8f40SJoe Perches } 6235179f8f40SJoe Perches 6236179f8f40SJoe Perches CHK("BOOL_COMPARISON", 6237179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 6238179f8f40SJoe Perches 6239179f8f40SJoe Perches## maybe suggesting a correct construct would better 6240179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 6241179f8f40SJoe Perches 6242179f8f40SJoe Perches } 6243179f8f40SJoe Perches } 6244179f8f40SJoe Perches 62454882720bSThomas Gleixner# check for semaphores initialized locked 62464882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 6247000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 6248000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 6249773647a0SAndy Whitcroft } 62506712d858SJoe Perches 625167d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 625267d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 6253000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 625467d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 6255773647a0SAndy Whitcroft } 62566712d858SJoe Perches 6257ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 6258f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 6259000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 6260ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 6261f3db6639SMichael Ellerman } 62626712d858SJoe Perches 62630f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 6264d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 62656903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 6266d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 6267000d1cc1SJoe Perches WARN("CONST_STRUCT", 6268d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 62692b6db5cbSAndy Whitcroft } 6270773647a0SAndy Whitcroft 6271773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 6272773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 6273773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 6274c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 6275c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 6276171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 6277171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 6278171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 6279773647a0SAndy Whitcroft { 6280000d1cc1SJoe Perches WARN("NR_CPUS", 6281000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 6282773647a0SAndy Whitcroft } 62839c9ba34eSAndy Whitcroft 628452ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 628552ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 628652ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 628752ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 628852ea8506SJoe Perches } 628952ea8506SJoe Perches 6290acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 6291acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 6292acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 6293acd9362cSJoe Perches WARN("LIKELY_MISUSE", 6294acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 6295acd9362cSJoe Perches } 6296acd9362cSJoe Perches 6297691d77b6SAndy Whitcroft# whine mightly about in_atomic 6298691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 6299691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 6300000d1cc1SJoe Perches ERROR("IN_ATOMIC", 6301000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 6302f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 6303000d1cc1SJoe Perches WARN("IN_ATOMIC", 6304000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 6305691d77b6SAndy Whitcroft } 6306691d77b6SAndy Whitcroft } 63071704f47bSPeter Zijlstra 63080f5225b0SPeter Zijlstra# check for mutex_trylock_recursive usage 63090f5225b0SPeter Zijlstra if ($line =~ /mutex_trylock_recursive/) { 63100f5225b0SPeter Zijlstra ERROR("LOCKING", 63110f5225b0SPeter Zijlstra "recursive locking is bad, do not use this ever.\n" . $herecurr); 63120f5225b0SPeter Zijlstra } 63130f5225b0SPeter Zijlstra 63141704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 63151704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 63161704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 63171704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 63181704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 63191704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 6320000d1cc1SJoe Perches ERROR("LOCKDEP", 6321000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 63221704f47bSPeter Zijlstra } 63231704f47bSPeter Zijlstra } 632488f8831cSDave Jones 6325b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 6326b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 6327000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 6328000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 632988f8831cSDave Jones } 63302435880fSJoe Perches 633100180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 633200180468SJoe Perches# and whether or not function naming is typical and if 633300180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 633400180468SJoe Perches if ($^V && $^V ge 5.10.0 && 633500180468SJoe Perches defined $stat && 633600180468SJoe Perches $stat =~ /\bDEVICE_ATTR\s*\(\s*(\w+)\s*,\s*\(?\s*(\s*(?:${multi_mode_perms_string_search}|0[0-7]{3,3})\s*)\s*\)?\s*,\s*(\w+)\s*,\s*(\w+)\s*\)/) { 633700180468SJoe Perches my $var = $1; 633800180468SJoe Perches my $perms = $2; 633900180468SJoe Perches my $show = $3; 634000180468SJoe Perches my $store = $4; 634100180468SJoe Perches my $octal_perms = perms_to_octal($perms); 634200180468SJoe Perches if ($show =~ /^${var}_show$/ && 634300180468SJoe Perches $store =~ /^${var}_store$/ && 634400180468SJoe Perches $octal_perms eq "0644") { 634500180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 634600180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 634700180468SJoe Perches $fix) { 634800180468SJoe Perches $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/; 634900180468SJoe Perches } 635000180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 635100180468SJoe Perches $store =~ /^NULL$/ && 635200180468SJoe Perches $octal_perms eq "0444") { 635300180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 635400180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 635500180468SJoe Perches $fix) { 635600180468SJoe Perches $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/; 635700180468SJoe Perches } 635800180468SJoe Perches } elsif ($show =~ /^NULL$/ && 635900180468SJoe Perches $store =~ /^${var}_store$/ && 636000180468SJoe Perches $octal_perms eq "0200") { 636100180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 636200180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 636300180468SJoe Perches $fix) { 636400180468SJoe Perches $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/; 636500180468SJoe Perches } 636600180468SJoe Perches } elsif ($octal_perms eq "0644" || 636700180468SJoe Perches $octal_perms eq "0444" || 636800180468SJoe Perches $octal_perms eq "0200") { 636900180468SJoe Perches my $newshow = "$show"; 637000180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 637100180468SJoe Perches my $newstore = $store; 637200180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 637300180468SJoe Perches my $rename = ""; 637400180468SJoe Perches if ($show ne $newshow) { 637500180468SJoe Perches $rename .= " '$show' to '$newshow'"; 637600180468SJoe Perches } 637700180468SJoe Perches if ($store ne $newstore) { 637800180468SJoe Perches $rename .= " '$store' to '$newstore'"; 637900180468SJoe Perches } 638000180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 638100180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 638200180468SJoe Perches } else { 638300180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 638400180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 638500180468SJoe Perches } 638600180468SJoe Perches } 638700180468SJoe Perches 6388515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 6389515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 639073121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 639173121534SJoe Perches# specific definition of not visible in sysfs. 639273121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 639373121534SJoe Perches# use the default permissions 6394515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 6395459cf0aeSJoe Perches defined $stat && 6396515a235eSJoe Perches $line =~ /$mode_perms_search/) { 63972435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 63982435880fSJoe Perches my $func = $entry->[0]; 63992435880fSJoe Perches my $arg_pos = $entry->[1]; 64002435880fSJoe Perches 6401459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 6402459cf0aeSJoe Perches $lc = $lc + $linenr; 6403*2a9f9d85STobin C. Harding my $stat_real = get_stat_real($linenr, $lc); 6404459cf0aeSJoe Perches 64052435880fSJoe Perches my $skip_args = ""; 64062435880fSJoe Perches if ($arg_pos > 1) { 64072435880fSJoe Perches $arg_pos--; 64082435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 64092435880fSJoe Perches } 6410f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 6411459cf0aeSJoe Perches if ($stat =~ /$test/) { 64122435880fSJoe Perches my $val = $1; 64132435880fSJoe Perches $val = $6 if ($skip_args ne ""); 641473121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 641573121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 641673121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 64172435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 6418459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 6419f90774e1SJoe Perches } 6420f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6421c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6422459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 64232435880fSJoe Perches } 6424459cf0aeSJoe Perches } 6425459cf0aeSJoe Perches } 6426459cf0aeSJoe Perches } 6427459cf0aeSJoe Perches 6428459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 642900180468SJoe Perches if ($line =~ /\b($multi_mode_perms_string_search)\b/) { 643000180468SJoe Perches my $oval = $1; 643100180468SJoe Perches my $octal = perms_to_octal($oval); 6432f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 6433459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 6434f90774e1SJoe Perches $fix) { 643500180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 64362435880fSJoe Perches } 643713214adfSAndy Whitcroft } 64385a6d20ceSBjorn Andersson 64395a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 64405a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 64415a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 64425a6d20ceSBjorn Andersson my $valid_licenses = qr{ 64435a6d20ceSBjorn Andersson GPL| 64445a6d20ceSBjorn Andersson GPL\ v2| 64455a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 64465a6d20ceSBjorn Andersson Dual\ BSD/GPL| 64475a6d20ceSBjorn Andersson Dual\ MIT/GPL| 64485a6d20ceSBjorn Andersson Dual\ MPL/GPL| 64495a6d20ceSBjorn Andersson Proprietary 64505a6d20ceSBjorn Andersson }x; 64515a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 64525a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 64535a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 64545a6d20ceSBjorn Andersson } 64555a6d20ceSBjorn Andersson } 6456515a235eSJoe Perches } 645713214adfSAndy Whitcroft 645813214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 645913214adfSAndy Whitcroft # so just keep quiet. 646013214adfSAndy Whitcroft if ($#rawlines == -1) { 646113214adfSAndy Whitcroft exit(0); 64620a920b5bSAndy Whitcroft } 64630a920b5bSAndy Whitcroft 64648905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 64658905a67cSAndy Whitcroft # things that appear to be patches. 64668905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 64678905a67cSAndy Whitcroft exit(0); 64688905a67cSAndy Whitcroft } 64698905a67cSAndy Whitcroft 64708905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 64718905a67cSAndy Whitcroft # just keep quiet. 64728905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 64738905a67cSAndy Whitcroft exit(0); 64748905a67cSAndy Whitcroft } 64758905a67cSAndy Whitcroft 6476a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 6477000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6478000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 64790a920b5bSAndy Whitcroft } 6480ed43c4e5SAllen Hubbe if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) { 6481000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6482000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 64830a920b5bSAndy Whitcroft } 64840a920b5bSAndy Whitcroft 6485f0a594c1SAndy Whitcroft print report_dump(); 648613214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 648713214adfSAndy Whitcroft print "$filename " if ($summary_file); 64886c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 64896c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 64906c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 64916c72ffaaSAndy Whitcroft } 64928905a67cSAndy Whitcroft 6493d2c0a235SAndy Whitcroft if ($quiet == 0) { 6494ef212196SJoe Perches # If there were any defects found and not already fixing them 6495ef212196SJoe Perches if (!$clean and !$fix) { 6496ef212196SJoe Perches print << "EOM" 6497ef212196SJoe Perches 6498ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 6499ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 6500ef212196SJoe PerchesEOM 6501ef212196SJoe Perches } 6502d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 6503d2c0a235SAndy Whitcroft # then suggest that. 6504d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 6505b0781216SMike Frysinger $rpt_cleaners = 0; 6506d8469f16SJoe Perches print << "EOM" 6507d8469f16SJoe Perches 6508d8469f16SJoe PerchesNOTE: Whitespace errors detected. 6509d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 6510d8469f16SJoe PerchesEOM 6511d2c0a235SAndy Whitcroft } 6512d2c0a235SAndy Whitcroft } 6513d2c0a235SAndy Whitcroft 6514d752fcc8SJoe Perches if ($clean == 0 && $fix && 6515d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 6516d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 65179624b8d6SJoe Perches my $newfile = $filename; 65189624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 65193705ce5bSJoe Perches my $linecount = 0; 65203705ce5bSJoe Perches my $f; 65213705ce5bSJoe Perches 6522d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 6523d752fcc8SJoe Perches 65243705ce5bSJoe Perches open($f, '>', $newfile) 65253705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 65263705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 65273705ce5bSJoe Perches $linecount++; 65283705ce5bSJoe Perches if ($file) { 65293705ce5bSJoe Perches if ($linecount > 3) { 65303705ce5bSJoe Perches $fixed_line =~ s/^\+//; 65313705ce5bSJoe Perches print $f $fixed_line . "\n"; 65323705ce5bSJoe Perches } 65333705ce5bSJoe Perches } else { 65343705ce5bSJoe Perches print $f $fixed_line . "\n"; 65353705ce5bSJoe Perches } 65363705ce5bSJoe Perches } 65373705ce5bSJoe Perches close($f); 65383705ce5bSJoe Perches 65393705ce5bSJoe Perches if (!$quiet) { 65403705ce5bSJoe Perches print << "EOM"; 6541d8469f16SJoe Perches 65423705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 65433705ce5bSJoe Perches 65443705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 65453705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 65463705ce5bSJoe Perches 65473705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 65483705ce5bSJoe PerchesNo warranties, expressed or implied... 65493705ce5bSJoe PerchesEOM 65503705ce5bSJoe Perches } 65513705ce5bSJoe Perches } 65523705ce5bSJoe Perches 6553d8469f16SJoe Perches if ($quiet == 0) { 6554d8469f16SJoe Perches print "\n"; 6555d8469f16SJoe Perches if ($clean == 1) { 6556d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 6557d8469f16SJoe Perches } else { 6558d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 65590a920b5bSAndy Whitcroft } 65600a920b5bSAndy Whitcroft } 65610a920b5bSAndy Whitcroft return $clean; 65620a920b5bSAndy Whitcroft} 6563