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*\(| 794f8422308SJoe Perches (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\( 795f8422308SJoe Perches)}; 796f8422308SJoe Perches 7977d2367afSJoe Perchessub deparenthesize { 7987d2367afSJoe Perches my ($string) = @_; 7997d2367afSJoe Perches return "" if (!defined($string)); 8005b9553abSJoe Perches 8015b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 8025b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 8035b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 8045b9553abSJoe Perches } 8055b9553abSJoe Perches 8067d2367afSJoe Perches $string =~ s@\s+@ @g; 8075b9553abSJoe Perches 8087d2367afSJoe Perches return $string; 8097d2367afSJoe Perches} 8107d2367afSJoe Perches 8113445686aSJoe Perchessub seed_camelcase_file { 8123445686aSJoe Perches my ($file) = @_; 8133445686aSJoe Perches 8143445686aSJoe Perches return if (!(-f $file)); 8153445686aSJoe Perches 8163445686aSJoe Perches local $/; 8173445686aSJoe Perches 8183445686aSJoe Perches open(my $include_file, '<', "$file") 8193445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 8203445686aSJoe Perches my $text = <$include_file>; 8213445686aSJoe Perches close($include_file); 8223445686aSJoe Perches 8233445686aSJoe Perches my @lines = split('\n', $text); 8243445686aSJoe Perches 8253445686aSJoe Perches foreach my $line (@lines) { 8263445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 8273445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 8283445686aSJoe Perches $camelcase{$1} = 1; 82911ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 83011ea516aSJoe Perches $camelcase{$1} = 1; 83111ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 8323445686aSJoe Perches $camelcase{$1} = 1; 8333445686aSJoe Perches } 8343445686aSJoe Perches } 8353445686aSJoe Perches} 8363445686aSJoe Perches 83785b0ee18SJoe Perchessub is_maintained_obsolete { 83885b0ee18SJoe Perches my ($filename) = @_; 83985b0ee18SJoe Perches 840f2c19c2fSJerome Forissier return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 84185b0ee18SJoe Perches 8420616efa4SJoe Perches my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 84385b0ee18SJoe Perches 84485b0ee18SJoe Perches return $status =~ /obsolete/i; 84585b0ee18SJoe Perches} 84685b0ee18SJoe Perches 8473445686aSJoe Perchesmy $camelcase_seeded = 0; 8483445686aSJoe Perchessub seed_camelcase_includes { 8493445686aSJoe Perches return if ($camelcase_seeded); 8503445686aSJoe Perches 8513445686aSJoe Perches my $files; 852c707a81dSJoe Perches my $camelcase_cache = ""; 853c707a81dSJoe Perches my @include_files = (); 854c707a81dSJoe Perches 855c707a81dSJoe Perches $camelcase_seeded = 1; 856351b2a1fSJoe Perches 8573645e328SRichard Genoud if (-e ".git") { 858351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 859351b2a1fSJoe Perches chomp $git_last_include_commit; 860c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 861c707a81dSJoe Perches } else { 862c707a81dSJoe Perches my $last_mod_date = 0; 863c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 864c707a81dSJoe Perches @include_files = split('\n', $files); 865c707a81dSJoe Perches foreach my $file (@include_files) { 866c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 867c707a81dSJoe Perches localtime((stat $file)[9])); 868c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 869c707a81dSJoe Perches } 870c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 871c707a81dSJoe Perches } 872c707a81dSJoe Perches 873c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 874c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 875c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 876351b2a1fSJoe Perches while (<$camelcase_file>) { 877351b2a1fSJoe Perches chomp; 878351b2a1fSJoe Perches $camelcase{$_} = 1; 879351b2a1fSJoe Perches } 880351b2a1fSJoe Perches close($camelcase_file); 881351b2a1fSJoe Perches 882351b2a1fSJoe Perches return; 883351b2a1fSJoe Perches } 884c707a81dSJoe Perches 8853645e328SRichard Genoud if (-e ".git") { 886c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 887c707a81dSJoe Perches @include_files = split('\n', $files); 8883445686aSJoe Perches } 889c707a81dSJoe Perches 8903445686aSJoe Perches foreach my $file (@include_files) { 8913445686aSJoe Perches seed_camelcase_file($file); 8923445686aSJoe Perches } 893351b2a1fSJoe Perches 894c707a81dSJoe Perches if ($camelcase_cache ne "") { 895351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 896c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 897c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 898351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 899351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 900351b2a1fSJoe Perches } 901351b2a1fSJoe Perches close($camelcase_file); 902351b2a1fSJoe Perches } 9033445686aSJoe Perches} 9043445686aSJoe Perches 905d311cd44SJoe Perchessub git_commit_info { 906d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 907d311cd44SJoe Perches 908d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 909d311cd44SJoe Perches 910d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 911d311cd44SJoe Perches $output =~ s/^\s*//gm; 912d311cd44SJoe Perches my @lines = split("\n", $output); 913d311cd44SJoe Perches 9140d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 9150d7835fcSJoe Perches 916d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 917d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 918d311cd44SJoe Perches# all matching commit ids, but it's very slow... 919d311cd44SJoe Perches# 920d311cd44SJoe Perches# echo "checking commits $1..." 921d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 922d311cd44SJoe Perches# while read line ; do 923d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 924d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 925d311cd44SJoe Perches# done 926d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 927948b133aSHeinrich Schuchardt $id = undef; 928d311cd44SJoe Perches } else { 929d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 930d311cd44SJoe Perches $desc = substr($lines[0], 41); 931d311cd44SJoe Perches } 932d311cd44SJoe Perches 933d311cd44SJoe Perches return ($id, $desc); 934d311cd44SJoe Perches} 935d311cd44SJoe Perches 9366c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 9370a920b5bSAndy Whitcroft 93800df344fSAndy Whitcroftmy @rawlines = (); 939c2fdda0dSAndy Whitcroftmy @lines = (); 9403705ce5bSJoe Perchesmy @fixed = (); 941d752fcc8SJoe Perchesmy @fixed_inserted = (); 942d752fcc8SJoe Perchesmy @fixed_deleted = (); 943194f66fcSJoe Perchesmy $fixlinenr = -1; 944194f66fcSJoe Perches 9454a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 9464a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 9474a593c34SDu, Changbindie "$P: No git repository found\n" if ($git && !-e ".git"); 9484a593c34SDu, Changbin 9494a593c34SDu, Changbinif ($git) { 9504a593c34SDu, Changbin my @commits = (); 9510dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 9524a593c34SDu, Changbin my $git_range; 95328898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 95428898fd1SJoe Perches $git_range = "-$2 $1"; 9554a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 9564a593c34SDu, Changbin $git_range = "$commit_expr"; 9574a593c34SDu, Changbin } else { 9580dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 9590dea9f1eSJoe Perches } 9600dea9f1eSJoe Perches my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 9610dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 96228898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 96328898fd1SJoe Perches next if (!defined($1) || !defined($2)); 9640dea9f1eSJoe Perches my $sha1 = $1; 9650dea9f1eSJoe Perches my $subject = $2; 9660dea9f1eSJoe Perches unshift(@commits, $sha1); 9670dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 9684a593c34SDu, Changbin } 9694a593c34SDu, Changbin } 9704a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 9714a593c34SDu, Changbin @ARGV = @commits; 9724a593c34SDu, Changbin} 9734a593c34SDu, Changbin 974c2fdda0dSAndy Whitcroftmy $vname; 9756c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 97621caa13cSAndy Whitcroft my $FILE; 9774a593c34SDu, Changbin if ($git) { 9784a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 9794a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 9804a593c34SDu, Changbin } elsif ($file) { 98121caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 9826c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 98321caa13cSAndy Whitcroft } elsif ($filename eq '-') { 98421caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 9856c72ffaaSAndy Whitcroft } else { 98621caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 9876c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 9886c72ffaaSAndy Whitcroft } 989c2fdda0dSAndy Whitcroft if ($filename eq '-') { 990c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 9914a593c34SDu, Changbin } elsif ($git) { 9920dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 993c2fdda0dSAndy Whitcroft } else { 994c2fdda0dSAndy Whitcroft $vname = $filename; 995c2fdda0dSAndy Whitcroft } 99621caa13cSAndy Whitcroft while (<$FILE>) { 9970a920b5bSAndy Whitcroft chomp; 99800df344fSAndy Whitcroft push(@rawlines, $_); 9996c72ffaaSAndy Whitcroft } 100021caa13cSAndy Whitcroft close($FILE); 1001d8469f16SJoe Perches 1002d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 1003d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1004d8469f16SJoe Perches print "$vname\n"; 1005d8469f16SJoe Perches print '-' x length($vname) . "\n"; 1006d8469f16SJoe Perches } 1007d8469f16SJoe Perches 1008c2fdda0dSAndy Whitcroft if (!process($filename)) { 10090a920b5bSAndy Whitcroft $exit = 1; 10100a920b5bSAndy Whitcroft } 101100df344fSAndy Whitcroft @rawlines = (); 101213214adfSAndy Whitcroft @lines = (); 10133705ce5bSJoe Perches @fixed = (); 1014d752fcc8SJoe Perches @fixed_inserted = (); 1015d752fcc8SJoe Perches @fixed_deleted = (); 1016194f66fcSJoe Perches $fixlinenr = -1; 1017485ff23eSAlex Dowad @modifierListFile = (); 1018485ff23eSAlex Dowad @typeListFile = (); 1019485ff23eSAlex Dowad build_types(); 10200a920b5bSAndy Whitcroft} 10210a920b5bSAndy Whitcroft 1022d8469f16SJoe Perchesif (!$quiet) { 10233c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 10243c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 10253c816e49SJoe Perches 1026d8469f16SJoe Perches if ($^V lt 5.10.0) { 1027d8469f16SJoe Perches print << "EOM" 1028d8469f16SJoe Perches 1029d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 1030d8469f16SJoe Perches An upgrade to at least perl v5.10.0 is suggested. 1031d8469f16SJoe PerchesEOM 1032d8469f16SJoe Perches } 1033d8469f16SJoe Perches if ($exit) { 1034d8469f16SJoe Perches print << "EOM" 1035d8469f16SJoe Perches 1036d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 1037d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 1038d8469f16SJoe PerchesEOM 1039d8469f16SJoe Perches } 1040d8469f16SJoe Perches} 1041d8469f16SJoe Perches 10420a920b5bSAndy Whitcroftexit($exit); 10430a920b5bSAndy Whitcroft 10440a920b5bSAndy Whitcroftsub top_of_kernel_tree { 10456c72ffaaSAndy Whitcroft my ($root) = @_; 10466c72ffaaSAndy Whitcroft 10476c72ffaaSAndy Whitcroft my @tree_check = ( 10486c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 10496c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 10506c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 10516c72ffaaSAndy Whitcroft ); 10526c72ffaaSAndy Whitcroft 10536c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 10546c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 10550a920b5bSAndy Whitcroft return 0; 10560a920b5bSAndy Whitcroft } 10576c72ffaaSAndy Whitcroft } 10586c72ffaaSAndy Whitcroft return 1; 10596c72ffaaSAndy Whitcroft} 10600a920b5bSAndy Whitcroft 106120112475SJoe Perchessub parse_email { 106220112475SJoe Perches my ($formatted_email) = @_; 106320112475SJoe Perches 106420112475SJoe Perches my $name = ""; 106520112475SJoe Perches my $address = ""; 106620112475SJoe Perches my $comment = ""; 106720112475SJoe Perches 106820112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 106920112475SJoe Perches $name = $1; 107020112475SJoe Perches $address = $2; 107120112475SJoe Perches $comment = $3 if defined $3; 107220112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 107320112475SJoe Perches $address = $1; 107420112475SJoe Perches $comment = $2 if defined $2; 107520112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 107620112475SJoe Perches $address = $1; 107720112475SJoe Perches $comment = $2 if defined $2; 107885e12066SJoe Perches $formatted_email =~ s/\Q$address\E.*$//; 107920112475SJoe Perches $name = $formatted_email; 10803705ce5bSJoe Perches $name = trim($name); 108120112475SJoe Perches $name =~ s/^\"|\"$//g; 108220112475SJoe Perches # If there's a name left after stripping spaces and 108320112475SJoe Perches # leading quotes, and the address doesn't have both 108420112475SJoe Perches # leading and trailing angle brackets, the address 108520112475SJoe Perches # is invalid. ie: 108620112475SJoe Perches # "joe smith [email protected]" bad 108720112475SJoe Perches # "joe smith <[email protected]" bad 108820112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 108920112475SJoe Perches $name = ""; 109020112475SJoe Perches $address = ""; 109120112475SJoe Perches $comment = ""; 109220112475SJoe Perches } 109320112475SJoe Perches } 109420112475SJoe Perches 10953705ce5bSJoe Perches $name = trim($name); 109620112475SJoe Perches $name =~ s/^\"|\"$//g; 10973705ce5bSJoe Perches $address = trim($address); 109820112475SJoe Perches $address =~ s/^\<|\>$//g; 109920112475SJoe Perches 110020112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 110120112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 110220112475SJoe Perches $name = "\"$name\""; 110320112475SJoe Perches } 110420112475SJoe Perches 110520112475SJoe Perches return ($name, $address, $comment); 110620112475SJoe Perches} 110720112475SJoe Perches 110820112475SJoe Perchessub format_email { 110920112475SJoe Perches my ($name, $address) = @_; 111020112475SJoe Perches 111120112475SJoe Perches my $formatted_email; 111220112475SJoe Perches 11133705ce5bSJoe Perches $name = trim($name); 111420112475SJoe Perches $name =~ s/^\"|\"$//g; 11153705ce5bSJoe Perches $address = trim($address); 111620112475SJoe Perches 111720112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 111820112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 111920112475SJoe Perches $name = "\"$name\""; 112020112475SJoe Perches } 112120112475SJoe Perches 112220112475SJoe Perches if ("$name" eq "") { 112320112475SJoe Perches $formatted_email = "$address"; 112420112475SJoe Perches } else { 112520112475SJoe Perches $formatted_email = "$name <$address>"; 112620112475SJoe Perches } 112720112475SJoe Perches 112820112475SJoe Perches return $formatted_email; 112920112475SJoe Perches} 113020112475SJoe Perches 1131d311cd44SJoe Perchessub which { 1132d311cd44SJoe Perches my ($bin) = @_; 1133d311cd44SJoe Perches 1134d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1135d311cd44SJoe Perches if (-e "$path/$bin") { 1136d311cd44SJoe Perches return "$path/$bin"; 1137d311cd44SJoe Perches } 1138d311cd44SJoe Perches } 1139d311cd44SJoe Perches 1140d311cd44SJoe Perches return ""; 1141d311cd44SJoe Perches} 1142d311cd44SJoe Perches 1143000d1cc1SJoe Perchessub which_conf { 1144000d1cc1SJoe Perches my ($conf) = @_; 1145000d1cc1SJoe Perches 1146000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1147000d1cc1SJoe Perches if (-e "$path/$conf") { 1148000d1cc1SJoe Perches return "$path/$conf"; 1149000d1cc1SJoe Perches } 1150000d1cc1SJoe Perches } 1151000d1cc1SJoe Perches 1152000d1cc1SJoe Perches return ""; 1153000d1cc1SJoe Perches} 1154000d1cc1SJoe Perches 11550a920b5bSAndy Whitcroftsub expand_tabs { 11560a920b5bSAndy Whitcroft my ($str) = @_; 11570a920b5bSAndy Whitcroft 11580a920b5bSAndy Whitcroft my $res = ''; 11590a920b5bSAndy Whitcroft my $n = 0; 11600a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 11610a920b5bSAndy Whitcroft if ($c eq "\t") { 11620a920b5bSAndy Whitcroft $res .= ' '; 11630a920b5bSAndy Whitcroft $n++; 11640a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 11650a920b5bSAndy Whitcroft $res .= ' '; 11660a920b5bSAndy Whitcroft } 11670a920b5bSAndy Whitcroft next; 11680a920b5bSAndy Whitcroft } 11690a920b5bSAndy Whitcroft $res .= $c; 11700a920b5bSAndy Whitcroft $n++; 11710a920b5bSAndy Whitcroft } 11720a920b5bSAndy Whitcroft 11730a920b5bSAndy Whitcroft return $res; 11740a920b5bSAndy Whitcroft} 11756c72ffaaSAndy Whitcroftsub copy_spacing { 1176773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 11776c72ffaaSAndy Whitcroft return $res; 11786c72ffaaSAndy Whitcroft} 11790a920b5bSAndy Whitcroft 11804a0df2efSAndy Whitcroftsub line_stats { 11814a0df2efSAndy Whitcroft my ($line) = @_; 11824a0df2efSAndy Whitcroft 11834a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 11844a0df2efSAndy Whitcroft $line =~ s/^.//; 11854a0df2efSAndy Whitcroft $line = expand_tabs($line); 11864a0df2efSAndy Whitcroft 11874a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 11884a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 11894a0df2efSAndy Whitcroft 11904a0df2efSAndy Whitcroft return (length($line), length($white)); 11914a0df2efSAndy Whitcroft} 11924a0df2efSAndy Whitcroft 1193773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1194773647a0SAndy Whitcroft 1195773647a0SAndy Whitcroftsub sanitise_line_reset { 1196773647a0SAndy Whitcroft my ($in_comment) = @_; 1197773647a0SAndy Whitcroft 1198773647a0SAndy Whitcroft if ($in_comment) { 1199773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1200773647a0SAndy Whitcroft } else { 1201773647a0SAndy Whitcroft $sanitise_quote = ''; 1202773647a0SAndy Whitcroft } 1203773647a0SAndy Whitcroft} 120400df344fSAndy Whitcroftsub sanitise_line { 120500df344fSAndy Whitcroft my ($line) = @_; 120600df344fSAndy Whitcroft 120700df344fSAndy Whitcroft my $res = ''; 120800df344fSAndy Whitcroft my $l = ''; 120900df344fSAndy Whitcroft 1210c2fdda0dSAndy Whitcroft my $qlen = 0; 1211773647a0SAndy Whitcroft my $off = 0; 1212773647a0SAndy Whitcroft my $c; 121300df344fSAndy Whitcroft 1214773647a0SAndy Whitcroft # Always copy over the diff marker. 1215773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1216773647a0SAndy Whitcroft 1217773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1218773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1219773647a0SAndy Whitcroft 1220773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 1221773647a0SAndy Whitcroft # and end, all to $;. 1222773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1223773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1224773647a0SAndy Whitcroft 1225773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1226773647a0SAndy Whitcroft $off++; 122700df344fSAndy Whitcroft next; 1228773647a0SAndy Whitcroft } 122981bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1230773647a0SAndy Whitcroft $sanitise_quote = ''; 1231773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1232773647a0SAndy Whitcroft $off++; 1233773647a0SAndy Whitcroft next; 1234773647a0SAndy Whitcroft } 1235113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1236113f04a8SDaniel Walker $sanitise_quote = '//'; 1237113f04a8SDaniel Walker 1238113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1239113f04a8SDaniel Walker $off++; 1240113f04a8SDaniel Walker next; 1241113f04a8SDaniel Walker } 1242773647a0SAndy Whitcroft 1243773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1244773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1245773647a0SAndy Whitcroft $c eq "\\") { 1246773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1247773647a0SAndy Whitcroft $off++; 1248773647a0SAndy Whitcroft next; 1249773647a0SAndy Whitcroft } 1250773647a0SAndy Whitcroft # Regular quotes. 1251773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1252773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1253773647a0SAndy Whitcroft $sanitise_quote = $c; 1254773647a0SAndy Whitcroft 1255773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1256773647a0SAndy Whitcroft next; 1257773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1258773647a0SAndy Whitcroft $sanitise_quote = ''; 125900df344fSAndy Whitcroft } 126000df344fSAndy Whitcroft } 1261773647a0SAndy Whitcroft 1262fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1263773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1264773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1265113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1266113f04a8SDaniel Walker substr($res, $off, 1, $;); 1267773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1268773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 126900df344fSAndy Whitcroft } else { 1270773647a0SAndy Whitcroft substr($res, $off, 1, $c); 127100df344fSAndy Whitcroft } 1272c2fdda0dSAndy Whitcroft } 1273c2fdda0dSAndy Whitcroft 1274113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1275113f04a8SDaniel Walker $sanitise_quote = ''; 1276113f04a8SDaniel Walker } 1277113f04a8SDaniel Walker 1278c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1279c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1280c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1281c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1282c2fdda0dSAndy Whitcroft 1283c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1284c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1285c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1286c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1287c2fdda0dSAndy Whitcroft } 1288c2fdda0dSAndy Whitcroft 1289dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1290dadf680dSJoe Perches my $match = $1; 1291dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1292dadf680dSJoe Perches } 1293dadf680dSJoe Perches 129400df344fSAndy Whitcroft return $res; 129500df344fSAndy Whitcroft} 129600df344fSAndy Whitcroft 1297a6962d72SJoe Perchessub get_quoted_string { 1298a6962d72SJoe Perches my ($line, $rawline) = @_; 1299a6962d72SJoe Perches 130033acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1301a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1302a6962d72SJoe Perches} 1303a6962d72SJoe Perches 13048905a67cSAndy Whitcroftsub ctx_statement_block { 13058905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 13068905a67cSAndy Whitcroft my $line = $linenr - 1; 13078905a67cSAndy Whitcroft my $blk = ''; 13088905a67cSAndy Whitcroft my $soff = $off; 13098905a67cSAndy Whitcroft my $coff = $off - 1; 1310773647a0SAndy Whitcroft my $coff_set = 0; 13118905a67cSAndy Whitcroft 131213214adfSAndy Whitcroft my $loff = 0; 131313214adfSAndy Whitcroft 13148905a67cSAndy Whitcroft my $type = ''; 13158905a67cSAndy Whitcroft my $level = 0; 1316a2750645SAndy Whitcroft my @stack = (); 1317cf655043SAndy Whitcroft my $p; 13188905a67cSAndy Whitcroft my $c; 13198905a67cSAndy Whitcroft my $len = 0; 132013214adfSAndy Whitcroft 132113214adfSAndy Whitcroft my $remainder; 13228905a67cSAndy Whitcroft while (1) { 1323a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1324a2750645SAndy Whitcroft 1325773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 13268905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 13278905a67cSAndy Whitcroft # context. 13288905a67cSAndy Whitcroft if ($off >= $len) { 13298905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1330dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1331c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 13328905a67cSAndy Whitcroft $remain--; 133313214adfSAndy Whitcroft $loff = $len; 1334c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 13358905a67cSAndy Whitcroft $len = length($blk); 13368905a67cSAndy Whitcroft $line++; 13378905a67cSAndy Whitcroft last; 13388905a67cSAndy Whitcroft } 13398905a67cSAndy Whitcroft # Bail if there is no further context. 13408905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 134113214adfSAndy Whitcroft if ($off >= $len) { 13428905a67cSAndy Whitcroft last; 13438905a67cSAndy Whitcroft } 1344f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1345f74bd194SAndy Whitcroft $level++; 1346f74bd194SAndy Whitcroft $type = '#'; 1347f74bd194SAndy Whitcroft } 13488905a67cSAndy Whitcroft } 1349cf655043SAndy Whitcroft $p = $c; 13508905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 135113214adfSAndy Whitcroft $remainder = substr($blk, $off); 13528905a67cSAndy Whitcroft 1353773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 13544635f4fbSAndy Whitcroft 13554635f4fbSAndy Whitcroft # Handle nested #if/#else. 13564635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 13574635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 13584635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 13594635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 13604635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 13614635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 13624635f4fbSAndy Whitcroft } 13634635f4fbSAndy Whitcroft 13648905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 13658905a67cSAndy Whitcroft # outermost level. 13668905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 13678905a67cSAndy Whitcroft last; 13688905a67cSAndy Whitcroft } 13698905a67cSAndy Whitcroft 137013214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1371773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1372773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1373773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1374773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1375773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1376773647a0SAndy Whitcroft $coff_set = 1; 1377773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1378773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 137913214adfSAndy Whitcroft } 138013214adfSAndy Whitcroft 13818905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 13828905a67cSAndy Whitcroft $level++; 13838905a67cSAndy Whitcroft $type = '('; 13848905a67cSAndy Whitcroft } 13858905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 13868905a67cSAndy Whitcroft $level--; 13878905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 13888905a67cSAndy Whitcroft 13898905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 13908905a67cSAndy Whitcroft $coff = $off; 1391773647a0SAndy Whitcroft $coff_set = 1; 1392773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 13938905a67cSAndy Whitcroft } 13948905a67cSAndy Whitcroft } 13958905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 13968905a67cSAndy Whitcroft $level++; 13978905a67cSAndy Whitcroft $type = '{'; 13988905a67cSAndy Whitcroft } 13998905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 14008905a67cSAndy Whitcroft $level--; 14018905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 14028905a67cSAndy Whitcroft 14038905a67cSAndy Whitcroft if ($level == 0) { 1404b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1405b998e001SPatrick Pannuto $off++; 1406b998e001SPatrick Pannuto } 14078905a67cSAndy Whitcroft last; 14088905a67cSAndy Whitcroft } 14098905a67cSAndy Whitcroft } 1410f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1411f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1412f74bd194SAndy Whitcroft $level--; 1413f74bd194SAndy Whitcroft $type = ''; 1414f74bd194SAndy Whitcroft $off++; 1415f74bd194SAndy Whitcroft last; 1416f74bd194SAndy Whitcroft } 14178905a67cSAndy Whitcroft $off++; 14188905a67cSAndy Whitcroft } 1419a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 142013214adfSAndy Whitcroft if ($off == $len) { 1421a3bb97a7SAndy Whitcroft $loff = $len + 1; 142213214adfSAndy Whitcroft $line++; 142313214adfSAndy Whitcroft $remain--; 142413214adfSAndy Whitcroft } 14258905a67cSAndy Whitcroft 14268905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 14278905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 14288905a67cSAndy Whitcroft 14298905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 14308905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 14318905a67cSAndy Whitcroft 1432773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 143313214adfSAndy Whitcroft 143413214adfSAndy Whitcroft return ($statement, $condition, 143513214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 143613214adfSAndy Whitcroft} 143713214adfSAndy Whitcroft 1438cf655043SAndy Whitcroftsub statement_lines { 1439cf655043SAndy Whitcroft my ($stmt) = @_; 1440cf655043SAndy Whitcroft 1441cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1442cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1443cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1444cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1445cf655043SAndy Whitcroft 1446cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1447cf655043SAndy Whitcroft 1448cf655043SAndy Whitcroft return $#stmt_lines + 2; 1449cf655043SAndy Whitcroft} 1450cf655043SAndy Whitcroft 1451cf655043SAndy Whitcroftsub statement_rawlines { 1452cf655043SAndy Whitcroft my ($stmt) = @_; 1453cf655043SAndy Whitcroft 1454cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1455cf655043SAndy Whitcroft 1456cf655043SAndy Whitcroft return $#stmt_lines + 2; 1457cf655043SAndy Whitcroft} 1458cf655043SAndy Whitcroft 1459cf655043SAndy Whitcroftsub statement_block_size { 1460cf655043SAndy Whitcroft my ($stmt) = @_; 1461cf655043SAndy Whitcroft 1462cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1463cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1464cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1465cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1466cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1467cf655043SAndy Whitcroft 1468cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1469cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1470cf655043SAndy Whitcroft 1471cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1472cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1473cf655043SAndy Whitcroft 1474cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1475cf655043SAndy Whitcroft return $stmt_lines; 1476cf655043SAndy Whitcroft } else { 1477cf655043SAndy Whitcroft return $stmt_statements; 1478cf655043SAndy Whitcroft } 1479cf655043SAndy Whitcroft} 1480cf655043SAndy Whitcroft 148113214adfSAndy Whitcroftsub ctx_statement_full { 148213214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 148313214adfSAndy Whitcroft my ($statement, $condition, $level); 148413214adfSAndy Whitcroft 148513214adfSAndy Whitcroft my (@chunks); 148613214adfSAndy Whitcroft 1487cf655043SAndy Whitcroft # Grab the first conditional/block pair. 148813214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 148913214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1490773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 149113214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1492cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1493cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1494cf655043SAndy Whitcroft } 1495cf655043SAndy Whitcroft 1496cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1497cf655043SAndy Whitcroft # could continue the statement. 1498cf655043SAndy Whitcroft for (;;) { 149913214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 150013214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1501cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1502773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1503cf655043SAndy Whitcroft #print "C: push\n"; 1504cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 150513214adfSAndy Whitcroft } 150613214adfSAndy Whitcroft 150713214adfSAndy Whitcroft return ($level, $linenr, @chunks); 15088905a67cSAndy Whitcroft} 15098905a67cSAndy Whitcroft 15104a0df2efSAndy Whitcroftsub ctx_block_get { 1511f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 15124a0df2efSAndy Whitcroft my $line; 15134a0df2efSAndy Whitcroft my $start = $linenr - 1; 15144a0df2efSAndy Whitcroft my $blk = ''; 15154a0df2efSAndy Whitcroft my @o; 15164a0df2efSAndy Whitcroft my @c; 15174a0df2efSAndy Whitcroft my @res = (); 15184a0df2efSAndy Whitcroft 1519f0a594c1SAndy Whitcroft my $level = 0; 15204635f4fbSAndy Whitcroft my @stack = ($level); 152100df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 152200df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 152300df344fSAndy Whitcroft $remain--; 152400df344fSAndy Whitcroft 152500df344fSAndy Whitcroft $blk .= $rawlines[$line]; 15264635f4fbSAndy Whitcroft 15274635f4fbSAndy Whitcroft # Handle nested #if/#else. 152801464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 15294635f4fbSAndy Whitcroft push(@stack, $level); 153001464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 15314635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 153201464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 15334635f4fbSAndy Whitcroft $level = pop(@stack); 15344635f4fbSAndy Whitcroft } 15354635f4fbSAndy Whitcroft 153601464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1537f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1538f0a594c1SAndy Whitcroft if ($off > 0) { 1539f0a594c1SAndy Whitcroft $off--; 1540f0a594c1SAndy Whitcroft next; 1541f0a594c1SAndy Whitcroft } 15424a0df2efSAndy Whitcroft 1543f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1544f0a594c1SAndy Whitcroft $level--; 1545f0a594c1SAndy Whitcroft last if ($level == 0); 1546f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1547f0a594c1SAndy Whitcroft $level++; 1548f0a594c1SAndy Whitcroft } 1549f0a594c1SAndy Whitcroft } 15504a0df2efSAndy Whitcroft 1551f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 155200df344fSAndy Whitcroft push(@res, $rawlines[$line]); 15534a0df2efSAndy Whitcroft } 15544a0df2efSAndy Whitcroft 1555f0a594c1SAndy Whitcroft last if ($level == 0); 15564a0df2efSAndy Whitcroft } 15574a0df2efSAndy Whitcroft 1558f0a594c1SAndy Whitcroft return ($level, @res); 15594a0df2efSAndy Whitcroft} 15604a0df2efSAndy Whitcroftsub ctx_block_outer { 15614a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 15624a0df2efSAndy Whitcroft 1563f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1564f0a594c1SAndy Whitcroft return @r; 15654a0df2efSAndy Whitcroft} 15664a0df2efSAndy Whitcroftsub ctx_block { 15674a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 15684a0df2efSAndy Whitcroft 1569f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1570f0a594c1SAndy Whitcroft return @r; 1571653d4876SAndy Whitcroft} 1572653d4876SAndy Whitcroftsub ctx_statement { 1573f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1574f0a594c1SAndy Whitcroft 1575f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1576f0a594c1SAndy Whitcroft return @r; 1577f0a594c1SAndy Whitcroft} 1578f0a594c1SAndy Whitcroftsub ctx_block_level { 1579653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1580653d4876SAndy Whitcroft 1581f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 15824a0df2efSAndy Whitcroft} 15839c0ca6f9SAndy Whitcroftsub ctx_statement_level { 15849c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 15859c0ca6f9SAndy Whitcroft 15869c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 15879c0ca6f9SAndy Whitcroft} 15884a0df2efSAndy Whitcroft 15894a0df2efSAndy Whitcroftsub ctx_locate_comment { 15904a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 15914a0df2efSAndy Whitcroft 15924a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1593beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 15944a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 15954a0df2efSAndy Whitcroft 15964a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 15974a0df2efSAndy Whitcroft # comment. 15984a0df2efSAndy Whitcroft my $in_comment = 0; 15994a0df2efSAndy Whitcroft $current_comment = ''; 16004a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 160100df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 160200df344fSAndy Whitcroft #warn " $line\n"; 16034a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 16044a0df2efSAndy Whitcroft $in_comment = 1; 16054a0df2efSAndy Whitcroft } 16064a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 16074a0df2efSAndy Whitcroft $in_comment = 1; 16084a0df2efSAndy Whitcroft } 16094a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 16104a0df2efSAndy Whitcroft $current_comment = ''; 16114a0df2efSAndy Whitcroft } 16124a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 16134a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 16144a0df2efSAndy Whitcroft $in_comment = 0; 16154a0df2efSAndy Whitcroft } 16164a0df2efSAndy Whitcroft } 16174a0df2efSAndy Whitcroft 16184a0df2efSAndy Whitcroft chomp($current_comment); 16194a0df2efSAndy Whitcroft return($current_comment); 16204a0df2efSAndy Whitcroft} 16214a0df2efSAndy Whitcroftsub ctx_has_comment { 16224a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 16234a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 16244a0df2efSAndy Whitcroft 162500df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 16264a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 16274a0df2efSAndy Whitcroft 16284a0df2efSAndy Whitcroft return ($cmt ne ''); 16294a0df2efSAndy Whitcroft} 16304a0df2efSAndy Whitcroft 16314d001e4dSAndy Whitcroftsub raw_line { 16324d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 16334d001e4dSAndy Whitcroft 16344d001e4dSAndy Whitcroft my $offset = $linenr - 1; 16354d001e4dSAndy Whitcroft $cnt++; 16364d001e4dSAndy Whitcroft 16374d001e4dSAndy Whitcroft my $line; 16384d001e4dSAndy Whitcroft while ($cnt) { 16394d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 16404d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 16414d001e4dSAndy Whitcroft $cnt--; 16424d001e4dSAndy Whitcroft } 16434d001e4dSAndy Whitcroft 16444d001e4dSAndy Whitcroft return $line; 16454d001e4dSAndy Whitcroft} 16464d001e4dSAndy Whitcroft 16470a920b5bSAndy Whitcroftsub cat_vet { 16480a920b5bSAndy Whitcroft my ($vet) = @_; 16499c0ca6f9SAndy Whitcroft my ($res, $coded); 16500a920b5bSAndy Whitcroft 16519c0ca6f9SAndy Whitcroft $res = ''; 16526c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 16536c72ffaaSAndy Whitcroft $res .= $1; 16546c72ffaaSAndy Whitcroft if ($2 ne '') { 16559c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 16566c72ffaaSAndy Whitcroft $res .= $coded; 16576c72ffaaSAndy Whitcroft } 16589c0ca6f9SAndy Whitcroft } 16599c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 16600a920b5bSAndy Whitcroft 16619c0ca6f9SAndy Whitcroft return $res; 16620a920b5bSAndy Whitcroft} 16630a920b5bSAndy Whitcroft 1664c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1665cf655043SAndy Whitcroftmy $av_pending; 1666c2fdda0dSAndy Whitcroftmy @av_paren_type; 16671f65f947SAndy Whitcroftmy $av_pend_colon; 1668c2fdda0dSAndy Whitcroft 1669c2fdda0dSAndy Whitcroftsub annotate_reset { 1670c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1671cf655043SAndy Whitcroft $av_pending = '_'; 1672cf655043SAndy Whitcroft @av_paren_type = ('E'); 16731f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1674c2fdda0dSAndy Whitcroft} 1675c2fdda0dSAndy Whitcroft 16766c72ffaaSAndy Whitcroftsub annotate_values { 16776c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 16786c72ffaaSAndy Whitcroft 16796c72ffaaSAndy Whitcroft my $res; 16801f65f947SAndy Whitcroft my $var = '_' x length($stream); 16816c72ffaaSAndy Whitcroft my $cur = $stream; 16826c72ffaaSAndy Whitcroft 1683c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 16846c72ffaaSAndy Whitcroft 16856c72ffaaSAndy Whitcroft while (length($cur)) { 1686773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1687cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1688171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 16896c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1690c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1691c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1692cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1693c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 16946c72ffaaSAndy Whitcroft } 16956c72ffaaSAndy Whitcroft 1696c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 16979446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 16989446ef56SAndy Whitcroft push(@av_paren_type, $type); 1699addcdceaSAndy Whitcroft $type = 'c'; 17009446ef56SAndy Whitcroft 1701e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1702c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 17036c72ffaaSAndy Whitcroft $type = 'T'; 17046c72ffaaSAndy Whitcroft 1705389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1706389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1707389a2fe5SAndy Whitcroft $type = 'T'; 1708389a2fe5SAndy Whitcroft 1709c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1710171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1711c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1712171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1713171ae1a4SAndy Whitcroft if ($2 ne '') { 1714cf655043SAndy Whitcroft $av_pending = 'N'; 1715171ae1a4SAndy Whitcroft } 1716171ae1a4SAndy Whitcroft $type = 'E'; 1717171ae1a4SAndy Whitcroft 1718c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1719171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1720171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1721171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 17226c72ffaaSAndy Whitcroft 1723c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1724cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1725c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1726cf655043SAndy Whitcroft 1727cf655043SAndy Whitcroft push(@av_paren_type, $type); 1728cf655043SAndy Whitcroft push(@av_paren_type, $type); 1729171ae1a4SAndy Whitcroft $type = 'E'; 1730cf655043SAndy Whitcroft 1731c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1732cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1733cf655043SAndy Whitcroft $av_preprocessor = 1; 1734cf655043SAndy Whitcroft 1735cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1736cf655043SAndy Whitcroft 1737171ae1a4SAndy Whitcroft $type = 'E'; 1738cf655043SAndy Whitcroft 1739c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1740cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1741cf655043SAndy Whitcroft 1742cf655043SAndy Whitcroft $av_preprocessor = 1; 1743cf655043SAndy Whitcroft 1744cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1745cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1746cf655043SAndy Whitcroft pop(@av_paren_type); 1747cf655043SAndy Whitcroft push(@av_paren_type, $type); 1748171ae1a4SAndy Whitcroft $type = 'E'; 17496c72ffaaSAndy Whitcroft 17506c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1751c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 17526c72ffaaSAndy Whitcroft 1753171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1754171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1755171ae1a4SAndy Whitcroft $av_pending = $type; 1756171ae1a4SAndy Whitcroft $type = 'N'; 1757171ae1a4SAndy Whitcroft 17586c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1759c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 17606c72ffaaSAndy Whitcroft if (defined $2) { 1761cf655043SAndy Whitcroft $av_pending = 'V'; 17626c72ffaaSAndy Whitcroft } 17636c72ffaaSAndy Whitcroft $type = 'N'; 17646c72ffaaSAndy Whitcroft 176514b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1766c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 176714b111c1SAndy Whitcroft $av_pending = 'E'; 17686c72ffaaSAndy Whitcroft $type = 'N'; 17696c72ffaaSAndy Whitcroft 17701f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 17711f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 17721f65f947SAndy Whitcroft $av_pend_colon = 'C'; 17731f65f947SAndy Whitcroft $type = 'N'; 17741f65f947SAndy Whitcroft 177514b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1776c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 17776c72ffaaSAndy Whitcroft $type = 'N'; 17786c72ffaaSAndy Whitcroft 17796c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1780c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1781cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1782cf655043SAndy Whitcroft $av_pending = '_'; 17836c72ffaaSAndy Whitcroft $type = 'N'; 17846c72ffaaSAndy Whitcroft 17856c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1786cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1787cf655043SAndy Whitcroft if ($new_type ne '_') { 1788cf655043SAndy Whitcroft $type = $new_type; 1789c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1790c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 17916c72ffaaSAndy Whitcroft } else { 1792c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 17936c72ffaaSAndy Whitcroft } 17946c72ffaaSAndy Whitcroft 1795c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1796c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1797c8cb2ca3SAndy Whitcroft $type = 'V'; 1798cf655043SAndy Whitcroft $av_pending = 'V'; 17996c72ffaaSAndy Whitcroft 18008e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 18018e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 18021f65f947SAndy Whitcroft $av_pend_colon = 'B'; 18038e761b04SAndy Whitcroft } elsif ($type eq 'E') { 18048e761b04SAndy Whitcroft $av_pend_colon = 'L'; 18051f65f947SAndy Whitcroft } 18061f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 18071f65f947SAndy Whitcroft $type = 'V'; 18081f65f947SAndy Whitcroft 18096c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1810c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 18116c72ffaaSAndy Whitcroft $type = 'V'; 18126c72ffaaSAndy Whitcroft 18136c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1814c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 18156c72ffaaSAndy Whitcroft $type = 'N'; 18166c72ffaaSAndy Whitcroft 1817cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1818c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 181913214adfSAndy Whitcroft $type = 'E'; 18201f65f947SAndy Whitcroft $av_pend_colon = 'O'; 182113214adfSAndy Whitcroft 18228e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 18238e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 18248e761b04SAndy Whitcroft $type = 'C'; 18258e761b04SAndy Whitcroft 18261f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 18271f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 18281f65f947SAndy Whitcroft $type = 'N'; 18291f65f947SAndy Whitcroft 18301f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 18311f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 18321f65f947SAndy Whitcroft 18331f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 18341f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 18351f65f947SAndy Whitcroft $type = 'E'; 18361f65f947SAndy Whitcroft } else { 18371f65f947SAndy Whitcroft $type = 'N'; 18381f65f947SAndy Whitcroft } 18391f65f947SAndy Whitcroft $av_pend_colon = 'O'; 18401f65f947SAndy Whitcroft 18418e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 184213214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 18436c72ffaaSAndy Whitcroft $type = 'N'; 18446c72ffaaSAndy Whitcroft 18450d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 184674048ed8SAndy Whitcroft my $variant; 184774048ed8SAndy Whitcroft 184874048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 184974048ed8SAndy Whitcroft if ($type eq 'V') { 185074048ed8SAndy Whitcroft $variant = 'B'; 185174048ed8SAndy Whitcroft } else { 185274048ed8SAndy Whitcroft $variant = 'U'; 185374048ed8SAndy Whitcroft } 185474048ed8SAndy Whitcroft 185574048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 185674048ed8SAndy Whitcroft $type = 'N'; 185774048ed8SAndy Whitcroft 18586c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1859c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 18606c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 18616c72ffaaSAndy Whitcroft $type = 'N'; 18626c72ffaaSAndy Whitcroft } 18636c72ffaaSAndy Whitcroft 18646c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1865c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 18666c72ffaaSAndy Whitcroft } 18676c72ffaaSAndy Whitcroft if (defined $1) { 18686c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 18696c72ffaaSAndy Whitcroft $res .= $type x length($1); 18706c72ffaaSAndy Whitcroft } 18716c72ffaaSAndy Whitcroft } 18726c72ffaaSAndy Whitcroft 18731f65f947SAndy Whitcroft return ($res, $var); 18746c72ffaaSAndy Whitcroft} 18756c72ffaaSAndy Whitcroft 18768905a67cSAndy Whitcroftsub possible { 187713214adfSAndy Whitcroft my ($possible, $line) = @_; 18789a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 18790776e594SAndy Whitcroft ^(?: 18800776e594SAndy Whitcroft $Modifier| 18810776e594SAndy Whitcroft $Storage| 18820776e594SAndy Whitcroft $Type| 18839a974fdbSAndy Whitcroft DEFINE_\S+ 18849a974fdbSAndy Whitcroft )$| 18859a974fdbSAndy Whitcroft ^(?: 18860776e594SAndy Whitcroft goto| 18870776e594SAndy Whitcroft return| 18880776e594SAndy Whitcroft case| 18890776e594SAndy Whitcroft else| 18900776e594SAndy Whitcroft asm|__asm__| 189189a88353SAndy Whitcroft do| 189289a88353SAndy Whitcroft \#| 189389a88353SAndy Whitcroft \#\#| 18949a974fdbSAndy Whitcroft )(?:\s|$)| 18950776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 18969a974fdbSAndy Whitcroft )}x; 18979a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 18989a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1899c45dcabdSAndy Whitcroft # Check for modifiers. 1900c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1901c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1902c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1903c45dcabdSAndy Whitcroft 1904c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1905c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1906d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 19079a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1908d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1909485ff23eSAlex Dowad push(@modifierListFile, $modifier); 1910d2506586SAndy Whitcroft } 19119a974fdbSAndy Whitcroft } 1912c45dcabdSAndy Whitcroft 1913c45dcabdSAndy Whitcroft } else { 191413214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 1915485ff23eSAlex Dowad push(@typeListFile, $possible); 1916c45dcabdSAndy Whitcroft } 19178905a67cSAndy Whitcroft build_types(); 19180776e594SAndy Whitcroft } else { 19190776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 19208905a67cSAndy Whitcroft } 19218905a67cSAndy Whitcroft} 19228905a67cSAndy Whitcroft 19236c72ffaaSAndy Whitcroftmy $prefix = ''; 19246c72ffaaSAndy Whitcroft 1925000d1cc1SJoe Perchessub show_type { 1926cbec18afSJoe Perches my ($type) = @_; 192791bfe484SJoe Perches 1928522b837cSAlexey Dobriyan $type =~ tr/[a-z]/[A-Z]/; 1929522b837cSAlexey Dobriyan 1930cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1931cbec18afSJoe Perches 1932cbec18afSJoe Perches return !defined $ignore_type{$type}; 1933000d1cc1SJoe Perches} 1934000d1cc1SJoe Perches 1935f0a594c1SAndy Whitcroftsub report { 1936cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1937cbec18afSJoe Perches 1938cbec18afSJoe Perches if (!show_type($type) || 1939cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1940773647a0SAndy Whitcroft return 0; 1941773647a0SAndy Whitcroft } 194257230297SJoe Perches my $output = ''; 1943737c0767SJohn Brooks if ($color) { 194457230297SJoe Perches if ($level eq 'ERROR') { 194557230297SJoe Perches $output .= RED; 194657230297SJoe Perches } elsif ($level eq 'WARNING') { 194757230297SJoe Perches $output .= YELLOW; 1948000d1cc1SJoe Perches } else { 194957230297SJoe Perches $output .= GREEN; 1950000d1cc1SJoe Perches } 195157230297SJoe Perches } 195257230297SJoe Perches $output .= $prefix . $level . ':'; 195357230297SJoe Perches if ($show_types) { 1954737c0767SJohn Brooks $output .= BLUE if ($color); 195557230297SJoe Perches $output .= "$type:"; 195657230297SJoe Perches } 1957737c0767SJohn Brooks $output .= RESET if ($color); 195857230297SJoe Perches $output .= ' ' . $msg . "\n"; 195934d8815fSJoe Perches 196034d8815fSJoe Perches if ($showfile) { 196134d8815fSJoe Perches my @lines = split("\n", $output, -1); 196234d8815fSJoe Perches splice(@lines, 1, 1); 196334d8815fSJoe Perches $output = join("\n", @lines); 196434d8815fSJoe Perches } 196557230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 19668905a67cSAndy Whitcroft 196757230297SJoe Perches push(our @report, $output); 1968773647a0SAndy Whitcroft 1969773647a0SAndy Whitcroft return 1; 1970f0a594c1SAndy Whitcroft} 1971cbec18afSJoe Perches 1972f0a594c1SAndy Whitcroftsub report_dump { 197313214adfSAndy Whitcroft our @report; 1974f0a594c1SAndy Whitcroft} 1975000d1cc1SJoe Perches 1976d752fcc8SJoe Perchessub fixup_current_range { 1977d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 1978d752fcc8SJoe Perches 1979d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 1980d752fcc8SJoe Perches my $o = $1; 1981d752fcc8SJoe Perches my $l = $2; 1982d752fcc8SJoe Perches my $no = $o + $offset; 1983d752fcc8SJoe Perches my $nl = $l + $length; 1984d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 1985d752fcc8SJoe Perches } 1986d752fcc8SJoe Perches} 1987d752fcc8SJoe Perches 1988d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 1989d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 1990d752fcc8SJoe Perches 1991d752fcc8SJoe Perches my $range_last_linenr = 0; 1992d752fcc8SJoe Perches my $delta_offset = 0; 1993d752fcc8SJoe Perches 1994d752fcc8SJoe Perches my $old_linenr = 0; 1995d752fcc8SJoe Perches my $new_linenr = 0; 1996d752fcc8SJoe Perches 1997d752fcc8SJoe Perches my $next_insert = 0; 1998d752fcc8SJoe Perches my $next_delete = 0; 1999d752fcc8SJoe Perches 2000d752fcc8SJoe Perches my @lines = (); 2001d752fcc8SJoe Perches 2002d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 2003d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 2004d752fcc8SJoe Perches 2005d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 2006d752fcc8SJoe Perches my $save_line = 1; 2007d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 2008323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2009d752fcc8SJoe Perches $delta_offset = 0; 2010d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2011d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 2012d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 2013d752fcc8SJoe Perches } 2014d752fcc8SJoe Perches 2015d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2016d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 2017d752fcc8SJoe Perches $save_line = 0; 2018d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2019d752fcc8SJoe Perches } 2020d752fcc8SJoe Perches 2021d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2022d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 2023d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 2024d752fcc8SJoe Perches $new_linenr++; 2025d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2026d752fcc8SJoe Perches } 2027d752fcc8SJoe Perches 2028d752fcc8SJoe Perches if ($save_line) { 2029d752fcc8SJoe Perches push(@lines, $line); 2030d752fcc8SJoe Perches $new_linenr++; 2031d752fcc8SJoe Perches } 2032d752fcc8SJoe Perches 2033d752fcc8SJoe Perches $old_linenr++; 2034d752fcc8SJoe Perches } 2035d752fcc8SJoe Perches 2036d752fcc8SJoe Perches return @lines; 2037d752fcc8SJoe Perches} 2038d752fcc8SJoe Perches 2039f2d7e4d4SJoe Perchessub fix_insert_line { 2040f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2041f2d7e4d4SJoe Perches 2042f2d7e4d4SJoe Perches my $inserted = { 2043f2d7e4d4SJoe Perches LINENR => $linenr, 2044f2d7e4d4SJoe Perches LINE => $line, 2045f2d7e4d4SJoe Perches }; 2046f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 2047f2d7e4d4SJoe Perches} 2048f2d7e4d4SJoe Perches 2049f2d7e4d4SJoe Perchessub fix_delete_line { 2050f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 2051f2d7e4d4SJoe Perches 2052f2d7e4d4SJoe Perches my $deleted = { 2053f2d7e4d4SJoe Perches LINENR => $linenr, 2054f2d7e4d4SJoe Perches LINE => $line, 2055f2d7e4d4SJoe Perches }; 2056f2d7e4d4SJoe Perches 2057f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 2058f2d7e4d4SJoe Perches} 2059f2d7e4d4SJoe Perches 2060de7d4f0eSAndy Whitcroftsub ERROR { 2061cbec18afSJoe Perches my ($type, $msg) = @_; 2062cbec18afSJoe Perches 2063cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 2064de7d4f0eSAndy Whitcroft our $clean = 0; 20656c72ffaaSAndy Whitcroft our $cnt_error++; 20663705ce5bSJoe Perches return 1; 2067de7d4f0eSAndy Whitcroft } 20683705ce5bSJoe Perches return 0; 2069773647a0SAndy Whitcroft} 2070de7d4f0eSAndy Whitcroftsub WARN { 2071cbec18afSJoe Perches my ($type, $msg) = @_; 2072cbec18afSJoe Perches 2073cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 2074de7d4f0eSAndy Whitcroft our $clean = 0; 20756c72ffaaSAndy Whitcroft our $cnt_warn++; 20763705ce5bSJoe Perches return 1; 2077de7d4f0eSAndy Whitcroft } 20783705ce5bSJoe Perches return 0; 2079773647a0SAndy Whitcroft} 2080de7d4f0eSAndy Whitcroftsub CHK { 2081cbec18afSJoe Perches my ($type, $msg) = @_; 2082cbec18afSJoe Perches 2083cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2084de7d4f0eSAndy Whitcroft our $clean = 0; 20856c72ffaaSAndy Whitcroft our $cnt_chk++; 20863705ce5bSJoe Perches return 1; 20876c72ffaaSAndy Whitcroft } 20883705ce5bSJoe Perches return 0; 2089de7d4f0eSAndy Whitcroft} 2090de7d4f0eSAndy Whitcroft 20916ecd9674SAndy Whitcroftsub check_absolute_file { 20926ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 20936ecd9674SAndy Whitcroft my $file = $absolute; 20946ecd9674SAndy Whitcroft 20956ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 20966ecd9674SAndy Whitcroft 20976ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 20986ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 20996ecd9674SAndy Whitcroft if (-f "$root/$file") { 21006ecd9674SAndy Whitcroft ##print "file<$file>\n"; 21016ecd9674SAndy Whitcroft last; 21026ecd9674SAndy Whitcroft } 21036ecd9674SAndy Whitcroft } 21046ecd9674SAndy Whitcroft if (! -f _) { 21056ecd9674SAndy Whitcroft return 0; 21066ecd9674SAndy Whitcroft } 21076ecd9674SAndy Whitcroft 21086ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 21096ecd9674SAndy Whitcroft my $prefix = $absolute; 21106ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 21116ecd9674SAndy Whitcroft 21126ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 21136ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2114000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2115000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 21166ecd9674SAndy Whitcroft } 21176ecd9674SAndy Whitcroft} 21186ecd9674SAndy Whitcroft 21193705ce5bSJoe Perchessub trim { 21203705ce5bSJoe Perches my ($string) = @_; 21213705ce5bSJoe Perches 2122b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2123b34c648bSJoe Perches 2124b34c648bSJoe Perches return $string; 2125b34c648bSJoe Perches} 2126b34c648bSJoe Perches 2127b34c648bSJoe Perchessub ltrim { 2128b34c648bSJoe Perches my ($string) = @_; 2129b34c648bSJoe Perches 2130b34c648bSJoe Perches $string =~ s/^\s+//; 2131b34c648bSJoe Perches 2132b34c648bSJoe Perches return $string; 2133b34c648bSJoe Perches} 2134b34c648bSJoe Perches 2135b34c648bSJoe Perchessub rtrim { 2136b34c648bSJoe Perches my ($string) = @_; 2137b34c648bSJoe Perches 2138b34c648bSJoe Perches $string =~ s/\s+$//; 21393705ce5bSJoe Perches 21403705ce5bSJoe Perches return $string; 21413705ce5bSJoe Perches} 21423705ce5bSJoe Perches 214352ea8506SJoe Perchessub string_find_replace { 214452ea8506SJoe Perches my ($string, $find, $replace) = @_; 214552ea8506SJoe Perches 214652ea8506SJoe Perches $string =~ s/$find/$replace/g; 214752ea8506SJoe Perches 214852ea8506SJoe Perches return $string; 214952ea8506SJoe Perches} 215052ea8506SJoe Perches 21513705ce5bSJoe Perchessub tabify { 21523705ce5bSJoe Perches my ($leading) = @_; 21533705ce5bSJoe Perches 21543705ce5bSJoe Perches my $source_indent = 8; 21553705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 21563705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 21573705ce5bSJoe Perches 21583705ce5bSJoe Perches #convert leading spaces to tabs 21593705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 21603705ce5bSJoe Perches #Remove spaces before a tab 21613705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 21623705ce5bSJoe Perches 21633705ce5bSJoe Perches return "$leading"; 21643705ce5bSJoe Perches} 21653705ce5bSJoe Perches 2166d1fe9c09SJoe Perchessub pos_last_openparen { 2167d1fe9c09SJoe Perches my ($line) = @_; 2168d1fe9c09SJoe Perches 2169d1fe9c09SJoe Perches my $pos = 0; 2170d1fe9c09SJoe Perches 2171d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2172d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2173d1fe9c09SJoe Perches 2174d1fe9c09SJoe Perches my $last_openparen = 0; 2175d1fe9c09SJoe Perches 2176d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2177d1fe9c09SJoe Perches return -1; 2178d1fe9c09SJoe Perches } 2179d1fe9c09SJoe Perches 2180d1fe9c09SJoe Perches my $len = length($line); 2181d1fe9c09SJoe Perches 2182d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2183d1fe9c09SJoe Perches my $string = substr($line, $pos); 2184d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2185d1fe9c09SJoe Perches $pos += length($1) - 1; 2186d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2187d1fe9c09SJoe Perches $last_openparen = $pos; 2188d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2189d1fe9c09SJoe Perches last; 2190d1fe9c09SJoe Perches } 2191d1fe9c09SJoe Perches } 2192d1fe9c09SJoe Perches 219391cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2194d1fe9c09SJoe Perches} 2195d1fe9c09SJoe Perches 21960a920b5bSAndy Whitcroftsub process { 21970a920b5bSAndy Whitcroft my $filename = shift; 21980a920b5bSAndy Whitcroft 21990a920b5bSAndy Whitcroft my $linenr=0; 22000a920b5bSAndy Whitcroft my $prevline=""; 2201c2fdda0dSAndy Whitcroft my $prevrawline=""; 22020a920b5bSAndy Whitcroft my $stashline=""; 2203c2fdda0dSAndy Whitcroft my $stashrawline=""; 22040a920b5bSAndy Whitcroft 22054a0df2efSAndy Whitcroft my $length; 22060a920b5bSAndy Whitcroft my $indent; 22070a920b5bSAndy Whitcroft my $previndent=0; 22080a920b5bSAndy Whitcroft my $stashindent=0; 22090a920b5bSAndy Whitcroft 2210de7d4f0eSAndy Whitcroft our $clean = 1; 22110a920b5bSAndy Whitcroft my $signoff = 0; 22120a920b5bSAndy Whitcroft my $is_patch = 0; 221329ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 221415662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 2215ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2216bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 22172a076f40SJoe Perches my $commit_log_long_line = 0; 2218e518e9a5SJoe Perches my $commit_log_has_diff = 0; 221913f1937eSJoe Perches my $reported_maintainer_file = 0; 2220fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2221fa64205dSPasi Savanainen 2222365dd4eaSJoe Perches my $last_blank_line = 0; 22235e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2224365dd4eaSJoe Perches 222513214adfSAndy Whitcroft our @report = (); 22266c72ffaaSAndy Whitcroft our $cnt_lines = 0; 22276c72ffaaSAndy Whitcroft our $cnt_error = 0; 22286c72ffaaSAndy Whitcroft our $cnt_warn = 0; 22296c72ffaaSAndy Whitcroft our $cnt_chk = 0; 22306c72ffaaSAndy Whitcroft 22310a920b5bSAndy Whitcroft # Trace the real file/line as we go. 22320a920b5bSAndy Whitcroft my $realfile = ''; 22330a920b5bSAndy Whitcroft my $realline = 0; 22340a920b5bSAndy Whitcroft my $realcnt = 0; 22350a920b5bSAndy Whitcroft my $here = ''; 223677cb8546SJoe Perches my $context_function; #undef'd unless there's a known function 22370a920b5bSAndy Whitcroft my $in_comment = 0; 2238c2fdda0dSAndy Whitcroft my $comment_edge = 0; 22390a920b5bSAndy Whitcroft my $first_line = 0; 22401e855726SWolfram Sang my $p1_prefix = ''; 22410a920b5bSAndy Whitcroft 224213214adfSAndy Whitcroft my $prev_values = 'E'; 224313214adfSAndy Whitcroft 224413214adfSAndy Whitcroft # suppression flags 2245773647a0SAndy Whitcroft my %suppress_ifbraces; 2246170d3a22SAndy Whitcroft my %suppress_whiletrailers; 22472b474a1aSAndy Whitcroft my %suppress_export; 22483e469cdcSAndy Whitcroft my $suppress_statement = 0; 2249653d4876SAndy Whitcroft 22507e51f197SJoe Perches my %signatures = (); 2251323c1260SJoe Perches 2252c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2253de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2254c2fdda0dSAndy Whitcroft # 2255de7d4f0eSAndy Whitcroft my @setup_docs = (); 2256de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2257773647a0SAndy Whitcroft 2258d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2259d8b07710SJoe Perches 2260*9f3a8992SRob Herring my $checklicenseline = 1; 2261*9f3a8992SRob Herring 2262773647a0SAndy Whitcroft sanitise_line_reset(); 2263c2fdda0dSAndy Whitcroft my $line; 2264c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2265773647a0SAndy Whitcroft $linenr++; 2266773647a0SAndy Whitcroft $line = $rawline; 2267c2fdda0dSAndy Whitcroft 22683705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 22693705ce5bSJoe Perches 2270773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2271de7d4f0eSAndy Whitcroft $setup_docs = 0; 22728c27ceffSMauro Carvalho Chehab if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) { 2273de7d4f0eSAndy Whitcroft $setup_docs = 1; 2274de7d4f0eSAndy Whitcroft } 2275773647a0SAndy Whitcroft #next; 2276de7d4f0eSAndy Whitcroft } 227774fd4f34SJoe Perches if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2278773647a0SAndy Whitcroft $realline=$1-1; 2279773647a0SAndy Whitcroft if (defined $2) { 2280773647a0SAndy Whitcroft $realcnt=$3+1; 2281773647a0SAndy Whitcroft } else { 2282773647a0SAndy Whitcroft $realcnt=1+1; 2283773647a0SAndy Whitcroft } 2284c45dcabdSAndy Whitcroft $in_comment = 0; 2285773647a0SAndy Whitcroft 2286773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2287773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2288773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2289773647a0SAndy Whitcroft # at context start. 2290773647a0SAndy Whitcroft my $edge; 229101fa9147SAndy Whitcroft my $cnt = $realcnt; 229201fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 229301fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 229401fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 229501fa9147SAndy Whitcroft $cnt--; 229601fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2297721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2298fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2299fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2300fae17daeSAndy Whitcroft ($edge) = $1; 2301fae17daeSAndy Whitcroft last; 2302fae17daeSAndy Whitcroft } 2303773647a0SAndy Whitcroft } 2304773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2305773647a0SAndy Whitcroft $in_comment = 1; 2306773647a0SAndy Whitcroft } 2307773647a0SAndy Whitcroft 2308773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2309773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2310773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2311773647a0SAndy Whitcroft if (!defined $edge && 231283242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2313773647a0SAndy Whitcroft { 2314773647a0SAndy Whitcroft $in_comment = 1; 2315773647a0SAndy Whitcroft } 2316773647a0SAndy Whitcroft 2317773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2318773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2319773647a0SAndy Whitcroft 2320171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2321773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2322171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2323773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2324773647a0SAndy Whitcroft } 2325773647a0SAndy Whitcroft push(@lines, $line); 2326773647a0SAndy Whitcroft 2327773647a0SAndy Whitcroft if ($realcnt > 1) { 2328773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2329773647a0SAndy Whitcroft } else { 2330773647a0SAndy Whitcroft $realcnt = 0; 2331773647a0SAndy Whitcroft } 2332773647a0SAndy Whitcroft 2333773647a0SAndy Whitcroft #print "==>$rawline\n"; 2334773647a0SAndy Whitcroft #print "-->$line\n"; 2335de7d4f0eSAndy Whitcroft 2336de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2337de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2338de7d4f0eSAndy Whitcroft } 2339de7d4f0eSAndy Whitcroft } 2340de7d4f0eSAndy Whitcroft 23416c72ffaaSAndy Whitcroft $prefix = ''; 23426c72ffaaSAndy Whitcroft 2343773647a0SAndy Whitcroft $realcnt = 0; 2344773647a0SAndy Whitcroft $linenr = 0; 2345194f66fcSJoe Perches $fixlinenr = -1; 23460a920b5bSAndy Whitcroft foreach my $line (@lines) { 23470a920b5bSAndy Whitcroft $linenr++; 2348194f66fcSJoe Perches $fixlinenr++; 23491b5539b1SJoe Perches my $sline = $line; #copy of $line 23501b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 23510a920b5bSAndy Whitcroft 2352c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 23536c72ffaaSAndy Whitcroft 23540a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2355e518e9a5SJoe Perches if (!$in_commit_log && 235674fd4f34SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 235774fd4f34SJoe Perches my $context = $4; 23580a920b5bSAndy Whitcroft $is_patch = 1; 23594a0df2efSAndy Whitcroft $first_line = $linenr + 1; 23600a920b5bSAndy Whitcroft $realline=$1-1; 23610a920b5bSAndy Whitcroft if (defined $2) { 23620a920b5bSAndy Whitcroft $realcnt=$3+1; 23630a920b5bSAndy Whitcroft } else { 23640a920b5bSAndy Whitcroft $realcnt=1+1; 23650a920b5bSAndy Whitcroft } 2366c2fdda0dSAndy Whitcroft annotate_reset(); 236713214adfSAndy Whitcroft $prev_values = 'E'; 236813214adfSAndy Whitcroft 2369773647a0SAndy Whitcroft %suppress_ifbraces = (); 2370170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 23712b474a1aSAndy Whitcroft %suppress_export = (); 23723e469cdcSAndy Whitcroft $suppress_statement = 0; 237374fd4f34SJoe Perches if ($context =~ /\b(\w+)\s*\(/) { 237474fd4f34SJoe Perches $context_function = $1; 237574fd4f34SJoe Perches } else { 237674fd4f34SJoe Perches undef $context_function; 237774fd4f34SJoe Perches } 23780a920b5bSAndy Whitcroft next; 23790a920b5bSAndy Whitcroft 23804a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 23814a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 23824a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2383773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 23840a920b5bSAndy Whitcroft $realline++; 2385d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 23860a920b5bSAndy Whitcroft 23874a0df2efSAndy Whitcroft # Measure the line length and indent. 2388c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 23890a920b5bSAndy Whitcroft 23900a920b5bSAndy Whitcroft # Track the previous line. 23910a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 23920a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2393c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2394c2fdda0dSAndy Whitcroft 2395773647a0SAndy Whitcroft #warn "line<$line>\n"; 23966c72ffaaSAndy Whitcroft 2397d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2398d8aaf121SAndy Whitcroft $realcnt--; 23990a920b5bSAndy Whitcroft } 24000a920b5bSAndy Whitcroft 2401cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2402cc77cdcaSAndy Whitcroft 24036c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 24046c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2405773647a0SAndy Whitcroft 24062ac73b4fSJoe Perches my $found_file = 0; 2407773647a0SAndy Whitcroft # extract the filename as it passes 24083bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 24093bf9a009SRabin Vincent $realfile = $1; 24102b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2411270c49a0SJoe Perches $in_commit_log = 0; 24122ac73b4fSJoe Perches $found_file = 1; 24133bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2414773647a0SAndy Whitcroft $realfile = $1; 24152b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2416270c49a0SJoe Perches $in_commit_log = 0; 24171e855726SWolfram Sang 24181e855726SWolfram Sang $p1_prefix = $1; 2419e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2420e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2421000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2422000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 24231e855726SWolfram Sang } 2424773647a0SAndy Whitcroft 2425c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2426000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2427000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2428773647a0SAndy Whitcroft } 24292ac73b4fSJoe Perches $found_file = 1; 24302ac73b4fSJoe Perches } 24312ac73b4fSJoe Perches 243234d8815fSJoe Perches#make up the handle for any error we report on this line 243334d8815fSJoe Perches if ($showfile) { 243434d8815fSJoe Perches $prefix = "$realfile:$realline: " 243534d8815fSJoe Perches } elsif ($emacs) { 24367d3a9f67SJoe Perches if ($file) { 24377d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 24387d3a9f67SJoe Perches } else { 243934d8815fSJoe Perches $prefix = "$filename:$linenr: "; 244034d8815fSJoe Perches } 24417d3a9f67SJoe Perches } 244234d8815fSJoe Perches 24432ac73b4fSJoe Perches if ($found_file) { 244485b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 244585b0ee18SJoe Perches WARN("OBSOLETE", 244685b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 244785b0ee18SJoe Perches } 24487bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 24492ac73b4fSJoe Perches $check = 1; 24502ac73b4fSJoe Perches } else { 24512ac73b4fSJoe Perches $check = $check_orig; 24522ac73b4fSJoe Perches } 2453*9f3a8992SRob Herring $checklicenseline = 1; 2454773647a0SAndy Whitcroft next; 2455773647a0SAndy Whitcroft } 2456773647a0SAndy Whitcroft 2457389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 24580a920b5bSAndy Whitcroft 2459c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2460c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2461c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 24620a920b5bSAndy Whitcroft 24636c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 24646c72ffaaSAndy Whitcroft 2465e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2466e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2467e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2468e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2469e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2470e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2471e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2472e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2473e518e9a5SJoe Perches $commit_log_has_diff = 1; 2474e518e9a5SJoe Perches } 2475e518e9a5SJoe Perches 24763bf9a009SRabin Vincent# Check for incorrect file permissions 24773bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 24783bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 247904db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 248004db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2481000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2482000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 24833bf9a009SRabin Vincent } 24843bf9a009SRabin Vincent } 24853bf9a009SRabin Vincent 248620112475SJoe Perches# Check the patch for a signoff: 2487d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 24884a0df2efSAndy Whitcroft $signoff++; 248915662b3eSJoe Perches $in_commit_log = 0; 24900a920b5bSAndy Whitcroft } 249120112475SJoe Perches 2492e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2493e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2494e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2495e0d975b1SJoe Perches $reported_maintainer_file = 1; 2496e0d975b1SJoe Perches } 2497e0d975b1SJoe Perches 249820112475SJoe Perches# Check signature styles 2499270c49a0SJoe Perches if (!$in_header_lines && 2500ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 250120112475SJoe Perches my $space_before = $1; 250220112475SJoe Perches my $sign_off = $2; 250320112475SJoe Perches my $space_after = $3; 250420112475SJoe Perches my $email = $4; 250520112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 250620112475SJoe Perches 2507ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2508ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2509ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2510ce0338dfSJoe Perches } 251120112475SJoe Perches if (defined $space_before && $space_before ne "") { 25123705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 25133705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 25143705ce5bSJoe Perches $fix) { 2515194f66fcSJoe Perches $fixed[$fixlinenr] = 25163705ce5bSJoe Perches "$ucfirst_sign_off $email"; 25173705ce5bSJoe Perches } 251820112475SJoe Perches } 251920112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 25203705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 25213705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 25223705ce5bSJoe Perches $fix) { 2523194f66fcSJoe Perches $fixed[$fixlinenr] = 25243705ce5bSJoe Perches "$ucfirst_sign_off $email"; 25253705ce5bSJoe Perches } 25263705ce5bSJoe Perches 252720112475SJoe Perches } 252820112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 25293705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 25303705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 25313705ce5bSJoe Perches $fix) { 2532194f66fcSJoe Perches $fixed[$fixlinenr] = 25333705ce5bSJoe Perches "$ucfirst_sign_off $email"; 25343705ce5bSJoe Perches } 253520112475SJoe Perches } 253620112475SJoe Perches 253720112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 253820112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 253920112475SJoe Perches if ($suggested_email eq "") { 2540000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2541000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 254220112475SJoe Perches } else { 254320112475SJoe Perches my $dequoted = $suggested_email; 254420112475SJoe Perches $dequoted =~ s/^"//; 254520112475SJoe Perches $dequoted =~ s/" </ </; 254620112475SJoe Perches # Don't force email to have quotes 254720112475SJoe Perches # Allow just an angle bracketed address 254820112475SJoe Perches if ("$dequoted$comment" ne $email && 254920112475SJoe Perches "<$email_address>$comment" ne $email && 255020112475SJoe Perches "$suggested_email$comment" ne $email) { 2551000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2552000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 255320112475SJoe Perches } 25540a920b5bSAndy Whitcroft } 25557e51f197SJoe Perches 25567e51f197SJoe Perches# Check for duplicate signatures 25577e51f197SJoe Perches my $sig_nospace = $line; 25587e51f197SJoe Perches $sig_nospace =~ s/\s//g; 25597e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 25607e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 25617e51f197SJoe Perches WARN("BAD_SIGN_OFF", 25627e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 25637e51f197SJoe Perches } else { 25647e51f197SJoe Perches $signatures{$sig_nospace} = 1; 25657e51f197SJoe Perches } 25660a920b5bSAndy Whitcroft } 25670a920b5bSAndy Whitcroft 2568a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2569a2fe16b9SJoe Perches if ($in_header_lines && 2570a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2571a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2572a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2573a2fe16b9SJoe Perches } 2574a2fe16b9SJoe Perches 25759b3189ebSJoe Perches# Check for old stable address 25769b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 25779b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 25789b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 25799b3189ebSJoe Perches } 25809b3189ebSJoe Perches 25817ebd05efSChristopher Covington# Check for unwanted Gerrit info 25827ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 25837ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 25847ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 25857ebd05efSChristopher Covington } 25867ebd05efSChristopher Covington 2587369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2588369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2589369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2590369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2591369c8dd3SJoe Perches # timestamp 2592369c8dd3SJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) { 2593369c8dd3SJoe Perches # stack dump address 2594369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2595369c8dd3SJoe Perches } 2596369c8dd3SJoe Perches 25972a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 25982a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2599bf4daf12SJoe Perches length($line) > 75 && 2600bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2601bf4daf12SJoe Perches # file delta changes 2602bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2603bf4daf12SJoe Perches # filename then : 2604bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2605bf4daf12SJoe Perches # A Fixes: or Link: line 2606bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 26072a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 26082a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 26092a076f40SJoe Perches $commit_log_long_line = 1; 26102a076f40SJoe Perches } 26112a076f40SJoe Perches 2612bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2613bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2614bf4daf12SJoe Perches $line =~ /^\s*$/) { 2615bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2616bf4daf12SJoe Perches } 2617bf4daf12SJoe Perches 26180d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2619369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2620aab38f51SJoe Perches $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i && 2621e882dbfcSWei Wang $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 2622fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2623aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2624369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2625bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2626fe043ea1SJoe Perches my $init_char = "c"; 2627fe043ea1SJoe Perches my $orig_commit = ""; 26280d7835fcSJoe Perches my $short = 1; 26290d7835fcSJoe Perches my $long = 0; 26300d7835fcSJoe Perches my $case = 1; 26310d7835fcSJoe Perches my $space = 1; 26320d7835fcSJoe Perches my $hasdesc = 0; 263319c146a6SJoe Perches my $hasparens = 0; 26340d7835fcSJoe Perches my $id = '0123456789ab'; 26350d7835fcSJoe Perches my $orig_desc = "commit description"; 26360d7835fcSJoe Perches my $description = ""; 26370d7835fcSJoe Perches 2638fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2639fe043ea1SJoe Perches $init_char = $1; 2640fe043ea1SJoe Perches $orig_commit = lc($2); 2641fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2642fe043ea1SJoe Perches $orig_commit = lc($1); 2643fe043ea1SJoe Perches } 2644fe043ea1SJoe Perches 26450d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 26460d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 26470d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 26480d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 26490d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 26500d7835fcSJoe Perches $orig_desc = $1; 265119c146a6SJoe Perches $hasparens = 1; 26520d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 26530d7835fcSJoe Perches defined $rawlines[$linenr] && 26540d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 26550d7835fcSJoe Perches $orig_desc = $1; 265619c146a6SJoe Perches $hasparens = 1; 2657b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2658b671fde0SJoe Perches defined $rawlines[$linenr] && 2659b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2660b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2661b671fde0SJoe Perches $orig_desc = $1; 2662b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2663b671fde0SJoe Perches $orig_desc .= " " . $1; 266419c146a6SJoe Perches $hasparens = 1; 26650d7835fcSJoe Perches } 26660d7835fcSJoe Perches 26670d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 26680d7835fcSJoe Perches $id, $orig_desc); 26690d7835fcSJoe Perches 2670948b133aSHeinrich Schuchardt if (defined($id) && 2671948b133aSHeinrich Schuchardt ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { 2672d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 26730d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 26740d7835fcSJoe Perches } 2675d311cd44SJoe Perches } 2676d311cd44SJoe Perches 267713f1937eSJoe Perches# Check for added, moved or deleted files 267813f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 267913f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 268013f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 268113f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 268213f1937eSJoe Perches (defined($1) || defined($2))))) { 2683a82603a8SAndrew Jeffery $is_patch = 1; 268413f1937eSJoe Perches $reported_maintainer_file = 1; 268513f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 268613f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 268713f1937eSJoe Perches } 268813f1937eSJoe Perches 268900df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 26908905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2691000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2692000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 26936c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2694de7d4f0eSAndy Whitcroft } 2695de7d4f0eSAndy Whitcroft 2696de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2697de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2698171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2699171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2700171ae1a4SAndy Whitcroft 2701171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2702171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2703171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2704171ae1a4SAndy Whitcroft 270534d99219SJoe Perches CHK("INVALID_UTF8", 2706000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 270700df344fSAndy Whitcroft } 27080a920b5bSAndy Whitcroft 270915662b3eSJoe Perches# Check if it's the start of a commit log 271015662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 271115662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 2712eb3a58deSJoe Perches !($rawline =~ /^\s+(?:\S|$)/ || 2713eb3a58deSJoe Perches $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 271415662b3eSJoe Perches $in_header_lines = 0; 271515662b3eSJoe Perches $in_commit_log = 1; 2716ed43c4e5SAllen Hubbe $has_commit_log = 1; 271715662b3eSJoe Perches } 271815662b3eSJoe Perches 2719fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2720fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2721fa64205dSPasi Savanainen if ($in_header_lines && 2722fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2723fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2724fa64205dSPasi Savanainen $non_utf8_charset = 1; 2725fa64205dSPasi Savanainen } 2726fa64205dSPasi Savanainen 2727fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 272815662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2729fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 273015662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 273115662b3eSJoe Perches } 273215662b3eSJoe Perches 2733d6430f71SJoe Perches# Check for absolute kernel paths in commit message 2734d6430f71SJoe Perches if ($tree && $in_commit_log) { 2735d6430f71SJoe Perches while ($line =~ m{(?:^|\s)(/\S*)}g) { 2736d6430f71SJoe Perches my $file = $1; 2737d6430f71SJoe Perches 2738d6430f71SJoe Perches if ($file =~ m{^(.*?)(?::\d+)+:?$} && 2739d6430f71SJoe Perches check_absolute_file($1, $herecurr)) { 2740d6430f71SJoe Perches # 2741d6430f71SJoe Perches } else { 2742d6430f71SJoe Perches check_absolute_file($file, $herecurr); 2743d6430f71SJoe Perches } 2744d6430f71SJoe Perches } 2745d6430f71SJoe Perches } 2746d6430f71SJoe Perches 274766b47b4aSKees Cook# Check for various typo / spelling mistakes 274866d7a382SJoe Perches if (defined($misspellings) && 274966d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2750ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 275166b47b4aSKees Cook my $typo = $1; 275266b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 275366b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 275466b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 27550675a8fbSJean Delvare my $msg_level = \&WARN; 27560675a8fbSJean Delvare $msg_level = \&CHK if ($file); 27570675a8fbSJean Delvare if (&{$msg_level}("TYPO_SPELLING", 275866b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 275966b47b4aSKees Cook $fix) { 276066b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 276166b47b4aSKees Cook } 276266b47b4aSKees Cook } 276366b47b4aSKees Cook } 276466b47b4aSKees Cook 276530670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 276630670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 276700df344fSAndy Whitcroft 27680a920b5bSAndy Whitcroft#trailing whitespace 27699c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2770c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2771d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2772d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2773d5e616fcSJoe Perches $fix) { 2774194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2775d5e616fcSJoe Perches } 2776c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2777c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 27783705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 27793705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 27803705ce5bSJoe Perches $fix) { 2781194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 27823705ce5bSJoe Perches } 27833705ce5bSJoe Perches 2784d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 27850a920b5bSAndy Whitcroft } 27865368df20SAndy Whitcroft 27874783f894SJosh Triplett# Check for FSF mailing addresses. 2788109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 27891bde561eSMatthew Wilcox $rawline =~ /\b675\s+Mass\s+Ave/i || 27903e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 27913e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 27924783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 27930675a8fbSJean Delvare my $msg_level = \&ERROR; 27940675a8fbSJean Delvare $msg_level = \&CHK if ($file); 27950675a8fbSJean Delvare &{$msg_level}("FSF_MAILING_ADDRESS", 27964783f894SJosh 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) 27974783f894SJosh Triplett } 27984783f894SJosh Triplett 27993354957aSAndi Kleen# check for Kconfig help text having a real description 28009fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 28019fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 28023354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 2803678ae162SUlf Magnusson # 'choice' is usually the last thing on the line (though 2804678ae162SUlf Magnusson # Kconfig supports named choices), so use a word boundary 2805678ae162SUlf Magnusson # (\b) rather than a whitespace character (\s) 2806678ae162SUlf Magnusson $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 28073354957aSAndi Kleen my $length = 0; 28089fe287d7SAndy Whitcroft my $cnt = $realcnt; 28099fe287d7SAndy Whitcroft my $ln = $linenr + 1; 28109fe287d7SAndy Whitcroft my $f; 2811a1385803SAndy Whitcroft my $is_start = 0; 28129fe287d7SAndy Whitcroft my $is_end = 0; 2813a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 28149fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 28159fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 28169fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 28179fe287d7SAndy Whitcroft 28189fe287d7SAndy Whitcroft next if ($f =~ /^-/); 28198d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2820a1385803SAndy Whitcroft 282186adf1a0SUlf Magnusson if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 2822a1385803SAndy Whitcroft $is_start = 1; 282384af7a61SUlf Magnusson } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) { 282484af7a61SUlf Magnusson if ($lines[$ln - 1] =~ "---help---") { 282584af7a61SUlf Magnusson WARN("CONFIG_DESCRIPTION", 282684af7a61SUlf Magnusson "prefer 'help' over '---help---' for new help texts\n" . $herecurr); 282784af7a61SUlf Magnusson } 2828a1385803SAndy Whitcroft $length = -1; 2829a1385803SAndy Whitcroft } 2830a1385803SAndy Whitcroft 28319fe287d7SAndy Whitcroft $f =~ s/^.//; 28323354957aSAndi Kleen $f =~ s/#.*//; 28333354957aSAndi Kleen $f =~ s/^\s+//; 28343354957aSAndi Kleen next if ($f =~ /^$/); 2835678ae162SUlf Magnusson 2836678ae162SUlf Magnusson # This only checks context lines in the patch 2837678ae162SUlf Magnusson # and so hopefully shouldn't trigger false 2838678ae162SUlf Magnusson # positives, even though some of these are 2839678ae162SUlf Magnusson # common words in help texts 2840678ae162SUlf Magnusson if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| 2841678ae162SUlf Magnusson if|endif|menu|endmenu|source)\b/x) { 28429fe287d7SAndy Whitcroft $is_end = 1; 28439fe287d7SAndy Whitcroft last; 28449fe287d7SAndy Whitcroft } 28453354957aSAndi Kleen $length++; 28463354957aSAndi Kleen } 284756193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2848000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 284956193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 285056193274SVadim Bendebury } 2851a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 28523354957aSAndi Kleen } 28533354957aSAndi Kleen 2854628f91a2SJoe Perches# check for MAINTAINERS entries that don't have the right form 2855628f91a2SJoe Perches if ($realfile =~ /^MAINTAINERS$/ && 2856628f91a2SJoe Perches $rawline =~ /^\+[A-Z]:/ && 2857628f91a2SJoe Perches $rawline !~ /^\+[A-Z]:\t\S/) { 2858628f91a2SJoe Perches if (WARN("MAINTAINERS_STYLE", 2859628f91a2SJoe Perches "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 2860628f91a2SJoe Perches $fix) { 2861628f91a2SJoe Perches $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 2862628f91a2SJoe Perches } 2863628f91a2SJoe Perches } 2864628f91a2SJoe Perches 2865327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2866327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2867327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2868327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2869327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2870327953e9SChristoph Jaeger } 2871327953e9SChristoph Jaeger 2872c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2873c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2874c68e5878SArnaud Lacombe my $flag = $1; 2875c68e5878SArnaud Lacombe my $replacement = { 2876c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2877c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2878c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2879c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2880c68e5878SArnaud Lacombe }; 2881c68e5878SArnaud Lacombe 2882c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2883c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2884c68e5878SArnaud Lacombe } 2885c68e5878SArnaud Lacombe 2886bff5da43SRob Herring# check for DT compatible documentation 28877dd05b38SFlorian Vaussard if (defined $root && 28887dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 28897dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 28907dd05b38SFlorian Vaussard 2891bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2892bff5da43SRob Herring 2893cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2894cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2895cc93319bSFlorian Vaussard 2896bff5da43SRob Herring foreach my $compat (@compats) { 2897bff5da43SRob Herring my $compat2 = $compat; 2898185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2899185d566bSRob Herring my $compat3 = $compat; 2900185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2901185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2902bff5da43SRob Herring if ( $? >> 8 ) { 2903bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2904bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2905bff5da43SRob Herring } 2906bff5da43SRob Herring 29074fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 29084fbf32a6SFlorian Vaussard my $vendor = $1; 2909cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2910bff5da43SRob Herring if ( $? >> 8 ) { 2911bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2912cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2913bff5da43SRob Herring } 2914bff5da43SRob Herring } 2915bff5da43SRob Herring } 2916bff5da43SRob Herring 2917*9f3a8992SRob Herring# check for using SPDX license tag at beginning of files 2918*9f3a8992SRob Herring if ($realline == $checklicenseline) { 2919*9f3a8992SRob Herring if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 2920*9f3a8992SRob Herring $checklicenseline = 2; 2921*9f3a8992SRob Herring } elsif ($rawline =~ /^\+/) { 2922*9f3a8992SRob Herring my $comment = ""; 2923*9f3a8992SRob Herring if ($realfile =~ /\.(h|s|S)$/) { 2924*9f3a8992SRob Herring $comment = '/*'; 2925*9f3a8992SRob Herring } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 2926*9f3a8992SRob Herring $comment = '//'; 2927*9f3a8992SRob Herring } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) { 2928*9f3a8992SRob Herring $comment = '#'; 2929*9f3a8992SRob Herring } elsif ($realfile =~ /\.rst$/) { 2930*9f3a8992SRob Herring $comment = '..'; 2931*9f3a8992SRob Herring } 2932*9f3a8992SRob Herring 2933*9f3a8992SRob Herring if ($comment !~ /^$/ && 2934*9f3a8992SRob Herring $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) { 2935*9f3a8992SRob Herring WARN("SPDX_LICENSE_TAG", 2936*9f3a8992SRob Herring "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 2937*9f3a8992SRob Herring } 2938*9f3a8992SRob Herring } 2939*9f3a8992SRob Herring } 2940*9f3a8992SRob Herring 29415368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2942d6430f71SJoe Perches next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 29435368df20SAndy Whitcroft 294447e0c88bSJoe Perches# line length limit (with some exclusions) 294547e0c88bSJoe Perches# 294647e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 294747e0c88bSJoe Perches# logging functions like pr_info that end in a string 294847e0c88bSJoe Perches# lines with a single string 294947e0c88bSJoe Perches# #defines that are a single string 29502e4bbbc5SAndreas Brauchli# lines with an RFC3986 like URL 295147e0c88bSJoe Perches# 295247e0c88bSJoe Perches# There are 3 different line length message types: 2953ab1ecabfSJean Delvare# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 295447e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 295547e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 295647e0c88bSJoe Perches# 295747e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 295847e0c88bSJoe Perches# 295947e0c88bSJoe Perches 2960b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 296147e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 296247e0c88bSJoe Perches 296347e0c88bSJoe Perches # Check the allowed long line types first 296447e0c88bSJoe Perches 296547e0c88bSJoe Perches # logging functions that end in a string that starts 296647e0c88bSJoe Perches # before $max_line_length 296747e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 296847e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 296947e0c88bSJoe Perches $msg_type = ""; 297047e0c88bSJoe Perches 297147e0c88bSJoe Perches # lines with only strings (w/ possible termination) 297247e0c88bSJoe Perches # #defines with only strings 297347e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 297447e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 297547e0c88bSJoe Perches $msg_type = ""; 297647e0c88bSJoe Perches 2977cc147506SJoe Perches # More special cases 2978cc147506SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 2979cc147506SJoe Perches $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 2980d560a5f8SJoe Perches $msg_type = ""; 2981d560a5f8SJoe Perches 29822e4bbbc5SAndreas Brauchli # URL ($rawline is used in case the URL is in a comment) 29832e4bbbc5SAndreas Brauchli } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 29842e4bbbc5SAndreas Brauchli $msg_type = ""; 29852e4bbbc5SAndreas Brauchli 298647e0c88bSJoe Perches # Otherwise set the alternate message types 298747e0c88bSJoe Perches 298847e0c88bSJoe Perches # a comment starts before $max_line_length 298947e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 299047e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 299147e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 299247e0c88bSJoe Perches 299347e0c88bSJoe Perches # a quoted string starts before $max_line_length 299447e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 299547e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 299647e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 299747e0c88bSJoe Perches } 299847e0c88bSJoe Perches 299947e0c88bSJoe Perches if ($msg_type ne "" && 300047e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 300147e0c88bSJoe Perches WARN($msg_type, 30026cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 30030a920b5bSAndy Whitcroft } 300447e0c88bSJoe Perches } 30050a920b5bSAndy Whitcroft 30068905a67cSAndy Whitcroft# check for adding lines without a newline. 30078905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 3008000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 3009000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 30108905a67cSAndy Whitcroft } 30118905a67cSAndy Whitcroft 3012b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 3013de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 30140a920b5bSAndy Whitcroft 30150a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 30160a920b5bSAndy Whitcroft# more than 8 must use tabs. 3017c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 3018c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 3019c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3020d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 30213705ce5bSJoe Perches if (ERROR("CODE_INDENT", 30223705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 30233705ce5bSJoe Perches $fix) { 3024194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 30253705ce5bSJoe Perches } 30260a920b5bSAndy Whitcroft } 30270a920b5bSAndy Whitcroft 302808e44365SAlberto Panizzo# check for space before tabs. 302908e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 303008e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 30313705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 30323705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 30333705ce5bSJoe Perches $fix) { 3034194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3035d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 3036194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 3037c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 30383705ce5bSJoe Perches } 303908e44365SAlberto Panizzo } 304008e44365SAlberto Panizzo 3041d1fe9c09SJoe Perches# check for && or || at the start of a line 3042d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 3043d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 3044d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 3045d1fe9c09SJoe Perches } 3046d1fe9c09SJoe Perches 3047a91e8994SJoe Perches# check indentation starts on a tab stop 3048a91e8994SJoe Perches if ($^V && $^V ge 5.10.0 && 3049bd49111fSJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3050a91e8994SJoe Perches my $indent = length($1); 3051a91e8994SJoe Perches if ($indent % 8) { 3052a91e8994SJoe Perches if (WARN("TABSTOP", 3053a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 3054a91e8994SJoe Perches $fix) { 3055a91e8994SJoe Perches $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; 3056a91e8994SJoe Perches } 3057a91e8994SJoe Perches } 3058a91e8994SJoe Perches } 3059a91e8994SJoe Perches 3060d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 3061d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3062fd71f632SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3063d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 3064d1fe9c09SJoe Perches my $oldindent = $1; 3065d1fe9c09SJoe Perches my $rest = $2; 3066d1fe9c09SJoe Perches 3067d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 3068d1fe9c09SJoe Perches if ($pos >= 0) { 3069b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 3070b34a26f3SJoe Perches my $newindent = $2; 3071d1fe9c09SJoe Perches 3072d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 3073d1fe9c09SJoe Perches "\t" x ($pos / 8) . 3074d1fe9c09SJoe Perches " " x ($pos % 8); 3075d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 3076d1fe9c09SJoe Perches 3077d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 3078d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 30793705ce5bSJoe Perches 30803705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 30813705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 30823705ce5bSJoe Perches $fix && $line =~ /^\+/) { 3083194f66fcSJoe Perches $fixed[$fixlinenr] =~ 30843705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 30853705ce5bSJoe Perches } 3086d1fe9c09SJoe Perches } 3087d1fe9c09SJoe Perches } 3088d1fe9c09SJoe Perches } 3089d1fe9c09SJoe Perches 30906ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 30916ab3a970SJoe Perches# avoid checking a few false positives: 30926ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 30936ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 30946ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 30956ab3a970SJoe Perches# multiline macros that define functions 30966ab3a970SJoe Perches# known attributes or the __attribute__ keyword 30976ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 30986ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 30993705ce5bSJoe Perches if (CHK("SPACING", 3100f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 31013705ce5bSJoe Perches $fix) { 3102194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3103f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 31043705ce5bSJoe Perches } 3105aad4f614SJoe Perches } 3106aad4f614SJoe Perches 310786406b1cSJoe Perches# Block comment styles 310886406b1cSJoe Perches# Networking with an initial /* 310905880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 3110fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 311185ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 311285ad978cSJoe Perches $realline > 2) { 311305880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 311405880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 311505880600SJoe Perches } 311605880600SJoe Perches 311786406b1cSJoe Perches# Block comments use * on subsequent lines 311886406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 311986406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3120a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 312161135e96SJoe Perches $rawline =~ /^\+/ && #line is new 3122a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 312386406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 312486406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 3125a605e32eSJoe Perches } 3126a605e32eSJoe Perches 312786406b1cSJoe Perches# Block comments use */ on trailing lines 312886406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3129c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3130c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3131c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 313286406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 313386406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 313405880600SJoe Perches } 313505880600SJoe Perches 313608eb9b80SJoe Perches# Block comment * alignment 313708eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3138af207524SJoe Perches $line =~ /^\+[ \t]*$;/ && #leading comment 3139af207524SJoe Perches $rawline =~ /^\+[ \t]*\*/ && #leading * 3140af207524SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 314108eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3142af207524SJoe Perches $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3143af207524SJoe Perches my $oldindent; 314408eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 3145af207524SJoe Perches if (defined($1)) { 3146af207524SJoe Perches $oldindent = expand_tabs($1); 3147af207524SJoe Perches } else { 3148af207524SJoe Perches $prevrawline =~ m@^\+(.*/?)\*@; 3149af207524SJoe Perches $oldindent = expand_tabs($1); 3150af207524SJoe Perches } 315108eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 315208eb9b80SJoe Perches my $newindent = $1; 315308eb9b80SJoe Perches $newindent = expand_tabs($newindent); 3154af207524SJoe Perches if (length($oldindent) ne length($newindent)) { 315508eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 315608eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 315708eb9b80SJoe Perches } 315808eb9b80SJoe Perches } 315908eb9b80SJoe Perches 31607f619191SJoe Perches# check for missing blank lines after struct/union declarations 31617f619191SJoe Perches# with exceptions for various attributes and macros 31627f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 31637f619191SJoe Perches $line =~ /^\+/ && 31647f619191SJoe Perches !($line =~ /^\+\s*$/ || 31657f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 31667f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 31677f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 31687f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 31697f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 31707f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 31710bc989ffSMasahiro Yamada $line =~ /^\+\s*builtin_[\w_]*driver/ || 31727f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3173d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3174d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3175d752fcc8SJoe Perches $fix) { 3176f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3177d752fcc8SJoe Perches } 31787f619191SJoe Perches } 31797f619191SJoe Perches 3180365dd4eaSJoe Perches# check for multiple consecutive blank lines 3181365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3182365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3183365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3184d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3185d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3186d752fcc8SJoe Perches $fix) { 3187f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3188d752fcc8SJoe Perches } 3189d752fcc8SJoe Perches 3190365dd4eaSJoe Perches $last_blank_line = $linenr; 3191365dd4eaSJoe Perches } 3192365dd4eaSJoe Perches 31933b617e3bSJoe Perches# check for missing blank lines after declarations 31943f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 31953f7bac03SJoe Perches # actual declarations 31963f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 31975a4e1fd3SJoe Perches # function pointer declarations 31985a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 31993f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 32003f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 32013f7bac03SJoe Perches # known declaration macros 32023f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 32033f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 32043f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 32053f7bac03SJoe Perches # other possible extensions of declaration lines 32063f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 32073f7bac03SJoe Perches # not starting a section or a macro "\" extended line 32083f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 32093f7bac03SJoe Perches # looks like a declaration 32103f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 32115a4e1fd3SJoe Perches # function pointer declarations 32125a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 32133f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 32143f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 32153f7bac03SJoe Perches # known declaration macros 32163f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 32173f7bac03SJoe Perches # start of struct or union or enum 32183b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 32193f7bac03SJoe Perches # start or end of block or continuation of declaration 32203f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 32213f7bac03SJoe Perches # bitfield continuation 32223f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 32233f7bac03SJoe Perches # other possible extensions of declaration lines 32243f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 32253f7bac03SJoe Perches # indentation of previous and current line are the same 32263f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3227d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3228d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3229d752fcc8SJoe Perches $fix) { 3230f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3231d752fcc8SJoe Perches } 32323b617e3bSJoe Perches } 32333b617e3bSJoe Perches 32345f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 32356b4c5bebSAndy Whitcroft# Exceptions: 32366b4c5bebSAndy Whitcroft# 1) within comments 32376b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 32386b4c5bebSAndy Whitcroft# 3) hanging labels 32393705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 32405f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 32413705ce5bSJoe Perches if (WARN("LEADING_SPACE", 32423705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 32433705ce5bSJoe Perches $fix) { 3244194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 32453705ce5bSJoe Perches } 32465f7ddae6SRaffaele Recalcati } 32475f7ddae6SRaffaele Recalcati 3248b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3249b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3250b9ea10d6SAndy Whitcroft 32515751a24eSJoe Perches# check for unusual line ending [ or ( 32525751a24eSJoe Perches if ($line =~ /^\+.*([\[\(])\s*$/) { 32535751a24eSJoe Perches CHK("OPEN_ENDED_LINE", 32545751a24eSJoe Perches "Lines should not end with a '$1'\n" . $herecurr); 32555751a24eSJoe Perches } 32565751a24eSJoe Perches 32574dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name 32584dbed76fSJoe Perches if ($sline =~ /^\+\{\s*$/ && 32594dbed76fSJoe Perches $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 32604dbed76fSJoe Perches $context_function = $1; 32614dbed76fSJoe Perches } 32624dbed76fSJoe Perches 32634dbed76fSJoe Perches# check if this appears to be the end of function declaration 32644dbed76fSJoe Perches if ($sline =~ /^\+\}\s*$/) { 32654dbed76fSJoe Perches undef $context_function; 32664dbed76fSJoe Perches } 32674dbed76fSJoe Perches 3268032a4c0fSJoe Perches# check indentation of any line with a bare else 3269840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3270032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3271032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3272032a4c0fSJoe Perches my $tabs = length($1) + 1; 3273840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3274840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3275840080a0SJoe Perches defined $lines[$linenr] && 3276840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3277032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3278032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3279032a4c0fSJoe Perches } 3280032a4c0fSJoe Perches } 3281032a4c0fSJoe Perches 3282c00df19aSJoe Perches# check indentation of a line with a break; 3283c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3284c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3285c00df19aSJoe Perches my $tabs = $1; 3286c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3287c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3288c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3289c00df19aSJoe Perches } 3290c00df19aSJoe Perches } 3291c00df19aSJoe Perches 3292c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3293cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3294000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3295000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3296c2fdda0dSAndy Whitcroft } 329722f2a2efSAndy Whitcroft 329856e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 329956e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 330056e77d70SJoe Perches WARN("HOTPLUG_SECTION", 330156e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 330256e77d70SJoe Perches } 330356e77d70SJoe Perches 33049c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 33052b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 33062b474a1aSAndy Whitcroft $realline_next); 33073e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 3308ca819864SJoe Perches if ($linenr > $suppress_statement && 33091b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3310170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3311f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3312171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3313171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3314171ae1a4SAndy Whitcroft 33153e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 33163e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 33173e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 33183e469cdcSAndy Whitcroft # until we hit end of it. 33193e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 33203e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 33213e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 33223e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 33233e469cdcSAndy Whitcroft } 3324f74bd194SAndy Whitcroft 33252b474a1aSAndy Whitcroft # Find the real next line. 33262b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 33272b474a1aSAndy Whitcroft if (defined $realline_next && 33282b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 33292b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 33302b474a1aSAndy Whitcroft $realline_next++; 33312b474a1aSAndy Whitcroft } 33322b474a1aSAndy Whitcroft 3333171ae1a4SAndy Whitcroft my $s = $stat; 3334171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3335cf655043SAndy Whitcroft 3336c2fdda0dSAndy Whitcroft # Ignore goto labels. 3337171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3338c2fdda0dSAndy Whitcroft 3339c2fdda0dSAndy Whitcroft # Ignore functions being called 3340171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3341c2fdda0dSAndy Whitcroft 3342463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3343463f2864SAndy Whitcroft 3344c45dcabdSAndy Whitcroft # declarations always start with types 3345d2506586SAndy 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) { 3346c45dcabdSAndy Whitcroft my $type = $1; 3347c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3348c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3349c45dcabdSAndy Whitcroft 33506c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3351a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3352c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3353c2fdda0dSAndy Whitcroft } 33548905a67cSAndy Whitcroft 33556c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 335665863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3357c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 33589c0ca6f9SAndy Whitcroft } 33598905a67cSAndy Whitcroft 33608905a67cSAndy Whitcroft # Check for any sort of function declaration. 33618905a67cSAndy Whitcroft # int foo(something bar, other baz); 33628905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3363171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 33648905a67cSAndy Whitcroft my ($name_len) = length($1); 33658905a67cSAndy Whitcroft 3366cf655043SAndy Whitcroft my $ctx = $s; 3367773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 33688905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3369cf655043SAndy Whitcroft 33708905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3371c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 33728905a67cSAndy Whitcroft 3373c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 33748905a67cSAndy Whitcroft } 33758905a67cSAndy Whitcroft } 33768905a67cSAndy Whitcroft } 33778905a67cSAndy Whitcroft 33789c0ca6f9SAndy Whitcroft } 33799c0ca6f9SAndy Whitcroft 338000df344fSAndy Whitcroft# 338100df344fSAndy Whitcroft# Checks which may be anchored in the context. 338200df344fSAndy Whitcroft# 338300df344fSAndy Whitcroft 338400df344fSAndy Whitcroft# Check for switch () and associated case and default 338500df344fSAndy Whitcroft# statements should be at the same indent. 338600df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 338700df344fSAndy Whitcroft my $err = ''; 338800df344fSAndy Whitcroft my $sep = ''; 338900df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 339000df344fSAndy Whitcroft shift(@ctx); 339100df344fSAndy Whitcroft for my $ctx (@ctx) { 339200df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 339300df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 339400df344fSAndy Whitcroft $indent != $cindent) { 339500df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 339600df344fSAndy Whitcroft $sep = ''; 339700df344fSAndy Whitcroft } else { 339800df344fSAndy Whitcroft $sep = "[...]\n"; 339900df344fSAndy Whitcroft } 340000df344fSAndy Whitcroft } 340100df344fSAndy Whitcroft if ($err ne '') { 3402000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3403000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3404de7d4f0eSAndy Whitcroft } 3405de7d4f0eSAndy Whitcroft } 3406de7d4f0eSAndy Whitcroft 3407de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3408de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 34090fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3410773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3411773647a0SAndy Whitcroft 34129c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 34138eef05ddSJoe Perches 34148eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 34158eef05ddSJoe Perches WARN("DEEP_INDENTATION", 34168eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 34178eef05ddSJoe Perches } 34188eef05ddSJoe Perches 3419de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3420de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3421de7d4f0eSAndy Whitcroft 3422548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3423548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3424de7d4f0eSAndy Whitcroft 3425548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3426548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3427548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3428548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3429548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3430773647a0SAndy Whitcroft $ctx_ln++; 3431773647a0SAndy Whitcroft } 3432548596d5SAndy Whitcroft 343353210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 343453210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3435773647a0SAndy Whitcroft 3436773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3437000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3438000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 343901464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 344000df344fSAndy Whitcroft } 3441773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3442773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3443773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3444773647a0SAndy Whitcroft { 34459c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 34469c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3447000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3448000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 344901464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 34509c0ca6f9SAndy Whitcroft } 34519c0ca6f9SAndy Whitcroft } 345200df344fSAndy Whitcroft } 345300df344fSAndy Whitcroft 34544d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 3455f6950a73SJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 34563e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 34573e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 34583e469cdcSAndy Whitcroft if (!defined $stat); 34594d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 34604d001e4dSAndy Whitcroft 34614d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 34624d001e4dSAndy Whitcroft 34639f5af480SJoe Perches # remove inline comments 34649f5af480SJoe Perches $s =~ s/$;/ /g; 34659f5af480SJoe Perches $c =~ s/$;/ /g; 34664d001e4dSAndy Whitcroft 34674d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 34686f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 34696f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 34704d001e4dSAndy Whitcroft 34719f5af480SJoe Perches # Make sure we remove the line prefixes as we have 34729f5af480SJoe Perches # none on the first line, and are going to readd them 34739f5af480SJoe Perches # where necessary. 34749f5af480SJoe Perches $s =~ s/\n./\n/gs; 34759f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 34769f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 34779f5af480SJoe Perches } 34789f5af480SJoe Perches 34794d001e4dSAndy Whitcroft # We want to check the first line inside the block 34804d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 34814d001e4dSAndy Whitcroft # 1) any blank line termination 34824d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 34834d001e4dSAndy Whitcroft # 3) any do (...) { 34844d001e4dSAndy Whitcroft my $continuation = 0; 34854d001e4dSAndy Whitcroft my $check = 0; 34864d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 34874d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 34884d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 34894d001e4dSAndy Whitcroft $continuation = 1; 34904d001e4dSAndy Whitcroft } 34919bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 34924d001e4dSAndy Whitcroft $check = 1; 34934d001e4dSAndy Whitcroft $cond_lines++; 34944d001e4dSAndy Whitcroft } 34954d001e4dSAndy Whitcroft 34964d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 34974d001e4dSAndy Whitcroft # preprocessor statement. 34984d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 34994d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 35004d001e4dSAndy Whitcroft $check = 0; 35014d001e4dSAndy Whitcroft } 35024d001e4dSAndy Whitcroft 35039bd49efeSAndy Whitcroft my $cond_ptr = -1; 3504740504c6SAndy Whitcroft $continuation = 0; 35059bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 35069bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 35074d001e4dSAndy Whitcroft 3508f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3509f16fa28fSAndy Whitcroft # is not linear. 3510f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3511f16fa28fSAndy Whitcroft $check = 0; 3512f16fa28fSAndy Whitcroft } 3513f16fa28fSAndy Whitcroft 35149bd49efeSAndy Whitcroft # Ignore: 35159bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 35169bd49efeSAndy Whitcroft # 2) preprocessor lines, and 35179bd49efeSAndy Whitcroft # 3) labels. 3518740504c6SAndy Whitcroft if ($continuation || 3519740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 35209bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 35219bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3522740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 352330dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 35249bd49efeSAndy Whitcroft $cond_lines++; 35259bd49efeSAndy Whitcroft } 35264d001e4dSAndy Whitcroft } 352730dad6ebSAndy Whitcroft } 35284d001e4dSAndy Whitcroft 35294d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 35304d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 35314d001e4dSAndy Whitcroft 35324d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 35334d001e4dSAndy Whitcroft # this is not this patch's fault. 35344d001e4dSAndy Whitcroft if (!defined($stat_real) || 35354d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 35364d001e4dSAndy Whitcroft $check = 0; 35374d001e4dSAndy Whitcroft } 35384d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 35394d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 35404d001e4dSAndy Whitcroft } 35414d001e4dSAndy Whitcroft 35429bd49efeSAndy 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"; 35434d001e4dSAndy Whitcroft 35449f5af480SJoe Perches if ($check && $s ne '' && 35459f5af480SJoe Perches (($sindent % 8) != 0 || 35469f5af480SJoe Perches ($sindent < $indent) || 3547f6950a73SJoe Perches ($sindent == $indent && 3548f6950a73SJoe Perches ($s !~ /^\s*(?:\}|\{|else\b)/)) || 35499f5af480SJoe Perches ($sindent > $indent + 8))) { 3550000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3551000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 35524d001e4dSAndy Whitcroft } 35534d001e4dSAndy Whitcroft } 35544d001e4dSAndy Whitcroft 35556c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 35566c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 35571f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 35581f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 35596c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3560c2fdda0dSAndy Whitcroft if ($dbg_values) { 3561c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3562cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3563cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 35641f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3565c2fdda0dSAndy Whitcroft } 35666c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 35676c72ffaaSAndy Whitcroft 356800df344fSAndy Whitcroft#ignore lines not being added 35693705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 357000df344fSAndy Whitcroft 357111ca40a0SJoe Perches# check for dereferences that span multiple lines 357211ca40a0SJoe Perches if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 357311ca40a0SJoe Perches $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 357411ca40a0SJoe Perches $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 357511ca40a0SJoe Perches my $ref = $1; 357611ca40a0SJoe Perches $line =~ /^.\s*($Lval)/; 357711ca40a0SJoe Perches $ref .= $1; 357811ca40a0SJoe Perches $ref =~ s/\s//g; 357911ca40a0SJoe Perches WARN("MULTILINE_DEREFERENCE", 358011ca40a0SJoe Perches "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 358111ca40a0SJoe Perches } 358211ca40a0SJoe Perches 3583a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3584c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3585a1ce18e4SJoe Perches my $type = $1; 3586a1ce18e4SJoe Perches my $var = $2; 3587207a8e84SJoe Perches $var = "" if (!defined $var); 3588207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3589a1ce18e4SJoe Perches my $sign = $1; 3590a1ce18e4SJoe Perches my $pointer = $2; 3591a1ce18e4SJoe Perches 3592a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3593a1ce18e4SJoe Perches 3594a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3595a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3596a1ce18e4SJoe Perches $fix) { 3597a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3598207a8e84SJoe Perches my $comp_pointer = $pointer; 3599207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 3600207a8e84SJoe Perches $decl .= $comp_pointer; 3601207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 3602207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 3603a1ce18e4SJoe Perches } 3604a1ce18e4SJoe Perches } 3605a1ce18e4SJoe Perches } 3606a1ce18e4SJoe Perches 3607653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 36087429c690SAndy Whitcroft if ($dbg_type) { 36097429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3610000d1cc1SJoe Perches ERROR("TEST_TYPE", 3611000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 36127429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3613000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3614000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 36157429c690SAndy Whitcroft } 3616653d4876SAndy Whitcroft next; 3617653d4876SAndy Whitcroft } 3618a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3619a1ef277eSAndy Whitcroft if ($dbg_attr) { 36209360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3621000d1cc1SJoe Perches ERROR("TEST_ATTR", 3622000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 36239360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3624000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3625000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3626a1ef277eSAndy Whitcroft } 3627a1ef277eSAndy Whitcroft next; 3628a1ef277eSAndy Whitcroft } 3629653d4876SAndy Whitcroft 3630f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 363199423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 363299423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3633d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3634d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3635f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3636f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3637f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3638d752fcc8SJoe Perches my $fixedline = $prevrawline; 3639d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3640f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3641d752fcc8SJoe Perches $fixedline = $line; 36428d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1/; 3643f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3644d752fcc8SJoe Perches } 3645f0a594c1SAndy Whitcroft } 3646f0a594c1SAndy Whitcroft 364700df344fSAndy Whitcroft# 364800df344fSAndy Whitcroft# Checks which are anchored on the added line. 364900df344fSAndy Whitcroft# 365000df344fSAndy Whitcroft 3651653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3652c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3653653d4876SAndy Whitcroft my $path = $1; 3654653d4876SAndy Whitcroft if ($path =~ m{//}) { 3655000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3656495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3657495e9d84SJoe Perches } 3658495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3659495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3660495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3661653d4876SAndy Whitcroft } 3662653d4876SAndy Whitcroft } 3663653d4876SAndy Whitcroft 366400df344fSAndy Whitcroft# no C99 // comments 366500df344fSAndy Whitcroft if ($line =~ m{//}) { 36663705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 36673705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 36683705ce5bSJoe Perches $fix) { 3669194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 36703705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 36713705ce5bSJoe Perches my $comment = trim($1); 3672194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 36733705ce5bSJoe Perches } 36743705ce5bSJoe Perches } 367500df344fSAndy Whitcroft } 367600df344fSAndy Whitcroft # Remove C99 comments. 36770a920b5bSAndy Whitcroft $line =~ s@//.*@@; 36786c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 36790a920b5bSAndy Whitcroft 36802b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 36812b474a1aSAndy Whitcroft# the whole statement. 36822b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 36832b474a1aSAndy Whitcroft if (defined $realline_next && 36842b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 36852b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 36862b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 36872b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 36883cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 36893cbf62dfSAndy Whitcroft # a prefix: 36903cbf62dfSAndy Whitcroft # XXX(foo); 36913cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3692653d4876SAndy Whitcroft my $name = $1; 369387a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 36943cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 36953cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 36963cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 36973cbf62dfSAndy Whitcroft 36983cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 36992b474a1aSAndy Whitcroft \n.}\s*$| 370048012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 370148012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 370248012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 37032b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 37042b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 370548012058SAndy Whitcroft )/x) { 37062b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 37072b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 37082b474a1aSAndy Whitcroft } else { 37092b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 37100a920b5bSAndy Whitcroft } 37110a920b5bSAndy Whitcroft } 37122b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 37132b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 37142b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 37152b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 37162b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 37172b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 37182b474a1aSAndy Whitcroft } 37192b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 37202b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3721000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3722000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 37232b474a1aSAndy Whitcroft } 37240a920b5bSAndy Whitcroft 37255150bda4SJoe Eloff# check for global initialisers. 37266d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 3727d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 37286d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 3729d5e616fcSJoe Perches $fix) { 37306d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 3731d5e616fcSJoe Perches } 3732f0a594c1SAndy Whitcroft } 37330a920b5bSAndy Whitcroft# check for static initialisers. 37346d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 3735d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 37366d32f7a3SJoe Perches "do not initialise statics to $1\n" . 3737d5e616fcSJoe Perches $herecurr) && 3738d5e616fcSJoe Perches $fix) { 37396d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 3740d5e616fcSJoe Perches } 37410a920b5bSAndy Whitcroft } 37420a920b5bSAndy Whitcroft 37431813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 37441813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 37451813087dSJoe Perches my $tmp = trim($1); 37461813087dSJoe Perches WARN("MISORDERED_TYPE", 37471813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 37481813087dSJoe Perches } 37491813087dSJoe Perches 3750cb710ecaSJoe Perches# check for static const char * arrays. 3751cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3752000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3753000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3754cb710ecaSJoe Perches $herecurr); 3755cb710ecaSJoe Perches } 3756cb710ecaSJoe Perches 3757cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3758cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3759000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3760000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3761cb710ecaSJoe Perches $herecurr); 3762cb710ecaSJoe Perches } 3763cb710ecaSJoe Perches 3764ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3765ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3766ab7e23f3SJoe Perches my $found = $1; 3767ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3768ab7e23f3SJoe Perches WARN("CONST_CONST", 3769ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3770ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3771ab7e23f3SJoe Perches WARN("CONST_CONST", 3772ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3773ab7e23f3SJoe Perches } 3774ab7e23f3SJoe Perches } 3775ab7e23f3SJoe Perches 37769b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 37779b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 37789b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 37799b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 37809b0fa60dSJoe Perches $herecurr); 37819b0fa60dSJoe Perches } 37829b0fa60dSJoe Perches 3783b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3784b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3785b598b670SJoe Perches my $array = $1; 3786b598b670SJoe 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*\))@) { 3787b598b670SJoe Perches my $array_div = $1; 3788b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3789b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3790b598b670SJoe Perches $fix) { 3791b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3792b598b670SJoe Perches } 3793b598b670SJoe Perches } 3794b598b670SJoe Perches } 3795b598b670SJoe Perches 3796b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3797b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3798b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3799b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3800b36190c5SJoe Perches $fix) { 3801194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3802b36190c5SJoe Perches } 3803b36190c5SJoe Perches } 3804b36190c5SJoe Perches 3805653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3806653d4876SAndy Whitcroft# make sense. 3807653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 38088054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3809c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 38108ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 381146d832f5SMichael S. Tsirkin $line !~ /\b__bitwise\b/) { 3812000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3813000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 38140a920b5bSAndy Whitcroft } 38150a920b5bSAndy Whitcroft 38160a920b5bSAndy Whitcroft# * goes on variable not on type 381765863862SAndy Whitcroft # (char*[ const]) 3818bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3819bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 38203705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3821d8aaf121SAndy Whitcroft 382265863862SAndy Whitcroft # Should start with a space. 382365863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 382465863862SAndy Whitcroft # Should not end with a space. 382565863862SAndy Whitcroft $to =~ s/\s+$//; 382665863862SAndy Whitcroft # '*'s should not have spaces between. 3827f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 382865863862SAndy Whitcroft } 3829d8aaf121SAndy Whitcroft 38303705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 383165863862SAndy Whitcroft if ($from ne $to) { 38323705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 38333705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 38343705ce5bSJoe Perches $fix) { 38353705ce5bSJoe Perches my $sub_from = $ident; 38363705ce5bSJoe Perches my $sub_to = $ident; 38373705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3838194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38393705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 38403705ce5bSJoe Perches } 384165863862SAndy Whitcroft } 3842bfcb2cc7SAndy Whitcroft } 3843bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3844bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 38453705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3846d8aaf121SAndy Whitcroft 384765863862SAndy Whitcroft # Should start with a space. 384865863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 384965863862SAndy Whitcroft # Should not end with a space. 385065863862SAndy Whitcroft $to =~ s/\s+$//; 385165863862SAndy Whitcroft # '*'s should not have spaces between. 3852f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 385365863862SAndy Whitcroft } 385465863862SAndy Whitcroft # Modifiers should have spaces. 385565863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 385665863862SAndy Whitcroft 38573705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3858667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 38593705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 38603705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 38613705ce5bSJoe Perches $fix) { 38623705ce5bSJoe Perches 38633705ce5bSJoe Perches my $sub_from = $match; 38643705ce5bSJoe Perches my $sub_to = $match; 38653705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3866194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38673705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 38683705ce5bSJoe Perches } 386965863862SAndy Whitcroft } 38700a920b5bSAndy Whitcroft } 38710a920b5bSAndy Whitcroft 38729d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 38739d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 38740675a8fbSJean Delvare my $msg_level = \&WARN; 38750675a8fbSJean Delvare $msg_level = \&CHK if ($file); 38760675a8fbSJean Delvare &{$msg_level}("AVOID_BUG", 38779d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 38789d3e3c70SJoe Perches } 38790a920b5bSAndy Whitcroft 38809d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 38818905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3882000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3883000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 38848905a67cSAndy Whitcroft } 38858905a67cSAndy Whitcroft 388617441227SJoe Perches# check for uses of printk_ratelimit 388717441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3888000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3889000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 389017441227SJoe Perches } 389117441227SJoe Perches 3892eeef5733SJoe Perches# printk should use KERN_* levels 3893eeef5733SJoe Perches if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 3894000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3895eeef5733SJoe Perches "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 389600df344fSAndy Whitcroft } 38970a920b5bSAndy Whitcroft 3898243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3899243f3803SJoe Perches my $orig = $1; 3900243f3803SJoe Perches my $level = lc($orig); 3901243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 39028f26b837SJoe Perches my $level2 = $level; 39038f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3904243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3905daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3906243f3803SJoe Perches } 3907243f3803SJoe Perches 3908243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3909d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3910d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3911d5e616fcSJoe Perches $fix) { 3912194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3913d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3914d5e616fcSJoe Perches } 3915243f3803SJoe Perches } 3916243f3803SJoe Perches 3917dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3918dc139313SJoe Perches my $orig = $1; 3919dc139313SJoe Perches my $level = lc($orig); 3920dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3921dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3922dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3923dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3924dc139313SJoe Perches } 3925dc139313SJoe Perches 392691c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 392791c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 392891c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 392991c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 393091c9afafSAndy Lutomirski WARN("ENOSYS", 393191c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 393291c9afafSAndy Lutomirski } 393391c9afafSAndy Lutomirski 3934653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3935653d4876SAndy Whitcroft# or if closed on same line 39362d453e3bSJoe Perches if ($^V && $^V ge 5.10.0 && 39372d453e3bSJoe Perches $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 39382d453e3bSJoe Perches $sline !~ /\#\s*define\b.*do\s*\{/ && 39392d453e3bSJoe Perches $sline !~ /}/) { 39408d182478SJoe Perches if (ERROR("OPEN_BRACE", 39412d453e3bSJoe Perches "open brace '{' following function definitions go on the next line\n" . $herecurr) && 39428d182478SJoe Perches $fix) { 39438d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 39448d182478SJoe Perches my $fixed_line = $rawline; 39458d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 39468d182478SJoe Perches my $line1 = $1; 39478d182478SJoe Perches my $line2 = $2; 39488d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 39498d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 39508d182478SJoe Perches if ($line2 !~ /^\s*$/) { 39518d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 39528d182478SJoe Perches } 39538d182478SJoe Perches } 39540a920b5bSAndy Whitcroft } 3955653d4876SAndy Whitcroft 39568905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 39578905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 39588905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 39598d182478SJoe Perches if (ERROR("OPEN_BRACE", 39608d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 39618d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 39628d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 39638d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 39648d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 39658d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 39668d182478SJoe Perches $fixedline = $rawline; 39678d81ae05SCyril Bur $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 39688d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 39698d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 39708d182478SJoe Perches } 39718d182478SJoe Perches } 39728905a67cSAndy Whitcroft } 39738905a67cSAndy Whitcroft 39740c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 39753705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 39763705ce5bSJoe Perches if (WARN("SPACING", 39773705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 39783705ce5bSJoe Perches $fix) { 3979194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39803705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 39813705ce5bSJoe Perches } 39820c73b4ebSAndy Whitcroft } 39830c73b4ebSAndy Whitcroft 398431070b5dSJoe Perches# Function pointer declarations 398531070b5dSJoe Perches# check spacing between type, funcptr, and args 398631070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 398791f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 398831070b5dSJoe Perches my $declare = $1; 398931070b5dSJoe Perches my $pre_pointer_space = $2; 399031070b5dSJoe Perches my $post_pointer_space = $3; 399131070b5dSJoe Perches my $funcname = $4; 399231070b5dSJoe Perches my $post_funcname_space = $5; 399331070b5dSJoe Perches my $pre_args_space = $6; 399431070b5dSJoe Perches 399591f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 399691f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 399791f72e9cSJoe Perches# don't need a space so don't warn for those. 399891f72e9cSJoe Perches my $post_declare_space = ""; 399991f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 400091f72e9cSJoe Perches $post_declare_space = $1; 400191f72e9cSJoe Perches $declare = rtrim($declare); 400291f72e9cSJoe Perches } 400391f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 400431070b5dSJoe Perches WARN("SPACING", 400531070b5dSJoe Perches "missing space after return type\n" . $herecurr); 400691f72e9cSJoe Perches $post_declare_space = " "; 400731070b5dSJoe Perches } 400831070b5dSJoe Perches 400931070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 401091f72e9cSJoe Perches# This test is not currently implemented because these declarations are 401191f72e9cSJoe Perches# equivalent to 401291f72e9cSJoe Perches# int foo(int bar, ...) 401391f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 401491f72e9cSJoe Perches# 401591f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 401691f72e9cSJoe Perches# WARN("SPACING", 401791f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 401891f72e9cSJoe Perches# } 401931070b5dSJoe Perches 402031070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 402131070b5dSJoe Perches if (defined $pre_pointer_space && 402231070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 402331070b5dSJoe Perches WARN("SPACING", 402431070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 402531070b5dSJoe Perches } 402631070b5dSJoe Perches 402731070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 402831070b5dSJoe Perches if (defined $post_pointer_space && 402931070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 403031070b5dSJoe Perches WARN("SPACING", 403131070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 403231070b5dSJoe Perches } 403331070b5dSJoe Perches 403431070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 403531070b5dSJoe Perches if (defined $post_funcname_space && 403631070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 403731070b5dSJoe Perches WARN("SPACING", 403831070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 403931070b5dSJoe Perches } 404031070b5dSJoe Perches 404131070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 404231070b5dSJoe Perches if (defined $pre_args_space && 404331070b5dSJoe Perches $pre_args_space =~ /^\s/) { 404431070b5dSJoe Perches WARN("SPACING", 404531070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 404631070b5dSJoe Perches } 404731070b5dSJoe Perches 404831070b5dSJoe Perches if (show_type("SPACING") && $fix) { 4049194f66fcSJoe Perches $fixed[$fixlinenr] =~ 405091f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 405131070b5dSJoe Perches } 405231070b5dSJoe Perches } 405331070b5dSJoe Perches 40548d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 40558d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 4056fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4057fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 40588d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 40598d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 40608d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 4061fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 4062daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 40633705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 40643705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 40653705ce5bSJoe Perches $fix) { 4066194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40673705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 40683705ce5bSJoe Perches } 40698d31cfceSAndy Whitcroft } 40708d31cfceSAndy Whitcroft } 40718d31cfceSAndy Whitcroft 4072f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 40736c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 4074c2fdda0dSAndy Whitcroft my $name = $1; 4075773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 4076773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 4077c2fdda0dSAndy Whitcroft 4078c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 4079773647a0SAndy Whitcroft if ($name =~ /^(?: 4080773647a0SAndy Whitcroft if|for|while|switch|return|case| 4081773647a0SAndy Whitcroft volatile|__volatile__| 4082773647a0SAndy Whitcroft __attribute__|format|__extension__| 4083773647a0SAndy Whitcroft asm|__asm__)$/x) 4084773647a0SAndy Whitcroft { 4085c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 4086c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 4087c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 4088c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4089773647a0SAndy Whitcroft 4090773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 4091c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4092c2fdda0dSAndy Whitcroft 4093c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 4094c2fdda0dSAndy Whitcroft # likely a typedef for a function. 4095773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 4096c2fdda0dSAndy Whitcroft 4097c2fdda0dSAndy Whitcroft } else { 40983705ce5bSJoe Perches if (WARN("SPACING", 40993705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 41003705ce5bSJoe Perches $fix) { 4101194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41023705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 41033705ce5bSJoe Perches } 4104f0a594c1SAndy Whitcroft } 41056c72ffaaSAndy Whitcroft } 41069a4cad4eSEric Nelson 4107653d4876SAndy Whitcroft# Check operator spacing. 41080a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 41093705ce5bSJoe Perches my $fixed_line = ""; 41103705ce5bSJoe Perches my $line_fixed = 0; 41113705ce5bSJoe Perches 41129c0ca6f9SAndy Whitcroft my $ops = qr{ 41139c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 41149c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 41159c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 41161f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 411784731623SJoe Perches \?:|\?|: 41189c0ca6f9SAndy Whitcroft }x; 4119cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 41203705ce5bSJoe Perches 41213705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 41223705ce5bSJoe Perches## foreach my $el (@elements) { 41233705ce5bSJoe Perches## print("el: <$el>\n"); 41243705ce5bSJoe Perches## } 41253705ce5bSJoe Perches 41263705ce5bSJoe Perches my @fix_elements = (); 412700df344fSAndy Whitcroft my $off = 0; 41286c72ffaaSAndy Whitcroft 41293705ce5bSJoe Perches foreach my $el (@elements) { 41303705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 41313705ce5bSJoe Perches $off += length($el); 41323705ce5bSJoe Perches } 41333705ce5bSJoe Perches 41343705ce5bSJoe Perches $off = 0; 41353705ce5bSJoe Perches 41366c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4137b34c648bSJoe Perches my $last_after = -1; 41386c72ffaaSAndy Whitcroft 41390a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 41403705ce5bSJoe Perches 41413705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 41423705ce5bSJoe Perches 41433705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 41443705ce5bSJoe Perches 41454a0df2efSAndy Whitcroft $off += length($elements[$n]); 41464a0df2efSAndy Whitcroft 414725985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4148773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4149773647a0SAndy Whitcroft my $cc = ''; 4150773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4151773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4152773647a0SAndy Whitcroft } 4153773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4154773647a0SAndy Whitcroft 41554a0df2efSAndy Whitcroft my $a = ''; 41564a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 41574a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4158cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 41594a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 41604a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 4161773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 41624a0df2efSAndy Whitcroft 41630a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 41644a0df2efSAndy Whitcroft 41654a0df2efSAndy Whitcroft my $c = ''; 41660a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 41674a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 41684a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4169cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 41704a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 41714a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 41728b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 41734a0df2efSAndy Whitcroft } else { 41744a0df2efSAndy Whitcroft $c = 'E'; 41750a920b5bSAndy Whitcroft } 41760a920b5bSAndy Whitcroft 41774a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 41784a0df2efSAndy Whitcroft 41794a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 41804a0df2efSAndy Whitcroft 41816c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 4182de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 41830a920b5bSAndy Whitcroft 418474048ed8SAndy Whitcroft # Pull out the value of this operator. 41856c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 41860a920b5bSAndy Whitcroft 41871f65f947SAndy Whitcroft # Get the full operator variant. 41881f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 41891f65f947SAndy Whitcroft 419013214adfSAndy Whitcroft # Ignore operators passed as parameters. 419113214adfSAndy Whitcroft if ($op_type ne 'V' && 4192d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 419313214adfSAndy Whitcroft 4194cf655043SAndy Whitcroft# # Ignore comments 4195cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 419613214adfSAndy Whitcroft 4197d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 419813214adfSAndy Whitcroft } elsif ($op eq ';') { 4199cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 4200cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 42013705ce5bSJoe Perches if (ERROR("SPACING", 42023705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 4203b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 42043705ce5bSJoe Perches $line_fixed = 1; 42053705ce5bSJoe Perches } 4206d8aaf121SAndy Whitcroft } 4207d8aaf121SAndy Whitcroft 4208d8aaf121SAndy Whitcroft # // is a comment 4209d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 42100a920b5bSAndy Whitcroft 4211b00e4814SJoe Perches # : when part of a bitfield 4212b00e4814SJoe Perches } elsif ($opv eq ':B') { 4213b00e4814SJoe Perches # skip the bitfield test for now 4214b00e4814SJoe Perches 42151f65f947SAndy Whitcroft # No spaces for: 42161f65f947SAndy Whitcroft # -> 4217b00e4814SJoe Perches } elsif ($op eq '->') { 42184a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 42193705ce5bSJoe Perches if (ERROR("SPACING", 42203705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4221b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 42223705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 42233705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 42243705ce5bSJoe Perches } 4225b34c648bSJoe Perches $line_fixed = 1; 42263705ce5bSJoe Perches } 42270a920b5bSAndy Whitcroft } 42280a920b5bSAndy Whitcroft 42292381097bSJoe Perches # , must not have a space before and must have a space on the right. 42300a920b5bSAndy Whitcroft } elsif ($op eq ',') { 42312381097bSJoe Perches my $rtrim_before = 0; 42322381097bSJoe Perches my $space_after = 0; 42332381097bSJoe Perches if ($ctx =~ /Wx./) { 42342381097bSJoe Perches if (ERROR("SPACING", 42352381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 42362381097bSJoe Perches $line_fixed = 1; 42372381097bSJoe Perches $rtrim_before = 1; 42382381097bSJoe Perches } 42392381097bSJoe Perches } 4240cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 42413705ce5bSJoe Perches if (ERROR("SPACING", 42423705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 42433705ce5bSJoe Perches $line_fixed = 1; 4244b34c648bSJoe Perches $last_after = $n; 42452381097bSJoe Perches $space_after = 1; 42462381097bSJoe Perches } 42472381097bSJoe Perches } 42482381097bSJoe Perches if ($rtrim_before || $space_after) { 42492381097bSJoe Perches if ($rtrim_before) { 42502381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 42512381097bSJoe Perches } else { 42522381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 42532381097bSJoe Perches } 42542381097bSJoe Perches if ($space_after) { 42552381097bSJoe Perches $good .= " "; 42563705ce5bSJoe Perches } 42570a920b5bSAndy Whitcroft } 42580a920b5bSAndy Whitcroft 42599c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 426074048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 42619c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 42629c0ca6f9SAndy Whitcroft 42639c0ca6f9SAndy Whitcroft # unary operators should have a space before and 42649c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 42659c0ca6f9SAndy Whitcroft # unary operator, or a cast 42669c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 426774048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 42680d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4269cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 42703705ce5bSJoe Perches if (ERROR("SPACING", 42713705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4272b34c648bSJoe Perches if ($n != $last_after + 2) { 4273b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 42743705ce5bSJoe Perches $line_fixed = 1; 42753705ce5bSJoe Perches } 42760a920b5bSAndy Whitcroft } 4277b34c648bSJoe Perches } 4278a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4279171ae1a4SAndy Whitcroft # A unary '*' may be const 4280171ae1a4SAndy Whitcroft 4281171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 42823705ce5bSJoe Perches if (ERROR("SPACING", 42833705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4284b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 42853705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 42863705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 42873705ce5bSJoe Perches } 4288b34c648bSJoe Perches $line_fixed = 1; 42893705ce5bSJoe Perches } 42900a920b5bSAndy Whitcroft } 42910a920b5bSAndy Whitcroft 42920a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 42930a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4294773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 42953705ce5bSJoe Perches if (ERROR("SPACING", 42963705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4297b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 42983705ce5bSJoe Perches $line_fixed = 1; 42993705ce5bSJoe Perches } 43000a920b5bSAndy Whitcroft } 4301773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4302773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 43033705ce5bSJoe Perches if (ERROR("SPACING", 43043705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4305b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43063705ce5bSJoe Perches $line_fixed = 1; 43073705ce5bSJoe Perches } 4308653d4876SAndy Whitcroft } 4309773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 43103705ce5bSJoe Perches if (ERROR("SPACING", 43113705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4312b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 43133705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 43143705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4315773647a0SAndy Whitcroft } 4316b34c648bSJoe Perches $line_fixed = 1; 43173705ce5bSJoe Perches } 43183705ce5bSJoe Perches } 43190a920b5bSAndy Whitcroft 43200a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 43219c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 43229c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 43239c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4324c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4325c2fdda0dSAndy Whitcroft $op eq '%') 43260a920b5bSAndy Whitcroft { 4327d2e025f3SJoe Perches if ($check) { 4328d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4329d2e025f3SJoe Perches if (CHK("SPACING", 4330d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4331d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4332d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4333d2e025f3SJoe Perches $line_fixed = 1; 4334d2e025f3SJoe Perches } 4335d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4336d2e025f3SJoe Perches if (CHK("SPACING", 4337d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4338d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4339d2e025f3SJoe Perches $line_fixed = 1; 4340d2e025f3SJoe Perches } 4341d2e025f3SJoe Perches } 4342d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 43433705ce5bSJoe Perches if (ERROR("SPACING", 43443705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4345b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4346b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4347b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4348b34c648bSJoe Perches } 43493705ce5bSJoe Perches $line_fixed = 1; 43503705ce5bSJoe Perches } 43510a920b5bSAndy Whitcroft } 43520a920b5bSAndy Whitcroft 43531f65f947SAndy Whitcroft # A colon needs no spaces before when it is 43541f65f947SAndy Whitcroft # terminating a case value or a label. 43551f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 43561f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 43573705ce5bSJoe Perches if (ERROR("SPACING", 43583705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4359b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 43603705ce5bSJoe Perches $line_fixed = 1; 43613705ce5bSJoe Perches } 43621f65f947SAndy Whitcroft } 43631f65f947SAndy Whitcroft 43640a920b5bSAndy Whitcroft # All the others need spaces both sides. 4365cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 43661f65f947SAndy Whitcroft my $ok = 0; 43671f65f947SAndy Whitcroft 436822f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 43691f65f947SAndy Whitcroft if (($op eq '<' && 43701f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 43711f65f947SAndy Whitcroft ($op eq '>' && 43721f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 43731f65f947SAndy Whitcroft { 43741f65f947SAndy Whitcroft $ok = 1; 43751f65f947SAndy Whitcroft } 43761f65f947SAndy Whitcroft 4377e0df7e1fSJoe Perches # for asm volatile statements 4378e0df7e1fSJoe Perches # ignore a colon with another 4379e0df7e1fSJoe Perches # colon immediately before or after 4380e0df7e1fSJoe Perches if (($op eq ':') && 4381e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4382e0df7e1fSJoe Perches $ok = 1; 4383e0df7e1fSJoe Perches } 4384e0df7e1fSJoe Perches 438584731623SJoe Perches # messages are ERROR, but ?: are CHK 43861f65f947SAndy Whitcroft if ($ok == 0) { 43870675a8fbSJean Delvare my $msg_level = \&ERROR; 43880675a8fbSJean Delvare $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 438984731623SJoe Perches 43900675a8fbSJean Delvare if (&{$msg_level}("SPACING", 43913705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4392b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4393b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4394b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4395b34c648bSJoe Perches } 43963705ce5bSJoe Perches $line_fixed = 1; 43973705ce5bSJoe Perches } 43980a920b5bSAndy Whitcroft } 439922f2a2efSAndy Whitcroft } 44004a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 44013705ce5bSJoe Perches 44023705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 44033705ce5bSJoe Perches 44043705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 44050a920b5bSAndy Whitcroft } 44063705ce5bSJoe Perches 44073705ce5bSJoe Perches if (($#elements % 2) == 0) { 44083705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 44093705ce5bSJoe Perches } 44103705ce5bSJoe Perches 4411194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4412194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 44133705ce5bSJoe Perches } 44143705ce5bSJoe Perches 44153705ce5bSJoe Perches 44160a920b5bSAndy Whitcroft } 44170a920b5bSAndy Whitcroft 4418786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4419d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4420786b6326SJoe Perches if (WARN("SPACING", 4421786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4422786b6326SJoe Perches $fix) { 4423194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4424786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4425786b6326SJoe Perches } 4426786b6326SJoe Perches } 4427786b6326SJoe Perches 4428f0a594c1SAndy Whitcroft# check for multiple assignments 4429f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4430000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4431000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4432f0a594c1SAndy Whitcroft } 4433f0a594c1SAndy Whitcroft 443422f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 443522f2a2efSAndy Whitcroft## # continuation. 443622f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 443722f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 443822f2a2efSAndy Whitcroft## 443922f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 444022f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 444122f2a2efSAndy Whitcroft## my $ln = $line; 444222f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 444322f2a2efSAndy Whitcroft## } 444422f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4445000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4446000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 444722f2a2efSAndy Whitcroft## } 444822f2a2efSAndy Whitcroft## } 4449f0a594c1SAndy Whitcroft 44500a920b5bSAndy Whitcroft#need space before brace following if, while, etc 44516b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 44524e5d56bdSEddie Kovsky $line =~ /do\{/) { 44533705ce5bSJoe Perches if (ERROR("SPACING", 44543705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 44553705ce5bSJoe Perches $fix) { 44568d81ae05SCyril Bur $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/; 44573705ce5bSJoe Perches } 4458de7d4f0eSAndy Whitcroft } 4459de7d4f0eSAndy Whitcroft 4460c4a62ef9SJoe Perches## # check for blank lines before declarations 4461c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4462c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4463c4a62ef9SJoe Perches## WARN("SPACING", 4464c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4465c4a62ef9SJoe Perches## } 4466c4a62ef9SJoe Perches## 4467c4a62ef9SJoe Perches 4468de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4469de7d4f0eSAndy Whitcroft# on the line 4470de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4471d5e616fcSJoe Perches if (ERROR("SPACING", 4472d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4473d5e616fcSJoe Perches $fix) { 4474194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4475d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4476d5e616fcSJoe Perches } 44770a920b5bSAndy Whitcroft } 44780a920b5bSAndy Whitcroft 447922f2a2efSAndy Whitcroft# check spacing on square brackets 448022f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 44813705ce5bSJoe Perches if (ERROR("SPACING", 44823705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 44833705ce5bSJoe Perches $fix) { 4484194f66fcSJoe Perches $fixed[$fixlinenr] =~ 44853705ce5bSJoe Perches s/\[\s+/\[/; 44863705ce5bSJoe Perches } 448722f2a2efSAndy Whitcroft } 448822f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 44893705ce5bSJoe Perches if (ERROR("SPACING", 44903705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 44913705ce5bSJoe Perches $fix) { 4492194f66fcSJoe Perches $fixed[$fixlinenr] =~ 44933705ce5bSJoe Perches s/\s+\]/\]/; 44943705ce5bSJoe Perches } 449522f2a2efSAndy Whitcroft } 449622f2a2efSAndy Whitcroft 4497c45dcabdSAndy Whitcroft# check spacing on parentheses 44989c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 44999c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 45003705ce5bSJoe Perches if (ERROR("SPACING", 45013705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 45023705ce5bSJoe Perches $fix) { 4503194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45043705ce5bSJoe Perches s/\(\s+/\(/; 45053705ce5bSJoe Perches } 450622f2a2efSAndy Whitcroft } 450713214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4508c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4509c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 45103705ce5bSJoe Perches if (ERROR("SPACING", 45113705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 45123705ce5bSJoe Perches $fix) { 4513194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45143705ce5bSJoe Perches s/\s+\)/\)/; 45153705ce5bSJoe Perches } 451622f2a2efSAndy Whitcroft } 451722f2a2efSAndy Whitcroft 4518e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4519e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4520e2826fd0SJoe Perches 4521e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4522ea4acbb1SJoe Perches my $var = $1; 4523ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4524ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4525ea4acbb1SJoe Perches $fix) { 4526ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4527ea4acbb1SJoe Perches } 4528ea4acbb1SJoe Perches } 4529ea4acbb1SJoe Perches 4530ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4531ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4532ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4533ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4534ea4acbb1SJoe Perches my $var = $2; 4535ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4536ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4537ea4acbb1SJoe Perches $fix) { 4538ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4539ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4540ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4541ea4acbb1SJoe Perches } 4542e2826fd0SJoe Perches } 4543e2826fd0SJoe Perches 454463b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses 4545a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict 4546a032aa4cSJoe Perches if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 4547a032aa4cSJoe Perches $^V && $^V ge 5.10.0 && defined($stat) && 454863b7c73eSJoe Perches $stat =~ /(^.\s*if\s*($balanced_parens))/) { 454963b7c73eSJoe Perches my $if_stat = $1; 455063b7c73eSJoe Perches my $test = substr($2, 1, -1); 455163b7c73eSJoe Perches my $herectx; 455263b7c73eSJoe Perches while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 455363b7c73eSJoe Perches my $match = $1; 455463b7c73eSJoe Perches # avoid parentheses around potential macro args 455563b7c73eSJoe Perches next if ($match =~ /^\s*\w+\s*$/); 455663b7c73eSJoe Perches if (!defined($herectx)) { 455763b7c73eSJoe Perches $herectx = $here . "\n"; 455863b7c73eSJoe Perches my $cnt = statement_rawlines($if_stat); 455963b7c73eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 456063b7c73eSJoe Perches my $rl = raw_line($linenr, $n); 456163b7c73eSJoe Perches $herectx .= $rl . "\n"; 456263b7c73eSJoe Perches last if $rl =~ /^[ \+].*\{/; 456363b7c73eSJoe Perches } 456463b7c73eSJoe Perches } 456563b7c73eSJoe Perches CHK("UNNECESSARY_PARENTHESES", 456663b7c73eSJoe Perches "Unnecessary parentheses around '$match'\n" . $herectx); 456763b7c73eSJoe Perches } 456863b7c73eSJoe Perches } 456963b7c73eSJoe Perches 45700a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 45714a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 45720a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 45733705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 45743705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 45753705ce5bSJoe Perches $fix) { 4576194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45773705ce5bSJoe Perches s/^(.)\s+/$1/; 45783705ce5bSJoe Perches } 45790a920b5bSAndy Whitcroft } 45800a920b5bSAndy Whitcroft 45815b9553abSJoe Perches# return is not a function 4582507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4583c45dcabdSAndy Whitcroft my $spacing = $1; 4584507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 45855b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 45865b9553abSJoe Perches my $value = $1; 45875b9553abSJoe Perches $value = deparenthesize($value); 45885b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4589000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4590000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 45915b9553abSJoe Perches } 4592c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4593000d1cc1SJoe Perches ERROR("SPACING", 4594000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4595c45dcabdSAndy Whitcroft } 4596c45dcabdSAndy Whitcroft } 4597507e5141SJoe Perches 4598b43ae21bSJoe Perches# unnecessary return in a void function 4599b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4600b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4601b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4602b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4603b43ae21bSJoe Perches $linenr >= 3 && 4604b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4605b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 46069819cf25SJoe Perches WARN("RETURN_VOID", 4607b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 46089819cf25SJoe Perches } 46099819cf25SJoe Perches 4610189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4611189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4612189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4613189248d8SJoe Perches my $openparens = $1; 4614189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4615189248d8SJoe Perches my $msg = ""; 4616189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4617189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4618189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4619189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4620189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4621189248d8SJoe Perches } 4622189248d8SJoe Perches } 4623189248d8SJoe Perches 4624c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4625c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4626c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4627c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 4628c5595fa2SJoe Perches if ($^V && $^V ge 5.10.0 && 4629c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4630c5595fa2SJoe Perches my $lead = $1; 4631c5595fa2SJoe Perches my $const = $2; 4632c5595fa2SJoe Perches my $comp = $3; 4633c5595fa2SJoe Perches my $to = $4; 4634c5595fa2SJoe Perches my $newcomp = $comp; 4635f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 4636c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4637c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4638c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4639c5595fa2SJoe Perches $fix) { 4640c5595fa2SJoe Perches if ($comp eq "<") { 4641c5595fa2SJoe Perches $newcomp = ">"; 4642c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4643c5595fa2SJoe Perches $newcomp = ">="; 4644c5595fa2SJoe Perches } elsif ($comp eq ">") { 4645c5595fa2SJoe Perches $newcomp = "<"; 4646c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4647c5595fa2SJoe Perches $newcomp = "<="; 4648c5595fa2SJoe Perches } 4649c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4650c5595fa2SJoe Perches } 4651c5595fa2SJoe Perches } 4652c5595fa2SJoe Perches 4653f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4654f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 465553a3c448SAndy Whitcroft my $name = $1; 465653a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4657000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4658f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 465953a3c448SAndy Whitcroft } 466053a3c448SAndy Whitcroft } 4661c45dcabdSAndy Whitcroft 46620a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 46634a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 46643705ce5bSJoe Perches if (ERROR("SPACING", 46653705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 46663705ce5bSJoe Perches $fix) { 4667194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46683705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 46693705ce5bSJoe Perches } 46700a920b5bSAndy Whitcroft } 46710a920b5bSAndy Whitcroft 4672f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4673f5fe35ddSAndy Whitcroft# statements after the conditional. 4674170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 46753e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 46763e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 46773e469cdcSAndy Whitcroft if (!defined $stat); 4678170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4679170d3a22SAndy Whitcroft $remain_next, $off_next); 4680170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4681170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4682170d3a22SAndy Whitcroft 4683170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4684170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4685170d3a22SAndy Whitcroft # then count those as offsets. 4686170d3a22SAndy Whitcroft my ($whitespace) = 4687170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4688170d3a22SAndy Whitcroft my $offset = 4689170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4690170d3a22SAndy Whitcroft 4691170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4692170d3a22SAndy Whitcroft $offset} = 1; 4693170d3a22SAndy Whitcroft } 4694170d3a22SAndy Whitcroft } 4695170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4696c11230f4SJoe Perches defined($stat) && defined($cond) && 4697170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4698171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 46998905a67cSAndy Whitcroft 4700b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4701000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4702000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 47038905a67cSAndy Whitcroft } 47048905a67cSAndy Whitcroft 47058905a67cSAndy Whitcroft # Find out what is on the end of the line after the 47068905a67cSAndy Whitcroft # conditional. 4707773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 47088905a67cSAndy Whitcroft $s =~ s/\n.*//g; 470913214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 471053210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 471153210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4712773647a0SAndy Whitcroft { 4713bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4714bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4715bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 471642bdf74cSHidetoshi Seto my $stat_real = ''; 4717bb44ad39SAndy Whitcroft 471842bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 471942bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4720bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4721bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4722bb44ad39SAndy Whitcroft } 4723bb44ad39SAndy Whitcroft 4724000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4725000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 47268905a67cSAndy Whitcroft } 47278905a67cSAndy Whitcroft } 47288905a67cSAndy Whitcroft 472913214adfSAndy Whitcroft# Check for bitwise tests written as boolean 473013214adfSAndy Whitcroft if ($line =~ / 473113214adfSAndy Whitcroft (?: 473213214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 473313214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 473413214adfSAndy Whitcroft (?:\&\&|\|\|) 473513214adfSAndy Whitcroft | 473613214adfSAndy Whitcroft (?:\&\&|\|\|) 473713214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 473813214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 473913214adfSAndy Whitcroft )/x) 474013214adfSAndy Whitcroft { 4741000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4742000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 474313214adfSAndy Whitcroft } 474413214adfSAndy Whitcroft 47458905a67cSAndy Whitcroft# if and else should not have general statements after it 474613214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 474713214adfSAndy Whitcroft my $s = $1; 474813214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 474913214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4750000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4751000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 47520a920b5bSAndy Whitcroft } 475313214adfSAndy Whitcroft } 475439667782SAndy Whitcroft# if should not continue a brace 475539667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4756000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4757048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 475839667782SAndy Whitcroft $herecurr); 475939667782SAndy Whitcroft } 4760a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4761a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4762a1080bf8SAndy Whitcroft $line !~ /\G(?: 47633fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4764a1080bf8SAndy Whitcroft \s*return\s+ 4765a1080bf8SAndy Whitcroft )/xg) 4766a1080bf8SAndy Whitcroft { 4767000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4768000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4769a1080bf8SAndy Whitcroft } 47700a920b5bSAndy Whitcroft 47710a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 47720a920b5bSAndy Whitcroft # indent level to be relevant to each other. 47738b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 47740a920b5bSAndy Whitcroft $previndent == $indent) { 47758b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 47768b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 47778b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 47788b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 47798b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 47808b8856f4SJoe Perches my $fixedline = $prevrawline; 47818b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 47828b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 47838b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 47848b8856f4SJoe Perches } 47858b8856f4SJoe Perches $fixedline = $rawline; 47868b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 47878b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 47888b8856f4SJoe Perches } 47890a920b5bSAndy Whitcroft } 47900a920b5bSAndy Whitcroft 47918b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4792c2fdda0dSAndy Whitcroft $previndent == $indent) { 4793c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4794c2fdda0dSAndy Whitcroft 4795c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4796c2fdda0dSAndy Whitcroft # conditional. 4797773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4798c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4799c2fdda0dSAndy Whitcroft 4800c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 48018b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 48028b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 48038b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 48048b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48058b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 48068b8856f4SJoe Perches my $fixedline = $prevrawline; 48078b8856f4SJoe Perches my $trailing = $rawline; 48088b8856f4SJoe Perches $trailing =~ s/^\+//; 48098b8856f4SJoe Perches $trailing = trim($trailing); 48108b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 48118b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48128b8856f4SJoe Perches } 4813c2fdda0dSAndy Whitcroft } 4814c2fdda0dSAndy Whitcroft } 4815c2fdda0dSAndy Whitcroft 481695e2c602SJoe Perches#Specific variable tests 4817323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4818323c1260SJoe Perches my $var = $1; 481995e2c602SJoe Perches 482095e2c602SJoe Perches#gcc binary extension 482195e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4822d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4823d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4824d5e616fcSJoe Perches $fix) { 4825d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4826194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4827d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4828d5e616fcSJoe Perches } 482995e2c602SJoe Perches } 483095e2c602SJoe Perches 483195e2c602SJoe Perches#CamelCase 4832807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4833be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 483422735ce8SJoe Perches#Ignore Page<foo> variants 4835807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 483622735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4837f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4838f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4839f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 48407e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 48417e781f67SJoe Perches my $word = $1; 48427e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4843d8b07710SJoe Perches if ($check) { 4844d8b07710SJoe Perches seed_camelcase_includes(); 4845d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4846d8b07710SJoe Perches seed_camelcase_file($realfile); 4847d8b07710SJoe Perches $camelcase_file_seeded = 1; 4848d8b07710SJoe Perches } 4849d8b07710SJoe Perches } 48507e781f67SJoe Perches if (!defined $camelcase{$word}) { 48517e781f67SJoe Perches $camelcase{$word} = 1; 4852be79794bSJoe Perches CHK("CAMELCASE", 48537e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 48547e781f67SJoe Perches } 4855323c1260SJoe Perches } 4856323c1260SJoe Perches } 48573445686aSJoe Perches } 48580a920b5bSAndy Whitcroft 48590a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4860d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4861d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4862d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4863d5e616fcSJoe Perches $fix) { 4864194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4865d5e616fcSJoe Perches } 48660a920b5bSAndy Whitcroft } 48670a920b5bSAndy Whitcroft 48680e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 48690e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4870c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4871e09dec48SAndy Whitcroft my $file = "$1.h"; 4872e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4873e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4874e09dec48SAndy Whitcroft $realfile ne $checkfile && 48757840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4876c45dcabdSAndy Whitcroft { 48770e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 48780e212e0aSFabian Frederick if ($asminclude > 0) { 4879e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4880000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4881000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4882e09dec48SAndy Whitcroft } else { 4883000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4884000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4885e09dec48SAndy Whitcroft } 48860a920b5bSAndy Whitcroft } 48870a920b5bSAndy Whitcroft } 48880e212e0aSFabian Frederick } 48890a920b5bSAndy Whitcroft 4890653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4891653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4892cf655043SAndy Whitcroft# in a known good container 4893b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4894b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4895d8aaf121SAndy Whitcroft my $ln = $linenr; 4896d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4897c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4898c45dcabdSAndy Whitcroft my $ctx = ''; 489908a2843eSJoe Perches my $has_flow_statement = 0; 490008a2843eSJoe Perches my $has_arg_concat = 0; 4901c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4902f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4903f74bd194SAndy Whitcroft $ctx = $dstat; 4904c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4905a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4906c45dcabdSAndy Whitcroft 490708a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 490862e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 490908a2843eSJoe Perches 4910f59b64bfSJoe Perches $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 4911f59b64bfSJoe Perches my $define_args = $1; 4912f59b64bfSJoe Perches my $define_stmt = $dstat; 4913f59b64bfSJoe Perches my @def_args = (); 4914f59b64bfSJoe Perches 4915f59b64bfSJoe Perches if (defined $define_args && $define_args ne "") { 4916f59b64bfSJoe Perches $define_args = substr($define_args, 1, length($define_args) - 2); 4917f59b64bfSJoe Perches $define_args =~ s/\s*//g; 4918f59b64bfSJoe Perches @def_args = split(",", $define_args); 4919f59b64bfSJoe Perches } 4920f59b64bfSJoe Perches 4921292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4922c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4923c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4924c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4925c45dcabdSAndy Whitcroft 4926c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4927bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4928bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 49296b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 4930bf30d6edSAndy Whitcroft { 4931c45dcabdSAndy Whitcroft } 4932c45dcabdSAndy Whitcroft 4933e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 493433acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 493533acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 4936e45bab8eSAndy Whitcroft { 4937e45bab8eSAndy Whitcroft } 4938e45bab8eSAndy Whitcroft 493942e15293SJoe Perches # Make asm volatile uses seem like a generic function 494042e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 494142e15293SJoe Perches 4942c45dcabdSAndy Whitcroft my $exceptions = qr{ 4943c45dcabdSAndy Whitcroft $Declare| 4944c45dcabdSAndy Whitcroft module_param_named| 4945a0a0a7a9SKees Cook MODULE_PARM_DESC| 4946c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4947c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4948383099fdSAndy Whitcroft __typeof__\(| 494922fd2d3eSStefani Seibold union| 495022fd2d3eSStefani Seibold struct| 4951ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 49526b10df42SVladimir Zapolskiy ^\"|\"$| 49536b10df42SVladimir Zapolskiy ^\[ 4954c45dcabdSAndy Whitcroft }x; 49555eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4956f59b64bfSJoe Perches 4957f59b64bfSJoe Perches $ctx =~ s/\n*$//; 4958f59b64bfSJoe Perches my $herectx = $here . "\n"; 4959f59b64bfSJoe Perches my $stmt_cnt = statement_rawlines($ctx); 4960f59b64bfSJoe Perches 4961f59b64bfSJoe Perches for (my $n = 0; $n < $stmt_cnt; $n++) { 4962f59b64bfSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4963f59b64bfSJoe Perches } 4964f59b64bfSJoe Perches 4965f74bd194SAndy Whitcroft if ($dstat ne '' && 4966f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4967f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 49683cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4969356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4970f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4971f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4972e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 497372f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4974f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4975f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4976f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 49774e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 4978f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4979c45dcabdSAndy Whitcroft { 4980e795556aSJoe Perches if ($dstat =~ /^\s*if\b/) { 4981e795556aSJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4982e795556aSJoe Perches "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 4983e795556aSJoe Perches } elsif ($dstat =~ /;/) { 4984f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4985f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4986f74bd194SAndy Whitcroft } else { 4987000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 4988388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 4989d8aaf121SAndy Whitcroft } 4990f59b64bfSJoe Perches 4991f59b64bfSJoe Perches } 49925207649bSJoe Perches 49935207649bSJoe Perches # Make $define_stmt single line, comment-free, etc 49945207649bSJoe Perches my @stmt_array = split('\n', $define_stmt); 49955207649bSJoe Perches my $first = 1; 49965207649bSJoe Perches $define_stmt = ""; 49975207649bSJoe Perches foreach my $l (@stmt_array) { 49985207649bSJoe Perches $l =~ s/\\$//; 49995207649bSJoe Perches if ($first) { 50005207649bSJoe Perches $define_stmt = $l; 50015207649bSJoe Perches $first = 0; 50025207649bSJoe Perches } elsif ($l =~ /^[\+ ]/) { 50035207649bSJoe Perches $define_stmt .= substr($l, 1); 50045207649bSJoe Perches } 50055207649bSJoe Perches } 50065207649bSJoe Perches $define_stmt =~ s/$;//g; 50075207649bSJoe Perches $define_stmt =~ s/\s+/ /g; 50085207649bSJoe Perches $define_stmt = trim($define_stmt); 50095207649bSJoe Perches 5010f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type') 5011f59b64bfSJoe Perches foreach my $arg (@def_args) { 5012f59b64bfSJoe Perches next if ($arg =~ /\.\.\./); 50139192d41aSJoe Perches next if ($arg =~ /^type$/i); 50147fe528a2SJoe Perches my $tmp_stmt = $define_stmt; 50157fe528a2SJoe Perches $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 50167fe528a2SJoe Perches $tmp_stmt =~ s/\#+\s*$arg\b//g; 50177fe528a2SJoe Perches $tmp_stmt =~ s/\b$arg\s*\#\#//g; 50187fe528a2SJoe Perches my $use_cnt = $tmp_stmt =~ s/\b$arg\b//g; 5019f59b64bfSJoe Perches if ($use_cnt > 1) { 5020f59b64bfSJoe Perches CHK("MACRO_ARG_REUSE", 5021f59b64bfSJoe Perches "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5022f59b64bfSJoe Perches } 50239192d41aSJoe Perches# check if any macro arguments may have other precedence issues 50247fe528a2SJoe Perches if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 50259192d41aSJoe Perches ((defined($1) && $1 ne ',') || 50269192d41aSJoe Perches (defined($2) && $2 ne ','))) { 50279192d41aSJoe Perches CHK("MACRO_ARG_PRECEDENCE", 50289192d41aSJoe Perches "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 50299192d41aSJoe Perches } 50300a920b5bSAndy Whitcroft } 50315023d347SJoe Perches 503208a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 503308a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 503408a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 503508a2843eSJoe Perches my $herectx = $here . "\n"; 503608a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 503708a2843eSJoe Perches 503808a2843eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 503908a2843eSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 504008a2843eSJoe Perches } 504108a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 504208a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 504308a2843eSJoe Perches } 504408a2843eSJoe Perches 5045481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 50465023d347SJoe Perches 50475023d347SJoe Perches } else { 50485023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 5049481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5050481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 50515023d347SJoe Perches $line =~ /^\+.*\\$/) { 50525023d347SJoe Perches WARN("LINE_CONTINUATIONS", 50535023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 50545023d347SJoe Perches } 5055653d4876SAndy Whitcroft } 50560a920b5bSAndy Whitcroft 5057b13edf7fSJoe Perches# do {} while (0) macro tests: 5058b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 5059b13edf7fSJoe Perches# macro should not end with a semicolon 5060b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 5061b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 5062b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5063b13edf7fSJoe Perches my $ln = $linenr; 5064b13edf7fSJoe Perches my $cnt = $realcnt; 5065b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 5066b13edf7fSJoe Perches my $ctx = ''; 5067b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 5068b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 5069b13edf7fSJoe Perches $ctx = $dstat; 5070b13edf7fSJoe Perches 5071b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 50721b36b201SJoe Perches $dstat =~ s/$;/ /g; 5073b13edf7fSJoe Perches 5074b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5075b13edf7fSJoe Perches my $stmts = $2; 5076b13edf7fSJoe Perches my $semis = $3; 5077b13edf7fSJoe Perches 5078b13edf7fSJoe Perches $ctx =~ s/\n*$//; 5079b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 5080b13edf7fSJoe Perches my $herectx = $here . "\n"; 5081b13edf7fSJoe Perches 5082b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5083b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5084b13edf7fSJoe Perches } 5085b13edf7fSJoe Perches 5086ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 5087ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 5088b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5089b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5090b13edf7fSJoe Perches } 5091b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 5092b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5093b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5094b13edf7fSJoe Perches } 5095f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5096f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 5097f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 5098f5ef95b1SJoe Perches my $herectx = $here . "\n"; 5099f5ef95b1SJoe Perches 5100f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5101f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5102f5ef95b1SJoe Perches } 5103f5ef95b1SJoe Perches 5104f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 5105f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 5106b13edf7fSJoe Perches } 5107b13edf7fSJoe Perches } 5108b13edf7fSJoe Perches 5109080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 5110080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 5111080ba929SMike Frysinger# . 5112080ba929SMike Frysinger# ALIGN(...) 5113080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 5114080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 5115000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 5116000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 5117080ba929SMike Frysinger } 5118080ba929SMike Frysinger 5119f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 512013214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 512113214adfSAndy Whitcroft my ($level, $endln, @chunks) = 5122cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 512313214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5124cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5125cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 5126aad4f614SJoe Perches my @allowed = (); 5127aad4f614SJoe Perches my $allow = 0; 512813214adfSAndy Whitcroft my $seen = 0; 5129773647a0SAndy Whitcroft my $herectx = $here . "\n"; 5130cf655043SAndy Whitcroft my $ln = $linenr - 1; 513113214adfSAndy Whitcroft for my $chunk (@chunks) { 513213214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 513313214adfSAndy Whitcroft 5134773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 5135773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5136773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 5137773647a0SAndy Whitcroft 5138aad4f614SJoe Perches $allowed[$allow] = 0; 5139773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5140773647a0SAndy Whitcroft 5141773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 5142773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 5143773647a0SAndy Whitcroft 5144773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5145cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 5146cf655043SAndy Whitcroft 5147773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 514813214adfSAndy Whitcroft 514913214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 515013214adfSAndy Whitcroft 5151aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5152cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5153cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5154aad4f614SJoe Perches $allowed[$allow] = 1; 515513214adfSAndy Whitcroft } 515613214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5157cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5158aad4f614SJoe Perches $allowed[$allow] = 1; 515913214adfSAndy Whitcroft } 5160cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5161cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5162aad4f614SJoe Perches $allowed[$allow] = 1; 516313214adfSAndy Whitcroft } 5164aad4f614SJoe Perches $allow++; 516513214adfSAndy Whitcroft } 5166aad4f614SJoe Perches if ($seen) { 5167aad4f614SJoe Perches my $sum_allowed = 0; 5168aad4f614SJoe Perches foreach (@allowed) { 5169aad4f614SJoe Perches $sum_allowed += $_; 5170aad4f614SJoe Perches } 5171aad4f614SJoe Perches if ($sum_allowed == 0) { 5172000d1cc1SJoe Perches WARN("BRACES", 5173000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 5174aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 5175aad4f614SJoe Perches $seen != $allow) { 5176aad4f614SJoe Perches CHK("BRACES", 5177aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 5178aad4f614SJoe Perches } 517913214adfSAndy Whitcroft } 518013214adfSAndy Whitcroft } 518113214adfSAndy Whitcroft } 5182773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 518313214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 5184cf655043SAndy Whitcroft my $allowed = 0; 5185f0a594c1SAndy Whitcroft 5186cf655043SAndy Whitcroft # Check the pre-context. 5187cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 5188cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 5189cf655043SAndy Whitcroft $allowed = 1; 5190f0a594c1SAndy Whitcroft } 5191773647a0SAndy Whitcroft 5192773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 5193773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 5194773647a0SAndy Whitcroft 5195cf655043SAndy Whitcroft # Check the condition. 5196cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 5197773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 5198cf655043SAndy Whitcroft if (defined $cond) { 5199773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5200cf655043SAndy Whitcroft } 5201cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 5202cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 5203cf655043SAndy Whitcroft $allowed = 1; 5204cf655043SAndy Whitcroft } 5205cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 5206cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 5207cf655043SAndy Whitcroft $allowed = 1; 5208cf655043SAndy Whitcroft } 5209cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 5210cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 5211cf655043SAndy Whitcroft $allowed = 1; 5212cf655043SAndy Whitcroft } 5213cf655043SAndy Whitcroft # Check the post-context. 5214cf655043SAndy Whitcroft if (defined $chunks[1]) { 5215cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 5216cf655043SAndy Whitcroft if (defined $cond) { 5217773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5218cf655043SAndy Whitcroft } 5219cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 5220cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5221cf655043SAndy Whitcroft $allowed = 1; 5222cf655043SAndy Whitcroft } 5223cf655043SAndy Whitcroft } 5224cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 522569932487SJustin P. Mattock my $herectx = $here . "\n"; 5226f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 5227cf655043SAndy Whitcroft 5228f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 522969932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 5230cf655043SAndy Whitcroft } 5231cf655043SAndy Whitcroft 5232000d1cc1SJoe Perches WARN("BRACES", 5233000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 5234f0a594c1SAndy Whitcroft } 5235f0a594c1SAndy Whitcroft } 5236f0a594c1SAndy Whitcroft 5237e4c5babdSJoe Perches# check for single line unbalanced braces 523895330473SSven Eckelmann if ($sline =~ /^.\s*\}\s*else\s*$/ || 523995330473SSven Eckelmann $sline =~ /^.\s*else\s*\{\s*$/) { 5240e4c5babdSJoe Perches CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 5241e4c5babdSJoe Perches } 5242e4c5babdSJoe Perches 52430979ae66SJoe Perches# check for unnecessary blank lines around braces 524477b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5245f8e58219SJoe Perches if (CHK("BRACES", 5246f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5247f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 5248f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5249f8e58219SJoe Perches } 52500979ae66SJoe Perches } 525177b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5252f8e58219SJoe Perches if (CHK("BRACES", 5253f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5254f8e58219SJoe Perches $fix) { 5255f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 5256f8e58219SJoe Perches } 52570979ae66SJoe Perches } 52580979ae66SJoe Perches 52594a0df2efSAndy Whitcroft# no volatiles please 52606c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 52616c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5262000d1cc1SJoe Perches WARN("VOLATILE", 52638c27ceffSMauro Carvalho Chehab "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 52644a0df2efSAndy Whitcroft } 52654a0df2efSAndy Whitcroft 52665e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 52675e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 52685e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 52695e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 527033acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 52715e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 52725e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 52735e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 52745e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 52755e4f6ba5SJoe Perches $fix && 52765e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 52775e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 52785e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 52795e4f6ba5SJoe Perches my $comma_close = ""; 52805e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 52815e4f6ba5SJoe Perches $comma_close = $1; 52825e4f6ba5SJoe Perches } 52835e4f6ba5SJoe Perches 52845e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 52855e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 52865e4f6ba5SJoe Perches my $fixedline = $prevrawline; 52875e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 52885e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 52895e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 52905e4f6ba5SJoe Perches $fixedline = $rawline; 52915e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 52925e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 52935e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 52945e4f6ba5SJoe Perches } 52955e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 52965e4f6ba5SJoe Perches } 52975e4f6ba5SJoe Perches } 52985e4f6ba5SJoe Perches 52995e4f6ba5SJoe Perches# check for missing a space in a string concatenation 53005e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 53015e4f6ba5SJoe Perches WARN('MISSING_SPACE', 53025e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 53035e4f6ba5SJoe Perches } 53045e4f6ba5SJoe Perches 530577cb8546SJoe Perches# check for an embedded function name in a string when the function is known 5306e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch 5307e4b7d309SJoe Perches# context providing the function name or a single line form for in-file 5308e4b7d309SJoe Perches# function declarations 530977cb8546SJoe Perches if ($line =~ /^\+.*$String/ && 531077cb8546SJoe Perches defined($context_function) && 5311e4b7d309SJoe Perches get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 5312e4b7d309SJoe Perches length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 531377cb8546SJoe Perches WARN("EMBEDDED_FUNCTION_NAME", 5314e4b7d309SJoe Perches "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 531577cb8546SJoe Perches } 531677cb8546SJoe Perches 53175e4f6ba5SJoe Perches# check for spaces before a quoted newline 53185e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 53195e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 53205e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 53215e4f6ba5SJoe Perches $fix) { 53225e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 53235e4f6ba5SJoe Perches } 53245e4f6ba5SJoe Perches 53255e4f6ba5SJoe Perches } 53265e4f6ba5SJoe Perches 5327f17dba4fSJoe Perches# concatenated string without spaces between elements 532833acb54aSJoe Perches if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) { 5329f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 5330f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 5331f17dba4fSJoe Perches } 5332f17dba4fSJoe Perches 533390ad30e5SJoe Perches# uncoalesced string fragments 533433acb54aSJoe Perches if ($line =~ /$String\s*"/) { 533590ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 533690ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 533790ad30e5SJoe Perches } 533890ad30e5SJoe Perches 5339522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats 5340522b837cSAlexey Dobriyan my $show_L = 1; #don't show the same defect twice 5341522b837cSAlexey Dobriyan my $show_Z = 1; 53425e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 5343522b837cSAlexey Dobriyan my $string = substr($rawline, $-[1], $+[1] - $-[1]); 53445e4f6ba5SJoe Perches $string =~ s/%%/__/g; 5345522b837cSAlexey Dobriyan # check for %L 5346522b837cSAlexey Dobriyan if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 53475e4f6ba5SJoe Perches WARN("PRINTF_L", 5348522b837cSAlexey Dobriyan "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 5349522b837cSAlexey Dobriyan $show_L = 0; 53505e4f6ba5SJoe Perches } 5351522b837cSAlexey Dobriyan # check for %Z 5352522b837cSAlexey Dobriyan if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 5353522b837cSAlexey Dobriyan WARN("PRINTF_Z", 5354522b837cSAlexey Dobriyan "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 5355522b837cSAlexey Dobriyan $show_Z = 0; 5356522b837cSAlexey Dobriyan } 5357522b837cSAlexey Dobriyan # check for 0x<decimal> 5358522b837cSAlexey Dobriyan if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 5359522b837cSAlexey Dobriyan ERROR("PRINTF_0XDECIMAL", 53606e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 53616e300757SJoe Perches } 53625e4f6ba5SJoe Perches } 53635e4f6ba5SJoe Perches 53645e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 53653f7f335dSJoe Perches if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 53665e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 53675e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 53685e4f6ba5SJoe Perches } 53695e4f6ba5SJoe Perches 537000df344fSAndy Whitcroft# warn about #if 0 5371c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 5372000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 5373000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 5374de7d4f0eSAndy Whitcroft $herecurr); 53754a0df2efSAndy Whitcroft } 53764a0df2efSAndy Whitcroft 537703df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 537803df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5379100425deSJoe Perches my $tested = quotemeta($1); 5380100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5381100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5382100425deSJoe Perches my $func = $1; 5383100425deSJoe Perches if (WARN('NEEDLESS_IF', 5384100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5385100425deSJoe Perches $fix) { 5386100425deSJoe Perches my $do_fix = 1; 5387100425deSJoe Perches my $leading_tabs = ""; 5388100425deSJoe Perches my $new_leading_tabs = ""; 5389100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5390100425deSJoe Perches $leading_tabs = $1; 5391100425deSJoe Perches } else { 5392100425deSJoe Perches $do_fix = 0; 5393100425deSJoe Perches } 5394100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5395100425deSJoe Perches $new_leading_tabs = $1; 5396100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5397100425deSJoe Perches $do_fix = 0; 5398100425deSJoe Perches } 5399100425deSJoe Perches } else { 5400100425deSJoe Perches $do_fix = 0; 5401100425deSJoe Perches } 5402100425deSJoe Perches if ($do_fix) { 5403100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5404100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5405100425deSJoe Perches } 5406100425deSJoe Perches } 54074c432a8fSGreg Kroah-Hartman } 54084c432a8fSGreg Kroah-Hartman } 5409f0a594c1SAndy Whitcroft 5410ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5411ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5412ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5413ebfdc409SJoe Perches (defined $1 || defined $3) && 5414ebfdc409SJoe Perches $linenr > 3) { 5415ebfdc409SJoe Perches my $testval = $2; 5416ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5417ebfdc409SJoe Perches 5418ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5419ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5420ebfdc409SJoe Perches 5421fb0d0e08SJoe 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)/) { 5422ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5423ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5424ebfdc409SJoe Perches } 5425ebfdc409SJoe Perches } 5426ebfdc409SJoe Perches 5427f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5428dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5429f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5430f78d98f6SJoe Perches my $level = $1; 5431f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5432f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5433f78d98f6SJoe Perches $fix) { 5434f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5435f78d98f6SJoe Perches } 5436f78d98f6SJoe Perches } 5437f78d98f6SJoe Perches 543845c55e92SJoe Perches# check for logging continuations 543945c55e92SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 544045c55e92SJoe Perches WARN("LOGGING_CONTINUATION", 544145c55e92SJoe Perches "Avoid logging continuation uses where feasible\n" . $herecurr); 544245c55e92SJoe Perches } 544345c55e92SJoe Perches 5444abb08a53SJoe Perches# check for mask then right shift without a parentheses 5445abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 5446abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5447abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5448abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5449abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5450abb08a53SJoe Perches } 5451abb08a53SJoe Perches 5452b75ac618SJoe Perches# check for pointer comparisons to NULL 5453b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 5454b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5455b75ac618SJoe Perches my $val = $1; 5456b75ac618SJoe Perches my $equal = "!"; 5457b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5458b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5459b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5460b75ac618SJoe Perches $fix) { 5461b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5462b75ac618SJoe Perches } 5463b75ac618SJoe Perches } 5464b75ac618SJoe Perches } 5465b75ac618SJoe Perches 54668716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 54678716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 54688716de38SJoe Perches my $attr = $1; 54698716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 54708716de38SJoe Perches my $ptr = $1; 54718716de38SJoe Perches my $var = $2; 54728716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 54738716de38SJoe Perches ERROR("MISPLACED_INIT", 54748716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 54758716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 54768716de38SJoe Perches WARN("MISPLACED_INIT", 54778716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 54788716de38SJoe Perches $fix) { 5479194f66fcSJoe 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; 54808716de38SJoe Perches } 54818716de38SJoe Perches } 54828716de38SJoe Perches } 54838716de38SJoe Perches 5484e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5485e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5486e970b884SJoe Perches my $attr = $1; 5487e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5488e970b884SJoe Perches my $attr_prefix = $1; 5489e970b884SJoe Perches my $attr_type = $2; 5490e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5491e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5492e970b884SJoe Perches $fix) { 5493194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5494e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5495e970b884SJoe Perches } 5496e970b884SJoe Perches } 5497e970b884SJoe Perches 5498e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5499e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5500e970b884SJoe Perches my $attr = $1; 5501e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5502e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5503e970b884SJoe Perches $fix) { 5504194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5505e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5506e970b884SJoe Perches $lead = rtrim($1); 5507e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5508e970b884SJoe Perches $lead = "${lead}const "; 5509194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5510e970b884SJoe Perches } 5511e970b884SJoe Perches } 5512e970b884SJoe Perches 5513c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5514c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5515c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5516c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5517c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5518c17893c7SJoe Perches $fix) { 5519c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5520c17893c7SJoe Perches } 5521c17893c7SJoe Perches } 5522c17893c7SJoe Perches 5523fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5524fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5525fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5526fbdb8138SJoe Perches my $constant_func = $1; 5527fbdb8138SJoe Perches my $func = $constant_func; 5528fbdb8138SJoe Perches $func =~ s/^__constant_//; 5529fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5530fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5531fbdb8138SJoe Perches $fix) { 5532194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5533fbdb8138SJoe Perches } 5534fbdb8138SJoe Perches } 5535fbdb8138SJoe Perches 55361a15a250SPatrick Pannuto# prefer usleep_range over udelay 553737581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 553843c1d77cSJoe Perches my $delay = $1; 55391a15a250SPatrick Pannuto # ignore udelay's < 10, however 554043c1d77cSJoe Perches if (! ($delay < 10) ) { 5541000d1cc1SJoe Perches CHK("USLEEP_RANGE", 554243c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 554343c1d77cSJoe Perches } 554443c1d77cSJoe Perches if ($delay > 2000) { 554543c1d77cSJoe Perches WARN("LONG_UDELAY", 554643c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 55471a15a250SPatrick Pannuto } 55481a15a250SPatrick Pannuto } 55491a15a250SPatrick Pannuto 555009ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 555109ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 555209ef8725SPatrick Pannuto if ($1 < 20) { 5553000d1cc1SJoe Perches WARN("MSLEEP", 555443c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 555509ef8725SPatrick Pannuto } 555609ef8725SPatrick Pannuto } 555709ef8725SPatrick Pannuto 555836ec1939SJoe Perches# check for comparisons of jiffies 555936ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 556036ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 556136ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 556236ec1939SJoe Perches } 556336ec1939SJoe Perches 55649d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 55659d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 55669d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 55679d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 55689d7a34a5SJoe Perches } 55699d7a34a5SJoe Perches 557000df344fSAndy Whitcroft# warn about #ifdefs in C files 5571c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 557200df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 557300df344fSAndy Whitcroft# print "$herecurr"; 557400df344fSAndy Whitcroft# $clean = 0; 557500df344fSAndy Whitcroft# } 557600df344fSAndy Whitcroft 557722f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5578c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 55793705ce5bSJoe Perches if (ERROR("SPACING", 55803705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 55813705ce5bSJoe Perches $fix) { 5582194f66fcSJoe Perches $fixed[$fixlinenr] =~ 55833705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 55843705ce5bSJoe Perches } 55853705ce5bSJoe Perches 558622f2a2efSAndy Whitcroft } 558722f2a2efSAndy Whitcroft 55884a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5589171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5590171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 55914a0df2efSAndy Whitcroft my $which = $1; 55924a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5593000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5594000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 55954a0df2efSAndy Whitcroft } 55964a0df2efSAndy Whitcroft } 55974a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5598402c2553SMichael S. Tsirkin 5599402c2553SMichael S. Tsirkin my $barriers = qr{ 5600402c2553SMichael S. Tsirkin mb| 5601402c2553SMichael S. Tsirkin rmb| 5602402c2553SMichael S. Tsirkin wmb| 5603402c2553SMichael S. Tsirkin read_barrier_depends 5604402c2553SMichael S. Tsirkin }x; 5605402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5606402c2553SMichael S. Tsirkin mb__before_atomic| 5607402c2553SMichael S. Tsirkin mb__after_atomic| 5608402c2553SMichael S. Tsirkin store_release| 5609402c2553SMichael S. Tsirkin load_acquire| 5610402c2553SMichael S. Tsirkin store_mb| 5611402c2553SMichael S. Tsirkin (?:$barriers) 5612402c2553SMichael S. Tsirkin }x; 5613402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5614402c2553SMichael S. Tsirkin (?:$barriers)| 561543e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 561643e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5617402c2553SMichael S. Tsirkin }x; 5618402c2553SMichael S. Tsirkin 5619402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 56204a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5621c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5622000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 56234a0df2efSAndy Whitcroft } 56244a0df2efSAndy Whitcroft } 56253ad81779SPaul E. McKenney 5626f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5627f4073b0fSMichael S. Tsirkin 5628f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5629f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5630f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5631f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5632f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5633f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5634f4073b0fSMichael S. Tsirkin } 5635f4073b0fSMichael S. Tsirkin 5636cb426e99SJoe Perches# check for waitqueue_active without a comment. 5637cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5638cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5639cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5640cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5641cb426e99SJoe Perches } 5642cb426e99SJoe Perches } 56433ad81779SPaul E. McKenney 564491db2592SPaul E. McKenney# check for smp_read_barrier_depends and read_barrier_depends 564591db2592SPaul E. McKenney if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) { 564691db2592SPaul E. McKenney WARN("READ_BARRIER_DEPENDS", 564791db2592SPaul E. McKenney "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr); 564891db2592SPaul E. McKenney } 564991db2592SPaul E. McKenney 56504a0df2efSAndy Whitcroft# check of hardware specific defines 5651c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5652000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5653000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 56540a920b5bSAndy Whitcroft } 5655653d4876SAndy Whitcroft 5656596ed45bSJoe Perches# check that the storage class is not after a type 5657596ed45bSJoe Perches if ($line =~ /\b($Type)\s+($Storage)\b/) { 5658000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5659596ed45bSJoe Perches "storage class '$2' should be located before type '$1'\n" . $herecurr); 5660596ed45bSJoe Perches } 5661596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration 5662596ed45bSJoe Perches if ($line =~ /\b$Storage\b/ && 5663596ed45bSJoe Perches $line !~ /^.\s*$Storage/ && 5664596ed45bSJoe Perches $line =~ /^.\s*(.+?)\$Storage\s/ && 5665596ed45bSJoe Perches $1 !~ /[\,\)]\s*$/) { 5666596ed45bSJoe Perches WARN("STORAGE_CLASS", 5667596ed45bSJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr); 5668d4977c78STobias Klauser } 5669d4977c78STobias Klauser 5670de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5671de7d4f0eSAndy Whitcroft# storage class and type. 56729c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 56739c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5674000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5675000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5676de7d4f0eSAndy Whitcroft } 5677de7d4f0eSAndy Whitcroft 56788905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 56792b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 56802b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5681d5e616fcSJoe Perches if (WARN("INLINE", 5682d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5683d5e616fcSJoe Perches $fix) { 5684194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5685d5e616fcSJoe Perches 5686d5e616fcSJoe Perches } 56878905a67cSAndy Whitcroft } 56888905a67cSAndy Whitcroft 56893d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 56902b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 56912b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5692000d1cc1SJoe Perches WARN("PREFER_PACKED", 5693000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 56943d130fd0SJoe Perches } 56953d130fd0SJoe Perches 569639b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 56972b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 56982b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5699000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5700000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 570139b7e287SJoe Perches } 570239b7e287SJoe Perches 57035f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 57042b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57052b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5706d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5707d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5708d5e616fcSJoe Perches $fix) { 5709194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5710d5e616fcSJoe Perches 5711d5e616fcSJoe Perches } 57125f14d3bdSJoe Perches } 57135f14d3bdSJoe Perches 57146061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 57152b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 57162b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5717d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5718d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5719d5e616fcSJoe Perches $fix) { 5720194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5721d5e616fcSJoe Perches } 57226061d949SJoe Perches } 57236061d949SJoe Perches 5724619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 5725619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 5726619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5727619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5728619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5729619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5730619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5731619a908aSJoe Perches } 5732619a908aSJoe Perches 5733fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/ 5734e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5735fd39f904STomas Winkler $realfile !~ m@\btools/@ && 5736e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5737e6176fa4SJoe Perches my $type = $1; 5738e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5739e6176fa4SJoe Perches $type = $1; 5740e6176fa4SJoe Perches my $kernel_type = 'u'; 5741e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5742e6176fa4SJoe Perches $type =~ /(\d+)/; 5743e6176fa4SJoe Perches $kernel_type .= $1; 5744e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5745e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5746e6176fa4SJoe Perches $fix) { 5747e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5748e6176fa4SJoe Perches } 5749e6176fa4SJoe Perches } 5750e6176fa4SJoe Perches } 5751e6176fa4SJoe Perches 5752938224b5SJoe Perches# check for cast of C90 native int or longer types constants 5753938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 5754938224b5SJoe Perches my $cast = $1; 5755938224b5SJoe Perches my $const = $2; 5756938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 5757938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 5758938224b5SJoe Perches $fix) { 5759938224b5SJoe Perches my $suffix = ""; 5760938224b5SJoe Perches my $newconst = $const; 5761938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 5762938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 5763938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 5764938224b5SJoe Perches $suffix .= 'LL'; 5765938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 5766938224b5SJoe Perches $suffix .= 'L'; 5767938224b5SJoe Perches } 5768938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 5769938224b5SJoe Perches } 5770938224b5SJoe Perches } 5771938224b5SJoe Perches 57728f53a9b8SJoe Perches# check for sizeof(&) 57738f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5774000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5775000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 57768f53a9b8SJoe Perches } 57778f53a9b8SJoe Perches 577866c80b60SJoe Perches# check for sizeof without parenthesis 577966c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5780d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5781d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5782d5e616fcSJoe Perches $fix) { 5783194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5784d5e616fcSJoe Perches } 578566c80b60SJoe Perches } 578666c80b60SJoe Perches 578788982feaSJoe Perches# check for struct spinlock declarations 578888982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 578988982feaSJoe Perches WARN("USE_SPINLOCK_T", 579088982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 579188982feaSJoe Perches } 579288982feaSJoe Perches 5793a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 579406668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5795a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5796caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5797caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5798d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5799d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5800d5e616fcSJoe Perches $fix) { 5801194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5802d5e616fcSJoe Perches } 5803a6962d72SJoe Perches } 5804a6962d72SJoe Perches } 5805a6962d72SJoe Perches 58060b523769SJoe Perches # check for vsprintf extension %p<foo> misuses 58070b523769SJoe Perches if ($^V && $^V ge 5.10.0 && 58080b523769SJoe Perches defined $stat && 58090b523769SJoe Perches $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 58100b523769SJoe Perches $1 !~ /^_*volatile_*$/) { 58110b523769SJoe Perches my $bad_extension = ""; 58120b523769SJoe Perches my $lc = $stat =~ tr@\n@@; 58130b523769SJoe Perches $lc = $lc + $linenr; 58140b523769SJoe Perches for (my $count = $linenr; $count <= $lc; $count++) { 58150b523769SJoe Perches my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 58160b523769SJoe Perches $fmt =~ s/%%//g; 5817ab486bc9SLinus Torvalds if ($fmt =~ /(\%[\*\d\.]*p(?![\WSsBKRraEhMmIiUDdgVCbGNOx]).)/) { 58180b523769SJoe Perches $bad_extension = $1; 58190b523769SJoe Perches last; 58200b523769SJoe Perches } 58210b523769SJoe Perches } 58220b523769SJoe Perches if ($bad_extension ne "") { 58230b523769SJoe Perches my $stat_real = raw_line($linenr, 0); 58241df7338aSSergey Senozhatsky my $ext_type = "Invalid"; 58251df7338aSSergey Senozhatsky my $use = ""; 58260b523769SJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 58270b523769SJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 58280b523769SJoe Perches } 58291df7338aSSergey Senozhatsky if ($bad_extension =~ /p[Ff]/) { 58301df7338aSSergey Senozhatsky $ext_type = "Deprecated"; 58311df7338aSSergey Senozhatsky $use = " - use %pS instead"; 58321df7338aSSergey Senozhatsky $use =~ s/pS/ps/ if ($bad_extension =~ /pf/); 58331df7338aSSergey Senozhatsky } 58340b523769SJoe Perches WARN("VSPRINTF_POINTER_EXTENSION", 58351df7338aSSergey Senozhatsky "$ext_type vsprintf pointer extension '$bad_extension'$use\n" . "$here\n$stat_real\n"); 58360b523769SJoe Perches } 58370b523769SJoe Perches } 58380b523769SJoe Perches 5839554e165cSAndy Whitcroft# Check for misused memsets 5840d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5841d1fe9c09SJoe Perches defined $stat && 58429e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5843554e165cSAndy Whitcroft 5844d7c76ba7SJoe Perches my $ms_addr = $2; 5845d1fe9c09SJoe Perches my $ms_val = $7; 5846d1fe9c09SJoe Perches my $ms_size = $12; 5847d7c76ba7SJoe Perches 5848554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5849554e165cSAndy Whitcroft ERROR("MEMSET", 5850d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5851554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5852554e165cSAndy Whitcroft WARN("MEMSET", 5853d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5854d7c76ba7SJoe Perches } 5855d7c76ba7SJoe Perches } 5856d7c76ba7SJoe Perches 585798a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 5858f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5859f333195dSJoe Perches# defined $stat && 5860f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5861f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 5862f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 5863f333195dSJoe Perches# $fix) { 5864f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 5865f333195dSJoe Perches# } 5866f333195dSJoe Perches# } 586798a9bba5SJoe Perches 5868b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 5869f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5870f333195dSJoe Perches# defined $stat && 5871f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5872f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 5873f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5874f333195dSJoe Perches# } 5875b6117d17SMateusz Kulikowski 58768617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 58778617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 5878f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5879f333195dSJoe Perches# defined $stat && 5880f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5881f333195dSJoe Perches# 5882f333195dSJoe Perches# my $ms_val = $7; 5883f333195dSJoe Perches# 5884f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 5885f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 5886f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 5887f333195dSJoe Perches# $fix) { 5888f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 5889f333195dSJoe Perches# } 5890f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 5891f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 5892f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 5893f333195dSJoe Perches# $fix) { 5894f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 5895f333195dSJoe Perches# } 5896f333195dSJoe Perches# } 5897f333195dSJoe Perches# } 58988617cd09SMateusz Kulikowski 5899d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5900d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5901d1fe9c09SJoe Perches defined $stat && 5902d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5903d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5904d7c76ba7SJoe Perches my $call = $1; 5905d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5906d7c76ba7SJoe Perches my $arg1 = $3; 5907d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5908d1fe9c09SJoe Perches my $arg2 = $8; 5909d7c76ba7SJoe Perches my $cast; 5910d7c76ba7SJoe Perches 5911d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5912d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5913d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5914d7c76ba7SJoe Perches $cast = $cast1; 5915d7c76ba7SJoe Perches } else { 5916d7c76ba7SJoe Perches $cast = $cast2; 5917d7c76ba7SJoe Perches } 5918d7c76ba7SJoe Perches WARN("MINMAX", 5919d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5920554e165cSAndy Whitcroft } 5921554e165cSAndy Whitcroft } 5922554e165cSAndy Whitcroft 59234a273195SJoe Perches# check usleep_range arguments 59244a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 59254a273195SJoe Perches defined $stat && 59264a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 59274a273195SJoe Perches my $min = $1; 59284a273195SJoe Perches my $max = $7; 59294a273195SJoe Perches if ($min eq $max) { 59304a273195SJoe Perches WARN("USLEEP_RANGE", 59314a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 59324a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 59334a273195SJoe Perches $min > $max) { 59344a273195SJoe Perches WARN("USLEEP_RANGE", 59354a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 59364a273195SJoe Perches } 59374a273195SJoe Perches } 59384a273195SJoe Perches 5939823b794cSJoe Perches# check for naked sscanf 5940823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5941823b794cSJoe Perches defined $stat && 59426c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5943823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5944823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5945823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5946823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5947823b794cSJoe Perches $lc = $lc + $linenr; 5948823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 5949823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5950823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5951823b794cSJoe Perches } 5952823b794cSJoe Perches WARN("NAKED_SSCANF", 5953823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5954823b794cSJoe Perches } 5955823b794cSJoe Perches 5956afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5957afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5958afc819abSJoe Perches defined $stat && 5959afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5960afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5961afc819abSJoe Perches $lc = $lc + $linenr; 5962afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 5963afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5964afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5965afc819abSJoe Perches } 5966afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5967afc819abSJoe Perches my $format = $6; 5968afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5969afc819abSJoe Perches if ($count == 1 && 5970afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5971afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5972afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5973afc819abSJoe Perches } 5974afc819abSJoe Perches } 5975afc819abSJoe Perches } 5976afc819abSJoe Perches 597770dc8a48SJoe Perches# check for new externs in .h files. 597870dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 597970dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5980d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 598170dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 598270dc8a48SJoe Perches $fix) { 5983194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 598470dc8a48SJoe Perches } 598570dc8a48SJoe Perches } 598670dc8a48SJoe Perches 5987de7d4f0eSAndy Whitcroft# check for new externs in .c files. 5988171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 5989c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 5990171ae1a4SAndy Whitcroft { 5991c45dcabdSAndy Whitcroft my $function_name = $1; 5992c45dcabdSAndy Whitcroft my $paren_space = $2; 5993171ae1a4SAndy Whitcroft 5994171ae1a4SAndy Whitcroft my $s = $stat; 5995171ae1a4SAndy Whitcroft if (defined $cond) { 5996171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 5997171ae1a4SAndy Whitcroft } 5998c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 5999c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 6000c45dcabdSAndy Whitcroft { 6001000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6002000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6003de7d4f0eSAndy Whitcroft } 6004de7d4f0eSAndy Whitcroft 6005171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 6006000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 6007000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 6008171ae1a4SAndy Whitcroft } 60099c9ba34eSAndy Whitcroft 60109c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 60119c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 60129c9ba34eSAndy Whitcroft { 6013000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 6014000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 6015171ae1a4SAndy Whitcroft } 6016171ae1a4SAndy Whitcroft 6017a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names 6018a0ad7596SJoe Perches if (defined $stat && 601925bdda2bSMiles Chen $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 6020ca0d8929SJoe Perches $1 ne "void") { 6021ca0d8929SJoe Perches my $args = trim($1); 6022ca0d8929SJoe Perches while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6023ca0d8929SJoe Perches my $arg = trim($1); 6024ca0d8929SJoe Perches if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 6025ca0d8929SJoe Perches WARN("FUNCTION_ARGUMENTS", 6026ca0d8929SJoe Perches "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6027ca0d8929SJoe Perches } 6028ca0d8929SJoe Perches } 6029ca0d8929SJoe Perches } 6030ca0d8929SJoe Perches 6031a0ad7596SJoe Perches# check for function definitions 6032a0ad7596SJoe Perches if ($^V && $^V ge 5.10.0 && 6033a0ad7596SJoe Perches defined $stat && 6034a0ad7596SJoe Perches $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6035a0ad7596SJoe Perches $context_function = $1; 6036a0ad7596SJoe Perches 6037a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace 6038a0ad7596SJoe Perches my $ok = 0; 6039a0ad7596SJoe Perches my $cnt = statement_rawlines($stat); 6040a0ad7596SJoe Perches my $herectx = $here . "\n"; 6041a0ad7596SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6042a0ad7596SJoe Perches my $rl = raw_line($linenr, $n); 6043a0ad7596SJoe Perches $herectx .= $rl . "\n"; 6044a0ad7596SJoe Perches $ok = 1 if ($rl =~ /^[ \+]\{/); 6045a0ad7596SJoe Perches $ok = 1 if ($rl =~ /\{/ && $n == 0); 6046a0ad7596SJoe Perches last if $rl =~ /^[ \+].*\{/; 6047a0ad7596SJoe Perches } 6048a0ad7596SJoe Perches if (!$ok) { 6049a0ad7596SJoe Perches ERROR("OPEN_BRACE", 6050a0ad7596SJoe Perches "open brace '{' following function definitions go on the next line\n" . $herectx); 6051a0ad7596SJoe Perches } 6052a0ad7596SJoe Perches } 6053a0ad7596SJoe Perches 6054de7d4f0eSAndy Whitcroft# checks for new __setup's 6055de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 6056de7d4f0eSAndy Whitcroft my $name = $1; 6057de7d4f0eSAndy Whitcroft 6058de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 6059000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 60608c27ceffSMauro Carvalho Chehab "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr); 6061de7d4f0eSAndy Whitcroft } 6062653d4876SAndy Whitcroft } 60639c0ca6f9SAndy Whitcroft 60649c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 6065caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 6066000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 6067000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 60689c0ca6f9SAndy Whitcroft } 606913214adfSAndy Whitcroft 6070a640d25cSJoe Perches# alloc style 6071a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 6072a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 6073a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 6074a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 6075a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 6076a640d25cSJoe Perches } 6077a640d25cSJoe Perches 607860a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 607960a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 60801b4a2ed4SJoe Perches defined $stat && 60811b4a2ed4SJoe Perches $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 608260a55369SJoe Perches my $oldfunc = $3; 608360a55369SJoe Perches my $a1 = $4; 608460a55369SJoe Perches my $a2 = $10; 608560a55369SJoe Perches my $newfunc = "kmalloc_array"; 608660a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 608760a55369SJoe Perches my $r1 = $a1; 608860a55369SJoe Perches my $r2 = $a2; 608960a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 609060a55369SJoe Perches $r1 = $a2; 609160a55369SJoe Perches $r2 = $a1; 609260a55369SJoe Perches } 6093e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 6094e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 60951b4a2ed4SJoe Perches my $ctx = ''; 60961b4a2ed4SJoe Perches my $herectx = $here . "\n"; 60971b4a2ed4SJoe Perches my $cnt = statement_rawlines($stat); 60981b4a2ed4SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 60991b4a2ed4SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 61001b4a2ed4SJoe Perches } 6101e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 61021b4a2ed4SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 61031b4a2ed4SJoe Perches $cnt == 1 && 6104e367455aSJoe Perches $fix) { 6105194f66fcSJoe 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; 610660a55369SJoe Perches } 610760a55369SJoe Perches } 610860a55369SJoe Perches } 610960a55369SJoe Perches 6110972fdea2SJoe Perches# check for krealloc arg reuse 6111972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 6112972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 6113972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 6114972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 6115972fdea2SJoe Perches } 6116972fdea2SJoe Perches 61175ce59ae0SJoe Perches# check for alloc argument mismatch 61185ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 61195ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 61205ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 61215ce59ae0SJoe Perches } 61225ce59ae0SJoe Perches 6123caf2a54fSJoe Perches# check for multiple semicolons 6124caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 6125d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 6126d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 6127d5e616fcSJoe Perches $fix) { 6128194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 6129d5e616fcSJoe Perches } 6130d1e2ad07SJoe Perches } 6131d1e2ad07SJoe Perches 6132cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 6133cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 6134cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 61350ab90191SJoe Perches my $ull = ""; 61360ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 61370ab90191SJoe Perches if (CHK("BIT_MACRO", 61380ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 61390ab90191SJoe Perches $fix) { 61400ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 61410ab90191SJoe Perches } 61420ab90191SJoe Perches } 61430ab90191SJoe Perches 61442d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 61452d632745SJoe 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*$/) { 61462d632745SJoe Perches my $config = $1; 61472d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 61482d632745SJoe Perches "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) && 61492d632745SJoe Perches $fix) { 61502d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 61512d632745SJoe Perches } 61522d632745SJoe Perches } 61532d632745SJoe Perches 6154e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 6155c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 6156c34c09a8SJoe Perches my $has_break = 0; 6157c34c09a8SJoe Perches my $has_statement = 0; 6158c34c09a8SJoe Perches my $count = 0; 6159c34c09a8SJoe Perches my $prevline = $linenr; 6160e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 6161c34c09a8SJoe Perches $prevline--; 6162c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 6163c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 6164c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 6165c34c09a8SJoe Perches next if ($fline =~ /^\-/); 6166c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 6167c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 6168c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 6169c34c09a8SJoe Perches $has_statement = 1; 6170c34c09a8SJoe Perches $count++; 6171258f79d5SHeinrich Schuchardt $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/); 6172c34c09a8SJoe Perches } 6173c34c09a8SJoe Perches if (!$has_break && $has_statement) { 6174c34c09a8SJoe Perches WARN("MISSING_BREAK", 6175224236d9SAndrew Morton "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr); 6176c34c09a8SJoe Perches } 6177c34c09a8SJoe Perches } 6178c34c09a8SJoe Perches 6179d1e2ad07SJoe Perches# check for switch/default statements without a break; 6180d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 6181d1e2ad07SJoe Perches defined $stat && 6182d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 6183d1e2ad07SJoe Perches my $ctx = ''; 6184d1e2ad07SJoe Perches my $herectx = $here . "\n"; 6185d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 6186d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 6187d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 6188d1e2ad07SJoe Perches } 6189d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 6190d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 6191caf2a54fSJoe Perches } 6192caf2a54fSJoe Perches 619313214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 6194d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 6195d5e616fcSJoe Perches if (WARN("USE_FUNC", 6196d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 6197d5e616fcSJoe Perches $fix) { 6198194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 6199d5e616fcSJoe Perches } 620013214adfSAndy Whitcroft } 6201773647a0SAndy Whitcroft 620262ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 620362ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 620462ec818fSJoe Perches ERROR("DATE_TIME", 620562ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 620662ec818fSJoe Perches } 620762ec818fSJoe Perches 62082c92488aSJoe Perches# check for use of yield() 62092c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 62102c92488aSJoe Perches WARN("YIELD", 62112c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 62122c92488aSJoe Perches } 62132c92488aSJoe Perches 6214179f8f40SJoe Perches# check for comparisons against true and false 6215179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 6216179f8f40SJoe Perches my $lead = $1; 6217179f8f40SJoe Perches my $arg = $2; 6218179f8f40SJoe Perches my $test = $3; 6219179f8f40SJoe Perches my $otype = $4; 6220179f8f40SJoe Perches my $trail = $5; 6221179f8f40SJoe Perches my $op = "!"; 6222179f8f40SJoe Perches 6223179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 6224179f8f40SJoe Perches 6225179f8f40SJoe Perches my $type = lc($otype); 6226179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 6227179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 6228179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 6229179f8f40SJoe Perches $op = ""; 6230179f8f40SJoe Perches } 6231179f8f40SJoe Perches 6232179f8f40SJoe Perches CHK("BOOL_COMPARISON", 6233179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 6234179f8f40SJoe Perches 6235179f8f40SJoe Perches## maybe suggesting a correct construct would better 6236179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 6237179f8f40SJoe Perches 6238179f8f40SJoe Perches } 6239179f8f40SJoe Perches } 6240179f8f40SJoe Perches 62414882720bSThomas Gleixner# check for semaphores initialized locked 62424882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 6243000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 6244000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 6245773647a0SAndy Whitcroft } 62466712d858SJoe Perches 624767d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 624867d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 6249000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 625067d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 6251773647a0SAndy Whitcroft } 62526712d858SJoe Perches 6253ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 6254f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 6255000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 6256ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 6257f3db6639SMichael Ellerman } 62586712d858SJoe Perches 62590f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 6260d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {' 62616903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 6262d9190e4eSJoe Perches $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 6263000d1cc1SJoe Perches WARN("CONST_STRUCT", 6264d9190e4eSJoe Perches "struct $1 should normally be const\n" . $herecurr); 62652b6db5cbSAndy Whitcroft } 6266773647a0SAndy Whitcroft 6267773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 6268773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 6269773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 6270c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 6271c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 6272171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 6273171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 6274171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 6275773647a0SAndy Whitcroft { 6276000d1cc1SJoe Perches WARN("NR_CPUS", 6277000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 6278773647a0SAndy Whitcroft } 62799c9ba34eSAndy Whitcroft 628052ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 628152ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 628252ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 628352ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 628452ea8506SJoe Perches } 628552ea8506SJoe Perches 6286acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 6287acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 6288acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 6289acd9362cSJoe Perches WARN("LIKELY_MISUSE", 6290acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 6291acd9362cSJoe Perches } 6292acd9362cSJoe Perches 6293691d77b6SAndy Whitcroft# whine mightly about in_atomic 6294691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 6295691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 6296000d1cc1SJoe Perches ERROR("IN_ATOMIC", 6297000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 6298f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 6299000d1cc1SJoe Perches WARN("IN_ATOMIC", 6300000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 6301691d77b6SAndy Whitcroft } 6302691d77b6SAndy Whitcroft } 63031704f47bSPeter Zijlstra 63040f5225b0SPeter Zijlstra# check for mutex_trylock_recursive usage 63050f5225b0SPeter Zijlstra if ($line =~ /mutex_trylock_recursive/) { 63060f5225b0SPeter Zijlstra ERROR("LOCKING", 63070f5225b0SPeter Zijlstra "recursive locking is bad, do not use this ever.\n" . $herecurr); 63080f5225b0SPeter Zijlstra } 63090f5225b0SPeter Zijlstra 63101704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 63111704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 63121704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 63131704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 63141704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 63151704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 6316000d1cc1SJoe Perches ERROR("LOCKDEP", 6317000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 63181704f47bSPeter Zijlstra } 63191704f47bSPeter Zijlstra } 632088f8831cSDave Jones 6321b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 6322b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 6323000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 6324000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 632588f8831cSDave Jones } 63262435880fSJoe Perches 632700180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 632800180468SJoe Perches# and whether or not function naming is typical and if 632900180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too 633000180468SJoe Perches if ($^V && $^V ge 5.10.0 && 633100180468SJoe Perches defined $stat && 633200180468SJoe 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*\)/) { 633300180468SJoe Perches my $var = $1; 633400180468SJoe Perches my $perms = $2; 633500180468SJoe Perches my $show = $3; 633600180468SJoe Perches my $store = $4; 633700180468SJoe Perches my $octal_perms = perms_to_octal($perms); 633800180468SJoe Perches if ($show =~ /^${var}_show$/ && 633900180468SJoe Perches $store =~ /^${var}_store$/ && 634000180468SJoe Perches $octal_perms eq "0644") { 634100180468SJoe Perches if (WARN("DEVICE_ATTR_RW", 634200180468SJoe Perches "Use DEVICE_ATTR_RW\n" . $herecurr) && 634300180468SJoe Perches $fix) { 634400180468SJoe 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})/; 634500180468SJoe Perches } 634600180468SJoe Perches } elsif ($show =~ /^${var}_show$/ && 634700180468SJoe Perches $store =~ /^NULL$/ && 634800180468SJoe Perches $octal_perms eq "0444") { 634900180468SJoe Perches if (WARN("DEVICE_ATTR_RO", 635000180468SJoe Perches "Use DEVICE_ATTR_RO\n" . $herecurr) && 635100180468SJoe Perches $fix) { 635200180468SJoe 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})/; 635300180468SJoe Perches } 635400180468SJoe Perches } elsif ($show =~ /^NULL$/ && 635500180468SJoe Perches $store =~ /^${var}_store$/ && 635600180468SJoe Perches $octal_perms eq "0200") { 635700180468SJoe Perches if (WARN("DEVICE_ATTR_WO", 635800180468SJoe Perches "Use DEVICE_ATTR_WO\n" . $herecurr) && 635900180468SJoe Perches $fix) { 636000180468SJoe 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})/; 636100180468SJoe Perches } 636200180468SJoe Perches } elsif ($octal_perms eq "0644" || 636300180468SJoe Perches $octal_perms eq "0444" || 636400180468SJoe Perches $octal_perms eq "0200") { 636500180468SJoe Perches my $newshow = "$show"; 636600180468SJoe Perches $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 636700180468SJoe Perches my $newstore = $store; 636800180468SJoe Perches $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 636900180468SJoe Perches my $rename = ""; 637000180468SJoe Perches if ($show ne $newshow) { 637100180468SJoe Perches $rename .= " '$show' to '$newshow'"; 637200180468SJoe Perches } 637300180468SJoe Perches if ($store ne $newstore) { 637400180468SJoe Perches $rename .= " '$store' to '$newstore'"; 637500180468SJoe Perches } 637600180468SJoe Perches WARN("DEVICE_ATTR_FUNCTIONS", 637700180468SJoe Perches "Consider renaming function(s)$rename\n" . $herecurr); 637800180468SJoe Perches } else { 637900180468SJoe Perches WARN("DEVICE_ATTR_PERMS", 638000180468SJoe Perches "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 638100180468SJoe Perches } 638200180468SJoe Perches } 638300180468SJoe Perches 6384515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 6385515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 638673121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 638773121534SJoe Perches# specific definition of not visible in sysfs. 638873121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 638973121534SJoe Perches# use the default permissions 6390515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 6391459cf0aeSJoe Perches defined $stat && 6392515a235eSJoe Perches $line =~ /$mode_perms_search/) { 63932435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 63942435880fSJoe Perches my $func = $entry->[0]; 63952435880fSJoe Perches my $arg_pos = $entry->[1]; 63962435880fSJoe Perches 6397459cf0aeSJoe Perches my $lc = $stat =~ tr@\n@@; 6398459cf0aeSJoe Perches $lc = $lc + $linenr; 6399459cf0aeSJoe Perches my $stat_real = raw_line($linenr, 0); 6400459cf0aeSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 6401459cf0aeSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 6402459cf0aeSJoe Perches } 6403459cf0aeSJoe Perches 64042435880fSJoe Perches my $skip_args = ""; 64052435880fSJoe Perches if ($arg_pos > 1) { 64062435880fSJoe Perches $arg_pos--; 64072435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 64082435880fSJoe Perches } 6409f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 6410459cf0aeSJoe Perches if ($stat =~ /$test/) { 64112435880fSJoe Perches my $val = $1; 64122435880fSJoe Perches $val = $6 if ($skip_args ne ""); 641373121534SJoe Perches if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 641473121534SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 641573121534SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4))) { 64162435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 6417459cf0aeSJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 6418f90774e1SJoe Perches } 6419f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6420c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6421459cf0aeSJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 64222435880fSJoe Perches } 6423459cf0aeSJoe Perches } 6424459cf0aeSJoe Perches } 6425459cf0aeSJoe Perches } 6426459cf0aeSJoe Perches 6427459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability 642800180468SJoe Perches if ($line =~ /\b($multi_mode_perms_string_search)\b/) { 642900180468SJoe Perches my $oval = $1; 643000180468SJoe Perches my $octal = perms_to_octal($oval); 6431f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 6432459cf0aeSJoe Perches "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 6433f90774e1SJoe Perches $fix) { 643400180468SJoe Perches $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 64352435880fSJoe Perches } 643613214adfSAndy Whitcroft } 64375a6d20ceSBjorn Andersson 64385a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 64395a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 64405a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 64415a6d20ceSBjorn Andersson my $valid_licenses = qr{ 64425a6d20ceSBjorn Andersson GPL| 64435a6d20ceSBjorn Andersson GPL\ v2| 64445a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 64455a6d20ceSBjorn Andersson Dual\ BSD/GPL| 64465a6d20ceSBjorn Andersson Dual\ MIT/GPL| 64475a6d20ceSBjorn Andersson Dual\ MPL/GPL| 64485a6d20ceSBjorn Andersson Proprietary 64495a6d20ceSBjorn Andersson }x; 64505a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 64515a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 64525a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 64535a6d20ceSBjorn Andersson } 64545a6d20ceSBjorn Andersson } 6455515a235eSJoe Perches } 645613214adfSAndy Whitcroft 645713214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 645813214adfSAndy Whitcroft # so just keep quiet. 645913214adfSAndy Whitcroft if ($#rawlines == -1) { 646013214adfSAndy Whitcroft exit(0); 64610a920b5bSAndy Whitcroft } 64620a920b5bSAndy Whitcroft 64638905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 64648905a67cSAndy Whitcroft # things that appear to be patches. 64658905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 64668905a67cSAndy Whitcroft exit(0); 64678905a67cSAndy Whitcroft } 64688905a67cSAndy Whitcroft 64698905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 64708905a67cSAndy Whitcroft # just keep quiet. 64718905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 64728905a67cSAndy Whitcroft exit(0); 64738905a67cSAndy Whitcroft } 64748905a67cSAndy Whitcroft 6475a08ffbefSStafford Horne if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 6476000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6477000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 64780a920b5bSAndy Whitcroft } 6479ed43c4e5SAllen Hubbe if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) { 6480000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6481000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 64820a920b5bSAndy Whitcroft } 64830a920b5bSAndy Whitcroft 6484f0a594c1SAndy Whitcroft print report_dump(); 648513214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 648613214adfSAndy Whitcroft print "$filename " if ($summary_file); 64876c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 64886c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 64896c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 64906c72ffaaSAndy Whitcroft } 64918905a67cSAndy Whitcroft 6492d2c0a235SAndy Whitcroft if ($quiet == 0) { 6493ef212196SJoe Perches # If there were any defects found and not already fixing them 6494ef212196SJoe Perches if (!$clean and !$fix) { 6495ef212196SJoe Perches print << "EOM" 6496ef212196SJoe Perches 6497ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 6498ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 6499ef212196SJoe PerchesEOM 6500ef212196SJoe Perches } 6501d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 6502d2c0a235SAndy Whitcroft # then suggest that. 6503d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 6504b0781216SMike Frysinger $rpt_cleaners = 0; 6505d8469f16SJoe Perches print << "EOM" 6506d8469f16SJoe Perches 6507d8469f16SJoe PerchesNOTE: Whitespace errors detected. 6508d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 6509d8469f16SJoe PerchesEOM 6510d2c0a235SAndy Whitcroft } 6511d2c0a235SAndy Whitcroft } 6512d2c0a235SAndy Whitcroft 6513d752fcc8SJoe Perches if ($clean == 0 && $fix && 6514d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 6515d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 65169624b8d6SJoe Perches my $newfile = $filename; 65179624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 65183705ce5bSJoe Perches my $linecount = 0; 65193705ce5bSJoe Perches my $f; 65203705ce5bSJoe Perches 6521d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 6522d752fcc8SJoe Perches 65233705ce5bSJoe Perches open($f, '>', $newfile) 65243705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 65253705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 65263705ce5bSJoe Perches $linecount++; 65273705ce5bSJoe Perches if ($file) { 65283705ce5bSJoe Perches if ($linecount > 3) { 65293705ce5bSJoe Perches $fixed_line =~ s/^\+//; 65303705ce5bSJoe Perches print $f $fixed_line . "\n"; 65313705ce5bSJoe Perches } 65323705ce5bSJoe Perches } else { 65333705ce5bSJoe Perches print $f $fixed_line . "\n"; 65343705ce5bSJoe Perches } 65353705ce5bSJoe Perches } 65363705ce5bSJoe Perches close($f); 65373705ce5bSJoe Perches 65383705ce5bSJoe Perches if (!$quiet) { 65393705ce5bSJoe Perches print << "EOM"; 6540d8469f16SJoe Perches 65413705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 65423705ce5bSJoe Perches 65433705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 65443705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 65453705ce5bSJoe Perches 65463705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 65473705ce5bSJoe PerchesNo warranties, expressed or implied... 65483705ce5bSJoe PerchesEOM 65493705ce5bSJoe Perches } 65503705ce5bSJoe Perches } 65513705ce5bSJoe Perches 6552d8469f16SJoe Perches if ($quiet == 0) { 6553d8469f16SJoe Perches print "\n"; 6554d8469f16SJoe Perches if ($clean == 1) { 6555d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 6556d8469f16SJoe Perches } else { 6557d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 65580a920b5bSAndy Whitcroft } 65590a920b5bSAndy Whitcroft } 65600a920b5bSAndy Whitcroft return $clean; 65610a920b5bSAndy Whitcroft} 6562