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"; 57*bf1fa1daSJoe Perchesmy $conststructsfile = "$D/const_structs.checkpatch"; 5857230297SJoe Perchesmy $color = 1; 59dadf680dSJoe Perchesmy $allow_c99_comments = 1; 6077f5b10aSHannes Eder 6177f5b10aSHannes Edersub help { 6277f5b10aSHannes Eder my ($exitcode) = @_; 6377f5b10aSHannes Eder 6477f5b10aSHannes Eder print << "EOM"; 6577f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 6677f5b10aSHannes EderVersion: $V 6777f5b10aSHannes Eder 6877f5b10aSHannes EderOptions: 6977f5b10aSHannes Eder -q, --quiet quiet 7077f5b10aSHannes Eder --no-tree run without a kernel tree 7177f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 7277f5b10aSHannes Eder --patch treat FILE as patchfile (default) 7377f5b10aSHannes Eder --emacs emacs compile window format 7477f5b10aSHannes Eder --terse one line per report 7534d8815fSJoe Perches --showfile emit diffed file position, not input file position 764a593c34SDu, Changbin -g, --git treat FILE as a single commit or git revision range 774a593c34SDu, Changbin single git commit with: 784a593c34SDu, Changbin <rev> 794a593c34SDu, Changbin <rev>^ 804a593c34SDu, Changbin <rev>~n 814a593c34SDu, Changbin multiple git commits with: 824a593c34SDu, Changbin <rev1>..<rev2> 834a593c34SDu, Changbin <rev1>...<rev2> 844a593c34SDu, Changbin <rev>-<count> 854a593c34SDu, Changbin git merges are ignored 8677f5b10aSHannes Eder -f, --file treat FILE as regular source file 8777f5b10aSHannes Eder --subjective, --strict enable more subjective tests 883beb42ecSJoe Perches --list-types list the possible message types 8991bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 90000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 913beb42ecSJoe Perches --show-types show the specific message type in the output 926cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 9356193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 9477f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 9577f5b10aSHannes Eder --no-summary suppress the per-file summary 9677f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 9777f5b10aSHannes Eder --summary-file include the filename in summary 9877f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 9977f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 10077f5b10aSHannes Eder is all off) 10177f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 10277f5b10aSHannes Eder literally 1033705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 1043705ce5bSJoe Perches If correctable single-line errors exist, create 1053705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 1063705ce5bSJoe Perches with potential errors corrected to the preferred 1073705ce5bSJoe Perches checkpatch style 1089624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 1099624b8d6SJoe Perches Is the same as --fix, but overwrites the input 1109624b8d6SJoe Perches file. It's your fault if there's no backup or git 111d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 112d62a201fSDave Hansen runtime errors. 113ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 114f1a63678SMaxim Uvarov (default:/usr/share/codespell/dictionary.txt) 115ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 11657230297SJoe Perches --color Use colors when output is STDOUT (default: on) 11777f5b10aSHannes Eder -h, --help, --version display this help and exit 11877f5b10aSHannes Eder 11977f5b10aSHannes EderWhen FILE is - read standard input. 12077f5b10aSHannes EderEOM 12177f5b10aSHannes Eder 12277f5b10aSHannes Eder exit($exitcode); 12377f5b10aSHannes Eder} 12477f5b10aSHannes Eder 1253beb42ecSJoe Perchessub uniq { 1263beb42ecSJoe Perches my %seen; 1273beb42ecSJoe Perches return grep { !$seen{$_}++ } @_; 1283beb42ecSJoe Perches} 1293beb42ecSJoe Perches 1303beb42ecSJoe Perchessub list_types { 1313beb42ecSJoe Perches my ($exitcode) = @_; 1323beb42ecSJoe Perches 1333beb42ecSJoe Perches my $count = 0; 1343beb42ecSJoe Perches 1353beb42ecSJoe Perches local $/ = undef; 1363beb42ecSJoe Perches 1373beb42ecSJoe Perches open(my $script, '<', abs_path($P)) or 1383beb42ecSJoe Perches die "$P: Can't read '$P' $!\n"; 1393beb42ecSJoe Perches 1403beb42ecSJoe Perches my $text = <$script>; 1413beb42ecSJoe Perches close($script); 1423beb42ecSJoe Perches 1433beb42ecSJoe Perches my @types = (); 1443beb42ecSJoe Perches for ($text =~ /\b(?:(?:CHK|WARN|ERROR)\s*\(\s*"([^"]+)")/g) { 1453beb42ecSJoe Perches push (@types, $_); 1463beb42ecSJoe Perches } 1473beb42ecSJoe Perches @types = sort(uniq(@types)); 1483beb42ecSJoe Perches print("#\tMessage type\n\n"); 1493beb42ecSJoe Perches foreach my $type (@types) { 1503beb42ecSJoe Perches print(++$count . "\t" . $type . "\n"); 1513beb42ecSJoe Perches } 1523beb42ecSJoe Perches 1533beb42ecSJoe Perches exit($exitcode); 1543beb42ecSJoe Perches} 1553beb42ecSJoe Perches 156000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 157000d1cc1SJoe Perchesif (-f $conf) { 158000d1cc1SJoe Perches my @conf_args; 159000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 160000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 161000d1cc1SJoe Perches 162000d1cc1SJoe Perches while (<$conffile>) { 163000d1cc1SJoe Perches my $line = $_; 164000d1cc1SJoe Perches 165000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 166000d1cc1SJoe Perches $line =~ s/^\s*//g; 167000d1cc1SJoe Perches $line =~ s/\s+/ /g; 168000d1cc1SJoe Perches 169000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 170000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 171000d1cc1SJoe Perches 172000d1cc1SJoe Perches my @words = split(" ", $line); 173000d1cc1SJoe Perches foreach my $word (@words) { 174000d1cc1SJoe Perches last if ($word =~ m/^#/); 175000d1cc1SJoe Perches push (@conf_args, $word); 176000d1cc1SJoe Perches } 177000d1cc1SJoe Perches } 178000d1cc1SJoe Perches close($conffile); 179000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 180000d1cc1SJoe Perches} 181000d1cc1SJoe Perches 1820a920b5bSAndy WhitcroftGetOptions( 1836c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1840a920b5bSAndy Whitcroft 'tree!' => \$tree, 1850a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1860a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1876c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1888905a67cSAndy Whitcroft 'terse!' => \$terse, 18934d8815fSJoe Perches 'showfile!' => \$showfile, 19077f5b10aSHannes Eder 'f|file!' => \$file, 1914a593c34SDu, Changbin 'g|git!' => \$git, 1926c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1936c72ffaaSAndy Whitcroft 'strict!' => \$check, 194000d1cc1SJoe Perches 'ignore=s' => \@ignore, 19591bfe484SJoe Perches 'types=s' => \@use, 196000d1cc1SJoe Perches 'show-types!' => \$show_types, 1973beb42ecSJoe Perches 'list-types!' => \$list_types, 1986cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 19956193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 2006c72ffaaSAndy Whitcroft 'root=s' => \$root, 2018905a67cSAndy Whitcroft 'summary!' => \$summary, 2028905a67cSAndy Whitcroft 'mailback!' => \$mailback, 20313214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 2043705ce5bSJoe Perches 'fix!' => \$fix, 2059624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 206d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 207c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 208773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 209ebfd7d62SJoe Perches 'codespell!' => \$codespell, 210ebfd7d62SJoe Perches 'codespellfile=s' => \$codespellfile, 21157230297SJoe Perches 'color!' => \$color, 21277f5b10aSHannes Eder 'h|help' => \$help, 21377f5b10aSHannes Eder 'version' => \$help 21477f5b10aSHannes Eder) or help(1); 21577f5b10aSHannes Eder 21677f5b10aSHannes Ederhelp(0) if ($help); 2170a920b5bSAndy Whitcroft 2183beb42ecSJoe Percheslist_types(0) if ($list_types); 2193beb42ecSJoe Perches 2209624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 2212ac73b4fSJoe Perches$check_orig = $check; 2229624b8d6SJoe Perches 2230a920b5bSAndy Whitcroftmy $exit = 0; 2240a920b5bSAndy Whitcroft 225d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 226d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 227d62a201fSDave Hansen if (!$ignore_perl_version) { 228d62a201fSDave Hansen exit(1); 229d62a201fSDave Hansen } 230d62a201fSDave Hansen} 231d62a201fSDave Hansen 23245107ff6SAllen Hubbe#if no filenames are given, push '-' to read patch from stdin 2330a920b5bSAndy Whitcroftif ($#ARGV < 0) { 23445107ff6SAllen Hubbe push(@ARGV, '-'); 2350a920b5bSAndy Whitcroft} 2360a920b5bSAndy Whitcroft 23791bfe484SJoe Perchessub hash_save_array_words { 23891bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 23991bfe484SJoe Perches 24091bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 24191bfe484SJoe Perches foreach my $word (@array) { 242000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 243000d1cc1SJoe Perches $word =~ s/^\s*//g; 244000d1cc1SJoe Perches $word =~ s/\s+/ /g; 245000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 246000d1cc1SJoe Perches 247000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 248000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 249000d1cc1SJoe Perches 25091bfe484SJoe Perches $hashRef->{$word}++; 251000d1cc1SJoe Perches } 25291bfe484SJoe Perches} 25391bfe484SJoe Perches 25491bfe484SJoe Perchessub hash_show_words { 25591bfe484SJoe Perches my ($hashRef, $prefix) = @_; 25691bfe484SJoe Perches 2573c816e49SJoe Perches if (keys %$hashRef) { 258d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 25958cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 26091bfe484SJoe Perches print " $word"; 26191bfe484SJoe Perches } 262d8469f16SJoe Perches print "\n"; 26391bfe484SJoe Perches } 26491bfe484SJoe Perches} 26591bfe484SJoe Perches 26691bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 26791bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 268000d1cc1SJoe Perches 269c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 270c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 2717429c690SAndy Whitcroftmy $dbg_type = 0; 272a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 273c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 27421caa13cSAndy Whitcroft ## no critic 27521caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 27621caa13cSAndy Whitcroft die "$@" if ($@); 277c2fdda0dSAndy Whitcroft} 278c2fdda0dSAndy Whitcroft 279d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 280d2c0a235SAndy Whitcroft 2818905a67cSAndy Whitcroftif ($terse) { 2828905a67cSAndy Whitcroft $emacs = 1; 2838905a67cSAndy Whitcroft $quiet++; 2848905a67cSAndy Whitcroft} 2858905a67cSAndy Whitcroft 2866c72ffaaSAndy Whitcroftif ($tree) { 2876c72ffaaSAndy Whitcroft if (defined $root) { 2886c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 2896c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 2906c72ffaaSAndy Whitcroft } 2916c72ffaaSAndy Whitcroft } else { 2926c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 2936c72ffaaSAndy Whitcroft $root = '.'; 2946c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 2956c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 2966c72ffaaSAndy Whitcroft $root = $1; 2976c72ffaaSAndy Whitcroft } 2986c72ffaaSAndy Whitcroft } 2996c72ffaaSAndy Whitcroft 3006c72ffaaSAndy Whitcroft if (!defined $root) { 3010a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 3020a920b5bSAndy Whitcroft exit(2); 3030a920b5bSAndy Whitcroft } 3046c72ffaaSAndy Whitcroft} 3056c72ffaaSAndy Whitcroft 3066c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 3076c72ffaaSAndy Whitcroft 3082ceb532bSAndy Whitcroftour $Ident = qr{ 3092ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 3102ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 3112ceb532bSAndy Whitcroft }x; 3126c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 3136c72ffaaSAndy Whitcroftour $Sparse = qr{ 3146c72ffaaSAndy Whitcroft __user| 3156c72ffaaSAndy Whitcroft __kernel| 3166c72ffaaSAndy Whitcroft __force| 3176c72ffaaSAndy Whitcroft __iomem| 3186c72ffaaSAndy Whitcroft __must_check| 3196c72ffaaSAndy Whitcroft __init_refok| 320417495edSAndy Whitcroft __kprobes| 321165e72a6SSven Eckelmann __ref| 322ad315455SBoqun Feng __rcu| 323ad315455SBoqun Feng __private 3246c72ffaaSAndy Whitcroft }x; 325e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 326e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 327e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 328e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 329e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 3308716de38SJoe Perches 33152131292SWolfram Sang# Notes to $Attribute: 33252131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 3336c72ffaaSAndy Whitcroftour $Attribute = qr{ 3346c72ffaaSAndy Whitcroft const| 33503f1df7dSJoe Perches __percpu| 33603f1df7dSJoe Perches __nocast| 33703f1df7dSJoe Perches __safe| 33803f1df7dSJoe Perches __bitwise__| 33903f1df7dSJoe Perches __packed__| 34003f1df7dSJoe Perches __packed2__| 34103f1df7dSJoe Perches __naked| 34203f1df7dSJoe Perches __maybe_unused| 34303f1df7dSJoe Perches __always_unused| 34403f1df7dSJoe Perches __noreturn| 34503f1df7dSJoe Perches __used| 34603f1df7dSJoe Perches __cold| 347e23ef1f3SJoe Perches __pure| 34803f1df7dSJoe Perches __noclone| 34903f1df7dSJoe Perches __deprecated| 3506c72ffaaSAndy Whitcroft __read_mostly| 3516c72ffaaSAndy Whitcroft __kprobes| 3528716de38SJoe Perches $InitAttribute| 35324e1d81aSAndy Whitcroft ____cacheline_aligned| 35424e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 3555fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 3565fe3af11SAndy Whitcroft __weak 3576c72ffaaSAndy Whitcroft }x; 358c45dcabdSAndy Whitcroftour $Modifier; 35991cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 3606c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 3616c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 3626c72ffaaSAndy Whitcroft 36395e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 36495e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 36595e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 36695e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 3672435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 368c0a5c898SJoe Perchesour $String = qr{"[X\t]*"}; 369326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 370326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 371326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 37274349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 3732435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 374326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 375447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 37623f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 3776c72ffaaSAndy Whitcroftour $Operators = qr{ 3786c72ffaaSAndy Whitcroft <=|>=|==|!=| 3796c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 38023f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 3816c72ffaaSAndy Whitcroft }x; 3826c72ffaaSAndy Whitcroft 38391cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 38491cb5195SJoe Perches 385ab7e23f3SJoe Perchesour $BasicType; 3868905a67cSAndy Whitcroftour $NonptrType; 3871813087dSJoe Perchesour $NonptrTypeMisordered; 3888716de38SJoe Perchesour $NonptrTypeWithAttr; 3898905a67cSAndy Whitcroftour $Type; 3901813087dSJoe Perchesour $TypeMisordered; 3918905a67cSAndy Whitcroftour $Declare; 3921813087dSJoe Perchesour $DeclareMisordered; 3938905a67cSAndy Whitcroft 39415662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 39515662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 396171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 397171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 398171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 399171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 400171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 401171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 402171ae1a4SAndy Whitcroft}x; 403171ae1a4SAndy Whitcroft 40415662b3eSJoe Perchesour $UTF8 = qr{ 40515662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 40615662b3eSJoe Perches | $NON_ASCII_UTF8 40715662b3eSJoe Perches}x; 40815662b3eSJoe Perches 409e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 410021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 411021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 412021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 413021158b4SJoe Perches)}; 414e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 415fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 4168ed22cadSAndy Whitcroft atomic_t 4178ed22cadSAndy Whitcroft)}; 418e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 419e6176fa4SJoe Perches $typeC99Typedefs\b| 420e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 421e6176fa4SJoe Perches $typeKernelTypedefs\b 422e6176fa4SJoe Perches)}; 4238ed22cadSAndy Whitcroft 4246d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 4256d32f7a3SJoe Perches 426691e669bSJoe Perchesour $logFunctions = qr{(?x: 4276e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 4287d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 4296e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 430b0531722SJoe Perches panic| 43106668727SJoe Perches MODULE_[A-Z_]+| 43206668727SJoe Perches seq_vprintf|seq_printf|seq_puts 433691e669bSJoe Perches)}; 434691e669bSJoe Perches 43520112475SJoe Perchesour $signature_tags = qr{(?xi: 43620112475SJoe Perches Signed-off-by:| 43720112475SJoe Perches Acked-by:| 43820112475SJoe Perches Tested-by:| 43920112475SJoe Perches Reviewed-by:| 44020112475SJoe Perches Reported-by:| 4418543ae12SMugunthan V N Suggested-by:| 44220112475SJoe Perches To:| 44320112475SJoe Perches Cc: 44420112475SJoe Perches)}; 44520112475SJoe Perches 4461813087dSJoe Perchesour @typeListMisordered = ( 4471813087dSJoe Perches qr{char\s+(?:un)?signed}, 4481813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 4491813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 4501813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 4511813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 4521813087dSJoe Perches qr{short\s+(?:un)?signed}, 4531813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 4541813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 4551813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 4561813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 4571813087dSJoe Perches qr{int\s+(?:un)?signed}, 4581813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 4591813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 4601813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 4611813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 4621813087dSJoe Perches qr{long\s+(?:un)?signed}, 4631813087dSJoe Perches); 4641813087dSJoe Perches 4658905a67cSAndy Whitcroftour @typeList = ( 4668905a67cSAndy Whitcroft qr{void}, 4670c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 4680c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 4690c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 4700c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 4710c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 4720c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 4730c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 4740c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 4750c773d9dSJoe Perches qr{(?:un)?signed}, 4768905a67cSAndy Whitcroft qr{float}, 4778905a67cSAndy Whitcroft qr{double}, 4788905a67cSAndy Whitcroft qr{bool}, 4798905a67cSAndy Whitcroft qr{struct\s+$Ident}, 4808905a67cSAndy Whitcroft qr{union\s+$Ident}, 4818905a67cSAndy Whitcroft qr{enum\s+$Ident}, 4828905a67cSAndy Whitcroft qr{${Ident}_t}, 4838905a67cSAndy Whitcroft qr{${Ident}_handler}, 4848905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 4851813087dSJoe Perches @typeListMisordered, 4868905a67cSAndy Whitcroft); 487938224b5SJoe Perches 488938224b5SJoe Perchesour $C90_int_types = qr{(?x: 489938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 490938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 491938224b5SJoe Perches long\s+long\s+(?:un)?signed| 492938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 493938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 494938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 495938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 496938224b5SJoe Perches 497938224b5SJoe Perches long\s+int\s+(?:un)?signed| 498938224b5SJoe Perches long\s+(?:un)?signed\s+int| 499938224b5SJoe Perches long\s+(?:un)?signed| 500938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 501938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 502938224b5SJoe Perches int\s+long\s+(?:un)?signed| 503938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 504938224b5SJoe Perches 505938224b5SJoe Perches int\s+(?:un)?signed| 506938224b5SJoe Perches (?:(?:un)?signed\s+)?int 507938224b5SJoe Perches)}; 508938224b5SJoe Perches 509485ff23eSAlex Dowadour @typeListFile = (); 5108716de38SJoe Perchesour @typeListWithAttr = ( 5118716de38SJoe Perches @typeList, 5128716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 5138716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 5148716de38SJoe Perches); 5158716de38SJoe Perches 516c45dcabdSAndy Whitcroftour @modifierList = ( 517c45dcabdSAndy Whitcroft qr{fastcall}, 518c45dcabdSAndy Whitcroft); 519485ff23eSAlex Dowadour @modifierListFile = (); 5208905a67cSAndy Whitcroft 5212435880fSJoe Perchesour @mode_permission_funcs = ( 5222435880fSJoe Perches ["module_param", 3], 5232435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 5242435880fSJoe Perches ["module_param_array_named", 5], 5252435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 5262435880fSJoe Perches ["proc_create(?:_data|)", 2], 5272435880fSJoe Perches ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2], 5282435880fSJoe Perches); 5292435880fSJoe Perches 530515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 531515a235eSJoe Perchesour $mode_perms_search = ""; 532515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 533515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 534515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 535515a235eSJoe Perches} 536515a235eSJoe Perches 537b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 538b392c64fSJoe Perches S_IWUGO | 539b392c64fSJoe Perches S_IWOTH | 540b392c64fSJoe Perches S_IRWXUGO | 541b392c64fSJoe Perches S_IALLUGO | 542b392c64fSJoe Perches 0[0-7][0-7][2367] 543b392c64fSJoe Perches}x; 544b392c64fSJoe Perches 545f90774e1SJoe Perchesour %mode_permission_string_types = ( 546f90774e1SJoe Perches "S_IRWXU" => 0700, 547f90774e1SJoe Perches "S_IRUSR" => 0400, 548f90774e1SJoe Perches "S_IWUSR" => 0200, 549f90774e1SJoe Perches "S_IXUSR" => 0100, 550f90774e1SJoe Perches "S_IRWXG" => 0070, 551f90774e1SJoe Perches "S_IRGRP" => 0040, 552f90774e1SJoe Perches "S_IWGRP" => 0020, 553f90774e1SJoe Perches "S_IXGRP" => 0010, 554f90774e1SJoe Perches "S_IRWXO" => 0007, 555f90774e1SJoe Perches "S_IROTH" => 0004, 556f90774e1SJoe Perches "S_IWOTH" => 0002, 557f90774e1SJoe Perches "S_IXOTH" => 0001, 558f90774e1SJoe Perches "S_IRWXUGO" => 0777, 559f90774e1SJoe Perches "S_IRUGO" => 0444, 560f90774e1SJoe Perches "S_IWUGO" => 0222, 561f90774e1SJoe Perches "S_IXUGO" => 0111, 562f90774e1SJoe Perches); 563f90774e1SJoe Perches 564f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below 565f90774e1SJoe Perchesour $mode_perms_string_search = ""; 566f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) { 567f90774e1SJoe Perches $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); 568f90774e1SJoe Perches $mode_perms_string_search .= $entry; 569f90774e1SJoe Perches} 570f90774e1SJoe Perches 5717840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 5727840a94cSWolfram Sang irq| 573cdcee686SSergey Ryazanov memory| 574cdcee686SSergey Ryazanov time| 575cdcee686SSergey Ryazanov reboot 5767840a94cSWolfram Sang)}; 5777840a94cSWolfram Sang# memory.h: ARM has a custom one 5787840a94cSWolfram Sang 57966b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 58066b47b4aSKees Cookmy $misspellings; 58166b47b4aSKees Cookmy %spelling_fix; 58236061e38SJoe Perches 58336061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 58466b47b4aSKees Cook while (<$spelling>) { 58566b47b4aSKees Cook my $line = $_; 58666b47b4aSKees Cook 58766b47b4aSKees Cook $line =~ s/\s*\n?$//g; 58866b47b4aSKees Cook $line =~ s/^\s*//g; 58966b47b4aSKees Cook 59066b47b4aSKees Cook next if ($line =~ m/^\s*#/); 59166b47b4aSKees Cook next if ($line =~ m/^\s*$/); 59266b47b4aSKees Cook 59366b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 59466b47b4aSKees Cook 59566b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 59666b47b4aSKees Cook } 59766b47b4aSKees Cook close($spelling); 59836061e38SJoe Perches} else { 59936061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 60036061e38SJoe Perches} 60166b47b4aSKees Cook 602ebfd7d62SJoe Perchesif ($codespell) { 603ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 604ebfd7d62SJoe Perches while (<$spelling>) { 605ebfd7d62SJoe Perches my $line = $_; 606ebfd7d62SJoe Perches 607ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 608ebfd7d62SJoe Perches $line =~ s/^\s*//g; 609ebfd7d62SJoe Perches 610ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 611ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 612ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 613ebfd7d62SJoe Perches 614ebfd7d62SJoe Perches $line =~ s/,.*$//; 615ebfd7d62SJoe Perches 616ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 617ebfd7d62SJoe Perches 618ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 619ebfd7d62SJoe Perches } 620ebfd7d62SJoe Perches close($spelling); 621ebfd7d62SJoe Perches } else { 622ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 623ebfd7d62SJoe Perches } 624ebfd7d62SJoe Perches} 625ebfd7d62SJoe Perches 626ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 627ebfd7d62SJoe Perches 628*bf1fa1daSJoe Perchesmy $const_structs = ""; 629*bf1fa1daSJoe Perchesif (open(my $conststructs, '<', $conststructsfile)) { 630*bf1fa1daSJoe Perches while (<$conststructs>) { 631*bf1fa1daSJoe Perches my $line = $_; 632*bf1fa1daSJoe Perches 633*bf1fa1daSJoe Perches $line =~ s/\s*\n?$//g; 634*bf1fa1daSJoe Perches $line =~ s/^\s*//g; 635*bf1fa1daSJoe Perches 636*bf1fa1daSJoe Perches next if ($line =~ m/^\s*#/); 637*bf1fa1daSJoe Perches next if ($line =~ m/^\s*$/); 638*bf1fa1daSJoe Perches if ($line =~ /\s/) { 639*bf1fa1daSJoe Perches print("$conststructsfile: '$line' invalid - ignored\n"); 640*bf1fa1daSJoe Perches next; 641*bf1fa1daSJoe Perches } 642*bf1fa1daSJoe Perches 643*bf1fa1daSJoe Perches $const_structs .= '|' if ($const_structs ne ""); 644*bf1fa1daSJoe Perches $const_structs .= $line; 645*bf1fa1daSJoe Perches } 646*bf1fa1daSJoe Perches close($conststructsfile); 647*bf1fa1daSJoe Perches} else { 648*bf1fa1daSJoe Perches warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 649*bf1fa1daSJoe Perches} 650*bf1fa1daSJoe Perches 6518905a67cSAndy Whitcroftsub build_types { 652485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 653485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 6541813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 6558716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 656c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 657ab7e23f3SJoe Perches $BasicType = qr{ 658ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 659ab7e23f3SJoe Perches (?:${all}\b) 660ab7e23f3SJoe Perches }x; 6618905a67cSAndy Whitcroft $NonptrType = qr{ 662d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 663cf655043SAndy Whitcroft (?: 6646b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 6658ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 666c45dcabdSAndy Whitcroft (?:${all}\b) 667cf655043SAndy Whitcroft ) 668c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 6698905a67cSAndy Whitcroft }x; 6701813087dSJoe Perches $NonptrTypeMisordered = qr{ 6711813087dSJoe Perches (?:$Modifier\s+|const\s+)* 6721813087dSJoe Perches (?: 6731813087dSJoe Perches (?:${Misordered}\b) 6741813087dSJoe Perches ) 6751813087dSJoe Perches (?:\s+$Modifier|\s+const)* 6761813087dSJoe Perches }x; 6778716de38SJoe Perches $NonptrTypeWithAttr = qr{ 6788716de38SJoe Perches (?:$Modifier\s+|const\s+)* 6798716de38SJoe Perches (?: 6808716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 6818716de38SJoe Perches (?:$typeTypedefs\b)| 6828716de38SJoe Perches (?:${allWithAttr}\b) 6838716de38SJoe Perches ) 6848716de38SJoe Perches (?:\s+$Modifier|\s+const)* 6858716de38SJoe Perches }x; 6868905a67cSAndy Whitcroft $Type = qr{ 687c45dcabdSAndy Whitcroft $NonptrType 6881574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 689c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 6908905a67cSAndy Whitcroft }x; 6911813087dSJoe Perches $TypeMisordered = qr{ 6921813087dSJoe Perches $NonptrTypeMisordered 6931813087dSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 6941813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 6951813087dSJoe Perches }x; 69691cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 6971813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 6988905a67cSAndy Whitcroft} 6998905a67cSAndy Whitcroftbuild_types(); 7006c72ffaaSAndy Whitcroft 7017d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 702d1fe9c09SJoe Perches 703d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 704d1fe9c09SJoe Perches# requires at least perl version v5.10.0 705d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 706d1fe9c09SJoe Perches 707d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 7082435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 709c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 7107d2367afSJoe Perches 711f8422308SJoe Perchesour $declaration_macros = qr{(?x: 7123e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 713f8422308SJoe Perches (?:$Storage\s+)?LIST_HEAD\s*\(| 714f8422308SJoe Perches (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\( 715f8422308SJoe Perches)}; 716f8422308SJoe Perches 7177d2367afSJoe Perchessub deparenthesize { 7187d2367afSJoe Perches my ($string) = @_; 7197d2367afSJoe Perches return "" if (!defined($string)); 7205b9553abSJoe Perches 7215b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 7225b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 7235b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 7245b9553abSJoe Perches } 7255b9553abSJoe Perches 7267d2367afSJoe Perches $string =~ s@\s+@ @g; 7275b9553abSJoe Perches 7287d2367afSJoe Perches return $string; 7297d2367afSJoe Perches} 7307d2367afSJoe Perches 7313445686aSJoe Perchessub seed_camelcase_file { 7323445686aSJoe Perches my ($file) = @_; 7333445686aSJoe Perches 7343445686aSJoe Perches return if (!(-f $file)); 7353445686aSJoe Perches 7363445686aSJoe Perches local $/; 7373445686aSJoe Perches 7383445686aSJoe Perches open(my $include_file, '<', "$file") 7393445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 7403445686aSJoe Perches my $text = <$include_file>; 7413445686aSJoe Perches close($include_file); 7423445686aSJoe Perches 7433445686aSJoe Perches my @lines = split('\n', $text); 7443445686aSJoe Perches 7453445686aSJoe Perches foreach my $line (@lines) { 7463445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 7473445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 7483445686aSJoe Perches $camelcase{$1} = 1; 74911ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 75011ea516aSJoe Perches $camelcase{$1} = 1; 75111ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 7523445686aSJoe Perches $camelcase{$1} = 1; 7533445686aSJoe Perches } 7543445686aSJoe Perches } 7553445686aSJoe Perches} 7563445686aSJoe Perches 75785b0ee18SJoe Perchessub is_maintained_obsolete { 75885b0ee18SJoe Perches my ($filename) = @_; 75985b0ee18SJoe Perches 76085b0ee18SJoe Perches return 0 if (!(-e "$root/scripts/get_maintainer.pl")); 76185b0ee18SJoe Perches 76285b0ee18SJoe Perches my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback $filename 2>&1`; 76385b0ee18SJoe Perches 76485b0ee18SJoe Perches return $status =~ /obsolete/i; 76585b0ee18SJoe Perches} 76685b0ee18SJoe Perches 7673445686aSJoe Perchesmy $camelcase_seeded = 0; 7683445686aSJoe Perchessub seed_camelcase_includes { 7693445686aSJoe Perches return if ($camelcase_seeded); 7703445686aSJoe Perches 7713445686aSJoe Perches my $files; 772c707a81dSJoe Perches my $camelcase_cache = ""; 773c707a81dSJoe Perches my @include_files = (); 774c707a81dSJoe Perches 775c707a81dSJoe Perches $camelcase_seeded = 1; 776351b2a1fSJoe Perches 7773645e328SRichard Genoud if (-e ".git") { 778351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 779351b2a1fSJoe Perches chomp $git_last_include_commit; 780c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 781c707a81dSJoe Perches } else { 782c707a81dSJoe Perches my $last_mod_date = 0; 783c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 784c707a81dSJoe Perches @include_files = split('\n', $files); 785c707a81dSJoe Perches foreach my $file (@include_files) { 786c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 787c707a81dSJoe Perches localtime((stat $file)[9])); 788c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 789c707a81dSJoe Perches } 790c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 791c707a81dSJoe Perches } 792c707a81dSJoe Perches 793c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 794c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 795c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 796351b2a1fSJoe Perches while (<$camelcase_file>) { 797351b2a1fSJoe Perches chomp; 798351b2a1fSJoe Perches $camelcase{$_} = 1; 799351b2a1fSJoe Perches } 800351b2a1fSJoe Perches close($camelcase_file); 801351b2a1fSJoe Perches 802351b2a1fSJoe Perches return; 803351b2a1fSJoe Perches } 804c707a81dSJoe Perches 8053645e328SRichard Genoud if (-e ".git") { 806c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 807c707a81dSJoe Perches @include_files = split('\n', $files); 8083445686aSJoe Perches } 809c707a81dSJoe Perches 8103445686aSJoe Perches foreach my $file (@include_files) { 8113445686aSJoe Perches seed_camelcase_file($file); 8123445686aSJoe Perches } 813351b2a1fSJoe Perches 814c707a81dSJoe Perches if ($camelcase_cache ne "") { 815351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 816c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 817c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 818351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 819351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 820351b2a1fSJoe Perches } 821351b2a1fSJoe Perches close($camelcase_file); 822351b2a1fSJoe Perches } 8233445686aSJoe Perches} 8243445686aSJoe Perches 825d311cd44SJoe Perchessub git_commit_info { 826d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 827d311cd44SJoe Perches 828d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 829d311cd44SJoe Perches 830d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 831d311cd44SJoe Perches $output =~ s/^\s*//gm; 832d311cd44SJoe Perches my @lines = split("\n", $output); 833d311cd44SJoe Perches 8340d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 8350d7835fcSJoe Perches 836d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 837d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 838d311cd44SJoe Perches# all matching commit ids, but it's very slow... 839d311cd44SJoe Perches# 840d311cd44SJoe Perches# echo "checking commits $1..." 841d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 842d311cd44SJoe Perches# while read line ; do 843d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 844d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 845d311cd44SJoe Perches# done 846d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 847d311cd44SJoe Perches } else { 848d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 849d311cd44SJoe Perches $desc = substr($lines[0], 41); 850d311cd44SJoe Perches } 851d311cd44SJoe Perches 852d311cd44SJoe Perches return ($id, $desc); 853d311cd44SJoe Perches} 854d311cd44SJoe Perches 8556c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 8560a920b5bSAndy Whitcroft 85700df344fSAndy Whitcroftmy @rawlines = (); 858c2fdda0dSAndy Whitcroftmy @lines = (); 8593705ce5bSJoe Perchesmy @fixed = (); 860d752fcc8SJoe Perchesmy @fixed_inserted = (); 861d752fcc8SJoe Perchesmy @fixed_deleted = (); 862194f66fcSJoe Perchesmy $fixlinenr = -1; 863194f66fcSJoe Perches 8644a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions. 8654a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 8664a593c34SDu, Changbindie "$P: No git repository found\n" if ($git && !-e ".git"); 8674a593c34SDu, Changbin 8684a593c34SDu, Changbinif ($git) { 8694a593c34SDu, Changbin my @commits = (); 8700dea9f1eSJoe Perches foreach my $commit_expr (@ARGV) { 8714a593c34SDu, Changbin my $git_range; 87228898fd1SJoe Perches if ($commit_expr =~ m/^(.*)-(\d+)$/) { 87328898fd1SJoe Perches $git_range = "-$2 $1"; 8744a593c34SDu, Changbin } elsif ($commit_expr =~ m/\.\./) { 8754a593c34SDu, Changbin $git_range = "$commit_expr"; 8764a593c34SDu, Changbin } else { 8770dea9f1eSJoe Perches $git_range = "-1 $commit_expr"; 8780dea9f1eSJoe Perches } 8790dea9f1eSJoe Perches my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 8800dea9f1eSJoe Perches foreach my $line (split(/\n/, $lines)) { 88128898fd1SJoe Perches $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 88228898fd1SJoe Perches next if (!defined($1) || !defined($2)); 8830dea9f1eSJoe Perches my $sha1 = $1; 8840dea9f1eSJoe Perches my $subject = $2; 8850dea9f1eSJoe Perches unshift(@commits, $sha1); 8860dea9f1eSJoe Perches $git_commits{$sha1} = $subject; 8874a593c34SDu, Changbin } 8884a593c34SDu, Changbin } 8894a593c34SDu, Changbin die "$P: no git commits after extraction!\n" if (@commits == 0); 8904a593c34SDu, Changbin @ARGV = @commits; 8914a593c34SDu, Changbin} 8924a593c34SDu, Changbin 893c2fdda0dSAndy Whitcroftmy $vname; 8946c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 89521caa13cSAndy Whitcroft my $FILE; 8964a593c34SDu, Changbin if ($git) { 8974a593c34SDu, Changbin open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 8984a593c34SDu, Changbin die "$P: $filename: git format-patch failed - $!\n"; 8994a593c34SDu, Changbin } elsif ($file) { 90021caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 9016c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 90221caa13cSAndy Whitcroft } elsif ($filename eq '-') { 90321caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 9046c72ffaaSAndy Whitcroft } else { 90521caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 9066c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 9076c72ffaaSAndy Whitcroft } 908c2fdda0dSAndy Whitcroft if ($filename eq '-') { 909c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 9104a593c34SDu, Changbin } elsif ($git) { 9110dea9f1eSJoe Perches $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 912c2fdda0dSAndy Whitcroft } else { 913c2fdda0dSAndy Whitcroft $vname = $filename; 914c2fdda0dSAndy Whitcroft } 91521caa13cSAndy Whitcroft while (<$FILE>) { 9160a920b5bSAndy Whitcroft chomp; 91700df344fSAndy Whitcroft push(@rawlines, $_); 9186c72ffaaSAndy Whitcroft } 91921caa13cSAndy Whitcroft close($FILE); 920d8469f16SJoe Perches 921d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 922d8469f16SJoe Perches print '-' x length($vname) . "\n"; 923d8469f16SJoe Perches print "$vname\n"; 924d8469f16SJoe Perches print '-' x length($vname) . "\n"; 925d8469f16SJoe Perches } 926d8469f16SJoe Perches 927c2fdda0dSAndy Whitcroft if (!process($filename)) { 9280a920b5bSAndy Whitcroft $exit = 1; 9290a920b5bSAndy Whitcroft } 93000df344fSAndy Whitcroft @rawlines = (); 93113214adfSAndy Whitcroft @lines = (); 9323705ce5bSJoe Perches @fixed = (); 933d752fcc8SJoe Perches @fixed_inserted = (); 934d752fcc8SJoe Perches @fixed_deleted = (); 935194f66fcSJoe Perches $fixlinenr = -1; 936485ff23eSAlex Dowad @modifierListFile = (); 937485ff23eSAlex Dowad @typeListFile = (); 938485ff23eSAlex Dowad build_types(); 9390a920b5bSAndy Whitcroft} 9400a920b5bSAndy Whitcroft 941d8469f16SJoe Perchesif (!$quiet) { 9423c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 9433c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 9443c816e49SJoe Perches 945d8469f16SJoe Perches if ($^V lt 5.10.0) { 946d8469f16SJoe Perches print << "EOM" 947d8469f16SJoe Perches 948d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 949d8469f16SJoe Perches An upgrade to at least perl v5.10.0 is suggested. 950d8469f16SJoe PerchesEOM 951d8469f16SJoe Perches } 952d8469f16SJoe Perches if ($exit) { 953d8469f16SJoe Perches print << "EOM" 954d8469f16SJoe Perches 955d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 956d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 957d8469f16SJoe PerchesEOM 958d8469f16SJoe Perches } 959d8469f16SJoe Perches} 960d8469f16SJoe Perches 9610a920b5bSAndy Whitcroftexit($exit); 9620a920b5bSAndy Whitcroft 9630a920b5bSAndy Whitcroftsub top_of_kernel_tree { 9646c72ffaaSAndy Whitcroft my ($root) = @_; 9656c72ffaaSAndy Whitcroft 9666c72ffaaSAndy Whitcroft my @tree_check = ( 9676c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 9686c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 9696c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 9706c72ffaaSAndy Whitcroft ); 9716c72ffaaSAndy Whitcroft 9726c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 9736c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 9740a920b5bSAndy Whitcroft return 0; 9750a920b5bSAndy Whitcroft } 9766c72ffaaSAndy Whitcroft } 9776c72ffaaSAndy Whitcroft return 1; 9786c72ffaaSAndy Whitcroft} 9790a920b5bSAndy Whitcroft 98020112475SJoe Perchessub parse_email { 98120112475SJoe Perches my ($formatted_email) = @_; 98220112475SJoe Perches 98320112475SJoe Perches my $name = ""; 98420112475SJoe Perches my $address = ""; 98520112475SJoe Perches my $comment = ""; 98620112475SJoe Perches 98720112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 98820112475SJoe Perches $name = $1; 98920112475SJoe Perches $address = $2; 99020112475SJoe Perches $comment = $3 if defined $3; 99120112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 99220112475SJoe Perches $address = $1; 99320112475SJoe Perches $comment = $2 if defined $2; 99420112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 99520112475SJoe Perches $address = $1; 99620112475SJoe Perches $comment = $2 if defined $2; 99720112475SJoe Perches $formatted_email =~ s/$address.*$//; 99820112475SJoe Perches $name = $formatted_email; 9993705ce5bSJoe Perches $name = trim($name); 100020112475SJoe Perches $name =~ s/^\"|\"$//g; 100120112475SJoe Perches # If there's a name left after stripping spaces and 100220112475SJoe Perches # leading quotes, and the address doesn't have both 100320112475SJoe Perches # leading and trailing angle brackets, the address 100420112475SJoe Perches # is invalid. ie: 100520112475SJoe Perches # "joe smith [email protected]" bad 100620112475SJoe Perches # "joe smith <[email protected]" bad 100720112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 100820112475SJoe Perches $name = ""; 100920112475SJoe Perches $address = ""; 101020112475SJoe Perches $comment = ""; 101120112475SJoe Perches } 101220112475SJoe Perches } 101320112475SJoe Perches 10143705ce5bSJoe Perches $name = trim($name); 101520112475SJoe Perches $name =~ s/^\"|\"$//g; 10163705ce5bSJoe Perches $address = trim($address); 101720112475SJoe Perches $address =~ s/^\<|\>$//g; 101820112475SJoe Perches 101920112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 102020112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 102120112475SJoe Perches $name = "\"$name\""; 102220112475SJoe Perches } 102320112475SJoe Perches 102420112475SJoe Perches return ($name, $address, $comment); 102520112475SJoe Perches} 102620112475SJoe Perches 102720112475SJoe Perchessub format_email { 102820112475SJoe Perches my ($name, $address) = @_; 102920112475SJoe Perches 103020112475SJoe Perches my $formatted_email; 103120112475SJoe Perches 10323705ce5bSJoe Perches $name = trim($name); 103320112475SJoe Perches $name =~ s/^\"|\"$//g; 10343705ce5bSJoe Perches $address = trim($address); 103520112475SJoe Perches 103620112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 103720112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 103820112475SJoe Perches $name = "\"$name\""; 103920112475SJoe Perches } 104020112475SJoe Perches 104120112475SJoe Perches if ("$name" eq "") { 104220112475SJoe Perches $formatted_email = "$address"; 104320112475SJoe Perches } else { 104420112475SJoe Perches $formatted_email = "$name <$address>"; 104520112475SJoe Perches } 104620112475SJoe Perches 104720112475SJoe Perches return $formatted_email; 104820112475SJoe Perches} 104920112475SJoe Perches 1050d311cd44SJoe Perchessub which { 1051d311cd44SJoe Perches my ($bin) = @_; 1052d311cd44SJoe Perches 1053d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 1054d311cd44SJoe Perches if (-e "$path/$bin") { 1055d311cd44SJoe Perches return "$path/$bin"; 1056d311cd44SJoe Perches } 1057d311cd44SJoe Perches } 1058d311cd44SJoe Perches 1059d311cd44SJoe Perches return ""; 1060d311cd44SJoe Perches} 1061d311cd44SJoe Perches 1062000d1cc1SJoe Perchessub which_conf { 1063000d1cc1SJoe Perches my ($conf) = @_; 1064000d1cc1SJoe Perches 1065000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1066000d1cc1SJoe Perches if (-e "$path/$conf") { 1067000d1cc1SJoe Perches return "$path/$conf"; 1068000d1cc1SJoe Perches } 1069000d1cc1SJoe Perches } 1070000d1cc1SJoe Perches 1071000d1cc1SJoe Perches return ""; 1072000d1cc1SJoe Perches} 1073000d1cc1SJoe Perches 10740a920b5bSAndy Whitcroftsub expand_tabs { 10750a920b5bSAndy Whitcroft my ($str) = @_; 10760a920b5bSAndy Whitcroft 10770a920b5bSAndy Whitcroft my $res = ''; 10780a920b5bSAndy Whitcroft my $n = 0; 10790a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 10800a920b5bSAndy Whitcroft if ($c eq "\t") { 10810a920b5bSAndy Whitcroft $res .= ' '; 10820a920b5bSAndy Whitcroft $n++; 10830a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 10840a920b5bSAndy Whitcroft $res .= ' '; 10850a920b5bSAndy Whitcroft } 10860a920b5bSAndy Whitcroft next; 10870a920b5bSAndy Whitcroft } 10880a920b5bSAndy Whitcroft $res .= $c; 10890a920b5bSAndy Whitcroft $n++; 10900a920b5bSAndy Whitcroft } 10910a920b5bSAndy Whitcroft 10920a920b5bSAndy Whitcroft return $res; 10930a920b5bSAndy Whitcroft} 10946c72ffaaSAndy Whitcroftsub copy_spacing { 1095773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 10966c72ffaaSAndy Whitcroft return $res; 10976c72ffaaSAndy Whitcroft} 10980a920b5bSAndy Whitcroft 10994a0df2efSAndy Whitcroftsub line_stats { 11004a0df2efSAndy Whitcroft my ($line) = @_; 11014a0df2efSAndy Whitcroft 11024a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 11034a0df2efSAndy Whitcroft $line =~ s/^.//; 11044a0df2efSAndy Whitcroft $line = expand_tabs($line); 11054a0df2efSAndy Whitcroft 11064a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 11074a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 11084a0df2efSAndy Whitcroft 11094a0df2efSAndy Whitcroft return (length($line), length($white)); 11104a0df2efSAndy Whitcroft} 11114a0df2efSAndy Whitcroft 1112773647a0SAndy Whitcroftmy $sanitise_quote = ''; 1113773647a0SAndy Whitcroft 1114773647a0SAndy Whitcroftsub sanitise_line_reset { 1115773647a0SAndy Whitcroft my ($in_comment) = @_; 1116773647a0SAndy Whitcroft 1117773647a0SAndy Whitcroft if ($in_comment) { 1118773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1119773647a0SAndy Whitcroft } else { 1120773647a0SAndy Whitcroft $sanitise_quote = ''; 1121773647a0SAndy Whitcroft } 1122773647a0SAndy Whitcroft} 112300df344fSAndy Whitcroftsub sanitise_line { 112400df344fSAndy Whitcroft my ($line) = @_; 112500df344fSAndy Whitcroft 112600df344fSAndy Whitcroft my $res = ''; 112700df344fSAndy Whitcroft my $l = ''; 112800df344fSAndy Whitcroft 1129c2fdda0dSAndy Whitcroft my $qlen = 0; 1130773647a0SAndy Whitcroft my $off = 0; 1131773647a0SAndy Whitcroft my $c; 113200df344fSAndy Whitcroft 1133773647a0SAndy Whitcroft # Always copy over the diff marker. 1134773647a0SAndy Whitcroft $res = substr($line, 0, 1); 1135773647a0SAndy Whitcroft 1136773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 1137773647a0SAndy Whitcroft $c = substr($line, $off, 1); 1138773647a0SAndy Whitcroft 1139773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 1140773647a0SAndy Whitcroft # and end, all to $;. 1141773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1142773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1143773647a0SAndy Whitcroft 1144773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1145773647a0SAndy Whitcroft $off++; 114600df344fSAndy Whitcroft next; 1147773647a0SAndy Whitcroft } 114881bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1149773647a0SAndy Whitcroft $sanitise_quote = ''; 1150773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1151773647a0SAndy Whitcroft $off++; 1152773647a0SAndy Whitcroft next; 1153773647a0SAndy Whitcroft } 1154113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1155113f04a8SDaniel Walker $sanitise_quote = '//'; 1156113f04a8SDaniel Walker 1157113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1158113f04a8SDaniel Walker $off++; 1159113f04a8SDaniel Walker next; 1160113f04a8SDaniel Walker } 1161773647a0SAndy Whitcroft 1162773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1163773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1164773647a0SAndy Whitcroft $c eq "\\") { 1165773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1166773647a0SAndy Whitcroft $off++; 1167773647a0SAndy Whitcroft next; 1168773647a0SAndy Whitcroft } 1169773647a0SAndy Whitcroft # Regular quotes. 1170773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1171773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1172773647a0SAndy Whitcroft $sanitise_quote = $c; 1173773647a0SAndy Whitcroft 1174773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1175773647a0SAndy Whitcroft next; 1176773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1177773647a0SAndy Whitcroft $sanitise_quote = ''; 117800df344fSAndy Whitcroft } 117900df344fSAndy Whitcroft } 1180773647a0SAndy Whitcroft 1181fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1182773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1183773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1184113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1185113f04a8SDaniel Walker substr($res, $off, 1, $;); 1186773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1187773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 118800df344fSAndy Whitcroft } else { 1189773647a0SAndy Whitcroft substr($res, $off, 1, $c); 119000df344fSAndy Whitcroft } 1191c2fdda0dSAndy Whitcroft } 1192c2fdda0dSAndy Whitcroft 1193113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1194113f04a8SDaniel Walker $sanitise_quote = ''; 1195113f04a8SDaniel Walker } 1196113f04a8SDaniel Walker 1197c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1198c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1199c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1200c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1201c2fdda0dSAndy Whitcroft 1202c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1203c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1204c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1205c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1206c2fdda0dSAndy Whitcroft } 1207c2fdda0dSAndy Whitcroft 1208dadf680dSJoe Perches if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1209dadf680dSJoe Perches my $match = $1; 1210dadf680dSJoe Perches $res =~ s/\Q$match\E/"$;" x length($match)/e; 1211dadf680dSJoe Perches } 1212dadf680dSJoe Perches 121300df344fSAndy Whitcroft return $res; 121400df344fSAndy Whitcroft} 121500df344fSAndy Whitcroft 1216a6962d72SJoe Perchessub get_quoted_string { 1217a6962d72SJoe Perches my ($line, $rawline) = @_; 1218a6962d72SJoe Perches 121933acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1220a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1221a6962d72SJoe Perches} 1222a6962d72SJoe Perches 12238905a67cSAndy Whitcroftsub ctx_statement_block { 12248905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 12258905a67cSAndy Whitcroft my $line = $linenr - 1; 12268905a67cSAndy Whitcroft my $blk = ''; 12278905a67cSAndy Whitcroft my $soff = $off; 12288905a67cSAndy Whitcroft my $coff = $off - 1; 1229773647a0SAndy Whitcroft my $coff_set = 0; 12308905a67cSAndy Whitcroft 123113214adfSAndy Whitcroft my $loff = 0; 123213214adfSAndy Whitcroft 12338905a67cSAndy Whitcroft my $type = ''; 12348905a67cSAndy Whitcroft my $level = 0; 1235a2750645SAndy Whitcroft my @stack = (); 1236cf655043SAndy Whitcroft my $p; 12378905a67cSAndy Whitcroft my $c; 12388905a67cSAndy Whitcroft my $len = 0; 123913214adfSAndy Whitcroft 124013214adfSAndy Whitcroft my $remainder; 12418905a67cSAndy Whitcroft while (1) { 1242a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1243a2750645SAndy Whitcroft 1244773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 12458905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 12468905a67cSAndy Whitcroft # context. 12478905a67cSAndy Whitcroft if ($off >= $len) { 12488905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1249dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1250c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 12518905a67cSAndy Whitcroft $remain--; 125213214adfSAndy Whitcroft $loff = $len; 1253c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 12548905a67cSAndy Whitcroft $len = length($blk); 12558905a67cSAndy Whitcroft $line++; 12568905a67cSAndy Whitcroft last; 12578905a67cSAndy Whitcroft } 12588905a67cSAndy Whitcroft # Bail if there is no further context. 12598905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 126013214adfSAndy Whitcroft if ($off >= $len) { 12618905a67cSAndy Whitcroft last; 12628905a67cSAndy Whitcroft } 1263f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1264f74bd194SAndy Whitcroft $level++; 1265f74bd194SAndy Whitcroft $type = '#'; 1266f74bd194SAndy Whitcroft } 12678905a67cSAndy Whitcroft } 1268cf655043SAndy Whitcroft $p = $c; 12698905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 127013214adfSAndy Whitcroft $remainder = substr($blk, $off); 12718905a67cSAndy Whitcroft 1272773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 12734635f4fbSAndy Whitcroft 12744635f4fbSAndy Whitcroft # Handle nested #if/#else. 12754635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 12764635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 12774635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 12784635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 12794635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 12804635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 12814635f4fbSAndy Whitcroft } 12824635f4fbSAndy Whitcroft 12838905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 12848905a67cSAndy Whitcroft # outermost level. 12858905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 12868905a67cSAndy Whitcroft last; 12878905a67cSAndy Whitcroft } 12888905a67cSAndy Whitcroft 128913214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1290773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1291773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1292773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1293773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1294773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1295773647a0SAndy Whitcroft $coff_set = 1; 1296773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1297773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 129813214adfSAndy Whitcroft } 129913214adfSAndy Whitcroft 13008905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 13018905a67cSAndy Whitcroft $level++; 13028905a67cSAndy Whitcroft $type = '('; 13038905a67cSAndy Whitcroft } 13048905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 13058905a67cSAndy Whitcroft $level--; 13068905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 13078905a67cSAndy Whitcroft 13088905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 13098905a67cSAndy Whitcroft $coff = $off; 1310773647a0SAndy Whitcroft $coff_set = 1; 1311773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 13128905a67cSAndy Whitcroft } 13138905a67cSAndy Whitcroft } 13148905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 13158905a67cSAndy Whitcroft $level++; 13168905a67cSAndy Whitcroft $type = '{'; 13178905a67cSAndy Whitcroft } 13188905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 13198905a67cSAndy Whitcroft $level--; 13208905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 13218905a67cSAndy Whitcroft 13228905a67cSAndy Whitcroft if ($level == 0) { 1323b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1324b998e001SPatrick Pannuto $off++; 1325b998e001SPatrick Pannuto } 13268905a67cSAndy Whitcroft last; 13278905a67cSAndy Whitcroft } 13288905a67cSAndy Whitcroft } 1329f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1330f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1331f74bd194SAndy Whitcroft $level--; 1332f74bd194SAndy Whitcroft $type = ''; 1333f74bd194SAndy Whitcroft $off++; 1334f74bd194SAndy Whitcroft last; 1335f74bd194SAndy Whitcroft } 13368905a67cSAndy Whitcroft $off++; 13378905a67cSAndy Whitcroft } 1338a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 133913214adfSAndy Whitcroft if ($off == $len) { 1340a3bb97a7SAndy Whitcroft $loff = $len + 1; 134113214adfSAndy Whitcroft $line++; 134213214adfSAndy Whitcroft $remain--; 134313214adfSAndy Whitcroft } 13448905a67cSAndy Whitcroft 13458905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 13468905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 13478905a67cSAndy Whitcroft 13488905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 13498905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 13508905a67cSAndy Whitcroft 1351773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 135213214adfSAndy Whitcroft 135313214adfSAndy Whitcroft return ($statement, $condition, 135413214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 135513214adfSAndy Whitcroft} 135613214adfSAndy Whitcroft 1357cf655043SAndy Whitcroftsub statement_lines { 1358cf655043SAndy Whitcroft my ($stmt) = @_; 1359cf655043SAndy Whitcroft 1360cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1361cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1362cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1363cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1364cf655043SAndy Whitcroft 1365cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1366cf655043SAndy Whitcroft 1367cf655043SAndy Whitcroft return $#stmt_lines + 2; 1368cf655043SAndy Whitcroft} 1369cf655043SAndy Whitcroft 1370cf655043SAndy Whitcroftsub statement_rawlines { 1371cf655043SAndy Whitcroft my ($stmt) = @_; 1372cf655043SAndy Whitcroft 1373cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1374cf655043SAndy Whitcroft 1375cf655043SAndy Whitcroft return $#stmt_lines + 2; 1376cf655043SAndy Whitcroft} 1377cf655043SAndy Whitcroft 1378cf655043SAndy Whitcroftsub statement_block_size { 1379cf655043SAndy Whitcroft my ($stmt) = @_; 1380cf655043SAndy Whitcroft 1381cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1382cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1383cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1384cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1385cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1386cf655043SAndy Whitcroft 1387cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1388cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1389cf655043SAndy Whitcroft 1390cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1391cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1392cf655043SAndy Whitcroft 1393cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1394cf655043SAndy Whitcroft return $stmt_lines; 1395cf655043SAndy Whitcroft } else { 1396cf655043SAndy Whitcroft return $stmt_statements; 1397cf655043SAndy Whitcroft } 1398cf655043SAndy Whitcroft} 1399cf655043SAndy Whitcroft 140013214adfSAndy Whitcroftsub ctx_statement_full { 140113214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 140213214adfSAndy Whitcroft my ($statement, $condition, $level); 140313214adfSAndy Whitcroft 140413214adfSAndy Whitcroft my (@chunks); 140513214adfSAndy Whitcroft 1406cf655043SAndy Whitcroft # Grab the first conditional/block pair. 140713214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 140813214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1409773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 141013214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1411cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1412cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1413cf655043SAndy Whitcroft } 1414cf655043SAndy Whitcroft 1415cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1416cf655043SAndy Whitcroft # could continue the statement. 1417cf655043SAndy Whitcroft for (;;) { 141813214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 141913214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1420cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1421773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1422cf655043SAndy Whitcroft #print "C: push\n"; 1423cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 142413214adfSAndy Whitcroft } 142513214adfSAndy Whitcroft 142613214adfSAndy Whitcroft return ($level, $linenr, @chunks); 14278905a67cSAndy Whitcroft} 14288905a67cSAndy Whitcroft 14294a0df2efSAndy Whitcroftsub ctx_block_get { 1430f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 14314a0df2efSAndy Whitcroft my $line; 14324a0df2efSAndy Whitcroft my $start = $linenr - 1; 14334a0df2efSAndy Whitcroft my $blk = ''; 14344a0df2efSAndy Whitcroft my @o; 14354a0df2efSAndy Whitcroft my @c; 14364a0df2efSAndy Whitcroft my @res = (); 14374a0df2efSAndy Whitcroft 1438f0a594c1SAndy Whitcroft my $level = 0; 14394635f4fbSAndy Whitcroft my @stack = ($level); 144000df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 144100df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 144200df344fSAndy Whitcroft $remain--; 144300df344fSAndy Whitcroft 144400df344fSAndy Whitcroft $blk .= $rawlines[$line]; 14454635f4fbSAndy Whitcroft 14464635f4fbSAndy Whitcroft # Handle nested #if/#else. 144701464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 14484635f4fbSAndy Whitcroft push(@stack, $level); 144901464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 14504635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 145101464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 14524635f4fbSAndy Whitcroft $level = pop(@stack); 14534635f4fbSAndy Whitcroft } 14544635f4fbSAndy Whitcroft 145501464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1456f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1457f0a594c1SAndy Whitcroft if ($off > 0) { 1458f0a594c1SAndy Whitcroft $off--; 1459f0a594c1SAndy Whitcroft next; 1460f0a594c1SAndy Whitcroft } 14614a0df2efSAndy Whitcroft 1462f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1463f0a594c1SAndy Whitcroft $level--; 1464f0a594c1SAndy Whitcroft last if ($level == 0); 1465f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1466f0a594c1SAndy Whitcroft $level++; 1467f0a594c1SAndy Whitcroft } 1468f0a594c1SAndy Whitcroft } 14694a0df2efSAndy Whitcroft 1470f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 147100df344fSAndy Whitcroft push(@res, $rawlines[$line]); 14724a0df2efSAndy Whitcroft } 14734a0df2efSAndy Whitcroft 1474f0a594c1SAndy Whitcroft last if ($level == 0); 14754a0df2efSAndy Whitcroft } 14764a0df2efSAndy Whitcroft 1477f0a594c1SAndy Whitcroft return ($level, @res); 14784a0df2efSAndy Whitcroft} 14794a0df2efSAndy Whitcroftsub ctx_block_outer { 14804a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 14814a0df2efSAndy Whitcroft 1482f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1483f0a594c1SAndy Whitcroft return @r; 14844a0df2efSAndy Whitcroft} 14854a0df2efSAndy Whitcroftsub ctx_block { 14864a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 14874a0df2efSAndy Whitcroft 1488f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1489f0a594c1SAndy Whitcroft return @r; 1490653d4876SAndy Whitcroft} 1491653d4876SAndy Whitcroftsub ctx_statement { 1492f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1493f0a594c1SAndy Whitcroft 1494f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1495f0a594c1SAndy Whitcroft return @r; 1496f0a594c1SAndy Whitcroft} 1497f0a594c1SAndy Whitcroftsub ctx_block_level { 1498653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1499653d4876SAndy Whitcroft 1500f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 15014a0df2efSAndy Whitcroft} 15029c0ca6f9SAndy Whitcroftsub ctx_statement_level { 15039c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 15049c0ca6f9SAndy Whitcroft 15059c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 15069c0ca6f9SAndy Whitcroft} 15074a0df2efSAndy Whitcroft 15084a0df2efSAndy Whitcroftsub ctx_locate_comment { 15094a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 15104a0df2efSAndy Whitcroft 15114a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1512beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 15134a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 15144a0df2efSAndy Whitcroft 15154a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 15164a0df2efSAndy Whitcroft # comment. 15174a0df2efSAndy Whitcroft my $in_comment = 0; 15184a0df2efSAndy Whitcroft $current_comment = ''; 15194a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 152000df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 152100df344fSAndy Whitcroft #warn " $line\n"; 15224a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 15234a0df2efSAndy Whitcroft $in_comment = 1; 15244a0df2efSAndy Whitcroft } 15254a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 15264a0df2efSAndy Whitcroft $in_comment = 1; 15274a0df2efSAndy Whitcroft } 15284a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 15294a0df2efSAndy Whitcroft $current_comment = ''; 15304a0df2efSAndy Whitcroft } 15314a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 15324a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 15334a0df2efSAndy Whitcroft $in_comment = 0; 15344a0df2efSAndy Whitcroft } 15354a0df2efSAndy Whitcroft } 15364a0df2efSAndy Whitcroft 15374a0df2efSAndy Whitcroft chomp($current_comment); 15384a0df2efSAndy Whitcroft return($current_comment); 15394a0df2efSAndy Whitcroft} 15404a0df2efSAndy Whitcroftsub ctx_has_comment { 15414a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 15424a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 15434a0df2efSAndy Whitcroft 154400df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 15454a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 15464a0df2efSAndy Whitcroft 15474a0df2efSAndy Whitcroft return ($cmt ne ''); 15484a0df2efSAndy Whitcroft} 15494a0df2efSAndy Whitcroft 15504d001e4dSAndy Whitcroftsub raw_line { 15514d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 15524d001e4dSAndy Whitcroft 15534d001e4dSAndy Whitcroft my $offset = $linenr - 1; 15544d001e4dSAndy Whitcroft $cnt++; 15554d001e4dSAndy Whitcroft 15564d001e4dSAndy Whitcroft my $line; 15574d001e4dSAndy Whitcroft while ($cnt) { 15584d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 15594d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 15604d001e4dSAndy Whitcroft $cnt--; 15614d001e4dSAndy Whitcroft } 15624d001e4dSAndy Whitcroft 15634d001e4dSAndy Whitcroft return $line; 15644d001e4dSAndy Whitcroft} 15654d001e4dSAndy Whitcroft 15660a920b5bSAndy Whitcroftsub cat_vet { 15670a920b5bSAndy Whitcroft my ($vet) = @_; 15689c0ca6f9SAndy Whitcroft my ($res, $coded); 15690a920b5bSAndy Whitcroft 15709c0ca6f9SAndy Whitcroft $res = ''; 15716c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 15726c72ffaaSAndy Whitcroft $res .= $1; 15736c72ffaaSAndy Whitcroft if ($2 ne '') { 15749c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 15756c72ffaaSAndy Whitcroft $res .= $coded; 15766c72ffaaSAndy Whitcroft } 15779c0ca6f9SAndy Whitcroft } 15789c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 15790a920b5bSAndy Whitcroft 15809c0ca6f9SAndy Whitcroft return $res; 15810a920b5bSAndy Whitcroft} 15820a920b5bSAndy Whitcroft 1583c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1584cf655043SAndy Whitcroftmy $av_pending; 1585c2fdda0dSAndy Whitcroftmy @av_paren_type; 15861f65f947SAndy Whitcroftmy $av_pend_colon; 1587c2fdda0dSAndy Whitcroft 1588c2fdda0dSAndy Whitcroftsub annotate_reset { 1589c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1590cf655043SAndy Whitcroft $av_pending = '_'; 1591cf655043SAndy Whitcroft @av_paren_type = ('E'); 15921f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1593c2fdda0dSAndy Whitcroft} 1594c2fdda0dSAndy Whitcroft 15956c72ffaaSAndy Whitcroftsub annotate_values { 15966c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 15976c72ffaaSAndy Whitcroft 15986c72ffaaSAndy Whitcroft my $res; 15991f65f947SAndy Whitcroft my $var = '_' x length($stream); 16006c72ffaaSAndy Whitcroft my $cur = $stream; 16016c72ffaaSAndy Whitcroft 1602c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 16036c72ffaaSAndy Whitcroft 16046c72ffaaSAndy Whitcroft while (length($cur)) { 1605773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1606cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1607171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 16086c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1609c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1610c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1611cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1612c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 16136c72ffaaSAndy Whitcroft } 16146c72ffaaSAndy Whitcroft 1615c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 16169446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 16179446ef56SAndy Whitcroft push(@av_paren_type, $type); 1618addcdceaSAndy Whitcroft $type = 'c'; 16199446ef56SAndy Whitcroft 1620e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1621c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 16226c72ffaaSAndy Whitcroft $type = 'T'; 16236c72ffaaSAndy Whitcroft 1624389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1625389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1626389a2fe5SAndy Whitcroft $type = 'T'; 1627389a2fe5SAndy Whitcroft 1628c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1629171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1630c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1631171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1632171ae1a4SAndy Whitcroft if ($2 ne '') { 1633cf655043SAndy Whitcroft $av_pending = 'N'; 1634171ae1a4SAndy Whitcroft } 1635171ae1a4SAndy Whitcroft $type = 'E'; 1636171ae1a4SAndy Whitcroft 1637c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1638171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1639171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1640171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 16416c72ffaaSAndy Whitcroft 1642c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1643cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1644c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1645cf655043SAndy Whitcroft 1646cf655043SAndy Whitcroft push(@av_paren_type, $type); 1647cf655043SAndy Whitcroft push(@av_paren_type, $type); 1648171ae1a4SAndy Whitcroft $type = 'E'; 1649cf655043SAndy Whitcroft 1650c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1651cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1652cf655043SAndy Whitcroft $av_preprocessor = 1; 1653cf655043SAndy Whitcroft 1654cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1655cf655043SAndy Whitcroft 1656171ae1a4SAndy Whitcroft $type = 'E'; 1657cf655043SAndy Whitcroft 1658c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1659cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1660cf655043SAndy Whitcroft 1661cf655043SAndy Whitcroft $av_preprocessor = 1; 1662cf655043SAndy Whitcroft 1663cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1664cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1665cf655043SAndy Whitcroft pop(@av_paren_type); 1666cf655043SAndy Whitcroft push(@av_paren_type, $type); 1667171ae1a4SAndy Whitcroft $type = 'E'; 16686c72ffaaSAndy Whitcroft 16696c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1670c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 16716c72ffaaSAndy Whitcroft 1672171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1673171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1674171ae1a4SAndy Whitcroft $av_pending = $type; 1675171ae1a4SAndy Whitcroft $type = 'N'; 1676171ae1a4SAndy Whitcroft 16776c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1678c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 16796c72ffaaSAndy Whitcroft if (defined $2) { 1680cf655043SAndy Whitcroft $av_pending = 'V'; 16816c72ffaaSAndy Whitcroft } 16826c72ffaaSAndy Whitcroft $type = 'N'; 16836c72ffaaSAndy Whitcroft 168414b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1685c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 168614b111c1SAndy Whitcroft $av_pending = 'E'; 16876c72ffaaSAndy Whitcroft $type = 'N'; 16886c72ffaaSAndy Whitcroft 16891f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 16901f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 16911f65f947SAndy Whitcroft $av_pend_colon = 'C'; 16921f65f947SAndy Whitcroft $type = 'N'; 16931f65f947SAndy Whitcroft 169414b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1695c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 16966c72ffaaSAndy Whitcroft $type = 'N'; 16976c72ffaaSAndy Whitcroft 16986c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1699c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1700cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1701cf655043SAndy Whitcroft $av_pending = '_'; 17026c72ffaaSAndy Whitcroft $type = 'N'; 17036c72ffaaSAndy Whitcroft 17046c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1705cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1706cf655043SAndy Whitcroft if ($new_type ne '_') { 1707cf655043SAndy Whitcroft $type = $new_type; 1708c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1709c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 17106c72ffaaSAndy Whitcroft } else { 1711c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 17126c72ffaaSAndy Whitcroft } 17136c72ffaaSAndy Whitcroft 1714c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1715c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1716c8cb2ca3SAndy Whitcroft $type = 'V'; 1717cf655043SAndy Whitcroft $av_pending = 'V'; 17186c72ffaaSAndy Whitcroft 17198e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 17208e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 17211f65f947SAndy Whitcroft $av_pend_colon = 'B'; 17228e761b04SAndy Whitcroft } elsif ($type eq 'E') { 17238e761b04SAndy Whitcroft $av_pend_colon = 'L'; 17241f65f947SAndy Whitcroft } 17251f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 17261f65f947SAndy Whitcroft $type = 'V'; 17271f65f947SAndy Whitcroft 17286c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1729c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 17306c72ffaaSAndy Whitcroft $type = 'V'; 17316c72ffaaSAndy Whitcroft 17326c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1733c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 17346c72ffaaSAndy Whitcroft $type = 'N'; 17356c72ffaaSAndy Whitcroft 1736cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1737c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 173813214adfSAndy Whitcroft $type = 'E'; 17391f65f947SAndy Whitcroft $av_pend_colon = 'O'; 174013214adfSAndy Whitcroft 17418e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 17428e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 17438e761b04SAndy Whitcroft $type = 'C'; 17448e761b04SAndy Whitcroft 17451f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 17461f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 17471f65f947SAndy Whitcroft $type = 'N'; 17481f65f947SAndy Whitcroft 17491f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 17501f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 17511f65f947SAndy Whitcroft 17521f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 17531f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 17541f65f947SAndy Whitcroft $type = 'E'; 17551f65f947SAndy Whitcroft } else { 17561f65f947SAndy Whitcroft $type = 'N'; 17571f65f947SAndy Whitcroft } 17581f65f947SAndy Whitcroft $av_pend_colon = 'O'; 17591f65f947SAndy Whitcroft 17608e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 176113214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 17626c72ffaaSAndy Whitcroft $type = 'N'; 17636c72ffaaSAndy Whitcroft 17640d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 176574048ed8SAndy Whitcroft my $variant; 176674048ed8SAndy Whitcroft 176774048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 176874048ed8SAndy Whitcroft if ($type eq 'V') { 176974048ed8SAndy Whitcroft $variant = 'B'; 177074048ed8SAndy Whitcroft } else { 177174048ed8SAndy Whitcroft $variant = 'U'; 177274048ed8SAndy Whitcroft } 177374048ed8SAndy Whitcroft 177474048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 177574048ed8SAndy Whitcroft $type = 'N'; 177674048ed8SAndy Whitcroft 17776c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1778c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 17796c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 17806c72ffaaSAndy Whitcroft $type = 'N'; 17816c72ffaaSAndy Whitcroft } 17826c72ffaaSAndy Whitcroft 17836c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1784c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 17856c72ffaaSAndy Whitcroft } 17866c72ffaaSAndy Whitcroft if (defined $1) { 17876c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 17886c72ffaaSAndy Whitcroft $res .= $type x length($1); 17896c72ffaaSAndy Whitcroft } 17906c72ffaaSAndy Whitcroft } 17916c72ffaaSAndy Whitcroft 17921f65f947SAndy Whitcroft return ($res, $var); 17936c72ffaaSAndy Whitcroft} 17946c72ffaaSAndy Whitcroft 17958905a67cSAndy Whitcroftsub possible { 179613214adfSAndy Whitcroft my ($possible, $line) = @_; 17979a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 17980776e594SAndy Whitcroft ^(?: 17990776e594SAndy Whitcroft $Modifier| 18000776e594SAndy Whitcroft $Storage| 18010776e594SAndy Whitcroft $Type| 18029a974fdbSAndy Whitcroft DEFINE_\S+ 18039a974fdbSAndy Whitcroft )$| 18049a974fdbSAndy Whitcroft ^(?: 18050776e594SAndy Whitcroft goto| 18060776e594SAndy Whitcroft return| 18070776e594SAndy Whitcroft case| 18080776e594SAndy Whitcroft else| 18090776e594SAndy Whitcroft asm|__asm__| 181089a88353SAndy Whitcroft do| 181189a88353SAndy Whitcroft \#| 181289a88353SAndy Whitcroft \#\#| 18139a974fdbSAndy Whitcroft )(?:\s|$)| 18140776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 18159a974fdbSAndy Whitcroft )}x; 18169a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 18179a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1818c45dcabdSAndy Whitcroft # Check for modifiers. 1819c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1820c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1821c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1822c45dcabdSAndy Whitcroft 1823c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1824c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1825d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 18269a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1827d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1828485ff23eSAlex Dowad push(@modifierListFile, $modifier); 1829d2506586SAndy Whitcroft } 18309a974fdbSAndy Whitcroft } 1831c45dcabdSAndy Whitcroft 1832c45dcabdSAndy Whitcroft } else { 183313214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 1834485ff23eSAlex Dowad push(@typeListFile, $possible); 1835c45dcabdSAndy Whitcroft } 18368905a67cSAndy Whitcroft build_types(); 18370776e594SAndy Whitcroft } else { 18380776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 18398905a67cSAndy Whitcroft } 18408905a67cSAndy Whitcroft} 18418905a67cSAndy Whitcroft 18426c72ffaaSAndy Whitcroftmy $prefix = ''; 18436c72ffaaSAndy Whitcroft 1844000d1cc1SJoe Perchessub show_type { 1845cbec18afSJoe Perches my ($type) = @_; 184691bfe484SJoe Perches 1847cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1848cbec18afSJoe Perches 1849cbec18afSJoe Perches return !defined $ignore_type{$type}; 1850000d1cc1SJoe Perches} 1851000d1cc1SJoe Perches 1852f0a594c1SAndy Whitcroftsub report { 1853cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1854cbec18afSJoe Perches 1855cbec18afSJoe Perches if (!show_type($type) || 1856cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1857773647a0SAndy Whitcroft return 0; 1858773647a0SAndy Whitcroft } 185957230297SJoe Perches my $output = ''; 186057230297SJoe Perches if (-t STDOUT && $color) { 186157230297SJoe Perches if ($level eq 'ERROR') { 186257230297SJoe Perches $output .= RED; 186357230297SJoe Perches } elsif ($level eq 'WARNING') { 186457230297SJoe Perches $output .= YELLOW; 1865000d1cc1SJoe Perches } else { 186657230297SJoe Perches $output .= GREEN; 1867000d1cc1SJoe Perches } 186857230297SJoe Perches } 186957230297SJoe Perches $output .= $prefix . $level . ':'; 187057230297SJoe Perches if ($show_types) { 187157230297SJoe Perches $output .= BLUE if (-t STDOUT && $color); 187257230297SJoe Perches $output .= "$type:"; 187357230297SJoe Perches } 187457230297SJoe Perches $output .= RESET if (-t STDOUT && $color); 187557230297SJoe Perches $output .= ' ' . $msg . "\n"; 187634d8815fSJoe Perches 187734d8815fSJoe Perches if ($showfile) { 187834d8815fSJoe Perches my @lines = split("\n", $output, -1); 187934d8815fSJoe Perches splice(@lines, 1, 1); 188034d8815fSJoe Perches $output = join("\n", @lines); 188134d8815fSJoe Perches } 188257230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 18838905a67cSAndy Whitcroft 188457230297SJoe Perches push(our @report, $output); 1885773647a0SAndy Whitcroft 1886773647a0SAndy Whitcroft return 1; 1887f0a594c1SAndy Whitcroft} 1888cbec18afSJoe Perches 1889f0a594c1SAndy Whitcroftsub report_dump { 189013214adfSAndy Whitcroft our @report; 1891f0a594c1SAndy Whitcroft} 1892000d1cc1SJoe Perches 1893d752fcc8SJoe Perchessub fixup_current_range { 1894d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 1895d752fcc8SJoe Perches 1896d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 1897d752fcc8SJoe Perches my $o = $1; 1898d752fcc8SJoe Perches my $l = $2; 1899d752fcc8SJoe Perches my $no = $o + $offset; 1900d752fcc8SJoe Perches my $nl = $l + $length; 1901d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 1902d752fcc8SJoe Perches } 1903d752fcc8SJoe Perches} 1904d752fcc8SJoe Perches 1905d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 1906d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 1907d752fcc8SJoe Perches 1908d752fcc8SJoe Perches my $range_last_linenr = 0; 1909d752fcc8SJoe Perches my $delta_offset = 0; 1910d752fcc8SJoe Perches 1911d752fcc8SJoe Perches my $old_linenr = 0; 1912d752fcc8SJoe Perches my $new_linenr = 0; 1913d752fcc8SJoe Perches 1914d752fcc8SJoe Perches my $next_insert = 0; 1915d752fcc8SJoe Perches my $next_delete = 0; 1916d752fcc8SJoe Perches 1917d752fcc8SJoe Perches my @lines = (); 1918d752fcc8SJoe Perches 1919d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 1920d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 1921d752fcc8SJoe Perches 1922d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 1923d752fcc8SJoe Perches my $save_line = 1; 1924d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 1925323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 1926d752fcc8SJoe Perches $delta_offset = 0; 1927d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 1928d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 1929d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 1930d752fcc8SJoe Perches } 1931d752fcc8SJoe Perches 1932d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 1933d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 1934d752fcc8SJoe Perches $save_line = 0; 1935d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 1936d752fcc8SJoe Perches } 1937d752fcc8SJoe Perches 1938d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 1939d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 1940d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 1941d752fcc8SJoe Perches $new_linenr++; 1942d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 1943d752fcc8SJoe Perches } 1944d752fcc8SJoe Perches 1945d752fcc8SJoe Perches if ($save_line) { 1946d752fcc8SJoe Perches push(@lines, $line); 1947d752fcc8SJoe Perches $new_linenr++; 1948d752fcc8SJoe Perches } 1949d752fcc8SJoe Perches 1950d752fcc8SJoe Perches $old_linenr++; 1951d752fcc8SJoe Perches } 1952d752fcc8SJoe Perches 1953d752fcc8SJoe Perches return @lines; 1954d752fcc8SJoe Perches} 1955d752fcc8SJoe Perches 1956f2d7e4d4SJoe Perchessub fix_insert_line { 1957f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1958f2d7e4d4SJoe Perches 1959f2d7e4d4SJoe Perches my $inserted = { 1960f2d7e4d4SJoe Perches LINENR => $linenr, 1961f2d7e4d4SJoe Perches LINE => $line, 1962f2d7e4d4SJoe Perches }; 1963f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 1964f2d7e4d4SJoe Perches} 1965f2d7e4d4SJoe Perches 1966f2d7e4d4SJoe Perchessub fix_delete_line { 1967f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1968f2d7e4d4SJoe Perches 1969f2d7e4d4SJoe Perches my $deleted = { 1970f2d7e4d4SJoe Perches LINENR => $linenr, 1971f2d7e4d4SJoe Perches LINE => $line, 1972f2d7e4d4SJoe Perches }; 1973f2d7e4d4SJoe Perches 1974f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 1975f2d7e4d4SJoe Perches} 1976f2d7e4d4SJoe Perches 1977de7d4f0eSAndy Whitcroftsub ERROR { 1978cbec18afSJoe Perches my ($type, $msg) = @_; 1979cbec18afSJoe Perches 1980cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 1981de7d4f0eSAndy Whitcroft our $clean = 0; 19826c72ffaaSAndy Whitcroft our $cnt_error++; 19833705ce5bSJoe Perches return 1; 1984de7d4f0eSAndy Whitcroft } 19853705ce5bSJoe Perches return 0; 1986773647a0SAndy Whitcroft} 1987de7d4f0eSAndy Whitcroftsub WARN { 1988cbec18afSJoe Perches my ($type, $msg) = @_; 1989cbec18afSJoe Perches 1990cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 1991de7d4f0eSAndy Whitcroft our $clean = 0; 19926c72ffaaSAndy Whitcroft our $cnt_warn++; 19933705ce5bSJoe Perches return 1; 1994de7d4f0eSAndy Whitcroft } 19953705ce5bSJoe Perches return 0; 1996773647a0SAndy Whitcroft} 1997de7d4f0eSAndy Whitcroftsub CHK { 1998cbec18afSJoe Perches my ($type, $msg) = @_; 1999cbec18afSJoe Perches 2000cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 2001de7d4f0eSAndy Whitcroft our $clean = 0; 20026c72ffaaSAndy Whitcroft our $cnt_chk++; 20033705ce5bSJoe Perches return 1; 20046c72ffaaSAndy Whitcroft } 20053705ce5bSJoe Perches return 0; 2006de7d4f0eSAndy Whitcroft} 2007de7d4f0eSAndy Whitcroft 20086ecd9674SAndy Whitcroftsub check_absolute_file { 20096ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 20106ecd9674SAndy Whitcroft my $file = $absolute; 20116ecd9674SAndy Whitcroft 20126ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 20136ecd9674SAndy Whitcroft 20146ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 20156ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 20166ecd9674SAndy Whitcroft if (-f "$root/$file") { 20176ecd9674SAndy Whitcroft ##print "file<$file>\n"; 20186ecd9674SAndy Whitcroft last; 20196ecd9674SAndy Whitcroft } 20206ecd9674SAndy Whitcroft } 20216ecd9674SAndy Whitcroft if (! -f _) { 20226ecd9674SAndy Whitcroft return 0; 20236ecd9674SAndy Whitcroft } 20246ecd9674SAndy Whitcroft 20256ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 20266ecd9674SAndy Whitcroft my $prefix = $absolute; 20276ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 20286ecd9674SAndy Whitcroft 20296ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 20306ecd9674SAndy Whitcroft if ($prefix ne ".../") { 2031000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 2032000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 20336ecd9674SAndy Whitcroft } 20346ecd9674SAndy Whitcroft} 20356ecd9674SAndy Whitcroft 20363705ce5bSJoe Perchessub trim { 20373705ce5bSJoe Perches my ($string) = @_; 20383705ce5bSJoe Perches 2039b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 2040b34c648bSJoe Perches 2041b34c648bSJoe Perches return $string; 2042b34c648bSJoe Perches} 2043b34c648bSJoe Perches 2044b34c648bSJoe Perchessub ltrim { 2045b34c648bSJoe Perches my ($string) = @_; 2046b34c648bSJoe Perches 2047b34c648bSJoe Perches $string =~ s/^\s+//; 2048b34c648bSJoe Perches 2049b34c648bSJoe Perches return $string; 2050b34c648bSJoe Perches} 2051b34c648bSJoe Perches 2052b34c648bSJoe Perchessub rtrim { 2053b34c648bSJoe Perches my ($string) = @_; 2054b34c648bSJoe Perches 2055b34c648bSJoe Perches $string =~ s/\s+$//; 20563705ce5bSJoe Perches 20573705ce5bSJoe Perches return $string; 20583705ce5bSJoe Perches} 20593705ce5bSJoe Perches 206052ea8506SJoe Perchessub string_find_replace { 206152ea8506SJoe Perches my ($string, $find, $replace) = @_; 206252ea8506SJoe Perches 206352ea8506SJoe Perches $string =~ s/$find/$replace/g; 206452ea8506SJoe Perches 206552ea8506SJoe Perches return $string; 206652ea8506SJoe Perches} 206752ea8506SJoe Perches 20683705ce5bSJoe Perchessub tabify { 20693705ce5bSJoe Perches my ($leading) = @_; 20703705ce5bSJoe Perches 20713705ce5bSJoe Perches my $source_indent = 8; 20723705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 20733705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 20743705ce5bSJoe Perches 20753705ce5bSJoe Perches #convert leading spaces to tabs 20763705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 20773705ce5bSJoe Perches #Remove spaces before a tab 20783705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 20793705ce5bSJoe Perches 20803705ce5bSJoe Perches return "$leading"; 20813705ce5bSJoe Perches} 20823705ce5bSJoe Perches 2083d1fe9c09SJoe Perchessub pos_last_openparen { 2084d1fe9c09SJoe Perches my ($line) = @_; 2085d1fe9c09SJoe Perches 2086d1fe9c09SJoe Perches my $pos = 0; 2087d1fe9c09SJoe Perches 2088d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 2089d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 2090d1fe9c09SJoe Perches 2091d1fe9c09SJoe Perches my $last_openparen = 0; 2092d1fe9c09SJoe Perches 2093d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 2094d1fe9c09SJoe Perches return -1; 2095d1fe9c09SJoe Perches } 2096d1fe9c09SJoe Perches 2097d1fe9c09SJoe Perches my $len = length($line); 2098d1fe9c09SJoe Perches 2099d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 2100d1fe9c09SJoe Perches my $string = substr($line, $pos); 2101d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 2102d1fe9c09SJoe Perches $pos += length($1) - 1; 2103d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 2104d1fe9c09SJoe Perches $last_openparen = $pos; 2105d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 2106d1fe9c09SJoe Perches last; 2107d1fe9c09SJoe Perches } 2108d1fe9c09SJoe Perches } 2109d1fe9c09SJoe Perches 211091cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2111d1fe9c09SJoe Perches} 2112d1fe9c09SJoe Perches 21130a920b5bSAndy Whitcroftsub process { 21140a920b5bSAndy Whitcroft my $filename = shift; 21150a920b5bSAndy Whitcroft 21160a920b5bSAndy Whitcroft my $linenr=0; 21170a920b5bSAndy Whitcroft my $prevline=""; 2118c2fdda0dSAndy Whitcroft my $prevrawline=""; 21190a920b5bSAndy Whitcroft my $stashline=""; 2120c2fdda0dSAndy Whitcroft my $stashrawline=""; 21210a920b5bSAndy Whitcroft 21224a0df2efSAndy Whitcroft my $length; 21230a920b5bSAndy Whitcroft my $indent; 21240a920b5bSAndy Whitcroft my $previndent=0; 21250a920b5bSAndy Whitcroft my $stashindent=0; 21260a920b5bSAndy Whitcroft 2127de7d4f0eSAndy Whitcroft our $clean = 1; 21280a920b5bSAndy Whitcroft my $signoff = 0; 21290a920b5bSAndy Whitcroft my $is_patch = 0; 213029ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 213115662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 2132ed43c4e5SAllen Hubbe my $has_commit_log = 0; #Encountered lines before patch 2133bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 21342a076f40SJoe Perches my $commit_log_long_line = 0; 2135e518e9a5SJoe Perches my $commit_log_has_diff = 0; 213613f1937eSJoe Perches my $reported_maintainer_file = 0; 2137fa64205dSPasi Savanainen my $non_utf8_charset = 0; 2138fa64205dSPasi Savanainen 2139365dd4eaSJoe Perches my $last_blank_line = 0; 21405e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 2141365dd4eaSJoe Perches 214213214adfSAndy Whitcroft our @report = (); 21436c72ffaaSAndy Whitcroft our $cnt_lines = 0; 21446c72ffaaSAndy Whitcroft our $cnt_error = 0; 21456c72ffaaSAndy Whitcroft our $cnt_warn = 0; 21466c72ffaaSAndy Whitcroft our $cnt_chk = 0; 21476c72ffaaSAndy Whitcroft 21480a920b5bSAndy Whitcroft # Trace the real file/line as we go. 21490a920b5bSAndy Whitcroft my $realfile = ''; 21500a920b5bSAndy Whitcroft my $realline = 0; 21510a920b5bSAndy Whitcroft my $realcnt = 0; 21520a920b5bSAndy Whitcroft my $here = ''; 21530a920b5bSAndy Whitcroft my $in_comment = 0; 2154c2fdda0dSAndy Whitcroft my $comment_edge = 0; 21550a920b5bSAndy Whitcroft my $first_line = 0; 21561e855726SWolfram Sang my $p1_prefix = ''; 21570a920b5bSAndy Whitcroft 215813214adfSAndy Whitcroft my $prev_values = 'E'; 215913214adfSAndy Whitcroft 216013214adfSAndy Whitcroft # suppression flags 2161773647a0SAndy Whitcroft my %suppress_ifbraces; 2162170d3a22SAndy Whitcroft my %suppress_whiletrailers; 21632b474a1aSAndy Whitcroft my %suppress_export; 21643e469cdcSAndy Whitcroft my $suppress_statement = 0; 2165653d4876SAndy Whitcroft 21667e51f197SJoe Perches my %signatures = (); 2167323c1260SJoe Perches 2168c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2169de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2170c2fdda0dSAndy Whitcroft # 2171de7d4f0eSAndy Whitcroft my @setup_docs = (); 2172de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2173773647a0SAndy Whitcroft 2174d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2175d8b07710SJoe Perches 2176773647a0SAndy Whitcroft sanitise_line_reset(); 2177c2fdda0dSAndy Whitcroft my $line; 2178c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2179773647a0SAndy Whitcroft $linenr++; 2180773647a0SAndy Whitcroft $line = $rawline; 2181c2fdda0dSAndy Whitcroft 21823705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 21833705ce5bSJoe Perches 2184773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2185de7d4f0eSAndy Whitcroft $setup_docs = 0; 2186de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 2187de7d4f0eSAndy Whitcroft $setup_docs = 1; 2188de7d4f0eSAndy Whitcroft } 2189773647a0SAndy Whitcroft #next; 2190de7d4f0eSAndy Whitcroft } 2191773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2192773647a0SAndy Whitcroft $realline=$1-1; 2193773647a0SAndy Whitcroft if (defined $2) { 2194773647a0SAndy Whitcroft $realcnt=$3+1; 2195773647a0SAndy Whitcroft } else { 2196773647a0SAndy Whitcroft $realcnt=1+1; 2197773647a0SAndy Whitcroft } 2198c45dcabdSAndy Whitcroft $in_comment = 0; 2199773647a0SAndy Whitcroft 2200773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2201773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2202773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2203773647a0SAndy Whitcroft # at context start. 2204773647a0SAndy Whitcroft my $edge; 220501fa9147SAndy Whitcroft my $cnt = $realcnt; 220601fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 220701fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 220801fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 220901fa9147SAndy Whitcroft $cnt--; 221001fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2211721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2212fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2213fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2214fae17daeSAndy Whitcroft ($edge) = $1; 2215fae17daeSAndy Whitcroft last; 2216fae17daeSAndy Whitcroft } 2217773647a0SAndy Whitcroft } 2218773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2219773647a0SAndy Whitcroft $in_comment = 1; 2220773647a0SAndy Whitcroft } 2221773647a0SAndy Whitcroft 2222773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2223773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2224773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2225773647a0SAndy Whitcroft if (!defined $edge && 222683242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2227773647a0SAndy Whitcroft { 2228773647a0SAndy Whitcroft $in_comment = 1; 2229773647a0SAndy Whitcroft } 2230773647a0SAndy Whitcroft 2231773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2232773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2233773647a0SAndy Whitcroft 2234171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2235773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2236171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2237773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2238773647a0SAndy Whitcroft } 2239773647a0SAndy Whitcroft push(@lines, $line); 2240773647a0SAndy Whitcroft 2241773647a0SAndy Whitcroft if ($realcnt > 1) { 2242773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2243773647a0SAndy Whitcroft } else { 2244773647a0SAndy Whitcroft $realcnt = 0; 2245773647a0SAndy Whitcroft } 2246773647a0SAndy Whitcroft 2247773647a0SAndy Whitcroft #print "==>$rawline\n"; 2248773647a0SAndy Whitcroft #print "-->$line\n"; 2249de7d4f0eSAndy Whitcroft 2250de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2251de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2252de7d4f0eSAndy Whitcroft } 2253de7d4f0eSAndy Whitcroft } 2254de7d4f0eSAndy Whitcroft 22556c72ffaaSAndy Whitcroft $prefix = ''; 22566c72ffaaSAndy Whitcroft 2257773647a0SAndy Whitcroft $realcnt = 0; 2258773647a0SAndy Whitcroft $linenr = 0; 2259194f66fcSJoe Perches $fixlinenr = -1; 22600a920b5bSAndy Whitcroft foreach my $line (@lines) { 22610a920b5bSAndy Whitcroft $linenr++; 2262194f66fcSJoe Perches $fixlinenr++; 22631b5539b1SJoe Perches my $sline = $line; #copy of $line 22641b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 22650a920b5bSAndy Whitcroft 2266c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 22676c72ffaaSAndy Whitcroft 22680a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2269e518e9a5SJoe Perches if (!$in_commit_log && 2270e518e9a5SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 22710a920b5bSAndy Whitcroft $is_patch = 1; 22724a0df2efSAndy Whitcroft $first_line = $linenr + 1; 22730a920b5bSAndy Whitcroft $realline=$1-1; 22740a920b5bSAndy Whitcroft if (defined $2) { 22750a920b5bSAndy Whitcroft $realcnt=$3+1; 22760a920b5bSAndy Whitcroft } else { 22770a920b5bSAndy Whitcroft $realcnt=1+1; 22780a920b5bSAndy Whitcroft } 2279c2fdda0dSAndy Whitcroft annotate_reset(); 228013214adfSAndy Whitcroft $prev_values = 'E'; 228113214adfSAndy Whitcroft 2282773647a0SAndy Whitcroft %suppress_ifbraces = (); 2283170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 22842b474a1aSAndy Whitcroft %suppress_export = (); 22853e469cdcSAndy Whitcroft $suppress_statement = 0; 22860a920b5bSAndy Whitcroft next; 22870a920b5bSAndy Whitcroft 22884a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 22894a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 22904a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2291773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 22920a920b5bSAndy Whitcroft $realline++; 2293d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 22940a920b5bSAndy Whitcroft 22954a0df2efSAndy Whitcroft # Measure the line length and indent. 2296c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 22970a920b5bSAndy Whitcroft 22980a920b5bSAndy Whitcroft # Track the previous line. 22990a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 23000a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2301c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2302c2fdda0dSAndy Whitcroft 2303773647a0SAndy Whitcroft #warn "line<$line>\n"; 23046c72ffaaSAndy Whitcroft 2305d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2306d8aaf121SAndy Whitcroft $realcnt--; 23070a920b5bSAndy Whitcroft } 23080a920b5bSAndy Whitcroft 2309cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2310cc77cdcaSAndy Whitcroft 23116c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 23126c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2313773647a0SAndy Whitcroft 23142ac73b4fSJoe Perches my $found_file = 0; 2315773647a0SAndy Whitcroft # extract the filename as it passes 23163bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 23173bf9a009SRabin Vincent $realfile = $1; 23182b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2319270c49a0SJoe Perches $in_commit_log = 0; 23202ac73b4fSJoe Perches $found_file = 1; 23213bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2322773647a0SAndy Whitcroft $realfile = $1; 23232b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2324270c49a0SJoe Perches $in_commit_log = 0; 23251e855726SWolfram Sang 23261e855726SWolfram Sang $p1_prefix = $1; 2327e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2328e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2329000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2330000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 23311e855726SWolfram Sang } 2332773647a0SAndy Whitcroft 2333c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2334000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2335000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2336773647a0SAndy Whitcroft } 23372ac73b4fSJoe Perches $found_file = 1; 23382ac73b4fSJoe Perches } 23392ac73b4fSJoe Perches 234034d8815fSJoe Perches#make up the handle for any error we report on this line 234134d8815fSJoe Perches if ($showfile) { 234234d8815fSJoe Perches $prefix = "$realfile:$realline: " 234334d8815fSJoe Perches } elsif ($emacs) { 23447d3a9f67SJoe Perches if ($file) { 23457d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 23467d3a9f67SJoe Perches } else { 234734d8815fSJoe Perches $prefix = "$filename:$linenr: "; 234834d8815fSJoe Perches } 23497d3a9f67SJoe Perches } 235034d8815fSJoe Perches 23512ac73b4fSJoe Perches if ($found_file) { 235285b0ee18SJoe Perches if (is_maintained_obsolete($realfile)) { 235385b0ee18SJoe Perches WARN("OBSOLETE", 235485b0ee18SJoe Perches "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 235585b0ee18SJoe Perches } 23567bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 23572ac73b4fSJoe Perches $check = 1; 23582ac73b4fSJoe Perches } else { 23592ac73b4fSJoe Perches $check = $check_orig; 23602ac73b4fSJoe Perches } 2361773647a0SAndy Whitcroft next; 2362773647a0SAndy Whitcroft } 2363773647a0SAndy Whitcroft 2364389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 23650a920b5bSAndy Whitcroft 2366c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2367c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2368c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 23690a920b5bSAndy Whitcroft 23706c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 23716c72ffaaSAndy Whitcroft 2372e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2373e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2374e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2375e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2376e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2377e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2378e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2379e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2380e518e9a5SJoe Perches $commit_log_has_diff = 1; 2381e518e9a5SJoe Perches } 2382e518e9a5SJoe Perches 23833bf9a009SRabin Vincent# Check for incorrect file permissions 23843bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 23853bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 238604db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 238704db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2388000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2389000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 23903bf9a009SRabin Vincent } 23913bf9a009SRabin Vincent } 23923bf9a009SRabin Vincent 239320112475SJoe Perches# Check the patch for a signoff: 2394d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 23954a0df2efSAndy Whitcroft $signoff++; 239615662b3eSJoe Perches $in_commit_log = 0; 23970a920b5bSAndy Whitcroft } 239820112475SJoe Perches 2399e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2400e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2401e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2402e0d975b1SJoe Perches $reported_maintainer_file = 1; 2403e0d975b1SJoe Perches } 2404e0d975b1SJoe Perches 240520112475SJoe Perches# Check signature styles 2406270c49a0SJoe Perches if (!$in_header_lines && 2407ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 240820112475SJoe Perches my $space_before = $1; 240920112475SJoe Perches my $sign_off = $2; 241020112475SJoe Perches my $space_after = $3; 241120112475SJoe Perches my $email = $4; 241220112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 241320112475SJoe Perches 2414ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2415ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2416ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2417ce0338dfSJoe Perches } 241820112475SJoe Perches if (defined $space_before && $space_before ne "") { 24193705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 24203705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 24213705ce5bSJoe Perches $fix) { 2422194f66fcSJoe Perches $fixed[$fixlinenr] = 24233705ce5bSJoe Perches "$ucfirst_sign_off $email"; 24243705ce5bSJoe Perches } 242520112475SJoe Perches } 242620112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 24273705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 24283705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 24293705ce5bSJoe Perches $fix) { 2430194f66fcSJoe Perches $fixed[$fixlinenr] = 24313705ce5bSJoe Perches "$ucfirst_sign_off $email"; 24323705ce5bSJoe Perches } 24333705ce5bSJoe Perches 243420112475SJoe Perches } 243520112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 24363705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 24373705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 24383705ce5bSJoe Perches $fix) { 2439194f66fcSJoe Perches $fixed[$fixlinenr] = 24403705ce5bSJoe Perches "$ucfirst_sign_off $email"; 24413705ce5bSJoe Perches } 244220112475SJoe Perches } 244320112475SJoe Perches 244420112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 244520112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 244620112475SJoe Perches if ($suggested_email eq "") { 2447000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2448000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 244920112475SJoe Perches } else { 245020112475SJoe Perches my $dequoted = $suggested_email; 245120112475SJoe Perches $dequoted =~ s/^"//; 245220112475SJoe Perches $dequoted =~ s/" </ </; 245320112475SJoe Perches # Don't force email to have quotes 245420112475SJoe Perches # Allow just an angle bracketed address 245520112475SJoe Perches if ("$dequoted$comment" ne $email && 245620112475SJoe Perches "<$email_address>$comment" ne $email && 245720112475SJoe Perches "$suggested_email$comment" ne $email) { 2458000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2459000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 246020112475SJoe Perches } 24610a920b5bSAndy Whitcroft } 24627e51f197SJoe Perches 24637e51f197SJoe Perches# Check for duplicate signatures 24647e51f197SJoe Perches my $sig_nospace = $line; 24657e51f197SJoe Perches $sig_nospace =~ s/\s//g; 24667e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 24677e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 24687e51f197SJoe Perches WARN("BAD_SIGN_OFF", 24697e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 24707e51f197SJoe Perches } else { 24717e51f197SJoe Perches $signatures{$sig_nospace} = 1; 24727e51f197SJoe Perches } 24730a920b5bSAndy Whitcroft } 24740a920b5bSAndy Whitcroft 2475a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2476a2fe16b9SJoe Perches if ($in_header_lines && 2477a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2478a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2479a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2480a2fe16b9SJoe Perches } 2481a2fe16b9SJoe Perches 24829b3189ebSJoe Perches# Check for old stable address 24839b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 24849b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 24859b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 24869b3189ebSJoe Perches } 24879b3189ebSJoe Perches 24887ebd05efSChristopher Covington# Check for unwanted Gerrit info 24897ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 24907ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 24917ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 24927ebd05efSChristopher Covington } 24937ebd05efSChristopher Covington 2494369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2495369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2496369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2497369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2498369c8dd3SJoe Perches # timestamp 2499369c8dd3SJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) { 2500369c8dd3SJoe Perches # stack dump address 2501369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2502369c8dd3SJoe Perches } 2503369c8dd3SJoe Perches 25042a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 25052a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2506bf4daf12SJoe Perches length($line) > 75 && 2507bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2508bf4daf12SJoe Perches # file delta changes 2509bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2510bf4daf12SJoe Perches # filename then : 2511bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2512bf4daf12SJoe Perches # A Fixes: or Link: line 2513bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 25142a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 25152a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 25162a076f40SJoe Perches $commit_log_long_line = 1; 25172a076f40SJoe Perches } 25182a076f40SJoe Perches 2519bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2520bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2521bf4daf12SJoe Perches $line =~ /^\s*$/) { 2522bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2523bf4daf12SJoe Perches } 2524bf4daf12SJoe Perches 25250d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2526369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2527aab38f51SJoe Perches $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i && 2528fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2529aab38f51SJoe Perches ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 2530369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2531bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2532fe043ea1SJoe Perches my $init_char = "c"; 2533fe043ea1SJoe Perches my $orig_commit = ""; 25340d7835fcSJoe Perches my $short = 1; 25350d7835fcSJoe Perches my $long = 0; 25360d7835fcSJoe Perches my $case = 1; 25370d7835fcSJoe Perches my $space = 1; 25380d7835fcSJoe Perches my $hasdesc = 0; 253919c146a6SJoe Perches my $hasparens = 0; 25400d7835fcSJoe Perches my $id = '0123456789ab'; 25410d7835fcSJoe Perches my $orig_desc = "commit description"; 25420d7835fcSJoe Perches my $description = ""; 25430d7835fcSJoe Perches 2544fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2545fe043ea1SJoe Perches $init_char = $1; 2546fe043ea1SJoe Perches $orig_commit = lc($2); 2547fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2548fe043ea1SJoe Perches $orig_commit = lc($1); 2549fe043ea1SJoe Perches } 2550fe043ea1SJoe Perches 25510d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 25520d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 25530d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 25540d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 25550d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 25560d7835fcSJoe Perches $orig_desc = $1; 255719c146a6SJoe Perches $hasparens = 1; 25580d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 25590d7835fcSJoe Perches defined $rawlines[$linenr] && 25600d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 25610d7835fcSJoe Perches $orig_desc = $1; 256219c146a6SJoe Perches $hasparens = 1; 2563b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2564b671fde0SJoe Perches defined $rawlines[$linenr] && 2565b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2566b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2567b671fde0SJoe Perches $orig_desc = $1; 2568b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2569b671fde0SJoe Perches $orig_desc .= " " . $1; 257019c146a6SJoe Perches $hasparens = 1; 25710d7835fcSJoe Perches } 25720d7835fcSJoe Perches 25730d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 25740d7835fcSJoe Perches $id, $orig_desc); 25750d7835fcSJoe Perches 257619c146a6SJoe Perches if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) { 2577d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 25780d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 25790d7835fcSJoe Perches } 2580d311cd44SJoe Perches } 2581d311cd44SJoe Perches 258213f1937eSJoe Perches# Check for added, moved or deleted files 258313f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 258413f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 258513f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 258613f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 258713f1937eSJoe Perches (defined($1) || defined($2))))) { 258813f1937eSJoe Perches $reported_maintainer_file = 1; 258913f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 259013f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 259113f1937eSJoe Perches } 259213f1937eSJoe Perches 259300df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 25948905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2595000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2596000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 25976c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2598de7d4f0eSAndy Whitcroft } 2599de7d4f0eSAndy Whitcroft 26006ecd9674SAndy Whitcroft# Check for absolute kernel paths. 26016ecd9674SAndy Whitcroft if ($tree) { 26026ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 26036ecd9674SAndy Whitcroft my $file = $1; 26046ecd9674SAndy Whitcroft 26056ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 26066ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 26076ecd9674SAndy Whitcroft # 26086ecd9674SAndy Whitcroft } else { 26096ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 26106ecd9674SAndy Whitcroft } 26116ecd9674SAndy Whitcroft } 26126ecd9674SAndy Whitcroft } 26136ecd9674SAndy Whitcroft 2614de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2615de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2616171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2617171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2618171ae1a4SAndy Whitcroft 2619171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2620171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2621171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2622171ae1a4SAndy Whitcroft 262334d99219SJoe Perches CHK("INVALID_UTF8", 2624000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 262500df344fSAndy Whitcroft } 26260a920b5bSAndy Whitcroft 262715662b3eSJoe Perches# Check if it's the start of a commit log 262815662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 262915662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 263029ee1b0cSJoe Perches !($rawline =~ /^\s+\S/ || 263129ee1b0cSJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 263215662b3eSJoe Perches $in_header_lines = 0; 263315662b3eSJoe Perches $in_commit_log = 1; 2634ed43c4e5SAllen Hubbe $has_commit_log = 1; 263515662b3eSJoe Perches } 263615662b3eSJoe Perches 2637fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2638fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2639fa64205dSPasi Savanainen if ($in_header_lines && 2640fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2641fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2642fa64205dSPasi Savanainen $non_utf8_charset = 1; 2643fa64205dSPasi Savanainen } 2644fa64205dSPasi Savanainen 2645fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 264615662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2647fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 264815662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 264915662b3eSJoe Perches } 265015662b3eSJoe Perches 265166b47b4aSKees Cook# Check for various typo / spelling mistakes 265266d7a382SJoe Perches if (defined($misspellings) && 265366d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2654ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 265566b47b4aSKees Cook my $typo = $1; 265666b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 265766b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 265866b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 265966b47b4aSKees Cook my $msg_type = \&WARN; 266066b47b4aSKees Cook $msg_type = \&CHK if ($file); 266166b47b4aSKees Cook if (&{$msg_type}("TYPO_SPELLING", 266266b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 266366b47b4aSKees Cook $fix) { 266466b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 266566b47b4aSKees Cook } 266666b47b4aSKees Cook } 266766b47b4aSKees Cook } 266866b47b4aSKees Cook 266930670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 267030670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 267100df344fSAndy Whitcroft 26720a920b5bSAndy Whitcroft#trailing whitespace 26739c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2674c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2675d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2676d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2677d5e616fcSJoe Perches $fix) { 2678194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2679d5e616fcSJoe Perches } 2680c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2681c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 26823705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 26833705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 26843705ce5bSJoe Perches $fix) { 2685194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 26863705ce5bSJoe Perches } 26873705ce5bSJoe Perches 2688d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 26890a920b5bSAndy Whitcroft } 26905368df20SAndy Whitcroft 26914783f894SJosh Triplett# Check for FSF mailing addresses. 2692109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 26933e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 26943e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 26954783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 26964783f894SJosh Triplett my $msg_type = \&ERROR; 26974783f894SJosh Triplett $msg_type = \&CHK if ($file); 26984783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 26994783f894SJosh 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) 27004783f894SJosh Triplett } 27014783f894SJosh Triplett 27023354957aSAndi Kleen# check for Kconfig help text having a real description 27039fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 27049fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 27053354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 27068d73e0e7SJoe Perches $line =~ /^\+\s*config\s+/) { 27073354957aSAndi Kleen my $length = 0; 27089fe287d7SAndy Whitcroft my $cnt = $realcnt; 27099fe287d7SAndy Whitcroft my $ln = $linenr + 1; 27109fe287d7SAndy Whitcroft my $f; 2711a1385803SAndy Whitcroft my $is_start = 0; 27129fe287d7SAndy Whitcroft my $is_end = 0; 2713a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 27149fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 27159fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 27169fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 27179fe287d7SAndy Whitcroft 27189fe287d7SAndy Whitcroft next if ($f =~ /^-/); 27198d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2720a1385803SAndy Whitcroft 27218d73e0e7SJoe Perches if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) { 2722a1385803SAndy Whitcroft $is_start = 1; 27238d73e0e7SJoe Perches } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 2724a1385803SAndy Whitcroft $length = -1; 2725a1385803SAndy Whitcroft } 2726a1385803SAndy Whitcroft 27279fe287d7SAndy Whitcroft $f =~ s/^.//; 27283354957aSAndi Kleen $f =~ s/#.*//; 27293354957aSAndi Kleen $f =~ s/^\s+//; 27303354957aSAndi Kleen next if ($f =~ /^$/); 27319fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 27329fe287d7SAndy Whitcroft $is_end = 1; 27339fe287d7SAndy Whitcroft last; 27349fe287d7SAndy Whitcroft } 27353354957aSAndi Kleen $length++; 27363354957aSAndi Kleen } 273756193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2738000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 273956193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 274056193274SVadim Bendebury } 2741a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 27423354957aSAndi Kleen } 27433354957aSAndi Kleen 27441ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 27451ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 27461ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 27471ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 27481ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 27491ba8dfd1SKees Cook } 27501ba8dfd1SKees Cook 2751327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2752327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2753327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2754327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2755327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2756327953e9SChristoph Jaeger } 2757327953e9SChristoph Jaeger 2758c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2759c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2760c68e5878SArnaud Lacombe my $flag = $1; 2761c68e5878SArnaud Lacombe my $replacement = { 2762c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2763c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2764c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2765c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2766c68e5878SArnaud Lacombe }; 2767c68e5878SArnaud Lacombe 2768c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2769c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2770c68e5878SArnaud Lacombe } 2771c68e5878SArnaud Lacombe 2772bff5da43SRob Herring# check for DT compatible documentation 27737dd05b38SFlorian Vaussard if (defined $root && 27747dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 27757dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 27767dd05b38SFlorian Vaussard 2777bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2778bff5da43SRob Herring 2779cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2780cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2781cc93319bSFlorian Vaussard 2782bff5da43SRob Herring foreach my $compat (@compats) { 2783bff5da43SRob Herring my $compat2 = $compat; 2784185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2785185d566bSRob Herring my $compat3 = $compat; 2786185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2787185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2788bff5da43SRob Herring if ( $? >> 8 ) { 2789bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2790bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2791bff5da43SRob Herring } 2792bff5da43SRob Herring 27934fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 27944fbf32a6SFlorian Vaussard my $vendor = $1; 2795cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2796bff5da43SRob Herring if ( $? >> 8 ) { 2797bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2798cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2799bff5da43SRob Herring } 2800bff5da43SRob Herring } 2801bff5da43SRob Herring } 2802bff5da43SRob Herring 28035368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2804de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/); 28055368df20SAndy Whitcroft 280647e0c88bSJoe Perches# line length limit (with some exclusions) 280747e0c88bSJoe Perches# 280847e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 280947e0c88bSJoe Perches# logging functions like pr_info that end in a string 281047e0c88bSJoe Perches# lines with a single string 281147e0c88bSJoe Perches# #defines that are a single string 281247e0c88bSJoe Perches# 281347e0c88bSJoe Perches# There are 3 different line length message types: 281447e0c88bSJoe Perches# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength 281547e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 281647e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 281747e0c88bSJoe Perches# 281847e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 281947e0c88bSJoe Perches# 282047e0c88bSJoe Perches 2821b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 282247e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 282347e0c88bSJoe Perches 282447e0c88bSJoe Perches # Check the allowed long line types first 282547e0c88bSJoe Perches 282647e0c88bSJoe Perches # logging functions that end in a string that starts 282747e0c88bSJoe Perches # before $max_line_length 282847e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 282947e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 283047e0c88bSJoe Perches $msg_type = ""; 283147e0c88bSJoe Perches 283247e0c88bSJoe Perches # lines with only strings (w/ possible termination) 283347e0c88bSJoe Perches # #defines with only strings 283447e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 283547e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 283647e0c88bSJoe Perches $msg_type = ""; 283747e0c88bSJoe Perches 2838d560a5f8SJoe Perches # EFI_GUID is another special case 2839d560a5f8SJoe Perches } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/) { 2840d560a5f8SJoe Perches $msg_type = ""; 2841d560a5f8SJoe Perches 284247e0c88bSJoe Perches # Otherwise set the alternate message types 284347e0c88bSJoe Perches 284447e0c88bSJoe Perches # a comment starts before $max_line_length 284547e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 284647e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 284747e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 284847e0c88bSJoe Perches 284947e0c88bSJoe Perches # a quoted string starts before $max_line_length 285047e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 285147e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 285247e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 285347e0c88bSJoe Perches } 285447e0c88bSJoe Perches 285547e0c88bSJoe Perches if ($msg_type ne "" && 285647e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 285747e0c88bSJoe Perches WARN($msg_type, 28586cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 28590a920b5bSAndy Whitcroft } 286047e0c88bSJoe Perches } 28610a920b5bSAndy Whitcroft 28628905a67cSAndy Whitcroft# check for adding lines without a newline. 28638905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2864000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2865000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 28668905a67cSAndy Whitcroft } 28678905a67cSAndy Whitcroft 286842e41c54SMike Frysinger# Blackfin: use hi/lo macros 286942e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 287042e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 287142e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2872000d1cc1SJoe Perches ERROR("LO_MACRO", 2873000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 287442e41c54SMike Frysinger } 287542e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 287642e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2877000d1cc1SJoe Perches ERROR("HI_MACRO", 2878000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 287942e41c54SMike Frysinger } 288042e41c54SMike Frysinger } 288142e41c54SMike Frysinger 2882b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2883de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 28840a920b5bSAndy Whitcroft 28850a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 28860a920b5bSAndy Whitcroft# more than 8 must use tabs. 2887c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2888c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2889c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2890d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 28913705ce5bSJoe Perches if (ERROR("CODE_INDENT", 28923705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 28933705ce5bSJoe Perches $fix) { 2894194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 28953705ce5bSJoe Perches } 28960a920b5bSAndy Whitcroft } 28970a920b5bSAndy Whitcroft 289808e44365SAlberto Panizzo# check for space before tabs. 289908e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 290008e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 29013705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 29023705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 29033705ce5bSJoe Perches $fix) { 2904194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2905d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 2906194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2907c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 29083705ce5bSJoe Perches } 290908e44365SAlberto Panizzo } 291008e44365SAlberto Panizzo 2911d1fe9c09SJoe Perches# check for && or || at the start of a line 2912d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2913d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2914d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2915d1fe9c09SJoe Perches } 2916d1fe9c09SJoe Perches 2917a91e8994SJoe Perches# check indentation starts on a tab stop 2918a91e8994SJoe Perches if ($^V && $^V ge 5.10.0 && 2919a91e8994SJoe Perches $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) { 2920a91e8994SJoe Perches my $indent = length($1); 2921a91e8994SJoe Perches if ($indent % 8) { 2922a91e8994SJoe Perches if (WARN("TABSTOP", 2923a91e8994SJoe Perches "Statements should start on a tabstop\n" . $herecurr) && 2924a91e8994SJoe Perches $fix) { 2925a91e8994SJoe Perches $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; 2926a91e8994SJoe Perches } 2927a91e8994SJoe Perches } 2928a91e8994SJoe Perches } 2929a91e8994SJoe Perches 2930d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2931d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 293291cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2933d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2934d1fe9c09SJoe Perches my $oldindent = $1; 2935d1fe9c09SJoe Perches my $rest = $2; 2936d1fe9c09SJoe Perches 2937d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2938d1fe9c09SJoe Perches if ($pos >= 0) { 2939b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2940b34a26f3SJoe Perches my $newindent = $2; 2941d1fe9c09SJoe Perches 2942d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2943d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2944d1fe9c09SJoe Perches " " x ($pos % 8); 2945d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2946d1fe9c09SJoe Perches 2947d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2948d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 29493705ce5bSJoe Perches 29503705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 29513705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 29523705ce5bSJoe Perches $fix && $line =~ /^\+/) { 2953194f66fcSJoe Perches $fixed[$fixlinenr] =~ 29543705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 29553705ce5bSJoe Perches } 2956d1fe9c09SJoe Perches } 2957d1fe9c09SJoe Perches } 2958d1fe9c09SJoe Perches } 2959d1fe9c09SJoe Perches 29606ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 29616ab3a970SJoe Perches# avoid checking a few false positives: 29626ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 29636ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 29646ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 29656ab3a970SJoe Perches# multiline macros that define functions 29666ab3a970SJoe Perches# known attributes or the __attribute__ keyword 29676ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 29686ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 29693705ce5bSJoe Perches if (CHK("SPACING", 2970f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 29713705ce5bSJoe Perches $fix) { 2972194f66fcSJoe Perches $fixed[$fixlinenr] =~ 2973f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 29743705ce5bSJoe Perches } 2975aad4f614SJoe Perches } 2976aad4f614SJoe Perches 297786406b1cSJoe Perches# Block comment styles 297886406b1cSJoe Perches# Networking with an initial /* 297905880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2980fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 298185ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 298285ad978cSJoe Perches $realline > 2) { 298305880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 298405880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 298505880600SJoe Perches } 298605880600SJoe Perches 298786406b1cSJoe Perches# Block comments use * on subsequent lines 298886406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 298986406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 2990a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 299161135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2992a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 299386406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 299486406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 2995a605e32eSJoe Perches } 2996a605e32eSJoe Perches 299786406b1cSJoe Perches# Block comments use */ on trailing lines 299886406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2999c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3000c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3001c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 300286406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 300386406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 300405880600SJoe Perches } 300505880600SJoe Perches 300608eb9b80SJoe Perches# Block comment * alignment 300708eb9b80SJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 300808eb9b80SJoe Perches (($prevrawline =~ /^\+.*?\/\*/ && #starting /* 300908eb9b80SJoe Perches $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 301008eb9b80SJoe Perches $prevrawline =~ /^\+[ \t]*\*/) && #starting * 301108eb9b80SJoe Perches $rawline =~ /^\+[ \t]*\*/) { #rawline * 301208eb9b80SJoe Perches $prevrawline =~ m@^\+([ \t]*/?)\*@; 301308eb9b80SJoe Perches my $oldindent = expand_tabs($1); 301408eb9b80SJoe Perches $rawline =~ m@^\+([ \t]*)\*@; 301508eb9b80SJoe Perches my $newindent = $1; 301608eb9b80SJoe Perches my $test_comment = '^\\+' . "$;" x (length($newindent) + 1); 301708eb9b80SJoe Perches $newindent = expand_tabs($newindent); 301808eb9b80SJoe Perches if ($line =~ /$test_comment/ && 301908eb9b80SJoe Perches length($oldindent) ne length($newindent)) { 302008eb9b80SJoe Perches WARN("BLOCK_COMMENT_STYLE", 302108eb9b80SJoe Perches "Block comments should align the * on each line\n" . $hereprev); 302208eb9b80SJoe Perches } 302308eb9b80SJoe Perches } 302408eb9b80SJoe Perches 30257f619191SJoe Perches# check for missing blank lines after struct/union declarations 30267f619191SJoe Perches# with exceptions for various attributes and macros 30277f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 30287f619191SJoe Perches $line =~ /^\+/ && 30297f619191SJoe Perches !($line =~ /^\+\s*$/ || 30307f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 30317f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 30327f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 30337f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 30347f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 30357f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 30367f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 3037d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3038d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3039d752fcc8SJoe Perches $fix) { 3040f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3041d752fcc8SJoe Perches } 30427f619191SJoe Perches } 30437f619191SJoe Perches 3044365dd4eaSJoe Perches# check for multiple consecutive blank lines 3045365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 3046365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 3047365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 3048d752fcc8SJoe Perches if (CHK("LINE_SPACING", 3049d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 3050d752fcc8SJoe Perches $fix) { 3051f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3052d752fcc8SJoe Perches } 3053d752fcc8SJoe Perches 3054365dd4eaSJoe Perches $last_blank_line = $linenr; 3055365dd4eaSJoe Perches } 3056365dd4eaSJoe Perches 30573b617e3bSJoe Perches# check for missing blank lines after declarations 30583f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 30593f7bac03SJoe Perches # actual declarations 30603f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 30615a4e1fd3SJoe Perches # function pointer declarations 30625a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 30633f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 30643f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 30653f7bac03SJoe Perches # known declaration macros 30663f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 30673f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 30683f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 30693f7bac03SJoe Perches # other possible extensions of declaration lines 30703f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 30713f7bac03SJoe Perches # not starting a section or a macro "\" extended line 30723f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 30733f7bac03SJoe Perches # looks like a declaration 30743f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 30755a4e1fd3SJoe Perches # function pointer declarations 30765a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 30773f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 30783f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 30793f7bac03SJoe Perches # known declaration macros 30803f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 30813f7bac03SJoe Perches # start of struct or union or enum 30823b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 30833f7bac03SJoe Perches # start or end of block or continuation of declaration 30843f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 30853f7bac03SJoe Perches # bitfield continuation 30863f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 30873f7bac03SJoe Perches # other possible extensions of declaration lines 30883f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 30893f7bac03SJoe Perches # indentation of previous and current line are the same 30903f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 3091d752fcc8SJoe Perches if (WARN("LINE_SPACING", 3092d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 3093d752fcc8SJoe Perches $fix) { 3094f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 3095d752fcc8SJoe Perches } 30963b617e3bSJoe Perches } 30973b617e3bSJoe Perches 30985f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 30996b4c5bebSAndy Whitcroft# Exceptions: 31006b4c5bebSAndy Whitcroft# 1) within comments 31016b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 31026b4c5bebSAndy Whitcroft# 3) hanging labels 31033705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 31045f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 31053705ce5bSJoe Perches if (WARN("LEADING_SPACE", 31063705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 31073705ce5bSJoe Perches $fix) { 3108194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 31093705ce5bSJoe Perches } 31105f7ddae6SRaffaele Recalcati } 31115f7ddae6SRaffaele Recalcati 3112b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 3113b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 3114b9ea10d6SAndy Whitcroft 3115032a4c0fSJoe Perches# check indentation of any line with a bare else 3116840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3117032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 3118032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3119032a4c0fSJoe Perches my $tabs = length($1) + 1; 3120840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3121840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3122840080a0SJoe Perches defined $lines[$linenr] && 3123840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3124032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 3125032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 3126032a4c0fSJoe Perches } 3127032a4c0fSJoe Perches } 3128032a4c0fSJoe Perches 3129c00df19aSJoe Perches# check indentation of a line with a break; 3130c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 3131c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3132c00df19aSJoe Perches my $tabs = $1; 3133c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 3134c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 3135c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 3136c00df19aSJoe Perches } 3137c00df19aSJoe Perches } 3138c00df19aSJoe Perches 31391ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 31401ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 31411ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 31421ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 31431ba8dfd1SKees Cook } 31441ba8dfd1SKees Cook 3145c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 3146cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3147000d1cc1SJoe Perches WARN("CVS_KEYWORD", 3148000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3149c2fdda0dSAndy Whitcroft } 315022f2a2efSAndy Whitcroft 315142e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 315242e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 315342e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 3154000d1cc1SJoe Perches ERROR("CSYNC", 3155000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 315642e41c54SMike Frysinger } 315742e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 315842e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 3159000d1cc1SJoe Perches ERROR("SSYNC", 3160000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 316142e41c54SMike Frysinger } 316242e41c54SMike Frysinger 316356e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 316456e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 316556e77d70SJoe Perches WARN("HOTPLUG_SECTION", 316656e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 316756e77d70SJoe Perches } 316856e77d70SJoe Perches 31699c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 31702b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 31712b474a1aSAndy Whitcroft $realline_next); 31723e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 31733e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 31741b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 3175170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3176f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3177171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 3178171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 3179171ae1a4SAndy Whitcroft 31803e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 31813e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 31823e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 31833e469cdcSAndy Whitcroft # until we hit end of it. 31843e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 31853e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 31863e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 31873e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 31883e469cdcSAndy Whitcroft } 3189f74bd194SAndy Whitcroft 31902b474a1aSAndy Whitcroft # Find the real next line. 31912b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 31922b474a1aSAndy Whitcroft if (defined $realline_next && 31932b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 31942b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 31952b474a1aSAndy Whitcroft $realline_next++; 31962b474a1aSAndy Whitcroft } 31972b474a1aSAndy Whitcroft 3198171ae1a4SAndy Whitcroft my $s = $stat; 3199171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3200cf655043SAndy Whitcroft 3201c2fdda0dSAndy Whitcroft # Ignore goto labels. 3202171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3203c2fdda0dSAndy Whitcroft 3204c2fdda0dSAndy Whitcroft # Ignore functions being called 3205171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3206c2fdda0dSAndy Whitcroft 3207463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3208463f2864SAndy Whitcroft 3209c45dcabdSAndy Whitcroft # declarations always start with types 3210d2506586SAndy 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) { 3211c45dcabdSAndy Whitcroft my $type = $1; 3212c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3213c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3214c45dcabdSAndy Whitcroft 32156c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3216a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3217c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3218c2fdda0dSAndy Whitcroft } 32198905a67cSAndy Whitcroft 32206c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 322165863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3222c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 32239c0ca6f9SAndy Whitcroft } 32248905a67cSAndy Whitcroft 32258905a67cSAndy Whitcroft # Check for any sort of function declaration. 32268905a67cSAndy Whitcroft # int foo(something bar, other baz); 32278905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3228171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 32298905a67cSAndy Whitcroft my ($name_len) = length($1); 32308905a67cSAndy Whitcroft 3231cf655043SAndy Whitcroft my $ctx = $s; 3232773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 32338905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3234cf655043SAndy Whitcroft 32358905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3236c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 32378905a67cSAndy Whitcroft 3238c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 32398905a67cSAndy Whitcroft } 32408905a67cSAndy Whitcroft } 32418905a67cSAndy Whitcroft } 32428905a67cSAndy Whitcroft 32439c0ca6f9SAndy Whitcroft } 32449c0ca6f9SAndy Whitcroft 324500df344fSAndy Whitcroft# 324600df344fSAndy Whitcroft# Checks which may be anchored in the context. 324700df344fSAndy Whitcroft# 324800df344fSAndy Whitcroft 324900df344fSAndy Whitcroft# Check for switch () and associated case and default 325000df344fSAndy Whitcroft# statements should be at the same indent. 325100df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 325200df344fSAndy Whitcroft my $err = ''; 325300df344fSAndy Whitcroft my $sep = ''; 325400df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 325500df344fSAndy Whitcroft shift(@ctx); 325600df344fSAndy Whitcroft for my $ctx (@ctx) { 325700df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 325800df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 325900df344fSAndy Whitcroft $indent != $cindent) { 326000df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 326100df344fSAndy Whitcroft $sep = ''; 326200df344fSAndy Whitcroft } else { 326300df344fSAndy Whitcroft $sep = "[...]\n"; 326400df344fSAndy Whitcroft } 326500df344fSAndy Whitcroft } 326600df344fSAndy Whitcroft if ($err ne '') { 3267000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3268000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3269de7d4f0eSAndy Whitcroft } 3270de7d4f0eSAndy Whitcroft } 3271de7d4f0eSAndy Whitcroft 3272de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3273de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 32740fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3275773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3276773647a0SAndy Whitcroft 32779c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 32788eef05ddSJoe Perches 32798eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 32808eef05ddSJoe Perches WARN("DEEP_INDENTATION", 32818eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 32828eef05ddSJoe Perches } 32838eef05ddSJoe Perches 3284de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3285de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3286de7d4f0eSAndy Whitcroft 3287548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3288548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3289de7d4f0eSAndy Whitcroft 3290548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3291548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3292548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3293548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3294548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3295773647a0SAndy Whitcroft $ctx_ln++; 3296773647a0SAndy Whitcroft } 3297548596d5SAndy Whitcroft 329853210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 329953210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3300773647a0SAndy Whitcroft 3301773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3302000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3303000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 330401464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 330500df344fSAndy Whitcroft } 3306773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3307773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3308773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3309773647a0SAndy Whitcroft { 33109c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 33119c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3312000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3313000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 331401464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 33159c0ca6f9SAndy Whitcroft } 33169c0ca6f9SAndy Whitcroft } 331700df344fSAndy Whitcroft } 331800df344fSAndy Whitcroft 33194d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 33200fe3dc2bSJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 33213e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 33223e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 33233e469cdcSAndy Whitcroft if (!defined $stat); 33244d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 33254d001e4dSAndy Whitcroft 33264d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 33274d001e4dSAndy Whitcroft 33289f5af480SJoe Perches # remove inline comments 33299f5af480SJoe Perches $s =~ s/$;/ /g; 33309f5af480SJoe Perches $c =~ s/$;/ /g; 33314d001e4dSAndy Whitcroft 33324d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 33336f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 33346f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 33354d001e4dSAndy Whitcroft 33369f5af480SJoe Perches # Make sure we remove the line prefixes as we have 33379f5af480SJoe Perches # none on the first line, and are going to readd them 33389f5af480SJoe Perches # where necessary. 33399f5af480SJoe Perches $s =~ s/\n./\n/gs; 33409f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 33419f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 33429f5af480SJoe Perches } 33439f5af480SJoe Perches 33444d001e4dSAndy Whitcroft # We want to check the first line inside the block 33454d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 33464d001e4dSAndy Whitcroft # 1) any blank line termination 33474d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 33484d001e4dSAndy Whitcroft # 3) any do (...) { 33494d001e4dSAndy Whitcroft my $continuation = 0; 33504d001e4dSAndy Whitcroft my $check = 0; 33514d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 33524d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 33534d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 33544d001e4dSAndy Whitcroft $continuation = 1; 33554d001e4dSAndy Whitcroft } 33569bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 33574d001e4dSAndy Whitcroft $check = 1; 33584d001e4dSAndy Whitcroft $cond_lines++; 33594d001e4dSAndy Whitcroft } 33604d001e4dSAndy Whitcroft 33614d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 33624d001e4dSAndy Whitcroft # preprocessor statement. 33634d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 33644d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 33654d001e4dSAndy Whitcroft $check = 0; 33664d001e4dSAndy Whitcroft } 33674d001e4dSAndy Whitcroft 33689bd49efeSAndy Whitcroft my $cond_ptr = -1; 3369740504c6SAndy Whitcroft $continuation = 0; 33709bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 33719bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 33724d001e4dSAndy Whitcroft 3373f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3374f16fa28fSAndy Whitcroft # is not linear. 3375f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3376f16fa28fSAndy Whitcroft $check = 0; 3377f16fa28fSAndy Whitcroft } 3378f16fa28fSAndy Whitcroft 33799bd49efeSAndy Whitcroft # Ignore: 33809bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 33819bd49efeSAndy Whitcroft # 2) preprocessor lines, and 33829bd49efeSAndy Whitcroft # 3) labels. 3383740504c6SAndy Whitcroft if ($continuation || 3384740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 33859bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 33869bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3387740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 338830dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 33899bd49efeSAndy Whitcroft $cond_lines++; 33909bd49efeSAndy Whitcroft } 33914d001e4dSAndy Whitcroft } 339230dad6ebSAndy Whitcroft } 33934d001e4dSAndy Whitcroft 33944d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 33954d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 33964d001e4dSAndy Whitcroft 33974d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 33984d001e4dSAndy Whitcroft # this is not this patch's fault. 33994d001e4dSAndy Whitcroft if (!defined($stat_real) || 34004d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 34014d001e4dSAndy Whitcroft $check = 0; 34024d001e4dSAndy Whitcroft } 34034d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 34044d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 34054d001e4dSAndy Whitcroft } 34064d001e4dSAndy Whitcroft 34079bd49efeSAndy 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"; 34084d001e4dSAndy Whitcroft 34099f5af480SJoe Perches if ($check && $s ne '' && 34109f5af480SJoe Perches (($sindent % 8) != 0 || 34119f5af480SJoe Perches ($sindent < $indent) || 34129f5af480SJoe Perches ($sindent > $indent + 8))) { 3413000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3414000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 34154d001e4dSAndy Whitcroft } 34164d001e4dSAndy Whitcroft } 34174d001e4dSAndy Whitcroft 34186c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 34196c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 34201f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 34211f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 34226c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3423c2fdda0dSAndy Whitcroft if ($dbg_values) { 3424c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3425cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3426cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 34271f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3428c2fdda0dSAndy Whitcroft } 34296c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 34306c72ffaaSAndy Whitcroft 343100df344fSAndy Whitcroft#ignore lines not being added 34323705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 343300df344fSAndy Whitcroft 3434a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3435c8447115SJoe Perches while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 3436a1ce18e4SJoe Perches my $type = $1; 3437a1ce18e4SJoe Perches my $var = $2; 3438207a8e84SJoe Perches $var = "" if (!defined $var); 3439207a8e84SJoe Perches if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 3440a1ce18e4SJoe Perches my $sign = $1; 3441a1ce18e4SJoe Perches my $pointer = $2; 3442a1ce18e4SJoe Perches 3443a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3444a1ce18e4SJoe Perches 3445a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3446a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3447a1ce18e4SJoe Perches $fix) { 3448a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3449207a8e84SJoe Perches my $comp_pointer = $pointer; 3450207a8e84SJoe Perches $comp_pointer =~ s/\s//g; 3451207a8e84SJoe Perches $decl .= $comp_pointer; 3452207a8e84SJoe Perches $decl = rtrim($decl) if ($var eq ""); 3453207a8e84SJoe Perches $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 3454a1ce18e4SJoe Perches } 3455a1ce18e4SJoe Perches } 3456a1ce18e4SJoe Perches } 3457a1ce18e4SJoe Perches 3458653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 34597429c690SAndy Whitcroft if ($dbg_type) { 34607429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3461000d1cc1SJoe Perches ERROR("TEST_TYPE", 3462000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 34637429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3464000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3465000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 34667429c690SAndy Whitcroft } 3467653d4876SAndy Whitcroft next; 3468653d4876SAndy Whitcroft } 3469a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3470a1ef277eSAndy Whitcroft if ($dbg_attr) { 34719360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3472000d1cc1SJoe Perches ERROR("TEST_ATTR", 3473000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 34749360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3475000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3476000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3477a1ef277eSAndy Whitcroft } 3478a1ef277eSAndy Whitcroft next; 3479a1ef277eSAndy Whitcroft } 3480653d4876SAndy Whitcroft 3481f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 348299423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 348399423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3484d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3485d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3486f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3487f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3488f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3489d752fcc8SJoe Perches my $fixedline = $prevrawline; 3490d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3491f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3492d752fcc8SJoe Perches $fixedline = $line; 3493d752fcc8SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1/; 3494f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3495d752fcc8SJoe Perches } 3496f0a594c1SAndy Whitcroft } 3497f0a594c1SAndy Whitcroft 349800df344fSAndy Whitcroft# 349900df344fSAndy Whitcroft# Checks which are anchored on the added line. 350000df344fSAndy Whitcroft# 350100df344fSAndy Whitcroft 3502653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3503c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3504653d4876SAndy Whitcroft my $path = $1; 3505653d4876SAndy Whitcroft if ($path =~ m{//}) { 3506000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3507495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3508495e9d84SJoe Perches } 3509495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3510495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3511495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3512653d4876SAndy Whitcroft } 3513653d4876SAndy Whitcroft } 3514653d4876SAndy Whitcroft 351500df344fSAndy Whitcroft# no C99 // comments 351600df344fSAndy Whitcroft if ($line =~ m{//}) { 35173705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 35183705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 35193705ce5bSJoe Perches $fix) { 3520194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 35213705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 35223705ce5bSJoe Perches my $comment = trim($1); 3523194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 35243705ce5bSJoe Perches } 35253705ce5bSJoe Perches } 352600df344fSAndy Whitcroft } 352700df344fSAndy Whitcroft # Remove C99 comments. 35280a920b5bSAndy Whitcroft $line =~ s@//.*@@; 35296c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 35300a920b5bSAndy Whitcroft 35312b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 35322b474a1aSAndy Whitcroft# the whole statement. 35332b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 35342b474a1aSAndy Whitcroft if (defined $realline_next && 35352b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 35362b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 35372b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 35382b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 35393cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 35403cbf62dfSAndy Whitcroft # a prefix: 35413cbf62dfSAndy Whitcroft # XXX(foo); 35423cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3543653d4876SAndy Whitcroft my $name = $1; 354487a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 35453cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 35463cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 35473cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 35483cbf62dfSAndy Whitcroft 35493cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 35502b474a1aSAndy Whitcroft \n.}\s*$| 355148012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 355248012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 355348012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 35542b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 35552b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 355648012058SAndy Whitcroft )/x) { 35572b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 35582b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 35592b474a1aSAndy Whitcroft } else { 35602b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 35610a920b5bSAndy Whitcroft } 35620a920b5bSAndy Whitcroft } 35632b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 35642b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 35652b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 35662b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 35672b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 35682b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 35692b474a1aSAndy Whitcroft } 35702b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 35712b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3572000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3573000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 35742b474a1aSAndy Whitcroft } 35750a920b5bSAndy Whitcroft 35765150bda4SJoe Eloff# check for global initialisers. 35776d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 3578d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 35796d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 3580d5e616fcSJoe Perches $fix) { 35816d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 3582d5e616fcSJoe Perches } 3583f0a594c1SAndy Whitcroft } 35840a920b5bSAndy Whitcroft# check for static initialisers. 35856d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 3586d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 35876d32f7a3SJoe Perches "do not initialise statics to $1\n" . 3588d5e616fcSJoe Perches $herecurr) && 3589d5e616fcSJoe Perches $fix) { 35906d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 3591d5e616fcSJoe Perches } 35920a920b5bSAndy Whitcroft } 35930a920b5bSAndy Whitcroft 35941813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 35951813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 35961813087dSJoe Perches my $tmp = trim($1); 35971813087dSJoe Perches WARN("MISORDERED_TYPE", 35981813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 35991813087dSJoe Perches } 36001813087dSJoe Perches 3601cb710ecaSJoe Perches# check for static const char * arrays. 3602cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3603000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3604000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3605cb710ecaSJoe Perches $herecurr); 3606cb710ecaSJoe Perches } 3607cb710ecaSJoe Perches 3608cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3609cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3610000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3611000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3612cb710ecaSJoe Perches $herecurr); 3613cb710ecaSJoe Perches } 3614cb710ecaSJoe Perches 3615ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3616ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3617ab7e23f3SJoe Perches my $found = $1; 3618ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3619ab7e23f3SJoe Perches WARN("CONST_CONST", 3620ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3621ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3622ab7e23f3SJoe Perches WARN("CONST_CONST", 3623ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3624ab7e23f3SJoe Perches } 3625ab7e23f3SJoe Perches } 3626ab7e23f3SJoe Perches 36279b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 36289b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 36299b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 36309b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 36319b0fa60dSJoe Perches $herecurr); 36329b0fa60dSJoe Perches } 36339b0fa60dSJoe Perches 3634b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3635b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3636b598b670SJoe Perches my $array = $1; 3637b598b670SJoe 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*\))@) { 3638b598b670SJoe Perches my $array_div = $1; 3639b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3640b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3641b598b670SJoe Perches $fix) { 3642b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3643b598b670SJoe Perches } 3644b598b670SJoe Perches } 3645b598b670SJoe Perches } 3646b598b670SJoe Perches 3647b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3648b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3649b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3650b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3651b36190c5SJoe Perches $fix) { 3652194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3653b36190c5SJoe Perches } 3654b36190c5SJoe Perches } 3655b36190c5SJoe Perches 3656653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3657653d4876SAndy Whitcroft# make sense. 3658653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 36598054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3660c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 36618ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 3662653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 3663000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3664000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 36650a920b5bSAndy Whitcroft } 36660a920b5bSAndy Whitcroft 36670a920b5bSAndy Whitcroft# * goes on variable not on type 366865863862SAndy Whitcroft # (char*[ const]) 3669bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3670bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 36713705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3672d8aaf121SAndy Whitcroft 367365863862SAndy Whitcroft # Should start with a space. 367465863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 367565863862SAndy Whitcroft # Should not end with a space. 367665863862SAndy Whitcroft $to =~ s/\s+$//; 367765863862SAndy Whitcroft # '*'s should not have spaces between. 3678f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 367965863862SAndy Whitcroft } 3680d8aaf121SAndy Whitcroft 36813705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 368265863862SAndy Whitcroft if ($from ne $to) { 36833705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 36843705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 36853705ce5bSJoe Perches $fix) { 36863705ce5bSJoe Perches my $sub_from = $ident; 36873705ce5bSJoe Perches my $sub_to = $ident; 36883705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3689194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36903705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 36913705ce5bSJoe Perches } 369265863862SAndy Whitcroft } 3693bfcb2cc7SAndy Whitcroft } 3694bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3695bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 36963705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3697d8aaf121SAndy Whitcroft 369865863862SAndy Whitcroft # Should start with a space. 369965863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 370065863862SAndy Whitcroft # Should not end with a space. 370165863862SAndy Whitcroft $to =~ s/\s+$//; 370265863862SAndy Whitcroft # '*'s should not have spaces between. 3703f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 370465863862SAndy Whitcroft } 370565863862SAndy Whitcroft # Modifiers should have spaces. 370665863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 370765863862SAndy Whitcroft 37083705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3709667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 37103705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 37113705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 37123705ce5bSJoe Perches $fix) { 37133705ce5bSJoe Perches 37143705ce5bSJoe Perches my $sub_from = $match; 37153705ce5bSJoe Perches my $sub_to = $match; 37163705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3717194f66fcSJoe Perches $fixed[$fixlinenr] =~ 37183705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 37193705ce5bSJoe Perches } 372065863862SAndy Whitcroft } 37210a920b5bSAndy Whitcroft } 37220a920b5bSAndy Whitcroft 37239d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 37249d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 37259d3e3c70SJoe Perches my $msg_type = \&WARN; 37269d3e3c70SJoe Perches $msg_type = \&CHK if ($file); 37279d3e3c70SJoe Perches &{$msg_type}("AVOID_BUG", 37289d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 37299d3e3c70SJoe Perches } 37300a920b5bSAndy Whitcroft 37319d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 37328905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3733000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3734000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 37358905a67cSAndy Whitcroft } 37368905a67cSAndy Whitcroft 373717441227SJoe Perches# check for uses of printk_ratelimit 373817441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3739000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3740000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 374117441227SJoe Perches } 374217441227SJoe Perches 374300df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 374400df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 374500df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 374625985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 374700df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 3748f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 374900df344fSAndy Whitcroft my $ok = 0; 375000df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 375100df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 375225985edcSLucas De Marchi # we have a preceding printk if it ends 375300df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 375400df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 375500df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 375600df344fSAndy Whitcroft $ok = 1; 375700df344fSAndy Whitcroft } 375800df344fSAndy Whitcroft last; 375900df344fSAndy Whitcroft } 376000df344fSAndy Whitcroft } 376100df344fSAndy Whitcroft if ($ok == 0) { 3762000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3763000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 37640a920b5bSAndy Whitcroft } 376500df344fSAndy Whitcroft } 37660a920b5bSAndy Whitcroft 3767243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3768243f3803SJoe Perches my $orig = $1; 3769243f3803SJoe Perches my $level = lc($orig); 3770243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 37718f26b837SJoe Perches my $level2 = $level; 37728f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3773243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3774daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3775243f3803SJoe Perches } 3776243f3803SJoe Perches 3777243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3778d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3779d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3780d5e616fcSJoe Perches $fix) { 3781194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3782d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3783d5e616fcSJoe Perches } 3784243f3803SJoe Perches } 3785243f3803SJoe Perches 3786dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3787dc139313SJoe Perches my $orig = $1; 3788dc139313SJoe Perches my $level = lc($orig); 3789dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3790dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3791dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3792dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3793dc139313SJoe Perches } 3794dc139313SJoe Perches 379591c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 379691c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 379791c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 379891c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 379991c9afafSAndy Lutomirski WARN("ENOSYS", 380091c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 380191c9afafSAndy Lutomirski } 380291c9afafSAndy Lutomirski 3803653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3804653d4876SAndy Whitcroft# or if closed on same line 38058d182478SJoe Perches if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and 38064e5d56bdSEddie Kovsky !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) { 38078d182478SJoe Perches if (ERROR("OPEN_BRACE", 38088d182478SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr) && 38098d182478SJoe Perches $fix) { 38108d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 38118d182478SJoe Perches my $fixed_line = $rawline; 38128d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 38138d182478SJoe Perches my $line1 = $1; 38148d182478SJoe Perches my $line2 = $2; 38158d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 38168d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 38178d182478SJoe Perches if ($line2 !~ /^\s*$/) { 38188d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 38198d182478SJoe Perches } 38208d182478SJoe Perches } 38210a920b5bSAndy Whitcroft } 3822653d4876SAndy Whitcroft 38238905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 38248905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 38258905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 38268d182478SJoe Perches if (ERROR("OPEN_BRACE", 38278d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 38288d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 38298d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 38308d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 38318d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 38328d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 38338d182478SJoe Perches $fixedline = $rawline; 38348d182478SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1\t/; 38358d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 38368d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 38378d182478SJoe Perches } 38388d182478SJoe Perches } 38398905a67cSAndy Whitcroft } 38408905a67cSAndy Whitcroft 38410c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 38423705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 38433705ce5bSJoe Perches if (WARN("SPACING", 38443705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 38453705ce5bSJoe Perches $fix) { 3846194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38473705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 38483705ce5bSJoe Perches } 38490c73b4ebSAndy Whitcroft } 38500c73b4ebSAndy Whitcroft 385131070b5dSJoe Perches# Function pointer declarations 385231070b5dSJoe Perches# check spacing between type, funcptr, and args 385331070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 385491f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 385531070b5dSJoe Perches my $declare = $1; 385631070b5dSJoe Perches my $pre_pointer_space = $2; 385731070b5dSJoe Perches my $post_pointer_space = $3; 385831070b5dSJoe Perches my $funcname = $4; 385931070b5dSJoe Perches my $post_funcname_space = $5; 386031070b5dSJoe Perches my $pre_args_space = $6; 386131070b5dSJoe Perches 386291f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 386391f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 386491f72e9cSJoe Perches# don't need a space so don't warn for those. 386591f72e9cSJoe Perches my $post_declare_space = ""; 386691f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 386791f72e9cSJoe Perches $post_declare_space = $1; 386891f72e9cSJoe Perches $declare = rtrim($declare); 386991f72e9cSJoe Perches } 387091f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 387131070b5dSJoe Perches WARN("SPACING", 387231070b5dSJoe Perches "missing space after return type\n" . $herecurr); 387391f72e9cSJoe Perches $post_declare_space = " "; 387431070b5dSJoe Perches } 387531070b5dSJoe Perches 387631070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 387791f72e9cSJoe Perches# This test is not currently implemented because these declarations are 387891f72e9cSJoe Perches# equivalent to 387991f72e9cSJoe Perches# int foo(int bar, ...) 388091f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 388191f72e9cSJoe Perches# 388291f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 388391f72e9cSJoe Perches# WARN("SPACING", 388491f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 388591f72e9cSJoe Perches# } 388631070b5dSJoe Perches 388731070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 388831070b5dSJoe Perches if (defined $pre_pointer_space && 388931070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 389031070b5dSJoe Perches WARN("SPACING", 389131070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 389231070b5dSJoe Perches } 389331070b5dSJoe Perches 389431070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 389531070b5dSJoe Perches if (defined $post_pointer_space && 389631070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 389731070b5dSJoe Perches WARN("SPACING", 389831070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 389931070b5dSJoe Perches } 390031070b5dSJoe Perches 390131070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 390231070b5dSJoe Perches if (defined $post_funcname_space && 390331070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 390431070b5dSJoe Perches WARN("SPACING", 390531070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 390631070b5dSJoe Perches } 390731070b5dSJoe Perches 390831070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 390931070b5dSJoe Perches if (defined $pre_args_space && 391031070b5dSJoe Perches $pre_args_space =~ /^\s/) { 391131070b5dSJoe Perches WARN("SPACING", 391231070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 391331070b5dSJoe Perches } 391431070b5dSJoe Perches 391531070b5dSJoe Perches if (show_type("SPACING") && $fix) { 3916194f66fcSJoe Perches $fixed[$fixlinenr] =~ 391791f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 391831070b5dSJoe Perches } 391931070b5dSJoe Perches } 392031070b5dSJoe Perches 39218d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 39228d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3923fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3924fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 39258d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 39268d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 39278d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3928fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3929daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 39303705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 39313705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 39323705ce5bSJoe Perches $fix) { 3933194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39343705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 39353705ce5bSJoe Perches } 39368d31cfceSAndy Whitcroft } 39378d31cfceSAndy Whitcroft } 39388d31cfceSAndy Whitcroft 3939f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 39406c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3941c2fdda0dSAndy Whitcroft my $name = $1; 3942773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3943773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3944c2fdda0dSAndy Whitcroft 3945c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3946773647a0SAndy Whitcroft if ($name =~ /^(?: 3947773647a0SAndy Whitcroft if|for|while|switch|return|case| 3948773647a0SAndy Whitcroft volatile|__volatile__| 3949773647a0SAndy Whitcroft __attribute__|format|__extension__| 3950773647a0SAndy Whitcroft asm|__asm__)$/x) 3951773647a0SAndy Whitcroft { 3952c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3953c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3954c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3955c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3956773647a0SAndy Whitcroft 3957773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3958c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3959c2fdda0dSAndy Whitcroft 3960c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3961c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3962773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3963c2fdda0dSAndy Whitcroft 3964c2fdda0dSAndy Whitcroft } else { 39653705ce5bSJoe Perches if (WARN("SPACING", 39663705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 39673705ce5bSJoe Perches $fix) { 3968194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39693705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 39703705ce5bSJoe Perches } 3971f0a594c1SAndy Whitcroft } 39726c72ffaaSAndy Whitcroft } 39739a4cad4eSEric Nelson 3974653d4876SAndy Whitcroft# Check operator spacing. 39750a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 39763705ce5bSJoe Perches my $fixed_line = ""; 39773705ce5bSJoe Perches my $line_fixed = 0; 39783705ce5bSJoe Perches 39799c0ca6f9SAndy Whitcroft my $ops = qr{ 39809c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 39819c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 39829c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 39831f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 398484731623SJoe Perches \?:|\?|: 39859c0ca6f9SAndy Whitcroft }x; 3986cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 39873705ce5bSJoe Perches 39883705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 39893705ce5bSJoe Perches## foreach my $el (@elements) { 39903705ce5bSJoe Perches## print("el: <$el>\n"); 39913705ce5bSJoe Perches## } 39923705ce5bSJoe Perches 39933705ce5bSJoe Perches my @fix_elements = (); 399400df344fSAndy Whitcroft my $off = 0; 39956c72ffaaSAndy Whitcroft 39963705ce5bSJoe Perches foreach my $el (@elements) { 39973705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 39983705ce5bSJoe Perches $off += length($el); 39993705ce5bSJoe Perches } 40003705ce5bSJoe Perches 40013705ce5bSJoe Perches $off = 0; 40023705ce5bSJoe Perches 40036c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 4004b34c648bSJoe Perches my $last_after = -1; 40056c72ffaaSAndy Whitcroft 40060a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 40073705ce5bSJoe Perches 40083705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 40093705ce5bSJoe Perches 40103705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 40113705ce5bSJoe Perches 40124a0df2efSAndy Whitcroft $off += length($elements[$n]); 40134a0df2efSAndy Whitcroft 401425985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 4015773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 4016773647a0SAndy Whitcroft my $cc = ''; 4017773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 4018773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 4019773647a0SAndy Whitcroft } 4020773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 4021773647a0SAndy Whitcroft 40224a0df2efSAndy Whitcroft my $a = ''; 40234a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 40244a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 4025cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 40264a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 40274a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 4028773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 40294a0df2efSAndy Whitcroft 40300a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 40314a0df2efSAndy Whitcroft 40324a0df2efSAndy Whitcroft my $c = ''; 40330a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 40344a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 40354a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4036cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 40374a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 40384a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 40398b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 40404a0df2efSAndy Whitcroft } else { 40414a0df2efSAndy Whitcroft $c = 'E'; 40420a920b5bSAndy Whitcroft } 40430a920b5bSAndy Whitcroft 40444a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 40454a0df2efSAndy Whitcroft 40464a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 40474a0df2efSAndy Whitcroft 40486c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 4049de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 40500a920b5bSAndy Whitcroft 405174048ed8SAndy Whitcroft # Pull out the value of this operator. 40526c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 40530a920b5bSAndy Whitcroft 40541f65f947SAndy Whitcroft # Get the full operator variant. 40551f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 40561f65f947SAndy Whitcroft 405713214adfSAndy Whitcroft # Ignore operators passed as parameters. 405813214adfSAndy Whitcroft if ($op_type ne 'V' && 4059d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 406013214adfSAndy Whitcroft 4061cf655043SAndy Whitcroft# # Ignore comments 4062cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 406313214adfSAndy Whitcroft 4064d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 406513214adfSAndy Whitcroft } elsif ($op eq ';') { 4066cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 4067cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 40683705ce5bSJoe Perches if (ERROR("SPACING", 40693705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 4070b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 40713705ce5bSJoe Perches $line_fixed = 1; 40723705ce5bSJoe Perches } 4073d8aaf121SAndy Whitcroft } 4074d8aaf121SAndy Whitcroft 4075d8aaf121SAndy Whitcroft # // is a comment 4076d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 40770a920b5bSAndy Whitcroft 4078b00e4814SJoe Perches # : when part of a bitfield 4079b00e4814SJoe Perches } elsif ($opv eq ':B') { 4080b00e4814SJoe Perches # skip the bitfield test for now 4081b00e4814SJoe Perches 40821f65f947SAndy Whitcroft # No spaces for: 40831f65f947SAndy Whitcroft # -> 4084b00e4814SJoe Perches } elsif ($op eq '->') { 40854a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 40863705ce5bSJoe Perches if (ERROR("SPACING", 40873705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4088b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 40893705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 40903705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 40913705ce5bSJoe Perches } 4092b34c648bSJoe Perches $line_fixed = 1; 40933705ce5bSJoe Perches } 40940a920b5bSAndy Whitcroft } 40950a920b5bSAndy Whitcroft 40962381097bSJoe Perches # , must not have a space before and must have a space on the right. 40970a920b5bSAndy Whitcroft } elsif ($op eq ',') { 40982381097bSJoe Perches my $rtrim_before = 0; 40992381097bSJoe Perches my $space_after = 0; 41002381097bSJoe Perches if ($ctx =~ /Wx./) { 41012381097bSJoe Perches if (ERROR("SPACING", 41022381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 41032381097bSJoe Perches $line_fixed = 1; 41042381097bSJoe Perches $rtrim_before = 1; 41052381097bSJoe Perches } 41062381097bSJoe Perches } 4107cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 41083705ce5bSJoe Perches if (ERROR("SPACING", 41093705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 41103705ce5bSJoe Perches $line_fixed = 1; 4111b34c648bSJoe Perches $last_after = $n; 41122381097bSJoe Perches $space_after = 1; 41132381097bSJoe Perches } 41142381097bSJoe Perches } 41152381097bSJoe Perches if ($rtrim_before || $space_after) { 41162381097bSJoe Perches if ($rtrim_before) { 41172381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 41182381097bSJoe Perches } else { 41192381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 41202381097bSJoe Perches } 41212381097bSJoe Perches if ($space_after) { 41222381097bSJoe Perches $good .= " "; 41233705ce5bSJoe Perches } 41240a920b5bSAndy Whitcroft } 41250a920b5bSAndy Whitcroft 41269c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 412774048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 41289c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 41299c0ca6f9SAndy Whitcroft 41309c0ca6f9SAndy Whitcroft # unary operators should have a space before and 41319c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 41329c0ca6f9SAndy Whitcroft # unary operator, or a cast 41339c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 413474048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 41350d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 4136cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 41373705ce5bSJoe Perches if (ERROR("SPACING", 41383705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 4139b34c648bSJoe Perches if ($n != $last_after + 2) { 4140b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 41413705ce5bSJoe Perches $line_fixed = 1; 41423705ce5bSJoe Perches } 41430a920b5bSAndy Whitcroft } 4144b34c648bSJoe Perches } 4145a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4146171ae1a4SAndy Whitcroft # A unary '*' may be const 4147171ae1a4SAndy Whitcroft 4148171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 41493705ce5bSJoe Perches if (ERROR("SPACING", 41503705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4151b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 41523705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 41533705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 41543705ce5bSJoe Perches } 4155b34c648bSJoe Perches $line_fixed = 1; 41563705ce5bSJoe Perches } 41570a920b5bSAndy Whitcroft } 41580a920b5bSAndy Whitcroft 41590a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 41600a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 4161773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 41623705ce5bSJoe Perches if (ERROR("SPACING", 41633705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 4164b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 41653705ce5bSJoe Perches $line_fixed = 1; 41663705ce5bSJoe Perches } 41670a920b5bSAndy Whitcroft } 4168773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 4169773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 41703705ce5bSJoe Perches if (ERROR("SPACING", 41713705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4172b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 41733705ce5bSJoe Perches $line_fixed = 1; 41743705ce5bSJoe Perches } 4175653d4876SAndy Whitcroft } 4176773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 41773705ce5bSJoe Perches if (ERROR("SPACING", 41783705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 4179b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 41803705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 41813705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4182773647a0SAndy Whitcroft } 4183b34c648bSJoe Perches $line_fixed = 1; 41843705ce5bSJoe Perches } 41853705ce5bSJoe Perches } 41860a920b5bSAndy Whitcroft 41870a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 41889c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 41899c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 41909c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4191c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4192c2fdda0dSAndy Whitcroft $op eq '%') 41930a920b5bSAndy Whitcroft { 4194d2e025f3SJoe Perches if ($check) { 4195d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4196d2e025f3SJoe Perches if (CHK("SPACING", 4197d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4198d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4199d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4200d2e025f3SJoe Perches $line_fixed = 1; 4201d2e025f3SJoe Perches } 4202d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4203d2e025f3SJoe Perches if (CHK("SPACING", 4204d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4205d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4206d2e025f3SJoe Perches $line_fixed = 1; 4207d2e025f3SJoe Perches } 4208d2e025f3SJoe Perches } 4209d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 42103705ce5bSJoe Perches if (ERROR("SPACING", 42113705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4212b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4213b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4214b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4215b34c648bSJoe Perches } 42163705ce5bSJoe Perches $line_fixed = 1; 42173705ce5bSJoe Perches } 42180a920b5bSAndy Whitcroft } 42190a920b5bSAndy Whitcroft 42201f65f947SAndy Whitcroft # A colon needs no spaces before when it is 42211f65f947SAndy Whitcroft # terminating a case value or a label. 42221f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 42231f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 42243705ce5bSJoe Perches if (ERROR("SPACING", 42253705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4226b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 42273705ce5bSJoe Perches $line_fixed = 1; 42283705ce5bSJoe Perches } 42291f65f947SAndy Whitcroft } 42301f65f947SAndy Whitcroft 42310a920b5bSAndy Whitcroft # All the others need spaces both sides. 4232cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 42331f65f947SAndy Whitcroft my $ok = 0; 42341f65f947SAndy Whitcroft 423522f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 42361f65f947SAndy Whitcroft if (($op eq '<' && 42371f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 42381f65f947SAndy Whitcroft ($op eq '>' && 42391f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 42401f65f947SAndy Whitcroft { 42411f65f947SAndy Whitcroft $ok = 1; 42421f65f947SAndy Whitcroft } 42431f65f947SAndy Whitcroft 4244e0df7e1fSJoe Perches # for asm volatile statements 4245e0df7e1fSJoe Perches # ignore a colon with another 4246e0df7e1fSJoe Perches # colon immediately before or after 4247e0df7e1fSJoe Perches if (($op eq ':') && 4248e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4249e0df7e1fSJoe Perches $ok = 1; 4250e0df7e1fSJoe Perches } 4251e0df7e1fSJoe Perches 425284731623SJoe Perches # messages are ERROR, but ?: are CHK 42531f65f947SAndy Whitcroft if ($ok == 0) { 425484731623SJoe Perches my $msg_type = \&ERROR; 425584731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 425684731623SJoe Perches 425784731623SJoe Perches if (&{$msg_type}("SPACING", 42583705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4259b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4260b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4261b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4262b34c648bSJoe Perches } 42633705ce5bSJoe Perches $line_fixed = 1; 42643705ce5bSJoe Perches } 42650a920b5bSAndy Whitcroft } 426622f2a2efSAndy Whitcroft } 42674a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 42683705ce5bSJoe Perches 42693705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 42703705ce5bSJoe Perches 42713705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 42720a920b5bSAndy Whitcroft } 42733705ce5bSJoe Perches 42743705ce5bSJoe Perches if (($#elements % 2) == 0) { 42753705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 42763705ce5bSJoe Perches } 42773705ce5bSJoe Perches 4278194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4279194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 42803705ce5bSJoe Perches } 42813705ce5bSJoe Perches 42823705ce5bSJoe Perches 42830a920b5bSAndy Whitcroft } 42840a920b5bSAndy Whitcroft 4285786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4286d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4287786b6326SJoe Perches if (WARN("SPACING", 4288786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4289786b6326SJoe Perches $fix) { 4290194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4291786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4292786b6326SJoe Perches } 4293786b6326SJoe Perches } 4294786b6326SJoe Perches 4295f0a594c1SAndy Whitcroft# check for multiple assignments 4296f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4297000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4298000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4299f0a594c1SAndy Whitcroft } 4300f0a594c1SAndy Whitcroft 430122f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 430222f2a2efSAndy Whitcroft## # continuation. 430322f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 430422f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 430522f2a2efSAndy Whitcroft## 430622f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 430722f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 430822f2a2efSAndy Whitcroft## my $ln = $line; 430922f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 431022f2a2efSAndy Whitcroft## } 431122f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4312000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4313000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 431422f2a2efSAndy Whitcroft## } 431522f2a2efSAndy Whitcroft## } 4316f0a594c1SAndy Whitcroft 43170a920b5bSAndy Whitcroft#need space before brace following if, while, etc 43186b8c69e4SGeyslan G. Bem if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 43194e5d56bdSEddie Kovsky $line =~ /do\{/) { 43203705ce5bSJoe Perches if (ERROR("SPACING", 43213705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 43223705ce5bSJoe Perches $fix) { 4323194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/; 43243705ce5bSJoe Perches } 4325de7d4f0eSAndy Whitcroft } 4326de7d4f0eSAndy Whitcroft 4327c4a62ef9SJoe Perches## # check for blank lines before declarations 4328c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4329c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4330c4a62ef9SJoe Perches## WARN("SPACING", 4331c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4332c4a62ef9SJoe Perches## } 4333c4a62ef9SJoe Perches## 4334c4a62ef9SJoe Perches 4335de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4336de7d4f0eSAndy Whitcroft# on the line 4337de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4338d5e616fcSJoe Perches if (ERROR("SPACING", 4339d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4340d5e616fcSJoe Perches $fix) { 4341194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4342d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4343d5e616fcSJoe Perches } 43440a920b5bSAndy Whitcroft } 43450a920b5bSAndy Whitcroft 434622f2a2efSAndy Whitcroft# check spacing on square brackets 434722f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 43483705ce5bSJoe Perches if (ERROR("SPACING", 43493705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 43503705ce5bSJoe Perches $fix) { 4351194f66fcSJoe Perches $fixed[$fixlinenr] =~ 43523705ce5bSJoe Perches s/\[\s+/\[/; 43533705ce5bSJoe Perches } 435422f2a2efSAndy Whitcroft } 435522f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 43563705ce5bSJoe Perches if (ERROR("SPACING", 43573705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 43583705ce5bSJoe Perches $fix) { 4359194f66fcSJoe Perches $fixed[$fixlinenr] =~ 43603705ce5bSJoe Perches s/\s+\]/\]/; 43613705ce5bSJoe Perches } 436222f2a2efSAndy Whitcroft } 436322f2a2efSAndy Whitcroft 4364c45dcabdSAndy Whitcroft# check spacing on parentheses 43659c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 43669c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 43673705ce5bSJoe Perches if (ERROR("SPACING", 43683705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 43693705ce5bSJoe Perches $fix) { 4370194f66fcSJoe Perches $fixed[$fixlinenr] =~ 43713705ce5bSJoe Perches s/\(\s+/\(/; 43723705ce5bSJoe Perches } 437322f2a2efSAndy Whitcroft } 437413214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4375c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4376c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 43773705ce5bSJoe Perches if (ERROR("SPACING", 43783705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 43793705ce5bSJoe Perches $fix) { 4380194f66fcSJoe Perches $fixed[$fixlinenr] =~ 43813705ce5bSJoe Perches s/\s+\)/\)/; 43823705ce5bSJoe Perches } 438322f2a2efSAndy Whitcroft } 438422f2a2efSAndy Whitcroft 4385e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4386e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4387e2826fd0SJoe Perches 4388e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4389ea4acbb1SJoe Perches my $var = $1; 4390ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4391ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4392ea4acbb1SJoe Perches $fix) { 4393ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4394ea4acbb1SJoe Perches } 4395ea4acbb1SJoe Perches } 4396ea4acbb1SJoe Perches 4397ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4398ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4399ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4400ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4401ea4acbb1SJoe Perches my $var = $2; 4402ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4403ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4404ea4acbb1SJoe Perches $fix) { 4405ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4406ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4407ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4408ea4acbb1SJoe Perches } 4409e2826fd0SJoe Perches } 4410e2826fd0SJoe Perches 44110a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 44124a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 44130a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 44143705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 44153705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 44163705ce5bSJoe Perches $fix) { 4417194f66fcSJoe Perches $fixed[$fixlinenr] =~ 44183705ce5bSJoe Perches s/^(.)\s+/$1/; 44193705ce5bSJoe Perches } 44200a920b5bSAndy Whitcroft } 44210a920b5bSAndy Whitcroft 44225b9553abSJoe Perches# return is not a function 4423507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4424c45dcabdSAndy Whitcroft my $spacing = $1; 4425507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 44265b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 44275b9553abSJoe Perches my $value = $1; 44285b9553abSJoe Perches $value = deparenthesize($value); 44295b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4430000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4431000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 44325b9553abSJoe Perches } 4433c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4434000d1cc1SJoe Perches ERROR("SPACING", 4435000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4436c45dcabdSAndy Whitcroft } 4437c45dcabdSAndy Whitcroft } 4438507e5141SJoe Perches 4439b43ae21bSJoe Perches# unnecessary return in a void function 4440b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4441b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4442b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4443b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4444b43ae21bSJoe Perches $linenr >= 3 && 4445b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4446b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 44479819cf25SJoe Perches WARN("RETURN_VOID", 4448b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 44499819cf25SJoe Perches } 44509819cf25SJoe Perches 4451189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4452189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4453189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4454189248d8SJoe Perches my $openparens = $1; 4455189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4456189248d8SJoe Perches my $msg = ""; 4457189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4458189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4459189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4460189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4461189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4462189248d8SJoe Perches } 4463189248d8SJoe Perches } 4464189248d8SJoe Perches 4465c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4466c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4467c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4468c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 4469c5595fa2SJoe Perches if ($^V && $^V ge 5.10.0 && 4470c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4471c5595fa2SJoe Perches my $lead = $1; 4472c5595fa2SJoe Perches my $const = $2; 4473c5595fa2SJoe Perches my $comp = $3; 4474c5595fa2SJoe Perches my $to = $4; 4475c5595fa2SJoe Perches my $newcomp = $comp; 4476f39e1769SJoe Perches if ($lead !~ /(?:$Operators|\.)\s*$/ && 4477c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4478c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4479c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4480c5595fa2SJoe Perches $fix) { 4481c5595fa2SJoe Perches if ($comp eq "<") { 4482c5595fa2SJoe Perches $newcomp = ">"; 4483c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4484c5595fa2SJoe Perches $newcomp = ">="; 4485c5595fa2SJoe Perches } elsif ($comp eq ">") { 4486c5595fa2SJoe Perches $newcomp = "<"; 4487c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4488c5595fa2SJoe Perches $newcomp = "<="; 4489c5595fa2SJoe Perches } 4490c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4491c5595fa2SJoe Perches } 4492c5595fa2SJoe Perches } 4493c5595fa2SJoe Perches 4494f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4495f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 449653a3c448SAndy Whitcroft my $name = $1; 449753a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4498000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4499f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 450053a3c448SAndy Whitcroft } 450153a3c448SAndy Whitcroft } 4502c45dcabdSAndy Whitcroft 45030a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 45044a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 45053705ce5bSJoe Perches if (ERROR("SPACING", 45063705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 45073705ce5bSJoe Perches $fix) { 4508194f66fcSJoe Perches $fixed[$fixlinenr] =~ 45093705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 45103705ce5bSJoe Perches } 45110a920b5bSAndy Whitcroft } 45120a920b5bSAndy Whitcroft 4513f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4514f5fe35ddSAndy Whitcroft# statements after the conditional. 4515170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 45163e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 45173e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 45183e469cdcSAndy Whitcroft if (!defined $stat); 4519170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4520170d3a22SAndy Whitcroft $remain_next, $off_next); 4521170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4522170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4523170d3a22SAndy Whitcroft 4524170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4525170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4526170d3a22SAndy Whitcroft # then count those as offsets. 4527170d3a22SAndy Whitcroft my ($whitespace) = 4528170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4529170d3a22SAndy Whitcroft my $offset = 4530170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4531170d3a22SAndy Whitcroft 4532170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4533170d3a22SAndy Whitcroft $offset} = 1; 4534170d3a22SAndy Whitcroft } 4535170d3a22SAndy Whitcroft } 4536170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4537c11230f4SJoe Perches defined($stat) && defined($cond) && 4538170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4539171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 45408905a67cSAndy Whitcroft 4541b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4542000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4543000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 45448905a67cSAndy Whitcroft } 45458905a67cSAndy Whitcroft 45468905a67cSAndy Whitcroft # Find out what is on the end of the line after the 45478905a67cSAndy Whitcroft # conditional. 4548773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 45498905a67cSAndy Whitcroft $s =~ s/\n.*//g; 455013214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 455153210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 455253210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4553773647a0SAndy Whitcroft { 4554bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4555bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4556bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 455742bdf74cSHidetoshi Seto my $stat_real = ''; 4558bb44ad39SAndy Whitcroft 455942bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 456042bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4561bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4562bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4563bb44ad39SAndy Whitcroft } 4564bb44ad39SAndy Whitcroft 4565000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4566000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 45678905a67cSAndy Whitcroft } 45688905a67cSAndy Whitcroft } 45698905a67cSAndy Whitcroft 457013214adfSAndy Whitcroft# Check for bitwise tests written as boolean 457113214adfSAndy Whitcroft if ($line =~ / 457213214adfSAndy Whitcroft (?: 457313214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 457413214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 457513214adfSAndy Whitcroft (?:\&\&|\|\|) 457613214adfSAndy Whitcroft | 457713214adfSAndy Whitcroft (?:\&\&|\|\|) 457813214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 457913214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 458013214adfSAndy Whitcroft )/x) 458113214adfSAndy Whitcroft { 4582000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4583000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 458413214adfSAndy Whitcroft } 458513214adfSAndy Whitcroft 45868905a67cSAndy Whitcroft# if and else should not have general statements after it 458713214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 458813214adfSAndy Whitcroft my $s = $1; 458913214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 459013214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4591000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4592000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 45930a920b5bSAndy Whitcroft } 459413214adfSAndy Whitcroft } 459539667782SAndy Whitcroft# if should not continue a brace 459639667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4597000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4598048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 459939667782SAndy Whitcroft $herecurr); 460039667782SAndy Whitcroft } 4601a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4602a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4603a1080bf8SAndy Whitcroft $line !~ /\G(?: 46043fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4605a1080bf8SAndy Whitcroft \s*return\s+ 4606a1080bf8SAndy Whitcroft )/xg) 4607a1080bf8SAndy Whitcroft { 4608000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4609000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4610a1080bf8SAndy Whitcroft } 46110a920b5bSAndy Whitcroft 46120a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 46130a920b5bSAndy Whitcroft # indent level to be relevant to each other. 46148b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 46150a920b5bSAndy Whitcroft $previndent == $indent) { 46168b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 46178b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 46188b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 46198b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 46208b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 46218b8856f4SJoe Perches my $fixedline = $prevrawline; 46228b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 46238b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 46248b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 46258b8856f4SJoe Perches } 46268b8856f4SJoe Perches $fixedline = $rawline; 46278b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 46288b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 46298b8856f4SJoe Perches } 46300a920b5bSAndy Whitcroft } 46310a920b5bSAndy Whitcroft 46328b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4633c2fdda0dSAndy Whitcroft $previndent == $indent) { 4634c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4635c2fdda0dSAndy Whitcroft 4636c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4637c2fdda0dSAndy Whitcroft # conditional. 4638773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4639c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4640c2fdda0dSAndy Whitcroft 4641c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 46428b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 46438b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 46448b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 46458b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 46468b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 46478b8856f4SJoe Perches my $fixedline = $prevrawline; 46488b8856f4SJoe Perches my $trailing = $rawline; 46498b8856f4SJoe Perches $trailing =~ s/^\+//; 46508b8856f4SJoe Perches $trailing = trim($trailing); 46518b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 46528b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 46538b8856f4SJoe Perches } 4654c2fdda0dSAndy Whitcroft } 4655c2fdda0dSAndy Whitcroft } 4656c2fdda0dSAndy Whitcroft 465795e2c602SJoe Perches#Specific variable tests 4658323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4659323c1260SJoe Perches my $var = $1; 466095e2c602SJoe Perches 466195e2c602SJoe Perches#gcc binary extension 466295e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4663d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4664d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4665d5e616fcSJoe Perches $fix) { 4666d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4667194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4668d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4669d5e616fcSJoe Perches } 467095e2c602SJoe Perches } 467195e2c602SJoe Perches 467295e2c602SJoe Perches#CamelCase 4673807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4674be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 467522735ce8SJoe Perches#Ignore Page<foo> variants 4676807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 467722735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4678f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4679f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4680f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 46817e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 46827e781f67SJoe Perches my $word = $1; 46837e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4684d8b07710SJoe Perches if ($check) { 4685d8b07710SJoe Perches seed_camelcase_includes(); 4686d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4687d8b07710SJoe Perches seed_camelcase_file($realfile); 4688d8b07710SJoe Perches $camelcase_file_seeded = 1; 4689d8b07710SJoe Perches } 4690d8b07710SJoe Perches } 46917e781f67SJoe Perches if (!defined $camelcase{$word}) { 46927e781f67SJoe Perches $camelcase{$word} = 1; 4693be79794bSJoe Perches CHK("CAMELCASE", 46947e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 46957e781f67SJoe Perches } 4696323c1260SJoe Perches } 4697323c1260SJoe Perches } 46983445686aSJoe Perches } 46990a920b5bSAndy Whitcroft 47000a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4701d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4702d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4703d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4704d5e616fcSJoe Perches $fix) { 4705194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4706d5e616fcSJoe Perches } 47070a920b5bSAndy Whitcroft } 47080a920b5bSAndy Whitcroft 47090e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 47100e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4711c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4712e09dec48SAndy Whitcroft my $file = "$1.h"; 4713e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4714e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4715e09dec48SAndy Whitcroft $realfile ne $checkfile && 47167840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4717c45dcabdSAndy Whitcroft { 47180e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 47190e212e0aSFabian Frederick if ($asminclude > 0) { 4720e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4721000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4722000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4723e09dec48SAndy Whitcroft } else { 4724000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4725000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4726e09dec48SAndy Whitcroft } 47270a920b5bSAndy Whitcroft } 47280a920b5bSAndy Whitcroft } 47290e212e0aSFabian Frederick } 47300a920b5bSAndy Whitcroft 4731653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4732653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4733cf655043SAndy Whitcroft# in a known good container 4734b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4735b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4736d8aaf121SAndy Whitcroft my $ln = $linenr; 4737d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4738c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4739c45dcabdSAndy Whitcroft my $ctx = ''; 474008a2843eSJoe Perches my $has_flow_statement = 0; 474108a2843eSJoe Perches my $has_arg_concat = 0; 4742c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4743f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4744f74bd194SAndy Whitcroft $ctx = $dstat; 4745c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4746a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4747c45dcabdSAndy Whitcroft 474808a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 474962e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 475008a2843eSJoe Perches 4751f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 4752292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4753c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4754c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4755c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4756c45dcabdSAndy Whitcroft 4757c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4758bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4759bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 47606b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 4761bf30d6edSAndy Whitcroft { 4762c45dcabdSAndy Whitcroft } 4763c45dcabdSAndy Whitcroft 4764e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 476533acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 476633acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 4767e45bab8eSAndy Whitcroft { 4768e45bab8eSAndy Whitcroft } 4769e45bab8eSAndy Whitcroft 477042e15293SJoe Perches # Make asm volatile uses seem like a generic function 477142e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 477242e15293SJoe Perches 4773c45dcabdSAndy Whitcroft my $exceptions = qr{ 4774c45dcabdSAndy Whitcroft $Declare| 4775c45dcabdSAndy Whitcroft module_param_named| 4776a0a0a7a9SKees Cook MODULE_PARM_DESC| 4777c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4778c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4779383099fdSAndy Whitcroft __typeof__\(| 478022fd2d3eSStefani Seibold union| 478122fd2d3eSStefani Seibold struct| 4782ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 47836b10df42SVladimir Zapolskiy ^\"|\"$| 47846b10df42SVladimir Zapolskiy ^\[ 4785c45dcabdSAndy Whitcroft }x; 47865eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4787f74bd194SAndy Whitcroft if ($dstat ne '' && 4788f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4789f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 47903cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4791356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4792f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4793f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4794e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 479572f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4796f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4797f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4798f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 47994e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 4800f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4801c45dcabdSAndy Whitcroft { 4802f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 4803f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 4804f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 4805f74bd194SAndy Whitcroft 4806f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 4807f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 4808c45dcabdSAndy Whitcroft } 4809c45dcabdSAndy Whitcroft 4810f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 4811f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4812f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4813f74bd194SAndy Whitcroft } else { 4814000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 4815388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 4816d8aaf121SAndy Whitcroft } 48170a920b5bSAndy Whitcroft } 48185023d347SJoe Perches 481908a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 482008a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 482108a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 482208a2843eSJoe Perches my $herectx = $here . "\n"; 482308a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 482408a2843eSJoe Perches 482508a2843eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 482608a2843eSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 482708a2843eSJoe Perches } 482808a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 482908a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 483008a2843eSJoe Perches } 483108a2843eSJoe Perches 4832481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 48335023d347SJoe Perches 48345023d347SJoe Perches } else { 48355023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 4836481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 4837481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 48385023d347SJoe Perches $line =~ /^\+.*\\$/) { 48395023d347SJoe Perches WARN("LINE_CONTINUATIONS", 48405023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 48415023d347SJoe Perches } 4842653d4876SAndy Whitcroft } 48430a920b5bSAndy Whitcroft 4844b13edf7fSJoe Perches# do {} while (0) macro tests: 4845b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 4846b13edf7fSJoe Perches# macro should not end with a semicolon 4847b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 4848b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 4849b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 4850b13edf7fSJoe Perches my $ln = $linenr; 4851b13edf7fSJoe Perches my $cnt = $realcnt; 4852b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 4853b13edf7fSJoe Perches my $ctx = ''; 4854b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 4855b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 4856b13edf7fSJoe Perches $ctx = $dstat; 4857b13edf7fSJoe Perches 4858b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 48591b36b201SJoe Perches $dstat =~ s/$;/ /g; 4860b13edf7fSJoe Perches 4861b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 4862b13edf7fSJoe Perches my $stmts = $2; 4863b13edf7fSJoe Perches my $semis = $3; 4864b13edf7fSJoe Perches 4865b13edf7fSJoe Perches $ctx =~ s/\n*$//; 4866b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 4867b13edf7fSJoe Perches my $herectx = $here . "\n"; 4868b13edf7fSJoe Perches 4869b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4870b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4871b13edf7fSJoe Perches } 4872b13edf7fSJoe Perches 4873ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 4874ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 4875b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 4876b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 4877b13edf7fSJoe Perches } 4878b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 4879b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 4880b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 4881b13edf7fSJoe Perches } 4882f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 4883f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 4884f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 4885f5ef95b1SJoe Perches my $herectx = $here . "\n"; 4886f5ef95b1SJoe Perches 4887f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4888f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4889f5ef95b1SJoe Perches } 4890f5ef95b1SJoe Perches 4891f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 4892f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 4893b13edf7fSJoe Perches } 4894b13edf7fSJoe Perches } 4895b13edf7fSJoe Perches 4896080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 4897080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 4898080ba929SMike Frysinger# . 4899080ba929SMike Frysinger# ALIGN(...) 4900080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 4901080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 4902000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 4903000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 4904080ba929SMike Frysinger } 4905080ba929SMike Frysinger 4906f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 490713214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 490813214adfSAndy Whitcroft my ($level, $endln, @chunks) = 4909cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 491013214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 4911cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 4912cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 4913aad4f614SJoe Perches my @allowed = (); 4914aad4f614SJoe Perches my $allow = 0; 491513214adfSAndy Whitcroft my $seen = 0; 4916773647a0SAndy Whitcroft my $herectx = $here . "\n"; 4917cf655043SAndy Whitcroft my $ln = $linenr - 1; 491813214adfSAndy Whitcroft for my $chunk (@chunks) { 491913214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 492013214adfSAndy Whitcroft 4921773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 4922773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 4923773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 4924773647a0SAndy Whitcroft 4925aad4f614SJoe Perches $allowed[$allow] = 0; 4926773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 4927773647a0SAndy Whitcroft 4928773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 4929773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 4930773647a0SAndy Whitcroft 4931773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 4932cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 4933cf655043SAndy Whitcroft 4934773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 493513214adfSAndy Whitcroft 493613214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 493713214adfSAndy Whitcroft 4938aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 4939cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4940cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4941aad4f614SJoe Perches $allowed[$allow] = 1; 494213214adfSAndy Whitcroft } 494313214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4944cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4945aad4f614SJoe Perches $allowed[$allow] = 1; 494613214adfSAndy Whitcroft } 4947cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4948cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4949aad4f614SJoe Perches $allowed[$allow] = 1; 495013214adfSAndy Whitcroft } 4951aad4f614SJoe Perches $allow++; 495213214adfSAndy Whitcroft } 4953aad4f614SJoe Perches if ($seen) { 4954aad4f614SJoe Perches my $sum_allowed = 0; 4955aad4f614SJoe Perches foreach (@allowed) { 4956aad4f614SJoe Perches $sum_allowed += $_; 4957aad4f614SJoe Perches } 4958aad4f614SJoe Perches if ($sum_allowed == 0) { 4959000d1cc1SJoe Perches WARN("BRACES", 4960000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 4961aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 4962aad4f614SJoe Perches $seen != $allow) { 4963aad4f614SJoe Perches CHK("BRACES", 4964aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 4965aad4f614SJoe Perches } 496613214adfSAndy Whitcroft } 496713214adfSAndy Whitcroft } 496813214adfSAndy Whitcroft } 4969773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 497013214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 4971cf655043SAndy Whitcroft my $allowed = 0; 4972f0a594c1SAndy Whitcroft 4973cf655043SAndy Whitcroft # Check the pre-context. 4974cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 4975cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 4976cf655043SAndy Whitcroft $allowed = 1; 4977f0a594c1SAndy Whitcroft } 4978773647a0SAndy Whitcroft 4979773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 4980773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 4981773647a0SAndy Whitcroft 4982cf655043SAndy Whitcroft # Check the condition. 4983cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 4984773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 4985cf655043SAndy Whitcroft if (defined $cond) { 4986773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4987cf655043SAndy Whitcroft } 4988cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4989cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4990cf655043SAndy Whitcroft $allowed = 1; 4991cf655043SAndy Whitcroft } 4992cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4993cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4994cf655043SAndy Whitcroft $allowed = 1; 4995cf655043SAndy Whitcroft } 4996cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4997cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4998cf655043SAndy Whitcroft $allowed = 1; 4999cf655043SAndy Whitcroft } 5000cf655043SAndy Whitcroft # Check the post-context. 5001cf655043SAndy Whitcroft if (defined $chunks[1]) { 5002cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 5003cf655043SAndy Whitcroft if (defined $cond) { 5004773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 5005cf655043SAndy Whitcroft } 5006cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 5007cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5008cf655043SAndy Whitcroft $allowed = 1; 5009cf655043SAndy Whitcroft } 5010cf655043SAndy Whitcroft } 5011cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 501269932487SJustin P. Mattock my $herectx = $here . "\n"; 5013f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 5014cf655043SAndy Whitcroft 5015f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 501669932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 5017cf655043SAndy Whitcroft } 5018cf655043SAndy Whitcroft 5019000d1cc1SJoe Perches WARN("BRACES", 5020000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 5021f0a594c1SAndy Whitcroft } 5022f0a594c1SAndy Whitcroft } 5023f0a594c1SAndy Whitcroft 50240979ae66SJoe Perches# check for unnecessary blank lines around braces 502577b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5026f8e58219SJoe Perches if (CHK("BRACES", 5027f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5028f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 5029f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5030f8e58219SJoe Perches } 50310979ae66SJoe Perches } 503277b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5033f8e58219SJoe Perches if (CHK("BRACES", 5034f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5035f8e58219SJoe Perches $fix) { 5036f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 5037f8e58219SJoe Perches } 50380979ae66SJoe Perches } 50390979ae66SJoe Perches 50404a0df2efSAndy Whitcroft# no volatiles please 50416c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 50426c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5043000d1cc1SJoe Perches WARN("VOLATILE", 5044000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 50454a0df2efSAndy Whitcroft } 50464a0df2efSAndy Whitcroft 50475e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 50485e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 50495e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 50505e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 505133acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 50525e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 50535e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 50545e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 50555e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 50565e4f6ba5SJoe Perches $fix && 50575e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 50585e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 50595e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 50605e4f6ba5SJoe Perches my $comma_close = ""; 50615e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 50625e4f6ba5SJoe Perches $comma_close = $1; 50635e4f6ba5SJoe Perches } 50645e4f6ba5SJoe Perches 50655e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 50665e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 50675e4f6ba5SJoe Perches my $fixedline = $prevrawline; 50685e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 50695e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 50705e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 50715e4f6ba5SJoe Perches $fixedline = $rawline; 50725e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 50735e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 50745e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 50755e4f6ba5SJoe Perches } 50765e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 50775e4f6ba5SJoe Perches } 50785e4f6ba5SJoe Perches } 50795e4f6ba5SJoe Perches 50805e4f6ba5SJoe Perches# check for missing a space in a string concatenation 50815e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 50825e4f6ba5SJoe Perches WARN('MISSING_SPACE', 50835e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 50845e4f6ba5SJoe Perches } 50855e4f6ba5SJoe Perches 50865e4f6ba5SJoe Perches# check for spaces before a quoted newline 50875e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 50885e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 50895e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 50905e4f6ba5SJoe Perches $fix) { 50915e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 50925e4f6ba5SJoe Perches } 50935e4f6ba5SJoe Perches 50945e4f6ba5SJoe Perches } 50955e4f6ba5SJoe Perches 5096f17dba4fSJoe Perches# concatenated string without spaces between elements 509733acb54aSJoe Perches if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) { 5098f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 5099f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 5100f17dba4fSJoe Perches } 5101f17dba4fSJoe Perches 510290ad30e5SJoe Perches# uncoalesced string fragments 510333acb54aSJoe Perches if ($line =~ /$String\s*"/) { 510490ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 510590ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 510690ad30e5SJoe Perches } 510790ad30e5SJoe Perches 51086e300757SJoe Perches# check for %L{u,d,i} and 0x%[udi] in strings 51095e4f6ba5SJoe Perches my $string; 51105e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 51115e4f6ba5SJoe Perches $string = substr($rawline, $-[1], $+[1] - $-[1]); 51125e4f6ba5SJoe Perches $string =~ s/%%/__/g; 51136e300757SJoe Perches if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) { 51145e4f6ba5SJoe Perches WARN("PRINTF_L", 51155e4f6ba5SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 51165e4f6ba5SJoe Perches last; 51175e4f6ba5SJoe Perches } 51186e300757SJoe Perches if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) { 51196e300757SJoe Perches ERROR("PRINTF_0xDECIMAL", 51206e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 51216e300757SJoe Perches } 51225e4f6ba5SJoe Perches } 51235e4f6ba5SJoe Perches 51245e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 51255e4f6ba5SJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 51265e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 51275e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 51285e4f6ba5SJoe Perches } 51295e4f6ba5SJoe Perches 513000df344fSAndy Whitcroft# warn about #if 0 5131c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 5132000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 5133000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 5134de7d4f0eSAndy Whitcroft $herecurr); 51354a0df2efSAndy Whitcroft } 51364a0df2efSAndy Whitcroft 513703df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 513803df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 5139100425deSJoe Perches my $tested = quotemeta($1); 5140100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 5141100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 5142100425deSJoe Perches my $func = $1; 5143100425deSJoe Perches if (WARN('NEEDLESS_IF', 5144100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 5145100425deSJoe Perches $fix) { 5146100425deSJoe Perches my $do_fix = 1; 5147100425deSJoe Perches my $leading_tabs = ""; 5148100425deSJoe Perches my $new_leading_tabs = ""; 5149100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 5150100425deSJoe Perches $leading_tabs = $1; 5151100425deSJoe Perches } else { 5152100425deSJoe Perches $do_fix = 0; 5153100425deSJoe Perches } 5154100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 5155100425deSJoe Perches $new_leading_tabs = $1; 5156100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 5157100425deSJoe Perches $do_fix = 0; 5158100425deSJoe Perches } 5159100425deSJoe Perches } else { 5160100425deSJoe Perches $do_fix = 0; 5161100425deSJoe Perches } 5162100425deSJoe Perches if ($do_fix) { 5163100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 5164100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 5165100425deSJoe Perches } 5166100425deSJoe Perches } 51674c432a8fSGreg Kroah-Hartman } 51684c432a8fSGreg Kroah-Hartman } 5169f0a594c1SAndy Whitcroft 5170ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 5171ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 5172ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 5173ebfdc409SJoe Perches (defined $1 || defined $3) && 5174ebfdc409SJoe Perches $linenr > 3) { 5175ebfdc409SJoe Perches my $testval = $2; 5176ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 5177ebfdc409SJoe Perches 5178ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 5179ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 5180ebfdc409SJoe Perches 5181ebfdc409SJoe 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)/) { 5182ebfdc409SJoe Perches WARN("OOM_MESSAGE", 5183ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 5184ebfdc409SJoe Perches } 5185ebfdc409SJoe Perches } 5186ebfdc409SJoe Perches 5187f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5188dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5189f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5190f78d98f6SJoe Perches my $level = $1; 5191f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5192f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5193f78d98f6SJoe Perches $fix) { 5194f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5195f78d98f6SJoe Perches } 5196f78d98f6SJoe Perches } 5197f78d98f6SJoe Perches 5198abb08a53SJoe Perches# check for mask then right shift without a parentheses 5199abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 5200abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5201abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5202abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5203abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5204abb08a53SJoe Perches } 5205abb08a53SJoe Perches 5206b75ac618SJoe Perches# check for pointer comparisons to NULL 5207b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 5208b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5209b75ac618SJoe Perches my $val = $1; 5210b75ac618SJoe Perches my $equal = "!"; 5211b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5212b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5213b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5214b75ac618SJoe Perches $fix) { 5215b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5216b75ac618SJoe Perches } 5217b75ac618SJoe Perches } 5218b75ac618SJoe Perches } 5219b75ac618SJoe Perches 52208716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 52218716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 52228716de38SJoe Perches my $attr = $1; 52238716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 52248716de38SJoe Perches my $ptr = $1; 52258716de38SJoe Perches my $var = $2; 52268716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 52278716de38SJoe Perches ERROR("MISPLACED_INIT", 52288716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 52298716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 52308716de38SJoe Perches WARN("MISPLACED_INIT", 52318716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 52328716de38SJoe Perches $fix) { 5233194f66fcSJoe 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; 52348716de38SJoe Perches } 52358716de38SJoe Perches } 52368716de38SJoe Perches } 52378716de38SJoe Perches 5238e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5239e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5240e970b884SJoe Perches my $attr = $1; 5241e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5242e970b884SJoe Perches my $attr_prefix = $1; 5243e970b884SJoe Perches my $attr_type = $2; 5244e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5245e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5246e970b884SJoe Perches $fix) { 5247194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5248e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5249e970b884SJoe Perches } 5250e970b884SJoe Perches } 5251e970b884SJoe Perches 5252e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5253e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5254e970b884SJoe Perches my $attr = $1; 5255e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5256e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5257e970b884SJoe Perches $fix) { 5258194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5259e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5260e970b884SJoe Perches $lead = rtrim($1); 5261e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5262e970b884SJoe Perches $lead = "${lead}const "; 5263194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5264e970b884SJoe Perches } 5265e970b884SJoe Perches } 5266e970b884SJoe Perches 5267c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5268c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5269c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5270c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5271c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5272c17893c7SJoe Perches $fix) { 5273c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5274c17893c7SJoe Perches } 5275c17893c7SJoe Perches } 5276c17893c7SJoe Perches 5277fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5278fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5279fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5280fbdb8138SJoe Perches my $constant_func = $1; 5281fbdb8138SJoe Perches my $func = $constant_func; 5282fbdb8138SJoe Perches $func =~ s/^__constant_//; 5283fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5284fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5285fbdb8138SJoe Perches $fix) { 5286194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5287fbdb8138SJoe Perches } 5288fbdb8138SJoe Perches } 5289fbdb8138SJoe Perches 52901a15a250SPatrick Pannuto# prefer usleep_range over udelay 529137581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 529243c1d77cSJoe Perches my $delay = $1; 52931a15a250SPatrick Pannuto # ignore udelay's < 10, however 529443c1d77cSJoe Perches if (! ($delay < 10) ) { 5295000d1cc1SJoe Perches CHK("USLEEP_RANGE", 529643c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 529743c1d77cSJoe Perches } 529843c1d77cSJoe Perches if ($delay > 2000) { 529943c1d77cSJoe Perches WARN("LONG_UDELAY", 530043c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 53011a15a250SPatrick Pannuto } 53021a15a250SPatrick Pannuto } 53031a15a250SPatrick Pannuto 530409ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 530509ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 530609ef8725SPatrick Pannuto if ($1 < 20) { 5307000d1cc1SJoe Perches WARN("MSLEEP", 530843c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 530909ef8725SPatrick Pannuto } 531009ef8725SPatrick Pannuto } 531109ef8725SPatrick Pannuto 531236ec1939SJoe Perches# check for comparisons of jiffies 531336ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 531436ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 531536ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 531636ec1939SJoe Perches } 531736ec1939SJoe Perches 53189d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 53199d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 53209d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 53219d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 53229d7a34a5SJoe Perches } 53239d7a34a5SJoe Perches 532400df344fSAndy Whitcroft# warn about #ifdefs in C files 5325c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 532600df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 532700df344fSAndy Whitcroft# print "$herecurr"; 532800df344fSAndy Whitcroft# $clean = 0; 532900df344fSAndy Whitcroft# } 533000df344fSAndy Whitcroft 533122f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5332c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 53333705ce5bSJoe Perches if (ERROR("SPACING", 53343705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 53353705ce5bSJoe Perches $fix) { 5336194f66fcSJoe Perches $fixed[$fixlinenr] =~ 53373705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 53383705ce5bSJoe Perches } 53393705ce5bSJoe Perches 534022f2a2efSAndy Whitcroft } 534122f2a2efSAndy Whitcroft 53424a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5343171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5344171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 53454a0df2efSAndy Whitcroft my $which = $1; 53464a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5347000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5348000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 53494a0df2efSAndy Whitcroft } 53504a0df2efSAndy Whitcroft } 53514a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5352402c2553SMichael S. Tsirkin 5353402c2553SMichael S. Tsirkin my $barriers = qr{ 5354402c2553SMichael S. Tsirkin mb| 5355402c2553SMichael S. Tsirkin rmb| 5356402c2553SMichael S. Tsirkin wmb| 5357402c2553SMichael S. Tsirkin read_barrier_depends 5358402c2553SMichael S. Tsirkin }x; 5359402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5360402c2553SMichael S. Tsirkin mb__before_atomic| 5361402c2553SMichael S. Tsirkin mb__after_atomic| 5362402c2553SMichael S. Tsirkin store_release| 5363402c2553SMichael S. Tsirkin load_acquire| 5364402c2553SMichael S. Tsirkin store_mb| 5365402c2553SMichael S. Tsirkin (?:$barriers) 5366402c2553SMichael S. Tsirkin }x; 5367402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5368402c2553SMichael S. Tsirkin (?:$barriers)| 536943e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 537043e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5371402c2553SMichael S. Tsirkin }x; 5372402c2553SMichael S. Tsirkin 5373402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 53744a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5375c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5376000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 53774a0df2efSAndy Whitcroft } 53784a0df2efSAndy Whitcroft } 53793ad81779SPaul E. McKenney 5380f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5381f4073b0fSMichael S. Tsirkin 5382f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5383f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5384f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5385f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5386f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5387f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5388f4073b0fSMichael S. Tsirkin } 5389f4073b0fSMichael S. Tsirkin 5390cb426e99SJoe Perches# check for waitqueue_active without a comment. 5391cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5392cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5393cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5394cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5395cb426e99SJoe Perches } 5396cb426e99SJoe Perches } 53973ad81779SPaul E. McKenney 53983ad81779SPaul E. McKenney# Check for expedited grace periods that interrupt non-idle non-nohz 53993ad81779SPaul E. McKenney# online CPUs. These expedited can therefore degrade real-time response 54003ad81779SPaul E. McKenney# if used carelessly, and should be avoided where not absolutely 54013ad81779SPaul E. McKenney# needed. It is always OK to use synchronize_rcu_expedited() and 54023ad81779SPaul E. McKenney# synchronize_sched_expedited() at boot time (before real-time applications 54033ad81779SPaul E. McKenney# start) and in error situations where real-time response is compromised in 54043ad81779SPaul E. McKenney# any case. Note that synchronize_srcu_expedited() does -not- interrupt 54053ad81779SPaul E. McKenney# other CPUs, so don't warn on uses of synchronize_srcu_expedited(). 54063ad81779SPaul E. McKenney# Of course, nothing comes for free, and srcu_read_lock() and 54073ad81779SPaul E. McKenney# srcu_read_unlock() do contain full memory barriers in payment for 54083ad81779SPaul E. McKenney# synchronize_srcu_expedited() non-interruption properties. 54093ad81779SPaul E. McKenney if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) { 54103ad81779SPaul E. McKenney WARN("EXPEDITED_RCU_GRACE_PERIOD", 54113ad81779SPaul E. McKenney "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr); 54123ad81779SPaul E. McKenney 54133ad81779SPaul E. McKenney } 54143ad81779SPaul E. McKenney 54154a0df2efSAndy Whitcroft# check of hardware specific defines 5416c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5417000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5418000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 54190a920b5bSAndy Whitcroft } 5420653d4876SAndy Whitcroft 5421d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 5422d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 5423000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5424000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 5425d4977c78STobias Klauser } 5426d4977c78STobias Klauser 5427de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5428de7d4f0eSAndy Whitcroft# storage class and type. 54299c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 54309c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5431000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5432000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5433de7d4f0eSAndy Whitcroft } 5434de7d4f0eSAndy Whitcroft 54358905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 54362b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 54372b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5438d5e616fcSJoe Perches if (WARN("INLINE", 5439d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5440d5e616fcSJoe Perches $fix) { 5441194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5442d5e616fcSJoe Perches 5443d5e616fcSJoe Perches } 54448905a67cSAndy Whitcroft } 54458905a67cSAndy Whitcroft 54463d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 54472b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 54482b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5449000d1cc1SJoe Perches WARN("PREFER_PACKED", 5450000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 54513d130fd0SJoe Perches } 54523d130fd0SJoe Perches 545339b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 54542b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 54552b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5456000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5457000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 545839b7e287SJoe Perches } 545939b7e287SJoe Perches 54605f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 54612b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 54622b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5463d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5464d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5465d5e616fcSJoe Perches $fix) { 5466194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5467d5e616fcSJoe Perches 5468d5e616fcSJoe Perches } 54695f14d3bdSJoe Perches } 54705f14d3bdSJoe Perches 54716061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 54722b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 54732b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5474d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5475d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5476d5e616fcSJoe Perches $fix) { 5477194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5478d5e616fcSJoe Perches } 54796061d949SJoe Perches } 54806061d949SJoe Perches 5481619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 5482619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 5483619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5484619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5485619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5486619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5487619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5488619a908aSJoe Perches } 5489619a908aSJoe Perches 5490e6176fa4SJoe Perches# check for c99 types like uint8_t used outside of uapi/ 5491e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5492e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5493e6176fa4SJoe Perches my $type = $1; 5494e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5495e6176fa4SJoe Perches $type = $1; 5496e6176fa4SJoe Perches my $kernel_type = 'u'; 5497e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5498e6176fa4SJoe Perches $type =~ /(\d+)/; 5499e6176fa4SJoe Perches $kernel_type .= $1; 5500e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5501e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5502e6176fa4SJoe Perches $fix) { 5503e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5504e6176fa4SJoe Perches } 5505e6176fa4SJoe Perches } 5506e6176fa4SJoe Perches } 5507e6176fa4SJoe Perches 5508938224b5SJoe Perches# check for cast of C90 native int or longer types constants 5509938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 5510938224b5SJoe Perches my $cast = $1; 5511938224b5SJoe Perches my $const = $2; 5512938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 5513938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 5514938224b5SJoe Perches $fix) { 5515938224b5SJoe Perches my $suffix = ""; 5516938224b5SJoe Perches my $newconst = $const; 5517938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 5518938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 5519938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 5520938224b5SJoe Perches $suffix .= 'LL'; 5521938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 5522938224b5SJoe Perches $suffix .= 'L'; 5523938224b5SJoe Perches } 5524938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 5525938224b5SJoe Perches } 5526938224b5SJoe Perches } 5527938224b5SJoe Perches 55288f53a9b8SJoe Perches# check for sizeof(&) 55298f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5530000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5531000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 55328f53a9b8SJoe Perches } 55338f53a9b8SJoe Perches 553466c80b60SJoe Perches# check for sizeof without parenthesis 553566c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5536d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5537d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5538d5e616fcSJoe Perches $fix) { 5539194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5540d5e616fcSJoe Perches } 554166c80b60SJoe Perches } 554266c80b60SJoe Perches 554388982feaSJoe Perches# check for struct spinlock declarations 554488982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 554588982feaSJoe Perches WARN("USE_SPINLOCK_T", 554688982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 554788982feaSJoe Perches } 554888982feaSJoe Perches 5549a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 555006668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5551a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5552caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5553caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5554d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5555d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5556d5e616fcSJoe Perches $fix) { 5557194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5558d5e616fcSJoe Perches } 5559a6962d72SJoe Perches } 5560a6962d72SJoe Perches } 5561a6962d72SJoe Perches 5562554e165cSAndy Whitcroft# Check for misused memsets 5563d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5564d1fe9c09SJoe Perches defined $stat && 55659e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5566554e165cSAndy Whitcroft 5567d7c76ba7SJoe Perches my $ms_addr = $2; 5568d1fe9c09SJoe Perches my $ms_val = $7; 5569d1fe9c09SJoe Perches my $ms_size = $12; 5570d7c76ba7SJoe Perches 5571554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5572554e165cSAndy Whitcroft ERROR("MEMSET", 5573d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5574554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5575554e165cSAndy Whitcroft WARN("MEMSET", 5576d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5577d7c76ba7SJoe Perches } 5578d7c76ba7SJoe Perches } 5579d7c76ba7SJoe Perches 558098a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 5581f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5582f333195dSJoe Perches# defined $stat && 5583f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5584f333195dSJoe Perches# if (WARN("PREFER_ETHER_ADDR_COPY", 5585f333195dSJoe Perches# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 5586f333195dSJoe Perches# $fix) { 5587f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 5588f333195dSJoe Perches# } 5589f333195dSJoe Perches# } 559098a9bba5SJoe Perches 5591b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 5592f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5593f333195dSJoe Perches# defined $stat && 5594f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5595f333195dSJoe Perches# WARN("PREFER_ETHER_ADDR_EQUAL", 5596f333195dSJoe Perches# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5597f333195dSJoe Perches# } 5598b6117d17SMateusz Kulikowski 55998617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 56008617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 5601f333195dSJoe Perches# if ($^V && $^V ge 5.10.0 && 5602f333195dSJoe Perches# defined $stat && 5603f333195dSJoe Perches# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5604f333195dSJoe Perches# 5605f333195dSJoe Perches# my $ms_val = $7; 5606f333195dSJoe Perches# 5607f333195dSJoe Perches# if ($ms_val =~ /^(?:0x|)0+$/i) { 5608f333195dSJoe Perches# if (WARN("PREFER_ETH_ZERO_ADDR", 5609f333195dSJoe Perches# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 5610f333195dSJoe Perches# $fix) { 5611f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 5612f333195dSJoe Perches# } 5613f333195dSJoe Perches# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 5614f333195dSJoe Perches# if (WARN("PREFER_ETH_BROADCAST_ADDR", 5615f333195dSJoe Perches# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 5616f333195dSJoe Perches# $fix) { 5617f333195dSJoe Perches# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 5618f333195dSJoe Perches# } 5619f333195dSJoe Perches# } 5620f333195dSJoe Perches# } 56218617cd09SMateusz Kulikowski 5622d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5623d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5624d1fe9c09SJoe Perches defined $stat && 5625d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5626d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5627d7c76ba7SJoe Perches my $call = $1; 5628d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5629d7c76ba7SJoe Perches my $arg1 = $3; 5630d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5631d1fe9c09SJoe Perches my $arg2 = $8; 5632d7c76ba7SJoe Perches my $cast; 5633d7c76ba7SJoe Perches 5634d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5635d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5636d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5637d7c76ba7SJoe Perches $cast = $cast1; 5638d7c76ba7SJoe Perches } else { 5639d7c76ba7SJoe Perches $cast = $cast2; 5640d7c76ba7SJoe Perches } 5641d7c76ba7SJoe Perches WARN("MINMAX", 5642d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5643554e165cSAndy Whitcroft } 5644554e165cSAndy Whitcroft } 5645554e165cSAndy Whitcroft 56464a273195SJoe Perches# check usleep_range arguments 56474a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 56484a273195SJoe Perches defined $stat && 56494a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 56504a273195SJoe Perches my $min = $1; 56514a273195SJoe Perches my $max = $7; 56524a273195SJoe Perches if ($min eq $max) { 56534a273195SJoe Perches WARN("USLEEP_RANGE", 56544a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 56554a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 56564a273195SJoe Perches $min > $max) { 56574a273195SJoe Perches WARN("USLEEP_RANGE", 56584a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 56594a273195SJoe Perches } 56604a273195SJoe Perches } 56614a273195SJoe Perches 5662823b794cSJoe Perches# check for naked sscanf 5663823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5664823b794cSJoe Perches defined $stat && 56656c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5666823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5667823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5668823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5669823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5670823b794cSJoe Perches $lc = $lc + $linenr; 5671823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 5672823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5673823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5674823b794cSJoe Perches } 5675823b794cSJoe Perches WARN("NAKED_SSCANF", 5676823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5677823b794cSJoe Perches } 5678823b794cSJoe Perches 5679afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5680afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5681afc819abSJoe Perches defined $stat && 5682afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5683afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5684afc819abSJoe Perches $lc = $lc + $linenr; 5685afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 5686afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5687afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5688afc819abSJoe Perches } 5689afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5690afc819abSJoe Perches my $format = $6; 5691afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5692afc819abSJoe Perches if ($count == 1 && 5693afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5694afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5695afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5696afc819abSJoe Perches } 5697afc819abSJoe Perches } 5698afc819abSJoe Perches } 5699afc819abSJoe Perches 570070dc8a48SJoe Perches# check for new externs in .h files. 570170dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 570270dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5703d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 570470dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 570570dc8a48SJoe Perches $fix) { 5706194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 570770dc8a48SJoe Perches } 570870dc8a48SJoe Perches } 570970dc8a48SJoe Perches 5710de7d4f0eSAndy Whitcroft# check for new externs in .c files. 5711171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 5712c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 5713171ae1a4SAndy Whitcroft { 5714c45dcabdSAndy Whitcroft my $function_name = $1; 5715c45dcabdSAndy Whitcroft my $paren_space = $2; 5716171ae1a4SAndy Whitcroft 5717171ae1a4SAndy Whitcroft my $s = $stat; 5718171ae1a4SAndy Whitcroft if (defined $cond) { 5719171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 5720171ae1a4SAndy Whitcroft } 5721c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 5722c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 5723c45dcabdSAndy Whitcroft { 5724000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5725000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5726de7d4f0eSAndy Whitcroft } 5727de7d4f0eSAndy Whitcroft 5728171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 5729000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 5730000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 5731171ae1a4SAndy Whitcroft } 57329c9ba34eSAndy Whitcroft 57339c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 57349c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 57359c9ba34eSAndy Whitcroft { 5736000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5737000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5738171ae1a4SAndy Whitcroft } 5739171ae1a4SAndy Whitcroft 5740de7d4f0eSAndy Whitcroft# checks for new __setup's 5741de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 5742de7d4f0eSAndy Whitcroft my $name = $1; 5743de7d4f0eSAndy Whitcroft 5744de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 5745000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 5746000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 5747de7d4f0eSAndy Whitcroft } 5748653d4876SAndy Whitcroft } 57499c0ca6f9SAndy Whitcroft 57509c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 5751caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 5752000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 5753000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 57549c0ca6f9SAndy Whitcroft } 575513214adfSAndy Whitcroft 5756a640d25cSJoe Perches# alloc style 5757a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 5758a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 5759a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 5760a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 5761a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 5762a640d25cSJoe Perches } 5763a640d25cSJoe Perches 576460a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 576560a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 5766e367455aSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 576760a55369SJoe Perches my $oldfunc = $3; 576860a55369SJoe Perches my $a1 = $4; 576960a55369SJoe Perches my $a2 = $10; 577060a55369SJoe Perches my $newfunc = "kmalloc_array"; 577160a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 577260a55369SJoe Perches my $r1 = $a1; 577360a55369SJoe Perches my $r2 = $a2; 577460a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 577560a55369SJoe Perches $r1 = $a2; 577660a55369SJoe Perches $r2 = $a1; 577760a55369SJoe Perches } 5778e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 5779e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 5780e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 5781e367455aSJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 5782e367455aSJoe Perches $fix) { 5783194f66fcSJoe 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; 578460a55369SJoe Perches 578560a55369SJoe Perches } 578660a55369SJoe Perches } 578760a55369SJoe Perches } 578860a55369SJoe Perches 5789972fdea2SJoe Perches# check for krealloc arg reuse 5790972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 5791972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 5792972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 5793972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 5794972fdea2SJoe Perches } 5795972fdea2SJoe Perches 57965ce59ae0SJoe Perches# check for alloc argument mismatch 57975ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 57985ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 57995ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 58005ce59ae0SJoe Perches } 58015ce59ae0SJoe Perches 5802caf2a54fSJoe Perches# check for multiple semicolons 5803caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 5804d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 5805d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 5806d5e616fcSJoe Perches $fix) { 5807194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 5808d5e616fcSJoe Perches } 5809d1e2ad07SJoe Perches } 5810d1e2ad07SJoe Perches 5811cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 5812cec3aaa5STomas Winkler if ($realfile !~ m@^include/uapi/@ && 5813cec3aaa5STomas Winkler $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 58140ab90191SJoe Perches my $ull = ""; 58150ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 58160ab90191SJoe Perches if (CHK("BIT_MACRO", 58170ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 58180ab90191SJoe Perches $fix) { 58190ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 58200ab90191SJoe Perches } 58210ab90191SJoe Perches } 58220ab90191SJoe Perches 58232d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 58242d632745SJoe 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*$/) { 58252d632745SJoe Perches my $config = $1; 58262d632745SJoe Perches if (WARN("PREFER_IS_ENABLED", 58272d632745SJoe Perches "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) && 58282d632745SJoe Perches $fix) { 58292d632745SJoe Perches $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 58302d632745SJoe Perches } 58312d632745SJoe Perches } 58322d632745SJoe Perches 5833e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 5834c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 5835c34c09a8SJoe Perches my $has_break = 0; 5836c34c09a8SJoe Perches my $has_statement = 0; 5837c34c09a8SJoe Perches my $count = 0; 5838c34c09a8SJoe Perches my $prevline = $linenr; 5839e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 5840c34c09a8SJoe Perches $prevline--; 5841c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 5842c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 5843c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 5844c34c09a8SJoe Perches next if ($fline =~ /^\-/); 5845c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 5846c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 5847c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 5848c34c09a8SJoe Perches $has_statement = 1; 5849c34c09a8SJoe Perches $count++; 5850c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 5851c34c09a8SJoe Perches } 5852c34c09a8SJoe Perches if (!$has_break && $has_statement) { 5853c34c09a8SJoe Perches WARN("MISSING_BREAK", 5854c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 5855c34c09a8SJoe Perches } 5856c34c09a8SJoe Perches } 5857c34c09a8SJoe Perches 5858d1e2ad07SJoe Perches# check for switch/default statements without a break; 5859d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 5860d1e2ad07SJoe Perches defined $stat && 5861d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 5862d1e2ad07SJoe Perches my $ctx = ''; 5863d1e2ad07SJoe Perches my $herectx = $here . "\n"; 5864d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 5865d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5866d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5867d1e2ad07SJoe Perches } 5868d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 5869d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 5870caf2a54fSJoe Perches } 5871caf2a54fSJoe Perches 587213214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 5873d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 5874d5e616fcSJoe Perches if (WARN("USE_FUNC", 5875d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 5876d5e616fcSJoe Perches $fix) { 5877194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 5878d5e616fcSJoe Perches } 587913214adfSAndy Whitcroft } 5880773647a0SAndy Whitcroft 588162ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 588262ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 588362ec818fSJoe Perches ERROR("DATE_TIME", 588462ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 588562ec818fSJoe Perches } 588662ec818fSJoe Perches 58872c92488aSJoe Perches# check for use of yield() 58882c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 58892c92488aSJoe Perches WARN("YIELD", 58902c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 58912c92488aSJoe Perches } 58922c92488aSJoe Perches 5893179f8f40SJoe Perches# check for comparisons against true and false 5894179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 5895179f8f40SJoe Perches my $lead = $1; 5896179f8f40SJoe Perches my $arg = $2; 5897179f8f40SJoe Perches my $test = $3; 5898179f8f40SJoe Perches my $otype = $4; 5899179f8f40SJoe Perches my $trail = $5; 5900179f8f40SJoe Perches my $op = "!"; 5901179f8f40SJoe Perches 5902179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 5903179f8f40SJoe Perches 5904179f8f40SJoe Perches my $type = lc($otype); 5905179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 5906179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 5907179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 5908179f8f40SJoe Perches $op = ""; 5909179f8f40SJoe Perches } 5910179f8f40SJoe Perches 5911179f8f40SJoe Perches CHK("BOOL_COMPARISON", 5912179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 5913179f8f40SJoe Perches 5914179f8f40SJoe Perches## maybe suggesting a correct construct would better 5915179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 5916179f8f40SJoe Perches 5917179f8f40SJoe Perches } 5918179f8f40SJoe Perches } 5919179f8f40SJoe Perches 59204882720bSThomas Gleixner# check for semaphores initialized locked 59214882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 5922000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 5923000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 5924773647a0SAndy Whitcroft } 59256712d858SJoe Perches 592667d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 592767d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 5928000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 592967d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 5930773647a0SAndy Whitcroft } 59316712d858SJoe Perches 5932ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 5933f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 5934000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 5935ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 5936f3db6639SMichael Ellerman } 59376712d858SJoe Perches 59380f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 59396903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 59400f3c5aabSJoe Perches $line =~ /\bstruct\s+($const_structs)\b/) { 5941000d1cc1SJoe Perches WARN("CONST_STRUCT", 5942000d1cc1SJoe Perches "struct $1 should normally be const\n" . 59436903ffb2SAndy Whitcroft $herecurr); 59442b6db5cbSAndy Whitcroft } 5945773647a0SAndy Whitcroft 5946773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 5947773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 5948773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 5949c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 5950c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 5951171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 5952171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 5953171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 5954773647a0SAndy Whitcroft { 5955000d1cc1SJoe Perches WARN("NR_CPUS", 5956000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 5957773647a0SAndy Whitcroft } 59589c9ba34eSAndy Whitcroft 595952ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 596052ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 596152ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 596252ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 596352ea8506SJoe Perches } 596452ea8506SJoe Perches 5965acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 5966acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 5967acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 5968acd9362cSJoe Perches WARN("LIKELY_MISUSE", 5969acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 5970acd9362cSJoe Perches } 5971acd9362cSJoe Perches 5972691d77b6SAndy Whitcroft# whine mightly about in_atomic 5973691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 5974691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 5975000d1cc1SJoe Perches ERROR("IN_ATOMIC", 5976000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 5977f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 5978000d1cc1SJoe Perches WARN("IN_ATOMIC", 5979000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 5980691d77b6SAndy Whitcroft } 5981691d77b6SAndy Whitcroft } 59821704f47bSPeter Zijlstra 5983481aea5cSJoe Perches# whine about ACCESS_ONCE 5984481aea5cSJoe Perches if ($^V && $^V ge 5.10.0 && 5985481aea5cSJoe Perches $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) { 5986481aea5cSJoe Perches my $par = $1; 5987481aea5cSJoe Perches my $eq = $2; 5988481aea5cSJoe Perches my $fun = $3; 5989481aea5cSJoe Perches $par =~ s/^\(\s*(.*)\s*\)$/$1/; 5990481aea5cSJoe Perches if (defined($eq)) { 5991481aea5cSJoe Perches if (WARN("PREFER_WRITE_ONCE", 5992481aea5cSJoe Perches "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) && 5993481aea5cSJoe Perches $fix) { 5994481aea5cSJoe Perches $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/; 5995481aea5cSJoe Perches } 5996481aea5cSJoe Perches } else { 5997481aea5cSJoe Perches if (WARN("PREFER_READ_ONCE", 5998481aea5cSJoe Perches "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) && 5999481aea5cSJoe Perches $fix) { 6000481aea5cSJoe Perches $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/; 6001481aea5cSJoe Perches } 6002481aea5cSJoe Perches } 6003481aea5cSJoe Perches } 6004481aea5cSJoe Perches 60051704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 60061704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 60071704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 60081704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 60091704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 60101704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 6011000d1cc1SJoe Perches ERROR("LOCKDEP", 6012000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 60131704f47bSPeter Zijlstra } 60141704f47bSPeter Zijlstra } 601588f8831cSDave Jones 6016b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 6017b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 6018000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 6019000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 602088f8831cSDave Jones } 60212435880fSJoe Perches 6022515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 6023515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 6024515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 6025515a235eSJoe Perches $line =~ /$mode_perms_search/) { 60262435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 60272435880fSJoe Perches my $func = $entry->[0]; 60282435880fSJoe Perches my $arg_pos = $entry->[1]; 60292435880fSJoe Perches 60302435880fSJoe Perches my $skip_args = ""; 60312435880fSJoe Perches if ($arg_pos > 1) { 60322435880fSJoe Perches $arg_pos--; 60332435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 60342435880fSJoe Perches } 6035f90774e1SJoe Perches my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 6036515a235eSJoe Perches if ($line =~ /$test/) { 60372435880fSJoe Perches my $val = $1; 60382435880fSJoe Perches $val = $6 if ($skip_args ne ""); 6039f90774e1SJoe Perches if (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 6040f90774e1SJoe Perches ($val =~ /^$Octal$/ && length($val) ne 4)) { 60412435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 60421727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 6043f90774e1SJoe Perches } 6044f90774e1SJoe Perches if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 6045c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 6046c0a5c898SJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 60472435880fSJoe Perches } 6048f90774e1SJoe Perches if ($val =~ /\b$mode_perms_string_search\b/) { 6049f90774e1SJoe Perches my $to = 0; 6050f90774e1SJoe Perches while ($val =~ /\b($mode_perms_string_search)\b(?:\s*\|\s*)?\s*/g) { 6051f90774e1SJoe Perches $to |= $mode_permission_string_types{$1}; 6052f90774e1SJoe Perches } 6053f90774e1SJoe Perches my $new = sprintf("%04o", $to); 6054f90774e1SJoe Perches if (WARN("SYMBOLIC_PERMS", 6055f90774e1SJoe Perches "Symbolic permissions are not preferred. Consider using octal permissions $new.\n" . $herecurr) && 6056f90774e1SJoe Perches $fix) { 6057f90774e1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$val\E/$new/; 6058f90774e1SJoe Perches } 6059f90774e1SJoe Perches } 60602435880fSJoe Perches } 60612435880fSJoe Perches } 606213214adfSAndy Whitcroft } 60635a6d20ceSBjorn Andersson 60645a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 60655a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 60665a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 60675a6d20ceSBjorn Andersson my $valid_licenses = qr{ 60685a6d20ceSBjorn Andersson GPL| 60695a6d20ceSBjorn Andersson GPL\ v2| 60705a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 60715a6d20ceSBjorn Andersson Dual\ BSD/GPL| 60725a6d20ceSBjorn Andersson Dual\ MIT/GPL| 60735a6d20ceSBjorn Andersson Dual\ MPL/GPL| 60745a6d20ceSBjorn Andersson Proprietary 60755a6d20ceSBjorn Andersson }x; 60765a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 60775a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 60785a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 60795a6d20ceSBjorn Andersson } 60805a6d20ceSBjorn Andersson } 6081515a235eSJoe Perches } 608213214adfSAndy Whitcroft 608313214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 608413214adfSAndy Whitcroft # so just keep quiet. 608513214adfSAndy Whitcroft if ($#rawlines == -1) { 608613214adfSAndy Whitcroft exit(0); 60870a920b5bSAndy Whitcroft } 60880a920b5bSAndy Whitcroft 60898905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 60908905a67cSAndy Whitcroft # things that appear to be patches. 60918905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 60928905a67cSAndy Whitcroft exit(0); 60938905a67cSAndy Whitcroft } 60948905a67cSAndy Whitcroft 60958905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 60968905a67cSAndy Whitcroft # just keep quiet. 60978905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 60988905a67cSAndy Whitcroft exit(0); 60998905a67cSAndy Whitcroft } 61008905a67cSAndy Whitcroft 610106330fc4SJoe Perches if (!$is_patch && $file !~ /cover-letter\.patch$/) { 6102000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 6103000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 61040a920b5bSAndy Whitcroft } 6105ed43c4e5SAllen Hubbe if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) { 6106000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 6107000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 61080a920b5bSAndy Whitcroft } 61090a920b5bSAndy Whitcroft 6110f0a594c1SAndy Whitcroft print report_dump(); 611113214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 611213214adfSAndy Whitcroft print "$filename " if ($summary_file); 61136c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 61146c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 61156c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 61166c72ffaaSAndy Whitcroft } 61178905a67cSAndy Whitcroft 6118d2c0a235SAndy Whitcroft if ($quiet == 0) { 6119ef212196SJoe Perches # If there were any defects found and not already fixing them 6120ef212196SJoe Perches if (!$clean and !$fix) { 6121ef212196SJoe Perches print << "EOM" 6122ef212196SJoe Perches 6123ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to 6124ef212196SJoe Perches mechanically convert to the typical style using --fix or --fix-inplace. 6125ef212196SJoe PerchesEOM 6126ef212196SJoe Perches } 6127d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 6128d2c0a235SAndy Whitcroft # then suggest that. 6129d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 6130b0781216SMike Frysinger $rpt_cleaners = 0; 6131d8469f16SJoe Perches print << "EOM" 6132d8469f16SJoe Perches 6133d8469f16SJoe PerchesNOTE: Whitespace errors detected. 6134d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 6135d8469f16SJoe PerchesEOM 6136d2c0a235SAndy Whitcroft } 6137d2c0a235SAndy Whitcroft } 6138d2c0a235SAndy Whitcroft 6139d752fcc8SJoe Perches if ($clean == 0 && $fix && 6140d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 6141d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 61429624b8d6SJoe Perches my $newfile = $filename; 61439624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 61443705ce5bSJoe Perches my $linecount = 0; 61453705ce5bSJoe Perches my $f; 61463705ce5bSJoe Perches 6147d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 6148d752fcc8SJoe Perches 61493705ce5bSJoe Perches open($f, '>', $newfile) 61503705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 61513705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 61523705ce5bSJoe Perches $linecount++; 61533705ce5bSJoe Perches if ($file) { 61543705ce5bSJoe Perches if ($linecount > 3) { 61553705ce5bSJoe Perches $fixed_line =~ s/^\+//; 61563705ce5bSJoe Perches print $f $fixed_line . "\n"; 61573705ce5bSJoe Perches } 61583705ce5bSJoe Perches } else { 61593705ce5bSJoe Perches print $f $fixed_line . "\n"; 61603705ce5bSJoe Perches } 61613705ce5bSJoe Perches } 61623705ce5bSJoe Perches close($f); 61633705ce5bSJoe Perches 61643705ce5bSJoe Perches if (!$quiet) { 61653705ce5bSJoe Perches print << "EOM"; 6166d8469f16SJoe Perches 61673705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 61683705ce5bSJoe Perches 61693705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 61703705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 61713705ce5bSJoe Perches 61723705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 61733705ce5bSJoe PerchesNo warranties, expressed or implied... 61743705ce5bSJoe PerchesEOM 61753705ce5bSJoe Perches } 61763705ce5bSJoe Perches } 61773705ce5bSJoe Perches 6178d8469f16SJoe Perches if ($quiet == 0) { 6179d8469f16SJoe Perches print "\n"; 6180d8469f16SJoe Perches if ($clean == 1) { 6181d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 6182d8469f16SJoe Perches } else { 6183d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 61840a920b5bSAndy Whitcroft } 61850a920b5bSAndy Whitcroft } 61860a920b5bSAndy Whitcroft return $clean; 61870a920b5bSAndy Whitcroft} 6188