10a920b5bSAndy Whitcroft#!/usr/bin/perl -w 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; 9c707a81dSJoe Perchesuse POSIX; 1036061e38SJoe Perchesuse File::Basename; 1136061e38SJoe Perchesuse Cwd 'abs_path'; 1257230297SJoe Perchesuse Term::ANSIColor qw(:constants); 130a920b5bSAndy Whitcroft 140a920b5bSAndy Whitcroftmy $P = $0; 1536061e38SJoe Perchesmy $D = dirname(abs_path($P)); 160a920b5bSAndy Whitcroft 17000d1cc1SJoe Perchesmy $V = '0.32'; 180a920b5bSAndy Whitcroft 190a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 200a920b5bSAndy Whitcroft 210a920b5bSAndy Whitcroftmy $quiet = 0; 220a920b5bSAndy Whitcroftmy $tree = 1; 230a920b5bSAndy Whitcroftmy $chk_signoff = 1; 240a920b5bSAndy Whitcroftmy $chk_patch = 1; 25773647a0SAndy Whitcroftmy $tst_only; 266c72ffaaSAndy Whitcroftmy $emacs = 0; 278905a67cSAndy Whitcroftmy $terse = 0; 2834d8815fSJoe Perchesmy $showfile = 0; 296c72ffaaSAndy Whitcroftmy $file = 0; 304a593c34SDu, Changbinmy $git = 0; 310dea9f1eSJoe Perchesmy %git_commits = (); 326c72ffaaSAndy Whitcroftmy $check = 0; 332ac73b4fSJoe Perchesmy $check_orig = 0; 348905a67cSAndy Whitcroftmy $summary = 1; 358905a67cSAndy Whitcroftmy $mailback = 0; 3613214adfSAndy Whitcroftmy $summary_file = 0; 37000d1cc1SJoe Perchesmy $show_types = 0; 383beb42ecSJoe Perchesmy $list_types = 0; 393705ce5bSJoe Perchesmy $fix = 0; 409624b8d6SJoe Perchesmy $fix_inplace = 0; 416c72ffaaSAndy Whitcroftmy $root; 42c2fdda0dSAndy Whitcroftmy %debug; 433445686aSJoe Perchesmy %camelcase = (); 4491bfe484SJoe Perchesmy %use_type = (); 4591bfe484SJoe Perchesmy @use = (); 4691bfe484SJoe Perchesmy %ignore_type = (); 47000d1cc1SJoe Perchesmy @ignore = (); 4877f5b10aSHannes Edermy $help = 0; 49000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 506cd7f386SJoe Perchesmy $max_line_length = 80; 51d62a201fSDave Hansenmy $ignore_perl_version = 0; 52d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 5356193274SVadim Bendeburymy $min_conf_desc_length = 4; 5466b47b4aSKees Cookmy $spelling_file = "$D/spelling.txt"; 55ebfd7d62SJoe Perchesmy $codespell = 0; 56f1a63678SMaxim Uvarovmy $codespellfile = "/usr/share/codespell/dictionary.txt"; 5757230297SJoe Perchesmy $color = 1; 58dadf680dSJoe Perchesmy $allow_c99_comments = 1; 5977f5b10aSHannes Eder 6077f5b10aSHannes Edersub help { 6177f5b10aSHannes Eder my ($exitcode) = @_; 6277f5b10aSHannes Eder 6377f5b10aSHannes Eder print << "EOM"; 6477f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 6577f5b10aSHannes EderVersion: $V 6677f5b10aSHannes Eder 6777f5b10aSHannes EderOptions: 6877f5b10aSHannes Eder -q, --quiet quiet 6977f5b10aSHannes Eder --no-tree run without a kernel tree 7077f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 7177f5b10aSHannes Eder --patch treat FILE as patchfile (default) 7277f5b10aSHannes Eder --emacs emacs compile window format 7377f5b10aSHannes Eder --terse one line per report 7434d8815fSJoe Perches --showfile emit diffed file position, not input file position 754a593c34SDu, Changbin -g, --git treat FILE as a single commit or git revision range 764a593c34SDu, Changbin single git commit with: 774a593c34SDu, Changbin <rev> 784a593c34SDu, Changbin <rev>^ 794a593c34SDu, Changbin <rev>~n 804a593c34SDu, Changbin multiple git commits with: 814a593c34SDu, Changbin <rev1>..<rev2> 824a593c34SDu, Changbin <rev1>...<rev2> 834a593c34SDu, Changbin <rev>-<count> 844a593c34SDu, Changbin git merges are ignored 8577f5b10aSHannes Eder -f, --file treat FILE as regular source file 8677f5b10aSHannes Eder --subjective, --strict enable more subjective tests 873beb42ecSJoe Perches --list-types list the possible message types 8891bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 89000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 903beb42ecSJoe Perches --show-types show the specific message type in the output 916cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 9256193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 9377f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 9477f5b10aSHannes Eder --no-summary suppress the per-file summary 9577f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 9677f5b10aSHannes Eder --summary-file include the filename in summary 9777f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 9877f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 9977f5b10aSHannes Eder is all off) 10077f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 10177f5b10aSHannes Eder literally 1023705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 1033705ce5bSJoe Perches If correctable single-line errors exist, create 1043705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 1053705ce5bSJoe Perches with potential errors corrected to the preferred 1063705ce5bSJoe Perches checkpatch style 1079624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 1089624b8d6SJoe Perches Is the same as --fix, but overwrites the input 1099624b8d6SJoe Perches file. It's your fault if there's no backup or git 110d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 111d62a201fSDave Hansen runtime errors. 112ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 113f1a63678SMaxim Uvarov (default:/usr/share/codespell/dictionary.txt) 114ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 11557230297SJoe Perches --color Use colors when output is STDOUT (default: on) 11677f5b10aSHannes Eder -h, --help, --version display this help and exit 11777f5b10aSHannes Eder 11877f5b10aSHannes EderWhen FILE is - read standard input. 11977f5b10aSHannes EderEOM 12077f5b10aSHannes Eder 12177f5b10aSHannes Eder exit($exitcode); 12277f5b10aSHannes Eder} 12377f5b10aSHannes Eder 1243beb42ecSJoe Perchessub uniq { 1253beb42ecSJoe Perches my %seen; 1263beb42ecSJoe Perches return grep { !$seen{$_}++ } @_; 1273beb42ecSJoe Perches} 1283beb42ecSJoe Perches 1293beb42ecSJoe Perchessub list_types { 1303beb42ecSJoe Perches my ($exitcode) = @_; 1313beb42ecSJoe Perches 1323beb42ecSJoe Perches my $count = 0; 1333beb42ecSJoe Perches 1343beb42ecSJoe Perches local $/ = undef; 1353beb42ecSJoe Perches 1363beb42ecSJoe Perches open(my $script, '<', abs_path($P)) or 1373beb42ecSJoe Perches die "$P: Can't read '$P' $!\n"; 1383beb42ecSJoe Perches 1393beb42ecSJoe Perches my $text = <$script>; 1403beb42ecSJoe Perches close($script); 1413beb42ecSJoe Perches 1423beb42ecSJoe Perches my @types = (); 1433beb42ecSJoe Perches for ($text =~ /\b(?:(?:CHK|WARN|ERROR)\s*\(\s*"([^"]+)")/g) { 1443beb42ecSJoe Perches push (@types, $_); 1453beb42ecSJoe Perches } 1463beb42ecSJoe Perches @types = sort(uniq(@types)); 1473beb42ecSJoe Perches print("#\tMessage type\n\n"); 1483beb42ecSJoe Perches foreach my $type (@types) { 1493beb42ecSJoe Perches print(++$count . "\t" . $type . "\n"); 1503beb42ecSJoe Perches } 1513beb42ecSJoe Perches 1523beb42ecSJoe Perches exit($exitcode); 1533beb42ecSJoe Perches} 1543beb42ecSJoe Perches 155000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 156000d1cc1SJoe Perchesif (-f $conf) { 157000d1cc1SJoe Perches my @conf_args; 158000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 159000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 160000d1cc1SJoe Perches 161000d1cc1SJoe Perches while (<$conffile>) { 162000d1cc1SJoe Perches my $line = $_; 163000d1cc1SJoe Perches 164000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 165000d1cc1SJoe Perches $line =~ s/^\s*//g; 166000d1cc1SJoe Perches $line =~ s/\s+/ /g; 167000d1cc1SJoe Perches 168000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 169000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 170000d1cc1SJoe Perches 171000d1cc1SJoe Perches my @words = split(" ", $line); 172000d1cc1SJoe Perches foreach my $word (@words) { 173000d1cc1SJoe Perches last if ($word =~ m/^#/); 174000d1cc1SJoe Perches push (@conf_args, $word); 175000d1cc1SJoe Perches } 176000d1cc1SJoe Perches } 177000d1cc1SJoe Perches close($conffile); 178000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 179000d1cc1SJoe Perches} 180000d1cc1SJoe Perches 1810a920b5bSAndy WhitcroftGetOptions( 1826c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1830a920b5bSAndy Whitcroft 'tree!' => \$tree, 1840a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1850a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1866c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1878905a67cSAndy Whitcroft 'terse!' => \$terse, 18834d8815fSJoe Perches 'showfile!' => \$showfile, 18977f5b10aSHannes Eder 'f|file!' => \$file, 1904a593c34SDu, Changbin 'g|git!' => \$git, 1916c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1926c72ffaaSAndy Whitcroft 'strict!' => \$check, 193000d1cc1SJoe Perches 'ignore=s' => \@ignore, 19491bfe484SJoe Perches 'types=s' => \@use, 195000d1cc1SJoe Perches 'show-types!' => \$show_types, 1963beb42ecSJoe Perches 'list-types!' => \$list_types, 1976cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 19856193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 1996c72ffaaSAndy Whitcroft 'root=s' => \$root, 2008905a67cSAndy Whitcroft 'summary!' => \$summary, 2018905a67cSAndy Whitcroft 'mailback!' => \$mailback, 20213214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 2033705ce5bSJoe Perches 'fix!' => \$fix, 2049624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 205d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 206c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 207773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 208ebfd7d62SJoe Perches 'codespell!' => \$codespell, 209ebfd7d62SJoe Perches 'codespellfile=s' => \$codespellfile, 21057230297SJoe Perches 'color!' => \$color, 21177f5b10aSHannes Eder 'h|help' => \$help, 21277f5b10aSHannes Eder 'version' => \$help 21377f5b10aSHannes Eder) or help(1); 21477f5b10aSHannes Eder 21577f5b10aSHannes Ederhelp(0) if ($help); 2160a920b5bSAndy Whitcroft 2173beb42ecSJoe Percheslist_types(0) if ($list_types); 2183beb42ecSJoe Perches 2199624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 2202ac73b4fSJoe Perches$check_orig = $check; 2219624b8d6SJoe Perches 2220a920b5bSAndy Whitcroftmy $exit = 0; 2230a920b5bSAndy Whitcroft 224d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 225d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 226d62a201fSDave Hansen if (!$ignore_perl_version) { 227d62a201fSDave Hansen exit(1); 228d62a201fSDave Hansen } 229d62a201fSDave Hansen} 230d62a201fSDave Hansen 2310a920b5bSAndy Whitcroftif ($#ARGV < 0) { 23277f5b10aSHannes Eder print "$P: no input files\n"; 2330a920b5bSAndy Whitcroft exit(1); 2340a920b5bSAndy Whitcroft} 2350a920b5bSAndy Whitcroft 23691bfe484SJoe Perchessub hash_save_array_words { 23791bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 23891bfe484SJoe Perches 23991bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 24091bfe484SJoe Perches foreach my $word (@array) { 241000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 242000d1cc1SJoe Perches $word =~ s/^\s*//g; 243000d1cc1SJoe Perches $word =~ s/\s+/ /g; 244000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 245000d1cc1SJoe Perches 246000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 247000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 248000d1cc1SJoe Perches 24991bfe484SJoe Perches $hashRef->{$word}++; 250000d1cc1SJoe Perches } 25191bfe484SJoe Perches} 25291bfe484SJoe Perches 25391bfe484SJoe Perchessub hash_show_words { 25491bfe484SJoe Perches my ($hashRef, $prefix) = @_; 25591bfe484SJoe Perches 2563c816e49SJoe Perches if (keys %$hashRef) { 257d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 25858cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 25991bfe484SJoe Perches print " $word"; 26091bfe484SJoe Perches } 261d8469f16SJoe Perches print "\n"; 26291bfe484SJoe Perches } 26391bfe484SJoe Perches} 26491bfe484SJoe Perches 26591bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 26691bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 267000d1cc1SJoe Perches 268c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 269c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 2707429c690SAndy Whitcroftmy $dbg_type = 0; 271a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 272c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 27321caa13cSAndy Whitcroft ## no critic 27421caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 27521caa13cSAndy Whitcroft die "$@" if ($@); 276c2fdda0dSAndy Whitcroft} 277c2fdda0dSAndy Whitcroft 278d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 279d2c0a235SAndy Whitcroft 2808905a67cSAndy Whitcroftif ($terse) { 2818905a67cSAndy Whitcroft $emacs = 1; 2828905a67cSAndy Whitcroft $quiet++; 2838905a67cSAndy Whitcroft} 2848905a67cSAndy Whitcroft 2856c72ffaaSAndy Whitcroftif ($tree) { 2866c72ffaaSAndy Whitcroft if (defined $root) { 2876c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 2886c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 2896c72ffaaSAndy Whitcroft } 2906c72ffaaSAndy Whitcroft } else { 2916c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 2926c72ffaaSAndy Whitcroft $root = '.'; 2936c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 2946c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 2956c72ffaaSAndy Whitcroft $root = $1; 2966c72ffaaSAndy Whitcroft } 2976c72ffaaSAndy Whitcroft } 2986c72ffaaSAndy Whitcroft 2996c72ffaaSAndy Whitcroft if (!defined $root) { 3000a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 3010a920b5bSAndy Whitcroft exit(2); 3020a920b5bSAndy Whitcroft } 3036c72ffaaSAndy Whitcroft} 3046c72ffaaSAndy Whitcroft 3056c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 3066c72ffaaSAndy Whitcroft 3072ceb532bSAndy Whitcroftour $Ident = qr{ 3082ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 3092ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 3102ceb532bSAndy Whitcroft }x; 3116c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 3126c72ffaaSAndy Whitcroftour $Sparse = qr{ 3136c72ffaaSAndy Whitcroft __user| 3146c72ffaaSAndy Whitcroft __kernel| 3156c72ffaaSAndy Whitcroft __force| 3166c72ffaaSAndy Whitcroft __iomem| 3176c72ffaaSAndy Whitcroft __must_check| 3186c72ffaaSAndy Whitcroft __init_refok| 319417495edSAndy Whitcroft __kprobes| 320165e72a6SSven Eckelmann __ref| 321ad315455SBoqun Feng __rcu| 322ad315455SBoqun Feng __private 3236c72ffaaSAndy Whitcroft }x; 324e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 325e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 326e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 327e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 328e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 3298716de38SJoe Perches 33052131292SWolfram Sang# Notes to $Attribute: 33152131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 3326c72ffaaSAndy Whitcroftour $Attribute = qr{ 3336c72ffaaSAndy Whitcroft const| 33403f1df7dSJoe Perches __percpu| 33503f1df7dSJoe Perches __nocast| 33603f1df7dSJoe Perches __safe| 33703f1df7dSJoe Perches __bitwise__| 33803f1df7dSJoe Perches __packed__| 33903f1df7dSJoe Perches __packed2__| 34003f1df7dSJoe Perches __naked| 34103f1df7dSJoe Perches __maybe_unused| 34203f1df7dSJoe Perches __always_unused| 34303f1df7dSJoe Perches __noreturn| 34403f1df7dSJoe Perches __used| 34503f1df7dSJoe Perches __cold| 346e23ef1f3SJoe Perches __pure| 34703f1df7dSJoe Perches __noclone| 34803f1df7dSJoe Perches __deprecated| 3496c72ffaaSAndy Whitcroft __read_mostly| 3506c72ffaaSAndy Whitcroft __kprobes| 3518716de38SJoe Perches $InitAttribute| 35224e1d81aSAndy Whitcroft ____cacheline_aligned| 35324e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 3545fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 3555fe3af11SAndy Whitcroft __weak 3566c72ffaaSAndy Whitcroft }x; 357c45dcabdSAndy Whitcroftour $Modifier; 35891cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 3596c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 3606c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 3616c72ffaaSAndy Whitcroft 36295e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 36395e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 36495e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 36595e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 3662435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 367c0a5c898SJoe Perchesour $String = qr{"[X\t]*"}; 368326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 369326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 370326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 37174349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 3722435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 373326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 374447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 37523f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 3766c72ffaaSAndy Whitcroftour $Operators = qr{ 3776c72ffaaSAndy Whitcroft <=|>=|==|!=| 3786c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 37923f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 3806c72ffaaSAndy Whitcroft }x; 3816c72ffaaSAndy Whitcroft 38291cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 38391cb5195SJoe Perches 384ab7e23f3SJoe Perchesour $BasicType; 3858905a67cSAndy Whitcroftour $NonptrType; 3861813087dSJoe Perchesour $NonptrTypeMisordered; 3878716de38SJoe Perchesour $NonptrTypeWithAttr; 3888905a67cSAndy Whitcroftour $Type; 3891813087dSJoe Perchesour $TypeMisordered; 3908905a67cSAndy Whitcroftour $Declare; 3911813087dSJoe Perchesour $DeclareMisordered; 3928905a67cSAndy Whitcroft 39315662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 39415662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 395171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 396171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 397171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 398171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 399171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 400171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 401171ae1a4SAndy Whitcroft}x; 402171ae1a4SAndy Whitcroft 40315662b3eSJoe Perchesour $UTF8 = qr{ 40415662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 40515662b3eSJoe Perches | $NON_ASCII_UTF8 40615662b3eSJoe Perches}x; 40715662b3eSJoe Perches 408e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 409021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 410021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 411021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 412021158b4SJoe Perches)}; 413e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 414fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 4158ed22cadSAndy Whitcroft atomic_t 4168ed22cadSAndy Whitcroft)}; 417e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 418e6176fa4SJoe Perches $typeC99Typedefs\b| 419e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 420e6176fa4SJoe Perches $typeKernelTypedefs\b 421e6176fa4SJoe Perches)}; 4228ed22cadSAndy Whitcroft 4236d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 4246d32f7a3SJoe Perches 425691e669bSJoe Perchesour $logFunctions = qr{(?x: 4266e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 4277d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 4286e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 429b0531722SJoe Perches panic| 43006668727SJoe Perches MODULE_[A-Z_]+| 43106668727SJoe Perches seq_vprintf|seq_printf|seq_puts 432691e669bSJoe Perches)}; 433691e669bSJoe Perches 43420112475SJoe Perchesour $signature_tags = qr{(?xi: 43520112475SJoe Perches Signed-off-by:| 43620112475SJoe Perches Acked-by:| 43720112475SJoe Perches Tested-by:| 43820112475SJoe Perches Reviewed-by:| 43920112475SJoe Perches Reported-by:| 4408543ae12SMugunthan V N Suggested-by:| 44120112475SJoe Perches To:| 44220112475SJoe Perches Cc: 44320112475SJoe Perches)}; 44420112475SJoe Perches 4451813087dSJoe Perchesour @typeListMisordered = ( 4461813087dSJoe Perches qr{char\s+(?:un)?signed}, 4471813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 4481813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 4491813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 4501813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 4511813087dSJoe Perches qr{short\s+(?:un)?signed}, 4521813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 4531813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 4541813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 4551813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 4561813087dSJoe Perches qr{int\s+(?:un)?signed}, 4571813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 4581813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 4591813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 4601813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 4611813087dSJoe Perches qr{long\s+(?:un)?signed}, 4621813087dSJoe Perches); 4631813087dSJoe Perches 4648905a67cSAndy Whitcroftour @typeList = ( 4658905a67cSAndy Whitcroft qr{void}, 4660c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 4670c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 4680c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 4690c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 4700c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 4710c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 4720c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 4730c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 4740c773d9dSJoe Perches qr{(?:un)?signed}, 4758905a67cSAndy Whitcroft qr{float}, 4768905a67cSAndy Whitcroft qr{double}, 4778905a67cSAndy Whitcroft qr{bool}, 4788905a67cSAndy Whitcroft qr{struct\s+$Ident}, 4798905a67cSAndy Whitcroft qr{union\s+$Ident}, 4808905a67cSAndy Whitcroft qr{enum\s+$Ident}, 4818905a67cSAndy Whitcroft qr{${Ident}_t}, 4828905a67cSAndy Whitcroft qr{${Ident}_handler}, 4838905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 4841813087dSJoe Perches @typeListMisordered, 4858905a67cSAndy Whitcroft); 486938224b5SJoe Perches 487938224b5SJoe Perchesour $C90_int_types = qr{(?x: 488938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 489938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 490938224b5SJoe Perches long\s+long\s+(?:un)?signed| 491938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 492938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 493938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 494938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 495938224b5SJoe Perches 496938224b5SJoe Perches long\s+int\s+(?:un)?signed| 497938224b5SJoe Perches long\s+(?:un)?signed\s+int| 498938224b5SJoe Perches long\s+(?:un)?signed| 499938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 500938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 501938224b5SJoe Perches int\s+long\s+(?:un)?signed| 502938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 503938224b5SJoe Perches 504938224b5SJoe Perches int\s+(?:un)?signed| 505938224b5SJoe Perches (?:(?:un)?signed\s+)?int 506938224b5SJoe Perches)}; 507938224b5SJoe Perches 508485ff23eSAlex Dowadour @typeListFile = (); 5098716de38SJoe Perchesour @typeListWithAttr = ( 5108716de38SJoe Perches @typeList, 5118716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 5128716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 5138716de38SJoe Perches); 5148716de38SJoe Perches 515c45dcabdSAndy Whitcroftour @modifierList = ( 516c45dcabdSAndy Whitcroft qr{fastcall}, 517c45dcabdSAndy Whitcroft); 518485ff23eSAlex Dowadour @modifierListFile = (); 5198905a67cSAndy Whitcroft 5202435880fSJoe Perchesour @mode_permission_funcs = ( 5212435880fSJoe Perches ["module_param", 3], 5222435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 5232435880fSJoe Perches ["module_param_array_named", 5], 5242435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 5252435880fSJoe Perches ["proc_create(?:_data|)", 2], 5262435880fSJoe Perches ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2], 5272435880fSJoe Perches); 5282435880fSJoe Perches 529515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 530515a235eSJoe Perchesour $mode_perms_search = ""; 531515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 532515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 533515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 534515a235eSJoe Perches} 535515a235eSJoe Perches 536b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 537b392c64fSJoe Perches S_IWUGO | 538b392c64fSJoe Perches S_IWOTH | 539b392c64fSJoe Perches S_IRWXUGO | 540b392c64fSJoe Perches S_IALLUGO | 541b392c64fSJoe Perches 0[0-7][0-7][2367] 542b392c64fSJoe Perches}x; 543b392c64fSJoe Perches 5447840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 5457840a94cSWolfram Sang irq| 546cdcee686SSergey Ryazanov memory| 547cdcee686SSergey Ryazanov time| 548cdcee686SSergey Ryazanov reboot 5497840a94cSWolfram Sang)}; 5507840a94cSWolfram Sang# memory.h: ARM has a custom one 5517840a94cSWolfram Sang 55266b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 55366b47b4aSKees Cookmy $misspellings; 55466b47b4aSKees Cookmy %spelling_fix; 55536061e38SJoe Perches 55636061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 55766b47b4aSKees Cook while (<$spelling>) { 55866b47b4aSKees Cook my $line = $_; 55966b47b4aSKees Cook 56066b47b4aSKees Cook $line =~ s/\s*\n?$//g; 56166b47b4aSKees Cook $line =~ s/^\s*//g; 56266b47b4aSKees Cook 56366b47b4aSKees Cook next if ($line =~ m/^\s*#/); 56466b47b4aSKees Cook next if ($line =~ m/^\s*$/); 56566b47b4aSKees Cook 56666b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 56766b47b4aSKees Cook 56866b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 56966b47b4aSKees Cook } 57066b47b4aSKees Cook close($spelling); 57136061e38SJoe Perches} else { 57236061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 57336061e38SJoe Perches} 57466b47b4aSKees Cook 575ebfd7d62SJoe Perchesif ($codespell) { 576ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 577ebfd7d62SJoe Perches while (<$spelling>) { 578ebfd7d62SJoe Perches my $line = $_; 579ebfd7d62SJoe Perches 580ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 581ebfd7d62SJoe Perches $line =~ s/^\s*//g; 582ebfd7d62SJoe Perches 583ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 584ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 585ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 586ebfd7d62SJoe Perches 587ebfd7d62SJoe Perches $line =~ s/,.*$//; 588ebfd7d62SJoe Perches 589ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 590ebfd7d62SJoe Perches 591ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 592ebfd7d62SJoe Perches } 593ebfd7d62SJoe Perches close($spelling); 594ebfd7d62SJoe Perches } else { 595ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 596ebfd7d62SJoe Perches } 597ebfd7d62SJoe Perches} 598ebfd7d62SJoe Perches 599ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 600ebfd7d62SJoe Perches 6018905a67cSAndy Whitcroftsub build_types { 602485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 603485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 6041813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 6058716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 606c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 607ab7e23f3SJoe Perches $BasicType = qr{ 608ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 609ab7e23f3SJoe Perches (?:${all}\b) 610ab7e23f3SJoe Perches }x; 6118905a67cSAndy Whitcroft $NonptrType = qr{ 612d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 613cf655043SAndy Whitcroft (?: 6146b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 6158ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 616c45dcabdSAndy Whitcroft (?:${all}\b) 617cf655043SAndy Whitcroft ) 618c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 6198905a67cSAndy Whitcroft }x; 6201813087dSJoe Perches $NonptrTypeMisordered = qr{ 6211813087dSJoe Perches (?:$Modifier\s+|const\s+)* 6221813087dSJoe Perches (?: 6231813087dSJoe Perches (?:${Misordered}\b) 6241813087dSJoe Perches ) 6251813087dSJoe Perches (?:\s+$Modifier|\s+const)* 6261813087dSJoe Perches }x; 6278716de38SJoe Perches $NonptrTypeWithAttr = qr{ 6288716de38SJoe Perches (?:$Modifier\s+|const\s+)* 6298716de38SJoe Perches (?: 6308716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 6318716de38SJoe Perches (?:$typeTypedefs\b)| 6328716de38SJoe Perches (?:${allWithAttr}\b) 6338716de38SJoe Perches ) 6348716de38SJoe Perches (?:\s+$Modifier|\s+const)* 6358716de38SJoe Perches }x; 6368905a67cSAndy Whitcroft $Type = qr{ 637c45dcabdSAndy Whitcroft $NonptrType 6381574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 639c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 6408905a67cSAndy Whitcroft }x; 6411813087dSJoe Perches $TypeMisordered = qr{ 6421813087dSJoe Perches $NonptrTypeMisordered 6431813087dSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 6441813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 6451813087dSJoe Perches }x; 64691cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 6471813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 6488905a67cSAndy Whitcroft} 6498905a67cSAndy Whitcroftbuild_types(); 6506c72ffaaSAndy Whitcroft 6517d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 652d1fe9c09SJoe Perches 653d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 654d1fe9c09SJoe Perches# requires at least perl version v5.10.0 655d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 656d1fe9c09SJoe Perches 657d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 6582435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 659c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 6607d2367afSJoe Perches 661f8422308SJoe Perchesour $declaration_macros = qr{(?x: 6623e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 663f8422308SJoe Perches (?:$Storage\s+)?LIST_HEAD\s*\(| 664f8422308SJoe Perches (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\( 665f8422308SJoe Perches)}; 666f8422308SJoe Perches 6677d2367afSJoe Perchessub deparenthesize { 6687d2367afSJoe Perches my ($string) = @_; 6697d2367afSJoe Perches return "" if (!defined($string)); 6705b9553abSJoe Perches 6715b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 6725b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 6735b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 6745b9553abSJoe Perches } 6755b9553abSJoe Perches 6767d2367afSJoe Perches $string =~ s@\s+@ @g; 6775b9553abSJoe Perches 6787d2367afSJoe Perches return $string; 6797d2367afSJoe Perches} 6807d2367afSJoe Perches 6813445686aSJoe Perchessub seed_camelcase_file { 6823445686aSJoe Perches my ($file) = @_; 6833445686aSJoe Perches 6843445686aSJoe Perches return if (!(-f $file)); 6853445686aSJoe Perches 6863445686aSJoe Perches local $/; 6873445686aSJoe Perches 6883445686aSJoe Perches open(my $include_file, '<', "$file") 6893445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 6903445686aSJoe Perches my $text = <$include_file>; 6913445686aSJoe Perches close($include_file); 6923445686aSJoe Perches 6933445686aSJoe Perches my @lines = split('\n', $text); 6943445686aSJoe Perches 6953445686aSJoe Perches foreach my $line (@lines) { 6963445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 6973445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 6983445686aSJoe Perches $camelcase{$1} = 1; 69911ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 70011ea516aSJoe Perches $camelcase{$1} = 1; 70111ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 7023445686aSJoe Perches $camelcase{$1} = 1; 7033445686aSJoe Perches } 7043445686aSJoe Perches } 7053445686aSJoe Perches} 7063445686aSJoe Perches 7073445686aSJoe Perchesmy $camelcase_seeded = 0; 7083445686aSJoe Perchessub seed_camelcase_includes { 7093445686aSJoe Perches return if ($camelcase_seeded); 7103445686aSJoe Perches 7113445686aSJoe Perches my $files; 712c707a81dSJoe Perches my $camelcase_cache = ""; 713c707a81dSJoe Perches my @include_files = (); 714c707a81dSJoe Perches 715c707a81dSJoe Perches $camelcase_seeded = 1; 716351b2a1fSJoe Perches 7173645e328SRichard Genoud if (-e ".git") { 718351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 719351b2a1fSJoe Perches chomp $git_last_include_commit; 720c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 721c707a81dSJoe Perches } else { 722c707a81dSJoe Perches my $last_mod_date = 0; 723c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 724c707a81dSJoe Perches @include_files = split('\n', $files); 725c707a81dSJoe Perches foreach my $file (@include_files) { 726c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 727c707a81dSJoe Perches localtime((stat $file)[9])); 728c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 729c707a81dSJoe Perches } 730c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 731c707a81dSJoe Perches } 732c707a81dSJoe Perches 733c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 734c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 735c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 736351b2a1fSJoe Perches while (<$camelcase_file>) { 737351b2a1fSJoe Perches chomp; 738351b2a1fSJoe Perches $camelcase{$_} = 1; 739351b2a1fSJoe Perches } 740351b2a1fSJoe Perches close($camelcase_file); 741351b2a1fSJoe Perches 742351b2a1fSJoe Perches return; 743351b2a1fSJoe Perches } 744c707a81dSJoe Perches 7453645e328SRichard Genoud if (-e ".git") { 746c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 747c707a81dSJoe Perches @include_files = split('\n', $files); 7483445686aSJoe Perches } 749c707a81dSJoe Perches 7503445686aSJoe Perches foreach my $file (@include_files) { 7513445686aSJoe Perches seed_camelcase_file($file); 7523445686aSJoe Perches } 753351b2a1fSJoe Perches 754c707a81dSJoe Perches if ($camelcase_cache ne "") { 755351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 756c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 757c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 758351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 759351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 760351b2a1fSJoe Perches } 761351b2a1fSJoe Perches close($camelcase_file); 762351b2a1fSJoe Perches } 7633445686aSJoe Perches} 7643445686aSJoe Perches 765d311cd44SJoe Perchessub git_commit_info { 766d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 767d311cd44SJoe Perches 768d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 769d311cd44SJoe Perches 770d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 771d311cd44SJoe Perches $output =~ s/^\s*//gm; 772d311cd44SJoe Perches my @lines = split("\n", $output); 773d311cd44SJoe Perches 7740d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 7750d7835fcSJoe Perches 776d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 777d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 778d311cd44SJoe Perches# all matching commit ids, but it's very slow... 779d311cd44SJoe Perches# 780d311cd44SJoe Perches# echo "checking commits $1..." 781d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 782d311cd44SJoe Perches# while read line ; do 783d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 784d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 785d311cd44SJoe Perches# done 786d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 787d311cd44SJoe Perches } else { 788d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 789d311cd44SJoe Perches $desc = substr($lines[0], 41); 790d311cd44SJoe Perches } 791d311cd44SJoe Perches 792d311cd44SJoe Perches return ($id, $desc); 793d311cd44SJoe Perches} 794d311cd44SJoe Perches 7956c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 7960a920b5bSAndy Whitcroft 79700df344fSAndy Whitcroftmy @rawlines = (); 798c2fdda0dSAndy Whitcroftmy @lines = (); 7993705ce5bSJoe Perchesmy @fixed = (); 800d752fcc8SJoe Perchesmy @fixed_inserted = (); 801d752fcc8SJoe Perchesmy @fixed_deleted = (); 802194f66fcSJoe Perchesmy $fixlinenr = -1; 803194f66fcSJoe Perches 8044a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 8054a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 8064a593c34SDu, Changbindie "$P: No git repository found\n" if ($git && !-e ".git"); 8074a593c34SDu, Changbin 8084a593c34SDu, Changbinif ($git) { 8094a593c34SDu, Changbin my @commits = (); 8100dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 8114a593c34SDu, Changbin my $git_range; 81228898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 81328898fd1SJoe Perches $git_range = "-$2 $1"; 8144a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 8154a593c34SDu, Changbin $git_range = "$commit_expr"; 8164a593c34SDu, Changbin } else { 8170dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 8180dea9f1eSJoe Perches } 8190dea9f1eSJoe Perches my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 8200dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 82128898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 82228898fd1SJoe Perches next if (!defined($1) || !defined($2)); 8230dea9f1eSJoe Perches my $sha1 = $1; 8240dea9f1eSJoe Perches my $subject = $2; 8250dea9f1eSJoe Perches unshift(@commits, $sha1); 8260dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 8274a593c34SDu, Changbin } 8284a593c34SDu, Changbin } 8294a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 8304a593c34SDu, Changbin @ARGV = @commits; 8314a593c34SDu, Changbin} 8324a593c34SDu, Changbin 833c2fdda0dSAndy Whitcroftmy $vname; 8346c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 83521caa13cSAndy Whitcroft my $FILE; 8364a593c34SDu, Changbin if ($git) { 8374a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 8384a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 8394a593c34SDu, Changbin } elsif ($file) { 84021caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 8416c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 84221caa13cSAndy Whitcroft } elsif ($filename eq '-') { 84321caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 8446c72ffaaSAndy Whitcroft } else { 84521caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 8466c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 8476c72ffaaSAndy Whitcroft } 848c2fdda0dSAndy Whitcroft if ($filename eq '-') { 849c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 8504a593c34SDu, Changbin } elsif ($git) { 8510dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 852c2fdda0dSAndy Whitcroft } else { 853c2fdda0dSAndy Whitcroft $vname = $filename; 854c2fdda0dSAndy Whitcroft } 85521caa13cSAndy Whitcroft while (<$FILE>) { 8560a920b5bSAndy Whitcroft chomp; 85700df344fSAndy Whitcroft push(@rawlines, $_); 8586c72ffaaSAndy Whitcroft } 85921caa13cSAndy Whitcroft close($FILE); 860d8469f16SJoe Perches 861d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 862d8469f16SJoe Perches print '-' x length($vname) . "\n"; 863d8469f16SJoe Perches print "$vname\n"; 864d8469f16SJoe Perches print '-' x length($vname) . "\n"; 865d8469f16SJoe Perches } 866d8469f16SJoe Perches 867c2fdda0dSAndy Whitcroft if (!process($filename)) { 8680a920b5bSAndy Whitcroft $exit = 1; 8690a920b5bSAndy Whitcroft } 87000df344fSAndy Whitcroft @rawlines = (); 87113214adfSAndy Whitcroft @lines = (); 8723705ce5bSJoe Perches @fixed = (); 873d752fcc8SJoe Perches @fixed_inserted = (); 874d752fcc8SJoe Perches @fixed_deleted = (); 875194f66fcSJoe Perches $fixlinenr = -1; 876485ff23eSAlex Dowad @modifierListFile = (); 877485ff23eSAlex Dowad @typeListFile = (); 878485ff23eSAlex Dowad build_types(); 8790a920b5bSAndy Whitcroft} 8800a920b5bSAndy Whitcroft 881d8469f16SJoe Perchesif (!$quiet) { 8823c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 8833c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 8843c816e49SJoe Perches 885d8469f16SJoe Perches if ($^V lt 5.10.0) { 886d8469f16SJoe Perches print << "EOM" 887d8469f16SJoe Perches 888d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 889d8469f16SJoe Perches An upgrade to at least perl v5.10.0 is suggested. 890d8469f16SJoe PerchesEOM 891d8469f16SJoe Perches } 892d8469f16SJoe Perches if ($exit) { 893d8469f16SJoe Perches print << "EOM" 894d8469f16SJoe Perches 895d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 896d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 897d8469f16SJoe PerchesEOM 898d8469f16SJoe Perches } 899d8469f16SJoe Perches} 900d8469f16SJoe Perches 9010a920b5bSAndy Whitcroftexit($exit); 9020a920b5bSAndy Whitcroft 9030a920b5bSAndy Whitcroftsub top_of_kernel_tree { 9046c72ffaaSAndy Whitcroft my ($root) = @_; 9056c72ffaaSAndy Whitcroft 9066c72ffaaSAndy Whitcroft my @tree_check = ( 9076c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 9086c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 9096c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 9106c72ffaaSAndy Whitcroft ); 9116c72ffaaSAndy Whitcroft 9126c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 9136c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 9140a920b5bSAndy Whitcroft return 0; 9150a920b5bSAndy Whitcroft } 9166c72ffaaSAndy Whitcroft } 9176c72ffaaSAndy Whitcroft return 1; 9186c72ffaaSAndy Whitcroft} 9190a920b5bSAndy Whitcroft 92020112475SJoe Perchessub parse_email { 92120112475SJoe Perches my ($formatted_email) = @_; 92220112475SJoe Perches 92320112475SJoe Perches my $name = ""; 92420112475SJoe Perches my $address = ""; 92520112475SJoe Perches my $comment = ""; 92620112475SJoe Perches 92720112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 92820112475SJoe Perches $name = $1; 92920112475SJoe Perches $address = $2; 93020112475SJoe Perches $comment = $3 if defined $3; 93120112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 93220112475SJoe Perches $address = $1; 93320112475SJoe Perches $comment = $2 if defined $2; 93420112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 93520112475SJoe Perches $address = $1; 93620112475SJoe Perches $comment = $2 if defined $2; 93720112475SJoe Perches $formatted_email =~ s/$address.*$//; 93820112475SJoe Perches $name = $formatted_email; 9393705ce5bSJoe Perches $name = trim($name); 94020112475SJoe Perches $name =~ s/^\"|\"$//g; 94120112475SJoe Perches # If there's a name left after stripping spaces and 94220112475SJoe Perches # leading quotes, and the address doesn't have both 94320112475SJoe Perches # leading and trailing angle brackets, the address 94420112475SJoe Perches # is invalid. ie: 94520112475SJoe Perches # "joe smith [email protected]" bad 94620112475SJoe Perches # "joe smith <[email protected]" bad 94720112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 94820112475SJoe Perches $name = ""; 94920112475SJoe Perches $address = ""; 95020112475SJoe Perches $comment = ""; 95120112475SJoe Perches } 95220112475SJoe Perches } 95320112475SJoe Perches 9543705ce5bSJoe Perches $name = trim($name); 95520112475SJoe Perches $name =~ s/^\"|\"$//g; 9563705ce5bSJoe Perches $address = trim($address); 95720112475SJoe Perches $address =~ s/^\<|\>$//g; 95820112475SJoe Perches 95920112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 96020112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 96120112475SJoe Perches $name = "\"$name\""; 96220112475SJoe Perches } 96320112475SJoe Perches 96420112475SJoe Perches return ($name, $address, $comment); 96520112475SJoe Perches} 96620112475SJoe Perches 96720112475SJoe Perchessub format_email { 96820112475SJoe Perches my ($name, $address) = @_; 96920112475SJoe Perches 97020112475SJoe Perches my $formatted_email; 97120112475SJoe Perches 9723705ce5bSJoe Perches $name = trim($name); 97320112475SJoe Perches $name =~ s/^\"|\"$//g; 9743705ce5bSJoe Perches $address = trim($address); 97520112475SJoe Perches 97620112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 97720112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 97820112475SJoe Perches $name = "\"$name\""; 97920112475SJoe Perches } 98020112475SJoe Perches 98120112475SJoe Perches if ("$name" eq "") { 98220112475SJoe Perches $formatted_email = "$address"; 98320112475SJoe Perches } else { 98420112475SJoe Perches $formatted_email = "$name <$address>"; 98520112475SJoe Perches } 98620112475SJoe Perches 98720112475SJoe Perches return $formatted_email; 98820112475SJoe Perches} 98920112475SJoe Perches 990d311cd44SJoe Perchessub which { 991d311cd44SJoe Perches my ($bin) = @_; 992d311cd44SJoe Perches 993d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 994d311cd44SJoe Perches if (-e "$path/$bin") { 995d311cd44SJoe Perches return "$path/$bin"; 996d311cd44SJoe Perches } 997d311cd44SJoe Perches } 998d311cd44SJoe Perches 999d311cd44SJoe Perches return ""; 1000d311cd44SJoe Perches} 1001d311cd44SJoe Perches 1002000d1cc1SJoe Perchessub which_conf { 1003000d1cc1SJoe Perches my ($conf) = @_; 1004000d1cc1SJoe Perches 1005000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1006000d1cc1SJoe Perches if (-e "$path/$conf") { 1007000d1cc1SJoe Perches return "$path/$conf"; 1008000d1cc1SJoe Perches } 1009000d1cc1SJoe Perches } 1010000d1cc1SJoe Perches 1011000d1cc1SJoe Perches return ""; 1012000d1cc1SJoe Perches} 1013000d1cc1SJoe Perches 10140a920b5bSAndy Whitcroftsub expand_tabs { 10150a920b5bSAndy Whitcroft my ($str) = @_; 10160a920b5bSAndy Whitcroft 10170a920b5bSAndy Whitcroft my $res = ''; 10180a920b5bSAndy Whitcroft my $n = 0; 10190a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 10200a920b5bSAndy Whitcroft if ($c eq "\t") { 10210a920b5bSAndy Whitcroft $res .= ' '; 10220a920b5bSAndy Whitcroft $n++; 10230a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 10240a920b5bSAndy Whitcroft $res .= ' '; 10250a920b5bSAndy Whitcroft } 10260a920b5bSAndy Whitcroft next; 10270a920b5bSAndy Whitcroft } 10280a920b5bSAndy Whitcroft $res .= $c; 10290a920b5bSAndy Whitcroft $n++; 10300a920b5bSAndy Whitcroft } 10310a920b5bSAndy Whitcroft 10320a920b5bSAndy Whitcroft return $res; 10330a920b5bSAndy Whitcroft} 10346c72ffaaSAndy Whitcroftsub copy_spacing { 1035773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 10366c72ffaaSAndy Whitcroft return $res; 10376c72ffaaSAndy Whitcroft} 10380a920b5bSAndy Whitcroft 10394a0df2efSAndy Whitcroftsub line_stats { 10404a0df2efSAndy Whitcroft my ($line) = @_; 10414a0df2efSAndy Whitcroft 10424a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 10434a0df2efSAndy Whitcroft $line =~ s/^.//; 10444a0df2efSAndy Whitcroft $line = expand_tabs($line); 10454a0df2efSAndy Whitcroft 10464a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 10474a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 10484a0df2efSAndy Whitcroft 10494a0df2efSAndy Whitcroft return (length($line), length($white)); 10504a0df2efSAndy Whitcroft} 10514a0df2efSAndy Whitcroft 1052773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1053773647a0SAndy Whitcroft 1054773647a0SAndy Whitcroftsub sanitise_line_reset { 1055773647a0SAndy Whitcroft my ($in_comment) = @_; 1056773647a0SAndy Whitcroft 1057773647a0SAndy Whitcroft if ($in_comment) { 1058773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1059773647a0SAndy Whitcroft } else { 1060773647a0SAndy Whitcroft $sanitise_quote = ''; 1061773647a0SAndy Whitcroft } 1062773647a0SAndy Whitcroft} 106300df344fSAndy Whitcroftsub sanitise_line { 106400df344fSAndy Whitcroft my ($line) = @_; 106500df344fSAndy Whitcroft 106600df344fSAndy Whitcroft my $res = ''; 106700df344fSAndy Whitcroft my $l = ''; 106800df344fSAndy Whitcroft 1069c2fdda0dSAndy Whitcroft my $qlen = 0; 1070773647a0SAndy Whitcroft my $off = 0; 1071773647a0SAndy Whitcroft my $c; 107200df344fSAndy Whitcroft 1073773647a0SAndy Whitcroft # Always copy over the diff marker. 1074773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1075773647a0SAndy Whitcroft 1076773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1077773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1078773647a0SAndy Whitcroft 1079773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 1080773647a0SAndy Whitcroft # and end, all to $;. 1081773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1082773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1083773647a0SAndy Whitcroft 1084773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1085773647a0SAndy Whitcroft $off++; 108600df344fSAndy Whitcroft next; 1087773647a0SAndy Whitcroft } 108881bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1089773647a0SAndy Whitcroft $sanitise_quote = ''; 1090773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1091773647a0SAndy Whitcroft $off++; 1092773647a0SAndy Whitcroft next; 1093773647a0SAndy Whitcroft } 1094113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1095113f04a8SDaniel Walker $sanitise_quote = '//'; 1096113f04a8SDaniel Walker 1097113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1098113f04a8SDaniel Walker $off++; 1099113f04a8SDaniel Walker next; 1100113f04a8SDaniel Walker } 1101773647a0SAndy Whitcroft 1102773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1103773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1104773647a0SAndy Whitcroft $c eq "\\") { 1105773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1106773647a0SAndy Whitcroft $off++; 1107773647a0SAndy Whitcroft next; 1108773647a0SAndy Whitcroft } 1109773647a0SAndy Whitcroft # Regular quotes. 1110773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1111773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1112773647a0SAndy Whitcroft $sanitise_quote = $c; 1113773647a0SAndy Whitcroft 1114773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1115773647a0SAndy Whitcroft next; 1116773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1117773647a0SAndy Whitcroft $sanitise_quote = ''; 111800df344fSAndy Whitcroft } 111900df344fSAndy Whitcroft } 1120773647a0SAndy Whitcroft 1121fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1122773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1123773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1124113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1125113f04a8SDaniel Walker substr($res, $off, 1, $;); 1126773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1127773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 112800df344fSAndy Whitcroft } else { 1129773647a0SAndy Whitcroft substr($res, $off, 1, $c); 113000df344fSAndy Whitcroft } 1131c2fdda0dSAndy Whitcroft } 1132c2fdda0dSAndy Whitcroft 1133113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1134113f04a8SDaniel Walker $sanitise_quote = ''; 1135113f04a8SDaniel Walker } 1136113f04a8SDaniel Walker 1137c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1138c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1139c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1140c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1141c2fdda0dSAndy Whitcroft 1142c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1143c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1144c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1145c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1146c2fdda0dSAndy Whitcroft } 1147c2fdda0dSAndy Whitcroft 1148dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1149dadf680dSJoe Perches my $match = $1; 1150dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1151dadf680dSJoe Perches } 1152dadf680dSJoe Perches 115300df344fSAndy Whitcroft return $res; 115400df344fSAndy Whitcroft} 115500df344fSAndy Whitcroft 1156a6962d72SJoe Perchessub get_quoted_string { 1157a6962d72SJoe Perches my ($line, $rawline) = @_; 1158a6962d72SJoe Perches 115933acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1160a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1161a6962d72SJoe Perches} 1162a6962d72SJoe Perches 11638905a67cSAndy Whitcroftsub ctx_statement_block { 11648905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 11658905a67cSAndy Whitcroft my $line = $linenr - 1; 11668905a67cSAndy Whitcroft my $blk = ''; 11678905a67cSAndy Whitcroft my $soff = $off; 11688905a67cSAndy Whitcroft my $coff = $off - 1; 1169773647a0SAndy Whitcroft my $coff_set = 0; 11708905a67cSAndy Whitcroft 117113214adfSAndy Whitcroft my $loff = 0; 117213214adfSAndy Whitcroft 11738905a67cSAndy Whitcroft my $type = ''; 11748905a67cSAndy Whitcroft my $level = 0; 1175a2750645SAndy Whitcroft my @stack = (); 1176cf655043SAndy Whitcroft my $p; 11778905a67cSAndy Whitcroft my $c; 11788905a67cSAndy Whitcroft my $len = 0; 117913214adfSAndy Whitcroft 118013214adfSAndy Whitcroft my $remainder; 11818905a67cSAndy Whitcroft while (1) { 1182a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1183a2750645SAndy Whitcroft 1184773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 11858905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 11868905a67cSAndy Whitcroft # context. 11878905a67cSAndy Whitcroft if ($off >= $len) { 11888905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1189dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1190c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 11918905a67cSAndy Whitcroft $remain--; 119213214adfSAndy Whitcroft $loff = $len; 1193c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 11948905a67cSAndy Whitcroft $len = length($blk); 11958905a67cSAndy Whitcroft $line++; 11968905a67cSAndy Whitcroft last; 11978905a67cSAndy Whitcroft } 11988905a67cSAndy Whitcroft # Bail if there is no further context. 11998905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 120013214adfSAndy Whitcroft if ($off >= $len) { 12018905a67cSAndy Whitcroft last; 12028905a67cSAndy Whitcroft } 1203f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1204f74bd194SAndy Whitcroft $level++; 1205f74bd194SAndy Whitcroft $type = '#'; 1206f74bd194SAndy Whitcroft } 12078905a67cSAndy Whitcroft } 1208cf655043SAndy Whitcroft $p = $c; 12098905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 121013214adfSAndy Whitcroft $remainder = substr($blk, $off); 12118905a67cSAndy Whitcroft 1212773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 12134635f4fbSAndy Whitcroft 12144635f4fbSAndy Whitcroft # Handle nested #if/#else. 12154635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 12164635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 12174635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 12184635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 12194635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 12204635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 12214635f4fbSAndy Whitcroft } 12224635f4fbSAndy Whitcroft 12238905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 12248905a67cSAndy Whitcroft # outermost level. 12258905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 12268905a67cSAndy Whitcroft last; 12278905a67cSAndy Whitcroft } 12288905a67cSAndy Whitcroft 122913214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1230773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1231773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1232773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1233773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1234773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1235773647a0SAndy Whitcroft $coff_set = 1; 1236773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1237773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 123813214adfSAndy Whitcroft } 123913214adfSAndy Whitcroft 12408905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 12418905a67cSAndy Whitcroft $level++; 12428905a67cSAndy Whitcroft $type = '('; 12438905a67cSAndy Whitcroft } 12448905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 12458905a67cSAndy Whitcroft $level--; 12468905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 12478905a67cSAndy Whitcroft 12488905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 12498905a67cSAndy Whitcroft $coff = $off; 1250773647a0SAndy Whitcroft $coff_set = 1; 1251773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 12528905a67cSAndy Whitcroft } 12538905a67cSAndy Whitcroft } 12548905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 12558905a67cSAndy Whitcroft $level++; 12568905a67cSAndy Whitcroft $type = '{'; 12578905a67cSAndy Whitcroft } 12588905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 12598905a67cSAndy Whitcroft $level--; 12608905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 12618905a67cSAndy Whitcroft 12628905a67cSAndy Whitcroft if ($level == 0) { 1263b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1264b998e001SPatrick Pannuto $off++; 1265b998e001SPatrick Pannuto } 12668905a67cSAndy Whitcroft last; 12678905a67cSAndy Whitcroft } 12688905a67cSAndy Whitcroft } 1269f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1270f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1271f74bd194SAndy Whitcroft $level--; 1272f74bd194SAndy Whitcroft $type = ''; 1273f74bd194SAndy Whitcroft $off++; 1274f74bd194SAndy Whitcroft last; 1275f74bd194SAndy Whitcroft } 12768905a67cSAndy Whitcroft $off++; 12778905a67cSAndy Whitcroft } 1278a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 127913214adfSAndy Whitcroft if ($off == $len) { 1280a3bb97a7SAndy Whitcroft $loff = $len + 1; 128113214adfSAndy Whitcroft $line++; 128213214adfSAndy Whitcroft $remain--; 128313214adfSAndy Whitcroft } 12848905a67cSAndy Whitcroft 12858905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 12868905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 12878905a67cSAndy Whitcroft 12888905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 12898905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 12908905a67cSAndy Whitcroft 1291773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 129213214adfSAndy Whitcroft 129313214adfSAndy Whitcroft return ($statement, $condition, 129413214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 129513214adfSAndy Whitcroft} 129613214adfSAndy Whitcroft 1297cf655043SAndy Whitcroftsub statement_lines { 1298cf655043SAndy Whitcroft my ($stmt) = @_; 1299cf655043SAndy Whitcroft 1300cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1301cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1302cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1303cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1304cf655043SAndy Whitcroft 1305cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1306cf655043SAndy Whitcroft 1307cf655043SAndy Whitcroft return $#stmt_lines + 2; 1308cf655043SAndy Whitcroft} 1309cf655043SAndy Whitcroft 1310cf655043SAndy Whitcroftsub statement_rawlines { 1311cf655043SAndy Whitcroft my ($stmt) = @_; 1312cf655043SAndy Whitcroft 1313cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1314cf655043SAndy Whitcroft 1315cf655043SAndy Whitcroft return $#stmt_lines + 2; 1316cf655043SAndy Whitcroft} 1317cf655043SAndy Whitcroft 1318cf655043SAndy Whitcroftsub statement_block_size { 1319cf655043SAndy Whitcroft my ($stmt) = @_; 1320cf655043SAndy Whitcroft 1321cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1322cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1323cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1324cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1325cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1326cf655043SAndy Whitcroft 1327cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1328cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1329cf655043SAndy Whitcroft 1330cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1331cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1332cf655043SAndy Whitcroft 1333cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1334cf655043SAndy Whitcroft return $stmt_lines; 1335cf655043SAndy Whitcroft } else { 1336cf655043SAndy Whitcroft return $stmt_statements; 1337cf655043SAndy Whitcroft } 1338cf655043SAndy Whitcroft} 1339cf655043SAndy Whitcroft 134013214adfSAndy Whitcroftsub ctx_statement_full { 134113214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 134213214adfSAndy Whitcroft my ($statement, $condition, $level); 134313214adfSAndy Whitcroft 134413214adfSAndy Whitcroft my (@chunks); 134513214adfSAndy Whitcroft 1346cf655043SAndy Whitcroft # Grab the first conditional/block pair. 134713214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 134813214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1349773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 135013214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1351cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1352cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1353cf655043SAndy Whitcroft } 1354cf655043SAndy Whitcroft 1355cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1356cf655043SAndy Whitcroft # could continue the statement. 1357cf655043SAndy Whitcroft for (;;) { 135813214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 135913214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1360cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1361773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1362cf655043SAndy Whitcroft #print "C: push\n"; 1363cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 136413214adfSAndy Whitcroft } 136513214adfSAndy Whitcroft 136613214adfSAndy Whitcroft return ($level, $linenr, @chunks); 13678905a67cSAndy Whitcroft} 13688905a67cSAndy Whitcroft 13694a0df2efSAndy Whitcroftsub ctx_block_get { 1370f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 13714a0df2efSAndy Whitcroft my $line; 13724a0df2efSAndy Whitcroft my $start = $linenr - 1; 13734a0df2efSAndy Whitcroft my $blk = ''; 13744a0df2efSAndy Whitcroft my @o; 13754a0df2efSAndy Whitcroft my @c; 13764a0df2efSAndy Whitcroft my @res = (); 13774a0df2efSAndy Whitcroft 1378f0a594c1SAndy Whitcroft my $level = 0; 13794635f4fbSAndy Whitcroft my @stack = ($level); 138000df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 138100df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 138200df344fSAndy Whitcroft $remain--; 138300df344fSAndy Whitcroft 138400df344fSAndy Whitcroft $blk .= $rawlines[$line]; 13854635f4fbSAndy Whitcroft 13864635f4fbSAndy Whitcroft # Handle nested #if/#else. 138701464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 13884635f4fbSAndy Whitcroft push(@stack, $level); 138901464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 13904635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 139101464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 13924635f4fbSAndy Whitcroft $level = pop(@stack); 13934635f4fbSAndy Whitcroft } 13944635f4fbSAndy Whitcroft 139501464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1396f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1397f0a594c1SAndy Whitcroft if ($off > 0) { 1398f0a594c1SAndy Whitcroft $off--; 1399f0a594c1SAndy Whitcroft next; 1400f0a594c1SAndy Whitcroft } 14014a0df2efSAndy Whitcroft 1402f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1403f0a594c1SAndy Whitcroft $level--; 1404f0a594c1SAndy Whitcroft last if ($level == 0); 1405f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1406f0a594c1SAndy Whitcroft $level++; 1407f0a594c1SAndy Whitcroft } 1408f0a594c1SAndy Whitcroft } 14094a0df2efSAndy Whitcroft 1410f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 141100df344fSAndy Whitcroft push(@res, $rawlines[$line]); 14124a0df2efSAndy Whitcroft } 14134a0df2efSAndy Whitcroft 1414f0a594c1SAndy Whitcroft last if ($level == 0); 14154a0df2efSAndy Whitcroft } 14164a0df2efSAndy Whitcroft 1417f0a594c1SAndy Whitcroft return ($level, @res); 14184a0df2efSAndy Whitcroft} 14194a0df2efSAndy Whitcroftsub ctx_block_outer { 14204a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 14214a0df2efSAndy Whitcroft 1422f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1423f0a594c1SAndy Whitcroft return @r; 14244a0df2efSAndy Whitcroft} 14254a0df2efSAndy Whitcroftsub ctx_block { 14264a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 14274a0df2efSAndy Whitcroft 1428f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1429f0a594c1SAndy Whitcroft return @r; 1430653d4876SAndy Whitcroft} 1431653d4876SAndy Whitcroftsub ctx_statement { 1432f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1433f0a594c1SAndy Whitcroft 1434f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1435f0a594c1SAndy Whitcroft return @r; 1436f0a594c1SAndy Whitcroft} 1437f0a594c1SAndy Whitcroftsub ctx_block_level { 1438653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1439653d4876SAndy Whitcroft 1440f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 14414a0df2efSAndy Whitcroft} 14429c0ca6f9SAndy Whitcroftsub ctx_statement_level { 14439c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 14449c0ca6f9SAndy Whitcroft 14459c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 14469c0ca6f9SAndy Whitcroft} 14474a0df2efSAndy Whitcroft 14484a0df2efSAndy Whitcroftsub ctx_locate_comment { 14494a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 14504a0df2efSAndy Whitcroft 14514a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1452beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 14534a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 14544a0df2efSAndy Whitcroft 14554a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 14564a0df2efSAndy Whitcroft # comment. 14574a0df2efSAndy Whitcroft my $in_comment = 0; 14584a0df2efSAndy Whitcroft $current_comment = ''; 14594a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 146000df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 146100df344fSAndy Whitcroft #warn " $line\n"; 14624a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 14634a0df2efSAndy Whitcroft $in_comment = 1; 14644a0df2efSAndy Whitcroft } 14654a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 14664a0df2efSAndy Whitcroft $in_comment = 1; 14674a0df2efSAndy Whitcroft } 14684a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 14694a0df2efSAndy Whitcroft $current_comment = ''; 14704a0df2efSAndy Whitcroft } 14714a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 14724a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 14734a0df2efSAndy Whitcroft $in_comment = 0; 14744a0df2efSAndy Whitcroft } 14754a0df2efSAndy Whitcroft } 14764a0df2efSAndy Whitcroft 14774a0df2efSAndy Whitcroft chomp($current_comment); 14784a0df2efSAndy Whitcroft return($current_comment); 14794a0df2efSAndy Whitcroft} 14804a0df2efSAndy Whitcroftsub ctx_has_comment { 14814a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 14824a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 14834a0df2efSAndy Whitcroft 148400df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 14854a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 14864a0df2efSAndy Whitcroft 14874a0df2efSAndy Whitcroft return ($cmt ne ''); 14884a0df2efSAndy Whitcroft} 14894a0df2efSAndy Whitcroft 14904d001e4dSAndy Whitcroftsub raw_line { 14914d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 14924d001e4dSAndy Whitcroft 14934d001e4dSAndy Whitcroft my $offset = $linenr - 1; 14944d001e4dSAndy Whitcroft $cnt++; 14954d001e4dSAndy Whitcroft 14964d001e4dSAndy Whitcroft my $line; 14974d001e4dSAndy Whitcroft while ($cnt) { 14984d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 14994d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 15004d001e4dSAndy Whitcroft $cnt--; 15014d001e4dSAndy Whitcroft } 15024d001e4dSAndy Whitcroft 15034d001e4dSAndy Whitcroft return $line; 15044d001e4dSAndy Whitcroft} 15054d001e4dSAndy Whitcroft 15060a920b5bSAndy Whitcroftsub cat_vet { 15070a920b5bSAndy Whitcroft my ($vet) = @_; 15089c0ca6f9SAndy Whitcroft my ($res, $coded); 15090a920b5bSAndy Whitcroft 15109c0ca6f9SAndy Whitcroft $res = ''; 15116c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 15126c72ffaaSAndy Whitcroft $res .= $1; 15136c72ffaaSAndy Whitcroft if ($2 ne '') { 15149c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 15156c72ffaaSAndy Whitcroft $res .= $coded; 15166c72ffaaSAndy Whitcroft } 15179c0ca6f9SAndy Whitcroft } 15189c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 15190a920b5bSAndy Whitcroft 15209c0ca6f9SAndy Whitcroft return $res; 15210a920b5bSAndy Whitcroft} 15220a920b5bSAndy Whitcroft 1523c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1524cf655043SAndy Whitcroftmy $av_pending; 1525c2fdda0dSAndy Whitcroftmy @av_paren_type; 15261f65f947SAndy Whitcroftmy $av_pend_colon; 1527c2fdda0dSAndy Whitcroft 1528c2fdda0dSAndy Whitcroftsub annotate_reset { 1529c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1530cf655043SAndy Whitcroft $av_pending = '_'; 1531cf655043SAndy Whitcroft @av_paren_type = ('E'); 15321f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1533c2fdda0dSAndy Whitcroft} 1534c2fdda0dSAndy Whitcroft 15356c72ffaaSAndy Whitcroftsub annotate_values { 15366c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 15376c72ffaaSAndy Whitcroft 15386c72ffaaSAndy Whitcroft my $res; 15391f65f947SAndy Whitcroft my $var = '_' x length($stream); 15406c72ffaaSAndy Whitcroft my $cur = $stream; 15416c72ffaaSAndy Whitcroft 1542c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 15436c72ffaaSAndy Whitcroft 15446c72ffaaSAndy Whitcroft while (length($cur)) { 1545773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1546cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1547171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 15486c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1549c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1550c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1551cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1552c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 15536c72ffaaSAndy Whitcroft } 15546c72ffaaSAndy Whitcroft 1555c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 15569446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 15579446ef56SAndy Whitcroft push(@av_paren_type, $type); 1558addcdceaSAndy Whitcroft $type = 'c'; 15599446ef56SAndy Whitcroft 1560e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1561c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 15626c72ffaaSAndy Whitcroft $type = 'T'; 15636c72ffaaSAndy Whitcroft 1564389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1565389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1566389a2fe5SAndy Whitcroft $type = 'T'; 1567389a2fe5SAndy Whitcroft 1568c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1569171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1570c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1571171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1572171ae1a4SAndy Whitcroft if ($2 ne '') { 1573cf655043SAndy Whitcroft $av_pending = 'N'; 1574171ae1a4SAndy Whitcroft } 1575171ae1a4SAndy Whitcroft $type = 'E'; 1576171ae1a4SAndy Whitcroft 1577c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1578171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1579171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1580171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 15816c72ffaaSAndy Whitcroft 1582c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1583cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1584c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1585cf655043SAndy Whitcroft 1586cf655043SAndy Whitcroft push(@av_paren_type, $type); 1587cf655043SAndy Whitcroft push(@av_paren_type, $type); 1588171ae1a4SAndy Whitcroft $type = 'E'; 1589cf655043SAndy Whitcroft 1590c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1591cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1592cf655043SAndy Whitcroft $av_preprocessor = 1; 1593cf655043SAndy Whitcroft 1594cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1595cf655043SAndy Whitcroft 1596171ae1a4SAndy Whitcroft $type = 'E'; 1597cf655043SAndy Whitcroft 1598c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1599cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1600cf655043SAndy Whitcroft 1601cf655043SAndy Whitcroft $av_preprocessor = 1; 1602cf655043SAndy Whitcroft 1603cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1604cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1605cf655043SAndy Whitcroft pop(@av_paren_type); 1606cf655043SAndy Whitcroft push(@av_paren_type, $type); 1607171ae1a4SAndy Whitcroft $type = 'E'; 16086c72ffaaSAndy Whitcroft 16096c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1610c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 16116c72ffaaSAndy Whitcroft 1612171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1613171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1614171ae1a4SAndy Whitcroft $av_pending = $type; 1615171ae1a4SAndy Whitcroft $type = 'N'; 1616171ae1a4SAndy Whitcroft 16176c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1618c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 16196c72ffaaSAndy Whitcroft if (defined $2) { 1620cf655043SAndy Whitcroft $av_pending = 'V'; 16216c72ffaaSAndy Whitcroft } 16226c72ffaaSAndy Whitcroft $type = 'N'; 16236c72ffaaSAndy Whitcroft 162414b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1625c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 162614b111c1SAndy Whitcroft $av_pending = 'E'; 16276c72ffaaSAndy Whitcroft $type = 'N'; 16286c72ffaaSAndy Whitcroft 16291f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 16301f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 16311f65f947SAndy Whitcroft $av_pend_colon = 'C'; 16321f65f947SAndy Whitcroft $type = 'N'; 16331f65f947SAndy Whitcroft 163414b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1635c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 16366c72ffaaSAndy Whitcroft $type = 'N'; 16376c72ffaaSAndy Whitcroft 16386c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1639c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1640cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1641cf655043SAndy Whitcroft $av_pending = '_'; 16426c72ffaaSAndy Whitcroft $type = 'N'; 16436c72ffaaSAndy Whitcroft 16446c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1645cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1646cf655043SAndy Whitcroft if ($new_type ne '_') { 1647cf655043SAndy Whitcroft $type = $new_type; 1648c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1649c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 16506c72ffaaSAndy Whitcroft } else { 1651c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 16526c72ffaaSAndy Whitcroft } 16536c72ffaaSAndy Whitcroft 1654c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1655c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1656c8cb2ca3SAndy Whitcroft $type = 'V'; 1657cf655043SAndy Whitcroft $av_pending = 'V'; 16586c72ffaaSAndy Whitcroft 16598e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 16608e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 16611f65f947SAndy Whitcroft $av_pend_colon = 'B'; 16628e761b04SAndy Whitcroft } elsif ($type eq 'E') { 16638e761b04SAndy Whitcroft $av_pend_colon = 'L'; 16641f65f947SAndy Whitcroft } 16651f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 16661f65f947SAndy Whitcroft $type = 'V'; 16671f65f947SAndy Whitcroft 16686c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1669c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 16706c72ffaaSAndy Whitcroft $type = 'V'; 16716c72ffaaSAndy Whitcroft 16726c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1673c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 16746c72ffaaSAndy Whitcroft $type = 'N'; 16756c72ffaaSAndy Whitcroft 1676cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1677c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 167813214adfSAndy Whitcroft $type = 'E'; 16791f65f947SAndy Whitcroft $av_pend_colon = 'O'; 168013214adfSAndy Whitcroft 16818e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 16828e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 16838e761b04SAndy Whitcroft $type = 'C'; 16848e761b04SAndy Whitcroft 16851f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 16861f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 16871f65f947SAndy Whitcroft $type = 'N'; 16881f65f947SAndy Whitcroft 16891f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 16901f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 16911f65f947SAndy Whitcroft 16921f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 16931f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 16941f65f947SAndy Whitcroft $type = 'E'; 16951f65f947SAndy Whitcroft } else { 16961f65f947SAndy Whitcroft $type = 'N'; 16971f65f947SAndy Whitcroft } 16981f65f947SAndy Whitcroft $av_pend_colon = 'O'; 16991f65f947SAndy Whitcroft 17008e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 170113214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 17026c72ffaaSAndy Whitcroft $type = 'N'; 17036c72ffaaSAndy Whitcroft 17040d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 170574048ed8SAndy Whitcroft my $variant; 170674048ed8SAndy Whitcroft 170774048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 170874048ed8SAndy Whitcroft if ($type eq 'V') { 170974048ed8SAndy Whitcroft $variant = 'B'; 171074048ed8SAndy Whitcroft } else { 171174048ed8SAndy Whitcroft $variant = 'U'; 171274048ed8SAndy Whitcroft } 171374048ed8SAndy Whitcroft 171474048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 171574048ed8SAndy Whitcroft $type = 'N'; 171674048ed8SAndy Whitcroft 17176c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1718c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 17196c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 17206c72ffaaSAndy Whitcroft $type = 'N'; 17216c72ffaaSAndy Whitcroft } 17226c72ffaaSAndy Whitcroft 17236c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1724c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 17256c72ffaaSAndy Whitcroft } 17266c72ffaaSAndy Whitcroft if (defined $1) { 17276c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 17286c72ffaaSAndy Whitcroft $res .= $type x length($1); 17296c72ffaaSAndy Whitcroft } 17306c72ffaaSAndy Whitcroft } 17316c72ffaaSAndy Whitcroft 17321f65f947SAndy Whitcroft return ($res, $var); 17336c72ffaaSAndy Whitcroft} 17346c72ffaaSAndy Whitcroft 17358905a67cSAndy Whitcroftsub possible { 173613214adfSAndy Whitcroft my ($possible, $line) = @_; 17379a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 17380776e594SAndy Whitcroft ^(?: 17390776e594SAndy Whitcroft $Modifier| 17400776e594SAndy Whitcroft $Storage| 17410776e594SAndy Whitcroft $Type| 17429a974fdbSAndy Whitcroft DEFINE_\S+ 17439a974fdbSAndy Whitcroft )$| 17449a974fdbSAndy Whitcroft ^(?: 17450776e594SAndy Whitcroft goto| 17460776e594SAndy Whitcroft return| 17470776e594SAndy Whitcroft case| 17480776e594SAndy Whitcroft else| 17490776e594SAndy Whitcroft asm|__asm__| 175089a88353SAndy Whitcroft do| 175189a88353SAndy Whitcroft \#| 175289a88353SAndy Whitcroft \#\#| 17539a974fdbSAndy Whitcroft )(?:\s|$)| 17540776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 17559a974fdbSAndy Whitcroft )}x; 17569a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 17579a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1758c45dcabdSAndy Whitcroft # Check for modifiers. 1759c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1760c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1761c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1762c45dcabdSAndy Whitcroft 1763c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1764c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1765d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 17669a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1767d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1768485ff23eSAlex Dowad push(@modifierListFile, $modifier); 1769d2506586SAndy Whitcroft } 17709a974fdbSAndy Whitcroft } 1771c45dcabdSAndy Whitcroft 1772c45dcabdSAndy Whitcroft } else { 177313214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 1774485ff23eSAlex Dowad push(@typeListFile, $possible); 1775c45dcabdSAndy Whitcroft } 17768905a67cSAndy Whitcroft build_types(); 17770776e594SAndy Whitcroft } else { 17780776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 17798905a67cSAndy Whitcroft } 17808905a67cSAndy Whitcroft} 17818905a67cSAndy Whitcroft 17826c72ffaaSAndy Whitcroftmy $prefix = ''; 17836c72ffaaSAndy Whitcroft 1784000d1cc1SJoe Perchessub show_type { 1785cbec18afSJoe Perches my ($type) = @_; 178691bfe484SJoe Perches 1787cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1788cbec18afSJoe Perches 1789cbec18afSJoe Perches return !defined $ignore_type{$type}; 1790000d1cc1SJoe Perches} 1791000d1cc1SJoe Perches 1792f0a594c1SAndy Whitcroftsub report { 1793cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1794cbec18afSJoe Perches 1795cbec18afSJoe Perches if (!show_type($type) || 1796cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1797773647a0SAndy Whitcroft return 0; 1798773647a0SAndy Whitcroft } 179957230297SJoe Perches my $output = ''; 180057230297SJoe Perches if (-t STDOUT && $color) { 180157230297SJoe Perches if ($level eq 'ERROR') { 180257230297SJoe Perches $output .= RED; 180357230297SJoe Perches } elsif ($level eq 'WARNING') { 180457230297SJoe Perches $output .= YELLOW; 1805000d1cc1SJoe Perches } else { 180657230297SJoe Perches $output .= GREEN; 1807000d1cc1SJoe Perches } 180857230297SJoe Perches } 180957230297SJoe Perches $output .= $prefix . $level . ':'; 181057230297SJoe Perches if ($show_types) { 181157230297SJoe Perches $output .= BLUE if (-t STDOUT && $color); 181257230297SJoe Perches $output .= "$type:"; 181357230297SJoe Perches } 181457230297SJoe Perches $output .= RESET if (-t STDOUT && $color); 181557230297SJoe Perches $output .= ' ' . $msg . "\n"; 181634d8815fSJoe Perches 181734d8815fSJoe Perches if ($showfile) { 181834d8815fSJoe Perches my @lines = split("\n", $output, -1); 181934d8815fSJoe Perches splice(@lines, 1, 1); 182034d8815fSJoe Perches $output = join("\n", @lines); 182134d8815fSJoe Perches } 182257230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 18238905a67cSAndy Whitcroft 182457230297SJoe Perches push(our @report, $output); 1825773647a0SAndy Whitcroft 1826773647a0SAndy Whitcroft return 1; 1827f0a594c1SAndy Whitcroft} 1828cbec18afSJoe Perches 1829f0a594c1SAndy Whitcroftsub report_dump { 183013214adfSAndy Whitcroft our @report; 1831f0a594c1SAndy Whitcroft} 1832000d1cc1SJoe Perches 1833d752fcc8SJoe Perchessub fixup_current_range { 1834d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 1835d752fcc8SJoe Perches 1836d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 1837d752fcc8SJoe Perches my $o = $1; 1838d752fcc8SJoe Perches my $l = $2; 1839d752fcc8SJoe Perches my $no = $o + $offset; 1840d752fcc8SJoe Perches my $nl = $l + $length; 1841d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 1842d752fcc8SJoe Perches } 1843d752fcc8SJoe Perches} 1844d752fcc8SJoe Perches 1845d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 1846d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 1847d752fcc8SJoe Perches 1848d752fcc8SJoe Perches my $range_last_linenr = 0; 1849d752fcc8SJoe Perches my $delta_offset = 0; 1850d752fcc8SJoe Perches 1851d752fcc8SJoe Perches my $old_linenr = 0; 1852d752fcc8SJoe Perches my $new_linenr = 0; 1853d752fcc8SJoe Perches 1854d752fcc8SJoe Perches my $next_insert = 0; 1855d752fcc8SJoe Perches my $next_delete = 0; 1856d752fcc8SJoe Perches 1857d752fcc8SJoe Perches my @lines = (); 1858d752fcc8SJoe Perches 1859d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 1860d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 1861d752fcc8SJoe Perches 1862d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 1863d752fcc8SJoe Perches my $save_line = 1; 1864d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 1865323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 1866d752fcc8SJoe Perches $delta_offset = 0; 1867d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 1868d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 1869d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 1870d752fcc8SJoe Perches } 1871d752fcc8SJoe Perches 1872d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 1873d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 1874d752fcc8SJoe Perches $save_line = 0; 1875d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 1876d752fcc8SJoe Perches } 1877d752fcc8SJoe Perches 1878d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 1879d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 1880d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 1881d752fcc8SJoe Perches $new_linenr++; 1882d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 1883d752fcc8SJoe Perches } 1884d752fcc8SJoe Perches 1885d752fcc8SJoe Perches if ($save_line) { 1886d752fcc8SJoe Perches push(@lines, $line); 1887d752fcc8SJoe Perches $new_linenr++; 1888d752fcc8SJoe Perches } 1889d752fcc8SJoe Perches 1890d752fcc8SJoe Perches $old_linenr++; 1891d752fcc8SJoe Perches } 1892d752fcc8SJoe Perches 1893d752fcc8SJoe Perches return @lines; 1894d752fcc8SJoe Perches} 1895d752fcc8SJoe Perches 1896f2d7e4d4SJoe Perchessub fix_insert_line { 1897f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1898f2d7e4d4SJoe Perches 1899f2d7e4d4SJoe Perches my $inserted = { 1900f2d7e4d4SJoe Perches LINENR => $linenr, 1901f2d7e4d4SJoe Perches LINE => $line, 1902f2d7e4d4SJoe Perches }; 1903f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 1904f2d7e4d4SJoe Perches} 1905f2d7e4d4SJoe Perches 1906f2d7e4d4SJoe Perchessub fix_delete_line { 1907f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1908f2d7e4d4SJoe Perches 1909f2d7e4d4SJoe Perches my $deleted = { 1910f2d7e4d4SJoe Perches LINENR => $linenr, 1911f2d7e4d4SJoe Perches LINE => $line, 1912f2d7e4d4SJoe Perches }; 1913f2d7e4d4SJoe Perches 1914f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 1915f2d7e4d4SJoe Perches} 1916f2d7e4d4SJoe Perches 1917de7d4f0eSAndy Whitcroftsub ERROR { 1918cbec18afSJoe Perches my ($type, $msg) = @_; 1919cbec18afSJoe Perches 1920cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 1921de7d4f0eSAndy Whitcroft our $clean = 0; 19226c72ffaaSAndy Whitcroft our $cnt_error++; 19233705ce5bSJoe Perches return 1; 1924de7d4f0eSAndy Whitcroft } 19253705ce5bSJoe Perches return 0; 1926773647a0SAndy Whitcroft} 1927de7d4f0eSAndy Whitcroftsub WARN { 1928cbec18afSJoe Perches my ($type, $msg) = @_; 1929cbec18afSJoe Perches 1930cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 1931de7d4f0eSAndy Whitcroft our $clean = 0; 19326c72ffaaSAndy Whitcroft our $cnt_warn++; 19333705ce5bSJoe Perches return 1; 1934de7d4f0eSAndy Whitcroft } 19353705ce5bSJoe Perches return 0; 1936773647a0SAndy Whitcroft} 1937de7d4f0eSAndy Whitcroftsub CHK { 1938cbec18afSJoe Perches my ($type, $msg) = @_; 1939cbec18afSJoe Perches 1940cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 1941de7d4f0eSAndy Whitcroft our $clean = 0; 19426c72ffaaSAndy Whitcroft our $cnt_chk++; 19433705ce5bSJoe Perches return 1; 19446c72ffaaSAndy Whitcroft } 19453705ce5bSJoe Perches return 0; 1946de7d4f0eSAndy Whitcroft} 1947de7d4f0eSAndy Whitcroft 19486ecd9674SAndy Whitcroftsub check_absolute_file { 19496ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 19506ecd9674SAndy Whitcroft my $file = $absolute; 19516ecd9674SAndy Whitcroft 19526ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 19536ecd9674SAndy Whitcroft 19546ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 19556ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 19566ecd9674SAndy Whitcroft if (-f "$root/$file") { 19576ecd9674SAndy Whitcroft ##print "file<$file>\n"; 19586ecd9674SAndy Whitcroft last; 19596ecd9674SAndy Whitcroft } 19606ecd9674SAndy Whitcroft } 19616ecd9674SAndy Whitcroft if (! -f _) { 19626ecd9674SAndy Whitcroft return 0; 19636ecd9674SAndy Whitcroft } 19646ecd9674SAndy Whitcroft 19656ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 19666ecd9674SAndy Whitcroft my $prefix = $absolute; 19676ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 19686ecd9674SAndy Whitcroft 19696ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 19706ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1971000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1972000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 19736ecd9674SAndy Whitcroft } 19746ecd9674SAndy Whitcroft} 19756ecd9674SAndy Whitcroft 19763705ce5bSJoe Perchessub trim { 19773705ce5bSJoe Perches my ($string) = @_; 19783705ce5bSJoe Perches 1979b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1980b34c648bSJoe Perches 1981b34c648bSJoe Perches return $string; 1982b34c648bSJoe Perches} 1983b34c648bSJoe Perches 1984b34c648bSJoe Perchessub ltrim { 1985b34c648bSJoe Perches my ($string) = @_; 1986b34c648bSJoe Perches 1987b34c648bSJoe Perches $string =~ s/^\s+//; 1988b34c648bSJoe Perches 1989b34c648bSJoe Perches return $string; 1990b34c648bSJoe Perches} 1991b34c648bSJoe Perches 1992b34c648bSJoe Perchessub rtrim { 1993b34c648bSJoe Perches my ($string) = @_; 1994b34c648bSJoe Perches 1995b34c648bSJoe Perches $string =~ s/\s+$//; 19963705ce5bSJoe Perches 19973705ce5bSJoe Perches return $string; 19983705ce5bSJoe Perches} 19993705ce5bSJoe Perches 200052ea8506SJoe Perchessub string_find_replace { 200152ea8506SJoe Perches my ($string, $find, $replace) = @_; 200252ea8506SJoe Perches 200352ea8506SJoe Perches $string =~ s/$find/$replace/g; 200452ea8506SJoe Perches 200552ea8506SJoe Perches return $string; 200652ea8506SJoe Perches} 200752ea8506SJoe Perches 20083705ce5bSJoe Perchessub tabify { 20093705ce5bSJoe Perches my ($leading) = @_; 20103705ce5bSJoe Perches 20113705ce5bSJoe Perches my $source_indent = 8; 20123705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 20133705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 20143705ce5bSJoe Perches 20153705ce5bSJoe Perches #convert leading spaces to tabs 20163705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 20173705ce5bSJoe Perches #Remove spaces before a tab 20183705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 20193705ce5bSJoe Perches 20203705ce5bSJoe Perches return "$leading"; 20213705ce5bSJoe Perches} 20223705ce5bSJoe Perches 2023d1fe9c09SJoe Perchessub pos_last_openparen { 2024d1fe9c09SJoe Perches my ($line) = @_; 2025d1fe9c09SJoe Perches 2026d1fe9c09SJoe Perches my $pos = 0; 2027d1fe9c09SJoe Perches 2028d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2029d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2030d1fe9c09SJoe Perches 2031d1fe9c09SJoe Perches my $last_openparen = 0; 2032d1fe9c09SJoe Perches 2033d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2034d1fe9c09SJoe Perches return -1; 2035d1fe9c09SJoe Perches } 2036d1fe9c09SJoe Perches 2037d1fe9c09SJoe Perches my $len = length($line); 2038d1fe9c09SJoe Perches 2039d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2040d1fe9c09SJoe Perches my $string = substr($line, $pos); 2041d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2042d1fe9c09SJoe Perches $pos += length($1) - 1; 2043d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2044d1fe9c09SJoe Perches $last_openparen = $pos; 2045d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2046d1fe9c09SJoe Perches last; 2047d1fe9c09SJoe Perches } 2048d1fe9c09SJoe Perches } 2049d1fe9c09SJoe Perches 205091cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2051d1fe9c09SJoe Perches} 2052d1fe9c09SJoe Perches 20530a920b5bSAndy Whitcroftsub process { 20540a920b5bSAndy Whitcroft my $filename = shift; 20550a920b5bSAndy Whitcroft 20560a920b5bSAndy Whitcroft my $linenr=0; 20570a920b5bSAndy Whitcroft my $prevline=""; 2058c2fdda0dSAndy Whitcroft my $prevrawline=""; 20590a920b5bSAndy Whitcroft my $stashline=""; 2060c2fdda0dSAndy Whitcroft my $stashrawline=""; 20610a920b5bSAndy Whitcroft 20624a0df2efSAndy Whitcroft my $length; 20630a920b5bSAndy Whitcroft my $indent; 20640a920b5bSAndy Whitcroft my $previndent=0; 20650a920b5bSAndy Whitcroft my $stashindent=0; 20660a920b5bSAndy Whitcroft 2067de7d4f0eSAndy Whitcroft our $clean = 1; 20680a920b5bSAndy Whitcroft my $signoff = 0; 20690a920b5bSAndy Whitcroft my $is_patch = 0; 207029ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 207115662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 2072*ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2073bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 20742a076f40SJoe Perches my $commit_log_long_line = 0; 2075e518e9a5SJoe Perches my $commit_log_has_diff = 0; 207613f1937eSJoe Perches my $reported_maintainer_file = 0; 2077fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2078fa64205dSPasi Savanainen 2079365dd4eaSJoe Perches my $last_blank_line = 0; 20805e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2081365dd4eaSJoe Perches 208213214adfSAndy Whitcroft our @report = (); 20836c72ffaaSAndy Whitcroft our $cnt_lines = 0; 20846c72ffaaSAndy Whitcroft our $cnt_error = 0; 20856c72ffaaSAndy Whitcroft our $cnt_warn = 0; 20866c72ffaaSAndy Whitcroft our $cnt_chk = 0; 20876c72ffaaSAndy Whitcroft 20880a920b5bSAndy Whitcroft # Trace the real file/line as we go. 20890a920b5bSAndy Whitcroft my $realfile = ''; 20900a920b5bSAndy Whitcroft my $realline = 0; 20910a920b5bSAndy Whitcroft my $realcnt = 0; 20920a920b5bSAndy Whitcroft my $here = ''; 20930a920b5bSAndy Whitcroft my $in_comment = 0; 2094c2fdda0dSAndy Whitcroft my $comment_edge = 0; 20950a920b5bSAndy Whitcroft my $first_line = 0; 20961e855726SWolfram Sang my $p1_prefix = ''; 20970a920b5bSAndy Whitcroft 209813214adfSAndy Whitcroft my $prev_values = 'E'; 209913214adfSAndy Whitcroft 210013214adfSAndy Whitcroft # suppression flags 2101773647a0SAndy Whitcroft my %suppress_ifbraces; 2102170d3a22SAndy Whitcroft my %suppress_whiletrailers; 21032b474a1aSAndy Whitcroft my %suppress_export; 21043e469cdcSAndy Whitcroft my $suppress_statement = 0; 2105653d4876SAndy Whitcroft 21067e51f197SJoe Perches my %signatures = (); 2107323c1260SJoe Perches 2108c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2109de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2110c2fdda0dSAndy Whitcroft # 2111de7d4f0eSAndy Whitcroft my @setup_docs = (); 2112de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2113773647a0SAndy Whitcroft 2114d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2115d8b07710SJoe Perches 2116773647a0SAndy Whitcroft sanitise_line_reset(); 2117c2fdda0dSAndy Whitcroft my $line; 2118c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2119773647a0SAndy Whitcroft $linenr++; 2120773647a0SAndy Whitcroft $line = $rawline; 2121c2fdda0dSAndy Whitcroft 21223705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 21233705ce5bSJoe Perches 2124773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2125de7d4f0eSAndy Whitcroft $setup_docs = 0; 2126de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 2127de7d4f0eSAndy Whitcroft $setup_docs = 1; 2128de7d4f0eSAndy Whitcroft } 2129773647a0SAndy Whitcroft #next; 2130de7d4f0eSAndy Whitcroft } 2131773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2132773647a0SAndy Whitcroft $realline=$1-1; 2133773647a0SAndy Whitcroft if (defined $2) { 2134773647a0SAndy Whitcroft $realcnt=$3+1; 2135773647a0SAndy Whitcroft } else { 2136773647a0SAndy Whitcroft $realcnt=1+1; 2137773647a0SAndy Whitcroft } 2138c45dcabdSAndy Whitcroft $in_comment = 0; 2139773647a0SAndy Whitcroft 2140773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2141773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2142773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2143773647a0SAndy Whitcroft # at context start. 2144773647a0SAndy Whitcroft my $edge; 214501fa9147SAndy Whitcroft my $cnt = $realcnt; 214601fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 214701fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 214801fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 214901fa9147SAndy Whitcroft $cnt--; 215001fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2151721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2152fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2153fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2154fae17daeSAndy Whitcroft ($edge) = $1; 2155fae17daeSAndy Whitcroft last; 2156fae17daeSAndy Whitcroft } 2157773647a0SAndy Whitcroft } 2158773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2159773647a0SAndy Whitcroft $in_comment = 1; 2160773647a0SAndy Whitcroft } 2161773647a0SAndy Whitcroft 2162773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2163773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2164773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2165773647a0SAndy Whitcroft if (!defined $edge && 216683242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2167773647a0SAndy Whitcroft { 2168773647a0SAndy Whitcroft $in_comment = 1; 2169773647a0SAndy Whitcroft } 2170773647a0SAndy Whitcroft 2171773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2172773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2173773647a0SAndy Whitcroft 2174171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2175773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2176171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2177773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2178773647a0SAndy Whitcroft } 2179773647a0SAndy Whitcroft push(@lines, $line); 2180773647a0SAndy Whitcroft 2181773647a0SAndy Whitcroft if ($realcnt > 1) { 2182773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2183773647a0SAndy Whitcroft } else { 2184773647a0SAndy Whitcroft $realcnt = 0; 2185773647a0SAndy Whitcroft } 2186773647a0SAndy Whitcroft 2187773647a0SAndy Whitcroft #print "==>$rawline\n"; 2188773647a0SAndy Whitcroft #print "-->$line\n"; 2189de7d4f0eSAndy Whitcroft 2190de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2191de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2192de7d4f0eSAndy Whitcroft } 2193de7d4f0eSAndy Whitcroft } 2194de7d4f0eSAndy Whitcroft 21956c72ffaaSAndy Whitcroft $prefix = ''; 21966c72ffaaSAndy Whitcroft 2197773647a0SAndy Whitcroft $realcnt = 0; 2198773647a0SAndy Whitcroft $linenr = 0; 2199194f66fcSJoe Perches $fixlinenr = -1; 22000a920b5bSAndy Whitcroft foreach my $line (@lines) { 22010a920b5bSAndy Whitcroft $linenr++; 2202194f66fcSJoe Perches $fixlinenr++; 22031b5539b1SJoe Perches my $sline = $line; #copy of $line 22041b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 22050a920b5bSAndy Whitcroft 2206c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 22076c72ffaaSAndy Whitcroft 22080a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2209e518e9a5SJoe Perches if (!$in_commit_log && 2210e518e9a5SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 22110a920b5bSAndy Whitcroft $is_patch = 1; 22124a0df2efSAndy Whitcroft $first_line = $linenr + 1; 22130a920b5bSAndy Whitcroft $realline=$1-1; 22140a920b5bSAndy Whitcroft if (defined $2) { 22150a920b5bSAndy Whitcroft $realcnt=$3+1; 22160a920b5bSAndy Whitcroft } else { 22170a920b5bSAndy Whitcroft $realcnt=1+1; 22180a920b5bSAndy Whitcroft } 2219c2fdda0dSAndy Whitcroft annotate_reset(); 222013214adfSAndy Whitcroft $prev_values = 'E'; 222113214adfSAndy Whitcroft 2222773647a0SAndy Whitcroft %suppress_ifbraces = (); 2223170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 22242b474a1aSAndy Whitcroft %suppress_export = (); 22253e469cdcSAndy Whitcroft $suppress_statement = 0; 22260a920b5bSAndy Whitcroft next; 22270a920b5bSAndy Whitcroft 22284a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 22294a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 22304a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2231773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 22320a920b5bSAndy Whitcroft $realline++; 2233d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 22340a920b5bSAndy Whitcroft 22354a0df2efSAndy Whitcroft # Measure the line length and indent. 2236c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 22370a920b5bSAndy Whitcroft 22380a920b5bSAndy Whitcroft # Track the previous line. 22390a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 22400a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2241c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2242c2fdda0dSAndy Whitcroft 2243773647a0SAndy Whitcroft #warn "line<$line>\n"; 22446c72ffaaSAndy Whitcroft 2245d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2246d8aaf121SAndy Whitcroft $realcnt--; 22470a920b5bSAndy Whitcroft } 22480a920b5bSAndy Whitcroft 2249cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2250cc77cdcaSAndy Whitcroft 22516c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 22526c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2253773647a0SAndy Whitcroft 22542ac73b4fSJoe Perches my $found_file = 0; 2255773647a0SAndy Whitcroft # extract the filename as it passes 22563bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 22573bf9a009SRabin Vincent $realfile = $1; 22582b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2259270c49a0SJoe Perches $in_commit_log = 0; 22602ac73b4fSJoe Perches $found_file = 1; 22613bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2262773647a0SAndy Whitcroft $realfile = $1; 22632b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2264270c49a0SJoe Perches $in_commit_log = 0; 22651e855726SWolfram Sang 22661e855726SWolfram Sang $p1_prefix = $1; 2267e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2268e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2269000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2270000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 22711e855726SWolfram Sang } 2272773647a0SAndy Whitcroft 2273c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2274000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2275000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2276773647a0SAndy Whitcroft } 22772ac73b4fSJoe Perches $found_file = 1; 22782ac73b4fSJoe Perches } 22792ac73b4fSJoe Perches 228034d8815fSJoe Perches#make up the handle for any error we report on this line 228134d8815fSJoe Perches if ($showfile) { 228234d8815fSJoe Perches $prefix = "$realfile:$realline: " 228334d8815fSJoe Perches } elsif ($emacs) { 22847d3a9f67SJoe Perches if ($file) { 22857d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 22867d3a9f67SJoe Perches } else { 228734d8815fSJoe Perches $prefix = "$filename:$linenr: "; 228834d8815fSJoe Perches } 22897d3a9f67SJoe Perches } 229034d8815fSJoe Perches 22912ac73b4fSJoe Perches if ($found_file) { 22927bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 22932ac73b4fSJoe Perches $check = 1; 22942ac73b4fSJoe Perches } else { 22952ac73b4fSJoe Perches $check = $check_orig; 22962ac73b4fSJoe Perches } 2297773647a0SAndy Whitcroft next; 2298773647a0SAndy Whitcroft } 2299773647a0SAndy Whitcroft 2300389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 23010a920b5bSAndy Whitcroft 2302c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2303c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2304c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 23050a920b5bSAndy Whitcroft 23066c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 23076c72ffaaSAndy Whitcroft 2308e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2309e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2310e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2311e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2312e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2313e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2314e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2315e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2316e518e9a5SJoe Perches $commit_log_has_diff = 1; 2317e518e9a5SJoe Perches } 2318e518e9a5SJoe Perches 23193bf9a009SRabin Vincent# Check for incorrect file permissions 23203bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 23213bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 232204db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 232304db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2324000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2325000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 23263bf9a009SRabin Vincent } 23273bf9a009SRabin Vincent } 23283bf9a009SRabin Vincent 232920112475SJoe Perches# Check the patch for a signoff: 2330d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 23314a0df2efSAndy Whitcroft $signoff++; 233215662b3eSJoe Perches $in_commit_log = 0; 23330a920b5bSAndy Whitcroft } 233420112475SJoe Perches 2335e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2336e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2337e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2338e0d975b1SJoe Perches $reported_maintainer_file = 1; 2339e0d975b1SJoe Perches } 2340e0d975b1SJoe Perches 234120112475SJoe Perches# Check signature styles 2342270c49a0SJoe Perches if (!$in_header_lines && 2343ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 234420112475SJoe Perches my $space_before = $1; 234520112475SJoe Perches my $sign_off = $2; 234620112475SJoe Perches my $space_after = $3; 234720112475SJoe Perches my $email = $4; 234820112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 234920112475SJoe Perches 2350ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2351ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2352ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2353ce0338dfSJoe Perches } 235420112475SJoe Perches if (defined $space_before && $space_before ne "") { 23553705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 23563705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 23573705ce5bSJoe Perches $fix) { 2358194f66fcSJoe Perches $fixed[$fixlinenr] = 23593705ce5bSJoe Perches "$ucfirst_sign_off $email"; 23603705ce5bSJoe Perches } 236120112475SJoe Perches } 236220112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 23633705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 23643705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 23653705ce5bSJoe Perches $fix) { 2366194f66fcSJoe Perches $fixed[$fixlinenr] = 23673705ce5bSJoe Perches "$ucfirst_sign_off $email"; 23683705ce5bSJoe Perches } 23693705ce5bSJoe Perches 237020112475SJoe Perches } 237120112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 23723705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 23733705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 23743705ce5bSJoe Perches $fix) { 2375194f66fcSJoe Perches $fixed[$fixlinenr] = 23763705ce5bSJoe Perches "$ucfirst_sign_off $email"; 23773705ce5bSJoe Perches } 237820112475SJoe Perches } 237920112475SJoe Perches 238020112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 238120112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 238220112475SJoe Perches if ($suggested_email eq "") { 2383000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2384000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 238520112475SJoe Perches } else { 238620112475SJoe Perches my $dequoted = $suggested_email; 238720112475SJoe Perches $dequoted =~ s/^"//; 238820112475SJoe Perches $dequoted =~ s/" </ </; 238920112475SJoe Perches # Don't force email to have quotes 239020112475SJoe Perches # Allow just an angle bracketed address 239120112475SJoe Perches if ("$dequoted$comment" ne $email && 239220112475SJoe Perches "<$email_address>$comment" ne $email && 239320112475SJoe Perches "$suggested_email$comment" ne $email) { 2394000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2395000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 239620112475SJoe Perches } 23970a920b5bSAndy Whitcroft } 23987e51f197SJoe Perches 23997e51f197SJoe Perches# Check for duplicate signatures 24007e51f197SJoe Perches my $sig_nospace = $line; 24017e51f197SJoe Perches $sig_nospace =~ s/\s//g; 24027e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 24037e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 24047e51f197SJoe Perches WARN("BAD_SIGN_OFF", 24057e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 24067e51f197SJoe Perches } else { 24077e51f197SJoe Perches $signatures{$sig_nospace} = 1; 24087e51f197SJoe Perches } 24090a920b5bSAndy Whitcroft } 24100a920b5bSAndy Whitcroft 2411a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2412a2fe16b9SJoe Perches if ($in_header_lines && 2413a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2414a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2415a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2416a2fe16b9SJoe Perches } 2417a2fe16b9SJoe Perches 24189b3189ebSJoe Perches# Check for old stable address 24199b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 24209b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 24219b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 24229b3189ebSJoe Perches } 24239b3189ebSJoe Perches 24247ebd05efSChristopher Covington# Check for unwanted Gerrit info 24257ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 24267ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 24277ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 24287ebd05efSChristopher Covington } 24297ebd05efSChristopher Covington 2430369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2431369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2432369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2433369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2434369c8dd3SJoe Perches # timestamp 2435369c8dd3SJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) { 2436369c8dd3SJoe Perches # stack dump address 2437369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2438369c8dd3SJoe Perches } 2439369c8dd3SJoe Perches 24402a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 24412a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2442bf4daf12SJoe Perches length($line) > 75 && 2443bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2444bf4daf12SJoe Perches # file delta changes 2445bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2446bf4daf12SJoe Perches # filename then : 2447bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2448bf4daf12SJoe Perches # A Fixes: or Link: line 2449bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 24502a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 24512a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 24522a076f40SJoe Perches $commit_log_long_line = 1; 24532a076f40SJoe Perches } 24542a076f40SJoe Perches 2455bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2456bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2457bf4daf12SJoe Perches $line =~ /^\s*$/) { 2458bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2459bf4daf12SJoe Perches } 2460bf4daf12SJoe Perches 24610d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2462369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2463aab38f51SJoe Perches $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i && 2464fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2465aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2466369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2467bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2468fe043ea1SJoe Perches my $init_char = "c"; 2469fe043ea1SJoe Perches my $orig_commit = ""; 24700d7835fcSJoe Perches my $short = 1; 24710d7835fcSJoe Perches my $long = 0; 24720d7835fcSJoe Perches my $case = 1; 24730d7835fcSJoe Perches my $space = 1; 24740d7835fcSJoe Perches my $hasdesc = 0; 247519c146a6SJoe Perches my $hasparens = 0; 24760d7835fcSJoe Perches my $id = '0123456789ab'; 24770d7835fcSJoe Perches my $orig_desc = "commit description"; 24780d7835fcSJoe Perches my $description = ""; 24790d7835fcSJoe Perches 2480fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2481fe043ea1SJoe Perches $init_char = $1; 2482fe043ea1SJoe Perches $orig_commit = lc($2); 2483fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2484fe043ea1SJoe Perches $orig_commit = lc($1); 2485fe043ea1SJoe Perches } 2486fe043ea1SJoe Perches 24870d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 24880d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 24890d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 24900d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 24910d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 24920d7835fcSJoe Perches $orig_desc = $1; 249319c146a6SJoe Perches $hasparens = 1; 24940d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 24950d7835fcSJoe Perches defined $rawlines[$linenr] && 24960d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 24970d7835fcSJoe Perches $orig_desc = $1; 249819c146a6SJoe Perches $hasparens = 1; 2499b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2500b671fde0SJoe Perches defined $rawlines[$linenr] && 2501b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2502b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2503b671fde0SJoe Perches $orig_desc = $1; 2504b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2505b671fde0SJoe Perches $orig_desc .= " " . $1; 250619c146a6SJoe Perches $hasparens = 1; 25070d7835fcSJoe Perches } 25080d7835fcSJoe Perches 25090d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 25100d7835fcSJoe Perches $id, $orig_desc); 25110d7835fcSJoe Perches 251219c146a6SJoe Perches if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) { 2513d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 25140d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 25150d7835fcSJoe Perches } 2516d311cd44SJoe Perches } 2517d311cd44SJoe Perches 251813f1937eSJoe Perches# Check for added, moved or deleted files 251913f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 252013f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 252113f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 252213f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 252313f1937eSJoe Perches (defined($1) || defined($2))))) { 252413f1937eSJoe Perches $reported_maintainer_file = 1; 252513f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 252613f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 252713f1937eSJoe Perches } 252813f1937eSJoe Perches 252900df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 25308905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2531000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2532000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 25336c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2534de7d4f0eSAndy Whitcroft } 2535de7d4f0eSAndy Whitcroft 25366ecd9674SAndy Whitcroft# Check for absolute kernel paths. 25376ecd9674SAndy Whitcroft if ($tree) { 25386ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 25396ecd9674SAndy Whitcroft my $file = $1; 25406ecd9674SAndy Whitcroft 25416ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 25426ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 25436ecd9674SAndy Whitcroft # 25446ecd9674SAndy Whitcroft } else { 25456ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 25466ecd9674SAndy Whitcroft } 25476ecd9674SAndy Whitcroft } 25486ecd9674SAndy Whitcroft } 25496ecd9674SAndy Whitcroft 2550de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2551de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2552171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2553171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2554171ae1a4SAndy Whitcroft 2555171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2556171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2557171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2558171ae1a4SAndy Whitcroft 255934d99219SJoe Perches CHK("INVALID_UTF8", 2560000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 256100df344fSAndy Whitcroft } 25620a920b5bSAndy Whitcroft 256315662b3eSJoe Perches# Check if it's the start of a commit log 256415662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 256515662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 256629ee1b0cSJoe Perches !($rawline =~ /^\s+\S/ || 256729ee1b0cSJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 256815662b3eSJoe Perches $in_header_lines = 0; 256915662b3eSJoe Perches $in_commit_log = 1; 2570*ed43c4e5SAllen Hubbe $has_commit_log = 1; 257115662b3eSJoe Perches } 257215662b3eSJoe Perches 2573fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2574fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2575fa64205dSPasi Savanainen if ($in_header_lines && 2576fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2577fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2578fa64205dSPasi Savanainen $non_utf8_charset = 1; 2579fa64205dSPasi Savanainen } 2580fa64205dSPasi Savanainen 2581fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 258215662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2583fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 258415662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 258515662b3eSJoe Perches } 258615662b3eSJoe Perches 258766b47b4aSKees Cook# Check for various typo / spelling mistakes 258866d7a382SJoe Perches if (defined($misspellings) && 258966d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2590ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 259166b47b4aSKees Cook my $typo = $1; 259266b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 259366b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 259466b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 259566b47b4aSKees Cook my $msg_type = \&WARN; 259666b47b4aSKees Cook $msg_type = \&CHK if ($file); 259766b47b4aSKees Cook if (&{$msg_type}("TYPO_SPELLING", 259866b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 259966b47b4aSKees Cook $fix) { 260066b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 260166b47b4aSKees Cook } 260266b47b4aSKees Cook } 260366b47b4aSKees Cook } 260466b47b4aSKees Cook 260530670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 260630670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 260700df344fSAndy Whitcroft 26080a920b5bSAndy Whitcroft#trailing whitespace 26099c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2610c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2611d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2612d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2613d5e616fcSJoe Perches $fix) { 2614194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2615d5e616fcSJoe Perches } 2616c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2617c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 26183705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 26193705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 26203705ce5bSJoe Perches $fix) { 2621194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 26223705ce5bSJoe Perches } 26233705ce5bSJoe Perches 2624d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 26250a920b5bSAndy Whitcroft } 26265368df20SAndy Whitcroft 26274783f894SJosh Triplett# Check for FSF mailing addresses. 2628109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 26293e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 26303e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 26314783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 26324783f894SJosh Triplett my $msg_type = \&ERROR; 26334783f894SJosh Triplett $msg_type = \&CHK if ($file); 26344783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 26354783f894SJosh 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) 26364783f894SJosh Triplett } 26374783f894SJosh Triplett 26383354957aSAndi Kleen# check for Kconfig help text having a real description 26399fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 26409fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 26413354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 26428d73e0e7SJoe Perches $line =~ /^\+\s*config\s+/) { 26433354957aSAndi Kleen my $length = 0; 26449fe287d7SAndy Whitcroft my $cnt = $realcnt; 26459fe287d7SAndy Whitcroft my $ln = $linenr + 1; 26469fe287d7SAndy Whitcroft my $f; 2647a1385803SAndy Whitcroft my $is_start = 0; 26489fe287d7SAndy Whitcroft my $is_end = 0; 2649a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 26509fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 26519fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 26529fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 26539fe287d7SAndy Whitcroft 26549fe287d7SAndy Whitcroft next if ($f =~ /^-/); 26558d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2656a1385803SAndy Whitcroft 26578d73e0e7SJoe Perches if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) { 2658a1385803SAndy Whitcroft $is_start = 1; 26598d73e0e7SJoe Perches } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 2660a1385803SAndy Whitcroft $length = -1; 2661a1385803SAndy Whitcroft } 2662a1385803SAndy Whitcroft 26639fe287d7SAndy Whitcroft $f =~ s/^.//; 26643354957aSAndi Kleen $f =~ s/#.*//; 26653354957aSAndi Kleen $f =~ s/^\s+//; 26663354957aSAndi Kleen next if ($f =~ /^$/); 26679fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 26689fe287d7SAndy Whitcroft $is_end = 1; 26699fe287d7SAndy Whitcroft last; 26709fe287d7SAndy Whitcroft } 26713354957aSAndi Kleen $length++; 26723354957aSAndi Kleen } 267356193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2674000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 267556193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 267656193274SVadim Bendebury } 2677a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 26783354957aSAndi Kleen } 26793354957aSAndi Kleen 26801ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 26811ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 26821ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 26831ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 26841ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 26851ba8dfd1SKees Cook } 26861ba8dfd1SKees Cook 2687327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2688327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2689327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2690327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2691327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2692327953e9SChristoph Jaeger } 2693327953e9SChristoph Jaeger 2694c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2695c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2696c68e5878SArnaud Lacombe my $flag = $1; 2697c68e5878SArnaud Lacombe my $replacement = { 2698c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2699c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2700c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2701c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2702c68e5878SArnaud Lacombe }; 2703c68e5878SArnaud Lacombe 2704c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2705c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2706c68e5878SArnaud Lacombe } 2707c68e5878SArnaud Lacombe 2708bff5da43SRob Herring# check for DT compatible documentation 27097dd05b38SFlorian Vaussard if (defined $root && 27107dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 27117dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 27127dd05b38SFlorian Vaussard 2713bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2714bff5da43SRob Herring 2715cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2716cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2717cc93319bSFlorian Vaussard 2718bff5da43SRob Herring foreach my $compat (@compats) { 2719bff5da43SRob Herring my $compat2 = $compat; 2720185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2721185d566bSRob Herring my $compat3 = $compat; 2722185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2723185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2724bff5da43SRob Herring if ( $? >> 8 ) { 2725bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2726bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2727bff5da43SRob Herring } 2728bff5da43SRob Herring 27294fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 27304fbf32a6SFlorian Vaussard my $vendor = $1; 2731cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2732bff5da43SRob Herring if ( $? >> 8 ) { 2733bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2734cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2735bff5da43SRob Herring } 2736bff5da43SRob Herring } 2737bff5da43SRob Herring } 2738bff5da43SRob Herring 27395368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2740de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/); 27415368df20SAndy Whitcroft 274247e0c88bSJoe Perches# line length limit (with some exclusions) 274347e0c88bSJoe Perches# 274447e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 274547e0c88bSJoe Perches# logging functions like pr_info that end in a string 274647e0c88bSJoe Perches# lines with a single string 274747e0c88bSJoe Perches# #defines that are a single string 274847e0c88bSJoe Perches# 274947e0c88bSJoe Perches# There are 3 different line length message types: 275047e0c88bSJoe Perches# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength 275147e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 275247e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 275347e0c88bSJoe Perches# 275447e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 275547e0c88bSJoe Perches# 275647e0c88bSJoe Perches 2757b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 275847e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 275947e0c88bSJoe Perches 276047e0c88bSJoe Perches # Check the allowed long line types first 276147e0c88bSJoe Perches 276247e0c88bSJoe Perches # logging functions that end in a string that starts 276347e0c88bSJoe Perches # before $max_line_length 276447e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 276547e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 276647e0c88bSJoe Perches $msg_type = ""; 276747e0c88bSJoe Perches 276847e0c88bSJoe Perches # lines with only strings (w/ possible termination) 276947e0c88bSJoe Perches # #defines with only strings 277047e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 277147e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 277247e0c88bSJoe Perches $msg_type = ""; 277347e0c88bSJoe Perches 2774d560a5f8SJoe Perches # EFI_GUID is another special case 2775d560a5f8SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/) { 2776d560a5f8SJoe Perches $msg_type = ""; 2777d560a5f8SJoe Perches 277847e0c88bSJoe Perches # Otherwise set the alternate message types 277947e0c88bSJoe Perches 278047e0c88bSJoe Perches # a comment starts before $max_line_length 278147e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 278247e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 278347e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 278447e0c88bSJoe Perches 278547e0c88bSJoe Perches # a quoted string starts before $max_line_length 278647e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 278747e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 278847e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 278947e0c88bSJoe Perches } 279047e0c88bSJoe Perches 279147e0c88bSJoe Perches if ($msg_type ne "" && 279247e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 279347e0c88bSJoe Perches WARN($msg_type, 27946cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 27950a920b5bSAndy Whitcroft } 279647e0c88bSJoe Perches } 27970a920b5bSAndy Whitcroft 27988905a67cSAndy Whitcroft# check for adding lines without a newline. 27998905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2800000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2801000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 28028905a67cSAndy Whitcroft } 28038905a67cSAndy Whitcroft 280442e41c54SMike Frysinger# Blackfin: use hi/lo macros 280542e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 280642e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 280742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2808000d1cc1SJoe Perches ERROR("LO_MACRO", 2809000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 281042e41c54SMike Frysinger } 281142e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 281242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2813000d1cc1SJoe Perches ERROR("HI_MACRO", 2814000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 281542e41c54SMike Frysinger } 281642e41c54SMike Frysinger } 281742e41c54SMike Frysinger 2818b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2819de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 28200a920b5bSAndy Whitcroft 28210a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 28220a920b5bSAndy Whitcroft# more than 8 must use tabs. 2823c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2824c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2825c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2826d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 28273705ce5bSJoe Perches if (ERROR("CODE_INDENT", 28283705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 28293705ce5bSJoe Perches $fix) { 2830194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 28313705ce5bSJoe Perches } 28320a920b5bSAndy Whitcroft } 28330a920b5bSAndy Whitcroft 283408e44365SAlberto Panizzo# check for space before tabs. 283508e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 283608e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28373705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 28383705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 28393705ce5bSJoe Perches $fix) { 2840194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2841d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 2842194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2843c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 28443705ce5bSJoe Perches } 284508e44365SAlberto Panizzo } 284608e44365SAlberto Panizzo 2847d1fe9c09SJoe Perches# check for && or || at the start of a line 2848d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2849d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2850d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2851d1fe9c09SJoe Perches } 2852d1fe9c09SJoe Perches 2853a91e8994SJoe Perches# check indentation starts on a tab stop 2854a91e8994SJoe Perches if ($^V && $^V ge 5.10.0 && 2855a91e8994SJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) { 2856a91e8994SJoe Perches my $indent = length($1); 2857a91e8994SJoe Perches if ($indent % 8) { 2858a91e8994SJoe Perches if (WARN("TABSTOP", 2859a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 2860a91e8994SJoe Perches $fix) { 2861a91e8994SJoe Perches $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; 2862a91e8994SJoe Perches } 2863a91e8994SJoe Perches } 2864a91e8994SJoe Perches } 2865a91e8994SJoe Perches 2866d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2867d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 286891cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2869d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2870d1fe9c09SJoe Perches my $oldindent = $1; 2871d1fe9c09SJoe Perches my $rest = $2; 2872d1fe9c09SJoe Perches 2873d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2874d1fe9c09SJoe Perches if ($pos >= 0) { 2875b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2876b34a26f3SJoe Perches my $newindent = $2; 2877d1fe9c09SJoe Perches 2878d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2879d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2880d1fe9c09SJoe Perches " " x ($pos % 8); 2881d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2882d1fe9c09SJoe Perches 2883d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2884d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 28853705ce5bSJoe Perches 28863705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 28873705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 28883705ce5bSJoe Perches $fix && $line =~ /^\+/) { 2889194f66fcSJoe Perches $fixed[$fixlinenr] =~ 28903705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 28913705ce5bSJoe Perches } 2892d1fe9c09SJoe Perches } 2893d1fe9c09SJoe Perches } 2894d1fe9c09SJoe Perches } 2895d1fe9c09SJoe Perches 28966ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 28976ab3a970SJoe Perches# avoid checking a few false positives: 28986ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 28996ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 29006ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 29016ab3a970SJoe Perches# multiline macros that define functions 29026ab3a970SJoe Perches# known attributes or the __attribute__ keyword 29036ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 29046ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 29053705ce5bSJoe Perches if (CHK("SPACING", 2906f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 29073705ce5bSJoe Perches $fix) { 2908194f66fcSJoe Perches $fixed[$fixlinenr] =~ 2909f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 29103705ce5bSJoe Perches } 2911aad4f614SJoe Perches } 2912aad4f614SJoe Perches 291386406b1cSJoe Perches# Block comment styles 291486406b1cSJoe Perches# Networking with an initial /* 291505880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2916fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 291785ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 291885ad978cSJoe Perches $realline > 2) { 291905880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 292005880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 292105880600SJoe Perches } 292205880600SJoe Perches 292386406b1cSJoe Perches# Block comments use * on subsequent lines 292486406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 292586406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 2926a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 292761135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2928a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 292986406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 293086406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 2931a605e32eSJoe Perches } 2932a605e32eSJoe Perches 293386406b1cSJoe Perches# Block comments use */ on trailing lines 293486406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2935c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2936c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2937c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 293886406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 293986406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 294005880600SJoe Perches } 294105880600SJoe Perches 29427f619191SJoe Perches# check for missing blank lines after struct/union declarations 29437f619191SJoe Perches# with exceptions for various attributes and macros 29447f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 29457f619191SJoe Perches $line =~ /^\+/ && 29467f619191SJoe Perches !($line =~ /^\+\s*$/ || 29477f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 29487f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 29497f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 29507f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 29517f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 29527f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 29537f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 2954d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2955d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 2956d752fcc8SJoe Perches $fix) { 2957f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2958d752fcc8SJoe Perches } 29597f619191SJoe Perches } 29607f619191SJoe Perches 2961365dd4eaSJoe Perches# check for multiple consecutive blank lines 2962365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 2963365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 2964365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 2965d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2966d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 2967d752fcc8SJoe Perches $fix) { 2968f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 2969d752fcc8SJoe Perches } 2970d752fcc8SJoe Perches 2971365dd4eaSJoe Perches $last_blank_line = $linenr; 2972365dd4eaSJoe Perches } 2973365dd4eaSJoe Perches 29743b617e3bSJoe Perches# check for missing blank lines after declarations 29753f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 29763f7bac03SJoe Perches # actual declarations 29773f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 29785a4e1fd3SJoe Perches # function pointer declarations 29795a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 29803f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 29813f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 29823f7bac03SJoe Perches # known declaration macros 29833f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 29843f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 29853f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 29863f7bac03SJoe Perches # other possible extensions of declaration lines 29873f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 29883f7bac03SJoe Perches # not starting a section or a macro "\" extended line 29893f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 29903f7bac03SJoe Perches # looks like a declaration 29913f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 29925a4e1fd3SJoe Perches # function pointer declarations 29935a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 29943f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 29953f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 29963f7bac03SJoe Perches # known declaration macros 29973f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 29983f7bac03SJoe Perches # start of struct or union or enum 29993b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 30003f7bac03SJoe Perches # start or end of block or continuation of declaration 30013f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 30023f7bac03SJoe Perches # bitfield continuation 30033f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 30043f7bac03SJoe Perches # other possible extensions of declaration lines 30053f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 30063f7bac03SJoe Perches # indentation of previous and current line are the same 30073f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3008d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3009d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3010d752fcc8SJoe Perches $fix) { 3011f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3012d752fcc8SJoe Perches } 30133b617e3bSJoe Perches } 30143b617e3bSJoe Perches 30155f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 30166b4c5bebSAndy Whitcroft# Exceptions: 30176b4c5bebSAndy Whitcroft# 1) within comments 30186b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 30196b4c5bebSAndy Whitcroft# 3) hanging labels 30203705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 30215f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 30223705ce5bSJoe Perches if (WARN("LEADING_SPACE", 30233705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 30243705ce5bSJoe Perches $fix) { 3025194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 30263705ce5bSJoe Perches } 30275f7ddae6SRaffaele Recalcati } 30285f7ddae6SRaffaele Recalcati 3029b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3030b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3031b9ea10d6SAndy Whitcroft 3032032a4c0fSJoe Perches# check indentation of any line with a bare else 3033840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3034032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3035032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3036032a4c0fSJoe Perches my $tabs = length($1) + 1; 3037840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3038840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3039840080a0SJoe Perches defined $lines[$linenr] && 3040840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3041032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3042032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3043032a4c0fSJoe Perches } 3044032a4c0fSJoe Perches } 3045032a4c0fSJoe Perches 3046c00df19aSJoe Perches# check indentation of a line with a break; 3047c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3048c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3049c00df19aSJoe Perches my $tabs = $1; 3050c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3051c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3052c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3053c00df19aSJoe Perches } 3054c00df19aSJoe Perches } 3055c00df19aSJoe Perches 30561ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 30571ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 30581ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 30591ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 30601ba8dfd1SKees Cook } 30611ba8dfd1SKees Cook 3062c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3063cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3064000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3065000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3066c2fdda0dSAndy Whitcroft } 306722f2a2efSAndy Whitcroft 306842e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 306942e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 307042e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 3071000d1cc1SJoe Perches ERROR("CSYNC", 3072000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 307342e41c54SMike Frysinger } 307442e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 307542e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 3076000d1cc1SJoe Perches ERROR("SSYNC", 3077000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 307842e41c54SMike Frysinger } 307942e41c54SMike Frysinger 308056e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 308156e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 308256e77d70SJoe Perches WARN("HOTPLUG_SECTION", 308356e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 308456e77d70SJoe Perches } 308556e77d70SJoe Perches 30869c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 30872b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 30882b474a1aSAndy Whitcroft $realline_next); 30893e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 30903e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 30911b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3092170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3093f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3094171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3095171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3096171ae1a4SAndy Whitcroft 30973e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 30983e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 30993e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 31003e469cdcSAndy Whitcroft # until we hit end of it. 31013e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 31023e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 31033e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 31043e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 31053e469cdcSAndy Whitcroft } 3106f74bd194SAndy Whitcroft 31072b474a1aSAndy Whitcroft # Find the real next line. 31082b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 31092b474a1aSAndy Whitcroft if (defined $realline_next && 31102b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 31112b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 31122b474a1aSAndy Whitcroft $realline_next++; 31132b474a1aSAndy Whitcroft } 31142b474a1aSAndy Whitcroft 3115171ae1a4SAndy Whitcroft my $s = $stat; 3116171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3117cf655043SAndy Whitcroft 3118c2fdda0dSAndy Whitcroft # Ignore goto labels. 3119171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3120c2fdda0dSAndy Whitcroft 3121c2fdda0dSAndy Whitcroft # Ignore functions being called 3122171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3123c2fdda0dSAndy Whitcroft 3124463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3125463f2864SAndy Whitcroft 3126c45dcabdSAndy Whitcroft # declarations always start with types 3127d2506586SAndy 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) { 3128c45dcabdSAndy Whitcroft my $type = $1; 3129c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3130c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3131c45dcabdSAndy Whitcroft 31326c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3133a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3134c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3135c2fdda0dSAndy Whitcroft } 31368905a67cSAndy Whitcroft 31376c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 313865863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3139c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 31409c0ca6f9SAndy Whitcroft } 31418905a67cSAndy Whitcroft 31428905a67cSAndy Whitcroft # Check for any sort of function declaration. 31438905a67cSAndy Whitcroft # int foo(something bar, other baz); 31448905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3145171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 31468905a67cSAndy Whitcroft my ($name_len) = length($1); 31478905a67cSAndy Whitcroft 3148cf655043SAndy Whitcroft my $ctx = $s; 3149773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 31508905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3151cf655043SAndy Whitcroft 31528905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3153c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 31548905a67cSAndy Whitcroft 3155c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 31568905a67cSAndy Whitcroft } 31578905a67cSAndy Whitcroft } 31588905a67cSAndy Whitcroft } 31598905a67cSAndy Whitcroft 31609c0ca6f9SAndy Whitcroft } 31619c0ca6f9SAndy Whitcroft 316200df344fSAndy Whitcroft# 316300df344fSAndy Whitcroft# Checks which may be anchored in the context. 316400df344fSAndy Whitcroft# 316500df344fSAndy Whitcroft 316600df344fSAndy Whitcroft# Check for switch () and associated case and default 316700df344fSAndy Whitcroft# statements should be at the same indent. 316800df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 316900df344fSAndy Whitcroft my $err = ''; 317000df344fSAndy Whitcroft my $sep = ''; 317100df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 317200df344fSAndy Whitcroft shift(@ctx); 317300df344fSAndy Whitcroft for my $ctx (@ctx) { 317400df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 317500df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 317600df344fSAndy Whitcroft $indent != $cindent) { 317700df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 317800df344fSAndy Whitcroft $sep = ''; 317900df344fSAndy Whitcroft } else { 318000df344fSAndy Whitcroft $sep = "[...]\n"; 318100df344fSAndy Whitcroft } 318200df344fSAndy Whitcroft } 318300df344fSAndy Whitcroft if ($err ne '') { 3184000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3185000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3186de7d4f0eSAndy Whitcroft } 3187de7d4f0eSAndy Whitcroft } 3188de7d4f0eSAndy Whitcroft 3189de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3190de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 31910fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3192773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3193773647a0SAndy Whitcroft 31949c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 31958eef05ddSJoe Perches 31968eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 31978eef05ddSJoe Perches WARN("DEEP_INDENTATION", 31988eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 31998eef05ddSJoe Perches } 32008eef05ddSJoe Perches 3201de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3202de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3203de7d4f0eSAndy Whitcroft 3204548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3205548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3206de7d4f0eSAndy Whitcroft 3207548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3208548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3209548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3210548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3211548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3212773647a0SAndy Whitcroft $ctx_ln++; 3213773647a0SAndy Whitcroft } 3214548596d5SAndy Whitcroft 321553210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 321653210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3217773647a0SAndy Whitcroft 3218773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3219000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3220000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 322101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 322200df344fSAndy Whitcroft } 3223773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3224773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3225773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3226773647a0SAndy Whitcroft { 32279c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 32289c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3229000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3230000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 323101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 32329c0ca6f9SAndy Whitcroft } 32339c0ca6f9SAndy Whitcroft } 323400df344fSAndy Whitcroft } 323500df344fSAndy Whitcroft 32364d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 32370fe3dc2bSJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 32383e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 32393e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 32403e469cdcSAndy Whitcroft if (!defined $stat); 32414d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 32424d001e4dSAndy Whitcroft 32434d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 32444d001e4dSAndy Whitcroft 32459f5af480SJoe Perches # remove inline comments 32469f5af480SJoe Perches $s =~ s/$;/ /g; 32479f5af480SJoe Perches $c =~ s/$;/ /g; 32484d001e4dSAndy Whitcroft 32494d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 32506f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 32516f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 32524d001e4dSAndy Whitcroft 32539f5af480SJoe Perches # Make sure we remove the line prefixes as we have 32549f5af480SJoe Perches # none on the first line, and are going to readd them 32559f5af480SJoe Perches # where necessary. 32569f5af480SJoe Perches $s =~ s/\n./\n/gs; 32579f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 32589f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 32599f5af480SJoe Perches } 32609f5af480SJoe Perches 32614d001e4dSAndy Whitcroft # We want to check the first line inside the block 32624d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 32634d001e4dSAndy Whitcroft # 1) any blank line termination 32644d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 32654d001e4dSAndy Whitcroft # 3) any do (...) { 32664d001e4dSAndy Whitcroft my $continuation = 0; 32674d001e4dSAndy Whitcroft my $check = 0; 32684d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 32694d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 32704d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 32714d001e4dSAndy Whitcroft $continuation = 1; 32724d001e4dSAndy Whitcroft } 32739bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 32744d001e4dSAndy Whitcroft $check = 1; 32754d001e4dSAndy Whitcroft $cond_lines++; 32764d001e4dSAndy Whitcroft } 32774d001e4dSAndy Whitcroft 32784d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 32794d001e4dSAndy Whitcroft # preprocessor statement. 32804d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 32814d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 32824d001e4dSAndy Whitcroft $check = 0; 32834d001e4dSAndy Whitcroft } 32844d001e4dSAndy Whitcroft 32859bd49efeSAndy Whitcroft my $cond_ptr = -1; 3286740504c6SAndy Whitcroft $continuation = 0; 32879bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 32889bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 32894d001e4dSAndy Whitcroft 3290f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3291f16fa28fSAndy Whitcroft # is not linear. 3292f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3293f16fa28fSAndy Whitcroft $check = 0; 3294f16fa28fSAndy Whitcroft } 3295f16fa28fSAndy Whitcroft 32969bd49efeSAndy Whitcroft # Ignore: 32979bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 32989bd49efeSAndy Whitcroft # 2) preprocessor lines, and 32999bd49efeSAndy Whitcroft # 3) labels. 3300740504c6SAndy Whitcroft if ($continuation || 3301740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 33029bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 33039bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3304740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 330530dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 33069bd49efeSAndy Whitcroft $cond_lines++; 33079bd49efeSAndy Whitcroft } 33084d001e4dSAndy Whitcroft } 330930dad6ebSAndy Whitcroft } 33104d001e4dSAndy Whitcroft 33114d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 33124d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 33134d001e4dSAndy Whitcroft 33144d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 33154d001e4dSAndy Whitcroft # this is not this patch's fault. 33164d001e4dSAndy Whitcroft if (!defined($stat_real) || 33174d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 33184d001e4dSAndy Whitcroft $check = 0; 33194d001e4dSAndy Whitcroft } 33204d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 33214d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 33224d001e4dSAndy Whitcroft } 33234d001e4dSAndy Whitcroft 33249bd49efeSAndy 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"; 33254d001e4dSAndy Whitcroft 33269f5af480SJoe Perches if ($check && $s ne '' && 33279f5af480SJoe Perches (($sindent % 8) != 0 || 33289f5af480SJoe Perches ($sindent < $indent) || 33299f5af480SJoe Perches ($sindent > $indent + 8))) { 3330000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3331000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 33324d001e4dSAndy Whitcroft } 33334d001e4dSAndy Whitcroft } 33344d001e4dSAndy Whitcroft 33356c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 33366c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 33371f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 33381f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 33396c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3340c2fdda0dSAndy Whitcroft if ($dbg_values) { 3341c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3342cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3343cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 33441f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3345c2fdda0dSAndy Whitcroft } 33466c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 33476c72ffaaSAndy Whitcroft 334800df344fSAndy Whitcroft#ignore lines not being added 33493705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 335000df344fSAndy Whitcroft 3351a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3352c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3353a1ce18e4SJoe Perches my $type = $1; 3354a1ce18e4SJoe Perches my $var = $2; 3355207a8e84SJoe Perches $var = "" if (!defined $var); 3356207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3357a1ce18e4SJoe Perches my $sign = $1; 3358a1ce18e4SJoe Perches my $pointer = $2; 3359a1ce18e4SJoe Perches 3360a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3361a1ce18e4SJoe Perches 3362a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3363a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3364a1ce18e4SJoe Perches $fix) { 3365a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3366207a8e84SJoe Perches my $comp_pointer = $pointer; 3367207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 3368207a8e84SJoe Perches $decl .= $comp_pointer; 3369207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 3370207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 3371a1ce18e4SJoe Perches } 3372a1ce18e4SJoe Perches } 3373a1ce18e4SJoe Perches } 3374a1ce18e4SJoe Perches 3375653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 33767429c690SAndy Whitcroft if ($dbg_type) { 33777429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3378000d1cc1SJoe Perches ERROR("TEST_TYPE", 3379000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 33807429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3381000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3382000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 33837429c690SAndy Whitcroft } 3384653d4876SAndy Whitcroft next; 3385653d4876SAndy Whitcroft } 3386a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3387a1ef277eSAndy Whitcroft if ($dbg_attr) { 33889360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3389000d1cc1SJoe Perches ERROR("TEST_ATTR", 3390000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 33919360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3392000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3393000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3394a1ef277eSAndy Whitcroft } 3395a1ef277eSAndy Whitcroft next; 3396a1ef277eSAndy Whitcroft } 3397653d4876SAndy Whitcroft 3398f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 339999423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 340099423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3401d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3402d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3403f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3404f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3405f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3406d752fcc8SJoe Perches my $fixedline = $prevrawline; 3407d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3408f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3409d752fcc8SJoe Perches $fixedline = $line; 3410d752fcc8SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1/; 3411f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3412d752fcc8SJoe Perches } 3413f0a594c1SAndy Whitcroft } 3414f0a594c1SAndy Whitcroft 341500df344fSAndy Whitcroft# 341600df344fSAndy Whitcroft# Checks which are anchored on the added line. 341700df344fSAndy Whitcroft# 341800df344fSAndy Whitcroft 3419653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3420c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3421653d4876SAndy Whitcroft my $path = $1; 3422653d4876SAndy Whitcroft if ($path =~ m{//}) { 3423000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3424495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3425495e9d84SJoe Perches } 3426495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3427495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3428495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3429653d4876SAndy Whitcroft } 3430653d4876SAndy Whitcroft } 3431653d4876SAndy Whitcroft 343200df344fSAndy Whitcroft# no C99 // comments 343300df344fSAndy Whitcroft if ($line =~ m{//}) { 34343705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 34353705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 34363705ce5bSJoe Perches $fix) { 3437194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 34383705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 34393705ce5bSJoe Perches my $comment = trim($1); 3440194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 34413705ce5bSJoe Perches } 34423705ce5bSJoe Perches } 344300df344fSAndy Whitcroft } 344400df344fSAndy Whitcroft # Remove C99 comments. 34450a920b5bSAndy Whitcroft $line =~ s@//.*@@; 34466c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 34470a920b5bSAndy Whitcroft 34482b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 34492b474a1aSAndy Whitcroft# the whole statement. 34502b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 34512b474a1aSAndy Whitcroft if (defined $realline_next && 34522b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 34532b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 34542b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 34552b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 34563cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 34573cbf62dfSAndy Whitcroft # a prefix: 34583cbf62dfSAndy Whitcroft # XXX(foo); 34593cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3460653d4876SAndy Whitcroft my $name = $1; 346187a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 34623cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 34633cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 34643cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 34653cbf62dfSAndy Whitcroft 34663cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 34672b474a1aSAndy Whitcroft \n.}\s*$| 346848012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 346948012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 347048012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 34712b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 34722b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 347348012058SAndy Whitcroft )/x) { 34742b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 34752b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 34762b474a1aSAndy Whitcroft } else { 34772b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 34780a920b5bSAndy Whitcroft } 34790a920b5bSAndy Whitcroft } 34802b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 34812b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 34822b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 34832b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 34842b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 34852b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 34862b474a1aSAndy Whitcroft } 34872b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 34882b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3489000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3490000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 34912b474a1aSAndy Whitcroft } 34920a920b5bSAndy Whitcroft 34935150bda4SJoe Eloff# check for global initialisers. 34946d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 3495d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 34966d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 3497d5e616fcSJoe Perches $fix) { 34986d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 3499d5e616fcSJoe Perches } 3500f0a594c1SAndy Whitcroft } 35010a920b5bSAndy Whitcroft# check for static initialisers. 35026d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 3503d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 35046d32f7a3SJoe Perches "do not initialise statics to $1\n" . 3505d5e616fcSJoe Perches $herecurr) && 3506d5e616fcSJoe Perches $fix) { 35076d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 3508d5e616fcSJoe Perches } 35090a920b5bSAndy Whitcroft } 35100a920b5bSAndy Whitcroft 35111813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 35121813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 35131813087dSJoe Perches my $tmp = trim($1); 35141813087dSJoe Perches WARN("MISORDERED_TYPE", 35151813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 35161813087dSJoe Perches } 35171813087dSJoe Perches 3518cb710ecaSJoe Perches# check for static const char * arrays. 3519cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3520000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3521000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3522cb710ecaSJoe Perches $herecurr); 3523cb710ecaSJoe Perches } 3524cb710ecaSJoe Perches 3525cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3526cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3527000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3528000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3529cb710ecaSJoe Perches $herecurr); 3530cb710ecaSJoe Perches } 3531cb710ecaSJoe Perches 3532ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3533ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3534ab7e23f3SJoe Perches my $found = $1; 3535ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3536ab7e23f3SJoe Perches WARN("CONST_CONST", 3537ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3538ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3539ab7e23f3SJoe Perches WARN("CONST_CONST", 3540ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3541ab7e23f3SJoe Perches } 3542ab7e23f3SJoe Perches } 3543ab7e23f3SJoe Perches 35449b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 35459b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 35469b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 35479b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 35489b0fa60dSJoe Perches $herecurr); 35499b0fa60dSJoe Perches } 35509b0fa60dSJoe Perches 3551b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3552b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3553b598b670SJoe Perches my $array = $1; 3554b598b670SJoe 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*\))@) { 3555b598b670SJoe Perches my $array_div = $1; 3556b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3557b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3558b598b670SJoe Perches $fix) { 3559b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3560b598b670SJoe Perches } 3561b598b670SJoe Perches } 3562b598b670SJoe Perches } 3563b598b670SJoe Perches 3564b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3565b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3566b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3567b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3568b36190c5SJoe Perches $fix) { 3569194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3570b36190c5SJoe Perches } 3571b36190c5SJoe Perches } 3572b36190c5SJoe Perches 357392e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 357492e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 357592e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 357692e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 357792e112fdSJoe Perches $fix) { 3578194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 357992e112fdSJoe Perches } 358093ed0e2dSJoe Perches } 358193ed0e2dSJoe Perches 3582653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3583653d4876SAndy Whitcroft# make sense. 3584653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 35858054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3586c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 35878ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 3588653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 3589000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3590000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 35910a920b5bSAndy Whitcroft } 35920a920b5bSAndy Whitcroft 35930a920b5bSAndy Whitcroft# * goes on variable not on type 359465863862SAndy Whitcroft # (char*[ const]) 3595bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3596bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 35973705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3598d8aaf121SAndy Whitcroft 359965863862SAndy Whitcroft # Should start with a space. 360065863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 360165863862SAndy Whitcroft # Should not end with a space. 360265863862SAndy Whitcroft $to =~ s/\s+$//; 360365863862SAndy Whitcroft # '*'s should not have spaces between. 3604f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 360565863862SAndy Whitcroft } 3606d8aaf121SAndy Whitcroft 36073705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 360865863862SAndy Whitcroft if ($from ne $to) { 36093705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 36103705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 36113705ce5bSJoe Perches $fix) { 36123705ce5bSJoe Perches my $sub_from = $ident; 36133705ce5bSJoe Perches my $sub_to = $ident; 36143705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3615194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36163705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 36173705ce5bSJoe Perches } 361865863862SAndy Whitcroft } 3619bfcb2cc7SAndy Whitcroft } 3620bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3621bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 36223705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3623d8aaf121SAndy Whitcroft 362465863862SAndy Whitcroft # Should start with a space. 362565863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 362665863862SAndy Whitcroft # Should not end with a space. 362765863862SAndy Whitcroft $to =~ s/\s+$//; 362865863862SAndy Whitcroft # '*'s should not have spaces between. 3629f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 363065863862SAndy Whitcroft } 363165863862SAndy Whitcroft # Modifiers should have spaces. 363265863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 363365863862SAndy Whitcroft 36343705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3635667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 36363705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 36373705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 36383705ce5bSJoe Perches $fix) { 36393705ce5bSJoe Perches 36403705ce5bSJoe Perches my $sub_from = $match; 36413705ce5bSJoe Perches my $sub_to = $match; 36423705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3643194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36443705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 36453705ce5bSJoe Perches } 364665863862SAndy Whitcroft } 36470a920b5bSAndy Whitcroft } 36480a920b5bSAndy Whitcroft 36499d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 36509d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 36519d3e3c70SJoe Perches my $msg_type = \&WARN; 36529d3e3c70SJoe Perches $msg_type = \&CHK if ($file); 36539d3e3c70SJoe Perches &{$msg_type}("AVOID_BUG", 36549d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 36559d3e3c70SJoe Perches } 36560a920b5bSAndy Whitcroft 36579d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 36588905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3659000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3660000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 36618905a67cSAndy Whitcroft } 36628905a67cSAndy Whitcroft 366317441227SJoe Perches# check for uses of printk_ratelimit 366417441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3665000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3666000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 366717441227SJoe Perches } 366817441227SJoe Perches 366900df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 367000df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 367100df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 367225985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 367300df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 3674f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 367500df344fSAndy Whitcroft my $ok = 0; 367600df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 367700df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 367825985edcSLucas De Marchi # we have a preceding printk if it ends 367900df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 368000df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 368100df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 368200df344fSAndy Whitcroft $ok = 1; 368300df344fSAndy Whitcroft } 368400df344fSAndy Whitcroft last; 368500df344fSAndy Whitcroft } 368600df344fSAndy Whitcroft } 368700df344fSAndy Whitcroft if ($ok == 0) { 3688000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3689000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 36900a920b5bSAndy Whitcroft } 369100df344fSAndy Whitcroft } 36920a920b5bSAndy Whitcroft 3693243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3694243f3803SJoe Perches my $orig = $1; 3695243f3803SJoe Perches my $level = lc($orig); 3696243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 36978f26b837SJoe Perches my $level2 = $level; 36988f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3699243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3700daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3701243f3803SJoe Perches } 3702243f3803SJoe Perches 3703243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3704d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3705d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3706d5e616fcSJoe Perches $fix) { 3707194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3708d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3709d5e616fcSJoe Perches } 3710243f3803SJoe Perches } 3711243f3803SJoe Perches 3712dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3713dc139313SJoe Perches my $orig = $1; 3714dc139313SJoe Perches my $level = lc($orig); 3715dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3716dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3717dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3718dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3719dc139313SJoe Perches } 3720dc139313SJoe Perches 372191c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 372291c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 372391c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 372491c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 372591c9afafSAndy Lutomirski WARN("ENOSYS", 372691c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 372791c9afafSAndy Lutomirski } 372891c9afafSAndy Lutomirski 3729653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3730653d4876SAndy Whitcroft# or if closed on same line 37318d182478SJoe Perches if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and 37324e5d56bdSEddie Kovsky !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) { 37338d182478SJoe Perches if (ERROR("OPEN_BRACE", 37348d182478SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr) && 37358d182478SJoe Perches $fix) { 37368d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 37378d182478SJoe Perches my $fixed_line = $rawline; 37388d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 37398d182478SJoe Perches my $line1 = $1; 37408d182478SJoe Perches my $line2 = $2; 37418d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 37428d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 37438d182478SJoe Perches if ($line2 !~ /^\s*$/) { 37448d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 37458d182478SJoe Perches } 37468d182478SJoe Perches } 37470a920b5bSAndy Whitcroft } 3748653d4876SAndy Whitcroft 37498905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 37508905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 37518905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 37528d182478SJoe Perches if (ERROR("OPEN_BRACE", 37538d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 37548d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 37558d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 37568d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 37578d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 37588d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 37598d182478SJoe Perches $fixedline = $rawline; 37608d182478SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1\t/; 37618d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 37628d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 37638d182478SJoe Perches } 37648d182478SJoe Perches } 37658905a67cSAndy Whitcroft } 37668905a67cSAndy Whitcroft 37670c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 37683705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 37693705ce5bSJoe Perches if (WARN("SPACING", 37703705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 37713705ce5bSJoe Perches $fix) { 3772194f66fcSJoe Perches $fixed[$fixlinenr] =~ 37733705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 37743705ce5bSJoe Perches } 37750c73b4ebSAndy Whitcroft } 37760c73b4ebSAndy Whitcroft 377731070b5dSJoe Perches# Function pointer declarations 377831070b5dSJoe Perches# check spacing between type, funcptr, and args 377931070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 378091f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 378131070b5dSJoe Perches my $declare = $1; 378231070b5dSJoe Perches my $pre_pointer_space = $2; 378331070b5dSJoe Perches my $post_pointer_space = $3; 378431070b5dSJoe Perches my $funcname = $4; 378531070b5dSJoe Perches my $post_funcname_space = $5; 378631070b5dSJoe Perches my $pre_args_space = $6; 378731070b5dSJoe Perches 378891f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 378991f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 379091f72e9cSJoe Perches# don't need a space so don't warn for those. 379191f72e9cSJoe Perches my $post_declare_space = ""; 379291f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 379391f72e9cSJoe Perches $post_declare_space = $1; 379491f72e9cSJoe Perches $declare = rtrim($declare); 379591f72e9cSJoe Perches } 379691f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 379731070b5dSJoe Perches WARN("SPACING", 379831070b5dSJoe Perches "missing space after return type\n" . $herecurr); 379991f72e9cSJoe Perches $post_declare_space = " "; 380031070b5dSJoe Perches } 380131070b5dSJoe Perches 380231070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 380391f72e9cSJoe Perches# This test is not currently implemented because these declarations are 380491f72e9cSJoe Perches# equivalent to 380591f72e9cSJoe Perches# int foo(int bar, ...) 380691f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 380791f72e9cSJoe Perches# 380891f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 380991f72e9cSJoe Perches# WARN("SPACING", 381091f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 381191f72e9cSJoe Perches# } 381231070b5dSJoe Perches 381331070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 381431070b5dSJoe Perches if (defined $pre_pointer_space && 381531070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 381631070b5dSJoe Perches WARN("SPACING", 381731070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 381831070b5dSJoe Perches } 381931070b5dSJoe Perches 382031070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 382131070b5dSJoe Perches if (defined $post_pointer_space && 382231070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 382331070b5dSJoe Perches WARN("SPACING", 382431070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 382531070b5dSJoe Perches } 382631070b5dSJoe Perches 382731070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 382831070b5dSJoe Perches if (defined $post_funcname_space && 382931070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 383031070b5dSJoe Perches WARN("SPACING", 383131070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 383231070b5dSJoe Perches } 383331070b5dSJoe Perches 383431070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 383531070b5dSJoe Perches if (defined $pre_args_space && 383631070b5dSJoe Perches $pre_args_space =~ /^\s/) { 383731070b5dSJoe Perches WARN("SPACING", 383831070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 383931070b5dSJoe Perches } 384031070b5dSJoe Perches 384131070b5dSJoe Perches if (show_type("SPACING") && $fix) { 3842194f66fcSJoe Perches $fixed[$fixlinenr] =~ 384391f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 384431070b5dSJoe Perches } 384531070b5dSJoe Perches } 384631070b5dSJoe Perches 38478d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 38488d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3849fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3850fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 38518d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 38528d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 38538d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3854fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3855daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 38563705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 38573705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 38583705ce5bSJoe Perches $fix) { 3859194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38603705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 38613705ce5bSJoe Perches } 38628d31cfceSAndy Whitcroft } 38638d31cfceSAndy Whitcroft } 38648d31cfceSAndy Whitcroft 3865f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 38666c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3867c2fdda0dSAndy Whitcroft my $name = $1; 3868773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3869773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3870c2fdda0dSAndy Whitcroft 3871c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3872773647a0SAndy Whitcroft if ($name =~ /^(?: 3873773647a0SAndy Whitcroft if|for|while|switch|return|case| 3874773647a0SAndy Whitcroft volatile|__volatile__| 3875773647a0SAndy Whitcroft __attribute__|format|__extension__| 3876773647a0SAndy Whitcroft asm|__asm__)$/x) 3877773647a0SAndy Whitcroft { 3878c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3879c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3880c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3881c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3882773647a0SAndy Whitcroft 3883773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3884c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3885c2fdda0dSAndy Whitcroft 3886c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3887c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3888773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3889c2fdda0dSAndy Whitcroft 3890c2fdda0dSAndy Whitcroft } else { 38913705ce5bSJoe Perches if (WARN("SPACING", 38923705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 38933705ce5bSJoe Perches $fix) { 3894194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38953705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 38963705ce5bSJoe Perches } 3897f0a594c1SAndy Whitcroft } 38986c72ffaaSAndy Whitcroft } 38999a4cad4eSEric Nelson 3900653d4876SAndy Whitcroft# Check operator spacing. 39010a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 39023705ce5bSJoe Perches my $fixed_line = ""; 39033705ce5bSJoe Perches my $line_fixed = 0; 39043705ce5bSJoe Perches 39059c0ca6f9SAndy Whitcroft my $ops = qr{ 39069c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 39079c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 39089c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 39091f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 391084731623SJoe Perches \?:|\?|: 39119c0ca6f9SAndy Whitcroft }x; 3912cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 39133705ce5bSJoe Perches 39143705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 39153705ce5bSJoe Perches## foreach my $el (@elements) { 39163705ce5bSJoe Perches## print("el: <$el>\n"); 39173705ce5bSJoe Perches## } 39183705ce5bSJoe Perches 39193705ce5bSJoe Perches my @fix_elements = (); 392000df344fSAndy Whitcroft my $off = 0; 39216c72ffaaSAndy Whitcroft 39223705ce5bSJoe Perches foreach my $el (@elements) { 39233705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 39243705ce5bSJoe Perches $off += length($el); 39253705ce5bSJoe Perches } 39263705ce5bSJoe Perches 39273705ce5bSJoe Perches $off = 0; 39283705ce5bSJoe Perches 39296c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3930b34c648bSJoe Perches my $last_after = -1; 39316c72ffaaSAndy Whitcroft 39320a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 39333705ce5bSJoe Perches 39343705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 39353705ce5bSJoe Perches 39363705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 39373705ce5bSJoe Perches 39384a0df2efSAndy Whitcroft $off += length($elements[$n]); 39394a0df2efSAndy Whitcroft 394025985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3941773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3942773647a0SAndy Whitcroft my $cc = ''; 3943773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3944773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3945773647a0SAndy Whitcroft } 3946773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3947773647a0SAndy Whitcroft 39484a0df2efSAndy Whitcroft my $a = ''; 39494a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 39504a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3951cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 39524a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 39534a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3954773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 39554a0df2efSAndy Whitcroft 39560a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 39574a0df2efSAndy Whitcroft 39584a0df2efSAndy Whitcroft my $c = ''; 39590a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 39604a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 39614a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3962cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 39634a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 39644a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 39658b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 39664a0df2efSAndy Whitcroft } else { 39674a0df2efSAndy Whitcroft $c = 'E'; 39680a920b5bSAndy Whitcroft } 39690a920b5bSAndy Whitcroft 39704a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 39714a0df2efSAndy Whitcroft 39724a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 39734a0df2efSAndy Whitcroft 39746c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3975de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 39760a920b5bSAndy Whitcroft 397774048ed8SAndy Whitcroft # Pull out the value of this operator. 39786c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 39790a920b5bSAndy Whitcroft 39801f65f947SAndy Whitcroft # Get the full operator variant. 39811f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 39821f65f947SAndy Whitcroft 398313214adfSAndy Whitcroft # Ignore operators passed as parameters. 398413214adfSAndy Whitcroft if ($op_type ne 'V' && 3985d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 398613214adfSAndy Whitcroft 3987cf655043SAndy Whitcroft# # Ignore comments 3988cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 398913214adfSAndy Whitcroft 3990d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 399113214adfSAndy Whitcroft } elsif ($op eq ';') { 3992cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3993cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 39943705ce5bSJoe Perches if (ERROR("SPACING", 39953705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3996b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 39973705ce5bSJoe Perches $line_fixed = 1; 39983705ce5bSJoe Perches } 3999d8aaf121SAndy Whitcroft } 4000d8aaf121SAndy Whitcroft 4001d8aaf121SAndy Whitcroft # // is a comment 4002d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 40030a920b5bSAndy Whitcroft 4004b00e4814SJoe Perches # : when part of a bitfield 4005b00e4814SJoe Perches } elsif ($opv eq ':B') { 4006b00e4814SJoe Perches # skip the bitfield test for now 4007b00e4814SJoe Perches 40081f65f947SAndy Whitcroft # No spaces for: 40091f65f947SAndy Whitcroft # -> 4010b00e4814SJoe Perches } elsif ($op eq '->') { 40114a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 40123705ce5bSJoe Perches if (ERROR("SPACING", 40133705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4014b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 40153705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 40163705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 40173705ce5bSJoe Perches } 4018b34c648bSJoe Perches $line_fixed = 1; 40193705ce5bSJoe Perches } 40200a920b5bSAndy Whitcroft } 40210a920b5bSAndy Whitcroft 40222381097bSJoe Perches # , must not have a space before and must have a space on the right. 40230a920b5bSAndy Whitcroft } elsif ($op eq ',') { 40242381097bSJoe Perches my $rtrim_before = 0; 40252381097bSJoe Perches my $space_after = 0; 40262381097bSJoe Perches if ($ctx =~ /Wx./) { 40272381097bSJoe Perches if (ERROR("SPACING", 40282381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 40292381097bSJoe Perches $line_fixed = 1; 40302381097bSJoe Perches $rtrim_before = 1; 40312381097bSJoe Perches } 40322381097bSJoe Perches } 4033cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 40343705ce5bSJoe Perches if (ERROR("SPACING", 40353705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 40363705ce5bSJoe Perches $line_fixed = 1; 4037b34c648bSJoe Perches $last_after = $n; 40382381097bSJoe Perches $space_after = 1; 40392381097bSJoe Perches } 40402381097bSJoe Perches } 40412381097bSJoe Perches if ($rtrim_before || $space_after) { 40422381097bSJoe Perches if ($rtrim_before) { 40432381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 40442381097bSJoe Perches } else { 40452381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 40462381097bSJoe Perches } 40472381097bSJoe Perches if ($space_after) { 40482381097bSJoe Perches $good .= " "; 40493705ce5bSJoe Perches } 40500a920b5bSAndy Whitcroft } 40510a920b5bSAndy Whitcroft 40529c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 405374048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 40549c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 40559c0ca6f9SAndy Whitcroft 40569c0ca6f9SAndy Whitcroft # unary operators should have a space before and 40579c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 40589c0ca6f9SAndy Whitcroft # unary operator, or a cast 40599c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 406074048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 40610d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4062cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 40633705ce5bSJoe Perches if (ERROR("SPACING", 40643705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4065b34c648bSJoe Perches if ($n != $last_after + 2) { 4066b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 40673705ce5bSJoe Perches $line_fixed = 1; 40683705ce5bSJoe Perches } 40690a920b5bSAndy Whitcroft } 4070b34c648bSJoe Perches } 4071a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4072171ae1a4SAndy Whitcroft # A unary '*' may be const 4073171ae1a4SAndy Whitcroft 4074171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 40753705ce5bSJoe Perches if (ERROR("SPACING", 40763705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4077b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 40783705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 40793705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 40803705ce5bSJoe Perches } 4081b34c648bSJoe Perches $line_fixed = 1; 40823705ce5bSJoe Perches } 40830a920b5bSAndy Whitcroft } 40840a920b5bSAndy Whitcroft 40850a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 40860a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4087773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 40883705ce5bSJoe Perches if (ERROR("SPACING", 40893705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4090b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 40913705ce5bSJoe Perches $line_fixed = 1; 40923705ce5bSJoe Perches } 40930a920b5bSAndy Whitcroft } 4094773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4095773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 40963705ce5bSJoe Perches if (ERROR("SPACING", 40973705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4098b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 40993705ce5bSJoe Perches $line_fixed = 1; 41003705ce5bSJoe Perches } 4101653d4876SAndy Whitcroft } 4102773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 41033705ce5bSJoe Perches if (ERROR("SPACING", 41043705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4105b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 41063705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 41073705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4108773647a0SAndy Whitcroft } 4109b34c648bSJoe Perches $line_fixed = 1; 41103705ce5bSJoe Perches } 41113705ce5bSJoe Perches } 41120a920b5bSAndy Whitcroft 41130a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 41149c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 41159c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 41169c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4117c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4118c2fdda0dSAndy Whitcroft $op eq '%') 41190a920b5bSAndy Whitcroft { 4120d2e025f3SJoe Perches if ($check) { 4121d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4122d2e025f3SJoe Perches if (CHK("SPACING", 4123d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4124d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4125d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4126d2e025f3SJoe Perches $line_fixed = 1; 4127d2e025f3SJoe Perches } 4128d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4129d2e025f3SJoe Perches if (CHK("SPACING", 4130d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4131d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4132d2e025f3SJoe Perches $line_fixed = 1; 4133d2e025f3SJoe Perches } 4134d2e025f3SJoe Perches } 4135d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 41363705ce5bSJoe Perches if (ERROR("SPACING", 41373705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4138b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4139b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4140b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4141b34c648bSJoe Perches } 41423705ce5bSJoe Perches $line_fixed = 1; 41433705ce5bSJoe Perches } 41440a920b5bSAndy Whitcroft } 41450a920b5bSAndy Whitcroft 41461f65f947SAndy Whitcroft # A colon needs no spaces before when it is 41471f65f947SAndy Whitcroft # terminating a case value or a label. 41481f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 41491f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 41503705ce5bSJoe Perches if (ERROR("SPACING", 41513705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4152b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 41533705ce5bSJoe Perches $line_fixed = 1; 41543705ce5bSJoe Perches } 41551f65f947SAndy Whitcroft } 41561f65f947SAndy Whitcroft 41570a920b5bSAndy Whitcroft # All the others need spaces both sides. 4158cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 41591f65f947SAndy Whitcroft my $ok = 0; 41601f65f947SAndy Whitcroft 416122f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 41621f65f947SAndy Whitcroft if (($op eq '<' && 41631f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 41641f65f947SAndy Whitcroft ($op eq '>' && 41651f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 41661f65f947SAndy Whitcroft { 41671f65f947SAndy Whitcroft $ok = 1; 41681f65f947SAndy Whitcroft } 41691f65f947SAndy Whitcroft 4170e0df7e1fSJoe Perches # for asm volatile statements 4171e0df7e1fSJoe Perches # ignore a colon with another 4172e0df7e1fSJoe Perches # colon immediately before or after 4173e0df7e1fSJoe Perches if (($op eq ':') && 4174e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4175e0df7e1fSJoe Perches $ok = 1; 4176e0df7e1fSJoe Perches } 4177e0df7e1fSJoe Perches 417884731623SJoe Perches # messages are ERROR, but ?: are CHK 41791f65f947SAndy Whitcroft if ($ok == 0) { 418084731623SJoe Perches my $msg_type = \&ERROR; 418184731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 418284731623SJoe Perches 418384731623SJoe Perches if (&{$msg_type}("SPACING", 41843705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4185b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4186b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4187b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4188b34c648bSJoe Perches } 41893705ce5bSJoe Perches $line_fixed = 1; 41903705ce5bSJoe Perches } 41910a920b5bSAndy Whitcroft } 419222f2a2efSAndy Whitcroft } 41934a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 41943705ce5bSJoe Perches 41953705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 41963705ce5bSJoe Perches 41973705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 41980a920b5bSAndy Whitcroft } 41993705ce5bSJoe Perches 42003705ce5bSJoe Perches if (($#elements % 2) == 0) { 42013705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 42023705ce5bSJoe Perches } 42033705ce5bSJoe Perches 4204194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4205194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 42063705ce5bSJoe Perches } 42073705ce5bSJoe Perches 42083705ce5bSJoe Perches 42090a920b5bSAndy Whitcroft } 42100a920b5bSAndy Whitcroft 4211786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4212d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4213786b6326SJoe Perches if (WARN("SPACING", 4214786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4215786b6326SJoe Perches $fix) { 4216194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4217786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4218786b6326SJoe Perches } 4219786b6326SJoe Perches } 4220786b6326SJoe Perches 4221f0a594c1SAndy Whitcroft# check for multiple assignments 4222f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4223000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4224000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4225f0a594c1SAndy Whitcroft } 4226f0a594c1SAndy Whitcroft 422722f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 422822f2a2efSAndy Whitcroft## # continuation. 422922f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 423022f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 423122f2a2efSAndy Whitcroft## 423222f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 423322f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 423422f2a2efSAndy Whitcroft## my $ln = $line; 423522f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 423622f2a2efSAndy Whitcroft## } 423722f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4238000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4239000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 424022f2a2efSAndy Whitcroft## } 424122f2a2efSAndy Whitcroft## } 4242f0a594c1SAndy Whitcroft 42430a920b5bSAndy Whitcroft#need space before brace following if, while, etc 42446b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 42454e5d56bdSEddie Kovsky $line =~ /do\{/) { 42463705ce5bSJoe Perches if (ERROR("SPACING", 42473705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 42483705ce5bSJoe Perches $fix) { 4249194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/; 42503705ce5bSJoe Perches } 4251de7d4f0eSAndy Whitcroft } 4252de7d4f0eSAndy Whitcroft 4253c4a62ef9SJoe Perches## # check for blank lines before declarations 4254c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4255c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4256c4a62ef9SJoe Perches## WARN("SPACING", 4257c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4258c4a62ef9SJoe Perches## } 4259c4a62ef9SJoe Perches## 4260c4a62ef9SJoe Perches 4261de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4262de7d4f0eSAndy Whitcroft# on the line 4263de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4264d5e616fcSJoe Perches if (ERROR("SPACING", 4265d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4266d5e616fcSJoe Perches $fix) { 4267194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4268d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4269d5e616fcSJoe Perches } 42700a920b5bSAndy Whitcroft } 42710a920b5bSAndy Whitcroft 427222f2a2efSAndy Whitcroft# check spacing on square brackets 427322f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 42743705ce5bSJoe Perches if (ERROR("SPACING", 42753705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 42763705ce5bSJoe Perches $fix) { 4277194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42783705ce5bSJoe Perches s/\[\s+/\[/; 42793705ce5bSJoe Perches } 428022f2a2efSAndy Whitcroft } 428122f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 42823705ce5bSJoe Perches if (ERROR("SPACING", 42833705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 42843705ce5bSJoe Perches $fix) { 4285194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42863705ce5bSJoe Perches s/\s+\]/\]/; 42873705ce5bSJoe Perches } 428822f2a2efSAndy Whitcroft } 428922f2a2efSAndy Whitcroft 4290c45dcabdSAndy Whitcroft# check spacing on parentheses 42919c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 42929c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 42933705ce5bSJoe Perches if (ERROR("SPACING", 42943705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 42953705ce5bSJoe Perches $fix) { 4296194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42973705ce5bSJoe Perches s/\(\s+/\(/; 42983705ce5bSJoe Perches } 429922f2a2efSAndy Whitcroft } 430013214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4301c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4302c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 43033705ce5bSJoe Perches if (ERROR("SPACING", 43043705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 43053705ce5bSJoe Perches $fix) { 4306194f66fcSJoe Perches $fixed[$fixlinenr] =~ 43073705ce5bSJoe Perches s/\s+\)/\)/; 43083705ce5bSJoe Perches } 430922f2a2efSAndy Whitcroft } 431022f2a2efSAndy Whitcroft 4311e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4312e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4313e2826fd0SJoe Perches 4314e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4315ea4acbb1SJoe Perches my $var = $1; 4316ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4317ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4318ea4acbb1SJoe Perches $fix) { 4319ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4320ea4acbb1SJoe Perches } 4321ea4acbb1SJoe Perches } 4322ea4acbb1SJoe Perches 4323ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4324ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4325ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4326ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4327ea4acbb1SJoe Perches my $var = $2; 4328ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4329ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4330ea4acbb1SJoe Perches $fix) { 4331ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4332ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4333ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4334ea4acbb1SJoe Perches } 4335e2826fd0SJoe Perches } 4336e2826fd0SJoe Perches 43370a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 43384a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 43390a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 43403705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 43413705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 43423705ce5bSJoe Perches $fix) { 4343194f66fcSJoe Perches $fixed[$fixlinenr] =~ 43443705ce5bSJoe Perches s/^(.)\s+/$1/; 43453705ce5bSJoe Perches } 43460a920b5bSAndy Whitcroft } 43470a920b5bSAndy Whitcroft 43485b9553abSJoe Perches# return is not a function 4349507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4350c45dcabdSAndy Whitcroft my $spacing = $1; 4351507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 43525b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 43535b9553abSJoe Perches my $value = $1; 43545b9553abSJoe Perches $value = deparenthesize($value); 43555b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4356000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4357000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 43585b9553abSJoe Perches } 4359c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4360000d1cc1SJoe Perches ERROR("SPACING", 4361000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4362c45dcabdSAndy Whitcroft } 4363c45dcabdSAndy Whitcroft } 4364507e5141SJoe Perches 4365b43ae21bSJoe Perches# unnecessary return in a void function 4366b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4367b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4368b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4369b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4370b43ae21bSJoe Perches $linenr >= 3 && 4371b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4372b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 43739819cf25SJoe Perches WARN("RETURN_VOID", 4374b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 43759819cf25SJoe Perches } 43769819cf25SJoe Perches 4377189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4378189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4379189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4380189248d8SJoe Perches my $openparens = $1; 4381189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4382189248d8SJoe Perches my $msg = ""; 4383189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4384189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4385189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4386189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4387189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4388189248d8SJoe Perches } 4389189248d8SJoe Perches } 4390189248d8SJoe Perches 4391c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4392c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4393c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4394c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 4395c5595fa2SJoe Perches if ($^V && $^V ge 5.10.0 && 4396c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4397c5595fa2SJoe Perches my $lead = $1; 4398c5595fa2SJoe Perches my $const = $2; 4399c5595fa2SJoe Perches my $comp = $3; 4400c5595fa2SJoe Perches my $to = $4; 4401c5595fa2SJoe Perches my $newcomp = $comp; 4402f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 4403c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4404c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4405c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4406c5595fa2SJoe Perches $fix) { 4407c5595fa2SJoe Perches if ($comp eq "<") { 4408c5595fa2SJoe Perches $newcomp = ">"; 4409c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4410c5595fa2SJoe Perches $newcomp = ">="; 4411c5595fa2SJoe Perches } elsif ($comp eq ">") { 4412c5595fa2SJoe Perches $newcomp = "<"; 4413c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4414c5595fa2SJoe Perches $newcomp = "<="; 4415c5595fa2SJoe Perches } 4416c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4417c5595fa2SJoe Perches } 4418c5595fa2SJoe Perches } 4419c5595fa2SJoe Perches 4420f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4421f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 442253a3c448SAndy Whitcroft my $name = $1; 442353a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4424000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4425f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 442653a3c448SAndy Whitcroft } 442753a3c448SAndy Whitcroft } 4428c45dcabdSAndy Whitcroft 44290a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 44304a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 44313705ce5bSJoe Perches if (ERROR("SPACING", 44323705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 44333705ce5bSJoe Perches $fix) { 4434194f66fcSJoe Perches $fixed[$fixlinenr] =~ 44353705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 44363705ce5bSJoe Perches } 44370a920b5bSAndy Whitcroft } 44380a920b5bSAndy Whitcroft 4439f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4440f5fe35ddSAndy Whitcroft# statements after the conditional. 4441170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 44423e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 44433e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 44443e469cdcSAndy Whitcroft if (!defined $stat); 4445170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4446170d3a22SAndy Whitcroft $remain_next, $off_next); 4447170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4448170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4449170d3a22SAndy Whitcroft 4450170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4451170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4452170d3a22SAndy Whitcroft # then count those as offsets. 4453170d3a22SAndy Whitcroft my ($whitespace) = 4454170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4455170d3a22SAndy Whitcroft my $offset = 4456170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4457170d3a22SAndy Whitcroft 4458170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4459170d3a22SAndy Whitcroft $offset} = 1; 4460170d3a22SAndy Whitcroft } 4461170d3a22SAndy Whitcroft } 4462170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4463c11230f4SJoe Perches defined($stat) && defined($cond) && 4464170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4465171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 44668905a67cSAndy Whitcroft 4467b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4468000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4469000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 44708905a67cSAndy Whitcroft } 44718905a67cSAndy Whitcroft 44728905a67cSAndy Whitcroft # Find out what is on the end of the line after the 44738905a67cSAndy Whitcroft # conditional. 4474773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 44758905a67cSAndy Whitcroft $s =~ s/\n.*//g; 447613214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 447753210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 447853210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4479773647a0SAndy Whitcroft { 4480bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4481bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4482bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 448342bdf74cSHidetoshi Seto my $stat_real = ''; 4484bb44ad39SAndy Whitcroft 448542bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 448642bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4487bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4488bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4489bb44ad39SAndy Whitcroft } 4490bb44ad39SAndy Whitcroft 4491000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4492000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 44938905a67cSAndy Whitcroft } 44948905a67cSAndy Whitcroft } 44958905a67cSAndy Whitcroft 449613214adfSAndy Whitcroft# Check for bitwise tests written as boolean 449713214adfSAndy Whitcroft if ($line =~ / 449813214adfSAndy Whitcroft (?: 449913214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 450013214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 450113214adfSAndy Whitcroft (?:\&\&|\|\|) 450213214adfSAndy Whitcroft | 450313214adfSAndy Whitcroft (?:\&\&|\|\|) 450413214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 450513214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 450613214adfSAndy Whitcroft )/x) 450713214adfSAndy Whitcroft { 4508000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4509000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 451013214adfSAndy Whitcroft } 451113214adfSAndy Whitcroft 45128905a67cSAndy Whitcroft# if and else should not have general statements after it 451313214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 451413214adfSAndy Whitcroft my $s = $1; 451513214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 451613214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4517000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4518000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 45190a920b5bSAndy Whitcroft } 452013214adfSAndy Whitcroft } 452139667782SAndy Whitcroft# if should not continue a brace 452239667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4523000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4524048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 452539667782SAndy Whitcroft $herecurr); 452639667782SAndy Whitcroft } 4527a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4528a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4529a1080bf8SAndy Whitcroft $line !~ /\G(?: 45303fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4531a1080bf8SAndy Whitcroft \s*return\s+ 4532a1080bf8SAndy Whitcroft )/xg) 4533a1080bf8SAndy Whitcroft { 4534000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4535000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4536a1080bf8SAndy Whitcroft } 45370a920b5bSAndy Whitcroft 45380a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 45390a920b5bSAndy Whitcroft # indent level to be relevant to each other. 45408b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 45410a920b5bSAndy Whitcroft $previndent == $indent) { 45428b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 45438b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 45448b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 45458b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 45468b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 45478b8856f4SJoe Perches my $fixedline = $prevrawline; 45488b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 45498b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 45508b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 45518b8856f4SJoe Perches } 45528b8856f4SJoe Perches $fixedline = $rawline; 45538b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 45548b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 45558b8856f4SJoe Perches } 45560a920b5bSAndy Whitcroft } 45570a920b5bSAndy Whitcroft 45588b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4559c2fdda0dSAndy Whitcroft $previndent == $indent) { 4560c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4561c2fdda0dSAndy Whitcroft 4562c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4563c2fdda0dSAndy Whitcroft # conditional. 4564773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4565c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4566c2fdda0dSAndy Whitcroft 4567c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 45688b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 45698b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 45708b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 45718b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 45728b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 45738b8856f4SJoe Perches my $fixedline = $prevrawline; 45748b8856f4SJoe Perches my $trailing = $rawline; 45758b8856f4SJoe Perches $trailing =~ s/^\+//; 45768b8856f4SJoe Perches $trailing = trim($trailing); 45778b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 45788b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 45798b8856f4SJoe Perches } 4580c2fdda0dSAndy Whitcroft } 4581c2fdda0dSAndy Whitcroft } 4582c2fdda0dSAndy Whitcroft 458395e2c602SJoe Perches#Specific variable tests 4584323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4585323c1260SJoe Perches my $var = $1; 458695e2c602SJoe Perches 458795e2c602SJoe Perches#gcc binary extension 458895e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4589d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4590d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4591d5e616fcSJoe Perches $fix) { 4592d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4593194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4594d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4595d5e616fcSJoe Perches } 459695e2c602SJoe Perches } 459795e2c602SJoe Perches 459895e2c602SJoe Perches#CamelCase 4599807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4600be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 460122735ce8SJoe Perches#Ignore Page<foo> variants 4602807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 460322735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4604f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4605f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4606f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 46077e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 46087e781f67SJoe Perches my $word = $1; 46097e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4610d8b07710SJoe Perches if ($check) { 4611d8b07710SJoe Perches seed_camelcase_includes(); 4612d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4613d8b07710SJoe Perches seed_camelcase_file($realfile); 4614d8b07710SJoe Perches $camelcase_file_seeded = 1; 4615d8b07710SJoe Perches } 4616d8b07710SJoe Perches } 46177e781f67SJoe Perches if (!defined $camelcase{$word}) { 46187e781f67SJoe Perches $camelcase{$word} = 1; 4619be79794bSJoe Perches CHK("CAMELCASE", 46207e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 46217e781f67SJoe Perches } 4622323c1260SJoe Perches } 4623323c1260SJoe Perches } 46243445686aSJoe Perches } 46250a920b5bSAndy Whitcroft 46260a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4627d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4628d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4629d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4630d5e616fcSJoe Perches $fix) { 4631194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4632d5e616fcSJoe Perches } 46330a920b5bSAndy Whitcroft } 46340a920b5bSAndy Whitcroft 46350e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 46360e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4637c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4638e09dec48SAndy Whitcroft my $file = "$1.h"; 4639e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4640e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4641e09dec48SAndy Whitcroft $realfile ne $checkfile && 46427840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4643c45dcabdSAndy Whitcroft { 46440e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 46450e212e0aSFabian Frederick if ($asminclude > 0) { 4646e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4647000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4648000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4649e09dec48SAndy Whitcroft } else { 4650000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4651000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4652e09dec48SAndy Whitcroft } 46530a920b5bSAndy Whitcroft } 46540a920b5bSAndy Whitcroft } 46550e212e0aSFabian Frederick } 46560a920b5bSAndy Whitcroft 4657653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4658653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4659cf655043SAndy Whitcroft# in a known good container 4660b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4661b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4662d8aaf121SAndy Whitcroft my $ln = $linenr; 4663d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4664c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4665c45dcabdSAndy Whitcroft my $ctx = ''; 466608a2843eSJoe Perches my $has_flow_statement = 0; 466708a2843eSJoe Perches my $has_arg_concat = 0; 4668c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4669f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4670f74bd194SAndy Whitcroft $ctx = $dstat; 4671c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4672a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4673c45dcabdSAndy Whitcroft 467408a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 467562e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 467608a2843eSJoe Perches 4677f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 4678292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4679c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4680c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4681c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4682c45dcabdSAndy Whitcroft 4683c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4684bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4685bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 46866b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 4687bf30d6edSAndy Whitcroft { 4688c45dcabdSAndy Whitcroft } 4689c45dcabdSAndy Whitcroft 4690e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 469133acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 469233acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 4693e45bab8eSAndy Whitcroft { 4694e45bab8eSAndy Whitcroft } 4695e45bab8eSAndy Whitcroft 469642e15293SJoe Perches # Make asm volatile uses seem like a generic function 469742e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 469842e15293SJoe Perches 4699c45dcabdSAndy Whitcroft my $exceptions = qr{ 4700c45dcabdSAndy Whitcroft $Declare| 4701c45dcabdSAndy Whitcroft module_param_named| 4702a0a0a7a9SKees Cook MODULE_PARM_DESC| 4703c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4704c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4705383099fdSAndy Whitcroft __typeof__\(| 470622fd2d3eSStefani Seibold union| 470722fd2d3eSStefani Seibold struct| 4708ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 47096b10df42SVladimir Zapolskiy ^\"|\"$| 47106b10df42SVladimir Zapolskiy ^\[ 4711c45dcabdSAndy Whitcroft }x; 47125eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4713f74bd194SAndy Whitcroft if ($dstat ne '' && 4714f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4715f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 47163cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4717356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4718f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4719f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4720e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 472172f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4722f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4723f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4724f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 47254e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 4726f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4727c45dcabdSAndy Whitcroft { 4728f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 4729f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 4730f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 4731f74bd194SAndy Whitcroft 4732f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 4733f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 4734c45dcabdSAndy Whitcroft } 4735c45dcabdSAndy Whitcroft 4736f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 4737f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4738f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4739f74bd194SAndy Whitcroft } else { 4740000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 4741388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 4742d8aaf121SAndy Whitcroft } 47430a920b5bSAndy Whitcroft } 47445023d347SJoe Perches 474508a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 474608a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 474708a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 474808a2843eSJoe Perches my $herectx = $here . "\n"; 474908a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 475008a2843eSJoe Perches 475108a2843eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 475208a2843eSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 475308a2843eSJoe Perches } 475408a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 475508a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 475608a2843eSJoe Perches } 475708a2843eSJoe Perches 4758481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 47595023d347SJoe Perches 47605023d347SJoe Perches } else { 47615023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 4762481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 4763481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 47645023d347SJoe Perches $line =~ /^\+.*\\$/) { 47655023d347SJoe Perches WARN("LINE_CONTINUATIONS", 47665023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 47675023d347SJoe Perches } 4768653d4876SAndy Whitcroft } 47690a920b5bSAndy Whitcroft 4770b13edf7fSJoe Perches# do {} while (0) macro tests: 4771b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 4772b13edf7fSJoe Perches# macro should not end with a semicolon 4773b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 4774b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 4775b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 4776b13edf7fSJoe Perches my $ln = $linenr; 4777b13edf7fSJoe Perches my $cnt = $realcnt; 4778b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 4779b13edf7fSJoe Perches my $ctx = ''; 4780b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 4781b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 4782b13edf7fSJoe Perches $ctx = $dstat; 4783b13edf7fSJoe Perches 4784b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 47851b36b201SJoe Perches $dstat =~ s/$;/ /g; 4786b13edf7fSJoe Perches 4787b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 4788b13edf7fSJoe Perches my $stmts = $2; 4789b13edf7fSJoe Perches my $semis = $3; 4790b13edf7fSJoe Perches 4791b13edf7fSJoe Perches $ctx =~ s/\n*$//; 4792b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 4793b13edf7fSJoe Perches my $herectx = $here . "\n"; 4794b13edf7fSJoe Perches 4795b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4796b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4797b13edf7fSJoe Perches } 4798b13edf7fSJoe Perches 4799ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 4800ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 4801b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 4802b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 4803b13edf7fSJoe Perches } 4804b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 4805b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 4806b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 4807b13edf7fSJoe Perches } 4808f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 4809f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 4810f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 4811f5ef95b1SJoe Perches my $herectx = $here . "\n"; 4812f5ef95b1SJoe Perches 4813f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4814f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4815f5ef95b1SJoe Perches } 4816f5ef95b1SJoe Perches 4817f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 4818f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 4819b13edf7fSJoe Perches } 4820b13edf7fSJoe Perches } 4821b13edf7fSJoe Perches 4822080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 4823080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 4824080ba929SMike Frysinger# . 4825080ba929SMike Frysinger# ALIGN(...) 4826080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 4827080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 4828000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 4829000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 4830080ba929SMike Frysinger } 4831080ba929SMike Frysinger 4832f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 483313214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 483413214adfSAndy Whitcroft my ($level, $endln, @chunks) = 4835cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 483613214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 4837cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 4838cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 4839aad4f614SJoe Perches my @allowed = (); 4840aad4f614SJoe Perches my $allow = 0; 484113214adfSAndy Whitcroft my $seen = 0; 4842773647a0SAndy Whitcroft my $herectx = $here . "\n"; 4843cf655043SAndy Whitcroft my $ln = $linenr - 1; 484413214adfSAndy Whitcroft for my $chunk (@chunks) { 484513214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 484613214adfSAndy Whitcroft 4847773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 4848773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 4849773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 4850773647a0SAndy Whitcroft 4851aad4f614SJoe Perches $allowed[$allow] = 0; 4852773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 4853773647a0SAndy Whitcroft 4854773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 4855773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 4856773647a0SAndy Whitcroft 4857773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 4858cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 4859cf655043SAndy Whitcroft 4860773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 486113214adfSAndy Whitcroft 486213214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 486313214adfSAndy Whitcroft 4864aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 4865cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4866cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4867aad4f614SJoe Perches $allowed[$allow] = 1; 486813214adfSAndy Whitcroft } 486913214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4870cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4871aad4f614SJoe Perches $allowed[$allow] = 1; 487213214adfSAndy Whitcroft } 4873cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4874cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4875aad4f614SJoe Perches $allowed[$allow] = 1; 487613214adfSAndy Whitcroft } 4877aad4f614SJoe Perches $allow++; 487813214adfSAndy Whitcroft } 4879aad4f614SJoe Perches if ($seen) { 4880aad4f614SJoe Perches my $sum_allowed = 0; 4881aad4f614SJoe Perches foreach (@allowed) { 4882aad4f614SJoe Perches $sum_allowed += $_; 4883aad4f614SJoe Perches } 4884aad4f614SJoe Perches if ($sum_allowed == 0) { 4885000d1cc1SJoe Perches WARN("BRACES", 4886000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 4887aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 4888aad4f614SJoe Perches $seen != $allow) { 4889aad4f614SJoe Perches CHK("BRACES", 4890aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 4891aad4f614SJoe Perches } 489213214adfSAndy Whitcroft } 489313214adfSAndy Whitcroft } 489413214adfSAndy Whitcroft } 4895773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 489613214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 4897cf655043SAndy Whitcroft my $allowed = 0; 4898f0a594c1SAndy Whitcroft 4899cf655043SAndy Whitcroft # Check the pre-context. 4900cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 4901cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 4902cf655043SAndy Whitcroft $allowed = 1; 4903f0a594c1SAndy Whitcroft } 4904773647a0SAndy Whitcroft 4905773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 4906773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 4907773647a0SAndy Whitcroft 4908cf655043SAndy Whitcroft # Check the condition. 4909cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 4910773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 4911cf655043SAndy Whitcroft if (defined $cond) { 4912773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4913cf655043SAndy Whitcroft } 4914cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4915cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4916cf655043SAndy Whitcroft $allowed = 1; 4917cf655043SAndy Whitcroft } 4918cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4919cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4920cf655043SAndy Whitcroft $allowed = 1; 4921cf655043SAndy Whitcroft } 4922cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4923cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4924cf655043SAndy Whitcroft $allowed = 1; 4925cf655043SAndy Whitcroft } 4926cf655043SAndy Whitcroft # Check the post-context. 4927cf655043SAndy Whitcroft if (defined $chunks[1]) { 4928cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 4929cf655043SAndy Whitcroft if (defined $cond) { 4930773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4931cf655043SAndy Whitcroft } 4932cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 4933cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 4934cf655043SAndy Whitcroft $allowed = 1; 4935cf655043SAndy Whitcroft } 4936cf655043SAndy Whitcroft } 4937cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 493869932487SJustin P. Mattock my $herectx = $here . "\n"; 4939f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 4940cf655043SAndy Whitcroft 4941f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 494269932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 4943cf655043SAndy Whitcroft } 4944cf655043SAndy Whitcroft 4945000d1cc1SJoe Perches WARN("BRACES", 4946000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 4947f0a594c1SAndy Whitcroft } 4948f0a594c1SAndy Whitcroft } 4949f0a594c1SAndy Whitcroft 49500979ae66SJoe Perches# check for unnecessary blank lines around braces 495177b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 4952f8e58219SJoe Perches if (CHK("BRACES", 4953f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 4954f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 4955f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4956f8e58219SJoe Perches } 49570979ae66SJoe Perches } 495877b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 4959f8e58219SJoe Perches if (CHK("BRACES", 4960f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 4961f8e58219SJoe Perches $fix) { 4962f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 4963f8e58219SJoe Perches } 49640979ae66SJoe Perches } 49650979ae66SJoe Perches 49664a0df2efSAndy Whitcroft# no volatiles please 49676c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 49686c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 4969000d1cc1SJoe Perches WARN("VOLATILE", 4970000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 49714a0df2efSAndy Whitcroft } 49724a0df2efSAndy Whitcroft 49735e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 49745e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 49755e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 49765e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 497733acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 49785e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 49795e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 49805e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 49815e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 49825e4f6ba5SJoe Perches $fix && 49835e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 49845e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 49855e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 49865e4f6ba5SJoe Perches my $comma_close = ""; 49875e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 49885e4f6ba5SJoe Perches $comma_close = $1; 49895e4f6ba5SJoe Perches } 49905e4f6ba5SJoe Perches 49915e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 49925e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 49935e4f6ba5SJoe Perches my $fixedline = $prevrawline; 49945e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 49955e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 49965e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 49975e4f6ba5SJoe Perches $fixedline = $rawline; 49985e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 49995e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 50005e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 50015e4f6ba5SJoe Perches } 50025e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 50035e4f6ba5SJoe Perches } 50045e4f6ba5SJoe Perches } 50055e4f6ba5SJoe Perches 50065e4f6ba5SJoe Perches# check for missing a space in a string concatenation 50075e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 50085e4f6ba5SJoe Perches WARN('MISSING_SPACE', 50095e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 50105e4f6ba5SJoe Perches } 50115e4f6ba5SJoe Perches 50125e4f6ba5SJoe Perches# check for spaces before a quoted newline 50135e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 50145e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 50155e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 50165e4f6ba5SJoe Perches $fix) { 50175e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 50185e4f6ba5SJoe Perches } 50195e4f6ba5SJoe Perches 50205e4f6ba5SJoe Perches } 50215e4f6ba5SJoe Perches 5022f17dba4fSJoe Perches# concatenated string without spaces between elements 502333acb54aSJoe Perches if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) { 5024f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 5025f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 5026f17dba4fSJoe Perches } 5027f17dba4fSJoe Perches 502890ad30e5SJoe Perches# uncoalesced string fragments 502933acb54aSJoe Perches if ($line =~ /$String\s*"/) { 503090ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 503190ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 503290ad30e5SJoe Perches } 503390ad30e5SJoe Perches 50346e300757SJoe Perches# check for %L{u,d,i} and 0x%[udi] in strings 50355e4f6ba5SJoe Perches my $string; 50365e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 50375e4f6ba5SJoe Perches $string = substr($rawline, $-[1], $+[1] - $-[1]); 50385e4f6ba5SJoe Perches $string =~ s/%%/__/g; 50396e300757SJoe Perches if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) { 50405e4f6ba5SJoe Perches WARN("PRINTF_L", 50415e4f6ba5SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 50425e4f6ba5SJoe Perches last; 50435e4f6ba5SJoe Perches } 50446e300757SJoe Perches if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) { 50456e300757SJoe Perches ERROR("PRINTF_0xDECIMAL", 50466e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 50476e300757SJoe Perches } 50485e4f6ba5SJoe Perches } 50495e4f6ba5SJoe Perches 50505e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 50515e4f6ba5SJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 50525e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 50535e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 50545e4f6ba5SJoe Perches } 50555e4f6ba5SJoe Perches 505600df344fSAndy Whitcroft# warn about #if 0 5057c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 5058000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 5059000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 5060de7d4f0eSAndy Whitcroft $herecurr); 50614a0df2efSAndy Whitcroft } 50624a0df2efSAndy Whitcroft 506303df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 506403df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5065100425deSJoe Perches my $tested = quotemeta($1); 5066100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5067100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5068100425deSJoe Perches my $func = $1; 5069100425deSJoe Perches if (WARN('NEEDLESS_IF', 5070100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5071100425deSJoe Perches $fix) { 5072100425deSJoe Perches my $do_fix = 1; 5073100425deSJoe Perches my $leading_tabs = ""; 5074100425deSJoe Perches my $new_leading_tabs = ""; 5075100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5076100425deSJoe Perches $leading_tabs = $1; 5077100425deSJoe Perches } else { 5078100425deSJoe Perches $do_fix = 0; 5079100425deSJoe Perches } 5080100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5081100425deSJoe Perches $new_leading_tabs = $1; 5082100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5083100425deSJoe Perches $do_fix = 0; 5084100425deSJoe Perches } 5085100425deSJoe Perches } else { 5086100425deSJoe Perches $do_fix = 0; 5087100425deSJoe Perches } 5088100425deSJoe Perches if ($do_fix) { 5089100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5090100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5091100425deSJoe Perches } 5092100425deSJoe Perches } 50934c432a8fSGreg Kroah-Hartman } 50944c432a8fSGreg Kroah-Hartman } 5095f0a594c1SAndy Whitcroft 5096ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5097ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5098ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5099ebfdc409SJoe Perches (defined $1 || defined $3) && 5100ebfdc409SJoe Perches $linenr > 3) { 5101ebfdc409SJoe Perches my $testval = $2; 5102ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5103ebfdc409SJoe Perches 5104ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5105ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5106ebfdc409SJoe Perches 5107ebfdc409SJoe Perches if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) { 5108ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5109ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5110ebfdc409SJoe Perches } 5111ebfdc409SJoe Perches } 5112ebfdc409SJoe Perches 5113f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5114dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5115f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5116f78d98f6SJoe Perches my $level = $1; 5117f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5118f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5119f78d98f6SJoe Perches $fix) { 5120f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5121f78d98f6SJoe Perches } 5122f78d98f6SJoe Perches } 5123f78d98f6SJoe Perches 5124abb08a53SJoe Perches# check for mask then right shift without a parentheses 5125abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 5126abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5127abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5128abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5129abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5130abb08a53SJoe Perches } 5131abb08a53SJoe Perches 5132b75ac618SJoe Perches# check for pointer comparisons to NULL 5133b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 5134b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5135b75ac618SJoe Perches my $val = $1; 5136b75ac618SJoe Perches my $equal = "!"; 5137b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5138b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5139b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5140b75ac618SJoe Perches $fix) { 5141b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5142b75ac618SJoe Perches } 5143b75ac618SJoe Perches } 5144b75ac618SJoe Perches } 5145b75ac618SJoe Perches 51468716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 51478716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 51488716de38SJoe Perches my $attr = $1; 51498716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 51508716de38SJoe Perches my $ptr = $1; 51518716de38SJoe Perches my $var = $2; 51528716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 51538716de38SJoe Perches ERROR("MISPLACED_INIT", 51548716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 51558716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 51568716de38SJoe Perches WARN("MISPLACED_INIT", 51578716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 51588716de38SJoe Perches $fix) { 5159194f66fcSJoe 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; 51608716de38SJoe Perches } 51618716de38SJoe Perches } 51628716de38SJoe Perches } 51638716de38SJoe Perches 5164e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5165e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5166e970b884SJoe Perches my $attr = $1; 5167e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5168e970b884SJoe Perches my $attr_prefix = $1; 5169e970b884SJoe Perches my $attr_type = $2; 5170e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5171e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5172e970b884SJoe Perches $fix) { 5173194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5174e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5175e970b884SJoe Perches } 5176e970b884SJoe Perches } 5177e970b884SJoe Perches 5178e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5179e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5180e970b884SJoe Perches my $attr = $1; 5181e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5182e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5183e970b884SJoe Perches $fix) { 5184194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5185e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5186e970b884SJoe Perches $lead = rtrim($1); 5187e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5188e970b884SJoe Perches $lead = "${lead}const "; 5189194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5190e970b884SJoe Perches } 5191e970b884SJoe Perches } 5192e970b884SJoe Perches 5193c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5194c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5195c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5196c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5197c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5198c17893c7SJoe Perches $fix) { 5199c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5200c17893c7SJoe Perches } 5201c17893c7SJoe Perches } 5202c17893c7SJoe Perches 5203fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5204fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5205fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5206fbdb8138SJoe Perches my $constant_func = $1; 5207fbdb8138SJoe Perches my $func = $constant_func; 5208fbdb8138SJoe Perches $func =~ s/^__constant_//; 5209fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5210fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5211fbdb8138SJoe Perches $fix) { 5212194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5213fbdb8138SJoe Perches } 5214fbdb8138SJoe Perches } 5215fbdb8138SJoe Perches 52161a15a250SPatrick Pannuto# prefer usleep_range over udelay 521737581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 521843c1d77cSJoe Perches my $delay = $1; 52191a15a250SPatrick Pannuto # ignore udelay's < 10, however 522043c1d77cSJoe Perches if (! ($delay < 10) ) { 5221000d1cc1SJoe Perches CHK("USLEEP_RANGE", 522243c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 522343c1d77cSJoe Perches } 522443c1d77cSJoe Perches if ($delay > 2000) { 522543c1d77cSJoe Perches WARN("LONG_UDELAY", 522643c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 52271a15a250SPatrick Pannuto } 52281a15a250SPatrick Pannuto } 52291a15a250SPatrick Pannuto 523009ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 523109ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 523209ef8725SPatrick Pannuto if ($1 < 20) { 5233000d1cc1SJoe Perches WARN("MSLEEP", 523443c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 523509ef8725SPatrick Pannuto } 523609ef8725SPatrick Pannuto } 523709ef8725SPatrick Pannuto 523836ec1939SJoe Perches# check for comparisons of jiffies 523936ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 524036ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 524136ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 524236ec1939SJoe Perches } 524336ec1939SJoe Perches 52449d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 52459d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 52469d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 52479d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 52489d7a34a5SJoe Perches } 52499d7a34a5SJoe Perches 525000df344fSAndy Whitcroft# warn about #ifdefs in C files 5251c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 525200df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 525300df344fSAndy Whitcroft# print "$herecurr"; 525400df344fSAndy Whitcroft# $clean = 0; 525500df344fSAndy Whitcroft# } 525600df344fSAndy Whitcroft 525722f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5258c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 52593705ce5bSJoe Perches if (ERROR("SPACING", 52603705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 52613705ce5bSJoe Perches $fix) { 5262194f66fcSJoe Perches $fixed[$fixlinenr] =~ 52633705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 52643705ce5bSJoe Perches } 52653705ce5bSJoe Perches 526622f2a2efSAndy Whitcroft } 526722f2a2efSAndy Whitcroft 52684a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5269171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5270171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 52714a0df2efSAndy Whitcroft my $which = $1; 52724a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5273000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5274000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 52754a0df2efSAndy Whitcroft } 52764a0df2efSAndy Whitcroft } 52774a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5278402c2553SMichael S. Tsirkin 5279402c2553SMichael S. Tsirkin my $barriers = qr{ 5280402c2553SMichael S. Tsirkin mb| 5281402c2553SMichael S. Tsirkin rmb| 5282402c2553SMichael S. Tsirkin wmb| 5283402c2553SMichael S. Tsirkin read_barrier_depends 5284402c2553SMichael S. Tsirkin }x; 5285402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5286402c2553SMichael S. Tsirkin mb__before_atomic| 5287402c2553SMichael S. Tsirkin mb__after_atomic| 5288402c2553SMichael S. Tsirkin store_release| 5289402c2553SMichael S. Tsirkin load_acquire| 5290402c2553SMichael S. Tsirkin store_mb| 5291402c2553SMichael S. Tsirkin (?:$barriers) 5292402c2553SMichael S. Tsirkin }x; 5293402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5294402c2553SMichael S. Tsirkin (?:$barriers)| 529543e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 529643e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5297402c2553SMichael S. Tsirkin }x; 5298402c2553SMichael S. Tsirkin 5299402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 53004a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5301c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5302000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 53034a0df2efSAndy Whitcroft } 53044a0df2efSAndy Whitcroft } 53053ad81779SPaul E. McKenney 5306f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5307f4073b0fSMichael S. Tsirkin 5308f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5309f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5310f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5311f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5312f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5313f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5314f4073b0fSMichael S. Tsirkin } 5315f4073b0fSMichael S. Tsirkin 5316cb426e99SJoe Perches# check for waitqueue_active without a comment. 5317cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5318cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5319cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5320cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5321cb426e99SJoe Perches } 5322cb426e99SJoe Perches } 53233ad81779SPaul E. McKenney 53243ad81779SPaul E. McKenney# Check for expedited grace periods that interrupt non-idle non-nohz 53253ad81779SPaul E. McKenney# online CPUs. These expedited can therefore degrade real-time response 53263ad81779SPaul E. McKenney# if used carelessly, and should be avoided where not absolutely 53273ad81779SPaul E. McKenney# needed. It is always OK to use synchronize_rcu_expedited() and 53283ad81779SPaul E. McKenney# synchronize_sched_expedited() at boot time (before real-time applications 53293ad81779SPaul E. McKenney# start) and in error situations where real-time response is compromised in 53303ad81779SPaul E. McKenney# any case. Note that synchronize_srcu_expedited() does -not- interrupt 53313ad81779SPaul E. McKenney# other CPUs, so don't warn on uses of synchronize_srcu_expedited(). 53323ad81779SPaul E. McKenney# Of course, nothing comes for free, and srcu_read_lock() and 53333ad81779SPaul E. McKenney# srcu_read_unlock() do contain full memory barriers in payment for 53343ad81779SPaul E. McKenney# synchronize_srcu_expedited() non-interruption properties. 53353ad81779SPaul E. McKenney if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) { 53363ad81779SPaul E. McKenney WARN("EXPEDITED_RCU_GRACE_PERIOD", 53373ad81779SPaul E. McKenney "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr); 53383ad81779SPaul E. McKenney 53393ad81779SPaul E. McKenney } 53403ad81779SPaul E. McKenney 53414a0df2efSAndy Whitcroft# check of hardware specific defines 5342c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5343000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5344000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 53450a920b5bSAndy Whitcroft } 5346653d4876SAndy Whitcroft 5347d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 5348d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 5349000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5350000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 5351d4977c78STobias Klauser } 5352d4977c78STobias Klauser 5353de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5354de7d4f0eSAndy Whitcroft# storage class and type. 53559c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 53569c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5357000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5358000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5359de7d4f0eSAndy Whitcroft } 5360de7d4f0eSAndy Whitcroft 53618905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 53622b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 53632b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5364d5e616fcSJoe Perches if (WARN("INLINE", 5365d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5366d5e616fcSJoe Perches $fix) { 5367194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5368d5e616fcSJoe Perches 5369d5e616fcSJoe Perches } 53708905a67cSAndy Whitcroft } 53718905a67cSAndy Whitcroft 53723d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 53732b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 53742b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5375000d1cc1SJoe Perches WARN("PREFER_PACKED", 5376000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 53773d130fd0SJoe Perches } 53783d130fd0SJoe Perches 537939b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 53802b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 53812b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5382000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5383000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 538439b7e287SJoe Perches } 538539b7e287SJoe Perches 53865f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 53872b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 53882b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5389d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5390d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5391d5e616fcSJoe Perches $fix) { 5392194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5393d5e616fcSJoe Perches 5394d5e616fcSJoe Perches } 53955f14d3bdSJoe Perches } 53965f14d3bdSJoe Perches 53976061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 53982b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 53992b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5400d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5401d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5402d5e616fcSJoe Perches $fix) { 5403194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5404d5e616fcSJoe Perches } 54056061d949SJoe Perches } 54066061d949SJoe Perches 5407619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 5408619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 5409619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5410619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5411619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5412619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5413619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5414619a908aSJoe Perches } 5415619a908aSJoe Perches 5416e6176fa4SJoe Perches# check for c99 types like uint8_t used outside of uapi/ 5417e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5418e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5419e6176fa4SJoe Perches my $type = $1; 5420e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5421e6176fa4SJoe Perches $type = $1; 5422e6176fa4SJoe Perches my $kernel_type = 'u'; 5423e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5424e6176fa4SJoe Perches $type =~ /(\d+)/; 5425e6176fa4SJoe Perches $kernel_type .= $1; 5426e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5427e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5428e6176fa4SJoe Perches $fix) { 5429e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5430e6176fa4SJoe Perches } 5431e6176fa4SJoe Perches } 5432e6176fa4SJoe Perches } 5433e6176fa4SJoe Perches 5434938224b5SJoe Perches# check for cast of C90 native int or longer types constants 5435938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 5436938224b5SJoe Perches my $cast = $1; 5437938224b5SJoe Perches my $const = $2; 5438938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 5439938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 5440938224b5SJoe Perches $fix) { 5441938224b5SJoe Perches my $suffix = ""; 5442938224b5SJoe Perches my $newconst = $const; 5443938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 5444938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 5445938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 5446938224b5SJoe Perches $suffix .= 'LL'; 5447938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 5448938224b5SJoe Perches $suffix .= 'L'; 5449938224b5SJoe Perches } 5450938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 5451938224b5SJoe Perches } 5452938224b5SJoe Perches } 5453938224b5SJoe Perches 54548f53a9b8SJoe Perches# check for sizeof(&) 54558f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5456000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5457000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 54588f53a9b8SJoe Perches } 54598f53a9b8SJoe Perches 546066c80b60SJoe Perches# check for sizeof without parenthesis 546166c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5462d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5463d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5464d5e616fcSJoe Perches $fix) { 5465194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5466d5e616fcSJoe Perches } 546766c80b60SJoe Perches } 546866c80b60SJoe Perches 546988982feaSJoe Perches# check for struct spinlock declarations 547088982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 547188982feaSJoe Perches WARN("USE_SPINLOCK_T", 547288982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 547388982feaSJoe Perches } 547488982feaSJoe Perches 5475a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 547606668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5477a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5478caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5479caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5480d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5481d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5482d5e616fcSJoe Perches $fix) { 5483194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5484d5e616fcSJoe Perches } 5485a6962d72SJoe Perches } 5486a6962d72SJoe Perches } 5487a6962d72SJoe Perches 5488554e165cSAndy Whitcroft# Check for misused memsets 5489d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5490d1fe9c09SJoe Perches defined $stat && 54919e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5492554e165cSAndy Whitcroft 5493d7c76ba7SJoe Perches my $ms_addr = $2; 5494d1fe9c09SJoe Perches my $ms_val = $7; 5495d1fe9c09SJoe Perches my $ms_size = $12; 5496d7c76ba7SJoe Perches 5497554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5498554e165cSAndy Whitcroft ERROR("MEMSET", 5499d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5500554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5501554e165cSAndy Whitcroft WARN("MEMSET", 5502d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5503d7c76ba7SJoe Perches } 5504d7c76ba7SJoe Perches } 5505d7c76ba7SJoe Perches 550698a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 550798a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 550810895d2cSMateusz Kulikowski defined $stat && 550910895d2cSMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 551098a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 551110895d2cSMateusz Kulikowski "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 551298a9bba5SJoe Perches $fix) { 5513194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 551498a9bba5SJoe Perches } 551598a9bba5SJoe Perches } 551698a9bba5SJoe Perches 5517b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 5518b6117d17SMateusz Kulikowski if ($^V && $^V ge 5.10.0 && 5519b6117d17SMateusz Kulikowski defined $stat && 5520b6117d17SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5521b6117d17SMateusz Kulikowski WARN("PREFER_ETHER_ADDR_EQUAL", 5522b6117d17SMateusz Kulikowski "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5523b6117d17SMateusz Kulikowski } 5524b6117d17SMateusz Kulikowski 55258617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 55268617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 55278617cd09SMateusz Kulikowski if ($^V && $^V ge 5.10.0 && 55288617cd09SMateusz Kulikowski defined $stat && 55298617cd09SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 55308617cd09SMateusz Kulikowski 55318617cd09SMateusz Kulikowski my $ms_val = $7; 55328617cd09SMateusz Kulikowski 55338617cd09SMateusz Kulikowski if ($ms_val =~ /^(?:0x|)0+$/i) { 55348617cd09SMateusz Kulikowski if (WARN("PREFER_ETH_ZERO_ADDR", 55358617cd09SMateusz Kulikowski "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 55368617cd09SMateusz Kulikowski $fix) { 55378617cd09SMateusz Kulikowski $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 55388617cd09SMateusz Kulikowski } 55398617cd09SMateusz Kulikowski } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 55408617cd09SMateusz Kulikowski if (WARN("PREFER_ETH_BROADCAST_ADDR", 55418617cd09SMateusz Kulikowski "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 55428617cd09SMateusz Kulikowski $fix) { 55438617cd09SMateusz Kulikowski $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 55448617cd09SMateusz Kulikowski } 55458617cd09SMateusz Kulikowski } 55468617cd09SMateusz Kulikowski } 55478617cd09SMateusz Kulikowski 5548d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5549d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5550d1fe9c09SJoe Perches defined $stat && 5551d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5552d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5553d7c76ba7SJoe Perches my $call = $1; 5554d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5555d7c76ba7SJoe Perches my $arg1 = $3; 5556d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5557d1fe9c09SJoe Perches my $arg2 = $8; 5558d7c76ba7SJoe Perches my $cast; 5559d7c76ba7SJoe Perches 5560d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5561d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5562d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5563d7c76ba7SJoe Perches $cast = $cast1; 5564d7c76ba7SJoe Perches } else { 5565d7c76ba7SJoe Perches $cast = $cast2; 5566d7c76ba7SJoe Perches } 5567d7c76ba7SJoe Perches WARN("MINMAX", 5568d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5569554e165cSAndy Whitcroft } 5570554e165cSAndy Whitcroft } 5571554e165cSAndy Whitcroft 55724a273195SJoe Perches# check usleep_range arguments 55734a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 55744a273195SJoe Perches defined $stat && 55754a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 55764a273195SJoe Perches my $min = $1; 55774a273195SJoe Perches my $max = $7; 55784a273195SJoe Perches if ($min eq $max) { 55794a273195SJoe Perches WARN("USLEEP_RANGE", 55804a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 55814a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 55824a273195SJoe Perches $min > $max) { 55834a273195SJoe Perches WARN("USLEEP_RANGE", 55844a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 55854a273195SJoe Perches } 55864a273195SJoe Perches } 55874a273195SJoe Perches 5588823b794cSJoe Perches# check for naked sscanf 5589823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5590823b794cSJoe Perches defined $stat && 55916c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5592823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5593823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5594823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5595823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5596823b794cSJoe Perches $lc = $lc + $linenr; 5597823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 5598823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5599823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5600823b794cSJoe Perches } 5601823b794cSJoe Perches WARN("NAKED_SSCANF", 5602823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5603823b794cSJoe Perches } 5604823b794cSJoe Perches 5605afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5606afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5607afc819abSJoe Perches defined $stat && 5608afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5609afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5610afc819abSJoe Perches $lc = $lc + $linenr; 5611afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 5612afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5613afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5614afc819abSJoe Perches } 5615afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5616afc819abSJoe Perches my $format = $6; 5617afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5618afc819abSJoe Perches if ($count == 1 && 5619afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5620afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5621afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5622afc819abSJoe Perches } 5623afc819abSJoe Perches } 5624afc819abSJoe Perches } 5625afc819abSJoe Perches 562670dc8a48SJoe Perches# check for new externs in .h files. 562770dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 562870dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5629d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 563070dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 563170dc8a48SJoe Perches $fix) { 5632194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 563370dc8a48SJoe Perches } 563470dc8a48SJoe Perches } 563570dc8a48SJoe Perches 5636de7d4f0eSAndy Whitcroft# check for new externs in .c files. 5637171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 5638c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 5639171ae1a4SAndy Whitcroft { 5640c45dcabdSAndy Whitcroft my $function_name = $1; 5641c45dcabdSAndy Whitcroft my $paren_space = $2; 5642171ae1a4SAndy Whitcroft 5643171ae1a4SAndy Whitcroft my $s = $stat; 5644171ae1a4SAndy Whitcroft if (defined $cond) { 5645171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 5646171ae1a4SAndy Whitcroft } 5647c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 5648c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 5649c45dcabdSAndy Whitcroft { 5650000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5651000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5652de7d4f0eSAndy Whitcroft } 5653de7d4f0eSAndy Whitcroft 5654171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 5655000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 5656000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 5657171ae1a4SAndy Whitcroft } 56589c9ba34eSAndy Whitcroft 56599c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 56609c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 56619c9ba34eSAndy Whitcroft { 5662000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5663000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5664171ae1a4SAndy Whitcroft } 5665171ae1a4SAndy Whitcroft 5666de7d4f0eSAndy Whitcroft# checks for new __setup's 5667de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 5668de7d4f0eSAndy Whitcroft my $name = $1; 5669de7d4f0eSAndy Whitcroft 5670de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 5671000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 5672000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 5673de7d4f0eSAndy Whitcroft } 5674653d4876SAndy Whitcroft } 56759c0ca6f9SAndy Whitcroft 56769c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 5677caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 5678000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 5679000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 56809c0ca6f9SAndy Whitcroft } 568113214adfSAndy Whitcroft 5682a640d25cSJoe Perches# alloc style 5683a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 5684a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 5685a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 5686a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 5687a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 5688a640d25cSJoe Perches } 5689a640d25cSJoe Perches 569060a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 569160a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 5692e367455aSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 569360a55369SJoe Perches my $oldfunc = $3; 569460a55369SJoe Perches my $a1 = $4; 569560a55369SJoe Perches my $a2 = $10; 569660a55369SJoe Perches my $newfunc = "kmalloc_array"; 569760a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 569860a55369SJoe Perches my $r1 = $a1; 569960a55369SJoe Perches my $r2 = $a2; 570060a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 570160a55369SJoe Perches $r1 = $a2; 570260a55369SJoe Perches $r2 = $a1; 570360a55369SJoe Perches } 5704e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 5705e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 5706e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 5707e367455aSJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 5708e367455aSJoe Perches $fix) { 5709194f66fcSJoe 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; 571060a55369SJoe Perches 571160a55369SJoe Perches } 571260a55369SJoe Perches } 571360a55369SJoe Perches } 571460a55369SJoe Perches 5715972fdea2SJoe Perches# check for krealloc arg reuse 5716972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 5717972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 5718972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 5719972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 5720972fdea2SJoe Perches } 5721972fdea2SJoe Perches 57225ce59ae0SJoe Perches# check for alloc argument mismatch 57235ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 57245ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 57255ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 57265ce59ae0SJoe Perches } 57275ce59ae0SJoe Perches 5728caf2a54fSJoe Perches# check for multiple semicolons 5729caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 5730d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 5731d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 5732d5e616fcSJoe Perches $fix) { 5733194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 5734d5e616fcSJoe Perches } 5735d1e2ad07SJoe Perches } 5736d1e2ad07SJoe Perches 5737cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 5738cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 5739cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 57400ab90191SJoe Perches my $ull = ""; 57410ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 57420ab90191SJoe Perches if (CHK("BIT_MACRO", 57430ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 57440ab90191SJoe Perches $fix) { 57450ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 57460ab90191SJoe Perches } 57470ab90191SJoe Perches } 57480ab90191SJoe Perches 57492d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 57502d632745SJoe 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*$/) { 57512d632745SJoe Perches my $config = $1; 57522d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 57532d632745SJoe Perches "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) && 57542d632745SJoe Perches $fix) { 57552d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 57562d632745SJoe Perches } 57572d632745SJoe Perches } 57582d632745SJoe Perches 5759e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 5760c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 5761c34c09a8SJoe Perches my $has_break = 0; 5762c34c09a8SJoe Perches my $has_statement = 0; 5763c34c09a8SJoe Perches my $count = 0; 5764c34c09a8SJoe Perches my $prevline = $linenr; 5765e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 5766c34c09a8SJoe Perches $prevline--; 5767c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 5768c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 5769c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 5770c34c09a8SJoe Perches next if ($fline =~ /^\-/); 5771c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 5772c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 5773c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 5774c34c09a8SJoe Perches $has_statement = 1; 5775c34c09a8SJoe Perches $count++; 5776c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 5777c34c09a8SJoe Perches } 5778c34c09a8SJoe Perches if (!$has_break && $has_statement) { 5779c34c09a8SJoe Perches WARN("MISSING_BREAK", 5780c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 5781c34c09a8SJoe Perches } 5782c34c09a8SJoe Perches } 5783c34c09a8SJoe Perches 5784d1e2ad07SJoe Perches# check for switch/default statements without a break; 5785d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 5786d1e2ad07SJoe Perches defined $stat && 5787d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 5788d1e2ad07SJoe Perches my $ctx = ''; 5789d1e2ad07SJoe Perches my $herectx = $here . "\n"; 5790d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 5791d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5792d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5793d1e2ad07SJoe Perches } 5794d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 5795d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 5796caf2a54fSJoe Perches } 5797caf2a54fSJoe Perches 579813214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 5799d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 5800d5e616fcSJoe Perches if (WARN("USE_FUNC", 5801d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 5802d5e616fcSJoe Perches $fix) { 5803194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 5804d5e616fcSJoe Perches } 580513214adfSAndy Whitcroft } 5806773647a0SAndy Whitcroft 580762ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 580862ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 580962ec818fSJoe Perches ERROR("DATE_TIME", 581062ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 581162ec818fSJoe Perches } 581262ec818fSJoe Perches 58132c92488aSJoe Perches# check for use of yield() 58142c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 58152c92488aSJoe Perches WARN("YIELD", 58162c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 58172c92488aSJoe Perches } 58182c92488aSJoe Perches 5819179f8f40SJoe Perches# check for comparisons against true and false 5820179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 5821179f8f40SJoe Perches my $lead = $1; 5822179f8f40SJoe Perches my $arg = $2; 5823179f8f40SJoe Perches my $test = $3; 5824179f8f40SJoe Perches my $otype = $4; 5825179f8f40SJoe Perches my $trail = $5; 5826179f8f40SJoe Perches my $op = "!"; 5827179f8f40SJoe Perches 5828179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 5829179f8f40SJoe Perches 5830179f8f40SJoe Perches my $type = lc($otype); 5831179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 5832179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 5833179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 5834179f8f40SJoe Perches $op = ""; 5835179f8f40SJoe Perches } 5836179f8f40SJoe Perches 5837179f8f40SJoe Perches CHK("BOOL_COMPARISON", 5838179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 5839179f8f40SJoe Perches 5840179f8f40SJoe Perches## maybe suggesting a correct construct would better 5841179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 5842179f8f40SJoe Perches 5843179f8f40SJoe Perches } 5844179f8f40SJoe Perches } 5845179f8f40SJoe Perches 58464882720bSThomas Gleixner# check for semaphores initialized locked 58474882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 5848000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 5849000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 5850773647a0SAndy Whitcroft } 58516712d858SJoe Perches 585267d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 585367d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 5854000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 585567d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 5856773647a0SAndy Whitcroft } 58576712d858SJoe Perches 5858ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 5859f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 5860000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 5861ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 5862f3db6639SMichael Ellerman } 58636712d858SJoe Perches 58640f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 58650f3c5aabSJoe Perches my $const_structs = qr{ 58660f3c5aabSJoe Perches acpi_dock_ops| 586779404849SEmese Revfy address_space_operations| 586879404849SEmese Revfy backlight_ops| 586979404849SEmese Revfy block_device_operations| 587079404849SEmese Revfy dentry_operations| 587179404849SEmese Revfy dev_pm_ops| 587279404849SEmese Revfy dma_map_ops| 587379404849SEmese Revfy extent_io_ops| 587479404849SEmese Revfy file_lock_operations| 587579404849SEmese Revfy file_operations| 587679404849SEmese Revfy hv_ops| 587779404849SEmese Revfy ide_dma_ops| 587879404849SEmese Revfy intel_dvo_dev_ops| 587979404849SEmese Revfy item_operations| 588079404849SEmese Revfy iwl_ops| 588179404849SEmese Revfy kgdb_arch| 588279404849SEmese Revfy kgdb_io| 588379404849SEmese Revfy kset_uevent_ops| 588479404849SEmese Revfy lock_manager_operations| 588579404849SEmese Revfy microcode_ops| 588679404849SEmese Revfy mtrr_ops| 588779404849SEmese Revfy neigh_ops| 588879404849SEmese Revfy nlmsvc_binding| 58890f3c5aabSJoe Perches of_device_id| 589079404849SEmese Revfy pci_raw_ops| 589179404849SEmese Revfy pipe_buf_operations| 589279404849SEmese Revfy platform_hibernation_ops| 589379404849SEmese Revfy platform_suspend_ops| 589479404849SEmese Revfy proto_ops| 589579404849SEmese Revfy rpc_pipe_ops| 589679404849SEmese Revfy seq_operations| 589779404849SEmese Revfy snd_ac97_build_ops| 589879404849SEmese Revfy soc_pcmcia_socket_ops| 589979404849SEmese Revfy stacktrace_ops| 590079404849SEmese Revfy sysfs_ops| 590179404849SEmese Revfy tty_operations| 59026d07d01bSJoe Perches uart_ops| 590379404849SEmese Revfy usb_mon_operations| 590479404849SEmese Revfy wd_ops}x; 59056903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 59060f3c5aabSJoe Perches $line =~ /\bstruct\s+($const_structs)\b/) { 5907000d1cc1SJoe Perches WARN("CONST_STRUCT", 5908000d1cc1SJoe Perches "struct $1 should normally be const\n" . 59096903ffb2SAndy Whitcroft $herecurr); 59102b6db5cbSAndy Whitcroft } 5911773647a0SAndy Whitcroft 5912773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 5913773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 5914773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 5915c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 5916c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 5917171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 5918171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 5919171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 5920773647a0SAndy Whitcroft { 5921000d1cc1SJoe Perches WARN("NR_CPUS", 5922000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 5923773647a0SAndy Whitcroft } 59249c9ba34eSAndy Whitcroft 592552ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 592652ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 592752ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 592852ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 592952ea8506SJoe Perches } 593052ea8506SJoe Perches 5931acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 5932acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 5933acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 5934acd9362cSJoe Perches WARN("LIKELY_MISUSE", 5935acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 5936acd9362cSJoe Perches } 5937acd9362cSJoe Perches 5938691d77b6SAndy Whitcroft# whine mightly about in_atomic 5939691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 5940691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 5941000d1cc1SJoe Perches ERROR("IN_ATOMIC", 5942000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 5943f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 5944000d1cc1SJoe Perches WARN("IN_ATOMIC", 5945000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 5946691d77b6SAndy Whitcroft } 5947691d77b6SAndy Whitcroft } 59481704f47bSPeter Zijlstra 5949481aea5cSJoe Perches# whine about ACCESS_ONCE 5950481aea5cSJoe Perches if ($^V && $^V ge 5.10.0 && 5951481aea5cSJoe Perches $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) { 5952481aea5cSJoe Perches my $par = $1; 5953481aea5cSJoe Perches my $eq = $2; 5954481aea5cSJoe Perches my $fun = $3; 5955481aea5cSJoe Perches $par =~ s/^\(\s*(.*)\s*\)$/$1/; 5956481aea5cSJoe Perches if (defined($eq)) { 5957481aea5cSJoe Perches if (WARN("PREFER_WRITE_ONCE", 5958481aea5cSJoe Perches "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) && 5959481aea5cSJoe Perches $fix) { 5960481aea5cSJoe Perches $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/; 5961481aea5cSJoe Perches } 5962481aea5cSJoe Perches } else { 5963481aea5cSJoe Perches if (WARN("PREFER_READ_ONCE", 5964481aea5cSJoe Perches "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) && 5965481aea5cSJoe Perches $fix) { 5966481aea5cSJoe Perches $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/; 5967481aea5cSJoe Perches } 5968481aea5cSJoe Perches } 5969481aea5cSJoe Perches } 5970481aea5cSJoe Perches 59711704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 59721704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 59731704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 59741704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 59751704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 59761704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 5977000d1cc1SJoe Perches ERROR("LOCKDEP", 5978000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 59791704f47bSPeter Zijlstra } 59801704f47bSPeter Zijlstra } 598188f8831cSDave Jones 5982b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 5983b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 5984000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 5985000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 598688f8831cSDave Jones } 59872435880fSJoe Perches 5988515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 5989515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 5990515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 5991515a235eSJoe Perches $line =~ /$mode_perms_search/) { 59922435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 59932435880fSJoe Perches my $func = $entry->[0]; 59942435880fSJoe Perches my $arg_pos = $entry->[1]; 59952435880fSJoe Perches 59962435880fSJoe Perches my $skip_args = ""; 59972435880fSJoe Perches if ($arg_pos > 1) { 59982435880fSJoe Perches $arg_pos--; 59992435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 60002435880fSJoe Perches } 60012435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 6002515a235eSJoe Perches if ($line =~ /$test/) { 60032435880fSJoe Perches my $val = $1; 60042435880fSJoe Perches $val = $6 if ($skip_args ne ""); 60052435880fSJoe Perches 60061727cc70SJoe Perches if ($val !~ /^0$/ && 60071727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 60081727cc70SJoe Perches length($val) ne 4)) { 60092435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 60101727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 6011c0a5c898SJoe Perches } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6012c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6013c0a5c898SJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 60142435880fSJoe Perches } 60152435880fSJoe Perches } 60162435880fSJoe Perches } 601713214adfSAndy Whitcroft } 60185a6d20ceSBjorn Andersson 60195a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 60205a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 60215a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 60225a6d20ceSBjorn Andersson my $valid_licenses = qr{ 60235a6d20ceSBjorn Andersson GPL| 60245a6d20ceSBjorn Andersson GPL\ v2| 60255a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 60265a6d20ceSBjorn Andersson Dual\ BSD/GPL| 60275a6d20ceSBjorn Andersson Dual\ MIT/GPL| 60285a6d20ceSBjorn Andersson Dual\ MPL/GPL| 60295a6d20ceSBjorn Andersson Proprietary 60305a6d20ceSBjorn Andersson }x; 60315a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 60325a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 60335a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 60345a6d20ceSBjorn Andersson } 60355a6d20ceSBjorn Andersson } 6036515a235eSJoe Perches } 603713214adfSAndy Whitcroft 603813214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 603913214adfSAndy Whitcroft # so just keep quiet. 604013214adfSAndy Whitcroft if ($#rawlines == -1) { 604113214adfSAndy Whitcroft exit(0); 60420a920b5bSAndy Whitcroft } 60430a920b5bSAndy Whitcroft 60448905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 60458905a67cSAndy Whitcroft # things that appear to be patches. 60468905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 60478905a67cSAndy Whitcroft exit(0); 60488905a67cSAndy Whitcroft } 60498905a67cSAndy Whitcroft 60508905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 60518905a67cSAndy Whitcroft # just keep quiet. 60528905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 60538905a67cSAndy Whitcroft exit(0); 60548905a67cSAndy Whitcroft } 60558905a67cSAndy Whitcroft 605606330fc4SJoe Perches if (!$is_patch && $file !~ /cover-letter\.patch$/) { 6057000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6058000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 60590a920b5bSAndy Whitcroft } 6060*ed43c4e5SAllen Hubbe if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) { 6061000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6062000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 60630a920b5bSAndy Whitcroft } 60640a920b5bSAndy Whitcroft 6065f0a594c1SAndy Whitcroft print report_dump(); 606613214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 606713214adfSAndy Whitcroft print "$filename " if ($summary_file); 60686c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 60696c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 60706c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 60716c72ffaaSAndy Whitcroft } 60728905a67cSAndy Whitcroft 6073d2c0a235SAndy Whitcroft if ($quiet == 0) { 6074ef212196SJoe Perches # If there were any defects found and not already fixing them 6075ef212196SJoe Perches if (!$clean and !$fix) { 6076ef212196SJoe Perches print << "EOM" 6077ef212196SJoe Perches 6078ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 6079ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 6080ef212196SJoe PerchesEOM 6081ef212196SJoe Perches } 6082d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 6083d2c0a235SAndy Whitcroft # then suggest that. 6084d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 6085b0781216SMike Frysinger $rpt_cleaners = 0; 6086d8469f16SJoe Perches print << "EOM" 6087d8469f16SJoe Perches 6088d8469f16SJoe PerchesNOTE: Whitespace errors detected. 6089d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 6090d8469f16SJoe PerchesEOM 6091d2c0a235SAndy Whitcroft } 6092d2c0a235SAndy Whitcroft } 6093d2c0a235SAndy Whitcroft 6094d752fcc8SJoe Perches if ($clean == 0 && $fix && 6095d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 6096d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 60979624b8d6SJoe Perches my $newfile = $filename; 60989624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 60993705ce5bSJoe Perches my $linecount = 0; 61003705ce5bSJoe Perches my $f; 61013705ce5bSJoe Perches 6102d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 6103d752fcc8SJoe Perches 61043705ce5bSJoe Perches open($f, '>', $newfile) 61053705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 61063705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 61073705ce5bSJoe Perches $linecount++; 61083705ce5bSJoe Perches if ($file) { 61093705ce5bSJoe Perches if ($linecount > 3) { 61103705ce5bSJoe Perches $fixed_line =~ s/^\+//; 61113705ce5bSJoe Perches print $f $fixed_line . "\n"; 61123705ce5bSJoe Perches } 61133705ce5bSJoe Perches } else { 61143705ce5bSJoe Perches print $f $fixed_line . "\n"; 61153705ce5bSJoe Perches } 61163705ce5bSJoe Perches } 61173705ce5bSJoe Perches close($f); 61183705ce5bSJoe Perches 61193705ce5bSJoe Perches if (!$quiet) { 61203705ce5bSJoe Perches print << "EOM"; 6121d8469f16SJoe Perches 61223705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 61233705ce5bSJoe Perches 61243705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 61253705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 61263705ce5bSJoe Perches 61273705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 61283705ce5bSJoe PerchesNo warranties, expressed or implied... 61293705ce5bSJoe PerchesEOM 61303705ce5bSJoe Perches } 61313705ce5bSJoe Perches } 61323705ce5bSJoe Perches 6133d8469f16SJoe Perches if ($quiet == 0) { 6134d8469f16SJoe Perches print "\n"; 6135d8469f16SJoe Perches if ($clean == 1) { 6136d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 6137d8469f16SJoe Perches } else { 6138d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 61390a920b5bSAndy Whitcroft } 61400a920b5bSAndy Whitcroft } 61410a920b5bSAndy Whitcroft return $clean; 61420a920b5bSAndy Whitcroft} 6143