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; 100a920b5bSAndy Whitcroft 110a920b5bSAndy Whitcroftmy $P = $0; 1200df344fSAndy Whitcroft$P =~ s@.*/@@g; 130a920b5bSAndy Whitcroft 14000d1cc1SJoe Perchesmy $V = '0.32'; 150a920b5bSAndy Whitcroft 160a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 170a920b5bSAndy Whitcroft 180a920b5bSAndy Whitcroftmy $quiet = 0; 190a920b5bSAndy Whitcroftmy $tree = 1; 200a920b5bSAndy Whitcroftmy $chk_signoff = 1; 210a920b5bSAndy Whitcroftmy $chk_patch = 1; 22773647a0SAndy Whitcroftmy $tst_only; 236c72ffaaSAndy Whitcroftmy $emacs = 0; 248905a67cSAndy Whitcroftmy $terse = 0; 256c72ffaaSAndy Whitcroftmy $file = 0; 266c72ffaaSAndy Whitcroftmy $check = 0; 278905a67cSAndy Whitcroftmy $summary = 1; 288905a67cSAndy Whitcroftmy $mailback = 0; 2913214adfSAndy Whitcroftmy $summary_file = 0; 30000d1cc1SJoe Perchesmy $show_types = 0; 313705ce5bSJoe Perchesmy $fix = 0; 329624b8d6SJoe Perchesmy $fix_inplace = 0; 336c72ffaaSAndy Whitcroftmy $root; 34c2fdda0dSAndy Whitcroftmy %debug; 353445686aSJoe Perchesmy %camelcase = (); 3691bfe484SJoe Perchesmy %use_type = (); 3791bfe484SJoe Perchesmy @use = (); 3891bfe484SJoe Perchesmy %ignore_type = (); 39000d1cc1SJoe Perchesmy @ignore = (); 4077f5b10aSHannes Edermy $help = 0; 41000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 426cd7f386SJoe Perchesmy $max_line_length = 80; 43d62a201fSDave Hansenmy $ignore_perl_version = 0; 44d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 4577f5b10aSHannes Eder 4677f5b10aSHannes Edersub help { 4777f5b10aSHannes Eder my ($exitcode) = @_; 4877f5b10aSHannes Eder 4977f5b10aSHannes Eder print << "EOM"; 5077f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 5177f5b10aSHannes EderVersion: $V 5277f5b10aSHannes Eder 5377f5b10aSHannes EderOptions: 5477f5b10aSHannes Eder -q, --quiet quiet 5577f5b10aSHannes Eder --no-tree run without a kernel tree 5677f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 5777f5b10aSHannes Eder --patch treat FILE as patchfile (default) 5877f5b10aSHannes Eder --emacs emacs compile window format 5977f5b10aSHannes Eder --terse one line per report 6077f5b10aSHannes Eder -f, --file treat FILE as regular source file 6177f5b10aSHannes Eder --subjective, --strict enable more subjective tests 6291bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 63000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 646cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 65000d1cc1SJoe Perches --show-types show the message "types" in the output 6677f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 6777f5b10aSHannes Eder --no-summary suppress the per-file summary 6877f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 6977f5b10aSHannes Eder --summary-file include the filename in summary 7077f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 7177f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 7277f5b10aSHannes Eder is all off) 7377f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 7477f5b10aSHannes Eder literally 753705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 763705ce5bSJoe Perches If correctable single-line errors exist, create 773705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 783705ce5bSJoe Perches with potential errors corrected to the preferred 793705ce5bSJoe Perches checkpatch style 809624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 819624b8d6SJoe Perches Is the same as --fix, but overwrites the input 829624b8d6SJoe Perches file. It's your fault if there's no backup or git 83d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 84d62a201fSDave Hansen runtime errors. 8577f5b10aSHannes Eder -h, --help, --version display this help and exit 8677f5b10aSHannes Eder 8777f5b10aSHannes EderWhen FILE is - read standard input. 8877f5b10aSHannes EderEOM 8977f5b10aSHannes Eder 9077f5b10aSHannes Eder exit($exitcode); 9177f5b10aSHannes Eder} 9277f5b10aSHannes Eder 93000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 94000d1cc1SJoe Perchesif (-f $conf) { 95000d1cc1SJoe Perches my @conf_args; 96000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 97000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 98000d1cc1SJoe Perches 99000d1cc1SJoe Perches while (<$conffile>) { 100000d1cc1SJoe Perches my $line = $_; 101000d1cc1SJoe Perches 102000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 103000d1cc1SJoe Perches $line =~ s/^\s*//g; 104000d1cc1SJoe Perches $line =~ s/\s+/ /g; 105000d1cc1SJoe Perches 106000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 107000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 108000d1cc1SJoe Perches 109000d1cc1SJoe Perches my @words = split(" ", $line); 110000d1cc1SJoe Perches foreach my $word (@words) { 111000d1cc1SJoe Perches last if ($word =~ m/^#/); 112000d1cc1SJoe Perches push (@conf_args, $word); 113000d1cc1SJoe Perches } 114000d1cc1SJoe Perches } 115000d1cc1SJoe Perches close($conffile); 116000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 117000d1cc1SJoe Perches} 118000d1cc1SJoe Perches 1190a920b5bSAndy WhitcroftGetOptions( 1206c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1210a920b5bSAndy Whitcroft 'tree!' => \$tree, 1220a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1230a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1246c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1258905a67cSAndy Whitcroft 'terse!' => \$terse, 12677f5b10aSHannes Eder 'f|file!' => \$file, 1276c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1286c72ffaaSAndy Whitcroft 'strict!' => \$check, 129000d1cc1SJoe Perches 'ignore=s' => \@ignore, 13091bfe484SJoe Perches 'types=s' => \@use, 131000d1cc1SJoe Perches 'show-types!' => \$show_types, 1326cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 1336c72ffaaSAndy Whitcroft 'root=s' => \$root, 1348905a67cSAndy Whitcroft 'summary!' => \$summary, 1358905a67cSAndy Whitcroft 'mailback!' => \$mailback, 13613214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 1373705ce5bSJoe Perches 'fix!' => \$fix, 1389624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 139d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 140c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 141773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 14277f5b10aSHannes Eder 'h|help' => \$help, 14377f5b10aSHannes Eder 'version' => \$help 14477f5b10aSHannes Eder) or help(1); 14577f5b10aSHannes Eder 14677f5b10aSHannes Ederhelp(0) if ($help); 1470a920b5bSAndy Whitcroft 1489624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 1499624b8d6SJoe Perches 1500a920b5bSAndy Whitcroftmy $exit = 0; 1510a920b5bSAndy Whitcroft 152d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 153d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 154d62a201fSDave Hansen if (!$ignore_perl_version) { 155d62a201fSDave Hansen exit(1); 156d62a201fSDave Hansen } 157d62a201fSDave Hansen} 158d62a201fSDave Hansen 1590a920b5bSAndy Whitcroftif ($#ARGV < 0) { 16077f5b10aSHannes Eder print "$P: no input files\n"; 1610a920b5bSAndy Whitcroft exit(1); 1620a920b5bSAndy Whitcroft} 1630a920b5bSAndy Whitcroft 16491bfe484SJoe Perchessub hash_save_array_words { 16591bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 16691bfe484SJoe Perches 16791bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 16891bfe484SJoe Perches foreach my $word (@array) { 169000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 170000d1cc1SJoe Perches $word =~ s/^\s*//g; 171000d1cc1SJoe Perches $word =~ s/\s+/ /g; 172000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 173000d1cc1SJoe Perches 174000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 175000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 176000d1cc1SJoe Perches 17791bfe484SJoe Perches $hashRef->{$word}++; 178000d1cc1SJoe Perches } 17991bfe484SJoe Perches} 18091bfe484SJoe Perches 18191bfe484SJoe Perchessub hash_show_words { 18291bfe484SJoe Perches my ($hashRef, $prefix) = @_; 18391bfe484SJoe Perches 18458cb3cf6SJoe Perches if ($quiet == 0 && keys %$hashRef) { 18591bfe484SJoe Perches print "NOTE: $prefix message types:"; 18658cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 18791bfe484SJoe Perches print " $word"; 18891bfe484SJoe Perches } 18991bfe484SJoe Perches print "\n\n"; 19091bfe484SJoe Perches } 19191bfe484SJoe Perches} 19291bfe484SJoe Perches 19391bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 19491bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 195000d1cc1SJoe Perches 196c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 197c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 1987429c690SAndy Whitcroftmy $dbg_type = 0; 199a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 200c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 20121caa13cSAndy Whitcroft ## no critic 20221caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 20321caa13cSAndy Whitcroft die "$@" if ($@); 204c2fdda0dSAndy Whitcroft} 205c2fdda0dSAndy Whitcroft 206d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 207d2c0a235SAndy Whitcroft 2088905a67cSAndy Whitcroftif ($terse) { 2098905a67cSAndy Whitcroft $emacs = 1; 2108905a67cSAndy Whitcroft $quiet++; 2118905a67cSAndy Whitcroft} 2128905a67cSAndy Whitcroft 2136c72ffaaSAndy Whitcroftif ($tree) { 2146c72ffaaSAndy Whitcroft if (defined $root) { 2156c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 2166c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 2176c72ffaaSAndy Whitcroft } 2186c72ffaaSAndy Whitcroft } else { 2196c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 2206c72ffaaSAndy Whitcroft $root = '.'; 2216c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 2226c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 2236c72ffaaSAndy Whitcroft $root = $1; 2246c72ffaaSAndy Whitcroft } 2256c72ffaaSAndy Whitcroft } 2266c72ffaaSAndy Whitcroft 2276c72ffaaSAndy Whitcroft if (!defined $root) { 2280a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 2290a920b5bSAndy Whitcroft exit(2); 2300a920b5bSAndy Whitcroft } 2316c72ffaaSAndy Whitcroft} 2326c72ffaaSAndy Whitcroft 2336c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 2346c72ffaaSAndy Whitcroft 2352ceb532bSAndy Whitcroftour $Ident = qr{ 2362ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 2372ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 2382ceb532bSAndy Whitcroft }x; 2396c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 2406c72ffaaSAndy Whitcroftour $Sparse = qr{ 2416c72ffaaSAndy Whitcroft __user| 2426c72ffaaSAndy Whitcroft __kernel| 2436c72ffaaSAndy Whitcroft __force| 2446c72ffaaSAndy Whitcroft __iomem| 2456c72ffaaSAndy Whitcroft __must_check| 2466c72ffaaSAndy Whitcroft __init_refok| 247417495edSAndy Whitcroft __kprobes| 248165e72a6SSven Eckelmann __ref| 249165e72a6SSven Eckelmann __rcu 2506c72ffaaSAndy Whitcroft }x; 251e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 252e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 253e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 254e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 255e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 2568716de38SJoe Perches 25752131292SWolfram Sang# Notes to $Attribute: 25852131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2596c72ffaaSAndy Whitcroftour $Attribute = qr{ 2606c72ffaaSAndy Whitcroft const| 26103f1df7dSJoe Perches __percpu| 26203f1df7dSJoe Perches __nocast| 26303f1df7dSJoe Perches __safe| 26403f1df7dSJoe Perches __bitwise__| 26503f1df7dSJoe Perches __packed__| 26603f1df7dSJoe Perches __packed2__| 26703f1df7dSJoe Perches __naked| 26803f1df7dSJoe Perches __maybe_unused| 26903f1df7dSJoe Perches __always_unused| 27003f1df7dSJoe Perches __noreturn| 27103f1df7dSJoe Perches __used| 27203f1df7dSJoe Perches __cold| 27303f1df7dSJoe Perches __noclone| 27403f1df7dSJoe Perches __deprecated| 2756c72ffaaSAndy Whitcroft __read_mostly| 2766c72ffaaSAndy Whitcroft __kprobes| 2778716de38SJoe Perches $InitAttribute| 27824e1d81aSAndy Whitcroft ____cacheline_aligned| 27924e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 2805fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 2815fe3af11SAndy Whitcroft __weak 2826c72ffaaSAndy Whitcroft }x; 283c45dcabdSAndy Whitcroftour $Modifier; 2846c72ffaaSAndy Whitcroftour $Inline = qr{inline|__always_inline|noinline}; 2856c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 2866c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 2876c72ffaaSAndy Whitcroft 28895e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 28995e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 29095e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 29195e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 2922435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 293326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 294326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 295326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 29674349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 2972435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 298326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 299447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 30023f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 3016c72ffaaSAndy Whitcroftour $Operators = qr{ 3026c72ffaaSAndy Whitcroft <=|>=|==|!=| 3036c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 30423f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 3056c72ffaaSAndy Whitcroft }x; 3066c72ffaaSAndy Whitcroft 3078905a67cSAndy Whitcroftour $NonptrType; 3088716de38SJoe Perchesour $NonptrTypeWithAttr; 3098905a67cSAndy Whitcroftour $Type; 3108905a67cSAndy Whitcroftour $Declare; 3118905a67cSAndy Whitcroft 31215662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 31315662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 314171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 315171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 316171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 317171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 318171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 319171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 320171ae1a4SAndy Whitcroft}x; 321171ae1a4SAndy Whitcroft 32215662b3eSJoe Perchesour $UTF8 = qr{ 32315662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 32415662b3eSJoe Perches | $NON_ASCII_UTF8 32515662b3eSJoe Perches}x; 32615662b3eSJoe Perches 3278ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x: 328fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 3298ed22cadSAndy Whitcroft atomic_t 3308ed22cadSAndy Whitcroft)}; 3318ed22cadSAndy Whitcroft 332691e669bSJoe Perchesour $logFunctions = qr{(?x: 3336e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 3347d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 3356e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 336b0531722SJoe Perches panic| 33706668727SJoe Perches MODULE_[A-Z_]+| 33806668727SJoe Perches seq_vprintf|seq_printf|seq_puts 339691e669bSJoe Perches)}; 340691e669bSJoe Perches 34120112475SJoe Perchesour $signature_tags = qr{(?xi: 34220112475SJoe Perches Signed-off-by:| 34320112475SJoe Perches Acked-by:| 34420112475SJoe Perches Tested-by:| 34520112475SJoe Perches Reviewed-by:| 34620112475SJoe Perches Reported-by:| 3478543ae12SMugunthan V N Suggested-by:| 34820112475SJoe Perches To:| 34920112475SJoe Perches Cc: 35020112475SJoe Perches)}; 35120112475SJoe Perches 3528905a67cSAndy Whitcroftour @typeList = ( 3538905a67cSAndy Whitcroft qr{void}, 354c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?char}, 355c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?short}, 356c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?int}, 357c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long}, 358c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+int}, 359c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long}, 360c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long\s+int}, 3618905a67cSAndy Whitcroft qr{unsigned}, 3628905a67cSAndy Whitcroft qr{float}, 3638905a67cSAndy Whitcroft qr{double}, 3648905a67cSAndy Whitcroft qr{bool}, 3658905a67cSAndy Whitcroft qr{struct\s+$Ident}, 3668905a67cSAndy Whitcroft qr{union\s+$Ident}, 3678905a67cSAndy Whitcroft qr{enum\s+$Ident}, 3688905a67cSAndy Whitcroft qr{${Ident}_t}, 3698905a67cSAndy Whitcroft qr{${Ident}_handler}, 3708905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 3718905a67cSAndy Whitcroft); 3728716de38SJoe Perchesour @typeListWithAttr = ( 3738716de38SJoe Perches @typeList, 3748716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 3758716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 3768716de38SJoe Perches); 3778716de38SJoe Perches 378c45dcabdSAndy Whitcroftour @modifierList = ( 379c45dcabdSAndy Whitcroft qr{fastcall}, 380c45dcabdSAndy Whitcroft); 3818905a67cSAndy Whitcroft 3822435880fSJoe Perchesour @mode_permission_funcs = ( 3832435880fSJoe Perches ["module_param", 3], 3842435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 3852435880fSJoe Perches ["module_param_array_named", 5], 3862435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 3872435880fSJoe Perches ["proc_create(?:_data|)", 2], 3882435880fSJoe Perches ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2], 3892435880fSJoe Perches); 3902435880fSJoe Perches 391515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 392515a235eSJoe Perchesour $mode_perms_search = ""; 393515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 394515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 395515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 396515a235eSJoe Perches} 397515a235eSJoe Perches 3987840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 3997840a94cSWolfram Sang irq| 4007840a94cSWolfram Sang memory 4017840a94cSWolfram Sang)}; 4027840a94cSWolfram Sang# memory.h: ARM has a custom one 4037840a94cSWolfram Sang 4048905a67cSAndy Whitcroftsub build_types { 405d2172eb5SAndy Whitcroft my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 406d2172eb5SAndy Whitcroft my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 4078716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 408c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 4098905a67cSAndy Whitcroft $NonptrType = qr{ 410d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 411cf655043SAndy Whitcroft (?: 4126b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 4138ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 414c45dcabdSAndy Whitcroft (?:${all}\b) 415cf655043SAndy Whitcroft ) 416c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 4178905a67cSAndy Whitcroft }x; 4188716de38SJoe Perches $NonptrTypeWithAttr = qr{ 4198716de38SJoe Perches (?:$Modifier\s+|const\s+)* 4208716de38SJoe Perches (?: 4218716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 4228716de38SJoe Perches (?:$typeTypedefs\b)| 4238716de38SJoe Perches (?:${allWithAttr}\b) 4248716de38SJoe Perches ) 4258716de38SJoe Perches (?:\s+$Modifier|\s+const)* 4268716de38SJoe Perches }x; 4278905a67cSAndy Whitcroft $Type = qr{ 428c45dcabdSAndy Whitcroft $NonptrType 429b337d8b8SAndy Whitcroft (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)? 430c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 4318905a67cSAndy Whitcroft }x; 4328905a67cSAndy Whitcroft $Declare = qr{(?:$Storage\s+)?$Type}; 4338905a67cSAndy Whitcroft} 4348905a67cSAndy Whitcroftbuild_types(); 4356c72ffaaSAndy Whitcroft 4367d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 437d1fe9c09SJoe Perches 438d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 439d1fe9c09SJoe Perches# requires at least perl version v5.10.0 440d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 441d1fe9c09SJoe Perches 442d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 4432435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 444d7c76ba7SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)}; 4457d2367afSJoe Perches 4467d2367afSJoe Perchessub deparenthesize { 4477d2367afSJoe Perches my ($string) = @_; 4487d2367afSJoe Perches return "" if (!defined($string)); 4495b9553abSJoe Perches 4505b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 4515b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 4525b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 4535b9553abSJoe Perches } 4545b9553abSJoe Perches 4557d2367afSJoe Perches $string =~ s@\s+@ @g; 4565b9553abSJoe Perches 4577d2367afSJoe Perches return $string; 4587d2367afSJoe Perches} 4597d2367afSJoe Perches 4603445686aSJoe Perchessub seed_camelcase_file { 4613445686aSJoe Perches my ($file) = @_; 4623445686aSJoe Perches 4633445686aSJoe Perches return if (!(-f $file)); 4643445686aSJoe Perches 4653445686aSJoe Perches local $/; 4663445686aSJoe Perches 4673445686aSJoe Perches open(my $include_file, '<', "$file") 4683445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 4693445686aSJoe Perches my $text = <$include_file>; 4703445686aSJoe Perches close($include_file); 4713445686aSJoe Perches 4723445686aSJoe Perches my @lines = split('\n', $text); 4733445686aSJoe Perches 4743445686aSJoe Perches foreach my $line (@lines) { 4753445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 4763445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 4773445686aSJoe Perches $camelcase{$1} = 1; 47811ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 47911ea516aSJoe Perches $camelcase{$1} = 1; 48011ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 4813445686aSJoe Perches $camelcase{$1} = 1; 4823445686aSJoe Perches } 4833445686aSJoe Perches } 4843445686aSJoe Perches} 4853445686aSJoe Perches 4863445686aSJoe Perchesmy $camelcase_seeded = 0; 4873445686aSJoe Perchessub seed_camelcase_includes { 4883445686aSJoe Perches return if ($camelcase_seeded); 4893445686aSJoe Perches 4903445686aSJoe Perches my $files; 491c707a81dSJoe Perches my $camelcase_cache = ""; 492c707a81dSJoe Perches my @include_files = (); 493c707a81dSJoe Perches 494c707a81dSJoe Perches $camelcase_seeded = 1; 495351b2a1fSJoe Perches 4963645e328SRichard Genoud if (-e ".git") { 497351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 498351b2a1fSJoe Perches chomp $git_last_include_commit; 499c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 500c707a81dSJoe Perches } else { 501c707a81dSJoe Perches my $last_mod_date = 0; 502c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 503c707a81dSJoe Perches @include_files = split('\n', $files); 504c707a81dSJoe Perches foreach my $file (@include_files) { 505c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 506c707a81dSJoe Perches localtime((stat $file)[9])); 507c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 508c707a81dSJoe Perches } 509c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 510c707a81dSJoe Perches } 511c707a81dSJoe Perches 512c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 513c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 514c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 515351b2a1fSJoe Perches while (<$camelcase_file>) { 516351b2a1fSJoe Perches chomp; 517351b2a1fSJoe Perches $camelcase{$_} = 1; 518351b2a1fSJoe Perches } 519351b2a1fSJoe Perches close($camelcase_file); 520351b2a1fSJoe Perches 521351b2a1fSJoe Perches return; 522351b2a1fSJoe Perches } 523c707a81dSJoe Perches 5243645e328SRichard Genoud if (-e ".git") { 525c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 526c707a81dSJoe Perches @include_files = split('\n', $files); 5273445686aSJoe Perches } 528c707a81dSJoe Perches 5293445686aSJoe Perches foreach my $file (@include_files) { 5303445686aSJoe Perches seed_camelcase_file($file); 5313445686aSJoe Perches } 532351b2a1fSJoe Perches 533c707a81dSJoe Perches if ($camelcase_cache ne "") { 534351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 535c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 536c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 537351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 538351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 539351b2a1fSJoe Perches } 540351b2a1fSJoe Perches close($camelcase_file); 541351b2a1fSJoe Perches } 5423445686aSJoe Perches} 5433445686aSJoe Perches 5446c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 5450a920b5bSAndy Whitcroft 54600df344fSAndy Whitcroftmy @rawlines = (); 547c2fdda0dSAndy Whitcroftmy @lines = (); 5483705ce5bSJoe Perchesmy @fixed = (); 549c2fdda0dSAndy Whitcroftmy $vname; 5506c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 55121caa13cSAndy Whitcroft my $FILE; 5526c72ffaaSAndy Whitcroft if ($file) { 55321caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 5546c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 55521caa13cSAndy Whitcroft } elsif ($filename eq '-') { 55621caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 5576c72ffaaSAndy Whitcroft } else { 55821caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 5596c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 5606c72ffaaSAndy Whitcroft } 561c2fdda0dSAndy Whitcroft if ($filename eq '-') { 562c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 563c2fdda0dSAndy Whitcroft } else { 564c2fdda0dSAndy Whitcroft $vname = $filename; 565c2fdda0dSAndy Whitcroft } 56621caa13cSAndy Whitcroft while (<$FILE>) { 5670a920b5bSAndy Whitcroft chomp; 56800df344fSAndy Whitcroft push(@rawlines, $_); 5696c72ffaaSAndy Whitcroft } 57021caa13cSAndy Whitcroft close($FILE); 571c2fdda0dSAndy Whitcroft if (!process($filename)) { 5720a920b5bSAndy Whitcroft $exit = 1; 5730a920b5bSAndy Whitcroft } 57400df344fSAndy Whitcroft @rawlines = (); 57513214adfSAndy Whitcroft @lines = (); 5763705ce5bSJoe Perches @fixed = (); 5770a920b5bSAndy Whitcroft} 5780a920b5bSAndy Whitcroft 5790a920b5bSAndy Whitcroftexit($exit); 5800a920b5bSAndy Whitcroft 5810a920b5bSAndy Whitcroftsub top_of_kernel_tree { 5826c72ffaaSAndy Whitcroft my ($root) = @_; 5836c72ffaaSAndy Whitcroft 5846c72ffaaSAndy Whitcroft my @tree_check = ( 5856c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 5866c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 5876c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 5886c72ffaaSAndy Whitcroft ); 5896c72ffaaSAndy Whitcroft 5906c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 5916c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 5920a920b5bSAndy Whitcroft return 0; 5930a920b5bSAndy Whitcroft } 5946c72ffaaSAndy Whitcroft } 5956c72ffaaSAndy Whitcroft return 1; 5966c72ffaaSAndy Whitcroft} 5970a920b5bSAndy Whitcroft 59820112475SJoe Perchessub parse_email { 59920112475SJoe Perches my ($formatted_email) = @_; 60020112475SJoe Perches 60120112475SJoe Perches my $name = ""; 60220112475SJoe Perches my $address = ""; 60320112475SJoe Perches my $comment = ""; 60420112475SJoe Perches 60520112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 60620112475SJoe Perches $name = $1; 60720112475SJoe Perches $address = $2; 60820112475SJoe Perches $comment = $3 if defined $3; 60920112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 61020112475SJoe Perches $address = $1; 61120112475SJoe Perches $comment = $2 if defined $2; 61220112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 61320112475SJoe Perches $address = $1; 61420112475SJoe Perches $comment = $2 if defined $2; 61520112475SJoe Perches $formatted_email =~ s/$address.*$//; 61620112475SJoe Perches $name = $formatted_email; 6173705ce5bSJoe Perches $name = trim($name); 61820112475SJoe Perches $name =~ s/^\"|\"$//g; 61920112475SJoe Perches # If there's a name left after stripping spaces and 62020112475SJoe Perches # leading quotes, and the address doesn't have both 62120112475SJoe Perches # leading and trailing angle brackets, the address 62220112475SJoe Perches # is invalid. ie: 62320112475SJoe Perches # "joe smith [email protected]" bad 62420112475SJoe Perches # "joe smith <[email protected]" bad 62520112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 62620112475SJoe Perches $name = ""; 62720112475SJoe Perches $address = ""; 62820112475SJoe Perches $comment = ""; 62920112475SJoe Perches } 63020112475SJoe Perches } 63120112475SJoe Perches 6323705ce5bSJoe Perches $name = trim($name); 63320112475SJoe Perches $name =~ s/^\"|\"$//g; 6343705ce5bSJoe Perches $address = trim($address); 63520112475SJoe Perches $address =~ s/^\<|\>$//g; 63620112475SJoe Perches 63720112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 63820112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 63920112475SJoe Perches $name = "\"$name\""; 64020112475SJoe Perches } 64120112475SJoe Perches 64220112475SJoe Perches return ($name, $address, $comment); 64320112475SJoe Perches} 64420112475SJoe Perches 64520112475SJoe Perchessub format_email { 64620112475SJoe Perches my ($name, $address) = @_; 64720112475SJoe Perches 64820112475SJoe Perches my $formatted_email; 64920112475SJoe Perches 6503705ce5bSJoe Perches $name = trim($name); 65120112475SJoe Perches $name =~ s/^\"|\"$//g; 6523705ce5bSJoe Perches $address = trim($address); 65320112475SJoe Perches 65420112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 65520112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 65620112475SJoe Perches $name = "\"$name\""; 65720112475SJoe Perches } 65820112475SJoe Perches 65920112475SJoe Perches if ("$name" eq "") { 66020112475SJoe Perches $formatted_email = "$address"; 66120112475SJoe Perches } else { 66220112475SJoe Perches $formatted_email = "$name <$address>"; 66320112475SJoe Perches } 66420112475SJoe Perches 66520112475SJoe Perches return $formatted_email; 66620112475SJoe Perches} 66720112475SJoe Perches 668000d1cc1SJoe Perchessub which_conf { 669000d1cc1SJoe Perches my ($conf) = @_; 670000d1cc1SJoe Perches 671000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 672000d1cc1SJoe Perches if (-e "$path/$conf") { 673000d1cc1SJoe Perches return "$path/$conf"; 674000d1cc1SJoe Perches } 675000d1cc1SJoe Perches } 676000d1cc1SJoe Perches 677000d1cc1SJoe Perches return ""; 678000d1cc1SJoe Perches} 679000d1cc1SJoe Perches 6800a920b5bSAndy Whitcroftsub expand_tabs { 6810a920b5bSAndy Whitcroft my ($str) = @_; 6820a920b5bSAndy Whitcroft 6830a920b5bSAndy Whitcroft my $res = ''; 6840a920b5bSAndy Whitcroft my $n = 0; 6850a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 6860a920b5bSAndy Whitcroft if ($c eq "\t") { 6870a920b5bSAndy Whitcroft $res .= ' '; 6880a920b5bSAndy Whitcroft $n++; 6890a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 6900a920b5bSAndy Whitcroft $res .= ' '; 6910a920b5bSAndy Whitcroft } 6920a920b5bSAndy Whitcroft next; 6930a920b5bSAndy Whitcroft } 6940a920b5bSAndy Whitcroft $res .= $c; 6950a920b5bSAndy Whitcroft $n++; 6960a920b5bSAndy Whitcroft } 6970a920b5bSAndy Whitcroft 6980a920b5bSAndy Whitcroft return $res; 6990a920b5bSAndy Whitcroft} 7006c72ffaaSAndy Whitcroftsub copy_spacing { 701773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 7026c72ffaaSAndy Whitcroft return $res; 7036c72ffaaSAndy Whitcroft} 7040a920b5bSAndy Whitcroft 7054a0df2efSAndy Whitcroftsub line_stats { 7064a0df2efSAndy Whitcroft my ($line) = @_; 7074a0df2efSAndy Whitcroft 7084a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 7094a0df2efSAndy Whitcroft $line =~ s/^.//; 7104a0df2efSAndy Whitcroft $line = expand_tabs($line); 7114a0df2efSAndy Whitcroft 7124a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 7134a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 7144a0df2efSAndy Whitcroft 7154a0df2efSAndy Whitcroft return (length($line), length($white)); 7164a0df2efSAndy Whitcroft} 7174a0df2efSAndy Whitcroft 718773647a0SAndy Whitcroftmy $sanitise_quote = ''; 719773647a0SAndy Whitcroft 720773647a0SAndy Whitcroftsub sanitise_line_reset { 721773647a0SAndy Whitcroft my ($in_comment) = @_; 722773647a0SAndy Whitcroft 723773647a0SAndy Whitcroft if ($in_comment) { 724773647a0SAndy Whitcroft $sanitise_quote = '*/'; 725773647a0SAndy Whitcroft } else { 726773647a0SAndy Whitcroft $sanitise_quote = ''; 727773647a0SAndy Whitcroft } 728773647a0SAndy Whitcroft} 72900df344fSAndy Whitcroftsub sanitise_line { 73000df344fSAndy Whitcroft my ($line) = @_; 73100df344fSAndy Whitcroft 73200df344fSAndy Whitcroft my $res = ''; 73300df344fSAndy Whitcroft my $l = ''; 73400df344fSAndy Whitcroft 735c2fdda0dSAndy Whitcroft my $qlen = 0; 736773647a0SAndy Whitcroft my $off = 0; 737773647a0SAndy Whitcroft my $c; 73800df344fSAndy Whitcroft 739773647a0SAndy Whitcroft # Always copy over the diff marker. 740773647a0SAndy Whitcroft $res = substr($line, 0, 1); 741773647a0SAndy Whitcroft 742773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 743773647a0SAndy Whitcroft $c = substr($line, $off, 1); 744773647a0SAndy Whitcroft 745773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 746773647a0SAndy Whitcroft # and end, all to $;. 747773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 748773647a0SAndy Whitcroft $sanitise_quote = '*/'; 749773647a0SAndy Whitcroft 750773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 751773647a0SAndy Whitcroft $off++; 75200df344fSAndy Whitcroft next; 753773647a0SAndy Whitcroft } 75481bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 755773647a0SAndy Whitcroft $sanitise_quote = ''; 756773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 757773647a0SAndy Whitcroft $off++; 758773647a0SAndy Whitcroft next; 759773647a0SAndy Whitcroft } 760113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 761113f04a8SDaniel Walker $sanitise_quote = '//'; 762113f04a8SDaniel Walker 763113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 764113f04a8SDaniel Walker $off++; 765113f04a8SDaniel Walker next; 766113f04a8SDaniel Walker } 767773647a0SAndy Whitcroft 768773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 769773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 770773647a0SAndy Whitcroft $c eq "\\") { 771773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 772773647a0SAndy Whitcroft $off++; 773773647a0SAndy Whitcroft next; 774773647a0SAndy Whitcroft } 775773647a0SAndy Whitcroft # Regular quotes. 776773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 777773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 778773647a0SAndy Whitcroft $sanitise_quote = $c; 779773647a0SAndy Whitcroft 780773647a0SAndy Whitcroft substr($res, $off, 1, $c); 781773647a0SAndy Whitcroft next; 782773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 783773647a0SAndy Whitcroft $sanitise_quote = ''; 78400df344fSAndy Whitcroft } 78500df344fSAndy Whitcroft } 786773647a0SAndy Whitcroft 787fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 788773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 789773647a0SAndy Whitcroft substr($res, $off, 1, $;); 790113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 791113f04a8SDaniel Walker substr($res, $off, 1, $;); 792773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 793773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 79400df344fSAndy Whitcroft } else { 795773647a0SAndy Whitcroft substr($res, $off, 1, $c); 79600df344fSAndy Whitcroft } 797c2fdda0dSAndy Whitcroft } 798c2fdda0dSAndy Whitcroft 799113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 800113f04a8SDaniel Walker $sanitise_quote = ''; 801113f04a8SDaniel Walker } 802113f04a8SDaniel Walker 803c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 804c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 805c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 806c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 807c2fdda0dSAndy Whitcroft 808c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 809c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 810c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 811c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 812c2fdda0dSAndy Whitcroft } 813c2fdda0dSAndy Whitcroft 81400df344fSAndy Whitcroft return $res; 81500df344fSAndy Whitcroft} 81600df344fSAndy Whitcroft 817a6962d72SJoe Perchessub get_quoted_string { 818a6962d72SJoe Perches my ($line, $rawline) = @_; 819a6962d72SJoe Perches 820a6962d72SJoe Perches return "" if ($line !~ m/(\"[X]+\")/g); 821a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 822a6962d72SJoe Perches} 823a6962d72SJoe Perches 8248905a67cSAndy Whitcroftsub ctx_statement_block { 8258905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 8268905a67cSAndy Whitcroft my $line = $linenr - 1; 8278905a67cSAndy Whitcroft my $blk = ''; 8288905a67cSAndy Whitcroft my $soff = $off; 8298905a67cSAndy Whitcroft my $coff = $off - 1; 830773647a0SAndy Whitcroft my $coff_set = 0; 8318905a67cSAndy Whitcroft 83213214adfSAndy Whitcroft my $loff = 0; 83313214adfSAndy Whitcroft 8348905a67cSAndy Whitcroft my $type = ''; 8358905a67cSAndy Whitcroft my $level = 0; 836a2750645SAndy Whitcroft my @stack = (); 837cf655043SAndy Whitcroft my $p; 8388905a67cSAndy Whitcroft my $c; 8398905a67cSAndy Whitcroft my $len = 0; 84013214adfSAndy Whitcroft 84113214adfSAndy Whitcroft my $remainder; 8428905a67cSAndy Whitcroft while (1) { 843a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 844a2750645SAndy Whitcroft 845773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 8468905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 8478905a67cSAndy Whitcroft # context. 8488905a67cSAndy Whitcroft if ($off >= $len) { 8498905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 850dea33496SAndy Whitcroft last if (!defined $lines[$line]); 851c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 8528905a67cSAndy Whitcroft $remain--; 85313214adfSAndy Whitcroft $loff = $len; 854c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 8558905a67cSAndy Whitcroft $len = length($blk); 8568905a67cSAndy Whitcroft $line++; 8578905a67cSAndy Whitcroft last; 8588905a67cSAndy Whitcroft } 8598905a67cSAndy Whitcroft # Bail if there is no further context. 8608905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 86113214adfSAndy Whitcroft if ($off >= $len) { 8628905a67cSAndy Whitcroft last; 8638905a67cSAndy Whitcroft } 864f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 865f74bd194SAndy Whitcroft $level++; 866f74bd194SAndy Whitcroft $type = '#'; 867f74bd194SAndy Whitcroft } 8688905a67cSAndy Whitcroft } 869cf655043SAndy Whitcroft $p = $c; 8708905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 87113214adfSAndy Whitcroft $remainder = substr($blk, $off); 8728905a67cSAndy Whitcroft 873773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 8744635f4fbSAndy Whitcroft 8754635f4fbSAndy Whitcroft # Handle nested #if/#else. 8764635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 8774635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 8784635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 8794635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 8804635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 8814635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 8824635f4fbSAndy Whitcroft } 8834635f4fbSAndy Whitcroft 8848905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 8858905a67cSAndy Whitcroft # outermost level. 8868905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 8878905a67cSAndy Whitcroft last; 8888905a67cSAndy Whitcroft } 8898905a67cSAndy Whitcroft 89013214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 891773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 892773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 893773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 894773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 895773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 896773647a0SAndy Whitcroft $coff_set = 1; 897773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 898773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 89913214adfSAndy Whitcroft } 90013214adfSAndy Whitcroft 9018905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 9028905a67cSAndy Whitcroft $level++; 9038905a67cSAndy Whitcroft $type = '('; 9048905a67cSAndy Whitcroft } 9058905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 9068905a67cSAndy Whitcroft $level--; 9078905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 9088905a67cSAndy Whitcroft 9098905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 9108905a67cSAndy Whitcroft $coff = $off; 911773647a0SAndy Whitcroft $coff_set = 1; 912773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 9138905a67cSAndy Whitcroft } 9148905a67cSAndy Whitcroft } 9158905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 9168905a67cSAndy Whitcroft $level++; 9178905a67cSAndy Whitcroft $type = '{'; 9188905a67cSAndy Whitcroft } 9198905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 9208905a67cSAndy Whitcroft $level--; 9218905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 9228905a67cSAndy Whitcroft 9238905a67cSAndy Whitcroft if ($level == 0) { 924b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 925b998e001SPatrick Pannuto $off++; 926b998e001SPatrick Pannuto } 9278905a67cSAndy Whitcroft last; 9288905a67cSAndy Whitcroft } 9298905a67cSAndy Whitcroft } 930f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 931f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 932f74bd194SAndy Whitcroft $level--; 933f74bd194SAndy Whitcroft $type = ''; 934f74bd194SAndy Whitcroft $off++; 935f74bd194SAndy Whitcroft last; 936f74bd194SAndy Whitcroft } 9378905a67cSAndy Whitcroft $off++; 9388905a67cSAndy Whitcroft } 939a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 94013214adfSAndy Whitcroft if ($off == $len) { 941a3bb97a7SAndy Whitcroft $loff = $len + 1; 94213214adfSAndy Whitcroft $line++; 94313214adfSAndy Whitcroft $remain--; 94413214adfSAndy Whitcroft } 9458905a67cSAndy Whitcroft 9468905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 9478905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 9488905a67cSAndy Whitcroft 9498905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 9508905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 9518905a67cSAndy Whitcroft 952773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 95313214adfSAndy Whitcroft 95413214adfSAndy Whitcroft return ($statement, $condition, 95513214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 95613214adfSAndy Whitcroft} 95713214adfSAndy Whitcroft 958cf655043SAndy Whitcroftsub statement_lines { 959cf655043SAndy Whitcroft my ($stmt) = @_; 960cf655043SAndy Whitcroft 961cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 962cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 963cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 964cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 965cf655043SAndy Whitcroft 966cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 967cf655043SAndy Whitcroft 968cf655043SAndy Whitcroft return $#stmt_lines + 2; 969cf655043SAndy Whitcroft} 970cf655043SAndy Whitcroft 971cf655043SAndy Whitcroftsub statement_rawlines { 972cf655043SAndy Whitcroft my ($stmt) = @_; 973cf655043SAndy Whitcroft 974cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 975cf655043SAndy Whitcroft 976cf655043SAndy Whitcroft return $#stmt_lines + 2; 977cf655043SAndy Whitcroft} 978cf655043SAndy Whitcroft 979cf655043SAndy Whitcroftsub statement_block_size { 980cf655043SAndy Whitcroft my ($stmt) = @_; 981cf655043SAndy Whitcroft 982cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 983cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 984cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 985cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 986cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 987cf655043SAndy Whitcroft 988cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 989cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 990cf655043SAndy Whitcroft 991cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 992cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 993cf655043SAndy Whitcroft 994cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 995cf655043SAndy Whitcroft return $stmt_lines; 996cf655043SAndy Whitcroft } else { 997cf655043SAndy Whitcroft return $stmt_statements; 998cf655043SAndy Whitcroft } 999cf655043SAndy Whitcroft} 1000cf655043SAndy Whitcroft 100113214adfSAndy Whitcroftsub ctx_statement_full { 100213214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 100313214adfSAndy Whitcroft my ($statement, $condition, $level); 100413214adfSAndy Whitcroft 100513214adfSAndy Whitcroft my (@chunks); 100613214adfSAndy Whitcroft 1007cf655043SAndy Whitcroft # Grab the first conditional/block pair. 100813214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 100913214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1010773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 101113214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1012cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1013cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1014cf655043SAndy Whitcroft } 1015cf655043SAndy Whitcroft 1016cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1017cf655043SAndy Whitcroft # could continue the statement. 1018cf655043SAndy Whitcroft for (;;) { 101913214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 102013214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1021cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1022773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1023cf655043SAndy Whitcroft #print "C: push\n"; 1024cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 102513214adfSAndy Whitcroft } 102613214adfSAndy Whitcroft 102713214adfSAndy Whitcroft return ($level, $linenr, @chunks); 10288905a67cSAndy Whitcroft} 10298905a67cSAndy Whitcroft 10304a0df2efSAndy Whitcroftsub ctx_block_get { 1031f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 10324a0df2efSAndy Whitcroft my $line; 10334a0df2efSAndy Whitcroft my $start = $linenr - 1; 10344a0df2efSAndy Whitcroft my $blk = ''; 10354a0df2efSAndy Whitcroft my @o; 10364a0df2efSAndy Whitcroft my @c; 10374a0df2efSAndy Whitcroft my @res = (); 10384a0df2efSAndy Whitcroft 1039f0a594c1SAndy Whitcroft my $level = 0; 10404635f4fbSAndy Whitcroft my @stack = ($level); 104100df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 104200df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 104300df344fSAndy Whitcroft $remain--; 104400df344fSAndy Whitcroft 104500df344fSAndy Whitcroft $blk .= $rawlines[$line]; 10464635f4fbSAndy Whitcroft 10474635f4fbSAndy Whitcroft # Handle nested #if/#else. 104801464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 10494635f4fbSAndy Whitcroft push(@stack, $level); 105001464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 10514635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 105201464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 10534635f4fbSAndy Whitcroft $level = pop(@stack); 10544635f4fbSAndy Whitcroft } 10554635f4fbSAndy Whitcroft 105601464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1057f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1058f0a594c1SAndy Whitcroft if ($off > 0) { 1059f0a594c1SAndy Whitcroft $off--; 1060f0a594c1SAndy Whitcroft next; 1061f0a594c1SAndy Whitcroft } 10624a0df2efSAndy Whitcroft 1063f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1064f0a594c1SAndy Whitcroft $level--; 1065f0a594c1SAndy Whitcroft last if ($level == 0); 1066f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1067f0a594c1SAndy Whitcroft $level++; 1068f0a594c1SAndy Whitcroft } 1069f0a594c1SAndy Whitcroft } 10704a0df2efSAndy Whitcroft 1071f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 107200df344fSAndy Whitcroft push(@res, $rawlines[$line]); 10734a0df2efSAndy Whitcroft } 10744a0df2efSAndy Whitcroft 1075f0a594c1SAndy Whitcroft last if ($level == 0); 10764a0df2efSAndy Whitcroft } 10774a0df2efSAndy Whitcroft 1078f0a594c1SAndy Whitcroft return ($level, @res); 10794a0df2efSAndy Whitcroft} 10804a0df2efSAndy Whitcroftsub ctx_block_outer { 10814a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 10824a0df2efSAndy Whitcroft 1083f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1084f0a594c1SAndy Whitcroft return @r; 10854a0df2efSAndy Whitcroft} 10864a0df2efSAndy Whitcroftsub ctx_block { 10874a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 10884a0df2efSAndy Whitcroft 1089f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1090f0a594c1SAndy Whitcroft return @r; 1091653d4876SAndy Whitcroft} 1092653d4876SAndy Whitcroftsub ctx_statement { 1093f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1094f0a594c1SAndy Whitcroft 1095f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1096f0a594c1SAndy Whitcroft return @r; 1097f0a594c1SAndy Whitcroft} 1098f0a594c1SAndy Whitcroftsub ctx_block_level { 1099653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1100653d4876SAndy Whitcroft 1101f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 11024a0df2efSAndy Whitcroft} 11039c0ca6f9SAndy Whitcroftsub ctx_statement_level { 11049c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 11059c0ca6f9SAndy Whitcroft 11069c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 11079c0ca6f9SAndy Whitcroft} 11084a0df2efSAndy Whitcroft 11094a0df2efSAndy Whitcroftsub ctx_locate_comment { 11104a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 11114a0df2efSAndy Whitcroft 11124a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1113beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 11144a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 11154a0df2efSAndy Whitcroft 11164a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 11174a0df2efSAndy Whitcroft # comment. 11184a0df2efSAndy Whitcroft my $in_comment = 0; 11194a0df2efSAndy Whitcroft $current_comment = ''; 11204a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 112100df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 112200df344fSAndy Whitcroft #warn " $line\n"; 11234a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 11244a0df2efSAndy Whitcroft $in_comment = 1; 11254a0df2efSAndy Whitcroft } 11264a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 11274a0df2efSAndy Whitcroft $in_comment = 1; 11284a0df2efSAndy Whitcroft } 11294a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 11304a0df2efSAndy Whitcroft $current_comment = ''; 11314a0df2efSAndy Whitcroft } 11324a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 11334a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 11344a0df2efSAndy Whitcroft $in_comment = 0; 11354a0df2efSAndy Whitcroft } 11364a0df2efSAndy Whitcroft } 11374a0df2efSAndy Whitcroft 11384a0df2efSAndy Whitcroft chomp($current_comment); 11394a0df2efSAndy Whitcroft return($current_comment); 11404a0df2efSAndy Whitcroft} 11414a0df2efSAndy Whitcroftsub ctx_has_comment { 11424a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 11434a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 11444a0df2efSAndy Whitcroft 114500df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 11464a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 11474a0df2efSAndy Whitcroft 11484a0df2efSAndy Whitcroft return ($cmt ne ''); 11494a0df2efSAndy Whitcroft} 11504a0df2efSAndy Whitcroft 11514d001e4dSAndy Whitcroftsub raw_line { 11524d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 11534d001e4dSAndy Whitcroft 11544d001e4dSAndy Whitcroft my $offset = $linenr - 1; 11554d001e4dSAndy Whitcroft $cnt++; 11564d001e4dSAndy Whitcroft 11574d001e4dSAndy Whitcroft my $line; 11584d001e4dSAndy Whitcroft while ($cnt) { 11594d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 11604d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 11614d001e4dSAndy Whitcroft $cnt--; 11624d001e4dSAndy Whitcroft } 11634d001e4dSAndy Whitcroft 11644d001e4dSAndy Whitcroft return $line; 11654d001e4dSAndy Whitcroft} 11664d001e4dSAndy Whitcroft 11670a920b5bSAndy Whitcroftsub cat_vet { 11680a920b5bSAndy Whitcroft my ($vet) = @_; 11699c0ca6f9SAndy Whitcroft my ($res, $coded); 11700a920b5bSAndy Whitcroft 11719c0ca6f9SAndy Whitcroft $res = ''; 11726c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 11736c72ffaaSAndy Whitcroft $res .= $1; 11746c72ffaaSAndy Whitcroft if ($2 ne '') { 11759c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 11766c72ffaaSAndy Whitcroft $res .= $coded; 11776c72ffaaSAndy Whitcroft } 11789c0ca6f9SAndy Whitcroft } 11799c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 11800a920b5bSAndy Whitcroft 11819c0ca6f9SAndy Whitcroft return $res; 11820a920b5bSAndy Whitcroft} 11830a920b5bSAndy Whitcroft 1184c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1185cf655043SAndy Whitcroftmy $av_pending; 1186c2fdda0dSAndy Whitcroftmy @av_paren_type; 11871f65f947SAndy Whitcroftmy $av_pend_colon; 1188c2fdda0dSAndy Whitcroft 1189c2fdda0dSAndy Whitcroftsub annotate_reset { 1190c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1191cf655043SAndy Whitcroft $av_pending = '_'; 1192cf655043SAndy Whitcroft @av_paren_type = ('E'); 11931f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1194c2fdda0dSAndy Whitcroft} 1195c2fdda0dSAndy Whitcroft 11966c72ffaaSAndy Whitcroftsub annotate_values { 11976c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 11986c72ffaaSAndy Whitcroft 11996c72ffaaSAndy Whitcroft my $res; 12001f65f947SAndy Whitcroft my $var = '_' x length($stream); 12016c72ffaaSAndy Whitcroft my $cur = $stream; 12026c72ffaaSAndy Whitcroft 1203c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 12046c72ffaaSAndy Whitcroft 12056c72ffaaSAndy Whitcroft while (length($cur)) { 1206773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1207cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1208171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 12096c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1210c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1211c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1212cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1213c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 12146c72ffaaSAndy Whitcroft } 12156c72ffaaSAndy Whitcroft 1216c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 12179446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 12189446ef56SAndy Whitcroft push(@av_paren_type, $type); 1219addcdceaSAndy Whitcroft $type = 'c'; 12209446ef56SAndy Whitcroft 1221e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1222c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 12236c72ffaaSAndy Whitcroft $type = 'T'; 12246c72ffaaSAndy Whitcroft 1225389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1226389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1227389a2fe5SAndy Whitcroft $type = 'T'; 1228389a2fe5SAndy Whitcroft 1229c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1230171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1231c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1232171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1233171ae1a4SAndy Whitcroft if ($2 ne '') { 1234cf655043SAndy Whitcroft $av_pending = 'N'; 1235171ae1a4SAndy Whitcroft } 1236171ae1a4SAndy Whitcroft $type = 'E'; 1237171ae1a4SAndy Whitcroft 1238c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1239171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1240171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1241171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 12426c72ffaaSAndy Whitcroft 1243c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1244cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1245c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1246cf655043SAndy Whitcroft 1247cf655043SAndy Whitcroft push(@av_paren_type, $type); 1248cf655043SAndy Whitcroft push(@av_paren_type, $type); 1249171ae1a4SAndy Whitcroft $type = 'E'; 1250cf655043SAndy Whitcroft 1251c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1252cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1253cf655043SAndy Whitcroft $av_preprocessor = 1; 1254cf655043SAndy Whitcroft 1255cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1256cf655043SAndy Whitcroft 1257171ae1a4SAndy Whitcroft $type = 'E'; 1258cf655043SAndy Whitcroft 1259c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1260cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1261cf655043SAndy Whitcroft 1262cf655043SAndy Whitcroft $av_preprocessor = 1; 1263cf655043SAndy Whitcroft 1264cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1265cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1266cf655043SAndy Whitcroft pop(@av_paren_type); 1267cf655043SAndy Whitcroft push(@av_paren_type, $type); 1268171ae1a4SAndy Whitcroft $type = 'E'; 12696c72ffaaSAndy Whitcroft 12706c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1271c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 12726c72ffaaSAndy Whitcroft 1273171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1274171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1275171ae1a4SAndy Whitcroft $av_pending = $type; 1276171ae1a4SAndy Whitcroft $type = 'N'; 1277171ae1a4SAndy Whitcroft 12786c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1279c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 12806c72ffaaSAndy Whitcroft if (defined $2) { 1281cf655043SAndy Whitcroft $av_pending = 'V'; 12826c72ffaaSAndy Whitcroft } 12836c72ffaaSAndy Whitcroft $type = 'N'; 12846c72ffaaSAndy Whitcroft 128514b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1286c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 128714b111c1SAndy Whitcroft $av_pending = 'E'; 12886c72ffaaSAndy Whitcroft $type = 'N'; 12896c72ffaaSAndy Whitcroft 12901f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 12911f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 12921f65f947SAndy Whitcroft $av_pend_colon = 'C'; 12931f65f947SAndy Whitcroft $type = 'N'; 12941f65f947SAndy Whitcroft 129514b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1296c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 12976c72ffaaSAndy Whitcroft $type = 'N'; 12986c72ffaaSAndy Whitcroft 12996c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1300c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1301cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1302cf655043SAndy Whitcroft $av_pending = '_'; 13036c72ffaaSAndy Whitcroft $type = 'N'; 13046c72ffaaSAndy Whitcroft 13056c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1306cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1307cf655043SAndy Whitcroft if ($new_type ne '_') { 1308cf655043SAndy Whitcroft $type = $new_type; 1309c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1310c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 13116c72ffaaSAndy Whitcroft } else { 1312c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 13136c72ffaaSAndy Whitcroft } 13146c72ffaaSAndy Whitcroft 1315c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1316c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1317c8cb2ca3SAndy Whitcroft $type = 'V'; 1318cf655043SAndy Whitcroft $av_pending = 'V'; 13196c72ffaaSAndy Whitcroft 13208e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 13218e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 13221f65f947SAndy Whitcroft $av_pend_colon = 'B'; 13238e761b04SAndy Whitcroft } elsif ($type eq 'E') { 13248e761b04SAndy Whitcroft $av_pend_colon = 'L'; 13251f65f947SAndy Whitcroft } 13261f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 13271f65f947SAndy Whitcroft $type = 'V'; 13281f65f947SAndy Whitcroft 13296c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1330c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 13316c72ffaaSAndy Whitcroft $type = 'V'; 13326c72ffaaSAndy Whitcroft 13336c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1334c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 13356c72ffaaSAndy Whitcroft $type = 'N'; 13366c72ffaaSAndy Whitcroft 1337cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1338c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 133913214adfSAndy Whitcroft $type = 'E'; 13401f65f947SAndy Whitcroft $av_pend_colon = 'O'; 134113214adfSAndy Whitcroft 13428e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 13438e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 13448e761b04SAndy Whitcroft $type = 'C'; 13458e761b04SAndy Whitcroft 13461f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 13471f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 13481f65f947SAndy Whitcroft $type = 'N'; 13491f65f947SAndy Whitcroft 13501f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 13511f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 13521f65f947SAndy Whitcroft 13531f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 13541f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 13551f65f947SAndy Whitcroft $type = 'E'; 13561f65f947SAndy Whitcroft } else { 13571f65f947SAndy Whitcroft $type = 'N'; 13581f65f947SAndy Whitcroft } 13591f65f947SAndy Whitcroft $av_pend_colon = 'O'; 13601f65f947SAndy Whitcroft 13618e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 136213214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 13636c72ffaaSAndy Whitcroft $type = 'N'; 13646c72ffaaSAndy Whitcroft 13650d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 136674048ed8SAndy Whitcroft my $variant; 136774048ed8SAndy Whitcroft 136874048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 136974048ed8SAndy Whitcroft if ($type eq 'V') { 137074048ed8SAndy Whitcroft $variant = 'B'; 137174048ed8SAndy Whitcroft } else { 137274048ed8SAndy Whitcroft $variant = 'U'; 137374048ed8SAndy Whitcroft } 137474048ed8SAndy Whitcroft 137574048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 137674048ed8SAndy Whitcroft $type = 'N'; 137774048ed8SAndy Whitcroft 13786c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1379c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 13806c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 13816c72ffaaSAndy Whitcroft $type = 'N'; 13826c72ffaaSAndy Whitcroft } 13836c72ffaaSAndy Whitcroft 13846c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1385c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 13866c72ffaaSAndy Whitcroft } 13876c72ffaaSAndy Whitcroft if (defined $1) { 13886c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 13896c72ffaaSAndy Whitcroft $res .= $type x length($1); 13906c72ffaaSAndy Whitcroft } 13916c72ffaaSAndy Whitcroft } 13926c72ffaaSAndy Whitcroft 13931f65f947SAndy Whitcroft return ($res, $var); 13946c72ffaaSAndy Whitcroft} 13956c72ffaaSAndy Whitcroft 13968905a67cSAndy Whitcroftsub possible { 139713214adfSAndy Whitcroft my ($possible, $line) = @_; 13989a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 13990776e594SAndy Whitcroft ^(?: 14000776e594SAndy Whitcroft $Modifier| 14010776e594SAndy Whitcroft $Storage| 14020776e594SAndy Whitcroft $Type| 14039a974fdbSAndy Whitcroft DEFINE_\S+ 14049a974fdbSAndy Whitcroft )$| 14059a974fdbSAndy Whitcroft ^(?: 14060776e594SAndy Whitcroft goto| 14070776e594SAndy Whitcroft return| 14080776e594SAndy Whitcroft case| 14090776e594SAndy Whitcroft else| 14100776e594SAndy Whitcroft asm|__asm__| 141189a88353SAndy Whitcroft do| 141289a88353SAndy Whitcroft \#| 141389a88353SAndy Whitcroft \#\#| 14149a974fdbSAndy Whitcroft )(?:\s|$)| 14150776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 14169a974fdbSAndy Whitcroft )}x; 14179a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 14189a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1419c45dcabdSAndy Whitcroft # Check for modifiers. 1420c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1421c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1422c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1423c45dcabdSAndy Whitcroft 1424c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1425c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1426d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 14279a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1428d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1429d2506586SAndy Whitcroft push(@modifierList, $modifier); 1430d2506586SAndy Whitcroft } 14319a974fdbSAndy Whitcroft } 1432c45dcabdSAndy Whitcroft 1433c45dcabdSAndy Whitcroft } else { 143413214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 14358905a67cSAndy Whitcroft push(@typeList, $possible); 1436c45dcabdSAndy Whitcroft } 14378905a67cSAndy Whitcroft build_types(); 14380776e594SAndy Whitcroft } else { 14390776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 14408905a67cSAndy Whitcroft } 14418905a67cSAndy Whitcroft} 14428905a67cSAndy Whitcroft 14436c72ffaaSAndy Whitcroftmy $prefix = ''; 14446c72ffaaSAndy Whitcroft 1445000d1cc1SJoe Perchessub show_type { 1446cbec18afSJoe Perches my ($type) = @_; 144791bfe484SJoe Perches 1448cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1449cbec18afSJoe Perches 1450cbec18afSJoe Perches return !defined $ignore_type{$type}; 1451000d1cc1SJoe Perches} 1452000d1cc1SJoe Perches 1453f0a594c1SAndy Whitcroftsub report { 1454cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1455cbec18afSJoe Perches 1456cbec18afSJoe Perches if (!show_type($type) || 1457cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1458773647a0SAndy Whitcroft return 0; 1459773647a0SAndy Whitcroft } 1460000d1cc1SJoe Perches my $line; 1461000d1cc1SJoe Perches if ($show_types) { 1462cbec18afSJoe Perches $line = "$prefix$level:$type: $msg\n"; 1463000d1cc1SJoe Perches } else { 1464cbec18afSJoe Perches $line = "$prefix$level: $msg\n"; 1465000d1cc1SJoe Perches } 14668905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 14678905a67cSAndy Whitcroft 146813214adfSAndy Whitcroft push(our @report, $line); 1469773647a0SAndy Whitcroft 1470773647a0SAndy Whitcroft return 1; 1471f0a594c1SAndy Whitcroft} 1472cbec18afSJoe Perches 1473f0a594c1SAndy Whitcroftsub report_dump { 147413214adfSAndy Whitcroft our @report; 1475f0a594c1SAndy Whitcroft} 1476000d1cc1SJoe Perches 1477de7d4f0eSAndy Whitcroftsub ERROR { 1478cbec18afSJoe Perches my ($type, $msg) = @_; 1479cbec18afSJoe Perches 1480cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 1481de7d4f0eSAndy Whitcroft our $clean = 0; 14826c72ffaaSAndy Whitcroft our $cnt_error++; 14833705ce5bSJoe Perches return 1; 1484de7d4f0eSAndy Whitcroft } 14853705ce5bSJoe Perches return 0; 1486773647a0SAndy Whitcroft} 1487de7d4f0eSAndy Whitcroftsub WARN { 1488cbec18afSJoe Perches my ($type, $msg) = @_; 1489cbec18afSJoe Perches 1490cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 1491de7d4f0eSAndy Whitcroft our $clean = 0; 14926c72ffaaSAndy Whitcroft our $cnt_warn++; 14933705ce5bSJoe Perches return 1; 1494de7d4f0eSAndy Whitcroft } 14953705ce5bSJoe Perches return 0; 1496773647a0SAndy Whitcroft} 1497de7d4f0eSAndy Whitcroftsub CHK { 1498cbec18afSJoe Perches my ($type, $msg) = @_; 1499cbec18afSJoe Perches 1500cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 1501de7d4f0eSAndy Whitcroft our $clean = 0; 15026c72ffaaSAndy Whitcroft our $cnt_chk++; 15033705ce5bSJoe Perches return 1; 15046c72ffaaSAndy Whitcroft } 15053705ce5bSJoe Perches return 0; 1506de7d4f0eSAndy Whitcroft} 1507de7d4f0eSAndy Whitcroft 15086ecd9674SAndy Whitcroftsub check_absolute_file { 15096ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 15106ecd9674SAndy Whitcroft my $file = $absolute; 15116ecd9674SAndy Whitcroft 15126ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 15136ecd9674SAndy Whitcroft 15146ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 15156ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 15166ecd9674SAndy Whitcroft if (-f "$root/$file") { 15176ecd9674SAndy Whitcroft ##print "file<$file>\n"; 15186ecd9674SAndy Whitcroft last; 15196ecd9674SAndy Whitcroft } 15206ecd9674SAndy Whitcroft } 15216ecd9674SAndy Whitcroft if (! -f _) { 15226ecd9674SAndy Whitcroft return 0; 15236ecd9674SAndy Whitcroft } 15246ecd9674SAndy Whitcroft 15256ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 15266ecd9674SAndy Whitcroft my $prefix = $absolute; 15276ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 15286ecd9674SAndy Whitcroft 15296ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 15306ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1531000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1532000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 15336ecd9674SAndy Whitcroft } 15346ecd9674SAndy Whitcroft} 15356ecd9674SAndy Whitcroft 15363705ce5bSJoe Perchessub trim { 15373705ce5bSJoe Perches my ($string) = @_; 15383705ce5bSJoe Perches 1539b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1540b34c648bSJoe Perches 1541b34c648bSJoe Perches return $string; 1542b34c648bSJoe Perches} 1543b34c648bSJoe Perches 1544b34c648bSJoe Perchessub ltrim { 1545b34c648bSJoe Perches my ($string) = @_; 1546b34c648bSJoe Perches 1547b34c648bSJoe Perches $string =~ s/^\s+//; 1548b34c648bSJoe Perches 1549b34c648bSJoe Perches return $string; 1550b34c648bSJoe Perches} 1551b34c648bSJoe Perches 1552b34c648bSJoe Perchessub rtrim { 1553b34c648bSJoe Perches my ($string) = @_; 1554b34c648bSJoe Perches 1555b34c648bSJoe Perches $string =~ s/\s+$//; 15563705ce5bSJoe Perches 15573705ce5bSJoe Perches return $string; 15583705ce5bSJoe Perches} 15593705ce5bSJoe Perches 156052ea8506SJoe Perchessub string_find_replace { 156152ea8506SJoe Perches my ($string, $find, $replace) = @_; 156252ea8506SJoe Perches 156352ea8506SJoe Perches $string =~ s/$find/$replace/g; 156452ea8506SJoe Perches 156552ea8506SJoe Perches return $string; 156652ea8506SJoe Perches} 156752ea8506SJoe Perches 15683705ce5bSJoe Perchessub tabify { 15693705ce5bSJoe Perches my ($leading) = @_; 15703705ce5bSJoe Perches 15713705ce5bSJoe Perches my $source_indent = 8; 15723705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 15733705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 15743705ce5bSJoe Perches 15753705ce5bSJoe Perches #convert leading spaces to tabs 15763705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 15773705ce5bSJoe Perches #Remove spaces before a tab 15783705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 15793705ce5bSJoe Perches 15803705ce5bSJoe Perches return "$leading"; 15813705ce5bSJoe Perches} 15823705ce5bSJoe Perches 1583d1fe9c09SJoe Perchessub pos_last_openparen { 1584d1fe9c09SJoe Perches my ($line) = @_; 1585d1fe9c09SJoe Perches 1586d1fe9c09SJoe Perches my $pos = 0; 1587d1fe9c09SJoe Perches 1588d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1589d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1590d1fe9c09SJoe Perches 1591d1fe9c09SJoe Perches my $last_openparen = 0; 1592d1fe9c09SJoe Perches 1593d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1594d1fe9c09SJoe Perches return -1; 1595d1fe9c09SJoe Perches } 1596d1fe9c09SJoe Perches 1597d1fe9c09SJoe Perches my $len = length($line); 1598d1fe9c09SJoe Perches 1599d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1600d1fe9c09SJoe Perches my $string = substr($line, $pos); 1601d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1602d1fe9c09SJoe Perches $pos += length($1) - 1; 1603d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1604d1fe9c09SJoe Perches $last_openparen = $pos; 1605d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1606d1fe9c09SJoe Perches last; 1607d1fe9c09SJoe Perches } 1608d1fe9c09SJoe Perches } 1609d1fe9c09SJoe Perches 1610d1fe9c09SJoe Perches return $last_openparen + 1; 1611d1fe9c09SJoe Perches} 1612d1fe9c09SJoe Perches 16130a920b5bSAndy Whitcroftsub process { 16140a920b5bSAndy Whitcroft my $filename = shift; 16150a920b5bSAndy Whitcroft 16160a920b5bSAndy Whitcroft my $linenr=0; 16170a920b5bSAndy Whitcroft my $prevline=""; 1618c2fdda0dSAndy Whitcroft my $prevrawline=""; 16190a920b5bSAndy Whitcroft my $stashline=""; 1620c2fdda0dSAndy Whitcroft my $stashrawline=""; 16210a920b5bSAndy Whitcroft 16224a0df2efSAndy Whitcroft my $length; 16230a920b5bSAndy Whitcroft my $indent; 16240a920b5bSAndy Whitcroft my $previndent=0; 16250a920b5bSAndy Whitcroft my $stashindent=0; 16260a920b5bSAndy Whitcroft 1627de7d4f0eSAndy Whitcroft our $clean = 1; 16280a920b5bSAndy Whitcroft my $signoff = 0; 16290a920b5bSAndy Whitcroft my $is_patch = 0; 16300a920b5bSAndy Whitcroft 163115662b3eSJoe Perches my $in_header_lines = 1; 163215662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 163315662b3eSJoe Perches 1634fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1635fa64205dSPasi Savanainen 163613214adfSAndy Whitcroft our @report = (); 16376c72ffaaSAndy Whitcroft our $cnt_lines = 0; 16386c72ffaaSAndy Whitcroft our $cnt_error = 0; 16396c72ffaaSAndy Whitcroft our $cnt_warn = 0; 16406c72ffaaSAndy Whitcroft our $cnt_chk = 0; 16416c72ffaaSAndy Whitcroft 16420a920b5bSAndy Whitcroft # Trace the real file/line as we go. 16430a920b5bSAndy Whitcroft my $realfile = ''; 16440a920b5bSAndy Whitcroft my $realline = 0; 16450a920b5bSAndy Whitcroft my $realcnt = 0; 16460a920b5bSAndy Whitcroft my $here = ''; 16470a920b5bSAndy Whitcroft my $in_comment = 0; 1648c2fdda0dSAndy Whitcroft my $comment_edge = 0; 16490a920b5bSAndy Whitcroft my $first_line = 0; 16501e855726SWolfram Sang my $p1_prefix = ''; 16510a920b5bSAndy Whitcroft 165213214adfSAndy Whitcroft my $prev_values = 'E'; 165313214adfSAndy Whitcroft 165413214adfSAndy Whitcroft # suppression flags 1655773647a0SAndy Whitcroft my %suppress_ifbraces; 1656170d3a22SAndy Whitcroft my %suppress_whiletrailers; 16572b474a1aSAndy Whitcroft my %suppress_export; 16583e469cdcSAndy Whitcroft my $suppress_statement = 0; 1659653d4876SAndy Whitcroft 16607e51f197SJoe Perches my %signatures = (); 1661323c1260SJoe Perches 1662c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1663de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1664c2fdda0dSAndy Whitcroft # 1665de7d4f0eSAndy Whitcroft my @setup_docs = (); 1666de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1667773647a0SAndy Whitcroft 1668d8b07710SJoe Perches my $camelcase_file_seeded = 0; 1669d8b07710SJoe Perches 1670773647a0SAndy Whitcroft sanitise_line_reset(); 1671c2fdda0dSAndy Whitcroft my $line; 1672c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1673773647a0SAndy Whitcroft $linenr++; 1674773647a0SAndy Whitcroft $line = $rawline; 1675c2fdda0dSAndy Whitcroft 16763705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 16773705ce5bSJoe Perches 1678773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1679de7d4f0eSAndy Whitcroft $setup_docs = 0; 1680de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1681de7d4f0eSAndy Whitcroft $setup_docs = 1; 1682de7d4f0eSAndy Whitcroft } 1683773647a0SAndy Whitcroft #next; 1684de7d4f0eSAndy Whitcroft } 1685773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1686773647a0SAndy Whitcroft $realline=$1-1; 1687773647a0SAndy Whitcroft if (defined $2) { 1688773647a0SAndy Whitcroft $realcnt=$3+1; 1689773647a0SAndy Whitcroft } else { 1690773647a0SAndy Whitcroft $realcnt=1+1; 1691773647a0SAndy Whitcroft } 1692c45dcabdSAndy Whitcroft $in_comment = 0; 1693773647a0SAndy Whitcroft 1694773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1695773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1696773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1697773647a0SAndy Whitcroft # at context start. 1698773647a0SAndy Whitcroft my $edge; 169901fa9147SAndy Whitcroft my $cnt = $realcnt; 170001fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 170101fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 170201fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 170301fa9147SAndy Whitcroft $cnt--; 170401fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1705721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1706fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1707fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1708fae17daeSAndy Whitcroft ($edge) = $1; 1709fae17daeSAndy Whitcroft last; 1710fae17daeSAndy Whitcroft } 1711773647a0SAndy Whitcroft } 1712773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1713773647a0SAndy Whitcroft $in_comment = 1; 1714773647a0SAndy Whitcroft } 1715773647a0SAndy Whitcroft 1716773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1717773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1718773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1719773647a0SAndy Whitcroft if (!defined $edge && 172083242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1721773647a0SAndy Whitcroft { 1722773647a0SAndy Whitcroft $in_comment = 1; 1723773647a0SAndy Whitcroft } 1724773647a0SAndy Whitcroft 1725773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1726773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1727773647a0SAndy Whitcroft 1728171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1729773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1730171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1731773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1732773647a0SAndy Whitcroft } 1733773647a0SAndy Whitcroft push(@lines, $line); 1734773647a0SAndy Whitcroft 1735773647a0SAndy Whitcroft if ($realcnt > 1) { 1736773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1737773647a0SAndy Whitcroft } else { 1738773647a0SAndy Whitcroft $realcnt = 0; 1739773647a0SAndy Whitcroft } 1740773647a0SAndy Whitcroft 1741773647a0SAndy Whitcroft #print "==>$rawline\n"; 1742773647a0SAndy Whitcroft #print "-->$line\n"; 1743de7d4f0eSAndy Whitcroft 1744de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1745de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1746de7d4f0eSAndy Whitcroft } 1747de7d4f0eSAndy Whitcroft } 1748de7d4f0eSAndy Whitcroft 17496c72ffaaSAndy Whitcroft $prefix = ''; 17506c72ffaaSAndy Whitcroft 1751773647a0SAndy Whitcroft $realcnt = 0; 1752773647a0SAndy Whitcroft $linenr = 0; 17530a920b5bSAndy Whitcroft foreach my $line (@lines) { 17540a920b5bSAndy Whitcroft $linenr++; 17551b5539b1SJoe Perches my $sline = $line; #copy of $line 17561b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 17570a920b5bSAndy Whitcroft 1758c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 17596c72ffaaSAndy Whitcroft 17600a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 17616c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 17620a920b5bSAndy Whitcroft $is_patch = 1; 17634a0df2efSAndy Whitcroft $first_line = $linenr + 1; 17640a920b5bSAndy Whitcroft $realline=$1-1; 17650a920b5bSAndy Whitcroft if (defined $2) { 17660a920b5bSAndy Whitcroft $realcnt=$3+1; 17670a920b5bSAndy Whitcroft } else { 17680a920b5bSAndy Whitcroft $realcnt=1+1; 17690a920b5bSAndy Whitcroft } 1770c2fdda0dSAndy Whitcroft annotate_reset(); 177113214adfSAndy Whitcroft $prev_values = 'E'; 177213214adfSAndy Whitcroft 1773773647a0SAndy Whitcroft %suppress_ifbraces = (); 1774170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 17752b474a1aSAndy Whitcroft %suppress_export = (); 17763e469cdcSAndy Whitcroft $suppress_statement = 0; 17770a920b5bSAndy Whitcroft next; 17780a920b5bSAndy Whitcroft 17794a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 17804a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 17814a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1782773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 17830a920b5bSAndy Whitcroft $realline++; 1784d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 17850a920b5bSAndy Whitcroft 17864a0df2efSAndy Whitcroft # Measure the line length and indent. 1787c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 17880a920b5bSAndy Whitcroft 17890a920b5bSAndy Whitcroft # Track the previous line. 17900a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 17910a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1792c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1793c2fdda0dSAndy Whitcroft 1794773647a0SAndy Whitcroft #warn "line<$line>\n"; 17956c72ffaaSAndy Whitcroft 1796d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1797d8aaf121SAndy Whitcroft $realcnt--; 17980a920b5bSAndy Whitcroft } 17990a920b5bSAndy Whitcroft 1800cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 1801cc77cdcaSAndy Whitcroft 18020a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1803773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1804773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1805773647a0SAndy Whitcroft 18066c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 18076c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1808773647a0SAndy Whitcroft 1809773647a0SAndy Whitcroft # extract the filename as it passes 18103bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 18113bf9a009SRabin Vincent $realfile = $1; 18122b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 1813270c49a0SJoe Perches $in_commit_log = 0; 18143bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1815773647a0SAndy Whitcroft $realfile = $1; 18162b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 1817270c49a0SJoe Perches $in_commit_log = 0; 18181e855726SWolfram Sang 18191e855726SWolfram Sang $p1_prefix = $1; 1820e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 1821e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 1822000d1cc1SJoe Perches WARN("PATCH_PREFIX", 1823000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 18241e855726SWolfram Sang } 1825773647a0SAndy Whitcroft 1826c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1827000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 1828000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1829773647a0SAndy Whitcroft } 1830773647a0SAndy Whitcroft next; 1831773647a0SAndy Whitcroft } 1832773647a0SAndy Whitcroft 1833389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 18340a920b5bSAndy Whitcroft 1835c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1836c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1837c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 18380a920b5bSAndy Whitcroft 18396c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 18406c72ffaaSAndy Whitcroft 18413bf9a009SRabin Vincent# Check for incorrect file permissions 18423bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 18433bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 184404db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 184504db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 1846000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 1847000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 18483bf9a009SRabin Vincent } 18493bf9a009SRabin Vincent } 18503bf9a009SRabin Vincent 185120112475SJoe Perches# Check the patch for a signoff: 1852d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 18534a0df2efSAndy Whitcroft $signoff++; 185415662b3eSJoe Perches $in_commit_log = 0; 18550a920b5bSAndy Whitcroft } 185620112475SJoe Perches 185720112475SJoe Perches# Check signature styles 1858270c49a0SJoe Perches if (!$in_header_lines && 1859ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 186020112475SJoe Perches my $space_before = $1; 186120112475SJoe Perches my $sign_off = $2; 186220112475SJoe Perches my $space_after = $3; 186320112475SJoe Perches my $email = $4; 186420112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 186520112475SJoe Perches 1866ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 1867ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 1868ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 1869ce0338dfSJoe Perches } 187020112475SJoe Perches if (defined $space_before && $space_before ne "") { 18713705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 18723705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 18733705ce5bSJoe Perches $fix) { 18743705ce5bSJoe Perches $fixed[$linenr - 1] = 18753705ce5bSJoe Perches "$ucfirst_sign_off $email"; 18763705ce5bSJoe Perches } 187720112475SJoe Perches } 187820112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 18793705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 18803705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 18813705ce5bSJoe Perches $fix) { 18823705ce5bSJoe Perches $fixed[$linenr - 1] = 18833705ce5bSJoe Perches "$ucfirst_sign_off $email"; 18843705ce5bSJoe Perches } 18853705ce5bSJoe Perches 188620112475SJoe Perches } 188720112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 18883705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 18893705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 18903705ce5bSJoe Perches $fix) { 18913705ce5bSJoe Perches $fixed[$linenr - 1] = 18923705ce5bSJoe Perches "$ucfirst_sign_off $email"; 18933705ce5bSJoe Perches } 189420112475SJoe Perches } 189520112475SJoe Perches 189620112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 189720112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 189820112475SJoe Perches if ($suggested_email eq "") { 1899000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 1900000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 190120112475SJoe Perches } else { 190220112475SJoe Perches my $dequoted = $suggested_email; 190320112475SJoe Perches $dequoted =~ s/^"//; 190420112475SJoe Perches $dequoted =~ s/" </ </; 190520112475SJoe Perches # Don't force email to have quotes 190620112475SJoe Perches # Allow just an angle bracketed address 190720112475SJoe Perches if ("$dequoted$comment" ne $email && 190820112475SJoe Perches "<$email_address>$comment" ne $email && 190920112475SJoe Perches "$suggested_email$comment" ne $email) { 1910000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1911000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 191220112475SJoe Perches } 19130a920b5bSAndy Whitcroft } 19147e51f197SJoe Perches 19157e51f197SJoe Perches# Check for duplicate signatures 19167e51f197SJoe Perches my $sig_nospace = $line; 19177e51f197SJoe Perches $sig_nospace =~ s/\s//g; 19187e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 19197e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 19207e51f197SJoe Perches WARN("BAD_SIGN_OFF", 19217e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 19227e51f197SJoe Perches } else { 19237e51f197SJoe Perches $signatures{$sig_nospace} = 1; 19247e51f197SJoe Perches } 19250a920b5bSAndy Whitcroft } 19260a920b5bSAndy Whitcroft 1927*7ebd05efSChristopher Covington# Check for unwanted Gerrit info 1928*7ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 1929*7ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 1930*7ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 1931*7ebd05efSChristopher Covington } 1932*7ebd05efSChristopher Covington 193300df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 19348905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1935000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 1936000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 19376c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1938de7d4f0eSAndy Whitcroft } 1939de7d4f0eSAndy Whitcroft 19406ecd9674SAndy Whitcroft# Check for absolute kernel paths. 19416ecd9674SAndy Whitcroft if ($tree) { 19426ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 19436ecd9674SAndy Whitcroft my $file = $1; 19446ecd9674SAndy Whitcroft 19456ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 19466ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 19476ecd9674SAndy Whitcroft # 19486ecd9674SAndy Whitcroft } else { 19496ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 19506ecd9674SAndy Whitcroft } 19516ecd9674SAndy Whitcroft } 19526ecd9674SAndy Whitcroft } 19536ecd9674SAndy Whitcroft 1954de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1955de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1956171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1957171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1958171ae1a4SAndy Whitcroft 1959171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1960171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1961171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1962171ae1a4SAndy Whitcroft 196334d99219SJoe Perches CHK("INVALID_UTF8", 1964000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 196500df344fSAndy Whitcroft } 19660a920b5bSAndy Whitcroft 196715662b3eSJoe Perches# Check if it's the start of a commit log 196815662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 196915662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 1970270c49a0SJoe Perches $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) { 197115662b3eSJoe Perches $in_header_lines = 0; 197215662b3eSJoe Perches $in_commit_log = 1; 197315662b3eSJoe Perches } 197415662b3eSJoe Perches 1975fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 1976fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 1977fa64205dSPasi Savanainen if ($in_header_lines && 1978fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 1979fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 1980fa64205dSPasi Savanainen $non_utf8_charset = 1; 1981fa64205dSPasi Savanainen } 1982fa64205dSPasi Savanainen 1983fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 198415662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 1985fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 198615662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 198715662b3eSJoe Perches } 198815662b3eSJoe Perches 198930670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 199030670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 199100df344fSAndy Whitcroft 19920a920b5bSAndy Whitcroft#trailing whitespace 19939c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 1994c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1995d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 1996d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 1997d5e616fcSJoe Perches $fix) { 1998d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/[\s\015]+$//; 1999d5e616fcSJoe Perches } 2000c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2001c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 20023705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 20033705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 20043705ce5bSJoe Perches $fix) { 2005d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\s+$//; 20063705ce5bSJoe Perches } 20073705ce5bSJoe Perches 2008d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 20090a920b5bSAndy Whitcroft } 20105368df20SAndy Whitcroft 20114783f894SJosh Triplett# Check for FSF mailing addresses. 2012109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 20133e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 20143e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 20154783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 20164783f894SJosh Triplett my $msg_type = \&ERROR; 20174783f894SJosh Triplett $msg_type = \&CHK if ($file); 20184783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 20194783f894SJosh 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) 20204783f894SJosh Triplett } 20214783f894SJosh Triplett 20223354957aSAndi Kleen# check for Kconfig help text having a real description 20239fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 20249fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 20253354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 2026a1385803SAndy Whitcroft $line =~ /.\s*config\s+/) { 20273354957aSAndi Kleen my $length = 0; 20289fe287d7SAndy Whitcroft my $cnt = $realcnt; 20299fe287d7SAndy Whitcroft my $ln = $linenr + 1; 20309fe287d7SAndy Whitcroft my $f; 2031a1385803SAndy Whitcroft my $is_start = 0; 20329fe287d7SAndy Whitcroft my $is_end = 0; 2033a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 20349fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 20359fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 20369fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 20379fe287d7SAndy Whitcroft 20389fe287d7SAndy Whitcroft next if ($f =~ /^-/); 2039a1385803SAndy Whitcroft 2040a1385803SAndy Whitcroft if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) { 2041a1385803SAndy Whitcroft $is_start = 1; 2042a1385803SAndy Whitcroft } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) { 2043a1385803SAndy Whitcroft $length = -1; 2044a1385803SAndy Whitcroft } 2045a1385803SAndy Whitcroft 20469fe287d7SAndy Whitcroft $f =~ s/^.//; 20473354957aSAndi Kleen $f =~ s/#.*//; 20483354957aSAndi Kleen $f =~ s/^\s+//; 20493354957aSAndi Kleen next if ($f =~ /^$/); 20509fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 20519fe287d7SAndy Whitcroft $is_end = 1; 20529fe287d7SAndy Whitcroft last; 20539fe287d7SAndy Whitcroft } 20543354957aSAndi Kleen $length++; 20553354957aSAndi Kleen } 2056000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 2057a1385803SAndy Whitcroft "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4); 2058a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 20593354957aSAndi Kleen } 20603354957aSAndi Kleen 20611ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 20621ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 20631ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 20641ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 20651ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 20661ba8dfd1SKees Cook } 20671ba8dfd1SKees Cook 2068c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2069c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2070c68e5878SArnaud Lacombe my $flag = $1; 2071c68e5878SArnaud Lacombe my $replacement = { 2072c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2073c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2074c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2075c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2076c68e5878SArnaud Lacombe }; 2077c68e5878SArnaud Lacombe 2078c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2079c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2080c68e5878SArnaud Lacombe } 2081c68e5878SArnaud Lacombe 2082bff5da43SRob Herring# check for DT compatible documentation 20837dd05b38SFlorian Vaussard if (defined $root && 20847dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 20857dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 20867dd05b38SFlorian Vaussard 2087bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2088bff5da43SRob Herring 2089cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2090cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2091cc93319bSFlorian Vaussard 2092bff5da43SRob Herring foreach my $compat (@compats) { 2093bff5da43SRob Herring my $compat2 = $compat; 2094bff5da43SRob Herring $compat2 =~ s/\,[a-z]*\-/\,<\.\*>\-/; 2095bff5da43SRob Herring `grep -Erq "$compat|$compat2" $dt_path`; 2096bff5da43SRob Herring if ( $? >> 8 ) { 2097bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2098bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2099bff5da43SRob Herring } 2100bff5da43SRob Herring 21014fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 21024fbf32a6SFlorian Vaussard my $vendor = $1; 2103cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2104bff5da43SRob Herring if ( $? >> 8 ) { 2105bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2106cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2107bff5da43SRob Herring } 2108bff5da43SRob Herring } 2109bff5da43SRob Herring } 2110bff5da43SRob Herring 21115368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 21125368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 21135368df20SAndy Whitcroft 21146cd7f386SJoe Perches#line length limit 2115c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 2116f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 21170fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 21188bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 21196cd7f386SJoe Perches $length > $max_line_length) 2120c45dcabdSAndy Whitcroft { 2121000d1cc1SJoe Perches WARN("LONG_LINE", 21226cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 21230a920b5bSAndy Whitcroft } 21240a920b5bSAndy Whitcroft 2125ca56dc09SJosh Triplett# Check for user-visible strings broken across lines, which breaks the ability 21268c5fcd24SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 21278c5fcd24SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 21288c5fcd24SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 2129ca56dc09SJosh Triplett if ($line =~ /^\+\s*"/ && 2130ca56dc09SJosh Triplett $prevline =~ /"\s*$/ && 21318c5fcd24SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 2132ca56dc09SJosh Triplett WARN("SPLIT_STRING", 2133ca56dc09SJosh Triplett "quoted string split across lines\n" . $hereprev); 2134ca56dc09SJosh Triplett } 2135ca56dc09SJosh Triplett 21365e79d96eSJoe Perches# check for spaces before a quoted newline 21375e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 21383705ce5bSJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 21393705ce5bSJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 21403705ce5bSJoe Perches $fix) { 21413705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 21423705ce5bSJoe Perches } 21433705ce5bSJoe Perches 21445e79d96eSJoe Perches } 21455e79d96eSJoe Perches 21468905a67cSAndy Whitcroft# check for adding lines without a newline. 21478905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2148000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2149000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 21508905a67cSAndy Whitcroft } 21518905a67cSAndy Whitcroft 215242e41c54SMike Frysinger# Blackfin: use hi/lo macros 215342e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 215442e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 215542e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2156000d1cc1SJoe Perches ERROR("LO_MACRO", 2157000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 215842e41c54SMike Frysinger } 215942e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 216042e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2161000d1cc1SJoe Perches ERROR("HI_MACRO", 2162000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 216342e41c54SMike Frysinger } 216442e41c54SMike Frysinger } 216542e41c54SMike Frysinger 2166b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2167b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 21680a920b5bSAndy Whitcroft 21690a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 21700a920b5bSAndy Whitcroft# more than 8 must use tabs. 2171c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2172c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2173c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2174d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 21753705ce5bSJoe Perches if (ERROR("CODE_INDENT", 21763705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 21773705ce5bSJoe Perches $fix) { 21783705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 21793705ce5bSJoe Perches } 21800a920b5bSAndy Whitcroft } 21810a920b5bSAndy Whitcroft 218208e44365SAlberto Panizzo# check for space before tabs. 218308e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 218408e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 21853705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 21863705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 21873705ce5bSJoe Perches $fix) { 2188c76f4cb3SJoe Perches while ($fixed[$linenr - 1] =~ 2189c76f4cb3SJoe Perches s/(^\+.*) {8,8}+\t/$1\t\t/) {} 2190c76f4cb3SJoe Perches while ($fixed[$linenr - 1] =~ 2191c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 21923705ce5bSJoe Perches } 219308e44365SAlberto Panizzo } 219408e44365SAlberto Panizzo 2195d1fe9c09SJoe Perches# check for && or || at the start of a line 2196d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2197d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2198d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2199d1fe9c09SJoe Perches } 2200d1fe9c09SJoe Perches 2201d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2202d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 2203d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) { 2204d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2205d1fe9c09SJoe Perches my $oldindent = $1; 2206d1fe9c09SJoe Perches my $rest = $2; 2207d1fe9c09SJoe Perches 2208d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2209d1fe9c09SJoe Perches if ($pos >= 0) { 2210b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2211b34a26f3SJoe Perches my $newindent = $2; 2212d1fe9c09SJoe Perches 2213d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2214d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2215d1fe9c09SJoe Perches " " x ($pos % 8); 2216d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2217d1fe9c09SJoe Perches 2218d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2219d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 22203705ce5bSJoe Perches 22213705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 22223705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 22233705ce5bSJoe Perches $fix && $line =~ /^\+/) { 22243705ce5bSJoe Perches $fixed[$linenr - 1] =~ 22253705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 22263705ce5bSJoe Perches } 2227d1fe9c09SJoe Perches } 2228d1fe9c09SJoe Perches } 2229d1fe9c09SJoe Perches } 2230d1fe9c09SJoe Perches 223123f780c9SJoe Perches if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) { 22323705ce5bSJoe Perches if (CHK("SPACING", 22333705ce5bSJoe Perches "No space is necessary after a cast\n" . $hereprev) && 22343705ce5bSJoe Perches $fix) { 22353705ce5bSJoe Perches $fixed[$linenr - 1] =~ 22363705ce5bSJoe Perches s/^(\+.*\*[ \t]*\))[ \t]+/$1/; 22373705ce5bSJoe Perches } 2238aad4f614SJoe Perches } 2239aad4f614SJoe Perches 224005880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2241fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 224285ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 224385ad978cSJoe Perches $realline > 2) { 224405880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 224505880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 224605880600SJoe Perches } 224705880600SJoe Perches 224805880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2249a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2250a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 225161135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2252a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2253a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2254a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2255a605e32eSJoe Perches } 2256a605e32eSJoe Perches 2257a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2258c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2259c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2260c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2261c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 226205880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 226305880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 226405880600SJoe Perches } 226505880600SJoe Perches 22663b617e3bSJoe Perches# check for missing blank lines after declarations 22673b617e3bSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 22683b617e3bSJoe Perches $prevline =~ /^\+\s+$Declare\s+$Ident/ && 22693b617e3bSJoe Perches !($prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 22703b617e3bSJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && #extended lines 22713b617e3bSJoe Perches $sline =~ /^\+\s+/ && #Not at char 1 22723b617e3bSJoe Perches !($sline =~ /^\+\s+$Declare/ || 22733b617e3bSJoe Perches $sline =~ /^\+\s+$Ident\s+$Ident/ || #eg: typedef foo 22743b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 22753b617e3bSJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(])/ || 22763b617e3bSJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/)) { 22773b617e3bSJoe Perches WARN("SPACING", 22783b617e3bSJoe Perches "networking uses a blank line after declarations\n" . $hereprev); 22793b617e3bSJoe Perches } 22803b617e3bSJoe Perches 22815f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 22826b4c5bebSAndy Whitcroft# Exceptions: 22836b4c5bebSAndy Whitcroft# 1) within comments 22846b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 22856b4c5bebSAndy Whitcroft# 3) hanging labels 22863705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 22875f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 22883705ce5bSJoe Perches if (WARN("LEADING_SPACE", 22893705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 22903705ce5bSJoe Perches $fix) { 22913705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 22923705ce5bSJoe Perches } 22935f7ddae6SRaffaele Recalcati } 22945f7ddae6SRaffaele Recalcati 2295b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2296b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2297b9ea10d6SAndy Whitcroft 22981ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 22991ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 23001ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 23011ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 23021ba8dfd1SKees Cook } 23031ba8dfd1SKees Cook 2304c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2305cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2306000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2307000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2308c2fdda0dSAndy Whitcroft } 230922f2a2efSAndy Whitcroft 231042e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 231142e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 231242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2313000d1cc1SJoe Perches ERROR("CSYNC", 2314000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 231542e41c54SMike Frysinger } 231642e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 231742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2318000d1cc1SJoe Perches ERROR("SSYNC", 2319000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 232042e41c54SMike Frysinger } 232142e41c54SMike Frysinger 232256e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 232356e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 232456e77d70SJoe Perches WARN("HOTPLUG_SECTION", 232556e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 232656e77d70SJoe Perches } 232756e77d70SJoe Perches 23289c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 23292b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 23302b474a1aSAndy Whitcroft $realline_next); 23313e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 23323e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 23331b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2334170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2335f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2336171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2337171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2338171ae1a4SAndy Whitcroft 23393e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 23403e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 23413e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 23423e469cdcSAndy Whitcroft # until we hit end of it. 23433e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 23443e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 23453e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 23463e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 23473e469cdcSAndy Whitcroft } 2348f74bd194SAndy Whitcroft 23492b474a1aSAndy Whitcroft # Find the real next line. 23502b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 23512b474a1aSAndy Whitcroft if (defined $realline_next && 23522b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 23532b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 23542b474a1aSAndy Whitcroft $realline_next++; 23552b474a1aSAndy Whitcroft } 23562b474a1aSAndy Whitcroft 2357171ae1a4SAndy Whitcroft my $s = $stat; 2358171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2359cf655043SAndy Whitcroft 2360c2fdda0dSAndy Whitcroft # Ignore goto labels. 2361171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2362c2fdda0dSAndy Whitcroft 2363c2fdda0dSAndy Whitcroft # Ignore functions being called 2364171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2365c2fdda0dSAndy Whitcroft 2366463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2367463f2864SAndy Whitcroft 2368c45dcabdSAndy Whitcroft # declarations always start with types 2369d2506586SAndy 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) { 2370c45dcabdSAndy Whitcroft my $type = $1; 2371c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2372c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2373c45dcabdSAndy Whitcroft 23746c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2375a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2376c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2377c2fdda0dSAndy Whitcroft } 23788905a67cSAndy Whitcroft 23796c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 238065863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2381c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 23829c0ca6f9SAndy Whitcroft } 23838905a67cSAndy Whitcroft 23848905a67cSAndy Whitcroft # Check for any sort of function declaration. 23858905a67cSAndy Whitcroft # int foo(something bar, other baz); 23868905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2387171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 23888905a67cSAndy Whitcroft my ($name_len) = length($1); 23898905a67cSAndy Whitcroft 2390cf655043SAndy Whitcroft my $ctx = $s; 2391773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 23928905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2393cf655043SAndy Whitcroft 23948905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2395c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 23968905a67cSAndy Whitcroft 2397c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 23988905a67cSAndy Whitcroft } 23998905a67cSAndy Whitcroft } 24008905a67cSAndy Whitcroft } 24018905a67cSAndy Whitcroft 24029c0ca6f9SAndy Whitcroft } 24039c0ca6f9SAndy Whitcroft 240400df344fSAndy Whitcroft# 240500df344fSAndy Whitcroft# Checks which may be anchored in the context. 240600df344fSAndy Whitcroft# 240700df344fSAndy Whitcroft 240800df344fSAndy Whitcroft# Check for switch () and associated case and default 240900df344fSAndy Whitcroft# statements should be at the same indent. 241000df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 241100df344fSAndy Whitcroft my $err = ''; 241200df344fSAndy Whitcroft my $sep = ''; 241300df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 241400df344fSAndy Whitcroft shift(@ctx); 241500df344fSAndy Whitcroft for my $ctx (@ctx) { 241600df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 241700df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 241800df344fSAndy Whitcroft $indent != $cindent) { 241900df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 242000df344fSAndy Whitcroft $sep = ''; 242100df344fSAndy Whitcroft } else { 242200df344fSAndy Whitcroft $sep = "[...]\n"; 242300df344fSAndy Whitcroft } 242400df344fSAndy Whitcroft } 242500df344fSAndy Whitcroft if ($err ne '') { 2426000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2427000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2428de7d4f0eSAndy Whitcroft } 2429de7d4f0eSAndy Whitcroft } 2430de7d4f0eSAndy Whitcroft 2431de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2432de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 2433c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2434773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2435773647a0SAndy Whitcroft 24369c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 24378eef05ddSJoe Perches 24388eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 24398eef05ddSJoe Perches WARN("DEEP_INDENTATION", 24408eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 24418eef05ddSJoe Perches } 24428eef05ddSJoe Perches 2443de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2444de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2445de7d4f0eSAndy Whitcroft 2446548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2447548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2448de7d4f0eSAndy Whitcroft 2449548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2450548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2451548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2452548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2453548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2454773647a0SAndy Whitcroft $ctx_ln++; 2455773647a0SAndy Whitcroft } 2456548596d5SAndy Whitcroft 245753210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 245853210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2459773647a0SAndy Whitcroft 2460773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2461000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2462000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 246301464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 246400df344fSAndy Whitcroft } 2465773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2466773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2467773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2468773647a0SAndy Whitcroft { 24699c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 24709c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2471000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2472000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 247301464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 24749c0ca6f9SAndy Whitcroft } 24759c0ca6f9SAndy Whitcroft } 247600df344fSAndy Whitcroft } 247700df344fSAndy Whitcroft 24784d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 24794d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 24803e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 24813e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 24823e469cdcSAndy Whitcroft if (!defined $stat); 24834d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 24844d001e4dSAndy Whitcroft 24854d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 24864d001e4dSAndy Whitcroft 24874d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 24884d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 24894d001e4dSAndy Whitcroft # where necessary. 24904d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 24914d001e4dSAndy Whitcroft 24924d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 24936f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 24946f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 24954d001e4dSAndy Whitcroft 24964d001e4dSAndy Whitcroft # We want to check the first line inside the block 24974d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 24984d001e4dSAndy Whitcroft # 1) any blank line termination 24994d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 25004d001e4dSAndy Whitcroft # 3) any do (...) { 25014d001e4dSAndy Whitcroft my $continuation = 0; 25024d001e4dSAndy Whitcroft my $check = 0; 25034d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 25044d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 25054d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 25064d001e4dSAndy Whitcroft $continuation = 1; 25074d001e4dSAndy Whitcroft } 25089bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 25094d001e4dSAndy Whitcroft $check = 1; 25104d001e4dSAndy Whitcroft $cond_lines++; 25114d001e4dSAndy Whitcroft } 25124d001e4dSAndy Whitcroft 25134d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 25144d001e4dSAndy Whitcroft # preprocessor statement. 25154d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 25164d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 25174d001e4dSAndy Whitcroft $check = 0; 25184d001e4dSAndy Whitcroft } 25194d001e4dSAndy Whitcroft 25209bd49efeSAndy Whitcroft my $cond_ptr = -1; 2521740504c6SAndy Whitcroft $continuation = 0; 25229bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 25239bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 25244d001e4dSAndy Whitcroft 2525f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2526f16fa28fSAndy Whitcroft # is not linear. 2527f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2528f16fa28fSAndy Whitcroft $check = 0; 2529f16fa28fSAndy Whitcroft } 2530f16fa28fSAndy Whitcroft 25319bd49efeSAndy Whitcroft # Ignore: 25329bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 25339bd49efeSAndy Whitcroft # 2) preprocessor lines, and 25349bd49efeSAndy Whitcroft # 3) labels. 2535740504c6SAndy Whitcroft if ($continuation || 2536740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 25379bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 25389bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2539740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 254030dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 25419bd49efeSAndy Whitcroft $cond_lines++; 25429bd49efeSAndy Whitcroft } 25434d001e4dSAndy Whitcroft } 254430dad6ebSAndy Whitcroft } 25454d001e4dSAndy Whitcroft 25464d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 25474d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 25484d001e4dSAndy Whitcroft 25494d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 25504d001e4dSAndy Whitcroft # this is not this patch's fault. 25514d001e4dSAndy Whitcroft if (!defined($stat_real) || 25524d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 25534d001e4dSAndy Whitcroft $check = 0; 25544d001e4dSAndy Whitcroft } 25554d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 25564d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 25574d001e4dSAndy Whitcroft } 25584d001e4dSAndy Whitcroft 25599bd49efeSAndy 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"; 25604d001e4dSAndy Whitcroft 25614d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 25624d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2563000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2564000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 25654d001e4dSAndy Whitcroft } 25664d001e4dSAndy Whitcroft } 25674d001e4dSAndy Whitcroft 25686c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 25696c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 25701f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 25711f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 25726c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2573c2fdda0dSAndy Whitcroft if ($dbg_values) { 2574c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2575cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2576cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 25771f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2578c2fdda0dSAndy Whitcroft } 25796c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 25806c72ffaaSAndy Whitcroft 258100df344fSAndy Whitcroft#ignore lines not being added 25823705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 258300df344fSAndy Whitcroft 2584653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 25857429c690SAndy Whitcroft if ($dbg_type) { 25867429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2587000d1cc1SJoe Perches ERROR("TEST_TYPE", 2588000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 25897429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2590000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2591000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 25927429c690SAndy Whitcroft } 2593653d4876SAndy Whitcroft next; 2594653d4876SAndy Whitcroft } 2595a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2596a1ef277eSAndy Whitcroft if ($dbg_attr) { 25979360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2598000d1cc1SJoe Perches ERROR("TEST_ATTR", 2599000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 26009360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2601000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2602000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2603a1ef277eSAndy Whitcroft } 2604a1ef277eSAndy Whitcroft next; 2605a1ef277eSAndy Whitcroft } 2606653d4876SAndy Whitcroft 2607f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 260899423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 260999423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2610000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2611000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . $hereprev); 2612f0a594c1SAndy Whitcroft } 2613f0a594c1SAndy Whitcroft 261400df344fSAndy Whitcroft# 261500df344fSAndy Whitcroft# Checks which are anchored on the added line. 261600df344fSAndy Whitcroft# 261700df344fSAndy Whitcroft 2618653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2619c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2620653d4876SAndy Whitcroft my $path = $1; 2621653d4876SAndy Whitcroft if ($path =~ m{//}) { 2622000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2623495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 2624495e9d84SJoe Perches } 2625495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 2626495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 2627495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 2628653d4876SAndy Whitcroft } 2629653d4876SAndy Whitcroft } 2630653d4876SAndy Whitcroft 263100df344fSAndy Whitcroft# no C99 // comments 263200df344fSAndy Whitcroft if ($line =~ m{//}) { 26333705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 26343705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 26353705ce5bSJoe Perches $fix) { 26363705ce5bSJoe Perches my $line = $fixed[$linenr - 1]; 26373705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 26383705ce5bSJoe Perches my $comment = trim($1); 26393705ce5bSJoe Perches $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@; 26403705ce5bSJoe Perches } 26413705ce5bSJoe Perches } 264200df344fSAndy Whitcroft } 264300df344fSAndy Whitcroft # Remove C99 comments. 26440a920b5bSAndy Whitcroft $line =~ s@//.*@@; 26456c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 26460a920b5bSAndy Whitcroft 26472b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 26482b474a1aSAndy Whitcroft# the whole statement. 26492b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 26502b474a1aSAndy Whitcroft if (defined $realline_next && 26512b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 26522b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 26532b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 26542b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 26553cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 26563cbf62dfSAndy Whitcroft # a prefix: 26573cbf62dfSAndy Whitcroft # XXX(foo); 26583cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2659653d4876SAndy Whitcroft my $name = $1; 266087a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 26613cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 26623cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 26633cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 26643cbf62dfSAndy Whitcroft 26653cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 26662b474a1aSAndy Whitcroft \n.}\s*$| 266748012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 266848012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 266948012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 26702b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 26712b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 267248012058SAndy Whitcroft )/x) { 26732b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 26742b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 26752b474a1aSAndy Whitcroft } else { 26762b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 26770a920b5bSAndy Whitcroft } 26780a920b5bSAndy Whitcroft } 26792b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 26802b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 26812b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 26822b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 26832b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 26842b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 26852b474a1aSAndy Whitcroft } 26862b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 26872b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2688000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2689000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 26902b474a1aSAndy Whitcroft } 26910a920b5bSAndy Whitcroft 26925150bda4SJoe Eloff# check for global initialisers. 2693d5e616fcSJoe Perches if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) { 2694d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 2695000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2696d5e616fcSJoe Perches $herecurr) && 2697d5e616fcSJoe Perches $fix) { 2698d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/; 2699d5e616fcSJoe Perches } 2700f0a594c1SAndy Whitcroft } 27010a920b5bSAndy Whitcroft# check for static initialisers. 2702d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2703d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 2704000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2705d5e616fcSJoe Perches $herecurr) && 2706d5e616fcSJoe Perches $fix) { 2707d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 2708d5e616fcSJoe Perches } 27090a920b5bSAndy Whitcroft } 27100a920b5bSAndy Whitcroft 2711cb710ecaSJoe Perches# check for static const char * arrays. 2712cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2713000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2714000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2715cb710ecaSJoe Perches $herecurr); 2716cb710ecaSJoe Perches } 2717cb710ecaSJoe Perches 2718cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2719cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2720000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2721000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 2722cb710ecaSJoe Perches $herecurr); 2723cb710ecaSJoe Perches } 2724cb710ecaSJoe Perches 27259b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 27269b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 27279b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 27289b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 27299b0fa60dSJoe Perches $herecurr); 27309b0fa60dSJoe Perches } 27319b0fa60dSJoe Perches 2732b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 2733b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 2734b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 2735b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 2736b36190c5SJoe Perches $fix) { 2737b36190c5SJoe Perches $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 2738b36190c5SJoe Perches } 2739b36190c5SJoe Perches } 2740b36190c5SJoe Perches 274192e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 274292e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 274392e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 274492e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 274592e112fdSJoe Perches $fix) { 274692e112fdSJoe Perches $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 274792e112fdSJoe Perches } 274893ed0e2dSJoe Perches } 274993ed0e2dSJoe Perches 2750653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 2751653d4876SAndy Whitcroft# make sense. 2752653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 27538054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2754c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 27558ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 2756653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 2757000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 2758000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 27590a920b5bSAndy Whitcroft } 27600a920b5bSAndy Whitcroft 27610a920b5bSAndy Whitcroft# * goes on variable not on type 276265863862SAndy Whitcroft # (char*[ const]) 2763bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 2764bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 27653705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 2766d8aaf121SAndy Whitcroft 276765863862SAndy Whitcroft # Should start with a space. 276865863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 276965863862SAndy Whitcroft # Should not end with a space. 277065863862SAndy Whitcroft $to =~ s/\s+$//; 277165863862SAndy Whitcroft # '*'s should not have spaces between. 2772f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 277365863862SAndy Whitcroft } 2774d8aaf121SAndy Whitcroft 27753705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 277665863862SAndy Whitcroft if ($from ne $to) { 27773705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 27783705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 27793705ce5bSJoe Perches $fix) { 27803705ce5bSJoe Perches my $sub_from = $ident; 27813705ce5bSJoe Perches my $sub_to = $ident; 27823705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 27833705ce5bSJoe Perches $fixed[$linenr - 1] =~ 27843705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 27853705ce5bSJoe Perches } 278665863862SAndy Whitcroft } 2787bfcb2cc7SAndy Whitcroft } 2788bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 2789bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 27903705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 2791d8aaf121SAndy Whitcroft 279265863862SAndy Whitcroft # Should start with a space. 279365863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 279465863862SAndy Whitcroft # Should not end with a space. 279565863862SAndy Whitcroft $to =~ s/\s+$//; 279665863862SAndy Whitcroft # '*'s should not have spaces between. 2797f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 279865863862SAndy Whitcroft } 279965863862SAndy Whitcroft # Modifiers should have spaces. 280065863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 280165863862SAndy Whitcroft 28023705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 2803667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 28043705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 28053705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 28063705ce5bSJoe Perches $fix) { 28073705ce5bSJoe Perches 28083705ce5bSJoe Perches my $sub_from = $match; 28093705ce5bSJoe Perches my $sub_to = $match; 28103705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 28113705ce5bSJoe Perches $fixed[$linenr - 1] =~ 28123705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 28133705ce5bSJoe Perches } 281465863862SAndy Whitcroft } 28150a920b5bSAndy Whitcroft } 28160a920b5bSAndy Whitcroft 28170a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 28180a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 28190a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 28200a920b5bSAndy Whitcroft# print "$herecurr"; 28210a920b5bSAndy Whitcroft# $clean = 0; 28220a920b5bSAndy Whitcroft# } 28230a920b5bSAndy Whitcroft 28248905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2825000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 2826000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 28278905a67cSAndy Whitcroft } 28288905a67cSAndy Whitcroft 282917441227SJoe Perches# check for uses of printk_ratelimit 283017441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 2831000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 2832000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 283317441227SJoe Perches } 283417441227SJoe Perches 283500df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 283600df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 283700df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 283825985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 283900df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 2840f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 284100df344fSAndy Whitcroft my $ok = 0; 284200df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 284300df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 284425985edcSLucas De Marchi # we have a preceding printk if it ends 284500df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 284600df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 284700df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 284800df344fSAndy Whitcroft $ok = 1; 284900df344fSAndy Whitcroft } 285000df344fSAndy Whitcroft last; 285100df344fSAndy Whitcroft } 285200df344fSAndy Whitcroft } 285300df344fSAndy Whitcroft if ($ok == 0) { 2854000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 2855000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 28560a920b5bSAndy Whitcroft } 285700df344fSAndy Whitcroft } 28580a920b5bSAndy Whitcroft 2859243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 2860243f3803SJoe Perches my $orig = $1; 2861243f3803SJoe Perches my $level = lc($orig); 2862243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 28638f26b837SJoe Perches my $level2 = $level; 28648f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 2865243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 2866daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 2867243f3803SJoe Perches } 2868243f3803SJoe Perches 2869243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 2870d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 2871d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 2872d5e616fcSJoe Perches $fix) { 2873d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 2874d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 2875d5e616fcSJoe Perches } 2876243f3803SJoe Perches } 2877243f3803SJoe Perches 2878dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 2879dc139313SJoe Perches my $orig = $1; 2880dc139313SJoe Perches my $level = lc($orig); 2881dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 2882dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 2883dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 2884dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 2885dc139313SJoe Perches } 2886dc139313SJoe Perches 2887653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 2888653d4876SAndy Whitcroft# or if closed on same line 2889c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 2890c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 2891000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2892000d1cc1SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr); 28930a920b5bSAndy Whitcroft } 2894653d4876SAndy Whitcroft 28958905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 28968905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 28978905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2898000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2899000d1cc1SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev); 29008905a67cSAndy Whitcroft } 29018905a67cSAndy Whitcroft 29020c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 29033705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 29043705ce5bSJoe Perches if (WARN("SPACING", 29053705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 29063705ce5bSJoe Perches $fix) { 29073705ce5bSJoe Perches $fixed[$linenr - 1] =~ 29083705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 29093705ce5bSJoe Perches } 29100c73b4ebSAndy Whitcroft } 29110c73b4ebSAndy Whitcroft 291231070b5dSJoe Perches# Function pointer declarations 291331070b5dSJoe Perches# check spacing between type, funcptr, and args 291431070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 291591f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 291631070b5dSJoe Perches my $declare = $1; 291731070b5dSJoe Perches my $pre_pointer_space = $2; 291831070b5dSJoe Perches my $post_pointer_space = $3; 291931070b5dSJoe Perches my $funcname = $4; 292031070b5dSJoe Perches my $post_funcname_space = $5; 292131070b5dSJoe Perches my $pre_args_space = $6; 292231070b5dSJoe Perches 292391f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 292491f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 292591f72e9cSJoe Perches# don't need a space so don't warn for those. 292691f72e9cSJoe Perches my $post_declare_space = ""; 292791f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 292891f72e9cSJoe Perches $post_declare_space = $1; 292991f72e9cSJoe Perches $declare = rtrim($declare); 293091f72e9cSJoe Perches } 293191f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 293231070b5dSJoe Perches WARN("SPACING", 293331070b5dSJoe Perches "missing space after return type\n" . $herecurr); 293491f72e9cSJoe Perches $post_declare_space = " "; 293531070b5dSJoe Perches } 293631070b5dSJoe Perches 293731070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 293891f72e9cSJoe Perches# This test is not currently implemented because these declarations are 293991f72e9cSJoe Perches# equivalent to 294091f72e9cSJoe Perches# int foo(int bar, ...) 294191f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 294291f72e9cSJoe Perches# 294391f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 294491f72e9cSJoe Perches# WARN("SPACING", 294591f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 294691f72e9cSJoe Perches# } 294731070b5dSJoe Perches 294831070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 294931070b5dSJoe Perches if (defined $pre_pointer_space && 295031070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 295131070b5dSJoe Perches WARN("SPACING", 295231070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 295331070b5dSJoe Perches } 295431070b5dSJoe Perches 295531070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 295631070b5dSJoe Perches if (defined $post_pointer_space && 295731070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 295831070b5dSJoe Perches WARN("SPACING", 295931070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 296031070b5dSJoe Perches } 296131070b5dSJoe Perches 296231070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 296331070b5dSJoe Perches if (defined $post_funcname_space && 296431070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 296531070b5dSJoe Perches WARN("SPACING", 296631070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 296731070b5dSJoe Perches } 296831070b5dSJoe Perches 296931070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 297031070b5dSJoe Perches if (defined $pre_args_space && 297131070b5dSJoe Perches $pre_args_space =~ /^\s/) { 297231070b5dSJoe Perches WARN("SPACING", 297331070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 297431070b5dSJoe Perches } 297531070b5dSJoe Perches 297631070b5dSJoe Perches if (show_type("SPACING") && $fix) { 297731070b5dSJoe Perches $fixed[$linenr - 1] =~ 297891f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 297931070b5dSJoe Perches } 298031070b5dSJoe Perches } 298131070b5dSJoe Perches 29828d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 29838d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 2984fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 2985fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 29868d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 29878d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 29888d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 2989fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 2990daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 29913705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 29923705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 29933705ce5bSJoe Perches $fix) { 29943705ce5bSJoe Perches $fixed[$linenr - 1] =~ 29953705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 29963705ce5bSJoe Perches } 29978d31cfceSAndy Whitcroft } 29988d31cfceSAndy Whitcroft } 29998d31cfceSAndy Whitcroft 3000f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 30016c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3002c2fdda0dSAndy Whitcroft my $name = $1; 3003773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3004773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3005c2fdda0dSAndy Whitcroft 3006c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3007773647a0SAndy Whitcroft if ($name =~ /^(?: 3008773647a0SAndy Whitcroft if|for|while|switch|return|case| 3009773647a0SAndy Whitcroft volatile|__volatile__| 3010773647a0SAndy Whitcroft __attribute__|format|__extension__| 3011773647a0SAndy Whitcroft asm|__asm__)$/x) 3012773647a0SAndy Whitcroft { 3013c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3014c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3015c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3016c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3017773647a0SAndy Whitcroft 3018773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3019c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3020c2fdda0dSAndy Whitcroft 3021c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3022c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3023773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3024c2fdda0dSAndy Whitcroft 3025c2fdda0dSAndy Whitcroft } else { 30263705ce5bSJoe Perches if (WARN("SPACING", 30273705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 30283705ce5bSJoe Perches $fix) { 30293705ce5bSJoe Perches $fixed[$linenr - 1] =~ 30303705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 30313705ce5bSJoe Perches } 3032f0a594c1SAndy Whitcroft } 30336c72ffaaSAndy Whitcroft } 30349a4cad4eSEric Nelson 3035653d4876SAndy Whitcroft# Check operator spacing. 30360a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 30373705ce5bSJoe Perches my $fixed_line = ""; 30383705ce5bSJoe Perches my $line_fixed = 0; 30393705ce5bSJoe Perches 30409c0ca6f9SAndy Whitcroft my $ops = qr{ 30419c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 30429c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 30439c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 30441f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 304584731623SJoe Perches \?:|\?|: 30469c0ca6f9SAndy Whitcroft }x; 3047cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 30483705ce5bSJoe Perches 30493705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 30503705ce5bSJoe Perches## foreach my $el (@elements) { 30513705ce5bSJoe Perches## print("el: <$el>\n"); 30523705ce5bSJoe Perches## } 30533705ce5bSJoe Perches 30543705ce5bSJoe Perches my @fix_elements = (); 305500df344fSAndy Whitcroft my $off = 0; 30566c72ffaaSAndy Whitcroft 30573705ce5bSJoe Perches foreach my $el (@elements) { 30583705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 30593705ce5bSJoe Perches $off += length($el); 30603705ce5bSJoe Perches } 30613705ce5bSJoe Perches 30623705ce5bSJoe Perches $off = 0; 30633705ce5bSJoe Perches 30646c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3065b34c648bSJoe Perches my $last_after = -1; 30666c72ffaaSAndy Whitcroft 30670a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 30683705ce5bSJoe Perches 30693705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 30703705ce5bSJoe Perches 30713705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 30723705ce5bSJoe Perches 30734a0df2efSAndy Whitcroft $off += length($elements[$n]); 30744a0df2efSAndy Whitcroft 307525985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3076773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3077773647a0SAndy Whitcroft my $cc = ''; 3078773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3079773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3080773647a0SAndy Whitcroft } 3081773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3082773647a0SAndy Whitcroft 30834a0df2efSAndy Whitcroft my $a = ''; 30844a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 30854a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3086cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 30874a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 30884a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3089773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 30904a0df2efSAndy Whitcroft 30910a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 30924a0df2efSAndy Whitcroft 30934a0df2efSAndy Whitcroft my $c = ''; 30940a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 30954a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 30964a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3097cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 30984a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 30994a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 31008b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 31014a0df2efSAndy Whitcroft } else { 31024a0df2efSAndy Whitcroft $c = 'E'; 31030a920b5bSAndy Whitcroft } 31040a920b5bSAndy Whitcroft 31054a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 31064a0df2efSAndy Whitcroft 31074a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 31084a0df2efSAndy Whitcroft 31096c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3110de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 31110a920b5bSAndy Whitcroft 311274048ed8SAndy Whitcroft # Pull out the value of this operator. 31136c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 31140a920b5bSAndy Whitcroft 31151f65f947SAndy Whitcroft # Get the full operator variant. 31161f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 31171f65f947SAndy Whitcroft 311813214adfSAndy Whitcroft # Ignore operators passed as parameters. 311913214adfSAndy Whitcroft if ($op_type ne 'V' && 312013214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 312113214adfSAndy Whitcroft 3122cf655043SAndy Whitcroft# # Ignore comments 3123cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 312413214adfSAndy Whitcroft 3125d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 312613214adfSAndy Whitcroft } elsif ($op eq ';') { 3127cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3128cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 31293705ce5bSJoe Perches if (ERROR("SPACING", 31303705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3131b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 31323705ce5bSJoe Perches $line_fixed = 1; 31333705ce5bSJoe Perches } 3134d8aaf121SAndy Whitcroft } 3135d8aaf121SAndy Whitcroft 3136d8aaf121SAndy Whitcroft # // is a comment 3137d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 31380a920b5bSAndy Whitcroft 31391f65f947SAndy Whitcroft # No spaces for: 31401f65f947SAndy Whitcroft # -> 31411f65f947SAndy Whitcroft # : when part of a bitfield 31421f65f947SAndy Whitcroft } elsif ($op eq '->' || $opv eq ':B') { 31434a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 31443705ce5bSJoe Perches if (ERROR("SPACING", 31453705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3146b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 31473705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 31483705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 31493705ce5bSJoe Perches } 3150b34c648bSJoe Perches $line_fixed = 1; 31513705ce5bSJoe Perches } 31520a920b5bSAndy Whitcroft } 31530a920b5bSAndy Whitcroft 31540a920b5bSAndy Whitcroft # , must have a space on the right. 31550a920b5bSAndy Whitcroft } elsif ($op eq ',') { 3156cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 31573705ce5bSJoe Perches if (ERROR("SPACING", 31583705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3159b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 31603705ce5bSJoe Perches $line_fixed = 1; 3161b34c648bSJoe Perches $last_after = $n; 31623705ce5bSJoe Perches } 31630a920b5bSAndy Whitcroft } 31640a920b5bSAndy Whitcroft 31659c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 316674048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 31679c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 31689c0ca6f9SAndy Whitcroft 31699c0ca6f9SAndy Whitcroft # unary operators should have a space before and 31709c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 31719c0ca6f9SAndy Whitcroft # unary operator, or a cast 31729c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 317374048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 31740d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3175cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 31763705ce5bSJoe Perches if (ERROR("SPACING", 31773705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3178b34c648bSJoe Perches if ($n != $last_after + 2) { 3179b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 31803705ce5bSJoe Perches $line_fixed = 1; 31813705ce5bSJoe Perches } 31820a920b5bSAndy Whitcroft } 3183b34c648bSJoe Perches } 3184a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3185171ae1a4SAndy Whitcroft # A unary '*' may be const 3186171ae1a4SAndy Whitcroft 3187171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 31883705ce5bSJoe Perches if (ERROR("SPACING", 31893705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3190b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 31913705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 31923705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 31933705ce5bSJoe Perches } 3194b34c648bSJoe Perches $line_fixed = 1; 31953705ce5bSJoe Perches } 31960a920b5bSAndy Whitcroft } 31970a920b5bSAndy Whitcroft 31980a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 31990a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3200773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 32013705ce5bSJoe Perches if (ERROR("SPACING", 32023705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3203b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 32043705ce5bSJoe Perches $line_fixed = 1; 32053705ce5bSJoe Perches } 32060a920b5bSAndy Whitcroft } 3207773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3208773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 32093705ce5bSJoe Perches if (ERROR("SPACING", 32103705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3211b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 32123705ce5bSJoe Perches $line_fixed = 1; 32133705ce5bSJoe Perches } 3214653d4876SAndy Whitcroft } 3215773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 32163705ce5bSJoe Perches if (ERROR("SPACING", 32173705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3218b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 32193705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 32203705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3221773647a0SAndy Whitcroft } 3222b34c648bSJoe Perches $line_fixed = 1; 32233705ce5bSJoe Perches } 32243705ce5bSJoe Perches } 32250a920b5bSAndy Whitcroft 32260a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 32279c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 32289c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 32299c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3230c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3231c2fdda0dSAndy Whitcroft $op eq '%') 32320a920b5bSAndy Whitcroft { 3233773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 32343705ce5bSJoe Perches if (ERROR("SPACING", 32353705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3236b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3237b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3238b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3239b34c648bSJoe Perches } 32403705ce5bSJoe Perches $line_fixed = 1; 32413705ce5bSJoe Perches } 32420a920b5bSAndy Whitcroft } 32430a920b5bSAndy Whitcroft 32441f65f947SAndy Whitcroft # A colon needs no spaces before when it is 32451f65f947SAndy Whitcroft # terminating a case value or a label. 32461f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 32471f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 32483705ce5bSJoe Perches if (ERROR("SPACING", 32493705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3250b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 32513705ce5bSJoe Perches $line_fixed = 1; 32523705ce5bSJoe Perches } 32531f65f947SAndy Whitcroft } 32541f65f947SAndy Whitcroft 32550a920b5bSAndy Whitcroft # All the others need spaces both sides. 3256cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 32571f65f947SAndy Whitcroft my $ok = 0; 32581f65f947SAndy Whitcroft 325922f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 32601f65f947SAndy Whitcroft if (($op eq '<' && 32611f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 32621f65f947SAndy Whitcroft ($op eq '>' && 32631f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 32641f65f947SAndy Whitcroft { 32651f65f947SAndy Whitcroft $ok = 1; 32661f65f947SAndy Whitcroft } 32671f65f947SAndy Whitcroft 326884731623SJoe Perches # messages are ERROR, but ?: are CHK 32691f65f947SAndy Whitcroft if ($ok == 0) { 327084731623SJoe Perches my $msg_type = \&ERROR; 327184731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 327284731623SJoe Perches 327384731623SJoe Perches if (&{$msg_type}("SPACING", 32743705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 3275b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3276b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3277b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3278b34c648bSJoe Perches } 32793705ce5bSJoe Perches $line_fixed = 1; 32803705ce5bSJoe Perches } 32810a920b5bSAndy Whitcroft } 328222f2a2efSAndy Whitcroft } 32834a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 32843705ce5bSJoe Perches 32853705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 32863705ce5bSJoe Perches 32873705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 32880a920b5bSAndy Whitcroft } 32893705ce5bSJoe Perches 32903705ce5bSJoe Perches if (($#elements % 2) == 0) { 32913705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 32923705ce5bSJoe Perches } 32933705ce5bSJoe Perches 32943705ce5bSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) { 32953705ce5bSJoe Perches $fixed[$linenr - 1] = $fixed_line; 32963705ce5bSJoe Perches } 32973705ce5bSJoe Perches 32983705ce5bSJoe Perches 32990a920b5bSAndy Whitcroft } 33000a920b5bSAndy Whitcroft 3301786b6326SJoe Perches# check for whitespace before a non-naked semicolon 3302d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 3303786b6326SJoe Perches if (WARN("SPACING", 3304786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 3305786b6326SJoe Perches $fix) { 3306786b6326SJoe Perches 1 while $fixed[$linenr - 1] =~ 3307786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 3308786b6326SJoe Perches } 3309786b6326SJoe Perches } 3310786b6326SJoe Perches 3311f0a594c1SAndy Whitcroft# check for multiple assignments 3312f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 3313000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 3314000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 3315f0a594c1SAndy Whitcroft } 3316f0a594c1SAndy Whitcroft 331722f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 331822f2a2efSAndy Whitcroft## # continuation. 331922f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 332022f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 332122f2a2efSAndy Whitcroft## 332222f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 332322f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 332422f2a2efSAndy Whitcroft## my $ln = $line; 332522f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 332622f2a2efSAndy Whitcroft## } 332722f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 3328000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 3329000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 333022f2a2efSAndy Whitcroft## } 333122f2a2efSAndy Whitcroft## } 3332f0a594c1SAndy Whitcroft 33330a920b5bSAndy Whitcroft#need space before brace following if, while, etc 333422f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 333522f2a2efSAndy Whitcroft $line =~ /do{/) { 33363705ce5bSJoe Perches if (ERROR("SPACING", 33373705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 33383705ce5bSJoe Perches $fix) { 3339d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/; 33403705ce5bSJoe Perches } 3341de7d4f0eSAndy Whitcroft } 3342de7d4f0eSAndy Whitcroft 3343c4a62ef9SJoe Perches## # check for blank lines before declarations 3344c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 3345c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 3346c4a62ef9SJoe Perches## WARN("SPACING", 3347c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 3348c4a62ef9SJoe Perches## } 3349c4a62ef9SJoe Perches## 3350c4a62ef9SJoe Perches 3351de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 3352de7d4f0eSAndy Whitcroft# on the line 3353de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 3354d5e616fcSJoe Perches if (ERROR("SPACING", 3355d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 3356d5e616fcSJoe Perches $fix) { 3357d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 3358d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 3359d5e616fcSJoe Perches } 33600a920b5bSAndy Whitcroft } 33610a920b5bSAndy Whitcroft 336222f2a2efSAndy Whitcroft# check spacing on square brackets 336322f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 33643705ce5bSJoe Perches if (ERROR("SPACING", 33653705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 33663705ce5bSJoe Perches $fix) { 33673705ce5bSJoe Perches $fixed[$linenr - 1] =~ 33683705ce5bSJoe Perches s/\[\s+/\[/; 33693705ce5bSJoe Perches } 337022f2a2efSAndy Whitcroft } 337122f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 33723705ce5bSJoe Perches if (ERROR("SPACING", 33733705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 33743705ce5bSJoe Perches $fix) { 33753705ce5bSJoe Perches $fixed[$linenr - 1] =~ 33763705ce5bSJoe Perches s/\s+\]/\]/; 33773705ce5bSJoe Perches } 337822f2a2efSAndy Whitcroft } 337922f2a2efSAndy Whitcroft 3380c45dcabdSAndy Whitcroft# check spacing on parentheses 33819c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 33829c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 33833705ce5bSJoe Perches if (ERROR("SPACING", 33843705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 33853705ce5bSJoe Perches $fix) { 33863705ce5bSJoe Perches $fixed[$linenr - 1] =~ 33873705ce5bSJoe Perches s/\(\s+/\(/; 33883705ce5bSJoe Perches } 338922f2a2efSAndy Whitcroft } 339013214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 3391c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 3392c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 33933705ce5bSJoe Perches if (ERROR("SPACING", 33943705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 33953705ce5bSJoe Perches $fix) { 33963705ce5bSJoe Perches $fixed[$linenr - 1] =~ 33973705ce5bSJoe Perches s/\s+\)/\)/; 33983705ce5bSJoe Perches } 339922f2a2efSAndy Whitcroft } 340022f2a2efSAndy Whitcroft 34010a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 34024a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 34030a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 34043705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 34053705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 34063705ce5bSJoe Perches $fix) { 34073705ce5bSJoe Perches $fixed[$linenr - 1] =~ 34083705ce5bSJoe Perches s/^(.)\s+/$1/; 34093705ce5bSJoe Perches } 34100a920b5bSAndy Whitcroft } 34110a920b5bSAndy Whitcroft 34125b9553abSJoe Perches# return is not a function 3413507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 3414c45dcabdSAndy Whitcroft my $spacing = $1; 3415507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 34165b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 34175b9553abSJoe Perches my $value = $1; 34185b9553abSJoe Perches $value = deparenthesize($value); 34195b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 3420000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 3421000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 34225b9553abSJoe Perches } 3423c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 3424000d1cc1SJoe Perches ERROR("SPACING", 3425000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 3426c45dcabdSAndy Whitcroft } 3427c45dcabdSAndy Whitcroft } 3428507e5141SJoe Perches 3429189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 3430189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 3431189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 3432189248d8SJoe Perches my $openparens = $1; 3433189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 3434189248d8SJoe Perches my $msg = ""; 3435189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 3436189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 3437189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 3438189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 3439189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 3440189248d8SJoe Perches } 3441189248d8SJoe Perches } 3442189248d8SJoe Perches 344353a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 344453a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 344553a3c448SAndy Whitcroft my $name = $1; 344653a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 3447000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 3448000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 344953a3c448SAndy Whitcroft } 345053a3c448SAndy Whitcroft } 3451c45dcabdSAndy Whitcroft 34520a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 34534a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 34543705ce5bSJoe Perches if (ERROR("SPACING", 34553705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 34563705ce5bSJoe Perches $fix) { 34573705ce5bSJoe Perches $fixed[$linenr - 1] =~ 34583705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 34593705ce5bSJoe Perches } 34600a920b5bSAndy Whitcroft } 34610a920b5bSAndy Whitcroft 3462f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 3463f5fe35ddSAndy Whitcroft# statements after the conditional. 3464170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 34653e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 34663e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 34673e469cdcSAndy Whitcroft if (!defined $stat); 3468170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 3469170d3a22SAndy Whitcroft $remain_next, $off_next); 3470170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 3471170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 3472170d3a22SAndy Whitcroft 3473170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 3474170d3a22SAndy Whitcroft # If the statement carries leading newlines, 3475170d3a22SAndy Whitcroft # then count those as offsets. 3476170d3a22SAndy Whitcroft my ($whitespace) = 3477170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 3478170d3a22SAndy Whitcroft my $offset = 3479170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 3480170d3a22SAndy Whitcroft 3481170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 3482170d3a22SAndy Whitcroft $offset} = 1; 3483170d3a22SAndy Whitcroft } 3484170d3a22SAndy Whitcroft } 3485170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 3486c11230f4SJoe Perches defined($stat) && defined($cond) && 3487170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 3488171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 34898905a67cSAndy Whitcroft 3490b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 3491000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 3492000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 34938905a67cSAndy Whitcroft } 34948905a67cSAndy Whitcroft 34958905a67cSAndy Whitcroft # Find out what is on the end of the line after the 34968905a67cSAndy Whitcroft # conditional. 3497773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 34988905a67cSAndy Whitcroft $s =~ s/\n.*//g; 349913214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 350053210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 350153210168SAndy Whitcroft $c !~ /}\s*while\s*/) 3502773647a0SAndy Whitcroft { 3503bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 3504bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 3505bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 350642bdf74cSHidetoshi Seto my $stat_real = ''; 3507bb44ad39SAndy Whitcroft 350842bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 350942bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 3510bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 3511bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 3512bb44ad39SAndy Whitcroft } 3513bb44ad39SAndy Whitcroft 3514000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3515000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 35168905a67cSAndy Whitcroft } 35178905a67cSAndy Whitcroft } 35188905a67cSAndy Whitcroft 351913214adfSAndy Whitcroft# Check for bitwise tests written as boolean 352013214adfSAndy Whitcroft if ($line =~ / 352113214adfSAndy Whitcroft (?: 352213214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 352313214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 352413214adfSAndy Whitcroft (?:\&\&|\|\|) 352513214adfSAndy Whitcroft | 352613214adfSAndy Whitcroft (?:\&\&|\|\|) 352713214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 352813214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 352913214adfSAndy Whitcroft )/x) 353013214adfSAndy Whitcroft { 3531000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 3532000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 353313214adfSAndy Whitcroft } 353413214adfSAndy Whitcroft 35358905a67cSAndy Whitcroft# if and else should not have general statements after it 353613214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 353713214adfSAndy Whitcroft my $s = $1; 353813214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 353913214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 3540000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3541000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 35420a920b5bSAndy Whitcroft } 354313214adfSAndy Whitcroft } 354439667782SAndy Whitcroft# if should not continue a brace 354539667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 3546000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3547000d1cc1SJoe Perches "trailing statements should be on next line\n" . 354839667782SAndy Whitcroft $herecurr); 354939667782SAndy Whitcroft } 3550a1080bf8SAndy Whitcroft# case and default should not have general statements after them 3551a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 3552a1080bf8SAndy Whitcroft $line !~ /\G(?: 35533fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 3554a1080bf8SAndy Whitcroft \s*return\s+ 3555a1080bf8SAndy Whitcroft )/xg) 3556a1080bf8SAndy Whitcroft { 3557000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3558000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 3559a1080bf8SAndy Whitcroft } 35600a920b5bSAndy Whitcroft 35610a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 35620a920b5bSAndy Whitcroft # indent level to be relevant to each other. 35630a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 35640a920b5bSAndy Whitcroft $previndent == $indent) { 3565000d1cc1SJoe Perches ERROR("ELSE_AFTER_BRACE", 3566000d1cc1SJoe Perches "else should follow close brace '}'\n" . $hereprev); 35670a920b5bSAndy Whitcroft } 35680a920b5bSAndy Whitcroft 3569c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 3570c2fdda0dSAndy Whitcroft $previndent == $indent) { 3571c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 3572c2fdda0dSAndy Whitcroft 3573c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 3574c2fdda0dSAndy Whitcroft # conditional. 3575773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 3576c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 3577c2fdda0dSAndy Whitcroft 3578c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 3579000d1cc1SJoe Perches ERROR("WHILE_AFTER_BRACE", 3580000d1cc1SJoe Perches "while should follow close brace '}'\n" . $hereprev); 3581c2fdda0dSAndy Whitcroft } 3582c2fdda0dSAndy Whitcroft } 3583c2fdda0dSAndy Whitcroft 358495e2c602SJoe Perches#Specific variable tests 3585323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 3586323c1260SJoe Perches my $var = $1; 358795e2c602SJoe Perches 358895e2c602SJoe Perches#gcc binary extension 358995e2c602SJoe Perches if ($var =~ /^$Binary$/) { 3590d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 3591d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 3592d5e616fcSJoe Perches $fix) { 3593d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 3594d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 3595d5e616fcSJoe Perches s/\b$var\b/$hexval/; 3596d5e616fcSJoe Perches } 359795e2c602SJoe Perches } 359895e2c602SJoe Perches 359995e2c602SJoe Perches#CamelCase 3600807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 3601be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 360222735ce8SJoe Perches#Ignore Page<foo> variants 3603807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 360422735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 36053445686aSJoe Perches $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) { 36067e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 36077e781f67SJoe Perches my $word = $1; 36087e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 3609d8b07710SJoe Perches if ($check) { 3610d8b07710SJoe Perches seed_camelcase_includes(); 3611d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 3612d8b07710SJoe Perches seed_camelcase_file($realfile); 3613d8b07710SJoe Perches $camelcase_file_seeded = 1; 3614d8b07710SJoe Perches } 3615d8b07710SJoe Perches } 36167e781f67SJoe Perches if (!defined $camelcase{$word}) { 36177e781f67SJoe Perches $camelcase{$word} = 1; 3618be79794bSJoe Perches CHK("CAMELCASE", 36197e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 36207e781f67SJoe Perches } 3621323c1260SJoe Perches } 3622323c1260SJoe Perches } 36233445686aSJoe Perches } 36240a920b5bSAndy Whitcroft 36250a920b5bSAndy Whitcroft#no spaces allowed after \ in define 3626d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 3627d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 3628d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 3629d5e616fcSJoe Perches $fix) { 3630d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\s+$//; 3631d5e616fcSJoe Perches } 36320a920b5bSAndy Whitcroft } 36330a920b5bSAndy Whitcroft 3634653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 3635c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 3636e09dec48SAndy Whitcroft my $file = "$1.h"; 3637e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 3638e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 3639e09dec48SAndy Whitcroft $realfile ne $checkfile && 36407840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 3641c45dcabdSAndy Whitcroft { 3642e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 3643000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 3644000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3645e09dec48SAndy Whitcroft } else { 3646000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 3647000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3648e09dec48SAndy Whitcroft } 36490a920b5bSAndy Whitcroft } 36500a920b5bSAndy Whitcroft } 36510a920b5bSAndy Whitcroft 3652653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 3653653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 3654cf655043SAndy Whitcroft# in a known good container 3655b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 3656b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 3657d8aaf121SAndy Whitcroft my $ln = $linenr; 3658d8aaf121SAndy Whitcroft my $cnt = $realcnt; 3659c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 3660c45dcabdSAndy Whitcroft my $ctx = ''; 3661c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 3662f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3663f74bd194SAndy Whitcroft $ctx = $dstat; 3664c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 3665a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 3666c45dcabdSAndy Whitcroft 3667f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 3668292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 3669c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 3670c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 3671c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 3672c45dcabdSAndy Whitcroft 3673c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 3674bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 3675bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 3676c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 3677bf30d6edSAndy Whitcroft { 3678c45dcabdSAndy Whitcroft } 3679c45dcabdSAndy Whitcroft 3680e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 3681e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 3682e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 3683e45bab8eSAndy Whitcroft { 3684e45bab8eSAndy Whitcroft } 3685e45bab8eSAndy Whitcroft 3686c45dcabdSAndy Whitcroft my $exceptions = qr{ 3687c45dcabdSAndy Whitcroft $Declare| 3688c45dcabdSAndy Whitcroft module_param_named| 3689a0a0a7a9SKees Cook MODULE_PARM_DESC| 3690c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 3691c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 3692383099fdSAndy Whitcroft __typeof__\(| 369322fd2d3eSStefani Seibold union| 369422fd2d3eSStefani Seibold struct| 3695ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 3696ea71a0a0SAndy Whitcroft ^\"|\"$ 3697c45dcabdSAndy Whitcroft }x; 36985eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 3699f74bd194SAndy Whitcroft if ($dstat ne '' && 3700f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 3701f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 37023cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 3703b9df76acSAndy Whitcroft $dstat !~ /^'X'$/ && # character constants 3704f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 3705f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 3706e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 370772f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 3708f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 3709f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 3710f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 3711f95a7e6aSJoe Perches $dstat !~ /^\({/ && # ({... 3712f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 3713c45dcabdSAndy Whitcroft { 3714f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 3715f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 3716f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 3717f74bd194SAndy Whitcroft 3718f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 3719f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 3720c45dcabdSAndy Whitcroft } 3721c45dcabdSAndy Whitcroft 3722f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 3723f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 3724f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 3725f74bd194SAndy Whitcroft } else { 3726000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 3727f74bd194SAndy Whitcroft "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); 3728d8aaf121SAndy Whitcroft } 37290a920b5bSAndy Whitcroft } 37305023d347SJoe Perches 3731481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 37325023d347SJoe Perches 37335023d347SJoe Perches } else { 37345023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 3735481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 3736481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 37375023d347SJoe Perches $line =~ /^\+.*\\$/) { 37385023d347SJoe Perches WARN("LINE_CONTINUATIONS", 37395023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 37405023d347SJoe Perches } 3741653d4876SAndy Whitcroft } 37420a920b5bSAndy Whitcroft 3743b13edf7fSJoe Perches# do {} while (0) macro tests: 3744b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 3745b13edf7fSJoe Perches# macro should not end with a semicolon 3746b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 3747b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 3748b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 3749b13edf7fSJoe Perches my $ln = $linenr; 3750b13edf7fSJoe Perches my $cnt = $realcnt; 3751b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 3752b13edf7fSJoe Perches my $ctx = ''; 3753b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 3754b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 3755b13edf7fSJoe Perches $ctx = $dstat; 3756b13edf7fSJoe Perches 3757b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 3758b13edf7fSJoe Perches 3759b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 3760b13edf7fSJoe Perches my $stmts = $2; 3761b13edf7fSJoe Perches my $semis = $3; 3762b13edf7fSJoe Perches 3763b13edf7fSJoe Perches $ctx =~ s/\n*$//; 3764b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 3765b13edf7fSJoe Perches my $herectx = $here . "\n"; 3766b13edf7fSJoe Perches 3767b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3768b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3769b13edf7fSJoe Perches } 3770b13edf7fSJoe Perches 3771ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 3772ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 3773b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 3774b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 3775b13edf7fSJoe Perches } 3776b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 3777b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 3778b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 3779b13edf7fSJoe Perches } 3780b13edf7fSJoe Perches } 3781b13edf7fSJoe Perches } 3782b13edf7fSJoe Perches 3783080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 3784080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 3785080ba929SMike Frysinger# . 3786080ba929SMike Frysinger# ALIGN(...) 3787080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 3788080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 3789000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 3790000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 3791080ba929SMike Frysinger } 3792080ba929SMike Frysinger 3793f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 379413214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 379513214adfSAndy Whitcroft my ($level, $endln, @chunks) = 3796cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 379713214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 3798cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 3799cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 3800aad4f614SJoe Perches my @allowed = (); 3801aad4f614SJoe Perches my $allow = 0; 380213214adfSAndy Whitcroft my $seen = 0; 3803773647a0SAndy Whitcroft my $herectx = $here . "\n"; 3804cf655043SAndy Whitcroft my $ln = $linenr - 1; 380513214adfSAndy Whitcroft for my $chunk (@chunks) { 380613214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 380713214adfSAndy Whitcroft 3808773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 3809773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 3810773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 3811773647a0SAndy Whitcroft 3812aad4f614SJoe Perches $allowed[$allow] = 0; 3813773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 3814773647a0SAndy Whitcroft 3815773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 3816773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 3817773647a0SAndy Whitcroft 3818773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 3819cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 3820cf655043SAndy Whitcroft 3821773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 382213214adfSAndy Whitcroft 382313214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 382413214adfSAndy Whitcroft 3825aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 3826cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3827cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3828aad4f614SJoe Perches $allowed[$allow] = 1; 382913214adfSAndy Whitcroft } 383013214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3831cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3832aad4f614SJoe Perches $allowed[$allow] = 1; 383313214adfSAndy Whitcroft } 3834cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3835cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3836aad4f614SJoe Perches $allowed[$allow] = 1; 383713214adfSAndy Whitcroft } 3838aad4f614SJoe Perches $allow++; 383913214adfSAndy Whitcroft } 3840aad4f614SJoe Perches if ($seen) { 3841aad4f614SJoe Perches my $sum_allowed = 0; 3842aad4f614SJoe Perches foreach (@allowed) { 3843aad4f614SJoe Perches $sum_allowed += $_; 3844aad4f614SJoe Perches } 3845aad4f614SJoe Perches if ($sum_allowed == 0) { 3846000d1cc1SJoe Perches WARN("BRACES", 3847000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 3848aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 3849aad4f614SJoe Perches $seen != $allow) { 3850aad4f614SJoe Perches CHK("BRACES", 3851aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 3852aad4f614SJoe Perches } 385313214adfSAndy Whitcroft } 385413214adfSAndy Whitcroft } 385513214adfSAndy Whitcroft } 3856773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 385713214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 3858cf655043SAndy Whitcroft my $allowed = 0; 3859f0a594c1SAndy Whitcroft 3860cf655043SAndy Whitcroft # Check the pre-context. 3861cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 3862cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 3863cf655043SAndy Whitcroft $allowed = 1; 3864f0a594c1SAndy Whitcroft } 3865773647a0SAndy Whitcroft 3866773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 3867773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 3868773647a0SAndy Whitcroft 3869cf655043SAndy Whitcroft # Check the condition. 3870cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 3871773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 3872cf655043SAndy Whitcroft if (defined $cond) { 3873773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3874cf655043SAndy Whitcroft } 3875cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3876cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3877cf655043SAndy Whitcroft $allowed = 1; 3878cf655043SAndy Whitcroft } 3879cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3880cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3881cf655043SAndy Whitcroft $allowed = 1; 3882cf655043SAndy Whitcroft } 3883cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3884cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3885cf655043SAndy Whitcroft $allowed = 1; 3886cf655043SAndy Whitcroft } 3887cf655043SAndy Whitcroft # Check the post-context. 3888cf655043SAndy Whitcroft if (defined $chunks[1]) { 3889cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 3890cf655043SAndy Whitcroft if (defined $cond) { 3891773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3892cf655043SAndy Whitcroft } 3893cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 3894cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 3895cf655043SAndy Whitcroft $allowed = 1; 3896cf655043SAndy Whitcroft } 3897cf655043SAndy Whitcroft } 3898cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 389969932487SJustin P. Mattock my $herectx = $here . "\n"; 3900f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 3901cf655043SAndy Whitcroft 3902f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 390369932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 3904cf655043SAndy Whitcroft } 3905cf655043SAndy Whitcroft 3906000d1cc1SJoe Perches WARN("BRACES", 3907000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 3908f0a594c1SAndy Whitcroft } 3909f0a594c1SAndy Whitcroft } 3910f0a594c1SAndy Whitcroft 39110979ae66SJoe Perches# check for unnecessary blank lines around braces 391277b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 39130979ae66SJoe Perches CHK("BRACES", 39140979ae66SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev); 39150979ae66SJoe Perches } 391677b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 39170979ae66SJoe Perches CHK("BRACES", 39180979ae66SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev); 39190979ae66SJoe Perches } 39200979ae66SJoe Perches 39214a0df2efSAndy Whitcroft# no volatiles please 39226c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 39236c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 3924000d1cc1SJoe Perches WARN("VOLATILE", 3925000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 39264a0df2efSAndy Whitcroft } 39274a0df2efSAndy Whitcroft 392800df344fSAndy Whitcroft# warn about #if 0 3929c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 3930000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 3931000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 3932de7d4f0eSAndy Whitcroft $herecurr); 39334a0df2efSAndy Whitcroft } 39344a0df2efSAndy Whitcroft 393503df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 393603df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 393703df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 393803df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 393903df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 394003df4b51SAndy Whitcroft "$1(NULL) is safe this check is probably not required\n" . $hereprev); 39414c432a8fSGreg Kroah-Hartman } 39424c432a8fSGreg Kroah-Hartman } 3943f0a594c1SAndy Whitcroft 39448716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 39458716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 39468716de38SJoe Perches my $attr = $1; 39478716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 39488716de38SJoe Perches my $ptr = $1; 39498716de38SJoe Perches my $var = $2; 39508716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 39518716de38SJoe Perches ERROR("MISPLACED_INIT", 39528716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 39538716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 39548716de38SJoe Perches WARN("MISPLACED_INIT", 39558716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 39568716de38SJoe Perches $fix) { 39578716de38SJoe Perches $fixed[$linenr - 1] =~ 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; 39588716de38SJoe Perches } 39598716de38SJoe Perches } 39608716de38SJoe Perches } 39618716de38SJoe Perches 3962e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 3963e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 3964e970b884SJoe Perches my $attr = $1; 3965e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 3966e970b884SJoe Perches my $attr_prefix = $1; 3967e970b884SJoe Perches my $attr_type = $2; 3968e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 3969e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 3970e970b884SJoe Perches $fix) { 3971e970b884SJoe Perches $fixed[$linenr - 1] =~ 3972e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 3973e970b884SJoe Perches } 3974e970b884SJoe Perches } 3975e970b884SJoe Perches 3976e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 3977e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 3978e970b884SJoe Perches my $attr = $1; 3979e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 3980e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 3981e970b884SJoe Perches $fix) { 3982e970b884SJoe Perches my $lead = $fixed[$linenr - 1] =~ 3983e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 3984e970b884SJoe Perches $lead = rtrim($1); 3985e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 3986e970b884SJoe Perches $lead = "${lead}const "; 3987e970b884SJoe Perches $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/; 3988e970b884SJoe Perches } 3989e970b884SJoe Perches } 3990e970b884SJoe Perches 3991fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 3992fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 3993fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 3994fbdb8138SJoe Perches my $constant_func = $1; 3995fbdb8138SJoe Perches my $func = $constant_func; 3996fbdb8138SJoe Perches $func =~ s/^__constant_//; 3997fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 3998fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 3999fbdb8138SJoe Perches $fix) { 4000fbdb8138SJoe Perches $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g; 4001fbdb8138SJoe Perches } 4002fbdb8138SJoe Perches } 4003fbdb8138SJoe Perches 40041a15a250SPatrick Pannuto# prefer usleep_range over udelay 400537581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 400643c1d77cSJoe Perches my $delay = $1; 40071a15a250SPatrick Pannuto # ignore udelay's < 10, however 400843c1d77cSJoe Perches if (! ($delay < 10) ) { 4009000d1cc1SJoe Perches CHK("USLEEP_RANGE", 401043c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 401143c1d77cSJoe Perches } 401243c1d77cSJoe Perches if ($delay > 2000) { 401343c1d77cSJoe Perches WARN("LONG_UDELAY", 401443c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 40151a15a250SPatrick Pannuto } 40161a15a250SPatrick Pannuto } 40171a15a250SPatrick Pannuto 401809ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 401909ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 402009ef8725SPatrick Pannuto if ($1 < 20) { 4021000d1cc1SJoe Perches WARN("MSLEEP", 402243c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 402309ef8725SPatrick Pannuto } 402409ef8725SPatrick Pannuto } 402509ef8725SPatrick Pannuto 402636ec1939SJoe Perches# check for comparisons of jiffies 402736ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 402836ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 402936ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 403036ec1939SJoe Perches } 403136ec1939SJoe Perches 40329d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 40339d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 40349d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 40359d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 40369d7a34a5SJoe Perches } 40379d7a34a5SJoe Perches 403800df344fSAndy Whitcroft# warn about #ifdefs in C files 4039c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 404000df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 404100df344fSAndy Whitcroft# print "$herecurr"; 404200df344fSAndy Whitcroft# $clean = 0; 404300df344fSAndy Whitcroft# } 404400df344fSAndy Whitcroft 404522f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 4046c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 40473705ce5bSJoe Perches if (ERROR("SPACING", 40483705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 40493705ce5bSJoe Perches $fix) { 40503705ce5bSJoe Perches $fixed[$linenr - 1] =~ 40513705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 40523705ce5bSJoe Perches } 40533705ce5bSJoe Perches 405422f2a2efSAndy Whitcroft } 405522f2a2efSAndy Whitcroft 40564a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 4057171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 4058171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 40594a0df2efSAndy Whitcroft my $which = $1; 40604a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4061000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 4062000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 40634a0df2efSAndy Whitcroft } 40644a0df2efSAndy Whitcroft } 40654a0df2efSAndy Whitcroft# check for memory barriers without a comment. 40664a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 40674a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4068c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 4069000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 40704a0df2efSAndy Whitcroft } 40714a0df2efSAndy Whitcroft } 40724a0df2efSAndy Whitcroft# check of hardware specific defines 4073c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 4074000d1cc1SJoe Perches CHK("ARCH_DEFINES", 4075000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 40760a920b5bSAndy Whitcroft } 4077653d4876SAndy Whitcroft 4078d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 4079d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 4080000d1cc1SJoe Perches WARN("STORAGE_CLASS", 4081000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 4082d4977c78STobias Klauser } 4083d4977c78STobias Klauser 4084de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 4085de7d4f0eSAndy Whitcroft# storage class and type. 40869c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 40879c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 4088000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 4089000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 4090de7d4f0eSAndy Whitcroft } 4091de7d4f0eSAndy Whitcroft 40928905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 40932b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 40942b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 4095d5e616fcSJoe Perches if (WARN("INLINE", 4096d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 4097d5e616fcSJoe Perches $fix) { 4098d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/; 4099d5e616fcSJoe Perches 4100d5e616fcSJoe Perches } 41018905a67cSAndy Whitcroft } 41028905a67cSAndy Whitcroft 41033d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 41042b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 41052b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 4106000d1cc1SJoe Perches WARN("PREFER_PACKED", 4107000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 41083d130fd0SJoe Perches } 41093d130fd0SJoe Perches 411039b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 41112b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 41122b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 4113000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 4114000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 411539b7e287SJoe Perches } 411639b7e287SJoe Perches 41175f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 41182b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 41192b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 4120d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 4121d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 4122d5e616fcSJoe Perches $fix) { 4123d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 4124d5e616fcSJoe Perches 4125d5e616fcSJoe Perches } 41265f14d3bdSJoe Perches } 41275f14d3bdSJoe Perches 41286061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 41292b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 41302b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 4131d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 4132d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 4133d5e616fcSJoe Perches $fix) { 4134d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 4135d5e616fcSJoe Perches } 41366061d949SJoe Perches } 41376061d949SJoe Perches 41388f53a9b8SJoe Perches# check for sizeof(&) 41398f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 4140000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 4141000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 41428f53a9b8SJoe Perches } 41438f53a9b8SJoe Perches 414466c80b60SJoe Perches# check for sizeof without parenthesis 414566c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 4146d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 4147d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 4148d5e616fcSJoe Perches $fix) { 4149d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 4150d5e616fcSJoe Perches } 415166c80b60SJoe Perches } 415266c80b60SJoe Perches 4153428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 4154428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 4155000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 4156000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 4157428e2fdcSJoe Perches } 4158428e2fdcSJoe Perches 415988982feaSJoe Perches# check for struct spinlock declarations 416088982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 416188982feaSJoe Perches WARN("USE_SPINLOCK_T", 416288982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 416388982feaSJoe Perches } 416488982feaSJoe Perches 4165a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 416606668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 4167a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 416806668727SJoe Perches if ($fmt ne "" && $fmt !~ /[^\\]\%/) { 4169d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 4170d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 4171d5e616fcSJoe Perches $fix) { 4172d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/; 4173d5e616fcSJoe Perches } 4174a6962d72SJoe Perches } 4175a6962d72SJoe Perches } 4176a6962d72SJoe Perches 4177554e165cSAndy Whitcroft# Check for misused memsets 4178d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4179d1fe9c09SJoe Perches defined $stat && 4180d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 4181554e165cSAndy Whitcroft 4182d7c76ba7SJoe Perches my $ms_addr = $2; 4183d1fe9c09SJoe Perches my $ms_val = $7; 4184d1fe9c09SJoe Perches my $ms_size = $12; 4185d7c76ba7SJoe Perches 4186554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 4187554e165cSAndy Whitcroft ERROR("MEMSET", 4188d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 4189554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 4190554e165cSAndy Whitcroft WARN("MEMSET", 4191d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 4192d7c76ba7SJoe Perches } 4193d7c76ba7SJoe Perches } 4194d7c76ba7SJoe Perches 419598a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 419698a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 419798a9bba5SJoe Perches $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) { 419898a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 419998a9bba5SJoe Perches "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) && 420098a9bba5SJoe Perches $fix) { 420198a9bba5SJoe Perches $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 420298a9bba5SJoe Perches } 420398a9bba5SJoe Perches } 420498a9bba5SJoe Perches 4205d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 4206d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4207d1fe9c09SJoe Perches defined $stat && 4208d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 4209d1fe9c09SJoe Perches if (defined $2 || defined $7) { 4210d7c76ba7SJoe Perches my $call = $1; 4211d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 4212d7c76ba7SJoe Perches my $arg1 = $3; 4213d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 4214d1fe9c09SJoe Perches my $arg2 = $8; 4215d7c76ba7SJoe Perches my $cast; 4216d7c76ba7SJoe Perches 4217d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 4218d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 4219d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 4220d7c76ba7SJoe Perches $cast = $cast1; 4221d7c76ba7SJoe Perches } else { 4222d7c76ba7SJoe Perches $cast = $cast2; 4223d7c76ba7SJoe Perches } 4224d7c76ba7SJoe Perches WARN("MINMAX", 4225d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 4226554e165cSAndy Whitcroft } 4227554e165cSAndy Whitcroft } 4228554e165cSAndy Whitcroft 42294a273195SJoe Perches# check usleep_range arguments 42304a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 42314a273195SJoe Perches defined $stat && 42324a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 42334a273195SJoe Perches my $min = $1; 42344a273195SJoe Perches my $max = $7; 42354a273195SJoe Perches if ($min eq $max) { 42364a273195SJoe Perches WARN("USLEEP_RANGE", 42374a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 42384a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 42394a273195SJoe Perches $min > $max) { 42404a273195SJoe Perches WARN("USLEEP_RANGE", 42414a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 42424a273195SJoe Perches } 42434a273195SJoe Perches } 42444a273195SJoe Perches 4245823b794cSJoe Perches# check for naked sscanf 4246823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 4247823b794cSJoe Perches defined $stat && 42486c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 4249823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 4250823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 4251823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 4252823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 4253823b794cSJoe Perches $lc = $lc + $linenr; 4254823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 4255823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 4256823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 4257823b794cSJoe Perches } 4258823b794cSJoe Perches WARN("NAKED_SSCANF", 4259823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 4260823b794cSJoe Perches } 4261823b794cSJoe Perches 426270dc8a48SJoe Perches# check for new externs in .h files. 426370dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 426470dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 4265d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 426670dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 426770dc8a48SJoe Perches $fix) { 426870dc8a48SJoe Perches $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 426970dc8a48SJoe Perches } 427070dc8a48SJoe Perches } 427170dc8a48SJoe Perches 4272de7d4f0eSAndy Whitcroft# check for new externs in .c files. 4273171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 4274c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 4275171ae1a4SAndy Whitcroft { 4276c45dcabdSAndy Whitcroft my $function_name = $1; 4277c45dcabdSAndy Whitcroft my $paren_space = $2; 4278171ae1a4SAndy Whitcroft 4279171ae1a4SAndy Whitcroft my $s = $stat; 4280171ae1a4SAndy Whitcroft if (defined $cond) { 4281171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 4282171ae1a4SAndy Whitcroft } 4283c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 4284c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 4285c45dcabdSAndy Whitcroft { 4286000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4287000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4288de7d4f0eSAndy Whitcroft } 4289de7d4f0eSAndy Whitcroft 4290171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 4291000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 4292000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 4293171ae1a4SAndy Whitcroft } 42949c9ba34eSAndy Whitcroft 42959c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 42969c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 42979c9ba34eSAndy Whitcroft { 4298000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4299000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4300171ae1a4SAndy Whitcroft } 4301171ae1a4SAndy Whitcroft 4302de7d4f0eSAndy Whitcroft# checks for new __setup's 4303de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 4304de7d4f0eSAndy Whitcroft my $name = $1; 4305de7d4f0eSAndy Whitcroft 4306de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 4307000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 4308000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 4309de7d4f0eSAndy Whitcroft } 4310653d4876SAndy Whitcroft } 43119c0ca6f9SAndy Whitcroft 43129c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 4313caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 4314000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 4315000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 43169c0ca6f9SAndy Whitcroft } 431713214adfSAndy Whitcroft 4318a640d25cSJoe Perches# alloc style 4319a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 4320a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 4321a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 4322a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 4323a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 4324a640d25cSJoe Perches } 4325a640d25cSJoe Perches 4326972fdea2SJoe Perches# check for krealloc arg reuse 4327972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 4328972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 4329972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 4330972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 4331972fdea2SJoe Perches } 4332972fdea2SJoe Perches 43335ce59ae0SJoe Perches# check for alloc argument mismatch 43345ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 43355ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 43365ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 43375ce59ae0SJoe Perches } 43385ce59ae0SJoe Perches 4339caf2a54fSJoe Perches# check for multiple semicolons 4340caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 4341d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 4342d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 4343d5e616fcSJoe Perches $fix) { 4344d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g; 4345d5e616fcSJoe Perches } 4346d1e2ad07SJoe Perches } 4347d1e2ad07SJoe Perches 4348c34c09a8SJoe Perches# check for case / default statements not preceeded by break/fallthrough/switch 4349c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 4350c34c09a8SJoe Perches my $has_break = 0; 4351c34c09a8SJoe Perches my $has_statement = 0; 4352c34c09a8SJoe Perches my $count = 0; 4353c34c09a8SJoe Perches my $prevline = $linenr; 4354c34c09a8SJoe Perches while ($prevline > 1 && $count < 3 && !$has_break) { 4355c34c09a8SJoe Perches $prevline--; 4356c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 4357c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 4358c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 4359c34c09a8SJoe Perches next if ($fline =~ /^\-/); 4360c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 4361c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 4362c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 4363c34c09a8SJoe Perches $has_statement = 1; 4364c34c09a8SJoe Perches $count++; 4365c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 4366c34c09a8SJoe Perches } 4367c34c09a8SJoe Perches if (!$has_break && $has_statement) { 4368c34c09a8SJoe Perches WARN("MISSING_BREAK", 4369c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 4370c34c09a8SJoe Perches } 4371c34c09a8SJoe Perches } 4372c34c09a8SJoe Perches 4373d1e2ad07SJoe Perches# check for switch/default statements without a break; 4374d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 4375d1e2ad07SJoe Perches defined $stat && 4376d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 4377d1e2ad07SJoe Perches my $ctx = ''; 4378d1e2ad07SJoe Perches my $herectx = $here . "\n"; 4379d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 4380d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4381d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4382d1e2ad07SJoe Perches } 4383d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 4384d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 4385caf2a54fSJoe Perches } 4386caf2a54fSJoe Perches 438713214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 4388d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 4389d5e616fcSJoe Perches if (WARN("USE_FUNC", 4390d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 4391d5e616fcSJoe Perches $fix) { 4392d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g; 4393d5e616fcSJoe Perches } 439413214adfSAndy Whitcroft } 4395773647a0SAndy Whitcroft 43962c92488aSJoe Perches# check for use of yield() 43972c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 43982c92488aSJoe Perches WARN("YIELD", 43992c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 44002c92488aSJoe Perches } 44012c92488aSJoe Perches 4402179f8f40SJoe Perches# check for comparisons against true and false 4403179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 4404179f8f40SJoe Perches my $lead = $1; 4405179f8f40SJoe Perches my $arg = $2; 4406179f8f40SJoe Perches my $test = $3; 4407179f8f40SJoe Perches my $otype = $4; 4408179f8f40SJoe Perches my $trail = $5; 4409179f8f40SJoe Perches my $op = "!"; 4410179f8f40SJoe Perches 4411179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 4412179f8f40SJoe Perches 4413179f8f40SJoe Perches my $type = lc($otype); 4414179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 4415179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 4416179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 4417179f8f40SJoe Perches $op = ""; 4418179f8f40SJoe Perches } 4419179f8f40SJoe Perches 4420179f8f40SJoe Perches CHK("BOOL_COMPARISON", 4421179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 4422179f8f40SJoe Perches 4423179f8f40SJoe Perches## maybe suggesting a correct construct would better 4424179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 4425179f8f40SJoe Perches 4426179f8f40SJoe Perches } 4427179f8f40SJoe Perches } 4428179f8f40SJoe Perches 44294882720bSThomas Gleixner# check for semaphores initialized locked 44304882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 4431000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 4432000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 4433773647a0SAndy Whitcroft } 44346712d858SJoe Perches 443567d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 443667d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 4437000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 443867d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 4439773647a0SAndy Whitcroft } 44406712d858SJoe Perches 4441f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please 4442f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 4443000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 4444000d1cc1SJoe Perches "please use device_initcall() instead of __initcall()\n" . $herecurr); 4445f3db6639SMichael Ellerman } 44466712d858SJoe Perches 444779404849SEmese Revfy# check for various ops structs, ensure they are const. 444879404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 444979404849SEmese Revfy address_space_operations| 445079404849SEmese Revfy backlight_ops| 445179404849SEmese Revfy block_device_operations| 445279404849SEmese Revfy dentry_operations| 445379404849SEmese Revfy dev_pm_ops| 445479404849SEmese Revfy dma_map_ops| 445579404849SEmese Revfy extent_io_ops| 445679404849SEmese Revfy file_lock_operations| 445779404849SEmese Revfy file_operations| 445879404849SEmese Revfy hv_ops| 445979404849SEmese Revfy ide_dma_ops| 446079404849SEmese Revfy intel_dvo_dev_ops| 446179404849SEmese Revfy item_operations| 446279404849SEmese Revfy iwl_ops| 446379404849SEmese Revfy kgdb_arch| 446479404849SEmese Revfy kgdb_io| 446579404849SEmese Revfy kset_uevent_ops| 446679404849SEmese Revfy lock_manager_operations| 446779404849SEmese Revfy microcode_ops| 446879404849SEmese Revfy mtrr_ops| 446979404849SEmese Revfy neigh_ops| 447079404849SEmese Revfy nlmsvc_binding| 447179404849SEmese Revfy pci_raw_ops| 447279404849SEmese Revfy pipe_buf_operations| 447379404849SEmese Revfy platform_hibernation_ops| 447479404849SEmese Revfy platform_suspend_ops| 447579404849SEmese Revfy proto_ops| 447679404849SEmese Revfy rpc_pipe_ops| 447779404849SEmese Revfy seq_operations| 447879404849SEmese Revfy snd_ac97_build_ops| 447979404849SEmese Revfy soc_pcmcia_socket_ops| 448079404849SEmese Revfy stacktrace_ops| 448179404849SEmese Revfy sysfs_ops| 448279404849SEmese Revfy tty_operations| 448379404849SEmese Revfy usb_mon_operations| 448479404849SEmese Revfy wd_ops}x; 44856903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 448679404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 4487000d1cc1SJoe Perches WARN("CONST_STRUCT", 4488000d1cc1SJoe Perches "struct $1 should normally be const\n" . 44896903ffb2SAndy Whitcroft $herecurr); 44902b6db5cbSAndy Whitcroft } 4491773647a0SAndy Whitcroft 4492773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 4493773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 4494773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 4495c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 4496c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 4497171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 4498171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 4499171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 4500773647a0SAndy Whitcroft { 4501000d1cc1SJoe Perches WARN("NR_CPUS", 4502000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 4503773647a0SAndy Whitcroft } 45049c9ba34eSAndy Whitcroft 450552ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 450652ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 450752ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 450852ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 450952ea8506SJoe Perches } 451052ea8506SJoe Perches 45119c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 45129c9ba34eSAndy Whitcroft my $string; 45139c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 45149c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 45152a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 45169c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 4517000d1cc1SJoe Perches WARN("PRINTF_L", 4518000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 45199c9ba34eSAndy Whitcroft last; 45209c9ba34eSAndy Whitcroft } 45219c9ba34eSAndy Whitcroft } 4522691d77b6SAndy Whitcroft 4523691d77b6SAndy Whitcroft# whine mightly about in_atomic 4524691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 4525691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 4526000d1cc1SJoe Perches ERROR("IN_ATOMIC", 4527000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 4528f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 4529000d1cc1SJoe Perches WARN("IN_ATOMIC", 4530000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 4531691d77b6SAndy Whitcroft } 4532691d77b6SAndy Whitcroft } 45331704f47bSPeter Zijlstra 45341704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 45351704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 45361704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 45371704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 45381704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 45391704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 4540000d1cc1SJoe Perches ERROR("LOCKDEP", 4541000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 45421704f47bSPeter Zijlstra } 45431704f47bSPeter Zijlstra } 454488f8831cSDave Jones 454588f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 454688f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 4547000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 4548000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 454988f8831cSDave Jones } 45502435880fSJoe Perches 4551515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 4552515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 4553515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 4554515a235eSJoe Perches $line =~ /$mode_perms_search/) { 45552435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 45562435880fSJoe Perches my $func = $entry->[0]; 45572435880fSJoe Perches my $arg_pos = $entry->[1]; 45582435880fSJoe Perches 45592435880fSJoe Perches my $skip_args = ""; 45602435880fSJoe Perches if ($arg_pos > 1) { 45612435880fSJoe Perches $arg_pos--; 45622435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 45632435880fSJoe Perches } 45642435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 4565515a235eSJoe Perches if ($line =~ /$test/) { 45662435880fSJoe Perches my $val = $1; 45672435880fSJoe Perches $val = $6 if ($skip_args ne ""); 45682435880fSJoe Perches 45691727cc70SJoe Perches if ($val !~ /^0$/ && 45701727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 45711727cc70SJoe Perches length($val) ne 4)) { 45722435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 45731727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 45742435880fSJoe Perches } 45752435880fSJoe Perches } 45762435880fSJoe Perches } 457713214adfSAndy Whitcroft } 4578515a235eSJoe Perches } 457913214adfSAndy Whitcroft 458013214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 458113214adfSAndy Whitcroft # so just keep quiet. 458213214adfSAndy Whitcroft if ($#rawlines == -1) { 458313214adfSAndy Whitcroft exit(0); 45840a920b5bSAndy Whitcroft } 45850a920b5bSAndy Whitcroft 45868905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 45878905a67cSAndy Whitcroft # things that appear to be patches. 45888905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 45898905a67cSAndy Whitcroft exit(0); 45908905a67cSAndy Whitcroft } 45918905a67cSAndy Whitcroft 45928905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 45938905a67cSAndy Whitcroft # just keep quiet. 45948905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 45958905a67cSAndy Whitcroft exit(0); 45968905a67cSAndy Whitcroft } 45978905a67cSAndy Whitcroft 45988905a67cSAndy Whitcroft if (!$is_patch) { 4599000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 4600000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 46010a920b5bSAndy Whitcroft } 46020a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 4603000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 4604000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 46050a920b5bSAndy Whitcroft } 46060a920b5bSAndy Whitcroft 4607f0a594c1SAndy Whitcroft print report_dump(); 460813214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 460913214adfSAndy Whitcroft print "$filename " if ($summary_file); 46106c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 46116c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 46126c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 46138905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 46146c72ffaaSAndy Whitcroft } 46158905a67cSAndy Whitcroft 4616d2c0a235SAndy Whitcroft if ($quiet == 0) { 4617d1fe9c09SJoe Perches 4618d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 4619d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 4620d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 4621d1fe9c09SJoe Perches } 4622d1fe9c09SJoe Perches 4623d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 4624d2c0a235SAndy Whitcroft # then suggest that. 4625d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 4626d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 4627d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 4628b0781216SMike Frysinger $rpt_cleaners = 0; 4629d2c0a235SAndy Whitcroft } 4630d2c0a235SAndy Whitcroft } 4631d2c0a235SAndy Whitcroft 463291bfe484SJoe Perches hash_show_words(\%use_type, "Used"); 463391bfe484SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 4634000d1cc1SJoe Perches 46353705ce5bSJoe Perches if ($clean == 0 && $fix && "@rawlines" ne "@fixed") { 46369624b8d6SJoe Perches my $newfile = $filename; 46379624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 46383705ce5bSJoe Perches my $linecount = 0; 46393705ce5bSJoe Perches my $f; 46403705ce5bSJoe Perches 46413705ce5bSJoe Perches open($f, '>', $newfile) 46423705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 46433705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 46443705ce5bSJoe Perches $linecount++; 46453705ce5bSJoe Perches if ($file) { 46463705ce5bSJoe Perches if ($linecount > 3) { 46473705ce5bSJoe Perches $fixed_line =~ s/^\+//; 46483705ce5bSJoe Perches print $f $fixed_line. "\n"; 46493705ce5bSJoe Perches } 46503705ce5bSJoe Perches } else { 46513705ce5bSJoe Perches print $f $fixed_line . "\n"; 46523705ce5bSJoe Perches } 46533705ce5bSJoe Perches } 46543705ce5bSJoe Perches close($f); 46553705ce5bSJoe Perches 46563705ce5bSJoe Perches if (!$quiet) { 46573705ce5bSJoe Perches print << "EOM"; 46583705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 46593705ce5bSJoe Perches 46603705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 46613705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 46623705ce5bSJoe Perches 46633705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 46643705ce5bSJoe PerchesNo warranties, expressed or implied... 46653705ce5bSJoe Perches 46663705ce5bSJoe PerchesEOM 46673705ce5bSJoe Perches } 46683705ce5bSJoe Perches } 46693705ce5bSJoe Perches 46700a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 4671c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 46720a920b5bSAndy Whitcroft } 46730a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 4674000d1cc1SJoe Perches print << "EOM"; 4675000d1cc1SJoe Perches$vname has style problems, please review. 4676000d1cc1SJoe Perches 4677000d1cc1SJoe PerchesIf any of these errors are false positives, please report 4678000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 4679000d1cc1SJoe PerchesEOM 46800a920b5bSAndy Whitcroft } 468113214adfSAndy Whitcroft 46820a920b5bSAndy Whitcroft return $clean; 46830a920b5bSAndy Whitcroft} 4684