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; 5877f5b10aSHannes Eder 5977f5b10aSHannes Edersub help { 6077f5b10aSHannes Eder my ($exitcode) = @_; 6177f5b10aSHannes Eder 6277f5b10aSHannes Eder print << "EOM"; 6377f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 6477f5b10aSHannes EderVersion: $V 6577f5b10aSHannes Eder 6677f5b10aSHannes EderOptions: 6777f5b10aSHannes Eder -q, --quiet quiet 6877f5b10aSHannes Eder --no-tree run without a kernel tree 6977f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 7077f5b10aSHannes Eder --patch treat FILE as patchfile (default) 7177f5b10aSHannes Eder --emacs emacs compile window format 7277f5b10aSHannes Eder --terse one line per report 7334d8815fSJoe Perches --showfile emit diffed file position, not input file position 744a593c34SDu, Changbin -g, --git treat FILE as a single commit or git revision range 754a593c34SDu, Changbin single git commit with: 764a593c34SDu, Changbin <rev> 774a593c34SDu, Changbin <rev>^ 784a593c34SDu, Changbin <rev>~n 794a593c34SDu, Changbin multiple git commits with: 804a593c34SDu, Changbin <rev1>..<rev2> 814a593c34SDu, Changbin <rev1>...<rev2> 824a593c34SDu, Changbin <rev>-<count> 834a593c34SDu, Changbin git merges are ignored 8477f5b10aSHannes Eder -f, --file treat FILE as regular source file 8577f5b10aSHannes Eder --subjective, --strict enable more subjective tests 863beb42ecSJoe Perches --list-types list the possible message types 8791bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 88000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 893beb42ecSJoe Perches --show-types show the specific message type in the output 906cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 9156193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 9277f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 9377f5b10aSHannes Eder --no-summary suppress the per-file summary 9477f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 9577f5b10aSHannes Eder --summary-file include the filename in summary 9677f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 9777f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 9877f5b10aSHannes Eder is all off) 9977f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 10077f5b10aSHannes Eder literally 1013705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 1023705ce5bSJoe Perches If correctable single-line errors exist, create 1033705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 1043705ce5bSJoe Perches with potential errors corrected to the preferred 1053705ce5bSJoe Perches checkpatch style 1069624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 1079624b8d6SJoe Perches Is the same as --fix, but overwrites the input 1089624b8d6SJoe Perches file. It's your fault if there's no backup or git 109d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 110d62a201fSDave Hansen runtime errors. 111ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 112f1a63678SMaxim Uvarov (default:/usr/share/codespell/dictionary.txt) 113ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 11457230297SJoe Perches --color Use colors when output is STDOUT (default: on) 11577f5b10aSHannes Eder -h, --help, --version display this help and exit 11677f5b10aSHannes Eder 11777f5b10aSHannes EderWhen FILE is - read standard input. 11877f5b10aSHannes EderEOM 11977f5b10aSHannes Eder 12077f5b10aSHannes Eder exit($exitcode); 12177f5b10aSHannes Eder} 12277f5b10aSHannes Eder 1233beb42ecSJoe Perchessub uniq { 1243beb42ecSJoe Perches my %seen; 1253beb42ecSJoe Perches return grep { !$seen{$_}++ } @_; 1263beb42ecSJoe Perches} 1273beb42ecSJoe Perches 1283beb42ecSJoe Perchessub list_types { 1293beb42ecSJoe Perches my ($exitcode) = @_; 1303beb42ecSJoe Perches 1313beb42ecSJoe Perches my $count = 0; 1323beb42ecSJoe Perches 1333beb42ecSJoe Perches local $/ = undef; 1343beb42ecSJoe Perches 1353beb42ecSJoe Perches open(my $script, '<', abs_path($P)) or 1363beb42ecSJoe Perches die "$P: Can't read '$P' $!\n"; 1373beb42ecSJoe Perches 1383beb42ecSJoe Perches my $text = <$script>; 1393beb42ecSJoe Perches close($script); 1403beb42ecSJoe Perches 1413beb42ecSJoe Perches my @types = (); 1423beb42ecSJoe Perches for ($text =~ /\b(?:(?:CHK|WARN|ERROR)\s*\(\s*"([^"]+)")/g) { 1433beb42ecSJoe Perches push (@types, $_); 1443beb42ecSJoe Perches } 1453beb42ecSJoe Perches @types = sort(uniq(@types)); 1463beb42ecSJoe Perches print("#\tMessage type\n\n"); 1473beb42ecSJoe Perches foreach my $type (@types) { 1483beb42ecSJoe Perches print(++$count . "\t" . $type . "\n"); 1493beb42ecSJoe Perches } 1503beb42ecSJoe Perches 1513beb42ecSJoe Perches exit($exitcode); 1523beb42ecSJoe Perches} 1533beb42ecSJoe Perches 154000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 155000d1cc1SJoe Perchesif (-f $conf) { 156000d1cc1SJoe Perches my @conf_args; 157000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 158000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 159000d1cc1SJoe Perches 160000d1cc1SJoe Perches while (<$conffile>) { 161000d1cc1SJoe Perches my $line = $_; 162000d1cc1SJoe Perches 163000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 164000d1cc1SJoe Perches $line =~ s/^\s*//g; 165000d1cc1SJoe Perches $line =~ s/\s+/ /g; 166000d1cc1SJoe Perches 167000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 168000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 169000d1cc1SJoe Perches 170000d1cc1SJoe Perches my @words = split(" ", $line); 171000d1cc1SJoe Perches foreach my $word (@words) { 172000d1cc1SJoe Perches last if ($word =~ m/^#/); 173000d1cc1SJoe Perches push (@conf_args, $word); 174000d1cc1SJoe Perches } 175000d1cc1SJoe Perches } 176000d1cc1SJoe Perches close($conffile); 177000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 178000d1cc1SJoe Perches} 179000d1cc1SJoe Perches 1800a920b5bSAndy WhitcroftGetOptions( 1816c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1820a920b5bSAndy Whitcroft 'tree!' => \$tree, 1830a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1840a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1856c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1868905a67cSAndy Whitcroft 'terse!' => \$terse, 18734d8815fSJoe Perches 'showfile!' => \$showfile, 18877f5b10aSHannes Eder 'f|file!' => \$file, 1894a593c34SDu, Changbin 'g|git!' => \$git, 1906c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1916c72ffaaSAndy Whitcroft 'strict!' => \$check, 192000d1cc1SJoe Perches 'ignore=s' => \@ignore, 19391bfe484SJoe Perches 'types=s' => \@use, 194000d1cc1SJoe Perches 'show-types!' => \$show_types, 1953beb42ecSJoe Perches 'list-types!' => \$list_types, 1966cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 19756193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 1986c72ffaaSAndy Whitcroft 'root=s' => \$root, 1998905a67cSAndy Whitcroft 'summary!' => \$summary, 2008905a67cSAndy Whitcroft 'mailback!' => \$mailback, 20113214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 2023705ce5bSJoe Perches 'fix!' => \$fix, 2039624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 204d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 205c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 206773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 207ebfd7d62SJoe Perches 'codespell!' => \$codespell, 208ebfd7d62SJoe Perches 'codespellfile=s' => \$codespellfile, 20957230297SJoe Perches 'color!' => \$color, 21077f5b10aSHannes Eder 'h|help' => \$help, 21177f5b10aSHannes Eder 'version' => \$help 21277f5b10aSHannes Eder) or help(1); 21377f5b10aSHannes Eder 21477f5b10aSHannes Ederhelp(0) if ($help); 2150a920b5bSAndy Whitcroft 2163beb42ecSJoe Percheslist_types(0) if ($list_types); 2173beb42ecSJoe Perches 2189624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 2192ac73b4fSJoe Perches$check_orig = $check; 2209624b8d6SJoe Perches 2210a920b5bSAndy Whitcroftmy $exit = 0; 2220a920b5bSAndy Whitcroft 223d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 224d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 225d62a201fSDave Hansen if (!$ignore_perl_version) { 226d62a201fSDave Hansen exit(1); 227d62a201fSDave Hansen } 228d62a201fSDave Hansen} 229d62a201fSDave Hansen 2300a920b5bSAndy Whitcroftif ($#ARGV < 0) { 23177f5b10aSHannes Eder print "$P: no input files\n"; 2320a920b5bSAndy Whitcroft exit(1); 2330a920b5bSAndy Whitcroft} 2340a920b5bSAndy Whitcroft 23591bfe484SJoe Perchessub hash_save_array_words { 23691bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 23791bfe484SJoe Perches 23891bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 23991bfe484SJoe Perches foreach my $word (@array) { 240000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 241000d1cc1SJoe Perches $word =~ s/^\s*//g; 242000d1cc1SJoe Perches $word =~ s/\s+/ /g; 243000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 244000d1cc1SJoe Perches 245000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 246000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 247000d1cc1SJoe Perches 24891bfe484SJoe Perches $hashRef->{$word}++; 249000d1cc1SJoe Perches } 25091bfe484SJoe Perches} 25191bfe484SJoe Perches 25291bfe484SJoe Perchessub hash_show_words { 25391bfe484SJoe Perches my ($hashRef, $prefix) = @_; 25491bfe484SJoe Perches 2553c816e49SJoe Perches if (keys %$hashRef) { 256d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 25758cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 25891bfe484SJoe Perches print " $word"; 25991bfe484SJoe Perches } 260d8469f16SJoe Perches print "\n"; 26191bfe484SJoe Perches } 26291bfe484SJoe Perches} 26391bfe484SJoe Perches 26491bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 26591bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 266000d1cc1SJoe Perches 267c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 268c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 2697429c690SAndy Whitcroftmy $dbg_type = 0; 270a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 271c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 27221caa13cSAndy Whitcroft ## no critic 27321caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 27421caa13cSAndy Whitcroft die "$@" if ($@); 275c2fdda0dSAndy Whitcroft} 276c2fdda0dSAndy Whitcroft 277d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 278d2c0a235SAndy Whitcroft 2798905a67cSAndy Whitcroftif ($terse) { 2808905a67cSAndy Whitcroft $emacs = 1; 2818905a67cSAndy Whitcroft $quiet++; 2828905a67cSAndy Whitcroft} 2838905a67cSAndy Whitcroft 2846c72ffaaSAndy Whitcroftif ($tree) { 2856c72ffaaSAndy Whitcroft if (defined $root) { 2866c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 2876c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 2886c72ffaaSAndy Whitcroft } 2896c72ffaaSAndy Whitcroft } else { 2906c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 2916c72ffaaSAndy Whitcroft $root = '.'; 2926c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 2936c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 2946c72ffaaSAndy Whitcroft $root = $1; 2956c72ffaaSAndy Whitcroft } 2966c72ffaaSAndy Whitcroft } 2976c72ffaaSAndy Whitcroft 2986c72ffaaSAndy Whitcroft if (!defined $root) { 2990a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 3000a920b5bSAndy Whitcroft exit(2); 3010a920b5bSAndy Whitcroft } 3026c72ffaaSAndy Whitcroft} 3036c72ffaaSAndy Whitcroft 3046c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 3056c72ffaaSAndy Whitcroft 3062ceb532bSAndy Whitcroftour $Ident = qr{ 3072ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 3082ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 3092ceb532bSAndy Whitcroft }x; 3106c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 3116c72ffaaSAndy Whitcroftour $Sparse = qr{ 3126c72ffaaSAndy Whitcroft __user| 3136c72ffaaSAndy Whitcroft __kernel| 3146c72ffaaSAndy Whitcroft __force| 3156c72ffaaSAndy Whitcroft __iomem| 31654507b51SJoe Perches __pmem| 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; 812*28898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 813*28898fd1SJoe 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)) { 821*28898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 822*28898fd1SJoe 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 114800df344fSAndy Whitcroft return $res; 114900df344fSAndy Whitcroft} 115000df344fSAndy Whitcroft 1151a6962d72SJoe Perchessub get_quoted_string { 1152a6962d72SJoe Perches my ($line, $rawline) = @_; 1153a6962d72SJoe Perches 115433acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1155a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1156a6962d72SJoe Perches} 1157a6962d72SJoe Perches 11588905a67cSAndy Whitcroftsub ctx_statement_block { 11598905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 11608905a67cSAndy Whitcroft my $line = $linenr - 1; 11618905a67cSAndy Whitcroft my $blk = ''; 11628905a67cSAndy Whitcroft my $soff = $off; 11638905a67cSAndy Whitcroft my $coff = $off - 1; 1164773647a0SAndy Whitcroft my $coff_set = 0; 11658905a67cSAndy Whitcroft 116613214adfSAndy Whitcroft my $loff = 0; 116713214adfSAndy Whitcroft 11688905a67cSAndy Whitcroft my $type = ''; 11698905a67cSAndy Whitcroft my $level = 0; 1170a2750645SAndy Whitcroft my @stack = (); 1171cf655043SAndy Whitcroft my $p; 11728905a67cSAndy Whitcroft my $c; 11738905a67cSAndy Whitcroft my $len = 0; 117413214adfSAndy Whitcroft 117513214adfSAndy Whitcroft my $remainder; 11768905a67cSAndy Whitcroft while (1) { 1177a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1178a2750645SAndy Whitcroft 1179773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 11808905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 11818905a67cSAndy Whitcroft # context. 11828905a67cSAndy Whitcroft if ($off >= $len) { 11838905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1184dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1185c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 11868905a67cSAndy Whitcroft $remain--; 118713214adfSAndy Whitcroft $loff = $len; 1188c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 11898905a67cSAndy Whitcroft $len = length($blk); 11908905a67cSAndy Whitcroft $line++; 11918905a67cSAndy Whitcroft last; 11928905a67cSAndy Whitcroft } 11938905a67cSAndy Whitcroft # Bail if there is no further context. 11948905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 119513214adfSAndy Whitcroft if ($off >= $len) { 11968905a67cSAndy Whitcroft last; 11978905a67cSAndy Whitcroft } 1198f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1199f74bd194SAndy Whitcroft $level++; 1200f74bd194SAndy Whitcroft $type = '#'; 1201f74bd194SAndy Whitcroft } 12028905a67cSAndy Whitcroft } 1203cf655043SAndy Whitcroft $p = $c; 12048905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 120513214adfSAndy Whitcroft $remainder = substr($blk, $off); 12068905a67cSAndy Whitcroft 1207773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 12084635f4fbSAndy Whitcroft 12094635f4fbSAndy Whitcroft # Handle nested #if/#else. 12104635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 12114635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 12124635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 12134635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 12144635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 12154635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 12164635f4fbSAndy Whitcroft } 12174635f4fbSAndy Whitcroft 12188905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 12198905a67cSAndy Whitcroft # outermost level. 12208905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 12218905a67cSAndy Whitcroft last; 12228905a67cSAndy Whitcroft } 12238905a67cSAndy Whitcroft 122413214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1225773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1226773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1227773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1228773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1229773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1230773647a0SAndy Whitcroft $coff_set = 1; 1231773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1232773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 123313214adfSAndy Whitcroft } 123413214adfSAndy Whitcroft 12358905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 12368905a67cSAndy Whitcroft $level++; 12378905a67cSAndy Whitcroft $type = '('; 12388905a67cSAndy Whitcroft } 12398905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 12408905a67cSAndy Whitcroft $level--; 12418905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 12428905a67cSAndy Whitcroft 12438905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 12448905a67cSAndy Whitcroft $coff = $off; 1245773647a0SAndy Whitcroft $coff_set = 1; 1246773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 12478905a67cSAndy Whitcroft } 12488905a67cSAndy Whitcroft } 12498905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 12508905a67cSAndy Whitcroft $level++; 12518905a67cSAndy Whitcroft $type = '{'; 12528905a67cSAndy Whitcroft } 12538905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 12548905a67cSAndy Whitcroft $level--; 12558905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 12568905a67cSAndy Whitcroft 12578905a67cSAndy Whitcroft if ($level == 0) { 1258b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1259b998e001SPatrick Pannuto $off++; 1260b998e001SPatrick Pannuto } 12618905a67cSAndy Whitcroft last; 12628905a67cSAndy Whitcroft } 12638905a67cSAndy Whitcroft } 1264f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1265f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1266f74bd194SAndy Whitcroft $level--; 1267f74bd194SAndy Whitcroft $type = ''; 1268f74bd194SAndy Whitcroft $off++; 1269f74bd194SAndy Whitcroft last; 1270f74bd194SAndy Whitcroft } 12718905a67cSAndy Whitcroft $off++; 12728905a67cSAndy Whitcroft } 1273a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 127413214adfSAndy Whitcroft if ($off == $len) { 1275a3bb97a7SAndy Whitcroft $loff = $len + 1; 127613214adfSAndy Whitcroft $line++; 127713214adfSAndy Whitcroft $remain--; 127813214adfSAndy Whitcroft } 12798905a67cSAndy Whitcroft 12808905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 12818905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 12828905a67cSAndy Whitcroft 12838905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 12848905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 12858905a67cSAndy Whitcroft 1286773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 128713214adfSAndy Whitcroft 128813214adfSAndy Whitcroft return ($statement, $condition, 128913214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 129013214adfSAndy Whitcroft} 129113214adfSAndy Whitcroft 1292cf655043SAndy Whitcroftsub statement_lines { 1293cf655043SAndy Whitcroft my ($stmt) = @_; 1294cf655043SAndy Whitcroft 1295cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1296cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1297cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1298cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1299cf655043SAndy Whitcroft 1300cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1301cf655043SAndy Whitcroft 1302cf655043SAndy Whitcroft return $#stmt_lines + 2; 1303cf655043SAndy Whitcroft} 1304cf655043SAndy Whitcroft 1305cf655043SAndy Whitcroftsub statement_rawlines { 1306cf655043SAndy Whitcroft my ($stmt) = @_; 1307cf655043SAndy Whitcroft 1308cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1309cf655043SAndy Whitcroft 1310cf655043SAndy Whitcroft return $#stmt_lines + 2; 1311cf655043SAndy Whitcroft} 1312cf655043SAndy Whitcroft 1313cf655043SAndy Whitcroftsub statement_block_size { 1314cf655043SAndy Whitcroft my ($stmt) = @_; 1315cf655043SAndy Whitcroft 1316cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1317cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1318cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1319cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1320cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1321cf655043SAndy Whitcroft 1322cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1323cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1324cf655043SAndy Whitcroft 1325cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1326cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1327cf655043SAndy Whitcroft 1328cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1329cf655043SAndy Whitcroft return $stmt_lines; 1330cf655043SAndy Whitcroft } else { 1331cf655043SAndy Whitcroft return $stmt_statements; 1332cf655043SAndy Whitcroft } 1333cf655043SAndy Whitcroft} 1334cf655043SAndy Whitcroft 133513214adfSAndy Whitcroftsub ctx_statement_full { 133613214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 133713214adfSAndy Whitcroft my ($statement, $condition, $level); 133813214adfSAndy Whitcroft 133913214adfSAndy Whitcroft my (@chunks); 134013214adfSAndy Whitcroft 1341cf655043SAndy Whitcroft # Grab the first conditional/block pair. 134213214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 134313214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1344773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 134513214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1346cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1347cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1348cf655043SAndy Whitcroft } 1349cf655043SAndy Whitcroft 1350cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1351cf655043SAndy Whitcroft # could continue the statement. 1352cf655043SAndy Whitcroft for (;;) { 135313214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 135413214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1355cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1356773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1357cf655043SAndy Whitcroft #print "C: push\n"; 1358cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 135913214adfSAndy Whitcroft } 136013214adfSAndy Whitcroft 136113214adfSAndy Whitcroft return ($level, $linenr, @chunks); 13628905a67cSAndy Whitcroft} 13638905a67cSAndy Whitcroft 13644a0df2efSAndy Whitcroftsub ctx_block_get { 1365f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 13664a0df2efSAndy Whitcroft my $line; 13674a0df2efSAndy Whitcroft my $start = $linenr - 1; 13684a0df2efSAndy Whitcroft my $blk = ''; 13694a0df2efSAndy Whitcroft my @o; 13704a0df2efSAndy Whitcroft my @c; 13714a0df2efSAndy Whitcroft my @res = (); 13724a0df2efSAndy Whitcroft 1373f0a594c1SAndy Whitcroft my $level = 0; 13744635f4fbSAndy Whitcroft my @stack = ($level); 137500df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 137600df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 137700df344fSAndy Whitcroft $remain--; 137800df344fSAndy Whitcroft 137900df344fSAndy Whitcroft $blk .= $rawlines[$line]; 13804635f4fbSAndy Whitcroft 13814635f4fbSAndy Whitcroft # Handle nested #if/#else. 138201464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 13834635f4fbSAndy Whitcroft push(@stack, $level); 138401464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 13854635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 138601464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 13874635f4fbSAndy Whitcroft $level = pop(@stack); 13884635f4fbSAndy Whitcroft } 13894635f4fbSAndy Whitcroft 139001464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1391f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1392f0a594c1SAndy Whitcroft if ($off > 0) { 1393f0a594c1SAndy Whitcroft $off--; 1394f0a594c1SAndy Whitcroft next; 1395f0a594c1SAndy Whitcroft } 13964a0df2efSAndy Whitcroft 1397f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1398f0a594c1SAndy Whitcroft $level--; 1399f0a594c1SAndy Whitcroft last if ($level == 0); 1400f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1401f0a594c1SAndy Whitcroft $level++; 1402f0a594c1SAndy Whitcroft } 1403f0a594c1SAndy Whitcroft } 14044a0df2efSAndy Whitcroft 1405f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 140600df344fSAndy Whitcroft push(@res, $rawlines[$line]); 14074a0df2efSAndy Whitcroft } 14084a0df2efSAndy Whitcroft 1409f0a594c1SAndy Whitcroft last if ($level == 0); 14104a0df2efSAndy Whitcroft } 14114a0df2efSAndy Whitcroft 1412f0a594c1SAndy Whitcroft return ($level, @res); 14134a0df2efSAndy Whitcroft} 14144a0df2efSAndy Whitcroftsub ctx_block_outer { 14154a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 14164a0df2efSAndy Whitcroft 1417f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1418f0a594c1SAndy Whitcroft return @r; 14194a0df2efSAndy Whitcroft} 14204a0df2efSAndy Whitcroftsub ctx_block { 14214a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 14224a0df2efSAndy Whitcroft 1423f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1424f0a594c1SAndy Whitcroft return @r; 1425653d4876SAndy Whitcroft} 1426653d4876SAndy Whitcroftsub ctx_statement { 1427f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1428f0a594c1SAndy Whitcroft 1429f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1430f0a594c1SAndy Whitcroft return @r; 1431f0a594c1SAndy Whitcroft} 1432f0a594c1SAndy Whitcroftsub ctx_block_level { 1433653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1434653d4876SAndy Whitcroft 1435f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 14364a0df2efSAndy Whitcroft} 14379c0ca6f9SAndy Whitcroftsub ctx_statement_level { 14389c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 14399c0ca6f9SAndy Whitcroft 14409c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 14419c0ca6f9SAndy Whitcroft} 14424a0df2efSAndy Whitcroft 14434a0df2efSAndy Whitcroftsub ctx_locate_comment { 14444a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 14454a0df2efSAndy Whitcroft 14464a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1447beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 14484a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 14494a0df2efSAndy Whitcroft 14504a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 14514a0df2efSAndy Whitcroft # comment. 14524a0df2efSAndy Whitcroft my $in_comment = 0; 14534a0df2efSAndy Whitcroft $current_comment = ''; 14544a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 145500df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 145600df344fSAndy Whitcroft #warn " $line\n"; 14574a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 14584a0df2efSAndy Whitcroft $in_comment = 1; 14594a0df2efSAndy Whitcroft } 14604a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 14614a0df2efSAndy Whitcroft $in_comment = 1; 14624a0df2efSAndy Whitcroft } 14634a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 14644a0df2efSAndy Whitcroft $current_comment = ''; 14654a0df2efSAndy Whitcroft } 14664a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 14674a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 14684a0df2efSAndy Whitcroft $in_comment = 0; 14694a0df2efSAndy Whitcroft } 14704a0df2efSAndy Whitcroft } 14714a0df2efSAndy Whitcroft 14724a0df2efSAndy Whitcroft chomp($current_comment); 14734a0df2efSAndy Whitcroft return($current_comment); 14744a0df2efSAndy Whitcroft} 14754a0df2efSAndy Whitcroftsub ctx_has_comment { 14764a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 14774a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 14784a0df2efSAndy Whitcroft 147900df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 14804a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 14814a0df2efSAndy Whitcroft 14824a0df2efSAndy Whitcroft return ($cmt ne ''); 14834a0df2efSAndy Whitcroft} 14844a0df2efSAndy Whitcroft 14854d001e4dSAndy Whitcroftsub raw_line { 14864d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 14874d001e4dSAndy Whitcroft 14884d001e4dSAndy Whitcroft my $offset = $linenr - 1; 14894d001e4dSAndy Whitcroft $cnt++; 14904d001e4dSAndy Whitcroft 14914d001e4dSAndy Whitcroft my $line; 14924d001e4dSAndy Whitcroft while ($cnt) { 14934d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 14944d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 14954d001e4dSAndy Whitcroft $cnt--; 14964d001e4dSAndy Whitcroft } 14974d001e4dSAndy Whitcroft 14984d001e4dSAndy Whitcroft return $line; 14994d001e4dSAndy Whitcroft} 15004d001e4dSAndy Whitcroft 15010a920b5bSAndy Whitcroftsub cat_vet { 15020a920b5bSAndy Whitcroft my ($vet) = @_; 15039c0ca6f9SAndy Whitcroft my ($res, $coded); 15040a920b5bSAndy Whitcroft 15059c0ca6f9SAndy Whitcroft $res = ''; 15066c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 15076c72ffaaSAndy Whitcroft $res .= $1; 15086c72ffaaSAndy Whitcroft if ($2 ne '') { 15099c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 15106c72ffaaSAndy Whitcroft $res .= $coded; 15116c72ffaaSAndy Whitcroft } 15129c0ca6f9SAndy Whitcroft } 15139c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 15140a920b5bSAndy Whitcroft 15159c0ca6f9SAndy Whitcroft return $res; 15160a920b5bSAndy Whitcroft} 15170a920b5bSAndy Whitcroft 1518c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1519cf655043SAndy Whitcroftmy $av_pending; 1520c2fdda0dSAndy Whitcroftmy @av_paren_type; 15211f65f947SAndy Whitcroftmy $av_pend_colon; 1522c2fdda0dSAndy Whitcroft 1523c2fdda0dSAndy Whitcroftsub annotate_reset { 1524c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1525cf655043SAndy Whitcroft $av_pending = '_'; 1526cf655043SAndy Whitcroft @av_paren_type = ('E'); 15271f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1528c2fdda0dSAndy Whitcroft} 1529c2fdda0dSAndy Whitcroft 15306c72ffaaSAndy Whitcroftsub annotate_values { 15316c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 15326c72ffaaSAndy Whitcroft 15336c72ffaaSAndy Whitcroft my $res; 15341f65f947SAndy Whitcroft my $var = '_' x length($stream); 15356c72ffaaSAndy Whitcroft my $cur = $stream; 15366c72ffaaSAndy Whitcroft 1537c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 15386c72ffaaSAndy Whitcroft 15396c72ffaaSAndy Whitcroft while (length($cur)) { 1540773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1541cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1542171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 15436c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1544c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1545c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1546cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1547c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 15486c72ffaaSAndy Whitcroft } 15496c72ffaaSAndy Whitcroft 1550c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 15519446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 15529446ef56SAndy Whitcroft push(@av_paren_type, $type); 1553addcdceaSAndy Whitcroft $type = 'c'; 15549446ef56SAndy Whitcroft 1555e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1556c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 15576c72ffaaSAndy Whitcroft $type = 'T'; 15586c72ffaaSAndy Whitcroft 1559389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1560389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1561389a2fe5SAndy Whitcroft $type = 'T'; 1562389a2fe5SAndy Whitcroft 1563c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1564171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1565c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1566171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1567171ae1a4SAndy Whitcroft if ($2 ne '') { 1568cf655043SAndy Whitcroft $av_pending = 'N'; 1569171ae1a4SAndy Whitcroft } 1570171ae1a4SAndy Whitcroft $type = 'E'; 1571171ae1a4SAndy Whitcroft 1572c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1573171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1574171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1575171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 15766c72ffaaSAndy Whitcroft 1577c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1578cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1579c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1580cf655043SAndy Whitcroft 1581cf655043SAndy Whitcroft push(@av_paren_type, $type); 1582cf655043SAndy Whitcroft push(@av_paren_type, $type); 1583171ae1a4SAndy Whitcroft $type = 'E'; 1584cf655043SAndy Whitcroft 1585c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1586cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1587cf655043SAndy Whitcroft $av_preprocessor = 1; 1588cf655043SAndy Whitcroft 1589cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1590cf655043SAndy Whitcroft 1591171ae1a4SAndy Whitcroft $type = 'E'; 1592cf655043SAndy Whitcroft 1593c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1594cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1595cf655043SAndy Whitcroft 1596cf655043SAndy Whitcroft $av_preprocessor = 1; 1597cf655043SAndy Whitcroft 1598cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1599cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1600cf655043SAndy Whitcroft pop(@av_paren_type); 1601cf655043SAndy Whitcroft push(@av_paren_type, $type); 1602171ae1a4SAndy Whitcroft $type = 'E'; 16036c72ffaaSAndy Whitcroft 16046c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1605c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 16066c72ffaaSAndy Whitcroft 1607171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1608171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1609171ae1a4SAndy Whitcroft $av_pending = $type; 1610171ae1a4SAndy Whitcroft $type = 'N'; 1611171ae1a4SAndy Whitcroft 16126c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1613c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 16146c72ffaaSAndy Whitcroft if (defined $2) { 1615cf655043SAndy Whitcroft $av_pending = 'V'; 16166c72ffaaSAndy Whitcroft } 16176c72ffaaSAndy Whitcroft $type = 'N'; 16186c72ffaaSAndy Whitcroft 161914b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1620c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 162114b111c1SAndy Whitcroft $av_pending = 'E'; 16226c72ffaaSAndy Whitcroft $type = 'N'; 16236c72ffaaSAndy Whitcroft 16241f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 16251f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 16261f65f947SAndy Whitcroft $av_pend_colon = 'C'; 16271f65f947SAndy Whitcroft $type = 'N'; 16281f65f947SAndy Whitcroft 162914b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1630c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 16316c72ffaaSAndy Whitcroft $type = 'N'; 16326c72ffaaSAndy Whitcroft 16336c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1634c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1635cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1636cf655043SAndy Whitcroft $av_pending = '_'; 16376c72ffaaSAndy Whitcroft $type = 'N'; 16386c72ffaaSAndy Whitcroft 16396c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1640cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1641cf655043SAndy Whitcroft if ($new_type ne '_') { 1642cf655043SAndy Whitcroft $type = $new_type; 1643c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1644c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 16456c72ffaaSAndy Whitcroft } else { 1646c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 16476c72ffaaSAndy Whitcroft } 16486c72ffaaSAndy Whitcroft 1649c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1650c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1651c8cb2ca3SAndy Whitcroft $type = 'V'; 1652cf655043SAndy Whitcroft $av_pending = 'V'; 16536c72ffaaSAndy Whitcroft 16548e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 16558e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 16561f65f947SAndy Whitcroft $av_pend_colon = 'B'; 16578e761b04SAndy Whitcroft } elsif ($type eq 'E') { 16588e761b04SAndy Whitcroft $av_pend_colon = 'L'; 16591f65f947SAndy Whitcroft } 16601f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 16611f65f947SAndy Whitcroft $type = 'V'; 16621f65f947SAndy Whitcroft 16636c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1664c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 16656c72ffaaSAndy Whitcroft $type = 'V'; 16666c72ffaaSAndy Whitcroft 16676c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1668c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 16696c72ffaaSAndy Whitcroft $type = 'N'; 16706c72ffaaSAndy Whitcroft 1671cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1672c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 167313214adfSAndy Whitcroft $type = 'E'; 16741f65f947SAndy Whitcroft $av_pend_colon = 'O'; 167513214adfSAndy Whitcroft 16768e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 16778e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 16788e761b04SAndy Whitcroft $type = 'C'; 16798e761b04SAndy Whitcroft 16801f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 16811f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 16821f65f947SAndy Whitcroft $type = 'N'; 16831f65f947SAndy Whitcroft 16841f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 16851f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 16861f65f947SAndy Whitcroft 16871f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 16881f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 16891f65f947SAndy Whitcroft $type = 'E'; 16901f65f947SAndy Whitcroft } else { 16911f65f947SAndy Whitcroft $type = 'N'; 16921f65f947SAndy Whitcroft } 16931f65f947SAndy Whitcroft $av_pend_colon = 'O'; 16941f65f947SAndy Whitcroft 16958e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 169613214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 16976c72ffaaSAndy Whitcroft $type = 'N'; 16986c72ffaaSAndy Whitcroft 16990d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 170074048ed8SAndy Whitcroft my $variant; 170174048ed8SAndy Whitcroft 170274048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 170374048ed8SAndy Whitcroft if ($type eq 'V') { 170474048ed8SAndy Whitcroft $variant = 'B'; 170574048ed8SAndy Whitcroft } else { 170674048ed8SAndy Whitcroft $variant = 'U'; 170774048ed8SAndy Whitcroft } 170874048ed8SAndy Whitcroft 170974048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 171074048ed8SAndy Whitcroft $type = 'N'; 171174048ed8SAndy Whitcroft 17126c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1713c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 17146c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 17156c72ffaaSAndy Whitcroft $type = 'N'; 17166c72ffaaSAndy Whitcroft } 17176c72ffaaSAndy Whitcroft 17186c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1719c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 17206c72ffaaSAndy Whitcroft } 17216c72ffaaSAndy Whitcroft if (defined $1) { 17226c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 17236c72ffaaSAndy Whitcroft $res .= $type x length($1); 17246c72ffaaSAndy Whitcroft } 17256c72ffaaSAndy Whitcroft } 17266c72ffaaSAndy Whitcroft 17271f65f947SAndy Whitcroft return ($res, $var); 17286c72ffaaSAndy Whitcroft} 17296c72ffaaSAndy Whitcroft 17308905a67cSAndy Whitcroftsub possible { 173113214adfSAndy Whitcroft my ($possible, $line) = @_; 17329a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 17330776e594SAndy Whitcroft ^(?: 17340776e594SAndy Whitcroft $Modifier| 17350776e594SAndy Whitcroft $Storage| 17360776e594SAndy Whitcroft $Type| 17379a974fdbSAndy Whitcroft DEFINE_\S+ 17389a974fdbSAndy Whitcroft )$| 17399a974fdbSAndy Whitcroft ^(?: 17400776e594SAndy Whitcroft goto| 17410776e594SAndy Whitcroft return| 17420776e594SAndy Whitcroft case| 17430776e594SAndy Whitcroft else| 17440776e594SAndy Whitcroft asm|__asm__| 174589a88353SAndy Whitcroft do| 174689a88353SAndy Whitcroft \#| 174789a88353SAndy Whitcroft \#\#| 17489a974fdbSAndy Whitcroft )(?:\s|$)| 17490776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 17509a974fdbSAndy Whitcroft )}x; 17519a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 17529a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1753c45dcabdSAndy Whitcroft # Check for modifiers. 1754c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1755c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1756c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1757c45dcabdSAndy Whitcroft 1758c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1759c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1760d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 17619a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1762d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1763485ff23eSAlex Dowad push(@modifierListFile, $modifier); 1764d2506586SAndy Whitcroft } 17659a974fdbSAndy Whitcroft } 1766c45dcabdSAndy Whitcroft 1767c45dcabdSAndy Whitcroft } else { 176813214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 1769485ff23eSAlex Dowad push(@typeListFile, $possible); 1770c45dcabdSAndy Whitcroft } 17718905a67cSAndy Whitcroft build_types(); 17720776e594SAndy Whitcroft } else { 17730776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 17748905a67cSAndy Whitcroft } 17758905a67cSAndy Whitcroft} 17768905a67cSAndy Whitcroft 17776c72ffaaSAndy Whitcroftmy $prefix = ''; 17786c72ffaaSAndy Whitcroft 1779000d1cc1SJoe Perchessub show_type { 1780cbec18afSJoe Perches my ($type) = @_; 178191bfe484SJoe Perches 1782cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1783cbec18afSJoe Perches 1784cbec18afSJoe Perches return !defined $ignore_type{$type}; 1785000d1cc1SJoe Perches} 1786000d1cc1SJoe Perches 1787f0a594c1SAndy Whitcroftsub report { 1788cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1789cbec18afSJoe Perches 1790cbec18afSJoe Perches if (!show_type($type) || 1791cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1792773647a0SAndy Whitcroft return 0; 1793773647a0SAndy Whitcroft } 179457230297SJoe Perches my $output = ''; 179557230297SJoe Perches if (-t STDOUT && $color) { 179657230297SJoe Perches if ($level eq 'ERROR') { 179757230297SJoe Perches $output .= RED; 179857230297SJoe Perches } elsif ($level eq 'WARNING') { 179957230297SJoe Perches $output .= YELLOW; 1800000d1cc1SJoe Perches } else { 180157230297SJoe Perches $output .= GREEN; 1802000d1cc1SJoe Perches } 180357230297SJoe Perches } 180457230297SJoe Perches $output .= $prefix . $level . ':'; 180557230297SJoe Perches if ($show_types) { 180657230297SJoe Perches $output .= BLUE if (-t STDOUT && $color); 180757230297SJoe Perches $output .= "$type:"; 180857230297SJoe Perches } 180957230297SJoe Perches $output .= RESET if (-t STDOUT && $color); 181057230297SJoe Perches $output .= ' ' . $msg . "\n"; 181134d8815fSJoe Perches 181234d8815fSJoe Perches if ($showfile) { 181334d8815fSJoe Perches my @lines = split("\n", $output, -1); 181434d8815fSJoe Perches splice(@lines, 1, 1); 181534d8815fSJoe Perches $output = join("\n", @lines); 181634d8815fSJoe Perches } 181757230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 18188905a67cSAndy Whitcroft 181957230297SJoe Perches push(our @report, $output); 1820773647a0SAndy Whitcroft 1821773647a0SAndy Whitcroft return 1; 1822f0a594c1SAndy Whitcroft} 1823cbec18afSJoe Perches 1824f0a594c1SAndy Whitcroftsub report_dump { 182513214adfSAndy Whitcroft our @report; 1826f0a594c1SAndy Whitcroft} 1827000d1cc1SJoe Perches 1828d752fcc8SJoe Perchessub fixup_current_range { 1829d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 1830d752fcc8SJoe Perches 1831d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 1832d752fcc8SJoe Perches my $o = $1; 1833d752fcc8SJoe Perches my $l = $2; 1834d752fcc8SJoe Perches my $no = $o + $offset; 1835d752fcc8SJoe Perches my $nl = $l + $length; 1836d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 1837d752fcc8SJoe Perches } 1838d752fcc8SJoe Perches} 1839d752fcc8SJoe Perches 1840d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 1841d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 1842d752fcc8SJoe Perches 1843d752fcc8SJoe Perches my $range_last_linenr = 0; 1844d752fcc8SJoe Perches my $delta_offset = 0; 1845d752fcc8SJoe Perches 1846d752fcc8SJoe Perches my $old_linenr = 0; 1847d752fcc8SJoe Perches my $new_linenr = 0; 1848d752fcc8SJoe Perches 1849d752fcc8SJoe Perches my $next_insert = 0; 1850d752fcc8SJoe Perches my $next_delete = 0; 1851d752fcc8SJoe Perches 1852d752fcc8SJoe Perches my @lines = (); 1853d752fcc8SJoe Perches 1854d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 1855d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 1856d752fcc8SJoe Perches 1857d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 1858d752fcc8SJoe Perches my $save_line = 1; 1859d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 1860323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 1861d752fcc8SJoe Perches $delta_offset = 0; 1862d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 1863d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 1864d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 1865d752fcc8SJoe Perches } 1866d752fcc8SJoe Perches 1867d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 1868d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 1869d752fcc8SJoe Perches $save_line = 0; 1870d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 1871d752fcc8SJoe Perches } 1872d752fcc8SJoe Perches 1873d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 1874d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 1875d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 1876d752fcc8SJoe Perches $new_linenr++; 1877d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 1878d752fcc8SJoe Perches } 1879d752fcc8SJoe Perches 1880d752fcc8SJoe Perches if ($save_line) { 1881d752fcc8SJoe Perches push(@lines, $line); 1882d752fcc8SJoe Perches $new_linenr++; 1883d752fcc8SJoe Perches } 1884d752fcc8SJoe Perches 1885d752fcc8SJoe Perches $old_linenr++; 1886d752fcc8SJoe Perches } 1887d752fcc8SJoe Perches 1888d752fcc8SJoe Perches return @lines; 1889d752fcc8SJoe Perches} 1890d752fcc8SJoe Perches 1891f2d7e4d4SJoe Perchessub fix_insert_line { 1892f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1893f2d7e4d4SJoe Perches 1894f2d7e4d4SJoe Perches my $inserted = { 1895f2d7e4d4SJoe Perches LINENR => $linenr, 1896f2d7e4d4SJoe Perches LINE => $line, 1897f2d7e4d4SJoe Perches }; 1898f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 1899f2d7e4d4SJoe Perches} 1900f2d7e4d4SJoe Perches 1901f2d7e4d4SJoe Perchessub fix_delete_line { 1902f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1903f2d7e4d4SJoe Perches 1904f2d7e4d4SJoe Perches my $deleted = { 1905f2d7e4d4SJoe Perches LINENR => $linenr, 1906f2d7e4d4SJoe Perches LINE => $line, 1907f2d7e4d4SJoe Perches }; 1908f2d7e4d4SJoe Perches 1909f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 1910f2d7e4d4SJoe Perches} 1911f2d7e4d4SJoe Perches 1912de7d4f0eSAndy Whitcroftsub ERROR { 1913cbec18afSJoe Perches my ($type, $msg) = @_; 1914cbec18afSJoe Perches 1915cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 1916de7d4f0eSAndy Whitcroft our $clean = 0; 19176c72ffaaSAndy Whitcroft our $cnt_error++; 19183705ce5bSJoe Perches return 1; 1919de7d4f0eSAndy Whitcroft } 19203705ce5bSJoe Perches return 0; 1921773647a0SAndy Whitcroft} 1922de7d4f0eSAndy Whitcroftsub WARN { 1923cbec18afSJoe Perches my ($type, $msg) = @_; 1924cbec18afSJoe Perches 1925cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 1926de7d4f0eSAndy Whitcroft our $clean = 0; 19276c72ffaaSAndy Whitcroft our $cnt_warn++; 19283705ce5bSJoe Perches return 1; 1929de7d4f0eSAndy Whitcroft } 19303705ce5bSJoe Perches return 0; 1931773647a0SAndy Whitcroft} 1932de7d4f0eSAndy Whitcroftsub CHK { 1933cbec18afSJoe Perches my ($type, $msg) = @_; 1934cbec18afSJoe Perches 1935cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 1936de7d4f0eSAndy Whitcroft our $clean = 0; 19376c72ffaaSAndy Whitcroft our $cnt_chk++; 19383705ce5bSJoe Perches return 1; 19396c72ffaaSAndy Whitcroft } 19403705ce5bSJoe Perches return 0; 1941de7d4f0eSAndy Whitcroft} 1942de7d4f0eSAndy Whitcroft 19436ecd9674SAndy Whitcroftsub check_absolute_file { 19446ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 19456ecd9674SAndy Whitcroft my $file = $absolute; 19466ecd9674SAndy Whitcroft 19476ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 19486ecd9674SAndy Whitcroft 19496ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 19506ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 19516ecd9674SAndy Whitcroft if (-f "$root/$file") { 19526ecd9674SAndy Whitcroft ##print "file<$file>\n"; 19536ecd9674SAndy Whitcroft last; 19546ecd9674SAndy Whitcroft } 19556ecd9674SAndy Whitcroft } 19566ecd9674SAndy Whitcroft if (! -f _) { 19576ecd9674SAndy Whitcroft return 0; 19586ecd9674SAndy Whitcroft } 19596ecd9674SAndy Whitcroft 19606ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 19616ecd9674SAndy Whitcroft my $prefix = $absolute; 19626ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 19636ecd9674SAndy Whitcroft 19646ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 19656ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1966000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1967000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 19686ecd9674SAndy Whitcroft } 19696ecd9674SAndy Whitcroft} 19706ecd9674SAndy Whitcroft 19713705ce5bSJoe Perchessub trim { 19723705ce5bSJoe Perches my ($string) = @_; 19733705ce5bSJoe Perches 1974b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1975b34c648bSJoe Perches 1976b34c648bSJoe Perches return $string; 1977b34c648bSJoe Perches} 1978b34c648bSJoe Perches 1979b34c648bSJoe Perchessub ltrim { 1980b34c648bSJoe Perches my ($string) = @_; 1981b34c648bSJoe Perches 1982b34c648bSJoe Perches $string =~ s/^\s+//; 1983b34c648bSJoe Perches 1984b34c648bSJoe Perches return $string; 1985b34c648bSJoe Perches} 1986b34c648bSJoe Perches 1987b34c648bSJoe Perchessub rtrim { 1988b34c648bSJoe Perches my ($string) = @_; 1989b34c648bSJoe Perches 1990b34c648bSJoe Perches $string =~ s/\s+$//; 19913705ce5bSJoe Perches 19923705ce5bSJoe Perches return $string; 19933705ce5bSJoe Perches} 19943705ce5bSJoe Perches 199552ea8506SJoe Perchessub string_find_replace { 199652ea8506SJoe Perches my ($string, $find, $replace) = @_; 199752ea8506SJoe Perches 199852ea8506SJoe Perches $string =~ s/$find/$replace/g; 199952ea8506SJoe Perches 200052ea8506SJoe Perches return $string; 200152ea8506SJoe Perches} 200252ea8506SJoe Perches 20033705ce5bSJoe Perchessub tabify { 20043705ce5bSJoe Perches my ($leading) = @_; 20053705ce5bSJoe Perches 20063705ce5bSJoe Perches my $source_indent = 8; 20073705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 20083705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 20093705ce5bSJoe Perches 20103705ce5bSJoe Perches #convert leading spaces to tabs 20113705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 20123705ce5bSJoe Perches #Remove spaces before a tab 20133705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 20143705ce5bSJoe Perches 20153705ce5bSJoe Perches return "$leading"; 20163705ce5bSJoe Perches} 20173705ce5bSJoe Perches 2018d1fe9c09SJoe Perchessub pos_last_openparen { 2019d1fe9c09SJoe Perches my ($line) = @_; 2020d1fe9c09SJoe Perches 2021d1fe9c09SJoe Perches my $pos = 0; 2022d1fe9c09SJoe Perches 2023d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2024d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2025d1fe9c09SJoe Perches 2026d1fe9c09SJoe Perches my $last_openparen = 0; 2027d1fe9c09SJoe Perches 2028d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2029d1fe9c09SJoe Perches return -1; 2030d1fe9c09SJoe Perches } 2031d1fe9c09SJoe Perches 2032d1fe9c09SJoe Perches my $len = length($line); 2033d1fe9c09SJoe Perches 2034d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2035d1fe9c09SJoe Perches my $string = substr($line, $pos); 2036d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2037d1fe9c09SJoe Perches $pos += length($1) - 1; 2038d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2039d1fe9c09SJoe Perches $last_openparen = $pos; 2040d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2041d1fe9c09SJoe Perches last; 2042d1fe9c09SJoe Perches } 2043d1fe9c09SJoe Perches } 2044d1fe9c09SJoe Perches 204591cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2046d1fe9c09SJoe Perches} 2047d1fe9c09SJoe Perches 20480a920b5bSAndy Whitcroftsub process { 20490a920b5bSAndy Whitcroft my $filename = shift; 20500a920b5bSAndy Whitcroft 20510a920b5bSAndy Whitcroft my $linenr=0; 20520a920b5bSAndy Whitcroft my $prevline=""; 2053c2fdda0dSAndy Whitcroft my $prevrawline=""; 20540a920b5bSAndy Whitcroft my $stashline=""; 2055c2fdda0dSAndy Whitcroft my $stashrawline=""; 20560a920b5bSAndy Whitcroft 20574a0df2efSAndy Whitcroft my $length; 20580a920b5bSAndy Whitcroft my $indent; 20590a920b5bSAndy Whitcroft my $previndent=0; 20600a920b5bSAndy Whitcroft my $stashindent=0; 20610a920b5bSAndy Whitcroft 2062de7d4f0eSAndy Whitcroft our $clean = 1; 20630a920b5bSAndy Whitcroft my $signoff = 0; 20640a920b5bSAndy Whitcroft my $is_patch = 0; 206529ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 206615662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 2067bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 20682a076f40SJoe Perches my $commit_log_long_line = 0; 2069e518e9a5SJoe Perches my $commit_log_has_diff = 0; 207013f1937eSJoe Perches my $reported_maintainer_file = 0; 2071fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2072fa64205dSPasi Savanainen 2073365dd4eaSJoe Perches my $last_blank_line = 0; 20745e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2075365dd4eaSJoe Perches 207613214adfSAndy Whitcroft our @report = (); 20776c72ffaaSAndy Whitcroft our $cnt_lines = 0; 20786c72ffaaSAndy Whitcroft our $cnt_error = 0; 20796c72ffaaSAndy Whitcroft our $cnt_warn = 0; 20806c72ffaaSAndy Whitcroft our $cnt_chk = 0; 20816c72ffaaSAndy Whitcroft 20820a920b5bSAndy Whitcroft # Trace the real file/line as we go. 20830a920b5bSAndy Whitcroft my $realfile = ''; 20840a920b5bSAndy Whitcroft my $realline = 0; 20850a920b5bSAndy Whitcroft my $realcnt = 0; 20860a920b5bSAndy Whitcroft my $here = ''; 20870a920b5bSAndy Whitcroft my $in_comment = 0; 2088c2fdda0dSAndy Whitcroft my $comment_edge = 0; 20890a920b5bSAndy Whitcroft my $first_line = 0; 20901e855726SWolfram Sang my $p1_prefix = ''; 20910a920b5bSAndy Whitcroft 209213214adfSAndy Whitcroft my $prev_values = 'E'; 209313214adfSAndy Whitcroft 209413214adfSAndy Whitcroft # suppression flags 2095773647a0SAndy Whitcroft my %suppress_ifbraces; 2096170d3a22SAndy Whitcroft my %suppress_whiletrailers; 20972b474a1aSAndy Whitcroft my %suppress_export; 20983e469cdcSAndy Whitcroft my $suppress_statement = 0; 2099653d4876SAndy Whitcroft 21007e51f197SJoe Perches my %signatures = (); 2101323c1260SJoe Perches 2102c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2103de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2104c2fdda0dSAndy Whitcroft # 2105de7d4f0eSAndy Whitcroft my @setup_docs = (); 2106de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2107773647a0SAndy Whitcroft 2108d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2109d8b07710SJoe Perches 2110773647a0SAndy Whitcroft sanitise_line_reset(); 2111c2fdda0dSAndy Whitcroft my $line; 2112c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2113773647a0SAndy Whitcroft $linenr++; 2114773647a0SAndy Whitcroft $line = $rawline; 2115c2fdda0dSAndy Whitcroft 21163705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 21173705ce5bSJoe Perches 2118773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2119de7d4f0eSAndy Whitcroft $setup_docs = 0; 2120de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 2121de7d4f0eSAndy Whitcroft $setup_docs = 1; 2122de7d4f0eSAndy Whitcroft } 2123773647a0SAndy Whitcroft #next; 2124de7d4f0eSAndy Whitcroft } 2125773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2126773647a0SAndy Whitcroft $realline=$1-1; 2127773647a0SAndy Whitcroft if (defined $2) { 2128773647a0SAndy Whitcroft $realcnt=$3+1; 2129773647a0SAndy Whitcroft } else { 2130773647a0SAndy Whitcroft $realcnt=1+1; 2131773647a0SAndy Whitcroft } 2132c45dcabdSAndy Whitcroft $in_comment = 0; 2133773647a0SAndy Whitcroft 2134773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2135773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2136773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2137773647a0SAndy Whitcroft # at context start. 2138773647a0SAndy Whitcroft my $edge; 213901fa9147SAndy Whitcroft my $cnt = $realcnt; 214001fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 214101fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 214201fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 214301fa9147SAndy Whitcroft $cnt--; 214401fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2145721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2146fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2147fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2148fae17daeSAndy Whitcroft ($edge) = $1; 2149fae17daeSAndy Whitcroft last; 2150fae17daeSAndy Whitcroft } 2151773647a0SAndy Whitcroft } 2152773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2153773647a0SAndy Whitcroft $in_comment = 1; 2154773647a0SAndy Whitcroft } 2155773647a0SAndy Whitcroft 2156773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2157773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2158773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2159773647a0SAndy Whitcroft if (!defined $edge && 216083242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2161773647a0SAndy Whitcroft { 2162773647a0SAndy Whitcroft $in_comment = 1; 2163773647a0SAndy Whitcroft } 2164773647a0SAndy Whitcroft 2165773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2166773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2167773647a0SAndy Whitcroft 2168171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2169773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2170171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2171773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2172773647a0SAndy Whitcroft } 2173773647a0SAndy Whitcroft push(@lines, $line); 2174773647a0SAndy Whitcroft 2175773647a0SAndy Whitcroft if ($realcnt > 1) { 2176773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2177773647a0SAndy Whitcroft } else { 2178773647a0SAndy Whitcroft $realcnt = 0; 2179773647a0SAndy Whitcroft } 2180773647a0SAndy Whitcroft 2181773647a0SAndy Whitcroft #print "==>$rawline\n"; 2182773647a0SAndy Whitcroft #print "-->$line\n"; 2183de7d4f0eSAndy Whitcroft 2184de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2185de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2186de7d4f0eSAndy Whitcroft } 2187de7d4f0eSAndy Whitcroft } 2188de7d4f0eSAndy Whitcroft 21896c72ffaaSAndy Whitcroft $prefix = ''; 21906c72ffaaSAndy Whitcroft 2191773647a0SAndy Whitcroft $realcnt = 0; 2192773647a0SAndy Whitcroft $linenr = 0; 2193194f66fcSJoe Perches $fixlinenr = -1; 21940a920b5bSAndy Whitcroft foreach my $line (@lines) { 21950a920b5bSAndy Whitcroft $linenr++; 2196194f66fcSJoe Perches $fixlinenr++; 21971b5539b1SJoe Perches my $sline = $line; #copy of $line 21981b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 21990a920b5bSAndy Whitcroft 2200c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 22016c72ffaaSAndy Whitcroft 22020a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2203e518e9a5SJoe Perches if (!$in_commit_log && 2204e518e9a5SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 22050a920b5bSAndy Whitcroft $is_patch = 1; 22064a0df2efSAndy Whitcroft $first_line = $linenr + 1; 22070a920b5bSAndy Whitcroft $realline=$1-1; 22080a920b5bSAndy Whitcroft if (defined $2) { 22090a920b5bSAndy Whitcroft $realcnt=$3+1; 22100a920b5bSAndy Whitcroft } else { 22110a920b5bSAndy Whitcroft $realcnt=1+1; 22120a920b5bSAndy Whitcroft } 2213c2fdda0dSAndy Whitcroft annotate_reset(); 221413214adfSAndy Whitcroft $prev_values = 'E'; 221513214adfSAndy Whitcroft 2216773647a0SAndy Whitcroft %suppress_ifbraces = (); 2217170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 22182b474a1aSAndy Whitcroft %suppress_export = (); 22193e469cdcSAndy Whitcroft $suppress_statement = 0; 22200a920b5bSAndy Whitcroft next; 22210a920b5bSAndy Whitcroft 22224a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 22234a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 22244a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2225773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 22260a920b5bSAndy Whitcroft $realline++; 2227d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 22280a920b5bSAndy Whitcroft 22294a0df2efSAndy Whitcroft # Measure the line length and indent. 2230c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 22310a920b5bSAndy Whitcroft 22320a920b5bSAndy Whitcroft # Track the previous line. 22330a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 22340a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2235c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2236c2fdda0dSAndy Whitcroft 2237773647a0SAndy Whitcroft #warn "line<$line>\n"; 22386c72ffaaSAndy Whitcroft 2239d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2240d8aaf121SAndy Whitcroft $realcnt--; 22410a920b5bSAndy Whitcroft } 22420a920b5bSAndy Whitcroft 2243cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2244cc77cdcaSAndy Whitcroft 22456c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 22466c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2247773647a0SAndy Whitcroft 22482ac73b4fSJoe Perches my $found_file = 0; 2249773647a0SAndy Whitcroft # extract the filename as it passes 22503bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 22513bf9a009SRabin Vincent $realfile = $1; 22522b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2253270c49a0SJoe Perches $in_commit_log = 0; 22542ac73b4fSJoe Perches $found_file = 1; 22553bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2256773647a0SAndy Whitcroft $realfile = $1; 22572b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2258270c49a0SJoe Perches $in_commit_log = 0; 22591e855726SWolfram Sang 22601e855726SWolfram Sang $p1_prefix = $1; 2261e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2262e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2263000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2264000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 22651e855726SWolfram Sang } 2266773647a0SAndy Whitcroft 2267c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2268000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2269000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2270773647a0SAndy Whitcroft } 22712ac73b4fSJoe Perches $found_file = 1; 22722ac73b4fSJoe Perches } 22732ac73b4fSJoe Perches 227434d8815fSJoe Perches#make up the handle for any error we report on this line 227534d8815fSJoe Perches if ($showfile) { 227634d8815fSJoe Perches $prefix = "$realfile:$realline: " 227734d8815fSJoe Perches } elsif ($emacs) { 22787d3a9f67SJoe Perches if ($file) { 22797d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 22807d3a9f67SJoe Perches } else { 228134d8815fSJoe Perches $prefix = "$filename:$linenr: "; 228234d8815fSJoe Perches } 22837d3a9f67SJoe Perches } 228434d8815fSJoe Perches 22852ac73b4fSJoe Perches if ($found_file) { 22867bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 22872ac73b4fSJoe Perches $check = 1; 22882ac73b4fSJoe Perches } else { 22892ac73b4fSJoe Perches $check = $check_orig; 22902ac73b4fSJoe Perches } 2291773647a0SAndy Whitcroft next; 2292773647a0SAndy Whitcroft } 2293773647a0SAndy Whitcroft 2294389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 22950a920b5bSAndy Whitcroft 2296c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2297c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2298c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 22990a920b5bSAndy Whitcroft 23006c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 23016c72ffaaSAndy Whitcroft 2302e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2303e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2304e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2305e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2306e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2307e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2308e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2309e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2310e518e9a5SJoe Perches $commit_log_has_diff = 1; 2311e518e9a5SJoe Perches } 2312e518e9a5SJoe Perches 23133bf9a009SRabin Vincent# Check for incorrect file permissions 23143bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 23153bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 231604db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 231704db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2318000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2319000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 23203bf9a009SRabin Vincent } 23213bf9a009SRabin Vincent } 23223bf9a009SRabin Vincent 232320112475SJoe Perches# Check the patch for a signoff: 2324d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 23254a0df2efSAndy Whitcroft $signoff++; 232615662b3eSJoe Perches $in_commit_log = 0; 23270a920b5bSAndy Whitcroft } 232820112475SJoe Perches 2329e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2330e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2331e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2332e0d975b1SJoe Perches $reported_maintainer_file = 1; 2333e0d975b1SJoe Perches } 2334e0d975b1SJoe Perches 233520112475SJoe Perches# Check signature styles 2336270c49a0SJoe Perches if (!$in_header_lines && 2337ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 233820112475SJoe Perches my $space_before = $1; 233920112475SJoe Perches my $sign_off = $2; 234020112475SJoe Perches my $space_after = $3; 234120112475SJoe Perches my $email = $4; 234220112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 234320112475SJoe Perches 2344ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2345ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2346ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2347ce0338dfSJoe Perches } 234820112475SJoe Perches if (defined $space_before && $space_before ne "") { 23493705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 23503705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 23513705ce5bSJoe Perches $fix) { 2352194f66fcSJoe Perches $fixed[$fixlinenr] = 23533705ce5bSJoe Perches "$ucfirst_sign_off $email"; 23543705ce5bSJoe Perches } 235520112475SJoe Perches } 235620112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 23573705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 23583705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 23593705ce5bSJoe Perches $fix) { 2360194f66fcSJoe Perches $fixed[$fixlinenr] = 23613705ce5bSJoe Perches "$ucfirst_sign_off $email"; 23623705ce5bSJoe Perches } 23633705ce5bSJoe Perches 236420112475SJoe Perches } 236520112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 23663705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 23673705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 23683705ce5bSJoe Perches $fix) { 2369194f66fcSJoe Perches $fixed[$fixlinenr] = 23703705ce5bSJoe Perches "$ucfirst_sign_off $email"; 23713705ce5bSJoe Perches } 237220112475SJoe Perches } 237320112475SJoe Perches 237420112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 237520112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 237620112475SJoe Perches if ($suggested_email eq "") { 2377000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2378000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 237920112475SJoe Perches } else { 238020112475SJoe Perches my $dequoted = $suggested_email; 238120112475SJoe Perches $dequoted =~ s/^"//; 238220112475SJoe Perches $dequoted =~ s/" </ </; 238320112475SJoe Perches # Don't force email to have quotes 238420112475SJoe Perches # Allow just an angle bracketed address 238520112475SJoe Perches if ("$dequoted$comment" ne $email && 238620112475SJoe Perches "<$email_address>$comment" ne $email && 238720112475SJoe Perches "$suggested_email$comment" ne $email) { 2388000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2389000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 239020112475SJoe Perches } 23910a920b5bSAndy Whitcroft } 23927e51f197SJoe Perches 23937e51f197SJoe Perches# Check for duplicate signatures 23947e51f197SJoe Perches my $sig_nospace = $line; 23957e51f197SJoe Perches $sig_nospace =~ s/\s//g; 23967e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 23977e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 23987e51f197SJoe Perches WARN("BAD_SIGN_OFF", 23997e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 24007e51f197SJoe Perches } else { 24017e51f197SJoe Perches $signatures{$sig_nospace} = 1; 24027e51f197SJoe Perches } 24030a920b5bSAndy Whitcroft } 24040a920b5bSAndy Whitcroft 2405a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2406a2fe16b9SJoe Perches if ($in_header_lines && 2407a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2408a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2409a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2410a2fe16b9SJoe Perches } 2411a2fe16b9SJoe Perches 24129b3189ebSJoe Perches# Check for old stable address 24139b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 24149b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 24159b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 24169b3189ebSJoe Perches } 24179b3189ebSJoe Perches 24187ebd05efSChristopher Covington# Check for unwanted Gerrit info 24197ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 24207ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 24217ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 24227ebd05efSChristopher Covington } 24237ebd05efSChristopher Covington 2424369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2425369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2426369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2427369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2428369c8dd3SJoe Perches # timestamp 2429369c8dd3SJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) { 2430369c8dd3SJoe Perches # stack dump address 2431369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2432369c8dd3SJoe Perches } 2433369c8dd3SJoe Perches 24342a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 24352a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2436bf4daf12SJoe Perches length($line) > 75 && 2437bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2438bf4daf12SJoe Perches # file delta changes 2439bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2440bf4daf12SJoe Perches # filename then : 2441bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2442bf4daf12SJoe Perches # A Fixes: or Link: line 2443bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 24442a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 24452a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 24462a076f40SJoe Perches $commit_log_long_line = 1; 24472a076f40SJoe Perches } 24482a076f40SJoe Perches 2449bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2450bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2451bf4daf12SJoe Perches $line =~ /^\s*$/) { 2452bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2453bf4daf12SJoe Perches } 2454bf4daf12SJoe Perches 24550d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2456369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2457fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2458bf4daf12SJoe Perches ($line =~ /\b[0-9a-f]{12,40}\b/i && 2459369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2460bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2461fe043ea1SJoe Perches my $init_char = "c"; 2462fe043ea1SJoe Perches my $orig_commit = ""; 24630d7835fcSJoe Perches my $short = 1; 24640d7835fcSJoe Perches my $long = 0; 24650d7835fcSJoe Perches my $case = 1; 24660d7835fcSJoe Perches my $space = 1; 24670d7835fcSJoe Perches my $hasdesc = 0; 246819c146a6SJoe Perches my $hasparens = 0; 24690d7835fcSJoe Perches my $id = '0123456789ab'; 24700d7835fcSJoe Perches my $orig_desc = "commit description"; 24710d7835fcSJoe Perches my $description = ""; 24720d7835fcSJoe Perches 2473fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2474fe043ea1SJoe Perches $init_char = $1; 2475fe043ea1SJoe Perches $orig_commit = lc($2); 2476fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2477fe043ea1SJoe Perches $orig_commit = lc($1); 2478fe043ea1SJoe Perches } 2479fe043ea1SJoe Perches 24800d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 24810d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 24820d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 24830d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 24840d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 24850d7835fcSJoe Perches $orig_desc = $1; 248619c146a6SJoe Perches $hasparens = 1; 24870d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 24880d7835fcSJoe Perches defined $rawlines[$linenr] && 24890d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 24900d7835fcSJoe Perches $orig_desc = $1; 249119c146a6SJoe Perches $hasparens = 1; 2492b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2493b671fde0SJoe Perches defined $rawlines[$linenr] && 2494b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2495b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2496b671fde0SJoe Perches $orig_desc = $1; 2497b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2498b671fde0SJoe Perches $orig_desc .= " " . $1; 249919c146a6SJoe Perches $hasparens = 1; 25000d7835fcSJoe Perches } 25010d7835fcSJoe Perches 25020d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 25030d7835fcSJoe Perches $id, $orig_desc); 25040d7835fcSJoe Perches 250519c146a6SJoe Perches if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) { 2506d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 25070d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 25080d7835fcSJoe Perches } 2509d311cd44SJoe Perches } 2510d311cd44SJoe Perches 251113f1937eSJoe Perches# Check for added, moved or deleted files 251213f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 251313f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 251413f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 251513f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 251613f1937eSJoe Perches (defined($1) || defined($2))))) { 251713f1937eSJoe Perches $reported_maintainer_file = 1; 251813f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 251913f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 252013f1937eSJoe Perches } 252113f1937eSJoe Perches 252200df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 25238905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2524000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2525000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 25266c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2527de7d4f0eSAndy Whitcroft } 2528de7d4f0eSAndy Whitcroft 25296ecd9674SAndy Whitcroft# Check for absolute kernel paths. 25306ecd9674SAndy Whitcroft if ($tree) { 25316ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 25326ecd9674SAndy Whitcroft my $file = $1; 25336ecd9674SAndy Whitcroft 25346ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 25356ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 25366ecd9674SAndy Whitcroft # 25376ecd9674SAndy Whitcroft } else { 25386ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 25396ecd9674SAndy Whitcroft } 25406ecd9674SAndy Whitcroft } 25416ecd9674SAndy Whitcroft } 25426ecd9674SAndy Whitcroft 2543de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2544de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2545171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2546171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2547171ae1a4SAndy Whitcroft 2548171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2549171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2550171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2551171ae1a4SAndy Whitcroft 255234d99219SJoe Perches CHK("INVALID_UTF8", 2553000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 255400df344fSAndy Whitcroft } 25550a920b5bSAndy Whitcroft 255615662b3eSJoe Perches# Check if it's the start of a commit log 255715662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 255815662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 255929ee1b0cSJoe Perches !($rawline =~ /^\s+\S/ || 256029ee1b0cSJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 256115662b3eSJoe Perches $in_header_lines = 0; 256215662b3eSJoe Perches $in_commit_log = 1; 256315662b3eSJoe Perches } 256415662b3eSJoe Perches 2565fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2566fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2567fa64205dSPasi Savanainen if ($in_header_lines && 2568fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2569fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2570fa64205dSPasi Savanainen $non_utf8_charset = 1; 2571fa64205dSPasi Savanainen } 2572fa64205dSPasi Savanainen 2573fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 257415662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2575fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 257615662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 257715662b3eSJoe Perches } 257815662b3eSJoe Perches 257966b47b4aSKees Cook# Check for various typo / spelling mistakes 258066d7a382SJoe Perches if (defined($misspellings) && 258166d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2582ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 258366b47b4aSKees Cook my $typo = $1; 258466b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 258566b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 258666b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 258766b47b4aSKees Cook my $msg_type = \&WARN; 258866b47b4aSKees Cook $msg_type = \&CHK if ($file); 258966b47b4aSKees Cook if (&{$msg_type}("TYPO_SPELLING", 259066b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 259166b47b4aSKees Cook $fix) { 259266b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 259366b47b4aSKees Cook } 259466b47b4aSKees Cook } 259566b47b4aSKees Cook } 259666b47b4aSKees Cook 259730670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 259830670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 259900df344fSAndy Whitcroft 26000a920b5bSAndy Whitcroft#trailing whitespace 26019c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2602c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2603d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2604d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2605d5e616fcSJoe Perches $fix) { 2606194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2607d5e616fcSJoe Perches } 2608c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2609c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 26103705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 26113705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 26123705ce5bSJoe Perches $fix) { 2613194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 26143705ce5bSJoe Perches } 26153705ce5bSJoe Perches 2616d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 26170a920b5bSAndy Whitcroft } 26185368df20SAndy Whitcroft 26194783f894SJosh Triplett# Check for FSF mailing addresses. 2620109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 26213e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 26223e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 26234783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 26244783f894SJosh Triplett my $msg_type = \&ERROR; 26254783f894SJosh Triplett $msg_type = \&CHK if ($file); 26264783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 26274783f894SJosh 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) 26284783f894SJosh Triplett } 26294783f894SJosh Triplett 26303354957aSAndi Kleen# check for Kconfig help text having a real description 26319fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 26329fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 26333354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 26348d73e0e7SJoe Perches $line =~ /^\+\s*config\s+/) { 26353354957aSAndi Kleen my $length = 0; 26369fe287d7SAndy Whitcroft my $cnt = $realcnt; 26379fe287d7SAndy Whitcroft my $ln = $linenr + 1; 26389fe287d7SAndy Whitcroft my $f; 2639a1385803SAndy Whitcroft my $is_start = 0; 26409fe287d7SAndy Whitcroft my $is_end = 0; 2641a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 26429fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 26439fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 26449fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 26459fe287d7SAndy Whitcroft 26469fe287d7SAndy Whitcroft next if ($f =~ /^-/); 26478d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2648a1385803SAndy Whitcroft 26498d73e0e7SJoe Perches if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) { 2650a1385803SAndy Whitcroft $is_start = 1; 26518d73e0e7SJoe Perches } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 2652a1385803SAndy Whitcroft $length = -1; 2653a1385803SAndy Whitcroft } 2654a1385803SAndy Whitcroft 26559fe287d7SAndy Whitcroft $f =~ s/^.//; 26563354957aSAndi Kleen $f =~ s/#.*//; 26573354957aSAndi Kleen $f =~ s/^\s+//; 26583354957aSAndi Kleen next if ($f =~ /^$/); 26599fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 26609fe287d7SAndy Whitcroft $is_end = 1; 26619fe287d7SAndy Whitcroft last; 26629fe287d7SAndy Whitcroft } 26633354957aSAndi Kleen $length++; 26643354957aSAndi Kleen } 266556193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2666000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 266756193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 266856193274SVadim Bendebury } 2669a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 26703354957aSAndi Kleen } 26713354957aSAndi Kleen 26721ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 26731ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 26741ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 26751ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 26761ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 26771ba8dfd1SKees Cook } 26781ba8dfd1SKees Cook 2679327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2680327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2681327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2682327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2683327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2684327953e9SChristoph Jaeger } 2685327953e9SChristoph Jaeger 2686c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2687c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2688c68e5878SArnaud Lacombe my $flag = $1; 2689c68e5878SArnaud Lacombe my $replacement = { 2690c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2691c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2692c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2693c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2694c68e5878SArnaud Lacombe }; 2695c68e5878SArnaud Lacombe 2696c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2697c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2698c68e5878SArnaud Lacombe } 2699c68e5878SArnaud Lacombe 2700bff5da43SRob Herring# check for DT compatible documentation 27017dd05b38SFlorian Vaussard if (defined $root && 27027dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 27037dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 27047dd05b38SFlorian Vaussard 2705bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2706bff5da43SRob Herring 2707cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2708cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2709cc93319bSFlorian Vaussard 2710bff5da43SRob Herring foreach my $compat (@compats) { 2711bff5da43SRob Herring my $compat2 = $compat; 2712185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2713185d566bSRob Herring my $compat3 = $compat; 2714185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2715185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2716bff5da43SRob Herring if ( $? >> 8 ) { 2717bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2718bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2719bff5da43SRob Herring } 2720bff5da43SRob Herring 27214fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 27224fbf32a6SFlorian Vaussard my $vendor = $1; 2723cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2724bff5da43SRob Herring if ( $? >> 8 ) { 2725bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2726cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2727bff5da43SRob Herring } 2728bff5da43SRob Herring } 2729bff5da43SRob Herring } 2730bff5da43SRob Herring 27315368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2732de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/); 27335368df20SAndy Whitcroft 273447e0c88bSJoe Perches# line length limit (with some exclusions) 273547e0c88bSJoe Perches# 273647e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 273747e0c88bSJoe Perches# logging functions like pr_info that end in a string 273847e0c88bSJoe Perches# lines with a single string 273947e0c88bSJoe Perches# #defines that are a single string 274047e0c88bSJoe Perches# 274147e0c88bSJoe Perches# There are 3 different line length message types: 274247e0c88bSJoe Perches# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength 274347e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 274447e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 274547e0c88bSJoe Perches# 274647e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 274747e0c88bSJoe Perches# 274847e0c88bSJoe Perches 2749b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 275047e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 275147e0c88bSJoe Perches 275247e0c88bSJoe Perches # Check the allowed long line types first 275347e0c88bSJoe Perches 275447e0c88bSJoe Perches # logging functions that end in a string that starts 275547e0c88bSJoe Perches # before $max_line_length 275647e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 275747e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 275847e0c88bSJoe Perches $msg_type = ""; 275947e0c88bSJoe Perches 276047e0c88bSJoe Perches # lines with only strings (w/ possible termination) 276147e0c88bSJoe Perches # #defines with only strings 276247e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 276347e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 276447e0c88bSJoe Perches $msg_type = ""; 276547e0c88bSJoe Perches 276647e0c88bSJoe Perches # Otherwise set the alternate message types 276747e0c88bSJoe Perches 276847e0c88bSJoe Perches # a comment starts before $max_line_length 276947e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 277047e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 277147e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 277247e0c88bSJoe Perches 277347e0c88bSJoe Perches # a quoted string starts before $max_line_length 277447e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 277547e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 277647e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 277747e0c88bSJoe Perches } 277847e0c88bSJoe Perches 277947e0c88bSJoe Perches if ($msg_type ne "" && 278047e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 278147e0c88bSJoe Perches WARN($msg_type, 27826cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 27830a920b5bSAndy Whitcroft } 278447e0c88bSJoe Perches } 27850a920b5bSAndy Whitcroft 27868905a67cSAndy Whitcroft# check for adding lines without a newline. 27878905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2788000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2789000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 27908905a67cSAndy Whitcroft } 27918905a67cSAndy Whitcroft 279242e41c54SMike Frysinger# Blackfin: use hi/lo macros 279342e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 279442e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 279542e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2796000d1cc1SJoe Perches ERROR("LO_MACRO", 2797000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 279842e41c54SMike Frysinger } 279942e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 280042e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2801000d1cc1SJoe Perches ERROR("HI_MACRO", 2802000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 280342e41c54SMike Frysinger } 280442e41c54SMike Frysinger } 280542e41c54SMike Frysinger 2806b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2807de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 28080a920b5bSAndy Whitcroft 28090a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 28100a920b5bSAndy Whitcroft# more than 8 must use tabs. 2811c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2812c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2813c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2814d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 28153705ce5bSJoe Perches if (ERROR("CODE_INDENT", 28163705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 28173705ce5bSJoe Perches $fix) { 2818194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 28193705ce5bSJoe Perches } 28200a920b5bSAndy Whitcroft } 28210a920b5bSAndy Whitcroft 282208e44365SAlberto Panizzo# check for space before tabs. 282308e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 282408e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28253705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 28263705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 28273705ce5bSJoe Perches $fix) { 2828194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2829d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 2830194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2831c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 28323705ce5bSJoe Perches } 283308e44365SAlberto Panizzo } 283408e44365SAlberto Panizzo 2835d1fe9c09SJoe Perches# check for && or || at the start of a line 2836d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2837d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2838d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2839d1fe9c09SJoe Perches } 2840d1fe9c09SJoe Perches 2841a91e8994SJoe Perches# check indentation starts on a tab stop 2842a91e8994SJoe Perches if ($^V && $^V ge 5.10.0 && 2843a91e8994SJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) { 2844a91e8994SJoe Perches my $indent = length($1); 2845a91e8994SJoe Perches if ($indent % 8) { 2846a91e8994SJoe Perches if (WARN("TABSTOP", 2847a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 2848a91e8994SJoe Perches $fix) { 2849a91e8994SJoe Perches $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; 2850a91e8994SJoe Perches } 2851a91e8994SJoe Perches } 2852a91e8994SJoe Perches } 2853a91e8994SJoe Perches 2854d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2855d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 285691cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2857d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2858d1fe9c09SJoe Perches my $oldindent = $1; 2859d1fe9c09SJoe Perches my $rest = $2; 2860d1fe9c09SJoe Perches 2861d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2862d1fe9c09SJoe Perches if ($pos >= 0) { 2863b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2864b34a26f3SJoe Perches my $newindent = $2; 2865d1fe9c09SJoe Perches 2866d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2867d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2868d1fe9c09SJoe Perches " " x ($pos % 8); 2869d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2870d1fe9c09SJoe Perches 2871d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2872d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 28733705ce5bSJoe Perches 28743705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 28753705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 28763705ce5bSJoe Perches $fix && $line =~ /^\+/) { 2877194f66fcSJoe Perches $fixed[$fixlinenr] =~ 28783705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 28793705ce5bSJoe Perches } 2880d1fe9c09SJoe Perches } 2881d1fe9c09SJoe Perches } 2882d1fe9c09SJoe Perches } 2883d1fe9c09SJoe Perches 28846ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 28856ab3a970SJoe Perches# avoid checking a few false positives: 28866ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 28876ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 28886ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 28896ab3a970SJoe Perches# multiline macros that define functions 28906ab3a970SJoe Perches# known attributes or the __attribute__ keyword 28916ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 28926ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 28933705ce5bSJoe Perches if (CHK("SPACING", 2894f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 28953705ce5bSJoe Perches $fix) { 2896194f66fcSJoe Perches $fixed[$fixlinenr] =~ 2897f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 28983705ce5bSJoe Perches } 2899aad4f614SJoe Perches } 2900aad4f614SJoe Perches 290186406b1cSJoe Perches# Block comment styles 290286406b1cSJoe Perches# Networking with an initial /* 290305880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2904fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 290585ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 290685ad978cSJoe Perches $realline > 2) { 290705880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 290805880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 290905880600SJoe Perches } 291005880600SJoe Perches 291186406b1cSJoe Perches# Block comments use * on subsequent lines 291286406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 291386406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 2914a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 291561135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2916a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 291786406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 291886406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 2919a605e32eSJoe Perches } 2920a605e32eSJoe Perches 292186406b1cSJoe Perches# Block comments use */ on trailing lines 292286406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2923c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2924c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2925c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 292686406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 292786406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 292805880600SJoe Perches } 292905880600SJoe Perches 29307f619191SJoe Perches# check for missing blank lines after struct/union declarations 29317f619191SJoe Perches# with exceptions for various attributes and macros 29327f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 29337f619191SJoe Perches $line =~ /^\+/ && 29347f619191SJoe Perches !($line =~ /^\+\s*$/ || 29357f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 29367f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 29377f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 29387f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 29397f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 29407f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 29417f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 2942d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2943d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 2944d752fcc8SJoe Perches $fix) { 2945f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2946d752fcc8SJoe Perches } 29477f619191SJoe Perches } 29487f619191SJoe Perches 2949365dd4eaSJoe Perches# check for multiple consecutive blank lines 2950365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 2951365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 2952365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 2953d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2954d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 2955d752fcc8SJoe Perches $fix) { 2956f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 2957d752fcc8SJoe Perches } 2958d752fcc8SJoe Perches 2959365dd4eaSJoe Perches $last_blank_line = $linenr; 2960365dd4eaSJoe Perches } 2961365dd4eaSJoe Perches 29623b617e3bSJoe Perches# check for missing blank lines after declarations 29633f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 29643f7bac03SJoe Perches # actual declarations 29653f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 29665a4e1fd3SJoe Perches # function pointer declarations 29675a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 29683f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 29693f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 29703f7bac03SJoe Perches # known declaration macros 29713f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 29723f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 29733f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 29743f7bac03SJoe Perches # other possible extensions of declaration lines 29753f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 29763f7bac03SJoe Perches # not starting a section or a macro "\" extended line 29773f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 29783f7bac03SJoe Perches # looks like a declaration 29793f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 29805a4e1fd3SJoe Perches # function pointer declarations 29815a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 29823f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 29833f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 29843f7bac03SJoe Perches # known declaration macros 29853f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 29863f7bac03SJoe Perches # start of struct or union or enum 29873b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 29883f7bac03SJoe Perches # start or end of block or continuation of declaration 29893f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 29903f7bac03SJoe Perches # bitfield continuation 29913f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 29923f7bac03SJoe Perches # other possible extensions of declaration lines 29933f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 29943f7bac03SJoe Perches # indentation of previous and current line are the same 29953f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 2996d752fcc8SJoe Perches if (WARN("LINE_SPACING", 2997d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 2998d752fcc8SJoe Perches $fix) { 2999f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3000d752fcc8SJoe Perches } 30013b617e3bSJoe Perches } 30023b617e3bSJoe Perches 30035f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 30046b4c5bebSAndy Whitcroft# Exceptions: 30056b4c5bebSAndy Whitcroft# 1) within comments 30066b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 30076b4c5bebSAndy Whitcroft# 3) hanging labels 30083705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 30095f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 30103705ce5bSJoe Perches if (WARN("LEADING_SPACE", 30113705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 30123705ce5bSJoe Perches $fix) { 3013194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 30143705ce5bSJoe Perches } 30155f7ddae6SRaffaele Recalcati } 30165f7ddae6SRaffaele Recalcati 3017b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3018b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3019b9ea10d6SAndy Whitcroft 3020032a4c0fSJoe Perches# check indentation of any line with a bare else 3021840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3022032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3023032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3024032a4c0fSJoe Perches my $tabs = length($1) + 1; 3025840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3026840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3027840080a0SJoe Perches defined $lines[$linenr] && 3028840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3029032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3030032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3031032a4c0fSJoe Perches } 3032032a4c0fSJoe Perches } 3033032a4c0fSJoe Perches 3034c00df19aSJoe Perches# check indentation of a line with a break; 3035c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3036c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3037c00df19aSJoe Perches my $tabs = $1; 3038c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3039c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3040c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3041c00df19aSJoe Perches } 3042c00df19aSJoe Perches } 3043c00df19aSJoe Perches 30441ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 30451ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 30461ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 30471ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 30481ba8dfd1SKees Cook } 30491ba8dfd1SKees Cook 3050c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3051cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3052000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3053000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3054c2fdda0dSAndy Whitcroft } 305522f2a2efSAndy Whitcroft 305642e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 305742e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 305842e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 3059000d1cc1SJoe Perches ERROR("CSYNC", 3060000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 306142e41c54SMike Frysinger } 306242e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 306342e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 3064000d1cc1SJoe Perches ERROR("SSYNC", 3065000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 306642e41c54SMike Frysinger } 306742e41c54SMike Frysinger 306856e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 306956e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 307056e77d70SJoe Perches WARN("HOTPLUG_SECTION", 307156e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 307256e77d70SJoe Perches } 307356e77d70SJoe Perches 30749c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 30752b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 30762b474a1aSAndy Whitcroft $realline_next); 30773e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 30783e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 30791b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3080170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3081f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3082171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3083171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3084171ae1a4SAndy Whitcroft 30853e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 30863e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 30873e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 30883e469cdcSAndy Whitcroft # until we hit end of it. 30893e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 30903e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 30913e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 30923e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 30933e469cdcSAndy Whitcroft } 3094f74bd194SAndy Whitcroft 30952b474a1aSAndy Whitcroft # Find the real next line. 30962b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 30972b474a1aSAndy Whitcroft if (defined $realline_next && 30982b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 30992b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 31002b474a1aSAndy Whitcroft $realline_next++; 31012b474a1aSAndy Whitcroft } 31022b474a1aSAndy Whitcroft 3103171ae1a4SAndy Whitcroft my $s = $stat; 3104171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3105cf655043SAndy Whitcroft 3106c2fdda0dSAndy Whitcroft # Ignore goto labels. 3107171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3108c2fdda0dSAndy Whitcroft 3109c2fdda0dSAndy Whitcroft # Ignore functions being called 3110171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3111c2fdda0dSAndy Whitcroft 3112463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3113463f2864SAndy Whitcroft 3114c45dcabdSAndy Whitcroft # declarations always start with types 3115d2506586SAndy 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) { 3116c45dcabdSAndy Whitcroft my $type = $1; 3117c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3118c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3119c45dcabdSAndy Whitcroft 31206c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3121a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3122c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3123c2fdda0dSAndy Whitcroft } 31248905a67cSAndy Whitcroft 31256c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 312665863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3127c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 31289c0ca6f9SAndy Whitcroft } 31298905a67cSAndy Whitcroft 31308905a67cSAndy Whitcroft # Check for any sort of function declaration. 31318905a67cSAndy Whitcroft # int foo(something bar, other baz); 31328905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3133171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 31348905a67cSAndy Whitcroft my ($name_len) = length($1); 31358905a67cSAndy Whitcroft 3136cf655043SAndy Whitcroft my $ctx = $s; 3137773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 31388905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3139cf655043SAndy Whitcroft 31408905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3141c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 31428905a67cSAndy Whitcroft 3143c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 31448905a67cSAndy Whitcroft } 31458905a67cSAndy Whitcroft } 31468905a67cSAndy Whitcroft } 31478905a67cSAndy Whitcroft 31489c0ca6f9SAndy Whitcroft } 31499c0ca6f9SAndy Whitcroft 315000df344fSAndy Whitcroft# 315100df344fSAndy Whitcroft# Checks which may be anchored in the context. 315200df344fSAndy Whitcroft# 315300df344fSAndy Whitcroft 315400df344fSAndy Whitcroft# Check for switch () and associated case and default 315500df344fSAndy Whitcroft# statements should be at the same indent. 315600df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 315700df344fSAndy Whitcroft my $err = ''; 315800df344fSAndy Whitcroft my $sep = ''; 315900df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 316000df344fSAndy Whitcroft shift(@ctx); 316100df344fSAndy Whitcroft for my $ctx (@ctx) { 316200df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 316300df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 316400df344fSAndy Whitcroft $indent != $cindent) { 316500df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 316600df344fSAndy Whitcroft $sep = ''; 316700df344fSAndy Whitcroft } else { 316800df344fSAndy Whitcroft $sep = "[...]\n"; 316900df344fSAndy Whitcroft } 317000df344fSAndy Whitcroft } 317100df344fSAndy Whitcroft if ($err ne '') { 3172000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3173000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3174de7d4f0eSAndy Whitcroft } 3175de7d4f0eSAndy Whitcroft } 3176de7d4f0eSAndy Whitcroft 3177de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3178de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 31790fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3180773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3181773647a0SAndy Whitcroft 31829c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 31838eef05ddSJoe Perches 31848eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 31858eef05ddSJoe Perches WARN("DEEP_INDENTATION", 31868eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 31878eef05ddSJoe Perches } 31888eef05ddSJoe Perches 3189de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3190de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3191de7d4f0eSAndy Whitcroft 3192548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3193548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3194de7d4f0eSAndy Whitcroft 3195548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3196548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3197548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3198548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3199548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3200773647a0SAndy Whitcroft $ctx_ln++; 3201773647a0SAndy Whitcroft } 3202548596d5SAndy Whitcroft 320353210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 320453210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3205773647a0SAndy Whitcroft 3206773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3207000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3208000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 320901464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 321000df344fSAndy Whitcroft } 3211773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3212773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3213773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3214773647a0SAndy Whitcroft { 32159c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 32169c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3217000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3218000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 321901464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 32209c0ca6f9SAndy Whitcroft } 32219c0ca6f9SAndy Whitcroft } 322200df344fSAndy Whitcroft } 322300df344fSAndy Whitcroft 32244d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 32250fe3dc2bSJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 32263e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 32273e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 32283e469cdcSAndy Whitcroft if (!defined $stat); 32294d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 32304d001e4dSAndy Whitcroft 32314d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 32324d001e4dSAndy Whitcroft 32339f5af480SJoe Perches # remove inline comments 32349f5af480SJoe Perches $s =~ s/$;/ /g; 32359f5af480SJoe Perches $c =~ s/$;/ /g; 32364d001e4dSAndy Whitcroft 32374d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 32386f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 32396f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 32404d001e4dSAndy Whitcroft 32419f5af480SJoe Perches # Make sure we remove the line prefixes as we have 32429f5af480SJoe Perches # none on the first line, and are going to readd them 32439f5af480SJoe Perches # where necessary. 32449f5af480SJoe Perches $s =~ s/\n./\n/gs; 32459f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 32469f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 32479f5af480SJoe Perches } 32489f5af480SJoe Perches 32494d001e4dSAndy Whitcroft # We want to check the first line inside the block 32504d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 32514d001e4dSAndy Whitcroft # 1) any blank line termination 32524d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 32534d001e4dSAndy Whitcroft # 3) any do (...) { 32544d001e4dSAndy Whitcroft my $continuation = 0; 32554d001e4dSAndy Whitcroft my $check = 0; 32564d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 32574d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 32584d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 32594d001e4dSAndy Whitcroft $continuation = 1; 32604d001e4dSAndy Whitcroft } 32619bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 32624d001e4dSAndy Whitcroft $check = 1; 32634d001e4dSAndy Whitcroft $cond_lines++; 32644d001e4dSAndy Whitcroft } 32654d001e4dSAndy Whitcroft 32664d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 32674d001e4dSAndy Whitcroft # preprocessor statement. 32684d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 32694d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 32704d001e4dSAndy Whitcroft $check = 0; 32714d001e4dSAndy Whitcroft } 32724d001e4dSAndy Whitcroft 32739bd49efeSAndy Whitcroft my $cond_ptr = -1; 3274740504c6SAndy Whitcroft $continuation = 0; 32759bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 32769bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 32774d001e4dSAndy Whitcroft 3278f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3279f16fa28fSAndy Whitcroft # is not linear. 3280f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3281f16fa28fSAndy Whitcroft $check = 0; 3282f16fa28fSAndy Whitcroft } 3283f16fa28fSAndy Whitcroft 32849bd49efeSAndy Whitcroft # Ignore: 32859bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 32869bd49efeSAndy Whitcroft # 2) preprocessor lines, and 32879bd49efeSAndy Whitcroft # 3) labels. 3288740504c6SAndy Whitcroft if ($continuation || 3289740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 32909bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 32919bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3292740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 329330dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 32949bd49efeSAndy Whitcroft $cond_lines++; 32959bd49efeSAndy Whitcroft } 32964d001e4dSAndy Whitcroft } 329730dad6ebSAndy Whitcroft } 32984d001e4dSAndy Whitcroft 32994d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 33004d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 33014d001e4dSAndy Whitcroft 33024d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 33034d001e4dSAndy Whitcroft # this is not this patch's fault. 33044d001e4dSAndy Whitcroft if (!defined($stat_real) || 33054d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 33064d001e4dSAndy Whitcroft $check = 0; 33074d001e4dSAndy Whitcroft } 33084d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 33094d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 33104d001e4dSAndy Whitcroft } 33114d001e4dSAndy Whitcroft 33129bd49efeSAndy 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"; 33134d001e4dSAndy Whitcroft 33149f5af480SJoe Perches if ($check && $s ne '' && 33159f5af480SJoe Perches (($sindent % 8) != 0 || 33169f5af480SJoe Perches ($sindent < $indent) || 33179f5af480SJoe Perches ($sindent > $indent + 8))) { 3318000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3319000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 33204d001e4dSAndy Whitcroft } 33214d001e4dSAndy Whitcroft } 33224d001e4dSAndy Whitcroft 33236c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 33246c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 33251f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 33261f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 33276c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3328c2fdda0dSAndy Whitcroft if ($dbg_values) { 3329c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3330cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3331cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 33321f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3333c2fdda0dSAndy Whitcroft } 33346c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 33356c72ffaaSAndy Whitcroft 333600df344fSAndy Whitcroft#ignore lines not being added 33373705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 333800df344fSAndy Whitcroft 3339a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3340207a8e84SJoe Perches while ($line =~ m{($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3341a1ce18e4SJoe Perches my $type = $1; 3342a1ce18e4SJoe Perches my $var = $2; 3343207a8e84SJoe Perches $var = "" if (!defined $var); 3344207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3345a1ce18e4SJoe Perches my $sign = $1; 3346a1ce18e4SJoe Perches my $pointer = $2; 3347a1ce18e4SJoe Perches 3348a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3349a1ce18e4SJoe Perches 3350a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3351a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3352a1ce18e4SJoe Perches $fix) { 3353a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3354207a8e84SJoe Perches my $comp_pointer = $pointer; 3355207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 3356207a8e84SJoe Perches $decl .= $comp_pointer; 3357207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 3358207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 3359a1ce18e4SJoe Perches } 3360a1ce18e4SJoe Perches } 3361a1ce18e4SJoe Perches } 3362a1ce18e4SJoe Perches 3363653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 33647429c690SAndy Whitcroft if ($dbg_type) { 33657429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3366000d1cc1SJoe Perches ERROR("TEST_TYPE", 3367000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 33687429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3369000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3370000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 33717429c690SAndy Whitcroft } 3372653d4876SAndy Whitcroft next; 3373653d4876SAndy Whitcroft } 3374a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3375a1ef277eSAndy Whitcroft if ($dbg_attr) { 33769360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3377000d1cc1SJoe Perches ERROR("TEST_ATTR", 3378000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 33799360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3380000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3381000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3382a1ef277eSAndy Whitcroft } 3383a1ef277eSAndy Whitcroft next; 3384a1ef277eSAndy Whitcroft } 3385653d4876SAndy Whitcroft 3386f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 338799423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 338899423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3389d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3390d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3391f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3392f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3393f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3394d752fcc8SJoe Perches my $fixedline = $prevrawline; 3395d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3396f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3397d752fcc8SJoe Perches $fixedline = $line; 3398d752fcc8SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1/; 3399f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3400d752fcc8SJoe Perches } 3401f0a594c1SAndy Whitcroft } 3402f0a594c1SAndy Whitcroft 340300df344fSAndy Whitcroft# 340400df344fSAndy Whitcroft# Checks which are anchored on the added line. 340500df344fSAndy Whitcroft# 340600df344fSAndy Whitcroft 3407653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3408c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3409653d4876SAndy Whitcroft my $path = $1; 3410653d4876SAndy Whitcroft if ($path =~ m{//}) { 3411000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3412495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3413495e9d84SJoe Perches } 3414495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3415495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3416495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3417653d4876SAndy Whitcroft } 3418653d4876SAndy Whitcroft } 3419653d4876SAndy Whitcroft 342000df344fSAndy Whitcroft# no C99 // comments 342100df344fSAndy Whitcroft if ($line =~ m{//}) { 34223705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 34233705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 34243705ce5bSJoe Perches $fix) { 3425194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 34263705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 34273705ce5bSJoe Perches my $comment = trim($1); 3428194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 34293705ce5bSJoe Perches } 34303705ce5bSJoe Perches } 343100df344fSAndy Whitcroft } 343200df344fSAndy Whitcroft # Remove C99 comments. 34330a920b5bSAndy Whitcroft $line =~ s@//.*@@; 34346c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 34350a920b5bSAndy Whitcroft 34362b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 34372b474a1aSAndy Whitcroft# the whole statement. 34382b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 34392b474a1aSAndy Whitcroft if (defined $realline_next && 34402b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 34412b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 34422b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 34432b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 34443cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 34453cbf62dfSAndy Whitcroft # a prefix: 34463cbf62dfSAndy Whitcroft # XXX(foo); 34473cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3448653d4876SAndy Whitcroft my $name = $1; 344987a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 34503cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 34513cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 34523cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 34533cbf62dfSAndy Whitcroft 34543cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 34552b474a1aSAndy Whitcroft \n.}\s*$| 345648012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 345748012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 345848012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 34592b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 34602b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 346148012058SAndy Whitcroft )/x) { 34622b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 34632b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 34642b474a1aSAndy Whitcroft } else { 34652b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 34660a920b5bSAndy Whitcroft } 34670a920b5bSAndy Whitcroft } 34682b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 34692b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 34702b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 34712b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 34722b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 34732b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 34742b474a1aSAndy Whitcroft } 34752b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 34762b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3477000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3478000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 34792b474a1aSAndy Whitcroft } 34800a920b5bSAndy Whitcroft 34815150bda4SJoe Eloff# check for global initialisers. 34826d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 3483d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 34846d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 3485d5e616fcSJoe Perches $fix) { 34866d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 3487d5e616fcSJoe Perches } 3488f0a594c1SAndy Whitcroft } 34890a920b5bSAndy Whitcroft# check for static initialisers. 34906d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 3491d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 34926d32f7a3SJoe Perches "do not initialise statics to $1\n" . 3493d5e616fcSJoe Perches $herecurr) && 3494d5e616fcSJoe Perches $fix) { 34956d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 3496d5e616fcSJoe Perches } 34970a920b5bSAndy Whitcroft } 34980a920b5bSAndy Whitcroft 34991813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 35001813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 35011813087dSJoe Perches my $tmp = trim($1); 35021813087dSJoe Perches WARN("MISORDERED_TYPE", 35031813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 35041813087dSJoe Perches } 35051813087dSJoe Perches 3506cb710ecaSJoe Perches# check for static const char * arrays. 3507cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3508000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3509000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3510cb710ecaSJoe Perches $herecurr); 3511cb710ecaSJoe Perches } 3512cb710ecaSJoe Perches 3513cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3514cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3515000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3516000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3517cb710ecaSJoe Perches $herecurr); 3518cb710ecaSJoe Perches } 3519cb710ecaSJoe Perches 3520ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3521ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3522ab7e23f3SJoe Perches my $found = $1; 3523ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3524ab7e23f3SJoe Perches WARN("CONST_CONST", 3525ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3526ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3527ab7e23f3SJoe Perches WARN("CONST_CONST", 3528ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3529ab7e23f3SJoe Perches } 3530ab7e23f3SJoe Perches } 3531ab7e23f3SJoe Perches 35329b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 35339b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 35349b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 35359b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 35369b0fa60dSJoe Perches $herecurr); 35379b0fa60dSJoe Perches } 35389b0fa60dSJoe Perches 3539b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3540b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3541b598b670SJoe Perches my $array = $1; 3542b598b670SJoe 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*\))@) { 3543b598b670SJoe Perches my $array_div = $1; 3544b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3545b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3546b598b670SJoe Perches $fix) { 3547b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3548b598b670SJoe Perches } 3549b598b670SJoe Perches } 3550b598b670SJoe Perches } 3551b598b670SJoe Perches 3552b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3553b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3554b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3555b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3556b36190c5SJoe Perches $fix) { 3557194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3558b36190c5SJoe Perches } 3559b36190c5SJoe Perches } 3560b36190c5SJoe Perches 356192e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 356292e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 356392e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 356492e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 356592e112fdSJoe Perches $fix) { 3566194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 356792e112fdSJoe Perches } 356893ed0e2dSJoe Perches } 356993ed0e2dSJoe Perches 3570653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3571653d4876SAndy Whitcroft# make sense. 3572653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 35738054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3574c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 35758ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 3576653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 3577000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3578000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 35790a920b5bSAndy Whitcroft } 35800a920b5bSAndy Whitcroft 35810a920b5bSAndy Whitcroft# * goes on variable not on type 358265863862SAndy Whitcroft # (char*[ const]) 3583bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3584bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 35853705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3586d8aaf121SAndy Whitcroft 358765863862SAndy Whitcroft # Should start with a space. 358865863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 358965863862SAndy Whitcroft # Should not end with a space. 359065863862SAndy Whitcroft $to =~ s/\s+$//; 359165863862SAndy Whitcroft # '*'s should not have spaces between. 3592f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 359365863862SAndy Whitcroft } 3594d8aaf121SAndy Whitcroft 35953705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 359665863862SAndy Whitcroft if ($from ne $to) { 35973705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 35983705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 35993705ce5bSJoe Perches $fix) { 36003705ce5bSJoe Perches my $sub_from = $ident; 36013705ce5bSJoe Perches my $sub_to = $ident; 36023705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3603194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36043705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 36053705ce5bSJoe Perches } 360665863862SAndy Whitcroft } 3607bfcb2cc7SAndy Whitcroft } 3608bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3609bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 36103705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3611d8aaf121SAndy Whitcroft 361265863862SAndy Whitcroft # Should start with a space. 361365863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 361465863862SAndy Whitcroft # Should not end with a space. 361565863862SAndy Whitcroft $to =~ s/\s+$//; 361665863862SAndy Whitcroft # '*'s should not have spaces between. 3617f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 361865863862SAndy Whitcroft } 361965863862SAndy Whitcroft # Modifiers should have spaces. 362065863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 362165863862SAndy Whitcroft 36223705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3623667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 36243705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 36253705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 36263705ce5bSJoe Perches $fix) { 36273705ce5bSJoe Perches 36283705ce5bSJoe Perches my $sub_from = $match; 36293705ce5bSJoe Perches my $sub_to = $match; 36303705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3631194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36323705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 36333705ce5bSJoe Perches } 363465863862SAndy Whitcroft } 36350a920b5bSAndy Whitcroft } 36360a920b5bSAndy Whitcroft 36379d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 36389d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 36399d3e3c70SJoe Perches my $msg_type = \&WARN; 36409d3e3c70SJoe Perches $msg_type = \&CHK if ($file); 36419d3e3c70SJoe Perches &{$msg_type}("AVOID_BUG", 36429d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 36439d3e3c70SJoe Perches } 36440a920b5bSAndy Whitcroft 36459d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 36468905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3647000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3648000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 36498905a67cSAndy Whitcroft } 36508905a67cSAndy Whitcroft 365117441227SJoe Perches# check for uses of printk_ratelimit 365217441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3653000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3654000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 365517441227SJoe Perches } 365617441227SJoe Perches 365700df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 365800df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 365900df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 366025985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 366100df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 3662f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 366300df344fSAndy Whitcroft my $ok = 0; 366400df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 366500df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 366625985edcSLucas De Marchi # we have a preceding printk if it ends 366700df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 366800df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 366900df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 367000df344fSAndy Whitcroft $ok = 1; 367100df344fSAndy Whitcroft } 367200df344fSAndy Whitcroft last; 367300df344fSAndy Whitcroft } 367400df344fSAndy Whitcroft } 367500df344fSAndy Whitcroft if ($ok == 0) { 3676000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3677000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 36780a920b5bSAndy Whitcroft } 367900df344fSAndy Whitcroft } 36800a920b5bSAndy Whitcroft 3681243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3682243f3803SJoe Perches my $orig = $1; 3683243f3803SJoe Perches my $level = lc($orig); 3684243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 36858f26b837SJoe Perches my $level2 = $level; 36868f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3687243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3688daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3689243f3803SJoe Perches } 3690243f3803SJoe Perches 3691243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3692d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3693d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3694d5e616fcSJoe Perches $fix) { 3695194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3696d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3697d5e616fcSJoe Perches } 3698243f3803SJoe Perches } 3699243f3803SJoe Perches 3700dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3701dc139313SJoe Perches my $orig = $1; 3702dc139313SJoe Perches my $level = lc($orig); 3703dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3704dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3705dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3706dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3707dc139313SJoe Perches } 3708dc139313SJoe Perches 370991c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 371091c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 371191c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 371291c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 371391c9afafSAndy Lutomirski WARN("ENOSYS", 371491c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 371591c9afafSAndy Lutomirski } 371691c9afafSAndy Lutomirski 3717653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3718653d4876SAndy Whitcroft# or if closed on same line 37198d182478SJoe Perches if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and 37204e5d56bdSEddie Kovsky !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) { 37218d182478SJoe Perches if (ERROR("OPEN_BRACE", 37228d182478SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr) && 37238d182478SJoe Perches $fix) { 37248d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 37258d182478SJoe Perches my $fixed_line = $rawline; 37268d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 37278d182478SJoe Perches my $line1 = $1; 37288d182478SJoe Perches my $line2 = $2; 37298d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 37308d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 37318d182478SJoe Perches if ($line2 !~ /^\s*$/) { 37328d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 37338d182478SJoe Perches } 37348d182478SJoe Perches } 37350a920b5bSAndy Whitcroft } 3736653d4876SAndy Whitcroft 37378905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 37388905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 37398905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 37408d182478SJoe Perches if (ERROR("OPEN_BRACE", 37418d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 37428d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 37438d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 37448d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 37458d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 37468d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 37478d182478SJoe Perches $fixedline = $rawline; 37488d182478SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1\t/; 37498d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 37508d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 37518d182478SJoe Perches } 37528d182478SJoe Perches } 37538905a67cSAndy Whitcroft } 37548905a67cSAndy Whitcroft 37550c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 37563705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 37573705ce5bSJoe Perches if (WARN("SPACING", 37583705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 37593705ce5bSJoe Perches $fix) { 3760194f66fcSJoe Perches $fixed[$fixlinenr] =~ 37613705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 37623705ce5bSJoe Perches } 37630c73b4ebSAndy Whitcroft } 37640c73b4ebSAndy Whitcroft 376531070b5dSJoe Perches# Function pointer declarations 376631070b5dSJoe Perches# check spacing between type, funcptr, and args 376731070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 376891f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 376931070b5dSJoe Perches my $declare = $1; 377031070b5dSJoe Perches my $pre_pointer_space = $2; 377131070b5dSJoe Perches my $post_pointer_space = $3; 377231070b5dSJoe Perches my $funcname = $4; 377331070b5dSJoe Perches my $post_funcname_space = $5; 377431070b5dSJoe Perches my $pre_args_space = $6; 377531070b5dSJoe Perches 377691f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 377791f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 377891f72e9cSJoe Perches# don't need a space so don't warn for those. 377991f72e9cSJoe Perches my $post_declare_space = ""; 378091f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 378191f72e9cSJoe Perches $post_declare_space = $1; 378291f72e9cSJoe Perches $declare = rtrim($declare); 378391f72e9cSJoe Perches } 378491f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 378531070b5dSJoe Perches WARN("SPACING", 378631070b5dSJoe Perches "missing space after return type\n" . $herecurr); 378791f72e9cSJoe Perches $post_declare_space = " "; 378831070b5dSJoe Perches } 378931070b5dSJoe Perches 379031070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 379191f72e9cSJoe Perches# This test is not currently implemented because these declarations are 379291f72e9cSJoe Perches# equivalent to 379391f72e9cSJoe Perches# int foo(int bar, ...) 379491f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 379591f72e9cSJoe Perches# 379691f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 379791f72e9cSJoe Perches# WARN("SPACING", 379891f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 379991f72e9cSJoe Perches# } 380031070b5dSJoe Perches 380131070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 380231070b5dSJoe Perches if (defined $pre_pointer_space && 380331070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 380431070b5dSJoe Perches WARN("SPACING", 380531070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 380631070b5dSJoe Perches } 380731070b5dSJoe Perches 380831070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 380931070b5dSJoe Perches if (defined $post_pointer_space && 381031070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 381131070b5dSJoe Perches WARN("SPACING", 381231070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 381331070b5dSJoe Perches } 381431070b5dSJoe Perches 381531070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 381631070b5dSJoe Perches if (defined $post_funcname_space && 381731070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 381831070b5dSJoe Perches WARN("SPACING", 381931070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 382031070b5dSJoe Perches } 382131070b5dSJoe Perches 382231070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 382331070b5dSJoe Perches if (defined $pre_args_space && 382431070b5dSJoe Perches $pre_args_space =~ /^\s/) { 382531070b5dSJoe Perches WARN("SPACING", 382631070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 382731070b5dSJoe Perches } 382831070b5dSJoe Perches 382931070b5dSJoe Perches if (show_type("SPACING") && $fix) { 3830194f66fcSJoe Perches $fixed[$fixlinenr] =~ 383191f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 383231070b5dSJoe Perches } 383331070b5dSJoe Perches } 383431070b5dSJoe Perches 38358d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 38368d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3837fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3838fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 38398d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 38408d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 38418d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3842fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3843daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 38443705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 38453705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 38463705ce5bSJoe Perches $fix) { 3847194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38483705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 38493705ce5bSJoe Perches } 38508d31cfceSAndy Whitcroft } 38518d31cfceSAndy Whitcroft } 38528d31cfceSAndy Whitcroft 3853f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 38546c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3855c2fdda0dSAndy Whitcroft my $name = $1; 3856773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3857773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3858c2fdda0dSAndy Whitcroft 3859c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3860773647a0SAndy Whitcroft if ($name =~ /^(?: 3861773647a0SAndy Whitcroft if|for|while|switch|return|case| 3862773647a0SAndy Whitcroft volatile|__volatile__| 3863773647a0SAndy Whitcroft __attribute__|format|__extension__| 3864773647a0SAndy Whitcroft asm|__asm__)$/x) 3865773647a0SAndy Whitcroft { 3866c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3867c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3868c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3869c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3870773647a0SAndy Whitcroft 3871773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3872c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3873c2fdda0dSAndy Whitcroft 3874c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3875c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3876773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3877c2fdda0dSAndy Whitcroft 3878c2fdda0dSAndy Whitcroft } else { 38793705ce5bSJoe Perches if (WARN("SPACING", 38803705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 38813705ce5bSJoe Perches $fix) { 3882194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38833705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 38843705ce5bSJoe Perches } 3885f0a594c1SAndy Whitcroft } 38866c72ffaaSAndy Whitcroft } 38879a4cad4eSEric Nelson 3888653d4876SAndy Whitcroft# Check operator spacing. 38890a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 38903705ce5bSJoe Perches my $fixed_line = ""; 38913705ce5bSJoe Perches my $line_fixed = 0; 38923705ce5bSJoe Perches 38939c0ca6f9SAndy Whitcroft my $ops = qr{ 38949c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 38959c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 38969c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 38971f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 389884731623SJoe Perches \?:|\?|: 38999c0ca6f9SAndy Whitcroft }x; 3900cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 39013705ce5bSJoe Perches 39023705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 39033705ce5bSJoe Perches## foreach my $el (@elements) { 39043705ce5bSJoe Perches## print("el: <$el>\n"); 39053705ce5bSJoe Perches## } 39063705ce5bSJoe Perches 39073705ce5bSJoe Perches my @fix_elements = (); 390800df344fSAndy Whitcroft my $off = 0; 39096c72ffaaSAndy Whitcroft 39103705ce5bSJoe Perches foreach my $el (@elements) { 39113705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 39123705ce5bSJoe Perches $off += length($el); 39133705ce5bSJoe Perches } 39143705ce5bSJoe Perches 39153705ce5bSJoe Perches $off = 0; 39163705ce5bSJoe Perches 39176c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3918b34c648bSJoe Perches my $last_after = -1; 39196c72ffaaSAndy Whitcroft 39200a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 39213705ce5bSJoe Perches 39223705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 39233705ce5bSJoe Perches 39243705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 39253705ce5bSJoe Perches 39264a0df2efSAndy Whitcroft $off += length($elements[$n]); 39274a0df2efSAndy Whitcroft 392825985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3929773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3930773647a0SAndy Whitcroft my $cc = ''; 3931773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3932773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3933773647a0SAndy Whitcroft } 3934773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3935773647a0SAndy Whitcroft 39364a0df2efSAndy Whitcroft my $a = ''; 39374a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 39384a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3939cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 39404a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 39414a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3942773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 39434a0df2efSAndy Whitcroft 39440a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 39454a0df2efSAndy Whitcroft 39464a0df2efSAndy Whitcroft my $c = ''; 39470a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 39484a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 39494a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3950cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 39514a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 39524a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 39538b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 39544a0df2efSAndy Whitcroft } else { 39554a0df2efSAndy Whitcroft $c = 'E'; 39560a920b5bSAndy Whitcroft } 39570a920b5bSAndy Whitcroft 39584a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 39594a0df2efSAndy Whitcroft 39604a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 39614a0df2efSAndy Whitcroft 39626c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3963de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 39640a920b5bSAndy Whitcroft 396574048ed8SAndy Whitcroft # Pull out the value of this operator. 39666c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 39670a920b5bSAndy Whitcroft 39681f65f947SAndy Whitcroft # Get the full operator variant. 39691f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 39701f65f947SAndy Whitcroft 397113214adfSAndy Whitcroft # Ignore operators passed as parameters. 397213214adfSAndy Whitcroft if ($op_type ne 'V' && 3973d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 397413214adfSAndy Whitcroft 3975cf655043SAndy Whitcroft# # Ignore comments 3976cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 397713214adfSAndy Whitcroft 3978d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 397913214adfSAndy Whitcroft } elsif ($op eq ';') { 3980cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3981cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 39823705ce5bSJoe Perches if (ERROR("SPACING", 39833705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3984b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 39853705ce5bSJoe Perches $line_fixed = 1; 39863705ce5bSJoe Perches } 3987d8aaf121SAndy Whitcroft } 3988d8aaf121SAndy Whitcroft 3989d8aaf121SAndy Whitcroft # // is a comment 3990d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 39910a920b5bSAndy Whitcroft 3992b00e4814SJoe Perches # : when part of a bitfield 3993b00e4814SJoe Perches } elsif ($opv eq ':B') { 3994b00e4814SJoe Perches # skip the bitfield test for now 3995b00e4814SJoe Perches 39961f65f947SAndy Whitcroft # No spaces for: 39971f65f947SAndy Whitcroft # -> 3998b00e4814SJoe Perches } elsif ($op eq '->') { 39994a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 40003705ce5bSJoe Perches if (ERROR("SPACING", 40013705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4002b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 40033705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 40043705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 40053705ce5bSJoe Perches } 4006b34c648bSJoe Perches $line_fixed = 1; 40073705ce5bSJoe Perches } 40080a920b5bSAndy Whitcroft } 40090a920b5bSAndy Whitcroft 40102381097bSJoe Perches # , must not have a space before and must have a space on the right. 40110a920b5bSAndy Whitcroft } elsif ($op eq ',') { 40122381097bSJoe Perches my $rtrim_before = 0; 40132381097bSJoe Perches my $space_after = 0; 40142381097bSJoe Perches if ($ctx =~ /Wx./) { 40152381097bSJoe Perches if (ERROR("SPACING", 40162381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 40172381097bSJoe Perches $line_fixed = 1; 40182381097bSJoe Perches $rtrim_before = 1; 40192381097bSJoe Perches } 40202381097bSJoe Perches } 4021cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 40223705ce5bSJoe Perches if (ERROR("SPACING", 40233705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 40243705ce5bSJoe Perches $line_fixed = 1; 4025b34c648bSJoe Perches $last_after = $n; 40262381097bSJoe Perches $space_after = 1; 40272381097bSJoe Perches } 40282381097bSJoe Perches } 40292381097bSJoe Perches if ($rtrim_before || $space_after) { 40302381097bSJoe Perches if ($rtrim_before) { 40312381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 40322381097bSJoe Perches } else { 40332381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 40342381097bSJoe Perches } 40352381097bSJoe Perches if ($space_after) { 40362381097bSJoe Perches $good .= " "; 40373705ce5bSJoe Perches } 40380a920b5bSAndy Whitcroft } 40390a920b5bSAndy Whitcroft 40409c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 404174048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 40429c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 40439c0ca6f9SAndy Whitcroft 40449c0ca6f9SAndy Whitcroft # unary operators should have a space before and 40459c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 40469c0ca6f9SAndy Whitcroft # unary operator, or a cast 40479c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 404874048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 40490d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4050cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 40513705ce5bSJoe Perches if (ERROR("SPACING", 40523705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4053b34c648bSJoe Perches if ($n != $last_after + 2) { 4054b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 40553705ce5bSJoe Perches $line_fixed = 1; 40563705ce5bSJoe Perches } 40570a920b5bSAndy Whitcroft } 4058b34c648bSJoe Perches } 4059a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4060171ae1a4SAndy Whitcroft # A unary '*' may be const 4061171ae1a4SAndy Whitcroft 4062171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 40633705ce5bSJoe Perches if (ERROR("SPACING", 40643705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4065b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 40663705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 40673705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 40683705ce5bSJoe Perches } 4069b34c648bSJoe Perches $line_fixed = 1; 40703705ce5bSJoe Perches } 40710a920b5bSAndy Whitcroft } 40720a920b5bSAndy Whitcroft 40730a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 40740a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4075773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 40763705ce5bSJoe Perches if (ERROR("SPACING", 40773705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4078b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 40793705ce5bSJoe Perches $line_fixed = 1; 40803705ce5bSJoe Perches } 40810a920b5bSAndy Whitcroft } 4082773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4083773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 40843705ce5bSJoe Perches if (ERROR("SPACING", 40853705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4086b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 40873705ce5bSJoe Perches $line_fixed = 1; 40883705ce5bSJoe Perches } 4089653d4876SAndy Whitcroft } 4090773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 40913705ce5bSJoe Perches if (ERROR("SPACING", 40923705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4093b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 40943705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 40953705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4096773647a0SAndy Whitcroft } 4097b34c648bSJoe Perches $line_fixed = 1; 40983705ce5bSJoe Perches } 40993705ce5bSJoe Perches } 41000a920b5bSAndy Whitcroft 41010a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 41029c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 41039c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 41049c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4105c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4106c2fdda0dSAndy Whitcroft $op eq '%') 41070a920b5bSAndy Whitcroft { 4108d2e025f3SJoe Perches if ($check) { 4109d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4110d2e025f3SJoe Perches if (CHK("SPACING", 4111d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4112d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4113d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4114d2e025f3SJoe Perches $line_fixed = 1; 4115d2e025f3SJoe Perches } 4116d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4117d2e025f3SJoe Perches if (CHK("SPACING", 4118d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4119d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4120d2e025f3SJoe Perches $line_fixed = 1; 4121d2e025f3SJoe Perches } 4122d2e025f3SJoe Perches } 4123d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 41243705ce5bSJoe Perches if (ERROR("SPACING", 41253705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4126b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4127b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4128b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4129b34c648bSJoe Perches } 41303705ce5bSJoe Perches $line_fixed = 1; 41313705ce5bSJoe Perches } 41320a920b5bSAndy Whitcroft } 41330a920b5bSAndy Whitcroft 41341f65f947SAndy Whitcroft # A colon needs no spaces before when it is 41351f65f947SAndy Whitcroft # terminating a case value or a label. 41361f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 41371f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 41383705ce5bSJoe Perches if (ERROR("SPACING", 41393705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4140b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 41413705ce5bSJoe Perches $line_fixed = 1; 41423705ce5bSJoe Perches } 41431f65f947SAndy Whitcroft } 41441f65f947SAndy Whitcroft 41450a920b5bSAndy Whitcroft # All the others need spaces both sides. 4146cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 41471f65f947SAndy Whitcroft my $ok = 0; 41481f65f947SAndy Whitcroft 414922f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 41501f65f947SAndy Whitcroft if (($op eq '<' && 41511f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 41521f65f947SAndy Whitcroft ($op eq '>' && 41531f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 41541f65f947SAndy Whitcroft { 41551f65f947SAndy Whitcroft $ok = 1; 41561f65f947SAndy Whitcroft } 41571f65f947SAndy Whitcroft 4158e0df7e1fSJoe Perches # for asm volatile statements 4159e0df7e1fSJoe Perches # ignore a colon with another 4160e0df7e1fSJoe Perches # colon immediately before or after 4161e0df7e1fSJoe Perches if (($op eq ':') && 4162e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4163e0df7e1fSJoe Perches $ok = 1; 4164e0df7e1fSJoe Perches } 4165e0df7e1fSJoe Perches 416684731623SJoe Perches # messages are ERROR, but ?: are CHK 41671f65f947SAndy Whitcroft if ($ok == 0) { 416884731623SJoe Perches my $msg_type = \&ERROR; 416984731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 417084731623SJoe Perches 417184731623SJoe Perches if (&{$msg_type}("SPACING", 41723705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4173b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4174b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4175b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4176b34c648bSJoe Perches } 41773705ce5bSJoe Perches $line_fixed = 1; 41783705ce5bSJoe Perches } 41790a920b5bSAndy Whitcroft } 418022f2a2efSAndy Whitcroft } 41814a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 41823705ce5bSJoe Perches 41833705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 41843705ce5bSJoe Perches 41853705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 41860a920b5bSAndy Whitcroft } 41873705ce5bSJoe Perches 41883705ce5bSJoe Perches if (($#elements % 2) == 0) { 41893705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 41903705ce5bSJoe Perches } 41913705ce5bSJoe Perches 4192194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4193194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 41943705ce5bSJoe Perches } 41953705ce5bSJoe Perches 41963705ce5bSJoe Perches 41970a920b5bSAndy Whitcroft } 41980a920b5bSAndy Whitcroft 4199786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4200d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4201786b6326SJoe Perches if (WARN("SPACING", 4202786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4203786b6326SJoe Perches $fix) { 4204194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4205786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4206786b6326SJoe Perches } 4207786b6326SJoe Perches } 4208786b6326SJoe Perches 4209f0a594c1SAndy Whitcroft# check for multiple assignments 4210f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4211000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4212000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4213f0a594c1SAndy Whitcroft } 4214f0a594c1SAndy Whitcroft 421522f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 421622f2a2efSAndy Whitcroft## # continuation. 421722f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 421822f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 421922f2a2efSAndy Whitcroft## 422022f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 422122f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 422222f2a2efSAndy Whitcroft## my $ln = $line; 422322f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 422422f2a2efSAndy Whitcroft## } 422522f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4226000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4227000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 422822f2a2efSAndy Whitcroft## } 422922f2a2efSAndy Whitcroft## } 4230f0a594c1SAndy Whitcroft 42310a920b5bSAndy Whitcroft#need space before brace following if, while, etc 42326b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 42334e5d56bdSEddie Kovsky $line =~ /do\{/) { 42343705ce5bSJoe Perches if (ERROR("SPACING", 42353705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 42363705ce5bSJoe Perches $fix) { 4237194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/; 42383705ce5bSJoe Perches } 4239de7d4f0eSAndy Whitcroft } 4240de7d4f0eSAndy Whitcroft 4241c4a62ef9SJoe Perches## # check for blank lines before declarations 4242c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4243c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4244c4a62ef9SJoe Perches## WARN("SPACING", 4245c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4246c4a62ef9SJoe Perches## } 4247c4a62ef9SJoe Perches## 4248c4a62ef9SJoe Perches 4249de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4250de7d4f0eSAndy Whitcroft# on the line 4251de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4252d5e616fcSJoe Perches if (ERROR("SPACING", 4253d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4254d5e616fcSJoe Perches $fix) { 4255194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4256d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4257d5e616fcSJoe Perches } 42580a920b5bSAndy Whitcroft } 42590a920b5bSAndy Whitcroft 426022f2a2efSAndy Whitcroft# check spacing on square brackets 426122f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 42623705ce5bSJoe Perches if (ERROR("SPACING", 42633705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 42643705ce5bSJoe Perches $fix) { 4265194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42663705ce5bSJoe Perches s/\[\s+/\[/; 42673705ce5bSJoe Perches } 426822f2a2efSAndy Whitcroft } 426922f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 42703705ce5bSJoe Perches if (ERROR("SPACING", 42713705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 42723705ce5bSJoe Perches $fix) { 4273194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42743705ce5bSJoe Perches s/\s+\]/\]/; 42753705ce5bSJoe Perches } 427622f2a2efSAndy Whitcroft } 427722f2a2efSAndy Whitcroft 4278c45dcabdSAndy Whitcroft# check spacing on parentheses 42799c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 42809c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 42813705ce5bSJoe Perches if (ERROR("SPACING", 42823705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 42833705ce5bSJoe Perches $fix) { 4284194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42853705ce5bSJoe Perches s/\(\s+/\(/; 42863705ce5bSJoe Perches } 428722f2a2efSAndy Whitcroft } 428813214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4289c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4290c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 42913705ce5bSJoe Perches if (ERROR("SPACING", 42923705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 42933705ce5bSJoe Perches $fix) { 4294194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42953705ce5bSJoe Perches s/\s+\)/\)/; 42963705ce5bSJoe Perches } 429722f2a2efSAndy Whitcroft } 429822f2a2efSAndy Whitcroft 4299e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4300e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4301e2826fd0SJoe Perches 4302e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4303ea4acbb1SJoe Perches my $var = $1; 4304ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4305ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4306ea4acbb1SJoe Perches $fix) { 4307ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4308ea4acbb1SJoe Perches } 4309ea4acbb1SJoe Perches } 4310ea4acbb1SJoe Perches 4311ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4312ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4313ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4314ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4315ea4acbb1SJoe Perches my $var = $2; 4316ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4317ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4318ea4acbb1SJoe Perches $fix) { 4319ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4320ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4321ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4322ea4acbb1SJoe Perches } 4323e2826fd0SJoe Perches } 4324e2826fd0SJoe Perches 43250a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 43264a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 43270a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 43283705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 43293705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 43303705ce5bSJoe Perches $fix) { 4331194f66fcSJoe Perches $fixed[$fixlinenr] =~ 43323705ce5bSJoe Perches s/^(.)\s+/$1/; 43333705ce5bSJoe Perches } 43340a920b5bSAndy Whitcroft } 43350a920b5bSAndy Whitcroft 43365b9553abSJoe Perches# return is not a function 4337507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4338c45dcabdSAndy Whitcroft my $spacing = $1; 4339507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 43405b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 43415b9553abSJoe Perches my $value = $1; 43425b9553abSJoe Perches $value = deparenthesize($value); 43435b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4344000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4345000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 43465b9553abSJoe Perches } 4347c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4348000d1cc1SJoe Perches ERROR("SPACING", 4349000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4350c45dcabdSAndy Whitcroft } 4351c45dcabdSAndy Whitcroft } 4352507e5141SJoe Perches 4353b43ae21bSJoe Perches# unnecessary return in a void function 4354b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4355b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4356b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4357b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4358b43ae21bSJoe Perches $linenr >= 3 && 4359b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4360b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 43619819cf25SJoe Perches WARN("RETURN_VOID", 4362b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 43639819cf25SJoe Perches } 43649819cf25SJoe Perches 4365189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4366189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4367189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4368189248d8SJoe Perches my $openparens = $1; 4369189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4370189248d8SJoe Perches my $msg = ""; 4371189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4372189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4373189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4374189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4375189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4376189248d8SJoe Perches } 4377189248d8SJoe Perches } 4378189248d8SJoe Perches 4379c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4380c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4381c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4382c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 4383c5595fa2SJoe Perches if ($^V && $^V ge 5.10.0 && 4384c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4385c5595fa2SJoe Perches my $lead = $1; 4386c5595fa2SJoe Perches my $const = $2; 4387c5595fa2SJoe Perches my $comp = $3; 4388c5595fa2SJoe Perches my $to = $4; 4389c5595fa2SJoe Perches my $newcomp = $comp; 4390f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 4391c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4392c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4393c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4394c5595fa2SJoe Perches $fix) { 4395c5595fa2SJoe Perches if ($comp eq "<") { 4396c5595fa2SJoe Perches $newcomp = ">"; 4397c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4398c5595fa2SJoe Perches $newcomp = ">="; 4399c5595fa2SJoe Perches } elsif ($comp eq ">") { 4400c5595fa2SJoe Perches $newcomp = "<"; 4401c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4402c5595fa2SJoe Perches $newcomp = "<="; 4403c5595fa2SJoe Perches } 4404c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4405c5595fa2SJoe Perches } 4406c5595fa2SJoe Perches } 4407c5595fa2SJoe Perches 4408f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4409f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 441053a3c448SAndy Whitcroft my $name = $1; 441153a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4412000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4413f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 441453a3c448SAndy Whitcroft } 441553a3c448SAndy Whitcroft } 4416c45dcabdSAndy Whitcroft 44170a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 44184a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 44193705ce5bSJoe Perches if (ERROR("SPACING", 44203705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 44213705ce5bSJoe Perches $fix) { 4422194f66fcSJoe Perches $fixed[$fixlinenr] =~ 44233705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 44243705ce5bSJoe Perches } 44250a920b5bSAndy Whitcroft } 44260a920b5bSAndy Whitcroft 4427f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4428f5fe35ddSAndy Whitcroft# statements after the conditional. 4429170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 44303e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 44313e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 44323e469cdcSAndy Whitcroft if (!defined $stat); 4433170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4434170d3a22SAndy Whitcroft $remain_next, $off_next); 4435170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4436170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4437170d3a22SAndy Whitcroft 4438170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4439170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4440170d3a22SAndy Whitcroft # then count those as offsets. 4441170d3a22SAndy Whitcroft my ($whitespace) = 4442170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4443170d3a22SAndy Whitcroft my $offset = 4444170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4445170d3a22SAndy Whitcroft 4446170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4447170d3a22SAndy Whitcroft $offset} = 1; 4448170d3a22SAndy Whitcroft } 4449170d3a22SAndy Whitcroft } 4450170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4451c11230f4SJoe Perches defined($stat) && defined($cond) && 4452170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4453171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 44548905a67cSAndy Whitcroft 4455b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4456000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4457000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 44588905a67cSAndy Whitcroft } 44598905a67cSAndy Whitcroft 44608905a67cSAndy Whitcroft # Find out what is on the end of the line after the 44618905a67cSAndy Whitcroft # conditional. 4462773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 44638905a67cSAndy Whitcroft $s =~ s/\n.*//g; 446413214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 446553210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 446653210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4467773647a0SAndy Whitcroft { 4468bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4469bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4470bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 447142bdf74cSHidetoshi Seto my $stat_real = ''; 4472bb44ad39SAndy Whitcroft 447342bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 447442bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4475bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4476bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4477bb44ad39SAndy Whitcroft } 4478bb44ad39SAndy Whitcroft 4479000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4480000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 44818905a67cSAndy Whitcroft } 44828905a67cSAndy Whitcroft } 44838905a67cSAndy Whitcroft 448413214adfSAndy Whitcroft# Check for bitwise tests written as boolean 448513214adfSAndy Whitcroft if ($line =~ / 448613214adfSAndy Whitcroft (?: 448713214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 448813214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 448913214adfSAndy Whitcroft (?:\&\&|\|\|) 449013214adfSAndy Whitcroft | 449113214adfSAndy Whitcroft (?:\&\&|\|\|) 449213214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 449313214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 449413214adfSAndy Whitcroft )/x) 449513214adfSAndy Whitcroft { 4496000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4497000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 449813214adfSAndy Whitcroft } 449913214adfSAndy Whitcroft 45008905a67cSAndy Whitcroft# if and else should not have general statements after it 450113214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 450213214adfSAndy Whitcroft my $s = $1; 450313214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 450413214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4505000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4506000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 45070a920b5bSAndy Whitcroft } 450813214adfSAndy Whitcroft } 450939667782SAndy Whitcroft# if should not continue a brace 451039667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4511000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4512048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 451339667782SAndy Whitcroft $herecurr); 451439667782SAndy Whitcroft } 4515a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4516a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4517a1080bf8SAndy Whitcroft $line !~ /\G(?: 45183fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4519a1080bf8SAndy Whitcroft \s*return\s+ 4520a1080bf8SAndy Whitcroft )/xg) 4521a1080bf8SAndy Whitcroft { 4522000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4523000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4524a1080bf8SAndy Whitcroft } 45250a920b5bSAndy Whitcroft 45260a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 45270a920b5bSAndy Whitcroft # indent level to be relevant to each other. 45288b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 45290a920b5bSAndy Whitcroft $previndent == $indent) { 45308b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 45318b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 45328b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 45338b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 45348b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 45358b8856f4SJoe Perches my $fixedline = $prevrawline; 45368b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 45378b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 45388b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 45398b8856f4SJoe Perches } 45408b8856f4SJoe Perches $fixedline = $rawline; 45418b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 45428b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 45438b8856f4SJoe Perches } 45440a920b5bSAndy Whitcroft } 45450a920b5bSAndy Whitcroft 45468b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4547c2fdda0dSAndy Whitcroft $previndent == $indent) { 4548c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4549c2fdda0dSAndy Whitcroft 4550c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4551c2fdda0dSAndy Whitcroft # conditional. 4552773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4553c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4554c2fdda0dSAndy Whitcroft 4555c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 45568b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 45578b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 45588b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 45598b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 45608b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 45618b8856f4SJoe Perches my $fixedline = $prevrawline; 45628b8856f4SJoe Perches my $trailing = $rawline; 45638b8856f4SJoe Perches $trailing =~ s/^\+//; 45648b8856f4SJoe Perches $trailing = trim($trailing); 45658b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 45668b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 45678b8856f4SJoe Perches } 4568c2fdda0dSAndy Whitcroft } 4569c2fdda0dSAndy Whitcroft } 4570c2fdda0dSAndy Whitcroft 457195e2c602SJoe Perches#Specific variable tests 4572323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4573323c1260SJoe Perches my $var = $1; 457495e2c602SJoe Perches 457595e2c602SJoe Perches#gcc binary extension 457695e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4577d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4578d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4579d5e616fcSJoe Perches $fix) { 4580d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4581194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4582d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4583d5e616fcSJoe Perches } 458495e2c602SJoe Perches } 458595e2c602SJoe Perches 458695e2c602SJoe Perches#CamelCase 4587807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4588be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 458922735ce8SJoe Perches#Ignore Page<foo> variants 4590807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 459122735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4592f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4593f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4594f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 45957e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 45967e781f67SJoe Perches my $word = $1; 45977e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4598d8b07710SJoe Perches if ($check) { 4599d8b07710SJoe Perches seed_camelcase_includes(); 4600d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4601d8b07710SJoe Perches seed_camelcase_file($realfile); 4602d8b07710SJoe Perches $camelcase_file_seeded = 1; 4603d8b07710SJoe Perches } 4604d8b07710SJoe Perches } 46057e781f67SJoe Perches if (!defined $camelcase{$word}) { 46067e781f67SJoe Perches $camelcase{$word} = 1; 4607be79794bSJoe Perches CHK("CAMELCASE", 46087e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 46097e781f67SJoe Perches } 4610323c1260SJoe Perches } 4611323c1260SJoe Perches } 46123445686aSJoe Perches } 46130a920b5bSAndy Whitcroft 46140a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4615d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4616d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4617d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4618d5e616fcSJoe Perches $fix) { 4619194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4620d5e616fcSJoe Perches } 46210a920b5bSAndy Whitcroft } 46220a920b5bSAndy Whitcroft 46230e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 46240e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4625c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4626e09dec48SAndy Whitcroft my $file = "$1.h"; 4627e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4628e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4629e09dec48SAndy Whitcroft $realfile ne $checkfile && 46307840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4631c45dcabdSAndy Whitcroft { 46320e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 46330e212e0aSFabian Frederick if ($asminclude > 0) { 4634e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4635000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4636000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4637e09dec48SAndy Whitcroft } else { 4638000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4639000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4640e09dec48SAndy Whitcroft } 46410a920b5bSAndy Whitcroft } 46420a920b5bSAndy Whitcroft } 46430e212e0aSFabian Frederick } 46440a920b5bSAndy Whitcroft 4645653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4646653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4647cf655043SAndy Whitcroft# in a known good container 4648b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4649b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4650d8aaf121SAndy Whitcroft my $ln = $linenr; 4651d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4652c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4653c45dcabdSAndy Whitcroft my $ctx = ''; 465408a2843eSJoe Perches my $has_flow_statement = 0; 465508a2843eSJoe Perches my $has_arg_concat = 0; 4656c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4657f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4658f74bd194SAndy Whitcroft $ctx = $dstat; 4659c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4660a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4661c45dcabdSAndy Whitcroft 466208a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 466362e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 466408a2843eSJoe Perches 4665f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 4666292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4667c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4668c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4669c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4670c45dcabdSAndy Whitcroft 4671c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4672bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4673bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 46746b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 4675bf30d6edSAndy Whitcroft { 4676c45dcabdSAndy Whitcroft } 4677c45dcabdSAndy Whitcroft 4678e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 467933acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 468033acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 4681e45bab8eSAndy Whitcroft { 4682e45bab8eSAndy Whitcroft } 4683e45bab8eSAndy Whitcroft 468442e15293SJoe Perches # Make asm volatile uses seem like a generic function 468542e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 468642e15293SJoe Perches 4687c45dcabdSAndy Whitcroft my $exceptions = qr{ 4688c45dcabdSAndy Whitcroft $Declare| 4689c45dcabdSAndy Whitcroft module_param_named| 4690a0a0a7a9SKees Cook MODULE_PARM_DESC| 4691c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4692c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4693383099fdSAndy Whitcroft __typeof__\(| 469422fd2d3eSStefani Seibold union| 469522fd2d3eSStefani Seibold struct| 4696ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 46976b10df42SVladimir Zapolskiy ^\"|\"$| 46986b10df42SVladimir Zapolskiy ^\[ 4699c45dcabdSAndy Whitcroft }x; 47005eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4701f74bd194SAndy Whitcroft if ($dstat ne '' && 4702f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4703f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 47043cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4705356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4706f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4707f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4708e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 470972f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4710f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4711f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4712f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 47134e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 4714f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4715c45dcabdSAndy Whitcroft { 4716f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 4717f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 4718f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 4719f74bd194SAndy Whitcroft 4720f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 4721f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 4722c45dcabdSAndy Whitcroft } 4723c45dcabdSAndy Whitcroft 4724f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 4725f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4726f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4727f74bd194SAndy Whitcroft } else { 4728000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 4729388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 4730d8aaf121SAndy Whitcroft } 47310a920b5bSAndy Whitcroft } 47325023d347SJoe Perches 473308a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 473408a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 473508a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 473608a2843eSJoe Perches my $herectx = $here . "\n"; 473708a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 473808a2843eSJoe Perches 473908a2843eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 474008a2843eSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 474108a2843eSJoe Perches } 474208a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 474308a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 474408a2843eSJoe Perches } 474508a2843eSJoe Perches 4746481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 47475023d347SJoe Perches 47485023d347SJoe Perches } else { 47495023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 4750481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 4751481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 47525023d347SJoe Perches $line =~ /^\+.*\\$/) { 47535023d347SJoe Perches WARN("LINE_CONTINUATIONS", 47545023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 47555023d347SJoe Perches } 4756653d4876SAndy Whitcroft } 47570a920b5bSAndy Whitcroft 4758b13edf7fSJoe Perches# do {} while (0) macro tests: 4759b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 4760b13edf7fSJoe Perches# macro should not end with a semicolon 4761b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 4762b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 4763b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 4764b13edf7fSJoe Perches my $ln = $linenr; 4765b13edf7fSJoe Perches my $cnt = $realcnt; 4766b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 4767b13edf7fSJoe Perches my $ctx = ''; 4768b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 4769b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 4770b13edf7fSJoe Perches $ctx = $dstat; 4771b13edf7fSJoe Perches 4772b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 47731b36b201SJoe Perches $dstat =~ s/$;/ /g; 4774b13edf7fSJoe Perches 4775b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 4776b13edf7fSJoe Perches my $stmts = $2; 4777b13edf7fSJoe Perches my $semis = $3; 4778b13edf7fSJoe Perches 4779b13edf7fSJoe Perches $ctx =~ s/\n*$//; 4780b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 4781b13edf7fSJoe Perches my $herectx = $here . "\n"; 4782b13edf7fSJoe Perches 4783b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4784b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4785b13edf7fSJoe Perches } 4786b13edf7fSJoe Perches 4787ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 4788ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 4789b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 4790b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 4791b13edf7fSJoe Perches } 4792b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 4793b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 4794b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 4795b13edf7fSJoe Perches } 4796f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 4797f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 4798f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 4799f5ef95b1SJoe Perches my $herectx = $here . "\n"; 4800f5ef95b1SJoe Perches 4801f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4802f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4803f5ef95b1SJoe Perches } 4804f5ef95b1SJoe Perches 4805f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 4806f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 4807b13edf7fSJoe Perches } 4808b13edf7fSJoe Perches } 4809b13edf7fSJoe Perches 4810080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 4811080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 4812080ba929SMike Frysinger# . 4813080ba929SMike Frysinger# ALIGN(...) 4814080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 4815080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 4816000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 4817000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 4818080ba929SMike Frysinger } 4819080ba929SMike Frysinger 4820f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 482113214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 482213214adfSAndy Whitcroft my ($level, $endln, @chunks) = 4823cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 482413214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 4825cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 4826cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 4827aad4f614SJoe Perches my @allowed = (); 4828aad4f614SJoe Perches my $allow = 0; 482913214adfSAndy Whitcroft my $seen = 0; 4830773647a0SAndy Whitcroft my $herectx = $here . "\n"; 4831cf655043SAndy Whitcroft my $ln = $linenr - 1; 483213214adfSAndy Whitcroft for my $chunk (@chunks) { 483313214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 483413214adfSAndy Whitcroft 4835773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 4836773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 4837773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 4838773647a0SAndy Whitcroft 4839aad4f614SJoe Perches $allowed[$allow] = 0; 4840773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 4841773647a0SAndy Whitcroft 4842773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 4843773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 4844773647a0SAndy Whitcroft 4845773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 4846cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 4847cf655043SAndy Whitcroft 4848773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 484913214adfSAndy Whitcroft 485013214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 485113214adfSAndy Whitcroft 4852aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 4853cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4854cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4855aad4f614SJoe Perches $allowed[$allow] = 1; 485613214adfSAndy Whitcroft } 485713214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4858cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4859aad4f614SJoe Perches $allowed[$allow] = 1; 486013214adfSAndy Whitcroft } 4861cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4862cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4863aad4f614SJoe Perches $allowed[$allow] = 1; 486413214adfSAndy Whitcroft } 4865aad4f614SJoe Perches $allow++; 486613214adfSAndy Whitcroft } 4867aad4f614SJoe Perches if ($seen) { 4868aad4f614SJoe Perches my $sum_allowed = 0; 4869aad4f614SJoe Perches foreach (@allowed) { 4870aad4f614SJoe Perches $sum_allowed += $_; 4871aad4f614SJoe Perches } 4872aad4f614SJoe Perches if ($sum_allowed == 0) { 4873000d1cc1SJoe Perches WARN("BRACES", 4874000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 4875aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 4876aad4f614SJoe Perches $seen != $allow) { 4877aad4f614SJoe Perches CHK("BRACES", 4878aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 4879aad4f614SJoe Perches } 488013214adfSAndy Whitcroft } 488113214adfSAndy Whitcroft } 488213214adfSAndy Whitcroft } 4883773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 488413214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 4885cf655043SAndy Whitcroft my $allowed = 0; 4886f0a594c1SAndy Whitcroft 4887cf655043SAndy Whitcroft # Check the pre-context. 4888cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 4889cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 4890cf655043SAndy Whitcroft $allowed = 1; 4891f0a594c1SAndy Whitcroft } 4892773647a0SAndy Whitcroft 4893773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 4894773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 4895773647a0SAndy Whitcroft 4896cf655043SAndy Whitcroft # Check the condition. 4897cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 4898773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 4899cf655043SAndy Whitcroft if (defined $cond) { 4900773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4901cf655043SAndy Whitcroft } 4902cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4903cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4904cf655043SAndy Whitcroft $allowed = 1; 4905cf655043SAndy Whitcroft } 4906cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4907cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4908cf655043SAndy Whitcroft $allowed = 1; 4909cf655043SAndy Whitcroft } 4910cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4911cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4912cf655043SAndy Whitcroft $allowed = 1; 4913cf655043SAndy Whitcroft } 4914cf655043SAndy Whitcroft # Check the post-context. 4915cf655043SAndy Whitcroft if (defined $chunks[1]) { 4916cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 4917cf655043SAndy Whitcroft if (defined $cond) { 4918773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4919cf655043SAndy Whitcroft } 4920cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 4921cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 4922cf655043SAndy Whitcroft $allowed = 1; 4923cf655043SAndy Whitcroft } 4924cf655043SAndy Whitcroft } 4925cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 492669932487SJustin P. Mattock my $herectx = $here . "\n"; 4927f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 4928cf655043SAndy Whitcroft 4929f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 493069932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 4931cf655043SAndy Whitcroft } 4932cf655043SAndy Whitcroft 4933000d1cc1SJoe Perches WARN("BRACES", 4934000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 4935f0a594c1SAndy Whitcroft } 4936f0a594c1SAndy Whitcroft } 4937f0a594c1SAndy Whitcroft 49380979ae66SJoe Perches# check for unnecessary blank lines around braces 493977b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 4940f8e58219SJoe Perches if (CHK("BRACES", 4941f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 4942f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 4943f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4944f8e58219SJoe Perches } 49450979ae66SJoe Perches } 494677b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 4947f8e58219SJoe Perches if (CHK("BRACES", 4948f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 4949f8e58219SJoe Perches $fix) { 4950f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 4951f8e58219SJoe Perches } 49520979ae66SJoe Perches } 49530979ae66SJoe Perches 49544a0df2efSAndy Whitcroft# no volatiles please 49556c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 49566c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 4957000d1cc1SJoe Perches WARN("VOLATILE", 4958000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 49594a0df2efSAndy Whitcroft } 49604a0df2efSAndy Whitcroft 49615e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 49625e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 49635e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 49645e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 496533acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 49665e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 49675e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 49685e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 49695e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 49705e4f6ba5SJoe Perches $fix && 49715e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 49725e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 49735e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 49745e4f6ba5SJoe Perches my $comma_close = ""; 49755e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 49765e4f6ba5SJoe Perches $comma_close = $1; 49775e4f6ba5SJoe Perches } 49785e4f6ba5SJoe Perches 49795e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 49805e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 49815e4f6ba5SJoe Perches my $fixedline = $prevrawline; 49825e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 49835e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 49845e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 49855e4f6ba5SJoe Perches $fixedline = $rawline; 49865e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 49875e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 49885e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 49895e4f6ba5SJoe Perches } 49905e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 49915e4f6ba5SJoe Perches } 49925e4f6ba5SJoe Perches } 49935e4f6ba5SJoe Perches 49945e4f6ba5SJoe Perches# check for missing a space in a string concatenation 49955e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 49965e4f6ba5SJoe Perches WARN('MISSING_SPACE', 49975e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 49985e4f6ba5SJoe Perches } 49995e4f6ba5SJoe Perches 50005e4f6ba5SJoe Perches# check for spaces before a quoted newline 50015e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 50025e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 50035e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 50045e4f6ba5SJoe Perches $fix) { 50055e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 50065e4f6ba5SJoe Perches } 50075e4f6ba5SJoe Perches 50085e4f6ba5SJoe Perches } 50095e4f6ba5SJoe Perches 5010f17dba4fSJoe Perches# concatenated string without spaces between elements 501133acb54aSJoe Perches if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) { 5012f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 5013f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 5014f17dba4fSJoe Perches } 5015f17dba4fSJoe Perches 501690ad30e5SJoe Perches# uncoalesced string fragments 501733acb54aSJoe Perches if ($line =~ /$String\s*"/) { 501890ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 501990ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 502090ad30e5SJoe Perches } 502190ad30e5SJoe Perches 50226e300757SJoe Perches# check for %L{u,d,i} and 0x%[udi] in strings 50235e4f6ba5SJoe Perches my $string; 50245e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 50255e4f6ba5SJoe Perches $string = substr($rawline, $-[1], $+[1] - $-[1]); 50265e4f6ba5SJoe Perches $string =~ s/%%/__/g; 50276e300757SJoe Perches if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) { 50285e4f6ba5SJoe Perches WARN("PRINTF_L", 50295e4f6ba5SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 50305e4f6ba5SJoe Perches last; 50315e4f6ba5SJoe Perches } 50326e300757SJoe Perches if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) { 50336e300757SJoe Perches ERROR("PRINTF_0xDECIMAL", 50346e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 50356e300757SJoe Perches } 50365e4f6ba5SJoe Perches } 50375e4f6ba5SJoe Perches 50385e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 50395e4f6ba5SJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 50405e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 50415e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 50425e4f6ba5SJoe Perches } 50435e4f6ba5SJoe Perches 504400df344fSAndy Whitcroft# warn about #if 0 5045c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 5046000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 5047000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 5048de7d4f0eSAndy Whitcroft $herecurr); 50494a0df2efSAndy Whitcroft } 50504a0df2efSAndy Whitcroft 505103df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 505203df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5053100425deSJoe Perches my $tested = quotemeta($1); 5054100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5055100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5056100425deSJoe Perches my $func = $1; 5057100425deSJoe Perches if (WARN('NEEDLESS_IF', 5058100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5059100425deSJoe Perches $fix) { 5060100425deSJoe Perches my $do_fix = 1; 5061100425deSJoe Perches my $leading_tabs = ""; 5062100425deSJoe Perches my $new_leading_tabs = ""; 5063100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5064100425deSJoe Perches $leading_tabs = $1; 5065100425deSJoe Perches } else { 5066100425deSJoe Perches $do_fix = 0; 5067100425deSJoe Perches } 5068100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5069100425deSJoe Perches $new_leading_tabs = $1; 5070100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5071100425deSJoe Perches $do_fix = 0; 5072100425deSJoe Perches } 5073100425deSJoe Perches } else { 5074100425deSJoe Perches $do_fix = 0; 5075100425deSJoe Perches } 5076100425deSJoe Perches if ($do_fix) { 5077100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5078100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5079100425deSJoe Perches } 5080100425deSJoe Perches } 50814c432a8fSGreg Kroah-Hartman } 50824c432a8fSGreg Kroah-Hartman } 5083f0a594c1SAndy Whitcroft 5084ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5085ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5086ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5087ebfdc409SJoe Perches (defined $1 || defined $3) && 5088ebfdc409SJoe Perches $linenr > 3) { 5089ebfdc409SJoe Perches my $testval = $2; 5090ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5091ebfdc409SJoe Perches 5092ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5093ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5094ebfdc409SJoe Perches 5095ebfdc409SJoe 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)/) { 5096ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5097ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5098ebfdc409SJoe Perches } 5099ebfdc409SJoe Perches } 5100ebfdc409SJoe Perches 5101f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5102dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5103f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5104f78d98f6SJoe Perches my $level = $1; 5105f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5106f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5107f78d98f6SJoe Perches $fix) { 5108f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5109f78d98f6SJoe Perches } 5110f78d98f6SJoe Perches } 5111f78d98f6SJoe Perches 5112abb08a53SJoe Perches# check for mask then right shift without a parentheses 5113abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 5114abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5115abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5116abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5117abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5118abb08a53SJoe Perches } 5119abb08a53SJoe Perches 5120b75ac618SJoe Perches# check for pointer comparisons to NULL 5121b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 5122b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5123b75ac618SJoe Perches my $val = $1; 5124b75ac618SJoe Perches my $equal = "!"; 5125b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5126b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5127b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5128b75ac618SJoe Perches $fix) { 5129b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5130b75ac618SJoe Perches } 5131b75ac618SJoe Perches } 5132b75ac618SJoe Perches } 5133b75ac618SJoe Perches 51348716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 51358716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 51368716de38SJoe Perches my $attr = $1; 51378716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 51388716de38SJoe Perches my $ptr = $1; 51398716de38SJoe Perches my $var = $2; 51408716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 51418716de38SJoe Perches ERROR("MISPLACED_INIT", 51428716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 51438716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 51448716de38SJoe Perches WARN("MISPLACED_INIT", 51458716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 51468716de38SJoe Perches $fix) { 5147194f66fcSJoe 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; 51488716de38SJoe Perches } 51498716de38SJoe Perches } 51508716de38SJoe Perches } 51518716de38SJoe Perches 5152e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5153e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5154e970b884SJoe Perches my $attr = $1; 5155e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5156e970b884SJoe Perches my $attr_prefix = $1; 5157e970b884SJoe Perches my $attr_type = $2; 5158e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5159e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5160e970b884SJoe Perches $fix) { 5161194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5162e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5163e970b884SJoe Perches } 5164e970b884SJoe Perches } 5165e970b884SJoe Perches 5166e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5167e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5168e970b884SJoe Perches my $attr = $1; 5169e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5170e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5171e970b884SJoe Perches $fix) { 5172194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5173e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5174e970b884SJoe Perches $lead = rtrim($1); 5175e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5176e970b884SJoe Perches $lead = "${lead}const "; 5177194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5178e970b884SJoe Perches } 5179e970b884SJoe Perches } 5180e970b884SJoe Perches 5181c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5182c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5183c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5184c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5185c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5186c17893c7SJoe Perches $fix) { 5187c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5188c17893c7SJoe Perches } 5189c17893c7SJoe Perches } 5190c17893c7SJoe Perches 5191fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5192fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5193fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5194fbdb8138SJoe Perches my $constant_func = $1; 5195fbdb8138SJoe Perches my $func = $constant_func; 5196fbdb8138SJoe Perches $func =~ s/^__constant_//; 5197fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5198fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5199fbdb8138SJoe Perches $fix) { 5200194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5201fbdb8138SJoe Perches } 5202fbdb8138SJoe Perches } 5203fbdb8138SJoe Perches 52041a15a250SPatrick Pannuto# prefer usleep_range over udelay 520537581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 520643c1d77cSJoe Perches my $delay = $1; 52071a15a250SPatrick Pannuto # ignore udelay's < 10, however 520843c1d77cSJoe Perches if (! ($delay < 10) ) { 5209000d1cc1SJoe Perches CHK("USLEEP_RANGE", 521043c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 521143c1d77cSJoe Perches } 521243c1d77cSJoe Perches if ($delay > 2000) { 521343c1d77cSJoe Perches WARN("LONG_UDELAY", 521443c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 52151a15a250SPatrick Pannuto } 52161a15a250SPatrick Pannuto } 52171a15a250SPatrick Pannuto 521809ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 521909ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 522009ef8725SPatrick Pannuto if ($1 < 20) { 5221000d1cc1SJoe Perches WARN("MSLEEP", 522243c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 522309ef8725SPatrick Pannuto } 522409ef8725SPatrick Pannuto } 522509ef8725SPatrick Pannuto 522636ec1939SJoe Perches# check for comparisons of jiffies 522736ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 522836ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 522936ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 523036ec1939SJoe Perches } 523136ec1939SJoe Perches 52329d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 52339d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 52349d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 52359d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 52369d7a34a5SJoe Perches } 52379d7a34a5SJoe Perches 523800df344fSAndy Whitcroft# warn about #ifdefs in C files 5239c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 524000df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 524100df344fSAndy Whitcroft# print "$herecurr"; 524200df344fSAndy Whitcroft# $clean = 0; 524300df344fSAndy Whitcroft# } 524400df344fSAndy Whitcroft 524522f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5246c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 52473705ce5bSJoe Perches if (ERROR("SPACING", 52483705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 52493705ce5bSJoe Perches $fix) { 5250194f66fcSJoe Perches $fixed[$fixlinenr] =~ 52513705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 52523705ce5bSJoe Perches } 52533705ce5bSJoe Perches 525422f2a2efSAndy Whitcroft } 525522f2a2efSAndy Whitcroft 52564a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5257171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5258171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 52594a0df2efSAndy Whitcroft my $which = $1; 52604a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5261000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5262000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 52634a0df2efSAndy Whitcroft } 52644a0df2efSAndy Whitcroft } 52654a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5266402c2553SMichael S. Tsirkin 5267402c2553SMichael S. Tsirkin my $barriers = qr{ 5268402c2553SMichael S. Tsirkin mb| 5269402c2553SMichael S. Tsirkin rmb| 5270402c2553SMichael S. Tsirkin wmb| 5271402c2553SMichael S. Tsirkin read_barrier_depends 5272402c2553SMichael S. Tsirkin }x; 5273402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5274402c2553SMichael S. Tsirkin mb__before_atomic| 5275402c2553SMichael S. Tsirkin mb__after_atomic| 5276402c2553SMichael S. Tsirkin store_release| 5277402c2553SMichael S. Tsirkin load_acquire| 5278402c2553SMichael S. Tsirkin store_mb| 5279402c2553SMichael S. Tsirkin (?:$barriers) 5280402c2553SMichael S. Tsirkin }x; 5281402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5282402c2553SMichael S. Tsirkin (?:$barriers)| 528343e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 528443e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5285402c2553SMichael S. Tsirkin }x; 5286402c2553SMichael S. Tsirkin 5287402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 52884a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5289c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5290000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 52914a0df2efSAndy Whitcroft } 52924a0df2efSAndy Whitcroft } 52933ad81779SPaul E. McKenney 5294f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5295f4073b0fSMichael S. Tsirkin 5296f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5297f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5298f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5299f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5300f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5301f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5302f4073b0fSMichael S. Tsirkin } 5303f4073b0fSMichael S. Tsirkin 5304cb426e99SJoe Perches# check for waitqueue_active without a comment. 5305cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5306cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5307cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5308cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5309cb426e99SJoe Perches } 5310cb426e99SJoe Perches } 53113ad81779SPaul E. McKenney 53123ad81779SPaul E. McKenney# Check for expedited grace periods that interrupt non-idle non-nohz 53133ad81779SPaul E. McKenney# online CPUs. These expedited can therefore degrade real-time response 53143ad81779SPaul E. McKenney# if used carelessly, and should be avoided where not absolutely 53153ad81779SPaul E. McKenney# needed. It is always OK to use synchronize_rcu_expedited() and 53163ad81779SPaul E. McKenney# synchronize_sched_expedited() at boot time (before real-time applications 53173ad81779SPaul E. McKenney# start) and in error situations where real-time response is compromised in 53183ad81779SPaul E. McKenney# any case. Note that synchronize_srcu_expedited() does -not- interrupt 53193ad81779SPaul E. McKenney# other CPUs, so don't warn on uses of synchronize_srcu_expedited(). 53203ad81779SPaul E. McKenney# Of course, nothing comes for free, and srcu_read_lock() and 53213ad81779SPaul E. McKenney# srcu_read_unlock() do contain full memory barriers in payment for 53223ad81779SPaul E. McKenney# synchronize_srcu_expedited() non-interruption properties. 53233ad81779SPaul E. McKenney if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) { 53243ad81779SPaul E. McKenney WARN("EXPEDITED_RCU_GRACE_PERIOD", 53253ad81779SPaul E. McKenney "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr); 53263ad81779SPaul E. McKenney 53273ad81779SPaul E. McKenney } 53283ad81779SPaul E. McKenney 53294a0df2efSAndy Whitcroft# check of hardware specific defines 5330c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5331000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5332000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 53330a920b5bSAndy Whitcroft } 5334653d4876SAndy Whitcroft 5335d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 5336d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 5337000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5338000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 5339d4977c78STobias Klauser } 5340d4977c78STobias Klauser 5341de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5342de7d4f0eSAndy Whitcroft# storage class and type. 53439c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 53449c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5345000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5346000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5347de7d4f0eSAndy Whitcroft } 5348de7d4f0eSAndy Whitcroft 53498905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 53502b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 53512b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5352d5e616fcSJoe Perches if (WARN("INLINE", 5353d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5354d5e616fcSJoe Perches $fix) { 5355194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5356d5e616fcSJoe Perches 5357d5e616fcSJoe Perches } 53588905a67cSAndy Whitcroft } 53598905a67cSAndy Whitcroft 53603d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 53612b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 53622b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5363000d1cc1SJoe Perches WARN("PREFER_PACKED", 5364000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 53653d130fd0SJoe Perches } 53663d130fd0SJoe Perches 536739b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 53682b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 53692b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5370000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5371000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 537239b7e287SJoe Perches } 537339b7e287SJoe Perches 53745f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 53752b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 53762b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5377d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5378d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5379d5e616fcSJoe Perches $fix) { 5380194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5381d5e616fcSJoe Perches 5382d5e616fcSJoe Perches } 53835f14d3bdSJoe Perches } 53845f14d3bdSJoe Perches 53856061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 53862b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 53872b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5388d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5389d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5390d5e616fcSJoe Perches $fix) { 5391194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5392d5e616fcSJoe Perches } 53936061d949SJoe Perches } 53946061d949SJoe Perches 5395619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 5396619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 5397619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5398619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5399619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5400619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5401619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5402619a908aSJoe Perches } 5403619a908aSJoe Perches 5404e6176fa4SJoe Perches# check for c99 types like uint8_t used outside of uapi/ 5405e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5406e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5407e6176fa4SJoe Perches my $type = $1; 5408e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5409e6176fa4SJoe Perches $type = $1; 5410e6176fa4SJoe Perches my $kernel_type = 'u'; 5411e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5412e6176fa4SJoe Perches $type =~ /(\d+)/; 5413e6176fa4SJoe Perches $kernel_type .= $1; 5414e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5415e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5416e6176fa4SJoe Perches $fix) { 5417e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5418e6176fa4SJoe Perches } 5419e6176fa4SJoe Perches } 5420e6176fa4SJoe Perches } 5421e6176fa4SJoe Perches 5422938224b5SJoe Perches# check for cast of C90 native int or longer types constants 5423938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 5424938224b5SJoe Perches my $cast = $1; 5425938224b5SJoe Perches my $const = $2; 5426938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 5427938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 5428938224b5SJoe Perches $fix) { 5429938224b5SJoe Perches my $suffix = ""; 5430938224b5SJoe Perches my $newconst = $const; 5431938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 5432938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 5433938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 5434938224b5SJoe Perches $suffix .= 'LL'; 5435938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 5436938224b5SJoe Perches $suffix .= 'L'; 5437938224b5SJoe Perches } 5438938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 5439938224b5SJoe Perches } 5440938224b5SJoe Perches } 5441938224b5SJoe Perches 54428f53a9b8SJoe Perches# check for sizeof(&) 54438f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5444000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5445000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 54468f53a9b8SJoe Perches } 54478f53a9b8SJoe Perches 544866c80b60SJoe Perches# check for sizeof without parenthesis 544966c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5450d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5451d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5452d5e616fcSJoe Perches $fix) { 5453194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5454d5e616fcSJoe Perches } 545566c80b60SJoe Perches } 545666c80b60SJoe Perches 545788982feaSJoe Perches# check for struct spinlock declarations 545888982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 545988982feaSJoe Perches WARN("USE_SPINLOCK_T", 546088982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 546188982feaSJoe Perches } 546288982feaSJoe Perches 5463a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 546406668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5465a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5466caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5467caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5468d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5469d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5470d5e616fcSJoe Perches $fix) { 5471194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5472d5e616fcSJoe Perches } 5473a6962d72SJoe Perches } 5474a6962d72SJoe Perches } 5475a6962d72SJoe Perches 5476554e165cSAndy Whitcroft# Check for misused memsets 5477d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5478d1fe9c09SJoe Perches defined $stat && 54799e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5480554e165cSAndy Whitcroft 5481d7c76ba7SJoe Perches my $ms_addr = $2; 5482d1fe9c09SJoe Perches my $ms_val = $7; 5483d1fe9c09SJoe Perches my $ms_size = $12; 5484d7c76ba7SJoe Perches 5485554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5486554e165cSAndy Whitcroft ERROR("MEMSET", 5487d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5488554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5489554e165cSAndy Whitcroft WARN("MEMSET", 5490d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5491d7c76ba7SJoe Perches } 5492d7c76ba7SJoe Perches } 5493d7c76ba7SJoe Perches 549498a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 549598a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 549610895d2cSMateusz Kulikowski defined $stat && 549710895d2cSMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 549898a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 549910895d2cSMateusz Kulikowski "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 550098a9bba5SJoe Perches $fix) { 5501194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 550298a9bba5SJoe Perches } 550398a9bba5SJoe Perches } 550498a9bba5SJoe Perches 5505b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 5506b6117d17SMateusz Kulikowski if ($^V && $^V ge 5.10.0 && 5507b6117d17SMateusz Kulikowski defined $stat && 5508b6117d17SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5509b6117d17SMateusz Kulikowski WARN("PREFER_ETHER_ADDR_EQUAL", 5510b6117d17SMateusz Kulikowski "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5511b6117d17SMateusz Kulikowski } 5512b6117d17SMateusz Kulikowski 55138617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 55148617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 55158617cd09SMateusz Kulikowski if ($^V && $^V ge 5.10.0 && 55168617cd09SMateusz Kulikowski defined $stat && 55178617cd09SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 55188617cd09SMateusz Kulikowski 55198617cd09SMateusz Kulikowski my $ms_val = $7; 55208617cd09SMateusz Kulikowski 55218617cd09SMateusz Kulikowski if ($ms_val =~ /^(?:0x|)0+$/i) { 55228617cd09SMateusz Kulikowski if (WARN("PREFER_ETH_ZERO_ADDR", 55238617cd09SMateusz Kulikowski "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 55248617cd09SMateusz Kulikowski $fix) { 55258617cd09SMateusz Kulikowski $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 55268617cd09SMateusz Kulikowski } 55278617cd09SMateusz Kulikowski } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 55288617cd09SMateusz Kulikowski if (WARN("PREFER_ETH_BROADCAST_ADDR", 55298617cd09SMateusz Kulikowski "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 55308617cd09SMateusz Kulikowski $fix) { 55318617cd09SMateusz Kulikowski $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 55328617cd09SMateusz Kulikowski } 55338617cd09SMateusz Kulikowski } 55348617cd09SMateusz Kulikowski } 55358617cd09SMateusz Kulikowski 5536d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5537d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5538d1fe9c09SJoe Perches defined $stat && 5539d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5540d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5541d7c76ba7SJoe Perches my $call = $1; 5542d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5543d7c76ba7SJoe Perches my $arg1 = $3; 5544d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5545d1fe9c09SJoe Perches my $arg2 = $8; 5546d7c76ba7SJoe Perches my $cast; 5547d7c76ba7SJoe Perches 5548d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5549d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5550d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5551d7c76ba7SJoe Perches $cast = $cast1; 5552d7c76ba7SJoe Perches } else { 5553d7c76ba7SJoe Perches $cast = $cast2; 5554d7c76ba7SJoe Perches } 5555d7c76ba7SJoe Perches WARN("MINMAX", 5556d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5557554e165cSAndy Whitcroft } 5558554e165cSAndy Whitcroft } 5559554e165cSAndy Whitcroft 55604a273195SJoe Perches# check usleep_range arguments 55614a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 55624a273195SJoe Perches defined $stat && 55634a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 55644a273195SJoe Perches my $min = $1; 55654a273195SJoe Perches my $max = $7; 55664a273195SJoe Perches if ($min eq $max) { 55674a273195SJoe Perches WARN("USLEEP_RANGE", 55684a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 55694a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 55704a273195SJoe Perches $min > $max) { 55714a273195SJoe Perches WARN("USLEEP_RANGE", 55724a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 55734a273195SJoe Perches } 55744a273195SJoe Perches } 55754a273195SJoe Perches 5576823b794cSJoe Perches# check for naked sscanf 5577823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5578823b794cSJoe Perches defined $stat && 55796c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5580823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5581823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5582823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5583823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5584823b794cSJoe Perches $lc = $lc + $linenr; 5585823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 5586823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5587823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5588823b794cSJoe Perches } 5589823b794cSJoe Perches WARN("NAKED_SSCANF", 5590823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5591823b794cSJoe Perches } 5592823b794cSJoe Perches 5593afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5594afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5595afc819abSJoe Perches defined $stat && 5596afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5597afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5598afc819abSJoe Perches $lc = $lc + $linenr; 5599afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 5600afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5601afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5602afc819abSJoe Perches } 5603afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5604afc819abSJoe Perches my $format = $6; 5605afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5606afc819abSJoe Perches if ($count == 1 && 5607afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5608afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5609afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5610afc819abSJoe Perches } 5611afc819abSJoe Perches } 5612afc819abSJoe Perches } 5613afc819abSJoe Perches 561470dc8a48SJoe Perches# check for new externs in .h files. 561570dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 561670dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5617d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 561870dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 561970dc8a48SJoe Perches $fix) { 5620194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 562170dc8a48SJoe Perches } 562270dc8a48SJoe Perches } 562370dc8a48SJoe Perches 5624de7d4f0eSAndy Whitcroft# check for new externs in .c files. 5625171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 5626c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 5627171ae1a4SAndy Whitcroft { 5628c45dcabdSAndy Whitcroft my $function_name = $1; 5629c45dcabdSAndy Whitcroft my $paren_space = $2; 5630171ae1a4SAndy Whitcroft 5631171ae1a4SAndy Whitcroft my $s = $stat; 5632171ae1a4SAndy Whitcroft if (defined $cond) { 5633171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 5634171ae1a4SAndy Whitcroft } 5635c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 5636c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 5637c45dcabdSAndy Whitcroft { 5638000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5639000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5640de7d4f0eSAndy Whitcroft } 5641de7d4f0eSAndy Whitcroft 5642171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 5643000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 5644000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 5645171ae1a4SAndy Whitcroft } 56469c9ba34eSAndy Whitcroft 56479c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 56489c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 56499c9ba34eSAndy Whitcroft { 5650000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5651000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5652171ae1a4SAndy Whitcroft } 5653171ae1a4SAndy Whitcroft 5654de7d4f0eSAndy Whitcroft# checks for new __setup's 5655de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 5656de7d4f0eSAndy Whitcroft my $name = $1; 5657de7d4f0eSAndy Whitcroft 5658de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 5659000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 5660000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 5661de7d4f0eSAndy Whitcroft } 5662653d4876SAndy Whitcroft } 56639c0ca6f9SAndy Whitcroft 56649c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 5665caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 5666000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 5667000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 56689c0ca6f9SAndy Whitcroft } 566913214adfSAndy Whitcroft 5670a640d25cSJoe Perches# alloc style 5671a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 5672a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 5673a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 5674a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 5675a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 5676a640d25cSJoe Perches } 5677a640d25cSJoe Perches 567860a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 567960a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 5680e367455aSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 568160a55369SJoe Perches my $oldfunc = $3; 568260a55369SJoe Perches my $a1 = $4; 568360a55369SJoe Perches my $a2 = $10; 568460a55369SJoe Perches my $newfunc = "kmalloc_array"; 568560a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 568660a55369SJoe Perches my $r1 = $a1; 568760a55369SJoe Perches my $r2 = $a2; 568860a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 568960a55369SJoe Perches $r1 = $a2; 569060a55369SJoe Perches $r2 = $a1; 569160a55369SJoe Perches } 5692e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 5693e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 5694e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 5695e367455aSJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 5696e367455aSJoe Perches $fix) { 5697194f66fcSJoe 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; 569860a55369SJoe Perches 569960a55369SJoe Perches } 570060a55369SJoe Perches } 570160a55369SJoe Perches } 570260a55369SJoe Perches 5703972fdea2SJoe Perches# check for krealloc arg reuse 5704972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 5705972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 5706972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 5707972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 5708972fdea2SJoe Perches } 5709972fdea2SJoe Perches 57105ce59ae0SJoe Perches# check for alloc argument mismatch 57115ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 57125ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 57135ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 57145ce59ae0SJoe Perches } 57155ce59ae0SJoe Perches 5716caf2a54fSJoe Perches# check for multiple semicolons 5717caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 5718d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 5719d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 5720d5e616fcSJoe Perches $fix) { 5721194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 5722d5e616fcSJoe Perches } 5723d1e2ad07SJoe Perches } 5724d1e2ad07SJoe Perches 57250ab90191SJoe Perches# check for #defines like: 1 << <digit> that could be BIT(digit) 57260ab90191SJoe Perches if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 57270ab90191SJoe Perches my $ull = ""; 57280ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 57290ab90191SJoe Perches if (CHK("BIT_MACRO", 57300ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 57310ab90191SJoe Perches $fix) { 57320ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 57330ab90191SJoe Perches } 57340ab90191SJoe Perches } 57350ab90191SJoe Perches 57362d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 57372d632745SJoe 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*$/) { 57382d632745SJoe Perches my $config = $1; 57392d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 57402d632745SJoe Perches "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) && 57412d632745SJoe Perches $fix) { 57422d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 57432d632745SJoe Perches } 57442d632745SJoe Perches } 57452d632745SJoe Perches 5746e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 5747c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 5748c34c09a8SJoe Perches my $has_break = 0; 5749c34c09a8SJoe Perches my $has_statement = 0; 5750c34c09a8SJoe Perches my $count = 0; 5751c34c09a8SJoe Perches my $prevline = $linenr; 5752e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 5753c34c09a8SJoe Perches $prevline--; 5754c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 5755c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 5756c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 5757c34c09a8SJoe Perches next if ($fline =~ /^\-/); 5758c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 5759c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 5760c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 5761c34c09a8SJoe Perches $has_statement = 1; 5762c34c09a8SJoe Perches $count++; 5763c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 5764c34c09a8SJoe Perches } 5765c34c09a8SJoe Perches if (!$has_break && $has_statement) { 5766c34c09a8SJoe Perches WARN("MISSING_BREAK", 5767c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 5768c34c09a8SJoe Perches } 5769c34c09a8SJoe Perches } 5770c34c09a8SJoe Perches 5771d1e2ad07SJoe Perches# check for switch/default statements without a break; 5772d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 5773d1e2ad07SJoe Perches defined $stat && 5774d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 5775d1e2ad07SJoe Perches my $ctx = ''; 5776d1e2ad07SJoe Perches my $herectx = $here . "\n"; 5777d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 5778d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5779d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5780d1e2ad07SJoe Perches } 5781d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 5782d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 5783caf2a54fSJoe Perches } 5784caf2a54fSJoe Perches 578513214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 5786d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 5787d5e616fcSJoe Perches if (WARN("USE_FUNC", 5788d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 5789d5e616fcSJoe Perches $fix) { 5790194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 5791d5e616fcSJoe Perches } 579213214adfSAndy Whitcroft } 5793773647a0SAndy Whitcroft 579462ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 579562ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 579662ec818fSJoe Perches ERROR("DATE_TIME", 579762ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 579862ec818fSJoe Perches } 579962ec818fSJoe Perches 58002c92488aSJoe Perches# check for use of yield() 58012c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 58022c92488aSJoe Perches WARN("YIELD", 58032c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 58042c92488aSJoe Perches } 58052c92488aSJoe Perches 5806179f8f40SJoe Perches# check for comparisons against true and false 5807179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 5808179f8f40SJoe Perches my $lead = $1; 5809179f8f40SJoe Perches my $arg = $2; 5810179f8f40SJoe Perches my $test = $3; 5811179f8f40SJoe Perches my $otype = $4; 5812179f8f40SJoe Perches my $trail = $5; 5813179f8f40SJoe Perches my $op = "!"; 5814179f8f40SJoe Perches 5815179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 5816179f8f40SJoe Perches 5817179f8f40SJoe Perches my $type = lc($otype); 5818179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 5819179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 5820179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 5821179f8f40SJoe Perches $op = ""; 5822179f8f40SJoe Perches } 5823179f8f40SJoe Perches 5824179f8f40SJoe Perches CHK("BOOL_COMPARISON", 5825179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 5826179f8f40SJoe Perches 5827179f8f40SJoe Perches## maybe suggesting a correct construct would better 5828179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 5829179f8f40SJoe Perches 5830179f8f40SJoe Perches } 5831179f8f40SJoe Perches } 5832179f8f40SJoe Perches 58334882720bSThomas Gleixner# check for semaphores initialized locked 58344882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 5835000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 5836000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 5837773647a0SAndy Whitcroft } 58386712d858SJoe Perches 583967d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 584067d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 5841000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 584267d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 5843773647a0SAndy Whitcroft } 58446712d858SJoe Perches 5845ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 5846f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 5847000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 5848ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 5849f3db6639SMichael Ellerman } 58506712d858SJoe Perches 58510f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 58520f3c5aabSJoe Perches my $const_structs = qr{ 58530f3c5aabSJoe Perches acpi_dock_ops| 585479404849SEmese Revfy address_space_operations| 585579404849SEmese Revfy backlight_ops| 585679404849SEmese Revfy block_device_operations| 585779404849SEmese Revfy dentry_operations| 585879404849SEmese Revfy dev_pm_ops| 585979404849SEmese Revfy dma_map_ops| 586079404849SEmese Revfy extent_io_ops| 586179404849SEmese Revfy file_lock_operations| 586279404849SEmese Revfy file_operations| 586379404849SEmese Revfy hv_ops| 586479404849SEmese Revfy ide_dma_ops| 586579404849SEmese Revfy intel_dvo_dev_ops| 586679404849SEmese Revfy item_operations| 586779404849SEmese Revfy iwl_ops| 586879404849SEmese Revfy kgdb_arch| 586979404849SEmese Revfy kgdb_io| 587079404849SEmese Revfy kset_uevent_ops| 587179404849SEmese Revfy lock_manager_operations| 587279404849SEmese Revfy microcode_ops| 587379404849SEmese Revfy mtrr_ops| 587479404849SEmese Revfy neigh_ops| 587579404849SEmese Revfy nlmsvc_binding| 58760f3c5aabSJoe Perches of_device_id| 587779404849SEmese Revfy pci_raw_ops| 587879404849SEmese Revfy pipe_buf_operations| 587979404849SEmese Revfy platform_hibernation_ops| 588079404849SEmese Revfy platform_suspend_ops| 588179404849SEmese Revfy proto_ops| 588279404849SEmese Revfy rpc_pipe_ops| 588379404849SEmese Revfy seq_operations| 588479404849SEmese Revfy snd_ac97_build_ops| 588579404849SEmese Revfy soc_pcmcia_socket_ops| 588679404849SEmese Revfy stacktrace_ops| 588779404849SEmese Revfy sysfs_ops| 588879404849SEmese Revfy tty_operations| 58896d07d01bSJoe Perches uart_ops| 589079404849SEmese Revfy usb_mon_operations| 589179404849SEmese Revfy wd_ops}x; 58926903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 58930f3c5aabSJoe Perches $line =~ /\bstruct\s+($const_structs)\b/) { 5894000d1cc1SJoe Perches WARN("CONST_STRUCT", 5895000d1cc1SJoe Perches "struct $1 should normally be const\n" . 58966903ffb2SAndy Whitcroft $herecurr); 58972b6db5cbSAndy Whitcroft } 5898773647a0SAndy Whitcroft 5899773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 5900773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 5901773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 5902c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 5903c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 5904171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 5905171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 5906171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 5907773647a0SAndy Whitcroft { 5908000d1cc1SJoe Perches WARN("NR_CPUS", 5909000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 5910773647a0SAndy Whitcroft } 59119c9ba34eSAndy Whitcroft 591252ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 591352ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 591452ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 591552ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 591652ea8506SJoe Perches } 591752ea8506SJoe Perches 5918acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 5919acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 5920acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 5921acd9362cSJoe Perches WARN("LIKELY_MISUSE", 5922acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 5923acd9362cSJoe Perches } 5924acd9362cSJoe Perches 5925691d77b6SAndy Whitcroft# whine mightly about in_atomic 5926691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 5927691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 5928000d1cc1SJoe Perches ERROR("IN_ATOMIC", 5929000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 5930f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 5931000d1cc1SJoe Perches WARN("IN_ATOMIC", 5932000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 5933691d77b6SAndy Whitcroft } 5934691d77b6SAndy Whitcroft } 59351704f47bSPeter Zijlstra 5936481aea5cSJoe Perches# whine about ACCESS_ONCE 5937481aea5cSJoe Perches if ($^V && $^V ge 5.10.0 && 5938481aea5cSJoe Perches $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) { 5939481aea5cSJoe Perches my $par = $1; 5940481aea5cSJoe Perches my $eq = $2; 5941481aea5cSJoe Perches my $fun = $3; 5942481aea5cSJoe Perches $par =~ s/^\(\s*(.*)\s*\)$/$1/; 5943481aea5cSJoe Perches if (defined($eq)) { 5944481aea5cSJoe Perches if (WARN("PREFER_WRITE_ONCE", 5945481aea5cSJoe Perches "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) && 5946481aea5cSJoe Perches $fix) { 5947481aea5cSJoe Perches $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/; 5948481aea5cSJoe Perches } 5949481aea5cSJoe Perches } else { 5950481aea5cSJoe Perches if (WARN("PREFER_READ_ONCE", 5951481aea5cSJoe Perches "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) && 5952481aea5cSJoe Perches $fix) { 5953481aea5cSJoe Perches $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/; 5954481aea5cSJoe Perches } 5955481aea5cSJoe Perches } 5956481aea5cSJoe Perches } 5957481aea5cSJoe Perches 59581704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 59591704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 59601704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 59611704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 59621704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 59631704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 5964000d1cc1SJoe Perches ERROR("LOCKDEP", 5965000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 59661704f47bSPeter Zijlstra } 59671704f47bSPeter Zijlstra } 596888f8831cSDave Jones 5969b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 5970b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 5971000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 5972000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 597388f8831cSDave Jones } 59742435880fSJoe Perches 5975515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 5976515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 5977515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 5978515a235eSJoe Perches $line =~ /$mode_perms_search/) { 59792435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 59802435880fSJoe Perches my $func = $entry->[0]; 59812435880fSJoe Perches my $arg_pos = $entry->[1]; 59822435880fSJoe Perches 59832435880fSJoe Perches my $skip_args = ""; 59842435880fSJoe Perches if ($arg_pos > 1) { 59852435880fSJoe Perches $arg_pos--; 59862435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 59872435880fSJoe Perches } 59882435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 5989515a235eSJoe Perches if ($line =~ /$test/) { 59902435880fSJoe Perches my $val = $1; 59912435880fSJoe Perches $val = $6 if ($skip_args ne ""); 59922435880fSJoe Perches 59931727cc70SJoe Perches if ($val !~ /^0$/ && 59941727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 59951727cc70SJoe Perches length($val) ne 4)) { 59962435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 59971727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 5998c0a5c898SJoe Perches } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) { 5999c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6000c0a5c898SJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 60012435880fSJoe Perches } 60022435880fSJoe Perches } 60032435880fSJoe Perches } 600413214adfSAndy Whitcroft } 60055a6d20ceSBjorn Andersson 60065a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 60075a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 60085a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 60095a6d20ceSBjorn Andersson my $valid_licenses = qr{ 60105a6d20ceSBjorn Andersson GPL| 60115a6d20ceSBjorn Andersson GPL\ v2| 60125a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 60135a6d20ceSBjorn Andersson Dual\ BSD/GPL| 60145a6d20ceSBjorn Andersson Dual\ MIT/GPL| 60155a6d20ceSBjorn Andersson Dual\ MPL/GPL| 60165a6d20ceSBjorn Andersson Proprietary 60175a6d20ceSBjorn Andersson }x; 60185a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 60195a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 60205a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 60215a6d20ceSBjorn Andersson } 60225a6d20ceSBjorn Andersson } 6023515a235eSJoe Perches } 602413214adfSAndy Whitcroft 602513214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 602613214adfSAndy Whitcroft # so just keep quiet. 602713214adfSAndy Whitcroft if ($#rawlines == -1) { 602813214adfSAndy Whitcroft exit(0); 60290a920b5bSAndy Whitcroft } 60300a920b5bSAndy Whitcroft 60318905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 60328905a67cSAndy Whitcroft # things that appear to be patches. 60338905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 60348905a67cSAndy Whitcroft exit(0); 60358905a67cSAndy Whitcroft } 60368905a67cSAndy Whitcroft 60378905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 60388905a67cSAndy Whitcroft # just keep quiet. 60398905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 60408905a67cSAndy Whitcroft exit(0); 60418905a67cSAndy Whitcroft } 60428905a67cSAndy Whitcroft 604306330fc4SJoe Perches if (!$is_patch && $file !~ /cover-letter\.patch$/) { 6044000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6045000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 60460a920b5bSAndy Whitcroft } 604734d8815fSJoe Perches if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) { 6048000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6049000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 60500a920b5bSAndy Whitcroft } 60510a920b5bSAndy Whitcroft 6052f0a594c1SAndy Whitcroft print report_dump(); 605313214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 605413214adfSAndy Whitcroft print "$filename " if ($summary_file); 60556c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 60566c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 60576c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 60586c72ffaaSAndy Whitcroft } 60598905a67cSAndy Whitcroft 6060d2c0a235SAndy Whitcroft if ($quiet == 0) { 6061ef212196SJoe Perches # If there were any defects found and not already fixing them 6062ef212196SJoe Perches if (!$clean and !$fix) { 6063ef212196SJoe Perches print << "EOM" 6064ef212196SJoe Perches 6065ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 6066ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 6067ef212196SJoe PerchesEOM 6068ef212196SJoe Perches } 6069d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 6070d2c0a235SAndy Whitcroft # then suggest that. 6071d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 6072b0781216SMike Frysinger $rpt_cleaners = 0; 6073d8469f16SJoe Perches print << "EOM" 6074d8469f16SJoe Perches 6075d8469f16SJoe PerchesNOTE: Whitespace errors detected. 6076d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 6077d8469f16SJoe PerchesEOM 6078d2c0a235SAndy Whitcroft } 6079d2c0a235SAndy Whitcroft } 6080d2c0a235SAndy Whitcroft 6081d752fcc8SJoe Perches if ($clean == 0 && $fix && 6082d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 6083d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 60849624b8d6SJoe Perches my $newfile = $filename; 60859624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 60863705ce5bSJoe Perches my $linecount = 0; 60873705ce5bSJoe Perches my $f; 60883705ce5bSJoe Perches 6089d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 6090d752fcc8SJoe Perches 60913705ce5bSJoe Perches open($f, '>', $newfile) 60923705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 60933705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 60943705ce5bSJoe Perches $linecount++; 60953705ce5bSJoe Perches if ($file) { 60963705ce5bSJoe Perches if ($linecount > 3) { 60973705ce5bSJoe Perches $fixed_line =~ s/^\+//; 60983705ce5bSJoe Perches print $f $fixed_line . "\n"; 60993705ce5bSJoe Perches } 61003705ce5bSJoe Perches } else { 61013705ce5bSJoe Perches print $f $fixed_line . "\n"; 61023705ce5bSJoe Perches } 61033705ce5bSJoe Perches } 61043705ce5bSJoe Perches close($f); 61053705ce5bSJoe Perches 61063705ce5bSJoe Perches if (!$quiet) { 61073705ce5bSJoe Perches print << "EOM"; 6108d8469f16SJoe Perches 61093705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 61103705ce5bSJoe Perches 61113705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 61123705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 61133705ce5bSJoe Perches 61143705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 61153705ce5bSJoe PerchesNo warranties, expressed or implied... 61163705ce5bSJoe PerchesEOM 61173705ce5bSJoe Perches } 61183705ce5bSJoe Perches } 61193705ce5bSJoe Perches 6120d8469f16SJoe Perches if ($quiet == 0) { 6121d8469f16SJoe Perches print "\n"; 6122d8469f16SJoe Perches if ($clean == 1) { 6123d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 6124d8469f16SJoe Perches } else { 6125d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 61260a920b5bSAndy Whitcroft } 61270a920b5bSAndy Whitcroft } 61280a920b5bSAndy Whitcroft return $clean; 61290a920b5bSAndy Whitcroft} 6130